Kita CaptureAPI reference

Transactions

Edit, revert and re-validate transactions on processed bank statements.

Edit transactions

PUT /documents/{document_id}/transactions

Replace the transaction array for a processed bank statement. The original extraction is preserved as an immutable backup on first edit, so POST /documents/{document_id}/transactions/revert can always restore it. Balance re-validation runs by default.

PUT/documents/{document_id}/transactions

curl

curl -X PUT "https://api.kita.ai/api/v1/documents/42/transactions" \
  -H "Authorization: Bearer $KITA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "transactions": [
    {
      "transaction_id": "<transaction_id>",
      "date": "<date>",
      "description": "<description>",
      "amount": 0
    }
  ]
}'

Path parameters

FieldTypeDescription
document_idrequiredintegerPositive integer document ID.

Request body · application/json

FieldTypeDescription
transactionsrequiredobject[]The full updated transactions array.
  transactions[].transaction_idstring
  transactions[].datestringAs printed on the statement.
  transactions[].descriptionstring
  transactions[].amountnumber
  transactions[].debitnumber
  transactions[].creditnumber
  transactions[].balancenumber
  transactions[].categorystring
  transactions[].is_outlierboolean
  transactions[].outlier_reasonstring | null
revalidatebooleanRe-run balance validation.

Response · 200

FieldTypeDescription
successboolean
transactionsobject[]
  transactions[].transaction_idstring
  transactions[].datestringAs printed on the statement.
  transactions[].descriptionstring
  transactions[].amountnumber
  transactions[].debitnumber
  transactions[].creditnumber
  transactions[].balancenumber
  transactions[].categorystring
  transactions[].is_outlierboolean
  transactions[].outlier_reasonstring | null
metricsobject
balance_checksobject
edit_historyobject
  edit_history.last_edited_atstring(date-time)
  edit_history.edited_by_user_idstring
  edit_history.versioninteger

Errors

FieldTypeDescription
400errorThe request was rejected. See `error` for the machine-readable code.
404errorResource does not exist, or belongs to another organization.

Revert to the original extraction

POST /documents/{document_id}/transactions/revert

Restores the originally extracted transactions. Only available after at least one edit.

POST/documents/{document_id}/transactions/revert

curl

curl -X POST "https://api.kita.ai/api/v1/documents/42/transactions/revert" \
  -H "Authorization: Bearer $KITA_API_KEY"

Path parameters

FieldTypeDescription
document_idrequiredintegerPositive integer document ID.

Response · 200

FieldTypeDescription
successboolean
transactionsobject[]
  transactions[].transaction_idstring
  transactions[].datestringAs printed on the statement.
  transactions[].descriptionstring
  transactions[].amountnumber
  transactions[].debitnumber
  transactions[].creditnumber
  transactions[].balancenumber
  transactions[].categorystring
  transactions[].is_outlierboolean
  transactions[].outlier_reasonstring | null
metricsobject
balance_checksobject
messagestring

Errors

FieldTypeDescription
400errorThe request was rejected. See `error` for the machine-readable code.
404errorResource does not exist, or belongs to another organization.

Re-run balance validation

POST /documents/{document_id}/transactions/revalidate

Re-validates the current transactions without modifying them.

POST/documents/{document_id}/transactions/revalidate

curl

curl -X POST "https://api.kita.ai/api/v1/documents/42/transactions/revalidate" \
  -H "Authorization: Bearer $KITA_API_KEY"

Path parameters

FieldTypeDescription
document_idrequiredintegerPositive integer document ID.

Response · 200

FieldTypeDescription
successboolean
transactionsobject[]
  transactions[].transaction_idstring
  transactions[].datestringAs printed on the statement.
  transactions[].descriptionstring
  transactions[].amountnumber
  transactions[].debitnumber
  transactions[].creditnumber
  transactions[].balancenumber
  transactions[].categorystring
  transactions[].is_outlierboolean
  transactions[].outlier_reasonstring | null
metricsobject
balance_checksobject

Errors

FieldTypeDescription
404errorResource does not exist, or belongs to another organization.

On this page