GuidesAPI Reference
Log In
API Reference
These docs are for v2025.2.0. Click to read the latest docs for v2026.2.0.

List Sales History Header

get
https://api.epicorretailcloud.com/api/sales_history/v1/header/

Returns a paginated listing of sales headers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
deprecated

Filter upon Store ID. (Deprecated, use store_id instead.)

uri
length ≥ 1

This URL will be invoked when results are ready for retrieval. The payload will contain the location of the results file. Use the Check Deferred Execution Status API to poll for status, or include a value for callback_url to be notified when results are ready.

integer
-2147483648 to 2147483647

The ID of the clerk.

date

Date when transaction was closed.

date-time

Filter upon the closed date/time using ISO8601 format. Assumption is UTC unless TZ offset is specified.

date-time

Filter upon the create date/time using ISO8601 format. Assumption is UTC unless TZ offset is specified.

integer | null
-2147483648 to 2147483647

The ID of the customer.

string

Invoice number of the transaction.

boolean

Set to true to request asynchronous processing, which is required for larger data requests.

integer

Maximum number of results per page. The default is 25.

string

Fields to order upon. Valid fields include: branch_id, store_id, closed_date, closed_datetime, register_id, invoice_id, customer_id

integer

Page of results to retrieve

string

Term(s) to search for. The following fields will be searched: store_id, closed_date, customer_id, invoice_id, transaction_type, clerk_id

integer
-2147483648 to 2147483647

The ID of the store.

integer
enum

The transaction type.

  • 0 - Sale
  • 1 - Return
  • 2 - Credit
  • 3 - Sale Reversal
  • 4 - Return Reversal
  • 5 - Credit Reversal
  • 6 - POS Manual Void
  • 7 - Drawer Opened
  • 8 - Pay In
  • 9 - Pay Out
  • 10 - Cash Sweep
  • 11 - Viewer Void
  • 12 - Drawer Counted
  • 13 - Drawer Posted
  • 14 - No Sale
  • 15 - Gift Card Balance Inquiry
  • 16 - Payment On Account
  • 17 - Order
  • 24 - Special Order
  • 18 - Order
  • 25 - Special Order
  • 19 - Estimate
  • 20 - BO Invoice
  • 21 - BO Credit
  • 22 - BO Invoice Reversal
  • 23 - BO Credit Reversal
date-time

Filter upon the update date/time using ISO8601 format. Assumption is UTC unless TZ offset is specified.

Headers
integer
required

The id of the active store to be used for this API invocation

Responses

Updated over 1 year ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?