Search code examples
square-connect

square-connect v2 - how are sales metrics defined / calculated?


Is there somewhere in the square documentation where terms like "Gross Sales", "Net Sales", etc are defined precisely, along with how the taxes are calculated?

Looking at the sales reports it's totally unclear how these numbers are produced.

I've been trying to re-create the sales summary report with the /ListTransactions endpoint but it's impossible without this info.


Solution

  • Currently, the v2 ListTransactions endpoint does not break down transaction amounts in such a way that it's straightforward to recreate the Square dashboard's sales summary report. However, the v1 List Payments endpoint does. This section of the v1 documentation describes the monetary fields of a Payment object returned by v1.

    Additionally, this PHP code sample demonstrates generating something very similar to the dashboard sales summary report using v1 endpoints. The sample is also available in a few other languages.