Items

The Item object refers to the goods involved in a transaction.

The Item object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

remote_dataRemoteData[]
Optional

nameString
Optional
The item's name.

statusEnum
Optional
The item's status. Possible values include: ACTIVE, ARCHIVED, or - in cases where there is no clear mapping - the original value passed through.

unit_priceNumber
Optional
The item's unit price.

purchase_priceNumber
Optional
The price at which the item is purchased from a vendor.

purchase_accountString
Optional
References the default account used to record a purchase of the item.

sales_accountString
Optional
References the default account used to record a sale.

companyString
Optional
The company the item belongs to.

remote_updated_atString
Optional
When the third party's item note was updated.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

field_mappingsObject
Optional

The Item object
JSON
{
"id": "d2f972d0-2526-434b-9409-4c3b468e08f0",
"remote_id": "12374",
"remote_data": [
{
"path": "/actions",
"data": [
"Varies by platform"
]
}
],
"name": "Pickleball Paddle",
"status": "ACTIVE",
"unit_price": 10,
"purchase_price": 25,
"purchase_account": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
"sales_account": "3872b4c9-f5d2-4f3b-a66b-dfedbed42c49",
"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
"remote_updated_at": "2020-03-31T00:00:00Z",
"remote_was_deleted": true,
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
}

GET

/items

Returns a list of Item objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


company_idString
Optional
If provided, will only return items for this company.

created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

remote_idString
Optional
The API provider's ID for the given object.

show_enum_originsString
Optional
Which fields should be returned in non-normalized form.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "d2f972d0-2526-434b-9409-4c3b468e08f0",
"remote_id": "12374",
"remote_data": [
{
"path": "/actions",
"data": [
"Varies by platform"
]
}
],
"name": "Pickleball Paddle",
"status": "ACTIVE",
"unit_price": 10,
"purchase_price": 25,
"purchase_account": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
"sales_account": "3872b4c9-f5d2-4f3b-a66b-dfedbed42c49",
"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
"remote_updated_at": "2020-03-31T00:00:00Z",
"remote_was_deleted": true,
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
}
]
}
Field support by platform

Clear Books

Clear Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

statusEnum

Microsoft Dynamics 365 Business Central

Microsoft Dynamics 365 Business Central

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

unit_priceNumber

Moneybird

Moneybird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

unit_priceNumber

NetSuite

NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

nameString

purchase_accountString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

sales_accountString

statusEnum

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

purchase_accountString

purchase_priceNumber

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

statusEnum

unit_priceNumber

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

purchase_accountString

purchase_priceNumber

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

sales_accountString

statusEnum

unit_priceNumber

Sage Intacct

Sage Intacct

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_idString

Wave Financial

Wave Financial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

statusEnum

unit_priceNumber

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

purchase_accountString

purchase_priceNumber

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

sales_accountString

unit_priceNumber

Zoho Books

Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

purchase_priceNumber

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

statusEnum
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/items/{id}

Returns an Item object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

remote_fieldsString
Optional
Deprecated. Use show_enum_origins.

show_enum_originsString
Optional
Which fields should be returned in non-normalized form.

Response
JSON
{
"id": "d2f972d0-2526-434b-9409-4c3b468e08f0",
"remote_id": "12374",
"remote_data": [
{
"path": "/actions",
"data": [
"Varies by platform"
]
}
],
"name": "Pickleball Paddle",
"status": "ACTIVE",
"unit_price": 10,
"purchase_price": 25,
"purchase_account": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46",
"sales_account": "3872b4c9-f5d2-4f3b-a66b-dfedbed42c49",
"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
"remote_updated_at": "2020-03-31T00:00:00Z",
"remote_was_deleted": true,
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
}
Field support by platform

Clear Books

Clear Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

statusEnum

Microsoft Dynamics 365 Business Central

Microsoft Dynamics 365 Business Central

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

unit_priceNumber

Moneybird

Moneybird

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

unit_priceNumber

NetSuite

NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


companyString

nameString

purchase_accountString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

sales_accountString

statusEnum

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

purchase_accountString

purchase_priceNumber

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

statusEnum

unit_priceNumber

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

purchase_accountString

purchase_priceNumber

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

sales_accountString

statusEnum

unit_priceNumber

Sage Intacct

Sage Intacct

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_idString

Wave Financial

Wave Financial

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

statusEnum

unit_priceNumber

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

purchase_accountString

purchase_priceNumber

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

sales_accountString

unit_priceNumber

Zoho Books

Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

purchase_priceNumber

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

statusEnum
Hint: Use the /linked-accounts endpoint to pull platform support information.