GET
/
api
/
bill-payments
/
{billPaymentId}
{
  "id": 1,
  "vendorId": 1,
  "amount": 100,
  "currencyCode": "USD",
  "paymentAccountId": 2,
  "paymentNumber": "PAY-2024-001",
  "paymentDate": "2024-01-01",
  "formattedPaymentDate": "2024-01-01",
  "exchangeRate": 1,
  "statement": "Payment for January bills",
  "reference": "REF-123",
  "branchId": 1,
  "formattedAmount": "100.00 USD",
  "createdAt": "2024-01-01T12:00:00Z",
  "formattedCreatedAt": "2024-01-01",
  "updatedAt": "2024-01-02T12:00:00Z",
  "entries": [
    {
      "paymentAmountFormatted": "100.00",
      "bill": {
        "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"
      }
    }
  ],
  "attachments": [
    {}
  ]
}

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

​
billPaymentId
number
required

The bill payment id

Response

200 - application/json

The bill payment details have been successfully retrieved.

​
id
number
required

The unique identifier of the bill payment

Example:

1

​
vendorId
number
required

The vendor ID

Example:

1

​
amount
number
required

The amount paid

Example:

100

​
paymentAccountId
number
required

The payment account ID

Example:

2

​
paymentDate
string
required

The payment date

Example:

"2024-01-01"

​
formattedPaymentDate
string
required

The formatted payment date

Example:

"2024-01-01"

​
formattedAmount
string
required

The formatted amount

Example:

"100.00 USD"

​
createdAt
string<date-time>
required

The date when the payment was created

Example:

"2024-01-01T12:00:00Z"

​
formattedCreatedAt
string
required

The formatted created at date

Example:

"2024-01-01"

​
entries
object[]
required

The entries of the bill payment

​
currencyCode
string

The currency code

Example:

"USD"

​
paymentNumber
string

The payment number

Example:

"PAY-2024-001"

​
exchangeRate
number

The exchange rate

Example:

1

​
statement
string

Statement or note

Example:

"Payment for January bills"

​
reference
string

Reference number

Example:

"REF-123"

​
branchId
number

The branch ID

Example:

1

​
updatedAt
string<date-time>

The date when the payment was last updated

Example:

"2024-01-02T12:00:00Z"

​
attachments
object[]

The attachments of the bill payment