> For the complete documentation index, see [llms.txt](https://docs.kick.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kick.co/api/api-reference/transactions.md).

# Transactions

Transactions are read across every entity in a workspace, so every endpoint is nested under the workspace uuid. `startDate` and `endDate` are inclusive calendar days.

Updates are partial: fields left out of the body keep their current value, and `classIds` replaces the class assignments as a whole. Inside a locked bookkeeping period only `memo` can change, and anything else is rejected with `409`.

## List transactions

> Returns the workspace's transactions across all of its entities. \`startDate\`/\`endDate\` are inclusive calendar days. Results are paged with \`limit\`/\`offset\`.

```json
{"openapi":"3.0.2","info":{"title":"Kick Platform API","version":"v1"},"servers":[{"description":"Production","url":"https://use.kick.co/api"}],"security":[{"organizationAccessToken":[]}],"components":{"securitySchemes":{"organizationAccessToken":{"description":"Organization access token issued by Kick, sent as `Authorization: Bearer kick_org_...`.","scheme":"bearer","type":"http"}}},"paths":{"/platform/v1/workspaces/{workspaceId}/transactions":{"get":{"description":"Returns the workspace's transactions across all of its entities. `startDate`/`endDate` are inclusive calendar days. Results are paged with `limit`/`offset`.","operationId":"transactions.list","parameters":[{"in":"path","name":"workspaceId","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"limit","schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"in":"query","name":"offset","schema":{"default":0,"minimum":0,"nullable":true,"type":"integer"}},{"in":"query","name":"startDate","schema":{"type":"string"}},{"in":"query","name":"endDate","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"accountId":{"format":"uuid","nullable":true,"type":"string"},"accrualAccountId":{"format":"uuid","nullable":true,"type":"string"},"amount":{"type":"number"},"bankDescription":{"description":"Description as it arrived from the bank or provider.","type":"string"},"classIds":{"description":"Classes assigned to the transaction, at most one per root dimension.","items":{"format":"uuid","type":"string"},"type":"array"},"date":{"description":"Calendar day the money moved, as YYYY-MM-DD.","type":"string"},"entityId":{"format":"uuid","type":"string"},"id":{"format":"uuid","type":"string"},"isBusiness":{"description":"Whether the transaction is booked as business or personal.","type":"boolean"},"memo":{"nullable":true,"type":"string"},"status":{"enum":["pending","completed","failed"],"type":"string"},"type":{"enum":["external","stripe","imported","ramp","mercury","paypal","manual"],"type":"string"}},"required":["id","entityId","date","amount","bankDescription","memo","type","status","accountId","accrualAccountId","isBusiness","classIds"],"type":"object"},"type":"array"},"pagination":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}},"required":["limit","offset","total"],"type":"object"}},"required":["data","pagination"],"type":"object"}}},"description":"200"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"400"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"401"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"404"},"429":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"429"}},"summary":"List transactions","tags":["transactions"]}}}}
```

## Retrieve a transaction

> Returns a single transaction of the workspace. A transaction outside the organization's book of business reads as not found.

```json
{"openapi":"3.0.2","info":{"title":"Kick Platform API","version":"v1"},"servers":[{"description":"Production","url":"https://use.kick.co/api"}],"security":[{"organizationAccessToken":[]}],"components":{"securitySchemes":{"organizationAccessToken":{"description":"Organization access token issued by Kick, sent as `Authorization: Bearer kick_org_...`.","scheme":"bearer","type":"http"}}},"paths":{"/platform/v1/workspaces/{workspaceId}/transactions/{transactionId}":{"get":{"description":"Returns a single transaction of the workspace. A transaction outside the organization's book of business reads as not found.","operationId":"transactions.get","parameters":[{"in":"path","name":"workspaceId","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"transactionId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"transaction":{"properties":{"accountId":{"format":"uuid","nullable":true,"type":"string"},"accrualAccountId":{"format":"uuid","nullable":true,"type":"string"},"amount":{"type":"number"},"bankDescription":{"description":"Description as it arrived from the bank or provider.","type":"string"},"classIds":{"description":"Classes assigned to the transaction, at most one per root dimension.","items":{"format":"uuid","type":"string"},"type":"array"},"date":{"description":"Calendar day the money moved, as YYYY-MM-DD.","type":"string"},"entityId":{"format":"uuid","type":"string"},"id":{"format":"uuid","type":"string"},"isBusiness":{"description":"Whether the transaction is booked as business or personal.","type":"boolean"},"memo":{"nullable":true,"type":"string"},"status":{"enum":["pending","completed","failed"],"type":"string"},"type":{"enum":["external","stripe","imported","ramp","mercury","paypal","manual"],"type":"string"}},"required":["id","entityId","date","amount","bankDescription","memo","type","status","accountId","accrualAccountId","isBusiness","classIds"],"type":"object"}},"required":["transaction"],"type":"object"}}},"description":"200"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"400"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"401"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"404"},"429":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"429"}},"summary":"Retrieve a transaction","tags":["transactions"]}}}}
```

## Update a transaction

> Updates the fields present in the body and leaves the others untouched. \`classIds\` replaces the class assignments as a whole — the full desired set, at most one class per root dimension. \`memo\`, \`accountId\` and \`accrualAccountId\` accept \`null\` to clear the current value; the two account ids must reference accounts of the transaction's entity. Inside a locked bookkeeping period only \`memo\` can be changed; anything else is rejected with 409.

```json
{"openapi":"3.0.2","info":{"title":"Kick Platform API","version":"v1"},"servers":[{"description":"Production","url":"https://use.kick.co/api"}],"security":[{"organizationAccessToken":[]}],"components":{"securitySchemes":{"organizationAccessToken":{"description":"Organization access token issued by Kick, sent as `Authorization: Bearer kick_org_...`.","scheme":"bearer","type":"http"}}},"paths":{"/platform/v1/workspaces/{workspaceId}/transactions/{transactionId}":{"patch":{"description":"Updates the fields present in the body and leaves the others untouched. `classIds` replaces the class assignments as a whole — the full desired set, at most one class per root dimension. `memo`, `accountId` and `accrualAccountId` accept `null` to clear the current value; the two account ids must reference accounts of the transaction's entity. Inside a locked bookkeeping period only `memo` can be changed; anything else is rejected with 409.","operationId":"transactions.update","parameters":[{"in":"path","name":"workspaceId","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"transactionId","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"accountId":{"description":"Chart of accounts account the transaction is categorized to on the cash basis. Must belong to the transaction's entity and cannot be the account of the transaction's own financial account. Pass null to uncategorize.","format":"uuid","nullable":true,"type":"string"},"accrualAccountId":{"description":"Chart of accounts account the transaction is categorized to on the accrual basis. Must belong to the transaction's entity and cannot be the account of the transaction's own financial account. Pass null to uncategorize.","format":"uuid","nullable":true,"type":"string"},"classIds":{"description":"Full desired set of classes for the transaction, at most one per root dimension. Pass an empty array to clear all assignments.","items":{"format":"uuid","type":"string"},"maxItems":10,"type":"array"},"memo":{"description":"Free-form note on the transaction. Pass null to clear it.","maxLength":1000,"nullable":true,"type":"string"}},"type":"object"}}},"description":"Body"},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"transaction":{"properties":{"accountId":{"format":"uuid","nullable":true,"type":"string"},"accrualAccountId":{"format":"uuid","nullable":true,"type":"string"},"amount":{"type":"number"},"bankDescription":{"description":"Description as it arrived from the bank or provider.","type":"string"},"classIds":{"description":"Classes assigned to the transaction, at most one per root dimension.","items":{"format":"uuid","type":"string"},"type":"array"},"date":{"description":"Calendar day the money moved, as YYYY-MM-DD.","type":"string"},"entityId":{"format":"uuid","type":"string"},"id":{"format":"uuid","type":"string"},"isBusiness":{"description":"Whether the transaction is booked as business or personal.","type":"boolean"},"memo":{"nullable":true,"type":"string"},"status":{"enum":["pending","completed","failed"],"type":"string"},"type":{"enum":["external","stripe","imported","ramp","mercury","paypal","manual"],"type":"string"}},"required":["id","entityId","date","amount","bankDescription","memo","type","status","accountId","accrualAccountId","isBusiness","classIds"],"type":"object"}},"required":["transaction"],"type":"object"}}},"description":"200"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"400"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"401"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"404"},"409":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"409"},"429":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"429"}},"summary":"Update a transaction","tags":["transactions"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.kick.co/api/api-reference/transactions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.