Skip to main content
POST
/
api
/
credit-notes
/
{creditNoteId}
/
apply-invoices
Apply credit note to invoices
curl --request POST \
  --url https://api.example.com/api/credit-notes/{creditNoteId}/apply-invoices \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "entries": [
    {
      "invoice_id": 1,
      "amount": 100.5
    },
    {
      "invoice_id": 2,
      "amount": 50
    }
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.bigcapital.app/llms.txt

Use this file to discover all available pages before exploring further.

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.

Path Parameters

​
creditNoteId
number
required

Body

application/json
​
entries
object[]
required

Entries of invoice ID and amount to apply

Example:
[
  { "invoice_id": 1, "amount": 100.5 },
  { "invoice_id": 2, "amount": 50 }
]

Response

Credit note successfully applied to invoices