Employee Advances

Employee Advances 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

An employee advance entity allows you to manage advance payments made to employees.

Download Employee Advances OpenAPI Document
End Points

Attribute

advance_payment_id
string
Unique identifier of the advance payment.
currency_id
string
Unique identifier of the currency.
currency_code
string
Currency code.
rcy_currency_id
string
Unique identifier of the reimbursement currency.
rcy_currency_code
string
Reimbursement currency code.
refund_currency_id
string
Unique identifier of the refund currency.
account_id
string
Unique identifier of the paid-through account.
account_name
string
Name of the paid-through account.
to_account_id
string
Unique identifier of the destination account.
to_account_name
string
Name of the destination account.
reference_number
string
Reference number of the advance payment. Max-length [50].
notes
string
Notes on the advance payment. Max-length [255].
refund_notes
string
Notes recorded with the refund.
refund_reference_number
string
Reference number of the refund.
status
string
Status of the advance payment. Possible values: draft, submitted, approved, rejected, recalled, void.
sub_status
string
Custom status of the advance payment.
advance_status
string
Applied status of the advance against expense reports. Possible values: applied, unapplied.
exchange_rate
double
Exchange rate of the foreign currency.
rcy_exchange_rate
double
Exchange rate for the reimbursement currency.
refund_exchange_rate
double
Exchange rate for the refund currency.
amount
double
Amount of the advance payment in the transaction currency.
bcy_amount
double
Advance amount in base currency.
rcy_amount
double
Advance amount in reimbursement currency.
refund_amount
double
Refund amount in the transaction currency.
refund_bcy_amount
double
Refund amount in base currency.
refund_rcy_amount
double
Refund amount in reimbursement currency.
date
string
Date of the advance payment in yyyy-MM-dd format.
refund_date
string
Date on which the refund was recorded.
price_precision
integer
Decimal precision for amounts.
created_time
string
Date and time when the advance payment was created.
created_date
string
Date when the advance payment was created.
last_modified_time
string
Date and time when the advance payment was last modified.
user_id
string
Unique identifier of the employee receiving the advance.
user_name
string
Name of the employee receiving the advance.
user_email
string
Email address of the employee receiving the advance.
user_zuid
string
ZUID of the employee receiving the advance.
user_photo_url
string
Photo URL of the employee receiving the advance.
employee_no
string
Employee number of the employee.
department_name
string
Department of the employee.
policy_id
string
Unique identifier of the policy.
policy_name
string
Name of the policy.
created_by
string
Name of the user who created the advance payment.
created_by_id
string
Unique identifier of the user who created the advance payment.
created_by_name
string
Name of the user who created the advance payment.
created_by_email
string
Email address of the user who created the advance payment.
created_by_employee_no
string
Employee number of the user who created the advance payment.
creator_photo_url
string
Photo URL of the user who created the advance payment.
submitted_date
string
Date when the advance payment was submitted.
last_submitted_date
string
Date when the advance payment was last submitted.
approved_date
string
Date when the advance payment was approved.
approver_id
string
Unique identifier of the approver.
approver_name
string
Name of the approver.
approver_email
string
Email address of the approver.
approver_photo_url
string
Photo URL of the approver.
approver_employee_no
string
Employee number of the approver.
approver_zuid
string
ZUID of the approver.
submitted_to_id
string
Unique identifier of the user the advance was submitted to.
submitted_to_name
string
Name of the user the advance was submitted to.
submitted_to_email
string
Email address of the user the advance was submitted to.
submitted_to_employee_no
string
Employee number of the user the advance was submitted to.
customer_id
string
Unique identifier of the customer.
customer_name
string
Name of the customer.
project_id
string
Unique identifier of the project.
project_name
string
Name of the project.
report_id
string
Unique identifier of the linked expense report.
report_name
string
Name of the linked expense report.
report_number
string
Number of the linked expense report.
report_status
string
Status of the linked expense report.
trip_id
string
Unique identifier of the associated trip.
trip_number
string
Trip number of the associated trip.
trip_name
string
Name of the associated trip.
trip_status
string
Status of the associated trip.
is_carried_forward_advance
boolean
Whether the advance is carried forward from a previous report. Allowed values true and false.
reference_report_id
string
Unique identifier of the reference report for a carried-forward advance.
refund_recorded_by
string
Name of the user who recorded the refund.
refund_recorded_by_id
string
Unique identifier of the user who recorded the refund.
location_id
string
Unique identifier of the location.
documents
array
Documents attached to the advance payment.
Show Sub-Attributes arrow
document_id
string
Unique identifier of the document.
file_name
string
Name of the attached document.
file_size_formatted
string
Formatted file size of the attached document.
attachment_order
integer
Order of the attached document.
expense_reports
array
Expense reports associated with the advance payment.
Show Sub-Attributes arrow
reimbursement_entity_id
string
Unique identifier of the reimbursement entity.
report_id
string
Unique identifier of the linked expense report.
report_name
string
Name of the linked expense report.
amount
double
Amount applied from the advance to the expense report.
date
string
Date the advance was applied to the expense report.
report_number
string
Number of the linked expense report.
report_status
string
Status of the linked expense report.
comments
array
Comments and approval history of the advance payment.
Show Sub-Attributes arrow
comment_id
string
Unique identifier of the comment.
advance_id
string
Unique identifier of the advance payment.
commented_by
string
Name of the person who posted the comment.
commented_by_id
string
Unique identifier of the commenter.
date
string
Date the comment was posted.
type
string
Type of comment entry.
previous_status
string
Previous status of the advance before the comment action.
approval_status
string
Approval status at the time of the comment.
custom_fields
array
Custom fields associated with the advance payment.
Show Sub-Attributes arrow
customfield_id
string
Unique identifier of the custom field.
label
string
Label of the custom field.
value
string
Value of the custom field.

Example

{ "advance_payment_id": "16367000000243203", "currency_id": "16367000000000099", "currency_code": "USD", "rcy_currency_id": "16367000000000099", "rcy_currency_code": "USD", "refund_currency_id": "16367000000000099", "account_id": "16367000000036003", "account_name": "Petty Cash", "to_account_id": "16367000000036007", "to_account_name": "Employee Advance", "reference_number": "ADV-00001", "notes": "Advance for business trip to New York.", "refund_notes": "Refund credited to petty cash.", "refund_reference_number": "REF-00001", "status": "approved", "sub_status": "", "advance_status": "unapplied", "exchange_rate": 1, "rcy_exchange_rate": 1, "refund_exchange_rate": 1, "amount": 5000, "bcy_amount": 5000, "rcy_amount": 5000, "refund_amount": 5000, "refund_bcy_amount": 5000, "refund_rcy_amount": 5000, "date": "2024-01-15", "refund_date": "2024-01-30", "price_precision": 2, "created_time": "2024-01-15T10:30:00+0530", "created_date": "2024-01-15", "last_modified_time": "2024-01-15T12:00:00+0530", "user_id": "16367000000073001", "user_name": "Will Smith", "user_email": "will.smith@zillum.com", "user_zuid": "12345678", "user_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "employee_no": "E001", "department_name": "Finance", "policy_id": "16367000000092011", "policy_name": "Default Policy", "created_by": "Will Smith", "created_by_id": "16367000000073071", "created_by_name": "Will Smith", "created_by_email": "will.smith@zillum.com", "created_by_employee_no": "E002", "creator_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "submitted_date": "2024-01-16", "last_submitted_date": "2024-01-16", "approved_date": "2024-01-17", "approver_id": "16367000000073001", "approver_name": "PATRICIA BOYLE", "approver_email": "patriciab@zillum.com", "approver_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "approver_employee_no": "E001", "approver_zuid": "23456789", "submitted_to_id": "16367000000073001", "submitted_to_name": "PATRICIA BOYLE", "submitted_to_email": "patriciab@zillum.com", "submitted_to_employee_no": "E001", "customer_id": "16367000000088005", "customer_name": "Zillum Corp", "project_id": "16367000000223045", "project_name": "Brochure Design", "report_id": "16367000000081005", "report_name": "Trip to SFA", "report_number": "ER-00001", "report_status": "approved", "trip_id": "16367000000312001", "trip_number": "TR-00001", "trip_name": "Business trip to New York", "trip_status": "approved", "is_carried_forward_advance": false, "reference_report_id": "16367000000081005", "refund_recorded_by": "Will Smith", "refund_recorded_by_id": "16367000000073071", "location_id": "16367000000401005", "documents": [ { "document_id": "16367000000078085", "file_name": "receipt.pdf", "file_size_formatted": "45.2 KB", "attachment_order": 1 } ], "expense_reports": [ { "reimbursement_entity_id": "16367000000501001", "report_id": "16367000000081005", "report_name": "Trip to SFA", "amount": 3000, "date": "2024-01-20", "report_number": "ER-00001", "report_status": "approved" } ], "comments": [ { "comment_id": "16367000000601001", "advance_id": "16367000000243203", "commented_by": "PATRICIA BOYLE", "commented_by_id": "16367000000073001", "date": "2024-01-17", "type": "comment", "previous_status": "submitted", "approval_status": "approved" } ], "custom_fields": [ { "customfield_id": "16367000000277001", "label": "Department Code", "value": "FIN-001" } ] }

Create an advance 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

Create a new advance payment for an employee. The currency_id, amount, date, and user_id fields are required.
OAuth Scope : ZohoExpense.advance.CREATE

Arguments

date
string
(Required)
Date of the advance in yyyy-MM-dd format.
amount
double
(Required)
Advance amount in the document currency.
exchange_rate
double
Exchange rate to base currency.
rcy_exchange_rate
double
Exchange rate to reimbursement currency.
notes
string
Notes on the advance. Max-length [255].
reference_number
string
Reference number. Max-length [50].
currency_id
string
(Required)
Unique ID of the currency.
account_id
string
Unique ID of the paid-through account.
user_id
string
(Required)
Unique ID of the user receiving the advance.
trip_id
string
Unique ID of the linked trip.
customer_id
string
Unique ID of the customer.
project_id
string
Unique ID of the project.
location_id
string
Unique ID of the location.
custom_fields
array
Custom fields recorded against the advance.
Show Sub-Attributes arrow
customfield_id
string
Unique identifier of the custom field.
value
string
Value of the custom field.

Query Parameters

delegate_user_id
string
ID of the user on whose behalf the advance is being created.

Headers

X-com-zoho-expense-organizationid
string
(Required)
ID of the organization

Request Example

Click to copy
parameters_data='{"field1":"value1","field2":"value2"}'; headers_data = Map(); headers_data.put("X-com-zoho-expense-organizationid", "10234695"); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/expense/v1/advancepayments" type: POST headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}"); Request request = new Request.Builder() .url("https://www.zohoapis.com/expense/v1/advancepayments") .post(body) .addHeader("X-com-zoho-expense-organizationid", "10234695") .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
const options = { method: 'POST', headers: { 'X-com-zoho-expense-organizationid': '10234695', Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'application/json' }, body: '{"field1":"value1","field2":"value2"}' }; fetch('https://www.zohoapis.com/expense/v1/advancepayments', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}" headers = { 'X-com-zoho-expense-organizationid': "10234695", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "application/json" } conn.request("POST", "/expense/v1/advancepayments", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "POST", "hostname": "www.zohoapis.com", "port": null, "path": "/expense/v1/advancepayments", "headers": { "X-com-zoho-expense-organizationid": "10234695", "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", "content-type": "application/json" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({field1: 'value1', field2: 'value2'})); req.end();
curl --request POST \ --url https://www.zohoapis.com/expense/v1/advancepayments \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'X-com-zoho-expense-organizationid: 10234695' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
{ "date": "2024-02-15", "amount": 5000, "exchange_rate": 1, "rcy_exchange_rate": 1, "notes": "Travel advance for client visit.", "reference_number": "ADV-00001", "currency_id": "16367000000000099", "account_id": "16367000000036003", "user_id": "16367000000073001", "trip_id": "34017000000000103", "customer_id": "16367000000088005", "project_id": "16367000000223045", "location_id": "16367000000110001", "custom_fields": [ { "customfield_id": "16367000000277001", "value": "FIN-001" } ] }

Response Example

{ "code": 0, "message": "Employee advance has been created successfully.", "advance_payment": { "advance_payment_id": "16367000000243203", "currency_id": "16367000000000099", "currency_code": "USD", "rcy_currency_id": "16367000000000099", "rcy_currency_code": "USD", "refund_currency_id": "16367000000000099", "account_id": "16367000000036003", "account_name": "Petty Cash", "to_account_id": "16367000000036007", "to_account_name": "Employee Advance", "reference_number": "ADV-00001", "notes": "Advance for business trip to New York.", "refund_notes": "Refund credited to petty cash.", "refund_reference_number": "REF-00001", "status": "approved", "sub_status": "", "advance_status": "unapplied", "exchange_rate": 1, "rcy_exchange_rate": 1, "refund_exchange_rate": 1, "amount": 5000, "bcy_amount": 5000, "rcy_amount": 5000, "refund_amount": 5000, "refund_bcy_amount": 5000, "refund_rcy_amount": 5000, "date": "2024-01-15", "refund_date": "2024-01-30", "price_precision": 2, "created_time": "2024-01-15T10:30:00+0530", "created_date": "2024-01-15", "last_modified_time": "2024-01-15T12:00:00+0530", "user_id": "16367000000073001", "user_name": "Will Smith", "user_email": "will.smith@zillum.com", "user_zuid": "12345678", "user_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "employee_no": "E001", "department_name": "Finance", "policy_id": "16367000000092011", "policy_name": "Default Policy", "created_by": "Will Smith", "created_by_id": "16367000000073071", "created_by_name": "Will Smith", "created_by_email": "will.smith@zillum.com", "created_by_employee_no": "E002", "creator_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "submitted_date": "2024-01-16", "last_submitted_date": "2024-01-16", "approved_date": "2024-01-17", "approver_id": "16367000000073001", "approver_name": "PATRICIA BOYLE", "approver_email": "patriciab@zillum.com", "approver_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "approver_employee_no": "E001", "approver_zuid": "23456789", "submitted_to_id": "16367000000073001", "submitted_to_name": "PATRICIA BOYLE", "submitted_to_email": "patriciab@zillum.com", "submitted_to_employee_no": "E001", "customer_id": "16367000000088005", "customer_name": "Zillum Corp", "project_id": "16367000000223045", "project_name": "Brochure Design", "report_id": "16367000000081005", "report_name": "Trip to SFA", "report_number": "ER-00001", "report_status": "approved", "trip_id": "16367000000312001", "trip_number": "TR-00001", "trip_name": "Business trip to New York", "trip_status": "approved", "is_carried_forward_advance": false, "reference_report_id": "16367000000081005", "refund_recorded_by": "Will Smith", "refund_recorded_by_id": "16367000000073071", "location_id": "16367000000401005", "documents": [ { "document_id": "16367000000078085", "file_name": "receipt.pdf", "file_size_formatted": "45.2 KB", "attachment_order": 1 } ], "expense_reports": [ { "reimbursement_entity_id": "16367000000501001", "report_id": "16367000000081005", "report_name": "Trip to SFA", "amount": 3000, "date": "2024-01-20", "report_number": "ER-00001", "report_status": "approved" } ], "comments": [ { "comment_id": "16367000000601001", "advance_id": "16367000000243203", "commented_by": "PATRICIA BOYLE", "commented_by_id": "16367000000073001", "date": "2024-01-17", "type": "comment", "previous_status": "submitted", "approval_status": "approved" } ], "custom_fields": [ { "customfield_id": "16367000000277001", "label": "Department Code", "value": "FIN-001" } ] } }

List advance payments AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

List all advance payments for the organization.
OAuth Scope : ZohoExpense.advance.READ

Query Parameters

filter_by
string
Filter advance payments by status or type. Allowed values: Status.All, Status.Draft, Status.Submitted, Status.Approved, Status.UnApproved, Status.Rejected, Status.Unsubmitted, Status.ModifiableAdvances, Status.Void, Status.Exported, Status.Unexported, Type.All, Type.Approval, Type.Advance, Type.MyApproval, Type.SharedAdvance.
status
string
Filter by advance status. Allowed values: all, submitted, draft, recalled, approved, unapproved, rejected, unsubmitted, modifiable, applied, unapplied, unrefunded, void. Multiple values can be combined with commas.
type
string
Type of view. Allowed values: approval, myapproval, advance.
advance_type
string
Type of advance. Allowed value cash.
user_id
string
Filter by the employee's user ID.
created_by
string
Filter advances by the user who created them.
trip_id
string
Filter advances by trip.
report_id
string
Filter advances by associated expense report.
customer_id
string
Filter advances by customer.
project_id
string
Filter advances by project.
currency_id
string
Filter advances by currency.
from_account_id
string
Filter advances by paid-through account.
to_account_id
string
Filter advances by destination account.
export_status
string
Filter by export status. Allowed values: exported, unexported.
approved_by
string
Filter advances by the user who approved them.
submitted_by
string
Filter advances by the user who submitted them.
submitted_to
string
Filter advances by the user to whom they were submitted.
customview_id
string
ID of the custom view.
search_text
string
Search advances by reference number, notes, or user name.
sort_column
string
Column to sort the results by. Allowed values: user_name, date, reference_number, created_by_name, amount, status, approver_name, customer_name, employee_no, account_name, project_name, report_number, report_name, submitted_date, last_submitted_date, trip_number.
sort_order
string
Sort order. Allowed values: A for ascending, D for descending.
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

X-com-zoho-expense-organizationid
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("X-com-zoho-expense-organizationid", "10234695"); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/expense/v1/advancepayments" type: GET headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/expense/v1/advancepayments") .get() .addHeader("X-com-zoho-expense-organizationid", "10234695") .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { 'X-com-zoho-expense-organizationid': '10234695', Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/expense/v1/advancepayments', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'X-com-zoho-expense-organizationid': "10234695", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/expense/v1/advancepayments", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/expense/v1/advancepayments", "headers": { "X-com-zoho-expense-organizationid": "10234695", "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request GET \ --url https://www.zohoapis.com/expense/v1/advancepayments \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'X-com-zoho-expense-organizationid: 10234695'

Response Example

{ "code": 0, "message": "success", "advance_payments": [ { "advance_payment_id": "16367000000243203", "currency_id": "16367000000000099", "currency_code": "USD", "rcy_currency_id": "16367000000000099", "rcy_currency_code": "USD", "refund_currency_id": "16367000000000099", "account_id": "16367000000036003", "account_name": "Petty Cash", "to_account_id": "16367000000036007", "to_account_name": "Employee Advance", "reference_number": "ADV-00001", "notes": "Advance for business trip to New York.", "refund_notes": "Refund credited to petty cash.", "refund_reference_number": "REF-00001", "status": "approved", "sub_status": "", "advance_status": "unapplied", "exchange_rate": 1, "rcy_exchange_rate": 1, "refund_exchange_rate": 1, "amount": 5000, "bcy_amount": 5000, "rcy_amount": 5000, "refund_amount": 5000, "refund_bcy_amount": 5000, "refund_rcy_amount": 5000, "date": "2024-01-15", "refund_date": "2024-01-30", "price_precision": 2, "created_time": "2024-01-15T10:30:00+0530", "created_date": "2024-01-15", "last_modified_time": "2024-01-15T12:00:00+0530", "user_id": "16367000000073001", "user_name": "Will Smith", "user_email": "will.smith@zillum.com", "user_zuid": "12345678", "user_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "employee_no": "E001", "department_name": "Finance", "policy_id": "16367000000092011", "policy_name": "Default Policy", "created_by": "Will Smith", "created_by_id": "16367000000073071", "created_by_name": "Will Smith", "created_by_email": "will.smith@zillum.com", "created_by_employee_no": "E002", "creator_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "submitted_date": "2024-01-16", "last_submitted_date": "2024-01-16", "approved_date": "2024-01-17", "approver_id": "16367000000073001", "approver_name": "PATRICIA BOYLE", "approver_email": "patriciab@zillum.com", "approver_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "approver_employee_no": "E001", "approver_zuid": "23456789", "submitted_to_id": "16367000000073001", "submitted_to_name": "PATRICIA BOYLE", "submitted_to_email": "patriciab@zillum.com", "submitted_to_employee_no": "E001", "customer_id": "16367000000088005", "customer_name": "Zillum Corp", "project_id": "16367000000223045", "project_name": "Brochure Design", "report_id": "16367000000081005", "report_name": "Trip to SFA", "report_number": "ER-00001", "report_status": "approved", "trip_id": "16367000000312001", "trip_number": "TR-00001", "trip_name": "Business trip to New York", "trip_status": "approved", "is_carried_forward_advance": false, "reference_report_id": "16367000000081005", "refund_recorded_by": "Will Smith", "refund_recorded_by_id": "16367000000073071", "location_id": "16367000000401005", "documents": [ { "document_id": "16367000000078085", "file_name": "receipt.pdf", "file_size_formatted": "45.2 KB", "attachment_order": 1 } ], "expense_reports": [ { "reimbursement_entity_id": "16367000000501001", "report_id": "16367000000081005", "report_name": "Trip to SFA", "amount": 3000, "date": "2024-01-20", "report_number": "ER-00001", "report_status": "approved" } ], "comments": [ { "comment_id": "16367000000601001", "advance_id": "16367000000243203", "commented_by": "PATRICIA BOYLE", "commented_by_id": "16367000000073001", "date": "2024-01-17", "type": "comment", "previous_status": "submitted", "approval_status": "approved" } ], "custom_fields": [ { "customfield_id": "16367000000277001", "label": "Department Code", "value": "FIN-001" } ] }, {...}, {...} ], "page_context": { "page": 1, "per_page": 200, "has_more_page": false, "report_name": "Advance Payment Details", "applied_filter": "Status.All", "sort_column": "created_time", "sort_order": "D" } }

Update an advance 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

Update the details of an existing advance payment. Only draft advances can be edited.
OAuth Scope : ZohoExpense.advance.UPDATE

Path Parameters

advance_payment_id
string
(Required)
Unique identifier of the advance payment.

Query Parameters

send
boolean
Whether to submit the advance for approval after update. Allowed values true and false.

Headers

X-com-zoho-expense-organizationid
string
(Required)
ID of the organization

Request Example

Click to copy
parameters_data='{"field1":"value1","field2":"value2"}'; headers_data = Map(); headers_data.put("X-com-zoho-expense-organizationid", "10234695"); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/expense/v1/advancepayments/16367000000243203" type: PUT headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}"); Request request = new Request.Builder() .url("https://www.zohoapis.com/expense/v1/advancepayments/16367000000243203") .put(body) .addHeader("X-com-zoho-expense-organizationid", "10234695") .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
const options = { method: 'PUT', headers: { 'X-com-zoho-expense-organizationid': '10234695', Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'application/json' }, body: '{"field1":"value1","field2":"value2"}' }; fetch('https://www.zohoapis.com/expense/v1/advancepayments/16367000000243203', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}" headers = { 'X-com-zoho-expense-organizationid': "10234695", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "application/json" } conn.request("PUT", "/expense/v1/advancepayments/16367000000243203", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "PUT", "hostname": "www.zohoapis.com", "port": null, "path": "/expense/v1/advancepayments/16367000000243203", "headers": { "X-com-zoho-expense-organizationid": "10234695", "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", "content-type": "application/json" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({field1: 'value1', field2: 'value2'})); req.end();
curl --request PUT \ --url https://www.zohoapis.com/expense/v1/advancepayments/16367000000243203 \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'X-com-zoho-expense-organizationid: 10234695' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

Click to copy
{ "date": "2024-02-15", "amount": 5000, "exchange_rate": 1, "rcy_exchange_rate": 1, "notes": "Travel advance for client visit.", "reference_number": "ADV-00001", "currency_id": "16367000000000099", "account_id": "16367000000036003", "user_id": "16367000000073001", "trip_id": "34017000000000103", "customer_id": "16367000000088005", "project_id": "16367000000223045", "location_id": "16367000000110001", "custom_fields": [ { "customfield_id": "16367000000277001", "value": "FIN-001" } ] }

Response Example

{ "code": 0, "message": "Employee advance has been updated successfully.", "advance_payment": { "advance_payment_id": "16367000000243203", "currency_id": "16367000000000099", "currency_code": "USD", "rcy_currency_id": "16367000000000099", "rcy_currency_code": "USD", "refund_currency_id": "16367000000000099", "account_id": "16367000000036003", "account_name": "Petty Cash", "to_account_id": "16367000000036007", "to_account_name": "Employee Advance", "reference_number": "ADV-00001", "notes": "Advance for business trip to New York.", "refund_notes": "Refund credited to petty cash.", "refund_reference_number": "REF-00001", "status": "approved", "sub_status": "", "advance_status": "unapplied", "exchange_rate": 1, "rcy_exchange_rate": 1, "refund_exchange_rate": 1, "amount": 5000, "bcy_amount": 5000, "rcy_amount": 5000, "refund_amount": 5000, "refund_bcy_amount": 5000, "refund_rcy_amount": 5000, "date": "2024-01-15", "refund_date": "2024-01-30", "price_precision": 2, "created_time": "2024-01-15T10:30:00+0530", "created_date": "2024-01-15", "last_modified_time": "2024-01-15T12:00:00+0530", "user_id": "16367000000073001", "user_name": "Will Smith", "user_email": "will.smith@zillum.com", "user_zuid": "12345678", "user_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "employee_no": "E001", "department_name": "Finance", "policy_id": "16367000000092011", "policy_name": "Default Policy", "created_by": "Will Smith", "created_by_id": "16367000000073071", "created_by_name": "Will Smith", "created_by_email": "will.smith@zillum.com", "created_by_employee_no": "E002", "creator_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "submitted_date": "2024-01-16", "last_submitted_date": "2024-01-16", "approved_date": "2024-01-17", "approver_id": "16367000000073001", "approver_name": "PATRICIA BOYLE", "approver_email": "patriciab@zillum.com", "approver_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "approver_employee_no": "E001", "approver_zuid": "23456789", "submitted_to_id": "16367000000073001", "submitted_to_name": "PATRICIA BOYLE", "submitted_to_email": "patriciab@zillum.com", "submitted_to_employee_no": "E001", "customer_id": "16367000000088005", "customer_name": "Zillum Corp", "project_id": "16367000000223045", "project_name": "Brochure Design", "report_id": "16367000000081005", "report_name": "Trip to SFA", "report_number": "ER-00001", "report_status": "approved", "trip_id": "16367000000312001", "trip_number": "TR-00001", "trip_name": "Business trip to New York", "trip_status": "approved", "is_carried_forward_advance": false, "reference_report_id": "16367000000081005", "refund_recorded_by": "Will Smith", "refund_recorded_by_id": "16367000000073071", "location_id": "16367000000401005", "documents": [ { "document_id": "16367000000078085", "file_name": "receipt.pdf", "file_size_formatted": "45.2 KB", "attachment_order": 1 } ], "expense_reports": [ { "reimbursement_entity_id": "16367000000501001", "report_id": "16367000000081005", "report_name": "Trip to SFA", "amount": 3000, "date": "2024-01-20", "report_number": "ER-00001", "report_status": "approved" } ], "comments": [ { "comment_id": "16367000000601001", "advance_id": "16367000000243203", "commented_by": "PATRICIA BOYLE", "commented_by_id": "16367000000073001", "date": "2024-01-17", "type": "comment", "previous_status": "submitted", "approval_status": "approved" } ], "custom_fields": [ { "customfield_id": "16367000000277001", "label": "Department Code", "value": "FIN-001" } ] } }

Retrieve an advance 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

Retrieve the details of an existing advance payment.
OAuth Scope : ZohoExpense.advance.READ

Path Parameters

advance_payment_id
string
(Required)
Unique identifier of the advance payment.

Query Parameters

print
boolean
Whether the response is requested in a printable format. Allowed values true and false.

Headers

X-com-zoho-expense-organizationid
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("X-com-zoho-expense-organizationid", "10234695"); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/expense/v1/advancepayments/16367000000243203" type: GET headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/expense/v1/advancepayments/16367000000243203") .get() .addHeader("X-com-zoho-expense-organizationid", "10234695") .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { 'X-com-zoho-expense-organizationid': '10234695', Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/expense/v1/advancepayments/16367000000243203', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'X-com-zoho-expense-organizationid': "10234695", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/expense/v1/advancepayments/16367000000243203", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/expense/v1/advancepayments/16367000000243203", "headers": { "X-com-zoho-expense-organizationid": "10234695", "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request GET \ --url https://www.zohoapis.com/expense/v1/advancepayments/16367000000243203 \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'X-com-zoho-expense-organizationid: 10234695'

Response Example

{ "code": 0, "message": "success", "advance_payment": { "advance_payment_id": "16367000000243203", "currency_id": "16367000000000099", "currency_code": "USD", "rcy_currency_id": "16367000000000099", "rcy_currency_code": "USD", "refund_currency_id": "16367000000000099", "account_id": "16367000000036003", "account_name": "Petty Cash", "to_account_id": "16367000000036007", "to_account_name": "Employee Advance", "reference_number": "ADV-00001", "notes": "Advance for business trip to New York.", "refund_notes": "Refund credited to petty cash.", "refund_reference_number": "REF-00001", "status": "approved", "sub_status": "", "advance_status": "unapplied", "exchange_rate": 1, "rcy_exchange_rate": 1, "refund_exchange_rate": 1, "amount": 5000, "bcy_amount": 5000, "rcy_amount": 5000, "refund_amount": 5000, "refund_bcy_amount": 5000, "refund_rcy_amount": 5000, "date": "2024-01-15", "refund_date": "2024-01-30", "price_precision": 2, "created_time": "2024-01-15T10:30:00+0530", "created_date": "2024-01-15", "last_modified_time": "2024-01-15T12:00:00+0530", "user_id": "16367000000073001", "user_name": "Will Smith", "user_email": "will.smith@zillum.com", "user_zuid": "12345678", "user_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "employee_no": "E001", "department_name": "Finance", "policy_id": "16367000000092011", "policy_name": "Default Policy", "created_by": "Will Smith", "created_by_id": "16367000000073071", "created_by_name": "Will Smith", "created_by_email": "will.smith@zillum.com", "created_by_employee_no": "E002", "creator_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "submitted_date": "2024-01-16", "last_submitted_date": "2024-01-16", "approved_date": "2024-01-17", "approver_id": "16367000000073001", "approver_name": "PATRICIA BOYLE", "approver_email": "patriciab@zillum.com", "approver_photo_url": "https://contacts.zoho.com/file?ID=abc123&fs=thumb", "approver_employee_no": "E001", "approver_zuid": "23456789", "submitted_to_id": "16367000000073001", "submitted_to_name": "PATRICIA BOYLE", "submitted_to_email": "patriciab@zillum.com", "submitted_to_employee_no": "E001", "customer_id": "16367000000088005", "customer_name": "Zillum Corp", "project_id": "16367000000223045", "project_name": "Brochure Design", "report_id": "16367000000081005", "report_name": "Trip to SFA", "report_number": "ER-00001", "report_status": "approved", "trip_id": "16367000000312001", "trip_number": "TR-00001", "trip_name": "Business trip to New York", "trip_status": "approved", "is_carried_forward_advance": false, "reference_report_id": "16367000000081005", "refund_recorded_by": "Will Smith", "refund_recorded_by_id": "16367000000073071", "location_id": "16367000000401005", "documents": [ { "document_id": "16367000000078085", "file_name": "receipt.pdf", "file_size_formatted": "45.2 KB", "attachment_order": 1 } ], "expense_reports": [ { "reimbursement_entity_id": "16367000000501001", "report_id": "16367000000081005", "report_name": "Trip to SFA", "amount": 3000, "date": "2024-01-20", "report_number": "ER-00001", "report_status": "approved" } ], "comments": [ { "comment_id": "16367000000601001", "advance_id": "16367000000243203", "commented_by": "PATRICIA BOYLE", "commented_by_id": "16367000000073001", "date": "2024-01-17", "type": "comment", "previous_status": "submitted", "approval_status": "approved" } ], "custom_fields": [ { "customfield_id": "16367000000277001", "label": "Department Code", "value": "FIN-001" } ] } }

Delete an advance 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

Delete an existing advance payment.
OAuth Scope : ZohoExpense.advance.DELETE

Path Parameters

advance_payment_id
string
(Required)
Unique identifier of the advance payment.

Headers

X-com-zoho-expense-organizationid
string
(Required)
ID of the organization

Request Example

Click to copy
headers_data = Map(); headers_data.put("X-com-zoho-expense-organizationid", "10234695"); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/expense/v1/advancepayments/16367000000243203" type: DELETE headers: headers_data connection: <connection_name> ]; info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/expense/v1/advancepayments/16367000000243203") .delete(null) .addHeader("X-com-zoho-expense-organizationid", "10234695") .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'DELETE', headers: { 'X-com-zoho-expense-organizationid': '10234695', Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/expense/v1/advancepayments/16367000000243203', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'X-com-zoho-expense-organizationid': "10234695", 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("DELETE", "/expense/v1/advancepayments/16367000000243203", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "DELETE", "hostname": "www.zohoapis.com", "port": null, "path": "/expense/v1/advancepayments/16367000000243203", "headers": { "X-com-zoho-expense-organizationid": "10234695", "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request DELETE \ --url https://www.zohoapis.com/expense/v1/advancepayments/16367000000243203 \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'X-com-zoho-expense-organizationid: 10234695'

Response Example

{ "code": 0, "message": "Employee advance has been deleted successfully." }