/accounting-periods/{id}

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

{
  "id": "3015f7b1-4d01-460d-bfab-02a52d16cbd0",
  "remote_id": "2804580",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "name": "April 2020 Financials",
  "status": "ACTIVE",
  "start_date": "2020-03-31T00:00:00Z",
  "end_date": "2020-04-31T00:00:00Z",
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  },
  "remote_data": [
    {
      "path": "/actions"
    }
  ]
}

Returns an AccountingPeriod object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

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.

namestring or null<=100 characters

Name of the accounting period.

statusenum or null

ACTIVE - ACTIVE
INACTIVE - INACTIVE

Allowed values:

start_datedatetime or null

Beginning date of the period

end_datedatetime or null

End date of the period

field_mappingsobject or nullRead-only

remote_datalist of objects or nullRead-only

/accounting-periods/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration