customers

Perform invoice action

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.

SEND always returns 201 with a job message. MARK_INVOICE_AS_VOID returns 201 with a job message when void runs asynchronously, or 200 with the invoice payload when it still runs synchronously. Poll GET /v3/jobs/:jobId for async job status.

post/v3/customers/{id}/invoices/{invoiceId}/actions

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v3/customers/{id}/invoices/{invoiceId}/actions
  • Auth: API key in header Authorization

Path parameters

idstring required

Customer Id

invoiceIdstring required

Invoice Id

Request body

OR
OR
OR
OR
OR

Response

Synchronous invoice action completed. Returned for MARK_INVOICE_AS_PENDING, MARK_INVOICE_TO_SENT_OFF_TABS, MARK_INVOICE_AS_SCHEDULED, SEND_REMINDER_EMAIL, and MARK_INVOICE_AS_VOID when void still runs synchronously.

payloadV3CustomersIdInvoicesInvoiceIdActionsPostResponsesContentApplicationJsonSchemaPayload required

Response payload, will be empty when success is false

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Changes

No recorded changes to this operation across all 1 revision of this API.