Accounting Periods
The
AccountingPeriod object is used to define a period of time in which events occurred.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
nameStringName of the accounting period.
statusEnum Possible values include:
ACTIVE, INACTIVE. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.start_dateDateTime (ISO 8601)Beginning date of the period
end_dateDateTime (ISO 8601)End date of the period
field_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
GET
/accounting-periods
https://api.merge.dev/api/accounting/v1/accounting-periods
US
EU
APAC
Returns a list of AccountingPeriod objects.
Query & path parameters
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
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.
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).
page_sizeIntegerOptional
Number of results to return per page.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
end_dateDateTime (ISO 8601)nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)
Sage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
end_dateDateTime (ISO 8601)nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)statusEnum
FreeAgent
QuickBooks Online
Xero
GET
/accounting-periods/{id}
https://api.merge.dev/api/accounting/v1/accounting-periods/{id}
US
EU
APAC
Returns an AccountingPeriod object with the given id.
Query & path parameters
idUUIDRequired
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).
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
end_dateDateTime (ISO 8601)nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)Sage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
end_dateDateTime (ISO 8601)nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringstart_dateDateTime (ISO 8601)statusEnumFreeAgent
QuickBooks Online
Xero