Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 53 KB

File metadata and controls

24 lines (21 loc) · 53 KB

GeneralLedgerTransaction

Fields

Field Type Required Description Example
id Optional<String> A unique identifier for an object. 12345
sourceType Optional<GeneralLedgerTransactionSourceType> ✔️ The originating transaction type that produced this posting in the general ledger. Discriminates whether the entry came from an invoice, a bill, a payment, a manual journal, etc. This is the key field that distinguishes general-ledger-transactions from journal-entries (which only covers manually-captured entries). May be null when the upstream connector did not return an origin discriminator (e.g. Xero's single-record endpoint strips SourceType for every record; certain historical records also omit it). To recover a populated value, query the list endpoint. invoice
sourceId JsonNullable<String> Identifier of the originating document in the vendor system. For example, when source_type is 'invoice', this is the id of the invoice that produced this posting. Use this id together with source_type to fetch the source document via its dedicated unified resource. 12345
postedAt OffsetDateTime The date on which the transaction was posted to the general ledger. This is the accounting date — it is what determines the period the transaction belongs to and can be earlier than the creation date for backdated postings. 2020-09-30T07:43:32.000Z
reference JsonNullable<String> Optional reference identifier for the transaction. INV-2024-001
number JsonNullable<String> Sequential number auto-assigned by the vendor system to the transaction (e.g. Xero JournalNumber). Unique per company. JNL-001
currency JsonNullable<Currency> Indicates the associated currency for an amount of money. Values correspond to ISO 4217. USD
currencyRate JsonNullable<Double> Currency Exchange Rate at the time entity was recorded/generated. 0.69
memo JsonNullable<String> Free-text description at the header level. Typically populated when the transaction originates from a manual journal — for system-generated postings (invoice, payment, etc.) the source document carries the descriptive text. Year-end adjustment for inventory revaluation
lineItems List<GeneralLedgerTransactionLineItem> ✔️ Lines of the transaction. Each line affects one ledger account with either a debit or a credit. The signed sum of net_amount across all lines must equal zero (double-entry invariant).
customFields List<CustomField> N/A
updatedBy JsonNullable<String> The user who last updated the object. 12345
createdBy JsonNullable<String> The user who created the object. 12345
updatedAt OffsetDateTime The date and time when the object was last updated. 2020-09-30T07:43:32.000Z
createdAt OffsetDateTime The date and time when the object was created. 2020-09-30T07:43:32.000Z
customMappings Map<String, Object> When custom mappings are configured on the resource, the result is included here.
passThrough List<PassThroughBody> The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.