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
- 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
Get a bank account transaction assignment
Get a bank account transaction assignment, which shows the match between a bank account transaction and an invoice.
Authorizations
Value for the Authorization header parameter.
Path Parameters
BankAccountTransactionAssignment identifier
Response
The applicated exchange rates of the invoice, fetched from the european central bank.
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
The customer of the invoice.
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
The total net discount amount of the invoice.
Dunning is disabled for this invoice.
reminder, dunning, none The einvoice generated xml file format.
The date and time when the media was created
The file extension of the media
The original file name of the media
Whether the media is public accessible or not
The mime type of the media
The file name of the media in the storage
The unique identifier of the invoice.
The notice of the invoice.
The invoice address of the invoice.
The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.
The net amount of the invoice.
The document id of the invoice. This will be generated, when the invoice will be finalized.
The payment method which should be used to fullfill the payment of the invoice.
The card data of the payment method, if the type is "card"
The brand of the card
The card holder name
The expiration month of the card
The expiration year of the card
The last 4 digits of the card
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing The sepa mandate data of the payment method, if the type is "sepa_debit"
The bic of the sepa mandate
The iban of the sepa mandate
The mandate reference of the sepa mandate
The signing date of the sepa mandate
The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
checkout, customerfront, api, add_link active, action_required, expired, revoked, gateway_unconfigured sepa_debit, card, paypal, bank_transfer, wallet, fake_provider The positions of the invoice.
The creation date of the invoice position item.
The description of the invoice position item.
The discount amount of the invoice position item.
The fixed applied discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The gross amount of the invoice position item, after discount.
The description of the invoice position item.
The net amount of the invoice position item, before discount.
The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.
The creation date of the invoice position item.
The description of the invoice position item.
The discount amount of the invoice position item.
The fixed applied discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The gross amount of the invoice position item, after discount.
The description of the invoice position item.
The net amount of the invoice position item, before discount.
The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.
The creation date of the invoice position item.
The description of the invoice position item.
The discount amount of the invoice position item.
The fixed applied discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The gross amount of the invoice position item, after discount.
The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.
The description of the invoice position item.
The net amount of the invoice position item, before discount.
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 service date from of the invoice position item.
The service date to of the invoice position item.
The tax of the invoice position item, calculated based on the tax group.
The tax amount of the invoice position item, after discount.
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The unit of the invoice position item.
The unit price of the invoice position item.
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 service date from of the invoice position item.
The service date to of the invoice position item.
The tax of the invoice position item, calculated based on the tax group.
The tax amount of the invoice position item, after discount.
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
255Defines if reverse charge will be applicated or not
REVERSE_CHARGE_DEACTIVATED, REVERSE_CHARGE, REVERSE_CHARGE_INTRA_EU_SUPPLY standard, reduced The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The unit price of the invoice position item.
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 service date from of the invoice position item.
The service date to of the invoice position item.
The tax of the invoice position item, calculated based on the tax group.
The tax amount of the invoice position item, after discount.
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
255Defines if reverse charge will be applicated or not
REVERSE_CHARGE_DEACTIVATED, REVERSE_CHARGE, REVERSE_CHARGE_INTRA_EU_SUPPLY standard, reduced The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The unit price of the invoice position item.
The referenced invoice of the invoice. This could be in case of a reminder, refund etc.
The applicated exchange rates of the invoice, fetched from the european central bank.
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
The customer of the invoice.
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
The total net discount amount of the invoice.
Dunning is disabled for this invoice.
reminder, dunning, none The einvoice generated xml file format.
The date and time when the media was created
The file extension of the media
The original file name of the media
Whether the media is public accessible or not
The mime type of the media
The file name of the media in the storage
The unique identifier of the invoice.
The notice of the invoice.
The invoice address of the invoice.
The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.
The net amount of the invoice.
The document id of the invoice. This will be generated, when the invoice will be finalized.
The payment method which should be used to fullfill the payment of the invoice.
The card data of the payment method, if the type is "card"
The brand of the card
The card holder name
The expiration month of the card
The expiration year of the card
The last 4 digits of the card
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing The sepa mandate data of the payment method, if the type is "sepa_debit"
The bic of the sepa mandate
The iban of the sepa mandate
The mandate reference of the sepa mandate
The signing date of the sepa mandate
The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
checkout, customerfront, api, add_link active, action_required, expired, revoked, gateway_unconfigured sepa_debit, card, paypal, bank_transfer, wallet, fake_provider The positions of the invoice.
The creation date of the invoice position item.
The description of the invoice position item.
The discount amount of the invoice position item.
The fixed applied discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The gross amount of the invoice position item, after discount.
The description of the invoice position item.
The net amount of the invoice position item, before discount.
The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.
The creation date of the invoice position item.
The description of the invoice position item.
The discount amount of the invoice position item.
The fixed applied discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The gross amount of the invoice position item, after discount.
The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.
The description of the invoice position item.
The net amount of the invoice position item, before discount.
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 service date from of the invoice position item.
The service date to of the invoice position item.
The tax of the invoice position item, calculated based on the tax group.
The tax amount of the invoice position item, after discount.
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The unit of the invoice position item.
The unit price of the invoice position item.
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 service date from of the invoice position item.
The service date to of the invoice position item.
The tax of the invoice position item, calculated based on the tax group.
Some internal code
Tax rate in percent
0 < x < 100Some internal description
255The tax amount of the invoice position item, after discount.
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
255Defines if reverse charge will be applicated or not
REVERSE_CHARGE_DEACTIVATED, REVERSE_CHARGE, REVERSE_CHARGE_INTRA_EU_SUPPLY standard, reduced The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The unit price of the invoice position item.
The referenced invoice of the invoice. This could be in case of a reminder, refund etc.
The applicated exchange rates of the invoice, fetched from the european central bank.
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
The customer of the invoice.
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
The total net discount amount of the invoice.
Dunning is disabled for this invoice.
reminder, dunning, none The einvoice generated xml file format.
The date and time when the media was created
The file extension of the media
The original file name of the media
Whether the media is public accessible or not
The mime type of the media
The file name of the media in the storage
The unique identifier of the invoice.
The notice of the invoice.
The invoice address of the invoice.
The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.
The net amount of the invoice.
The document id of the invoice. This will be generated, when the invoice will be finalized.
The payment method which should be used to fullfill the payment of the invoice.
The card data of the payment method, if the type is "card"
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing The paypal data of the payment method, if the type is "paypal"
The sepa mandate data of the payment method, if the type is "sepa_debit"
The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
checkout, customerfront, api, add_link active, action_required, expired, revoked, gateway_unconfigured sepa_debit, card, paypal, bank_transfer, wallet, fake_provider The positions of the invoice.
The creation date of the invoice position item.
The description of the invoice position item.
The discount amount of the invoice position item.
The fixed applied discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The gross amount of the invoice position item, after discount.
The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.
The description of the invoice position item.
The net amount of the invoice position item, before discount.
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 service date from of the invoice position item.
The service date to of the invoice position item.
The tax of the invoice position item, calculated based on the tax group.
The tax amount of the invoice position item, after discount.
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The unit of the invoice position item.
The unit price of the invoice position item.
The referenced invoice of the invoice. This could be in case of a reminder, refund etc.
The applicated exchange rates of the invoice, fetched from the european central bank.
The referenced cancellation document.
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
The customer of the invoice.
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
The total net discount amount of the invoice.
Dunning is disabled for this invoice.
reminder, dunning, none The einvoice generated xml file format.
The unique identifier of the invoice.
The notice of the invoice.
The invoice address of the invoice.
The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.
The net amount of the invoice.
The document id of the invoice. This will be generated, when the invoice will be finalized.
The payment method which should be used to fullfill the payment of the invoice.
The positions of the invoice.
The referenced invoice of the invoice. This could be in case of a reminder, refund etc.
The earliest service date of all positions.
The latest service date of all positions.
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.
STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING Public url to view the detailed usage breakdown of this invoice.
The xml representation of the invoice in EN16931 or x-Rechnung format.
The earliest service date of all positions.
The latest service date of all positions.
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.
STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING Public url to view the detailed usage breakdown of this invoice.
The xml representation of the invoice in EN16931 or x-Rechnung format.
The date and time when the media was created
The file extension of the media
The original file name of the media
Whether the media is public accessible or not
The mime type of the media
The file name of the media in the storage
The earliest service date of all positions.
The latest service date of all positions.
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.
STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING Public url to view the detailed usage breakdown of this invoice.
The xml representation of the invoice in EN16931 or x-Rechnung format.
The date and time when the media was created
The file extension of the media
The original file name of the media
Whether the media is public accessible or not
The mime type of the media
The file name of the media in the storage
The earliest service date of all positions.
The latest service date of all positions.
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.
STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING Public url to view the detailed usage breakdown of this invoice.
The xml representation of the invoice in EN16931 or x-Rechnung format.
The date and time when the media was created
The file extension of the media
The original file name of the media
Whether the media is public accessible or not
The mime type of the media
The file name of the media in the storage
The original amount which was requested.
Describes if the transaction is authorized and can be captured.
Describes if the transaction is sucessful processed.
The amount which was charged to the payment method.
The date when the transaction was created.
The currency code of the transaction.
The customer which belongs to the transaction.
The description of the transaction.
The internal reference number of the transaction.
The reason why the transaction failed.
The amount of the transaction fee.
The payment gateway which was used for this transaction.
Possible values:
paypal: PayPal (supports "paypal")stripe: Stripe (supports "card")testing: Testing (supports all)go_cardless: GoCardless (supports "sepa_debit")bank_transfer: Bank Transfer (supports "bank_transfer")sepa_debit: SEPA Credit and Debit with xml file (supports "sepa_debit")wallet: Credit Balance from Wallet (supports "wallet")
The invoice which belongs to the transaction. Can be null if the transaction is not related to an invoice.
The applicated exchange rates of the invoice, fetched from the european central bank.
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
The customer of the invoice.
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
The total net discount amount of the invoice.
Dunning is disabled for this invoice.
reminder, dunning, none The einvoice generated xml file format.
The date and time when the media was created
The file extension of the media
The original file name of the media
Whether the media is public accessible or not
The mime type of the media
The file name of the media in the storage
The unique identifier of the invoice.
The notice of the invoice.
The invoice address of the invoice.
The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.
The net amount of the invoice.
The document id of the invoice. This will be generated, when the invoice will be finalized.
The payment method which should be used to fullfill the payment of the invoice.
The card data of the payment method, if the type is "card"
The brand of the card
The card holder name
The expiration month of the card
The expiration year of the card
The last 4 digits of the card
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing The sepa mandate data of the payment method, if the type is "sepa_debit"
The bic of the sepa mandate
The iban of the sepa mandate
The mandate reference of the sepa mandate
The signing date of the sepa mandate
The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
checkout, customerfront, api, add_link active, action_required, expired, revoked, gateway_unconfigured sepa_debit, card, paypal, bank_transfer, wallet, fake_provider The positions of the invoice.
The creation date of the invoice position item.
The description of the invoice position item.
The discount amount of the invoice position item.
The fixed applied discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The gross amount of the invoice position item, after discount.
The description of the invoice position item.
The net amount of the invoice position item, before discount.
The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.
The creation date of the invoice position item.
The description of the invoice position item.
The discount amount of the invoice position item.
The fixed applied discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The gross amount of the invoice position item, after discount.
The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.
The description of the invoice position item.
The net amount of the invoice position item, before discount.
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 service date from of the invoice position item.
The service date to of the invoice position item.
The tax of the invoice position item, calculated based on the tax group.
The tax amount of the invoice position item, after discount.
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The unit of the invoice position item.
The unit price of the invoice position item.
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 service date from of the invoice position item.
The service date to of the invoice position item.
The tax of the invoice position item, calculated based on the tax group.
Some internal code
Tax rate in percent
0 < x < 100Some internal description
255The tax amount of the invoice position item, after discount.
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
255Defines if reverse charge will be applicated or not
REVERSE_CHARGE_DEACTIVATED, REVERSE_CHARGE, REVERSE_CHARGE_INTRA_EU_SUPPLY standard, reduced The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The unit price of the invoice position item.
The referenced invoice of the invoice. This could be in case of a reminder, refund etc.
The applicated exchange rates of the invoice, fetched from the european central bank.
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
The customer of the invoice.
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
The total net discount amount of the invoice.
Dunning is disabled for this invoice.
reminder, dunning, none The einvoice generated xml file format.
The date and time when the media was created
The file extension of the media
The original file name of the media
Whether the media is public accessible or not
The mime type of the media
The file name of the media in the storage
The unique identifier of the invoice.
The notice of the invoice.
The invoice address of the invoice.
The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.
The net amount of the invoice.
The document id of the invoice. This will be generated, when the invoice will be finalized.
The payment method which should be used to fullfill the payment of the invoice.
The card data of the payment method, if the type is "card"
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing The paypal data of the payment method, if the type is "paypal"
The sepa mandate data of the payment method, if the type is "sepa_debit"
The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
checkout, customerfront, api, add_link active, action_required, expired, revoked, gateway_unconfigured sepa_debit, card, paypal, bank_transfer, wallet, fake_provider The positions of the invoice.
The creation date of the invoice position item.
The description of the invoice position item.
The discount amount of the invoice position item.
The fixed applied discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The gross amount of the invoice position item, after discount.
The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.
The description of the invoice position item.
The net amount of the invoice position item, before discount.
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 service date from of the invoice position item.
The service date to of the invoice position item.
The tax of the invoice position item, calculated based on the tax group.
The tax amount of the invoice position item, after discount.
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The unit of the invoice position item.
The unit price of the invoice position item.
The referenced invoice of the invoice. This could be in case of a reminder, refund etc.
The applicated exchange rates of the invoice, fetched from the european central bank.
The referenced cancellation document.
The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
The customer of the invoice.
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
The total net discount amount of the invoice.
Dunning is disabled for this invoice.
reminder, dunning, none The einvoice generated xml file format.
The unique identifier of the invoice.
The notice of the invoice.
The invoice address of the invoice.
The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.
The net amount of the invoice.
The document id of the invoice. This will be generated, when the invoice will be finalized.
The payment method which should be used to fullfill the payment of the invoice.
The positions of the invoice.
The referenced invoice of the invoice. This could be in case of a reminder, refund etc.
The earliest service date of all positions.
The latest service date of all positions.
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.
STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING Public url to view the detailed usage breakdown of this invoice.
The xml representation of the invoice in EN16931 or x-Rechnung format.
The earliest service date of all positions.
The latest service date of all positions.
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.
STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING Public url to view the detailed usage breakdown of this invoice.
The xml representation of the invoice in EN16931 or x-Rechnung format.
The date and time when the media was created
The file extension of the media
The original file name of the media
Whether the media is public accessible or not
The mime type of the media
The file name of the media in the storage
The earliest service date of all positions.
The latest service date of all positions.
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.
STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING Public url to view the detailed usage breakdown of this invoice.
The xml representation of the invoice in EN16931 or x-Rechnung format.
The date and time when the media was created
The file extension of the media
The original file name of the media
Whether the media is public accessible or not
The mime type of the media
The file name of the media in the storage
The date when the transaction was charged.
The payment method which was used for this transaction.
The card data of the payment method, if the type is "card"
The brand of the card
The card holder name
The expiration month of the card
The expiration year of the card
The last 4 digits of the card
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing The sepa mandate data of the payment method, if the type is "sepa_debit"
The bic of the sepa mandate
The iban of the sepa mandate
The mandate reference of the sepa mandate
The signing date of the sepa mandate
The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
checkout, customerfront, api, add_link active, action_required, expired, revoked, gateway_unconfigured sepa_debit, card, paypal, bank_transfer, wallet, fake_provider Describes if the transaction is currently processing and cannot perform any actions.
The reference id of the payment provider.
Describes if the transaction is refundable.
The amount which was refunded.
The status of the transaction.
Possible values:
new: The transaction is new and not yet processed. A new transaction is created when a payment is initiated.authorized: The transaction is authorized and can be captured.authorizing: The transaction is authorizing. No actions can be performed on the transaction.waiting: The transaction is waiting for a response from the payment provider, or a customer input. No actions can be performed on the transaction.offsite_authorization_required: The transaction requires an offsite authorization, e.g. 3D Secure. The customer is informed about the required authorization and redirected to the payment provider.booked: The transaction is captured and booked on the account.captured: The transaction is captured and will be booked on the account.dispute: The transaction is disputed.manual: Legacy status. Do not use.canceled: The transaction is canceled, e.g. by the customer during the payment process, or by the merchant.pending: The transaction is pending, and will be processed soon by the payment provider.expired: The transaction is expired, e.g. because the customer did not complete the payment process in time.processing: The transaction is processing, e.g. because the payment provider is currently processing the payment.failed: The transaction failed, e.g. because the payment provider could not process the payment.unknown: The transaction status is unknown.refunded: The transaction is fully refunded.payedout: The transaction was a payout.partial_refunded: The transaction is partially refunded.refund_failed: The transaction refund failed.
payment, refund Was this page helpful?