Bank reconciliation

Bank statements (CSV / Excel, per bank) matched to rent UTR claims, deal receipts and booking payments by UTR, amount and date (N-10): clear matches confirmed by rule, near ones reviewed; never applied twice.

GET/v1/bank-statements

Imported statements

Newest first, with their counts. Keyset pagination.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reconciliation.view.

Parameters

cursorquery: string
limitquery: integer

Response · 200

datarequired: array of BankStatement
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/bank-statements' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "bank": "hdfc",
      "account_label": "string",
      "file_name": "string",
      "period_from": "2026-10-06",
      "period_to": "2026-10-06",
      "rows_total": 0,
      "rows_new": 0,
      "credits": 0,
      "auto_matched": 0,
      "to_review": 0,
      "problems": [
        {
          "row_no": 0,
          "message": "string"
        }
      ],
      "created_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/bank-statements

Import a bank statement

A CSV or XLSX statement (base64, ≤ 5 MB) read with the bank’s column names; new lines are stored once, credits are matched to rent UTR claims and receipts — clear matches are confirmed when the rule allows, near ones queued. 409 for the same file twice; 422 for a file the format cannot read. Audited.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reconciliation.import.

Request body

bankrequired: "hdfc" | "icici" | "sbi" | "axis" | "kotak" | "generic"
file_namerequired: string
content_base64required: string
account_label: string or null

Response · 201

datarequired: BankStatement
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/bank-statements' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"bank":"hdfc","file_name":"string","content_base64":"string","account_label":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "bank": "hdfc",
    "account_label": "string",
    "file_name": "string",
    "period_from": "2026-10-06",
    "period_to": "2026-10-06",
    "rows_total": 0,
    "rows_new": 0,
    "credits": 0,
    "auto_matched": 0,
    "to_review": 0,
    "problems": [
      {
        "row_no": 0,
        "message": "string"
      }
    ],
    "created_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/bank-statements/{id}/rematch

Match the open credits again

After new UTR claims or receipts were recorded.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reconciliation.confirm.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.autorequired: integer
data.reviewrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/bank-statements/{id}/rematch' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "auto": 0,
    "review": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/bank-transactions

Bank lines and the review queue

`suggested` is the review queue. Without a status every line except debits. Keyset pagination.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reconciliation.view.

Parameters

statusquery: "unmatched" | "suggested" | "matched" | "ignored" | "debit"
statement_idquery: Id
Opaque record id.
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of BankTransaction
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/bank-transactions' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "statement_id": "cmusrceel0000q7kaafxqi1om",
      "row_no": 0,
      "txn_date": "2026-10-06",
      "amount": 850000000,
      "narration": "string",
      "reference": "string",
      "utr": "string",
      "status": "unmatched",
      "match": {
        "kind": "string",
        "id": "cmusrceel0000q7kaafxqi1om",
        "score": 0,
        "reasons": [
          "string"
        ],
        "by": "string",
        "at": "2026-10-06T05:30:00.000Z"
      },
      "suggestion": {
        "best": {
          "kind": "rent_payment",
          "id": "cmusrceel0000q7kaafxqi1om",
          "label": "string",
          "amount": "string",
          "date": "2026-10-06",
          "utr": "string",
          "score": 0,
          "reasons": [
            "string"
          ]
        },
        "alternatives": [
          {
            "kind": "rent_payment",
            "id": "cmusrceel0000q7kaafxqi1om",
            "label": "string",
            "amount": "string",
            "date": "2026-10-06",
            "utr": "string",
            "score": 0,
            "reasons": [
              null
            ]
          }
        ]
      }
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/bank-transactions/{id}/ignore

Set a bank line aside

A transfer between own accounts or an unrelated credit. Audited with the reason.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reconciliation.confirm.

Parameters

idpathrequired: Id
Opaque record id.

Request body

reasonrequired: string

Response · 200

datarequired: BankTransaction
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/bank-transactions/{id}/ignore' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "statement_id": "cmusrceel0000q7kaafxqi1om",
    "row_no": 0,
    "txn_date": "2026-10-06",
    "amount": 850000000,
    "narration": "string",
    "reference": "string",
    "utr": "string",
    "status": "unmatched",
    "match": {
      "kind": "string",
      "id": "cmusrceel0000q7kaafxqi1om",
      "score": 0,
      "reasons": [
        "string"
      ],
      "by": "string",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "suggestion": {
      "best": {
        "kind": "rent_payment",
        "id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "amount": "string",
        "date": "2026-10-06",
        "utr": "string",
        "score": 0,
        "reasons": [
          "string"
        ]
      },
      "alternatives": [
        {
          "kind": "rent_payment",
          "id": "cmusrceel0000q7kaafxqi1om",
          "label": "string",
          "amount": "string",
          "date": "2026-10-06",
          "utr": "string",
          "score": 0,
          "reasons": [
            "string"
          ]
        }
      ]
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/bank-transactions/{id}/match

Confirm or link a match

Confirms the credit against a rent UTR claim (confirmed with its receipt) or a receipt (cleared on the bank date). Only an open record whose amount agrees; a record already matched is a 404; a decided line a 409. Audited.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reconciliation.confirm.

Parameters

idpathrequired: Id
Opaque record id.

Request body

kindrequired: "rent_payment" | "receipt"
record_idrequired: Id
Opaque record id.

Response · 200

datarequired: BankTransaction
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/bank-transactions/{id}/match' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"rent_payment","record_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "statement_id": "cmusrceel0000q7kaafxqi1om",
    "row_no": 0,
    "txn_date": "2026-10-06",
    "amount": 850000000,
    "narration": "string",
    "reference": "string",
    "utr": "string",
    "status": "unmatched",
    "match": {
      "kind": "string",
      "id": "cmusrceel0000q7kaafxqi1om",
      "score": 0,
      "reasons": [
        "string"
      ],
      "by": "string",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "suggestion": {
      "best": {
        "kind": "rent_payment",
        "id": "cmusrceel0000q7kaafxqi1om",
        "label": "string",
        "amount": "string",
        "date": "2026-10-06",
        "utr": "string",
        "score": 0,
        "reasons": [
          "string"
        ]
      },
      "alternatives": [
        {
          "kind": "rent_payment",
          "id": "cmusrceel0000q7kaafxqi1om",
          "label": "string",
          "amount": "string",
          "date": "2026-10-06",
          "utr": "string",
          "score": 0,
          "reasons": [
            "string"
          ]
        }
      ]
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/settings/bank-reconciliation

The reconciliation rule

Auto-confirm (off by default), the date window and the amount tolerance.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reconciliation.view.

Response · 200

datarequired: ReconciliationSettings
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/bank-reconciliation' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "auto_confirm": true,
    "date_window_days": 0,
    "amount_tolerance": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/settings/bank-reconciliation

Save the reconciliation rule

Audited.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reconciliation.confirm.

Request body

auto_confirmrequired: boolean
Confirm clear matches (same UTR, exact amount, in the window) without a person.
date_window_daysrequired: integer
amount_tolerancerequired: integer
Paise.

Response · 200

datarequired: ReconciliationSettings
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/bank-reconciliation' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"auto_confirm":true,"date_window_days":0,"amount_tolerance":0}'

Response example

{
  "data": {
    "auto_confirm": true,
    "date_window_days": 0,
    "amount_tolerance": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/settings/bank-reconciliation/mailbox

The bank statement mailbox

The inbound address statement mails are forwarded to, the bank format and the accepted senders.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reconciliation.confirm.

Response · 200

datarequired: StatementMailbox
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/bank-reconciliation/mailbox' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "enabled": true,
    "address": "string",
    "bank": "hdfc",
    "senders": [
      "string"
    ],
    "accounts": [
      "string"
    ],
    "last_received_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/settings/bank-reconciliation/mailbox

Set up the bank statement mailbox

On / off, the bank whose format the attachments are read in, and the senders accepted (addresses or @domain; a mail must also be DKIM-signed by that domain). `rotate` issues a new address. Audited.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reconciliation.confirm.

Request body

enabledrequired: boolean
bankrequired: "hdfc" | "icici" | "sbi" | "axis" | "kotak" | "generic"
sendersrequired: array of string
accounts: array of string
rotate: boolean

Response · 200

datarequired: StatementMailbox
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/bank-reconciliation/mailbox' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"bank":"hdfc","senders":["string"],"accounts":["string"],"rotate":true}'

Response example

{
  "data": {
    "enabled": true,
    "address": "string",
    "bank": "hdfc",
    "senders": [
      "string"
    ],
    "accounts": [
      "string"
    ],
    "last_received_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "bank": "hdfc", "account_label": "string", "file_name": "string", "period_from": "2026-10-06", "period_to": "2026-10-06", "rows_total": 0, "rows_new": 0, "credits": 0, "auto_matched": 0, "to_review": 0, "problems": [ { "row_no": 0, "message": "string" } ], "created_at": "2026-10-06T05:30:00.000Z" } ], "meta": { "next_cursor": "string", "has_more": true } }

curl -X POST 'https://api.propzolo.com/v1/bank-statements' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"bank":"hdfc","file_name":"string","content_base64":"string","account_label":"string"}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "bank": "hdfc", "account_label": "string", "file_name": "string", "period_from": "2026-10-06", "period_to": "2026-10-06", "rows_total": 0, "rows_new": 0, "credits": 0, "auto_matched": 0, "to_review": 0, "problems": [ { "row_no": 0, "message": "string" } ], "created_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

POST/v1/bank-statements/{id}/rematch

Match the open credits again

After new UTR claims or receipts were recorded.

Access: Signed-in members only (web or Android session) — not for API keys. Permission reconciliation.confirm.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.autorequired: integer
data.reviewrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/bank-statements/{id}/rematch' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "auto": 0,
    "review": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "statement_id": "cmusrceel0000q7kaafxqi1om", "row_no": 0, "txn_date": "2026-10-06", "amount": 850000000, "narration": "string", "reference": "string", "utr": "string", "status": "unmatched", "match": { "kind": "string", "id": "cmusrceel0000q7kaafxqi1om", "score": 0, "reasons": [ "string" ], "by": "string", "at": "2026-10-06T05:30:00.000Z" }, "suggestion": { "best": { "kind": "rent_payment", "id": "cmusrceel0000q7kaafxqi1om", "label": "string", "amount": "string", "date": "2026-10-06", "utr": "string", "score": 0, "reasons": [ "string" ] }, "alternatives": [ { "kind": "rent_payment", "id": "cmusrceel0000q7kaafxqi1om", "label": "string", "amount": "string", "date": "2026-10-06", "utr": "string", "score": 0, "reasons": [ null ] } ] } } ], "meta": { "next_cursor": "string", "has_more": true } }

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "statement_id": "cmusrceel0000q7kaafxqi1om", "row_no": 0, "txn_date": "2026-10-06", "amount": 850000000, "narration": "string", "reference": "string", "utr": "string", "status": "unmatched", "match": { "kind": "string", "id": "cmusrceel0000q7kaafxqi1om", "score": 0, "reasons": [ "string" ], "by": "string", "at": "2026-10-06T05:30:00.000Z" }, "suggestion": { "best": { "kind": "rent_payment", "id": "cmusrceel0000q7kaafxqi1om", "label": "string", "amount": "string", "date": "2026-10-06", "utr": "string", "score": 0, "reasons": [ "string" ] }, "alternatives": [ { "kind": "rent_payment", "id": "cmusrceel0000q7kaafxqi1om", "label": "string", "amount": "string", "date": "2026-10-06", "utr": "string", "score": 0, "reasons": [ "string" ] } ] } }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/bank-transactions/{id}/match' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"kind":"rent_payment","record_id":"cmusrceel0000q7kaafxqi1om"}'

curl -X PUT 'https://api.propzolo.com/v1/settings/bank-reconciliation' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"auto_confirm":true,"date_window_days":0,"amount_tolerance":0}'

{ "data": { "enabled": true, "address": "string", "bank": "hdfc", "senders": [ "string" ], "accounts": [ "string" ], "last_received_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

curl -X PUT 'https://api.propzolo.com/v1/settings/bank-reconciliation/mailbox' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"enabled":true,"bank":"hdfc","senders":["string"],"accounts":["string"],"rotate":true}'

{ "data": { "enabled": true, "address": "string", "bank": "hdfc", "senders": [ "string" ], "accounts": [ "string" ], "last_received_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }