Skip to main content
POST
Create journal entry

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Headers

X-Idempotency-Key
string

Body

application/json;charset=UTF-8
companyEntityId
string<uuid>
ledgerName
enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
PRIMARY,
ELIMINATION
documentNumber
string | null
description
string | null
currency
string | null
Example:

"USD"

postingDate
string<date> | null
valuationDate
string<date> | null
localCurrencyFxRateOverride
number | null

Custom foreign exchange rate for the ledger's local currency. If not provided, Light uses official ECB rates

groupCurrencyFxRateOverride
number | null

Custom foreign exchange rate for the ledger's group currency. If not provided, Light uses official ECB rates

documentDate
string<date> | null
areLinesWithTax
boolean
lines
object[] | null
businessPartnerName
string | null
businessPartnerId
string<uuid> | null
shouldPost
boolean
customProperties
(object | null)[] | null

List of custom properties to set on the vendor. Replaces the existing set.

Response

default - application/json;charset=UTF-8

default response

id
string<uuid>
companyId
string<uuid>
documentNumber
string
companyEntityId
string<uuid>
ledgerName
enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
PRIMARY,
ELIMINATION
createdBy
string<uuid>
updatedBy
string<uuid>
documentSequenceId
string
status
enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
DRAFT,
APPROVAL_PENDING,
APPROVED,
POSTED,
PARTIALLY_CLEARED,
CLEARED,
ARCHIVED
description
string
currency
string
Example:

"USD"

postingDate
string<date>
documentDate
string<date>
valuationDate
string<date>
localCurrencyFxRate
number | null

Custom foreign exchange rate for the ledger's local currency. If not provided, Light uses official ECB rates

groupCurrencyFxRate
number | null

Custom foreign exchange rate for the ledger's group currency. If not provided, Light uses official ECB rates

areLinesWithTax
boolean
failureContext
object | null

Failure context when vendor onboarding fails.

lines
object[]
customProperties
(object | null)[]

Custom properties set on the vendor.

businessPartnerName
string
businessPartnerId
string<uuid>
createdAt
string<date-time>
updatedAt
string<date-time>
totalNetTransactionAmount
object
totalTaxTransactionAmount
object
totalGrossTransactionAmount
object
multiJournalEntryId
string<uuid>