v2

latestOpenAPI 3.0.0Apache 2.02026-07-2638645559.8 KB
Products

List products

Get list of products

get/apps/{appId}/products

Path parameters

appIdinteger required

The identifier of the Sinao application you are using. Each application corresponds to a company and an accounting. A user can have several Sinao applications. To retrieve the identifiers of its applications, you must call the endpoint /apps.

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set.

limitinteger

The numbers of items to return.

searchstring

A string to search for in objects.

namestring
valuestring
comparator'=' | '<' | '>' | '<=' | '>=' | '!=' | 'LIKE' | 'IN' | 'REGEX' | 'NOT LIKE' | 'NOT <=>' | '<=>'

List of filters to apply to the query.

namestring

Column name

direction'asc' | 'desc' | 'closest'
valueinteger

Value for closest amount

List in order of priority of the variables by which to order the result.

Response

Success

idinteger
namestring
amount_accuratelyinteger

Price without taxes in milli-cents

vat_percentinteger

VAT rate in cents

currencystring
lifetimeinteger

Product life time in seconds

descriptionstring
unitystring

Unity, hours, days, meters, liters..

intangibleboolean

Is a service or a product ?

quantity_namestring

Name of the quantity: days, liters, m2, m3...

referencestring
accounting_numberstring
tagsstring[]