Documentation

Create journal entries overview

This page contains an overview of the logic and rules when creating journal entries.

Suggest Edits

✏️

Overview page.

This page contains an overview of the permitted payloads for the different entry types, when using the endpoint to create journal entries.

Reference this page when experiencing issues with the endpoint to check if the setup is correct.

Supplier entries

View the payload examples and general rules below, or expand a the property description to view the details of supplier properties.

Supplier invoice

General rules for supplier invoice entries:

  • "supplierUid" is required on the "entryLine" with the "SUPPLIER" type.
  • Payload must contain only 1 "SUPPLIER" type "entryLine", and at least 1 "EXPENSE" "entryLine".
  • "financeAccountUid" is required on the "entryLine" with "EXPENSE" type.

Payload examples:

{
    "date": "2024-01-02",
    "currencyCode": "DKK",
    "entryLines": [
        {
            "amount": 1999.5,
            "supplierUid": "e75a5145-c059-4dd6-b130-46ae4f330771",
            "type": "SUPPLIER"
        },
        {
            "amount": -1999.5,
            "financeAccountUid": "ac838618-6d65-4f84-bab6-9995611235c3",
            "type": "EXPENSE"
        }
    ]
}

{
    "sequenceId": "SE1",
    "date": "2024-01-02",
    "externalId": "Custom_Supplier_Expense_Id_1",
    "currencyCode": "DKK",
    "entryLines": [
        {
            "description": "Supplier expense main line",
            "amountInBase": 1999.5,
            "amount": 1999.5,
            "supplierUid": "e75a5145-c059-4dd6-b130-46ae4f330771",
            "type": "SUPPLIER"
        },
        {
            "description": "Supplier expense sub line",
            "amountInBase": -1999.5,
            "amount": -1999.5,
            "financeAccountUid": "ac838618-6d65-4f84-bab6-9995611235c3",
            "vatGroupUid": "cb3ae369-e161-488d-9973-1eeaeef5461c",            
            "type": "EXPENSE"
        }
    ]
}
Property description.

Use the table below to see the required/optional properties for supplier invoice entries

Required Property Description
:x: sequenceId Sequence id of entry seqence. Value will be defined using the journal number mask if omitted or null.
:white-check-mark: date Date of entry seqence.
:x: dueDate Due date of entries. No value if omitted or null.
:x: invoiceNumber Invoice number of entries. No value if omitted or null.
:x: externalId Custom external id of entries. No value if omitted or null.
:white-check-mark: currencyCode Currency of entries as ISO 4217 standard codes.
entryLines
:x: description Description of individual entry. No value if omitted or null.
:x: amountInBase Amount in base currency of individual entry. When "currencyCode" differs from base currency, value will be calculated using system exchange rate if omitted or null.
:white-check-mark: amount Amount for entry. Should always be uncalculated if "currencyCode" differs from the base currency.
:x:/:white-check-mark: financeAccountUid Unique ID of finance account connected to entry. Required for "EXPENSE" type entries.
:x:/:white-check-mark: supplierUid Unique ID of supplier connected to entry. Required for "SUPPLIER" main type entry.
:x: vatGroupUid Unique ID of VAT group connected to entry. No value if omitted or null.
:white-check-mark: type Journal entry type. At least one entry line with "SUPPLIER" type, and one with "EXPENSE" are required.

Supplier payment

General rules for supplier payment entries:

  • "supplierUid" is required on the "entryLine" with the "SUPPLIER" type.
  • Payload must contain only 1 "SUPPLIER" type "entryLine", and at least 1 "SUPPLIER_PAYMENT" "entryLine".
  • "financeAccountUid" is required on the "entryLine" with "SUPPLIER_PAYMENT" type.

Payload examples:

{
    "date": "2024-01-02",
    "currencyCode": "DKK",
    "entryLines": [
        {
            "amount": 1999.5,
            "supplierUid": "e75a5145-c059-4dd6-b130-46ae4f330771",
            "type": "SUPPLIER"
        },
        {
            "amount": -1999.5,
            "financeAccountUid": "ac838618-6d65-4f84-bab6-9995611235c3",
            "type": "SUPPLIER_PAYMENT"
        }
    ]
}

{
    "sequenceId": "SP1",
    "date": "2024-01-02",
    "externalId": "Custom_Supplier_Payment_Id_1",
    "currencyCode": "DKK",
    "entryLines": [
        {
            "description": "Supplier payment main line",
            "amountInBase": 1999.5,
            "amount": 1999.5,
            "supplierUid": "e75a5145-c059-4dd6-b130-46ae4f330771",
            "type": "SUPPLIER"
        },
        {
            "description": "Supplier payment sub line",
            "amountInBase": -1999.5,
            "amount": -1999.5,
            "financeAccountUid": "ac838618-6d65-4f84-bab6-9995611235c3",
            "type": "SUPPLIER_PAYMENT"
        }
    ]
}
Property description.

Use the table below to see the required/optional properties for supplier payment entries.

Required Property Description
:x: sequenceId Sequence id of entry seqence. Value will be defined using the journal number mask if omitted or null.
:white-check-mark: date Date of entry seqence.
:x: dueDate Due date of entries. No value if omitted or null.
:x: invoiceNumber Invoice number of entries. No value if omitted or null.
:x: externalId Custom external id of entries. No value if omitted or null.
:white-check-mark: currencyCode Currency of entries as ISO 4217 standard codes.
entryLines
:x: description Description of individual entry. No value if omitted or null.
:x: amountInBase Amount in base currency of individual entry. When "currencyCode" differs from base currency, value will be calculated using system exchange rate if omitted or null.
:white-check-mark: amount Amount for entry. Should always be uncalculated if "currencyCode" differs from the base currency.
:x:/:white-check-mark: financeAccountUid Unique ID of finance account connected to entry. Required for "SUPPLIER_PAYMENT" type entries.
:x:/:white-check-mark: supplierUid Unique ID of supplier connected to entry. Required for "SUPPLIER" main type entry.
:white-check-mark: type Journal entry type. At least one entry line with "SUPPLIER" type, and one with "SUPPLIER_PAYMENT" are required.

Customer entries

View the payload examples and general rules below, or expand a the property description to view the details of customer properties.

Customer invoice

General rules for customer invoice entries:

  • "customerUid" is required on the "entryLine" with the "CUSTOMER" type.
  • Payload must contain only 1 "CUSTOMER" type "entryLine", and at least 1 "INVOICE" "entryLine".
  • "financeAccountUid" is required on the "entryLine" with "INVOICE" type.

Payload examples:

{
    "date": "2024-01-02",
    "currencyCode": "DKK",
    "entryLines": [
        {
            "amount": 145.95,
            "customerUid": "5c5c7bc1-8c65-48c3-8362-c3c80e4ca948",
            "type": "CUSTOMER"
        },
        {
            "amount": -145.95,
            "financeAccountUid": "ac838618-6d65-4f84-bab6-9995611235c3",
            "type": "INVOICE"
        }
    ]
}

{
    "sequenceId": "CI1",
    "date": "2024-01-02",
    "externalId": "Custom_Customer_Invoice_Id_1",
    "dueDate": "2024-01-31",
    "invoiceNumber":"CII1",
    "currencyCode": "DKK",
    "entryLines": [
        {
            "description": "Customer invoice main line",
            "amountInBase": 145.95,
            "amount": 145.95,
            "customerUid": "5c5c7bc1-8c65-48c3-8362-c3c80e4ca948",
            "type": "CUSTOMER"
        },
        {
            "description": "Customer Invoice sub line",
            "amountInBase": -145.95,
            "amount": -145.95,
            "financeAccountUid": "ac838618-6d65-4f84-bab6-9995611235c3",
            "vatGroupUid": "50425ef2-7742-42e2-ad04-677158dc2ad6",            
            "type": "INVOICE"
        }
    ]
}
property description.

Use the table below to see the required/optional properties for customer invoice entries

Required Property Description
:x: sequenceId Sequence id of entry seqence. Value will be defined using the journal number mask if omitted or null.
:white-check-mark: date Date of entry seqence.
:x: dueDate Due date of entries. No value if omitted or null.
:x: invoiceNumber Invoice number of entries. No value if omitted or null.
:x: externalId Custom external id of entries. No value if omitted or null.
:white-check-mark: currencyCode Currency of entries as ISO 4217 standard codes.
entryLines
:x: description Description of individual entry. No value if omitted or null.
:x: amountInBase Amount in base currency of individual entry. When "currencyCode" differs from base currency, value will be calculated using system exchange rate if omitted or null.
:white-check-mark: amount Amount for entry. Should always be uncalculated if "currencyCode" differs from the base currency.
:x:/:white-check-mark: financeAccountUid Unique ID of finance account connected to entry. Required for "INVOICE" type entries.
:x:/:white-check-mark: customerUid Unique ID of customer connected to entry. Required for "CUSTOMER" main type entry.
:x: vatGroupUid Unique ID of VAT group connected to entry. No value if omitted or null.
:white-check-mark: type Journal entry type. At least one entry line with "CUSTOMER" type, and one with "INVOICE" are required.

Customer payment

General rules for customer payment entries:

  • "customerUid" is required on the "entryLine" with the "CUSTOMER" type.
  • Payload must contain only 1 "CUSTOMER" type "entryLine", and at least 1 "CUSTOMER_PAYMENT" "entryLine".
  • "financeAccountUid" is required on the "entryLine" with "CUSTOMER_PAYMENT" type.

Payload examples:

{
    "date": "2024-01-02",
    "currencyCode": "DKK",
    "entryLines": [
        {
            "amount": 145.95,
            "customerUid": "5c5c7bc1-8c65-48c3-8362-c3c80e4ca948",
            "type": "CUSTOMER"
        },
        {
            "amount": -145.95,
            "financeAccountUid": "ac838618-6d65-4f84-bab6-9995611235c3",
            "type": "CUSTOMER_PAYMENT"
        }
    ]
}

{
    "sequenceId": "CP1",
    "date": "2024-01-02",
    "externalId": "Custom_Customer_Payment_Id_1",
    "currencyCode": "DKK",
    "entryLines": [
        {
            "description": "Customer payment main line",
            "amountInBase": 145.95,
            "amount": 145.95,
            "customerUid": "5c5c7bc1-8c65-48c3-8362-c3c80e4ca948",
            "type": "CUSTOMER"
        },
        {
            "description": "Customer Payment sub line",
            "amountInBase": -145.95,
            "amount": -145.95,
            "financeAccountUid": "ac838618-6d65-4f84-bab6-9995611235c3",          
            "type": "CUSTOMER_PAYMENT"
        }
    ]
}
Property description.

Use the table below to see the required/optional properties for customer invoice entries

Required Property Description
:x: sequenceId Sequence id of entry seqence. Value will be defined using the journal number mask if omitted or null.
:white-check-mark: date Date of entry seqence.
:x: externalId Custom external id of entries. No value if omitted or null.
:white-check-mark: currencyCode Currency of entries as ISO 4217 standard codes.
entryLines
:x: description Description of individual entry. No value if omitted or null.
:x: amountInBase Amount in base currency of individual entry. When "currencyCode" differs from base currency, value will be calculated using system exchange rate if omitted or null.
:white-check-mark: amount Amount for entry. Should always be uncalculated if "currencyCode" differs from the base currency.
:x:/:white-check-mark: financeAccountUid Unique ID of finance account connected to entry. Required for "CUSTOMER_PAYMENT" type entries.
:x:/:white-check-mark: customerUid Unique ID of customer connected to entry. Required for "CUSTOMER" main type entry.
:white-check-mark: type Journal entry type. At least one entry line with "CUSTOMER" type, and one with "CUSTOMER_PAYMENT" are required.

Employee entries

View the payload examples and general rules below, or expand a the property description to view the details of employee properties.

Employee settlement

General rules for employee settlement entries:

  • "employeeUid" is required on the "entryLine" with the "EMPLOYEE" type.
  • Payload must contain only 1 "EMPLOYEE" type "entryLine", and at least 1 "EMPLOYEE_FINANCE" "entryLine".
  • "financeAccountUid" is required on the "entryLine" with "EMPLOYEE_FINANCE" type.

Payload examples:

{
    "date": "2024-01-02",
    "currencyCode": "DKK",
    "entryLines": [
        {
            "amount": 120.50,
            "employeeUid": "34827954-8407-4363-8ddb-dd0fe8bbf3d7",
            "type": "EMPLOYEE"
        },
        {
            "amount": -120.50,
            "financeAccountUid": "ac838618-6d65-4f84-bab6-9995611235c3",
            "type": "EMPLOYEE_FINANCE"
        }
    ]
}

{
    "sequenceId": "ES1",
    "date": "2024-01-02",
    "externalId": "Custom_Employee_Settlement_Id_1",
    "currencyCode": "DKK",
    "entryLines": [
        {
            "description": "Employee settlement main line",
            "amountInBase": 120.50,
            "amount": 120.50,
            "employeeUid": "34827954-8407-4363-8ddb-dd0fe8bbf3d7",
            "type": "EMPLOYEE"
        },
        {
            "description": "Employee settlement sub line",
            "amountInBase": -120.50,
            "amount": -120.50,
            "financeAccountUid": "ac838618-6d65-4f84-bab6-9995611235c3",          
            "type": "EMPLOYEE_FINANCE"
        }
    ]
}
Property description.

Use the table below to see the required/optional properties for employee settlement entries

Required Property Description
:x: sequenceId Sequence id of entry seqence. Value will be defined using the journal number mask if omitted or null.
:white-check-mark: date Date of entry seqence.
:x: externalId Custom external id of entries. No value if omitted or null.
:white-check-mark: currencyCode Currency of entries as ISO 4217 standard codes.
entryLines
:x: description Description of individual entry. No value if omitted or null.
:x: amountInBase Amount in base currency of individual entry. When "currencyCode" differs from base currency, value will be calculated using system exchange rate if omitted or null.
:white-check-mark: amount Amount for entry. Should always be uncalculated if "currencyCode" differs from the base currency.
:x:/:white-check-mark: financeAccountUid Unique ID of finance account connected to entry. Required for "EMPLOYEE_FINANCE" type entries.
:x:/:white-check-mark: employeeUID Unique ID of customer connected to entry. Required for "EMPLOYEE" main type entry.
:white-check-mark: type Journal entry type. At least one entry line with "EMPLOYEE" type, and one with "EMPLOYEE_FINANCE" are required.

Finance entries

View the payload examples and general rules below, or expand a the property description to view the details of employee properties.

Finance

General rules for finance entries:

  • Payload must contain at least 2 "FINANCE" type "entryLines".
  • "financeAccountUid" is required on all "entryLines".

Payload examples:

{
    "date": "2024-01-02",
    "currencyCode": "DKK",
    "entryLines": [
        {
            "amount": 120.50,
            "financeAccountUid": "ac838618-6d65-4f84-bab6-9995611235c3",
            "type": "FINANCE"
        },
        {
            "amount": -120.50,
            "financeAccountUid": "ac838618-6d65-4f84-bab6-9995611235c3",
            "type": "FINANCE"
        }
    ]
}

{
    "sequenceId": "FIN1",
    "date": "2024-01-02",
    "externalId": "Custom_Finance_Id_1",
    "currencyCode": "DKK",
    "entryLines": [
        {
            "description": "Finance main line",
            "amountInBase": 120.50,
            "amount": 120.50,
            "vatGroupUid": "50425ef2-7742-42e2-ad04-677158dc2ad6",            
            "financeAccountUid": "ac838618-6d65-4f84-bab6-9995611235c3",          
            "type": "FINANCE"
        },
        {
            "description": "Finance sub line",
            "amountInBase": -120.50,
            "amount": -120.50,
            "vatGroupUid": "50425ef2-7742-42e2-ad04-677158dc2ad6",            
            "financeAccountUid": "ac838618-6d65-4f84-bab6-9995611235c3",          
            "type": "FINANCE"
        }
    ]
}
Property description.

Use the table below to see the required/optional properties for finance entries

Required Property Description
:x: sequenceId Sequence id of entry seqence. Value will be defined using the journal number mask if omitted or null.
:white-check-mark: date Date of entry seqence.
:x: externalId Custom external id of entries. No value if omitted or null.
:white-check-mark: currencyCode Currency of entries as ISO 4217 standard codes.
entryLines
:x: description Description of individual entry. No value if omitted or null.
:x: amountInBase Amount in base currency of individual entry. When "currencyCode" differs from base currency, value will be calculated using system exchange rate if omitted or null.
:white-check-mark: amount Amount for entry. Should always be uncalculated if "currencyCode" differs from the base currency.
:white-check-mark: financeAccountUid Unique ID of finance account connected to entry. Required for all "entryLines".
:x: vatGroupUid Unique ID of VAT group connected to entry. No value if omitted or null.
:white-check-mark: type Journal entry type. Two or more "entryLines" are required with the "FINANCE" type.

Updated about 1 month ago