Items
TheItem
object refers to the goods involved in a transaction.The Item object
Properties
id
Stringremote_id
Stringremote_data
RemoteData[]name
Stringstatus
EnumACTIVE
, ARCHIVED
, or - in cases where there is no clear mapping - the original value passed through.unit_price
Numberpurchase_price
Numberpurchase_account
Stringsales_account
Stringcompany
Stringremote_updated_at
Stringremote_was_deleted
Booleanfield_mappings
Object{"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"}}}
/items
Returns a list of Item
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
company_id
Stringcreated_after
Stringcreated_before
Stringcursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_fields
Stringremote_id
Stringshow_enum_origins
String{"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"}}}]}

Clear Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectstatus
Enum
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringunit_price
Number
Moneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringunit_price
Number
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringname
Stringpurchase_account
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringsales_account
Stringstatus
Enum
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringpurchase_account
Stringpurchase_price
Numberremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumunit_price
Number
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringpurchase_account
Stringpurchase_price
Numberremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringsales_account
Stringstatus
Enumunit_price
Number
Sage Intacct
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_id
String
Wave Financial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumunit_price
Number
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringpurchase_account
Stringpurchase_price
Numberremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringsales_account
Stringunit_price
Number
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringpurchase_price
Numberremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstatus
Enum/items/{id}
Returns an Item
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
expand
Stringid
Stringinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
String{"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"}}}

Clear Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectstatus
Enum
Microsoft Dynamics 365 Business Central
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringunit_price
Number
Moneybird
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringunit_price
Number
NetSuite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
company
Stringname
Stringpurchase_account
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringsales_account
Stringstatus
Enum
QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringpurchase_account
Stringpurchase_price
Numberremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumunit_price
Number
Sage Business Cloud Accounting
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringpurchase_account
Stringpurchase_price
Numberremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringsales_account
Stringstatus
Enumunit_price
Number
Sage Intacct
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_id
String
Wave Financial
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringstatus
Enumunit_price
Number
Xero
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringpurchase_account
Stringpurchase_price
Numberremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringsales_account
Stringunit_price
Number
Zoho Books
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
name
Stringpurchase_price
Numberremote_data
RemoteData[]path
stringdata
objectremote_id
Stringstatus
Enum