Skip to Content
AccountingJournal Entries

Update a Journal Entry

PATCH
/v0/business/{business_id}/journal-entries/{journal_entry_id}

Scopes: journal_entry:update

Authorization

OAuth2ClientCredentialsBearer journal_entry:update
headerAuthorizationBearer <token>

Scope: journal_entry:update

Path Parameters

business_id*Business Id

The id of the business

Formatbiz_string
journal_entry_id*Journal Entry Id

The id of the journal entry

Formatje_string

Header Parameters

x-user-id?|

Optional external entity identifier that performed the update

Request Body

application/json
  1. body
description?|

The description of the Journal Entry

datetime?|

The datetime the Journal Entry was created in UTC ISO-8601 format

line_changes?|

An object with optional create and delete values that modify the lines in the Journal Entry. To update a line, simply remove the old line and add a new one.

review_status?|

The new status to set on the Journal Entry

is_reconciled?|

Whether the Journal Entry is reconciled

tags?|

Tags to apply to the Journal Entry, keyed by tag field name (the field must already exist). Each value is a tag value string, or a list of {value, amount?, ledger_id?} objects to split the amount across values and optionally pin a value to a ledger. Amounts left out are split evenly across the values. Supplying tags replaces all of the Journal Entry's tags; an empty object clears them. Only Journal Entries with no source transaction, invoice, or bill can be tagged this way.

Response Body

Successful Response

application/json
  1. response
data*
Example Request
curl -X PATCH 'https://api.sandbox.getasset.com/v0/business/biz_GA6EG2qFxA97NZHtxeLPUy/journal-entries/je_R2fAXCjqJPdpYata112zyW' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "business_id": "biz_Pk2fNFDd8wj7EFeLWJywc7",    "external_id": "je-2023-11-07-001",    "description": "HomeDepot purchase",    "clean_description": "HomeDepot purchase",    "datetime": "2023-11-07T05:31:56Z",    "is_reconciled": true,    "review_status": "bookkeeper_pending",    "basis": "both",    "id": "je_R2fAXCjqJPdpYata112zyW",    "transaction_id": "txn_WQMDNUHpBThYSNh4AprDBo",    "line_entries": [      {        "ledger_id": "ldg_Ns6rRRLYVZPh4cVB7MDby5",        "description": "HomeDepot purchase",        "debit_credit": "debit",        "amount": "89.23",        "id": "le_GA6EG2qFxA97NZHtxeLPUy",        "journal_entry_id": "je_R2fAXCjqJPdpYata112zyW",        "transaction_id": "txn_WQMDNUHpBThYSNh4AprDBo",        "tag_value_ids": [          "tv_Ns6rRRLYVZPh4cVB7MDby5"        ]      }    ],    "categorization_method": "manual",    "invoice_id": "inv_WQMDNUHpBThYSNh4AprDBo",    "bill_id": "bil_WQMDNUHpBThYSNh4AprDBo",    "tags": {      "Location": [        {          "amount": "75.00",          "value": "NYC"        },        {          "amount": "25.00",          "value": "LA"        }      ]    }  }}