POST
/
api
/
payments-received

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.

Body

application/json
customerId
number
required

The id of the customer

Example:

1

paymentDate
object
required

The payment date of the payment received

Example:

"2021-01-01"

amount
number
required

The amount of the payment received

Example:

100

exchangeRate
number
required

The exchange rate of the payment received

Example:

1

referenceNo
string
required

The reference number of the payment received

Example:

"123456"

depositAccountId
number
required

The id of the deposit account

Example:

1

paymentReceiveNo
string
required

The payment receive number of the payment received

Example:

"123456"

statement
string
required

The statement of the payment received

Example:

"123456"

entries
string[]
required

The entries of the payment received

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

The id of the branch

Example:

1

attachments
string[]
required

The attachments of the payment received

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