API v1 will be deprecated on 31.12.2020. Please move your API v1 requests to API v2.
Overview
The Scoro API is an interface for accessing your Scoro account data using HTTP and JSON. The API makes it easy to create web and desktop applications that integrate with your account.
The Scoro API has a single point of entry, derived from your account URL
Full url depends on the info requested.
Sample URL
https://#companyname#.scoro.ee/api/v1
Please note the use of https:// in the URL above. All API communication is encrypted over HTTPS. Any non-secure requests are automatically rejected, so we recommend establishing a test connection with the secure API entry point before sending sensitive data.
Full address to send JSON requests looks like this
where #companyname# is the subdomain #module# is the module accessed ("contacts") #action# (optional) what to do with the selected object. Possible options are ("modify", "delete", "view"),
see each module for a list of available actions #id# (optional) what object to get
Changes from version 18.4
Field types for quote_id and order_id in Invoices are deprecated and will be type of Array in v2 API
Additional check to salesdocs (invoices, prepayments, quotes, orders, bills) when creating new entry.
company_id must now refer to an existing contacts id.
By default, all accounts have a request limit of 500 API requests per day. Additionally, a maximum of 100 results
will be returned for list methods, regardless of the value sent with the per_page parameter. The page paramater can be
used to request additional items.
All responses are wrapped in a top-level response element. The status attribute will let you know whether the request succeeded or failed.
Status can be OK or ERROR. The statusCode attribute can contain the following values:
Status code
Response message
Description
200
Success
If data was requested, it will be available
in the data field at the top level of the response body.
400
Invalid request
This usually occurs because of a missing
or malformed parameter. Check the documentation and the syntax of
your request and try again.
401
No authorization
A valid API key was not provided
with the request, so the API could not associate a user with
the request.
403
Forbidden
The API key was wrong.
408
Request timed out
The maximum execution time of the request was reached.
500
Server error
There was a problem on our end.
503
Service unavailable
API usage has been temporarily suspended. Try again later.
In the event of an error, the response body will contain an messages
field at the top level. This contains an array of at least one error message
List results can be filtered by adding a filter object to the request. This filter object should have
field names as keys and search words as values. If filtering by a range the value should be another object
containing from and/or to field.
Array of objects containing the following address fields: country (3-letter ISO 3166 code), county, municipality, city, street, zipcode. Not used on company based API list requests.
means_of_contact
Object
Object containing any of the following fields: mobile, phone, email, website, skype, fax. Values can be strings or arrays if contact has multiple means of contact. Values will always be returned as arrays on view requests. Not used on company based API list requests.
tags
Array
Array of contact tags. Not used on list requests.
reference_no
String
Reference number for contact.
custom_fields
Object
Custom fields. Only filled on view requests.
is_deleted
Boolean
Is deleted. Use 'include_deleted = 1' in request object to get deleted objects to response as well.
This API is deprecated. Use general Relations API instead.
This API can be used to list, modify and delete relations between companies and persons.
List requests: either company_id or person_id must be provided and the result will contain an array of related contact ID-s in the other field.
Modify requests: must provide contact ID in one field and an array of related contact ID-s in the other field.
Delete requests: can provide one contact ID or both ID-s to remove all relations from contact or just one specific relation.
This API can be used to list, modify and delete relations between objects (for example companies and persons).
Every request must provide the type of relation to operate on. Supported relation types:
contacts - relations between contacts (companies or persons)
Modify requests: will add relations between object_id and values in related_objects
Delete requests: if related_objects is specified will delete only those relations, otherwise all relations are removed from object_id
Name
Type
Description
object_id
Integer
Main object ID
related_objects
Object
Object containing related objects ID-s for each type on list request. Array of ID-s on modify/delete request.
Priority of the task. Possible values: 1 -> high, 2 -> normal, 3 -> low.
project_id
Integer
Related project ID.
company_id
Integer
Related company ID.
person_id
Integer
Related person ID.
invoice_id
Integer
Related invoice ID.
order_id
Integer
Related order ID.
quote_id
Integer
Related quote ID.
purchase_order_id
Integer
Related purchase order ID.
rent_order_id
Integer
Related rental order ID.
bill_id
Integer
Related bill ID.
start_datetime
Datetime (YYYY-mm-dd HH:ii:ss)
Events start time. Used only for calendar events.
end_datetime
Datetime (YYYY-mm-dd HH:ii:ss)
Events end time. Used only for calendar events.
full_day_event
Boolean
If this is a full day event.
duration_planned
Time (HH:ii:ss)
Events or tasks planned duration. Rounded to the nearest minute.
duration_actual
Time (HH:ii:ss)
Tasks actual duration. This field is read only - it is calculated based on task time entries.
billable_hours
Time (HH:ii:ss)
Events billable duration. Rounded to nearest minute.
datetime_due
Datetime (YYYY-mm-dd HH:ii:ss)
.
owner_id
Integer
User ID of the user that is responsible for the event.
assigned_to
Integer
User ID of the user performing the assigned task.
is_completed
Boolean
Is completed. Used only for tasks.
datetime_completed
Datetime (YYYY-mm-dd HH:ii:ss)
Tasks completion time. Used only for tasks. Has value if task is completed.
status_id
Integer
Deprecated Task status. Used only for tasks. Possible values: 1 -> in progress, 3 -> completed.
status
String
Event status. Possible values for events: busy, free, tentative, outofoffice. Possible values for tasks: task_status1, task_status2, task_status3, task_status4.
cal_user
Array
Users related with this event. Used only for calendar events. Populated only on view requests.
time_entries
Array
Array of tasks' time entries. Used only for tasks. Populated only on view requests.
resources
Array
Array of resources related to calendar event. Used only for calendar event. Populated only on view requests.
modified_date
Datetime (YYYY-mm-dd HH:ii:ss)
The date when event was last modified.
permissions
Array
Object user permissions. Used only for user based API
custom_fields
Object
Custom fields. Only filled on view requests.
is_deleted
Boolean
Is deleted. Use 'include_deleted = 1' in request object to get deleted objects to response as well.
Available actions are
list
modify
view
delete
Request URL
https://#companyname#.scoro.ee/api/events
Time entries
Name
Type
Description
time_entry_id
Integer
Time entry ID.
description
String
Description.
title
String
Time Entry title. It will be constructed dynamically based on description and activity id values.
user_id
Integer
Related user ID.
activity_id
Integer
Related activity ID.
invoice_line_id
Integer
Related invoice line ID.
start_datetime
Datetime (YYYY-mm-dd HH:ii:ss)
Planned start date and time.
end_datetime
Datetime (YYYY-mm-dd HH:ii:ss)
Planned end date and time.
duration
Time (HH:ii:ss)
Time entry duration. Rounded to the nearest minute.
billable_duration
Time (HH:ii:ss)
Billable duration for time entry. Only used if site has billable hours feature activated. Rounded to the nearest minute.
is_completed
Boolean
Is the time entry completed or not.
is_confirmed
Boolean
Is the time entry confirmed or not.
completed_datetime
Datetime (YYYY-mm-dd HH:ii:ss)
Date and time when the time entry was completed. Will be set to current time, if time entry is completed and no datetime provided.
is_deleted
Boolean
Is deleted. Use 'include_deleted = 1' in request object to get deleted objects to response as well.
deleted_date
Datetime (YYYY-mm-dd HH:ii:ss)
The date when object was deleted.
Event Resources
Name
Type
Description
resource_id
Integer
Event resource ID.
resource_name
String
Event resource name.
resource_color
String
Event resource colour set in Scoro. Format is in hex "#ffffff"
Payment type, possible values are banktransfer, cash, cardpayment, credit, barter
fine
String
Fine percent per day
quote_id
Deprecated Integer
Related quote ID.
order_id
Deprecated Integer
Related order ID.
credited_invoices
Array
Credited invoices ID-s. Multiple invoices can be linked with one credit invoice.
prepayment_sum
Float
Prepayment sum (only for view command).
real_estate_id
Integer
Related real estate ID.
reference_no
String
Invoice reference number.
id
Integer
Document ID
no
Integer
Document number.
discount
Float
Overall discount.
discount2
Float or None
First additional discount.
discount3
Float or None
Second additional discount.
sum
Decimal (15,2)
Total sum after discounts without VAT. This value is ignored on modify and calculated from rows instead.
vat_sum
Decimal (15,2)
Total VAT sum. This value is ignored on modify and calculated from rows instead.
vat
Decimal(5,3)
VAT percent. Only used if line based VAT setting is not activated.
vat_code_id
Invoice default vat_code_id
company_id
Integer
ID of the related client.
person_id
Integer
ID of the related contact person.
company_address_id
Integer
If a company has multiple addresses, use this field to set which address is used on the document. If company_address_id is not specified, default address will be used.
interested_party_id
Integer
ID of the interested party. Only used if site has interested party feature activated.
interested_party_address_id
Integer
See company_address_id. Only used if site has interested party feature activated.
project_id
Integer
ID of the related project. If ID is -1 then each document line can have a different related project.
currency
String
Used currency. The default currency for site is used on modify if currency is missing or invalid.
owner_id
Integer
User ID of the user that is responsible for the document.
date
Date (YYYY-mm-dd)
Document date
deadline
Date (YYYY-mm-dd)
Document deadline
status
String
Status of the document(paid, unpaid)
description
String
Document description
account_id
String
Related company account. The account from the main request object is used on modify.
is_sent
Boolean
If document is sent. (Cannot unset when document is sent via Scoro)
lines
Array
Document lines. Lines will be null for list request and is only filled for view requests.
modified_date
Datetime (YYYY-mm-dd HH:ii:ss)
The date when document was last modified.
custom_fields
Object
Custom fields. Only filled on view requests.
is_deleted
Boolean
Is deleted. Use 'include_deleted = 1' in request object to get deleted objects to response as well.
deleted_date
Datetime (YYYY-mm-dd HH:ii:ss)
The date when object was deleted.
Available actions are
list
modify
view
delete
Request URL
https://#companyname#.scoro.ee/api/invoices
Invoice lines
Name
Type
Description
depot_amounts
Array
Array of objects containing the fields depot_id, amount, serial_no for each depot from which products should be taken.
id
Integer
Document line ID
product_id
Integer
ID of the product.
comment
String
Line comment.
comment2
String
Second line comment. Only used if "Use additional comments on lines" setting is activated.
price
Decimal (15,4)
Unit price.
amount
Decimal (15,2)
Amount.
amount2
Decimal (15,2)
Additional amount. Only used if "Use additional amount" setting is activated.
discount
Float
Line discount. Only used if "Use line based discount" setting is activated.
sum
Decimal (15,2)
Line sum without VAT.
vat
Decimal (5,2)
Line tax percent. Only used if "Use line based tax rates" setting is activated.
vat_code_id
Integer
Line tax id. Only used if "Use line based tax rates" setting is activated.
unit
String
Unit name.
finance_object_id
Integer
ID of the related accounting object. Only used if "Use accounting objects" setting is activated.
finance_account_id
Integer
ID of the related finance account. Only used if "Use finance accounts" setting is activated.
cost
Decimal(15,4)
Line cost. Only used if "Use margin" setting is activated.
supplier_id
Integer
ID of the contact supplying the product on this line. Only used if "Use margin" setting is activated.
project_id
Integer
ID of the related project.
custom_fields
Object
Custom fields. Only filled on view requests.
Prepayments
Name
Type
Description
fine
String
Fine percent per day
quote_id
Integer
Related quote ID.
order_id
Integer
Related order ID.
prepayment_percent
Float
Percent to pay in advance.
id
Integer
Document ID
no
Integer
Document number.
discount
Float
Overall discount.
discount2
Float or None
First additional discount.
discount3
Float or None
Second additional discount.
sum
Decimal (15,2)
Total sum after discounts without VAT. This value is ignored on modify and calculated from rows instead.
vat_sum
Decimal (15,2)
Total VAT sum. This value is ignored on modify and calculated from rows instead.
vat
Decimal(5,3)
VAT percent. Only used if line based VAT setting is not activated.
vat_code_id
Invoice default vat_code_id
company_id
Integer
ID of the related client.
person_id
Integer
ID of the related contact person.
company_address_id
Integer
If a company has multiple addresses, use this field to set which address is used on the document. If company_address_id is not specified, default address will be used.
interested_party_id
Integer
ID of the interested party. Only used if site has interested party feature activated.
interested_party_address_id
Integer
See company_address_id. Only used if site has interested party feature activated.
project_id
Integer
ID of the related project. If ID is -1 then each document line can have a different related project.
currency
String
Used currency. The default currency for site is used on modify if currency is missing or invalid.
owner_id
Integer
User ID of the user that is responsible for the document.
date
Date (YYYY-mm-dd)
Document date
deadline
Date (YYYY-mm-dd)
Document deadline
status
String
Status of the document(paid, unpaid)
description
String
Document description
account_id
String
Related company account. The account from the main request object is used on modify.
is_sent
Boolean
If document is sent. (Cannot unset when document is sent via Scoro)
lines
Array
Document lines. Lines will be null for list request and is only filled for view requests.
modified_date
Datetime (YYYY-mm-dd HH:ii:ss)
The date when document was last modified.
custom_fields
Object
Custom fields. Only filled on view requests.
is_deleted
Boolean
Is deleted. Use 'include_deleted = 1' in request object to get deleted objects to response as well.
Total sum after discounts without VAT. This value is ignored on modify and calculated from rows instead.
vat_sum
Decimal (15,2)
Total VAT sum. This value is ignored on modify and calculated from rows instead.
vat
Decimal(5,3)
VAT percent. Only used if line based VAT setting is not activated.
vat_code_id
Invoice default vat_code_id
company_id
Integer
ID of the related client.
person_id
Integer
ID of the related contact person.
company_address_id
Integer
If a company has multiple addresses, use this field to set which address is used on the document. If company_address_id is not specified, default address will be used.
interested_party_id
Integer
ID of the interested party. Only used if site has interested party feature activated.
interested_party_address_id
Integer
See company_address_id. Only used if site has interested party feature activated.
project_id
Integer
ID of the related project. If ID is -1 then each document line can have a different related project.
currency
String
Used currency. The default currency for site is used on modify if currency is missing or invalid.
owner_id
Integer
User ID of the user that is responsible for the document.
date
Date (YYYY-mm-dd)
Document date
deadline
Date (YYYY-mm-dd)
Document deadline
status
String
Status of the document(approved, completed, declined, incomplete, pending, ready)
description
String
Document description
account_id
String
Related company account. The account from the main request object is used on modify.
is_sent
Boolean
If document is sent. (Cannot unset when document is sent via Scoro)
lines
Array
Document lines. Lines will be null for list request and is only filled for view requests.
modified_date
Datetime (YYYY-mm-dd HH:ii:ss)
The date when document was last modified.
custom_fields
Object
Custom fields. Only filled on view requests.
is_deleted
Boolean
Is deleted. Use 'include_deleted = 1' in request object to get deleted objects to response as well.
deleted_date
Datetime (YYYY-mm-dd HH:ii:ss)
The date when object was deleted.
Available actions are
list
modify
view
delete
Request URL
https://#companyname#.scoro.ee/api/quotes
Quote lines
Name
Type
Description
dates
Object
Object with dates as keys and amounts as values. Empty on list requests.
is_confirmed
boolean
Quote line confirmation state
id
Integer
Document line ID
product_id
Integer
ID of the product.
comment
String
Line comment.
comment2
String
Second line comment. Only used if "Use additional comments on lines" setting is activated.
price
Decimal (15,4)
Unit price.
amount
Decimal (15,2)
Amount.
amount2
Decimal (15,2)
Additional amount. Only used if "Use additional amount" setting is activated.
discount
Float
Line discount. Only used if "Use line based discount" setting is activated.
sum
Decimal (15,2)
Line sum without VAT.
vat
Decimal (5,2)
Line tax percent. Only used if "Use line based tax rates" setting is activated.
vat_code_id
Integer
Line tax id. Only used if "Use line based tax rates" setting is activated.
unit
String
Unit name.
finance_object_id
Integer
ID of the related accounting object. Only used if "Use accounting objects" setting is activated.
finance_account_id
Integer
ID of the related finance account. Only used if "Use finance accounts" setting is activated.
cost
Decimal(15,4)
Line cost. Only used if "Use margin" setting is activated.
supplier_id
Integer
ID of the contact supplying the product on this line. Only used if "Use margin" setting is activated.
project_id
Integer
ID of the related project.
custom_fields
Object
Custom fields. Only filled on view requests.
Orders
Name
Type
Description
quote_id
Integer
Related quote ID.
id
Integer
Document ID
no
Integer
Document number.
discount
Float
Overall discount.
discount2
Float or None
First additional discount.
discount3
Float or None
Second additional discount.
sum
Decimal (15,2)
Total sum after discounts without VAT. This value is ignored on modify and calculated from rows instead.
vat_sum
Decimal (15,2)
Total VAT sum. This value is ignored on modify and calculated from rows instead.
vat
Decimal(5,3)
VAT percent. Only used if line based VAT setting is not activated.
vat_code_id
Invoice default vat_code_id
company_id
Integer
ID of the related client.
person_id
Integer
ID of the related contact person.
company_address_id
Integer
If a company has multiple addresses, use this field to set which address is used on the document. If company_address_id is not specified, default address will be used.
interested_party_id
Integer
ID of the interested party. Only used if site has interested party feature activated.
interested_party_address_id
Integer
See company_address_id. Only used if site has interested party feature activated.
project_id
Integer
ID of the related project. If ID is -1 then each document line can have a different related project.
currency
String
Used currency. The default currency for site is used on modify if currency is missing or invalid.
owner_id
Integer
User ID of the user that is responsible for the document.
date
Date (YYYY-mm-dd)
Document date
deadline
Date (YYYY-mm-dd)
Document deadline
status
String
Status of the document(approved, completed, declined, incomplete, pending)
description
String
Document description
account_id
String
Related company account. The account from the main request object is used on modify.
is_sent
Boolean
If document is sent. (Cannot unset when document is sent via Scoro)
lines
Array
Document lines. Lines will be null for list request and is only filled for view requests.
modified_date
Datetime (YYYY-mm-dd HH:ii:ss)
The date when document was last modified.
custom_fields
Object
Custom fields. Only filled on view requests.
is_deleted
Boolean
Is deleted. Use 'include_deleted = 1' in request object to get deleted objects to response as well.
deleted_date
Datetime (YYYY-mm-dd HH:ii:ss)
The date when object was deleted.
Available actions are
list
modify
view
delete
Request URL
https://#companyname#.scoro.ee/api/orders
Order lines
Name
Type
Description
dates
Object
Object with dates as keys and amounts as values. Empty on list requests.
id
Integer
Document line ID
product_id
Integer
ID of the product.
comment
String
Line comment.
comment2
String
Second line comment. Only used if "Use additional comments on lines" setting is activated.
price
Decimal (15,4)
Unit price.
amount
Decimal (15,2)
Amount.
amount2
Decimal (15,2)
Additional amount. Only used if "Use additional amount" setting is activated.
discount
Float
Line discount. Only used if "Use line based discount" setting is activated.
sum
Decimal (15,2)
Line sum without VAT.
vat
Decimal (5,2)
Line tax percent. Only used if "Use line based tax rates" setting is activated.
vat_code_id
Integer
Line tax id. Only used if "Use line based tax rates" setting is activated.
unit
String
Unit name.
finance_object_id
Integer
ID of the related accounting object. Only used if "Use accounting objects" setting is activated.
finance_account_id
Integer
ID of the related finance account. Only used if "Use finance accounts" setting is activated.
cost
Decimal(15,4)
Line cost. Only used if "Use margin" setting is activated.
supplier_id
Integer
ID of the contact supplying the product on this line. Only used if "Use margin" setting is activated.
project_id
Integer
ID of the related project.
custom_fields
Object
Custom fields. Only filled on view requests.
Expenses
Name
Type
Description
no
String
Document number.
is_chargeable
Boolean
Shows if bill is chargeable to the client.
dateofpayment
Date (YYYY-mm-dd)
Date of payment.
payment_type
String
Payment type, possible values are banktransfer, cash, cardpayment, credit, barter.
recognition_date
Date (YYYY-mm-dd)
Recognition date.
reference_no
String
Reference number, Available in view/modify request. Not filterable.
purchase_order_id
Integer
Related purchase order ID. Available in view request and list request.
id
Integer
Document ID
discount
Float
Overall discount.
discount2
Float or None
First additional discount.
discount3
Float or None
Second additional discount.
sum
Decimal (15,2)
Total sum after discounts without VAT. This value is ignored on modify and calculated from rows instead.
vat_sum
Decimal (15,2)
Total VAT sum. This value is ignored on modify and calculated from rows instead.
vat
Decimal(5,3)
VAT percent. Only used if line based VAT setting is not activated.
vat_code_id
Integer
Invoice default vat_code_id
vat_code
String
VAT code. Only used if line based VAT setting is not activated. Available in view request.
company_id
Integer
ID of the related client.
company_name
String
Name of the related company. Available in view request.
person_id
Integer
ID of the related contact person.
person_name
String
Name of the related contact person. Available in view request.
company_address_id
Integer
If a company has multiple addresses, use this field to set which address is used on the document. If company_address_id is not specified, default address will be used.
project_id
Integer
ID of the related project. If ID is -1 then each document line can have a different related project.
project_name
String
Name of the related project. Not shown in response if each document line has a different related project. Available in view request.
currency
String
Used currency. The default currency for site is used on modify if currency is missing or invalid.
owner_id
Integer
User ID of the user that is responsible for the document.
owner_email
String
E-mail of the user that is responsible for the document. Available in view request.
date
Date (YYYY-mm-dd)
Document date
deadline
Date (YYYY-mm-dd)
Document deadline
status
String
Status of the document(paid, unpaid)
description
String
Document description
account_id
String
Related company account. The account from the main request object is used on modify.
currency_rate
Decimal (25,15)
Exchange rate when invoice is issued. Indicates the invoice currency against the base currency. For example if the base currency is EUR and invoice currency is GBP then 1 GBP = X EUR. (X = currency_rate). Available in view request.
lines
Array
Document lines. Lines will be null for list request and is only filled for view requests.
modified_date
Datetime (YYYY-mm-dd HH:ii:ss)
The date when document was last modified.
created_date
Datetime (YYYY-mm-dd HH:ii:ss)
The date and time when document was created.
custom_fields
Object
Custom fields. Only filled on view requests.
is_deleted
Boolean
Is deleted. Use 'include_deleted = 1' in request object to get deleted objects to response as well.
deleted_date
Datetime (YYYY-mm-dd HH:ii:ss)
The date when object was deleted.
Available actions are
list
modify
view
delete
Request URL
https://#companyname#.scoro.ee/api/expenses
Expense lines
Name
Type
Description
id
Integer
Document line ID
product_id
Integer
ID of the product.
product_name
String
Name of the product. Available in view request.
product_code
String
Product code. Only used if "Product code" addon is activated. Available in view request.
comment
String
Line comment.
comment2
String
Second line comment. Only used if "Use additional comments on lines" setting is activated.
price
Decimal (15,4)
Unit price.
amount
Decimal (15,2)
Amount.
discount
Float
Line discount. Only used if "Use line based discount" setting is activated.
sum
Decimal (15,2)
Line sum without VAT.
vat
Decimal (5,2)
Line tax percent. Only used if "Use line based tax rates" setting is activated.
vat_code_id
Integer
Line tax id. Only used if "Use line based tax rates" setting is activated.
unit
String
Unit name.
finance_object_id
Integer
ID of the related accounting object. Only used if "Use accounting objects" setting is activated.
finance_object_name
String
Name of the related accounting object. Only used if "Use accounting objects" setting is activated. Available in view request.
finance_object_symbol
String
Symbol of the related accounting object. Only used if "Use accounting objects" setting is activated. Available in view request.
finance_account_id
Integer
ID of the related finance account. Only used if "Use finance accounts" setting is activated.
finance_account_name
String
Name of the related finance account. Only used if "Use finance accounts" setting is activated. Available in view request.
finance_account_symbol
String
Symbol of the related finance account. Only used if "Use finance accounts" setting is activated. Available in view request.
project_id
Integer
ID of the related project.
project_name
String
Name of the related project. Available in view request.
vat_code
String
VAT code. Only used if "Use line based tax rates" setting is activated. Available in view request.
custom_fields
Object
Custom fields. Only filled on view requests.
Products
Name
Type
Description
product_id
Integer
Product ID
code
String
Product code.
name
String
Product name in the language specified in request object. This field is used for view and list requests only. Modify requests should put the names to the field "names" (see example).
price
Decimal (15,4)
Product price. Price list id can be specified in the "price_list" field of the request object. Default price list will be used if "price_list" field is not set.
buying_price
Decimal (15,4)
Product buying price. Price list id can be specified in the "price_list" field of the request object. Default price list will be used if "price_list" field is not set.
description
String
Product description. Modify requests support descriptions in multiple languages (see example).
description2
String
Product additional description. Modify requests support additional descriptions in multiple languages (same as description field).
tag
String
Product tag.
url
String
Product URL.
supplier_id
Integer
Product supplier ID. Only used if extra field "Supplier" is activated.
productgroup_id
Integer
Product group ID. Only used if "Use product extras" setting is activated.
is_active
Boolean
If product is active or deactivated.
is_service
Boolean
If product is service or not.
default_vat_code_id
Integer
Default vat code. This applies to both default sales tax and purchases tax if aforementioned
default_sales_tax_id
Integer
Default sales vat code. This only applies to sales documents.
default_purchases_tax_id
Integer
Default purchases vat code. This only applies to purchase documents.
accounting_object_id
Integer
Product default accounting object. Only used if "Use accounting objects" setting is activated.
depots_total_amount
Decimal (15,4)
Total amount in all depots. Only used if site has "Depot" feature. To modify depot amounts use the depot_amounts field.
depot_amounts
Object
Amounts for each depot (depot ID as key and amount as value). Only used if site has "Depot" feature. This will be null on list requests.
pictures
Array
Product pictures. Only used if "Use product extras" setting is activated. This will be null on list requests.
modified_date
Datetime (YYYY-mm-dd HH:ii:ss)
The date when project was last modified.
custom_fields
Object
Custom fields. Only filled on view requests.
is_deleted
Boolean
Is deleted. Use 'include_deleted = 1' in request object to get deleted objects to response as well.