Create journal entry

Authorization

Send one of these on every request. See Authentication for how to get credentials.

• API key

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

• Bearer token

Headers

• X-Idempotency-Key string

Request body

application/json;charset=UTF-8

• companyEntityId string · uuid

  Note

  Required. The entity whose books the entry posts to.

• ledgerName string

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

  One of PRIMARY ELIMINATION

• documentNumber string

  Note

  Optional free-text reference of your own. Light assigns documentSequenceId separately at posting.

• description string

  Note

  Optional description for the entry.

• currency string

  Note

  No default, and required to post.

• postingDate string · date

  Note

  The ledger date. Defaults to today; the accounting period covering it must be open to post.

• valuationDate string · date

  Note

  The date whose exchange rate converts the lines. Defaults to the posting date.

• localCurrencyFxRateOverride number

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

• groupCurrencyFxRateOverride number

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

• documentDate string · date

  Note

  The date on the underlying document, informational.

• areLinesWithTax boolean

  Note

  Decides which amount each line carries: false (default) takes netTransactionAmount and rejects a gross amount, true takes grossTransactionAmount and rejects a net one.

• lines array of object

  Note

  To post: at least two lines that net to zero in the entry's currency, with at least one D and one C, each with a ledgerAccountId.

  • netTransactionAmount object

    Note

    Send this when areLinesWithTax is false (the default): the amount excluding tax, unsigned, with dcSign.

    • amount integer · int64

      Note

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

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

      One of D C

  • grossTransactionAmount object

    Note

    Send this instead when areLinesWithTax is true: the amount including tax. Sending both is rejected.

    • amount integer · int64

      Note

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

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

      One of D C

  • taxAmount object

    Note

    Optional explicit tax amount. Left out, Light derives it from the line's tax code.

    • amount integer · int64

      Note

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

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

      One of D C

  • description string

    Note

    Optional line description.

  • targetCompanyEntityId string · uuid

    Note

    For an intercompany line, the entity on the other side ("To entity" in the product). Leave out on ordinary lines.

  • ledgerTaxId string · uuid

    Note

    Tax code id; leave out for no tax.

  • ledgerAccountId string · uuid

    Note

    The ledger account to post to. Required to post.

  • costCenterId string · uuid

    Note

    Optional cost center.

  • amortizationTemplateId string · uuid

    Note

    Spread the line over a release schedule: the template id, sent together with the start and end dates.

  • amortizationStartDate string · date

    Note

    First date of the release schedule; required with the template.

  • amortizationEndDate string · date

    Note

    Last date of the release schedule; required with the template.

  • customProperties array of object

    Note

    Custom property values for the line. See Custom properties on writes.

    • groupId string · uuid

      ID of the custom property group.

    • valueIds array of string · uuid

      IDs of the selected custom property values. It behaves as a PUT operation, so if empty the existing ones will be effectively deleted.

      Note

      Catalogue value ids for this group. Required; send [] (with an empty inlineValues) to clear the group. SINGLE_SELECT and MULTI_SELECT groups accept nothing else. See Custom properties on writes.

    • inlineValues array of string

      Inline custom property values (used for TEXT/NUMERIC/DATE/etc. groups). It behaves as a PUT operation, so if empty or null the existing ones will be effectively deleted.

      Note

      Literal values for TEXT, NUMERIC, BOOLEAN and DATE groups, as strings (yyyy-MM-dd for dates). Rejected on select groups with CUSTOM_PROPERTY_VALUE_TYPE_MISMATCH. See Custom properties on writes.

• businessPartnerName string

  Note

  Optional vendor or customer name to show on the entry.

• businessPartnerId string · uuid

  Note

  Optional vendor or customer id.

• shouldPost boolean

  Note

  false (the default) creates a draft that the API can never post afterwards, only archive. Set true to post now; with a journal-entry approval workflow in place the result is APPROVAL_PENDING instead of POSTED.

• customProperties array of object

  Note

  Custom property values for the entry header. See Custom properties on writes.

  • groupId string · uuid

    ID of the custom property group.

  • valueIds array of string · uuid

    IDs of the selected custom property values. It behaves as a PUT operation, so if empty the existing ones will be effectively deleted.

    Note

    Catalogue value ids for this group. Required; send [] (with an empty inlineValues) to clear the group. SINGLE_SELECT and MULTI_SELECT groups accept nothing else. See Custom properties on writes.

  • inlineValues array of string

    Inline custom property values (used for TEXT/NUMERIC/DATE/etc. groups). It behaves as a PUT operation, so if empty or null the existing ones will be effectively deleted.

    Note

    Literal values for TEXT, NUMERIC, BOOLEAN and DATE groups, as strings (yyyy-MM-dd for dates). Rejected on select groups with CUSTOM_PROPERTY_VALUE_TYPE_MISMATCH. See Custom properties on writes.

Response

• id string · uuid

  Note

  The journal entry id, also its accounting document id.

• companyId string · uuid

  Note

  Your company id.

• documentNumber string

  Note

  Your own free-text reference for the entry. Not the number Light assigns; that is documentSequenceId.

• companyEntityId string · uuid

  Note

  The entity whose books the entry posts to.

• ledgerName string

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

  One of PRIMARY ELIMINATION

• createdBy string · uuid

  Note

  The principal that created the entry: a user or an API key.

• updatedBy string · uuid

  Note

  The principal that last changed it.

• documentSequenceId string

  Note

  null until the entry is posted.

• status string

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

  One of DRAFT APPROVAL_PENDING APPROVED POSTED PARTIALLY_CLEARED CLEARED ARCHIVED

• description string

  Note

  The entry's description.

• currency string

  Note

  The currency of the line amounts.

• postingDate string · date

  Note

  The ledger date; the accounting period covering it must be open to post.

• documentDate string · date

  Note

  The date on the underlying document, informational.

• valuationDate string · date

  Note

  The date whose exchange rate converted the lines to local and group currency; resolved at posting when not set.

• localCurrencyFxRate number

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

  Note

  Echoes the override you sent; null when Light applied its own rate, not the rate that was applied.

• groupCurrencyFxRate number

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

  Note

  Echoes the override you sent; null when Light applied its own rate, not the rate that was applied.

• areLinesWithTax boolean

  Note

  Whether line amounts were entered gross of tax (true) or net (false, the default).

• failureContext object

  Failure context when vendor onboarding fails.

  Note

  The error of the last failed posting attempt, typically from the approval workflow; cleared on the next successful post. The description about vendor onboarding is a copy-paste from another model.

  • name string

    The error name

  • type string

    The error type

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

    One of BAD_REQUEST UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_CONTENT

  • errors array of object

    List of errors providing details about what went wrong

    • type string

      A string code identifying the error type

    • message string

      A human-readable message providing more details about the error

    • path array of string

      Optional path of the error when the error is for a specific field. Used mostly on BAD_REQUEST errors, that path will match the field name on the request object

    • context object

      Optional context providing additional information about the error. This can include any relevant data that might help in understanding or resolving the error

• lines array of object

  Note

  The lines as entered. The ledger lines Light derived (tax, rounding) are not here; read them from ledger transaction lines.

  • id string · uuid

    Note

    The line id.

  • journalEntryId string · uuid

    Note

    The entry the line belongs to.

  • netTransactionAmount object

    Note

    The line amount excluding tax, unsigned with dcSign, in the entry's currency.

    • amount integer · int64

      Note

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

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

      One of D C

  • grossTransactionAmount object

    Note

    The line amount including tax.

    • amount integer · int64

      Note

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

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

      One of D C

  • taxTransactionAmount object

    Note

    The tax portion; null without a tax code.

    • amount integer · int64

      Note

      Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

    • dcSign string

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

      One of D C

  • description string

    Note

    The line description.

  • targetCompanyEntityId string · uuid

    Note

    For an intercompany line, the entity on the other side ("To entity" in the product). null on ordinary lines.

  • ledgerTaxId string · uuid

    Note

    Tax code id. Other documents call the same id taxCodeId.

  • ledgerAccountId string · uuid

    Note

    The ledger account the line posts to.

  • costCenterId string · uuid

    Note

    Cost center on the line; null when none.

  • customProperties array of object

    Note

    Custom property values on the line.

    • groupId string · uuid

      ID of the custom property group

    • groupInternalName string

      Internal name of the custom property group

    • values array of object

      List of values. Note that this will be a single value unless the group input type supports multiple values

      • id string · uuid

        Unique identifier for the object

      • groupId string · uuid

        ID of the custom property group

      • groupInternalName string

        Internal name of the custom property group

      • companyId string · uuid

        ID of the company

      • internalName string

        Internal name of the custom property value

      • label string

        Label of the custom property value

      • context string

        Context/description of the custom property value

      • createdAt string · date-time

        Timestamp when the custom property value was created

      • updatedAt string · date-time

        Timestamp when the custom property value was last updated

  • createdAt string · date-time

    Note

    When the line was created.

  • updatedAt string · date-time

    Note

    When it was last changed.

  • amortizationTemplateId string · uuid

    Note

    Release template id when the line is spread over a schedule instead of hitting the account at once; null otherwise.

  • amortizationStartDate string · date

    Note

    First date of that schedule.

  • amortizationEndDate string · date

    Note

    Last date of that schedule.

• customProperties array of object

  Note

  Custom property values on the entry header.

  • groupId string · uuid

    ID of the custom property group

  • groupInternalName string

    Internal name of the custom property group

  • values array of object

    List of values. Note that this will be a single value unless the group input type supports multiple values

    • id string · uuid

      Unique identifier for the object

    • groupId string · uuid

      ID of the custom property group

    • groupInternalName string

      Internal name of the custom property group

    • companyId string · uuid

      ID of the company

    • internalName string

      Internal name of the custom property value

    • label string

      Label of the custom property value

    • context string

      Context/description of the custom property value

    • createdAt string · date-time

      Timestamp when the custom property value was created

    • updatedAt string · date-time

      Timestamp when the custom property value was last updated

• businessPartnerName string

  Note

  Optional vendor or customer shown on the entry.

• businessPartnerId string · uuid

  Note

  Id of that vendor or customer.

• createdAt string · date-time

  Note

  When the entry was created.

• updatedAt string · date-time

  Note

  When it was last changed.

• totalNetTransactionAmount object

  Note

  Sum of the lines' net amounts as one directed figure. Read the magnitude as the entry's size; its dcSign carries no accounting meaning on a balanced entry.

  • amount integer · int64

    Note

    Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

  • dcSign string

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

    One of D C

• totalTaxTransactionAmount object

  Note

  Sum of the lines' tax amounts, read like the net total.

  • amount integer · int64

    Note

    Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

  • dcSign string

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

    One of D C

• totalGrossTransactionAmount object

  Note

  Sum of the lines' gross amounts, read like the net total.

  • amount integer · int64

    Note

    Unsigned integer in minor units. The direction is in dcSign; a negative value is rejected.

  • dcSign string

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

    One of D C

• multiJournalEntryId string · uuid

  Note

  Set when this entry is one entity's part of a multi-entity journal entry made in the product; entries sharing the id were entered together. null for entries created through the API.