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.0.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.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 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), retrieve-a-payment-response (3 properties). Each schema is shown below with its type and property counts.
tax_amount_withheld
number
Amount withheld for tax.
last_four_digits
integer
Last four digits of the card.
currency_code
string
Currency code in which the payment is made.
status
string
Status of the payment. It can either be success or failure .
list-customer-payments-response
object
3 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…
label
string
Label of the custom field.
update-an-customerpayment-customfield-response
object
2 properties
create-a-payment-request
object
14 properties4 required
invoice_number
string
Unique ID (starts with INV) of an invoice.
location_name
string
Name of the location.
payment_id
string
Unique ID of the payment generated by the server. Maximum length allowed [2000]
custom_fields_update
array
Custom fields for an payments.
data_type
string
Data type of the custom field.
balance_amount
number
Unpaid amount of the invoice.
customer_id
string
Customer ID of the customer involved in the payment.
bank_charges
number
Denotes any additional bank charges.
account_id
string
ID of the cash/ bank account the payment has to be deposited.
delete-a-payment-response
object
2 properties
create-a-payment-response
object
3 properties
email
string
Email address of the customer involved in the payment.
date
string
Date on which payment is made. Date Format [yyyy-mm-dd]
customer_name
string
Name of the customer to whom the invoice is raised. Maximum length [100]
invoice_id
string
Invoice ID of the required invoice.
update-a-payment-response
object
3 properties
index
integer
Index of the custom field. It can hold any value from 1 to 10.
amount_applied
number
Amount paid for the invoice.
retrieve-a-payment-response
object
3 properties
value
string
Value of the custom field.
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…
currency_symbol
string
Customer's currency symbol.
currency_id
string
ID of the currency used in the payment
invoice_amount
number
Total amount raised for the invoice.
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
payment_mode
string
Mode through which payment is made. This can be check , cash , creditcard , banktransfer , bankremittance , autotransaction or others . Maximum length [100]
account_name
string
Name of the cash/ bank account the payment has to be deposited.
tax_account_id
string
ID of the tax account, in case of withholding tax.
unused_amount
number
Amount which is not used for invoice payment yet.
payment_form
string
Mode of Vendor Payment
description
string
Description about the payment.
update-a-payment-request
object
14 properties4 required
payment_number
string
Number for the payment.
tax_account_name
string
Name of the tax account, in case of withholding tax.
bcy_amount
string
amount
number
Amount paid in the respective payment.
payment-response
object
Payment details of the transaction
27 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
