Products
Products are the goods or services you sell. You can add them to invoices and estimates.
Returns information about a product based on the identifier
Finds the product by the identifier field of the product.
Required scope(s)
settings
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
identifierformat^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Returns information about a product based on the identifier › Responses
A product
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
descriptiontitleidentifierpricecurrencyfrequencyfrequency_typetax_rate_id^\d+$A unique record identifier
ledger_account_id^\d+$A unique record identifier
created_atupdated_atCreate online sales link
This call generates an online sales link, and allows pre-setting the contact for a checkout page. The link is valid for one hour
Required scope(s)
settings
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
contact_id^\d+$A unique record identifier
Create online sales link › Responses
A sales link
Returns information about a product
Returns information about a product.
Required scope(s)
settings
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Returns information about a product › Responses
A product
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
descriptiontitleidentifierpricecurrencyfrequencyfrequency_typetax_rate_id^\d+$A unique record identifier
ledger_account_id^\d+$A unique record identifier
created_atupdated_atDeletes a product
Deletes a product if it has no dependencies. If the product has associated details, subscription products, orders, or subscription templates, deletion is blocked and the product will be deactivated instead. If the product has active subscriptions or subscription templates, deactivation is blocked and an error is returned.
Required scope(s)
settings
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Deletes a product › Responses
Product deleted
Updates a product
Updates a product.
Required scope(s)
settings
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Updates a product › Responses
Product updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
descriptiontitleidentifierpricecurrencyfrequencyfrequency_typetax_rate_id^\d+$A unique record identifier
ledger_account_id^\d+$A unique record identifier
created_atupdated_atList all products of an administration
Returns a paginated list of products in the administration. Each page contains 10 products. You can use the page parameter to fetch the next page of products.
Required scope(s)
settings
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
queryAllows filtering by product name.
pageThe page to fetch, starting at 1.
per_page^\d+$currencyISO three-character currency code, e.g. EUR or USD.
activeWhen true, only active products are returned. Set to false to include deactivated products.
for_checkoutWhen true, returns only products with online checkout enabled. When false, returns only products without checkout. Omit to include both.
ledger_account_id^\d+$Filters products by their associated ledger account.
List all products of an administration › Responses
A list of products
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
descriptiontitleidentifierpricecurrencyfrequencyfrequency_typetax_rate_id^\d+$A unique record identifier
ledger_account_id^\d+$A unique record identifier
created_atupdated_atCreates a new product
Creates a new product.
Required scope(s)
settings
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Creates a new product › Responses
Product created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
descriptiontitleidentifierpricecurrencyfrequencyfrequency_typetax_rate_id^\d+$A unique record identifier
ledger_account_id^\d+$A unique record identifier
created_atupdated_at