Zoho Inventory Customer Payments 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 Customer Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes
6 operations
across 3 paths,
and defines 47 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.
6 operations3 paths47 schemas1 DELETE2 GET1 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.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 Customer Payments API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are payment-response (27 properties), create-a-payment-request (14 properties), update-a-payment-request (14 properties), list-customer-payments-response (3 properties). Each schema is shown below with its type and property counts.
update-a-payment-response
object
3 properties
update-an-customerpayment-customfield-response
object
2 properties
amount_refunded
number
Amount that is refunded. Refunds are applicable only for payments whose paymentmode is autotransaction . Refunds would be made to the respective card provided…
custom_fields_update
array
Custom fields for an payments.
account_name
string
Name of the cash/ bank account the payment has to be deposited.
invoice_amount
number
Total amount raised for the invoice.
exchange_rate
number
Exchange rate for the currency used in the invoices and customer's currency. The payment amount would be the multiplicative product of the original amount and…
account_id
string
ID of the cash/ bank account the payment has to be deposited.
create-a-payment-request
object
14 properties4 required
amount_applied
number
Amount paid for the invoice.
value
string
Value of the custom field.
index
integer
Index of the custom field. It can hold any value from 1 to 10.
description
string
Description about the payment.
status
string
Status of the payment. It can either be success or failure .
payment-response
object
Payment details of the transaction
27 properties
bank_charges
number
Denotes any additional bank charges.
location_name
string
Name of the location.
customer_name
string
Name of the customer to whom the invoice is raised. Maximum length [100]
data_type
string
Data type of the custom field.
retrieve-a-payment-response
object
3 properties
amount
number
Amount paid in the respective payment.
currency_code
string
Currency code in which the payment is made.
payment_number
string
Number for the payment.
invoice_number
string
Unique ID (starts with INV) of an invoice.
customer_id
string
Customer ID of the customer involved in the payment.
last_four_digits
integer
Last four digits of the card.
currency_symbol
string
Customer's currency symbol.
invoice_id
string
Invoice ID of the required invoice.
update-a-payment-request
object
14 properties4 required
payment_mode
string
Mode through which payment is made. This can be check , cash , creditcard , banktransfer , bankremittance , autotransaction or others . Maximum length [100]
create-a-payment-response
object
3 properties
balance_amount
number
Unpaid amount of the invoice.
tax_account_name
string
Name of the tax account, in case of withholding tax.
currency_id
string
ID of the currency used in the payment
list-customer-payments-response
object
3 properties
payment_form
string
Mode of Vendor Payment
payment_id
string
Unique ID of the payment generated by the server. Maximum length allowed [2000]
unused_amount
number
Amount which is not used for invoice payment yet.
reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Maximum length of the reference number [100]
location_id
string
Location ID
tax_amount_withheld
number
Amount withheld for tax.
email
string
Email address of the customer involved in the payment.
label
string
Label of the custom field.
date
string
Date on which payment is made. Date Format [yyyy-mm-dd]
delete-a-payment-response
object
2 properties
tax_account_id
string
ID of the tax account, in case of withholding tax.
bcy_amount
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Zoho Inventory Customer Payments 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.
