Payer details
Get payer account details.
URL
/cnbs/v1/customers/id/payer
Method(s)
GET | POST
Parameters
Required
- Customer Number (customer_number)
Optional
- Company Code (company_code)
- Action (payer_det_action)
- 01 Get assigned soldto to the payer. If sales area parameters are filled, result list contains only soldto's matching the filter.
- Sales Area (sales_area_data)
- Sales Organization (sales_organization)
- Distribution Channel (distribution_channel)
- Division (division)
Example POST
JSON Payload:
{ "customer_number": "3050", "company_code": "3000", "action": "01", "sales_area_data": { "sales_organization": "3000", "distribution_channel": "10", "division": "00" } }
cURL
curl -X POST "https://<<your.server.here>>cnbs/v1/customers/id/payer?sap-client=800&sap-language=EN&apiid=CNBSMV01R" -H "accept: application/json" -H "cnbssysid: gPuM1VyY1dxlTE2MEs2yajJUkX3/4+2Pw1alRw4BOtI=" -H "authorization: Basic Y2tvZXNzbDpjbmJzMjF5b3U=" -H "Content-Type: application/json" -d "{ \"customer_number\": \"3050\", \"company_code\": \"3000\", \"action\": \"01\", \"sales_area_data\": { \"sales_organization\": \"3000\", \"distribution_channel\": \"10\", \"division\": \"00\" }}"
Example GET
cURL
curl -X GET "https://<<your.server.here>>/cnbs/v1/customers/id/payer?sap-client=800&sap-language=EN&apiid=CNBSMV01R&customer_number=3050&company_code=3000&payer_det_action=01&sales_organization=3000&distribution_channel=10&division=00" -H "accept: application/json" -H "content-type: application/json" -H "cnbssysid: gPuM1VyY1dxlTE2MEs2yajJUkX3/4+2Pw1alRw4BOtI="
Response
- Detail (detail)
- Address data (address_data)
- Name (name)
- Name 2 (name_2)
- Name 3 (name_3)
- Name 4 (name_4)
- City (city)
- District (district)
- Street (street)
- Postal Code City (postal_code_city)
- Region (region)
- Country (country)
- Communication data (communication_data)
- Phone (phone)
- Country code (country_code)
- Standard flag (standard)
- Telephone No (telephone)
- E-Mail addresses (smtp)
- Standard flag (standard)
- E-Mail address (email)
- Company Data Table (company_data)
- Data (data)
- Company Code (company_code)
- Payment Card Table (payment_cards)
- Payment Card Type (payment_card_type)
- Payment card type used for this transaction.
- Payment Card Token (payment_card_token)
- Tokenized payment card.
- Payment Card Name (payment_card_name)
- Full name of the payment card holder.
- Payment Card Valid-From (valid_from)
- Valid from date of the payment card.
- Payment Card Valid-To (valid_to)
- Expiry date of the payment card.
- Default
- X … Default Card
- Electronic Check Account Type (electronic_check_account_type)
- C … Consumer Checking Account (U.S. and Canada)
- S … Consumer Savings Account (U.S. only)
- X … Corporate Checking Account (U.S. only)
- Electronic Check Routing Number (electronic_check_rdfi_number)
- Receiving Depository Financial Institution Number.
- Soldto List Table(soldto_list)
- Customer Number (customer_number)
- Sales Area data (sales_area_data)
- Sales Organization (sales_organization)
- Distribution Channel (distribution_channel)
- Division (division)
- Address data (address_data)
- Name (name)
- Name 2 (name_2)
- City (city)
- District (district)
- Street (street)
- Postal Code City (postal_code_city)
- Region (region)
- Country (country)
- 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:
{ "detail": { "address_data": { "name": "Best Manufacturing Inc.", "city": "MAYWOOD", "district": "COOK", "street": "South 25th Ave", "postal_code_city": "60153", "region": "IL", "country": "US" }, "communcation_data": { "phone": [ { "country_code": "US", "standard": "X", "telephone": "555-111-1234" } ], "smtp": [ { "standard": "X", "email": "bush.holdings@mailinator.com" } ] }, "company_data": [ { "data": { "company_code": "3000" } } ], "payment_cards": [ { "payment_card_type": "EC", "payment_card_token": "-E803-9653-R0KMREDYR0AQ1K", "payment_card_name": "Susan Smith", "valid_from": "04-01-2017", "valid_to": "12-31-9999", "electronic_check_account_type": "C", "electronic_check_rdfi_number": "011000400" } ] }, "status": { "message_type": "S", "message_identification": "/CNBS/X_API", "message_number": 10, "message_line_string": "Request successfully processed" } }