Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Inventory bills API

Bills Module

Zoho Inventory bills 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 bills. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 14 operations across 11 paths, and defines 114 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.

14 operations 11 paths 114 schemas 1 DELETE2 GET9 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://www.zohoapis.com/inventory/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Zoho Inventory bills API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 1 DELETE, 2 GET, 9 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

bills 14

Bills Module

POST
/bills
Create a Bill
create_bill 1 param body → 201
GET
/bills
List all Bills.
list_bills 3 params → 200
GET
/bills/{bill_id}
Retrieve a Bill
get_bill 2 params → 200
PUT
/bills/{bill_id}
Update a Bill
update_bill 2 params body → 200
DELETE
/bills/{bill_id}
Delete a Bill.
delete_bill 2 params → 200
PUT
/bill/{bill_id}/customfields
Update custom field in existing bills
update_custom_field_in_bill 2 params body → 200
POST
/bills/{bill_id}/status/open
Mark as Open
mark_bill_as_open 2 params → 200
POST
/bills/{bill_id}/status/void
Mark as Void
mark_bill_as_void 2 params → 200
POST
/bills/{bill_id}/submit
Submit a bill for approval
submit_bill 2 params → 200
POST
/bills/{bill_id}/approve
Approve a bill
approve_bill 2 params → 200
POST
/bills/{bill_id}/approve/final
Final approval of a bill
approve_bill_final 2 params → 200
POST
/bills/{bill_id}/reject
Reject a bill
reject_bill 2 params body → 200
POST
/bills/submit
Bulk submit bills for approval
bulk_submit_bills 2 params → 200
POST
/bills/approve
Bulk approve bills
bulk_approve_bills 2 params → 200

Schemas 114

The contract defines 114 schemas that model the data the API accepts and returns. The most detailed are bill-response (42 properties), update-a-bill-request (22 properties), create-a-bill-request (20 properties), create-a-bill-response (3 properties). Each schema is shown below with its type and property counts.

vendor_credit_number
integer
item_custom_fields
array
List of custom fields associated with the line item
terms
string
Terms and conditions.
reverse_charge_tax_amount
number
Enter reverse charge amount
taxes
array
Number of taxes applied on the Purchase Order. Each tax contains: taxname and taxamount .
create-a-bill-request
object
20 properties 5 required
vendor_name
string
Name of the vendor.
zip
string
Zip code of the customer's billing address.
batches
array
Batches for the line item. Create a new batch using batchnumber or reference an existing batch using batchid . Applicable only for items with batch tracking en…
sub_total
number
Sub Total of the Bill.
approval-action-response
object
2 properties
account_id
string
Account ID of the item.
mark-as-open-response
object
2 properties
serial_numbers
array
Serial numbers for the line item. Applicable only for items with serial tracking enabled.
date
string
Date of the Bill.
paid_through_account_id
string
ID for the account through which the payment is made.
item_total
number
The total for the items.
custom_fields
array
Custom fields for a bill.
batches-update
array
Batches for the line item. Create a new batch using batchnumber or reference an existing batch using batchid . Applicable only for items with batch tracking en…
value
string
Value of the Custom Field
reverse_charge_tax_id
string
Reverse charge tax ID
currency_symbol
string
The symbol for the selected currency.
unused_credits_payable_amount
number
Unused credit payable amount.
reverse_charge_tax_percentage
number
Enter reverse charge percentage
open_purchaseorders_count
integer
Number of Purchase Orders that are associated with this Bill and open.
country
string
Name of the country of the customer's billing address.
update-a-bill-response
object
3 properties
bill_payment_id
string
Bill payment ID
mark-as-void-response
object
2 properties
status
string
Status of the Bill.
label
string
Label of the Custom Field
hsn_or_sac
string
Add HSN/SAC code for your goods/services
quantity
number
Quantity of the Item.
storages-response
array
Bin/storage locations tracked for the line item. Returned for items with bin tracking enabled.
payments
array
Payment details for the Bill.
billing_address
array
Customer's billing address. It contains - address , city , state , zip , country and fax .
bill-response
object
42 properties
retrieve-a-bill-response
object
3 properties
tax_percentage
number
Percentage of the tax applied.
name
string
Name of the line item.
bill_id
string
Unique ID generated by the server. This is used as identifier.
bill_number
string
Bill number of Purchase Order.
purchaseorder_item_id
string
Unique ID generated for a line item in the Purchase Order.
gst_treatment
string
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are businessgst , businessnone , overseas , consumer .
source_of_supply
string
Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken)
line_item_id
string
Unique ID generated by the server for each line item. This is used as an identifier.
currency_id
string
Unique ID generated by the server for the currency. This is used as an identifier.
tax_total
number
The total of the Tax.
reference_number
string
Reference number for the Bill.
location_id
string
Location ID
is_pre_gst
boolean
Applicable for transactions that fall before july 1, 2017
description
string
Description for the line item.
storages
array
Bin/storage locations allocated for the line item. Applicable only for items with bin tracking enabled.
line_items
array
The line items for a Bill.
amount
number
Amount paid for the payment.
notes
string
Notes for the Bill.
currency_code
string
Currency code.
attachment_name
string
Name of the attached file.
list-all-bills-response
object
3 properties
last_modified_time
string
Time at which the bill details were last Modified.
storages-update
array
Bin/storage locations allocated for the line item. Applicable only for items with bin tracking enabled.
due_by_days
integer
Number of days by which the Bill is due.
reject-request
object
1 property
address
string
Name of the street of the customer's billing address.
is_inclusive_tax
boolean
Indicates whether the item rates are tax inclusive or exclusive
payment_id
string
Unique ID generated by the server. This is used as identifier.
create-a-bill-response
object
3 properties
update-an-bill-customfield-response
object
2 properties
vendor_credits
array
The available Vendor Credits.
reference_id
string
Unique ID generated by the server for the reference.
due_date
string
Due date for the Bill.
vendor_credits_applied
number
Vendor credits applied to the Bill.
tax_treatment
string
VAT treatment for the bill. Choose whether the vendor falls under: homecountrymexico , borderregionmexico , nonmexico supported only for MX .
image_id
number
Unique ID generated by the server for the item image. This is used an identifier.
destination_of_supply
string
Place where the goods/services are supplied to. (If not given, organisation's home state will be taken)
exchange_rate
number
Exchange rate of the currency, with respect to the base currency.
fax
string
Fax number of the customer's billing address.
update-a-bill-request
object
22 properties 5 required
batches-response
array
Batches tracked for the line item. Returned for items with batch tracking enabled.
reverse_charge_tax_name
string
Name of the reverse charge tax
unit
string
Unit of the item.
image_type
string
The type (file format) of the image.
created_time
string
Time at which the Bill details were last created.
item_order
number
Order of the line item, starting from 0.
payment_number
string
Number of the payment.
rate
number
Item's Puchase Price.
receive_item_id
string
Unique ID generated by the server for the receive.
tax_exemption_id
string
ID of the Tax Exemption Applied
tax_exemption_code
string
Code of the Tax Exemption Applied
is_reverse_charge_applied
boolean
Applicable for transactions where you pay reverse charge
tax_id
string
Unique ID of the tax applied on the line item.
vendor_credit_id
string
Unique ID generated by server for vendor credits
vendor_credit_bill_id
string
Unique ID generated by server for vendor credit bills
location_name
string
Name of the location
balance
number
Remaining balance of the Bill.
city
string
Name of the city of the customer's billing address.
price_precision
integer
The precision level for the price's decimal point in a Bill.
purchaseorder_id
string
Unique ID generated by the server for the Purchase Order.
is_item_level_tax_calc
boolean
Checks whether item level tax is calculated or not.
delete-a-bill-response
object
2 properties
customfield_id
string
Unique identifier of the custom field
tds_tax_id
string
TDS ID of the tax or tax group applied to the line item
bcy_rate
number
Item rate in the organization's base currency.
image_name
string
Name of the image of the line item.
tax_amount
number
Amount of the tax.
is_single_bill_payment
boolean
Checks whether the payment is for single bills or multiple bills.
payment_mode
string
Mode of payment for the Bill.
account_name
string
Name of the account.
tax_type
string
Type of the tax
state
string
Name of the state of the customer's billing address.
paid_through_account_name
string
Name of the account.
gst_no
string
15 digit GST identification number of the vendor.
tax_name
string
Name of the tax.
vendor_id
string
Unique ID generated by the server for the vendor.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-inventory-bills-api-openapi.yml Raw ↑

Other APIs Zoho Inventory publishes across the network.

Zoho Inventory batches 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
Zoho Inventory items API