v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB
Customers

Get customer invoice by ID

get/v3/customers/{id}/invoices/{invoiceId}

Path parameters

idstring required
Example:123e4567-e89b-12d3-a456-426614174000

Customer Id

invoiceIdstring required
Example:123e4567-e89b-12d3-a456-426614174000

Invoice Id

Response

The invoice

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "issueDate": "2021-01-01",
    "dueDate": "2021-01-01",
    "sentDate": "2021-01-01",
    "createdAt": "2021-01-01",
    "status": "DRAFT",
    "invoiceNumber": "1234",
    "memo": "A memo / note on the invoice",
    "customFields": [
      {
        "name": "Custom Field 1",
        "value": "A value for the custom field"
      }
    ],
    "source": "TABS",
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "originalDueDate": "2021-01-01",
    "originalIssueDate": "2021-01-01",
    "total": 100,
    "balanceRemaining": 100,
    "externalIds": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "customer"
      }
    ],
    "lineItems": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Item 1",
        "quantity": 1,
        "unitPrice": 100,
        "subtotal": 110,
        "discountTotal": 10,
        "total": 100,
        "salesTaxRate": "8.5",
        "item": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Item 1",
          "displayName": "Item 1 (Annual)",
          "externalIds": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ]
        }
      }
    ],
    "poNumber": "1234",
    "paidOn": "2024-01-15T00:00:00.000Z",
    "uncollectibleOn": "2024-02-01T00:00:00.000Z",
    "lastUpdatedAt": "2024-01-01T00:00:00.000Z"
  }
}