ProjectsList the payments of a contract

List the payments of a contract

Lists the billing-plan instalments of one contract, in creation order, one page at a time.

contractID is required (without it no action matches → 405). An unknown contract returns an empty list, not an error. The caller needs access to the contract's project (403 otherwise).

Use it to:

  • Sync a contract's payment plan to an ERP
  • Find PaymentIDs for GET / update / delete

Behaviour:

  • Idempotent.
  • Safe to retry.
  • Changes are visible to the next read immediately.

Next: GET /v1/payment/{paymentID}

See also: POST /v1/payment

Not yet documented: examples.

curl -X GET "https://app3.timelog.com/your-account/api/v1/payment?contractID=123&$page=1&$pagesize=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Properties": {
    "TotalRecord": "example_string",
    "TotalPage": "example_string",
    "PageNumber": "example_string"
  },
  "Entities": [
    {
      "Properties": {
        "Name": "John Doe",
        "PaymentID": 123,
        "PaymentGuid": "123e4567-e89b-12d3-a456-426614174000",
        "Comment": "example_string",
        "Amount": 3.14,
        "InvoiceDate": "2024-12-25T10:00:00Z",
        "IsReadyForInvoicing": true,
        "InstallmentType": 42,
        "ProjectID": 123,
        "TaskID": 123,
        "ProductNumberID": 123,
        "Discount": 3.14,
        "ProjectSubContractID": 123,
        "Quantity": 3.14,
        "UnitType": 42,
        "Rate": 3.14,
        "IsFixedPricePayment": true,
        "ExpensesCost": 3.14
      },
      "Links": [
        {
          "Href": "example_string",
          "Rel": "example_string"
        }
      ],
      "Actions": [
        {}
      ]
    }
  ],
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ]
}
GET
/v1/payment
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user. > Not yet documented: how to obtain a token. > Not yet documented: token lifetime.

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user. > Not yet documented: how to obtain a token. > Not yet documented: token lifetime.
query
contractIDinteger
Required

The contract (ProjectSubContractID). Omitted → 405 UnsupportedApiVersion (no action matched).

Format: int32
query
$pageinteger

Page number.

query
$pagesizeinteger

Page size. No maximum in the API layer.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).

The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.

Not yet documented: how to obtain a token.

Not yet documented: token lifetime.

Query Parameters

contractIDinteger
Required

The contract (ProjectSubContractID). Omitted → 405 UnsupportedApiVersion (no action matched).

$pageinteger

Page number.

$pagesizeinteger

Page size. No maximum in the API layer.

Responses

Propertiesobject

Paging values. They are returned as STRINGS, for example "TotalRecord": "12".

Entitiesarray

Omitted (not []) when the list is empty.

Linksarray