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.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier of an administration
identifierformat^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Responses
A product
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier of an administration
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
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier of an administration
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
Responses
A sales link
Returns information about a product
Returns information about a product.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier of an administration
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
Responses
A product
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier of an administration
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.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier of an administration
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
Responses
Product deleted
Updates a product
Updates a product.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier of an administration
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
Responses
Product updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier of an administration
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.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier of an administration
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.
Responses
A list of products
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier of an administration
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.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier of an administration
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Responses
Product created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier of an administration
descriptiontitleidentifierpricecurrencyfrequencyfrequency_typetax_rate_id^\d+$A unique record identifier
ledger_account_id^\d+$A unique record identifier
created_atupdated_at