See what's new in the
Kick Changelog
Ctrlk
Go to Kick
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Transactions

Read a workspace's transactions across all of its entities, read a single transaction, and update one.

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

get

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

Authorizations
AuthorizationstringRequired

Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....

Path parameters
workspaceIdstring · uuidRequired
Query parameters
limitinteger · min: 1 · max: 100OptionalDefault: 100
offsetinteger · nullableOptionalDefault: 0
startDatestringOptional
endDatestringOptional
Responses
200

200

application/json
get/platform/v1/workspaces/{workspaceId}/transactions
GET /api/platform/v1/workspaces/{workspaceId}/transactions HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "accrualAccountId": "123e4567-e89b-12d3-a456-426614174000",
      "amount": 1,
      "bankDescription": "text",
      "classIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "date": "text",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isBusiness": true,
      "memo": "text",
      "status": "pending",
      "type": "external"
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "total": 1
  }
}

Retrieve a transaction

get

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

Authorizations
AuthorizationstringRequired

Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....

Path parameters
workspaceIdstring · uuidRequired
transactionIdstring · uuidRequired
Responses
200

200

application/json
get/platform/v1/workspaces/{workspaceId}/transactions/{transactionId}
GET /api/platform/v1/workspaces/{workspaceId}/transactions/{transactionId} HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "transaction": {
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "accrualAccountId": "123e4567-e89b-12d3-a456-426614174000",
    "amount": 1,
    "bankDescription": "text",
    "classIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "date": "text",
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isBusiness": true,
    "memo": "text",
    "status": "pending",
    "type": "external"
  }
}

Update a transaction

patch

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.

Authorizations
AuthorizationstringRequired

Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....

Path parameters
workspaceIdstring · uuidRequired
transactionIdstring · uuidRequired
Header parameters
Idempotency-Keystring · min: 1 · max: 255Optional

A unique key that makes the request idempotent. Retrying with the same key within 24 hours replays the original response (marked with Idempotent-Replayed: true) instead of executing again.

Body
accountIdstring · uuid · nullableOptional

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.

accrualAccountIdstring · uuid · nullableOptional

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.

classIdsstring · uuid[] · max: 10Optional

Full desired set of classes for the transaction, at most one per root dimension. Pass an empty array to clear all assignments.

memostring · max: 1000 · nullableOptional

Free-form note on the transaction. Pass null to clear it.

Responses
200

200

application/json
patch/platform/v1/workspaces/{workspaceId}/transactions/{transactionId}
PATCH /api/platform/v1/workspaces/{workspaceId}/transactions/{transactionId} HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "accrualAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "classIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "memo": "text"
}
{
  "transaction": {
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "accrualAccountId": "123e4567-e89b-12d3-a456-426614174000",
    "amount": 1,
    "bankDescription": "text",
    "classIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "date": "text",
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isBusiness": true,
    "memo": "text",
    "status": "pending",
    "type": "external"
  }
}
PreviousPlaid Connections
NextTransaction Rules

Last updated

Was this helpful?