Ads

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.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes
Example AdsInvoice Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "due_date": "2023-01-02T02:34:56.000Z",
  "currency_code": "USD",
  "document_number": "EXAMPLE_DOCUMENT_NUMBER",
  "name": "Ads Invoice",
  "total_amount": 3.34,
  "total_discounts": 1.11,
  "total_tax": 1.23,
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z",
  "platform_data": {
    "id": 123,
    "data": "Varies by platform"
  }
}

List Ad Invoices

GET /versioned/ads/invoices
Supported for: Google

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumoptionalquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    last_synced_at_minintegeroptionalquery

    Unix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.

    limitintegeroptionalquery

    The limit on the number of entities returned.

    sortstringoptionalquery

    The field and direction to sort by (ASC or DESC), e.g. last_synced_at ASC. Currently supports the fields: updated_at, 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_maxintegeroptionalquery

    Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

    updated_at_minintegeroptionalquery

    Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

    invoicesarray
    Show invoices attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "invoices": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "due_date": "2023-01-02T02:34:56.000Z",
      "currency_code": "USD",
      "document_number": "EXAMPLE_DOCUMENT_NUMBER",
      "name": "Ads Invoice",
      "total_amount": 3.34,
      "total_discounts": 1.11,
      "total_tax": 1.23,
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Fetch an Ad Invoice

GET /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 changelog page.