PIpinterest
billing

Get billing invoices

Changed on

Get billing invoices in the advertiser account.

get/ad_accounts/{ad_account_id}/billing_invoices

Request

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Query parameters

bookmarkstring

Cursor used to fetch the next page of items

page_sizeinteger

Maximum number of items to include in a single page. See documentation on Pagination for more information.

order'ASCENDING' | 'DESCENDING'

The order in which to sort the items returned: "ASCENDING" or "DESCENDING" by ID. Note that higher-value IDs are associated with more-recently added items.

sort'DUE_DATE' | 'BILLING_PERIOD' | 'DOCUMENT_TYPE' | 'TOTAL_AMOUNT' | 'INVOICE_NUMBER'

Field by which to sort billing invoices.

Field of which to sort billing invoices

status'OPEN' | 'CLOSED'

The status of a billing invoice.

Status of billing invoices to filter by

document_type'INVOICE' | 'CREDIT_MEMO'

The type of a billing invoice document.

Document type of billing invoices to filter by

start_due_datestring date

Starting point for due dates when searching for invoices. Format: YYYY-MM-DD

end_due_datestring date

Ending point for due dates when searching for invoices. Format: YYYY-MM-DD

Response

The request has succeeded.

bookmarkstring nullable

Example response

{
  "items": [
    {
      "payment_terms": "NET 30"
    }
  ]
}

Changes

  • v5b698c180678aRevision changes
    • breaking

      for the query request parameter order, default value ASCENDING was added

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed the pattern ^(\d{4})-(\d{2})-(\d{2})$ from the query request parameter end_due_date

    • info

      removed the pattern ^(\d{4})-(\d{2})-(\d{2})$ from the query request parameter start_due_date

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • v510f9eba4ad97Revision changes
    • info

      endpoint added