ZUzuper

Collect Estimate Deposit

Changed on

Records a deposit collection against an estimate (back-office/manual recording — for the hosted customer-payment page, see the public Collect Deposit endpoint). If the estimate already has a linked invoice, its amount_paid/amount_due/invoice_status are updated to match. Supports paying via a stored payment method or by redeeming customer credits (payment_via: CREDIT).

put/estimate/{estimate_uid}/deposit

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/estimate/{estimate_uid}/deposit
  • Auth
    API key in header x-api-key

Path parameters

estimate_uidstring required

Request body

payment_transaction_uidstring
sourcestring
card_idstring
charge_cardboolean
payment_via'PAYMENT_METHOD' | 'CREDIT'
send_receiptboolean
receipt_emailstring

Response

200

typestring
messagestring

Example response

{
  "type": "success"
}

Changes