ProjectsGet a payment

Get a payment

Returns one contract payment (billing-plan instalment) by its integer PaymentID, if the caller may see its project.

Reads one instalment (PaymentRead). Unknown IDs and instalments without a project answer 404. The caller needs access to the payment's project under the same rule as GET /v1/project/{projectID}.

Use it to:

  • Read back a payment after POST /v1/payment
  • Check invoicing state (IsReadyForInvoicing) of a known instalment

Behaviour:

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

Call first: GET /v1/payment

See also: POST /v1/payment

Not yet documented: examples.

curl -X GET "https://app3.timelog.com/your-account/api/v1/payment/123" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "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": [
    {}
  ]
}
GET
/v1/payment/{paymentID}
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.
path
paymentIDinteger
Required

The payment's integer ID.

Format: int32
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.

Path Parameters

paymentIDinteger
Required

The payment's integer ID.

Responses

Propertiesobject

One billing-plan instalment of a contract: what will be invoiced (name, quantity × rate less discount = amount), when (InvoiceDate), on which project / contract / task, and whether it is ready for invoicing. The TAF self link points to GET /v1/payment/{PaymentID}; each entity also lists the six payment TAF actions.

Linksarray
Actionsobject[]