Retrieve Supplier for Export

Overview

This route will search for supplier records based on the given search criteria for export

Resource Access

GET https://<hostname>/payee/v1/payee/export

Parameters

The requested criteria can be a combination of one or more of the following fields:

Keys	Values
filter	%7B%7D
search	<Item user wants to search>
size	10
sort	created%3Adesc
from	Defines the number of records to offset
fields	Allows the search to target specific fields
sort	Allows you to sort the matching results
globalFilters	Allows you to pass global filter.
scrollId	The id for the search context

Example Request

🚧
GET https://<hostname>/payee/v1/payee/export?size=2&sort=created%3Adesc

Example Response


{
   "_scroll_id": "eyJhbGciOiJFUzI1NiJ9.eyJzY3JvbGxJZCI6IkZHbHVZMngxWkdWZlkyOXVkR1Y0ZEY5MWRXbGtEWEYxWlhKNVFXNWtSbVYwWTJnQkZrNVVTM0ZTUVVSalVsbExVRUp1Wm04NWJYaHFObmNBQUFBQUFBWDNhQlptWjJnNVRTMTJUbFJvY1VSeFZuVm9kbGMwT0VwQiIsInRlbmFudElkIjoiNUQ0Q0QxRUEtNzI0Qi00NkFDLUE4NzgtMEIwNjhFMjM5RTAyIiwidmlydHVhbEVudiI6ImF3cy1udi1jcHhxYSIsInVzZXJJZCI6IjQwNGI4NjFjLTc0ZGYtNWUyOS1iNzBjLTVlOWMxM2MwOTk4NCJ9.93wliRbp39C9KtVkMJZc0ECuih9Bm6SET8fiWf4dHp10sXTvfbzQS7XdlxBX_tNiOLwUIbUO_sOJyV_IzqoYUA",
   "totalRecords": 82007,
   "totalType": "exact",
   "recordCount": 1,
   "records": [
       {
           "id": "5dce9b1b-b75a-530c-a8c0-ff63b892e686",
           "acl": [
               "pps:cpx-acquiring",
               "supplier:5dce9b1b-b75a-530c-a8c0-ff63b892e686",
               "buyer:b1a776bd-1c09-5c9f-830c-f263bd039dce",
               "institution:4a5ddde2-166b-54bb-82dc-4abad456f038",
               "network:a26a12d0-0967-5b08-b63f-892a8b217f38"
           ],
           "name": "Wire supplier main shivam",
           "status": "Approved",
           "address": {
               "city": "Panchkula",
               "state": "MP",
               "country": "USA",
               "street1": "533, First Floor",
               "street2": "Sector 12A",
               "postalCode": "10001"
           },
           "created": "2024-08-28T09:29:45.101Z",
           "creator": {
               "id": "d164ac22-fb51-55a2-abba-d98ed8ece457",
               "username": "shivam.ahuja+awsqa"
           },
"cpa": {
        "id": "b77258eb-3f16-5d9a-8819-94c4957776b3",
        "syncError": null
    },

           "deleted": false,
           "modified": "2024-08-28T09:29:48.637Z",
           "modifier": {
               "id": "d164ac22-fb51-55a2-abba-d98ed8ece457",
               "username": "shivam.ahuja+awsqa"
           },
           "passport": {
               "syncError": null,
               "customerId": 4005593,
               "externalAccount": {
                   "wire": {
                       "accountId": 4002986
                   }
               }
           },
           "variance": {
               "amount": 0
           },
           "payeeType": "Supplier",
           "acceptsWire": true,
           "paymentTypes": [
               {
                   "id": "V Card",
                   "type": "V Card",
                   "enabled": false,
                   "deliveryMethod": "Email",
                   "noNotification": false
               },
            {
    "id": "Wire",
    "type": "Wire",
    "phone": "3333333333",
    "address": {
        "city": "Amvala City",
        "state": "AL",
        "country": "USA",
        "street1": "Colony taran",
        "street2": "Airforce",
        "postalCode": "35013"
    },
    "enabled": true,
    "accountType": "Savings",
    "routingNumber": "121000248",
    "bankAccountNumber": "987654321495"
}
               {
                   "id": "Wire",
                   "type": "Wire",
                   "enabled": true,
                   "accountType": "Checking",
                   "routingNumber": {
                       "hash": "L45JEpx7mBOu8/OnLNpI1uWfJxwjky9bXicEnoFSnHE=",
                       "mask": "0248"
                   },
                   "bankAccountNumber": {
                       "hash": "JPHotseq53b1SDLcXtwNuHZtb6S0sFMmrZfKhjt8CyY=",
                       "mask": "7890"
                   }
               },
               {
                   "id": "Dollar Splits",
                   "type": "Dollar Splits",
                   "enabled": false
               },
               {
                   "id": "Dynamic Discounting",
                   "type": "Dynamic Discounting",
                   "enabled": false,
                   "netFees": false,
                   "lowTermDays": 0,
                   "discountRate": "0",
                   "highTermDays": 0
               },
               {
                   "id": "ACH+",
                   "type": "ACH+",
                   "enabled": false,
                   "flatFee": 0,
                   "netFees": false,
                   "discountRate": "0"
               },
               {
                   "id": "ACH",
                   "type": "ACH",
                   "enabled": false
               },
               {
                   "id": "Direct",
                   "type": "Direct",
                   "enabled": false
               },
               {
                   "id": "Check Issuing",
                   "type": "Check Issuing",
                   "enabled": false
               },
               {
                   "id": "Virtual Wallet",
                   "type": "Virtual Wallet",
                   "enabled": false,
                   "virtualWalletBalance": 0
               },
               {
                   "id": "Prepaid Debit",
                   "type": "Prepaid Debit",
                   "enabled": false,
                   "prepaidDebitBalance": 0
               },
               {
                   "id": "Payment Thresholds",
                   "type": "Payment Thresholds",
                   "enabled": false
               }
           ],
           "externalStatus": "Active",
           "isSupplierEnablement": false,
           "sids": [
               {
                   "id": "4019f13a-e9ad-51c8-8635-8845eabaf45a",
                   "name": "1221"
               }
           ],
           "totalBuyers": 1,
           "buyers": [
               {
                   "name": "Wire handover buyer"
               }
           ],
           "lastPayment": "08/28/2024"
       }
       
   ]
}