Contracts

Contract Service APIs

APIs to manage the functionalities of a Works contract.

POST/contract/v1/_create

Body

application/json

contractContract (object)

Contract details

workflowWorkflow (object)

Response

202400

Accepted create contract request.

Body

*/*

contractsarray of Contract (object)

paginationPagination (object)

Pagination details

Request

JavaScriptCurlPython

const response = await fetch('/contract/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202400

{
  "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": 0,
      "securityDeposit": 0,
      "agreementDate": 0,
      "defectLiabilityPeriod": 0,
      "orgId": "text",
      "startDate": 0,
      "endDate": 0,
      "lineItems": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "estimateId": "text",
          "estimateLineItemId": "text",
          "tenantId": "pb.amritsar",
          "unitRate": 0,
          "noOfunit": 0,
          "amountBreakups": [
            {
              "id": "251c51eb-e970-4e01-a99a-70136c47a934",
              "estimateAmountBreakupId": "251c51eb-e970-4e01-a99a-70136c47a934",
              "status": "ACTIVE",
              "amount": 0
            }
          ],
          "status": "ACTIVE",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 0,
            "lastModifiedTime": 0
          }
        }
      ],
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 0,
        "lastModifiedTime": 0
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offSet": 0,
    "totalCount": 0,
    "sortBy": "text",
    "order": {}
  }
}

POST/contract/v1/_update

Body

application/json

contractContract (object)

Contract details

workflowWorkflow (object)

Response

202400

Accepted create contract request.

Body

*/*

contractsarray of Contract (object)

paginationPagination (object)

Pagination details

Request

JavaScriptCurlPython

const response = await fetch('/contract/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202400

{
  "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": 0,
      "securityDeposit": 0,
      "agreementDate": 0,
      "defectLiabilityPeriod": 0,
      "orgId": "text",
      "startDate": 0,
      "endDate": 0,
      "lineItems": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "estimateId": "text",
          "estimateLineItemId": "text",
          "tenantId": "pb.amritsar",
          "unitRate": 0,
          "noOfunit": 0,
          "amountBreakups": [
            {
              "id": "251c51eb-e970-4e01-a99a-70136c47a934",
              "estimateAmountBreakupId": "251c51eb-e970-4e01-a99a-70136c47a934",
              "status": "ACTIVE",
              "amount": 0
            }
          ],
          "status": "ACTIVE",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 0,
            "lastModifiedTime": 0
          }
        }
      ],
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 0,
        "lastModifiedTime": 0
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offSet": 0,
    "totalCount": 0,
    "sortBy": "text",
    "order": {}
  }
}

POST/contract/v1/_search

Body

application/json

tenantId*string

Tenant Identifier

Example: "pb.amritsar"

idsarray of string

Search by contract ids

estimateIdsarray of string

Search by estimate ids

estimateLineItemIdsarray of string

Search by estimate line items ids

Response

200400

Successful response sorted by reverse chrnological order of creation

Body

*/*

contractsarray of Contract (object)

paginationPagination (object)

Pagination details

Request

JavaScriptCurlPython

const response = await fetch('/contract/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tenantId": "pb.amritsar"
    }),
});
const data = await response.json();

Response

200400

{
  "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": 0,
      "securityDeposit": 0,
      "agreementDate": 0,
      "defectLiabilityPeriod": 0,
      "orgId": "text",
      "startDate": 0,
      "endDate": 0,
      "lineItems": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "estimateId": "text",
          "estimateLineItemId": "text",
          "tenantId": "pb.amritsar",
          "unitRate": 0,
          "noOfunit": 0,
          "amountBreakups": [
            {
              "id": "251c51eb-e970-4e01-a99a-70136c47a934",
              "estimateAmountBreakupId": "251c51eb-e970-4e01-a99a-70136c47a934",
              "status": "ACTIVE",
              "amount": 0
            }
          ],
          "status": "ACTIVE",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 0,
            "lastModifiedTime": 0
          }
        }
      ],
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 0,
        "lastModifiedTime": 0
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offSet": 0,
    "totalCount": 0,
    "sortBy": "text",
    "order": {}
  }
}