LIlight
v1 - Journal Entries

Update journal entry

Updates the given draft journal entry. Only the fields present in the request body are modified; fields set explicitly to null are cleared.

patch/v1/journal-entries/{journalEntryId}

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

journalEntryIdstring uuid required

Headers

X-Idempotency-Keystring

Request body

companyEntityIdstring uuid nullable
ledgerName'PRIMARY' | 'ELIMINATION' nullable

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

postingDatestring date nullable
documentDatestring date nullable
areLinesWithTaxboolean nullable
valuationDatestring date nullable
localCurrencyFxRateOverridenumber nullable

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

groupCurrencyFxRateOverridenumber nullable

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

documentNumberstring nullable
businessPartnerNamestring nullable
businessPartnerIdstring uuid nullable
descriptionstring nullable
currencystring nullable

Example request

{
  "currency": "USD"
}

Response

default response

idstring uuid
companyIdstring uuid
documentNumberstring
companyEntityIdstring uuid
ledgerName'PRIMARY' | 'ELIMINATION'

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

createdBystring uuid
updatedBystring uuid
documentSequenceIdstring
status'DRAFT' | 'APPROVAL_PENDING' | 'APPROVED' | 'POSTED' | 'PARTIALLY_CLEARED' | 'CLEARED' | 'ARCHIVED'

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

descriptionstring
currencystring
postingDatestring date
documentDatestring date
valuationDatestring date
localCurrencyFxRatenumber nullable

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

groupCurrencyFxRatenumber nullable

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

areLinesWithTaxboolean
businessPartnerNamestring
businessPartnerIdstring uuid
createdAtstring date-time
updatedAtstring date-time
multiJournalEntryIdstring uuid

Example response

{
  "currency": "USD"
}

Changes

No recorded changes to this operation across all 1 revision of this API.