Items
The
Item object refers to the goods involved in a transaction.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
nameStringOptional
The item's name.
statusEnumOptional
The item's status. Possible values include:
ACTIVE, ARCHIVED. 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.unit_priceNumberOptional
The item's unit price.
purchase_priceNumberOptional
The price at which the item is purchased from a vendor.
purchase_accountUUIDOptional
References the default account used to record a purchase of the item.
sales_accountUUIDOptional
References the default account used to record a sale.
companyUUIDOptional
The company the item belongs to.
purchase_tax_rateUUIDOptional
The default purchase tax rate for this item.
sales_tax_rateUUIDOptional
The default sales tax rate for this item.
remote_updated_atDateTime (ISO 8601)Optional
When the third party's item note was updated.
remote_was_deletedBooleanRequired
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_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/items
https://api.merge.dev/api/accounting/v1/items
US
EU
APAC
Returns a list of Item objects.
Query & Path Parameters
company_idStringOptional
If provided, will only return items for this company.
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
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).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
FreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnum
Microsoft Dynamics 365 Business Central
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)unit_priceNumber
Microsoft Dynamics Finance and Operations
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Moneybird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)unit_priceNumber
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDnameStringpurchase_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)sales_accountUUIDstatusEnum
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringpurchase_accountUUIDpurchase_priceNumberremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)sales_accountUUIDstatusEnumunit_priceNumber
Sage Business Cloud Accounting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringpurchase_accountUUIDpurchase_priceNumberremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)sales_accountUUIDstatusEnumunit_priceNumber
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
companyUUIDnameStringpurchase_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)sales_accountUUIDstatusEnumunit_priceNumber
Wave Financial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumunit_priceNumber
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringpurchase_accountUUIDpurchase_priceNumberremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)sales_accountUUIDunit_priceNumber
Zoho Books
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDnameStringpurchase_priceNumberremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumGET
/items/{id}
https://api.merge.dev/api/accounting/v1/items/{id}
US
EU
APAC
Returns an Item object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
FreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumMicrosoft Dynamics 365 Business Central
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)unit_priceNumberMicrosoft Dynamics Finance and Operations
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringMoneybird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)unit_priceNumberNetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDnameStringpurchase_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)sales_accountUUIDstatusEnumQuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringpurchase_accountUUIDpurchase_priceNumberremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)sales_accountUUIDstatusEnumunit_priceNumberSage Business Cloud Accounting
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringpurchase_accountUUIDpurchase_priceNumberremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)sales_accountUUIDstatusEnumunit_priceNumberSage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDnameStringpurchase_accountUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)sales_accountUUIDstatusEnumunit_priceNumberWave Financial
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumunit_priceNumberXero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringpurchase_accountUUIDpurchase_priceNumberremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)sales_accountUUIDunit_priceNumberZoho Books
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
companyUUIDnameStringpurchase_priceNumberremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnum