API

Sales Transactions

This Web Service returns the full list of Sales Transactions, including all details, in a JSON array format.

It ouputs all fields and their corresponding value. It contains full Invoices Details, like nature, total price, tax values, customer identification, terminal and cashdrawer, date and time, employee, products quantities and prices details and payment tenders types and amounts.
Each new sale transaction will automatically discount stock quantity defined Store Warehouse, so you can have Live inventory quantities and valuations in real time. If transaction was cancelled, this method will automatically update current transaction and set back discounted stock quantities over all products details.

Bellow is a description list of some main fields you may get and post to this method:

FieldDescription
InvoiceNoFull Invoice Number
StoreIdStore belonging to current transaction.
TillIdCashdrawer Code where transaction was created
CustomerIdCustomer Code Indentification
SalesmanIdEmployee that created the transaction
TransDocumentTransaction Document Type
InvoiceStatusCurrent Invoice Status: Normal or Cancelled
TotalNetAmountTotal Net amount of all details
TotalGrossAmountTotal Final Amount with Taxes
TenderlineItemsArray with all tender payments types and amounts
SaleTransactionDetailsArray with all products details. See description table bellow

The following table lists a description of the SaleTransactionDetails array list:

FieldDescription
ItemIdProduct Code
QuantityQuantity sold
UnitPriceProduct Sale Price per unit
TotalNetAmountTotal line Net amount
TaxPercentageTax Applied
TotalTaxIncludedAmountTotal Price with Taxes included

Some specific customers and loyalty campaings processment are also made on current method. Although, this information is also available on different Web Services.

Search Arguments

To apply filters or search criteria over all sales transactions, the GET request type can receive the following arguments:

ArgumentDescription
storeStore Code to filter only Sales Transactions created on this store
InvoiceNoFilter and returns only the Sale Transaction with this Document Number
VoucherNoReturns the Sale Transaction that has this Voucher Code

HeadOffice Daily Resume

If you don't wish to send all detailed sales transactions back to your ERP software, there are 4 different Web Services that returns the total daily sales values, in the following grouped ways:

  • by Store and Date
  • by Store, Date and Customer
  • by Store, Date and Document Type
  • by Store, Date, Document Type and Customer

For more information about ERP comunication services, access the following Root page:

https://ENVIRONMENT.storesace.com/dimas/api/headoffice/

Note: To retrieve sales values over API, the Financials HO Integration module must be active.