EZezypay

Generate Outstanding Collections Report

Changed on

Generate Outstanding Collections Report

post/billing/reports/outstandingcollectionsreport/generate

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/billing/reports/outstandingcollectionsreport/generate
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://identity-sandbox.ezypay.com/token

Headers

merchantstring required

Merchant ID

Request body

reportFormatstring

Allows the report to be generated in either the .CSV format or the .PDF format. By default, it is PDF.

daysOutstandingstring

Number of days outstanding, Supported values are ALL, THIRTY, SIXTY, NINETY. By default, it is THIRTY.

reportFiltersstring[] required

Results will be filtered by this field. Supported values are FAILED_WITHOUT_FURTHER_RETRY, FAILED_BUT_WILL_ATTEMPT_RETRY, DUE_BUT_NOT_ATTEMPTED_YET, NOT_YET_DUE.

sortFieldstring required

Results will be sorted by this field. Supported values are CUSTOMER_NAME, CUSTOMER_NUMBER, EZYPAY_NUMBER, TOTAL_OUTSTANDING_AMOUNT.

Response

200

fileIdstring
createdOnstring
documentTypestring

Example response

{
  "fileId": "43ad51ba-b161-40d0-9025-a10i9a32fb54",
  "createdOn": "2020-06-17T17:42:34.860",
  "documentType": "outstanding_collections_report"
}

Changes