Get detailed period-by-period breakdown of support contingents

Retrieves a detailed period-by-period breakdown of all support contingents for a specific project.

What are Support Contingents? Support contingents are retainer plans that define allocated hours and pricing for support periods. They help manage support contracts with predefined hours, rates, and transferability of unused hours.

What is returned:

All support contingents for the project
For each contingent: period-by-period breakdown from start date until present day
Each period includes: start/end dates, allocated hours, hours from previous period (if transferable), consumed hours, and list of tasks
Tasks include: title, short number, hours billed, invoice number (if billed), and unbilled flag (if in progress)
Current period includes unbilled tasks with their spent hours
Periods are sorted newest first, active contingents appear before inactive ones
Tasks within each period are sorted with unbilled tasks first, then by short number

Note: Requires project access and Projects.canSeeSupportContingentDetails permission.

GET/projects/{id}/support-contingents-details

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Responses

200

Support contingents breakdown retrieved successfully

Array of SupportContingentWithBreakdownResponseDto

createdAtstringrequired

ISO 8601 timestamp when the contingent was created

frequencynumberrequired

Frequency in months for the contingent period

fromDatestringrequired

Start date of the contingent period (ISO 8601 date format)

hoursnumberrequired

Total hours allocated for the contingent period

idstringrequired

Unique identifier for the support contingent (UUID)

periodsSupportContingentPeriodDto[]required

Period-by-period breakdown of the contingent, from start until present day

Show properties

Array of SupportContingentPeriodDto

consumedHoursnumberrequired

Hours consumed in this period (from invoices)

hasNoEndDateboolean

Flag indicating if this period has no end date (for frequency=0 contingents with null toDate). When true, periodEnd represents the current date for display purposes, but the period is actually open-ended.

hoursnumberrequired

Hours allocated for this period

hoursFromPreviousnumberrequired

Hours transferred from previous period (only applicable for transferable contingents)

isCurrentPeriodbooleanrequired

Flag indicating if this is the current active period

periodEndstringrequired

End date of the period (ISO 8601 date format)

periodStartstringrequired

Start date of the period (ISO 8601 date format)

tasksSupportContingentPeriodTaskDto[]required

List of tasks billed or unbilled in this period

Show properties

Array of SupportContingentPeriodTaskDto

hoursBillednumberrequired

Hours billed/consumed for this task

idstringrequired

Unique identifier for the task (UUID)

invoiceNumberobject

Invoice number if the task is billed, null if unbilled

isUnbilledboolean

Flag indicating if this task is unbilled (in progress)

shortNumbernumberrequired

Short number of the task

titlestringrequired

Title of the task

pricenumberrequired

Total price for the contingent period

projectIdstringrequired

ID of the project this contingent belongs to (UUID)

ratenumberrequired

Calculated hourly rate (price / hours). Automatically computed.

titlestringrequired

Title or name of the support contingent plan

toDatestring

End date of the contingent period (ISO 8601 date format). If not set, the contingent is active forever.

transferablebooleanrequired

Whether unused hours can be transferred to the next period

updatedAtstringrequired

ISO 8601 timestamp when the contingent was last updated

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

idpath*

Request

curl -X GET "https://leadtime.app/api/public/projects/string/support-contingents-details" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/projects/string/support-contingents-details", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/projects/string/support-contingents-details",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

[
  {
    "createdAt": "2024-01-15T10:00:00Z",
    "frequency": 12,
    "fromDate": "2025-01-01",
    "hours": 120,
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "periods": [
      {
        "consumedHours": 15.5,
        "hasNoEndDate": false,
        "hours": 40,
        "hoursFromPrevious": 10,
        "isCurrentPeriod": true,
        "periodEnd": "2025-11-30",
        "periodStart": "2025-11-01",
        "tasks": [
          {
            "hoursBilled": 5.5,
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "invoiceNumber": "INV-2025-001",
            "isUnbilled": false,
            "shortNumber": 1234,
            "title": "Fix bug in payment module"
          }
        ]
      }
    ],
    "price": 10000,
    "projectId": "550e8400-e29b-41d4-a716-446655440001",
    "rate": 83.33,
    "title": "Maintenance flatrate",
    "toDate": "2025-12-31",
    "transferable": false,
    "updatedAt": "2024-01-20T14:30:00Z"
  }
]