ProjectsGet a contract

Get a contract

Returns one contract of a project — model, status, type and expense/mileage defaults.

Reads one contract by its integer ID and returns it as ContractRead with a self link and the ten contract TAF actions. An unknown ID is a 500 with Code 100 and no detail, not a 404.

Use it to:

  • Resolve the ProjectSubContractID of a payment, expense or mileage registration to its contract model and status
  • Read back a contract after one of the create-*-contract operations

Not for:

  • All contracts of a project → GET /v1/contract

Behaviour:

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

Call first: GET /v1/contract, GET /v1/payment/{paymentID}

Next: GET /v1/payment

See also: GET /v1/ContractModel

curl -X GET "https://app3.timelog.com/your-account/api/v1/contract/123" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Properties": {
    "ContractID": 123,
    "ContractGuid": "123e4567-e89b-12d3-a456-426614174000",
    "ContractModelType": 42,
    "ProjectID": 123,
    "IsMainContract": true,
    "ContractName": "John Doe",
    "ContractStatus": 42,
    "IsMileageBillable": true,
    "IsDefaultExpenses": "null",
    "ContractTypeID": 123,
    "ContractTypeName": "John Doe"
  },
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ],
  "Actions": [
    {}
  ]
}
GET
/v1/contract/{contractID}
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
contractIDinteger
Required

The contract. A non-integer does not match the route (404 Page Not Found).

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

contractIDinteger
Required

The contract. A non-integer does not match the route (404 Page Not Found).

Responses

Propertiesobject

A contract of a project: HOW the work on the project is invoiced. A project has one or more contracts; each has a contract model (time and material, fixed price, prepaid, ...), a status and an optional account-defined contract type. Tasks, payments (instalments), expenses and mileage are booked on a contract. The TAF self link points to GET /v1/contract/{ContractID}; each entity also lists the ten contract TAF actions (five creates, five validates).

Linksarray
Actionsobject[]