Contracts

Contract Service APIs

APIs to manage the functionalities of a Works contract.

post

Body

Responses

202

Accepted create contract request.

*/*

400

Invalid input.

*/*

post

HTTPcURLJavaScriptPython

POST /contract/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 942

{
  "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"
    ]
  }
}

{
  "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": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "estimateId": "text",
          "estimateLineItemId": "text",
          "tenantId": "pb.amritsar",
          "unitRate": 1,
          "noOfunit": 1,
          "amountBreakups": [
            {
              "id": "251c51eb-e970-4e01-a99a-70136c47a934",
              "estimateAmountBreakupId": "251c51eb-e970-4e01-a99a-70136c47a934",
              "status": "ACTIVE",
              "amount": 1,
              "additionalDetails": {}
            }
          ],
          "status": "ACTIVE",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "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"
    }
  }
}

post

Body

Responses

202

Accepted create contract request.

*/*

400

Invalid input.

*/*

post

HTTPcURLJavaScriptPython

POST /contract/v1/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 942

{
  "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"
    ]
  }
}

{
  "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": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "estimateId": "text",
          "estimateLineItemId": "text",
          "tenantId": "pb.amritsar",
          "unitRate": 1,
          "noOfunit": 1,
          "amountBreakups": [
            {
              "id": "251c51eb-e970-4e01-a99a-70136c47a934",
              "estimateAmountBreakupId": "251c51eb-e970-4e01-a99a-70136c47a934",
              "status": "ACTIVE",
              "amount": 1,
              "additionalDetails": {}
            }
          ],
          "status": "ACTIVE",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "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"
    }
  }
}

post

Body

The object will contain all the search parameters for contract service.

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

200

Successful response sorted by reverse chrnological order of creation

*/*

400

Bad Request.

*/*

post

HTTPcURLJavaScriptPython

POST /contract/v1/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "tenantId": "pb.amritsar",
  "ids": [
    "text"
  ],
  "estimateIds": [
    "text"
  ],
  "estimateLineItemIds": [
    "text"
  ]
}

{
  "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": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "estimateId": "text",
          "estimateLineItemId": "text",
          "tenantId": "pb.amritsar",
          "unitRate": 1,
          "noOfunit": 1,
          "amountBreakups": [
            {
              "id": "251c51eb-e970-4e01-a99a-70136c47a934",
              "estimateAmountBreakupId": "251c51eb-e970-4e01-a99a-70136c47a934",
              "status": "ACTIVE",
              "amount": 1,
              "additionalDetails": {}
            }
          ],
          "status": "ACTIVE",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "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"
    }
  }
}