API Reference

/api/Batch

post
https://reporting.ecrypt.com/api/Batch
Body Params
date-time
required
Defaults to 2025-01-01

Start date, all date times are in UTC.

Format:

  • yyyy-MM-dd
  • yyyy-MM-ddTHH:mm
  • yyyy-MM-ddTHH:mm:ss
  • yyyy-MM-ddTHH:mm:ss.fff
date-time
required
Defaults to 2025-02-01

End date, all date times are in UTC.

Format:

  • yyyy-MM-dd
  • yyyy-MM-ddTHH:mm
  • yyyy-MM-ddTHH:mm:ss
  • yyyy-MM-ddTHH:mm:ss.fff
string | null
^[A-Za-z0-9]*$
Defaults to Id

Sort column, the column being used for sorting. The default is batch Id.

Valid Options:

  • Id
  • Closed
  • Sales
  • Refunds
  • Voids
  • GrossRevenue
  • RefundTotal
  • NetIncome
  • Status
int32 | null
1 to 2147483647
Defaults to 1

Page, the of results being requested.

int32 | null
1 to 1000
Defaults to 20

Page size, the number of items being requested for the page.

string | null
^[A-Za-z]*$
Defaults to DESC

Sort order, the sort columns desired sort direction. The default is DESC.

Examples:

  • ASC
  • DESC
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Updated 6 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 6 months ago