Bulk Update Journal Entries

curl --request PATCH \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/journal-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "journal_entry_id": "<string>",
    "changes": {
      "description": "<string>",
      "datetime": "2023-11-07T05:31:56Z",
      "line_changes": {
        "create_lines": [
          {
            "ledger_id": "<string>",
            "description": "<string>",
            "debit_credit": "debit",
            "amount": 1,
            "tag_ids": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ],
            "basis": "all"
          }
        ],
        "delete_lines": [
          "<string>"
        ]
      },
      "review_status": "bookkeeper_pending",
      "is_reconciled": true
    }
  }
]
'

{
  "data": [
    {
      "business_id": "<string>",
      "description": "<string>",
      "clean_description": "<string>",
      "datetime": "2023-11-07T05:31:56Z",
      "is_reconciled": true,
      "review_status": "bookkeeper_pending",
      "id": "<string>",
      "transaction_id": "txn_WQMDNUHpBThYSNh4AprDBo",
      "line_entries": [
        {
          "ledger_id": "<string>",
          "description": "<string>",
          "debit_credit": "debit",
          "amount": 123,
          "id": "<string>",
          "journal_entry_id": "<string>",
          "transaction_id": "txn_WQMDNUHpBThYSNh4AprDBo"
        }
      ],
      "categorization_method": "refund",
      "invoice_id": "inv_WQMDNUHpBThYSNh4AprDBo"
    }
  ]
}

PATCH

business

{business_id}

journal-entries

Bulk Update Journal Entries

curl --request PATCH \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/journal-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "journal_entry_id": "<string>",
    "changes": {
      "description": "<string>",
      "datetime": "2023-11-07T05:31:56Z",
      "line_changes": {
        "create_lines": [
          {
            "ledger_id": "<string>",
            "description": "<string>",
            "debit_credit": "debit",
            "amount": 1,
            "tag_ids": [
              "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            ],
            "basis": "all"
          }
        ],
        "delete_lines": [
          "<string>"
        ]
      },
      "review_status": "bookkeeper_pending",
      "is_reconciled": true
    }
  }
]
'

{
  "data": [
    {
      "business_id": "<string>",
      "description": "<string>",
      "clean_description": "<string>",
      "datetime": "2023-11-07T05:31:56Z",
      "is_reconciled": true,
      "review_status": "bookkeeper_pending",
      "id": "<string>",
      "transaction_id": "txn_WQMDNUHpBThYSNh4AprDBo",
      "line_entries": [
        {
          "ledger_id": "<string>",
          "description": "<string>",
          "debit_credit": "debit",
          "amount": 123,
          "id": "<string>",
          "journal_entry_id": "<string>",
          "transaction_id": "txn_WQMDNUHpBThYSNh4AprDBo"
        }
      ],
      "categorization_method": "refund",
      "invoice_id": "inv_WQMDNUHpBThYSNh4AprDBo"
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-user-id

string | null

Optional external entity identifier that performed the update

Path Parameters

business_id

string<biz_string>

required

Body

application/json

Maximum array length: 100

journal_entry_id

string<je_string>

required

The ID of the Journal Entry to update

changes

JournalEntryPatch · object

required

The changes to apply to the Journal Entry

Show child attributes

changes.description

string | null

The description of the Journal Entry

changes.datetime

string<date-time> | null

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

changes.line_changes

JELineEntryChanges · object

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.

Show child attributes

changes.line_changes.create_lines

LineEntryCreate · object[] | null

A list of new Line Entries to add

Show child attributes

changes.line_changes.create_lines.ledger_id

string<ldg_string>

required

The ID of the Ledger associated with the Line Entry

changes.line_changes.create_lines.description

string

required

The line entry description

Maximum string length: 512

changes.line_changes.create_lines.debit_credit

enum<string>

required

Indicates whether this a debit or credit line

Available options:

debit,

credit

changes.line_changes.create_lines.amount

required

The line amount in decimal dollar cents, and it most always be positive

Required range: x >= 0

changes.line_changes.create_lines.tag_ids

string<uuid>[] | null

The IDs of the tags associated with the Line Entry

changes.line_changes.create_lines.basis

enum<string>

default:all

The basis of the line entry

Available options:

all,

accrual,

modified_cash

changes.line_changes.delete_lines

string<le_string>[] | null

A list of Line Entry IDs to delete

changes.review_status

enum<string> | null

The new status to set on the Journal Entry

Available options:

bookkeeper_pending,

business_pending,

confirmed

changes.is_reconciled

boolean | null

Whether the Journal Entry is reconciled

Response

Successful Response

data

JournalEntryPublic · object[]

required

Show child attributes

data.business_id

string<biz_string>

required

The ID of the Business that is associated with the Journal Entry

data.description

string

required

The description of the Journal Entry

Maximum string length: 512

data.clean_description

string | null

required

A more human-readable version of the description

Maximum string length: 512

data.datetime

string<date-time>

required

data.is_reconciled

boolean

required

data.review_status

enum<string>

required

The review status of the journal entry

Available options:

bookkeeper_pending,

business_pending,

confirmed

data.id

string<je_string>

required

The ID of the Journal Entry

data.transaction_id

string<txn_string> | null

required

The ID of the associated Transaction if the Journal Entry was created from a Transaction

Example:

"txn_WQMDNUHpBThYSNh4AprDBo"

data.line_entries

LineEntryPublic · object[]

required

The Line Entries for this Journal Entry

Show child attributes

data.line_entries.ledger_id

string<ldg_string>

required

The ID of the Ledger associated with the Line Entry

data.line_entries.description

string

required

The line entry description

Maximum string length: 512

data.line_entries.debit_credit

enum<string>

required

Indicates whether this a debit or credit line

Available options:

debit,

credit

data.line_entries.amount

number

required

The line amount in decimal dollar cents, and it most always be positive

data.line_entries.id

string<le_string>

required

The ID of the Line Entry

data.line_entries.journal_entry_id

string<je_string>

required

The ID of the parent Journal Entry

data.line_entries.transaction_id

string<txn_string> | null

The ID of the associated Transaction if the Line Entry was created from a Transaction

Example:

"txn_WQMDNUHpBThYSNh4AprDBo"

data.categorization_method

enum<string> | null

required

The method used to categorize the Journal Entry

Available options:

refund,

transfer,

similarity,

plaid,

ai,

ar,

ap,

uncategorized,

manual

data.invoice_id

string<inv_string> | null

required

The ID of the associated Invoice

Example:

"inv_WQMDNUHpBThYSNh4AprDBo"

Create a Journal Entry Retrieve a Journal Entry

⌘I

API Overview

Authentication

Business

Journal Entry

Ledger

Reports

Transaction

Invoice

Bill

Request

Document

Webhooks

Bulk Update Journal Entries

Authorizations

Headers

Path Parameters

Body

Response