PUT
/
api
/
bill-payments
/
{billPaymentId}

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

Body

application/json
vendorId
number
required

The id of the vendor

Example:

1

amount
number
required

The amount of the bill payment

Example:

100

paymentAccountId
number
required

The id of the payment account

Example:

1

paymentNumber
string
required

The payment number of the bill payment

Example:

"123456"

paymentDate
object
required

The payment date of the bill payment

Example:

"2021-01-01"

exchangeRate
number
required

The exchange rate of the bill payment

Example:

1

statement
string
required

The statement of the bill payment

Example:

"123456"

entries
string[]
required

The entries of the bill payment

Example:
[{ "billId": 1, "paymentAmount": 100 }]
branchId
number
required

The id of the branch

Example:

1

attachments
string[]
required

The attachments of the bill payment

Example:
[{ "id": 1, "type": "bill" }]