Finance

POST/v1/commission-payouts/{id}/approve

Approve a payout

Above the company’s payout approval amount it waits for the approval chain (409 approval_required; send request_approval=1 to raise it).

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

Parameters

idpathrequired: Id
Opaque record id.
request_approvalquery: "0" | "1"

Response · 200

datarequired: CommissionPayout
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/commission-payouts/{id}/approve' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "payee_type": "member",
    "payee": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "gross": 850000000,
    "gst_amount": 850000000,
    "tds": 850000000,
    "net": 850000000,
    "status": "pending",
    "release_rule": "manual",
    "releasable": 850000000,
    "tds_status": "pending",
    "tds_section": "string",
    "tds_rate_bps": 0,
    "tds_reason": "string",
    "invoice_ref": "string",
    "approved_on": "2026-10-06",
    "approved_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "paid_on": "2026-10-06",
    "paid_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "payment_mode": "string",
    "payment_reference": "string",
    "hold_reason": "string",
    "cancel_reason": "string",
    "notes": "string",
    "parent_id": "cmusrceel0000q7kaafxqi1om",
    "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.
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.

POST/v1/commission-payouts/{id}/pay

With the mode and reference (UTR, cheque number); a part leaves the rest as its own approved payout. Takes the TDS (data-driven section, yearly threshold, no-PAN rate) and writes the TDS register. Needs a fresh second factor.

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

Parameters

idpathrequired: Id
Opaque record id.
Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
paid_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
moderequired: "neft" | "rtgs" | "imps" | "upi" | "cheque" | "cash"
reference: string or null
override_release: boolean
note: string or null

Response · 200

datarequired: object
data.paidrequired: CommissionPayout
data.restrequired: CommissionPayout or null
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/commission-payouts/{id}/pay' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"amount":0,"paid_on":"2026-10-06","mode":"neft","reference":"string","override_release":false,"note":"string"}'

Response example

{
  "data": {
    "paid": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "deal": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "title": "string"
      },
      "payee_type": "member",
      "payee": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "gross": 850000000,
      "gst_amount": 850000000,
      "tds": 850000000,
      "net": 850000000,
      "status": "pending",
      "release_rule": "manual",
      "releasable": 850000000,
      "tds_status": "pending",
      "tds_section": "string",
      "tds_rate_bps": 0,
      "tds_reason": "string",
      "invoice_ref": "string",
      "approved_on": "2026-10-06",
      "approved_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "paid_on": "2026-10-06",
      "paid_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "payment_mode": "string",
      "payment_reference": "string",
      "hold_reason": "string",
      "cancel_reason": "string",
      "notes": "string",
      "parent_id": "cmusrceel0000q7kaafxqi1om",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "rest": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "deal": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "title": "string"
      },
      "payee_type": "member",
      "payee": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "gross": 850000000,
      "gst_amount": 850000000,
      "tds": 850000000,
      "net": 850000000,
      "status": "pending",
      "release_rule": "manual",
      "releasable": 850000000,
      "tds_status": "pending",
      "tds_section": "string",
      "tds_rate_bps": 0,
      "tds_reason": "string",
      "invoice_ref": "string",
      "approved_on": "2026-10-06",
      "approved_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "paid_on": "2026-10-06",
      "paid_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "payment_mode": "string",
      "payment_reference": "string",
      "hold_reason": "string",
      "cancel_reason": "string",
      "notes": "string",
      "parent_id": "cmusrceel0000q7kaafxqi1om",
      "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.
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/commission-payouts/{id}/tds-preview

What paying a payout would deduct

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

Parameters

idpathrequired: Id
Opaque record id.
amountquery: string
Paise; default the whole payout.
paid_onquery: LocalDate
Calendar date YYYY-MM-DD in the company time zone.

Response · 200

datarequired: TdsPreview
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/commission-payouts/{id}/tds-preview' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "amount": 850000000,
    "releasable": 850000000,
    "gst_amount": 850000000,
    "event_on": "2026-10-06",
    "section": {
      "act": "string",
      "code": "string"
    },
    "rate_bps": 0,
    "base": 850000000,
    "tds": 850000000,
    "reason": "string",
    "reason_label": "string",
    "capped": true,
    "net": 850000000,
    "prior_amount": 850000000,
    "financial_year": "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.
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/deals/{id}/finance

A deal’s finance timeline

Commission → invoices → credit notes → receipts → payouts, with what each side still has to bill.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: DealFinance
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/deals/{id}/finance' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string",
      "stage": "string"
    },
    "commission": {
      "expected": 850000000,
      "received": 850000000,
      "outstanding": 850000000
    },
    "sides": [
      {
        "side": "string",
        "contact_id": "cmusrceel0000q7kaafxqi1om",
        "contact_name": "string",
        "expected": 850000000,
        "invoiced": 850000000,
        "remaining": 850000000
      }
    ],
    "invoices": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "document_type": "tax_invoice",
        "status": "draft",
        "financial_year": "string",
        "deal": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref": "string",
          "title": "string"
        },
        "contact": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "party_role": "string",
        "bill_to": {
          "legal_name": "string",
          "gstin": "string",
          "pan": "string",
          "address": "string",
          "city": "string",
          "state": "string",
          "pincode": "string",
          "email": "string",
          "phone": "string"
        },
        "place_of_supply": "string",
        "pos_basis": "string",
        "supply_regime": "intra",
        "gst_rate_bps": 0,
        "lines": [
          {
            "index": 0,
            "description": "string",
            "sac": "string",
            "side": "string",
            "taxable": 850000000,
            "cgst": 850000000,
            "sgst": 850000000,
            "igst": 850000000,
            "total": 850000000
          }
        ],
        "subtotal": 850000000,
        "cgst": 850000000,
        "sgst": 850000000,
        "igst": 850000000,
        "round_off": 850000000,
        "total": 850000000,
        "amount_received": 850000000,
        "amount_tds": 850000000,
        "amount_credited": 850000000,
        "balance": 850000000,
        "issued_on": "2026-10-06",
        "due_on": "2026-10-06",
        "days_overdue": 0,
        "ageing": "not_due",
        "notes": "string",
        "terms": "string",
        "cancelled_at": "2026-10-06T05:30:00.000Z",
        "cancel_reason": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "created_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "issued_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "updated_at": "2026-10-06T05:30:00.000Z",
        "capabilities": {
          "edit": true,
          "issue": true,
          "cancel": true,
          "credit": true,
          "send": true,
          "allocate": true
        }
      }
    ],
    "credit_notes": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "financial_year": "string",
        "invoice": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "number": "string",
          "issued_on": "2026-10-06"
        },
        "deal": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref": "string",
          "title": "string"
        },
        "contact": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "reason": "string",
        "reason_note": "string",
        "gst_reversed": true,
        "bill_to": {
          "legal_name": "string",
          "gstin": "string",
          "pan": "string",
          "address": "string",
          "city": "string",
          "state": "string",
          "pincode": "string",
          "email": "string",
          "phone": "string"
        },
        "place_of_supply": "string",
        "supply_regime": "intra",
        "gst_rate_bps": 0,
        "lines": [
          {
            "index": 0,
            "description": "string",
            "sac": "string",
            "side": "string",
            "taxable": 850000000,
            "cgst": 850000000,
            "sgst": 850000000,
            "igst": 850000000,
            "total": 850000000
          }
        ],
        "subtotal": 850000000,
        "cgst": 850000000,
        "sgst": 850000000,
        "igst": 850000000,
        "total": 850000000,
        "issued_on": "2026-10-06",
        "issued_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "receipts": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "RCPT/2026-27/0001",
        "financial_year": "2026-27",
        "deal": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref": "string",
          "title": "string"
        },
        "invoice": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "number": "string"
        },
        "amount": 850000000,
        "tds_amount": 850000000,
        "gst_amount": 850000000,
        "excess_amount": 850000000,
        "purpose": "commission",
        "mode": "upi",
        "reference": "string",
        "bank": "string",
        "received_on": "2026-10-06",
        "cleared_on": "2026-10-06",
        "status": "received",
        "notes": "string",
        "attachment": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "kind": "token_receipt",
          "name": "string",
          "content_type": "string",
          "size": 0,
          "receipt_id": "cmusrceel0000q7kaafxqi1om",
          "uploaded_by": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          },
          "uploaded_at": "2026-10-06T05:30:00.000Z",
          "scan_status": "pending"
        },
        "created_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "payouts": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "deal": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref": "string",
          "title": "string"
        },
        "payee_type": "member",
        "payee": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "gross": 850000000,
        "gst_amount": 850000000,
        "tds": 850000000,
        "net": 850000000,
        "status": "pending",
        "release_rule": "manual",
        "releasable": 850000000,
        "tds_status": "pending",
        "tds_section": "string",
        "tds_rate_bps": 0,
        "tds_reason": "string",
        "invoice_ref": "string",
        "approved_on": "2026-10-06",
        "approved_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "paid_on": "2026-10-06",
        "paid_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "payment_mode": "string",
        "payment_reference": "string",
        "hold_reason": "string",
        "cancel_reason": "string",
        "notes": "string",
        "parent_id": "cmusrceel0000q7kaafxqi1om",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "timeline": [
      {
        "date": "2026-10-06",
        "kind": "invoice",
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "title": "string",
        "amount": 850000000,
        "status": "string"
      }
    ],
    "capabilities": {
      "invoice": true,
      "payout": true
    }
  },
  "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/finance/credit-notes

List credit notes

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

Parameters

invoice_idquery: Id
Opaque record id.
contact_idquery: Id
Opaque record id.
fyquery: string
fromquery: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
toquery: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of CreditNote
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/finance/credit-notes' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": "string",
      "financial_year": "string",
      "invoice": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "issued_on": "2026-10-06"
      },
      "deal": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "title": "string"
      },
      "contact": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "reason": "string",
      "reason_note": "string",
      "gst_reversed": true,
      "bill_to": {
        "legal_name": "string",
        "gstin": "string",
        "pan": "string",
        "address": "string",
        "city": "string",
        "state": "string",
        "pincode": "string",
        "email": "string",
        "phone": "string"
      },
      "place_of_supply": "string",
      "supply_regime": "intra",
      "gst_rate_bps": 0,
      "lines": [
        {
          "index": 0,
          "description": "string",
          "sac": "string",
          "side": "string",
          "taxable": 850000000,
          "cgst": 850000000,
          "sgst": 850000000,
          "igst": 850000000,
          "total": 850000000
        }
      ],
      "subtotal": 850000000,
      "cgst": 850000000,
      "sgst": 850000000,
      "igst": 850000000,
      "total": 850000000,
      "issued_on": "2026-10-06",
      "issued_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "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/finance/credit-notes

Issue a credit note

Against an issued invoice, all or part of what is still creditable; GST reduced until 30 November after the invoice’s financial year (CGST s.34(2)), a commercial credit after. Own series. Needs a fresh second factor.

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

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

invoice_idrequired: Id
Opaque record id.
taxable: PaiseInput or null
Taxable value to credit; default all that is left.
reasonrequired: "deficiency" | "discount" | "excess_billed" | "deal_cancelled" | "other"
reason_note: string or null
issued_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.

Response · 201

datarequired: CreditNote
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/finance/credit-notes' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"invoice_id":"cmusrceel0000q7kaafxqi1om","taxable":0,"reason":"deficiency","reason_note":"string","issued_on":"2026-10-06"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": "string",
    "financial_year": "string",
    "invoice": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": "string",
      "issued_on": "2026-10-06"
    },
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "reason": "string",
    "reason_note": "string",
    "gst_reversed": true,
    "bill_to": {
      "legal_name": "string",
      "gstin": "string",
      "pan": "string",
      "address": "string",
      "city": "string",
      "state": "string",
      "pincode": "string",
      "email": "string",
      "phone": "string"
    },
    "place_of_supply": "string",
    "supply_regime": "intra",
    "gst_rate_bps": 0,
    "lines": [
      {
        "index": 0,
        "description": "string",
        "sac": "string",
        "side": "string",
        "taxable": 850000000,
        "cgst": 850000000,
        "sgst": 850000000,
        "igst": 850000000,
        "total": 850000000
      }
    ],
    "subtotal": 850000000,
    "cgst": 850000000,
    "sgst": 850000000,
    "igst": 850000000,
    "total": 850000000,
    "issued_on": "2026-10-06",
    "issued_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "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.

GET/v1/finance/credit-notes/{id}/document

The credit note as PDF or print-ready HTML

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

Parameters

idpathrequired: Id
Opaque record id.
formatquery: "pdf" | "html"

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/finance/credit-notes/{id}/document' \
  -H 'Authorization: Bearer pz_live_…'

Response example

"string"

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/finance/dashboard

The finance dashboard

Invoiced, GST output, collected, receivables ageing, payouts and TDS for the month, quarter or year.

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

Parameters

periodquery: "month" | "quarter" | "fy"

Response · 200

datarequired: FinanceDashboard
metarequired: object

Request

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

Response example

{
  "data": {
    "period": "month",
    "from": "2026-10-06",
    "to": "2026-10-06",
    "invoiced": 850000000,
    "invoices": 0,
    "credited": 850000000,
    "net_invoiced": 850000000,
    "gst_output": {
      "cgst": 850000000,
      "sgst": 850000000,
      "igst": 850000000,
      "total": 850000000
    },
    "collected": 850000000,
    "tds_by_customers": 850000000,
    "receivables": {
      "buckets": {
        "not_due": 850000000,
        "d1_30": 850000000,
        "d31_60": 850000000,
        "d61_90": 850000000,
        "d90_plus": 850000000
      },
      "counts": {
        "not_due": 0,
        "d1_30": 0,
        "d31_60": 0,
        "d61_90": 0,
        "d90_plus": 0
      },
      "outstanding": 850000000,
      "overdue": 850000000,
      "credit": 850000000
    },
    "drafts": 0,
    "payouts": {
      "pending": 850000000,
      "approved": 850000000,
      "releasable": 850000000,
      "paid": 850000000,
      "tds_deducted": 850000000
    },
    "tds": {
      "payable": 850000000,
      "next_due_on": "2026-10-06"
    },
    "loan_commissions": {
      "accrued": 850000000,
      "received": 850000000,
      "pending": 850000000
    }
  },
  "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.
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/finance/documents/by-token/{token}

An invoice or credit note by its signed link

The customer’s link from the message that delivered it (30 days). Unknown or expired links answer 404.

Access: No authentication.

Parameters

tokenpathrequired: string

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/finance/documents/by-token/{token}'

Response example

"string"

Errors

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/finance/exports/{kind}

Export finance data as CSV

invoices (GST register), credit_notes, sac_summary, payouts, tds (the quarterly statement’s columns, PANs from the payee master), receivables, customer_statement (contact_id), payee_statement (payee_type, payee_id). Watermarked, at most 50,000 rows, audited; needs a fresh second factor.

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

Parameters

kindpathrequired: "invoices" | "credit_notes" | "sac_summary" | "payouts" | "tds" | "receivables" | …
fromquery: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
toquery: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
fyquery: string
quarterquery: "Q1" | "Q2" | "Q3" | "Q4"
contact_idquery: Id
Opaque record id.
payee_typequery: PayeeType
payee_idquery: Id
Opaque record id.

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/finance/exports/{kind}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

"string"

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/finance/invoices

List brokerage invoices

Newest first; overdue = open and past its due date. Within the caller’s deals.

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

Parameters

statusquery: "draft" | "issued" | "part_paid" | "paid" | "cancelled" | "overdue" | …
deal_idquery: Id
Opaque record id.
contact_idquery: Id
Opaque record id.
fyquery: string
fromquery: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
toquery: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
qquery: string
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of Invoice
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": "string",
      "document_type": "tax_invoice",
      "status": "draft",
      "financial_year": "string",
      "deal": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "title": "string"
      },
      "contact": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "party_role": "string",
      "bill_to": {
        "legal_name": "string",
        "gstin": "string",
        "pan": "string",
        "address": "string",
        "city": "string",
        "state": "string",
        "pincode": "string",
        "email": "string",
        "phone": "string"
      },
      "place_of_supply": "string",
      "pos_basis": "string",
      "supply_regime": "intra",
      "gst_rate_bps": 0,
      "lines": [
        {
          "index": 0,
          "description": "string",
          "sac": "string",
          "side": "string",
          "taxable": 850000000,
          "cgst": 850000000,
          "sgst": 850000000,
          "igst": 850000000,
          "total": 850000000
        }
      ],
      "subtotal": 850000000,
      "cgst": 850000000,
      "sgst": 850000000,
      "igst": 850000000,
      "round_off": 850000000,
      "total": 850000000,
      "amount_received": 850000000,
      "amount_tds": 850000000,
      "amount_credited": 850000000,
      "balance": 850000000,
      "issued_on": "2026-10-06",
      "due_on": "2026-10-06",
      "days_overdue": 0,
      "ageing": "not_due",
      "notes": "string",
      "terms": "string",
      "cancelled_at": "2026-10-06T05:30:00.000Z",
      "cancel_reason": "string",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "created_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "issued_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "capabilities": {
        "edit": true,
        "issue": true,
        "cancel": true,
        "credit": true,
        "send": true,
        "allocate": true
      }
    }
  ],
  "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/finance/invoices

Draft an invoice

From a deal’s commission sides (what each still owes) or free lines; priced on the finance settings: GST by the place of supply (the property’s state), the SAC of the deal type. A draft has no number.

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

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

deal_id: Id or null
Opaque record id.
contact_id: Id or null
Who is billed; default the deal party of party_role.
party_role: "buyer" | "seller" | "tenant" | "landlord" | "developer" | "other" or null
sides: array of "buyer" | "seller" | "tenant" | "landlord" or null
Commission sides to bill; default the party’s side, else every side with something left.
lines: array of object or null
Free lines (replace the deal’s).
lines[].descriptionrequired: string
lines[].sac: string or null
lines[].side: "buyer" | "seller" | "tenant" | "landlord" or null
lines[].taxablerequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
bill_to: object or null
bill_to.legal_name: string
bill_to.gstin: string or null
bill_to.pan: string or null
bill_to.address: string or null
bill_to.city: string or null
bill_to.state: "AN" | "AP" | "AR" | "AS" | "BR" | "CH" | … or null
bill_to.pincode: string or null
bill_to.email: string (email) or null
place_of_supply: "AN" | "AP" | "AR" | "AS" | "BR" | "CH" | … or null
Set by hand; default by the rules.
due_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
notes: string or null
terms: string or null

Response · 201

datarequired: InvoiceDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/finance/invoices' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"deal_id":"cmusrceel0000q7kaafxqi1om","contact_id":"cmusrceel0000q7kaafxqi1om","party_role":"buyer","sides":["buyer"],"lines":[{"description":"string","sac":"string","side":"buyer","taxable":0}],"bill_to":{"legal_name":"string","gstin":"string","pan":"string","address":"string","city":"string","state":"AN","pincode":"string","email":"name@example.com"},"place_of_supply":"AN","due_on":"2026-10-06","notes":"string","terms":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": "string",
    "document_type": "tax_invoice",
    "status": "draft",
    "financial_year": "string",
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "party_role": "string",
    "bill_to": {
      "legal_name": "string",
      "gstin": "string",
      "pan": "string",
      "address": "string",
      "city": "string",
      "state": "string",
      "pincode": "string",
      "email": "string",
      "phone": "string"
    },
    "place_of_supply": "string",
    "pos_basis": "string",
    "supply_regime": "intra",
    "gst_rate_bps": 0,
    "lines": [
      {
        "index": 0,
        "description": "string",
        "sac": "string",
        "side": "string",
        "taxable": 850000000,
        "cgst": 850000000,
        "sgst": 850000000,
        "igst": 850000000,
        "total": 850000000
      }
    ],
    "subtotal": 850000000,
    "cgst": 850000000,
    "sgst": 850000000,
    "igst": 850000000,
    "round_off": 850000000,
    "total": 850000000,
    "amount_received": 850000000,
    "amount_tds": 850000000,
    "amount_credited": 850000000,
    "balance": 850000000,
    "issued_on": "2026-10-06",
    "due_on": "2026-10-06",
    "days_overdue": 0,
    "ageing": "not_due",
    "notes": "string",
    "terms": "string",
    "cancelled_at": "2026-10-06T05:30:00.000Z",
    "cancel_reason": "string",
    "sent_at": "2026-10-06T05:30:00.000Z",
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "issued_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "issue": true,
      "cancel": true,
      "credit": true,
      "send": true,
      "allocate": true
    },
    "receipts": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "amount": 850000000,
        "tds_amount": 850000000,
        "gst_amount": 850000000,
        "excess_amount": 850000000,
        "mode": "string",
        "reference": "string",
        "received_on": "2026-10-06",
        "status": "string"
      }
    ],
    "credit_notes": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "total": 850000000,
        "issued_on": "2026-10-06",
        "reason": "string",
        "gst_reversed": true
      }
    ],
    "payment_links": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "string",
        "amount": 850000000,
        "amount_paid": 850000000,
        "short_url": "string",
        "expires_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "creditable": 850000000,
    "gst_reversal_until": "2026-10-06"
  },
  "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/finance/invoices/{id}

An invoice with its receipts, credit notes and payment links

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: InvoiceDetail
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/finance/invoices/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": "string",
    "document_type": "tax_invoice",
    "status": "draft",
    "financial_year": "string",
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "party_role": "string",
    "bill_to": {
      "legal_name": "string",
      "gstin": "string",
      "pan": "string",
      "address": "string",
      "city": "string",
      "state": "string",
      "pincode": "string",
      "email": "string",
      "phone": "string"
    },
    "place_of_supply": "string",
    "pos_basis": "string",
    "supply_regime": "intra",
    "gst_rate_bps": 0,
    "lines": [
      {
        "index": 0,
        "description": "string",
        "sac": "string",
        "side": "string",
        "taxable": 850000000,
        "cgst": 850000000,
        "sgst": 850000000,
        "igst": 850000000,
        "total": 850000000
      }
    ],
    "subtotal": 850000000,
    "cgst": 850000000,
    "sgst": 850000000,
    "igst": 850000000,
    "round_off": 850000000,
    "total": 850000000,
    "amount_received": 850000000,
    "amount_tds": 850000000,
    "amount_credited": 850000000,
    "balance": 850000000,
    "issued_on": "2026-10-06",
    "due_on": "2026-10-06",
    "days_overdue": 0,
    "ageing": "not_due",
    "notes": "string",
    "terms": "string",
    "cancelled_at": "2026-10-06T05:30:00.000Z",
    "cancel_reason": "string",
    "sent_at": "2026-10-06T05:30:00.000Z",
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "issued_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "issue": true,
      "cancel": true,
      "credit": true,
      "send": true,
      "allocate": true
    },
    "receipts": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "amount": 850000000,
        "tds_amount": 850000000,
        "gst_amount": 850000000,
        "excess_amount": 850000000,
        "mode": "string",
        "reference": "string",
        "received_on": "2026-10-06",
        "status": "string"
      }
    ],
    "credit_notes": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "total": 850000000,
        "issued_on": "2026-10-06",
        "reason": "string",
        "gst_reversed": true
      }
    ],
    "payment_links": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "string",
        "amount": 850000000,
        "amount_paid": 850000000,
        "short_url": "string",
        "expires_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "creditable": 850000000,
    "gst_reversal_until": "2026-10-06"
  },
  "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.

PATCH/v1/finance/invoices/{id}

Change a draft invoice

Drafts only — an issued invoice is changed by a credit note.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

contact_id: Id or null
Who is billed; default the deal party of party_role.
party_role: "buyer" | "seller" | "tenant" | "landlord" | "developer" | "other" or null
lines: array of object or null
Free lines (replace the deal’s).
lines[].descriptionrequired: string
lines[].sac: string or null
lines[].side: "buyer" | "seller" | "tenant" | "landlord" or null
lines[].taxablerequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
bill_to: object or null
bill_to.legal_name: string
bill_to.gstin: string or null
bill_to.pan: string or null
bill_to.address: string or null
bill_to.city: string or null
bill_to.state: "AN" | "AP" | "AR" | "AS" | "BR" | "CH" | … or null
bill_to.pincode: string or null
bill_to.email: string (email) or null
place_of_supply: "AN" | "AP" | "AR" | "AS" | "BR" | "CH" | … or null
Set by hand; default by the rules.
due_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
notes: string or null
terms: string or null

Response · 200

datarequired: InvoiceDetail
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/finance/invoices/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"contact_id":"cmusrceel0000q7kaafxqi1om","party_role":"buyer","lines":[{"description":"string","sac":"string","side":"buyer","taxable":0}],"bill_to":{"legal_name":"string","gstin":"string","pan":"string","address":"string","city":"string","state":"AN","pincode":"string","email":"name@example.com"},"place_of_supply":"AN","due_on":"2026-10-06","notes":"string","terms":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": "string",
    "document_type": "tax_invoice",
    "status": "draft",
    "financial_year": "string",
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "party_role": "string",
    "bill_to": {
      "legal_name": "string",
      "gstin": "string",
      "pan": "string",
      "address": "string",
      "city": "string",
      "state": "string",
      "pincode": "string",
      "email": "string",
      "phone": "string"
    },
    "place_of_supply": "string",
    "pos_basis": "string",
    "supply_regime": "intra",
    "gst_rate_bps": 0,
    "lines": [
      {
        "index": 0,
        "description": "string",
        "sac": "string",
        "side": "string",
        "taxable": 850000000,
        "cgst": 850000000,
        "sgst": 850000000,
        "igst": 850000000,
        "total": 850000000
      }
    ],
    "subtotal": 850000000,
    "cgst": 850000000,
    "sgst": 850000000,
    "igst": 850000000,
    "round_off": 850000000,
    "total": 850000000,
    "amount_received": 850000000,
    "amount_tds": 850000000,
    "amount_credited": 850000000,
    "balance": 850000000,
    "issued_on": "2026-10-06",
    "due_on": "2026-10-06",
    "days_overdue": 0,
    "ageing": "not_due",
    "notes": "string",
    "terms": "string",
    "cancelled_at": "2026-10-06T05:30:00.000Z",
    "cancel_reason": "string",
    "sent_at": "2026-10-06T05:30:00.000Z",
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "issued_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "issue": true,
      "cancel": true,
      "credit": true,
      "send": true,
      "allocate": true
    },
    "receipts": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "amount": 850000000,
        "tds_amount": 850000000,
        "gst_amount": 850000000,
        "excess_amount": 850000000,
        "mode": "string",
        "reference": "string",
        "received_on": "2026-10-06",
        "status": "string"
      }
    ],
    "credit_notes": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "total": 850000000,
        "issued_on": "2026-10-06",
        "reason": "string",
        "gst_reversed": true
      }
    ],
    "payment_links": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "string",
        "amount": 850000000,
        "amount_paid": 850000000,
        "short_url": "string",
        "expires_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "creditable": 850000000,
    "gst_reversal_until": "2026-10-06"
  },
  "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.

DELETE/v1/finance/invoices/{id}

Discard a draft invoice

Drafts only — an issued invoice is never deleted.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/finance/invoices/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "deleted": true
  },
  "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.

POST/v1/finance/invoices/{id}/cancel

Cancel an issued invoice

Only before anything settled it and until its GSTR-1 is due (the 11th of the next month); it keeps its number. Otherwise issue a credit note. Needs a fresh second factor.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

reasonrequired: string

Response · 200

datarequired: InvoiceDetail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": "string",
    "document_type": "tax_invoice",
    "status": "draft",
    "financial_year": "string",
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "party_role": "string",
    "bill_to": {
      "legal_name": "string",
      "gstin": "string",
      "pan": "string",
      "address": "string",
      "city": "string",
      "state": "string",
      "pincode": "string",
      "email": "string",
      "phone": "string"
    },
    "place_of_supply": "string",
    "pos_basis": "string",
    "supply_regime": "intra",
    "gst_rate_bps": 0,
    "lines": [
      {
        "index": 0,
        "description": "string",
        "sac": "string",
        "side": "string",
        "taxable": 850000000,
        "cgst": 850000000,
        "sgst": 850000000,
        "igst": 850000000,
        "total": 850000000
      }
    ],
    "subtotal": 850000000,
    "cgst": 850000000,
    "sgst": 850000000,
    "igst": 850000000,
    "round_off": 850000000,
    "total": 850000000,
    "amount_received": 850000000,
    "amount_tds": 850000000,
    "amount_credited": 850000000,
    "balance": 850000000,
    "issued_on": "2026-10-06",
    "due_on": "2026-10-06",
    "days_overdue": 0,
    "ageing": "not_due",
    "notes": "string",
    "terms": "string",
    "cancelled_at": "2026-10-06T05:30:00.000Z",
    "cancel_reason": "string",
    "sent_at": "2026-10-06T05:30:00.000Z",
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "issued_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "issue": true,
      "cancel": true,
      "credit": true,
      "send": true,
      "allocate": true
    },
    "receipts": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "amount": 850000000,
        "tds_amount": 850000000,
        "gst_amount": 850000000,
        "excess_amount": 850000000,
        "mode": "string",
        "reference": "string",
        "received_on": "2026-10-06",
        "status": "string"
      }
    ],
    "credit_notes": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "total": 850000000,
        "issued_on": "2026-10-06",
        "reason": "string",
        "gst_reversed": true
      }
    ],
    "payment_links": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "string",
        "amount": 850000000,
        "amount_paid": 850000000,
        "short_url": "string",
        "expires_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "creditable": 850000000,
    "gst_reversal_until": "2026-10-06"
  },
  "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/finance/invoices/{id}/document

The invoice as PDF or print-ready HTML

From the snapshots frozen at issue (a draft prints under a DRAFT banner).

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

Parameters

idpathrequired: Id
Opaque record id.
formatquery: "pdf" | "html"

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/finance/invoices/{id}/document' \
  -H 'Authorization: Bearer pz_live_…'

Response example

"string"

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.

POST/v1/finance/invoices/{id}/issue

Issue a draft invoice

Takes the next number of the financial year’s series (gap-free) and freezes the parties and amounts. Not dated in the future or before the series’ latest invoice. Needs a fresh second factor.

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

Parameters

idpathrequired: Id
Opaque record id.
Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

issued_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
due_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.

Response · 200

datarequired: InvoiceDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/finance/invoices/{id}/issue' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"issued_on":"2026-10-06","due_on":"2026-10-06"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": "string",
    "document_type": "tax_invoice",
    "status": "draft",
    "financial_year": "string",
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "party_role": "string",
    "bill_to": {
      "legal_name": "string",
      "gstin": "string",
      "pan": "string",
      "address": "string",
      "city": "string",
      "state": "string",
      "pincode": "string",
      "email": "string",
      "phone": "string"
    },
    "place_of_supply": "string",
    "pos_basis": "string",
    "supply_regime": "intra",
    "gst_rate_bps": 0,
    "lines": [
      {
        "index": 0,
        "description": "string",
        "sac": "string",
        "side": "string",
        "taxable": 850000000,
        "cgst": 850000000,
        "sgst": 850000000,
        "igst": 850000000,
        "total": 850000000
      }
    ],
    "subtotal": 850000000,
    "cgst": 850000000,
    "sgst": 850000000,
    "igst": 850000000,
    "round_off": 850000000,
    "total": 850000000,
    "amount_received": 850000000,
    "amount_tds": 850000000,
    "amount_credited": 850000000,
    "balance": 850000000,
    "issued_on": "2026-10-06",
    "due_on": "2026-10-06",
    "days_overdue": 0,
    "ageing": "not_due",
    "notes": "string",
    "terms": "string",
    "cancelled_at": "2026-10-06T05:30:00.000Z",
    "cancel_reason": "string",
    "sent_at": "2026-10-06T05:30:00.000Z",
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "issued_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "issue": true,
      "cancel": true,
      "credit": true,
      "send": true,
      "allocate": true
    },
    "receipts": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "amount": 850000000,
        "tds_amount": 850000000,
        "gst_amount": 850000000,
        "excess_amount": 850000000,
        "mode": "string",
        "reference": "string",
        "received_on": "2026-10-06",
        "status": "string"
      }
    ],
    "credit_notes": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": "string",
        "total": 850000000,
        "issued_on": "2026-10-06",
        "reason": "string",
        "gst_reversed": true
      }
    ],
    "payment_links": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "string",
        "amount": 850000000,
        "amount_paid": 850000000,
        "short_url": "string",
        "expires_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "creditable": 850000000,
    "gst_reversal_until": "2026-10-06"
  },
  "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/finance/invoices/{id}/send

Send an invoice to the customer

Through the compliance-gated pipeline (consent, quiet hours, WhatsApp window) with a sign-in-free link to the PDF, minted at delivery; answers why when it is blocked.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

channel: "auto" | "whatsapp_cloud" | "email"

Response · 200

datarequired: object or object
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/finance/invoices/{id}/send' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"channel":"auto"}'

Response example

{
  "data": {
    "status": "queued",
    "channel": "string",
    "message_id": "cmusrceel0000q7kaafxqi1om"
  },
  "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/finance/payees

List payees

Company-wide finance viewers see every payee; others only themselves.

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

Parameters

kindquery: PayeeType
qquery: string
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of Payee
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "member",
      "ref_id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "pan_status": "valid",
      "pan_holder": "string",
      "pan": "string",
      "bank": {
        "account_name": "string",
        "account_number": "string",
        "ifsc": "string",
        "bank_name": "string",
        "upi_vpa": "string"
      },
      "gstin": "string",
      "gst_registered": true,
      "employee": true,
      "tds_exempt_reason": "string",
      "certificate": {
        "rate_bps": 0,
        "number": "string",
        "valid_from": "2026-10-06",
        "valid_to": "2026-10-06",
        "limit": 850000000
      },
      "email": "string",
      "phone": "string",
      "state": "string",
      "notes": "string",
      "kyc_visible": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_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/finance/payees

The payee of a member, partner or contact

Creates the master row on first use (name and contact details from the record).

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

Request body

kindrequired: PayeeType
ref_idrequired: Id
Opaque record id.

Response · 200

datarequired: Payee
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/finance/payees' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"member","ref_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "member",
    "ref_id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "pan_status": "valid",
    "pan_holder": "string",
    "pan": "string",
    "bank": {
      "account_name": "string",
      "account_number": "string",
      "ifsc": "string",
      "bank_name": "string",
      "upi_vpa": "string"
    },
    "gstin": "string",
    "gst_registered": true,
    "employee": true,
    "tds_exempt_reason": "string",
    "certificate": {
      "rate_bps": 0,
      "number": "string",
      "valid_from": "2026-10-06",
      "valid_to": "2026-10-06",
      "limit": 850000000
    },
    "email": "string",
    "phone": "string",
    "state": "string",
    "notes": "string",
    "kyc_visible": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_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.

PATCH/v1/finance/payees/{id}

Change a payee’s KYC, TDS facts or bank details

PAN and bank details are stored encrypted. Needs a fresh second factor.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

pan: string or null
gstin: string or null
gst_registered: boolean
employee: boolean
tds_exempt_reason: string or null
certificate: object or null
certificate.rate_bpsrequired: integer
certificate.numberrequired: string
certificate.valid_fromrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
certificate.valid_torequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
certificate.limit: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
bank: object or null
bank.account_namerequired: string
bank.account_number: string or null
bank.ifsc: string or null
bank.bank_name: string or null
bank.upi_vpa: string or null
email: string (email) or null
phone: string or null
state: "AN" | "AP" | "AR" | "AS" | "BR" | "CH" | … or null
notes: string or null

Response · 200

datarequired: Payee
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/finance/payees/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"pan":"string","gstin":"string","gst_registered":true,"employee":true,"tds_exempt_reason":"string","certificate":{"rate_bps":0,"number":"string","valid_from":"2026-10-06","valid_to":"2026-10-06","limit":0},"bank":{"account_name":"string","account_number":"string","ifsc":"string","bank_name":"string","upi_vpa":"string"},"email":"name@example.com","phone":"string","state":"AN","notes":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "member",
    "ref_id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "pan_status": "valid",
    "pan_holder": "string",
    "pan": "string",
    "bank": {
      "account_name": "string",
      "account_number": "string",
      "ifsc": "string",
      "bank_name": "string",
      "upi_vpa": "string"
    },
    "gstin": "string",
    "gst_registered": true,
    "employee": true,
    "tds_exempt_reason": "string",
    "certificate": {
      "rate_bps": 0,
      "number": "string",
      "valid_from": "2026-10-06",
      "valid_to": "2026-10-06",
      "limit": 850000000
    },
    "email": "string",
    "phone": "string",
    "state": "string",
    "notes": "string",
    "kyc_visible": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_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.
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.

PUT/v1/finance/receipts/{id}/allocation

Settle an invoice with a receipt (or unlink it)

An open invoice of the receipt’s deal, with the TDS the payer deducted; null unlinks it.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

invoice_idrequired: Id or null
Opaque record id.
tds_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.

Response · 200

datarequired: Receipt
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/finance/receipts/{id}/allocation' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"invoice_id":"cmusrceel0000q7kaafxqi1om","tds_amount":0}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": "RCPT/2026-27/0001",
    "financial_year": "2026-27",
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "invoice": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": "string"
    },
    "amount": 850000000,
    "tds_amount": 850000000,
    "gst_amount": 850000000,
    "excess_amount": 850000000,
    "purpose": "commission",
    "mode": "upi",
    "reference": "string",
    "bank": "string",
    "received_on": "2026-10-06",
    "cleared_on": "2026-10-06",
    "status": "received",
    "notes": "string",
    "attachment": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "token_receipt",
      "name": "string",
      "content_type": "string",
      "size": 0,
      "receipt_id": "cmusrceel0000q7kaafxqi1om",
      "uploaded_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "uploaded_at": "2026-10-06T05:30:00.000Z",
      "scan_status": "pending"
    },
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "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.
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/finance/receivables

Open balances per customer with ageing

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

Response · 200

datarequired: array of Receivable
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "contact": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "invoices": 0,
      "outstanding": 850000000,
      "overdue": 850000000,
      "oldest_due_on": "2026-10-06",
      "ageing": {
        "not_due": 850000000,
        "d1_30": 850000000,
        "d31_60": 850000000,
        "d61_90": 850000000,
        "d90_plus": 850000000
      }
    }
  ],
  "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.

GET/v1/finance/settings

Finance settings

GST registration and rate, SAC codes, series, terms, signatory, bank, UPI, payouts, TDS, reminders.

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

Response · 200

datarequired: FinanceSettings
metarequired: object

Request

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

Response example

{
  "data": {
    "gst": {
      "registration": "regular",
      "rate_bps": 0,
      "sac_sale": "string",
      "sac_rent": "string",
      "sac_land": "string"
    },
    "invoice": {
      "prefix": "string",
      "credit_note_prefix": "string",
      "pad": 0,
      "due_days": 0,
      "backdate_days": 0,
      "round_total": true,
      "terms": "string",
      "notes": "string",
      "signatory_name": "string",
      "signatory_designation": "string",
      "show_upi_qr": true,
      "upi_vpa": "string"
    },
    "bank": {
      "account_name": "string",
      "account_number": "string",
      "ifsc": "string",
      "bank_name": "string",
      "branch": "string"
    },
    "payouts": {
      "release_rule": "manual",
      "payee_gst_rate_bps": 0
    },
    "tds": {
      "enabled": true
    },
    "reminders": {
      "customer": true,
      "days_after_due": [
        0
      ]
    },
    "company": {
      "legal_name": "string",
      "gstin": "string",
      "pan": "string",
      "state": "string"
    },
    "can_edit": true
  },
  "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/finance/settings

Change the finance settings

Needs settings.company and a fresh second factor (the bank details are printed on every invoice).

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

Request body

gst: object
gst.registration: "regular" | "composition" | "unregistered"
gst.rate_bps: integer
gst.sac_sale: string
gst.sac_rent: string
gst.sac_land: string
invoice: object
invoice.prefix: string
invoice.credit_note_prefix: string
invoice.pad: integer
invoice.due_days: integer
invoice.backdate_days: integer or null
invoice.round_total: boolean
invoice.terms: string or null
invoice.notes: string or null
invoice.signatory_name: string or null
invoice.signatory_designation: string or null
invoice.show_upi_qr: boolean
invoice.upi_vpa: string or null
bank: object or null
bank.account_namerequired: string
bank.account_numberrequired: string
bank.ifscrequired: string
bank.bank_namerequired: string
bank.branch: string or null
payouts: object
payouts.release_rule: PayoutReleaseRule
manual: payable at once · on_receipt: as the brokerage comes in · on_closure: once the deal is won.
payouts.payee_gst_rate_bps: integer
tds: object
tds.enabled: boolean
reminders: object
reminders.customer: boolean
reminders.days_after_due: array of integer

Response · 200

datarequired: FinanceSettings
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/finance/settings' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"gst":{"registration":"regular","rate_bps":0,"sac_sale":"string","sac_rent":"string","sac_land":"string"},"invoice":{"prefix":"string","credit_note_prefix":"string","pad":3,"due_days":0,"backdate_days":0,"round_total":true,"terms":"string","notes":"string","signatory_name":"string","signatory_designation":"string","show_upi_qr":true,"upi_vpa":"string"},"bank":{"account_name":"string","account_number":"string","ifsc":"string","bank_name":"string","branch":null},"payouts":{"release_rule":"manual","payee_gst_rate_bps":0},"tds":{"enabled":true},"reminders":{"customer":true,"days_after_due":[0]}}'

Response example

{
  "data": {
    "gst": {
      "registration": "regular",
      "rate_bps": 0,
      "sac_sale": "string",
      "sac_rent": "string",
      "sac_land": "string"
    },
    "invoice": {
      "prefix": "string",
      "credit_note_prefix": "string",
      "pad": 0,
      "due_days": 0,
      "backdate_days": 0,
      "round_total": true,
      "terms": "string",
      "notes": "string",
      "signatory_name": "string",
      "signatory_designation": "string",
      "show_upi_qr": true,
      "upi_vpa": "string"
    },
    "bank": {
      "account_name": "string",
      "account_number": "string",
      "ifsc": "string",
      "bank_name": "string",
      "branch": "string"
    },
    "payouts": {
      "release_rule": "manual",
      "payee_gst_rate_bps": 0
    },
    "tds": {
      "enabled": true
    },
    "reminders": {
      "customer": true,
      "days_after_due": [
        0
      ]
    },
    "company": {
      "legal_name": "string",
      "gstin": "string",
      "pan": "string",
      "state": "string"
    },
    "can_edit": true
  },
  "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/finance/statements/customers/{id}

A customer’s statement

Invoices, receipts, TDS they deducted and credit notes with opening and closing balances.

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

Parameters

idpathrequired: Id
Opaque record id.
fromquery: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
toquery: LocalDate
Calendar date YYYY-MM-DD in the company time zone.

Response · 200

datarequired: CustomerStatement
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/finance/statements/customers/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "billing": {
      "legal_name": "string",
      "gstin": "string"
    },
    "from": "2026-10-06",
    "to": "2026-10-06",
    "opening": 850000000,
    "lines": [
      {
        "date": "2026-10-06",
        "kind": "invoice",
        "ref": "string",
        "id": "string",
        "description": "string",
        "debit": 850000000,
        "credit": 850000000,
        "balance": 850000000
      }
    ],
    "debit": 850000000,
    "credit": 850000000,
    "closing": 850000000,
    "outstanding": 850000000
  },
  "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/finance/statements/payees/{type}/{id}

A payee’s statement for a financial year

Earned, TDS, paid and due with the payouts; members read their own.

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

Parameters

typepathrequired: PayeeType
idpathrequired: Id
Opaque record id.
fyquery: string

Response · 200

datarequired: PayeeStatement
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/finance/statements/payees/{type}/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "payee": {
      "type": "member",
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "financial_year": "string",
    "summary": {
      "earned": 850000000,
      "pending": 850000000,
      "tds": 850000000,
      "paid": 850000000,
      "due": 850000000,
      "count": 0
    },
    "payouts": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "deal": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref": "string",
          "title": "string"
        },
        "payee_type": "member",
        "payee": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "gross": 850000000,
        "gst_amount": 850000000,
        "tds": 850000000,
        "net": 850000000,
        "status": "pending",
        "release_rule": "manual",
        "releasable": 850000000,
        "tds_status": "pending",
        "tds_section": "string",
        "tds_rate_bps": 0,
        "tds_reason": "string",
        "invoice_ref": "string",
        "approved_on": "2026-10-06",
        "approved_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "paid_on": "2026-10-06",
        "paid_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "payment_mode": "string",
        "payment_reference": "string",
        "hold_reason": "string",
        "cancel_reason": "string",
        "notes": "string",
        "parent_id": "cmusrceel0000q7kaafxqi1om",
        "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.
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.

POST/v1/finance/tds/deposits

Record the challan that paid TDS

Each register row once. Needs a fresh second factor.

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

Request body

entry_idsrequired: array of Id
Opaque record id.
challan_numberrequired: string
bsr_coderequired: string
deposited_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.

Response · 200

datarequired: object
data.updatedrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/finance/tds/deposits' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"entry_ids":["cmusrceel0000q7kaafxqi1om"],"challan_number":"string","bsr_code":"string","deposited_on":"2026-10-06"}'

Response example

{
  "data": {
    "updated": 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/finance/tds/entries

The TDS register

Newest first; deposited=false lists the TDS still to deposit.

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

Parameters

fyquery: string
quarterquery: "Q1" | "Q2" | "Q3" | "Q4"
payee_typequery: PayeeType
payee_idquery: Id
Opaque record id.
depositedquery: "true" | "false"
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of TdsEntry
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/finance/tds/entries' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "payout_id": "cmusrceel0000q7kaafxqi1om",
      "payee": {
        "type": "string",
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "pan_status": "string",
      "pan_last4": "string",
      "pan_holder": "string",
      "act": "string",
      "section_code": "string",
      "nature": "string",
      "rate_bps": 0,
      "amount": 850000000,
      "base": 850000000,
      "tds": 850000000,
      "reason": "string",
      "reason_label": "string",
      "event_on": "2026-10-06",
      "financial_year": "string",
      "quarter": "Q1",
      "deposit_due_on": "2026-10-06",
      "deposit": {
        "challan_number": "string",
        "bsr_code": "string",
        "deposited_on": "2026-10-06"
      },
      "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.

GET/v1/finance/tds/sections

The TDS section table

Platform rows (Income-tax Act 1961 and 2025 numbering, with sources) and the company’s overrides.

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

Response · 200

datarequired: array of TdsSection
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/finance/tds/sections' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "act": "string",
      "code": "string",
      "nature": "string",
      "description": "string",
      "rate_bps": 0,
      "threshold_fy": 850000000,
      "threshold_single": 850000000,
      "no_pan_rate_bps": 0,
      "no_pan_code": "string",
      "effective_from": "2026-10-06",
      "effective_to": "2026-10-06",
      "return_form": "string",
      "certificate_form": "string",
      "source": "string",
      "verified": true,
      "override": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "rate_bps": 0,
        "threshold_fy": 850000000,
        "no_pan_rate_bps": 0,
        "reason": "string",
        "updated_at": "2026-10-06T05:30:00.000Z"
      },
      "current": true
    }
  ],
  "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/finance/tds/sections/{id}/override

Override a TDS section for the company

Rate, yearly threshold and no-PAN rate with a reason (audited). Needs a fresh second factor.

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

Parameters

idpathrequired: string

Request body

rate_bpsrequired: integer
threshold_fyrequired: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
no_pan_rate_bpsrequired: integer
reasonrequired: string

Response · 200

datarequired: array of TdsSection
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/finance/tds/sections/{id}/override' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"rate_bps":0,"threshold_fy":0,"no_pan_rate_bps":0,"reason":"string"}'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "act": "string",
      "code": "string",
      "nature": "string",
      "description": "string",
      "rate_bps": 0,
      "threshold_fy": 850000000,
      "threshold_single": 850000000,
      "no_pan_rate_bps": 0,
      "no_pan_code": "string",
      "effective_from": "2026-10-06",
      "effective_to": "2026-10-06",
      "return_form": "string",
      "certificate_form": "string",
      "source": "string",
      "verified": true,
      "override": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "rate_bps": 0,
        "threshold_fy": 850000000,
        "no_pan_rate_bps": 0,
        "reason": "string",
        "updated_at": "2026-10-06T05:30:00.000Z"
      },
      "current": true
    }
  ],
  "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.

DELETE/v1/finance/tds/sections/{id}/override

Remove the company’s override of a TDS section

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

Parameters

idpathrequired: string

Response · 200

datarequired: array of TdsSection
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/finance/tds/sections/{id}/override' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "act": "string",
      "code": "string",
      "nature": "string",
      "description": "string",
      "rate_bps": 0,
      "threshold_fy": 850000000,
      "threshold_single": 850000000,
      "no_pan_rate_bps": 0,
      "no_pan_code": "string",
      "effective_from": "2026-10-06",
      "effective_to": "2026-10-06",
      "return_form": "string",
      "certificate_form": "string",
      "source": "string",
      "verified": true,
      "override": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "rate_bps": 0,
        "threshold_fy": 850000000,
        "no_pan_rate_bps": 0,
        "reason": "string",
        "updated_at": "2026-10-06T05:30:00.000Z"
      },
      "current": true
    }
  ],
  "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/finance/tds/summary

TDS of a quarter or financial year

Totals by section, payee and month of deduction, with the deposit and return due dates.

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

Parameters

fyqueryrequired: string
quarterquery: "Q1" | "Q2" | "Q3" | "Q4"

Response · 200

datarequired: TdsSummary
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/finance/tds/summary' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "fy": "string",
    "quarter": "Q1",
    "from": "2026-10-06",
    "to": "2026-10-06",
    "return_due_on": "2026-10-06",
    "amount": 850000000,
    "tds": 850000000,
    "deposited": 850000000,
    "payable": 850000000,
    "by_section": [
      {
        "key": "string",
        "label": "string",
        "count": 0,
        "amount": 850000000,
        "tds": 850000000,
        "deposited": 850000000
      }
    ],
    "by_payee": [
      {
        "key": "string",
        "label": "string",
        "count": 0,
        "amount": 850000000,
        "tds": 850000000,
        "deposited": 850000000
      }
    ],
    "by_month": [
      {
        "month": "string",
        "tds": 850000000,
        "deposited": 850000000,
        "deposit_due_on": "2026-10-06"
      }
    ]
  },
  "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.
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.