Fetch E-Invoice

Changed on
get/api/v1/get-einvoice

Request

  • Base URL
    https://securelink-staging.valorpaytech.com:443
  • URL
    https://securelink-staging.valorpaytech.com:443/api/v1/get-einvoice
  • Auth
    none required

Query parameters

appidstring required

Merchant APP ID (Alphanumeric - Length of 32 chars and special chars $@%#)

appkeystring required

Merchant APP KEY (Alphanumeric - Length of 32 chars and special chars $@%#)

epistring required

EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2

limitinteger

Number of records returned per page. Default 25, maximum 1000.

offsetinteger

Number of records to skip before the result set begins. Used with limit for pagination. Default 0.

search_valuestring

Phone, Amount, Invoice Number, Customer Name, Product Description, Email

date_filterstring required

Set the date filter.<table> <tbody><tr> <th>Date Filter</th> <th>Options</th> </tr> <tr> <td>Recent (Used by default if date filter is not passed)</td> <td>0</td> </tr> <tr> <td>Today</td> <td>1</td> </tr> <tr> <td>MTD</td> <td>2</td> </tr> <tr> <td>Yesterday</td> <td>3</td> </tr> <tr> <td>Last Month</td> <td>4</td> </tr> <tr> <td>Current Week</td> <td>5</td> </tr> <tr> <td>Last Week</td> <td>6</td> </tr> <tr> <td>Last 90 Days</td> <td>7</td> </tr> <tr> <td>Last 90Days Behind</td> <td>8</td> </tr> <tr> <td>All</td> <td>9</td> </tr> </tbody></table>

selected_datestring

Returns E-Invoices for one specific calendar date. Format YYYY-MM-DD. Applies only when date_filter is set to the single-date option.

free_select'ID' | 'UID' | 'Amount' | 'Email' | 'Phone'

Selects a single field to filter on. Must be sent together with free_select_text.

free_select_textstring

The value to match for the field chosen in free_select e.g. test@valorpaytech.com when free_select=Email. Ignored if free_select is not set.

start_date_rangestring date

Start date (inclusive) of a custom date range. Format YYYY-MM-DD. Required when a custom range is used, must be sent with end_date_range.

end_date_rangestring

End date (inclusive) of a custom date range. Format YYYY-MM-DD. Must be on or after start_date_range.

status'PAID' | 'PENDING' | 'EXPIRED' | 'PROCESSING' | 'CANCELLED' | 'SALE(VOIDED)'

Filters results by E-Invoice status.

filterKeystring

Set to 0 when status is PAID or SALE(VOIDED), send an empty string for all other statuses.

Response

200

statusstring
messagestring
number_of_recordsinteger
page_numberinteger
total_resultsinteger
page_sizeinteger
total_pagesinteger

Example response

{
  "status": "OK",
  "message": "Success",
  "number_of_records": 2,
  "page_number": 1,
  "total_results": 8,
  "page_size": 2,
  "total_pages": 4,
  "data": [
    {
      "ID": 274426,
      "UID": "BiALkV1125lMvXiYZpaOLhbYB2gcH6Ds",
      "EPI": "2412333540",
      "INVOICE_MODE": "EINVOICE",
      "AMOUNT_TYPE": "FIXED",
      "AMOUNT": "20",
      "TAX": "0",
      "SURCHARGE": "0.6",
      "SURCHARGE_INDICATOR": 1,
      "ATTEMPTS": 1,
      "CREATED_ON": "2026-09-01 07:32:50",
      "ACTIVE_ON": "2026-09-02 07:32:49",
      "STATUS": "PENDING",
      "CUSTOMER_NAME": "Test",
      "INVOICE_NO": "inv0001",
      "PRODUCT_DESCRIPTION": "king size bed 10x12",
      "SMS_STATUS": 1,
      "IS_CUSTOMER_INFO_AVAIL": 1,
      "DBA_NAME": "Valor Store LLC",
      "CREATED_AT": "09/01/26 03:32 AM",
      "EXPIRED_AT": "09/02/26",
      "DAYS_UNTILL_EXPIRATION": 1
    }
  ]
}

Changes

    • breaking

      the query request parameter free_select was restricted to a list of enum values

    • breaking

      the query request parameter status was restricted to a list of enum values

    • breaking

      for the query request parameter limit, default value was changed from 200 to 25

    • info

      api operation id fetch-e-invoice-api removed and replaced with v1-fetch-einvoice

    • info

      added the new enum value Amount to the query request parameter free_select

    • info

      added the new enum value CANCELLED to the query request parameter status

    • info

      added the new enum value EXPIRED to the query request parameter status

    • info

      added the new enum value Email to the query request parameter free_select

    • info

      added the new enum value ID to the query request parameter free_select

    • info

      added the new enum value PAID to the query request parameter status

    • info

      added the new enum value PENDING to the query request parameter status

    • info

      added the new enum value PROCESSING to the query request parameter status

    • info

      added the new enum value Phone to the query request parameter free_select

    • info

      added the new enum value SALE(VOIDED) to the query request parameter status

    • info

      added the new enum value UID to the query request parameter free_select

    • info

      for the query request parameter date_filter, the format was generalized from date to no format

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status