Retainer Invoices
A lot of businesses collect an advance payment (or retainer) for products sold or services rendered by them. This amount collected will not be an income but a liability to the company. The revenue is earned only when the product is delivered or the service is completed, if not delivered or completed the advance payment made will be returned to the customer.
Attribute
retainerinvoice_number_startswith
and retainerinvoice_number_contains
. Max-length [100]sent
, draft
, overdue
, paid
, void
, unpaid
, partially_paid
and viewed
place of contact
given for the contact will be taken)standard
and adaptive
paypal
, authorize_net
, payflow_pro
, stripe
, 2checkout
and braintree
Create a retainerinvoice
Create a retainer invoice for your customer.
OAuth Scope : ZohoBooks.invoices.CREATE
Arguments
standard
and adaptive
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 a retainer invoices
List all retainer invoices with pagination.
OAuth Scope : ZohoBooks.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 retainerinvoice
Update an existing invoice.
OAuth Scope : ZohoBooks.invoices.UPDATE
Arguments
standard
and adaptive
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 : ZohoBooks.invoices.READ
Delete a retainer invoice
Delete an existing retainer invoice. Invoices which have payment or credits note applied cannot be deleted.
OAuth Scope : ZohoBooks.invoices.DELETE
Mark a retainer invoice as sent
Mark a draft retainer invoice as sent.
OAuth Scope : ZohoBooks.invoices.CREATE
Update retainer invoice template
Update the pdf template associated with the retainer invoice.
OAuth Scope : ZohoBooks.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 : ZohoBooks.invoices.CREATE
Mark as draft
Mark a voided retainer invoice as draft.
OAuth Scope : ZohoBooks.invoices.CREATE
Submit a retainer invoice for approval
Submit a retainer invoice for approval.
OAuth Scope : ZohoBooks.invoices.CREATE
Approve a retainer invoice.
Approve a retainer invoice.
OAuth Scope : ZohoBooks.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 : ZohoBooks.invoices.CREATE
Arguments
Query Parameters
Get retainer invoice email content
Get the email content of a retainer invoice.
OAuth Scope : ZohoBooks.invoices.READ
Update billing address
Updates the billing address for this retainer invoice alone.
OAuth Scope : ZohoBooks.invoices.UPDATE
Arguments
List retainer invoice templates
Get all retainer invoice pdf templates.
OAuth Scope : ZohoBooks.invoices.READ
Add attachment to a retainer invoice
Attach a file to an invoice.
OAuth Scope : ZohoBooks.invoices.CREATE
Arguments
Get a retainer invoice attachment
Returns the file attached to the retainer invoice.
OAuth Scope : ZohoBooks.invoices.READ
Delete an attachment
Delete the file attached to the retainer invoice.
OAuth Scope : ZohoBooks.invoices.DELETE
Add comment
Add a comment for a retainer invoice.
OAuth Scope : ZohoBooks.invoices.CREATE
Arguments
List retainer invoice comments & history
Get the complete history and comments of a retainer invoice.
OAuth Scope : ZohoBooks.invoices.READ
Update comment
Update an existing comment of a retainer invoice.
OAuth Scope : ZohoBooks.invoices.UPDATE
Arguments
Delete a comment
Delete a retainer invoice comment.
OAuth Scope : ZohoBooks.invoices.DELETE