Skip to main content
POST
/
payable_credit_notes
/
{credit_note_id}
/
line_items
Add a new line item to a credit note
curl --request POST \
  --url https://api.sandbox.monite.com/v1/payable_credit_notes/{credit_note_id}/line_items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "description": "Premium version of Product XYZ with extended warranty",
  "name": "Product XYZ",
  "quantity": 2,
  "tax": 1250,
  "unit": "pieces",
  "unit_price": 5000
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-01-15T14:30:00Z",
  "updated_at": "2024-01-15T14:30:00Z",
  "credit_note_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_by_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "description": "Premium version of Product XYZ with extended warranty",
  "name": "Product XYZ",
  "quantity": 2,
  "subtotal": 10000,
  "tax": 20,
  "tax_amount": 2000,
  "total": 12000,
  "unit": "pieces",
  "unit_price": 5000
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

​
credit_note_id
string<uuid>
required

Body

application/json

Schema for creating a new credit note line item.

​
description
string

Detailed description of the line item

Example:

"Premium version of Product XYZ with extended warranty"

​
name
string

Name or title of the line item

Example:

"Product XYZ"

​
quantity
number

Quantity of items

Required range: x >= 0
Example:

2

​
tax
integer

VAT rate in percent minor units. Example: 12.5% is 1250.

Required range: x <= 10000
Example:

1250

​
unit
string

Unit of measurement

Example:

"pieces"

​
unit_price
integer

Price per unit in smallest currency unit (e.g. cents)

Example:

5000

Response

Successful Response

Schema for credit note line item response. Includes all fields that can be returned from the API.

​
id
string<uuid>
required

Unique identifier of the line item

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
created_at
string<date-time>
required

Timestamp when the line item was created

Example:

"2024-01-15T14:30:00Z"

​
updated_at
string<date-time>
required

Timestamp when the line item was last updated

Example:

"2024-01-15T14:30:00Z"

​
credit_note_id
string<uuid>
required

ID of the parent credit note

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
created_by_user_id
string<uuid>

ID of the user who created the line item

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
description
string

Detailed description of the line item

Example:

"Premium version of Product XYZ with extended warranty"

​
name
string

Name or title of the line item

Example:

"Product XYZ"

​
quantity
number

Quantity of items

Required range: x >= 0
Example:

2

​
subtotal
integer

Subtotal amount before tax

Example:

10000

​
tax
integer

Tax percentage

Required range: x >= 0
Example:

20

​
tax_amount
integer

Tax amount

Example:

2000

​
total
integer

Total amount including tax

Example:

12000

​
unit
string

Unit of measurement

Example:

"pieces"

​
unit_price
integer

Price per unit in smallest currency unit

Example:

5000