For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The JournalEntry object
          • GET/journal-entries
          • POST/journal-entries
          • GET/journal-entries/{id}
          • GET/journal-entries/lines/remote-field-classes
          • GET/journal-entries/meta/post
          • GET/journal-entries/remote-field-classes
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsJournal Entries

The JournalEntry object

The JournalEntry Object
1{
2 "id": "string",
3 "remote_id": "string",
4 "created_at": "2023-01-01T00:00:00Z",
5 "modified_at": "2023-01-01T00:00:00Z",
6 "transaction_date": "2023-01-01T00:00:00Z",
7 "payments": [
8 "string"
9 ],
10 "applied_payments": [
11 "string"
12 ],
13 "memo": "string",
14 "currency": "XUA",
15 "exchange_rate": "string",
16 "company": "string",
17 "inclusive_of_tax": true,
18 "lines": [
19 {
20 "id": "string",
21 "remote_id": "string",
22 "created_at": "2023-01-01T00:00:00Z",
23 "modified_at": "2023-01-01T00:00:00Z",
24 "account": "string",
25 "net_amount": 1,
26 "tracking_category": "string",
27 "tracking_categories": [
28 "string"
29 ],
30 "currency": "XUA",
31 "company": "string",
32 "employee": "string",
33 "project": "string",
34 "contact": "string",
35 "tax_rate": "string",
36 "description": "string",
37 "exchange_rate": "string",
38 "remote_was_deleted": true,
39 "remote_fields": [
40 {
41 "remote_field_class": {
42 "id": "string",
43 "display_name": "string",
44 "remote_key_name": "string",
45 "description": "string",
46 "is_custom": true,
47 "is_common_model_field": true,
48 "is_required": true,
49 "field_type": "string",
50 "field_format": "string",
51 "field_choices": [
52 "string"
53 ],
54 "item_schema": {
55 "item_type": "string",
56 "item_format": "string",
57 "item_choices": [
58 "string"
59 ]
60 }
61 },
62 "value": {
63 "string": {}
64 }
65 }
66 ]
67 }
68 ],
69 "journal_number": "string",
70 "tracking_categories": [
71 "string"
72 ],
73 "remote_was_deleted": true,
74 "posting_status": "UNPOSTED",
75 "accounting_period": "string",
76 "remote_created_at": "2023-01-01T00:00:00Z",
77 "remote_updated_at": "2023-01-01T00:00:00Z",
78 "field_mappings": {},
79 "remote_data": [
80 {
81 "path": "string",
82 "data": {}
83 }
84 ],
85 "remote_fields": [
86 {
87 "remote_field_class": {
88 "id": "string",
89 "display_name": "string",
90 "remote_key_name": "string",
91 "description": "string",
92 "is_custom": true,
93 "is_common_model_field": true,
94 "is_required": true,
95 "field_type": "string",
96 "field_format": "string",
97 "field_choices": [
98 "string"
99 ],
100 "item_schema": {
101 "item_type": "string",
102 "item_format": "string",
103 "item_choices": [
104 "string"
105 ]
106 }
107 },
108 "value": {
109 "string": {}
110 }
111 }
112 ]
113}
Was this page helpful?
Previous

/items/meta/post

Next

/journal-entries

Built with

A JournalEntry is a record of a transaction or event that is entered into a company’s accounting system.

The JournalEntry common model contains records that are automatically created as a result of a certain type of transaction, like an Invoice, and records that are manually created against a company’s ledger.

The lines of a given JournalEntry object should always sum to 0. A positive net_amount means the line represents a debit and a negative net_amount represents a credit.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
transaction_datedatetime or nullOptional
The journal entry's transaction date.
paymentslist of stringsOptional
applied_paymentslist of stringsOptional
A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
memostring or nullOptional
The journal entry's private note.
currencyenum or nullOptional
The journal's currency. The currency code in ISO 4217 format.
exchange_ratestring or nullOptionalformat: "decimal"
The journal entry's exchange rate.
companystring or nullOptionalformat: "uuid"
The company the journal entry belongs to.
inclusive_of_taxboolean or nullOptional
lineslist of objectsOptionalRead-only
journal_numberstring or nullOptional<=70 characters
Reference number for identifying journal entries.
tracking_categorieslist of stringsOptional
remote_was_deletedbooleanOptionalRead-only
posting_statusenum or nullOptional
Allowed values:
accounting_periodstring or nullOptionalformat: "uuid"
The accounting period that the JournalEntry was generated in.
remote_created_atdatetime or nullOptional
When the third party's journal entry was created.
remote_updated_atdatetime or nullOptional
When the third party's journal entry was updated.
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
remote_fieldslist of objectsOptionalRead-only