API reference

Credit notes

What customers are credited: issued against the invoice they correct, or kept as credit to apply to later invoices.

GET/v1/credit_notesList credit notes
POST/v1/credit_notesWrite a draft credit note
GET/v1/credit_notes/{credit_note_id}Get a credit note
PATCH/v1/credit_notes/{credit_note_id}Change a draft credit note
DELETE/v1/credit_notes/{credit_note_id}Delete a draft credit note
POST/v1/credit_notes/{credit_note_id}/applyApply a credit note to invoices
POST/v1/credit_notes/{credit_note_id}/issueIssue a credit note onto the books
POST/v1/credit_notes/{credit_note_id}/voidVoid an issued credit note

Guides: Bill customers with invoices

List credit notes

GET/v1/credit_notes

client.creditNotes.list()

The credit notes of these books, the newest first, each with what it is applied to and what is left.

Parameters

Name	Type	Description
`status`Query	string or null	Only `draft`, `issued` or `void` credit notes.
`party_id`Query	string or null	An id that starts with `party_`.
`limit`Query	integer	Page size, 1–200. Default 50
`cursor`Query	string or null	The `next_cursor` of the previous page.

Response

200CreditNotePage

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl "https://api.ledgerit.ai/v1/credit_notes" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Write a draft credit note

POST/v1/credit_notes· Idempotent

client.creditNotes.create()

Write a draft credit note for a customer, for an invoice it corrects or on its own. Nothing is on the books until it is issued.

Request body

CreditNoteCreate

Response

201CreditNoteOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X POST "https://api.ledgerit.ai/v1/credit_notes" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"issue_date":"2026-09-30","lines":[{"account_id":"…","description":"…","unit_price":0}],"party_id":"…"}'

Get a credit note

GET/v1/credit_notes/{credit_note_id}

client.creditNotes.get()

One credit note, its lines, what it is applied to and what is left.

Parameters

Name	Type	Description
`credit_note_id`Path · Required	string	An id that starts with `cn_`.

Response

200CreditNoteOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl "https://api.ledgerit.ai/v1/credit_notes/{credit_note_id}" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

Change a draft credit note

PATCH/v1/credit_notes/{credit_note_id}· Idempotent

client.creditNotes.update()

Change a draft. An issued credit note is refused with conflict.

Parameters

Name	Type	Description
`credit_note_id`Path · Required	string	An id that starts with `cn_`.

Request body

CreditNoteUpdate

Response

200CreditNoteOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X PATCH "https://api.ledgerit.ai/v1/credit_notes/{credit_note_id}" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

Delete a draft credit note

DELETE/v1/credit_notes/{credit_note_id}· Idempotent

client.creditNotes.delete()

Delete a draft. An issued credit note is voided instead.

Parameters

Name	Type	Description
`credit_note_id`Path · Required	string	An id that starts with `cn_`.

Response

204No content

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X DELETE "https://api.ledgerit.ai/v1/credit_notes/{credit_note_id}" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Apply a credit note to invoices

POST/v1/credit_notes/{credit_note_id}/apply· Idempotent

client.creditNotes.apply()

Apply what is left of an issued credit note to the customer's invoices: those listed, or the oldest first.

Parameters

Name	Type	Description
`credit_note_id`Path · Required	string	An id that starts with `cn_`.

Request body

CreditNoteApply

Response

200CreditNoteOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X POST "https://api.ledgerit.ai/v1/credit_notes/{credit_note_id}/apply" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

Issue a credit note onto the books

POST/v1/credit_notes/{credit_note_id}/issue· Idempotent

client.creditNotes.issue()

Put a draft on the books: each line against the total off the customer's receivable. A credit note that corrects an invoice is applied to it at once, as far as the invoice is still open.

Parameters

Name	Type	Description
`credit_note_id`Path · Required	string	An id that starts with `cn_`.

Response

200CreditNoteOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X POST "https://api.ledgerit.ai/v1/credit_notes/{credit_note_id}/issue" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Void an issued credit note

POST/v1/credit_notes/{credit_note_id}/void· Idempotent

client.creditNotes.void()

Take an issued credit note off the books by reversing its entry. Refused with conflict while any of it is applied.

Parameters

Name	Type	Description
`credit_note_id`Path · Required	string	An id that starts with `cn_`.

Request body

CreditNoteVoid

Response

200CreditNoteOut

Errors

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

Example

curl

curl -X POST "https://api.ledgerit.ai/v1/credit_notes/{credit_note_id}/void" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

Objects

The objects these operations take and return.

CreditNotePage

Name	Type	Description
`data`Required	array of CreditNoteOut
`has_more`Required	boolean
`next_cursor`Required	string or null

CreditNoteCreate

Name	Type	Description
`issue_date`Required	string (date)
`lines`Required	array of CreditNoteLineIn
`memo`	string or null
`number`	string or null	Unique in these books; the next CN-0001-style number when left out.
`original_invoice_id`	string or null	An id that starts with `inv_`.
`party_id`Required	string	The customer: a counterparty of these books.

CreditNoteOut

Name	Type	Description
`applied_to`Required	array of CreditAppliedOut
`created_at`Required	string (date-time)
`currency`Required	string
`customer_name`Required	string or null
`entry_id`Required	string or null	An id that starts with `je_`.
`id`Required	string	An id that starts with `cn_`.
`issue_date`Required	string (date)
`issued_at`Required	string (date-time) or null
`lines`Required	array of CreditNoteLineOut
`memo`Required	string or null
`number`Required	string
`original_invoice_id`Required	string or null	An id that starts with `inv_`.
`party_id`Required	string	An id that starts with `party_`.
`row_version`Required	integer
`status`Required	string	`draft`, `issued` or `void`.
`subtotal`Required	string
`tax_total`Required	string
`total`Required	string
`unapplied`Required	string	What is left of the credit to apply; 0 for a draft or a void credit note.
`void_entry_id`Required	string or null	An id that starts with `je_`.
`voided_at`Required	string (date-time) or null

CreditNoteUpdate

Name	Type	Description
`issue_date`	string (date) or null
`lines`	array of CreditNoteLineIn or null
`memo`	string or null
`number`	string or null
`original_invoice_id`	string or null	An id that starts with `inv_`.
`party_id`	string or null	An id that starts with `party_`.

CreditNoteApply

Name	Type	Description
`invoice_ids`	array of string or null	The customer's invoices to apply it to; the oldest first when left out.

CreditNoteVoid

Name	Type	Description
`reason`	string or null

CreditNoteLineIn

Name	Type	Description
`account_id`Required	string	The income (or deferred revenue) account it comes off.
`description`Required	string	What is credited, as the customer reads it.
`quantity`	number \| string	Default 1
`service_end`	string (date) or null
`service_start`	string (date) or null
`tax_amount`	number \| string	Must be 0 until tax is supported. Default 0
`unit_price`Required	number \| string

CreditAppliedOut

Name	Type	Description
`amount`Required	string
`invoice_id`Required	string	An id that starts with `inv_`.
`number`Required	string

CreditNoteLineOut

Name	Type	Description
`account_id`Required	string	An id that starts with `gla_`.
`amount`Required	string
`description`Required	string
`line_no`Required	integer
`quantity`Required	string
`service_end`Required	string (date) or null
`service_start`Required	string (date) or null
`tax_amount`Required	string
`unit_price`Required	string