Commissions

Commission payouts to members and co-brokers (records; TDS and invoices in Phase 2).

GET/v1/commission-payouts

List commission payouts

Within the caller’s commissions scope (the payee), with what is releasable now under each rule.

Access: API key or member session. Permission commissions.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: PayoutStatus
payee_idquery: string
A member id, or `me`.

Response · 200

datarequired: array of CommissionPayout
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/commission-payouts' \
  -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": {
    "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/commission-payouts

Record a payout

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

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.
payee_typerequired: PayeeType
payee_idrequired: Id
A member, partner or contact (co-broker, referrer) id.
grossrequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
release_rule: PayoutReleaseRule or null
Default: the company’s finance setting.
invoice_ref: string or null
notes: string or null

Response · 201

datarequired: CommissionPayout
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/commission-payouts' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"deal_id":"cmusrceel0000q7kaafxqi1om","payee_type":"member","payee_id":"cmusrceel0000q7kaafxqi1om","gross":0,"release_rule":"manual","invoice_ref":"string","notes":"string"}'

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.
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/commission-payouts/{id}

Edit, approve, hold or cancel a payout

Amount and release rule while pending or on hold; approved runs the payout approval policy; on hold and cancelled need a reason. Paying is POST /commission-payouts/{id}/pay. Paid and cancelled payouts are final.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

status: PayoutStatus
pending, approved (runs the payout approval policy), on_hold or cancelled — paid goes through /pay.
gross: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
release_rule: PayoutReleaseRule
manual: payable at once · on_receipt: as the brokerage comes in · on_closure: once the deal is won.
invoice_ref: string or null
notes: string or null
reason: string or null
Why it is held or cancelled.
paid_on: LocalDate or null
Refused: record payments with /pay.

Response · 200

datarequired: CommissionPayout
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/commission-payouts/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"status":"pending","gross":0,"release_rule":"manual","invoice_ref":"string","notes":"string","reason":"string","paid_on":"2026-10-06"}'

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.
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/deals/{id}/payouts

Payouts from the splits

Creates a pending payout per split member (their share of the net commission) and the co-broker; payees that already have a payout on this deal are skipped.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.createdrequired: array of CommissionPayout
data.skippedrequired: integer
metarequired: object

Request

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

Response example

{
  "data": {
    "created": [
      {
        "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"
      }
    ],
    "skipped": 0
  },
  "meta": {}
}

Errors

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

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

curl -X POST 'https://api.propzolo.com/v1/commission-payouts' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"deal_id":"cmusrceel0000q7kaafxqi1om","payee_type":"member","payee_id":"cmusrceel0000q7kaafxqi1om","gross":0,"release_rule":"manual","invoice_ref":"string","notes":"string"}'

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

curl -X PATCH 'https://api.propzolo.com/v1/commission-payouts/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"status":"pending","gross":0,"release_rule":"manual","invoice_ref":"string","notes":"string","reason":"string","paid_on":"2026-10-06"}'

{ "data": { "created": [ { "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" } ], "skipped": 0 }, "meta": {} }