API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- GETGet invoices
- POSTCreate draft invoice
- GETGet invoice
- PUTUpdate draft invoice
- DELDelete invoice
- POSTCancel invoice
- POSTCredit invoice
- POSTSet invoice customer address
- PUTToggle dunning
- POSTDuplicate invoice
- POSTFinalize invoice
- PUTSet invoice note
- POSTSet invoice payment method
- POSTAdd invoice payment
- POSTAdd invoice position items
- GETGet invoice preview
- PUTResend invoice
- PUTGet invoice download link
- PUTClose invoice
- POSTAdd comment
- GET
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Set invoice customer address
Set an invoice address based on an existing customer address. The vat id will be updated accordingly. This is available for invoices only.
Required permissions:invoice:writecurl -X POST \
/invoices/{id}/customer-address \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"customerAddressId": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b"
}'{
"id": "00000000-0000-0000-0000-000000000000",
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"datevId": "123456789",
"status": "STATUS_ACTIVE"
},
"paymentMethod": {
"id": "<string>",
"gatewayName": "wallet",
"type": "sepa_debit",
"referenceId": "<string>",
"default": true,
"status": "active",
"source": "api",
"enabled": true,
"name": "<string>",
"data": [
"<string>"
],
"creationDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"sepaMandate": {},
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"referencedInvoice": {},
"type": "TYPE_INVOICE",
"currencyCode": "EUR",
"number": "RE-0000000001",
"status": "STATUS_DRAFT",
"creationDate": "2023-11-07T05:31:56Z",
"finalizationDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"lastReminderDate": "2023-11-07T05:31:56Z",
"lastSentAt": "2023-11-07T05:31:56Z",
"dunningLevel": 123,
"dunningStatus": "none",
"payDate": "2023-11-07T05:31:56Z",
"invoiceAddress": "<any>",
"internalNote": "This invoice is with a special discount.",
"title": "<string>",
"introduction": "<string>",
"closing": "<string>",
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"discountAmount": {},
"file": {
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"isPrivate": true,
"mimeType": "image/jpeg",
"fileExtension": "jpg",
"fileName": "invoice.jpg",
"storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
"createdAt": "2021-01-01T00:00:00+00:00"
},
"xmlFile": {
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"isPrivate": true,
"mimeType": "image/jpeg",
"fileExtension": "jpg",
"fileName": "invoice.jpg",
"storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
"createdAt": "2021-01-01T00:00:00+00:00"
},
"positions": [
{
"id": {},
"position": 123,
"quantity": 1,
"unit": {
"id": {},
"name": "Stück"
},
"unitPrice": {},
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"discountAmount": {},
"discountPercentage": 10,
"name": "My subscription product",
"description": "* my subscription product",
"taxGroup": {
"id": "00000000-0000-0000-0000-000000000000",
"internalDescription": "19%",
"reverseChargeType": "REVERSE_CHARGE",
"type": "standard"
},
"tax": {
"id": "00000000-0000-0000-0000-000000000000",
"description": "19%",
"code": "19",
"rate": 19
},
"type": "product",
"parent": {},
"group": {
"id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
"ranking": 1,
"name": "Subscription #12345"
},
"createdAt": "2020-01-01T00:00:00+00:00",
"product": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"name": "Basic",
"description": "For small teams.",
"type": "product",
"invoiceVisibility": "always",
"customFields": {
"field1": "value1",
"field2": "value2"
}
},
"subscriptionItem": {
"id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
"name": "Fitness M",
"description": "Everything included",
"furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
"status": "active",
"subscriptionId": "<string>"
},
"serviceDateFrom": "2020-01-01T00:00:00+00:00",
"serviceDateTo": "2020-01-01T00:00:00+00:00"
}
],
"applicatedExchangeRates": [
{
"sourceCurrencyCode": "EUR",
"destinationCurrencyCode": "CHF",
"exchangeRate": "1.135",
"exchangeRateDate": "2023-11-07T05:31:56Z"
}
],
"eInvoiceType": "<any>",
"leitwegId": "1234567890123",
"customFields": {
"field1": "value1",
"field2": "value2"
},
"serviceDateFrom": "2023-11-07T05:31:56Z",
"serviceDateTo": "2023-11-07T05:31:56Z",
"unpaidAmount": {},
"usageBreakdownUrl": "<string>",
"cancellationDocument": {
"number": "R2021-0001",
"id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
},
"dunningDisabled": true,
"sourceType": "<any>"
}Authorizations
Value for the Authorization header parameter.
Path Parameters
Invoice identifier
Body
The customer address id to change the invoice customer address to. The vat id will be updated accordingly.
"c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b"
Response
The unique identifier of the invoice.
"00000000-0000-0000-0000-000000000000"
The customer of the invoice.
"00000000-0000-0000-0000-000000000000"
2 - 255"CUSTOMER-000"
"Europe/Berlin"
Can be empty if the customer is a company.
2 - 255"John"
Can be empty if the customer is a company.
2 - 255"Doe"
Can be empty. In this case the default currency of the tenant is used.
"EUR"
2 - 255"Acme Inc."
The ID of the customer in DATEV
2 - 255"123456789"
STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED "STATUS_ACTIVE"
The payment method which should be used to fullfill the payment of the invoice.
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing sepa_debit, card, paypal, bank_transfer, wallet, fake_provider active, action_required, expired, revoked, gateway_unconfigured "active"
checkout, customerfront, api, add_link "api"
The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
The card data of the payment method, if the type is "card"
The brand of the card
"Visa"
The last 4 digits of the card
"4242"
The expiration month of the card
12
The expiration year of the card
2022
The card holder name
"Max Mustermann"
The sepa mandate data of the payment method, if the type is "sepa_debit"
The iban of the sepa mandate
"DE8937*********3232"
The bic of the sepa mandate
"COBADEFFXXX"
The mandate reference of the sepa mandate
"MNDT-2021-123456"
The signing date of the sepa mandate
"2021-01-01T00:00:00+00:00"
The referenced invoice of the invoice. This could be in case of a reminder, refund etc.
The unique identifier of the invoice.
"00000000-0000-0000-0000-000000000000"
The customer of the invoice.
"00000000-0000-0000-0000-000000000000"
2 - 255"CUSTOMER-000"
"Europe/Berlin"
Can be empty if the customer is a company.
2 - 255"John"
Can be empty if the customer is a company.
2 - 255"Doe"
Can be empty. In this case the default currency of the tenant is used.
"EUR"
2 - 255"Acme Inc."
The ID of the customer in DATEV
2 - 255"123456789"
STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED "STATUS_ACTIVE"
The payment method which should be used to fullfill the payment of the invoice.
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing sepa_debit, card, paypal, bank_transfer, wallet, fake_provider active, action_required, expired, revoked, gateway_unconfigured "active"
checkout, customerfront, api, add_link "api"
The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
The card data of the payment method, if the type is "card"
The brand of the card
"Visa"
The last 4 digits of the card
"4242"
The expiration month of the card
12
The expiration year of the card
2022
The card holder name
"Max Mustermann"
The sepa mandate data of the payment method, if the type is "sepa_debit"
The iban of the sepa mandate
"DE8937*********3232"
The bic of the sepa mandate
"COBADEFFXXX"
The mandate reference of the sepa mandate
"MNDT-2021-123456"
The signing date of the sepa mandate
"2021-01-01T00:00:00+00:00"
The paypal data of the payment method, if the type is "paypal"
The referenced invoice of the invoice. This could be in case of a reminder, refund etc.
The unique identifier of the invoice.
"00000000-0000-0000-0000-000000000000"
The customer of the invoice.
"00000000-0000-0000-0000-000000000000"
2 - 255"CUSTOMER-000"
"Europe/Berlin"
Can be empty if the customer is a company.
2 - 255"John"
Can be empty if the customer is a company.
2 - 255"Doe"
Can be empty. In this case the default currency of the tenant is used.
"EUR"
2 - 255"Acme Inc."
The ID of the customer in DATEV
2 - 255"123456789"
STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED "STATUS_ACTIVE"
The payment method which should be used to fullfill the payment of the invoice.
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing sepa_debit, card, paypal, bank_transfer, wallet, fake_provider active, action_required, expired, revoked, gateway_unconfigured "active"
checkout, customerfront, api, add_link "api"
The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
The card data of the payment method, if the type is "card"
The brand of the card
"Visa"
The last 4 digits of the card
"4242"
The expiration month of the card
12
The expiration year of the card
2022
The card holder name
"Max Mustermann"
The sepa mandate data of the payment method, if the type is "sepa_debit"
The iban of the sepa mandate
"DE8937*********3232"
The bic of the sepa mandate
"COBADEFFXXX"
The mandate reference of the sepa mandate
"MNDT-2021-123456"
The signing date of the sepa mandate
"2021-01-01T00:00:00+00:00"
The paypal data of the payment method, if the type is "paypal"
The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING "TYPE_INVOICE"
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
"EUR"
The document id of the invoice. This will be generated, when the invoice will be finalized.
"RE-0000000001"
STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING reminder, dunning, none "none"
The invoice address of the invoice.
The notice of the invoice.
"This invoice is with a special discount."
The net amount of the invoice.
The total net discount amount of the invoice.
Whether the media is public accessible or not
true
The mime type of the media
"image/jpeg"
The file extension of the media
"jpg"
The original file name of the media
"invoice.jpg"
The file name of the media in the storage
"01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg"
The date and time when the media was created
"2021-01-01T00:00:00+00:00"
The xml representation of the invoice in EN16931 or x-Rechnung format.
Whether the media is public accessible or not
true
The mime type of the media
"image/jpeg"
The file extension of the media
"jpg"
The original file name of the media
"invoice.jpg"
The file name of the media in the storage
"01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg"
The date and time when the media was created
"2021-01-01T00:00:00+00:00"
The positions of the invoice.
The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.
The quantity of the invoice position item.
The unit price of the invoice position item.
The net amount of the invoice position item, before discount.
The gross amount of the invoice position item, after discount.
The tax amount of the invoice position item, after discount.
The discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
10
The fixed applied discount amount of the invoice position item.
The description of the invoice position item.
"My subscription product"
The description of the invoice position item.
"* my subscription product"
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The name of the tax group which will be displayed only in the UI
255"19%"
Defines if reverse charge will be applicated or not
REVERSE_CHARGE_DEACTIVATED, REVERSE_CHARGE, REVERSE_CHARGE_INTRA_EU_SUPPLY "REVERSE_CHARGE"
standard, reduced "standard"
"00000000-0000-0000-0000-000000000000"
The tax of the invoice position item, calculated based on the tax group.
Some internal code
"19"
Tax rate in percent
0 <= x <= 10019
"00000000-0000-0000-0000-000000000000"
Some internal description
255"19%"
The type of the invoice position item.
product, discount, setup, dunning_fee, invoice "product"
The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.
The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.
The quantity of the invoice position item.
The unit of the invoice position item.
The unit price of the invoice position item.
The net amount of the invoice position item, before discount.
The gross amount of the invoice position item, after discount.
The tax amount of the invoice position item, after discount.
The discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
10
The fixed applied discount amount of the invoice position item.
The description of the invoice position item.
"My subscription product"
The description of the invoice position item.
"* my subscription product"
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The tax of the invoice position item, calculated based on the tax group.
The type of the invoice position item.
product, discount, setup, dunning_fee, invoice "product"
The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.
The creation date of the invoice position item.
"2020-01-01T00:00:00+00:00"
The service date from of the invoice position item.
"2020-01-01T00:00:00+00:00"
The service date to of the invoice position item.
"2020-01-01T00:00:00+00:00"
The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.
The creation date of the invoice position item.
"2020-01-01T00:00:00+00:00"
The type of the product.
product: recurring billed productcharge: one-time billingplan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.
product, charge, plan The unique identifier of the product.
"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
The name of the product based on the current tenant language. This will be displayed on customer communication.
"Basic"
The description of the product based on the current tenant language.
"For small teams."
Defines when the product should be displayed in the invoice.
always: The product is always displayed in the invoice.only_if_charged: The product is only displayed in the invoice if it is charged.
always, only_if_charged Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
{ "field1": "value1", "field2": "value2" }
"01F9ZQZJZJQZJZJZJZJZJZJZJZ"
The name of the item which will be used in the invoice. The name is translated based on the customer's locale.
"Fitness M"
The description of the item which will be used in the invoice. The description is translated based on the customer's locale.
"Everything included"
Further information defines additional information for the item which will be displayed in the invoice.
"Additional agreements: The contract includes a free drink flatrate."
The status of the item.
Possible values:
active: The item is active and will be billed.canceled: The item is canceled and will be billed until the end of the contract.pending: The item is pending and will be billed after the contract start.terminated: The item is terminated and will not be billed.
active, canceled, pending, terminated "active"
The service date from of the invoice position item.
"2020-01-01T00:00:00+00:00"
The service date to of the invoice position item.
"2020-01-01T00:00:00+00:00"
The applicated exchange rates of the invoice, fetched from the european central bank.
"EUR"
"CHF"
"1.135"
The einvoice generated xml file format.
The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.
"1234567890123"
Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
{ "field1": "value1", "field2": "value2" }
The earliest service date of all positions.
The latest service date of all positions.
Public url to view the detailed usage breakdown of this invoice.
The referenced cancellation document.
Dunning is disabled for this invoice.
Where the invoice was created from.
Possible values:
cart: The invoice was created from a cart.subscription: The invoice was created from a subscription billing run.manual: The invoice was created by a user.
The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING "TYPE_INVOICE"
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
"EUR"
The document id of the invoice. This will be generated, when the invoice will be finalized.
"RE-0000000001"
STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING reminder, dunning, none "none"
The invoice address of the invoice.
The notice of the invoice.
"This invoice is with a special discount."
The net amount of the invoice.
The total net discount amount of the invoice.
Whether the media is public accessible or not
true
The mime type of the media
"image/jpeg"
The file extension of the media
"jpg"
The original file name of the media
"invoice.jpg"
The file name of the media in the storage
"01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg"
The date and time when the media was created
"2021-01-01T00:00:00+00:00"
The xml representation of the invoice in EN16931 or x-Rechnung format.
Whether the media is public accessible or not
true
The mime type of the media
"image/jpeg"
The file extension of the media
"jpg"
The original file name of the media
"invoice.jpg"
The file name of the media in the storage
"01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg"
The date and time when the media was created
"2021-01-01T00:00:00+00:00"
The positions of the invoice.
The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.
The quantity of the invoice position item.
The unit price of the invoice position item.
The net amount of the invoice position item, before discount.
The gross amount of the invoice position item, after discount.
The tax amount of the invoice position item, after discount.
The discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
10
The fixed applied discount amount of the invoice position item.
The description of the invoice position item.
"My subscription product"
The description of the invoice position item.
"* my subscription product"
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The name of the tax group which will be displayed only in the UI
255"19%"
Defines if reverse charge will be applicated or not
REVERSE_CHARGE_DEACTIVATED, REVERSE_CHARGE, REVERSE_CHARGE_INTRA_EU_SUPPLY "REVERSE_CHARGE"
standard, reduced "standard"
"00000000-0000-0000-0000-000000000000"
The tax of the invoice position item, calculated based on the tax group.
Some internal code
"19"
Tax rate in percent
0 <= x <= 10019
"00000000-0000-0000-0000-000000000000"
Some internal description
255"19%"
The type of the invoice position item.
product, discount, setup, dunning_fee, invoice "product"
The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.
The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.
The quantity of the invoice position item.
The unit price of the invoice position item.
The net amount of the invoice position item, before discount.
The gross amount of the invoice position item, after discount.
The tax amount of the invoice position item, after discount.
The discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
10
The fixed applied discount amount of the invoice position item.
The description of the invoice position item.
"My subscription product"
The description of the invoice position item.
"* my subscription product"
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The name of the tax group which will be displayed only in the UI
255"19%"
Defines if reverse charge will be applicated or not
REVERSE_CHARGE_DEACTIVATED, REVERSE_CHARGE, REVERSE_CHARGE_INTRA_EU_SUPPLY "REVERSE_CHARGE"
standard, reduced "standard"
"00000000-0000-0000-0000-000000000000"
The tax of the invoice position item, calculated based on the tax group.
Some internal code
"19"
Tax rate in percent
0 <= x <= 10019
"00000000-0000-0000-0000-000000000000"
Some internal description
255"19%"
The type of the invoice position item.
product, discount, setup, dunning_fee, invoice "product"
The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.
The creation date of the invoice position item.
"2020-01-01T00:00:00+00:00"
The type of the product.
product: recurring billed productcharge: one-time billingplan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.
product, charge, plan The unique identifier of the product.
"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
The name of the product based on the current tenant language. This will be displayed on customer communication.
"Basic"
The description of the product based on the current tenant language.
"For small teams."
Defines when the product should be displayed in the invoice.
always: The product is always displayed in the invoice.only_if_charged: The product is only displayed in the invoice if it is charged.
always, only_if_charged Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
{ "field1": "value1", "field2": "value2" }
"01F9ZQZJZJQZJZJZJZJZJZJZJZ"
The name of the item which will be used in the invoice. The name is translated based on the customer's locale.
"Fitness M"
The description of the item which will be used in the invoice. The description is translated based on the customer's locale.
"Everything included"
Further information defines additional information for the item which will be displayed in the invoice.
"Additional agreements: The contract includes a free drink flatrate."
The status of the item.
Possible values:
active: The item is active and will be billed.canceled: The item is canceled and will be billed until the end of the contract.pending: The item is pending and will be billed after the contract start.terminated: The item is terminated and will not be billed.
active, canceled, pending, terminated "active"
The service date from of the invoice position item.
"2020-01-01T00:00:00+00:00"
The service date to of the invoice position item.
"2020-01-01T00:00:00+00:00"
The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.
The creation date of the invoice position item.
"2020-01-01T00:00:00+00:00"
The type of the product.
product: recurring billed productcharge: one-time billingplan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.
product, charge, plan The unique identifier of the product.
"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
The name of the product based on the current tenant language. This will be displayed on customer communication.
"Basic"
The description of the product based on the current tenant language.
"For small teams."
Defines when the product should be displayed in the invoice.
always: The product is always displayed in the invoice.only_if_charged: The product is only displayed in the invoice if it is charged.
always, only_if_charged Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
{ "field1": "value1", "field2": "value2" }
"01F9ZQZJZJQZJZJZJZJZJZJZJZ"
The name of the item which will be used in the invoice. The name is translated based on the customer's locale.
"Fitness M"
The description of the item which will be used in the invoice. The description is translated based on the customer's locale.
"Everything included"
Further information defines additional information for the item which will be displayed in the invoice.
"Additional agreements: The contract includes a free drink flatrate."
The status of the item.
Possible values:
active: The item is active and will be billed.canceled: The item is canceled and will be billed until the end of the contract.pending: The item is pending and will be billed after the contract start.terminated: The item is terminated and will not be billed.
active, canceled, pending, terminated "active"
The service date from of the invoice position item.
"2020-01-01T00:00:00+00:00"
The service date to of the invoice position item.
"2020-01-01T00:00:00+00:00"
The applicated exchange rates of the invoice, fetched from the european central bank.
"EUR"
"CHF"
"1.135"
The einvoice generated xml file format.
The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.
"1234567890123"
Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
{ "field1": "value1", "field2": "value2" }
The earliest service date of all positions.
The latest service date of all positions.
Public url to view the detailed usage breakdown of this invoice.
Dunning is disabled for this invoice.
Where the invoice was created from.
Possible values:
cart: The invoice was created from a cart.subscription: The invoice was created from a subscription billing run.manual: The invoice was created by a user.
The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING "TYPE_INVOICE"
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
"EUR"
The document id of the invoice. This will be generated, when the invoice will be finalized.
"RE-0000000001"
STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING reminder, dunning, none "none"
The invoice address of the invoice.
The notice of the invoice.
"This invoice is with a special discount."
The net amount of the invoice.
The total net discount amount of the invoice.
Whether the media is public accessible or not
true
The mime type of the media
"image/jpeg"
The file extension of the media
"jpg"
The original file name of the media
"invoice.jpg"
The file name of the media in the storage
"01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg"
The date and time when the media was created
"2021-01-01T00:00:00+00:00"
The xml representation of the invoice in EN16931 or x-Rechnung format.
Whether the media is public accessible or not
true
The mime type of the media
"image/jpeg"
The file extension of the media
"jpg"
The original file name of the media
"invoice.jpg"
The file name of the media in the storage
"01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg"
The date and time when the media was created
"2021-01-01T00:00:00+00:00"
The positions of the invoice.
The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.
The quantity of the invoice position item.
The unit price of the invoice position item.
The net amount of the invoice position item, before discount.
The gross amount of the invoice position item, after discount.
The tax amount of the invoice position item, after discount.
The discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
10
The fixed applied discount amount of the invoice position item.
The description of the invoice position item.
"My subscription product"
The description of the invoice position item.
"* my subscription product"
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The name of the tax group which will be displayed only in the UI
255"19%"
Defines if reverse charge will be applicated or not
REVERSE_CHARGE_DEACTIVATED, REVERSE_CHARGE, REVERSE_CHARGE_INTRA_EU_SUPPLY "REVERSE_CHARGE"
standard, reduced "standard"
"00000000-0000-0000-0000-000000000000"
The tax of the invoice position item, calculated based on the tax group.
Some internal code
"19"
Tax rate in percent
0 <= x <= 10019
"00000000-0000-0000-0000-000000000000"
Some internal description
255"19%"
The type of the invoice position item.
product, discount, setup, dunning_fee, invoice "product"
The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.
The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.
The quantity of the invoice position item.
The unit price of the invoice position item.
The net amount of the invoice position item, before discount.
The gross amount of the invoice position item, after discount.
The tax amount of the invoice position item, after discount.
The discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
10
The fixed applied discount amount of the invoice position item.
The description of the invoice position item.
"My subscription product"
The description of the invoice position item.
"* my subscription product"
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The name of the tax group which will be displayed only in the UI
255"19%"
Defines if reverse charge will be applicated or not
REVERSE_CHARGE_DEACTIVATED, REVERSE_CHARGE, REVERSE_CHARGE_INTRA_EU_SUPPLY "REVERSE_CHARGE"
standard, reduced "standard"
"00000000-0000-0000-0000-000000000000"
The tax of the invoice position item, calculated based on the tax group.
Some internal code
"19"
Tax rate in percent
0 <= x <= 10019
"00000000-0000-0000-0000-000000000000"
Some internal description
255"19%"
The type of the invoice position item.
product, discount, setup, dunning_fee, invoice "product"
The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.
The creation date of the invoice position item.
"2020-01-01T00:00:00+00:00"
The type of the product.
product: recurring billed productcharge: one-time billingplan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.
product, charge, plan The unique identifier of the product.
"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
The name of the product based on the current tenant language. This will be displayed on customer communication.
"Basic"
The description of the product based on the current tenant language.
"For small teams."
Defines when the product should be displayed in the invoice.
always: The product is always displayed in the invoice.only_if_charged: The product is only displayed in the invoice if it is charged.
always, only_if_charged Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
{ "field1": "value1", "field2": "value2" }
"01F9ZQZJZJQZJZJZJZJZJZJZJZ"
The name of the item which will be used in the invoice. The name is translated based on the customer's locale.
"Fitness M"
The description of the item which will be used in the invoice. The description is translated based on the customer's locale.
"Everything included"
Further information defines additional information for the item which will be displayed in the invoice.
"Additional agreements: The contract includes a free drink flatrate."
The status of the item.
Possible values:
active: The item is active and will be billed.canceled: The item is canceled and will be billed until the end of the contract.pending: The item is pending and will be billed after the contract start.terminated: The item is terminated and will not be billed.
active, canceled, pending, terminated "active"
The service date from of the invoice position item.
"2020-01-01T00:00:00+00:00"
The service date to of the invoice position item.
"2020-01-01T00:00:00+00:00"
The creation date of the invoice position item.
"2020-01-01T00:00:00+00:00"
The type of the product.
product: recurring billed productcharge: one-time billingplan: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.
product, charge, plan The unique identifier of the product.
"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
The name of the product based on the current tenant language. This will be displayed on customer communication.
"Basic"
The description of the product based on the current tenant language.
"For small teams."
Defines when the product should be displayed in the invoice.
always: The product is always displayed in the invoice.only_if_charged: The product is only displayed in the invoice if it is charged.
always, only_if_charged Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
{ "field1": "value1", "field2": "value2" }
"01F9ZQZJZJQZJZJZJZJZJZJZJZ"
The name of the item which will be used in the invoice. The name is translated based on the customer's locale.
"Fitness M"
The description of the item which will be used in the invoice. The description is translated based on the customer's locale.
"Everything included"
Further information defines additional information for the item which will be displayed in the invoice.
"Additional agreements: The contract includes a free drink flatrate."
The status of the item.
Possible values:
active: The item is active and will be billed.canceled: The item is canceled and will be billed until the end of the contract.pending: The item is pending and will be billed after the contract start.terminated: The item is terminated and will not be billed.
active, canceled, pending, terminated "active"
The service date from of the invoice position item.
"2020-01-01T00:00:00+00:00"
The service date to of the invoice position item.
"2020-01-01T00:00:00+00:00"
The applicated exchange rates of the invoice, fetched from the european central bank.
The einvoice generated xml file format.
The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.
"1234567890123"
Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
{ "field1": "value1", "field2": "value2" }
The earliest service date of all positions.
The latest service date of all positions.
Public url to view the detailed usage breakdown of this invoice.
Dunning is disabled for this invoice.
Where the invoice was created from.
Possible values:
cart: The invoice was created from a cart.subscription: The invoice was created from a subscription billing run.manual: The invoice was created by a user.
Was this page helpful?
curl -X POST \
/invoices/{id}/customer-address \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"customerAddressId": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b"
}'{
"id": "00000000-0000-0000-0000-000000000000",
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"datevId": "123456789",
"status": "STATUS_ACTIVE"
},
"paymentMethod": {
"id": "<string>",
"gatewayName": "wallet",
"type": "sepa_debit",
"referenceId": "<string>",
"default": true,
"status": "active",
"source": "api",
"enabled": true,
"name": "<string>",
"data": [
"<string>"
],
"creationDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"sepaMandate": {},
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"referencedInvoice": {},
"type": "TYPE_INVOICE",
"currencyCode": "EUR",
"number": "RE-0000000001",
"status": "STATUS_DRAFT",
"creationDate": "2023-11-07T05:31:56Z",
"finalizationDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"lastReminderDate": "2023-11-07T05:31:56Z",
"lastSentAt": "2023-11-07T05:31:56Z",
"dunningLevel": 123,
"dunningStatus": "none",
"payDate": "2023-11-07T05:31:56Z",
"invoiceAddress": "<any>",
"internalNote": "This invoice is with a special discount.",
"title": "<string>",
"introduction": "<string>",
"closing": "<string>",
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"discountAmount": {},
"file": {
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"isPrivate": true,
"mimeType": "image/jpeg",
"fileExtension": "jpg",
"fileName": "invoice.jpg",
"storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
"createdAt": "2021-01-01T00:00:00+00:00"
},
"xmlFile": {
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"isPrivate": true,
"mimeType": "image/jpeg",
"fileExtension": "jpg",
"fileName": "invoice.jpg",
"storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
"createdAt": "2021-01-01T00:00:00+00:00"
},
"positions": [
{
"id": {},
"position": 123,
"quantity": 1,
"unit": {
"id": {},
"name": "Stück"
},
"unitPrice": {},
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"discountAmount": {},
"discountPercentage": 10,
"name": "My subscription product",
"description": "* my subscription product",
"taxGroup": {
"id": "00000000-0000-0000-0000-000000000000",
"internalDescription": "19%",
"reverseChargeType": "REVERSE_CHARGE",
"type": "standard"
},
"tax": {
"id": "00000000-0000-0000-0000-000000000000",
"description": "19%",
"code": "19",
"rate": 19
},
"type": "product",
"parent": {},
"group": {
"id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
"ranking": 1,
"name": "Subscription #12345"
},
"createdAt": "2020-01-01T00:00:00+00:00",
"product": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"name": "Basic",
"description": "For small teams.",
"type": "product",
"invoiceVisibility": "always",
"customFields": {
"field1": "value1",
"field2": "value2"
}
},
"subscriptionItem": {
"id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
"name": "Fitness M",
"description": "Everything included",
"furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
"status": "active",
"subscriptionId": "<string>"
},
"serviceDateFrom": "2020-01-01T00:00:00+00:00",
"serviceDateTo": "2020-01-01T00:00:00+00:00"
}
],
"applicatedExchangeRates": [
{
"sourceCurrencyCode": "EUR",
"destinationCurrencyCode": "CHF",
"exchangeRate": "1.135",
"exchangeRateDate": "2023-11-07T05:31:56Z"
}
],
"eInvoiceType": "<any>",
"leitwegId": "1234567890123",
"customFields": {
"field1": "value1",
"field2": "value2"
},
"serviceDateFrom": "2023-11-07T05:31:56Z",
"serviceDateTo": "2023-11-07T05:31:56Z",
"unpaidAmount": {},
"usageBreakdownUrl": "<string>",
"cancellationDocument": {
"number": "R2021-0001",
"id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
},
"dunningDisabled": true,
"sourceType": "<any>"
}