Contracts

Contract Service APIs

APIs to manage the functionalities of a Works contract.

post

Body

requestInfoobjectoptional

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.

contractobjectoptional

Contract details

workflowobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/contract/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "contract": {
      "supplementaryNumber": "text",
      "tenantId": "pb.amritsar",
      "status": "ACTIVE",
      "wfStatus": "text",
      "executingAuthority": "DEPARTMENT",
      "contractType": "WORK_ORDER",
      "totalContractedamount": 1,
      "securityDeposit": 1,
      "agreementDate": 1,
      "defectLiabilityPeriod": 1,
      "orgId": "text",
      "startDate": 1,
      "endDate": 1,
      "lineItems": [
        {
          "estimateId": "text",
          "estimateLineItemId": "text",
          "tenantId": "pb.amritsar",
          "unitRate": 1,
          "noOfunit": 1,
          "amountBreakups": [
            {
              "estimateAmountBreakupId": "251c51eb-e970-4e01-a99a-70136c47a934",
              "status": "ACTIVE",
              "amount": 1,
              "additionalDetails": {}
            }
          ],
          "status": "ACTIVE",
          "additionalDetails": {}
        }
      ],
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "additionalDetails": {}
    },
    "workflow": {
      "action": "text",
      "comment": "text",
      "assignees": [
        "text"
      ]
    }
  }'

202

400

202

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

Accepted create contract request.

post

Body

requestInfoobjectoptional

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.

contractobjectoptional

Contract details

workflowobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/contract/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "contract": {
      "supplementaryNumber": "text",
      "tenantId": "pb.amritsar",
      "status": "ACTIVE",
      "wfStatus": "text",
      "executingAuthority": "DEPARTMENT",
      "contractType": "WORK_ORDER",
      "totalContractedamount": 1,
      "securityDeposit": 1,
      "agreementDate": 1,
      "defectLiabilityPeriod": 1,
      "orgId": "text",
      "startDate": 1,
      "endDate": 1,
      "lineItems": [
        {
          "estimateId": "text",
          "estimateLineItemId": "text",
          "tenantId": "pb.amritsar",
          "unitRate": 1,
          "noOfunit": 1,
          "amountBreakups": [
            {
              "estimateAmountBreakupId": "251c51eb-e970-4e01-a99a-70136c47a934",
              "status": "ACTIVE",
              "amount": 1,
              "additionalDetails": {}
            }
          ],
          "status": "ACTIVE",
          "additionalDetails": {}
        }
      ],
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "additionalDetails": {}
    },
    "workflow": {
      "action": "text",
      "comment": "text",
      "assignees": [
        "text"
      ]
    }
  }'

202

400

202

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

Accepted create contract request.

post

Body

tenantIdstring · min: 2 · max: 64required

Tenant Identifier

Example: pb.amritsar

idsstring[]optional

Search by contract ids

estimateIdsstring[]optional

Search by estimate ids

estimateLineItemIdsstring[]optional

Search by estimate line items ids

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

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

200

400

200

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

Successful response sorted by reverse chrnological order of creation