Items
The
Item
object refers to the goods involved in a transaction.Properties
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
name
StringOptional
The item's name.
status
EnumOptional
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.unit_price
NumberOptional
The item's unit price.
purchase_price
NumberOptional
The price at which the item is purchased from a vendor.
purchase_account
UUIDOptional
References the default account used to record a purchase of the item.
sales_account
UUIDOptional
References the default account used to record a sale.
company
UUIDOptional
The company the item belongs to.
remote_updated_at
DateTime (ISO 8601)Optional
When the third party's item note was updated.
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
created_at
DateTime (ISO 8601)Required
modified_at
DateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
field_mappings
ObjectOptional
remote_data
RemoteData[]Optional
GET
/items
https://api.merge.dev/api/accounting/v1/items
US
EU
Returns a list of Item
objects.
Query & Path Parameters
company_id
StringOptional
If provided, will only return items for this company.
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_fields
StringOptional
Deprecated. Use show_enum_origins.
remote_id
StringOptional
The API provider's ID for the given object.
show_enum_origins
StringOptional
Which fields should be returned in non-normalized form.
Field support by integration
See all supported fields
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
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)unit_price
Number
Moneybird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)unit_price
Number
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
company
UUIDname
Stringpurchase_account
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)sales_account
UUIDstatus
Enum
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
name
Stringpurchase_account
UUIDpurchase_price
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)sales_account
UUIDstatus
Enumunit_price
Number
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
name
Stringpurchase_account
UUIDpurchase_price
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)sales_account
UUIDstatus
Enumunit_price
Number
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
company
UUIDname
Stringpurchase_account
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)sales_account
UUIDstatus
Enumunit_price
Number
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
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumunit_price
Number
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
name
Stringpurchase_account
UUIDpurchase_price
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)sales_account
UUIDunit_price
Number
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
company
UUIDname
Stringpurchase_price
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
EnumGET
/items/{id}
https://api.merge.dev/api/accounting/v1/items/{id}
US
EU
Returns an Item
object with the given id
.
Query & Path Parameters
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
id
UUIDRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fields
StringOptional
Deprecated. Use show_enum_origins.
show_enum_origins
StringOptional
Which fields should be returned in non-normalized form.
Field support by integration
See all supported fields
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
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)unit_price
Number
Moneybird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)unit_price
Number
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
company
UUIDname
Stringpurchase_account
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)sales_account
UUIDstatus
Enum
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
name
Stringpurchase_account
UUIDpurchase_price
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)sales_account
UUIDstatus
Enumunit_price
Number
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
name
Stringpurchase_account
UUIDpurchase_price
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)sales_account
UUIDstatus
Enumunit_price
Number
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
company
UUIDname
Stringpurchase_account
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)sales_account
UUIDstatus
Enumunit_price
Number
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
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)status
Enumunit_price
Number
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API.
Supported Response Fields
name
Stringpurchase_account
UUIDpurchase_price
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)sales_account
UUIDunit_price
Number
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
company
UUIDname
Stringpurchase_price
Numberremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enum