Bank Transactions
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
In many instances, you would wish to record manual entries for your offline transactions for your bank or credit card accounts. These entries might not be a part of your bank feeds but would make an important entry for your business records.
Download Bank Transactions OpenAPI Document
End Points
Create a transaction for an account
Get transactions list
Update a transaction
Get transaction
Delete a transaction
Match a transaction
Get matching transactions
Unmatch a matched transaction
Exclude a transaction
Restore a transaction
Categorize an uncategorized transaction
Categorize as expense
Uncategorize a categorized transaction
Categorize a vendor payment
Categorize as customer payment
Categorize as credit note refunds
Categorize as vendor credit refunds
Categorize as Customer Payment refund
Categorize as Vendor Payment refund
Attribute
transaction_id
string
ID of the Transaction.
from_account_id
string
The account ID from which money will be transferred(Mandatory for specific type of transactions). These accounts differ with respect to transaction_type. Ex: To a bank account, from-account can be: bank , card, income, refund. To a card account, from account can be: bank, card, refund.
from_account_name
string
Name of the account from which money will be transferred.
to_account_id
string
ID of the account to which the money gets transferred(Mandatory for specific type of transactions). Ex: From a bank account, to-account can be: bank, card, drawings, expense,credit notes. From a card account, to-account can be: card, bank, expense.
to_account_name
string
transaction_type
string
Type of the transaction.
Allowed transaction types : deposit, refund(*Supported only in Credit Card accounts), transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return
Note: You will not be able to create the following module-specific transaction types under Bank Transaction endpoints :
Allowed transaction types : deposit, refund(*Supported only in Credit Card accounts), transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return
Note: You will not be able to create the following module-specific transaction types under Bank Transaction endpoints :
Expense, Vendor Advance/Vendor Payment/Bill Payment, Vendor Credit Refund, Vendor Payment Refund, Customer Advance/Customer Payment, Credit Note Refund, Payment Refund. Hence, refer them in their respective modules.
currency_id
string
The currency ID involved in the transaction.
currency_code
string
Code of the currency involved in the transaction.
payment_mode
string
Mode of payment for the transaction. (not applicable for transfer_fund, card_payment, owner_drawings). Ex:cash, cheque, etc.,.
exchange_rate
integer
The foreign currency exchange rate value.
date
string
Date of the transaction.
customer_id
string
ID of the customer or vendor.
customer_name
string
Name of the customer.
vendor_id
string
ID of the Vendor.
vendor_name
string
Name of the vendor.
reference_number
string
Reference number of the transaction.
description
string
A brief description about the transaction.
bank_charges
double
Bank charges applied to the transaction.
tax_id
string
ID of the tax or tax group applied.
documents
array
List of files to be attached to a particular transaction.
file_name
string
Name of the attached file.
document_id
string
Unique ID of the attached file.
is_inclusive_tax
boolean
Indicates if the transaction is tax inclusive.
tax_name
string
Name of the tax.
tax_percentage
double
Percentage of the tax.
tax_amount
double
Amount of tax.
sub_total
integer
Subtotal of the transaction.
tax_exemption_id
string
🇮🇳
India
only
ID of the tax exemption.
tax_exemption_code
string
🇮🇳
India
only
Code of the tax exemption.
total
integer
Total of the transaction.
bcy_total
integer
Total in base currency of the organization.
amount
double
Amount of the transaction.
reverse_charge_tax_id
string
🇮🇳
India
only
Reverse charge tax ID.
imported_transactions
array
imported_transaction_id
string
ID of the imported transaction.
date
string
Date of the imported transaction.
amount
double
Amount in the transaction.
payee
string
Payee involved in the transaction.
description
string
Description of the transaction.
reference_number
string
Reference number of the transaction.
status
string
Status of the transaction.
account_id
string
Account ID of the transaction.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_name
string
Name of the tag.
tag_option_id
string
Tag option ID.
tag_option_name
string
Tag option name.
is_tag_mandatory
boolean
Indicates if the tag is mandatory.
line_items
array
List of line items for the bank transaction.
from_account_id
string
The account ID from which money will be transferred(Mandatory for specific type of transactions). These accounts differ with respect to transaction_type. Ex: To a bank account, from-account can be: bank , card, income, refund. To a card account, from account can be: bank, card, refund.
from_account_name
string
Name of the account from which money will be transferred.
payment_mode
string
Mode of payment for the transaction. (not applicable for transfer_fund, card_payment, owner_drawings). Ex:cash, cheque, etc.,.
customer_id
string
ID of the customer or vendor.
customer_name
string
Name of the customer.
vendor_id
string
ID of the Vendor.
vendor_name
string
Name of the vendor.
sub_total
integer
Subtotal of the transaction.
total
integer
Total of the transaction.
bcy_total
integer
Total in base currency of the organization.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
Tag option ID.
{
"transaction_id": "460000000048017",
"from_account_id": "460000000070003",
"from_account_name": "Sales",
"to_account_id": "460000000048001",
"to_account_name": "Corporate Account",
"transaction_type": "deposit",
"currency_id": "460000000000097",
"currency_code": "INR",
"payment_mode": "Cash",
"exchange_rate": 1,
"date": "2013-10-01",
"customer_id": "460000000000111",
"customer_name": "string",
"vendor_id": "460000000026049",
"vendor_name": "Bowmen and co",
"reference_number": "Ref-121",
"description": "string",
"bank_charges": 0,
"tax_id": "string",
"documents": [
{
"file_name": "string",
"document_id": "string"
}
],
"is_inclusive_tax": false,
"tax_name": "string",
"tax_percentage": 0,
"tax_amount": 0,
"sub_total": 33,
"tax_exemption_id": "string",
"tax_exemption_code": "string",
"total": 33,
"bcy_total": 33,
"amount": 2000,
"reverse_charge_tax_id": 982000000567254,
"imported_transactions": [
{
"imported_transaction_id": "460000000013297",
"date": "2013-01-22",
"amount": 10,
"payee": "Smith",
"description": "Cheque Deposit",
"reference_number": "Ref-1900",
"status": "categorized",
"account_id": 460000000006294
}
],
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
],
"line_items": [
{
"from_account_id": "460000000070003",
"from_account_name": "Sales",
"payment_mode": "Cash",
"customer_id": "460000000000111",
"customer_name": "string",
"vendor_id": "460000000026049",
"vendor_name": "Bowmen and co",
"sub_total": 33,
"total": 33,
"bcy_total": 33,
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
]
}
]
}
Create a transaction for an account
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 bank transaction based on the allowed transaction types.
OAuth Scope : ERP.banking.CREATE
Arguments
from_account_id
string
The account ID from which money will be transferred(Mandatory for specific type of transactions). These accounts differ with respect to transaction_type. Ex: To a bank account, from-account can be: bank , card, income, refund. To a card account, from account can be: bank, card, refund.
to_account_id
string
ID of the account to which the money gets transferred(Mandatory for specific type of transactions). Ex: From a bank account, to-account can be: bank, card, drawings, expense,credit notes. From a card account, to-account can be: card, bank, expense.
transaction_type
string
(Required)
Type of the transaction.
Allowed transaction types : deposit, refund(*Supported only in Credit Card accounts), transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return
Note: You will not be able to create the following module-specific transaction types under Bank Transaction endpoints :
Allowed transaction types : deposit, refund(*Supported only in Credit Card accounts), transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return
Note: You will not be able to create the following module-specific transaction types under Bank Transaction endpoints :
Expense, Vendor Advance/Vendor Payment/Bill Payment, Vendor Credit Refund, Vendor Payment Refund, Customer Advance/Customer Payment, Credit Note Refund, Payment Refund. Hence, refer them in their respective modules.
amount
double
Amount of the transaction.
payment_mode
string
Mode of payment for the transaction. (not applicable for transfer_fund, card_payment, owner_drawings). Ex:cash, cheque, etc.,.
exchange_rate
integer
The foreign currency exchange rate value.
date
string
Date of the transaction.
customer_id
string
ID of the customer or vendor.
reference_number
string
Reference number of the transaction.
description
string
A brief description about the transaction.
currency_id
string
The currency ID involved in the transaction.
tax_id
string
ID of the tax or tax group applied.
is_inclusive_tax
boolean
Indicates if the transaction is tax inclusive.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
Tag option ID.
from_account_tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
Tag option ID.
to_account_tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
Tag option ID.
documents
array
List of files to be attached to a particular transaction.
file_name
string
Name of the attached file.
document_id
string
Unique ID of the attached file.
bank_charges
double
Bank charges applied to the transaction.
user_id
string
ID of the user involved in the transaction.
tax_exemption_id
string
🇮🇳
India
only
ID of the tax exemption.
custom_fields
array
List of custom fields associated with the transaction.
custom_field_id
string
ID of the custom field.
index
integer
Index of the custom field.
label
string
Label of the custom field.
value
string
Value of the custom field.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions?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.in/erp/v3/banktransactions?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.in/erp/v3/banktransactions?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.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/banktransactions?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.in",
"port": null,
"path": "/erp/v3/banktransactions?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.in/erp/v3/banktransactions?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"from_account_id": "460000000070003",
"to_account_id": "460000000048001",
"transaction_type": "deposit",
"amount": 2000,
"payment_mode": "Cash",
"exchange_rate": 1,
"date": "2013-10-01",
"customer_id": "460000000000111",
"reference_number": "Ref-121",
"description": "string",
"currency_id": "460000000000097",
"tax_id": "string",
"is_inclusive_tax": false,
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"from_account_tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"to_account_tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"documents": [
{
"file_name": "string",
"document_id": "string"
}
],
"bank_charges": 0,
"user_id": "string",
"tax_exemption_id": "string",
"custom_fields": [
{
"custom_field_id": "string",
"index": 0,
"label": "string",
"value": "string"
}
]
}
{
"code": 0,
"message": "The bank transaction has been recorded.",
"banktransaction": {
"transaction_id": "460000000048017",
"from_account_id": "460000000070003",
"from_account_name": "Sales",
"to_account_id": "460000000048001",
"to_account_name": "Corporate Account",
"transaction_type": "deposit",
"currency_id": "460000000000097",
"currency_code": "INR",
"payment_mode": "Cash",
"exchange_rate": 1,
"date": "2013-10-01",
"customer_id": "460000000000111",
"customer_name": "string",
"vendor_id": "460000000026049",
"vendor_name": "Bowmen and co",
"reference_number": "Ref-121",
"description": "string",
"bank_charges": 0,
"tax_id": "string",
"documents": [
{
"file_name": "string",
"document_id": "string"
}
],
"is_inclusive_tax": false,
"tax_name": "string",
"tax_percentage": 0,
"tax_amount": 0,
"sub_total": 33,
"tax_exemption_id": "string",
"tax_exemption_code": "string",
"total": 33,
"bcy_total": 33,
"amount": 2000,
"reverse_charge_tax_id": 982000000567254,
"imported_transactions": [
{
"imported_transaction_id": "460000000013297",
"date": "2013-01-22",
"amount": 10,
"payee": "Smith",
"description": "Cheque Deposit",
"reference_number": "Ref-1900",
"status": "categorized",
"account_id": 460000000006294
}
],
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
],
"line_items": [
{
"from_account_id": "460000000070003",
"from_account_name": "Sales",
"payment_mode": "Cash",
"customer_id": "460000000000111",
"customer_name": "string",
"vendor_id": "460000000026049",
"vendor_name": "Bowmen and co",
"sub_total": 33,
"total": 33,
"bcy_total": 33,
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
]
}
]
}
}
Get transactions list
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
Get all the transaction details involved in an account.
OAuth Scope : ERP.banking.READ
Query Parameters
organization_id
string
(Required)
ID of the organization
account_id
string
ID of the bank account to filter transactions.
transaction_type
string
Type of the bank transaction. Allowed Values:
sales_without_invoices, expense_refund, owner_drawings, owner_contribution, interest_income, other_income, expense, deposit date
string
Start and end date, to provide a range within which the transaction date exist. Variants:
date_start and date_end amount
double
Start and end amount, to provide a range within which the transaction amount exist. Variants:
amount_start and amount_end status
string
Status of the transaction. Values: All, uncategorized, manually_added, matched, excluded, categorized.
reference_number
string
Search using the reference number of the transaction.
filter_by
string
Filters the transactions based on the allowed types. Allowed Values:
Status.All, Status.Uncategorized, Status.Categorized, Status.ManuallyAdded, Status.Excluded and Status.Matched. sort_column
string
Sorts the transactions based on the allowed sort types. Allowed Values:
date. transaction_status
string
Status of the transaction. Values: All, uncategorized, manually_added, matched, excluded, categorized.
search_text
string
Search transactions by contact name or description.
page
integer
Page number to be fetched. Default value is 1.
per_page
integer
Number of records to be fetched per page. Default value is 200.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions?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.in/erp/v3/banktransactions?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.in/erp/v3/banktransactions?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.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v3/banktransactions?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.in",
"port": null,
"path": "/erp/v3/banktransactions?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.in/erp/v3/banktransactions?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"banktransactions": [
{
"transaction_id": "460000000048017",
"date": "2013-10-01",
"amount": 2000,
"transaction_type": "deposit",
"status": "categorized",
"source": "manually_added",
"account_id": "460000000048001",
"account_name": "Petty Cash",
"account_type": "cash",
"price_precision": 2,
"customer_id": "460000000000111",
"payee": "Smith",
"description": "string",
"currency_id": "460000000000097",
"currency_code": "INR",
"currency_symbol": "₹",
"debit_or_credit": "debit",
"offset_account_name": "Petty Cash",
"is_offsetaccount_matched": false,
"reference_number": "Ref-121",
"imported_transaction_id": "460000000013297",
"is_rule_exist": false,
"rule_details": [
"string"
]
},
{...},
{...}
]
}
Update a transaction
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
Make changes in the applicable fields of a transaction and update it.
OAuth Scope : ERP.banking.UPDATE
Arguments
from_account_id
string
The account ID from which money will be transferred(Mandatory for specific type of transactions). These accounts differ with respect to transaction_type. Ex: To a bank account, from-account can be: bank , card, income, refund. To a card account, from account can be: bank, card, refund.
to_account_id
string
ID of the account to which the money gets transferred(Mandatory for specific type of transactions). Ex: From a bank account, to-account can be: bank, card, drawings, expense,credit notes. From a card account, to-account can be: card, bank, expense.
transaction_type
string
(Required)
Type of the transaction.
Allowed transaction types : deposit, refund(*Supported only in Credit Card accounts), transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return
Note: You will not be able to create the following module-specific transaction types under Bank Transaction endpoints :
Allowed transaction types : deposit, refund(*Supported only in Credit Card accounts), transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return
Note: You will not be able to create the following module-specific transaction types under Bank Transaction endpoints :
Expense, Vendor Advance/Vendor Payment/Bill Payment, Vendor Credit Refund, Vendor Payment Refund, Customer Advance/Customer Payment, Credit Note Refund, Payment Refund. Hence, refer them in their respective modules.
amount
double
Amount of the transaction.
payment_mode
string
Mode of payment for the transaction. (not applicable for transfer_fund, card_payment, owner_drawings). Ex:cash, cheque, etc.,.
exchange_rate
integer
The foreign currency exchange rate value.
date
string
Date of the transaction.
customer_id
string
ID of the customer or vendor.
reference_number
string
Reference number of the transaction.
description
string
A brief description about the transaction.
currency_id
string
The currency ID involved in the transaction.
tax_id
string
ID of the tax or tax group applied.
is_inclusive_tax
boolean
Indicates if the transaction is tax inclusive.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
Tag option ID.
from_account_tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
Tag option ID.
to_account_tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
Tag option ID.
documents
array
List of files to be attached to a particular transaction.
file_name
string
Name of the attached file.
document_id
string
Unique ID of the attached file.
bank_charges
double
Bank charges applied to the transaction.
user_id
string
ID of the user involved in the transaction.
tax_exemption_id
string
🇮🇳
India
only
ID of the tax exemption.
custom_fields
array
List of custom fields associated with the transaction.
custom_field_id
string
ID of the custom field.
index
integer
Index of the custom field.
label
string
Label of the custom field.
value
string
Value of the custom field.
line_items
array
List of expense line items associated with the transaction.
line_id
string
ID of the line in bank transactions.
account_id
string
Mandatory Account ID for which transactions are to be listed.
account_name
string
Name of the account.
description
string
A brief description about the transaction.
tax_amount
double
Amount of tax.
tax_id
string
ID of the tax or tax group applied.
tax_name
string
Name of the tax.
tax_type
string
Type of tax applied to the line item.
tax_percentage
double
Percentage of the tax.
item_total
double
Total of the item.
item_total_inclusive_of_tax
double
Total of the item inclusive of tax.
item_order
integer
Order of the item.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
Tag option ID.
Path Parameters
bank_transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/460000000048017?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.in/erp/v3/banktransactions/460000000048017?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.in/erp/v3/banktransactions/460000000048017?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.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("PUT", "/erp/v3/banktransactions/460000000048017?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.in",
"port": null,
"path": "/erp/v3/banktransactions/460000000048017?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.in/erp/v3/banktransactions/460000000048017?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"from_account_id": "460000000070003",
"to_account_id": "460000000048001",
"transaction_type": "deposit",
"amount": 2000,
"payment_mode": "Cash",
"exchange_rate": 1,
"date": "2013-10-01",
"customer_id": "460000000000111",
"reference_number": "Ref-121",
"description": "string",
"currency_id": "460000000000097",
"tax_id": "string",
"is_inclusive_tax": false,
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"from_account_tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"to_account_tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"documents": [
{
"file_name": "string",
"document_id": "string"
}
],
"bank_charges": 0,
"user_id": "string",
"tax_exemption_id": "string",
"custom_fields": [
{
"custom_field_id": "string",
"index": 0,
"label": "string",
"value": "string"
}
],
"line_items": [
{
"line_id": "46000000001234",
"account_id": "460000000048001",
"account_name": "Petty Cash",
"description": "string",
"tax_amount": 0,
"tax_id": "string",
"tax_name": "string",
"tax_type": "tax",
"tax_percentage": 0,
"item_total": 7500,
"item_total_inclusive_of_tax": 7500,
"item_order": 1,
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
]
}
]
}
{
"code": 0,
"message": "The bank transaction has been updated.",
"banktransaction": {
"transaction_id": "460000000048017",
"from_account_id": "460000000070003",
"from_account_name": "Sales",
"to_account_id": "460000000048001",
"to_account_name": "Corporate Account",
"transaction_type": "deposit",
"currency_id": "460000000000097",
"currency_code": "INR",
"payment_mode": "Cash",
"exchange_rate": 1,
"date": "2013-10-01",
"customer_id": "460000000000111",
"customer_name": "string",
"vendor_id": "460000000026049",
"vendor_name": "Bowmen and co",
"reference_number": "Ref-121",
"description": "string",
"bank_charges": 0,
"tax_id": "string",
"documents": [
{
"file_name": "string",
"document_id": "string"
}
],
"is_inclusive_tax": false,
"tax_name": "string",
"tax_percentage": 0,
"tax_amount": 0,
"sub_total": 33,
"tax_exemption_id": "string",
"tax_exemption_code": "string",
"total": 33,
"bcy_total": 33,
"amount": 2000,
"reverse_charge_tax_id": 982000000567254,
"imported_transactions": [
{
"imported_transaction_id": "460000000013297",
"date": "2013-01-22",
"amount": 10,
"payee": "Smith",
"description": "Cheque Deposit",
"reference_number": "Ref-1900",
"status": "categorized",
"account_id": 460000000006294
}
],
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
],
"line_items": [
{
"from_account_id": "460000000070003",
"from_account_name": "Sales",
"payment_mode": "Cash",
"customer_id": "460000000000111",
"customer_name": "string",
"vendor_id": "460000000026049",
"vendor_name": "Bowmen and co",
"sub_total": 33,
"total": 33,
"bcy_total": 33,
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
]
}
]
}
}
Get transaction
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
Fetch the details of a transaction by specifying the transaction_id.
OAuth Scope : ERP.banking.READ
Path Parameters
bank_transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/460000000048017?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.in/erp/v3/banktransactions/460000000048017?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.in/erp/v3/banktransactions/460000000048017?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.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v3/banktransactions/460000000048017?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.in",
"port": null,
"path": "/erp/v3/banktransactions/460000000048017?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.in/erp/v3/banktransactions/460000000048017?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"banktransaction": {
"transaction_id": "460000000048017",
"from_account_id": "460000000070003",
"from_account_name": "Sales",
"to_account_id": "460000000048001",
"to_account_name": "Corporate Account",
"transaction_type": "deposit",
"currency_id": "460000000000097",
"currency_code": "INR",
"payment_mode": "Cash",
"exchange_rate": 1,
"date": "2013-10-01",
"customer_id": "460000000000111",
"customer_name": "string",
"vendor_id": "460000000026049",
"vendor_name": "Bowmen and co",
"reference_number": "Ref-121",
"description": "string",
"bank_charges": 0,
"tax_id": "string",
"documents": [
{
"file_name": "string",
"document_id": "string"
}
],
"is_inclusive_tax": false,
"tax_name": "string",
"tax_percentage": 0,
"tax_amount": 0,
"sub_total": 33,
"tax_exemption_id": "string",
"tax_exemption_code": "string",
"total": 33,
"bcy_total": 33,
"amount": 2000,
"reverse_charge_tax_id": 982000000567254,
"imported_transactions": [
{
"imported_transaction_id": "460000000013297",
"date": "2013-01-22",
"amount": 10,
"payee": "Smith",
"description": "Cheque Deposit",
"reference_number": "Ref-1900",
"status": "categorized",
"account_id": 460000000006294
}
],
"tags": [
{
"tag_id": "460000000000567",
"tag_name": "Business Unit",
"tag_option_id": "460000000014044",
"tag_option_name": "Sales",
"is_tag_mandatory": false
}
],
"line_items": [
{
"from_account_id": "460000000070003",
"from_account_name": "Sales",
"payment_mode": "Cash",
"customer_id": "460000000000111",
"customer_name": "string",
"vendor_id": "460000000026049",
"vendor_name": "Bowmen and co",
"sub_total": 33,
"total": 33,
"bcy_total": 33,
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
]
}
]
}
}
Delete a transaction
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 a transaction from an account by specifying the transaction_id.
OAuth Scope : ERP.banking.DELETE
Path Parameters
bank_transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/460000000048017?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.in/erp/v3/banktransactions/460000000048017?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.in/erp/v3/banktransactions/460000000048017?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.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("DELETE", "/erp/v3/banktransactions/460000000048017?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.in",
"port": null,
"path": "/erp/v3/banktransactions/460000000048017?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.in/erp/v3/banktransactions/460000000048017?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The transaction has been deleted."
}
Match a transaction
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
Arguments
transactions_to_be_matched
array
List of transactions to be matched with the uncategorized transaction.
transaction_id
string
ID of the Transaction.
transaction_type
string
Type of the transaction.
Allowed transaction types : deposit, refund(*Supported only in Credit Card accounts), transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return
Note: You will not be able to create the following module-specific transaction types under Bank Transaction endpoints :
Allowed transaction types : deposit, refund(*Supported only in Credit Card accounts), transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return
Note: You will not be able to create the following module-specific transaction types under Bank Transaction endpoints :
Expense, Vendor Advance/Vendor Payment/Bill Payment, Vendor Credit Refund, Vendor Payment Refund, Customer Advance/Customer Payment, Credit Note Refund, Payment Refund. Hence, refer them in their respective modules.
Path Parameters
transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
account_id
string
Mandatory Account ID for which transactions are to be listed.
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/match?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.in/erp/v3/banktransactions/uncategorized/460000000048017/match?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.in/erp/v3/banktransactions/uncategorized/460000000048017/match?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.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/banktransactions/uncategorized/460000000048017/match?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.in",
"port": null,
"path": "/erp/v3/banktransactions/uncategorized/460000000048017/match?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.in/erp/v3/banktransactions/uncategorized/460000000048017/match?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"transactions_to_be_matched": [
{
"transaction_id": "460000000048017",
"transaction_type": "deposit"
}
]
}
{
"code": 0,
"message": "The transaction has been matched."
}
Get matching transactions
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
Provide criteria to search for matching uncategorised transactions. The list of transactions can also include invoices/bills/credit-notes which will not be matched directly. Instead, a new (payment/refund) transaction is recorded and matched.
OAuth Scope : ERP.banking.READ
Path Parameters
transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
transaction_id
string
ID of the transaction.
transaction_type
string
Type of the transaction.
Allowed transaction types : deposit, refund(*Supported only in Credit Card accounts), transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return
Note: You will not be able to create the following module-specific transaction types under Bank Transaction endpoints :
Allowed transaction types : deposit, refund(*Supported only in Credit Card accounts), transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return
Note: You will not be able to create the following module-specific transaction types under Bank Transaction endpoints :
Expense, Vendor Advance/Vendor Payment/Bill Payment, Vendor Credit Refund, Vendor Payment Refund, Customer Advance/Customer Payment, Credit Note Refund, Payment Refund. Hence, refer them in their respective modules.
date_after
string
Date after which transactions are to be filtered.
date_before
string
Date before which transactions are to be filtered.
amount_start
double
Starting amount with which transactions are to be filtered.
amount_end
double
Ending amount with which transactions are to be filtered.
contact
string
Contact person name, involved in the transaction.
reference_number
string
Reference number of the transaction.
show_all_transactions
boolean
Indicates if all transactions must be shown.
page
integer
Page number to be fetched. Default value is 1.
per_page
integer
Number of records to be fetched per page. Default value is 200.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/match?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.in/erp/v3/banktransactions/uncategorized/460000000048017/match?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.in/erp/v3/banktransactions/uncategorized/460000000048017/match?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.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("GET", "/erp/v3/banktransactions/uncategorized/460000000048017/match?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.in",
"port": null,
"path": "/erp/v3/banktransactions/uncategorized/460000000048017/match?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.in/erp/v3/banktransactions/uncategorized/460000000048017/match?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "success",
"matching_transactions": [
{
"transaction_id": "460000000048017",
"date": "2013-10-01",
"transaction_type": "deposit",
"reference_number": "Ref-121",
"amount": 2000,
"debit_or_credit": "debit",
"transaction_number": "INV-000007",
"contact_name": "Zylker Inc",
"is_best_match": true
},
{...},
{...}
]
}
Unmatch a matched transaction
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
Unmatch a transaction that was previously matched and make it uncategorized.
OAuth Scope : ERP.banking.CREATE
Path Parameters
transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
account_id
string
Mandatory Account ID for which transactions are to be listed.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/460000000048017/unmatch?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/banktransactions/460000000048017/unmatch?organization_id=10234695")
.post(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/banktransactions/460000000048017/unmatch?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.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("POST", "/erp/v3/banktransactions/460000000048017/unmatch?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/banktransactions/460000000048017/unmatch?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 POST \
--url 'https://www.zohoapis.in/erp/v3/banktransactions/460000000048017/unmatch?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The transaction has been unmatched."
}
Exclude a transaction
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
Exclude a transaction from your bank or credit card account.
OAuth Scope : ERP.banking.CREATE
Path Parameters
transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
account_id
string
Mandatory Account ID for which transactions are to be listed.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/exclude?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/exclude?organization_id=10234695")
.post(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/exclude?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.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("POST", "/erp/v3/banktransactions/uncategorized/460000000048017/exclude?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/banktransactions/uncategorized/460000000048017/exclude?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 POST \
--url 'https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/exclude?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The transaction has been excluded."
}
Restore a transaction
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
Restore an excluded transaction in your account.
OAuth Scope : ERP.banking.CREATE
Path Parameters
transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
account_id
string
Mandatory Account ID for which transactions are to be listed.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/restore?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/restore?organization_id=10234695")
.post(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/restore?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.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("POST", "/erp/v3/banktransactions/uncategorized/460000000048017/restore?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/banktransactions/uncategorized/460000000048017/restore?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 POST \
--url 'https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/restore?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "The excluded transaction(s) have been restored."
}
Categorize an uncategorized transaction
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
Categorize an uncategorized transaction by creating a new transaction.
OAuth Scope : ERP.banking.CREATE
Arguments
from_account_id
string
The account ID from which money will be transferred(Mandatory for specific type of transactions). These accounts differ with respect to transaction_type. Ex: To a bank account, from-account can be: bank , card, income, refund. To a card account, from account can be: bank, card, refund.
to_account_id
string
ID of the account to which the money gets transferred(Mandatory for specific type of transactions). Ex: From a bank account, to-account can be: bank, card, drawings, expense,credit notes. From a card account, to-account can be: card, bank, expense.
transaction_type
string
(Required)
Type of the transaction.
Allowed transaction types : deposit, refund(*Supported only in Credit Card accounts), transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return
Note: You will not be able to create the following module-specific transaction types under Bank Transaction endpoints :
Allowed transaction types : deposit, refund(*Supported only in Credit Card accounts), transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income, owner_drawings, sales_return
Note: You will not be able to create the following module-specific transaction types under Bank Transaction endpoints :
Expense, Vendor Advance/Vendor Payment/Bill Payment, Vendor Credit Refund, Vendor Payment Refund, Customer Advance/Customer Payment, Credit Note Refund, Payment Refund. Hence, refer them in their respective modules.
amount
double
Amount of the transaction.
date
string
Date of the transaction.
reference_number
string
Reference number of the transaction.
payment_mode
string
Mode of payment for the transaction. (not applicable for transfer_fund, card_payment, owner_drawings). Ex:cash, cheque, etc.,.
exchange_rate
integer
The foreign currency exchange rate value.
description
string
A brief description about the transaction.
customer_id
string
ID of the customer or vendor.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
Tag option ID.
documents
array
List of files to be attached to a particular transaction.
file_name
string
Name of the attached file.
document_id
string
Unique ID of the attached file.
currency_id
string
The currency ID involved in the transaction.
tax_id
string
ID of the tax or tax group applied.
to_account_tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
Tag option ID.
from_account_tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
Tag option ID.
is_inclusive_tax
boolean
Indicates if the transaction is tax inclusive.
bank_charges
double
Bank charges applied to the transaction.
user_id
string
ID of the user involved in the transaction.
tax_exemption_id
string
🇮🇳
India
only
ID of the tax exemption.
custom_fields
array
List of custom fields associated with the transaction.
custom_field_id
string
ID of the custom field.
index
integer
Index of the custom field.
label
string
Label of the custom field.
value
string
Value of the custom field.
line_items
array
List of expense line items associated with the transaction.
line_id
string
ID of the line in bank transactions.
account_id
string
Mandatory Account ID for which transactions are to be listed.
account_name
string
Name of the account.
description
string
A brief description about the transaction.
tax_amount
double
Amount of tax.
tax_id
string
ID of the tax or tax group applied.
tax_name
string
Name of the tax.
tax_type
string
Type of tax applied to the line item.
tax_percentage
double
Percentage of the tax.
item_total
double
Total of the item.
item_total_inclusive_of_tax
double
Total of the item inclusive of tax.
item_order
integer
Order of the item.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
Tag option ID.
Path Parameters
transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize?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.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/banktransactions/uncategorized/460000000048017/categorize?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.in",
"port": null,
"path": "/erp/v3/banktransactions/uncategorized/460000000048017/categorize?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"from_account_id": "460000000070003",
"to_account_id": "460000000048001",
"transaction_type": "deposit",
"amount": 2000,
"date": "2013-10-01",
"reference_number": "Ref-121",
"payment_mode": "Cash",
"exchange_rate": 1,
"description": "string",
"customer_id": "460000000000111",
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"documents": [
{
"file_name": "string",
"document_id": "string"
}
],
"currency_id": "460000000000097",
"tax_id": "string",
"to_account_tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"from_account_tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"is_inclusive_tax": false,
"bank_charges": 0,
"user_id": "string",
"tax_exemption_id": "string",
"custom_fields": [
{
"custom_field_id": "string",
"index": 0,
"label": "string",
"value": "string"
}
],
"line_items": [
{
"line_id": "46000000001234",
"account_id": "460000000048001",
"account_name": "Petty Cash",
"description": "string",
"tax_amount": 0,
"tax_id": "string",
"tax_name": "string",
"tax_type": "tax",
"tax_percentage": 0,
"item_total": 7500,
"item_total_inclusive_of_tax": 7500,
"item_order": 1,
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
]
}
]
}
{
"code": 0,
"message": "The transaction(s) have been categorized."
}
Categorize as expense
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
Categorize an Uncategorized transaction as expense.
OAuth Scope : ERP.banking.CREATE
Arguments
account_id
string
Mandatory Account ID for which transactions are to be listed.
paid_through_account_id
string
ID of the credit/ bank account the payment is made.
date
string
Date of the transaction.
tax_id
string
ID of the tax or tax group applied.
amount
double
Amount of the transaction.
project_id
string
ID of the project associated with the expense.
tax_exemption_code
string
🇮🇳
India
only
Code of the tax exemption.
tax_exemption_id
string
🇮🇳
India
only
ID of the tax exemption.
is_inclusive_tax
boolean
Indicates if the transaction is tax inclusive.
is_billable
boolean
A boolean value to specify if the expense is billable.
reference_number
string
Reference number of the transaction.
description
string
A brief description about the transaction.
customer_id
string
ID of the customer or vendor.
zp_project_id
string
ID of the Project.
zp_project_name
string
Name of the project.
zp_client_id
string
ID of the client.
vendor_id
string
ID of the Vendor.
vehicle_id
string
ID of the Vehicle.
mileage_unit
string
Unit of mileage.
mileage_rate
double
Mileage rate to be applied.
employee_id
string
ID of the Employee.
mileage_type
string
Type of Mileage. Allowed Values:
gmaps,imaps,gps,odometer,wmaps,manual,non_mileage and per_diem expense_type
string
Type of expense.
distance
double
Distance covered in the trip.
start_reading
string
Start reading of the odometer.
end_reading
string
End reading of the odometer.
currency_id
string
The currency ID involved in the transaction.
custom_fields
array
List of custom fields associated with the transaction.
index
integer
Index of the custom field.
value
string
Value of the custom field.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
Tag option ID.
documents
array
List of files to be attached to a particular transaction.
file_name
string
Name of the attached file.
document_id
string
Unique ID of the attached file.
exchange_rate
integer
The foreign currency exchange rate value.
recurring_expense_id
string
ID of the Recurring Expense.
is_update_customer
boolean
Indicates if the customer should be updated.
taxes
array
List of taxes applied to the transaction.
tax_name
string
Name of the tax.
tax_amount
double
Amount of tax.
tax_id
string
ID of the tax or tax group applied.
reason
string
Reason for the action.
line_items
array
List of expense line items associated with the transaction.
line_item_id
string
ID of the Line Item.
account_id
string
Mandatory Account ID for which transactions are to be listed.
description
string
A brief description about the transaction.
amount
double
Amount of the transaction.
tax_id
string
ID of the tax or tax group applied.
item_order
integer
Order of the item.
tax_exemption_code
string
🇮🇳
India
only
Code of the tax exemption.
tax_exemption_id
string
🇮🇳
India
only
ID of the tax exemption.
tags
array
Reporting tags help organize and filter data across reports and enable detailed business intelligence analysis.
tag_id
string
ID of the tag.
tag_option_id
string
Tag option ID.
zcrm_potential_id
string
ID of the CRM potential associated with the transaction.
Path Parameters
transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
doc
string
Document that is to be attached.
totalFiles
integer
Total number of files.
document_ids
string
Comma-separated list of document IDs to be attached to the transaction.
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/expenses?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/expenses?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/expenses?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.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/banktransactions/uncategorized/460000000048017/categorize/expenses?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.in",
"port": null,
"path": "/erp/v3/banktransactions/uncategorized/460000000048017/categorize/expenses?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/expenses?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"account_id": "460000000048001",
"paid_through_account_id": "460000000000358",
"date": "2013-10-01",
"tax_id": "string",
"amount": 2000,
"project_id": "string",
"tax_exemption_code": "string",
"tax_exemption_id": "string",
"is_inclusive_tax": false,
"is_billable": true,
"reference_number": "Ref-121",
"description": "string",
"customer_id": "460000000000111",
"zp_project_id": "string",
"zp_project_name": "string",
"zp_client_id": "string",
"vendor_id": "460000000026049",
"vehicle_id": "string",
"mileage_unit": "km",
"mileage_rate": 0,
"employee_id": "string",
"mileage_type": "non_mileage",
"expense_type": "non_mileage",
"distance": 4,
"start_reading": "string",
"end_reading": "string",
"currency_id": "460000000000097",
"custom_fields": [
{
"index": 0,
"value": "string"
}
],
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
],
"documents": [
{
"file_name": "string",
"document_id": "string"
}
],
"exchange_rate": 1,
"recurring_expense_id": "string",
"is_update_customer": false,
"taxes": [
{
"tax_name": "string",
"tax_amount": 0,
"tax_id": "string"
}
],
"reason": "string",
"line_items": [
{
"line_item_id": "460000000012834",
"account_id": "460000000048001",
"description": "string",
"amount": 2000,
"tax_id": "string",
"item_order": 1,
"tax_exemption_code": "string",
"tax_exemption_id": "string",
"tags": [
{
"tag_id": "460000000000567",
"tag_option_id": "460000000014044"
}
]
}
],
"zcrm_potential_id": "string"
}
{
"code": 0,
"message": "The transaction(s) have been categorized."
}
Uncategorize a categorized transaction
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
Revert a categorized transaction as uncategorized.
OAuth Scope : ERP.banking.CREATE
Path Parameters
transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
account_id
string
Mandatory Account ID for which transactions are to be listed.
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/460000000048017/uncategorize?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://www.zohoapis.in/erp/v3/banktransactions/460000000048017/uncategorize?organization_id=10234695")
.post(null)
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://www.zohoapis.in/erp/v3/banktransactions/460000000048017/uncategorize?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.in")
headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }
conn.request("POST", "/erp/v3/banktransactions/460000000048017/uncategorize?organization_id=10234695", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "www.zohoapis.in",
"port": null,
"path": "/erp/v3/banktransactions/460000000048017/uncategorize?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 POST \
--url 'https://www.zohoapis.in/erp/v3/banktransactions/460000000048017/uncategorize?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"code": 0,
"message": "Transaction(s) have been uncategorized."
}
Categorize a vendor 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
Categorize an uncategorized transaction as Vendor Payment.
OAuth Scope : ERP.banking.CREATE
Arguments
vendor_id
string
ID of the Vendor.
bills
array
List of bills associated with the vendor payment.
bill_payment_id
string
ID of the Bill Payment.
bill_id
string
ID of the Bill.
amount_applied
double
Amount applied to the entity.
tax_amount_withheld
double
Amount of tax withheld for the transaction.
payment_mode
string
Mode of payment for the transaction. (not applicable for transfer_fund, card_payment, owner_drawings). Ex:cash, cheque, etc.,.
description
string
A brief description about the transaction.
date
string
Date of the transaction.
reference_number
string
Reference number of the transaction.
exchange_rate
integer
The foreign currency exchange rate value.
paid_through_account_id
string
ID of the credit/ bank account the payment is made.
amount
double
Amount of the transaction.
custom_fields
array
List of custom fields associated with the transaction.
index
integer
Index of the custom field.
value
string
Value of the custom field.
check_details
array
List of check details associated with the payment.
memo
string
Memo or note associated with the check.
check_number
string
Number of the check created.
Path Parameters
transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/vendorpayments?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/vendorpayments?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/vendorpayments?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.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/banktransactions/uncategorized/460000000048017/categorize/vendorpayments?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.in",
"port": null,
"path": "/erp/v3/banktransactions/uncategorized/460000000048017/categorize/vendorpayments?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/vendorpayments?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"vendor_id": "460000000026049",
"bills": [
{
"bill_payment_id": "string",
"bill_id": "460000000053199",
"amount_applied": 150,
"tax_amount_withheld": 0
}
],
"payment_mode": "Cash",
"description": "string",
"date": "2013-10-01",
"reference_number": "Ref-121",
"exchange_rate": 1,
"paid_through_account_id": "460000000000358",
"amount": 2000,
"custom_fields": [
{
"index": 0,
"value": "string"
}
],
"check_details": [
{
"memo": "string",
"check_number": "string"
}
]
}
{
"code": 0,
"message": "The transaction(s) have been categorized."
}
Categorize as 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
Categorize an uncategorized transaction as Customer Payment.
OAuth Scope : ERP.banking.CREATE
Arguments
customer_id
string
ID of the customer or vendor.
retainerinvoice_id
string
ID of the Retainer Invoice.
invoices
array
List of invoices associated with the customer payment.
invoice_payment_id
string
ID of the Invoice Payment.
invoice_id
string
ID of the Invoice.
amount_applied
double
Amount applied to the entity.
tax_amount_withheld
double
Amount of tax withheld for the transaction.
discount_amount
double
Amount of discount in the invoice.
payment_mode
string
Mode of payment for the transaction. (not applicable for transfer_fund, card_payment, owner_drawings). Ex:cash, cheque, etc.,.
description
string
A brief description about the transaction.
reference_number
string
Reference number of the transaction.
exchange_rate
integer
The foreign currency exchange rate value.
amount
double
Amount of the transaction.
bank_charges
double
Bank charges applied to the transaction.
account_id
string
Mandatory Account ID for which transactions are to be listed.
custom_fields
array
List of custom fields associated with the transaction.
index
integer
Index of the custom field.
value
string
Value of the custom field.
documents
array
List of files to be attached to a particular transaction.
file_name
string
Name of the attached file.
document_id
string
Unique ID of the attached file.
date
string
Date of the transaction.
template_id
string
ID of the template.
contact_persons
array
Array of contact person(s) for whom invoice has to be sent.
Path Parameters
transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/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.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/banktransactions/uncategorized/460000000048017/categorize/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.in",
"port": null,
"path": "/erp/v3/banktransactions/uncategorized/460000000048017/categorize/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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/customerpayments?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"customer_id": "460000000000111",
"retainerinvoice_id": "string",
"invoices": [
{
"invoice_payment_id": "460000000134123",
"invoice_id": "460000000000481",
"amount_applied": 150,
"tax_amount_withheld": 0,
"discount_amount": 20
}
],
"payment_mode": "Cash",
"description": "string",
"reference_number": "Ref-121",
"exchange_rate": 1,
"amount": 2000,
"bank_charges": 0,
"account_id": "460000000048001",
"custom_fields": [
{
"index": 0,
"value": "string"
}
],
"documents": [
{
"file_name": "string",
"document_id": "string"
}
],
"date": "2013-10-01",
"template_id": "string",
"contact_persons": [
"460000000870911",
"460000000870915"
]
}
{
"code": 0,
"message": "The transaction(s) have been categorized."
}
Categorize as credit note refunds
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
Categorize an Uncategorized transaction as a refund from a credit note.
OAuth Scope : ERP.banking.CREATE
Arguments
creditnote_id
string
(Required)
ID of the credit note that has to be refunded.
date
string
(Required)
Date of the transaction.
refund_mode
string
Mode of refund. e.g., Cash, Cheque, etc.
reference_number
string
Reference number of the transaction.
amount
double
Amount of the transaction.
exchange_rate
integer
The foreign currency exchange rate value.
from_account_id
string
The account ID from which money will be transferred(Mandatory for specific type of transactions). These accounts differ with respect to transaction_type. Ex: To a bank account, from-account can be: bank , card, income, refund. To a card account, from account can be: bank, card, refund.
description
string
A brief description about the transaction.
Path Parameters
transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/creditnoterefunds?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/creditnoterefunds?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/creditnoterefunds?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.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/banktransactions/uncategorized/460000000048017/categorize/creditnoterefunds?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.in",
"port": null,
"path": "/erp/v3/banktransactions/uncategorized/460000000048017/categorize/creditnoterefunds?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/creditnoterefunds?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"creditnote_id": "4000000030049",
"date": "2013-10-01",
"refund_mode": "Cash",
"reference_number": "Ref-121",
"amount": 2000,
"exchange_rate": 1,
"from_account_id": "460000000070003",
"description": "string"
}
{
"code": 0,
"message": "The transaction(s) have been categorized."
}
Categorize as vendor credit refunds
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
Categorize an uncategorized transaction as a refund from a vendor credit.
OAuth Scope : ERP.banking.CREATE
Arguments
vendor_credit_id
string
(Required)
ID of the vendor credit that has to be refunded.
date
string
(Required)
Date of the transaction.
refund_mode
string
Mode of refund. e.g., Cash, Cheque, etc.
reference_number
string
Reference number of the transaction.
amount
double
Amount of the transaction.
exchange_rate
integer
The foreign currency exchange rate value.
account_id
string
Mandatory Account ID for which transactions are to be listed.
description
string
A brief description about the transaction.
Path Parameters
transaction_id
string
(Required)
Unique identifier of the bank transaction.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/vendorcreditrefunds?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/vendorcreditrefunds?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/vendorcreditrefunds?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.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/banktransactions/uncategorized/460000000048017/categorize/vendorcreditrefunds?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.in",
"port": null,
"path": "/erp/v3/banktransactions/uncategorized/460000000048017/categorize/vendorcreditrefunds?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.in/erp/v3/banktransactions/uncategorized/460000000048017/categorize/vendorcreditrefunds?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"vendor_credit_id": "460000000030049",
"date": "2013-10-01",
"refund_mode": "Cash",
"reference_number": "Ref-121",
"amount": 2000,
"exchange_rate": 1,
"account_id": "460000000048001",
"description": "string"
}
{
"code": 0,
"message": "The transaction(s) have been categorized."
}
Categorize as Customer Payment 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
Categorizing bank transactions as Payment Refund.
OAuth Scope : ERP.banking.CREATE
Arguments
date
string
(Required)
Date of the transaction.
refund_mode
string
Mode of refund. e.g., Cash, Cheque, etc.
reference_number
string
Reference number of the transaction.
amount
double
(Required)
Amount of the transaction.
exchange_rate
integer
The foreign currency exchange rate value.
from_account_id
string
(Required)
The account ID from which money will be transferred(Mandatory for specific type of transactions). These accounts differ with respect to transaction_type. Ex: To a bank account, from-account can be: bank , card, income, refund. To a card account, from account can be: bank, card, refund.
description
string
A brief description about the transaction.
Path Parameters
statement_line_id
string
(Required)
Unique identifier of the bank statement line.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/uncategorized//categorize/paymentrefunds?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.in/erp/v3/banktransactions/uncategorized//categorize/paymentrefunds?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.in/erp/v3/banktransactions/uncategorized//categorize/paymentrefunds?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.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/banktransactions/uncategorized//categorize/paymentrefunds?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.in",
"port": null,
"path": "/erp/v3/banktransactions/uncategorized//categorize/paymentrefunds?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.in/erp/v3/banktransactions/uncategorized//categorize/paymentrefunds?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"date": "2013-10-01",
"refund_mode": "Cash",
"reference_number": "Ref-121",
"amount": 2000,
"exchange_rate": 1,
"from_account_id": "460000000070003",
"description": "string"
}
{
"code": 0,
"message": "The transaction(s) have been categorized."
}
Categorize as Vendor Payment 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
Categorizing bank transactions as Vendor Payment Refund.
OAuth Scope : ERP.banking.CREATE
Arguments
vendorpayment_id
string
Vendor Payment to which you want to record the refund.
date
string
(Required)
Date of the transaction.
refund_mode
string
Mode of refund. e.g., Cash, Cheque, etc.
reference_number
string
Reference number of the transaction.
amount
double
(Required)
Amount of the transaction.
exchange_rate
integer
The foreign currency exchange rate value.
to_account_id
string
(Required)
ID of the account to which the money gets transferred(Mandatory for specific type of transactions). Ex: From a bank account, to-account can be: bank, card, drawings, expense,credit notes. From a card account, to-account can be: card, bank, expense.
description
string
A brief description about the transaction.
Path Parameters
statement_line_id
string
(Required)
Unique identifier of the bank statement line.
Query Parameters
organization_id
string
(Required)
ID of the organization
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.in/erp/v3/banktransactions/uncategorized//categorize/vendorpaymentrefunds?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.in/erp/v3/banktransactions/uncategorized//categorize/vendorpaymentrefunds?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.in/erp/v3/banktransactions/uncategorized//categorize/vendorpaymentrefunds?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.in")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
'content-type': "application/json"
}
conn.request("POST", "/erp/v3/banktransactions/uncategorized//categorize/vendorpaymentrefunds?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.in",
"port": null,
"path": "/erp/v3/banktransactions/uncategorized//categorize/vendorpaymentrefunds?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.in/erp/v3/banktransactions/uncategorized//categorize/vendorpaymentrefunds?organization_id=10234695' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
--header 'content-type: application/json' \
--data '{"field1":"value1","field2":"value2"}'
{
"vendorpayment_id": "460000000012345",
"date": "2013-10-01",
"refund_mode": "Cash",
"reference_number": "Ref-121",
"amount": 2000,
"exchange_rate": 1,
"to_account_id": "460000000048001",
"description": "string"
}
{
"code": 0,
"message": "The transaction(s) have been categorized."
}