GET
/
api
/
sale-invoices
{
  "pagination": {
    "total": 100,
    "page": 1,
    "pageSize": 10
  },
  "data": [
    {
      "id": 1,
      "invoiceDate": "2023-01-01T00:00:00Z",
      "dueDate": "2023-01-15T00:00:00Z",
      "invoiceNo": "INV-001",
      "referenceNo": "REF-001",
      "customerId": 1,
      "exchangeRate": 1,
      "currencyCode": "USD",
      "invoiceMessage": "Thank you for your business",
      "termsConditions": "Payment due within 14 days",
      "isInclusiveTax": false,
      "entries": [
        {
          "index": 1,
          "itemId": 1,
          "rate": 1,
          "quantity": 1,
          "discount": 1,
          "discountType": "percentage",
          "description": "This is a description",
          "taxCode": "123456",
          "taxRateId": 1,
          "warehouseId": 1,
          "projectId": 1,
          "projectRefId": 1,
          "projectRefType": "TASK",
          "projectRefInvoicedAmount": 100,
          "sellAccountId": 1020,
          "costAccountId": 1021
        }
      ],
      "delivered": false,
      "deliveredAt": "2023-01-02T00:00:00Z",
      "warehouseId": 1,
      "branchId": 1,
      "projectId": 1,
      "attachments": [
        {}
      ],
      "paymentMethods": [
        {
          "paymentIntegrationId": 1,
          "enable": true
        }
      ],
      "discount": 10,
      "discountType": "percentage",
      "adjustment": 5,
      "pdfTemplateId": 1,
      "taxAmountWithheld": 50,
      "balance": 1000,
      "paymentAmount": 500,
      "creditedAmount": 0,
      "subtotal": 900,
      "total": 1000,
      "dueAmount": 500,
      "isOverdue": false,
      "isPartiallyPaid": true,
      "isFullyPaid": false,
      "createdAt": "2023-01-01T00:00:00Z",
      "updatedAt": "2023-01-02T00:00:00Z"
    }
  ]
}

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Response

200 - application/json

The sale invoices have been successfully retrieved.

The response is of type object.