Customer Payments
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Payments from Customers towards Invoices.
Download Customer Payments OpenAPI Document
End Points
Create a payment
Update a payment using a custom field's unique value
List Customer Payments
Bulk delete Customer payments
Update a payment
Retrieve a payment
Delete a payment
Refund an excess customer payment
List refunds of a customer payment
Update custom field in existing customerpayments
Update a refund
Details of a refund
Delete a Refund
Attribute
payment_id
string
Unique ID of the payment generated by the server. Max-length [2000]. Note: This value is a set of numeric characters.
payment_mode
string
Mode through which payment is made. This can be
check, cash, creditcard, banktransfer, bankremittance, autotransaction or others. Max-length [100] amount
double
Amount paid in the respective payment.
amount_refunded
double
Amount that is refund. Refunds are applicable only for payments whose payment_mode is
autotransaction. Refunds would be made to the respective card provided by the customer. bank_charges
double
Denotes any additional bank charges.
date
string
Date on which payment is made. Format [yyyy-mm-dd]
status
string
Status of the payment. It can either be
success or failure. reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-length [100]
description
string
Description about the payment.
customer_id
string
Customer ID of the customer involved in the payment. Note: This value is a set of numeric characters.
customer_name
string
Name of the customer to whom the invoice is raised. Max-length [100]
email
string
Email address of the customer involved in the payment.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
Tag's ID. Note: This value is a set of numeric characters.
tag_name
string
Tag's Name
tag_option_id
string
Tag Option's ID. Note: This value is a set of numeric characters.
tag_option_name
string
Tag Option's Name
is_tag_mandatory
boolean
Used to check if the tag is mandatory
invoices
array
List of invoices associated with the payment. Each invoice object contains
invoice_id, invoice_number, date, invoice_amount, amount_applied and balance_amount. invoice_id
string
Invoice ID of the required invoice. Note: This value is a set of numeric characters.
invoice_number
string
Unique ID (starts with INV) of an invoice.
date
Date on which the invoice was raised.
invoice_amount
double
Total amount raised for the invoice.
amount_applied
double
Amount paid for the invoice.
balance_amount
double
Unpaid amount of the invoice.
tax_amount_withheld
double
Amount withheld for tax.
currency_code
string
Currency code in which the payment is made.
currency_symbol
string
Customer's currency symbol.
location_id
string
Location ID. Note: This value is a set of numeric characters.
location_name
string
Name of the location.
custom_fields
array
Additional fields for the payments.
index
integer
Index of the custom field. It can hold any value from 1 to 10.
value
string
Value of the custom field.
label
string
Label of the custom field.
data_type
string
Data type of the custom field.
{
"payment_id": "9030000079467",
"payment_mode": "cash",
"amount": 450,
"amount_refunded": 50,
"bank_charges": 10,
"date": "2016-06-05",
"status": "success",
"reference_number": "INV-384",
"description": "Payment has been added to INV-384",
"customer_id": "903000000000099",
"customer_name": "Bowman Furniture",
"email": "benjamin.george@bowmanfurniture.com",
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
],
"invoices": [
{
"invoice_id": "90300000079426",
"invoice_number": "INV-384",
"date": "2016-06-05",
"invoice_amount": 450,
"amount_applied": 450,
"balance_amount": 0,
"tax_amount_withheld": 0
}
],
"currency_code": "USD",
"currency_symbol": "$",
"location_id": "460000000038080",
"location_name": "string",
"custom_fields": [
{
"index": 1,
"value": 129890,
"label": "label",
"data_type": "text"
}
]
}
Create a payment
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Create a new payment.
OAuth Scope : ZohoBooks.customerpayments.CREATE
Arguments
customer_id
string
(Required)
Customer ID of the customer involved in the payment. Note: This value is a set of numeric characters.
payment_mode
string
(Required)
Mode through which payment is made. This can be
check, cash, creditcard, banktransfer, bankremittance, autotransaction or others. Max-length [100] amount
double
(Required)
Amount paid in the respective payment.
date
string
(Required)
Date on which payment is made. Format [yyyy-mm-dd]
reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-length [100]
description
string
Description about the payment.
invoices
array
(Required)
List of invoices associated with the payment. Each invoice object contains
invoice_id, invoice_number, date, invoice_amount, amount_applied and balance_amount. invoice_id
string
(Required)
Invoice ID of the required invoice. Note: This value is a set of numeric characters.
amount_applied
double
(Required)
Amount paid for the invoice.
tax_amount_withheld
double
Amount withheld for tax.
exchange_rate
double
, default is 1
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 the exchange rate.
payment_form
string
🇲🇽
Mexico
only
Mode of Vendor Payment
bank_charges
double
Denotes any additional bank charges.
custom_fields
array
Additional fields for the payments.
label
string
Label of the custom field.
value
string
Value of the custom field.
location_id
string
Location ID. Note: This value is a set of numeric characters.
invoice_id
string
(Required)
Invoice ID of the required invoice. Note: This value is a set of numeric characters.
amount_applied
double
(Required)
Amount paid for the invoice.
account_id
string
ID of the cash/bank account the payment has to be deposited. Note: This value is a set of numeric characters.
contact_persons
array
IDs of the contact personsthe thank you mail has to be triggered.
retainerinvoice_id
string
ID of the retainer invoice associated with the payment. Note: This value is a set of numeric characters.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
Tag's ID. Note: This value is a set of numeric characters.
tag_option_id
string
Tag Option's ID. Note: This value is a set of numeric characters.
Query Parameters
organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695")
.post(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/books/v3/customerpayments?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/books/v3/customerpayments?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request POST \
--url 'https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"customer_id": "903000000000099",
"payment_mode": "cash",
"amount": 450,
"date": "2016-06-05",
"reference_number": "INV-384",
"description": "Payment has been added to INV-384",
"invoices": [
{
"invoice_id": "90300000079426",
"amount_applied": 450,
"tax_amount_withheld": 0
}
],
"exchange_rate": 1,
"payment_form": "cash",
"bank_charges": 10,
"custom_fields": [
{
"label": "label",
"value": 129890
}
],
"location_id": "460000000038080",
"invoice_id": "90300000079426",
"amount_applied": 450,
"account_id": " ",
"contact_persons": [
"982000000870911",
"982000000870915"
],
"retainerinvoice_id": "982000000567114",
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
]
}
{
"code": 0,
"message": "The payment has been created.",
"payment": {
"payment_id": "9030000079467",
"payment_mode": "cash",
"amount": 450,
"amount_refunded": 50,
"bank_charges": 10,
"date": "2016-06-05",
"status": "success",
"reference_number": "INV-384",
"description": "Payment has been added to INV-384",
"customer_id": "903000000000099",
"customer_name": "Bowman Furniture",
"email": "benjamin.george@bowmanfurniture.com",
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
],
"invoices": [
{
"invoice_id": "90300000079426",
"invoice_number": "INV-384",
"date": "2016-06-05",
"invoice_amount": 450,
"amount_applied": 450,
"balance_amount": 0,
"tax_amount_withheld": 0
}
],
"currency_code": "USD",
"currency_symbol": "$",
"location_id": "460000000038080",
"location_name": "string",
"custom_fields": [
{
"index": 1,
"value": 129890,
"label": "label",
"data_type": "text"
}
]
}
}
Update a payment using a custom field's unique value
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a payment by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header. Based on this value, the corresponding payment will be retrieved and updated. Additionally, there is an optional X-Upsert header. If the X-Upsert header is true and the custom field's unique value is not found in any of the existing payments, a new payment will be created if the necessary payload details are available
OAuth Scope : ZohoBooks.customerpayments.UPDATE
Arguments
customer_id
string
(Required)
Customer ID of the customer involved in the payment. Note: This value is a set of numeric characters.
payment_mode
string
(Required)
Mode through which payment is made. This can be
check, cash, creditcard, banktransfer, bankremittance, autotransaction or others. Max-length [100] amount
double
(Required)
Amount paid in the respective payment.
date
string
Date on which payment is made. Format [yyyy-mm-dd]
reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-length [100]
description
string
Description about the payment.
invoices
array
(Required)
List of invoices associated with the payment. Each invoice object contains
invoice_id, invoice_number, date, invoice_amount, amount_applied and balance_amount. invoice_id
string
(Required)
Invoice ID of the required invoice. Note: This value is a set of numeric characters.
amount_applied
double
(Required)
Amount paid for the invoice.
tax_amount_withheld
double
Amount withheld for tax.
exchange_rate
double
, default is 1
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 the exchange rate.
payment_form
string
🇲🇽
Mexico
only
Mode of Vendor Payment
bank_charges
double
Denotes any additional bank charges.
custom_fields
array
Additional fields for the payments.
label
string
Label of the custom field.
value
string
Value of the custom field.
invoice_id
string
(Required)
Invoice ID of the required invoice. Note: This value is a set of numeric characters.
amount_applied
double
(Required)
Amount paid for the invoice.
tax_amount_withheld
double
Amount withheld for tax.
location_id
string
Location ID. Note: This value is a set of numeric characters.
account_id
string
ID of the cash/bank account the payment has to be deposited. Note: This value is a set of numeric characters.
retainerinvoice_id
string
ID of the retainer invoice associated with the payment. Note: This value is a set of numeric characters.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
Tag's ID. Note: This value is a set of numeric characters.
tag_option_id
string
Tag Option's ID. Note: This value is a set of numeric characters.
Query Parameters
organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
Headers
X-Unique-Identifier-Key
string
(Required)
Unique CustomField Api Name
X-Unique-Identifier-Value
string
(Required)
Unique CustomField Value
X-Upsert
boolean
If there is no record is found unique custom field value , will create new invoice
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("X-Unique-Identifier-Key", "cf_unique_cf");
headers_data.put("X-Unique-Identifier-Value", "unique Value");
headers_data.put("X-Upsert", "true");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695")
.put(body)
.addHeader("X-Unique-Identifier-Key", "cf_unique_cf")
.addHeader("X-Unique-Identifier-Value", "unique Value")
.addHeader("X-Upsert", "true")
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'PUT',
headers: {
'X-Unique-Identifier-Key': 'cf_unique_cf',
'X-Unique-Identifier-Value': 'unique Value',
'X-Upsert': 'true',
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'X-Unique-Identifier-Key': "cf_unique_cf",
'X-Unique-Identifier-Value': "unique Value",
'X-Upsert': "true",
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PUT", "/books/v3/customerpayments?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "PUT",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/books/v3/customerpayments?organization_id=10234695",
"headers": {
"X-Unique-Identifier-Key": "cf_unique_cf",
"X-Unique-Identifier-Value": "unique Value",
"X-Upsert": "true",
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request PUT \
--url 'https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'X-Unique-Identifier-Key: cf_unique_cf' \
--header 'X-Unique-Identifier-Value: unique Value' \
--header 'X-Upsert: true' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"customer_id": "903000000000099",
"payment_mode": "cash",
"amount": 450,
"date": "2016-06-05",
"reference_number": "INV-384",
"description": "Payment has been added to INV-384",
"invoices": [
{
"invoice_id": "90300000079426",
"amount_applied": 450,
"tax_amount_withheld": 0
}
],
"exchange_rate": 1,
"payment_form": "cash",
"bank_charges": 10,
"custom_fields": [
{
"label": "label",
"value": 129890
}
],
"invoice_id": "90300000079426",
"amount_applied": 450,
"tax_amount_withheld": 0,
"location_id": "460000000038080",
"account_id": " ",
"retainerinvoice_id": "982000000567114",
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
]
}
{
"code": 0,
"message": "The payment details have been updated.",
"payment": {
"payment_id": "9030000079467",
"payment_mode": "cash",
"amount": 450,
"amount_refunded": 50,
"bank_charges": 10,
"date": "2016-06-05",
"status": "success",
"reference_number": "INV-384",
"description": "Payment has been added to INV-384",
"customer_id": "903000000000099",
"customer_name": "Bowman Furniture",
"email": "benjamin.george@bowmanfurniture.com",
"invoices": [
{
"invoice_id": "90300000079426",
"invoice_number": "INV-384",
"date": "2016-06-05",
"invoice_amount": 450,
"amount_applied": 450,
"balance_amount": 0,
"tax_amount_withheld": 0
}
],
"currency_code": "USD",
"currency_symbol": "$",
"location_id": "460000000038080",
"location_name": "string",
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
],
"custom_fields": [
{
"index": 1,
"value": 129890,
"label": "label",
"data_type": "text"
}
]
}
}
List Customer Payments
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
List all the payments made by your customer.
OAuth Scope : ZohoBooks.customerpayments.READ
Query Parameters
organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
customer_name
string
Search payments by customer name. Variants:
customer_name_startswith and customer_name_contains. Max-len [100] reference_number
string
Search payments by reference number. Variants:
reference_number_startswith and reference_number_contains. Max-len [100] date
string
Search payments by payment date.
amount
double
Search payments by payment amount. Variants:
amount_less_than, amount_less_equals, amount_greater_than and amount_greater_equals notes
string
Search payments by customer notes. Variants:
notes_startswith and notes_contains payment_mode
string
Search payments by payment mode. Variants:
payment_mode_startswith and payment_mode_contains filter_by
string
Filter payments by mode.Allowed Values:
PaymentMode.All, PaymentMode.Check, PaymentMode.Cash, PaymentMode.BankTransfer, PaymentMode.Paypal, PaymentMode.CreditCard, PaymentMode.GoogleCheckout, PaymentMode.Credit, PaymentMode.Authorizenet, PaymentMode.BankRemittance, PaymentMode.Payflowpro, PaymentMode.Stripe, PaymentMode.TwoCheckout, PaymentMode.Braintree and PaymentMode.Others sort_column
string
Sort the list of payments by the specified column.
search_text
string
Search payments by reference number or customer name or payment description. Max-length [100]
customer_id
string
Customer ID of the customer involved in the payment. Note: This value is a set of numeric characters.
page
integer
Page number to be fetched. Default value is 1.
per_page
integer
Number of records to be fetched per page.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/books/v3/customerpayments?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/books/v3/customerpayments?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"customer_payments": [
{
"payment_id": "9030000079467",
"payment_number": "2",
"invoice_number": "INV-384",
"date": "2016-06-05",
"payment_mode": "cash",
"amount": 450,
"bcy_amount": 450,
"location_id": "460000000038080",
"location_name": "string",
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
]
},
{...},
{...}
],
"page_context": null
}
Bulk delete Customer payments
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Delete multiple customer payments.
OAuth Scope : ZohoBooks.customerpayments.DELETE
Query Parameters
organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
payment_ids
string
(Required)
Comma-separated list of payment IDs to be deleted. Note: This value is a set of numeric characters separated by comma.
bulk_delete
boolean
(Required)
Flag to indicate bulk delete operation
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695&payment_ids=9030000079467,9030000079468,9030000079469&bulk_delete=true"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695&payment_ids=9030000079467%2C9030000079468%2C9030000079469&bulk_delete=true")
.delete(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'DELETE',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695&payment_ids=9030000079467%2C9030000079468%2C9030000079469&bulk_delete=true', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("DELETE", "/books/v3/customerpayments?organization_id=10234695&payment_ids=9030000079467%2C9030000079468%2C9030000079469&bulk_delete=true", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/books/v3/customerpayments?organization_id=10234695&payment_ids=9030000079467%2C9030000079468%2C9030000079469&bulk_delete=true",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request DELETE \
--url 'https://www.zohoapis.com/books/v3/customerpayments?organization_id=10234695&payment_ids=9030000079467%2C9030000079468%2C9030000079469&bulk_delete=true' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The selected customer payments have been deleted."
}
Update a payment
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Update an existing payment information.
OAuth Scope : ZohoBooks.customerpayments.UPDATE
Arguments
customer_id
string
(Required)
Customer ID of the customer involved in the payment. Note: This value is a set of numeric characters.
payment_mode
string
(Required)
Mode through which payment is made. This can be
check, cash, creditcard, banktransfer, bankremittance, autotransaction or others. Max-length [100] amount
double
(Required)
Amount paid in the respective payment.
date
string
Date on which payment is made. Format [yyyy-mm-dd]
reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-length [100]
description
string
Description about the payment.
invoices
array
(Required)
List of invoices associated with the payment. Each invoice object contains
invoice_id, invoice_number, date, invoice_amount, amount_applied and balance_amount. invoice_id
string
(Required)
Invoice ID of the required invoice. Note: This value is a set of numeric characters.
amount_applied
double
(Required)
Amount paid for the invoice.
tax_amount_withheld
double
Amount withheld for tax.
exchange_rate
double
, default is 1
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 the exchange rate.
payment_form
string
🇲🇽
Mexico
only
Mode of Vendor Payment
bank_charges
double
Denotes any additional bank charges.
custom_fields
array
Additional fields for the payments.
label
string
Label of the custom field.
value
string
Value of the custom field.
invoice_id
string
(Required)
Invoice ID of the required invoice. Note: This value is a set of numeric characters.
amount_applied
double
(Required)
Amount paid for the invoice.
tax_amount_withheld
double
Amount withheld for tax.
location_id
string
Location ID. Note: This value is a set of numeric characters.
account_id
string
ID of the cash/bank account the payment has to be deposited. Note: This value is a set of numeric characters.
retainerinvoice_id
string
ID of the retainer invoice associated with the payment. Note: This value is a set of numeric characters.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
Tag's ID. Note: This value is a set of numeric characters.
tag_option_id
string
Tag Option's ID. Note: This value is a set of numeric characters.
Path Parameters
payment_id
string
(Required)
Unique identifier of the payment. Note: This value is a set of numeric characters.
Query Parameters
organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/customerpayments/9030000079467?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.com/books/v3/customerpayments/9030000079467?organization_id=10234695")
.put(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'PUT',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.com/books/v3/customerpayments/9030000079467?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PUT", "/books/v3/customerpayments/9030000079467?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "PUT",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/books/v3/customerpayments/9030000079467?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request PUT \
--url 'https://www.zohoapis.com/books/v3/customerpayments/9030000079467?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"customer_id": "903000000000099",
"payment_mode": "cash",
"amount": 450,
"date": "2016-06-05",
"reference_number": "INV-384",
"description": "Payment has been added to INV-384",
"invoices": [
{
"invoice_id": "90300000079426",
"amount_applied": 450,
"tax_amount_withheld": 0
}
],
"exchange_rate": 1,
"payment_form": "cash",
"bank_charges": 10,
"custom_fields": [
{
"label": "label",
"value": 129890
}
],
"invoice_id": "90300000079426",
"amount_applied": 450,
"tax_amount_withheld": 0,
"location_id": "460000000038080",
"account_id": " ",
"retainerinvoice_id": "982000000567114",
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
]
}
{
"code": 0,
"message": "The payment details have been updated.",
"payment": {
"payment_id": "9030000079467",
"payment_mode": "cash",
"amount": 450,
"amount_refunded": 50,
"bank_charges": 10,
"date": "2016-06-05",
"status": "success",
"reference_number": "INV-384",
"description": "Payment has been added to INV-384",
"customer_id": "903000000000099",
"customer_name": "Bowman Furniture",
"email": "benjamin.george@bowmanfurniture.com",
"invoices": [
{
"invoice_id": "90300000079426",
"invoice_number": "INV-384",
"date": "2016-06-05",
"invoice_amount": 450,
"amount_applied": 450,
"balance_amount": 0,
"tax_amount_withheld": 0
}
],
"currency_code": "USD",
"currency_symbol": "$",
"location_id": "460000000038080",
"location_name": "string",
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
],
"custom_fields": [
{
"index": 1,
"value": 129890,
"label": "label",
"data_type": "text"
}
]
}
}
Retrieve a payment
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Details of an existing payment.
OAuth Scope : ZohoBooks.customerpayments.READ
Path Parameters
payment_id
string
(Required)
Unique identifier of the payment. Note: This value is a set of numeric characters.
Query Parameters
organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
accept
string
Format of the response. Allowed values are
json and pdf. Default is json.headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/customerpayments/9030000079467?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.com/books/v3/customerpayments/9030000079467?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.com/books/v3/customerpayments/9030000079467?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/books/v3/customerpayments/9030000079467?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/books/v3/customerpayments/9030000079467?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.com/books/v3/customerpayments/9030000079467?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"payment": {
"payment_id": "9030000079467",
"payment_mode": "cash",
"amount": 450,
"amount_refunded": 50,
"bank_charges": 10,
"date": "2016-06-05",
"status": "success",
"reference_number": "INV-384",
"description": "Payment has been added to INV-384",
"customer_id": "903000000000099",
"customer_name": "Bowman Furniture",
"email": "benjamin.george@bowmanfurniture.com",
"invoices": [
{
"invoice_id": "90300000079426",
"invoice_number": "INV-384",
"date": "2016-06-05",
"invoice_amount": 450,
"amount_applied": 450,
"balance_amount": 0,
"tax_amount_withheld": 0
}
],
"currency_code": "USD",
"currency_symbol": "$",
"location_id": "460000000038080",
"location_name": "string",
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
],
"custom_fields": [
{
"index": 1,
"value": 129890,
"label": "label",
"data_type": "text"
}
]
}
}
Delete a payment
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Delete an existing payment.
OAuth Scope : ZohoBooks.customerpayments.DELETE
Path Parameters
payment_id
string
(Required)
Unique identifier of the payment. Note: This value is a set of numeric characters.
Query Parameters
organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/customerpayments/9030000079467?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.com/books/v3/customerpayments/9030000079467?organization_id=10234695")
.delete(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'DELETE',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.com/books/v3/customerpayments/9030000079467?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("DELETE", "/books/v3/customerpayments/9030000079467?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/books/v3/customerpayments/9030000079467?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request DELETE \
--url 'https://www.zohoapis.com/books/v3/customerpayments/9030000079467?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The payment has been deleted."
}
Refund an excess customer payment
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Refund the excess amount paid by the customer.
OAuth Scope : ZohoBooks.customerpayments.CREATE
Arguments
date
string
(Required)
Date on which payment is made. Format [yyyy-mm-dd]
refund_mode
string
The method of refund. Max-length [50]
reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-length [100]
amount
double
(Required)
Amount paid in the respective payment.
exchange_rate
double
, default is 1
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 the exchange rate.
payment_form
string
🇲🇽
Mexico
only
Mode of Vendor Payment
from_account_id
string
(Required)
The account from which payment is refunded. Note: This value is a set of numeric characters.
description
string
Description about the payment.
Path Parameters
customer_payment_id
string
(Required)
Unique identifier of the customer payment. Note: This value is a set of numeric characters.
Query Parameters
organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds?organization_id=10234695")
.post(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/books/v3/customerpayments/9030000079467/refunds?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/books/v3/customerpayments/9030000079467/refunds?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request POST \
--url 'https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"date": "2016-06-05",
"refund_mode": "cash",
"reference_number": "INV-384",
"amount": 450,
"exchange_rate": 1,
"payment_form": "cash",
"from_account_id": " ",
"description": "Payment has been added to INV-384"
}
{
"code": 0,
"message": "The refund information for this payment has been saved.",
"payment_refunds": [
{
"payment_refund_id": "3000000003017",
"payment_id": "9030000079467",
"date": "2016-06-05",
"refund_mode": "cash",
"reference_number": "INV-384",
"amount": 450,
"exchange_rate": 1,
"payment_form": "cash",
"description": "Payment has been added to INV-384"
},
{...},
{...}
]
}
List refunds of a customer payment
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
List all the refunds pertaining to an existing customer payment.
OAuth Scope : ZohoBooks.customerpayments.READ
Path Parameters
customer_payment_id
string
(Required)
Unique identifier of the customer payment. Note: This value is a set of numeric characters.
Query Parameters
organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
page
integer
Page number to be fetched. Default value is 1.
per_page
integer
Number of records to be fetched per page.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/books/v3/customerpayments/9030000079467/refunds?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/books/v3/customerpayments/9030000079467/refunds?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The list of refunds of the customer is displayed successfully.",
"payment_refunds": [
{
"payment_refund_id": "3000000003017",
"payment_id": "9030000079467",
"date": "2016-06-05",
"refund_mode": "cash",
"reference_number": "INV-384",
"payment_number": "2",
"customer_name": "Bowman Furniture",
"amount_bcy": 10,
"amount_fcy": 10
},
{...},
{...}
],
"page_context": {
"page": 1,
"per_page": 10,
"has_more_page": false,
"report_name": "Customer Payments Refund",
"sort_column": "created_time",
"sort_order": "D"
}
}
Update custom field in existing customerpayments
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Update the value of the custom field in existing customerpayments.
OAuth Scope : ZohoBooks.customerpayments.UPDATE
Arguments
customfield_id
string
Unique identifier for the custom field. Note: This value is a set of numeric characters.
value
string
Value of the custom field.
Path Parameters
customer_payment_id
string
(Required)
Unique identifier of the customer payment. Note: This value is a set of numeric characters.
Query Parameters
organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/customerpayment/9030000079467/customfields?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.com/books/v3/customerpayment/9030000079467/customfields?organization_id=10234695")
.put(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'PUT',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.com/books/v3/customerpayment/9030000079467/customfields?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PUT", "/books/v3/customerpayment/9030000079467/customfields?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "PUT",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/books/v3/customerpayment/9030000079467/customfields?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request PUT \
--url 'https://www.zohoapis.com/books/v3/customerpayment/9030000079467/customfields?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
[
{
"customfield_id": "46000000012845",
"value": 129890
}
]
{
"code": 0,
"message": "Custom Fields Updated Successfully"
}
Update a refund
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Update the refunded transaction.
OAuth Scope : ZohoBooks.customerpayments.UPDATE
Arguments
date
string
(Required)
Date on which payment is made. Format [yyyy-mm-dd]
refund_mode
string
The method of refund. Max-length [50]
reference_number
string
Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-length [100]
amount
double
(Required)
Amount paid in the respective payment.
exchange_rate
double
, default is 1
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 the exchange rate.
payment_form
string
🇲🇽
Mexico
only
Mode of Vendor Payment
description
string
Description about the payment.
from_account_id
string
(Required)
The account from which payment is refunded. Note: This value is a set of numeric characters.
Path Parameters
customer_payment_id
string
(Required)
Unique identifier of the customer payment. Note: This value is a set of numeric characters.
refund_id
string
(Required)
Unique identifier of the refund. Note: This value is a set of numeric characters.
Query Parameters
organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
.url("https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695")
.put(body)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'PUT',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
'content-type': 'application/json'
},
body: '{"field1":"value1","field2":"value2"}'
};
fetch('https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PUT", "/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "PUT",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
"content-type": "application/json"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
curl --request PUT \
--url 'https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"date": "2016-06-05",
"refund_mode": "cash",
"reference_number": "INV-384",
"amount": 450,
"exchange_rate": 1,
"payment_form": "cash",
"description": "Payment has been added to INV-384",
"from_account_id": " "
}
{
"code": 0,
"message": "The refund information has been saved.",
"payment_refunds": [
{
"payment_refund_id": "3000000003017",
"payment_id": "9030000079467",
"date": "2016-06-05",
"refund_mode": "cash",
"reference_number": "INV-384",
"amount": 450,
"exchange_rate": 1,
"payment_form": "cash",
"description": "Payment has been added to INV-384"
},
{...},
{...}
]
}
Details of a refund
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Obtain details of a particular refund of a customer payment.
OAuth Scope : ZohoBooks.customerpayments.READ
Path Parameters
customer_payment_id
string
(Required)
Unique identifier of the customer payment. Note: This value is a set of numeric characters.
refund_id
string
(Required)
Unique identifier of the refund. Note: This value is a set of numeric characters.
Query Parameters
organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url 'https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The details of the refund are displayed successfully.",
"payment_refunds": [
{
"payment_refund_id": "3000000003017",
"payment_id": "9030000079467",
"date": "2016-06-05",
"refund_mode": "cash",
"reference_number": "INV-384",
"amount": 450,
"exchange_rate": 1,
"payment_form": "cash",
"description": "Payment has been added to INV-384"
},
{...},
{...}
]
}
Delete a Refund
AI Tools
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Open in ChatGPT
Open in ChatGPT to ask questions about this page
Open in Claude
Open in Claude to ask questions about this page
Copy as Markdown
Copy this page as markdown to use with AI assistants
View as Markdown
Open this page as markdown in a new tab
Delete refund pertaining to an existing customer payment.
OAuth Scope : ZohoBooks.customerpayments.DELETE
Path Parameters
customer_payment_id
string
(Required)
Unique identifier of the customer payment. Note: This value is a set of numeric characters.
refund_id
string
(Required)
Unique identifier of the refund. Note: This value is a set of numeric characters.
Query Parameters
organization_id
string
(Required)
ID of the organization. Note: This value is a set of numeric characters.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695")
.delete(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'DELETE',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("DELETE", "/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "DELETE",
"hostname": "www.zohoapis.com",
"port": null,
"path": "/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695",
"headers": {
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request DELETE \
--url 'https://www.zohoapis.com/books/v3/customerpayments/9030000079467/refunds/3000000003017?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The refund has been deleted."
}