List invoices

GET

https://integrators.prod.api.tabsplatform.com/v3/invoices

GET

/v3/invoices

$ curl -G https://integrators.prod.api.tabsplatform.com/v3/invoices \
>      -H "Authorization: <apiKey>" \
>      -d page=1 \
>      -d limit=50

200Retrieved

1 {
2   "payload": {
3     "data": [
4       {
5         "id": "123e4567-e89b-12d3-a456-426614174000",
6         "issueDate": "2021-01-01",
7         "dueDate": "2021-01-01",
8         "sentDate": "2021-01-01",
9         "createdAt": "2021-01-01",
10         "status": "DRAFT",
11         "invoiceNumber": "1234",
12         "memo": "A memo / note on the invoice",
13         "customFields": [
14           "string"
15         ],
16         "source": "TABS",
17         "customerId": "123e4567-e89b-12d3-a456-426614174000",
18         "originalDueDate": "2021-01-01",
19         "originalIssueDate": "2021-01-01",
20         "total": 100,
21         "balanceRemaining": 100,
22         "externalIds": [
23           {
24             "type": "QUICKBOOKS",
25             "id": "123e4567-e89b-12d3-a456-426614174000"
26           }
27         ],
28         "lineItems": [
29           {
30             "id": "123e4567-e89b-12d3-a456-426614174000",
31             "name": "Item 1",
32             "description": "string",
33             "quantity": 1,
34             "unitPrice": 100,
35             "subtotal": 110,
36             "discountTotal": 10,
37             "total": 100,
38             "salesTaxRate": "8.5",
39             "item": {
40               "id": "123e4567-e89b-12d3-a456-426614174000",
41               "name": "Item 1",
42               "displayName": "Item 1 (Annual)",
43               "externalIds": [
44                 {
45                   "type": "NETSUITE",
46                   "id": "123e4567-e89b-12d3-a456-426614174000"
47                 }
48               ]
49             }
50           }
51         ],
52         "paymentLink": "string",
53         "poNumber": "1234",
54         "paidOn": "2024-01-15T00:00:00.000Z",
55         "uncollectibleOn": "2024-02-01T00:00:00.000Z",
56         "lastUpdatedAt": "2024-01-01T00:00:00.000Z"
57       }
58     ],
59     "limit": 1.1,
60     "totalItems": 1.1,
61     "currentPage": 1.1
62   },
63   "success": true,
64   "message": "string",
65   "error": {
66     "code": 1.1,
67     "message": "string",
68     "details": {}
69   }
70 }

Authentication

Authorizationstring

API Key authentication via header

Query parameters

pagedoubleRequiredDefaults to 1

Page Number

limitdoubleRequiredDefaults to 50

Number of items to return

filterstringOptional

Format: field:rule:value — comma-separated for multiple filters.

Fields: customerId (uuid): eq, neq, in, nin, isnull, isnotnull total (number): eq, neq, gt, gte, lt, lte, in, nin contractId (uuid): eq, neq, in, nin, isnull, isnotnull obligationId (uuid): eq, neq, in, nin, isnull, isnotnull source (string): eq, neq, like, nlike, in, nin, isnull, isnotnull status (string): eq, neq, in, nin issueDate (datetime): eq, neq, gt, gte, lt, lte dueDate (datetime): eq, neq, gt, gte, lt, lte lastUpdatedAt (datetime): eq, neq, gt, gte, lt, lte

Date-only values (YYYY-MM-DD) match the full UTC day.

Example: filter=customerId:eq:00000000-0000-0000-0000-000000000001

Format: field:rule:value — comma-separated for multiple filters. Fields: customerId (uuid): eq, neq, in, nin, isnull, isnotnull total (number): eq, neq, gt, gte, lt, lte, in, nin contractId (uuid): eq, neq, in, nin, isnull, isnotnull obligationId (uuid): eq, neq, in, nin, isnull, isnotnull source (string): eq, neq, like, nlike, in, nin, isnull, isnotnull status (string): eq, neq, in, nin issueDate (datetime): eq, neq, gt, gte, lt, lte dueDate (datetime): eq, neq, gt, gte, lt, lte lastUpdatedAt (datetime): eq, neq, gt, gte, lt, lte Date-only values (YYYY-MM-DD) match the full UTC day. Example: filter=customerId:eq:00000000-0000-0000-0000-000000000001

Response

Get all Invoices by filter

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobject

json element with any error messages or warnings