GetContractDetails (POST)

  • Overview
  • Request
  • Response
  • Examples
  • Data Elements
Overview

A contract is a document that provides information on services and/or product offered by a vendor or service provider. The primary elements in a contract include product or service name, descriptions, hierarchy, prices and internal codes etc.

 

URL Format: https://<Instance>/SmartBulkInterfaceAPI/api/Contract/ContractDetails

Request 
{
   "documentCode": 0,
   "DateEffective": "2020-01-21T09:20:02.619Z",
   "DateExpiry": "2020-01-21T09:20:02.619Z"
}

 

Response 
{
   "totalPages": 1,
   "ContractResult": [
      {
         "contractDetails": {
            "contractTypeDescription": "string",
            "contractDocumentTypeDescription": "string",
            "dateEffective": "2020-01-21T09:20:02.619Z",
            "dateExecuted": "2020-01-21T09:20:02.619Z",
            "expiryDateType": "string",
            "contractValue": 0,
            "contractCurrency": "string",
            "legalCompanys": [
               {
                  "legalCompanyName": "string",
                  "partnerTypeName": "string"
               }
            ],
            "url": "string",
            "paymentTermDetails": {
               "noOfDays": 0,
               "discount": 0,
               "discountDays": 0,
               "paymentTermCode": "string"
            },
            "contractTerminationDate": "string",
            "lastApprover": "string",
            "documentName": "string",
            "documentNumber": "string",
            "documentStatusInfo": "string",
            "documentPasList": [
               {
                  "pasName": "string",
                  "clientPASCode": "string"
               }
            ],
            "documentRegionList": [
               {
                  "regionCode": 0,
                  "regionName": "string",
                  "isSelected": true,
                  "isSingleNode": true
               }
            ],
            "documentBuList": [
               {
                  "businessUnitCode": "string",
                  "businessUnitName": "string"
               }
            ],
            "documentStakeHolderList": [
               {
                  "partnerName": "string",
                  "contactName": "string",
                  "emailId": "string",
                  "clientContactCode": "string",
                  "address": {
                     "addressCode": 0,
                     "addressline1": "string",
                     "addressline2": "string",
                     "addressline3": "string",
                     "city": "string",
                     "zipCode": "string",
                     "stateInfo": {
                        "stateAbbrevationCode": "string"
                     },
                     "countryInfo": {
                        "countryCode": "string",
                        "countryName": "string"
                     },
                     "phoneNo1": "string",
                     "phoneNo2": "string"
                  },
                  "clientPartnerCode": "string",
                  "partnerTypeName": "string",
                  "documentAddressDetailsList": [
                     {
                        "clientLocationCode": "string"
                     }
                  ]
               }
            ],
            "isConfidential": true,
            "interfaceDocumentStatus": "string",
            "createdOn": "2020-01-21T09:20:02.619Z",
            "contractDescription": "string",
            "parentContractTitle": "string",
            "parentContractNumber": "string",
            "renewalTerm": 0,
            "renewalTermType": "string",
            "renewalFrequency": 0,
            "terminationTypeDescription": "string",
            "terminationTerm": 0,
            "terminationTermType": 0,
            "penaltyAmount": 0,
            "erpNumber": "string",
            "entityDetails": [
               {
                  "entityCode": "string",
                  "entityType": "string",
                  "lob": "string"
               }
            ]
         },
         "contractLineItemList": [
            {
               "startDate": "2020-01-21T09:20:02.619Z",
               "endDate": "2020-01-21T09:20:02.619Z",
               "itemId": 0,
               "itemCode": 0,
               "itemName": "string",
               "itemDescription": "string",
               "pasCode": 0,
               "uomCode": "string",
               "unitPrice": 0,
               "taxAmount": 0,
               "totalPrice": 0,
               "quantity": 0,
               "unspscId": 0,
               "itemType": "string",
               "itemAbbrevationCode": "string",
               "manufacturerName": "string",
               "partnerItemNumber": "string",
               "manufacturerItemNumber": "string",
               "gtin": "string",
               "catalogName": "string",
               "clientPasCode": "string",
               "isTaxExempt": "string",
               "lineItemNo": 0,
               "lineItemStatus": "string"
            }
         ],
         "additionalInformationTabList": [
            {
               "tabName": "string",
               "additionalInformationSectionList": [
                  {
                     "sectionName": "string",
                     "additionalInformationQuestionList": [
                        {
                           "questionText": "string",
                           "questionsResponseList": [
                              {
                                 "isChildQuestionPresent": true,
                                 "childQuestionList": [
                                    null
                                 ]
                              }
                           ]
                        }
                     ]
                  }
               ]
            }
         ]
      }
   ],
   "totalCount": 1
}

 

Examples

Success Scenario - Request
Request below describes that this contains only the mandatory attributes:

{
   "documentCode": 93167,
   "DateEffective": "2019-10-01",
   "DateExpiry": "2019-11-06"
}

Success Scenario – Response

  {
       "totalPages": 1,
       "contractResult": [
       {
         "contractDetails": {
            "procurementProfileID": 0,
            "documentCode": 93167,
            "documentName": "searchtest1234",
            "documentNumber": "2019.001996",
            "documentDescription": null,
            "documentTypeInfo": 0,
            "documentStatusInfo": 1,
            "numberofItems": -1,
            "numberofSurveys": -1,
            "numberofSections": -1,
            "numberofPartners": -1,
            "numberofAttachments": -1,
            "documentPASList": [
               {
                  "pasCode": 51336250002511,
                  "pasName": "00A - Buildings - Fixed",
                  "clientPASCode": "00A",
                  "isSelected": false,
                  "isSingleNode": false,
                  "categoryLevel": 0
               }
            ],
            "documentRegionList": [
               {
                  "regionCode": 369,
                  "regionName": "Africa, Asia Pacific & Middle East",
                  "isSelected": false,
                  "isSingleNode": false
               }
            ],
            "documentBUList": [
               {
                  "businessUnitCode": 1572779,
                  "businessUnitName": "1003|EUREKA CA TRM CHEVRON:1003",
                  "businessUnitEntityCode": null,
                  "isSingleNode": false,
                  "entityHierarchy": null,
                  "parentEntityDetailCode": null,
                  "level": null
               }
            ],
            "documentStakeHolderList": [
               {
                  "documentStakeholderId": 81578,
                  "documentCode": 0,
                  "partnerCode": 70021704,
                  "contactCode": 7002170404000001,
                  "stakeholderTypeInfo": 5,
                  "isDeleted": false,
                  "partnerName": "Chevron",
                  "contactName": "CVX Admin Coordinator's",
                  "firstName": null,
                  "lastName": null,
                  "stakeholderDocumentStatus": 0,
                  "emailId": "neha.pawar@gep.com",
                  "proxyContactCode": -9223372036854775808,
                  "proxyEmailId": "",
                  "proxyContactName": null,
                  "designation": "Admin",
                  "clientContactCode": "SAPPC3_User",
                  "address": {
                     "addressCode": 2666755,
                     "addressline1": "PHCBT,",
                     "addressline2": "Caltex Philippines Inc. Batangas Terminal Danglayan St, San Pascual",
                     "addressline3": "",
                     "city": "Batangas City",
                     "zipCode": "",
                     "stateInfo": {
                        "stateCode": -9223372036854775808,
                        "stateName": "",
                        "countryId": 0,
                        "isActive": true,
                        "isDeleted": false,
                        "stateAbbrevationCode": "",
                        "stateOther": null,
                        "companyName": null,
                        "clientID": 0,
                        "pageIndex": 0,
                        "pageSize": 0,
                        "totalRecords": 0,
                        "sortBy": null,
                        "sortOrder": null,
                        "cultureCode": "en-US",
                        "createdOn": "0001-01-01T00:00:00",
                        "updatedOn": "0001-01-01T00:00:00",
                        "createdBy": 0,
                        "modifiedBy": 0,
                        "defaultCurrencyCode": null
                     },
                     "countryInfo": {
                        "countryId": 221,
                        "countryCode": "US",
                        "countryName": "United States",
                        "countryCultureInfo": "en-US",
                        "currencyCode": null,
                        "isActive": true,
                        "isDeleted": false,
                        "preferenceOrder": 1,
                        "isZipCodeMandatory": false,
                        "zipCodeFormat": null,
                        "isdCode": null,
                        "companyName": null,
                        "clientID": 0,
                        "pageIndex": 0,
                        "pageSize": 0,
                        "totalRecords": 0,
                        "sortBy": null,
                        "sortOrder": null,
                        "cultureCode": "en-US",
                        "createdOn": "0001-01-01T00:00:00",
                        "updatedOn": "0001-01-01T00:00:00",
                        "createdBy": 0,
                        "modifiedBy": 0,
                        "defaultCurrencyCode": null
                     },
                     "phoneNo1": "",
                     "extenstionNo1": "",
                     "phoneNo2": "",
                     "extenstionNo2": "",
                     "mobileNo": null,
                     "faxNo": "",
                     "geographyDetail": null,
                     "latitude": "",
                     "longitude": "",
                     "county": null,
                     "poBoxNumber": null,
                     "isdCode": null,
                     "companyName": null,
                     "clientID": 0,
                     "pageIndex": 0,
                     "pageSize": 0,
                     "totalRecords": 0,
                     "sortBy": null,
                     "sortOrder": null,
                     "cultureCode": "en-US",
                     "createdOn": "0001-01-01T00:00:00",
                     "updatedOn": "0001-01-01T00:00:00",
                     "createdBy": 0,
                     "modifiedBy": 0,
                     "defaultCurrencyCode": null
                  },
                  "clientPartnerCode": "",
                  "partnerTypeId": -2147483648,
                  "partnerTypeName": "",
                  "partnerStatusCode": 0,
                  "sequenceId": -2147483648,
                  "doingBusinessAs": null,
                  "groupSequenceId": 0,
                  "documentAddressDetailsList": null,
                  "associatedDocumentCode": 0,
                  "acceptanceStatus": null,
                  "associatedDocumentNumber": null,
                  "externalDelegationDetails": null
               },
               {
                  "documentStakeholderId": 81577,
                  "documentCode": 0,
                  "partnerCode": 70021704,
                  "contactCode": 7002170404000001,
                  "stakeholderTypeInfo": 7,
                  "isDeleted": false,
                  "partnerName": "Chevron",
                  "contactName": "CVX Admin Coordinator's",
                  "firstName": null,
                  "lastName": null,
                  "stakeholderDocumentStatus": 0,
                  "emailId": "neha.pawar@gep.com",
                  "proxyContactCode": 0,
                  "proxyEmailId": "",
                  "proxyContactName": null,
                  "designation": "Admin",
                  "clientContactCode": "SAPPC3_User",
                  "address": {
                     "addressCode": 2666755,
                     "addressline1": "PHCBT,",
                     "addressline2": "Caltex Philippines Inc. Batangas Terminal Danglayan St, San Pascual",
                     "addressline3": "",
                     "city": "Batangas City",
                     "zipCode": "",
                     "stateInfo": {
                        "stateCode": -9223372036854775808,
                        "stateName": "",
                        "countryId": 0,
                        "isActive": true,
                        "isDeleted": false,
                        "stateAbbrevationCode": "",
                        "stateOther": null,
                        "companyName": null,
                        "clientID": 0,
                        "pageIndex": 0,
                        "pageSize": 0,
                        "totalRecords": 0,
                        "sortBy": null,
                        "sortOrder": null,
                        "cultureCode": "en-US",
                        "createdOn": "0001-01-01T00:00:00",
                        "updatedOn": "0001-01-01T00:00:00",
                        "createdBy": 0,
                        "modifiedBy": 0,
                        "defaultCurrencyCode": null
                     },
                     "countryInfo": {
                        "countryId": 221,
                        "countryCode": "US",
                        "countryName": "United States",
                        "countryCultureInfo": "en-US",
                        "currencyCode": null,
                        "isActive": true,
                        "isDeleted": false,
                        "preferenceOrder": 1,
                        "isZipCodeMandatory": false,
                        "zipCodeFormat": null,
                        "isdCode": null,
                        "companyName": null,
                        "clientID": 0,
                        "pageIndex": 0,
                        "pageSize": 0,
                        "totalRecords": 0,
                        "sortBy": null,
                        "sortOrder": null,
                        "cultureCode": "en-US",
                        "createdOn": "0001-01-01T00:00:00",
                        "updatedOn": "0001-01-01T00:00:00",
                        "createdBy": 0,
                        "modifiedBy": 0,
                        "defaultCurrencyCode": null
                     },
                     "phoneNo1": "",
                     "extenstionNo1": "",
                     "phoneNo2": "",
                     "extenstionNo2": "",
                     "mobileNo": null,
                     "faxNo": "",
                     "geographyDetail": null,
                     "latitude": "",
                     "longitude": "",
                     "county": null,
                     "poBoxNumber": null,
                     "isdCode": null,
                     "companyName": null,
                     "clientID": 0,
                     "pageIndex": 0,
                     "pageSize": 0,
                     "totalRecords": 0,
                     "sortBy": null,
                     "sortOrder": null,
                     "cultureCode": "en-US",
                     "createdOn": "0001-01-01T00:00:00",
                     "updatedOn": "0001-01-01T00:00:00",
                     "createdBy": 0,
                     "modifiedBy": 0,
                     "defaultCurrencyCode": null
                  },
                  "clientPartnerCode": "",
                  "partnerTypeId": 0,
                  "partnerTypeName": "Partner",
                  "partnerStatusCode": 0,
                  "sequenceId": 1,
                  "doingBusinessAs": null,
                  "groupSequenceId": 0,
                  "documentAddressDetailsList": null,
                  "associatedDocumentCode": 0,
                  "acceptanceStatus": null,
                  "associatedDocumentNumber": null,
                  "externalDelegationDetails": null
               },
               {
                  "documentStakeholderId": 81576,
                  "documentCode": 0,
                  "partnerCode": 70021704,
                  "contactCode": 7002170404000001,
                  "stakeholderTypeInfo": 105,
                  "isDeleted": false,
                  "partnerName": "Chevron",
                  "contactName": "CVX Admin Coordinator's",
                  "firstName": null,
                  "lastName": null,
                  "stakeholderDocumentStatus": 0,
                  "emailId": "neha.pawar@gep.com",
                  "proxyContactCode": 0,
                  "proxyEmailId": "",
                  "proxyContactName": null,
                  "designation": "Admin",
                  "clientContactCode": "SAPPC3_User",
                  "address": {
                     "addressCode": 2666755,
                     "addressline1": "PHCBT,",
                     "addressline2": "Caltex Philippines Inc. Batangas Terminal Danglayan St, San Pascual",
                     "addressline3": "",
                     "city": "Batangas City",
                     "zipCode": "",
                     "stateInfo": {
                        "stateCode": -9223372036854775808,
                        "stateName": "",
                        "countryId": 0,
                        "isActive": true,
                        "isDeleted": false,
                        "stateAbbrevationCode": "",
                        "stateOther": null,
                        "companyName": null,
                        "clientID": 0,
                        "pageIndex": 0,
                        "pageSize": 0,
                        "totalRecords": 0,
                        "sortBy": null,
                        "sortOrder": null,
                        "cultureCode": "en-US",
                        "createdOn": "0001-01-01T00:00:00",
                        "updatedOn": "0001-01-01T00:00:00",
                        "createdBy": 0,
                        "modifiedBy": 0,
                        "defaultCurrencyCode": null
                     },
                     "countryInfo": {
                        "countryId": 221,
                        "countryCode": "US",
                        "countryName": "United States",
                        "countryCultureInfo": "en-US",
                        "currencyCode": null,
                        "isActive": true,
                        "isDeleted": false,
                        "preferenceOrder": 1,
                        "isZipCodeMandatory": false,
                        "zipCodeFormat": null,
                        "isdCode": null,
                        "companyName": null,
                        "clientID": 0,
                        "pageIndex": 0,
                        "pageSize": 0,
                        "totalRecords": 0,
                        "sortBy": null,
                        "sortOrder": null,
                        "cultureCode": "en-US",
                        "createdOn": "0001-01-01T00:00:00",
                        "updatedOn": "0001-01-01T00:00:00",
                        "createdBy": 0,
                        "modifiedBy": 0,
                        "defaultCurrencyCode": null
                     },
                     "phoneNo1": "",
                     "extenstionNo1": "",
                     "phoneNo2": "",
                     "extenstionNo2": "",
                     "mobileNo": null,
                     "faxNo": "",
                     "geographyDetail": null,
                     "latitude": "",
                     "longitude": "",
                     "county": null,
                     "poBoxNumber": null,
                     "isdCode": null,
                     "companyName": null,
                     "clientID": 0,
                     "pageIndex": 0,
                     "pageSize": 0,
                     "totalRecords": 0,
                     "sortBy": null,
                     "sortOrder": null,
                     "cultureCode": "en-US",
                     "createdOn": "0001-01-01T00:00:00",
                     "updatedOn": "0001-01-01T00:00:00",
                     "createdBy": 0,
                     "modifiedBy": 0,
                     "defaultCurrencyCode": null
                  },
                  "clientPartnerCode": "",
                  "partnerTypeId": 0,
                  "partnerTypeName": "Partner",
                  "partnerStatusCode": 0,
                  "sequenceId": 1,
                  "doingBusinessAs": null,
                  "groupSequenceId": 0,
                  "documentAddressDetailsList": null,
                  "associatedDocumentCode": 0,
                  "acceptanceStatus": null,
                  "associatedDocumentNumber": null,
                  "externalDelegationDetails": null
               }
            ],
            "documentAdditionalFieldList": [],
            "documentLinkInfoList": [],
            "supplierDocumentLinkInfoList": null,
            "isTemplate": false,
            "isConfidential": false,
            "isSingleNode": false,
            "isDocumentDetails": false,
            "isStakeholderDetails": false,
            "isBUTree": false,
            "isAddtionalDetails": false,
            "searchKey": null,
            "allowDuplicateDocumentName": true,
            "gpnPasInCSV": null,
            "linkedDocumentCode": 0,
            "linkedDocumentTypeCode": 0,
            "generateDocumentName": false,
            "documentSourceTypeInfo": 0,
            "sourceType": 0,
            "interfaceDocumentStatus": 0,
            "entityId": 0,
            "entityDetailCode": null,
            "documentLOBDetails": null,
            "acEntityId": 0,
            "sourceSystemInfo": null,
            "selectedPasCode": null,
            "selectedRegionCode": null,
            "isFilterByBU": true,
            "isLinkInfoDetails": false,
            "aceEntityDetailCode": 0,
            "isDocumentNumberUpdatable": false,
            "existingDocumentNumber": null,
            "documentRelationID": 4,
            "id": 0,
            "attachment": null,
            "supplierContact": 0,
            "companyName": null,
            "clientID": 0,
            "pageIndex": 0,
            "pageSize": 0,
            "totalRecords": 0,
            "sortBy": null,
            "sortOrder": null,
            "cultureCode": "en-US",
            "createdOn": "2019-10-01T10:06:02.02",
            "updatedOn": "0001-01-01T00:00:00",
            "createdBy": 7002170404000001,
            "modifiedBy": 0,
            "defaultCurrencyCode": null
         },
         "contractAdditionalDetails": {
            "expiryNoticeValue": 0,
            "expiryNoticeType": 0,
            "isUploaded": false,
            "revisionNumber": 0,
            "closedDate": null,
            "amendmentType": 0,
            "isInternalAmendment": false,
            "erpNumber": "",
            "isAmendmentActive": false,
            "documentCode": 0,
            "parentContractCode": -9223372036854775808,
            "parentContractNumber": null,
            "renewalTermType": 0
         },
         "contractLineItemList": [
            {
               "utilizedQuantityValue": 0,
               "utilizedLineValue": 0,
               "validationMessage": null,
               "issueUOMDetails": null,
               "compositeTaxAuthority": null,
               "groupLineItemNo": 0,
               "volume": 0,
               "discountedAmount": 0
            }
         ],
         "additionalInformationTabList": [],
         "lstOrgEntity": [
            {
               "entityCode": "0061",
               "entityType": "Company code"
            },
            {
               "entityCode": "1003",
               "entityType": "Plant"
            }
         ],
         "lstEntityDetails": [
            {
               "entityId": 3,
               "entityCode": "1003",
               "entityType": "Plant",
               "entityDisplayName": "EUREKA CA TRM CHEVRON:1003",
               "lob": "PC2_Tax"
            },
            {
               "entityId": 9,
               "entityCode": "Pascagoula",
               "entityType": "Business Unit",
               "entityDisplayName": "Manufacturing - Pascagoula",
               "lob": "PC2_Tax"
            }
         ]
      }
   ],
   "totalCount": 1
}

Error Scenario – Request

Request has a missing value of the Authorization Header which is mandatory: (401 – Unauthorized)

Error Scenario - Response

Access to interface BulkAPI is denied, Authorization Header is missing.
 

Data Elements
 

Data

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1

ContractDetails

 

List of ContractDetails object

Details of contract

 

1.2

ContractLineItemList

 

List of ContractLineItem object

List of contract line items

 

1.3

AdditionalInformationTabList

 

List of AdditionalInformationTab object

List of additional information

 

 

 

ContractDetails

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1.1

DocumentStakeHolderList

 

List of DocumentStakeHolder object

List of document stakeholder

 

1.1.2

IsConfidential

 

Boolean

Is confidential

 

1.1.3

InterfaceDocumentStatus

 

String

Status of interface document

 

1.1.4

CreatedOn

 

datetime

Created on

 

1.1.5

ContractDescription

 

String

Contract Description

 

1.1.6

ParentContractTitle

 

String

Parent Contract Title

 

1.1.7

DocumentBuList

 

List of DocumentBuList object

Document Bu List

 

1.1.8

ParentContractNumber

 

String

Parent Contract Number

 

1.1.9

RenewalTermType

 

String

Renewal Term Type

 

1.1.10

RenewalFrequency

 

Int

Renewal Frequency

 

1.1.11

TerminationTypeDescription

 

String

Termination Type Description

 

1.1.12

TerminationTerm

 

Int

Termination Term

 

1.1.13

TerminationTermType

 

Int

Termination Term Type

 

1.1.14

PenaltyAmount

 

Decimal

Penalty Amount

 

1.1.15

RenewalTerm

 

Int

Renewal Term

 

1.1.16

ErpNumber

 

String

Erp Number

 

1.1.17

DocumentRegionList

 

List of InterfaceDocumentRegion object

Document Region List

 

1.1.18

DocumentStatusInfo

 

String

Document Status Info

 

1.1.19

ContractTypeDescription

 

String

Contract Type Description

 

1.1.20

ContractDocumentTypeDescription

 

String

Contract Document Type Description

 

1.1.21

DateEffective

 

Datetime

Date Effective

 

1.1.22

 

DateExecuted

 

Datetime

Date Executed

 

1.1.23

ExpiryDateType

 

String

Expiry Date Type

 

1.1.24

ContractValue

 

Decimal

Contract Value

 

1.1.25

DocumentPasList

 

List of InterfaceDocumentPas object

Document Pas List

 

1.1.26

ContractCurrency

 

String

Contract Currency

 

1.1.27

Url

 

String

 

 

1.1.28

PaymentTermDetails

 

List of InterfacePaymentTermDetails object

PaymentTermDetails

 

1.1.29

ContractTerminationDate

 

String

Termination Date of Contract

 

1.1.30

LastApprover

 

String

Last Approver

 

1.1.31

DocumentName

 

String

Document Name

 

1.1.32

DocumentNumber

 

String

Document Number

 

1.1.33

LegalCompanys

 

List of LegalCompanys object

Legal Company's

 

1.1.34

EntityDetails

 

List of EntityDetail object

Entity Details

 
 

DocumentStakeHolderList

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1.1.1

PartnerName

 

String

Name of Partner

 

1.1.1.2

ContactName

 

String

Name of contact

 

1.1.1.3

EmailId

 

String

Email id

 

1.1.1.4

ClientContactCode

 

String

Client Contact Code

 

1.1.1.5

Address

 

List of InterfaceContractAddress object

Address

 

1.1.1.6

ClientPartnerCode

 

String

Client Partner Code

 

1.1.1.7

PartnerTypeName

 

String

Partner Type Name

 

1.1.1.8

DocumentAddressDetailsList

 

List of InterfaceDocumentAddressDetails object

Document Address Details List

 
 

Address

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1.5.1

AddressCode

 

Long

Address Code

 

1.1.5.2

Addressline1

 

String

Address line 1

 

1.1.5.3

Addressline2

 

String

Address line 2

 

1.1.5.4

Addressline3

 

String

Address line 3

 

1.1.5.5

City

 

String

City

 

1.1.5.6

ZipCode

 

String

Zip code

 

1.1.5.7

StateInfo

 

StateInfo

State info

 

1.1.5.8

CountryInfo

 

CountryInfo

Country info

 

1.1.5.9

PhoneNo1

 

String

Phone no 1

 

1.1.5.10

PhoneNo2

 

String

Phone no 2

 
 

StateInfo

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1.5.7.1

StateAbbrevationCode

 

String

State Abbreviation Code

 
 

CountryInfo

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1.5.8.1

CountryCode

 

String

Country Code

 

1.1.5.8.2

CountryName

 

String

Country Name

 
 

DocumentAddressDetails

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1.8.1

ClientLocationCode

 

String

Client Location Code

 
 

DocumentBuList

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1.7.1

    BusinessUnitCode

 

String

Business Unit Code

 

1.1.7.2

    BusinessUnitName

 

String

Business Unit Name

 
 

DocumentRegionList

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1.17.1

    RegionCode

 

Long

Region Code

 

1.1.17.2

    RegionName

 

String

Region Name

 

1.1.17.3 

     IsSelected

 

Boolean

Is Selected

 

1.1.17.4

    IsSingleNode

 

Boolean

Is Single Node

 
 

DocumentPasList

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1.25.1

    PasName

 

String

Pas Name

 

1.1.25.2

    ClientPASCode

 

String

Client PAS Code

 
 

PaymentTermDetails

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1.28.1

NoOfDays

 

Int

No Of Days

 

1.1.28.2

Discount

 

Decimal

Discount

 

1.1.28.3

DiscountDays

 

Int

Discount Days

 

1.1.28.4

PaymentTermCode

 

String

Payment Term Code

 
 

  LegalCompanys

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1.33.1

    LegalCompanyName

 

String

Legal Company Name

 

1.1.33.2

    PartnerTypeName

 

String

Partner Type Name

 

 

 

EntityDetails

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1.34.1

EntityCode

 

String

 

 

1.1.34.2

EntityType

 

String

 

 

1.1.34.3

Lob

 

String

 

 
 

ContractLineItemList

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.2.1

IsTaxExempt

 

String

 

 

1.2.2

ClientPasCode

 

String

 

 

1.2.3

CatalogName

 

String

 

 

1.2.4

Gtin

 

String

 

 

1.2.5

ManufacturerItemNumber

 

String

 

 

1.2.6

PartnerItemNumber

 

String

 

 

1.2.7

ManufacturerName

 

String

 

 

1.2.8

ItemAbbrevationCode

 

String

 

 

1.2.9

ItemType

 

String

 

 

1.2.10

UnspscId

 

Long

 

 

1.2.11

LineItemNo

 

Long

 

 

1.2.12

Quantity

 

Decimal

 

 

1.2.13

TaxAmount

 

Decimal

 

 

1.2.14

UnitPrice

 

Decimal

 

 

1.2.15

UomCode

 

String

 

 

1.2.16

PasCode

 

Long

 

 

1.2.17

ItemDescription

 

String

 

 

1.2.18

ItemName

 

String

 

 

1.2.19

ItemCode

 

Long

 

 

1.2.20

ItemId

 

Long

 

 

1.2.21

EndDate

 

DateTime

 

 

1.2.22

StartDate

 

DateTime

 

 

1.2.23

TotalPrice

 

Decimal

 

 

1.2.24

LineItemStatus

 

String

 

 

 

 

AdditionalInformationTabList

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.3.1

    TabName

 

String

 

 

1.3.2

AdditionalInformationSectionList

 

List of AdditionalInformationSection object

 

 

 

 

AdditionalInformationSectionList

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.3.2.1

SectionName

 

String

 

 

1.3.2.2

AdditionalInformationQuestionList

 

List of AdditionalInformationQuestions object

 

 

 

 

AdditionalInformationQuestionsList

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.3.2.2.1

QuestionText

 

String

 

 

1.3.2.2.2

QuestionsResponseList

 

List of AdditionalInformationQuestionsResponse object

 

 
 

QuestionsResponseList

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.3.2.2.2.1

IsChildQuestionPresent

 

Boolean

 

 

1.3.2.2.2.2

ChildQuestionList

 

List of AdditionalInformationQuestions object