TAtalkdesk
Billing Insights API

Returns a collection of invoice lines for the given accounts.

Changed on

All the invoice lines will be returned for the accounts under the organization. A 403 error is returned if the specified accounts are not under the organization performing the call. The results are paged.

get/express/invoices

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/express/invoices
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: express-accounts-invoices:read

Query parameters

filterstring

Allows filtering the results by 'account_id', invoice 'number', invoice 'date', 'due_date', 'invoice_line_number' and 'id' using comparison or logical operators. Examples:

  • Returns the data for a specific account
accound_id eq '5ea75fe7aa224700012eae40'
  • Returns the data for a specific invoice number
number eq 'INV1120933'
  • Returns the data for a spcific account in a given range of dates
(date ge '2023-12-01' and date le '2023-01-01' and account_id eq '5ea75fe7aa224700012eae40')
order_bystring

Allows ordering the results by 'date', 'account_id', 'number', 'invoice_line_number', 'due_date' or 'id'

pageinteger
Example:1

The number of the page to be returned. The default value is 1.

per_pageinteger

The number of results to be returned per page. The default value is 50.

Response

successful operation

countinteger

The number of results on the current page.

pageinteger

The number of the current page.

per_pageinteger

The number of results per page.

totalinteger

The total number of results for all pages.

total_pagesinteger

The total number of pages.

Example response

{
  "count": 50,
  "page": 2,
  "per_page": 50,
  "total": 425,
  "total_pages": 9,
  "_embedded": {
    "invoices": [
      {
        "id": "8f3e643c16671acaf60e8bceddbc1877",
        "account_id": "5ea75fe7aa224700012eae40",
        "number": "INV13098292",
        "date": "2024-08-31T00:00:00.000Z",
        "due_date": "2024-10-10T00:00:00.000Z",
        "currency": "USD",
        "total_invoice_amount": 161.5,
        "product_id": "TD-LIC-APP-RC-101910",
        "description": "08/16/2023 - 09/15/2023",
        "product_name": "Talkdesk CX Cloud Elevate Edition",
        "quantity": 10,
        "rate": 5,
        "amount": 50,
        "total_tax_amount": 11.5
      }
    ]
  }
}

Changes