Dokumentation

Blog

Authorization

Fynn Docs

Integrationen

API Referenz

Changelog

App Login

Termin buchen

Support

Can be empty. In this case the default currency of the tenant is used.

Can be empty if the customer is a company.

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 total net discount amount of the invoice.

The amount as big integer, e.g. 1000 = 10.00 (precision = 2), 10000 = 10.000 (precision = 3)

Amount which can be used as input value, e.g. 10.00, 10.000.

The precision of the amount, which is the number of digits after the decimal separator, e.g. 2 = 10.00, 3 = 10.000

The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.

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 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.

Public url to view the detailed usage breakdown of this invoice.

Additional address information, which will be shown on generated documents like invoices, reminders, etc.

Company name, which will be used to bill to.

Cost centre, which will be shown on generated documents like invoices, reminders, etc.

Customer address id, from which this invoice address was created.

First name, which will be shown on generated documents like invoices, reminders, etc.

Last name, which will be shown on generated documents like invoices, reminders, etc.

VAT ID, which will be shown on generated documents like invoices, reminders, etc.

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 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 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 unit price of the invoice position item.

The date and time when the media was created

Whether the media is public accessible or not

The file name of the media in the storage

The card data of the payment method, if the type is "card"

The paypal data of the payment method, if the type is "paypal"

The billing agreement id of the paypal account

The sepa mandate data of the payment method, if the type is "sepa_debit"

The mandate reference of the sepa mandate

The sepa mandate of the payment method, if the gatewayName is "payment_sepa"

The description of the product based on the current tenant language.

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.


The name of the product based on the current tenant language. This will be displayed on customer communication.

The type of the product.
 - `product`: recurring billed product
 - `charge`: one-time billing
 - `plan`: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.


The description of the item which will be used in the invoice. The description is translated based on the customer's locale.

Further information defines additional information for the item which will be displayed in the invoice.

The name of the item which will be used in the invoice. The name is translated based on the customer's locale.

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.

The name of the tax group which will be displayed only in the UI

Defines if reverse charge will be applicated or not

Get all invoices. If the user is authenticated as customer (e.g. by the customerfront) the invoices are filtered by their customer.

<sup>Required permissions: `invoice:read`</sup>

Get invoices

Willkommen bei Fynn! Hier findest du alles, was du brauchst, um loszulegen.

Willkommen 👋

Richte deine Organisation ein, um mit der Abonnementabrechnung zu beginnen.

Erste Einrichtung

Organisation einrichten

Benutzer verwalten

Nummernkreise

Passe das Aussehen an deine Unternehmensfarben und Design an.

Aussehen

Währungen verwalten und automatisch umrechnen

Währungen

Zahlungsmethoden

Konfiguriere Benachrichtigungen und E-Mails.

Benachrichtigungen

Passe die Web-Oberfläche an, um Arbeitsprozesse zu optimieren.

Web-Oberfläche

Web-Oberfläche anpassen

Erstelle benutzerdefinierte Attribute für verschiedene Objekte.

Benutzerdefinierte Attribute

Welcome to the API reference documentation for the Fynn API.

Getting started

All API endpoints are authenticated using Bearer tokens and picked up from the specification file.

Authentication

Learn how to manage payment methods on your own payment page.

Manage payment methods on your own payment page

Collect usage data

Learn how to enable manual invoice checks for all customers.

Enable manual invoice checks

Wir bieten dir eine Vielzahl von Integrationen zu 3rd-Party-Tools und -Services, um die Funktionalität der Fynn-Plattform zu erweitern.

API documentation

User

Tenant

User & permissions

Settings

Payment

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Get invoices

Authorizations

Query Parameters

Response