GET api/Transaction?systemName={systemName}&username={username}&password={password}&advertiserId={advertiserId}&offset={offset}&limit={limit}

Gets all transactions for advertiser

Request Information

URI Parameters

NameDescriptionTypeAdditional information
systemName

string

Required

username

string

Required

password

string

Required

advertiserId

integer

Required

offset

integer

Default value is 0

limit

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of APITransaction
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

AdvertiserId

Unique identifier of advertiser to which this belongs

integer

None.

InvoiceNumber

Sequentially allocated invoice number

integer

None.

AlternateInvoiceNumber

Manually allocated invoice number

integer

None.

OrderNumber

Order number used for display only

string

None.

TransactionTimestamp

Timestamp when this was created

string

None.

Amount

Total value of transaction

decimal number

None.

VatRate

Vat rate applicable to transaction

decimal number

None.

Reason

Textual notes

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "advertiserId": 2,
    "invoiceNumber": 1,
    "alternateInvoiceNumber": 1,
    "orderNumber": "sample string 3",
    "transactionTimestamp": "sample string 4",
    "amount": 1.1,
    "vatRate": 1.1,
    "reason": "sample string 5"
  },
  {
    "id": 1,
    "advertiserId": 2,
    "invoiceNumber": 1,
    "alternateInvoiceNumber": 1,
    "orderNumber": "sample string 3",
    "transactionTimestamp": "sample string 4",
    "amount": 1.1,
    "vatRate": 1.1,
    "reason": "sample string 5"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPITransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APITransaction>
    <AdvertiserId>2</AdvertiserId>
    <AlternateInvoiceNumber>1</AlternateInvoiceNumber>
    <Amount>1.1</Amount>
    <Id>1</Id>
    <InvoiceNumber>1</InvoiceNumber>
    <OrderNumber>sample string 3</OrderNumber>
    <Reason>sample string 5</Reason>
    <TransactionTimestamp>sample string 4</TransactionTimestamp>
    <VatRate>1.1</VatRate>
  </APITransaction>
  <APITransaction>
    <AdvertiserId>2</AdvertiserId>
    <AlternateInvoiceNumber>1</AlternateInvoiceNumber>
    <Amount>1.1</Amount>
    <Id>1</Id>
    <InvoiceNumber>1</InvoiceNumber>
    <OrderNumber>sample string 3</OrderNumber>
    <Reason>sample string 5</Reason>
    <TransactionTimestamp>sample string 4</TransactionTimestamp>
    <VatRate>1.1</VatRate>
  </APITransaction>
</ArrayOfAPITransaction>