v1
latestOpenAPI 3.0.02026-07-2455104.8 MBList credit notes V3
This endpoint requires the following scopes: creditNote:read.
Paginated list of creditNotes.
Query parameters
The filter parameter is used to filter the results of the given endpoint.
Supported filter operators by key:
id: equals, notEquals, in, notIn
documentNumber: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentDate: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals
writeProtection: equals, notEquals
address.id: equals, notEquals, in, notIn
project.id: equals, notEquals, in, notIn
tags: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
tags.id: equals, notEquals, in, notIn
language: equals, notEquals, in, notIn
bodyIntroduction: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
bodyOutroduction: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
project.abbreviation: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
internalDesignation: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
vatId: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
deliveryTerms: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
internalComment: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
isDocumentSent: equals, notEquals
editor.id: equals, notEquals, in, notIn
createdAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull
updatedAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull
documentAddress.name: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentAddress.title: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentAddress.contactPerson: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentAddress.department: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentAddress.subDepartment: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentAddress.addressSupplement: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentAddress.street: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentAddress.zipCode: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentAddress.city: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentAddress.state: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentAddress.country: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentAddress.gln: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentAddress.email: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentAddress.phone: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
documentAddress.fax: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
financials.paymentMethod.id: equals, notEquals, in, notIn
financials.tax.disableTaxNotice: equals, notEquals
financials.tax.taxRates.standard: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals
financials.tax.taxRates.reduced: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals
financials.tax.taxation: equals, notEquals, in, notIn
totals.net.amount: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals
totals.net.currency: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
financials.paymentTerms.paymentTargetDays: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals
financials.paymentTerms.paymentTargetDiscount: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals
financials.paymentTerms.paymentTargetDiscountDays: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals
sales.id: equals, notEquals, in, notIn
costCenter: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith
invoice.id: equals, notEquals, in, notIn
status: equals, notEquals, in, notIn
paymentStatus: equals, notEquals, in, notIn
Sort via id, -id, documentNumber, -documentNumber, documentDate, -documentDate, customerNumber, -customerNumber, documentAddress.country, -documentAddress.country, project.id, -project.id, createdAt, -createdAt, updatedAt and -updatedAt. Default sort is id
Full-text-style search across predefined columns.
Number of items per page. Default: 15, Max: 1000
Page number. Only used with simple and table pagination.
The cursor to use for the paginated call. Only used with cursor pagination. Not compatible with page parameter
Headers
Controls the pagination format. Available types: simple, table, cursor. Defaults to 'simple' if not specified.
Response
Paginated list of creditNotes.
Example response
{
"data": [
{
"id": "1",
"documentNumber": "I-12343",
"documentDate": "2023-10-01",
"customerNumber": "CUST-54321",
"address": {
"id": "42",
"createdAt": "2025-03-15T09:27:00+01:00",
"updatedAt": "2025-10-20T14:45:12+01:00"
},
"project": {
"id": "54",
"name": "Standard Project",
"abbreviation": "STANDARD"
},
"tags": [
{
"id": "4",
"title": "important"
}
],
"documentAddress": {
"name": "John",
"type": "mr",
"title": "Ms.",
"contactPerson": "Laura Schneider",
"department": "Research & Development",
"subDepartment": "CAI Lab",
"addressSupplement": "Gebäude B, 4. Etage",
"street": "Fuggerstraße 11",
"zipCode": "86150",
"city": "Augsburg",
"state": "BY",
"country": "DE",
"salutation": "Sehr geehrte Damen und Herren",
"gln": "1234567890123",
"email": "alice@example.com",
"phone": "+1-234-567-8900",
"fax": "+1-234-567-8901",
"mobile": "+1-234-567-8902"
},
"internalDesignation": "FB-3860-L",
"language": "de",
"bodyIntroduction": "Dear customer, we are pleased to send you the following invoice.",
"bodyOutroduction": "Thank you for your business.",
"vatId": "DE123456789",
"deliveryTerms": "DDP",
"internalComment": "This is an internal comment.",
"editor": {
"id": "4"
},
"activity": [
{
"message": "Invoice released",
"causer": "John Doe",
"causedAt": "2023-01-01T00:00:00Z"
}
],
"customFields": [
{
"key": "customer_category",
"value": "Premium",
"label": "Customer Category"
},
{
"key": "priority_level",
"value": "High",
"label": "Priority Level"
}
],
"updatedAt": "2023-10-01T12:00:00Z",
"createdAt": "2023-10-01T12:00:00Z",
"financials": {
"paymentMethod": {
"id": "1"
},
"paymentTerms": {
"paymentTargetDays": 30,
"paymentTargetDiscount": 2.5,
"paymentTargetDiscountDays": 10
},
"tax": {
"taxation": "domestic",
"taxRates": {
"standard": 19,
"reduced": 7
}
},
"currency": "EUR",
"exchangeRate": 1.0875
},
"totals": {
"net": {
"amount": "13.37",
"currency": "EUR"
},
"gross": {
"amount": "13.37",
"currency": "EUR"
},
"contributionMargin": 42
},
"invoice": {
"id": "13"
},
"sales": {
"id": "1"
},
"customerOrderNumber": "CUST-54321",
"deviatingDebtorAccountNumber": "4001-12345",
"deliveryDate": "2025-11-15",
"paymentStatus": "paid",
"debtStatus": {
"doneAt": "2024-01-15",
"comment": "Customer was refund in cash."
},
"lineItems": [
{
"type": "product",
"id": "1",
"number": "2462-SK-D",
"name": "Strawberry Jam",
"description": "Delicious strawberry jam made from fresh strawberries.",
"quantity": 2,
"product": {
"createdAt": "2025-03-15T09:27:00+01:00",
"updatedAt": "2025-10-20T14:45:12+01:00"
},
"customFields": [
{
"key": "customer_category",
"value": "Premium",
"label": "Customer Category"
},
{
"key": "priority_level",
"value": "High",
"label": "Priority Level"
}
],
"unit": "kg",
"packagingUnit": "box",
"internalComment": "This is an internal comment.",
"customerProductNumber": "CUS-10077",
"order": 5,
"updatedAt": "2023-10-01T12:00:00Z",
"createdAt": "2023-10-01T12:00:00Z",
"taxRate": "standard",
"effectiveTaxRate": 19,
"price": {
"net": {
"amount": "13.37",
"currency": "EUR"
},
"gross": {
"amount": "13.37",
"currency": "EUR"
}
},
"discount": 10,
"itemRevenue": {
"net": {
"amount": "13.37",
"currency": "EUR"
},
"gross": {
"amount": "13.37",
"currency": "EUR"
}
},
"lineItemRevenue": {
"net": {
"amount": "13.37",
"currency": "EUR"
},
"gross": {
"amount": "13.37",
"currency": "EUR"
}
},
"purchasePrice": {
"net": {
"amount": "13.37",
"currency": "EUR"
}
},
"contributionMargin": 0.25,
"taxLegalNotice": "Tax exempt according to §19 UStG",
"salesOrderLineItem": {
"id": "1"
}
}
],
"costCenter": "CC-123"
}
],
"meta": {
"currentPage": 1,
"from": 1,
"path": "https://api.example.com/items",
"perPage": 15,
"to": 15
},
"links": {
"first": "https://api.example.com/items?page=1",
"next": "https://api.example.com/items?page=17"
}
}