Sign in
Customer Prepayment Applications

List CustomerPrepaymentApplication records

Retrieve a paginated list of CustomerPrepaymentApplication records with filtering and ordering options.

get/public/v2/customer-prepayment-applications/

Query parameters

searchstring nullable
company_idinteger[] nullable
numberinteger[] nullable
customer_idinteger[] nullable
start_datestring date nullable
end_datestring date nullable
transaction_currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
record_statusRecordStatus[] nullable
updated_afterstring date-time nullable
updated_beforestring date-time nullable
orderingstring nullable
limitinteger

Number of records to return per page (capped at 100)

Number of records to return per page (capped at 100)

offsetinteger

Number of records to skip before starting to return results

Number of records to skip before starting to return results

Response

OK

countinteger required

Changes

Changed in 2 of the 14 revisions of this API.13

  • 48edcb3acb742See the full diff
    • ○

      api operation id list_CustomerPrepaymentApplicationV2_records removed and replaced with list_CustomerPrepaymentApplication_records

      api-operation-id-removed

    • ○

      added the required property items/items/items to the response with the 200 status

      response-required-property-added

    This revision also has 93 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 844da04100e311See the full diff
    • ▲

      removed the required property items/items/items from the response with the 200 status

      response-required-property-removed

    • ○

      api operation id list_CustomerPrepaymentApplication_records removed and replaced with list_CustomerPrepaymentApplicationV2_records

      api-operation-id-removed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog