Get Schedule Data by Contract Display ID¶

ID: UC-NFS-CNTRCT-D001
Complexity: Medium
Description: This use case describes how to retrieve schedule period data starting from a Contract Display ID, navigating through Lease Components, Activation Groups, and Units to find the correct Lease Measurement ID.
Scenario: A financial analyst needs to retrieve specific schedule period data for a contract but only has the Contract Display ID.
Business Value: Enables precise data retrieval for consolidated financial reporting and auditing purposes.

Prerequisites¶

Valid Contract Display ID is known.
API User has permissions to view contract and financial data.

Steps¶

1. Contract Search¶

Search for the contract using the Display ID to get the internal Contract ID.

Endpoint: POST /api/v1/contracts/search

HTTP Request

curl -X POST "{{base_url}}/api/v1/contracts/search" 
-H "Content-Type: application/json" 
-d '{
  "contractDisplayIdIn": [
    "CT-88888996"
  ]
}'

Expected Response: 200 OK with Contract object(s).

Notes: You can get contract data from the Contract search

2. Lease Component Search¶

Search for lease components associated with the Contract Display ID.

Endpoint: POST /api/v1/lease-components/search

HTTP Request

curl -X POST "{{base_url}}/api/v1/lease-components/search" 
-H "Content-Type: application/json" 
-d '{
  "contractDisplayIdIn": [
    "CT-100007957"
  ]
}'

Expected Response: 200 OK with list of Lease Components.

Notes: Multiple lease components may exist per contract.

3. Activation Group Search¶

Search for activation groups associated with the Lease Component Display ID to get the latest revision.

Endpoint: POST /api/v1/activation-groups/search

HTTP Request

curl -X POST "{{base_url}}/api/v1/activation-groups/search" 
-H "Content-Type: application/json" 
-d '{
  "leaseComponentDisplayIdIn": [
    "LC-100010009"
  ]
}'

Expected Response: 200 OK with Activation Group data, including latest revision ID.

Notes: Revision data is included in the response. Use the latest revision ID for financial data in later steps.

4. Unit Search¶

Search for units associated with the Activation Group Display ID.

Endpoint: POST /api/v1/units/search

HTTP Request

curl -X POST "{{base_url}}/api/v1/units/search" 
-H "Content-Type: application/json" 
-d '{
  "activationGroupDisplayIdIn": [
    "AG-100003627"
  ]
}'

Expected Response: 200 OK with list of Units.

Notes: Identify the specific unit for which schedule data is required.

5. Get Lease Measurement ID via Schedule View¶

Retrieve the schedule view list for the Activation Group and Revision to find the Lease Measurement ID.

Endpoint: GET /api/v2/schedules-views/list/{activationGroupId}/{activationGroupRevisionId}/{unitId}

HTTP Request

curl -X GET "{{base_url}}/api/v2/schedules-views/list/{{activationGroupId}}/{{latestRevisionId}}/{{unitId}}"

Expected Response: 200 OK with List containing leaseMeasurementId.

Notes: This endpoint provides the necessary leaseMeasurementId for the final step.

6. Get Schedule Periods¶

Retrieve all schedule periods using the Lease Measurement ID.

Endpoint: GET /api/v1/schedules/{principalPositionType}/{leaseMeasurementId}/periods

HTTP Request

curl -X GET "{{base_url}}/api/v1/schedules/LESSEE/{{leaseMeasurementId}}/periods"

Expected Response: 200 OK with list of schedule periods.

Notes: Principal position type is typically ‘LESSEE’ for standard contracts.

Best Practices¶

Always use the latest revision ID for financial data consistency.