Ad Invoices
The AdsInvoice Object
Properties
id
stringThe Rutter generated unique ID of the ad invoice.
platform_id
stringThe platform specific ID of the ad invoice.
due_date
stringnullableThe ISO 8601 timestamp for the due date of the ad invoice.
currency_code
stringnullableThe ISO 4217 currency code of the ad invoice.
document_number
stringnullableThe document number of the ad invoice.
name
stringnullableThe name of the ad invoice.
total_amount
numbernullableThe total amount for the ad invoice.
total_discounts
numbernullableThe total discounts for the ad invoice.
total_tax
numbernullableThe total tax for the ad invoice.
created_at
stringnullableThe ISO 8601 timestamp that the ad invoices was created.
updated_at
stringnullableThe ISO 8601 timestamp that the ad invoices was last updated.
last_synced_at
stringThe ISO 8601 timestamp when the ad invoices was last synced by Rutter.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Ad Invoices
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor
value from the previous response.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
sort
stringqueryOptionalUsed to sort the returned objects, e.g. last_synced_at ASC
. Currently supports the updated_at
and last_synced_at
fields. If a value is provided but ASC
or DESC
is not, defaults to ASC
. If omitted, defaults to updated_at DESC
.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_min
integerqueryOptionalUsed to filter objects with a last_synced_at
value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
updated_at_max
integerqueryOptionalUsed to filter objects with a updated_at
value less than or equal to the supplied value. Should be a Unix time in milliseconds.
updated_at_min
integerqueryOptionalUsed to filter objects with a updated_at
value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
invoices
arrayinvoices
attributesnext_cursor
stringnullableOptionalconnection
objectconnection
attributes- Facebook
- Google
- TikTok
1{
2 "invoices": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "12345678",
6 "due_date": "2023-01-02T02:34:56.000Z",
7 "currency_code": "USD",
8 "document_number": "EXAMPLE_DOCUMENT_NUMBER",
9 "name": "Ads Invoice",
10 "total_amount": 3.34,
11 "total_discounts": 1.11,
12 "total_tax": 1.23,
13 "created_at": "2023-01-02T02:34:56.000Z",
14 "updated_at": "2023-01-02T02:34:56.000Z",
15 "last_synced_at": "2023-01-02T02:34:56.000Z",
16 "platform_data": {
17 "id": 123,
18 "data": "Varies by platform"
19 }
20 }
21 ],
22 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
23 "connection": {
24 "id": "00000000-0000-0000-0000-000000000000",
25 "orgId": "00000000-0000-0000-0000-000000000000",
26 "platform": "NETSUITE"
27 }
28}
Fetch an Ad Invoice
Endpoint Not Available for Version 2023-02-07
Have questions?
Contact support for personalized guidance.