Zoho Inventory retainer-invoices API
Retainer-Invoices Module
Zoho Inventory retainer-invoices API is one of 37 APIs that Zoho Inventory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include retainer-invoices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes 22 operations across 15 paths, and defines 151 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.
22 operations
15 paths
151 schemas
3 DELETE6 GET9 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoho Inventory retainer-invoices API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 22
Across 15 paths, the API surfaces 22 operations — 3 DELETE, 6 GET, 9 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
retainer-invoices 22
Retainer-Invoices Module
POST
/retainerinvoices
Create a retainerinvoice
GET
/retainerinvoices
List a retainer invoices
PUT
/retainerinvoices/{retainerinvoice_id}
update a retainerinvoice
GET
/retainerinvoices/{retainerinvoice_id}
Get a retainer invoice
DELETE
/retainerinvoices/{retainerinvoice_id}
Delete a retainer invoice
POST
/retainerinvoices/{retainerinvoice_id}/status/sent
Mark a retainer invoice as sent
PUT
/retainerinvoices/{retainerinvoice_id}/templates/{template_id}
Update retainer invoice template
POST
/retainerinvoices/{retainerinvoice_id}/status/void
Void a retainer invoice
POST
/retainerinvoices/{reatinerinvoice_id}/status/draft
Mark as draft
POST
/retainerinvoices/{reatinerinvoice_id}/submit
Submit a retainer invoice for approval
POST
/retainerinvoices/{reatinerinvoice_id}/approve
Approve a retainer invoice.
POST
/retainerinvoices/{retainerinvoice_id}/email
Email a retainer invoice
GET
/retainerinvoices/{retainerinvoice_id}/email
Get retainer invoice email content
PUT
/retainerinvoices/{retainerinvoice_id}/address/billing
Update billing address
GET
/retainerinvoices/templates
List retainer invoice templates
GET
/retainerinvoices/{retainerinvoice_id}/attachment
Get a retainer invoice attachment
POST
/retainerinvoices/{retainerinvoice_id}/attachment
Add attachment to a retainer invoice
DELETE
/retainerinvoices/{retainerinvoice_id}/documents/{document_id}
Delete an attachment
GET
/retainerinvoices/{retainerinvoice_id}/comments
List retainer invoice comments & history
POST
/retainerinvoices/{retainerinvoice_id}/comments
Add comment
DELETE
/retainerinvoices/{retainerinvoice_id}/comments/{comment_id}
Delete a comment
PUT
/retainerinvoices/{retainerinvoice_id}/comments/{comment_id}
Update comment
Schemas 151
The contract defines 151 schemas that model the data the API accepts and returns. The most detailed are retainerinvoice-response (50 properties), update-a-retainerinvoice-request (13 properties), get-retainer-invoice-email-content-response (13 properties), create-a-retainerinvoice-request (12 properties). Each schema is shown below with its type and property counts.
transaction_id
string
payment_expected_date
string
The date on which the payment is expected to be received for the retainer invoice.
update-comment-response
object
3 properties
terms
string
The terms added below expressing gratitude or for conveying some information.
contact_persons_associated
array
Contact Persons associated with the retainer invoice.
taxes
array
List of the taxes levied
mark-as-draft-response
object
2 properties
zip
string
user_name
array
page
integer
Number of pages
sub_total
number
The sub total of the all items
applied_filter
string
The filer applied for sorting
void-a-retainer-invoice-response
object
2 properties
documents
array
documents attached to the retainer invoice
date
string
The date of creation of the retainer invoice.
additional_field1
string
Paypal payment method. Allowed Values: standard and adaptive
item_total
number
The total amount of the line items
per_page
integer
Per page values
custom_fields
array
Custom fields for a retainer invoice.
approve-a-retainer-invoice-response
object
2 properties
value
string
The value of the custom field
to_mail_ids
array
Array of email address of the recipients.
currency_symbol
string
The currency symbol in which the retainer invoice is created.
create-a-retainerinvoice-response
object
3 properties
contact_person_email
string
Email ID of the Contact Person.
show_on_pdf
boolean
Boolean value to check if the custom field is to be dispplayed on the pdf.
create-a-retainerinvoice-request
object
12 properties
2 required
body
string
The body of the mail
list-retainer-invoice-comments-and-history-response
object
3 properties
retainerinvoice_number
string
number of the retainer invoice.Variants: retainerinvoicenumberstartswith and retainerinvoicenumbercontains . Max-length [100]
sort_order
string
The order for sorting
update-billing-address-response
object
2 properties
cc_mail_ids
array
Array of email address of the recipients to be cced.
country
string
created_by_id
string
status
string
retainer invoice status.Allowed Values: sent , draft , overdue , paid , void , unpaid , partiallypaid and viewed
transaction_type
string
label
string
The label of the custom field.
phone
string
Phone Number of the Contact Person
client_viewed_time
boolean
client viewed time for retainer invoice in client portal.
get-a-retainer-invoice-response
object
3 properties
allow_partial_payments
boolean
Boolean to check if partial payments are allowed for the contact
billing_address
object
7 properties
list-a-retainer-invoices-response
object
4 properties
get-a-retainer-invoice-attachment-response
object
2 properties
tax_percentage
number
The percentage of tax levied
payment_gateways
array
Online payment gateways through which payment can be made.
can_send_in_mail
boolean
Indicates whether the retainer invoice can be sent in mail
customer_name
string
The name of the customer. Max-length [100]
list-retainer-invoice-templates-response
object
3 properties
communication_preference
object
Preferred modes of communication for the contact person at transaction level.
2 properties
time
string
show_comment_to_clients
boolean
Boolean to check if the comment to be shown to the clients
retainerinvoice_id
string
ID of the retainerinvoice
line_item_id
string
The line item id
currency_id
string
The currenct id of the currency
reference_number
string
The reference number of the retainer invoice. Max-length [100]
comment_id
string
ID of the comment
location_id
string
Location ID
send_from_org_email_id
boolean
Boolean to trigger the email from the organization's email address
email_template_id
string
Get the email content based on a specific email template. If this param is not inputted, then the content will be based on the email template associated with t…
operation_type
string
gateway_name
string
Name of the payment gateway associated with the retainer invoice. E.g. paypal, stripe.Allowed Values: paypal , authorizenet , payflowpro , stripe , 2checkout a…
is_pre_gst
string
Applicable for transactions that fall before july 1, 2017
description
string
The description of the line items. Max-length [2000]
mobile
string
Mobile Number of the Contact Person
has_attachment
boolean
Boolean retainer invoice has attachment
payment_drawn
number
The amount drawn
date_description
string
project_name
string
Name of the project
notes
string
The notes added below expressing gratitude or for conveying some information.
currency_code
string
The currency code in which the retainer invoice is created.
attachment_name
string
add-comment-request
object
3 properties
update-billing-address-request
object
6 properties
last_modified_time
string
The time of last modification of the retainer invoice
address
string
is_inclusive_tax
boolean
delete-an-attachment-response
object
2 properties
update-comment-request
object
2 properties
commented_by
string
shipping_address
object
6 properties
gateways_configured
boolean
add-attachment-to-a-retainer-invoice-response
object
2 properties
email-a-retainer-invoice-response
object
2 properties
project_or_estimate_name
string
attachment
string
The file to be attached. It has to be sent in multipart/formdata
place_of_supply
string
Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)
customer_id
string
ID of the customer the retainer invoice has to be created.
street2
string
project_id
string
ID of the project
email
string
contact's email id. Maximum length [100]
has_more_page
boolean
Check if has more pages
contact_person_name
string
Name of the Contact Person
update-a-retainerinvoice-response
object
3 properties
comment_type
string
add-attachment-to-a-retainer-invoice-request
object
2 properties
submit-a-retainer-invoice-for-approval-response
object
2 properties
exchange_rate
number
Exchange rate of the currency.
update-a-retainerinvoice-request
object
13 properties
2 required
fax
string
deprecated_placeholders_used
array
get-retainer-invoice-email-content-response
object
13 properties
update-retainer-invoice-template-response
object
2 properties
page_width
string
last_name
string
Last name of the Contact Person
email-a-retainer-invoice-request
object
5 properties
1 required
delete-a-comment-response
object
2 properties
created_time
string
The time of creation of the retainer invoice
item_order
integer
The order of the line itemorder
template_name
string
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.
payment_made
number
The amount paid
rate
number
Rate of the line item.
commented_by_id
string
subject
string
The subject of the mail
first_name
string
First Name of the Contact Person
file_name
string
tax_id
string
ID of the tax or tax group applied to the estimate
contact_persons_associated_payload
array
Contact Persons associated with the retainer invoice.
last_payment_date
string
The last payment date of the retainer invoice
orientation
string
location_name
string
Name of the location.
template_id
string
ID of the pdf template associated with the retainer invoice.
template_type
string
The type of template type
balance
string
The unpaid amount
salutation
string
Salutation of the Contact Person
is_email_enabled
boolean
Used to check if Email communication preference is enabled for the contact person at transaction level.
city
string
price_precision
integer
The precision value on the price
is_viewed_by_client
boolean
Boolean is retainer invoice viewed by client in client portal.
report_name
string
The report name
customfield_id
string
Unique ID of the custom field.
error_list
array
selected
string
total
string
The total amount to be paid
mark-a-retainer-invoice-as-sent-response
object
2 properties
retainerinvoice-response
object
50 properties
sort_column
string
Sort retainer invoices.Allowed Values: customername , retainer invoicenumber , date , duedate , total , balance and createdtime
is_emailed
string
Boolean check to if the email was sent
bcy_rate
number
base currency rate
payment_options
object
Payment options for the retainer invoice, online payment gateways and bank accounts. Will be displayed in the pdf.
1 property
tax_amount
number
The amount of the tax levied
add-comment-response
object
2 properties
tax_type
string
The type of the tax
state
string
configured
boolean
Boolean check to see if a payment gateway ahs been configured
delete-a-retainer-invoice-response
object
2 properties
page_height
string
contact_person_id
string
Unique ID of the Contact Person
tax_name
string
The name of the tax
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zoho Inventory 12
Other APIs Zoho Inventory publishes across the network.
Zoho Inventory batches API
Zoho Inventory bills API
Zoho Inventory compositeitems API
Zoho Inventory contact-persons API
Zoho Inventory contacts API
Zoho Inventory credit-notes API
Zoho Inventory currency API
Zoho Inventory customer-payments API
Zoho Inventory delivery-challans API
Zoho Inventory inventoryadjustments API
Zoho Inventory invoices API
Zoho Inventory itemgroups API
#retainer-invoices