Zoho Inventory Invoices API
Invoices Module
Zoho Inventory 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 Invoices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes 42 operations across 33 paths, and defines 234 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.
42 operations
33 paths
234 schemas
5 DELETE11 GET19 POST7 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoho Inventory 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 42
Across 33 paths, the API surfaces 42 operations — 5 DELETE, 11 GET, 19 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.
Invoices 42
Invoices Module
POST
/invoices
Create an invoice
GET
/invoices
List invoices
PUT
/invoices/{invoice_id}
Update an invoice
GET
/invoices/{invoice_id}
Get an invoice
DELETE
/invoices/{invoice_id}
Delete an invoice
PUT
/invoice/{invoice_id}/customfields
Update custom field in existing invoices
POST
/invoices/{invoice_id}/status/sent
Mark an invoice as sent
POST
/invoices/{invoice_id}/status/void
Void an invoice
POST
/invoices/{invoice_id}/status/draft
Mark as draft
POST
/invoices/{invoice_id}/email
Email an invoice
GET
/invoices/{invoice_id}/email
Get invoice email content
POST
/invoices/email
Email invoices
GET
/invoices/{invoice_id}/paymentreminder
Get payment reminder mail content
GET
/invoices/pdf
Bulk export Invoices
GET
/invoices/print
Bulk print invoices
POST
/invoices/{invoice_id}/paymentreminder/disable
Disable payment reminder
POST
/invoices/{invoice_id}/paymentreminder/enable
Enable payment reminder
POST
/invoices/{invoice_id}/writeoff
Write off invoice
POST
/invoices/{invoice_id}/writeoff/cancel
Cancel write off
PUT
/invoices/{invoice_id}/address/billing
Update billing address
PUT
/invoices/{invoice_id}/address/shipping
Update shipping address
GET
/invoices/templates
List invoice templates
PUT
/invoices/{invoice_id}/templates/{template_id}
Update invoice template
GET
/invoices/{invoice_id}/payments
List invoice payments
GET
/invoices/{invoice_id}/creditsapplied
List credits applied
POST
/invoices/{invoice_id}/credits
Apply credits
DELETE
/invoices/{invoice_id}/payments/{invoice_payment_id}
Delete a payment
DELETE
/invoices/{invoice_id}/creditsapplied/{creditnotes_invoice_id}
Delete applied credit
GET
/invoices/{invoice_id}/attachment
Get an invoice attachment
POST
/invoices/{invoice_id}/attachment
Add attachment to an invoice
PUT
/invoices/{invoice_id}/attachment
Update attachment preference
DELETE
/invoices/{invoice_id}/attachment
Delete an attachment
GET
/invoices/{invoice_id}/comments
List invoice comments & history
POST
/invoices/{invoice_id}/comments
Add comment
PUT
/invoices/{invoice_id}/comments/{comment_id}
Update comment
DELETE
/invoices/{invoice_id}/comments/{comment_id}
Delete a comment
POST
/invoices/{invoice_id}/submit
Submit an invoice for approval
POST
/invoices/{invoice_id}/approve
Approve an invoice
POST
/invoices/{invoice_id}/approve/final
Final approval of an invoice
POST
/invoices/{invoice_id}/reject
Reject an invoice
POST
/invoices/submit
Bulk submit invoices for approval
POST
/invoices/approve
Bulk approve invoices
Schemas 234
The contract defines 234 schemas that model the data the API accepts and returns. The most detailed are invoice-response (69 properties), update-an-invoice-request (45 properties), create-an-invoice-request (43 properties), update-comment-response (11 properties). Each schema is shown below with its type and property counts.
gateways_configured
boolean
List of payment gateways configured
payment_terms
integer
Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this. Maximum length [100]
tax_total
number
The total amount of the tax levied
zip
string
Zip code of the customer's billing address.
to_mail_ids
array
Array of email addresses of the recipients.
bcc_mails
array
Bcc mail details
is_pre_gst
boolean
Applicable for transactions that fall before july 1, 2017
reference_number
string
The reference number of the invoice
payment_reminder_enabled
boolean
Boolean to check if reminders have been enabled
tax_percentage
number
The percentage of tax levied
shipping_address
object
Shipping address of the contact
6 properties
list-invoice-templates-response
object
3 properties
entity_id
string
Unique ID of the entity associated
payment_terms_label
string
Used to override the default payment terms label. Default value for 15 days is "Net 15 Days". Maximum length [100]
mark-as-draft-response
object
2 properties
add-comment-response
object
2 properties
created_time
string
The time of creation of the invoices
email-an-invoice-response
object
2 properties
commented_by_id
string
Sorting by ID of the comment
expense_id
string
Unique ID of the expenses associated
list-credits-applied-response
object
3 properties
address
string
Billing address for the invoice
attachment_name
string
Name of the file attached
emailtemplate_documents
array
Email templates used
avatax_use_code
string
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter…
due_date
string
due date of the invoices. Default date format is yyyy-mm-dd.
customer_name
string
The name of the customer. Maximum length [100]
apply-credits-response
object
2 properties
allow_partial_payments
boolean
Boolean to check if partial payments are allowed for the contact
sat_item_key_code
string
Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.
from_email
string
Mail sender
is_email_enabled
boolean
Used to check if Email communication preference is enabled for the contact person at transaction level.
approval-action-response
object
2 properties
has_attachment
boolean
To check if invoice has an attachment
adjustment
number
Adjustments made to the invoice.
shipping_charge
string
Shipping charges applied to the invoice. Maximum length [100]
shipping_address_id
string
Unique Id generated by the server for address in contacts page. To add a shipping address to invoice, send the addressid using this node. Else, the default shi…
terms
string
The terms added below expressing gratitude or for conveying some information.
invoiced_estimate_id
string
ID of the invoice from which the invoice is created.
invoice_url
string
Url of invoice as a link
update-attachment-preference-response
object
2 properties
show_comment_to_clients
boolean
Boolean to check if the comment to be shown to the clients
amount_applied
number
The amount applied to a creditnote
bcy_rate
number
base currency rate
cancel-write-off-response
object
2 properties
storages-update
array
Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.
item_total
number
The total amount of the line items
billing_address_id
string
Unique Id generated by the server for address in contacts page. To add a billing address to invoice, send the addressid using this node. Else, the default bill…
unitkey_code
string
Add SAT Unit Key Code for your goods/services. Download the CFDI Catalogs.
custom_fields
array
Additional fields added to the invoice
cc_mail_ids
array
Array of email addresses of the recipients to be CC'd.
state
string
State of the customer's billing address.
salesperson_name
string
Name of the salesperson. Maximum length [200]
client_viewed_time
string
Time when client viewed the statement
tax_amount_withheld
number
The tax amount which has been withheld
delete-a-payment-response
object
2 properties
contact_persons_associated
array
Contact Persons associated with the invoice.
reason
string
Description of the attachment
comment_type
string
Type of the comment
price_precision
integer
The precision value on the price
avatax_exempt_no
string
Exemption certificate number of the customer. Maximum length [25]
salesorder_item_id
string
Pass the unique ID(lineitemid) generated by the server for the line item in sales order for this node to associate this invoice with the sales order
attach_pdf
boolean
check if PDF attachment
is_emailed
boolean
Boolean check to see if the mail has been sent
adjustment_description
string
Customize the adjustment description. E.g. Rounding off.
balance
string
The unpaid amount
from_address
string
Sender's email address
cfdi_reference_type
string
Choose CFDI Reference Type. Allowed values: returnofmerchandise , substitutionpreviouscfdi , transferofgoods , invoicegeneratedfromorder , cfdiforadvance .
unit
string
Unit of the line item e.g. kgs, Nos. Maximum length [100]
hsn_or_sac
string
Add HSN/SAC code for your goods/services
recurring_invoice_id
string
ID of the recurring invoice from which the invoice is created.
template_id
string
ID of the pdf template associated with the invoice.
organization_contact_id
string
ID of the contact's organisation
item_custom_fields
array
List of custom fields associated with the line item
mapped_items
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
batches-response
array
Batches tracked for the line item. Returned for items with batch tracking enabled.
fax
string
Customer's fax number.
vat_treatment
string
VAT treatment for the invoice. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk . If the customer…
schedule_time
string
Schedule time for payment
communication_preference
object
Preferred modes of communication for the contact person at transaction level.
3 properties
show_on_pdf
boolean
Boolean value to check if the custom field is to be dispplayed on the pdf.
rate
number
Rate of the line item.
documents
string
Documents send along with invoice
tax_treatment
string
VAT treatment for the invoice .Choose whether the contact falls under: homecountrymexico , borderregionmexico , nonmexico supported only for MX .
configured
boolean
Boolean check to see if a payment gateway has been configured
status
string
Search invoices by invoice status.Allowed Values: sent , draft , overdue , paid , void , unpaid , partiallypaid and viewed
discount
number
Discount applied to the invoice, which can be either a percentage or a flat amount. For percentage discounts, the value should include the % symbol (e.g., 10%)…
send_from_org_email_id
boolean
Boolean to trigger the email from the organization's email address
cc_mails_str
string
Mail recepients who need to be CC'd
disable-payment-reminder-response
object
2 properties
email
string
contact's email id. Maximum length [100]
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.
storages-response
array
Bin/storage locations tracked for the line item. Returned for items with bin tracking enabled.
online_transaction_id
string
Unique ID of an online transaction
mapped_items_create
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
cfdi_usage
string
Choose CFDI Usage. Allowed values: acquisitionofmerchandise , returndiscountbonus , generalexpense , buildings , furnitureofficeequipment , transportequipment…
gst_no
string
15 digit GST identification number of the customer.
item_id
string
Unique item id.
tax_authority_id
string
ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax…
reject-request
object
1 property
sub_total
number
The sub total of the all items
create-an-invoice-request
object
43 properties
2 required
tax_amount
number
The amount of the tax levied
comment_id
string
The ID of the comment
payment_gateways
array
Payment gateways integrated and supported
last_payment_date
string
The last payment date of the invoice
list-invoices-response
object
3 properties
date
string
invoice date. Default date format is yyyy-mm-dd.
customer_id
string
ID of the customer the invoice has to be created.
list-invoice-payments-response
object
3 properties
tds_tax_id
string
ID of the TDS tax.
apply-credits-request
object
2 properties
mark-an-invoice-as-sent-response
object
2 properties
reference_invoice_id
string
Associate the reference invoice.
create-a-comment-request
object
3 properties
last_modified_time
string
Date of last modification of the invoice
exchange_rate
number
Exchange rate of the currency.
is_viewed_by_client
boolean
Check if invoice is viewed by client
currency_id
string
The currenct id of the currency
creditnotes_number
string
The creditnotes Number
item_order
integer
The order of the line itemorder
get-an-invoice-response
object
3 properties
quantity
number
The quantity of line item
deprecated_placeholders_used
array
List of placeholders used in invoice
description
string
The description of the line items. Maximum length [2000]
body
string
The body/content of the mail
custom_fields_update
array
Custom fields for an invoice.
update-a-comment-request
object
2 properties
list-invoice-comments-and-history-response
object
3 properties
total
string
The total amount to be paid
update-billing-address-request
object
6 properties
gateways_associated
boolean
List of Payment gateways associated
is_combo_product
boolean
Indicates whether the line item is a composite product.
enable-payment-reminder-response
object
2 properties
payment_made
number
The amount paid
project_id
string
Unique ID of the projet associated to an invoice
update-invoice-template-response
object
2 properties
label
string
The label of the custom field.
name
string
The name of the line item. Maximum length [100]
user_name
string
User name of the contact
create-an-invoice-response
object
3 properties
reminders_sent
integer
The number of reminders sent
customfield_id
string
Unique ID of the custom field.
update-shipping-address-request
object
6 properties
batches
array
Batch details for the line item. Reference an existing batch using batchid . Applicable only for items with batch tracking enabled.
invoice_id
string
The ID of the invoice
add-attachment-to-an-invoice-response
object
2 properties
gst_treatment
string
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are businessgst , businessnone , overseas , consumer .
mobile
string
Mobile Number of the Contact Person
email-invoices-response
object
2 properties
update-shipping-address-response
object
2 properties
salesperson_id
string
ID of the salesperson linked to invoice
file_name
string
Name of the file attached
template_name
string
Name of the invoice template used
bulk-print-invoices-response
object
2 properties
notes
string
The notes added below expressing gratitude or for conveying some information.
tax_exemption_id
string
ID of the tax exemption.
can_send_in_mail
boolean
To check if attachment can be sent in email
serial_numbers
array
Serial numbers for the line item. Applicable only for items with serial tracking enabled.
custom_subject
string
Customized Subject line
contact_persons_associated_payload
array
Contact Persons associated with the invoice.
email-an-invoice-request
object
5 properties
1 required
city
string
City of the customer's billing address.
is_discount_before_tax
boolean
Check if discount is exclusive of tax
get-an-invoice-attachment-response
object
2 properties
delete-applied-credit-response
object
2 properties
payment_options
object
Payment options available for payment
1 property
additional_field1
string
Paypal payment method. Allowed Values: standard and adaptive
time
string
Time of the comment
tax_name
string
The name of the tax
tax_id
string
ID of the tax or tax group applied to the estimate
file_name_without_extension
string
Name of file included
void-an-invoice-response
object
2 properties
get-invoice-email-content-response
object
3 properties
date_description
string
Number of days since the comment was made
location_id
string
Location ID
gateway_name
string
Name of the payment gateway associated with the invoice. E.g. paypal, stripe.Allowed Values: paypal , authorizenet , payflowpro , stripe , 2checkout and braint…
update-an-invoice-request
object
45 properties
2 required
currency_code
string
The currency code in which the invoice is created.
location_name
string
Name of the location
expense_receipt_name
string
Name of the expense receipt associated
time_entry_ids
string
Unique ID's of all the time entries associated to the linked project
line_item_id
string
The line item ID
creditnote_id
string
The ID of creditnote
update-comment-response
object
11 properties
is_sms_enabled
boolean
Used to check if SMS communication preference is enabled for the contact person at transaction level.
error_list
array
Error List
delete-a-comment-response
object
2 properties
selected
boolean
To check if invoice is selected or not
due_days
string
Specifies the number of day in which the invoice would become overdue
update-billing-address-response
object
2 properties
mapped_items_update
array
Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item.
invoice-response
object
69 properties
salutation
string
Salutation of the Contact Person
write-off-invoice-response
object
2 properties
country
string
Country of the customer's billing address.
combo_type
string
Type of the composite item. Allowed values are assembly and kit .
update-an-invoice-customfield-response
object
2 properties
phone
string
Phone Number of the Contact Person
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)
payment_expected_date
string
The expected date of payment
billing_address
object
Billing address of the contact
6 properties
last_name
string
Last Name of the Contact Person
get-payment-reminder-mail-content-response
object
3 properties
discount_type
string
Type of discount. Allowed values are entitylevel , itemlevel . For entitylevel type, discount is applied at entity level and the node discount resides outside…
taxes
array
List of the taxes levied
template_type
string
The type of template type
credits_applied
number
The credits applied
ach_payment_initiated
boolean
To check initiation of ACH Payment
last_reminder_sent_date
string
The date the last email was sent
update-an-invoice-response
object
3 properties
invoice_number
string
An unique number given to the invoice. Maximum length [100]
value
string
Value of the custom field like VAT Id etc.
tax_type
string
The type of the tax
bcc_mails_str
string
Bcc mails content
custom_body
string
Customized email content
credited_date
string
The date of credit
to_mails_str
string
Mail recepients
delete-an-attachment-response
object
2 properties
bulk-export-invoices-response
object
2 properties
subject
string
The subject of the mail
storages
array
Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.
creditnotes_invoice_id
string
The creditnotes invoice ID
is_org_email_id
boolean
To check if the email ID belongs to the organisation
write_off_amount
number
The write off amount. i.e. the amount which is not expected to be returned. Like a bad debt
commented_by
string
Individual who made a comment
first_name
string
First Name of the Contact Person
is_inclusive_tax
boolean
To check if discount is inclusive of tax
contact_person_name
string
Name of the Contact Person
batches-update
array
Batch details for the line item. Reference an existing batch using batchid . Applicable only for items with batch tracking enabled.
contact_person_email
string
Email ID of the Contact Person.
delete-an-invoice-response
object
2 properties
contact_person_id
string
Unique ID of the Contact Person
discount_amount
number
The discount amount on the line item
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 Items API
Zoho Inventory Landedcosts API
#Invoices
Where this information came from
This is an independent, third-party profile of Zoho Inventory Invoices API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.