Get status of Renewals

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  $skip	Integer	Query-String	The number of entries to skip from the beginning of the collection
  $top	Integer	Query-String	The number of entries to return from the beginning of the collection
  ContractId	String	Body	Contract Id
  ContractingEntity	String []	Body	List of Active Contracting Entity as present in CRM except for Swiss and Japan
  ContractType	RenewalStatusContractType	Body	Contract Type - Private, JointAccount, Corporate, LocalAssetSolution
  SalesOffice	Integer []	Body	List of Sales Office as present in CRM except for Swiss and Japan
  UserInitial	String	Body	UserInitial

• Response Parameters

  View Response Codes

  Name	Type	Description
  __count	Number	The total count of items in the feed.
  __next	String	The link for the next page of items in the feed.
  Data	ContractRenewalDetailData []	The collection of entities for this feed.
  MaxRows	Number	The maximum number of rows that can be returned (if applicable).

  HTTP Code	Description
  201	Created	Created
  400	Bad Request	Error Code Description InvalidRenewalStatusRequest Contract Type/Contracting Entity/Sales Office is not valid for this request
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  404	Not Found	Error Code Description ClientRenewalStatusDataNotFound Renewal Status data not found.
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  500	Internal Server Error	Internal Server Error
  503	Service Unavailable	Service Unavailable.

  Close

• Request Example

  Request URL

  POST /cm/v1/clientrenewals/all?$skip=1&$top=1

  Request Body

  {
    "ContractId": "stringValue",
    "ContractingEntity": [
      "stringValue"
    ],
    "ContractType": "Private",
    "SalesOffice": [
      99
    ],
    "UserInitial": "stringValue"
  }
  

• Response Example

  Response body

  {
    "Data": [
      {
        "ContractId": "stringValue",
        "ContractingEntity": "stringValue",
        "ContractRisk": "VeryHigh",
        "ContractType": "stringValue",
        "ContractualSolutionId": "stringValue",
        "IsRestricted": true,
        "OddExpiryDate": "2021-05-21T00:00:00Z",
        "RelationshipManager": "stringValue",
        "RenewalDetails": [
          {
            "CustomerRenewalDetails": [
              {
                "LoginUserId": "stringValue",
                "PoiStatus": {
                  "PendingMessage": "stringValue",
                  "PendingReasons": [
                    "CertificationMissingInvalid"
                  ],
                  "Status": "Approved"
                },
                "PorStatus": {
                  "PendingMessage": "stringValue",
                  "PendingReasons": [
                    "MissingProofOfResidence"
                  ],
                  "Status": "NotRequired"
                },
                "RenewalOtherDocuments": {
                  "DocumentStatus": "NotRequired",
                  "PendingMessage": "stringValue",
                  "PendingReasons": [
                    "OtherFamilyAllowanceForStudents"
                  ]
                },
                "RenewalState": "Pending",
                "SofStatus": {
                  "PendingMessage": "stringValue",
                  "PendingReasons": [
                    "BusinessIncomeFromSelfEmployed"
                  ],
                  "Status": "Approved"
                }
              }
            ],
            "RenewalStartDate": "2021-05-21T00:00:00Z",
            "RenewalStatus": "Waiting",
            "TypeOFTriggers": [
              "PhoneCountryCodeUpdate"
            ]
          }
        ],
        "RestrictionDate": "2021-05-21T00:00:00Z",
        "SalesOffice": "stringValue"
      }
    ],
    "MaxRows": 99
  }