Skip to main content
POST
/
v1
/
admin
/
finance
/
invoices
/
{id}
/
credit-notes
/
{creditNoteId}
/
line-items
Add a credit note line item
curl --request POST \
  --url https://{operatorDomain}/v1/admin/finance/invoices/{id}/credit-notes/{creditNoteId}/line-items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "invoiceId": "<string>",
  "description": "<string>",
  "totalCents": 119000,
  "currency": "<string>",
  "quantity": 1,
  "unitPriceCents": 100000,
  "taxRateBasisPoints": 1900
}
'
{
  "data": {
    "id": "<string>",
    "invoiceId": "<string>",
    "description": "<string>",
    "totalCents": 119000,
    "currency": "<string>",
    "quantity": 1,
    "unitPriceCents": 100000,
    "taxRateBasisPoints": 1900
  }
}

Authorizations

​
Authorization
string
header
required

Staff session or API token issued by your Voyant app.

Path Parameters

​
id
string
required
​
creditNoteId
string
required

Body

application/json
​
id
string
required
​
invoiceId
string
required
​
description
string
required
​
totalCents
integer
required
Example:

119000

​
currency
string
required
Required string length: 3
​
quantity
number
Example:

1

​
unitPriceCents
integer
Example:

100000

​
taxRateBasisPoints
integer | null
Example:

1900

Response

201 - application/json

Created line item

​
data
object