Credit Note
📄 About the credit note data model
The credit note data model describes a credit note document. A credit note is issued to correct or cancel an invoice, typically to refund or reduce the amount owed. The credit note data model includes attributes such as the credit note number, date, due date, total amount, and parties involved.
📦 Attributes
The credit note data model includes the following attributes:
| Attribute | Type | Description |
|---|---|---|
filename |
string | The original filename of the credit note document. |
document_number |
string | The credit note number. |
document_date |
date | The credit note date (RFC 3339 format). |
net_amount |
float | The net amount (excluding VAT). |
gross_amount |
float | The gross amount (including VAT). |
vat |
array of VatItem | VAT rates and amounts. |
sending_party |
PartyData | The sending party. |
receiving_party |
PartyData | The receiving party. |
order_number |
string | The order number. |
due_date |
date | The due date for payment (RFC 3339 format). |
currency |
string | The currency (ISO 4217 code, defaults to EUR if not provided). |
cash_discount_until_date |
date | Date until cash discount is valid (RFC 3339 format). |
cash_discount_rate |
number | Cash discount rate in percent. |
payment_date |
date | The payment date (RFC 3339 format). |
payment_reference |
string | Reference for the payment. |
line_items |
array | Array of line items (positions). |
payment_status |
string | Payment status (unknown, unpaid, partially_paid, paid). Defaults to unknown. |
payment_method |
string | Payment method (for example bank_transfer). |
direction |
string | Direction of the credit note (incoming or outgoing). Defaults to incoming. |
📦 Line items
The credit note data model can include an array of line items. Each line item is an object that includes the following attributes:
| Attribute | Type | Description |
|---|---|---|
| description | string | Description of the line item. |
| quantity | number | Quantity of the line item. |
| unit_price_net | number | Net price of the line item (excluding tax). |
| tax_rate | number | Tax rate in percent. |
| tax_amount | number | Tax amount for the line item. |
| total_price_net | number | Total net price for the line item. |
| total_price_gross | number | Total gross price for the line item. |
| order_number | string | Order number for the line item. |
📝 Example output
Below is an example of the output you can expect from the Credit Note Data Model in fetchdocs:
JSON
{
"filename": "creditnote-2024-0001.pdf",
"document_number": "CN20240724001",
"document_date": "2025-07-24",
"net_amount": 100.00,
"gross_amount": 119.00,
"vat": [
{
"vat_rate": 19.00,
"vat_amount": 19.00,
"net_amount": 100.00,
"gross_amount": 119.00
}
],
"sending_party": {
"company_name": "Supplier Inc.",
"address": {
"street": "Main Street 123",
"zip": "12345",
"city": "Springfield",
"country": "US"
},
"address_string": "Main Street 123, Springfield, 12345, US",
"external_id": "123456"
},
"receiving_party": {
"company_name": "Customer Inc.",
"address": {
"street": "Main Street 456",
"zip": "54321",
"city": "Springfield",
"country": "US"
},
"address_string": "Main Street 456, Springfield, 54321, US",
"external_id": "654321"
},
"order_number": "123456",
"due_date": "2025-08-24",
"currency": "EUR",
"cash_discount_until_date": "2025-08-01",
"cash_discount_rate": 2.00,
"payment_date": "2025-08-24",
"payment_reference": "KD 123456 / CN20240724001",
"line_items": [
{
"description": "Refund Product A",
"quantity": 1,
"unit_price_net": 100.00,
"tax_rate": 19.00,
"tax_amount": 19.00,
"total_price_net": 100.00,
"total_price_gross": 119.00
}
],
"payment_status": "paid",
"payment_method": "bank_transfer",
"direction": "incoming"
}
🛟 Need help?
If you need help or want to receive additional attributes, please contact the fetchdocs support team. They're happy to assist you.