List project interim payments

Returns all interim payments (partial payments, advance payments, prepayments) for the specified project.

What are Interim Payments? Interim payments are payments made before the final project invoice is completed. They help maintain cash flow during long-running projects, split large invoices into manageable parts, and track incoming payments according to agreed payment schedules.

Typical use cases:

Contractually agreed down payment at project start
Installment after milestone approval
Security payment before development start

What is returned:

All interim payments for the project, sorted by their sort order
Each payment includes: title, description (as HTML), amount, billing status, creation date, and sort order
The description field is automatically converted from internal IDoc format to HTML for API responses

Important:

Only non-deleted payments are returned
Payments marked as billed (isBilled: true) are still included in the list
Requires Projects.seeAnyProject permission

GET/projects/{projectId}/interim-payments

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

projectIdstringrequired

Responses

200

Interim payments retrieved successfully

Array of ProjectInterimPaymentResponseDto

amountnumberrequired

Payment amount in the workspace currency. This amount is automatically deducted from the final invoice when the payment is billed.

createdAtstringrequired

ISO 8601 timestamp when the payment was created

descriptionstringrequired

Detailed description of the payment formatted as HTML. This is automatically converted from the internal IDoc format for API responses. May include notes about when the payment was made, its purpose, or related contract terms.

idstringrequired

Unique identifier for the interim payment (UUID)

isBilledbooleanrequired

Whether this payment has already been included in an invoice. When true, the payment has been billed and deducted from a final invoice. This field is read-only and managed automatically by the invoicing system.

projectIdstringrequired

ID of the project this payment belongs to (UUID)

sortnumberrequired

Numeric sort order for displaying payments in a list. Lower numbers appear first. Used to organize payments chronologically or by priority.

titlestringrequired

Short label or title for the payment (e.g., "Prepayment", "50% Deposit", "Milestone 1")

updatedAtstringrequired

ISO 8601 timestamp when the payment was last updated

userIdstringrequired

ID of the user who created this interim payment (UUID)

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

404

Project not found

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

projectIdpath*

Request

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

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

import requests

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

Response

[
  {
    "amount": 10000,
    "createdAt": "2024-01-15T10:00:00Z",
    "description": "<p>Payment for Q1 milestone - Client paid €1,000 upfront</p>",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "isBilled": false,
    "projectId": "550e8400-e29b-41d4-a716-446655440001",
    "sort": 0,
    "title": "Advance Payment Q1",
    "updatedAt": "2024-01-20T14:30:00Z",
    "userId": "550e8400-e29b-41d4-a716-446655440002"
  }
]