Merge Accounting

Items

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

Properties

idUUID

remote_idString

The 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.

nameString

The item's name.

statusEnum

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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

typeEnum

The 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_priceNumber

The item's unit price.

purchase_priceNumber

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

purchase_accountUUID

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

sales_accountUUID

References the default account used to record a sale.

companyUUID

The company the item belongs to.

purchase_tax_rateUUID

The default purchase tax rate for this item.

sales_tax_rateUUID

The default sales tax rate for this item.

remote_updated_atDateTime (ISO 8601)

When the third party's item note was updated.

remote_was_deletedBoolean

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.

field_mappingsObject

remote_dataRemoteData[]

The RemoteData object

The RemoteData object is used to represent the full data pulled from the third-party API for an object.

Properties

pathString

The third-party API path that is being called.

dataAny

The data returned from the third-party for this object in its original, unnormalized format.

GET

/items

https://api.merge.dev/api/accounting/v1/items

APAC

Returns a list of Item objects.

Query & path parameters

company_idString

Optional

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.

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

include_remote_dataBoolean

Optional

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

include_shell_dataBoolean

Optional

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.

nameString

Optional

If provided, will only return items with this name.

page_sizeInteger

Optional

Number of results to return per page. The maximum limit is 100.

remote_fieldsString

Optional

Deprecated. Use show_enum_origins.

remote_idString

Optional

The API provider's ID for the given object.

show_enum_originsString

Optional

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

Microsoft Dynamics 365 Business Central

Microsoft Dynamics Finance and Operations

Moneybird

NetSuite

QuickBooks Online

Sage Business Cloud Accounting

Sage Intacct

Wave Financial

Xero

Zoho Books

POST

/items

Beta

https://api.merge.dev/api/accounting/v1/items

APAC

Creates an Item object with the given values. To run asynchronously, see our guide.

Query & path parameters

is_debug_modeBoolean

Optional

Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean

Optional

Whether or not third-party updates should be run asynchronously.

Body parameters

modelObject

Required

Find available fields below under “Model Parameters”.

Model parameters

View app-specific writable fields under “Field support by platform” in this section.

nameString

The item's name.

statusEnum

The item's status. Must pass in one of the following choices: ACTIVE, ARCHIVED.

typeEnum

The item's type. Must pass in one of the following choices: INVENTORY, NON_INVENTORY, SERVICE, UNKNOWN.

unit_priceNumber

The item's unit price.

purchase_priceNumber

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

purchase_accountUUID

References 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_accountUUID

References 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.

companyUUID

The 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_rateUUID

The 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_rateUUID

The 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_paramsObject

linked_account_paramsObject

Field support by integration

Use the /linked-accounts endpoint to pull platform support information

QuickBooks Online

Sage Intacct

Xero

Not seeing an integration that you're looking for?

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}

APAC

Returns an Item object with the given id.

Query & path parameters

expandString

Optional

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

idUUID

Required

include_remote_dataBoolean

Optional

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

include_shell_dataBoolean

Optional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsString

Optional

Deprecated. Use show_enum_origins.

show_enum_originsString

Optional

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

Microsoft Dynamics 365 Business Central

Microsoft Dynamics Finance and Operations

Moneybird

NetSuite

QuickBooks Online

Sage Business Cloud Accounting

Sage Intacct

Wave Financial

Xero

Zoho Books

PATCH

/items/{id}

Beta

https://api.merge.dev/api/accounting/v1/items/{id}

APAC

Updates an Item object with the given id.

Query & path parameters

idUUID

Required

is_debug_modeBoolean

Optional

Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean

Optional

Whether or not third-party updates should be run asynchronously.

Body parameters

modelObject

Required

Find available fields below under “Model Parameters”.

Model parameters

View app-specific writable fields under “Field support by platform” in this section.

nameString

The item's name.

statusEnum

The item's status. Must pass in one of the following choices: ACTIVE, ARCHIVED.

typeEnum

The item's type. Must pass in one of the following choices: INVENTORY, NON_INVENTORY, SERVICE, UNKNOWN.

unit_priceNumber

The item's unit price.

purchase_priceNumber

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

purchase_accountUUID

References 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_accountUUID

References 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.

companyUUID

The 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_rateUUID

The 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_rateUUID

The 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_paramsObject

linked_account_paramsObject

Field support by integration

Use the /linked-accounts endpoint to pull platform support information

QuickBooks Online