Download OpenAPI specification:Download
Note: Clio Accounting is available in the US region only. Every request goes to a single base URL,
https://api.clio.com/accounting. There are no region-specific endpoints.
Public REST API for the Clio Accounting service. Every path below is relative to that base URL, and all endpoints serve JSON.
Authenticate with an OAuth 2.0 bearer token (Authorization: Bearer <jwt>) issued through the Clio API Hub.
Pass the OpenAPI version with X-API-Version: YYYY-MM-DD to pin a specific contract, or unstable to opt
in to the latest spec.
Successful responses use { "data": ... } envelopes (with { "meta": { "paging": ... } }
on paginated collections). Errors use { "error": { "status": "<code>", "message": "..." } }.
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": {
- "id": 626,
- "name": "Doe & Associates",
- "currency": "USD",
- "country": "US",
- "status": "active",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| limit | integer [ 1 .. 200 ] Default: 25 |
| page_token | string Opaque token for cursor-based pagination. Pass back the value from |
string Filter users by email address (exact match). An unrecognized or malformed address returns an empty collection rather than an error. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": [
- {
- "id": 626,
- "first_name": "Jane",
- "last_name": "Doe",
- "email": "jane.doe@example.com",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "account": {
- "id": 350,
- "firm_name": "Doe & Associates"
}
}
],
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": {
- "id": 626,
- "first_name": "Jane",
- "last_name": "Doe",
- "email": "jane.doe@example.com",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "account": {
- "id": 350,
- "firm_name": "Doe & Associates"
}
}
}| limit | integer [ 1 .. 200 ] Default: 25 |
| page_token | string Opaque token for cursor-based pagination. Pass back the value from |
| date_from | string <date> Only return entries on or after this date (inclusive). |
| date_to | string <date> Only return entries on or before this date (inclusive). |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": [
- {
- "id": 626,
- "date": "2019-08-24",
- "description": "string",
- "user": {
- "id": 512,
- "first_name": "string",
- "last_name": "string"
}, - "vendor": {
- "id": 418,
- "name": "string"
}, - "client": {
- "id": 205,
- "display_name": "string"
}, - "matter": {
- "id": 337,
- "display_name": "string"
}, - "journal_entry_items": [
- {
- "id": 811,
- "ledger_account": {
- "id": 704,
- "name": "string"
}, - "operation_type": "debit",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "description": "string",
- "user": {
- "id": 513,
- "first_name": "string",
- "last_name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
],
}| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
| Idempotency-Key | string <= 255 characters Optional client-supplied key that makes the create idempotent. Replaying a request with the same key and the same request body returns |
required | object | ||||||||||||
| |||||||||||||
{- "data": {
- "date": "2019-08-24",
- "description": "string",
- "vendor": {
- "id": 418
}, - "client": {
- "id": 205
}, - "matter": {
- "id": 337
}, - "journal_entry_items": [
- {
- "ledger_account": {
- "id": 626
}, - "operation_type": "debit",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "description": "string"
}, - {
- "ledger_account": {
- "id": 626
}, - "operation_type": "debit",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "description": "string"
}
]
}
}{- "data": {
- "id": 626,
- "date": "2019-08-24",
- "description": "string",
- "user": {
- "id": 512,
- "first_name": "string",
- "last_name": "string"
}, - "vendor": {
- "id": 418,
- "name": "string"
}, - "client": {
- "id": 205,
- "display_name": "string"
}, - "matter": {
- "id": 337,
- "display_name": "string"
}, - "journal_entry_items": [
- {
- "id": 811,
- "ledger_account": {
- "id": 704,
- "name": "string"
}, - "operation_type": "debit",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "description": "string",
- "user": {
- "id": 513,
- "first_name": "string",
- "last_name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": {
- "id": 626,
- "date": "2019-08-24",
- "description": "string",
- "user": {
- "id": 512,
- "first_name": "string",
- "last_name": "string"
}, - "vendor": {
- "id": 418,
- "name": "string"
}, - "client": {
- "id": 205,
- "display_name": "string"
}, - "matter": {
- "id": 337,
- "display_name": "string"
}, - "journal_entry_items": [
- {
- "id": 811,
- "ledger_account": {
- "id": 704,
- "name": "string"
}, - "operation_type": "debit",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "description": "string",
- "user": {
- "id": 513,
- "first_name": "string",
- "last_name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
required | object Partial update of a journal entry. Omitted fields are left unchanged. | ||||||||||||
| |||||||||||||
{- "data": {
- "date": "2019-08-24",
- "description": "string",
- "vendor": {
- "id": 418
}, - "client": {
- "id": 205
}, - "matter": {
- "id": 337
}, - "journal_entry_items": [
- {
- "ledger_account": {
- "id": 626
}, - "operation_type": "debit",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "description": "string"
}, - {
- "ledger_account": {
- "id": 626
}, - "operation_type": "debit",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "description": "string"
}
]
}
}{- "data": {
- "id": 626,
- "date": "2019-08-24",
- "description": "string",
- "user": {
- "id": 512,
- "first_name": "string",
- "last_name": "string"
}, - "vendor": {
- "id": 418,
- "name": "string"
}, - "client": {
- "id": 205,
- "display_name": "string"
}, - "matter": {
- "id": 337,
- "display_name": "string"
}, - "journal_entry_items": [
- {
- "id": 811,
- "ledger_account": {
- "id": 704,
- "name": "string"
}, - "operation_type": "debit",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "description": "string",
- "user": {
- "id": 513,
- "first_name": "string",
- "last_name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}Soft-deletes the journal entry. The entry is marked deleted rather than removed from the database.
| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "error": {
- "status": "string",
- "message": "string"
}
}| limit | integer [ 1 .. 200 ] Default: 25 |
| page_token | string Opaque token for cursor-based pagination. Pass back the value from |
| status | string Enum: "active" "inactive" Filter by account status. When omitted, only active accounts are returned. |
| kind | string Enum: "operating" "trust" Filter by account kind. |
| ledger_type | string Enum: "default" "bank" "accounts_receivable" "accounts_payable" "expense" "undeposited_funds" "fixed" "trust_liability" "income" "trust_clearing" Filter by ledger type. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": [
- {
- "id": 626,
- "name": "Operating Account",
- "code": "0100",
- "status": "active",
- "kind": "operating",
- "ledger_type": "bank",
- "ledger_account_type": {
- "id": 314,
- "name": "string"
}, - "parent": {
- "id": 271,
- "name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
],
}| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
required | object | ||||||||
| |||||||||
{- "data": {
- "name": "Operating Account",
- "code": "0100",
- "ledger_account_type": {
- "id": 626
}, - "parent": {
- "id": 271
}
}
}{- "data": {
- "id": 626,
- "name": "Operating Account",
- "code": "0100",
- "status": "active",
- "kind": "operating",
- "ledger_type": "bank",
- "ledger_account_type": {
- "id": 314,
- "name": "string"
}, - "parent": {
- "id": 271,
- "name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": {
- "id": 626,
- "name": "Operating Account",
- "code": "0100",
- "status": "active",
- "kind": "operating",
- "ledger_type": "bank",
- "ledger_account_type": {
- "id": 314,
- "name": "string"
}, - "parent": {
- "id": 271,
- "name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
required | object | ||||||||||
| |||||||||||
{- "data": {
- "name": "Operating Account",
- "code": "0100",
- "status": "inactive",
- "ledger_account_type": {
- "id": 626
}, - "parent": {
- "id": 271
}
}
}{- "data": {
- "id": 626,
- "name": "Operating Account",
- "code": "0100",
- "status": "active",
- "kind": "operating",
- "ledger_type": "bank",
- "ledger_account_type": {
- "id": 314,
- "name": "string"
}, - "parent": {
- "id": 271,
- "name": "string"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| limit | integer [ 1 .. 200 ] Default: 25 |
| page_token | string |
| primary_type | string Enum: "unknown" "asset" "liability" "equity" "income" "expense" |
| ledger_type | string Enum: "default" "bank" "accounts_receivable" "accounts_payable" "expense" "undeposited_funds" "fixed" "trust_liability" "income" "trust_clearing" |
| bank_feed_connectable | boolean |
| reconcilable | boolean |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": [
- {
- "id": 626,
- "name": "Bank - Operating",
- "primary_type": "asset",
- "ledger_type": "bank",
- "bank_feed_connectable": true,
- "reconcilable": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
],
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": {
- "id": 626,
- "name": "Bank - Operating",
- "primary_type": "asset",
- "ledger_type": "bank",
- "bank_feed_connectable": true,
- "reconcilable": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| limit | integer [ 1 .. 200 ] Default: 25 |
| page_token | string Opaque token for cursor-based pagination. Pass back the value from |
| status | string Enum: "draft" "posted" "partially_paid" "paid" Filter by bill status. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": [
- {
- "id": 921,
- "vendor": {
- "id": 418,
- "company_name": "string"
}, - "status": "posted",
- "bill_number": "INV-1042",
- "account_number": "ACME-88231",
- "description": "string",
- "date": "2019-08-24",
- "due_date": "2019-08-24",
- "client_related": true,
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "balance_due": {
- "amount": "5.05",
- "currency": "USD"
}, - "vendor_bill_items": [
- {
- "id": 811,
- "ledger_account": {
- "id": 815,
- "name": "string"
}, - "client": {
- "id": 205,
- "display_name": "string"
}, - "matter": {
- "id": 337,
- "display_name": "string"
}, - "description": "string",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
],
}| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
| Idempotency-Key | string <= 255 characters Optional client-supplied key that makes the create idempotent. Replaying a request with the same key and the same request body returns |
required | object | ||||||||||||||
| |||||||||||||||
{- "data": {
- "vendor": {
- "id": 626
}, - "date": "2019-08-24",
- "due_date": "2019-08-24",
- "bill_number": "string",
- "account_number": "string",
- "description": "string",
- "vendor_bill_items": [
- {
- "ledger_account": {
- "id": 626
}, - "client": {
- "id": 626
}, - "matter": {
- "id": 626
}, - "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "description": "string"
}
]
}
}{- "data": {
- "id": 921,
- "vendor": {
- "id": 418,
- "company_name": "string"
}, - "status": "posted",
- "bill_number": "INV-1042",
- "account_number": "ACME-88231",
- "description": "string",
- "date": "2019-08-24",
- "due_date": "2019-08-24",
- "client_related": true,
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "balance_due": {
- "amount": "5.05",
- "currency": "USD"
}, - "vendor_bill_items": [
- {
- "id": 811,
- "ledger_account": {
- "id": 815,
- "name": "string"
}, - "client": {
- "id": 205,
- "display_name": "string"
}, - "matter": {
- "id": 337,
- "display_name": "string"
}, - "description": "string",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": {
- "id": 921,
- "vendor": {
- "id": 418,
- "company_name": "string"
}, - "status": "posted",
- "bill_number": "INV-1042",
- "account_number": "ACME-88231",
- "description": "string",
- "date": "2019-08-24",
- "due_date": "2019-08-24",
- "client_related": true,
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "balance_due": {
- "amount": "5.05",
- "currency": "USD"
}, - "vendor_bill_items": [
- {
- "id": 811,
- "ledger_account": {
- "id": 815,
- "name": "string"
}, - "client": {
- "id": 205,
- "display_name": "string"
}, - "matter": {
- "id": 337,
- "display_name": "string"
}, - "description": "string",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
required | object Partial update of a vendor bill. Omitted fields are left unchanged. | ||||||||||||||
| |||||||||||||||
{- "data": {
- "vendor": {
- "id": 626
}, - "date": "2019-08-24",
- "due_date": "2019-08-24",
- "bill_number": "string",
- "account_number": "string",
- "description": "string",
- "vendor_bill_items": [
- {
- "ledger_account": {
- "id": 626
}, - "client": {
- "id": 626
}, - "matter": {
- "id": 626
}, - "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "description": "string"
}
]
}
}{- "data": {
- "id": 921,
- "vendor": {
- "id": 418,
- "company_name": "string"
}, - "status": "posted",
- "bill_number": "INV-1042",
- "account_number": "ACME-88231",
- "description": "string",
- "date": "2019-08-24",
- "due_date": "2019-08-24",
- "client_related": true,
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "balance_due": {
- "amount": "5.05",
- "currency": "USD"
}, - "vendor_bill_items": [
- {
- "id": 811,
- "ledger_account": {
- "id": 815,
- "name": "string"
}, - "client": {
- "id": 205,
- "display_name": "string"
}, - "matter": {
- "id": 337,
- "display_name": "string"
}, - "description": "string",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}Soft-deletes the vendor bill. The bill is marked deleted rather than removed from the database.
| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "error": {
- "status": "string",
- "message": "string"
}
}| limit | integer [ 1 .. 200 ] Default: 25 |
| page_token | string Opaque token for cursor-based pagination. Pass back the value from |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": [
- {
- "id": 933,
- "vendor": {
- "id": 418,
- "name": "string"
}, - "ledger_account": {
- "id": 704,
- "name": "string"
}, - "payment_method": "check",
- "created_from": "manual",
- "description": "string",
- "date": "2019-08-24",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "vendor_bill_payment_items": [
- {
- "id": 937,
- "vendor_bill": {
- "id": 921,
- "bill_number": "string"
}, - "amount": {
- "amount": "5.05",
- "currency": "USD"
}
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
],
}| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
| Idempotency-Key | string <= 255 characters Optional client-supplied key that makes the create idempotent. Replaying a request with the same key and the same request body returns |
required | object | ||||||||||
| |||||||||||
{- "data": {
- "ledger_account": {
- "id": 704
}, - "date": "2019-08-24",
- "payment_method": "check",
- "description": "string",
- "vendor_bill_payment_items": [
- {
- "vendor_bill": {
- "id": 921
}, - "amount": {
- "amount": "5.05",
- "currency": "USD"
}
}
]
}
}{- "data": {
- "id": 933,
- "vendor": {
- "id": 418,
- "name": "string"
}, - "ledger_account": {
- "id": 704,
- "name": "string"
}, - "payment_method": "check",
- "created_from": "manual",
- "description": "string",
- "date": "2019-08-24",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "vendor_bill_payment_items": [
- {
- "id": 937,
- "vendor_bill": {
- "id": 921,
- "bill_number": "string"
}, - "amount": {
- "amount": "5.05",
- "currency": "USD"
}
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": {
- "id": 933,
- "vendor": {
- "id": 418,
- "name": "string"
}, - "ledger_account": {
- "id": 704,
- "name": "string"
}, - "payment_method": "check",
- "created_from": "manual",
- "description": "string",
- "date": "2019-08-24",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "vendor_bill_payment_items": [
- {
- "id": 937,
- "vendor_bill": {
- "id": 921,
- "bill_number": "string"
}, - "amount": {
- "amount": "5.05",
- "currency": "USD"
}
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}Voids (soft-deletes) the vendor bill payment. The payment is marked deleted rather than removed from the database, releasing the amounts it had applied to the associated bills.
| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "error": {
- "status": "string",
- "message": "string"
}
}| limit | integer [ 1 .. 200 ] Default: 25 |
| page_token | string Opaque token for cursor-based pagination. Pass back the value from |
| kind | string Enum: "balance_sheet" "general_ledger" "income_statement" Filter by report kind. |
| state | string Enum: "queued" "in_progress" "completed" "errored" "timed_out" Filter by generation state. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": [
- {
- "id": 626,
- "kind": "balance_sheet",
- "state": "queued",
- "format": "csv",
- "accounting_basis": "cash",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "download_url_expires_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
],
}Enqueues generation of a report and returns it in the queued state. Report generation is asynchronous: poll GET /reports/{id} until state reaches a terminal value (completed, errored, or timed_out). Once completed, the resource carries a short-lived signed download_url.
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
| Idempotency-Key | string <= 255 characters Optional client-supplied key that makes the create idempotent. Replaying a request with the same key and the same request body returns |
required | object | ||||||||
| |||||||||
{- "data": {
- "kind": "balance_sheet",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "accounting_basis": "cash"
}
}{- "data": {
- "id": 626,
- "kind": "balance_sheet",
- "state": "queued",
- "format": "csv",
- "accounting_basis": "cash",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "download_url_expires_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}Retrieve a report and its current generation state. Poll this endpoint until state reaches a terminal value (completed, errored, or timed_out); once completed, the resource includes a short-lived signed download_url for the generated file.
| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": {
- "id": 626,
- "kind": "balance_sheet",
- "state": "queued",
- "format": "csv",
- "accounting_basis": "cash",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "download_url_expires_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| limit | integer [ 1 .. 200 ] Default: 25 |
| page_token | string Opaque token for cursor-based pagination. Pass back the value from |
| status | string Enum: "active" "inactive" Filter by vendor status. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": [
- {
- "id": 918,
- "external_id": 4815162342,
- "company_name": "Acme Supplies Inc.",
- "first_name": "Jane",
- "last_name": "Doe",
- "email": "billing@acmesupplies.example.com",
- "phone": "+1-604-555-0142",
- "description": "string",
- "employer_identification_number": "12-3456789",
- "tax_1099": true,
- "is_clio": true,
- "status": "active",
- "address": {
- "street": "123 Main St",
- "city": "Vancouver",
- "state": "BC",
- "zip_code": "V6B 1A1",
- "country": "CA"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
],
}| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
| Idempotency-Key | string <= 255 characters Optional client-supplied key that makes the create idempotent. Replaying a request with the same key and the same request body returns |
required | object | ||||||||||||||||||||
| |||||||||||||||||||||
{- "data": {
- "company_name": "Acme Supplies Inc.",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "phone": "string",
- "description": "string",
- "employer_identification_number": "string",
- "tax_1099": true,
- "status": "active",
- "address": {
- "street": "123 Main St",
- "city": "Vancouver",
- "state": "BC",
- "zip_code": "V6B 1A1",
- "country": "CA"
}
}
}{- "data": {
- "id": 918,
- "external_id": 4815162342,
- "company_name": "Acme Supplies Inc.",
- "first_name": "Jane",
- "last_name": "Doe",
- "email": "billing@acmesupplies.example.com",
- "phone": "+1-604-555-0142",
- "description": "string",
- "employer_identification_number": "12-3456789",
- "tax_1099": true,
- "is_clio": true,
- "status": "active",
- "address": {
- "street": "123 Main St",
- "city": "Vancouver",
- "state": "BC",
- "zip_code": "V6B 1A1",
- "country": "CA"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": {
- "id": 918,
- "external_id": 4815162342,
- "company_name": "Acme Supplies Inc.",
- "first_name": "Jane",
- "last_name": "Doe",
- "email": "billing@acmesupplies.example.com",
- "phone": "+1-604-555-0142",
- "description": "string",
- "employer_identification_number": "12-3456789",
- "tax_1099": true,
- "is_clio": true,
- "status": "active",
- "address": {
- "street": "123 Main St",
- "city": "Vancouver",
- "state": "BC",
- "zip_code": "V6B 1A1",
- "country": "CA"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
required | object Partial update of a vendor. Omitted fields are left unchanged. | ||||||||||||||||||||
| |||||||||||||||||||||
{- "data": {
- "company_name": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "user@example.com",
- "phone": "string",
- "description": "string",
- "employer_identification_number": "string",
- "tax_1099": true,
- "status": "active",
- "address": {
- "street": "123 Main St",
- "city": "Vancouver",
- "state": "BC",
- "zip_code": "V6B 1A1",
- "country": "CA"
}
}
}{- "data": {
- "id": 918,
- "external_id": 4815162342,
- "company_name": "Acme Supplies Inc.",
- "first_name": "Jane",
- "last_name": "Doe",
- "email": "billing@acmesupplies.example.com",
- "phone": "+1-604-555-0142",
- "description": "string",
- "employer_identification_number": "12-3456789",
- "tax_1099": true,
- "is_clio": true,
- "status": "active",
- "address": {
- "street": "123 Main St",
- "city": "Vancouver",
- "state": "BC",
- "zip_code": "V6B 1A1",
- "country": "CA"
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}Permanently deletes the vendor. This action cannot be undone. Deletion is only allowed if the vendor has no transaction history and is not the Clio system vendor. To retire a vendor reversibly, use PATCH /api/v1/vendors/{id} with status: inactive.
| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "error": {
- "status": "string",
- "message": "string"
}
}| limit | integer [ 1 .. 200 ] Default: 25 |
| page_token | string Opaque token for cursor-based pagination. Pass back the value from |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": [
- {
- "id": 447,
- "external_id": 4815162342,
- "display_name": "Smith v. Jones",
- "clients": [
- {
- "id": 589,
- "display_name": "Doe & Associates"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
],
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": {
- "id": 447,
- "external_id": 4815162342,
- "display_name": "Smith v. Jones",
- "clients": [
- {
- "id": 589,
- "display_name": "Doe & Associates"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| limit | integer [ 1 .. 200 ] Default: 25 |
| page_token | string Opaque token for cursor-based pagination. Pass back the value from |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": [
- {
- "id": 733,
- "external_id": 4815162342,
- "display_name": "Jane Doe",
- "first_name": "Jane",
- "last_name": "Doe",
- "email": "jane.doe@example.com",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
],
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": {
- "id": 733,
- "external_id": 4815162342,
- "display_name": "Jane Doe",
- "first_name": "Jane",
- "last_name": "Doe",
- "email": "jane.doe@example.com",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| limit | integer [ 1 .. 200 ] Default: 25 |
| page_token | string Opaque token for cursor-based pagination. Pass back the value from |
| ledger_account_id | integer <int64> Filter to expenses paid from this ledger account. |
| vendor_id | integer <int64> Filter to expenses associated with this vendor. |
| date_from | string <date> Only return expenses on or after this date (inclusive). |
| date_to | string <date> Only return expenses on or before this date (inclusive). |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": [
- {
- "id": 626,
- "date": "2019-08-24",
- "description": "string",
- "reference_num": "1024",
- "payment_method": "check",
- "payment_method_description": "string",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "ledger_account": {
- "id": 704,
- "name": "string"
}, - "vendor": {
- "id": 418,
- "name": "string"
}, - "client": {
- "id": 205,
- "display_name": "string"
}, - "matter": {
- "id": 337,
- "display_name": "string"
}, - "reversal": true,
- "expense_items": [
- {
- "id": 811,
- "ledger_account": {
- "id": 815,
- "name": "string"
}, - "description": "string",
- "memo": "string",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
],
}| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
| Idempotency-Key | string <= 255 characters Optional client-supplied key that makes the create idempotent. Replaying a request with the same key and the same request body returns |
required | object | ||||||||||||||||||||
| |||||||||||||||||||||
{- "data": {
- "date": "2019-08-24",
- "ledger_account": {
- "id": 704
}, - "vendor": {
- "id": 418
}, - "client": {
- "id": 205
}, - "matter": {
- "id": 337
}, - "description": "string",
- "reference_num": "1024",
- "payment_method": "check",
- "payment_method_description": "string",
- "expense_items": [
- {
- "ledger_account": {
- "id": 815
}, - "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "description": "string",
- "memo": "string"
}
]
}
}{- "data": {
- "id": 626,
- "date": "2019-08-24",
- "description": "string",
- "reference_num": "1024",
- "payment_method": "check",
- "payment_method_description": "string",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "ledger_account": {
- "id": 704,
- "name": "string"
}, - "vendor": {
- "id": 418,
- "name": "string"
}, - "client": {
- "id": 205,
- "display_name": "string"
}, - "matter": {
- "id": 337,
- "display_name": "string"
}, - "reversal": true,
- "expense_items": [
- {
- "id": 811,
- "ledger_account": {
- "id": 815,
- "name": "string"
}, - "description": "string",
- "memo": "string",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "data": {
- "id": 626,
- "date": "2019-08-24",
- "description": "string",
- "reference_num": "1024",
- "payment_method": "check",
- "payment_method_description": "string",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "ledger_account": {
- "id": 704,
- "name": "string"
}, - "vendor": {
- "id": 418,
- "name": "string"
}, - "client": {
- "id": 205,
- "display_name": "string"
}, - "matter": {
- "id": 337,
- "display_name": "string"
}, - "reversal": true,
- "expense_items": [
- {
- "id": 811,
- "ledger_account": {
- "id": 815,
- "name": "string"
}, - "description": "string",
- "memo": "string",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
required | object Partial update of an expense. Omitted fields are left unchanged. | ||||||||||||||||||||
| |||||||||||||||||||||
{- "data": {
- "date": "2019-08-24",
- "ledger_account": {
- "id": 704
}, - "vendor": {
- "id": 418
}, - "client": {
- "id": 205
}, - "matter": {
- "id": 337
}, - "description": "string",
- "reference_num": "1024",
- "payment_method": "check",
- "payment_method_description": "string",
- "expense_items": [
- {
- "ledger_account": {
- "id": 815
}, - "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "description": "string",
- "memo": "string"
}
]
}
}{- "data": {
- "id": 626,
- "date": "2019-08-24",
- "description": "string",
- "reference_num": "1024",
- "payment_method": "check",
- "payment_method_description": "string",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}, - "ledger_account": {
- "id": 704,
- "name": "string"
}, - "vendor": {
- "id": 418,
- "name": "string"
}, - "client": {
- "id": 205,
- "display_name": "string"
}, - "matter": {
- "id": 337,
- "display_name": "string"
}, - "reversal": true,
- "expense_items": [
- {
- "id": 811,
- "ledger_account": {
- "id": 815,
- "name": "string"
}, - "description": "string",
- "memo": "string",
- "amount": {
- "amount": "5.05",
- "currency": "USD"
}
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}Deletes the expense. Returns no body.
| id required | integer <int64> (ResourceId) Example: 626 Unique numeric identifier for a resource. 64-bit to avoid overflow in generated clients. |
| X-API-Version | string^(unstable|\d{4}-\d{2}-\d{2})$ Example: 2026-03-31 Pins the request to a specific OpenAPI contract. Pass a date in |
{- "error": {
- "status": "string",
- "message": "string"
}
}