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.2.0, at version 1.0.0.
Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.
The identity and technical contract details declared by the specification.
submit-a-retainer-invoice-for-approval-response
object
2 properties
sort_order
string
The order for sorting
tax_percentage
number
The percentage of tax levied
item_order
integer
The order of the line itemorder
list-retainer-invoice-comments-and-history-response
object
3 properties
get-retainer-invoice-email-content-response
object
13 properties
update-comment-request
object
2 properties
create-a-retainerinvoice-request
object
12 properties
2 required
communication_preference
object
Preferred modes of communication for the contact person at transaction level.
2 properties
customer_name
string
The name of the customer. Max-length [100]
contact_person_id
string
Unique ID of the Contact Person
configured
boolean
Boolean check to see if a payment gateway ahs been configured
first_name
string
First Name of the Contact Person
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.
project_name
string
Name of the project
project_id
string
ID of the project
rate
number
Rate of the line item.
show_comment_to_clients
boolean
Boolean to check if the comment to be shown to the clients
customer_id
string
ID of the customer the retainer invoice has to be created.
item_total
number
The total amount of the line items
update-comment-response
object
3 properties
sub_total
number
The sub total of the all items
template_type
string
The type of template type
last_name
string
Last name of the Contact Person
taxes
array
List of the taxes levied
salutation
string
Salutation of the Contact Person
label
string
The label of the custom field.
attachment
string
The file to be attached. It has to be sent in multipart/formdata
approve-a-retainer-invoice-response
object
2 properties
body
string
The body of the mail
custom_fields
array
Custom fields for a retainer invoice.
list-retainer-invoice-templates-response
object
3 properties
balance
string
The unpaid amount
exchange_rate
number
Exchange rate of the currency.
add-attachment-to-a-retainer-invoice-request
object
2 properties
billing_address
object
7 properties
payment_expected_date
string
The date on which the payment is expected to be received for the retainer invoice.
description
string
The description of the line items. Max-length [2000]
add-attachment-to-a-retainer-invoice-response
object
2 properties
status
string
retainer invoice status.Allowed Values: sent , draft , overdue , paid , void , unpaid , partiallypaid and viewed
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…
location_name
string
Name of the location.
update-a-retainerinvoice-response
object
3 properties
send_from_org_email_id
boolean
Boolean to trigger the email from the organization's email address
delete-a-retainer-invoice-response
object
2 properties
template_id
string
ID of the pdf template associated with the retainer invoice.
has_attachment
boolean
Boolean retainer invoice has attachment
terms
string
The terms added below expressing gratitude or for conveying some information.
retainerinvoice-response
object
50 properties
mark-a-retainer-invoice-as-sent-response
object
2 properties
payment_drawn
number
The amount drawn
reference_number
string
The reference number of the retainer invoice. Max-length [100]
is_emailed
string
Boolean check to if the email was sent
can_send_in_mail
boolean
Indicates whether the retainer invoice can be sent in mail
report_name
string
The report name
total
string
The total amount to be paid
is_pre_gst
string
Applicable for transactions that fall before july 1, 2017
delete-an-attachment-response
object
2 properties
email-a-retainer-invoice-request
object
5 properties
1 required
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)
create-a-retainerinvoice-response
object
3 properties
tax_name
string
The name of the tax
last_payment_date
string
The last payment date of the retainer invoice
documents
array
documents attached to the retainer invoice
client_viewed_time
boolean
client viewed time for retainer invoice in client portal.
delete-a-comment-response
object
2 properties
notes
string
The notes added below expressing gratitude or for conveying some information.
mark-as-draft-response
object
2 properties
update-billing-address-request
object
6 properties
update-retainer-invoice-template-response
object
2 properties
update-a-retainerinvoice-request
object
13 properties
2 required
applied_filter
string
The filer applied for sorting
additional_field1
string
Paypal payment method. Allowed Values: standard and adaptive
gateways_configured
boolean
retainerinvoice_id
string
ID of the retainerinvoice
tax_type
string
The type of the tax
comment_id
string
ID of the comment
get-a-retainer-invoice-response
object
3 properties
shipping_address
object
6 properties
payment_options
object
Payment options for the retainer invoice, online payment gateways and bank accounts. Will be displayed in the pdf.
1 property
created_time
string
The time of creation of the retainer invoice
update-billing-address-response
object
2 properties
currency_code
string
The currency code in which the retainer invoice is created.
allow_partial_payments
boolean
Boolean to check if partial payments are allowed for the contact
bcy_rate
number
base currency rate
line_item_id
string
The line item id
is_viewed_by_client
boolean
Boolean is retainer invoice viewed by client in client portal.
contact_person_email
string
Email ID of the Contact Person.
add-comment-response
object
2 properties
payment_made
number
The amount paid
price_precision
integer
The precision value on the price
location_id
string
Location ID
payment_gateways
array
Online payment gateways through which payment can be made.
sort_column
string
Sort retainer invoices.Allowed Values: customername , retainer invoicenumber , date , duedate , total , balance and createdtime
tax_id
string
ID of the tax or tax group applied to the estimate
get-a-retainer-invoice-attachment-response
object
2 properties
contact_person_name
string
Name of the Contact Person
cc_mail_ids
array
Array of email address of the recipients to be cced.
tax_amount
number
The amount of the tax levied
deprecated_placeholders_used
array
project_or_estimate_name
string
value
string
The value of the custom field
last_modified_time
string
The time of last modification of the retainer invoice
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…
to_mail_ids
array
Array of email address of the recipients.
contact_persons_associated_payload
array
Contact Persons associated with the retainer invoice.
retainerinvoice_number
string
number of the retainer invoice.Variants: retainerinvoicenumberstartswith and retainerinvoicenumbercontains . Max-length [100]
contact_persons_associated
array
Contact Persons associated with the retainer invoice.
currency_symbol
string
The currency symbol in which the retainer invoice is created.
add-comment-request
object
3 properties
void-a-retainer-invoice-response
object
2 properties
email-a-retainer-invoice-response
object
2 properties
currency_id
string
The currenct id of the currency
phone
string
Phone Number of the Contact Person
page
integer
Number of pages
mobile
string
Mobile Number of the Contact Person
has_more_page
boolean
Check if has more pages
customfield_id
string
Unique ID of the custom field.
subject
string
The subject of the mail
per_page
integer
Per page values
email
string
contact's email id. Maximum length [100]
is_email_enabled
boolean
Used to check if Email communication preference is enabled for the contact person at transaction level.
date
string
The date of creation of the retainer invoice.
list-a-retainer-invoices-response
object
4 properties
show_on_pdf
boolean
Boolean value to check if the custom field is to be dispplayed on the pdf.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Zoho Inventory publishes across the network.
