Update Statement

PATCH /api/v1/statements/:id

Updates the period and balance fields of a statement. Use this to manually set or correct statement period dates and opening/closing balances.

Path Parameters

Request Body

All fields are optional. Only include fields you want to update. Balance values should be integers in the smallest currency unit (e.g., paise for INR).

Review Object

Example Request

curl -X PATCH "https://statements.finopsbricks.com/api/v1/statements/stmt123xyz" \
  -H "api-key: fob_stm_xxxxxxxxxxxx" \
  -H "api-secret: xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "period_start": "2025-01-01",
    "period_end": "2025-01-31",
    "opening_balance": 5000050,
    "closing_balance": 4825075
  }'

Example: Rename Statement

curl -X PATCH "https://statements.finopsbricks.com/api/v1/statements/stmt123xyz" \
  -H "api-key: fob_stm_xxxxxxxxxxxx" \
  -H "api-secret: xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "file_name": "HDFC Savings - January 2025.pdf"
  }'

Example: Update Period Only

curl -X PATCH "https://statements.finopsbricks.com/api/v1/statements/stmt123xyz" \
  -H "api-key: fob_stm_xxxxxxxxxxxx" \
  -H "api-secret: xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "period_start": "2025-01-01",
    "period_end": "2025-01-31"
  }'

Response

{
  "data": {
    "id": "stmt123xyz",
    "file_name": "statement_jan_2025.pdf",
    "mime_type": "application/pdf",
    "file_type": "pdf",
    "file_size": "245760",
    "parser_type": "hdfc_savings__pdf",
    "step": "complete",
    "error": null,
    "account_id": "acc123",
    "account_name": "Main Account",
    "account_currency": "INR",
    "is_archived": false,
    "created_at": "2025-01-05T10:30:00.000Z",
    "period_start": "2025-01-01",
    "period_end": "2025-01-31",
    "opening_balance": 5000050,
    "closing_balance": 4825075,
    "data_source": {
      "period_start": "user_entered",
      "period_end": "user_entered",
      "opening_balance": "user_entered",
      "closing_balance": "user_entered"
    }
  }
}

Data Source Tracking

When you update a field, the data_source object tracks how the value was set:

This allows you to see whether a value was originally extracted from the statement or manually entered.

Validation Rules

Period Validation

If the statement has transactions, the period must contain all transaction dates:

• period_start must be on or before the earliest transaction date
• period_end must be on or after the latest transaction date

Example: If a statement has transactions from 2025-01-03 to 2025-01-28:

• Valid: period_start: "2025-01-01", period_end: "2025-01-31"
• Invalid: period_start: "2025-01-05" (after earliest transaction)
• Invalid: period_end: "2025-01-25" (before latest transaction)

Validation Error Response

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid statement period",
    "details": [
      "period_start (2025-01-05) cannot be after earliest transaction (2025-01-03)"
    ]
  }
}

Errors