Skip to main content
PATCH
/
v1
/
journal-entries
/
{journalEntryId}
Update journal entry
curl --request PATCH \
  --url https://api.light.inc/v1/journal-entries/{journalEntryId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "postingDate": "2023-12-25",
  "documentDate": "2023-12-25",
  "areLinesWithTax": true,
  "customProperties": [
    {
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "valueIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "inlineValues": [
        "<string>"
      ]
    }
  ],
  "valuationDate": "2023-12-25",
  "documentNumber": "<string>",
  "businessPartnerName": "<string>",
  "businessPartnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "currency": "USD"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentNumber": "<string>",
  "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentSequenceId": "<string>",
  "description": "<string>",
  "currency": "USD",
  "postingDate": "2023-12-25",
  "documentDate": "2023-12-25",
  "valuationDate": "2023-12-25",
  "areLinesWithTax": true,
  "failureContext": {
    "name": "<string>",
    "errors": [
      {
        "type": "<string>",
        "message": "<string>",
        "path": [
          "<string>"
        ],
        "context": {}
      }
    ]
  },
  "lines": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "journalEntryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "netTransactionAmount": {
        "amount": 123
      },
      "grossTransactionAmount": {
        "amount": 123
      },
      "taxTransactionAmount": {
        "amount": 123
      },
      "description": "<string>",
      "targetCompanyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerTaxId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "costCenterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customProperties": [
        {
          "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupInternalName": "<string>",
          "values": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "groupInternalName": "<string>",
              "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "internalName": "<string>",
              "label": "<string>",
              "context": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "amortizationTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amortizationStartDate": "2023-12-25",
      "amortizationEndDate": "2023-12-25"
    }
  ],
  "customProperties": [
    {
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "groupInternalName": "<string>",
      "values": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "groupInternalName": "<string>",
          "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "internalName": "<string>",
          "label": "<string>",
          "context": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "businessPartnerName": "<string>",
  "businessPartnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "totalNetTransactionAmount": {
    "amount": 123
  },
  "totalTaxTransactionAmount": {
    "amount": 123
  },
  "totalGrossTransactionAmount": {
    "amount": 123
  },
  "multiJournalEntryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.light.inc/llms.txt

Use this file to discover all available pages before exploring further.

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

Path Parameters

​
journalEntryId
string<uuid>
required

Body

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

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

Available options:
PRIMARY,
ELIMINATION
​
postingDate
string<date> | null
​
documentDate
string<date> | null
​
areLinesWithTax
boolean | null
​
customProperties
(object | null)[] | null

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

​
valuationDate
string<date> | null
​
documentNumber
string | null
​
businessPartnerName
string | null
​
businessPartnerId
string<uuid> | null
​
description
string | null
​
currency
string | null
Example:

"USD"

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>
​
areLinesWithTax
boolean
​
failureContext
object

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>