Retrieve Buyer By Id for Export

Overview

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

Resource Access

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

Parameters

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

Keys	Values
filter	%7B%7D
search	<field 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>/buyer/v1/buyer/export?size=2
Host: <hostname>
Authorization: Bearer Bearer <JWT token>
Content-Type: application/json

Example Response


{
   "_scroll_id": "eyJhbGciOiJFUzI1NiJ9.eyJzY3JvbGxJZCI6IkZHbHVZMngxWkdWZlkyOXVkR1Y0ZEY5MWRXbGtEWEYxWlhKNVFXNWtSbVYwWTJnQkZuRm1WMUZHT1d4aVZEaHhOV1kzTVVaQ2IyRm5VbWNBQUFBQUFBaGxRQlkyY2w5eFdsbEZRMU0yTFdReWREWlhiMEZsTWxWMyIsInRlbmFudElkIjoiNUQ0Q0QxRUEtNzI0Qi00NkFDLUE4NzgtMEIwNjhFMjM5RTAyIiwidmlydHVhbEVudiI6ImF3cy1udi1jcHhxYSIsInVzZXJJZCI6IjQwNGI4NjFjLTc0ZGYtNWUyOS1iNzBjLTVlOWMxM2MwOTk4NCJ9.bKnmDa7SgTJYPxTy0IlrSnqvIsUqegSud4Hf8EXNGFn275lXLKW5QlomL9qcpTnz3i4sX90-qGcjxR-Xjcw-Mg",
   "totalRecords": 17385,
   "totalType": "exact",
   "recordCount": 2,
   "records": [
       {
           "achRequested": false,
           "acl": [
               "pps:cpx-acquiring",
               "buyer:a3b07cee-c0bf-573e-bb23-6cdad16b221a",
               "institution:46e90e13-f4d6-5eb8-891f-aec06ea997d2",
               "network:b5027e31-b9d6-577c-b600-69c03c1f7c90"
           ],
           "associatedInstitutionId": "46e90e13-f4d6-5eb8-891f-aec06ea997d2",
           "associatedInstitutionName": "CPX00172 Before",
           "bid": "qaBidE00",
           "checkEnabled": false,
           "created": "2021-08-23T11:25:18.385Z",
           "creator": {
               "id": "a252fa5a-bf70-5e97-b589-cef7a3e7e5c2",
               "username": "qa+networkadmin"
           },
           "creditLimit": 1000,
           "deleted": false,
           "externalStatus": "Active",
           "id": "a3b07cee-c0bf-573e-bb23-6cdad16b221a",
           "isAlternateMailingAddress": false,
           "lodgePaymentEnabled": false,
           "modified": "2021-08-23T11:25:18.406Z",
           "modifier": {
               "id": "a252fa5a-bf70-5e97-b589-cef7a3e7e5c2",
               "username": "qa+networkadmin"
           },
           "name": "CPX00195",
           "paymentFileType": "2661f29d-c9a4-5768-a9dd-189343a41e56",
           "ssnEinType": "EIN",
           "status": "Approved",
           "virtualCardRequested": false,
           "yearlyEstimatedSpend": "1000",
           "achPaymentRoute": "MX Merchant",
           "lodgePaymentCards": [],
           "totalSuppliers": 0,
           "activeSuppliers": 0
       },
       {
           "associatedInstitutionName": "Auto Inst Braves -Bill Level-inst 14022",
           "address": {
               "country": "USA"
           },
           "vcnHostConfig": {
               "braves": {
                   "companyNumber": "99999"
               }
           },
           "ach": {
               "billing": "GOOD_FUNDS",
               "bankAccountId": "131ff0d9bd4dc5c62c74727c95c26c8dad4a0faab8e82039f178d4d1dd8f0dc2"
           },
           "bankAccounts": [
               {
                   "accountNumber": {
                       "hash": "YuxACkRBVuKAB6cs/Ng0KKI2IpRWEFNXPCSLCeWEy18=",
                       "mask": "2579"
                   },
                   "routingNumber": {
                       "hash": "eg+BvXJDky5Jz2Jr8TnsL5ft/uxcDKJoZiKuPTbklhs=",
                       "mask": "0020"
                   },
                   "accountType": "checking",
                   "defaults[0]": "VCN",
                   "bankName": "SUNTRUST",
                   "id": "131ff0d9bd4dc5c62c74727c95c26c8dad4a0faab8e82039f178d4d1dd8f0dc2"
               }
           ],
           "virtualCardRequested": true,
           "associatedInstitutionId": "52fb18cc-8859-5796-aa65-3abc3141e000",
           "vcnHost": "braves",
           "name": "2nd_Buyer_Card 14346",
           "externalStatus": "Active",
           "bid": "10781-75910",
           "status": "Approved",
           "achPaymentRoute": "MX Merchant",
           "dualPifApproval": {
               "enabled": false
           },
           "virtualCard": {
               "bankAccountId": "131ff0d9bd4dc5c62c74727c95c26c8dad4a0faab8e82039f178d4d1dd8f0dc2"
           },
           "acl": [
               "pps:cpx-acquiring",
               "buyer:4de41d35-86c6-5e10-a425-857b0364dc95",
               "institution:52fb18cc-8859-5796-aa65-3abc3141e000",
               "network:cab29fab-2ac6-5a54-ae49-0702ea5b8a5e"
           ],
           "deleted": false,
           "paymentFileType": "5a039d86-e99a-5490-a24a-05dbacb99ad4",
           "created": "2022-07-04T11:16:05.216Z",
           "creator": {
               "id": "2a3ecae6-aade-59c2-8332-3d713902c841",
               "username": "john.doe+uat"
           },
           "modified": "2022-07-04T11:16:05.216Z",
           "modifier": {
               "id": "2a3ecae6-aade-59c2-8332-3d713902c841",
               "username": "john.doe+uat"
           },
           "id": "4de41d35-86c6-5e10-a425-857b0364dc95",
           "lodgePaymentCards": [],
           "totalSuppliers": 1,
           "activeSuppliers": 1
       }
   ]
}