Skip to main content

Sales documents

Every sale in a Wino shop leaves a document: a receipt at the cash register, or a quote, an invoice, a delivery note or a credit note for business sales. This page explains how these documents fit together. They're read-only in the API. Every field is described in the GraphQL schema.

At the cash register​

  • A SalesReceipt is the receipt of a sale at the cash register, with its lines (items), discounts, taxes and payments.
  • A RefundReceipt is the receipt of a refund for a sales receipt (salesReceipt), with its reason (CANCELLATION_SALE, CASHING_ERROR, PRODUCT_NOT_COMPLIANT_OR_DAMAGED, OTHER_REASON). Its amounts are positive: subtract them from your sales.

Business documents​

  • A Quote is a price proposal to a customer (status: PUBLISHED, then ACCEPTED). It can become an invoice or a delivery note.
  • An Invoice is a sales invoice, with an issueDate and a dueDate, its payments, and a status: DRAFT, UNPAID or PAID. It can come from a quote (parentQuote) or from a sales receipt (salesReceipt).
  • A DeliveryNote is a document for goods delivered to a customer (status: DRAFT or PUBLISHED), possibly created from a quote or an invoice.
  • A CreditNote cancels all or part of an invoice (parentInvoice).

What every document has​

  • Its shop, the device it was made on (device) and, often, the staff member who made it (staff).
  • Its lines (items), taxes and totals (totalAmountIncludingTaxes, totalAmountExcludingTaxes…).
  • Quotes, invoices, delivery notes and credit notes also keep the customer and shop details as printed (customerName, shopName…), which can differ from the current Customer and Shop records.

To read sales into your own tools, see Connect an analytics system.