GET
/
api
/
bills
{
  "pagination": {
    "total": 100,
    "page": 1,
    "pageSize": 10
  },
  "data": [
    {
      "id": 1,
      "billNumber": "BILL-2024-001",
      "billDate": "2024-03-15T00:00:00Z",
      "dueDate": "2024-04-15T00:00:00Z",
      "referenceNo": "PO-2024-001",
      "vendorId": 1001,
      "exchangeRate": 1.25,
      "currencyCode": "USD",
      "note": "Office supplies and equipment for Q2 2024",
      "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
        }
      ],
      "warehouseId": 101,
      "branchId": 201,
      "projectId": 301,
      "attachments": [
        {}
      ],
      "discount": 100,
      "discountType": "amount",
      "adjustment": 50,
      "taxAmountWithheld": 50,
      "balance": 1000,
      "paymentAmount": 500,
      "creditedAmount": 0,
      "subtotal": 900,
      "total": 1000,
      "dueAmount": 500,
      "isOverdue": false,
      "isPartiallyPaid": true,
      "isFullyPaid": false,
      "createdAt": "2024-03-15T00:00:00Z",
      "updatedAt": "2024-03-16T00: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.

Path Parameters

id
number
required

The bill id

Response

200 - application/json

The bill details has been retrieved successfully

The response is of type object.