Retainer Invoices
A retainer invoice is an advanced payment from a customer before we record any transaction with him.
Possible error codes:
Error Code | Message |
---|---|
9520 | Retainer Invoices for which payments have been recorded cannot be deleted |
9533 | Cannot modify Retainer Invoice amount, once the payment is recorded |
Attribute
sent
, draft
, overdue
, paid
, void
, unpaid
, partially_paid
and viewed
place of contact
given for the contact will be taken)Maximum length [100]
Maximum length [100]
Maximum length [2000]
paypal
, authorize_net
, payflow_pro
, stripe
, 2checkout
and braintree
Create a retainer invoice
Create a retainer invoice for your customer.
OAuth Scope : ZohoInvoice.invoices.CREATE
Arguments
Maximum length [100]
Maximum length [2000]
paypal
, authorize_net
, payflow_pro
, stripe
, 2checkout
and braintree
place of contact
given for the contact will be taken)Query Parameters
true
and false
List Retainer invoices
List all retainer invoices with pagination.
OAuth Scope : ZohoInvoice.invoices.READ
Query Parameters
customer_name
, retainer invoice_number
, date
, due_date
, total
, balance
and created_time
Status.All
, Status.Sent
, Status.Draft
, Status.OverDue
, Status.Paid
, Status.Void
, Status.Unpaid
, Status.PartiallyPaid
, Status.Viewed
and Date.PaymentExpectedDate
Update a retainer invoice
Update an existing invoice.
OAuth Scope : ZohoInvoice.invoices.UPDATE
Arguments
Maximum length [100]
Maximum length [2000]
paypal
, authorize_net
, payflow_pro
, stripe
, 2checkout
and braintree
place of contact
given for the contact will be taken)Get a retainer invoice
Get the details of a retainer invoice.
OAuth Scope : ZohoInvoice.invoices.READ
Delete a retainer invoice
Delete an existing retainer invoice. Invoices which have payment or credits note applied cannot be deleted.
OAuth Scope : ZohoInvoice.invoices.DELETE
Mark a retainer invoice as sent
Mark a draft retainer invoice as sent.
OAuth Scope : ZohoInvoice.invoices.CREATE
Update retainer invoice template
Update the pdf template associated with the retainer invoice.
OAuth Scope : ZohoInvoice.invoices.UPDATE
Void a retainer invoice
Mark an invoice status as void. Upon voiding, the payments and credits associated with the retainer invoices will be unassociated and will be under customer credits.
OAuth Scope : ZohoInvoice.invoices.CREATE
Mark as draft
Mark a voided retainer invoice as draft.
OAuth Scope : ZohoInvoice.invoices.CREATE
Email a retainer invoice
Email a retainer invoice to the customer. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content.
OAuth Scope : ZohoInvoice.invoices.CREATE
Arguments
Query Parameters
Get retainer invoice email content
Get the email content of a retainer invoice.
OAuth Scope : ZohoInvoice.invoices.READ
Update billing address
Updates the billing address for this retainer invoice alone.
OAuth Scope : ZohoInvoice.invoices.UPDATE
Arguments
List retainer invoice templates
Get all retainer invoice pdf templates.
OAuth Scope : ZohoInvoice.invoices.READ
Add attachment to a retainer invoice
Attach a file to an invoice.
OAuth Scope : ZohoInvoice.invoices.CREATE
Arguments
Get a retainer invoice attachment
Returns the file attached to the retainer invoice.
OAuth Scope : ZohoInvoice.invoices.READ
Delete an attachment
Delete the file attached to the retainer invoice.
OAuth Scope : ZohoInvoice.invoices.DELETE
Add comment
Add a comment for a retainer invoice.
OAuth Scope : ZohoInvoice.invoices.CREATE
Arguments
Maximum length [2000]
List retainer invoice comments & history
Get the complete history and comments of a retainer invoice.
OAuth Scope : ZohoInvoice.invoices.READ
Update comment
Update an existing comment of a retainer invoice.
OAuth Scope : ZohoInvoice.invoices.UPDATE
Arguments
Maximum length [2000]
Delete a comment
Delete a retainer invoice comment.
OAuth Scope : ZohoInvoice.invoices.DELETE