Credit Notes

Download schema

List credit notes

GET

https://api.ledgerbee.com/api

/v1/credit-notes

x-api-key (header)

OAuth 2.0

Returns a paginated list of credit notes for your company, optionally filtered by status and customer.

List credit notes › query Parameters

page

number · min: 1

Page number (1-indexed)

Example: 1

Default: 1

limit

number · min: 1 · max: 100

Number of items per page

Example: 25

Default: 25

search

string

Free-text search (credit note number, description)

status

string · enum

Filter credit notes by status

Enum values:

draft

scheduled

sending

sent

customerId

string

Filter credit notes for a specific customer

Example: 0197A943-2325-7829-B835-B6C71A293065

List credit notes › Responses

Paginated list of credit notes

PublicListCreditNotesResponse

PublicCreditNoteListItem[] · required

Credit notes on this page (line items omitted; GET one for lines)

total

number · required

Total credit notes matching the query

Example: 42

page

number · required

Current page (1-indexed)

Example: 1

limit

number · required

Items per page

Example: 25

totalPages

number · required

Total pages

Example: 2

Create a credit note

POST

https://api.ledgerbee.com/api

/v1/credit-notes

x-api-key (header)

OAuth 2.0

Creates a credit note. Pass invoiceNumber to credit an existing invoice; the referenced invoice is then marked credited.

Create a credit note › Request Body

PublicCreateCreditNote

customerId

string · required

Customer ID this credit note is for

Example: 0197A943-2325-7829-B835-B6C71A293065

date

string · required

Credit note date (ISO date, YYYY-MM-DD)

Example: 2024-01-15

PublicCreateCreditNoteLine[] · required

Credit note lines

customerDepartmentId

string

Customer department ID (for EAN-based e-invoicing and address override)

Example: 0197A943-2325-7829-B835-B6C71A293065

customerContactId

string

Customer contact ID (credit note recipient)

Example: 0197A943-2325-7829-B835-B6C71A293065

invoiceNumber

string

Original invoice number this credit note credits. When set, the referenced invoice is marked credited.

Example: 1

currency

string

Currency code (ISO 4217). Defaults to the company default currency.

Example: DKK

reference

string

Reference / PO number ("PO-nr.")

Example: PO-12345

ourReference

string

Our reference ("Vores ref.")

Example: Jane Doe

description

string

Optional description of the credit note

Example: Credit for returned items

notes

string

Additional notes or comments

Example: Credit issued due to product defect

Create a credit note › Responses

Credit note created successfully

PublicCreditNote

id

string · required

Credit note ID

Example: 0197A943-2325-7829-B835-B6C71A293065

number

string · required

Credit note number

Example: 1

status

string · enum · required

Credit note status

Enum values:

draft

scheduled

sending

sent

Example: sent

date

string · required

Credit note date (ISO date)

Example: 2024-01-15

currency

string · required

Currency code (ISO 4217)

Example: DKK

subtotal

string · required

Subtotal before VAT (decimal string)

Example: 2166.65

vat

string · required

VAT amount (decimal string)

Example: 541.66

amount

string · required

Total amount including VAT (decimal string)

Example: 2708.31

PublicCreditNoteLine[] · required

Credit note lines

createdAt

string · required

Creation timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

updatedAt

string · required

Last update timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

invoiceNumber

string | null

Original invoice number this credit note credits

customerId

string | null

Customer ID

reference

string | null

Reference / PO number

ourReference

string | null

Our reference ("Vores ref.")

notes

string | null

Additional notes

POST/v1/credit-notes

curl https://api.ledgerbee.com/api/v1/credit-notes \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "customerId": "0197A943-2325-7829-B835-B6C71A293065",
  "customerDepartmentId": "0197A943-2325-7829-B835-B6C71A293065",
  "customerContactId": "0197A943-2325-7829-B835-B6C71A293065",
  "invoiceNumber": "1",
  "date": "2024-01-15",
  "currency": "DKK",
  "reference": "PO-12345",
  "ourReference": "Jane Doe",
  "description": "Credit for returned items",
  "notes": "Credit issued due to product defect",
  "lines": [
    {
      "priceId": "0197A943-2325-7829-B835-B6C71A293065",
      "lineType": "subscription",
      "description": "Premium widget - Blue color - Return",
      "quantity": 2,
      "unitPrice": "1083.32"
    }
  ]
}'

Example Request Body

{
  "customerId": "0197A943-2325-7829-B835-B6C71A293065",
  "customerDepartmentId": "0197A943-2325-7829-B835-B6C71A293065",
  "customerContactId": "0197A943-2325-7829-B835-B6C71A293065",
  "invoiceNumber": "1",
  "date": "2024-01-15",
  "currency": "DKK",
  "reference": "PO-12345",
  "ourReference": "Jane Doe",
  "description": "Credit for returned items",
  "notes": "Credit issued due to product defect",
  "lines": [
    {
      "priceId": "0197A943-2325-7829-B835-B6C71A293065",
      "lineType": "subscription",
      "description": "Premium widget - Blue color - Return",
      "quantity": 2,
      "unitPrice": "1083.32"
    }
  ]
}

json

Example Responses

{
  "id": "0197A943-2325-7829-B835-B6C71A293065",
  "number": "1",
  "invoiceNumber": "invoiceNumber",
  "status": "sent",
  "date": "2024-01-15",
  "customerId": "customerId",
  "currency": "DKK",
  "subtotal": "2166.65",
  "vat": "541.66",
  "amount": "2708.31",
  "reference": "reference",
  "ourReference": "ourReference",
  "notes": "notes",
  "lines": [
    {
      "id": "0197A943-2325-7829-B835-B6C71A293065",
      "priceId": "priceId",
      "description": "description",
      "lineType": "subscription",
      "quantity": 2,
      "unitPrice": "1083.32",
      "totalPrice": "2166.65",
      "vatAmount": "vatAmount",
      "vatRate": "vatRate"
    }
  ],
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

json

application/json

Get a credit note by ID

GET

https://api.ledgerbee.com/api

/v1/credit-notes/{id}

x-api-key (header)

OAuth 2.0

Retrieves a single credit note by its unique identifier. Returns 404 when the credit note does not exist in your company. For the rendered document, use the PDF endpoint.

Required Scope

invoices-read

Get a credit note by ID › path Parameters

id

string · required

Credit Note ID

Get a credit note by ID › Responses

The credit note

PublicCreditNote

id

string · required

Credit note ID

Example: 0197A943-2325-7829-B835-B6C71A293065

number

string · required

Credit note number

Example: 1

status

string · enum · required

Credit note status

Enum values:

draft

scheduled

sending

sent

Example: sent

date

string · required

Credit note date (ISO date)

Example: 2024-01-15

currency

string · required

Currency code (ISO 4217)

Example: DKK

subtotal

string · required

Subtotal before VAT (decimal string)

Example: 2166.65

vat

string · required

VAT amount (decimal string)

Example: 541.66

amount

string · required

Total amount including VAT (decimal string)

Example: 2708.31

PublicCreditNoteLine[] · required

Credit note lines

createdAt

string · required

Creation timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

updatedAt

string · required

Last update timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

invoiceNumber

string | null

Original invoice number this credit note credits

customerId

string | null

Customer ID

reference

string | null

Reference / PO number

ourReference

string | null

Our reference ("Vores ref.")

notes

string | null

Additional notes

GET/v1/credit-notes/{id}

curl https://api.ledgerbee.com/api/v1/credit-notes/:id \
  --header 'x-api-key: <api-key>'

Example Responses

{
  "id": "0197A943-2325-7829-B835-B6C71A293065",
  "number": "1",
  "invoiceNumber": "invoiceNumber",
  "status": "sent",
  "date": "2024-01-15",
  "customerId": "customerId",
  "currency": "DKK",
  "subtotal": "2166.65",
  "vat": "541.66",
  "amount": "2708.31",
  "reference": "reference",
  "ourReference": "ourReference",
  "notes": "notes",
  "lines": [
    {
      "id": "0197A943-2325-7829-B835-B6C71A293065",
      "priceId": "priceId",
      "description": "description",
      "lineType": "subscription",
      "quantity": 2,
      "unitPrice": "1083.32",
      "totalPrice": "2166.65",
      "vatAmount": "vatAmount",
      "vatRate": "vatRate"
    }
  ],
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

json

application/json

Get the delivery status of a credit note

GET

https://api.ledgerbee.com/api

/v1/credit-notes/{id}/delivery-status

x-api-key (header)

OAuth 2.0

Returns an aggregate send summary plus a per-attempt delivery log for the credit note.

Get the delivery status of a credit note › path Parameters

id

string · required

Credit Note ID

Get the delivery status of a credit note › Responses

Delivery status

PublicDeliveryStatusResponse

object · required

Aggregate send summary

PublicDeliveryLogEntry[] · required

Per-attempt delivery log entries

Download the credit note PDF

GET

https://api.ledgerbee.com/api

/v1/credit-notes/{id}/pdf

x-api-key (header)

OAuth 2.0

Streams the rendered credit note PDF. Pass draft=true to render a draft watermark version (generated on the fly).

Download the credit note PDF › path Parameters

id

string · required

Credit Note ID

Download the credit note PDF › query Parameters

draft

boolean

Render a draft watermark version

Download the credit note PDF › Responses

Bad Request

statusCode

number

timestamp

string

path

string

message

string

Send a credit note to the customer

POST

https://api.ledgerbee.com/api

/v1/credit-notes/{id}/send

x-api-key (header)

OAuth 2.0

Sends the credit note over the chosen delivery channel (Email, Sproom e-invoicing, or Manual).

Send a credit note to the customer › path Parameters

id

string · required

Credit Note ID

Send a credit note to the customer › Request Body

PublicSendCreditNote

deliveryType

string · enum · required

Delivery channel

Enum values:

Sproom

Manual

Example: Email

overrideEmail

string

Override recipient email for this send only

overrideEanNumber

string

Override EAN number for this send only

updateCustomerRecord

boolean

Persist the override email / EAN onto the customer record

Default: false

documentTemplateId

string

Override document template for PDF generation

Send a credit note to the customer › Responses

Credit note send accepted

PublicSendInvoiceResponse

success

boolean · required

Whether the send was accepted

Example: true

deliveryType

string · enum · required

The delivery channel the document was sent through

Enum values:

Sproom

Manual

Example: Email

sproomDocumentId

string | null

Sproom document ID when sent via e-invoicing

POST/v1/credit-notes/{id}/send

curl https://api.ledgerbee.com/api/v1/credit-notes/:id/send \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "deliveryType": "Email",
  "overrideEmail": "overrideEmail",
  "overrideEanNumber": "overrideEanNumber",
  "updateCustomerRecord": false,
  "documentTemplateId": "documentTemplateId"
}'

Example Request Body

{
  "deliveryType": "Email",
  "overrideEmail": "overrideEmail",
  "overrideEanNumber": "overrideEanNumber",
  "updateCustomerRecord": false,
  "documentTemplateId": "documentTemplateId"
}

json

Example Responses

{
  "success": true,
  "deliveryType": "Email",
  "sproomDocumentId": "sproomDocumentId"
}

json

application/json

Portal SSO Payment Methods

LedgerBee Public API

Credit Notes

Download schema

List credit notes

GET

https://api.ledgerbee.com/api

/v1/credit-notes

x-api-key (header)

OAuth 2.0

Returns a paginated list of credit notes for your company, optionally filtered by status and customer.

List credit notes › query Parameters

page

number · min: 1

Page number (1-indexed)

Example: 1

Default: 1

limit

number · min: 1 · max: 100

Number of items per page

Example: 25

Default: 25

search

string

Free-text search (credit note number, description)

status

string · enum

Filter credit notes by status

Enum values:

draft

scheduled

sending

sent

customerId

string

Filter credit notes for a specific customer

Example: 0197A943-2325-7829-B835-B6C71A293065

List credit notes › Responses

Paginated list of credit notes

PublicListCreditNotesResponse

PublicCreditNoteListItem[] · required

Credit notes on this page (line items omitted; GET one for lines)

total

number · required

Total credit notes matching the query

Example: 42

page

number · required

Current page (1-indexed)

Example: 1

limit

number · required

Items per page

Example: 25

totalPages

number · required

Total pages

Example: 2

Create a credit note

POST

https://api.ledgerbee.com/api

/v1/credit-notes

x-api-key (header)

OAuth 2.0

Creates a credit note. Pass invoiceNumber to credit an existing invoice; the referenced invoice is then marked credited.

Create a credit note › Request Body

PublicCreateCreditNote

customerId

string · required

Customer ID this credit note is for

Example: 0197A943-2325-7829-B835-B6C71A293065

date

string · required

Credit note date (ISO date, YYYY-MM-DD)

Example: 2024-01-15

PublicCreateCreditNoteLine[] · required

Credit note lines

customerDepartmentId

string

Customer department ID (for EAN-based e-invoicing and address override)

Example: 0197A943-2325-7829-B835-B6C71A293065

customerContactId

string

Customer contact ID (credit note recipient)

Example: 0197A943-2325-7829-B835-B6C71A293065

invoiceNumber

string

Original invoice number this credit note credits. When set, the referenced invoice is marked credited.

Example: 1

currency

string

Currency code (ISO 4217). Defaults to the company default currency.

Example: DKK

reference

string

Reference / PO number ("PO-nr.")

Example: PO-12345

ourReference

string

Our reference ("Vores ref.")

Example: Jane Doe

description

string

Optional description of the credit note

Example: Credit for returned items

notes

string

Additional notes or comments

Example: Credit issued due to product defect

Create a credit note › Responses

Credit note created successfully

PublicCreditNote

id

string · required

Credit note ID

Example: 0197A943-2325-7829-B835-B6C71A293065

number

string · required

Credit note number

Example: 1

status

string · enum · required

Credit note status

Enum values:

draft

scheduled

sending

sent

Example: sent

date

string · required

Credit note date (ISO date)

Example: 2024-01-15

currency

string · required

Currency code (ISO 4217)

Example: DKK

subtotal

string · required

Subtotal before VAT (decimal string)

Example: 2166.65

vat

string · required

VAT amount (decimal string)

Example: 541.66

amount

string · required

Total amount including VAT (decimal string)

Example: 2708.31

PublicCreditNoteLine[] · required

Credit note lines

createdAt

string · required

Creation timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

updatedAt

string · required

Last update timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

invoiceNumber

string | null

Original invoice number this credit note credits

customerId

string | null

Customer ID

reference

string | null

Reference / PO number

ourReference

string | null

Our reference ("Vores ref.")

notes

string | null

Additional notes

POST/v1/credit-notes

curl https://api.ledgerbee.com/api/v1/credit-notes \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "customerId": "0197A943-2325-7829-B835-B6C71A293065",
  "customerDepartmentId": "0197A943-2325-7829-B835-B6C71A293065",
  "customerContactId": "0197A943-2325-7829-B835-B6C71A293065",
  "invoiceNumber": "1",
  "date": "2024-01-15",
  "currency": "DKK",
  "reference": "PO-12345",
  "ourReference": "Jane Doe",
  "description": "Credit for returned items",
  "notes": "Credit issued due to product defect",
  "lines": [
    {
      "priceId": "0197A943-2325-7829-B835-B6C71A293065",
      "lineType": "subscription",
      "description": "Premium widget - Blue color - Return",
      "quantity": 2,
      "unitPrice": "1083.32"
    }
  ]
}'

Example Request Body

{
  "customerId": "0197A943-2325-7829-B835-B6C71A293065",
  "customerDepartmentId": "0197A943-2325-7829-B835-B6C71A293065",
  "customerContactId": "0197A943-2325-7829-B835-B6C71A293065",
  "invoiceNumber": "1",
  "date": "2024-01-15",
  "currency": "DKK",
  "reference": "PO-12345",
  "ourReference": "Jane Doe",
  "description": "Credit for returned items",
  "notes": "Credit issued due to product defect",
  "lines": [
    {
      "priceId": "0197A943-2325-7829-B835-B6C71A293065",
      "lineType": "subscription",
      "description": "Premium widget - Blue color - Return",
      "quantity": 2,
      "unitPrice": "1083.32"
    }
  ]
}

json

Example Responses

{
  "id": "0197A943-2325-7829-B835-B6C71A293065",
  "number": "1",
  "invoiceNumber": "invoiceNumber",
  "status": "sent",
  "date": "2024-01-15",
  "customerId": "customerId",
  "currency": "DKK",
  "subtotal": "2166.65",
  "vat": "541.66",
  "amount": "2708.31",
  "reference": "reference",
  "ourReference": "ourReference",
  "notes": "notes",
  "lines": [
    {
      "id": "0197A943-2325-7829-B835-B6C71A293065",
      "priceId": "priceId",
      "description": "description",
      "lineType": "subscription",
      "quantity": 2,
      "unitPrice": "1083.32",
      "totalPrice": "2166.65",
      "vatAmount": "vatAmount",
      "vatRate": "vatRate"
    }
  ],
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

json

application/json

Get a credit note by ID

GET

https://api.ledgerbee.com/api

/v1/credit-notes/{id}

x-api-key (header)

OAuth 2.0

Retrieves a single credit note by its unique identifier. Returns 404 when the credit note does not exist in your company. For the rendered document, use the PDF endpoint.

Required Scope

invoices-read

Get a credit note by ID › path Parameters

id

string · required

Credit Note ID

Get a credit note by ID › Responses

The credit note

PublicCreditNote

id

string · required

Credit note ID

Example: 0197A943-2325-7829-B835-B6C71A293065

number

string · required

Credit note number

Example: 1

status

string · enum · required

Credit note status

Enum values:

draft

scheduled

sending

sent

Example: sent

date

string · required

Credit note date (ISO date)

Example: 2024-01-15

currency

string · required

Currency code (ISO 4217)

Example: DKK

subtotal

string · required

Subtotal before VAT (decimal string)

Example: 2166.65

vat

string · required

VAT amount (decimal string)

Example: 541.66

amount

string · required

Total amount including VAT (decimal string)

Example: 2708.31

PublicCreditNoteLine[] · required

Credit note lines

createdAt

string · required

Creation timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

updatedAt

string · required

Last update timestamp (ISO)

Example: 2024-01-15T10:30:00.000Z

invoiceNumber

string | null

Original invoice number this credit note credits

customerId

string | null

Customer ID

reference

string | null

Reference / PO number

ourReference

string | null

Our reference ("Vores ref.")

notes

string | null

Additional notes

GET/v1/credit-notes/{id}

curl https://api.ledgerbee.com/api/v1/credit-notes/:id \
  --header 'x-api-key: <api-key>'

Example Responses

{
  "id": "0197A943-2325-7829-B835-B6C71A293065",
  "number": "1",
  "invoiceNumber": "invoiceNumber",
  "status": "sent",
  "date": "2024-01-15",
  "customerId": "customerId",
  "currency": "DKK",
  "subtotal": "2166.65",
  "vat": "541.66",
  "amount": "2708.31",
  "reference": "reference",
  "ourReference": "ourReference",
  "notes": "notes",
  "lines": [
    {
      "id": "0197A943-2325-7829-B835-B6C71A293065",
      "priceId": "priceId",
      "description": "description",
      "lineType": "subscription",
      "quantity": 2,
      "unitPrice": "1083.32",
      "totalPrice": "2166.65",
      "vatAmount": "vatAmount",
      "vatRate": "vatRate"
    }
  ],
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

json

application/json

Get the delivery status of a credit note

GET

https://api.ledgerbee.com/api

/v1/credit-notes/{id}/delivery-status

x-api-key (header)

OAuth 2.0

Returns an aggregate send summary plus a per-attempt delivery log for the credit note.

Get the delivery status of a credit note › path Parameters

id

string · required

Credit Note ID

Get the delivery status of a credit note › Responses

Delivery status

PublicDeliveryStatusResponse

object · required

Aggregate send summary

PublicDeliveryLogEntry[] · required

Per-attempt delivery log entries

Download the credit note PDF

GET

https://api.ledgerbee.com/api

/v1/credit-notes/{id}/pdf

x-api-key (header)

OAuth 2.0

Streams the rendered credit note PDF. Pass draft=true to render a draft watermark version (generated on the fly).

Download the credit note PDF › path Parameters

id

string · required

Credit Note ID

Download the credit note PDF › query Parameters

draft

boolean

Render a draft watermark version

Download the credit note PDF › Responses

Bad Request

statusCode

number

timestamp

string

path

string

message

string

Send a credit note to the customer

POST

https://api.ledgerbee.com/api

/v1/credit-notes/{id}/send

x-api-key (header)

OAuth 2.0

Sends the credit note over the chosen delivery channel (Email, Sproom e-invoicing, or Manual).

Send a credit note to the customer › path Parameters

id

string · required

Credit Note ID

Send a credit note to the customer › Request Body

PublicSendCreditNote

deliveryType

string · enum · required

Delivery channel

Enum values:

Sproom

Manual

Example: Email

overrideEmail

string

Override recipient email for this send only

overrideEanNumber

string

Override EAN number for this send only

updateCustomerRecord

boolean

Persist the override email / EAN onto the customer record

Default: false

documentTemplateId

string

Override document template for PDF generation

Send a credit note to the customer › Responses

Credit note send accepted

PublicSendInvoiceResponse

success

boolean · required

Whether the send was accepted

Example: true

deliveryType

string · enum · required

The delivery channel the document was sent through

Enum values:

Sproom

Manual

Example: Email

sproomDocumentId

string | null

Sproom document ID when sent via e-invoicing

POST/v1/credit-notes/{id}/send

curl https://api.ledgerbee.com/api/v1/credit-notes/:id/send \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "deliveryType": "Email",
  "overrideEmail": "overrideEmail",
  "overrideEanNumber": "overrideEanNumber",
  "updateCustomerRecord": false,
  "documentTemplateId": "documentTemplateId"
}'

Example Request Body

{
  "deliveryType": "Email",
  "overrideEmail": "overrideEmail",
  "overrideEanNumber": "overrideEanNumber",
  "updateCustomerRecord": false,
  "documentTemplateId": "documentTemplateId"
}

json

Example Responses

{
  "success": true,
  "deliveryType": "Email",
  "sproomDocumentId": "sproomDocumentId"
}

json

application/json

Portal SSO Payment Methods