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.0.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.
organization_contact_id
string
ID of the contact's organisation
item_custom_fields
array
List of custom fields associated with the line item
payment_expected_date
string
The expected date of payment
update-comment-response
object
11 properties
terms
string
The terms added below expressing gratitude or for conveying some information.
entity_id
string
Unique ID of the entity associated
contact_persons_associated
array
Contact Persons associated with the invoice.
update-an-invoice-customfield-response
object
2 properties
enable-payment-reminder-response
object
2 properties
taxes
array
List of the taxes levied
mark-as-draft-response
object
2 properties
bcc_mails
array
Bcc mail details
zip
string
Zip code of the customer's billing address.
batches
array
Batch details for the line item. Reference an existing batch using batchid . Applicable only for items with batch tracking enabled.
user_name
string
User name of the contact
item_id
string
Unique item id.
sub_total
number
The sub total of the all items
avatax_exempt_no
string
Exemption certificate number of the customer. Maximum length [25]
custom_body
string
Customized email content
approval-action-response
object
2 properties
is_sms_enabled
boolean
Used to check if SMS communication preference is enabled for the contact person at transaction level.
get-payment-reminder-mail-content-response
object
3 properties
emailtemplate_documents
array
Email templates used
serial_numbers
array
Serial numbers for the line item. Applicable only for items with serial tracking enabled.
sat_item_key_code
string
Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.
documents
string
Documents send along with invoice
date
string
invoice date. Default date format is yyyy-mm-dd.
attach_pdf
boolean
check if PDF attachment
additional_field1
string
Paypal payment method. Allowed Values: standard and adaptive
item_total
number
The total amount of the line items
cancel-write-off-response
object
2 properties
update-an-invoice-request
object
45 properties
2 required
custom_fields
array
Additional fields added to the invoice
amount_applied
number
The amount applied to a creditnote
batches-update
array
Batch details for the line item. Reference an existing batch using batchid . Applicable only for items with batch tracking enabled.
value
string
Value of the custom field like VAT Id etc.
write-off-invoice-response
object
2 properties
to_mail_ids
array
Array of email addresses of the recipients.
expense_receipt_name
string
Name of the expense receipt associated
unitkey_code
string
Add SAT Unit Key Code for your goods/services. Download the CFDI Catalogs.
create-an-invoice-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.
reason
string
Description of the attachment
bulk-print-invoices-response
object
2 properties
payment_terms
integer
Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this. Maximum length [100]
body
string
The body/content of the mail
cc_mails_str
string
Mail recepients who need to be CC'd
schedule_time
string
Schedule time for payment
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.
update-billing-address-response
object
2 properties
ach_payment_initiated
boolean
To check initiation of ACH Payment
country
string
Country of the customer's billing address.
tax_amount_withheld
number
The tax amount which has been withheld
cc_mail_ids
array
Array of email addresses of the recipients to be CC'd.
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…
file_name_without_extension
string
Name of file included
time_entry_ids
string
Unique ID's of all the time entries associated to the linked project
status
string
Search invoices by invoice status.Allowed Values: sent , draft , overdue , paid , void , unpaid , partiallypaid and viewed
payment_terms_label
string
Used to override the default payment terms label. Default value for 15 days is "Net 15 Days". Maximum length [100]
label
string
The label of the custom field.
phone
string
Phone Number of the Contact Person
void-an-invoice-response
object
2 properties
hsn_or_sac
string
Add HSN/SAC code for your goods/services
client_viewed_time
string
Time when client viewed the statement
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…
list-invoices-response
object
3 properties
adjustment_description
string
Customize the adjustment description. E.g. Rounding off.
reference_invoice_id
string
Associate the reference invoice.
quantity
number
The quantity of line item
storages-response
array
Bin/storage locations tracked for the line item. Returned for items with bin tracking enabled.
allow_partial_payments
boolean
Boolean to check if partial payments are allowed for the contact
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%)…
billing_address
object
Billing address of the contact
6 properties
create-an-invoice-request
object
43 properties
2 required
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.
expense_id
string
Unique ID of the expenses associated
name
string
The name of the line item. Maximum length [100]
tax_percentage
number
The percentage of tax levied
payment_gateways
array
Payment gateways integrated and supported
delete-a-payment-response
object
2 properties
delete-an-invoice-response
object
2 properties
can_send_in_mail
boolean
To check if attachment can be sent in email
creditnotes_number
string
The creditnotes Number
customer_name
string
The name of the customer. Maximum length [100]
gst_treatment
string
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are businessgst , businessnone , overseas , consumer .
invoice_id
string
The ID of the invoice
communication_preference
object
Preferred modes of communication for the contact person at transaction level.
3 properties
online_transaction_id
string
Unique ID of an online transaction
list-invoice-payments-response
object
3 properties
show_comment_to_clients
boolean
Boolean to check if the comment to be shown to the clients
time
string
Time of the comment
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…
line_item_id
string
The line item ID
apply-credits-request
object
2 properties
currency_id
string
The currenct id of the currency
tax_total
number
The total amount of the tax levied
reference_number
string
The reference number of the invoice
email-an-invoice-response
object
2 properties
location_id
string
Location ID
invoiced_estimate_id
string
ID of the invoice from which the invoice is created.
from_address
string
Sender's email address
get-an-invoice-attachment-response
object
2 properties
comment_id
string
The ID of the comment
send_from_org_email_id
boolean
Boolean to trigger the email from the organization's email address
shipping_charge
string
Shipping charges applied to the invoice. Maximum length [100]
is_pre_gst
boolean
Applicable for transactions that fall before july 1, 2017
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…
description
string
The description of the line items. Maximum length [2000]
mobile
string
Mobile Number of the Contact Person
has_attachment
boolean
To check if invoice has an attachment
list-invoice-templates-response
object
3 properties
get-an-invoice-response
object
3 properties
cfdi_reference_type
string
Choose CFDI Reference Type. Allowed values: returnofmerchandise , substitutionpreviouscfdi , transferofgoods , invoicegeneratedfromorder , cfdiforadvance .
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
storages
array
Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.
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…
discount_amount
number
The discount amount on the line item
bulk-export-invoices-response
object
2 properties
date_description
string
Number of days since the comment was made
notes
string
The notes added below expressing gratitude or for conveying some information.
currency_code
string
The currency code in which the invoice is created.
attachment_name
string
Name of the file attached
update-a-comment-request
object
2 properties
update-billing-address-request
object
6 properties
gateways_associated
boolean
List of Payment gateways associated
last_modified_time
string
Date of last modification of the invoice
creditnotes_invoice_id
string
The creditnotes invoice ID
add-attachment-to-an-invoice-response
object
2 properties
update-shipping-address-request
object
6 properties
storages-update
array
Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.
reject-request
object
1 property
update-invoice-template-response
object
2 properties
address
string
Billing address for the invoice
is_inclusive_tax
boolean
To check if discount is inclusive of tax
delete-an-attachment-response
object
2 properties
salesperson_id
string
ID of the salesperson linked to invoice
shipping_address
object
Shipping address of the contact
6 properties
invoice_number
string
An unique number given to the invoice. Maximum length [100]
gateways_configured
boolean
List of payment gateways configured
list-credits-applied-response
object
3 properties
commented_by
string
Individual who made a comment
credits_applied
number
The credits applied
custom_subject
string
Customized Subject line
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 invoice has to be created.
project_id
string
Unique ID of the projet associated to an invoice
email
string
contact's email id. Maximum length [100]
due_date
string
due date of the invoices. Default date format is yyyy-mm-dd.
contact_person_name
string
Name of the Contact Person
tax_treatment
string
VAT treatment for the invoice .Choose whether the contact falls under: homecountrymexico , borderregionmexico , nonmexico supported only for MX .
invoice-response
object
69 properties
is_discount_before_tax
boolean
Check if discount is exclusive of tax
comment_type
string
Type of the comment
exchange_rate
number
Exchange rate of the currency.
fax
string
Customer's fax number.
batches-response
array
Batches tracked for the line item. Returned for items with batch tracking enabled.
deprecated_placeholders_used
array
List of placeholders used in invoice
last_name
string
Last Name of the Contact Person
unit
string
Unit of the line item e.g. kgs, Nos. Maximum length [100]
delete-a-comment-response
object
2 properties
salesperson_name
string
Name of the salesperson. Maximum length [200]
created_time
string
The time of creation of the invoices
item_order
integer
The order of the line itemorder
template_name
string
Name of the invoice template used
is_whatsapp_enabled
boolean
Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.
adjustment
number
Adjustments made to the invoice.
last_reminder_sent_date
string
The date the last email was sent
create-a-comment-request
object
3 properties
cfdi_usage
string
Choose CFDI Usage. Allowed values: acquisitionofmerchandise , returndiscountbonus , generalexpense , buildings , furnitureofficeequipment , transportequipment…
payment_made
number
The amount paid
rate
number
Rate of the line item.
update-shipping-address-response
object
2 properties
bcc_mails_str
string
Bcc mails content
commented_by_id
string
Sorting by ID of the comment
email-invoices-response
object
2 properties
tax_exemption_id
string
ID of the tax exemption.
subject
string
The subject of the mail
first_name
string
First Name of the Contact Person
recurring_invoice_id
string
ID of the recurring invoice from which the invoice is created.
file_name
string
Name of the file attached
tax_id
string
ID of the tax or tax group applied to the estimate
credited_date
string
The date of credit
creditnote_id
string
The ID of creditnote
contact_persons_associated_payload
array
Contact Persons associated with the invoice.
last_payment_date
string
The last payment date of the invoice
due_days
string
Specifies the number of day in which the invoice would become overdue
payment_reminder_enabled
boolean
Boolean to check if reminders have been enabled
location_name
string
Name of the location
list-invoice-comments-and-history-response
object
3 properties
template_id
string
ID of the pdf template associated with the invoice.
custom_fields_update
array
Custom fields for an invoice.
disable-payment-reminder-response
object
2 properties
combo_type
string
Type of the composite item. Allowed values are assembly and kit .
template_type
string
The type of template type
balance
string
The unpaid amount
get-invoice-email-content-response
object
3 properties
salutation
string
Salutation of the Contact Person
invoice_url
string
Url of invoice as a link
city
string
City of the customer's billing address.
is_email_enabled
boolean
Used to check if Email communication preference is enabled for the contact person at transaction level.
price_precision
integer
The precision value on the price
is_viewed_by_client
boolean
Check if invoice is viewed by client
mark-an-invoice-as-sent-response
object
2 properties
is_combo_product
boolean
Indicates whether the line item is a composite product.
update-attachment-preference-response
object
2 properties
to_mails_str
string
Mail recepients
write_off_amount
number
The write off amount. i.e. the amount which is not expected to be returned. Like a bad debt
update-an-invoice-response
object
3 properties
customfield_id
string
Unique ID of the custom field.
delete-applied-credit-response
object
2 properties
error_list
array
Error List
total
string
The total amount to be paid
email-an-invoice-request
object
5 properties
1 required
is_org_email_id
boolean
To check if the email ID belongs to the organisation
selected
boolean
To check if invoice is selected or not
is_emailed
boolean
Boolean check to see if the mail has been sent
bcy_rate
number
base currency rate
payment_options
object
Payment options available for payment
1 property
tds_tax_id
string
ID of the TDS tax.
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…
tax_amount
number
The amount of the tax levied
reminders_sent
integer
The number of reminders sent
from_email
string
Mail sender
add-comment-response
object
2 properties
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.
apply-credits-response
object
2 properties
tax_type
string
The type of the tax
state
string
State of the customer's billing address.
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…
configured
boolean
Boolean check to see if a payment gateway has been configured
gst_no
string
15 digit GST identification number of the customer.
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 itemgroups API
Zoho Inventory items API
#invoices