Important information

To communicate with our API, your API client must support the TLS SNI extension. More details on our blog.

Here is the list of items that you can use in the Sellsy API:

  • document - A document can be of several types: invoice, order form, delivery slip, proforma invoice, estimate, credit note
  • doctype - Document type
  • row - A document line, it can be of several types: once, item, shipping, packaging
  • steps - Document status. Each document type has different laws (see below)
  • tax ou taxrate - Sales tax rate. It is part of a list of taxes that is set in your Sellsy account
  • unit - A unit. It is part of a list of units that is defined in your Sellsy account
  • tags - Also called 'Smart Tags'. It is possible to tag many objects. The tags are then used to create groups and filter data
  • third - A third is a third party, ie a customer or supplier
  • thircontact - Contact (associated with a third)

Documents in Sellsy are always complete. When you retrieve a document, you get all the information related to it. For example: the tax rate at the time of the creation of the document.

Each document type has different statuses:

Invoices :

  • Draft => draft
  • Paid => due
  • Partial payment => payinprogress
  • Paid => paid
  • Late => late
  • Cancelled => cancelled

Estimates

  • Draft => draft
  • Sent => sent
  • Read => read
  • Accepted => accepted
  • Refused => refused
  • Expired => expired
  • Down payment => advanced
  • Partially invoiced => partialinvoiced
  • Charged => invoiced
  • Cancelled => cancelled

Credit notes

  • Draft => draft
  • Unaffected => stored
  • Partial => partielspend
  • Affected => spent
  • Cancelled => cancelled

Proformas

  • Draft => draft
  • Sent => sent
  • Read => read
  • Accepted => accepted
  • Expired => expired
  • Down payment => advanced
  • Partially invoiced => partialinvoiced
  • Charged => invoiced
  • Cancelled => cancelled

Orders

  • Draft => draft
  • Sent => sent
  • Read => read
  • Accepted => accepted
  • Expired => expired
  • Down payment => advanced
  • Partially invoiced => partialinvoiced
  • Charged => invoiced
  • Cancelled => cancelled

Delivery slips

  • Draft => draft
  • Sent => sent
  • Read => read
  • Partially invoiced => partialinvoiced
  • Charged => invoiced

With Sellsy all elements such as taxes, units, carriers or packing belong to lists and are identified by a numeric sequence. To simplify the process, API integrates a conversion system.

Example :

  • 19.6 yax rate belongs to taxes and have 192 as identifier. With the API, you do not need to know its identifier: simply enter 19.06 and the API will do the conversion. If the element is not present in the list, you will be notified by an error message.

The API includes methods that allow you to act on these lists.

Sellsy allow you to manage the addresses of contacts and companies. They may have 'N' addresses.

Here's the process when you manipulate addresses in the documents:

  1. You create a document that has a shipping address and customer address.
  2. The document will duplicate these addresses to make them its addresses.
  3. When you retrieve the document, you retrieve delivery and customer address provided during creation.
  4. Addresses will be rewritten each time you update the document.

Sellsy use a cascading settings system on 3 levels:

  1. Account
  2. Customer
  3. Document

For example, let's take the payment term. It can be defined:

  1. 45 days at the account level
  2. 30 days at the client record level (applies only to documents created after updating this customer)
  3. 15 days at the document level

All the document settings follow these rules.