Get Sales Order

Use this method to get sales orders lists. See our HTTP GET documentation for complete queries method.

The following elements are returned in the get sales orders lists methods response :

Body Response

Element Description
id Unique code for identifier sales quotations. String 36 characters.
status Status transaction, the status must be one of the following types: draft, deleted, submitted, approved, voided, finished.
date Transaction date. Date format YYYY-MM-DD.
time Transaction time. Time format hh:mm:ss.
number Reference number of sales quotations. String maximum 35 characters.
description Description of sales quotations. String maximum 75 characters.
customer* Element for customer.
customer.id Unique code for identifier customer. String 36 characters.
customer.code Customer code String maximum 255 characters.
customer.name Customer name String maximum 255 characters.
customer.classification* Element for customer classification.
customer.classification.id Unique code for identifier classification. String 36 characters.
customer.classification.name Classification name String maximum 255 characters.
billing_address* Element for billing address.
billing_address.complete_address Billing address complete String
billing_address.district District name String
billing_address.city City name String
billing_address.state State name String
billing_address.country Country name String
billing_address.postal_code Postal code String
shipping_address* Element for shipping address.
shipping_address.complete_address Shipping Address complete String
shipping_address.district District name String
shipping_address.city City name String
shipping_address.state State name String
shipping_address.country Country name String
shipping_address.postal_code Postal code String
employees* Element for employees.
employees.id Unique code for identifier employees. String 36 characters.
employees.type* employees.type
employees.type.id Unique code for identifier employees type. String 36 characters.
employees.type.name employees type name. String 36 characters.
employees.contact.id Unique code for identifier contact. String 36 characters.
employees.contact.code Contact code String maximum 255 characters.
employees.contact.name Contact name String maximum 255 characters.
employees.contact.classification.id Unique code for identifier classification. String 36 characters.
employees.contact.classification.name Contact classification name String maximum 255 characters.
term_of_payment* Element for term_of_payment.
term_of_payment.base_date Base date period of credit transaction, for customer and vendor type date format YYYY-MM-DD.
term_of_payment.percentage Due date period of credit transaction, for customer and vendor type. Integer.
term_of_payment.due_date Due date period of credit transaction, for customer and vendor type date format YYYY-MM-DD.
term_of_payment.due_days Due date period of credit transaction, for customer and vendor type. Integer.
term_of_payment.late_charge_rate Credit transaction late charge Integer.
term_of_payment.discount_days Discount day, for customer and vendor type Integer.
term_of_payment.early_discount_rate Early discount, for customer and vendor type Integer.
currency* Element for currency.
currency.id Unique code for identifier currency. String 36 characters.
currency.code Currency code String maximum 3 characters.
currency.name Currency name String maximum 255 characters.
currency.symbol Currency symbol String maximum 255 characters.
exchange_rate Exchange rate number
department* Department of sales quotations.
department.id Unique code for identifier customer. String 36 characters.
department.code Customer code String maximum 255 characters.
department.name Customer name String maximum 255 characters.
project* Project of sales quotations.
project.id Unique code for identifier project. String 36 characters.
project.code Project code String maximum 255 characters.
project.name Project name String maximum 255 characters.
warehouse* Warehouse of sales quotations.
warehouse.id Unique code for identifier department. String 36 characters.
warehouse.code Warehouse code String maximum 255 characters.
warehouse.name Warehouse name String maximum 255 characters.
document* Document of sales quotations.
document.date Document date. Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format). Automaticaly.
document.number Document number String.
other_fields Element for other_fields
other_fields.id Unique code for identifier other_fields. String 36 characters.
other_fields.key key words of other_fields. String 36 characters.
other_fields.type other_fields type. String 36 characters.
other_fields.value other_fields value. String 36 characters.
attachments* attachments.
attachments.id Unique code for identifier attachments. String 36 characters.
attachments.name Attachments name String.
attachments.extension Attachments extension JPG, PNG, PDF String.
attachments.url Attachments url String.
line_amount_type tax_exclusive String.
line_items* line_items of sales quotations
line_items.id Unique code for identifier line_items. String 36 characters.
line_items.description line_items description Number
line_items.quantity line_items quantity Number
line_items.unit_price line_items unit_price Number
line_items.note line_items note Number
line_items.discount* Line items discount.
line_items.discount.rate Discount rate Number
line_items.discount.amount Discount amount Number
line_items product* line_items Product data.
line_items.product.id Unique code for identifier product. String 36 characters.
line_items.product.code Product code String maximum 255 characters.
line_items.product.name Product name String maximum 255 characters.
line_items.unit* line_items unit.
line_items.unit.id Unique code for identifier unit. String 36 characters.
line_items.unit.code Unit code String maximum 255 characters.
line_items.unit.name Unit name String maximum 255 characters.
line_items.account* line_items account data .
line_items.account.id Unique code for identifier account. String 36 characters.
line_items.account.code Account code String maximum 255 characters.
line_items.account.name Account name String maximum 255 characters.
line_items.account.alias_name Account alias name String maximum 255 characters.
line_items.departement* Departement data .
line_items.departement.id Unique code for identifier department. String 36 characters.
line_items.departement.code Departement code String maximum 255 characters.
line_items.departement.name Departement name String maximum 255 characters.
line_items.project* Project of sales quotations.
line_items.project.id Unique code for identifier project. String 36 characters.
line_items.project.code Project code String maximum 255 characters.
line_items.project.name Project name String maximum 255 characters.
line_items.warehouse* Warehouse data.
line_items.warehouse.id Unique code for identifier warehouse. String 36 characters.
line_items.warehouse.code Warehouse code String maximum 255 characters.
line_items.warehouse.name Warehouse code String maximum 255 characters.
final_discount* Final discount of sales quotations.
final_discount.type Unique code for identifier department. String 36 characters.
final_discount.description Warehouse code String maximum 255 characters.
final_discount.rate Warehouse name String maximum 255 characters
final_discount.amount Warehouse name String maximum 255 characters
final_discount.account* account
final_discount.account.id Unique code for identifier final_discount account. String 36 characters.
final_discount.account.code final_discount account code String maximum 255 characters
final_discount.account.name final_discount account name String maximum 255 characters.
others* Element for others.
others.id Unique code for identifier others.id. String 36 characters.
others.description others description String maximum 255 characters.
others.amount others number Number maximum 255 characters.
others.account* Account data .
others.account.id Unique code for identifier account. String 36 characters.
others.account.code Account code String maximum 255 characters.
others.account.name Account name String maximum 255 characters.
others.currency* others currency.
others.currency.id Unique code for identifier currency String 36 characters.
others.currency.code currency code String 255 characters.
others.currency.name currency name String 255 characters.
others.currency.symbol currency symbol String 255 characters.
others.exchange_rate Exchange_rate Number.
total_amount total_amount Number.
orders* Element for orders.
orders.id Unique code for identifier orders.id. String 36 characters.
orders.date orders date Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format).
orders.number orders number Number maximum 255 characters.
orders.description orders description Number maximum 255 characters.
created* Element for Created.
created.user* Created User.
created.user.id User id String Automaticaly.
created.user.name User name String.
created.user.email User email String.
created.time Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format). Automaticaly.
update* Element for Update.
update.user* Update user.
update.user.id User id String Automaticaly.
update.user.name User name String.
update.user.email User email String.
update.time Date Time format YYYY-MM-DDThh:mm:ss.fffZ (RFC 3339, ISO 8601 date format). Automaticaly.