Skip to main content
Version: V2

Contract

Use the Contract API to generate, modify and renew CPQ quotesAttachment.

Introduction​

The Contract API allows you to manage contracts within the CPQ system. It provides endpoints to retrieve contract details.

Features and Functionalities​

The Contract API has the following functionalities:

1. Contract and contract archiving​

  • Endpoint:
    • GET /v2/contract/{contractId:int}: Retrieve a specific contract by its ID.
    • GET /v2/contract/bycontractnumber/{contractnumber:string}: Retrieve a specific contract by its contract number.
    • GET /v2/contract/contractNumber/{contractNumber}/archive: Archive a specific contract on Apparound.
    • GET /v2/contract/digitalarchivepayload/{contractNumber:string}: Retrieve the digital archive JSON payload for a specific contract.
  • Description: these endpoints allow for the retrieval of contract details and the management of contract archiving, including the access to the digital archive payload data of a specific contract.
  • Use Case: Use these endpoints to retrieve a contract or the complete data set for digital archiving, and archive a contract for long-term compliant storage.

2. Validation audit​

  • Endpoint:
    • GET /v2/contract/getjsonvalidationaudit/{quoteId:long}: Retrieve a specific quote json validation audit by its ID.
    • GET /v2/contract/downloadvalidationauditpdf/{quoteId:long}: Retrieve a specific quote pdf validation audit by its ID.
  • Description: These endpoints allow for the management of validation audit data, including customer data changes.
  • Use Case: Use these endpoints to manage method validation audit information within the system, ensuring that validation audit information data is up-to-date.