Items
The
Item object refers to the goods involved in a transaction.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.
nameStringThe item's name.
statusEnumThe 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.typeEnumThe item's type. Possible values include:
INVENTORY, NON_INVENTORY, SERVICE, UNKNOWN. 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_priceNumberThe item's unit price.
purchase_priceNumberThe price at which the item is purchased from a vendor.
purchase_accountUUIDReferences the default account used to record a purchase of the item.
sales_accountUUIDReferences the default account used to record a sale.
companyUUIDThe company the item belongs to.
purchase_tax_rateUUIDThe default purchase tax rate for this item.
sales_tax_rateUUIDThe default sales tax rate for this item.
remote_updated_atDateTime (ISO 8601)When the third party's item note was updated.
remote_was_deletedBooleanIndicates 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_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
/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
Use 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_accountUUIDstatusEnumtypeEnumunit_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_accountUUIDstatusEnumtypeEnumunit_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_accountUUIDtypeEnumunit_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_idStringstatusEnumPOST
/items
Betahttps://api.merge.dev/api/accounting/v1/items
US
EU
APAC
Creates an Item object with the given values. To run asynchronously, see our guide.
Query & path parameters
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model parameters
View app-specific writable fields under “Field support by platform” in this section.nameStringThe item's name.
statusEnumThe item's status. Must pass in one of the following choices:
ACTIVE, ARCHIVED.typeEnumThe item's type. Must pass in one of the following choices:
INVENTORY, NON_INVENTORY, SERVICE, UNKNOWN.unit_priceNumberThe item's unit price.
purchase_priceNumberThe price at which the item is purchased from a vendor.
purchase_accountUUIDReferences the default account used to record a purchase of the item. Must pass in a valid Merge ID, which can be obtained from the
id field in the Account object.sales_accountUUIDReferences the default account used to record a sale. Must pass in a valid Merge ID, which can be obtained from the
id field in the Account object.companyUUIDThe company the item belongs to. Must pass in a valid Merge ID, which can be obtained from the
id field in the CompanyInfo object.purchase_tax_rateUUIDThe default purchase tax rate for this item. Must pass in a valid Merge ID, which can be obtained from the
id field in the TaxRate object.sales_tax_rateUUIDThe default sales tax rate for this item. Must pass in a valid Merge ID, which can be obtained from the
id field in the TaxRate object.integration_paramsObjectlinked_account_paramsObjectField support by integration
Use the /linked-accounts endpoint to pull platform support information
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
nameStringRequired
purchase_accountUUIDOptional
purchase_priceNumberOptional
remote_idStringOptional
remote_updated_atDateTime (ISO 8601)Optional
sales_accountUUIDOptional
statusEnumOptional
typeEnumOptional
unit_priceNumberOptional
To include the correct model fields when making POST requests, use the GET /items/meta/post endpoint. Learn more in our /meta guide.
GET
/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.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
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
Use 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_accountUUIDstatusEnumtypeEnumunit_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_accountUUIDstatusEnumtypeEnumunit_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_accountUUIDtypeEnumunit_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_idStringstatusEnumPATCH
/items/{id}
Betahttps://api.merge.dev/api/accounting/v1/items/{id}
US
EU
APAC
Updates an Item object with the given id.
Query & path parameters
idUUIDRequired
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model parameters
View app-specific writable fields under “Field support by platform” in this section.nameStringThe item's name.
statusEnumThe item's status. Must pass in one of the following choices:
ACTIVE, ARCHIVED.typeEnumThe item's type. Must pass in one of the following choices:
INVENTORY, NON_INVENTORY, SERVICE, UNKNOWN.unit_priceNumberThe item's unit price.
purchase_priceNumberThe price at which the item is purchased from a vendor.
purchase_accountUUIDReferences the default account used to record a purchase of the item. Must pass in a valid Merge ID, which can be obtained from the
id field in the Purchase_account object.sales_accountUUIDReferences the default account used to record a sale. Must pass in a valid Merge ID, which can be obtained from the
id field in the Sales_account object.companyUUIDThe company the item belongs to. Must pass in a valid Merge ID, which can be obtained from the
id field in the Company object.purchase_tax_rateUUIDThe default purchase tax rate for this item. Must pass in a valid Merge ID, which can be obtained from the
id field in the Purchase_tax_rate object.sales_tax_rateUUIDThe default sales tax rate for this item. Must pass in a valid Merge ID, which can be obtained from the
id field in the Sales_tax_rate object.integration_paramsObjectlinked_account_paramsObjectField support by integration
Use the /linked-accounts endpoint to pull platform support information
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported PATCH Model Parameters
nameStringOptional
purchase_accountUUIDOptional
purchase_priceNumberOptional
remote_idStringOptional
remote_updated_atDateTime (ISO 8601)Optional
sales_accountUUIDOptional
statusEnumOptional
typeEnumOptional
unit_priceNumberOptional
GET
/items/meta/patch/{id}
https://api.merge.dev/api/accounting/v1/items/meta/patch/{id}
US
EU
APAC
Returns metadata for Item PATCHs.
Query & path parameters
idUUIDRequired
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported PATCH Model Parameters
nameStringOptional
purchase_accountUUIDOptional
purchase_priceNumberOptional
remote_idStringOptional
remote_updated_atDateTime (ISO 8601)Optional
sales_accountUUIDOptional
statusEnumOptional
typeEnumOptional
unit_priceNumberOptional
GET
/items/meta/post
https://api.merge.dev/api/accounting/v1/items/meta/post
US
EU
APAC
Returns metadata for Item POSTs.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
nameStringRequired
purchase_accountUUIDOptional
purchase_priceNumberOptional
remote_idStringOptional
remote_updated_atDateTime (ISO 8601)Optional
sales_accountUUIDOptional
statusEnumOptional
typeEnumOptional
unit_priceNumberOptional