Table of Contents

Get customizing data

Get customizing data. Should be called once when the UI frontend do the first connect to SAP.

URL

/cnbs/v1/customizing

Method(s)

GET | POST

Example POST

curl -X POST "https://<<your.server.here>>/cnbs/v1/customizing?sap-client=800&sap-language=EN&apiid=CNBSMV01R" -H  "accept: application/json" -H  "content-type: application/json" -H  "cnbssysid: gPuM1VyY1dxlTE2MEs2yajJUkX3/4+2Pw1alRw4BOtI="

Example GET

curl -X GET "https://<<your.server.here>>/cnbs/v1/customizing?sap-client=800&sap-language=EN&apiid=CNBSMV01R" -H  "accept: application/json" -H  "content-type: application/json" -H  "cnbssysid: gPuM1VyY1dxlTE2MEs2yajJUkX3/4+2Pw1alRw4BOtI=" -H  "authorization: Basic Y2tvZXNzbDpjbmJzMjF5b3U="

Response

The response consists of several customizing tables. 

{
  "application_id": "CNBSMV01R",
  "description": "CNBS API Master V01 (RESTful)",
  "generel_data": {
    "partial_payments_allowed": "X",
    "cvv_use_control": "1"
  },
  "company_codes": [
    {
      "company_code": "3000",
      "currency_key": "USD",
      "active": "X"
    }
  ],
  "sales_area_data": [
    {
      "sales_organization": "3000",
      "distribution_channel": "10",
      "division": "00",
      "active": "X"
    }
  ],
  "document_types": [
    {
      "document_type": "01",
      "description": "Invoice",
      "maximum_documents_returned": 500,
      "pdf_document_available": "X",
      "status_id": "01"
    }
  ],
  "document_status": [
    {
      "status_id": "01",
      "status": "01",
      "description": "Open"
    },
    {
      "status_id": "01",
      "status": "02",
      "description": "Completed"
    },
    {
      "status_id": "01",
      "status": "03",
      "description": "Open and Completed"
    }
  ],
  "payment_types": [
    {
      "payment_type": "D",
      "description": "[Deposits] Direct AR",
      "active": "X"
    },
    {
      "payment_type": "O",
      "description": "[Payments] Open AR",
      "active": "X",
      "overpayment_allowed": "X"
    }
  ],
  "payment_provider": [
    {
      "payment_provider": "PM",
      "description": "Paymetric",
      "payment_provider_key": "6w/XoN9?7i}B-2Gn8y!Fg%W45Cd+j3*R",
      "payment_provider_merchant_guide": "711c8483-d37f-4d82-bb9d-0273a560a96d",
      "payment_provider_version": "PM03",
      "initialization_url": "https://qaapp02.xisecurenet.com/DIeComm"
    }
  ],
  "payment_reason_codes": [
    {
      "company_code": "3000",
      "payment_type": "D",
      "reason_code": "055",
      "description": "Payment on Account"
    },
    {
      "company_code": "3000",
      "payment_type": "O",
      "reason_code": "DG",
      "description": "Damaged goods"
    },
    {
      "company_code": "3000",
      "payment_type": "O",
      "reason_code": "PP",
      "description": "Partial payment"
    }
  ],
  "payment_cards": [
    {
      "payment_provider": "PM",
      "payment_card_type": "AMEX",
      "external_payment_card_type": "3000"
    },
    {
      "payment_provider": "PM",
      "payment_card_type": "EC"
    },
    {
      "payment_provider": "PM",
      "payment_card_type": "MC",
      "external_payment_card_type": "5000"
    },
    {
      "payment_provider": "PM",
      "payment_card_type": "VISA",
      "external_payment_card_type": "4000",
      "preauthorization_active": "X",
      "preauthorization_amount": 0.1
    }
  ],
  "release_information": {
    "releae_version": "01",
    "service_pack": "01",
    "publishing_date": "20180427"
  },
  "status": {
    "message_type": "S",
    "message_identification": "/CNBS/X_API",
    "message_number": 10,
    "message_line_string": "Request successfully processed"
  }
}