ExpensesList payment methods by status

List payment methods by status

The value set for PaymentMethodID on employee and project expenses. A payment method says who paid and which method is preselected per expense kind. Paged ($pagesize 10 by default); TotalRecord uses the same filter as the page.

Use it to:

  • Payment-method picker in a receipt-capture client (preselect IsDefaultForEmployeeExpense)

Not for:

Behaviour:

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

Next: POST /v1/employee-expense, POST /v1/project-expense

Not yet documented: request → path params.

curl -X GET "https://app3.timelog.com/your-account/api/v1/payment-method/-1?$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": {
        "PaymentMethodID": 123,
        "Name": "John Doe",
        "IsPaidByEmployee": true,
        "IsDefaultForEmployeeExpense": true,
        "IsDefaultForProjectExpense": true,
        "IsActive": true,
        "IsDefaultForImport": true,
        "IsPersonalCreditCard": true,
        "CreditCardEmployeeUserID": "null"
      },
      "Links": [
        {
          "Href": "example_string",
          "Rel": "example_string"
        }
      ],
      "Actions": [
        {}
      ]
    }
  ],
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ]
}
GET
/v1/payment-method/{status}
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
statusinteger
Required

ActiveStatus. Also bound from the member name. Filters on PaymentMethodRead.IsActive (eq). Allowed values: | Value | Name | Meaning | |---|---|---| | -1 | All | Active and inactive methods (default when omitted). | | 0 | Inactive | Only methods with IsActive = false. | | 1 | Active | Only methods with IsActive = true — the ones usable on new expenses. |

Options: -1, 0, 1
query
$pageinteger

Page number.

query
$pagesizeinteger

Page size. No maximum enforced 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.

Path Parameters

statusinteger
Required

ActiveStatus. Also bound from the member name.

Filters on PaymentMethodRead.IsActive (eq).

Allowed values:

ValueNameMeaning
-1AllActive and inactive methods (default when omitted).
0InactiveOnly methods with IsActive = false.
1ActiveOnly methods with IsActive = true — the ones usable on new expenses.
Allowed values:-101

Query Parameters

$pageinteger

Page number.

$pagesizeinteger

Page size. No maximum enforced 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