Accounting Periods
The AccountingPeriod object is used to define a period of time in which events occurred.
Properties

idUUID

remote_idString
The 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.

nameString
Name 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_mappingsObject

remote_dataRemoteData[]
The RemoteData object
The RemoteData object is used to represent the full data pulled from the third-party API for an object.
Properties

pathString
The third-party API path that is being called.

dataAny
The 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

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
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_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

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

page_sizeInteger
Optional
Number of results to return per page.

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
NetSuite
NetSuite
Sage Intacct
Sage Intacct
FreeAgent
FreeAgent
Unsupported by API provider
QuickBooks Online
QuickBooks Online
Unsupported by API provider
Xero
Xero
Unsupported by API provider
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

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
NetSuite
NetSuite
Sage Intacct
Sage Intacct
FreeAgent
FreeAgent
Unsupported by API provider
QuickBooks Online
QuickBooks Online
Unsupported by API provider
Xero
Xero
Unsupported by API provider