Contracts

Contract Service APIs

APIs to manage the functionalities of a Works contract.

PreviousCampaign Delivery NextEstimates

Last updated 1 year ago

Was this helpful?

post

/contract/v1/_create

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

contractobject

Contract details

workflowobject

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/contract/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"contract":{"id":"32e33343-7b4c-4353-9abf-4de8f5bcd764","contractNumber":"CON/2023-24/001","tenantId":"pb.amritsar","auditDetails":{},"additionalDetails":{},"status":"ACTIVE","executingAuthority":"DEPARTMENT","contractType":"WORK_ORDER","lineItems":[{"estimateId":"text","tenantId":"pb.amritsar","auditDetails":{},"additionalDetails":{},"status":"ACTIVE","amountBreakups":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","estimateAmountBreakupId":"251c51eb-e970-4e01-a99a-70136c47a934","amount":1,"additionalDetails":{},"status":"ACTIVE"}]}],"documents":[{"additionalDetails":{}}]},"workflow":{"action":"text","assignees":[null]}}'

202

400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "pagination": {
    "limit": 10,
    "offSet": 0,
    "totalCount": 1,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  },
  "contracts": [
    {
      "id": "32e33343-7b4c-4353-9abf-4de8f5bcd764",
      "contractNumber": "CON/2023-24/001",
      "supplementaryNumber": "text",
      "tenantId": "pb.amritsar",
      "wfStatus": "text",
      "totalContractedamount": 1,
      "securityDeposit": 1,
      "agreementDate": 1,
      "defectLiabilityPeriod": 1,
      "orgId": "text",
      "startDate": 1,
      "endDate": 1,
      "auditDetails": {},
      "additionalDetails": {},
      "status": "ACTIVE",
      "executingAuthority": "DEPARTMENT",
      "contractType": "WORK_ORDER",
      "lineItems": [
        {
          "estimateId": "text",
          "tenantId": "pb.amritsar",
          "auditDetails": {},
          "additionalDetails": {},
          "status": "ACTIVE",
          "amountBreakups": [
            {
              "id": "251c51eb-e970-4e01-a99a-70136c47a934",
              "estimateAmountBreakupId": "251c51eb-e970-4e01-a99a-70136c47a934",
              "amount": 1,
              "additionalDetails": {},
              "status": "ACTIVE"
            }
          ]
        }
      ],
      "documents": [
        {
          "additionalDetails": {}
        }
      ]
    }
  ]
}

Accepted create contract request.

post

/contract/v1/_update

Body

requestInfoobject

contractobject

Contract details

workflowobject

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/contract/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"contract":{"id":"32e33343-7b4c-4353-9abf-4de8f5bcd764","contractNumber":"CON/2023-24/001","tenantId":"pb.amritsar","auditDetails":{},"additionalDetails":{},"status":"ACTIVE","executingAuthority":"DEPARTMENT","contractType":"WORK_ORDER","lineItems":[{"estimateId":"text","tenantId":"pb.amritsar","auditDetails":{},"additionalDetails":{},"status":"ACTIVE","amountBreakups":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","estimateAmountBreakupId":"251c51eb-e970-4e01-a99a-70136c47a934","amount":1,"additionalDetails":{},"status":"ACTIVE"}]}],"documents":[{"additionalDetails":{}}]},"workflow":{"action":"text","assignees":[null]}}'

202

400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "pagination": {
    "limit": 10,
    "offSet": 0,
    "totalCount": 1,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  },
  "contracts": [
    {
      "id": "32e33343-7b4c-4353-9abf-4de8f5bcd764",
      "contractNumber": "CON/2023-24/001",
      "supplementaryNumber": "text",
      "tenantId": "pb.amritsar",
      "wfStatus": "text",
      "totalContractedamount": 1,
      "securityDeposit": 1,
      "agreementDate": 1,
      "defectLiabilityPeriod": 1,
      "orgId": "text",
      "startDate": 1,
      "endDate": 1,
      "auditDetails": {},
      "additionalDetails": {},
      "status": "ACTIVE",
      "executingAuthority": "DEPARTMENT",
      "contractType": "WORK_ORDER",
      "lineItems": [
        {
          "estimateId": "text",
          "tenantId": "pb.amritsar",
          "auditDetails": {},
          "additionalDetails": {},
          "status": "ACTIVE",
          "amountBreakups": [
            {
              "id": "251c51eb-e970-4e01-a99a-70136c47a934",
              "estimateAmountBreakupId": "251c51eb-e970-4e01-a99a-70136c47a934",
              "amount": 1,
              "additionalDetails": {},
              "status": "ACTIVE"
            }
          ]
        }
      ],
      "documents": [
        {
          "additionalDetails": {}
        }
      ]
    }
  ]
}

Accepted create contract request.

post

/contract/v1/_search

Body

tenantIdstring · min: 2 · max: 64required

Tenant Identifier

Example: pb.amritsar

idsstring[]

Search by contract ids

estimateIdsstring[]

Search by estimate ids

estimateLineItemIdsstring[]

Search by estimate line items ids

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/contract/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{"tenantId":"pb.amritsar","ids":[null],"estimateIds":[null],"estimateLineItemIds":[null]}'

200

400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "pagination": {
    "limit": 10,
    "offSet": 0,
    "totalCount": 1,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  },
  "contracts": [
    {
      "id": "32e33343-7b4c-4353-9abf-4de8f5bcd764",
      "contractNumber": "CON/2023-24/001",
      "supplementaryNumber": "text",
      "tenantId": "pb.amritsar",
      "wfStatus": "text",
      "totalContractedamount": 1,
      "securityDeposit": 1,
      "agreementDate": 1,
      "defectLiabilityPeriod": 1,
      "orgId": "text",
      "startDate": 1,
      "endDate": 1,
      "auditDetails": {},
      "additionalDetails": {},
      "status": "ACTIVE",
      "executingAuthority": "DEPARTMENT",
      "contractType": "WORK_ORDER",
      "lineItems": [
        {
          "estimateId": "text",
          "tenantId": "pb.amritsar",
          "auditDetails": {},
          "additionalDetails": {},
          "status": "ACTIVE",
          "amountBreakups": [
            {
              "id": "251c51eb-e970-4e01-a99a-70136c47a934",
              "estimateAmountBreakupId": "251c51eb-e970-4e01-a99a-70136c47a934",
              "amount": 1,
              "additionalDetails": {},
              "status": "ACTIVE"
            }
          ]
        }
      ],
      "documents": [
        {
          "additionalDetails": {}
        }
      ]
    }
  ]
}

Successful response sorted by reverse chrnological order of creation