Essentio

Reads one of the connected Business's reports, as its dashboard computes them: income (Income over a period, by the issue date, a Credit Note subtracting), vat (the VAT reported on issued documents over a period, by category and rate), overdue (what is overdue today, by Client) or statement (one Client's Statement over a period: the balance brought forward, every document and Payment, and the closing balance). Amounts are decimal strings; income, vat and overdue are in the Business's reporting currency and count separately the documents in another currency they leave out. A Statement too long for one answer is refused; a shorter period fits.

essentio_get_report

Issues a Draft of the connected Business by its id: it takes its document number for good and today's issue date, and a due date already passed becomes today plus its payment terms. An issued document cannot be deleted, only cancelled. Does not send it to the Client; essentio_send_document does. Returns the document as it is now, or the Refusal's words and code when it cannot be issued.

essentio_issue_document

Records money a Client already paid against an issued Invoice or Proforma Invoice of the connected Business, by the document's id: the amount (a decimal string in the document's currency, not above its amount due), the day it was received and how. The document becomes Partially paid or Paid, and a Receipt is made. It moves no money. Returns the Payment with its Receipt, or the Refusal's words and code when the document takes no Payment.

essentio_record_payment

Reverses a Payment of the connected Business by its id: the Payment is voided and its Receipt keeps its number marked void, the document is owed that amount again, and every figure leaves it out. It moves no money and deletes nothing. Cannot be undone. Returns the voided Payment, or the Refusal's words and code when it is already voided.

essentio_reverse_payment

Lists the Clients of the connected Business, oldest first, optionally narrowed by a search over their name, legal name, email, account code and VAT number. Returns each Client with its id, contact and address details, currency, payment terms and preferred bank accounts, and a next_cursor for the next page. For one Client whose id you know, use essentio_get_client.

essentio_search_clients

Lists the documents of the connected Business — Invoices, Proforma Invoices, Credit Notes and Quotes — oldest first, optionally narrowed by type, status (overdue, and awaiting_payment: every document still taking a payment, in one list), Client, issue dates and a search over the document number, notes and Client name. Returns each document whole: number, type, status, Client, dates, currency, Lines, VAT, totals, money received, amount due, and the Actions the connection may take on it. Amounts are decimal strings in the document's currency. Drafts have no number and no issue date.

essentio_search_documents

Lists the Payments of the connected Business, oldest first, optionally only those of one document. Returns each Payment with its id, document, amount, currency, date, method, status (a reversed one is voided) and its Receipt, and a next_cursor for the next page. Amounts are decimal strings.

essentio_search_payments

Lists the Products and services of the connected Business, oldest first, optionally narrowed by a search over their name, code, SKU and description. Returns each with its id, name, unit, price, currency, VAT rate and the prices with and without VAT, as decimal strings.

essentio_search_products

Emails a document of the connected Business to its Client's address on record, with the document attached, through the Business's connected mail account; a Draft is issued first and takes its number. Takes an optional subject and message; it cannot send to any other address. Returns the document as it is now, or the Refusal's words and code when it cannot be sent (no Client address, no mail account connected, cancelled).

essentio_send_document

Changes a Client of the connected Business by its id: only the fields sent change, and is_active false makes it inactive. A changed VAT number is checked with the EU's VIES service. Returns the Client as it is now. Does not change the documents already made for it.

essentio_update_client

Changes a Draft of the connected Business by its id: only the fields sent change, and lines, when sent, replace every Line. Refuses a document that is already issued. Issues nothing, except a Draft still linked to the Proforma Invoice it was made from: its save is that Proforma's conversion, so it issues the Draft, or is refused when the Proforma does not convert into it. Returns the document with its VAT and totals as Essentio computed them. The person is shown it as a card with its Client, Lines, VAT and Total, and Issue and Send buttons where the connection may take them.

essentio_update_draft

Changes a Product of the connected Business by its id: only the fields sent change, and is_active false makes it inactive. Documents that already bill it keep their Lines as they are. Returns the Product as it is now.

essentio_update_product