> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fynn.eu/llms.txt
> Use this file to discover all available pages before exploring further.
# Get bank account transactions
> Get the bank account transactions. Bank account transactions are synchronized (e.g. by Klarna Sync) 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`
## OpenAPI
````yaml get /payment/bank-account-transactions
openapi: 3.1.0
info:
title: Fynn API
description: ''
termsOfService: https://www.fynn.eu/tos
contact:
name: Fynn UG (haftungsbeschränkt)
url: https://www.fynn.eu
email: hi@fynn.eu
license:
name: Proprietary
url: https://www.fynn.eu/license
version: 0.0.0
servers:
- url: https://coreapi.io
description: Production
- url: https://preview.coreapi.io
description: Sandbox
security:
- JWT: []
tags: []
paths:
/payment/bank-account-transactions:
parameters: []
get:
tags:
- BankAccountTransaction
summary: Get bank account transactions
description: >-
Get the bank account transactions. Bank account transactions are
synchronized (e.g. by Klarna Sync) 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`
operationId: getBankAccountTransactions
parameters:
- name: page
in: query
description: The collection page number
required: false
deprecated: false
allowEmptyValue: true
schema:
type: integer
default: 1
style: form
explode: false
allowReserved: false
- name: limit
in: query
description: The number of items per page
required: false
deprecated: false
allowEmptyValue: true
schema:
type: integer
default: 30
minimum: 0
maximum: 100
style: form
explode: false
allowReserved: false
- name: status
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: string
style: form
explode: false
allowReserved: false
- name: status[]
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: array
items:
type: string
style: form
explode: true
allowReserved: false
- name: order[receivedAt]
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: string
enum:
- asc
- desc
style: form
explode: false
allowReserved: false
- name: order[bookingDate]
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: string
enum:
- asc
- desc
style: form
explode: false
allowReserved: false
- name: order[bookedAt]
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: string
enum:
- asc
- desc
style: form
explode: false
allowReserved: false
responses:
'200':
description: BankAccountTransaction collection
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: >-
#/components/schemas/BankAccountTransaction-BankAccountTransactionRead
meta:
type: object
properties:
pagination:
type: object
properties:
totalItems:
type: integer
itemsPerPage:
type: integer
currentPage:
type: integer
lastPage:
type: integer
pageTotalItems:
type: integer
text/html:
schema:
type: array
items:
$ref: >-
#/components/schemas/BankAccountTransaction-BankAccountTransactionRead
deprecated: false
security:
- JWT:
- bank-account-transaction:read
x-codeSamples:
- lang: bash
label: cURL
source: |-
curl -X GET \
/payment/bank-account-transactions \
--header "Authorization: Bearer "
components:
schemas:
BankAccountTransaction-BankAccountTransactionRead:
type: object
description: ''
deprecated: false
properties:
id:
readOnly: true
example: ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c
type: string
description: Unique identifier of the bank account
suggestedInvoice:
readOnly: true
anyOf:
- $ref: '#/components/schemas/Invoice-BankAccountTransactionRead'
- type: 'null'
suggestedCustomer:
readOnly: true
anyOf:
- $ref: '#/components/schemas/Customer-BankAccountTransactionRead'
- type: 'null'
valueDate:
type: string
format: date-time
bookingDate:
type: string
format: date-time
paymentDate:
type: string
format: date-time
usageDescription:
example: Kundennummer 1234567890 Rechnung 1234567890
type: string
endToEndId:
example: '1234567890'
type:
- string
- 'null'
counterParty:
anyOf:
- $ref: '#/components/schemas/BankAccount-BankAccountTransactionRead'
- type: 'null'
amount:
$ref: '#/components/schemas/MoneyEmbedded-BankAccountTransactionRead'
fee:
$ref: '#/components/schemas/MoneyEmbedded-BankAccountTransactionRead'
readOnly: true
status:
type: string
enum:
- STATUS_RECEIVED
- STATUS_BOOKED
- STATUS_MANUAL_MATCHING_REQUIRED
- STATUS_IGNORED
- outstanding_amount
- suggestions_available
receivedAt:
readOnly: true
type: string
format: date-time
bookedAt:
readOnly: true
type:
- string
- 'null'
format: date-time
mandateId:
readOnly: true
example: MAN1234567890
type:
- string
- 'null'
source:
readOnly: true
description: The source of the bank account transaction.
example: klarna
enum:
- klarna
type:
description: The type of the bank account transaction.
example: debit
enum:
- debit
- credit
transactionCode:
description: >-
The transaction code as defined in ISO 20022. See:
https://www.iso20022.org/sites/default/files/2020-08/BTC_ExternalCodeListDescription_31Aug2020.doc
example: RCDT
type:
- string
- 'null'
unassignedAmount:
$ref: '#/components/schemas/Money-BankAccountTransactionRead'
readOnly: true
description: >-
The amount that is not assigned to any invoice or transaction. Can
be negative if the bank transaction is assigned to invoices and
transactions with a higher amount than the bank transaction amount.
Invoice-BankAccountTransactionRead:
type: object
description: ''
deprecated: false
properties:
id:
readOnly: true
description: The unique identifier of the invoice.
example: 00000000-0000-0000-0000-000000000000
type: string
format: uuid
customer:
$ref: '#/components/schemas/Customer-BankAccountTransactionRead'
description: The customer of the invoice.
paymentMethod:
description: >-
The payment method which should be used to fullfill the payment of
the invoice.
anyOf:
- $ref: '#/components/schemas/PaymentMethod-BankAccountTransactionRead'
- type: 'null'
type:
description: The type of the invoice.
example: TYPE_INVOICE
enum:
- TYPE_INVOICE
- TYPE_CREDIT
- TYPE_REFUND
- TYPE_REMINDER
- TYPE_CANCEL
- TYPE_DUNNING
currencyCode:
description: >-
The currency code of the invoice. If multiple currency codes will be
used in the positions, they will be converted to that base currency.
example: EUR
type: string
number:
readOnly: true
description: >-
The document id of the invoice. This will be generated, when the
invoice will be finalized.
example: RE-0000000001
type: string
status:
readOnly: true
type: string
enum:
- STATUS_DRAFT
- STATUS_PAID
- STATUS_CANCELLED
- STATUS_CLOSED
- STATUS_REFUNDED
- STATUS_REMINDED
- STATUS_UNPAID
- STATUS_NEW
- STATUS_FINALIZING
finalizationDate:
readOnly: true
type:
- string
- 'null'
format: date-time
dueDate:
type:
- string
- 'null'
format: date-time
dunningLevel:
readOnly: true
type: integer
dunningStatus:
readOnly: true
default: none
example: none
type: string
enum:
- reminder
- dunning
- none
payDate:
readOnly: true
type:
- string
- 'null'
format: date-time
invoiceAddress:
readOnly: true
description: The invoice address of the invoice.
nullable: true
internalNote:
description: The notice of the invoice.
deprecated: true
example: This invoice is with a special discount.
type:
- string
- 'null'
netAmount:
$ref: '#/components/schemas/MoneyEmbedded-BankAccountTransactionRead'
readOnly: true
description: The net amount of the invoice.
grossAmount:
$ref: '#/components/schemas/MoneyEmbedded-BankAccountTransactionRead'
readOnly: true
taxAmount:
$ref: '#/components/schemas/MoneyEmbedded-BankAccountTransactionRead'
readOnly: true
customFields:
additionalProperties:
type: string
type:
- object
- 'null'
example:
field1: value1
field2: value2
description: >-
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](/guide/tenant/custom-fields)
unpaidAmount:
$ref: '#/components/schemas/Money-BankAccountTransactionRead'
readOnly: true
Customer-BankAccountTransactionRead:
type: object
description: ''
deprecated: false
properties:
id:
readOnly: true
example: 00000000-0000-0000-0000-000000000000
type: string
customerNumber:
minLength: 2
maxLength: 255
example: CUSTOMER-000
nullable: false
timeZone:
readOnly: true
default: Europe/Berlin
example: Europe/Berlin
type: string
firstName:
minLength: 2
maxLength: 255
description: Can be empty if the customer is a company.
example: John
nullable: true
lastName:
minLength: 2
maxLength: 255
description: Can be empty if the customer is a company.
example: Doe
nullable: true
currencyCode:
description: >-
Can be empty. In this case the default currency of the tenant is
used.
externalDocs:
url: https://schema.org/priceCurrency
example: EUR
type: string
companyName:
minLength: 2
maxLength: 255
example: Acme Inc.
type:
- string
- 'null'
datevId:
minLength: 2
maxLength: 255
description: The ID of the customer in DATEV
example: '123456789'
type:
- string
- 'null'
status:
default: STATUS_ACTIVE
example: STATUS_ACTIVE
enum:
- STATUS_ACTIVE
- STATUS_ARCHIVED
- STATUS_SUSPENDED
BankAccount-BankAccountTransactionRead:
type: object
description: ''
deprecated: false
properties:
id:
readOnly: true
example: ad8f0b9c-4b1e-4e0e-8b9c-4b1e4e0e8b9c
type: string
description: Unique identifier of the bank account
alias:
example: Girokonto
type:
- string
- 'null'
iban:
example: DE12500105170648489890
type: string
description: The IBAN of the bank account
bic:
example: PBNKDEFFXXX
type: string
description: The BIC/SWIFT code of the bank
accountHolder:
example: Max Mustermann
type: string
description: The name of the account holder
bankName:
example: Commerzbank
type: string
description: The name of the bank
MoneyEmbedded-BankAccountTransactionRead:
type: object
description: ''
deprecated: false
Money-BankAccountTransactionRead:
type: object
description: ''
deprecated: false
PaymentMethod-BankAccountTransactionRead:
type: object
description: ''
deprecated: false
properties:
id:
readOnly: true
type: string
description: Unique identifier of the payment method
example: c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b
gatewayName:
type: string
enum:
- wallet
- sepa_debit
- stripe
- fake_provider
- paypal
- bank_transfer
- go_cardless
- testing
description: The payment gateway used to process the payment method
type:
type:
- string
- 'null'
enum:
- sepa_debit
- card
- paypal
- bank_transfer
- wallet
- fake_provider
- null
description: The type of the payment method
default:
type: boolean
description: Whether this is the default payment method for the customer
example: true
status:
default: active
example: active
type: string
enum:
- active
- action_required
- expired
- revoked
- gateway_unconfigured
description: The current status of the payment method
enabled:
type: boolean
description: Whether the payment method is enabled for use
example: true
name:
type:
- string
- 'null'
description: Display name of the payment method
example: Visa (4242)
creationDate:
readOnly: true
type: string
format: date-time
description: The date when the payment method was created
example: '2024-01-15T10:30:00+00:00'
expirationDate:
type:
- string
- 'null'
format: date-time
description: The expiration date of the payment method, if applicable
example: '2026-12-31T23:59:59+00:00'
card:
readOnly: true
description: The card data of the payment method, if the type is "card"
type: object
properties:
brand:
type: string
example: Visa
description: The brand of the card
last4:
type: string
example: '4242'
description: The last 4 digits of the card
expMonth:
type: integer
example: 12
description: The expiration month of the card
expYear:
type: integer
example: 2022
description: The expiration year of the card
cardHolder:
type: string
example: Max Mustermann
description: The card holder name
sepaDebit:
readOnly: true
description: >-
The sepa mandate data of the payment method, if the type is
"sepa_debit"
type: object
properties:
iban:
type: string
example: DE8937*********3232
description: The iban of the sepa mandate
bic:
type: string
example: COBADEFFXXX
description: The bic of the sepa mandate
mandateReference:
type: string
example: MNDT-2021-123456
description: The mandate reference of the sepa mandate
signingDate:
type: string
example: '2021-01-01T00:00:00+00:00'
description: The signing date of the sepa mandate
paypal:
readOnly: true
description: The paypal data of the payment method, if the type is "paypal"
type: object
properties:
email:
type: string
example: max@mustermann.de
description: The email of the paypal account
billingAgreementId:
type: string
example: I-1J5gqz2eZvKYlo2C2X2X2X2X
description: The billing agreement id of the paypal account
securitySchemes:
JWT:
type: http
scheme: bearer
````