/general-ledger-transactions/{id}

import { MergeClient } from "@mergeapi/merge-node-client";
const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
await client.accounting.generalLedgerTransactions.retrieve("id", {
    includeRemoteData: true,
    includeShellData: true
});

{
  "id": "b26fd49a-cbae-470a-a8f8-bcbc119e0390",
  "remote_id": "987300",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "underlying_transaction_remote_id": "1234",
  "underlying_transaction_type": "INVOICE",
  "accounting_period": "d6e687d6-0c36-48a1-8114-35324b5cb38f",
  "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
  "remote_updated_at": "2020-03-31T00:00:00Z",
  "remote_created_at": "2020-03-31T00:00:00Z",
  "tracking_categories": [
    "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
    "9b840d2-686a-465a-8a8e-7b028498f8e4",
    "a47e11b6-c73b-4a0c-be31-130fc48177fa"
  ],
  "posting_date": "2020-03-31T00:00:00Z",
  "general_ledger_transaction_lines": [
    {
      "debit_amount": "0",
      "credit_amount": "string",
      "foreign_debit_amount": "0",
      "foreign_credit_amount": "123.5",
      "remote_id": "123",
      "account": "a47e11b6-c73b-4a0c-be31-130fc48177fa",
      "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
      "contact": "d6e687d6-0c36-48a1-8114-35324b5cb38f",
      "base_currency": "USD",
      "transaction_currency": "USD",
      "exchange_rate": "1",
      "description": "Invoice created",
      "tracking_categories": [
        {},
        {},
        {}
      ],
      "item": "a47e11b6-c73b-4a0c-be31-130fc48177fa",
      "remote_was_deleted": false,
      "crebit_amount": 123.5,
      "remote_data": [
        {
          "path": "/actions",
          "data": [
            "Varies by platform"
          ]
        }
      ]
    }
  ],
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  },
  "remote_data": [
    {
      "path": "/platform-endpoint"
    }
  ]
}

Returns a GeneralLedgerTransaction object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstringRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only

The datetime that this object was created by Merge.

modified_atdatetimeRead-only

The datetime that this object was modified by Merge.

underlying_transaction_remote_idstring or null<=50 characters

The third party remote ID of the underlying transaction.

underlying_transaction_typeenum or null

The type of the underlying transaction.

INVOICE - INVOICE
EXPENSE - EXPENSE
TRANSACTION - TRANSACTION
JOURNAL_ENTRY - JOURNAL_ENTRY
PAYMENT - PAYMENT
VENDOR_CREDIT - VENDOR_CREDIT
CREDIT_NOTE - CREDIT_NOTE

The type of the underlying transaction. * `INVOICE` - INVOICE * `EXPENSE` - EXPENSE * `TRANSACTION` - TRANSACTION * `JOURNAL_ENTRY` - JOURNAL_ENTRY * `PAYMENT` - PAYMENT * `VENDOR_CREDIT` - VENDOR_CREDIT * `CREDIT_NOTE` - CREDIT_NOTE

accounting_periodstring or nullformat: "uuid"

The accounting period that the GeneralLedgerTransaction was generated in.

companystring or nullformat: "uuid"

The company the GeneralLedgerTransaction belongs to.

remote_updated_atdatetime or null

When the third party's GeneralLedgerTransaction entry was updated.

remote_created_atdatetime or null

When the third party's GeneralLedgerTransaction entry was created.

tracking_categorieslist of strings

posting_datedatetime or null

The date that the transaction was posted to the general ledger.

general_ledger_transaction_lineslist of objectsRead-only

A list of “General Ledger Transaction Applied to Lines” objects.

remote_was_deletedbooleanRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullRead-only

remote_datalist of objects or nullRead-only

/general-ledger-transactions/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration