Skip to main content
POST
/
api
/
payments-received
Create a new payment received.
curl --request POST \
  --url https://api.example.com/api/payments-received \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "customerId": 1,
  "paymentDate": "2021-01-01",
  "amount": 100,
  "exchangeRate": 1,
  "referenceNo": "123456",
  "depositAccountId": 1,
  "paymentReceiveNo": "123456",
  "statement": "123456",
  "entries": [
    {
      "invoiceId": 1,
      "paymentAmount": 100
    }
  ],
  "branchId": 1,
  "attachments": [
    {
      "id": 1,
      "type": "bill"
    }
  ]
}
'

Headers

​
Authorization
string
required

Value must be 'Bearer ' where 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" }]

Response

201 - undefined