Contracts

This API allows to retrieve the commercial contracts applicable to the provided search criteria. #### Request URI #### Request Parameters

API field	Type	Description	Mandatory	Technical Details
`salesOrganization`	String	Sales organization code used to identify the commercial context.	Y	Mapped to SAP SalesOrg. Maximum length: 4.
`vendorCode`	String	Vendor code used for the contract search.	Y	Mapped to SAP VendorCode. Maximum length: 10. Leading zeroes must be preserved where applicable.
`invoiceDate`	String	Invoice reference date used to identify applicable contracts.	Y	Mapped to SAP InvoiceDate. Expected format: YYYY-MM-DD.
`periodStartDate`	String	Start date of the period used for the contract search.	N	Mapped to SAP StartPeriod when provided. Expected format: YYYY-MM-DD.
`periodEndDate`	String	End date of the period used for the contract search.	N	Mapped to SAP EndPeriod when provided. Expected format: YYYY-MM-DD.
`brandCode`	String	Brand code to be included in the contract search.	Y	Mapped to SAP Brands. Mandatory because required by the SAP SOAP WSDL. Can be repeated to search for multiple brands. At least one brandCode must be provided.

#### Request Example

GET /contracts/v1?salesOrganization=<SALES_ORGANIZATION>&vendorCode=<VENDOR_CODE>&invoiceDate=<INVOICE_DATE>&periodStartDate=<PERIOD_START_DATE>&periodEndDate=<PERIOD_END_DATE>&brandCode=<BRAND_CODE>

#### Request Example with multiple brands

GET /contracts/v1?salesOrganization=<SALES_ORGANIZATION>&vendorCode=<VENDOR_CODE>&invoiceDate=<INVOICE_DATE>&periodStartDate=<PERIOD_START_DATE>&periodEndDate=<PERIOD_END_DATE>&brandCode=<BRAND_CODE_1>&brandCode=<BRAND_CODE_2>

#### Request Example - Test Case

GET /contracts/v1?salesOrganization=ES10&vendorCode=1000024624&invoiceDate=2026-07-13&periodStartDate=2025-03-01&periodEndDate=2026-08-28&brandCode=CG0A1301

#### Response Structure

API field	Type	Mandatory	Description
`contracts (0..∞)`
`contractCode`	String	N	Commercial contract identifier.
`contractTypeCode`	String	N	Commercial contract type code.
`brandCode`	String	N	Brand associated with the contract.
`validFromDate`	String	N	Contract validity start date.
`validToDate`	String	N	Contract validity end date.

#### Response Example

{
  "contracts": [
    {
      "contractCode": "1200009039",
      "contractTypeCode": "Z003",
      "brandCode": "CG0A1301",
      "validFromDate": "2025-04-01",
      "validToDate": "2025-04-30"
    }
  ]
}

#### Empty Response Example

{
  "contracts": []
}

#### Error Response Structure

API field	Type	Mandatory	Description
`status`	String	Y	Response status. Returned as Error in case of failed processing.
`message`	String	Y	Error message describing the reason of the failure.

#### Error Response Examples

Validation error - Missing brandCode

{
  "status": "Error",
  "message": "Missing mandatory parameter: brandCode."
}

Validation error - Generic

{
  "status": "Error",
  "message": "Invalid or missing request parameters."
}

SAP / backend processing error

{
  "status": "Error",
  "message": "Unable to retrieve contract information. SAP returned a processing error."
}

version 12 as of 1 week ago by Daniele.Urciuoli

0 Comments

Please sign in to post a comment.

Contracts

0 Comments

Docs Navigation