Get Application User Accounts List
Gets a list of Application User Accounts for one user.
If CAPI parameter DISAPULAD is set to “X” Payer/Sold-to detail data will not be returned.
URL
/cnbs/v1/apu/users/id/accounts
Method
GET
Parameters
Required
- Parameters (URI Parameter)
- User ID (user_id)
- GUID identifying an application user (Obtained by a Users Search).
Optional
- Cache ID (cache_id)
- GUID identifying the CAPi cache ID. If the cache_id is provided, the first request will retrieve the data as usual but also save the response in a cache table. The next call with the same cache ID value will retrieve the data from the cache table.
Example GET
cURL:
curl -X GET https://<<your.server.here>>/CNBS/v1/apu/users/id/accounts?sap-client=800&sap-language=EN&apiid=CNBSMV01R&user_id=A959E6704DF21EEAA1AEA05F353B4A56 -H content-type: application/json -H cnbssysid: nR4kLO/8HCiuv+1hev5fbMgcMpOwhKf3GvJZvxZ3ZPQ=
Response
The response consists of an accounts list table (data) and a status (status).
- Accounts List (data)
- Account ID (account_id)
- User ID (user_id)
- Account Type (account_type)
- Primary Account (primary_account)
- Sales Organization (sales_organization)
- Distribution Channel (distribution_channel)
- Division (division)
- Company Code (company_code)
- Allow Payments (allow_payments)
- Allow Deposits (allow_deposits)
- Status (status)
- Message Type (message_type)
- SAP Message Type.
- Errors:
- E = Error
- A = Abort
- X = Exception
- Others:
- S = Success
- W = Warning
- I = Information
- Message Identifier (message_identification)
- SAP Message ID.
- Message Number (message_number)
- SAP Message Number.
- Message Line (message_line_string)
- SAP Message Text.
Example Response
JSON:
{
"data": [
{
"application_id": "CNBSMV01R",
"account_id": "1WXjhQs1e05EG4BA396lS1DxEm8tiC",
"user_id": "000C29F0318A1EDEAFEE896F47D86B81",
"account_type": "Payer",
"primary_account": "4000",
"sales_organization": "3000",
"distribution_channel": "10",
"division": "00",
"company_code": "3000",
"payer_det": {
"address_data": {
"name": "North Energy Ltd",
"city": "Calgary",
"street": "#200 N. Road",
"postal_code_city": "T2P 4K9",
"region": "AB",
"country": "CA"
},
"communcation_data": {
"phone": [
{
"country_code": "CA",
"standard": "X",
"telephone": "00-141777754"
}
]
},
"company_data": [
{
"data": {
"company_code": "3000"
}
}
],
"payment_cards": [
{
"payment_card_type": "VISA",
"payment_card_token": "-E803-0002-PH3AE4RZAK831S",
"payment_card_name": "RC test",
"valid_from": "03-01-2026",
"valid_to": "01-28-2030",
"default": "X",
"last_four": "0002"
}
],
"soldto_list": [
{
"customer_number": "0000004000",
"sales_area_data": {
"sales_organization": "3000",
"distribution_channel": "10",
"division": "00"
},
"address_data": {
"name": "North Energy Ltd",
"city": "Calgary",
"street": "#200 N. Road",
"postal_code_city": "T2P 4K9",
"region": "AB",
"country": "CA"
}
},
{
"customer_number": "0000005000",
"sales_area_data": {
"sales_organization": "3000",
"distribution_channel": "10",
"division": "00"
},
"address_data": {
"name": "Bova Furnishings",
"city": "Cincinnati",
"street": "500 Main Street",
"postal_code_city": "45202",
"region": "OH",
"country": "US"
}
},
{
"customer_number": "0000006000",
"sales_area_data": {
"sales_organization": "3000",
"distribution_channel": "10",
"division": "00"
},
"address_data": {
"name": "RIWA Headquarters",
"city": "LOS ANGELES",
"district": "LOS ANGELES",
"street": "State St.",
"postal_code_city": "90011",
"region": "CA",
"country": "US"
}
}
],
"auto_pay_status": [
{
"company_code": "3000",
"payment_method": "CC",
"enrolled": true,
"payment_card_token": "-E803-0002-PH3AE4RZAK831S"
}
]
}
}
],
"status": {
"message_type": "S",
"message_identification": "/CNBS/X_API",
"message_number": 10,
"message_line_string": "Request successfully processed"
}
}