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 Tender

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

Returns a paginated listing of sales history tender.

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
enum

Card Type used on transaction.

  • 0 - Visa
  • 1 - MasterCard
  • 2 - American Express
  • 3 - Discover
  • 4 - Diners Club
  • 6 - PayPal Credit Line
  • 5 - Private Label
  • 7 - Japan Credit Bureau
  • 8 - Gift Card
  • 9 - Debit
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
enum

Gift card type used on transaction.

  • 10 - Local - Gift Card
  • 20 - Local - Merchandise Credit
  • 30 - Local - Promo Gift Card
  • 40 - Gift Card - Manage funds
  • 50 - Local - Legacy Gift Card
  • 60 - Ace Gift Card
  • 70 - DIB Gift Card
  • 80 - FDMS Gift Card
string
length ≥ 1

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, invoice_id

integer

Page of results to retrieve

string

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

integer
-2147483648 to 2147483647

The unique system-assigned identifier for the store.

integer
enum

The status of this tender record.

  • 0 - Open
  • 1 - Void Requested
  • 2 - Refund Requested
  • 4 - Void Refund Requested
  • 5 - Payment Requested
  • 10 - Started
  • 11 - Authorized
  • 12 - Being Reversed
  • 13 - Being Refunded
  • 14 - Cancellation Requested
  • 20 - Finalized
  • 22 - Refunded
  • 21 - Voided
  • 31 - Declined
  • 32 - Not Accepted
  • 34 - Payment Failed
  • 35 - Void Failed
  • 33 - Canceled
  • 36 - Aborted
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?