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