Receipts

Commission receipts with mode-specific references and per-financial-year numbers.

GET/v1/receipts

List commission receipts

Receipts of the deals in the caller’s scope, newest first. Sort keys: received_on, created_at, amount.

Access: API key with deals:read, or a member session. Permission deals.view.

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.
sortquery: string
Comma list of sort keys, "-" prefix for descending, e.g. -received_at.
deal_idquery: Id
Opaque record id.
statusquery: ReceiptStatus
modequery: PaymentMode
fyquery: string

Response · 200

datarequired: array of Receipt
metarequired: PageMeta

Request

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

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": {
    "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/receipts

Record a commission receipt

Needs edit rights on the deal and deal.commission in clear. The reference must fit the mode; the amount may not exceed what is still due. Updates the deal’s received commission.

Access: API key with deals:write, or a member session. Permission deals.edit.

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_idrequired: Id
Opaque record id.
invoice_id: Id or null
An open invoice of the deal it settles.
amountrequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
tds_amount: PaiseInput or null
TDS the payer deducted (with an invoice).
moderequired: PaymentMode
reference: string or null
bank: string or null
received_on: LocalDate or null
Default: today in the company time zone.
notes: string or null
attachment: ReceiptAttachmentInput or null
An upload presigned on the deal’s documents.

Response · 201

datarequired: Receipt
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/receipts' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"deal_id":"cmusrceel0000q7kaafxqi1om","invoice_id":"cmusrceel0000q7kaafxqi1om","amount":0,"tds_amount":0,"mode":"upi","reference":"string","bank":"string","received_on":"2026-10-06","notes":"string","attachment":{"key":"string","filename":"string","content_type":"string","size":1}}'

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.
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/receipts/{id}/status

Clear, bounce or cancel a receipt

Clearing needs deals.edit; a bounced cheque or a cancellation needs deals.approve.

Access: API key with deals:write, or a member session. Permission deals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

statusrequired: "cleared" | "bounced" | "cancelled"
date: LocalDate or null
Clearing date (default today).
reason: string or null

Response · 200

datarequired: Receipt
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/receipts/{id}/status' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"status":"cleared","date":"2026-10-06","reason":"string"}'

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.

{ "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": { "next_cursor": "string", "has_more": true } }

curl -X POST 'https://api.propzolo.com/v1/receipts' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"deal_id":"cmusrceel0000q7kaafxqi1om","invoice_id":"cmusrceel0000q7kaafxqi1om","amount":0,"tds_amount":0,"mode":"upi","reference":"string","bank":"string","received_on":"2026-10-06","notes":"string","attachment":{"key":"string","filename":"string","content_type":"string","size":1}}'

{ "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": {} }

curl -X POST 'https://api.propzolo.com/v1/receipts/{id}/status' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"status":"cleared","date":"2026-10-06","reason":"string"}'