Skip to content
/kontera/dev

API Reference

All exports using Universal Accounting consist of the following fields / data. Please reference the individual formats to get an example of a specific export structure.

General

konteraId
Required type: string

Id of a business transaction.

  • Type: string

Invoice

Information about the receipt / invoice are summed up in the invoice object. This is an optional field and might be null.

invoice
Optional type: object
number
Optional type: string
  • CSV-Header: invoice-number
date
Optional type: string
  • CSV-Header: invoice-date
  • Date in ISO-format YYYY-MM-DD
payableUntil
Optional type: string
  • CSV-Header: invoice-payableUntil
  • Date in ISO-format YYYY-MM-DD
billingPeriod
Optional type: object
from
Required type: string
  • CSV-Header: invoice-billingPeriod_from
  • Date in ISO-format YYYY-MM-DD
to
Required type: string
  • CSV-Header: invoice-billingPeriod_to
  • Date in ISO-format YYYY-MM-DD
qrReferenceNumber
Optional type: string
  • CSV-Header: invoice-qrReferenceNumber
  • 🇨🇭-only
  • accounts-receivables only
owner
Optional type: string
  • CSV-Header: invoice-owner
source
Optional type: string
  • CSV-Header: invoice-source
sourceId
Optional type: string
  • CSV-Header: invoice-sourceId

Contact

contacts
Required type: array
contactId
Required type: string

Unique ID within kontera. You must provide this value together with an externalId generated by your system if you have added contacts into your system and are re-importing those contacts, to avoid duplication.

  • UUID
  • CSV-Header: contact-contactId
externalId
Optional type: string

Internal ID of your project in your accounting system. kontera uses this ID to uniquely identify your project, and will reference it in the export.

  • Min: 1 character
  • Max: 36 characters
  • CSV-Header: contact-externalIdd
legalType
Required type: enum

Describes the type of legal entity the contacts represents.

  • Allowed values:
    • company
    • person
  • CSV-Header: contact-legalType
supplierType
Optional type: enum

Describes what kind of contact it is. Used by certain accounting systems with split contact pools.

  • Allowed values:
    • accounts-payable
    • accounts-receivable
  • CSV-Header: contact-supplierType
companyName
Optional type: string

Required if legalType = company

  • Min: 1 character
  • Max: 255 characters
  • CSV-Header: contact-companyName
companyUid
Optional type: string

Company UID.

  • Min: 1 character
  • Max: 255 characters
  • CSV-Header: contact-companyUid
companyTaxNumber
Optional type: string

VAT Number of your company.

  • Min: 1 character
  • Max: 255 characters
  • CSV-Header: contact-companyTaxNumber
firstName
Optional type: string

Required if legalType = person

  • Min: 1 character
  • Max: 255 characters
  • CSV-Header: contact-firstName
lastName
Optional type: string

Required if legalType = person

  • Min: 1 character
  • Max: 255 characters
  • CSV-Header: contact-lastName
address
Optional type: object
street
Optional type: string

Name of street.

  • Min: 1 character
  • Max: 255 characters
  • CSV-Header: contact-address
street
Optional type: string

Name of street.

  • Min: 1 character
  • Max: 255 characters
  • CSV-Header: contact-address-street
houseNumber
Optional type: string

House number.

  • Min: 1 character
  • Max: 255 characters
  • CSV-Header: contact-address-houseNumber
postalCode
Optional type: string

Postal code / ZIP code.

  • Min: 1 character
  • Max: 255 characters
  • CSV-Header: contact-address-postalCode
city
Optional type: string

Name of city.

  • Min: 1 character
  • Max: 255 characters
  • CSV-Header: contact-address-city
country
Optional type: string

Country.

  • 2-letter ISO3166 code
  • CSV-Header: contact-address-country

Payment Advises

paymentAdvises
Required type: array
account
Required type: object
number
Required type: string
  • Example: 2000 / 1020
externalId
Optional type: string
currency
Optional type: string

3-character ISO currency code.

executionDate
Required type: string
  • Date in ISO-format YYYY-MM-DD
amount
Required type: string
  • Example: 25.50
currency
Required type: string

3-character ISO currency code.

type
Required type: enum

What kind of payment it is.

  • Allowed values:
    • qr, swiss qr bill
    • iban, iban payment
iban
Required type: string

IBAN of the recipient.

reference
Optional type: string

Reference number of the payment (SCOR).

fee
Optional type: enum

Who pays the fee. May be null, in case of domestic payments.

  • Allowed values:
    • receiver-pays
    • sender-pays
    • splitted
message
Optional type: string
recipient
Required type: object
name
Required type: string
  • Example: Kontera GmbH
street
Optional type: string
  • Example: Debit-Credit-Street
houseNumber
Optional type: string
  • Example: 12
houseNumber
Optional type: string
  • Example: 12
postalCode
Optional type: string
  • Example: 8000
city
Optional type: string
  • Example: Zurich
country
Optional type: string

Country.

  • 2-letter ISO3166 code

Entries

Journal entries are collected in the entries array.

entries
Required type: array
entryId
Required type: string

Unique identifier of a journal entry.

  • CSV-Header: entry-entryId
  • Example: K-XYZ-1
entryNumber
Required type: number

Number of a journal entry within the transaction.

  • CSV-Header: entry-entryNumber
  • Example: 1
type
Required type: enum
  • CSV-Header: entry-type
  • Allowed values
    • profit-loss-to-payment (direct)
    • profit-loss-to-collective-account (to collective account)
    • collective-account-to-payment (from collective account)
    • fee-to-payment (fee)
date
Required type: string
  • CSV-Header: entry-date
  • Date in ISO-format YYYY-MM-DD

Lines

lines
Required type: array
lineId
Required type: string

The unique identifier of the journal entry line.

  • CSV-Header: entry-lineId
  • Example: K-XYZ-C-1
lineNumber
Required type: number

The number of the journal entry line.

  • CSV-Header: entry-lineNumber
  • Example: 1
creditDebit
Optional type: string
  • Note: Not applicable for CSV. It is split in debitAccount + creditAccount (see account for reference)
  • Allowed Values:
  • credit
  • debit
amount
Required type: string
  • CSV-Header: entry-amount
  • Example: 25.50
currency
Required type: string

Matches the lead currency of your accounting system. 3-character ISO currency code.

amountInAccountCurrency
Optional type: string

Depending on your accounting system, certain accounts might be in other currencies than your lead currency. If this is the case, and the currency used in the journal entry line (which matches the lead currency of your accounting system) does not match the account, this amount represents the value of the transaction in the currency of the chosen account.

  • Note: Not applicable for CSV
  • Example: 30.25
account
Required type: object
number
Required type: string
  • CSV-Header: debitAccount-number / creditAccount-number
  • Example: 2000 / 1020
externalId
Optional type: string
  • CSV-Header: debitAccount-externalId / creditAccount-externalId
currency
Optional type: string

3-character ISO currency code.

tax
Optional type: object
code
Optional type: string
  • CSV-Header: entry-tax-code
  • Example: VB77
externalId
Optional type: string
  • CSV-Header: entry-tax-externalId
  • Example: 1
  • Corresponds to externalId that was given during import.
value
Optional type: string

Value of tax, given in % (0-100).

  • CSV-Header: entry-tax-value
  • Example: 7.7
type
Optional type: enum
  • CSV-Header: entry-tax-type
  • Allowed values:
    • unknown
    • pre-tax
    • pre-tax-original-production
    • reverse-charge-pre-tax
    • sales-tax
originalAmount
Optional type: string

The amount that was specified on the original invoice / receipt.

  • CSV-Header: entry-originalAmount
  • Example: 30.25
originalCurrency
Optional type: string

The currency that was specified on the original invoice / receipt. 3-character ISO currency code.

text
Required type: string
  • CSV-Header: entry-text
  • Content can be configured via Settings -> Accounting system
dimensions
Required type: array
name
Optional type: string

Name der Dimension.

  • CSV-Header: entry-dimensions-{number}-name
externalId
Optional type: string

  • Corresponds to externalId that was given during import.

  • CSV-Header: entry-dimensions-{number}-externalId

type
Optional type: enum
  • CSV-Header: entry-dimensions-{number}-type
  • Allowed values:
    • cost-center
    • project

Files

files
Optional type: array
konteraId
Required type: string
name
Required type: string

Name of the uploaded file.

  • Example: Swisscom.pdf
contentType
Required type: string
  • Example: application/pdf
contentAsBase64
Required type: string

Content of the file as base64 encoded string.