Dokumentation

Blog

Authorization

Fynn Docs

Integrationen

API Referenz

Changelog

App Login

Termin buchen

Support

Retrieves the collection of Account resources.

Get all accounts of the current tenant.

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

Finde schnell und einfach die gewünschten Informationen.

Suche

Verfolge Aktivitäten und hinterlasse Kommentare zu wichtigen Ereignissen.

Aktivitätsprotokoll

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

Register a new user

Complete the user registration

Required permissions: `user:write`

Complete the user registration

Get the current user's accounts

Set the default tenant of the current user

Required permissions: `user:write`

Set the default tenant of the current user

Get all login activities.

Required permissions: `user:read`

Get all login activities

Get the current user

Required permissions: `user:read`

Get the current user

Get all api tokens

Required permissions: `user:api-token:read`

Get all api tokens

Create a new api token for this user. This token can be used to authenticate against the API. The token has the same privileges as the current user account, assigned to tenant.

Required permissions: `user:api-token:write`

Create api token

Delete an api token

Required permissions: `user:api-token:write`

Delete api token

Create a new tenant

Retrieves a Tenant resource.

Required permissions: `tenant:manager`

Get a tenant

Updates the Tenant resource.

Required permissions: `tenant:manager`

Update a tenant

Retrieves the collection of Tenant resources.

Required permissions: `ROLE_USER`

Get the tenants of the current user

Create feature

Update feature

Update feature status

Retrieves the collection of Feature resources.

Get features

Get feature

Assign feature

Unassign a feature. Existing entitlements **will not** be removed from the subscriptions.

Unassign feature

Get feature assignments

Get all current available features for a subscription

Get available features

Add subscription entitlement

Get subscription entitlements

Add subscription item entitlement

Get all entitlements of a subscription item

Get subscription item entitlements

Update entitlement status

Delete entitlement

Deactivates an account. The account will not have any access to the tenant anymore. You cannot deactivate your own account.

Required permissions: `account:deactivate`

Deactivate account

Reactivates an account. The account will have access again to their tenant.

Required permissions: `account:reactivate`

Reactivate account

Update the role of an account. The changes will apply immediately after the next page navigation of the user. You cannot change the role of your own account.

Required permissions: `account:role:write`

Update account role

Get all settings of the context

Required permissions: `settings:read`

Get settings

Update given setting key of the context.

Required permissions: `settings:write`

Update settings key

Get all medias

Required permissions: `media:read`

Get all medias

Upload a file

Required permissions: `media:write`

Upload a file

Get all media folders

Required permissions: `media:read`

Get media folders

Get a media by id

Required permissions: `media:read`

Get a media

Create token to download media file by get request and without another authentication.

Required permissions: `media:read`

Create download token

Download a media by download token. **No authentication required**

Download by token

Get available webhook events

Required permissions: `webhook:read`

Get available webhook events

Get webhook results

Required permissions: `webhook:read`

Get webhook results

Get webhook result

Required permissions: `webhook:read`

Get webhook result

Get webhooks

Required permissions: `webhook:read`

Get webhooks

Add webhook

Required permissions: `webhook:write`

Add webhook

Get webhook

Required permissions: `webhook:read`

Get webhook

Delete webhook and all related webhook results

Required permissions: `webhook:write`

Delete webhook

Update webhook

Required permissions: `webhook:write`

Update webhook

Get notifications

Get a notification

Get customer's payment methods.

Required permissions: `payment-method:read`, `customer:payment-method:read`

Get customer's payment methods

Create a customer's payment method

Required permissions: `payment-method:add`

Create payment method

Assigns stripe customer ids to fynn customers, which are matched by email. After that, all **not expired** and **attached** payment methods will be created in fynn.

Required permissions: `payment-method:migrate`

Migrate stripe payment methods

Upload a document for a payment method, e.g. a signed sepa mandate

Required permissions: `payment-method:write`

Upload a document for a payment method

Create a link to request the customer to add a new payment method. The link can be sent to the customer via email.

Required permissions: `payment-method:add`

Create payment method link

Get a list of payment transactions, which represents a payment, refund or payout.

Required permissions: `transaction:read`

Get transactions

Get a payment transaction, which represents a payment, refund or payout.

Get transaction

Returns a list of generated SEPA XML files.

Required permissions: `sepa-xml:read`

Get a list of SEPA XML files

Generates a SEPA XML file from unprocessed sepa xml payments.
The generated SEPA XML file needs to be uploaded to the bank **manually**.
**After uploading the SEPA XML file to the bank, you need to mark the SEPA XML file as uploaded.**
The SEPA XML file can contain *direct debits* and *credit* transfers.
Credit transfers is used for (partial) refunds.

The generated SEPA XML file is returned as zip file and can be redownloaded later.

Required permissions: `sepa-xml:write`

Generate a SEPA XML file

Returns a generated SEPA XML file.

Required permissions: `sepa-xml:read`

Get a SEPA XML file

Deletes a SEPA XML file and the associated media file. The deletion is only allowed, when the `uploaded` property is `false`. All related payment transactions will be marked as unprocessed and can be used for a new SEPA XML file.

Required permissions: `sepa-xml:write`

Delete a SEPA XML file

Marks a SEPA XML file as uploaded to the bank. This means, that the SEPA XML file was uploaded to the bank already. All related payment transactions will be marked as waiting, until the grace period of the bank is over. You cannot regenerate the SEPA XML file, when it was marked as uploaded.

Required permissions: `sepa-xml:write`

Mark a SEPA XML file as uploaded

Get a Sepa XML payment

Connect Klarna to allow fetching transactions from your bank account

Required permissions: `open-banking:fetch-transactions`

Connect Klarna

Get all connected open banking accounts, which allows to access transactions, balances and other information

Required permissions: `open-banking-account:read`

Get connected open banking accounts

Get open banking account details.

Required permissions: `open-banking-account:read`

Get open banking account

Disconnect an open banking account, to prevent further access to the account information

Required permissions: `open-banking-account:write`

Disconnect open banking account

Get a bank account transaction assignment, which shows the match between a bank account transaction and an invoice.

Get a bank account transaction assignment

Get the bank account transactions. Bank account transactions are synchronized (e.g. by <a href="#tag/Open-Banking/operation/connectKlarna">Klarna Sync</a>) or uploaded statements from the bank account.
The bank account transactions are matched with invoices and transactions. 
If the bank account transaction is not matched, it is shown in the list of bank account transactions with the status "matching required".
If the bank account transaction is matched, it is shown in the list of bank account transactions with the status "booked" or "outstanding amount".
If the bank account transaction is ignored, the transaction won't be processed and is not shown in the list of bank account transactions anymore.

Required permissions: `bank-account-transaction:read`

Get bank account transactions

Accept the suggestions for the bank account transaction. 
This will create a new transaction with the remaining bank transaction amount upto the unpaid invoice amounts.
When the bank transaction has a remaining amount, you can assign that to other invoices.

Required permissions: `bank-account-transaction:write`

Accept the suggestions

Ignore bank account transactions. The transaction will not be processed and showed in the list of transactions.
This is useful for transactions that are not relevant for the business, e.g. incoming payments for rentals.
Otherwise you can hide a bank transaction which is already assigned and has an outstanding, not mappable amount.

Required permissions: `bank-account-transaction:write`

Ignore bank account transactions.

Retrieves a BankAccountTransaction resource.

Required permissions: `bank-account-transaction:read`

Get the status count of the bank account transactions

Get the bank account transaction details with all the assigned invoices and transactions.

Required permissions: `bank-account-transaction:read`

Get bank account transaction details

Assign invoices to the bank account transaction. 
This will create a new transaction with the remaining bank transaction amount upto the unpaid invoice amount.
When the bank transaction has a remaining amount, you can assign that to other invoices.

Required permissions: `bank-account-transaction:write`

Assign invoices to the bank account transaction.

Get series data for analytics. Supported types are: customer, offer, subscription, revenue, signed-offer, open-offer.

Required permissions: `analytics:read`

Get series data

Get series data for subscription analytics, including MRR, new-MRR, expansion-MRR, churn-MRR. The result has one data-point for each currency and date combination. The data-point contains the MRR, new-MRR, expansion-MRR, and churn-MRR for the given currency and date.

Required permissions: `analytics:read`

Get series data for subscription

Get customers

Required permissions: `customer:read`

Get customers

Create customer

Required permissions: `customer:write`

Create customer

Get customer

Required permissions: `customer:read`, `customer:self:read`

Get customer

Update customer

Required permissions: `customer:write`

Update customer

Archives a customer. The customer is not visible anymore in the customer list.

Required permissions: `customer:write`

Archive customer

Deletes a customer. The customer can only be deleted if there are no invoices, active subscriptions or booked payments related to this customer. Otherwise you can only archive the customer.

Required permissions: `customer:write`

Delete customer

Add comment

Required permissions: `customer:write`

Add comment

Get a customer address

Required permissions: `customer:read`

Get a customer address

Update a customer address

Required permissions: `customer:write`

Update a customer address

Delete a customer address

Required permissions: `customer:write`

Delete a customer address

Set a customer address as default. The default will be set only for the address type of the given address.

Required permissions: `customer:write`

Set a customer address as default

Unset a customer address as default. This is only possible for the default address of the type "TYPE_INVOICE". Then the default address will be used as default invoice address.

Required permissions: `customer:write`

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Get all accounts of the current tenant.

Authorizations

Query Parameters

Response