Items
TheItem object refers to the goods involved in a transaction.The Item object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
remote_dataRemoteData[]Optional
nameStringOptional
The item's name.
statusEnumOptional
The item's status. Possible values include:
ACTIVE, ARCHIVED, or - in cases where there is no clear mapping - the original value passed through.unit_priceNumberOptional
The item's unit price.
purchase_priceNumberOptional
The price at which the item is purchased from a vendor.
purchase_accountStringOptional
References the default account used to record a purchase of the item.
sales_accountStringOptional
References the default account used to record a sale.
companyStringOptional
The company the item belongs to.
remote_updated_atStringOptional
When the third party's item note was updated.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObjectOptional
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
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
company_idStringOptional
If provided, will only return items for this company.
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
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
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterStringOptional
If provided, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
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
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
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdataobjectstatusEnum
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringunit_priceNumber
Moneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringunit_priceNumber
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringnameStringpurchase_accountStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringsales_accountStringstatusEnum
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringpurchase_accountStringpurchase_priceNumberremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumunit_priceNumber
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringpurchase_accountStringpurchase_priceNumberremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringsales_accountStringstatusEnumunit_priceNumber
Sage Intacct
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringremote_idString
Wave Financial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumunit_priceNumber
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringpurchase_accountStringpurchase_priceNumberremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringsales_accountStringunit_priceNumber
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringpurchase_priceNumberremote_dataRemoteData[]pathstringdataobjectremote_idStringstatusEnumHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/items/{id}
Returns an Item object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
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
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
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdataobjectstatusEnumMicrosoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringunit_priceNumberMoneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringunit_priceNumberNetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
companyStringnameStringpurchase_accountStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringsales_accountStringstatusEnumQuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringpurchase_accountStringpurchase_priceNumberremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumunit_priceNumberSage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringpurchase_accountStringpurchase_priceNumberremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringsales_accountStringstatusEnumunit_priceNumberSage Intacct
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringremote_idStringWave Financial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringstatusEnumunit_priceNumberXero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringpurchase_accountStringpurchase_priceNumberremote_dataRemoteData[]pathstringdataobjectremote_idStringremote_updated_atStringsales_accountStringunit_priceNumberZoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
nameStringpurchase_priceNumberremote_dataRemoteData[]pathstringdataobjectremote_idStringstatusEnumHint: Use the /linked-accounts endpoint to pull platform support information.