Ad Invoices

The AdsInvoice Object

Properties

idstring

The Rutter generated unique ID of the ad invoice.

platform_idstring

The platform specific ID of the ad invoice.

due_datestringnullable

The ISO 8601 timestamp for the due date of the ad invoice.

currency_codestringnullable

The ISO 4217 currency code of the ad invoice.

document_numberstringnullable

The document number of the ad invoice.

namestringnullable

The name of the ad invoice.

total_amountnumbernullable

The total amount for the ad invoice.

total_discountsnumbernullable

The total discounts for the ad invoice.

total_taxnumbernullable

The total tax for the ad invoice.

created_atstringnullable

The ISO 8601 timestamp that the ad invoices was created.

updated_atstringnullable

The ISO 8601 timestamp that the ad invoices was last updated.

last_synced_atstring

The ISO 8601 timestamp when the ad invoices was last synced by Rutter.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/ads/invoices

GET

/ads/invoices/:id

List Ad Invoices

GEThttps://production.rutterapi.com/versioned/ads/invoices

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringqueryOptional

Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

expandenumqueryOptional

Include platform specific data (includes additional fields not provided by the Rutter object).

Must beplatform_data.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

last_synced_at_minintegerqueryOptional

Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

limitintegerqueryOptional

Used to limit the number of returned objects. Defaults to 50.

sortstringqueryOptional

Used to sort the returned objects, e.g. last_synced_at ASC. Currently supports the fields: updated_at or last_synced_at. If a field is provided but ASC or DESC is not, defaults to ASC. If this field is omitted, defaults to updated_at DESC.

updated_at_maxintegerqueryOptional

Used 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_minintegerqueryOptional

Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

Response Body

connectionobject

Show connection attributes

invoicesarray

Show invoices attributes

next_cursorstringnullableOptional

Support by integration

Facebook
Google
TikTok

Example Response Body

JSON

1{
2  "connection": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "orgId": "00000000-0000-0000-0000-000000000000",
5    "platform": "NETSUITE"
6  },
7  "invoices": [
8    {
9      "id": "00000000-0000-0000-0000-000000000000",
10      "platform_id": "12345678",
11      "due_date": "2023-01-02T02:34:56.000Z",
12      "currency_code": "USD",
13      "document_number": "EXAMPLE_DOCUMENT_NUMBER",
14      "name": "Ads Invoice",
15      "total_amount": 3.34,
16      "total_discounts": 1.11,
17      "total_tax": 1.23,
18      "created_at": "2023-01-02T02:34:56.000Z",
19      "updated_at": "2023-01-02T02:34:56.000Z",
20      "last_synced_at": "2023-01-02T02:34:56.000Z",
21      "platform_data": {
22        "id": 123,
23        "data": "Varies by platform"
24      }
25    }
26  ],
27  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
28}

Fetch an Ad Invoice

GEThttps://production.rutterapi.com/versioned/ads/invoices/:id

Endpoint Not Available for Version 2023-03-14

The endpoint Fetch an Ad Invoice (GET /ads/invoices/:id) is not available in version 2023-03-14. The endpoint may be available in a prior or later version. To see API version history, please visit the API Upgrades page.

Have questions?

Contact support for personalized guidance.

Contact support