DealFinance

object

dealrequired: object
deal.idrequired: Id
Opaque record id.
deal.refrequired: string
deal.titlerequired: string
deal.stagerequired: string
commissionrequired: object
commission.expectedrequired: Paise or null
Money in paise (₹1 = 100), an exact integer.
commission.receivedrequired: Paise
Money in paise (₹1 = 100), an exact integer.
commission.outstandingrequired: Paise or null
Money in paise (₹1 = 100), an exact integer.
sidesrequired: array of object
sides[].siderequired: string
sides[].contact_idrequired: Id or null
Opaque record id.
sides[].contact_namerequired: string or null
sides[].expectedrequired: Paise
Money in paise (₹1 = 100), an exact integer.
sides[].invoicedrequired: Paise
Money in paise (₹1 = 100), an exact integer.
sides[].remainingrequired: Paise
Money in paise (₹1 = 100), an exact integer.
invoicesrequired: array of Invoice
credit_notesrequired: array of CreditNote
receiptsrequired: array of Receipt
payoutsrequired: array of CommissionPayout
timelinerequired: array of object
timeline[].daterequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
timeline[].kindrequired: "invoice" | "credit_note" | "receipt" | "payout"
timeline[].idrequired: Id
Opaque record id.
timeline[].refrequired: string
timeline[].titlerequired: string
timeline[].amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
timeline[].statusrequired: string
capabilitiesrequired: object
capabilities.invoicerequired: boolean
capabilities.payoutrequired: boolean

Example

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

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