Perform invoice action

POST

https://integrators.prod.api.tabsplatform.com/v3/customers/:id/invoices/:invoiceId/actions

POST

/v3/customers/:id/invoices/:invoiceId/actions

$ curl -X POST https://integrators.prod.api.tabsplatform.com/v3/customers/123e4567-e89b-12d3-a456-426614174000/invoices/123e4567-e89b-12d3-a456-426614174000/actions \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "action": "SEND",
>   "sendToErp": true,
>   "sendToCustomer": true,
>   "overrideInvoiceDate": true
> }'

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

Performs an action on an invoice. See the request body for the available actions.

SEND emails the customer only the first time. On an invoice already emailed, the customer email is skipped and the response carries “customerEmailSkipped”: “ALREADY_EMAILED”; any requested ERP push still runs. Use SEND_REMINDER_EMAIL to send a payment reminder.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Customer Id

invoiceIdstringRequired

Invoice Id

Request

Invoice actions for sending an invoice. Validation rules:

At least one of sendToErp or sendToCustomer must be true
sendToErp can be true while sendToCustomer is false (push to ERP only)
sendToCustomer can be true while sendToErp is false (email customer only; useful when no ERP is connected)
If sendToErp is true but the merchant has no ERP integration connected, the request is rejected
the field overrideInvoiceDate is optional

Invoice actions for sending an invoice. Validation rules: 1. At least one of sendToErp or sendToCustomer must be true 2. sendToErp can be true while sendToCustomer is false (push to ERP only) 3. sendToCustomer can be true while sendToErp is false (email customer only; useful when no ERP is connected) 4. If sendToErp is true but the merchant has no ERP integration connected, the request is rejected 5. the field overrideInvoiceDate is optional

SendInvoiceDtoobjectRequired

MarkInvoiceAsPendingDtoobjectRequired

MarkInvoiceToSentOffTabsDtoobjectRequired

MarkInvoiceAsScheduledDtoobjectRequired

MarkInvoiceAsVoidDtoobjectRequired

SendReminderEmailDtoobjectRequired

Response

Invoice marked as pending or sent off Tabs successfully

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobjectOptional

json element with any error messages or warnings

Errors

400

Bad Request Error

500

Internal Server Error