Zoho Books
Accounting access for sales, purchases, banking, projects, and settings
OAuth647 native toolsIcon needs-review
This catalogue entry describes the current repository definition. Availability, scopes, and production readiness should be confirmed during private-beta onboarding.
Native tools
GET
zoho_books_list_bank_accounts
List view of accounts in Zoho Books
/bankaccounts
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| filter_by | string | optional | Zoho Books filter by parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_bank_account
Create a bank account in Zoho Books
/bankaccounts
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a bank account request schema |
GET
zoho_books_get_bank_account
Get account details in Zoho Books
/bankaccounts/{account_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_bank_account
Update bank account in Zoho Books
/bankaccounts/{account_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update bank account request schema |
DELETE
zoho_books_delete_bank_account
Delete an account in Zoho Books
/bankaccounts/{account_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_bank_account_inactive
Deactivate account. in Zoho Books
/bankaccounts/{account_id}/inactive
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_bank_account_active
Activate account in Zoho Books
/bankaccounts/{account_id}/active
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_import_bank_statements
Import a Bank/Credit Card Statement in Zoho Books
/bankstatements
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' import a bank/credit card statement request schema |
GET
zoho_books_get_last_imported_bank_statement
Get last imported statement in Zoho Books
/bankaccounts/{account_id}/statement/lastimported
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_last_imported_bank_statement
Delete last imported statement in Zoho Books
/bankaccounts/{account_id}/statement/{statement_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| statement_id | string | required | Zoho Books statement id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_bank_reconciliations
List bank reconciliations in Zoho Books
/bankaccounts/{account_id}/reconciliations
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_create_bank_reconciliation
Create a bank reconciliation in Zoho Books
/bankaccounts/{account_id}/reconciliations
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a bank reconciliation request schema |
GET
zoho_books_get_bank_reconciliation
Get a bank reconciliation in Zoho Books
/bankaccounts/{account_id}/reconciliations/{reconciliation_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| reconciliation_id | string | required | Zoho Books reconciliation id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_bank_reconciliation
Update a bank reconciliation in Zoho Books
/bankaccounts/{account_id}/reconciliations/{reconciliation_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| reconciliation_id | string | required | Zoho Books reconciliation id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a bank reconciliation request schema |
DELETE
zoho_books_delete_bank_reconciliation
Delete a bank reconciliation in Zoho Books
/bankaccounts/{account_id}/reconciliations/{reconciliation_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| reconciliation_id | string | required | Zoho Books reconciliation id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_save_bank_reconciliation_draft
Save a bank reconciliation as draft in Zoho Books
/bankaccounts/{account_id}/reconciliations/{reconciliation_id}/draft
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| reconciliation_id | string | required | Zoho Books reconciliation id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' save a bank reconciliation as draft request schema |
POST
zoho_books_add_bank_reconciliation_attachment
Add a reconciliation attachment in Zoho Books
/bankaccounts/{account_id}/reconciliations/{reconciliation_id}/attachment
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| reconciliation_id | string | required | Zoho Books reconciliation id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_bank_reconciliation_document
Delete a reconciliation document in Zoho Books
/bankaccounts/{account_id}/reconciliations/{reconciliation_id}/documents/{document_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| reconciliation_id | string | required | Zoho Books reconciliation id |
| document_id | string | required | Zoho Books document id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_bank_account_balances
List bank account balances in Zoho Books
/bankaccounts/balances
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_bank_accounts_overview
Get bank accounts overview in Zoho Books
/bankaccounts/overview
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_bank_account_balance
Get a bank account balance in Zoho Books
/bankaccounts/{account_id}/balance
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_bank_account_balances
Get bank account balances in Zoho Books
/bankaccounts/{account_id}/balances
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_bank_account_insights
Get bank account insights in Zoho Books
/bankaccounts/{account_id}/insights
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_bank_account_overview
Get a bank account overview in Zoho Books
/bankaccounts/{account_id}/overview
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_bank_account_statement_summary
Get a bank statement summary in Zoho Books
/bankaccounts/{account_id}/statementsummary
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_bank_account_subaccounts
List bank account sub-accounts in Zoho Books
/bankaccounts/{account_id}/subaccounts
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_bank_account_statements
List bank account statements in Zoho Books
/bankaccounts/{account_id}/statements
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_unreviewed_bank_statements
List unreviewed bank statements in Zoho Books
/bankaccounts/{account_id}/statements/unreviewed
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_bank_account_transactions
List bank account transactions in Zoho Books
/bankaccounts/{account_id}/transactions
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_bank_account_preferences
Get bank account preferences in Zoho Books
/bankaccounts/{account_id}/preferences
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_bank_account_preferences
Update bank account preferences in Zoho Books
/bankaccounts/{account_id}/preferences
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_bank_statement_import_encryption_key
Get bank statement import encryption key in Zoho Books
/bankaccounts/import/encryptionkey
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_bank_transactions
Get transactions list in Zoho Books
/banktransactions
13 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| account_id | string | optional | Zoho Books account id parameter |
| transaction_type | string | optional | Zoho Books transaction type parameter |
| date | string | optional | Zoho Books date parameter |
| amount | string | optional | Zoho Books amount parameter |
| status | string | optional | Zoho Books status parameter |
| reference_number | string | optional | Zoho Books reference number parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| transaction_status | string | optional | Zoho Books transaction status parameter |
| search_text | string | optional | Zoho Books search text parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_bank_transaction
Create a transaction for an account in Zoho Books
/banktransactions
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a transaction for an account request schema |
GET
zoho_books_get_bank_transaction
Get transaction in Zoho Books
/banktransactions/{bank_transaction_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bank_transaction_id | string | required | Zoho Books bank transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_bank_transaction
Update a transaction in Zoho Books
/banktransactions/{bank_transaction_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bank_transaction_id | string | required | Zoho Books bank transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a transaction request schema |
DELETE
zoho_books_delete_bank_transaction
Delete a transaction in Zoho Books
/banktransactions/{bank_transaction_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bank_transaction_id | string | required | Zoho Books bank transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_matching_bank_transactions
Get matching transactions in Zoho Books
/banktransactions/uncategorized/{transaction_id}/match
12 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| transaction_type | string | optional | Zoho Books transaction type parameter |
| date_after | string | optional | Zoho Books date after parameter |
| date_before | string | optional | Zoho Books date before parameter |
| amount_start | string | optional | Zoho Books amount start parameter |
| amount_end | string | optional | Zoho Books amount end parameter |
| contact | string | optional | Zoho Books contact parameter |
| reference_number | string | optional | Zoho Books reference number parameter |
| show_all_transactions | boolean | optional | Zoho Books show all transactions parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_match_bank_transaction
Match a transaction in Zoho Books
/banktransactions/uncategorized/{transaction_id}/match
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| account_id | string | optional | Zoho Books account id parameter |
| body | object | optional | JSON object matching Zoho Books' match a transaction request schema |
POST
zoho_books_unmatch_bank_transaction
Unmatch a matched transaction in Zoho Books
/banktransactions/{transaction_id}/unmatch
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| account_id | string | optional | Zoho Books account id parameter |
POST
zoho_books_exclude_bank_transaction
Exclude a transaction in Zoho Books
/banktransactions/uncategorized/{transaction_id}/exclude
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| account_id | string | optional | Zoho Books account id parameter |
POST
zoho_books_restore_bank_transaction
Restore a transaction in Zoho Books
/banktransactions/uncategorized/{transaction_id}/restore
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| account_id | string | optional | Zoho Books account id parameter |
POST
zoho_books_categorize_bank_transaction
Categorize an uncategorized transaction in Zoho Books
/banktransactions/uncategorized/{transaction_id}/categorize
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' categorize an uncategorized transaction request schema |
POST
zoho_books_categorize_bank_transaction_as_expense
Categorize as expense in Zoho Books
/banktransactions/uncategorized/{transaction_id}/categorize/expenses
6 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| doc | string | optional | Zoho Books doc parameter |
| totalFiles | string | optional | Zoho Books totalfiles parameter |
| document_ids | string | optional | Zoho Books document ids parameter |
| body | object | optional | JSON object matching Zoho Books' categorize as expense request schema |
POST
zoho_books_uncategorize_bank_transaction
Uncategorize a categorized transaction in Zoho Books
/banktransactions/{transaction_id}/uncategorize
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| account_id | string | optional | Zoho Books account id parameter |
POST
zoho_books_categorize_bank_transaction_as_vendor_payment
Categorize a vendor payment in Zoho Books
/banktransactions/uncategorized/{transaction_id}/categorize/vendorpayments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' categorize a vendor payment request schema |
POST
zoho_books_categorize_bank_transaction_as_customer_payment
Categorize as customer payment in Zoho Books
/banktransactions/uncategorized/{transaction_id}/categorize/customerpayments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' categorize as customer payment request schema |
POST
zoho_books_categorize_as_credit_note_refunds
Categorize as credit note refunds in Zoho Books
/banktransactions/uncategorized/{transaction_id}/categorize/creditnoterefunds
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' categorize as credit note refunds request schema |
POST
zoho_books_categorize_as_vendor_credit_refunds
Categorize as vendor credit refunds in Zoho Books
/banktransactions/uncategorized/{transaction_id}/categorize/vendorcreditrefunds
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' categorize as vendor credit refunds request schema |
POST
zoho_books_categorize_bank_transaction_as_payment_refund
Categorize as Customer Payment refund in Zoho Books
/banktransactions/uncategorized/{statement_line_id}/categorize/paymentrefunds
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| statement_line_id | string | required | Zoho Books statement line id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' categorize as customer payment refund request schema |
POST
zoho_books_categorize_as_vendor_payment_refund
Categorize as Vendor Payment refund in Zoho Books
/banktransactions/uncategorized/{statement_line_id}/categorize/vendorpaymentrefunds
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| statement_line_id | string | required | Zoho Books statement line id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' categorize as vendor payment refund request schema |
GET
zoho_books_list_bills
List bills in Zoho Books
/bills
26 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| bill_number | string | optional | Zoho Books bill number parameter |
| reference_number | string | optional | Zoho Books reference number parameter |
| date | string | optional | Zoho Books date parameter |
| due_date | string | optional | Zoho Books due date parameter |
| created_date | string | optional | Zoho Books created date parameter |
| status | string | optional | Zoho Books status parameter |
| description | string | optional | Zoho Books description parameter |
| vendor_name | string | optional | Zoho Books vendor name parameter |
| total | string | optional | Zoho Books total parameter |
| vendor_id | string | optional | Zoho Books vendor id parameter |
| project_id | string | optional | Zoho Books project id parameter |
| item_name | string | optional | Zoho Books item name parameter |
| item_description | string | optional | Zoho Books item description parameter |
| item_id | string | optional | Zoho Books item id parameter |
| recurring_bill_id | string | optional | Zoho Books recurring bill id parameter |
| purchaseorder_id | string | optional | Zoho Books purchaseorder id parameter |
| last_modified_time | string | optional | Zoho Books last modified time parameter |
| customer_id | string | optional | Zoho Books customer id parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| search_text | string | optional | Zoho Books search text parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
| location_ids | string | optional | Zoho Books location ids parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| sort_order | string | optional | Zoho Books sort order parameter |
POST
zoho_books_create_bill
Create a bill in Zoho Books
/bills
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a bill request schema |
PUT
zoho_books_update_bill_using_custom_field
Update a bill using a custom field's unique value in Zoho Books
/bills
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a bill using a custom field's unique value request schema |
GET
zoho_books_get_bill
Get a bill in Zoho Books
/bills/{bill_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_bill
Update a bill in Zoho Books
/bills/{bill_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a bill request schema |
DELETE
zoho_books_delete_bill
Delete a bill in Zoho Books
/bills/{bill_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_custom_fields_in_bill
Update custom field in existing bills in Zoho Books
/bill/{bill_id}/customfields
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | array | optional | JSON array matching Zoho Books' update custom field in existing bills request schema |
POST
zoho_books_mark_bill_void
Void a bill in Zoho Books
/bills/{bill_id}/status/void
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_bill_open
Mark a bill as open in Zoho Books
/bills/{bill_id}/status/open
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_submit_bill
Submit a bill for approval in Zoho Books
/bills/{bill_id}/submit
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_approve_bill
Approve a bill in Zoho Books
/bills/{bill_id}/approve
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_bill_billing_address
Update billing address in Zoho Books
/bills/{bill_id}/address/billing
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update billing address request schema |
GET
zoho_books_list_bill_payments
List bill payments in Zoho Books
/bills/{bill_id}/payments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_apply_credits_to_bill
Apply credits in Zoho Books
/bills/{bill_id}/credits
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' apply credits request schema |
DELETE
zoho_books_delete_bill_payment
Delete a payment in Zoho Books
/bills/{bill_id}/payments/{bill_payment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| bill_payment_id | string | required | Zoho Books bill payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_bill_attachment
Delete an attachment in Zoho Books
/bills/{bill_id}/attachment
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_bill_comments
List bill comments & history in Zoho Books
/bills/{bill_id}/comments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_bill_comment
Add comment in Zoho Books
/bills/{bill_id}/comments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add comment request schema |
DELETE
zoho_books_delete_bill_comment
Delete a comment in Zoho Books
/bills/{bill_id}/comments/{comment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| bill_id | string | required | Zoho Books bill id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_convert_purchase_order_to_bill
Convert PO to Bill in Zoho Books
/bills/editpage/frompurchaseorders
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_ids | string | required | Zoho Books purchaseorder ids parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_chart_of_accounts
List chart of accounts in Zoho Books
/chartofaccounts
12 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| showbalance | string | optional | Zoho Books showbalance parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| last_modified_time | string | optional | Zoho Books last modified time parameter |
| customview_id | string | optional | Zoho Books customview id parameter |
| account_id | string | optional | Zoho Books account id parameter |
| account_code | string | optional | Zoho Books account code parameter |
| account_name | string | optional | Zoho Books account name parameter |
| search_text | string | optional | Zoho Books search text parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_chart_of_account
Create an account in Zoho Books
/chartofaccounts
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create an account request schema |
GET
zoho_books_get_chart_of_account
Get an account in Zoho Books
/chartofaccounts/{account_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_chart_of_account
Update an account in Zoho Books
/chartofaccounts/{account_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update an account request schema |
DELETE
zoho_books_delete_chart_of_account
Delete an account in Zoho Books
/chartofaccounts/{account_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_chart_of_account_active
Mark an account as active in Zoho Books
/chartofaccounts/{account_id}/active
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_chart_of_account_inactive
Mark an account as inactive in Zoho Books
/chartofaccounts/{account_id}/inactive
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_bulk_mark_chart_of_accounts_active
Bulk mark accounts as active in Zoho Books
/chartofaccounts/active
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| account_ids | string | required | Zoho Books account ids parameter |
POST
zoho_books_bulk_mark_chart_of_accounts_inactive
Bulk mark accounts as inactive in Zoho Books
/chartofaccounts/inactive
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| account_ids | string | required | Zoho Books account ids parameter |
DELETE
zoho_books_bulk_delete_chart_of_accounts
Bulk delete accounts in Zoho Books
/chartofaccounts/bulkdelete
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| account_ids | string | required | Zoho Books account ids parameter |
GET
zoho_books_list_chart_of_account_transactions
List of transactions for an account in Zoho Books
/chartofaccounts/accounttransactions
17 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| account_id | string | required | Zoho Books account id parameter |
| date | string | optional | Zoho Books date parameter |
| date_start | string | optional | Zoho Books date start parameter |
| date_end | string | optional | Zoho Books date end parameter |
| date_before | string | optional | Zoho Books date before parameter |
| date_after | string | optional | Zoho Books date after parameter |
| amount | string | optional | Zoho Books amount parameter |
| amount_less_than | string | optional | Zoho Books amount less than parameter |
| amount_less_equals | string | optional | Zoho Books amount less equals parameter |
| amount_greater_than | string | optional | Zoho Books amount greater than parameter |
| amount_greater_equals | string | optional | Zoho Books amount greater equals parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| transaction_type | string | optional | Zoho Books transaction type parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
DELETE
zoho_books_delete_chart_of_account_transaction
Delete a transaction in Zoho Books
/chartofaccounts/transactions/{transaction_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_contacts
List Contacts in Zoho Books
/contacts
17 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| contact_type | string | optional | Zoho Books contact type parameter |
| contact_name | string | optional | Zoho Books contact name parameter |
| company_name | string | optional | Zoho Books company name parameter |
| first_name | string | optional | Zoho Books first name parameter |
| last_name | string | optional | Zoho Books last name parameter |
| address | string | optional | Zoho Books address parameter |
| string | optional | Zoho Books email parameter | |
| phone | string | optional | Zoho Books phone parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| search_text | string | optional | Zoho Books search text parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| zcrm_contact_id | string | optional | Zoho Books zcrm contact id parameter |
| zcrm_account_id | string | optional | Zoho Books zcrm account id parameter |
| zcrm_vendor_id | string | optional | Zoho Books zcrm vendor id parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_contact
Create a Contact in Zoho Books
/contacts
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a contact request schema |
PUT
zoho_books_update_contact_using_custom_field
Update a contact using a custom field's unique value in Zoho Books
/contacts
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a contact using a custom field's unique value request schema |
DELETE
zoho_books_delete_contacts
Delete contacts in Zoho Books
/contacts
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| contact_ids | string | required | Zoho Books contact ids parameter |
POST
zoho_books_assign_contact_owner
Assign an Owner to a Contact in Zoho Books
/contacts/{contact_id}/owner
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| owner_id | string | optional | Zoho Books owner id parameter |
POST
zoho_books_assign_owner_to_contacts
Assign an Owner to Multiple Contacts in Zoho Books
/contacts/owner
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| contact_ids | string | required | Zoho Books contact ids parameter |
| owner_id | string | optional | Zoho Books owner id parameter |
POST
zoho_books_mark_contacts_for_1099_tracking
Mark Multiple Contacts for 1099 Tracking in Zoho Books
/contacts/track1099
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| contact_ids | string | optional | Zoho Books contact ids parameter |
POST
zoho_books_verify_contact_bank_account
Verify a Contact Bank Account in Zoho Books
/contacts/{contact_id}/bankaccount/{bank_account_id}/verify
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| bank_account_id | string | required | Zoho Books bank account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| first_deposit_amount | string | optional | Zoho Books first deposit amount parameter |
| second_deposit_amount | string | optional | Zoho Books second deposit amount parameter |
GET
zoho_books_verify_contact_address
Verify a Contact Address in Zoho Books
/contacts/address/verify
6 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| line1 | string | required | Zoho Books line1 parameter |
| city | string | optional | Zoho Books city parameter |
| region | string | optional | Zoho Books region parameter |
| country | string | optional | Zoho Books country parameter |
| postal_code | string | optional | Zoho Books postal code parameter |
GET
zoho_books_list_contact_autobill_recurring_invoices
List Auto-bill Recurring Invoices for a Contact Card in Zoho Books
/contacts/{contact_id}/card/{card_id}/recurringinvoices
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| card_id | string | required | Zoho Books card id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact
Get Contact in Zoho Books
/contacts/{contact_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_contact
Update a Contact in Zoho Books
/contacts/{contact_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a contact request schema |
DELETE
zoho_books_delete_contact
Delete a Contact in Zoho Books
/contacts/{contact_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_contact_active
Mark as Active in Zoho Books
/contacts/{contact_id}/active
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_contact_inactive
Mark as Inactive in Zoho Books
/contacts/{contact_id}/inactive
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_enable_contact_portal
Enable Portal Access in Zoho Books
/contacts/{contact_id}/portal/enable
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' enable portal access request schema |
POST
zoho_books_enable_contact_payment_reminder
Enable Payment Reminders in Zoho Books
/contacts/{contact_id}/paymentreminder/enable
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_disable_contact_payment_reminder
Disable Payment Reminders in Zoho Books
/contacts/{contact_id}/paymentreminder/disable
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact_statement_mail
Get Statement Mail Content in Zoho Books
/contacts/{contact_id}/statements/email
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| start_date | string | optional | Zoho Books start date parameter |
| end_date | string | optional | Zoho Books end date parameter |
POST
zoho_books_email_contact_statement
Email Statement in Zoho Books
/contacts/{contact_id}/statements/email
6 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| start_date | string | optional | Zoho Books start date parameter |
| end_date | string | optional | Zoho Books end date parameter |
| multipart_or_formdata | string | optional | Zoho Books multipart or formdata parameter |
| body | object | optional | JSON object matching Zoho Books' email statement request schema |
GET
zoho_books_get_contact_email_content
Get contact email content in Zoho Books
/contacts/{contact_id}/email
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_email_contact
Email Contact in Zoho Books
/contacts/{contact_id}/email
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| send_customer_statement | string | optional | Zoho Books send customer statement parameter |
| body | object | optional | JSON object matching Zoho Books' email contact request schema |
GET
zoho_books_list_contact_comments
List Comments in Zoho Books
/contacts/{contact_id}/comments
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_add_contact_comment
Add a comment to a contact in Zoho Books
/contacts/{contact_id}/comments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add a comment to a contact request schema |
GET
zoho_books_get_contact_address
Get Contact Addresses in Zoho Books
/contacts/{contact_id}/address
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_contact_address
Add Additional Address in Zoho Books
/contacts/{contact_id}/address
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add additional address request schema |
PUT
zoho_books_update_contact_address
Edit Additional Address in Zoho Books
/contacts/{contact_id}/address/{address_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| address_id | string | required | Zoho Books address id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' edit additional address request schema |
DELETE
zoho_books_delete_contact_address
Delete Additional Address in Zoho Books
/contacts/{contact_id}/address/{address_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| address_id | string | required | Zoho Books address id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_contact_credit_note_refunds
List credit note refunds for a contact in Zoho Books
/contacts/{contact_id}/refunds
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_track_contact_1099
Track 1099 in Zoho Books
/contacts/{contact_id}/track1099
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_untrack_contact_1099
Untrack 1099 in Zoho Books
/contacts/{contact_id}/untrack1099
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_unused_retainer_payments
Get Unused Retainer Payments in Zoho Books
/contacts/{contact_id}/receivables/unusedretainerpayments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| currency_id | string | optional | Zoho Books currency id parameter |
POST
zoho_books_add_contact_bank_account
Add a bank account to a contact in Zoho Books
/contacts/{contact_id}/bankaccount
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add a bank account to a contact request schema |
GET
zoho_books_get_contact_bank_account
Get a contact bank account in Zoho Books
/contacts/{contact_id}/bankaccount/{bank_account_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| bank_account_id | string | required | Zoho Books bank account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_contact_bank_account
Update a contact bank account in Zoho Books
/contacts/{contact_id}/bankaccount/{bank_account_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| bank_account_id | string | required | Zoho Books bank account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a contact bank account request schema |
DELETE
zoho_books_delete_contact_bank_account
Delete a contact bank account in Zoho Books
/contacts/{contact_id}/bankaccount/{bank_account_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| bank_account_id | string | required | Zoho Books bank account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_approve_contact_bank_account
Approve a contact bank account in Zoho Books
/contacts/{contact_id}/bankaccount/{bank_account_id}/approve
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| bank_account_id | string | required | Zoho Books bank account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_decline_contact_bank_account
Decline a contact bank account in Zoho Books
/contacts/{contact_id}/bankaccount/{bank_account_id}/decline
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| bank_account_id | string | required | Zoho Books bank account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_contact_bank_accounts
List contact bank accounts in Zoho Books
/contacts/{contact_id}/bankaccounts
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_all_contact_bank_accounts
List all contact bank accounts in Zoho Books
/contacts/bankaccounts
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_contact_card
Add a card to a contact in Zoho Books
/contacts/{contact_id}/card
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add a card to a contact request schema |
GET
zoho_books_get_contact_card
Get a contact card in Zoho Books
/contacts/{contact_id}/card/{card_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| card_id | string | required | Zoho Books card id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_contact_card
Update a contact card in Zoho Books
/contacts/{contact_id}/card/{card_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| card_id | string | required | Zoho Books card id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a contact card request schema |
DELETE
zoho_books_delete_contact_card
Delete a contact card in Zoho Books
/contacts/{contact_id}/card/{card_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| card_id | string | required | Zoho Books card id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_contact_cards
List contact cards in Zoho Books
/contacts/{contact_id}/cards
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact_card_count
Get contact card count in Zoho Books
/contacts/cardcount
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_all_contact_persons
List all contact persons in Zoho Books
/contacts/contactpersons
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_contacts_create_contact_person
Create a contact person in Zoho Books
/contacts/contactpersons
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a contact person request schema |
GET
zoho_books_contacts_get_contact_person
Get a contact person in Zoho Books
/contacts/contactpersons/{contactperson_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contactperson_id | string | required | Zoho Books contactperson id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_contacts_update_contact_person
Update a contact person in Zoho Books
/contacts/contactpersons/{contactperson_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contactperson_id | string | required | Zoho Books contactperson id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a contact person request schema |
DELETE
zoho_books_contacts_delete_contact_person
Delete a contact person in Zoho Books
/contacts/contactpersons/{contactperson_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contactperson_id | string | required | Zoho Books contactperson id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_contacts_list_contact_persons
List contact persons of a contact in Zoho Books
/contacts/{contact_id}/contactpersons
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact_contact_person
Get a contact person of a contact in Zoho Books
/contacts/{contact_id}/contactpersons/{contactperson_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| contactperson_id | string | required | Zoho Books contactperson id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_contacts_mark_contact_person_primary
Mark a contact person as primary in Zoho Books
/contacts/contactpersons/{contactperson_id}/primary
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contactperson_id | string | required | Zoho Books contactperson id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_invite_contact_person_to_portal
Invite a contact person to the portal in Zoho Books
/contacts/contactpersons/{contactperson_id}/portal/invite
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contactperson_id | string | required | Zoho Books contactperson id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_resend_contact_person_portal_invite
Resend a portal invite in Zoho Books
/contacts/contactpersons/{contactperson_id}/portal/invite/resend
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contactperson_id | string | required | Zoho Books contactperson id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_enable_contact_person_sms
Enable SMS for a contact person in Zoho Books
/contacts/contactpersons/{contactperson_id}/sms/enable
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contactperson_id | string | required | Zoho Books contactperson id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_disable_contact_person_sms
Disable SMS for a contact person in Zoho Books
/contacts/contactpersons/{contactperson_id}/sms/disable
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contactperson_id | string | required | Zoho Books contactperson id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_contact_comment
Delete a contact comment in Zoho Books
/contacts/{contact_id}/comments/{comment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_contact_document
Update a contact document in Zoho Books
/contacts/{contact_id}/documents/{document_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| document_id | string | required | Zoho Books document id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_contact_document
Delete a contact document in Zoho Books
/contacts/{contact_id}/documents/{document_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| document_id | string | required | Zoho Books document id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_restore_contact_documents
Restore contact documents in Zoho Books
/contacts/documents/restore
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_contact_tags
Update contact tags in Zoho Books
/contacts/{contact_id}/tags
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update contact tags request schema |
DELETE
zoho_books_delete_contact_tag
Delete a contact tag in Zoho Books
/contacts/{contact_id}/tags/{tag_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| tag_id | string | required | Zoho Books tag id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_contact_tax_info
List contact tax information in Zoho Books
/contacts/{contact_id}/taxinfo
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_contact_tax_info
Add contact tax information in Zoho Books
/contacts/{contact_id}/taxinfo
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add contact tax information request schema |
PUT
zoho_books_update_contact_tax_info
Update contact tax information in Zoho Books
/contacts/{contact_id}/taxinfo/{tax_info_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| tax_info_id | string | required | Zoho Books tax info id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update contact tax information request schema |
DELETE
zoho_books_delete_contact_tax_info
Delete contact tax information in Zoho Books
/contacts/{contact_id}/taxinfo/{tax_info_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| tax_info_id | string | required | Zoho Books tax info id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_contact_addresses
List contact addresses in Zoho Books
/contacts/address
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_contact_address_as_billing
Mark an address as billing in Zoho Books
/contacts/{contact_id}/address/{address_id}/markasbilling
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| address_id | string | required | Zoho Books address id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_contact_address_as_shipping
Mark an address as shipping in Zoho Books
/contacts/{contact_id}/address/{address_id}/markasshipping
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| address_id | string | required | Zoho Books address id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_verify_contact_address_by_id
Verify a contact address in Zoho Books
/contacts/{contact_id}/address/{address_id}/verify
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| address_id | string | required | Zoho Books address id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_contact_attachment
Add an attachment to a contact in Zoho Books
/contacts/{contact_id}/attachment
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_merge_contact
Merge contacts in Zoho Books
/contacts/{contact_id}/merge
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_verify_contact_einvoice
Verify contact e-invoice details in Zoho Books
/contacts/{contact_id}/einvoice/verify
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_disable_contact_portal
Disable the contact portal in Zoho Books
/contacts/{contact_id}/portal/disable
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contacts_sms_content
Get bulk contact SMS content in Zoho Books
/contacts/sms
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_send_contacts_sms
Send SMS to contacts in Zoho Books
/contacts/sms
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact_sms_content
Get contact SMS content in Zoho Books
/contacts/{contact_id}/sms
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_send_contact_sms
Send SMS to a contact in Zoho Books
/contacts/{contact_id}/sms
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact_by_reference
Get a contact by reference in Zoho Books
/contacts/reference/{reference_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| reference_id | string | required | Zoho Books reference id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact_statement
Get a contact statement in Zoho Books
/contacts/{contact_id}/statements
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_contact_unpaid_invoices
List unpaid invoices of a contact in Zoho Books
/contacts/{contact_id}/unpaidinvoices
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact_unused_credits
Get unused credits of a contact in Zoho Books
/contacts/{contact_id}/receivables/unusedcredits
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_contact_payment_refunds
List payment refunds of a contact in Zoho Books
/contacts/{contact_id}/paymentrefunds
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact_income_and_expense
Get contact income and expense in Zoho Books
/contacts/{contact_id}/incomeandexpense
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact_profit_and_loss
Get contact profit and loss in Zoho Books
/contacts/{contact_id}/profitandloss
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact_inventory_summary
Get contact inventory summary in Zoho Books
/contacts/{contact_id}/inventorysummary
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact_opening_balances
Get contact opening balances in Zoho Books
/contacts/{contact_id}/openingbalances
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_update_contact_trn_status
Update contact TRN status in Zoho Books
/contacts/{contact_id}/trnstatus
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact_client_review_email
Get client review email content in Zoho Books
/contacts/{contact_id}/clientreviews/email
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_send_contact_client_review_email
Send a client review email in Zoho Books
/contacts/{contact_id}/clientreviews/email
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact_payment_method_email
Get payment method email content in Zoho Books
/contacts/{contact_id}/paymentmethod/email
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_send_contact_payment_method_email
Send a payment method request email in Zoho Books
/contacts/{contact_id}/paymentmethod/email
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_contact_vendor_statement_email
Get vendor statement email content in Zoho Books
/contacts/{contact_id}/vendorstatements/email
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_send_contact_vendor_statement_email
Send a vendor statement email in Zoho Books
/contacts/{contact_id}/vendorstatements/email
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Zoho Books contact id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_credit_notes
List all Credit Notes in Zoho Books
/creditnotes
20 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| creditnote_number | string | optional | Zoho Books creditnote number parameter |
| date | string | optional | Zoho Books date parameter |
| status | string | optional | Zoho Books status parameter |
| total | string | optional | Zoho Books total parameter |
| reference_number | string | optional | Zoho Books reference number parameter |
| customer_name | string | optional | Zoho Books customer name parameter |
| item_name | string | optional | Zoho Books item name parameter |
| customer_id | string | optional | Zoho Books customer id parameter |
| item_description | string | optional | Zoho Books item description parameter |
| item_id | string | optional | Zoho Books item id parameter |
| line_item_id | string | optional | Zoho Books line item id parameter |
| tax_id | string | optional | Zoho Books tax id parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| search_text | string | optional | Zoho Books search text parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| last_modified_time | string | optional | Zoho Books last modified time parameter |
| location_ids | string | optional | Zoho Books location ids parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_credit_note
Create a credit note in Zoho Books
/creditnotes
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| invoice_id | string | optional | Zoho Books invoice id parameter |
| ignore_auto_number_generation | string | optional | Zoho Books ignore auto number generation parameter |
| body | object | optional | JSON object matching Zoho Books' create a credit note request schema |
PUT
zoho_books_update_credit_note_using_custom_field
Update a credit note using a custom field's unique value in Zoho Books
/creditnotes
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a credit note using a custom field's unique value request schema |
GET
zoho_books_get_credit_note
Get a credit note in Zoho Books
/creditnotes/{creditnote_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| string | optional | Zoho Books print parameter | |
| accept | string | optional | Zoho Books accept parameter |
PUT
zoho_books_update_credit_note
Update a credit note in Zoho Books
/creditnotes/{creditnote_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| ignore_auto_number_generation | string | optional | Zoho Books ignore auto number generation parameter |
| body | object | optional | JSON object matching Zoho Books' update a credit note request schema |
DELETE
zoho_books_delete_credit_note
Delete a credit note in Zoho Books
/creditnotes/{creditnote_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_credit_note_email
Get email content in Zoho Books
/creditnotes/{creditnote_id}/email
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| email_template_id | string | optional | Zoho Books email template id parameter |
POST
zoho_books_email_credit_note
Email a credit note in Zoho Books
/creditnotes/{creditnote_id}/email
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| customer_id | string | optional | Zoho Books customer id parameter |
| body | object | optional | JSON object matching Zoho Books' email a credit note request schema |
POST
zoho_books_mark_credit_note_void
Void a Credit Note in Zoho Books
/creditnotes/{creditnote_id}/status/void
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_credit_note_draft
Convert Credit Note to Draft. in Zoho Books
/creditnotes/{creditnote_id}/status/draft
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_credit_note_open
Convert to Open in Zoho Books
/creditnotes/{creditnote_id}/status/open
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_submit_credit_note
Submit a credit note for approval in Zoho Books
/creditnotes/{creditnote_id}/submit
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_approve_credit_note
Approve a credit note. in Zoho Books
/creditnotes/{creditnote_id}/approve
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_credit_note_email_history
Email history in Zoho Books
/creditnotes/{creditnote_id}/emailhistory
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_credit_note_billing_address
Update billing address in Zoho Books
/creditnotes/{creditnote_id}/address/billing
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update billing address request schema |
PUT
zoho_books_update_credit_note_shipping_address
Update Shipping address in Zoho Books
/creditnotes/{creditnote_id}/address/shipping
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update shipping address request schema |
GET
zoho_books_list_credit_note_templates
List credit note template in Zoho Books
/creditnotes/templates
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_credit_note_template
Update a credit note template in Zoho Books
/creditnotes/{creditnote_id}/templates/{template_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| template_id | string | required | Zoho Books template id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_invoices_of_credit_note
List invoices credited in Zoho Books
/creditnotes/{creditnote_id}/invoices
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_apply_credit_note_to_invoice
Credit to an invoice in Zoho Books
/creditnotes/{creditnote_id}/invoices
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' credit to an invoice request schema |
DELETE
zoho_books_delete_invoice_of_credit_note
Delete invoices credited in Zoho Books
/creditnotes/{creditnote_id}/invoices/{creditnote_invoice_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| creditnote_invoice_id | string | required | Zoho Books creditnote invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_credit_note_comments
List credit note comments & history in Zoho Books
/creditnotes/{creditnote_id}/comments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_credit_note_comment
Add a comment in Zoho Books
/creditnotes/{creditnote_id}/comments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add a comment request schema |
DELETE
zoho_books_delete_credit_note_comment
Delete a Comment in Zoho Books
/creditnotes/{creditnote_id}/comments/{comment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_credit_note_refunds_of_all_credit_notes
List credit note refunds in Zoho Books
/creditnotes/refunds
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| customer_id | string | optional | Zoho Books customer id parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
GET
zoho_books_list_credit_note_refunds_of_a_credit_note
List refunds of a credit note in Zoho Books
/creditnotes/{creditnote_id}/refunds
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_credit_note_refund
Refund credit note in Zoho Books
/creditnotes/{creditnote_id}/refunds
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' refund credit note request schema |
GET
zoho_books_get_credit_note_refund
Get credit note refund in Zoho Books
/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| creditnote_refund_id | string | required | Zoho Books creditnote refund id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_credit_note_refund
Update credit note refund in Zoho Books
/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| creditnote_refund_id | string | required | Zoho Books creditnote refund id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update credit note refund request schema |
DELETE
zoho_books_delete_credit_note_refund
Delete credit note refund in Zoho Books
/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| creditnote_refund_id | string | required | Zoho Books creditnote refund id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_approve_credit_notes
Approve credit notes in Zoho Books
/creditnotes/approve
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| creditnote_ids | string | required | Zoho Books creditnote ids parameter |
POST
zoho_books_submit_credit_notes
Submit credit notes for approval in Zoho Books
/creditnotes/submit
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| creditnote_ids | string | required | Zoho Books creditnote ids parameter |
POST
zoho_books_finalize_credit_note_approval
Finalize approval of a credit note in Zoho Books
/creditnotes/{creditnote_id}/approve/final
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_reject_credit_note
Reject a credit note in Zoho Books
/creditnotes/{creditnote_id}/reject
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| reason | string | optional | Zoho Books reason parameter |
GET
zoho_books_get_credit_note_signature_template
Get the digital signature template of a credit note in Zoho Books
/creditnotes/{creditnote_id}/dsign/template
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_print_credit_notes
Print credit notes in Zoho Books
/creditnotes/print
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_ids | string | required | Zoho Books creditnote ids parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_credit_note_document
Update a credit note document in Zoho Books
/creditnotes/{creditnote_id}/documents/{document_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| document_id | string | required | Zoho Books document id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_credit_note_document
Delete a credit note document in Zoho Books
/creditnotes/{creditnote_id}/documents/{document_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| document_id | string | required | Zoho Books document id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_credit_note_custom_fields
Get credit note custom fields in Zoho Books
/creditnotes/{creditnote_id}/customfields
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_update_credit_note_custom_fields
Update credit note custom fields in Zoho Books
/creditnotes/{creditnote_id}/customfields
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update credit note custom fields request schema |
GET
zoho_books_get_credit_note_mail_content
Get credit note email content in Zoho Books
/creditnotes/{creditnote_id}/mailcontent
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_credit_note_digital_signature
Add a digital signature to a credit note in Zoho Books
/creditnotes/{creditnote_id}/dsign
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_credit_note_refund_by_id
Get a credit note refund in Zoho Books
/creditnotes/refunds/{refund_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| refund_id | string | required | Zoho Books refund id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_apply_credit_note_substatus
Apply a sub-status to a credit note in Zoho Books
/creditnotes/{creditnote_id}/substatus/{substatus_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| substatus_id | string | required | Zoho Books substatus id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_credit_note_substatus
Delete a credit note sub-status in Zoho Books
/creditnotes/{creditnote_id}/substatus/{substatus_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| substatus_id | string | required | Zoho Books substatus id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_credit_notes_einvoice
List credit note e-invoices in Zoho Books
/creditnotes/einvoice
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_push_credit_notes_einvoice
Push credit note e-invoices in Zoho Books
/creditnotes/einvoice/push
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_cancel_credit_notes_einvoice
Cancel credit note e-invoices in Zoho Books
/creditnotes/einvoice/cancel
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_credit_note_einvoice
Get a credit note e-invoice in Zoho Books
/creditnotes/{creditnote_id}/einvoice
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_push_credit_note_einvoice
Push a credit note e-invoice in Zoho Books
/creditnotes/{creditnote_id}/einvoice/push
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_cancel_credit_note_einvoice
Cancel a credit note e-invoice in Zoho Books
/creditnotes/{creditnote_id}/einvoice/cancel
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_fetch_credit_note_einvoice
Fetch a credit note e-invoice in Zoho Books
/creditnotes/{creditnote_id}/einvoice/fetch
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_credit_note_einvoice_status
Delete a credit note e-invoice status in Zoho Books
/creditnotes/{creditnote_id}/einvoice/status
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_credit_note_einvoice_pushed
Mark a credit note e-invoice as manually pushed in Zoho Books
/creditnotes/{creditnote_id}/einvoice/status/push
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' mark a credit note e-invoice as manually pushed request schema |
POST
zoho_books_mark_credit_note_einvoice_cancelled
Mark a credit note e-invoice as cancelled in Zoho Books
/creditnotes/{creditnote_id}/einvoice/status/cancel
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_recall_credit_note_einvoice_status
Recall a credit note e-invoice status in Zoho Books
/creditnotes/{creditnote_id}/einvoice/status/recall
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_push_credit_note_refund_einvoice
Push a credit note refund e-invoice in Zoho Books
/creditnotes/{creditnote_id}/refunds/einvoice/push
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_credit_note_ready_to_push
Mark a credit note as ready to push in Zoho Books
/creditnotes/{creditnote_id}/status/readytopush
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_update_credit_note_cfdi_status
Update a credit note CFDI status in Zoho Books
/creditnotes/{creditnote_id}/cfdi/status
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_cancel_einvoice_credit_note
Cancel an e-invoice credit note in Zoho Books
/einvoices/creditnotes/{creditnote_id}/cancel
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| creditnote_id | string | required | Zoho Books creditnote id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_currencies
List Currencies in Zoho Books
/settings/currencies
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| filter_by | string | optional | Zoho Books filter by parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_currency
Create a Currency in Zoho Books
/settings/currencies
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a currency request schema |
GET
zoho_books_get_currency
Get a Currency in Zoho Books
/settings/currencies/{currency_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| currency_id | string | required | Zoho Books currency id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_currency
Update a Currency in Zoho Books
/settings/currencies/{currency_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| currency_id | string | required | Zoho Books currency id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a currency request schema |
DELETE
zoho_books_delete_currency
Delete a currency in Zoho Books
/settings/currencies/{currency_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| currency_id | string | required | Zoho Books currency id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_exchange_rates
List exchange rates in Zoho Books
/settings/currencies/{currency_id}/exchangerates
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| currency_id | string | required | Zoho Books currency id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| from_date | string | optional | Zoho Books from date parameter |
| is_current_date | boolean | optional | Zoho Books is current date parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
POST
zoho_books_create_exchange_rate
Create an exchange rate in Zoho Books
/settings/currencies/{currency_id}/exchangerates
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| currency_id | string | required | Zoho Books currency id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create an exchange rate request schema |
GET
zoho_books_get_exchange_rate
Get an exchange rate. in Zoho Books
/settings/currencies/{currency_id}/exchangerates/{exchange_rate_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| currency_id | string | required | Zoho Books currency id |
| exchange_rate_id | string | required | Zoho Books exchange rate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_exchange_rate
Update an exchange rate in Zoho Books
/settings/currencies/{currency_id}/exchangerates/{exchange_rate_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| currency_id | string | required | Zoho Books currency id |
| exchange_rate_id | string | required | Zoho Books exchange rate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update an exchange rate request schema |
DELETE
zoho_books_delete_exchange_rate
Delete an exchage rate in Zoho Books
/settings/currencies/{currency_id}/exchangerates/{exchange_rate_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| currency_id | string | required | Zoho Books currency id |
| exchange_rate_id | string | required | Zoho Books exchange rate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_customer_payments
List Customer Payments in Zoho Books
/customerpayments
13 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| customer_name | string | optional | Zoho Books customer name parameter |
| reference_number | string | optional | Zoho Books reference number parameter |
| date | string | optional | Zoho Books date parameter |
| amount | string | optional | Zoho Books amount parameter |
| notes | string | optional | Zoho Books notes parameter |
| payment_mode | string | optional | Zoho Books payment mode parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| search_text | string | optional | Zoho Books search text parameter |
| customer_id | string | optional | Zoho Books customer id parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_customer_payment
Create a payment in Zoho Books
/customerpayments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a payment request schema |
PUT
zoho_books_update_customer_payment_using_custom_field
Update a payment using a custom field's unique value in Zoho Books
/customerpayments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a payment using a custom field's unique value request schema |
DELETE
zoho_books_bulk_delete_customer_payments
Bulk delete Customer payments in Zoho Books
/customerpayments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| payment_ids | string | required | Zoho Books payment ids parameter |
| bulk_delete | string | required | Zoho Books bulk delete parameter |
GET
zoho_books_get_customer_payment
Retrieve a payment in Zoho Books
/customerpayments/{payment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| payment_id | string | required | Zoho Books payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| accept | string | optional | Zoho Books accept parameter |
PUT
zoho_books_update_customer_payment
Update a payment in Zoho Books
/customerpayments/{payment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| payment_id | string | required | Zoho Books payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a payment request schema |
DELETE
zoho_books_delete_customer_payment
Delete a payment in Zoho Books
/customerpayments/{payment_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| payment_id | string | required | Zoho Books payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_customer_payment_refunds
List refunds of a customer payment in Zoho Books
/customerpayments/{customer_payment_id}/refunds
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| customer_payment_id | string | required | Zoho Books customer payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_customer_payment_refund
Refund an excess customer payment in Zoho Books
/customerpayments/{customer_payment_id}/refunds
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| customer_payment_id | string | required | Zoho Books customer payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' refund an excess customer payment request schema |
PUT
zoho_books_update_custom_fields_in_customer_payment
Update custom field in existing customerpayments in Zoho Books
/customerpayment/{customer_payment_id}/customfields
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| customer_payment_id | string | required | Zoho Books customer payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | array | optional | JSON array matching Zoho Books' update custom field in existing customerpayments request schema |
GET
zoho_books_get_customer_payment_refund
Details of a refund in Zoho Books
/customerpayments/{customer_payment_id}/refunds/{refund_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| customer_payment_id | string | required | Zoho Books customer payment id |
| refund_id | string | required | Zoho Books refund id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_customer_payment_refund
Update a refund in Zoho Books
/customerpayments/{customer_payment_id}/refunds/{refund_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| customer_payment_id | string | required | Zoho Books customer payment id |
| refund_id | string | required | Zoho Books refund id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a refund request schema |
DELETE
zoho_books_delete_customer_payment_refund
Delete a Refund in Zoho Books
/customerpayments/{customer_payment_id}/refunds/{refund_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| customer_payment_id | string | required | Zoho Books customer payment id |
| refund_id | string | required | Zoho Books refund id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_estimates
List estimates in Zoho Books
/estimates
25 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| estimate_number | string | optional | Zoho Books estimate number parameter |
| reference_number | string | optional | Zoho Books reference number parameter |
| customer_name | string | optional | Zoho Books customer name parameter |
| total | string | optional | Zoho Books total parameter |
| customer_id | string | optional | Zoho Books customer id parameter |
| item_id | string | optional | Zoho Books item id parameter |
| item_name | string | optional | Zoho Books item name parameter |
| item_description | string | optional | Zoho Books item description parameter |
| custom_field | string | optional | Zoho Books custom field parameter |
| expiry_date | string | optional | Zoho Books expiry date parameter |
| expiry_date_start | string | optional | Zoho Books expiry date start parameter |
| expiry_date_end | string | optional | Zoho Books expiry date end parameter |
| expiry_date_before | string | optional | Zoho Books expiry date before parameter |
| expiry_date_after | string | optional | Zoho Books expiry date after parameter |
| date | string | optional | Zoho Books date parameter |
| last_modified_time | string | optional | Zoho Books last modified time parameter |
| status | string | optional | Zoho Books status parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| search_text | string | optional | Zoho Books search text parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| zcrm_potential_id | string | optional | Zoho Books zcrm potential id parameter |
| location_ids | string | optional | Zoho Books location ids parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_estimate
Create an Estimate in Zoho Books
/estimates
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| send | string | optional | Zoho Books send parameter |
| ignore_auto_number_generation | string | optional | Zoho Books ignore auto number generation parameter |
| body | object | optional | JSON object matching Zoho Books' create an estimate request schema |
PUT
zoho_books_update_estimate_using_custom_field
update an Estimate using a custom field's unique value in Zoho Books
/estimates
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update an estimate using a custom field's unique value request schema |
GET
zoho_books_get_estimate
Get an estimate in Zoho Books
/estimates/{estimate_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| string | optional | Zoho Books print parameter | |
| accept | string | optional | Zoho Books accept parameter |
PUT
zoho_books_update_estimate
Update an Estimate in Zoho Books
/estimates/{estimate_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| ignore_auto_number_generation | string | optional | Zoho Books ignore auto number generation parameter |
| body | object | optional | JSON object matching Zoho Books' update an estimate request schema |
DELETE
zoho_books_delete_estimate
Delete an Estimate in Zoho Books
/estimates/{estimate_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_custom_fields_in_estimate
Update custom field in existing estimates in Zoho Books
/estimate/{estimate_id}/customfields
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | array | optional | JSON array matching Zoho Books' update custom field in existing estimates request schema |
POST
zoho_books_mark_estimate_sent
Mark an estimate as sent in Zoho Books
/estimates/{estimate_id}/status/sent
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_estimate_accepted
Mark an estimate as accepted in Zoho Books
/estimates/{estimate_id}/status/accepted
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_estimate_declined
Mark an estimate as declined in Zoho Books
/estimates/{estimate_id}/status/declined
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_submit_estimate
Submit an estimate for approval in Zoho Books
/estimates/{estimate_id}/submit
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_approve_estimate
Approve an estimate. in Zoho Books
/estimates/{estimate_id}/approve
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_estimate_email
Get estimate email content in Zoho Books
/estimates/{estimate_id}/email
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| email_template_id | string | required | Zoho Books email template id parameter |
POST
zoho_books_email_estimate
Email an estimate in Zoho Books
/estimates/{estimate_id}/email
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' email an estimate request schema |
POST
zoho_books_email_multiple_estimates
Email multiple estimates in Zoho Books
/estimates/email
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| estimate_ids | string | required | Zoho Books estimate ids parameter |
PUT
zoho_books_update_estimate_billing_address
Update billing address in Zoho Books
/estimates/{estimate_id}/address/billing
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update billing address request schema |
PUT
zoho_books_update_estimate_shipping_address
Update shipping address in Zoho Books
/estimates/{estimate_id}/address/shipping
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update shipping address request schema |
GET
zoho_books_list_estimate_templates
List estimate template in Zoho Books
/estimates/templates
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_estimate_template
Update estimate template in Zoho Books
/estimates/{estimate_id}/templates/{template_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| template_id | string | required | Zoho Books template id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_estimate_comments
List estimate comments & history in Zoho Books
/estimates/{estimate_id}/comments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_create_estimate_comment
Add Comments in Zoho Books
/estimates/{estimate_id}/comments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add comments request schema |
PUT
zoho_books_update_estimate_comment
Update comment in Zoho Books
/estimates/{estimate_id}/comments/{comment_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update comment request schema |
DELETE
zoho_books_delete_estimate_comment
Delete a comment in Zoho Books
/estimates/{estimate_id}/comments/{comment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_id | string | required | Zoho Books estimate id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_expenses
List Expenses in Zoho Books
/expenses
19 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| description | string | optional | Zoho Books description parameter |
| reference_number | string | optional | Zoho Books reference number parameter |
| date | string | optional | Zoho Books date parameter |
| status | string | optional | Zoho Books status parameter |
| amount | string | optional | Zoho Books amount parameter |
| account_name | string | optional | Zoho Books account name parameter |
| customer_name | string | optional | Zoho Books customer name parameter |
| vendor_name | string | optional | Zoho Books vendor name parameter |
| customer_id | string | optional | Zoho Books customer id parameter |
| vendor_id | string | optional | Zoho Books vendor id parameter |
| recurring_expense_id | string | optional | Zoho Books recurring expense id parameter |
| paid_through_account_id | string | optional | Zoho Books paid through account id parameter |
| project_id | string | optional | Zoho Books project id parameter |
| search_text | string | optional | Zoho Books search text parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_expense
Create an Expense in Zoho Books
/expenses
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create an expense request schema |
PUT
zoho_books_update_expense_using_custom_field
Update an expense using a custom field's unique value in Zoho Books
/expenses
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update an expense using a custom field's unique value request schema |
GET
zoho_books_get_expense
Get an Expense in Zoho Books
/expenses/{expense_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| expense_id | string | required | Zoho Books expense id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_expense
Update an Expense in Zoho Books
/expenses/{expense_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| expense_id | string | required | Zoho Books expense id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| delete_receipt | string | optional | Zoho Books delete receipt parameter |
| body | object | optional | JSON object matching Zoho Books' update an expense request schema |
DELETE
zoho_books_delete_expense
Delete an Expense in Zoho Books
/expenses/{expense_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| expense_id | string | required | Zoho Books expense id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_expense_comments
List expense History & Comments in Zoho Books
/expenses/{expense_id}/comments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| expense_id | string | required | Zoho Books expense id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_employees
List employees in Zoho Books
/employees
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_employee
Create an employee in Zoho Books
/employees
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create an employee request schema |
GET
zoho_books_get_employee
Get an employee in Zoho Books
/employees/{employee_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| employee_id | string | required | Zoho Books employee id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_employee
Delete an employee in Zoho Books
/employee/{employee_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| employee_id | string | required | Zoho Books employee id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_expense_receipt
Delete a receipt in Zoho Books
/expenses/{expense_id}/receipt
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| expense_id | string | required | Zoho Books expense id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_invoices
List invoices in Zoho Books
/invoices
35 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| invoice_number | string | optional | Zoho Books invoice number parameter |
| item_name | string | optional | Zoho Books item name parameter |
| item_id | string | optional | Zoho Books item id parameter |
| item_description | string | optional | Zoho Books item description parameter |
| reference_number | string | optional | Zoho Books reference number parameter |
| customer_name | string | optional | Zoho Books customer name parameter |
| recurring_invoice_id | string | optional | Zoho Books recurring invoice id parameter |
| string | optional | Zoho Books email parameter | |
| total | string | optional | Zoho Books total parameter |
| balance | string | optional | Zoho Books balance parameter |
| custom_field | string | optional | Zoho Books custom field parameter |
| date | string | optional | Zoho Books date parameter |
| date_start | string | optional | Zoho Books date start parameter |
| date_end | string | optional | Zoho Books date end parameter |
| date_before | string | optional | Zoho Books date before parameter |
| date_after | string | optional | Zoho Books date after parameter |
| due_date | string | optional | Zoho Books due date parameter |
| due_date_start | string | optional | Zoho Books due date start parameter |
| due_date_end | string | optional | Zoho Books due date end parameter |
| due_date_before | string | optional | Zoho Books due date before parameter |
| due_date_after | string | optional | Zoho Books due date after parameter |
| created_date | string | optional | Zoho Books created date parameter |
| created_date_start | string | optional | Zoho Books created date start parameter |
| created_date_end | string | optional | Zoho Books created date end parameter |
| last_modified_time | string | optional | Zoho Books last modified time parameter |
| status | string | optional | Zoho Books status parameter |
| customer_id | string | optional | Zoho Books customer id parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| search_text | string | optional | Zoho Books search text parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| zcrm_potential_id | string | optional | Zoho Books zcrm potential id parameter |
| response_option | string | optional | Zoho Books response option parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_invoice
Create an invoice in Zoho Books
/invoices
6 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| send | string | optional | Zoho Books send parameter |
| ignore_auto_number_generation | string | optional | Zoho Books ignore auto number generation parameter |
| is_quick_create | boolean | optional | Zoho Books is quick create parameter |
| batch_payments | string | optional | Zoho Books batch payments parameter |
| body | object | optional | JSON object matching Zoho Books' create an invoice request schema |
PUT
zoho_books_update_invoice_using_custom_field
Update an invoice using a custom field's unique value in Zoho Books
/invoices
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update an invoice using a custom field's unique value request schema |
DELETE
zoho_books_delete_invoices
Delete invoices in Zoho Books
/invoices
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| invoice_ids | string | required | Zoho Books invoice ids parameter |
GET
zoho_books_get_invoice
Get an invoice in Zoho Books
/invoices/{invoice_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| string | optional | Zoho Books print parameter | |
| accept | string | optional | Zoho Books accept parameter |
PUT
zoho_books_update_invoice
Update an invoice in Zoho Books
/invoices/{invoice_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| ignore_auto_number_generation | string | optional | Zoho Books ignore auto number generation parameter |
| body | object | optional | JSON object matching Zoho Books' update an invoice request schema |
DELETE
zoho_books_delete_invoice
Delete an invoice in Zoho Books
/invoices/{invoice_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_invoice_sent
Mark an invoice as sent in Zoho Books
/invoices/{invoice_id}/status/sent
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_invoice_void
Void an invoice in Zoho Books
/invoices/{invoice_id}/status/void
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_invoice_draft
Mark as draft in Zoho Books
/invoices/{invoice_id}/status/draft
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_email_invoices
Email multiple invoices in Zoho Books
/invoices/email
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| invoice_ids | string | required | Zoho Books invoice ids parameter |
| body | object | optional | JSON object matching Zoho Books' email multiple invoices request schema |
POST
zoho_books_create_invoice_from_salesorder
Create an instant invoice in Zoho Books
/invoices/fromsalesorder
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_map_invoice_with_salesorder
Associate invoices with sales order in Zoho Books
/invoices/mapwithorder
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_ids | string | required | Zoho Books invoice ids parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_submit_invoice
Submit an invoice for approval in Zoho Books
/invoices/{invoice_id}/submit
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_approve_invoice
Approve an invoice. in Zoho Books
/invoices/{invoice_id}/approve
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_invoice_email
Get invoice email content in Zoho Books
/invoices/{invoice_id}/email
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| email_template_id | string | optional | Zoho Books email template id parameter |
POST
zoho_books_email_invoice
Email an invoice in Zoho Books
/invoices/{invoice_id}/email
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| send_customer_statement | string | optional | Zoho Books send customer statement parameter |
| send_attachment | string | optional | Zoho Books send attachment parameter |
| body | object | optional | JSON object matching Zoho Books' email an invoice request schema |
GET
zoho_books_get_payment_reminder_mail_content_for_invoice
Get payment reminder mail content in Zoho Books
/invoices/{invoice_id}/paymentreminder
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_remind_customer_for_invoice_payment
Remind Customer in Zoho Books
/invoices/{invoice_id}/paymentreminder
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| send_customer_statement | string | optional | Zoho Books send customer statement parameter |
| body | object | optional | JSON object matching Zoho Books' remind customer request schema |
POST
zoho_books_bulk_invoice_reminder
Bulk invoice reminder in Zoho Books
/invoices/paymentreminder
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| invoice_ids | string | required | Zoho Books invoice ids parameter |
POST
zoho_books_disable_invoice_payment_reminder
Disable payment reminder in Zoho Books
/invoices/{invoice_id}/paymentreminder/disable
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_enable_invoice_payment_reminder
Enable payment reminder in Zoho Books
/invoices/{invoice_id}/paymentreminder/enable
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_write_off_invoice
Write off invoice in Zoho Books
/invoices/{invoice_id}/writeoff
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_cancel_write_off_invoice
Cancel write off in Zoho Books
/invoices/{invoice_id}/writeoff/cancel
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_invoice_billing_address
Update billing address in Zoho Books
/invoices/{invoice_id}/address/billing
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update billing address request schema |
PUT
zoho_books_update_invoice_shipping_address
Update shipping address in Zoho Books
/invoices/{invoice_id}/address/shipping
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update shipping address request schema |
GET
zoho_books_list_invoice_templates
List invoice templates in Zoho Books
/invoices/templates
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_invoice_template
Update invoice template in Zoho Books
/invoices/{invoice_id}/templates/{template_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| template_id | string | required | Zoho Books template id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_invoice_payments
List invoice payments in Zoho Books
/invoices/{invoice_id}/payments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_invoice_credits_applied
List credits applied in Zoho Books
/invoices/{invoice_id}/creditsapplied
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_apply_credits_to_invoice
Apply credits in Zoho Books
/invoices/{invoice_id}/credits
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' apply credits request schema |
DELETE
zoho_books_delete_invoice_payment
Delete a payment in Zoho Books
/invoices/{invoice_id}/payments/{invoice_payment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| invoice_payment_id | string | required | Zoho Books invoice payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_invoice_applied_credit
Delete applied credit in Zoho Books
/invoices/{invoice_id}/creditsapplied/{creditnotes_invoice_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| creditnotes_invoice_id | string | required | Zoho Books creditnotes invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_invoice_attachment_preference
Update attachment preference in Zoho Books
/invoices/{invoice_id}/attachment
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| can_send_in_mail | boolean | required | Zoho Books can send in mail parameter |
DELETE
zoho_books_delete_invoice_attachment
Delete last attached attachment in Zoho Books
/invoices/{invoice_id}/attachment
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_invoice_document_details
Retrieve Invoice Document in Zoho Books
/invoices/{invoice_id}/documents/{document_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| document_id | string | required | Zoho Books document id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| responseformat | string | optional | Zoho Books responseformat parameter |
POST
zoho_books_add_invoice_document
Add a document to an invoice in Zoho Books
/invoices/{invoice_id}/documents/{document_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| document_id | string | required | Zoho Books document id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_invoice_document
Delete Invoice attachment in Zoho Books
/invoices/{invoice_id}/documents/{document_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| document_id | string | required | Zoho Books document id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_invoice_expense_receipt
Delete the expense receipt in Zoho Books
/invoices/expenses/{expense_id}/receipt
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| expense_id | string | required | Zoho Books expense id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_custom_fields_in_invoice
Update custom field in existing invoices in Zoho Books
/invoice/{invoice_id}/customfields
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | array | optional | JSON array matching Zoho Books' update custom field in existing invoices request schema |
GET
zoho_books_list_invoice_comments
List invoice comments & history in Zoho Books
/invoices/{invoice_id}/comments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_invoice_comment
Add comment in Zoho Books
/invoices/{invoice_id}/comments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add comment request schema |
PUT
zoho_books_update_invoice_comment
Update comment in Zoho Books
/invoices/{invoice_id}/comments/{comment_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update comment request schema |
DELETE
zoho_books_delete_invoice_comment
Delete a comment in Zoho Books
/invoices/{invoice_id}/comments/{comment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_generate_invoice_payment_link
Generate payment link in Zoho Books
/share/paymentlink
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id parameter |
| transaction_type | string | required | Zoho Books transaction type parameter |
| link_type | string | required | Zoho Books link type parameter |
| expiry_time | string | required | Zoho Books expiry time parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_approve_invoices
Approve invoices in Zoho Books
/invoices/approve
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| invoice_ids | string | required | Zoho Books invoice ids parameter |
POST
zoho_books_void_invoices
Mark invoices as void in Zoho Books
/invoices/status/void
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| invoice_ids | string | required | Zoho Books invoice ids parameter |
| can_create_network_entity | boolean | optional | Zoho Books can create network entity parameter |
| unmap_salesorder | string | optional | Zoho Books unmap salesorder parameter |
POST
zoho_books_create_invoices_from_projects
Create invoices from projects in Zoho Books
/invoices/fromprojects
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| project_ids | string | optional | Zoho Books project ids parameter |
| invoice_number | string | optional | Zoho Books invoice number parameter |
GET
zoho_books_get_invoice_delivery_notes
Get delivery notes for invoices in Zoho Books
/invoices/deliverynotes
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| invoice_ids | string | required | Zoho Books invoice ids parameter |
| string | optional | Zoho Books print parameter | |
| accept | string | required | Zoho Books accept parameter |
| no_of_copies | string | optional | Zoho Books no of copies parameter |
GET
zoho_books_get_invoice_packing_slips
Get packing slips for invoices in Zoho Books
/invoices/packingslips
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| invoice_ids | string | required | Zoho Books invoice ids parameter |
| string | optional | Zoho Books print parameter | |
| accept | string | required | Zoho Books accept parameter |
| no_of_copies | string | optional | Zoho Books no of copies parameter |
POST
zoho_books_finalize_invoice_approval
Finalize approval of an invoice in Zoho Books
/invoices/{invoice_id}/approve/final
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_reject_invoice
Reject an invoice in Zoho Books
/invoices/{invoice_id}/reject
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| reason | string | optional | Zoho Books reason parameter |
| isCallForOEmbed | string | optional | Zoho Books iscallforoembed parameter |
POST
zoho_books_send_invoice_via_snail_mail
Send an invoice via snail mail in Zoho Books
/invoices/{invoice_id}/snailmail
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| contact_person_id | string | optional | Zoho Books contact person id parameter |
POST
zoho_books_add_invoice_online_payment_bank_account
Add a bank account for invoice online payments in Zoho Books
/invoices/{invoice_id}/onlinepayments/bankaccount
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add a bank account for invoice online payments request schema |
PUT
zoho_books_apply_pricebook_to_invoice
Apply a price book to an invoice in Zoho Books
/invoices/{invoice_id}/pricebooks/{pricebook_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| pricebook_id | string | required | Zoho Books pricebook id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_submit_invoices
Submit invoices for approval in Zoho Books
/invoices/submit
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_ids | string | required | Zoho Books invoice ids parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_invoices_sent
Mark invoices as sent in Zoho Books
/invoices/status/sent
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_ids | string | required | Zoho Books invoice ids parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_write_off_invoices
Write off invoices in Zoho Books
/invoices/writeoff
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_ids | string | required | Zoho Books invoice ids parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_invoices_shipped
Mark invoices as shipped in Zoho Books
/invoices/markasshipped
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_ids | string | required | Zoho Books invoice ids parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_unship_invoices
Mark invoices as unshipped in Zoho Books
/invoices/unship
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_ids | string | required | Zoho Books invoice ids parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_create_invoices_from_estimates
Create invoices from estimates in Zoho Books
/invoices/fromestimates
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| estimate_ids | string | required | Zoho Books estimate ids parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_preview_invoice_coupons
Preview invoice with coupons in Zoho Books
/invoices/coupons/preview
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' preview invoice with coupons request schema |
PUT
zoho_books_unmap_invoices_from_salesorders
Unmap invoices from sales orders in Zoho Books
/invoices/unmap/salesorders
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_invoice_dashboard
Get invoice dashboard in Zoho Books
/invoices/dashboard
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_agent | string | optional | Zoho Books invoice agent parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_invoice_by_reference
Get an invoice by reference in Zoho Books
/invoices/reference/{reference_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| reference_id | string | required | Zoho Books reference id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_invoice_custom_fields
Get invoice custom fields in Zoho Books
/invoices/{invoice_id}/customfields
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_invoice_advanced_tracking_details
Get invoice advanced tracking details in Zoho Books
/invoices/{invoice_id}/advancedtrackingdetails
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_invoice_advanced_tracking_details
Update invoice advanced tracking details in Zoho Books
/invoices/{invoice_id}/advancedtrackingdetails
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update invoice advanced tracking details request schema |
GET
zoho_books_print_invoice_delivery_note
Print invoice delivery note in Zoho Books
/invoices/{invoice_id}/deliverynote/print
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_print_invoice_packing_slip
Print invoice packing slip in Zoho Books
/invoices/{invoice_id}/packingslip/print
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_invoice_qr_code
Get invoice QR code in Zoho Books
/invoices/{invoice_id}/qrcode
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_invoice_sms
Get invoice SMS content in Zoho Books
/invoices/{invoice_id}/sms
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_send_invoice_sms
Send invoice by SMS in Zoho Books
/invoices/{invoice_id}/sms
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_invoice_signature_template
Get invoice signature template in Zoho Books
/invoices/{invoice_id}/dsign/template
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_invoice_digital_signature
Add a digital signature to an invoice in Zoho Books
/invoices/{invoice_id}/dsign
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_update_invoice_cfdi_status
Update an invoice CFDI status in Zoho Books
/invoices/{invoice_id}/cfdi/status
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_cancel_invoice
Cancel an invoice in Zoho Books
/invoices/{invoice_id}/status/cancel
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_invoice_ready_to_push
Mark an invoice as ready to push in Zoho Books
/invoices/{invoice_id}/status/readytopush
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_apply_invoice_substatus
Apply a sub-status to an invoice in Zoho Books
/invoices/{invoice_id}/substatus/{substatus_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| substatus_id | string | required | Zoho Books substatus id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_invoice_substatus
Delete an invoice sub-status in Zoho Books
/invoices/{invoice_id}/substatus/{substatus_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| substatus_id | string | required | Zoho Books substatus id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_invoice_line_item
Delete an invoice line item in Zoho Books
/invoices/{invoice_id}/lineitems/{line_item_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| line_item_id | string | required | Zoho Books line item id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_schedule_invoice_email
Schedule an invoice email in Zoho Books
/invoices/{invoice_id}/email/schedule
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' schedule an invoice email request schema |
DELETE
zoho_books_cancel_scheduled_invoice_email
Cancel a scheduled invoice email in Zoho Books
/invoices/{invoice_id}/email/schedule
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_force_pay_invoice
Force pay an invoice in Zoho Books
/invoices/{invoice_id}/forcepay
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mail_invoice_pdf
Email an invoice as PDF in Zoho Books
/invoices/{invoice_id}/mailpdf
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_create_invoice_synchronous_online_payment
Process a synchronous online payment for an invoice in Zoho Books
/invoices/{invoice_id}/onlinepayments/synchronous
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' process a synchronous online payment for an invoice request schema |
POST
zoho_books_create_invoice_asynchronous_online_payment
Process an asynchronous online payment for an invoice in Zoho Books
/invoices/{invoice_id}/onlinepayments/asynchronous
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' process an asynchronous online payment for an invoice request schema |
GET
zoho_books_get_invoice_payment_qr
Get invoice online payment QR code in Zoho Books
/invoices/{invoice_id}/onlinepayments/qr
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_invoice_payment_qr_status
Get invoice online payment QR status in Zoho Books
/invoices/{invoice_id}/onlinepayments/qr/status
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_send_invoice_dunning_notifications
Send invoice dunning notifications in Zoho Books
/invoices/{invoice_id}/senddunningnotifications
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_send_invoice_retry_sms
Resend invoice payment SMS in Zoho Books
/invoices/{invoice_id}/sendretrysms
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_invoice_metadata
Get invoice metadata in Zoho Books
/invoices/{invoice_id}/metadata/{metadata_name}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| metadata_name | string | required | Zoho Books metadata name |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_invoice_metadata
Update invoice metadata in Zoho Books
/invoices/{invoice_id}/metadata/{metadata_name}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| metadata_name | string | required | Zoho Books metadata name |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_invoices_einvoice
List invoice e-invoices in Zoho Books
/invoices/einvoice
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_push_invoices_einvoice
Push invoice e-invoices in Zoho Books
/invoices/einvoice/push
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_cancel_invoices_einvoice
Cancel invoice e-invoices in Zoho Books
/invoices/einvoice/cancel
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_invoice_einvoice
Get an invoice e-invoice in Zoho Books
/invoices/{invoice_id}/einvoice
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_push_invoice_einvoice
Push an invoice e-invoice in Zoho Books
/invoices/{invoice_id}/einvoice/push
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_cancel_invoice_einvoice
Cancel an invoice e-invoice in Zoho Books
/invoices/{invoice_id}/einvoice/cancel
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_fetch_invoice_einvoice
Fetch an invoice e-invoice in Zoho Books
/invoices/{invoice_id}/einvoice/fetch
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_invoice_einvoice_status
Delete an invoice e-invoice status in Zoho Books
/invoices/{invoice_id}/einvoice/status
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_invoice_einvoice_pushed
Mark an invoice e-invoice as manually pushed in Zoho Books
/invoices/{invoice_id}/einvoice/status/push
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' mark an invoice e-invoice as manually pushed request schema |
POST
zoho_books_mark_invoice_einvoice_cancelled
Mark an invoice e-invoice as cancelled in Zoho Books
/invoices/{invoice_id}/einvoice/status/cancel
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_recall_invoice_einvoice_status
Recall an invoice e-invoice status in Zoho Books
/invoices/{invoice_id}/einvoice/status/recall
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_invoice_einvoice_payment_status
Update an invoice e-invoice payment status in Zoho Books
/invoices/{invoice_id}/einvoice/paymentstatus
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_cancel_einvoice_invoice
Cancel an e-invoice invoice in Zoho Books
/einvoices/invoices/{invoice_id}/cancel
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | required | Zoho Books invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_items
List items in Zoho Books
/items
24 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| name | string | optional | Zoho Books name parameter |
| name_startswith | string | optional | Zoho Books name startswith parameter |
| name_contains | string | optional | Zoho Books name contains parameter |
| description | string | optional | Zoho Books description parameter |
| description_startswith | string | optional | Zoho Books description startswith parameter |
| description_contains | string | optional | Zoho Books description contains parameter |
| rate | integer | optional | Zoho Books rate parameter |
| rate_less_than | string | optional | Zoho Books rate less than parameter |
| rate_less_equals | string | optional | Zoho Books rate less equals parameter |
| rate_greater_than | string | optional | Zoho Books rate greater than parameter |
| rate_greater_equals | string | optional | Zoho Books rate greater equals parameter |
| tax_id | string | optional | Zoho Books tax id parameter |
| tax_name | string | optional | Zoho Books tax name parameter |
| is_taxable | boolean | optional | Zoho Books is taxable parameter |
| tax_exemption_id | string | optional | Zoho Books tax exemption id parameter |
| account_id | string | optional | Zoho Books account id parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| search_text | string | optional | Zoho Books search text parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| sat_item_key_code | string | optional | Zoho Books sat item key code parameter |
| unitkey_code | string | optional | Zoho Books unitkey code parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_item
Create an Item in Zoho Books
/items
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create an item request schema |
PUT
zoho_books_update_item_using_custom_field
Update an item using a custom field's unique value in Zoho Books
/items
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update an item using a custom field's unique value request schema |
GET
zoho_books_list_item_details
Bulk fetch item details in Zoho Books
/itemdetails
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| item_ids | string | required | Zoho Books item ids parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_item
Get an item in Zoho Books
/items/{item_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| item_id | string | required | Zoho Books item id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_item
Update an item in Zoho Books
/items/{item_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| item_id | string | required | Zoho Books item id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update an item request schema |
DELETE
zoho_books_delete_item
Delete an item in Zoho Books
/items/{item_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| item_id | string | required | Zoho Books item id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_custom_fields_in_item
Update custom field in existing items in Zoho Books
/item/{item_id}/customfields
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| item_id | string | required | Zoho Books item id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | array | optional | JSON array matching Zoho Books' update custom field in existing items request schema |
POST
zoho_books_mark_item_active
Mark as active in Zoho Books
/items/{item_id}/active
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| item_id | string | required | Zoho Books item id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_item_inactive
Mark as inactive in Zoho Books
/items/{item_id}/inactive
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| item_id | string | required | Zoho Books item id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_items_to_portal
Add items to the customer portal in Zoho Books
/items/addtoportal
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| item_ids | string | required | Zoho Books item ids parameter |
POST
zoho_books_add_item_to_portal
Add an item to the customer portal in Zoho Books
/items/{item_id}/addtoportal
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| item_id | string | required | Zoho Books item id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_remove_item_from_portal
Remove an item from the customer portal in Zoho Books
/items/{item_id}/removefromportal
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| item_id | string | required | Zoho Books item id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_journals
Get journal list in Zoho Books
/journals
29 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| entry_number | string | optional | Zoho Books entry number parameter |
| reference_number | string | optional | Zoho Books reference number parameter |
| date | string | optional | Zoho Books date parameter |
| notes | string | optional | Zoho Books notes parameter |
| last_modified_time | string | optional | Zoho Books last modified time parameter |
| total | string | optional | Zoho Books total parameter |
| customer_id | string | optional | Zoho Books customer id parameter |
| vendor_id | string | optional | Zoho Books vendor id parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| status | string | optional | Zoho Books status parameter |
| journal_type | string | optional | Zoho Books journal type parameter |
| account_id | string | optional | Zoho Books account id parameter |
| account_code | string | optional | Zoho Books account code parameter |
| customview_id | string | optional | Zoho Books customview id parameter |
| journal_ids | string | optional | Zoho Books journal ids parameter |
| currency | string | optional | Zoho Books currency parameter |
| tax_id | string | optional | Zoho Books tax id parameter |
| tax_exemption_id | string | optional | Zoho Books tax exemption id parameter |
| tax_authority_id | string | optional | Zoho Books tax authority id parameter |
| search_text | string | optional | Zoho Books search text parameter |
| branch_ids | string | optional | Zoho Books branch ids parameter |
| location_ids | string | optional | Zoho Books location ids parameter |
| project_id | string | optional | Zoho Books project id parameter |
| journal_entity_type | string | optional | Zoho Books journal entity type parameter |
| period_closure_id | string | optional | Zoho Books period closure id parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_journal
Create a journal in Zoho Books
/journals
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a journal request schema |
GET
zoho_books_get_journal
Get journal in Zoho Books
/journals/{journal_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_journal
Update a journal in Zoho Books
/journals/{journal_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a journal request schema |
DELETE
zoho_books_delete_journal
Delete a journal in Zoho Books
/journals/{journal_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_journal_published
Mark a journal as published in Zoho Books
/journals/{journal_id}/status/publish
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_journal_comment
Add comment in Zoho Books
/journals/{journal_id}/comments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add comment request schema |
DELETE
zoho_books_delete_journal_comment
Delete a comment in Zoho Books
/journals/{journal_id}/comments/{comment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_reverse_journal
Reverse a journal in Zoho Books
/journals/{journal_id}/reverse
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| reversal_date | string | required | Zoho Books reversal date parameter |
| is_reversal_scheduled | boolean | required | Zoho Books is reversal scheduled parameter |
POST
zoho_books_submit_journal_for_approval
Submit a journal for approval in Zoho Books
/journals/{journal_id}/submit
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_approve_journal
Approve a journal in Zoho Books
/journals/{journal_id}/approve
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_reject_journal
Reject a journal in Zoho Books
/journals/{journal_id}/reject
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| reason | string | optional | Zoho Books reason parameter |
GET
zoho_books_list_journal_credits
List available credits of a journal in Zoho Books
/journals/{journal_id}/credits
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_apply_journal_credits_to_invoices
Apply journal credits to invoices in Zoho Books
/journals/{journal_id}/credits/{journal_line_id}/invoices
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| journal_line_id | string | required | Zoho Books journal line id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' apply journal credits to invoices request schema |
POST
zoho_books_apply_journal_credits_to_bills
Apply journal credits to bills in Zoho Books
/journals/{journal_id}/credits/{journal_line_id}/bills
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| journal_line_id | string | required | Zoho Books journal line id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' apply journal credits to bills request schema |
DELETE
zoho_books_delete_journal_credits_receivables
Delete applied credits from receivables in Zoho Books
/journals/{journal_id}/credits/{journal_line_id}/receivables
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| journal_line_id | string | required | Zoho Books journal line id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_journal_credits_payables
Delete applied credits from payables in Zoho Books
/journals/{journal_id}/credits/{journal_line_id}/payables
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| journal_id | string | required | Zoho Books journal id |
| journal_line_id | string | required | Zoho Books journal line id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_bulk_submit_journals
Bulk submit journals for approval in Zoho Books
/journals/submit
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| journal_ids | string | required | Zoho Books journal ids parameter |
POST
zoho_books_bulk_approve_journals
Bulk approve journals in Zoho Books
/journals/approve
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| journal_ids | string | required | Zoho Books journal ids parameter |
POST
zoho_books_bulk_publish_journals
Bulk publish journals in Zoho Books
/journals/status/publish
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| journal_ids | string | required | Zoho Books journal ids parameter |
DELETE
zoho_books_bulk_delete_journals
Bulk delete journals in Zoho Books
/journals/bulkdelete
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| journal_ids | string | required | Zoho Books journal ids parameter |
GET
zoho_books_list_recurring_journals
List recurring journals in Zoho Books
/recurringjournals
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| filter_by | string | optional | Zoho Books filter by parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| account_id | string | optional | Zoho Books account id parameter |
POST
zoho_books_create_recurring_journal
Create a recurring journal in Zoho Books
/recurringjournals
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a recurring journal request schema |
GET
zoho_books_get_recurring_journal
Get a recurring journal in Zoho Books
/recurringjournals/{recurring_journal_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_journal_id | string | required | Zoho Books recurring journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_recurring_journal
Update a recurring journal in Zoho Books
/recurringjournals/{recurring_journal_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_journal_id | string | required | Zoho Books recurring journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a recurring journal request schema |
DELETE
zoho_books_delete_recurring_journal
Delete a recurring journal in Zoho Books
/recurringjournals/{recurring_journal_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_journal_id | string | required | Zoho Books recurring journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_resume_recurring_journal
Resume a recurring journal in Zoho Books
/recurringjournals/{recurring_journal_id}/status/resume
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_journal_id | string | required | Zoho Books recurring journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_stop_recurring_journal
Stop a recurring journal in Zoho Books
/recurringjournals/{recurring_journal_id}/status/stop
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_journal_id | string | required | Zoho Books recurring journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_child_journals
List child journals of a recurring journal in Zoho Books
/recurringjournals/{recurring_journal_id}/journals
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_journal_id | string | required | Zoho Books recurring journal id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_transaction_journal_view
Get journal view of a transaction in Zoho Books
/transactions/{transaction_id}/journals
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | required | Zoho Books transaction id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| entity_type | string | required | Zoho Books entity type parameter |
| report_basis | string | optional | Zoho Books report basis parameter |
GET
zoho_books_list_organizations
List organizations in Zoho Books
/organizations
POST
zoho_books_create_organization
Create an organization in Zoho Books
/organizations
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| body | object | optional | JSON object matching Zoho Books' create an organization request schema |
GET
zoho_books_get_organization
Get an organization in Zoho Books
/organizations/{organization_id}
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization id |
PUT
zoho_books_update_organization
Update an organization in Zoho Books
/organizations/{organization_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization id |
| body | object | optional | JSON object matching Zoho Books' update an organization request schema |
GET
zoho_books_list_organizations_for_user
List organizations for a user in Zoho Books
/organizations/user
6 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| string | optional | Zoho Books email parameter | |
| show_same_currency_orgs_only | boolean | optional | Zoho Books show same currency orgs only parameter |
| show_admin_orgs_only | boolean | optional | Zoho Books show admin orgs only parameter |
| startTrial | string | optional | Zoho Books starttrial parameter |
| show_active_orgs_only | boolean | optional | Zoho Books show active orgs only parameter |
| app_name | string | optional | Zoho Books app name parameter |
GET
zoho_books_get_organization_address
Get the organization address in Zoho Books
/organizations/address
POST
zoho_books_create_organization_address
Create the organization address in Zoho Books
/organizations/address
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| body | object | optional | JSON object matching Zoho Books' create the organization address request schema |
PUT
zoho_books_update_organization_address
Update the organization address in Zoho Books
/organizations/address/{address_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| address_id | string | required | Zoho Books address id |
| body | object | optional | JSON object matching Zoho Books' update the organization address request schema |
DELETE
zoho_books_delete_organization_address
Delete the organization address in Zoho Books
/organizations/address/{address_id}
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| address_id | string | required | Zoho Books address id |
POST
zoho_books_copy_organization_settings
Copy settings to an organization in Zoho Books
/organizations/{organization_id}/copysettings
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization id |
| settings_to_copy | string | required | Zoho Books settings to copy parameter |
POST
zoho_books_downgrade_organization_to_invoice
Downgrade an organization to Zoho Invoice in Zoho Books
/organizations/{organization_id}/downgradetoinvoice
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization id |
POST
zoho_books_upgrade_organization_to_books
Upgrade an organization to Zoho Books in Zoho Books
/organizations/{organization_id}/upgradetobooks
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization id |
POST
zoho_books_mark_organization_inactive
Mark an organization as inactive in Zoho Books
/organizations/{organization_id}/inactive
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization id |
GET
zoho_books_list_projects
List projects in Zoho Books
/projects
6 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| filter_by | string | optional | Zoho Books filter by parameter |
| customer_id | string | optional | Zoho Books customer id parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_project
Create a project in Zoho Books
/projects
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a project request schema |
PUT
zoho_books_update_projects_using_custom_field
Update a project using a custom field's unique value in Zoho Books
/projects
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a project using a custom field's unique value request schema |
GET
zoho_books_get_project
Get a project in Zoho Books
/projects/{project_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_project
Update project in Zoho Books
/projects/{project_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update project request schema |
DELETE
zoho_books_delete_project
Delete project in Zoho Books
/projects/{project_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_project_active
Activate project in Zoho Books
/projects/{project_id}/active
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_project_inactive
Inactivate a project in Zoho Books
/projects/{project_id}/inactive
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_clone_project
Clone project in Zoho Books
/projects/{project_id}/clone
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' clone project request schema |
GET
zoho_books_list_project_users
List Users in Zoho Books
/projects/{project_id}/users
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_project_user
Assign users in Zoho Books
/projects/{project_id}/users
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' assign users request schema |
POST
zoho_books_invite_project_user
Invite user in Zoho Books
/projects/{project_id}/users/invite
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' invite user request schema |
GET
zoho_books_get_project_user
Get a Project User in Zoho Books
/projects/{project_id}/users/{user_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| user_id | string | required | Zoho Books user id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_project_user
Update user in Zoho Books
/projects/{project_id}/users/{user_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| user_id | string | required | Zoho Books user id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update user request schema |
DELETE
zoho_books_delete_project_user
Delete user in Zoho Books
/projects/{project_id}/users/{user_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| user_id | string | required | Zoho Books user id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_project_comments
List comments in Zoho Books
/projects/{project_id}/comments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_project_comment
Post comment in Zoho Books
/projects/{project_id}/comments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' post comment request schema |
DELETE
zoho_books_delete_project_comment
Delete comment in Zoho Books
/projects/{project_id}/comments/{comment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_project_invoices
List invoices in Zoho Books
/projects/{project_id}/invoices
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| sort_column | string | optional | Zoho Books sort column parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
GET
zoho_books_list_project_tasks
List project tasks in Zoho Books
/projects/{project_id}/tasks
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_add_project_task
Add a project task in Zoho Books
/projects/{project_id}/tasks
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add a project task request schema |
GET
zoho_books_get_project_task
Get a project task in Zoho Books
/projects/{project_id}/tasks/{task_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| task_id | string | required | Zoho Books task id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_project_task
Update a project task in Zoho Books
/projects/{project_id}/tasks/{task_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| task_id | string | required | Zoho Books task id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a project task request schema |
DELETE
zoho_books_delete_project_task
Delete project Task in Zoho Books
/projects/{project_id}/tasks/{task_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| project_id | string | required | Zoho Books project id |
| task_id | string | required | Zoho Books task id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_purchase_orders
List purchase orders in Zoho Books
/purchaseorders
20 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| purchaseorder_number | string | optional | Zoho Books purchaseorder number parameter |
| reference_number | string | optional | Zoho Books reference number parameter |
| date | string | optional | Zoho Books date parameter |
| status | string | optional | Zoho Books status parameter |
| item_name | string | optional | Zoho Books item name parameter |
| item_description | string | optional | Zoho Books item description parameter |
| vendor_name | string | optional | Zoho Books vendor name parameter |
| total | string | optional | Zoho Books total parameter |
| vendor_id | string | optional | Zoho Books vendor id parameter |
| last_modified_time | string | optional | Zoho Books last modified time parameter |
| item_id | string | optional | Zoho Books item id parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| search_text | string | optional | Zoho Books search text parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| custom_field | string | optional | Zoho Books custom field parameter |
| created_date | string | optional | Zoho Books created date parameter |
| location_ids | string | optional | Zoho Books location ids parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_purchase_order
Create a purchase order in Zoho Books
/purchaseorders
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| ignore_auto_number_generation | string | optional | Zoho Books ignore auto number generation parameter |
| body | object | optional | JSON object matching Zoho Books' create a purchase order request schema |
PUT
zoho_books_update_purchase_order_using_custom_field
Update a purchase order using a custom field's unique value in Zoho Books
/purchaseorders
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a purchase order using a custom field's unique value request schema |
GET
zoho_books_get_purchase_order
Get a purchase order in Zoho Books
/purchaseorders/{purchaseorder_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| string | optional | Zoho Books print parameter | |
| accept | string | optional | Zoho Books accept parameter |
PUT
zoho_books_update_purchase_order
Update a purchase order in Zoho Books
/purchaseorders/{purchaseorder_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| ignore_auto_number_generation | string | optional | Zoho Books ignore auto number generation parameter |
| body | object | optional | JSON object matching Zoho Books' update a purchase order request schema |
DELETE
zoho_books_delete_purchase_order
Delete purchase order in Zoho Books
/purchaseorders/{purchaseorder_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_custom_fields_in_purchase_order
Update custom field in existing purchaseorders in Zoho Books
/purchaseorder/{purchaseorder_id}/customfields
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | array | optional | JSON array matching Zoho Books' update custom field in existing purchaseorders request schema |
POST
zoho_books_mark_purchase_order_open
Mark a purchase order as open in Zoho Books
/purchaseorders/{purchaseorder_id}/status/open
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_purchase_order_billed
Mark as billed in Zoho Books
/purchaseorders/{purchaseorder_id}/status/billed
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_purchase_order_cancelled
Cancel a purchase order in Zoho Books
/purchaseorders/{purchaseorder_id}/status/cancelled
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_submit_purchase_order
Submit a purchase order for approval in Zoho Books
/purchaseorders/{purchaseorder_id}/submit
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_approve_purchase_order
Approve a purchase order in Zoho Books
/purchaseorders/{purchaseorder_id}/approve
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_purchase_order_email
Get purchase order email content in Zoho Books
/purchaseorders/{purchaseorder_id}/email
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| email_template_id | string | optional | Zoho Books email template id parameter |
POST
zoho_books_email_purchase_order
Email a purchase order in Zoho Books
/purchaseorders/{purchaseorder_id}/email
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| send_attachment | string | optional | Zoho Books send attachment parameter |
| file_name | string | optional | Zoho Books file name parameter |
| body | object | optional | JSON object matching Zoho Books' email a purchase order request schema |
PUT
zoho_books_update_purchase_order_billing_address
Update billing address in Zoho Books
/purchaseorders/{purchaseorder_id}/address/billing
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update billing address request schema |
GET
zoho_books_list_purchase_order_templates
List purchase order templates in Zoho Books
/purchaseorders/templates
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_purchase_order_template
Update purchase order template in Zoho Books
/purchaseorders/{purchaseorder_id}/templates/{template_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| template_id | string | required | Zoho Books template id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| templates | string | optional | Zoho Books templates parameter |
PUT
zoho_books_update_purchase_order_attachment
Update attachment preference in Zoho Books
/purchaseorders/{purchaseorder_id}/attachment
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| can_send_in_mail | boolean | required | Zoho Books can send in mail parameter |
DELETE
zoho_books_delete_purchase_order_attachment
Delete an attachment in Zoho Books
/purchaseorders/{purchaseorder_id}/attachment
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_purchase_order_comments
List purchase order comments & history in Zoho Books
/purchaseorders/{purchaseorder_id}/comments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_purchase_order_comment
Add comment in Zoho Books
/purchaseorders/{purchaseorder_id}/comments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add comment request schema |
PUT
zoho_books_update_purchase_order_comment
Update comment in Zoho Books
/purchaseorders/{purchaseorder_id}/comments/{comment_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update comment request schema |
DELETE
zoho_books_delete_purchase_order_comment
Delete a comment in Zoho Books
/purchaseorders/{purchaseorder_id}/comments/{comment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_reject_purchase_orders
Reject Purchase Order in Zoho Books
/purchaseorders/{purchaseorder_id}/reject
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| purchaseorder_id | string | required | Zoho Books purchaseorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_recurring_bills
List recurring bills in Zoho Books
/recurringbills
44 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| recurring_bill_id | string | optional | Zoho Books recurring bill id parameter |
| vendor_id | string | optional | Zoho Books vendor id parameter |
| vendor_name | string | optional | Zoho Books vendor name parameter |
| status | string | optional | Zoho Books status parameter |
| recurrence_name | string | optional | Zoho Books recurrence name parameter |
| currency_id | string | optional | Zoho Books currency id parameter |
| currency_code | string | optional | Zoho Books currency code parameter |
| currency_symbol | string | optional | Zoho Books currency symbol parameter |
| start_date | string | optional | Zoho Books start date parameter |
| end_date | string | optional | Zoho Books end date parameter |
| source_of_supply | string | optional | Zoho Books source of supply parameter |
| place_of_supply | string | optional | Zoho Books place of supply parameter |
| destination_of_supply | string | optional | Zoho Books destination of supply parameter |
| gst_treatment | string | optional | Zoho Books gst treatment parameter |
| gst_no | string | optional | Zoho Books gst no parameter |
| tax_treatment | string | optional | Zoho Books tax treatment parameter |
| vat_treatment | string | optional | Zoho Books vat treatment parameter |
| vat_reg_no | string | optional | Zoho Books vat reg no parameter |
| is_abn_quoted | boolean | optional | Zoho Books is abn quoted parameter |
| abn | string | optional | Zoho Books abn parameter |
| is_reverse_charge_applied | boolean | optional | Zoho Books is reverse charge applied parameter |
| pricebook_id | string | optional | Zoho Books pricebook id parameter |
| pricebook_name | string | optional | Zoho Books pricebook name parameter |
| is_inclusive_tax | boolean | optional | Zoho Books is inclusive tax parameter |
| line_items | string | optional | Zoho Books line items parameter |
| is_tds_applied | boolean | optional | Zoho Books is tds applied parameter |
| notes | string | optional | Zoho Books notes parameter |
| terms | string | optional | Zoho Books terms parameter |
| payment_terms | string | optional | Zoho Books payment terms parameter |
| payment_terms_label | string | optional | Zoho Books payment terms label parameter |
| custom_fields | string | optional | Zoho Books custom fields parameter |
| acquisition_vat_summary | string | optional | Zoho Books acquisition vat summary parameter |
| reverse_charge_vat_summary | string | optional | Zoho Books reverse charge vat summary parameter |
| acquisition_vat_total | string | optional | Zoho Books acquisition vat total parameter |
| reverse_charge_vat_total | string | optional | Zoho Books reverse charge vat total parameter |
| created_time | string | optional | Zoho Books created time parameter |
| created_by_id | string | optional | Zoho Books created by id parameter |
| last_modified_time | string | optional | Zoho Books last modified time parameter |
| discount | string | optional | Zoho Books discount parameter |
| discount_account_id | string | optional | Zoho Books discount account id parameter |
| is_discount_before_tax | boolean | optional | Zoho Books is discount before tax parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_recurring_bill
Create a recurring bill in Zoho Books
/recurringbills
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a recurring bill request schema |
PUT
zoho_books_update_recurring_bill_using_custom_field
Update a recurring bill using a custom field's unique value in Zoho Books
/recurringbills
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a recurring bill using a custom field's unique value request schema |
PUT
zoho_books_update_recurring_bill
Update a recurring bill in Zoho Books
/recurringbills/{recurring_bill_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_bill_id | string | required | Zoho Books recurring bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a recurring bill request schema |
GET
zoho_books_get_recurring_bill
Get a recurring bill in Zoho Books
/recurring_bills/{recurring_bill_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_bill_id | string | required | Zoho Books recurring bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_recurring_bill
Delete a recurring bill in Zoho Books
/recurring_bills/{recurring_bill_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_bill_id | string | required | Zoho Books recurring bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_stop_recurring_bill
Stop a recurring bill in Zoho Books
/recurringbills/{recurring_bill_id}/status/stop
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_bill_id | string | required | Zoho Books recurring bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_resume_recurring_bill
Resume a recurring Bill in Zoho Books
/recurringbills/{recurring_bill_id}/status/resume
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_bill_id | string | required | Zoho Books recurring bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_recurring_bill_history
List recurring bill history in Zoho Books
/recurringbills/{recurring_bill_id}/comments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_bill_id | string | required | Zoho Books recurring bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_recurring_invoices
List all Recurring Invoice in Zoho Books
/recurringinvoices
18 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| recurrence_name | string | optional | Zoho Books recurrence name parameter |
| item_name | string | optional | Zoho Books item name parameter |
| item_description | string | optional | Zoho Books item description parameter |
| customer_name | string | optional | Zoho Books customer name parameter |
| line_item_id | string | optional | Zoho Books line item id parameter |
| item_id | string | optional | Zoho Books item id parameter |
| tax_id | string | optional | Zoho Books tax id parameter |
| notes | string | optional | Zoho Books notes parameter |
| start_date | string | optional | Zoho Books start date parameter |
| end_date | string | optional | Zoho Books end date parameter |
| customer_id | string | optional | Zoho Books customer id parameter |
| status | string | optional | Zoho Books status parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| search_text | string | optional | Zoho Books search text parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_recurring_invoice
Create a Recurring Invoice in Zoho Books
/recurringinvoices
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a recurring invoice request schema |
PUT
zoho_books_update_recurring_invoice_using_custom_field
Update a recurring invoice using a custom field's unique value in Zoho Books
/recurringinvoices
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a recurring invoice using a custom field's unique value request schema |
GET
zoho_books_get_recurring_invoice
Get a Recurring Invoice in Zoho Books
/recurringinvoices/{recurring_invoice_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_invoice_id | string | required | Zoho Books recurring invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_recurring_invoice
Update Recurring Invoice in Zoho Books
/recurringinvoices/{recurring_invoice_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_invoice_id | string | required | Zoho Books recurring invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update recurring invoice request schema |
DELETE
zoho_books_delete_recurring_invoice
Delete a Recurring Invoice in Zoho Books
/recurringinvoices/{recurring_invoice_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_invoice_id | string | required | Zoho Books recurring invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_stop_recurring_invoice
Stop a Recurring Invoice in Zoho Books
/recurringinvoices/{recurring_invoice_id}/status/stop
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_invoice_id | string | required | Zoho Books recurring invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' stop a recurring invoice request schema |
POST
zoho_books_resume_recurring_invoice
Resume a Recurring Invoice in Zoho Books
/recurringinvoices/{recurring_invoice_id}/status/resume
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_invoice_id | string | required | Zoho Books recurring invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' resume a recurring invoice request schema |
PUT
zoho_books_update_recurring_invoice_template
Update Recurring Invoice template in Zoho Books
/recurringinvoices/{recurring_invoice_id}/templates/{template_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_invoice_id | string | required | Zoho Books recurring invoice id |
| template_id | string | required | Zoho Books template id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update recurring invoice template request schema |
GET
zoho_books_list_recurring_invoice_history
List Recurring Invoice History in Zoho Books
/recurringinvoices/{recurring_invoice_id}/comments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_invoice_id | string | required | Zoho Books recurring invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_resume_recurring_invoices
Resume recurring invoices in Zoho Books
/recurringinvoices/status/resume
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| recurring_invoice_ids | string | required | Zoho Books recurring invoice ids parameter |
POST
zoho_books_stop_recurring_invoices
Stop recurring invoices in Zoho Books
/recurringinvoices/status/stop
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| recurring_invoice_ids | string | required | Zoho Books recurring invoice ids parameter |
GET
zoho_books_get_recurring_invoice_dashboard
Get the recurring invoices dashboard in Zoho Books
/recurringinvoices/dashboard
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_recurring_invoice_child_invoices
List invoices created from a recurring invoice in Zoho Books
/recurringinvoices/{recurring_invoice_id}/invoices
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_invoice_id | string | required | Zoho Books recurring invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| filter_by | string | optional | Zoho Books filter by parameter |
| search_text | string | optional | Zoho Books search text parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
POST
zoho_books_enable_recurring_invoice_autobill
Enable auto-bill for a recurring invoice in Zoho Books
/recurringinvoices/{recurring_invoice_id}/autobill/enable
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_invoice_id | string | required | Zoho Books recurring invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_disable_recurring_invoice_autobill
Disable auto-bill for a recurring invoice in Zoho Books
/recurringinvoices/{recurring_invoice_id}/autobill/disable
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_invoice_id | string | required | Zoho Books recurring invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_recurring_invoice_bank_account
Delete the bank account of a recurring invoice in Zoho Books
/recurringinvoices/{recurring_invoice_id}/bankaccount
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_invoice_id | string | required | Zoho Books recurring invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| can_delete_in_customer | boolean | optional | Zoho Books can delete in customer parameter |
DELETE
zoho_books_delete_recurring_invoice_card
Delete the card of a recurring invoice in Zoho Books
/recurringinvoices/{recurring_invoice_id}/card
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_invoice_id | string | required | Zoho Books recurring invoice id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| can_delete_in_customer | boolean | optional | Zoho Books can delete in customer parameter |
POST
zoho_books_associate_recurring_invoice_bank_account
Associate a bank account with a recurring invoice in Zoho Books
/recurringinvoices/{recurring_invoice_id}/bankaccount/{account_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_invoice_id | string | required | Zoho Books recurring invoice id |
| account_id | string | required | Zoho Books account id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_associate_recurring_invoice_card
Associate a card with a recurring invoice in Zoho Books
/recurringinvoices/{recurring_invoice_id}/card/{card_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| recurring_invoice_id | string | required | Zoho Books recurring invoice id |
| card_id | string | required | Zoho Books card id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_sales_orders
List sales orders in Zoho Books
/salesorders
31 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| sort_column | string | optional | Zoho Books sort column parameter |
| search_text | string | optional | Zoho Books search text parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| salesorder_number | string | optional | Zoho Books salesorder number parameter |
| item_name | string | optional | Zoho Books item name parameter |
| item_id | string | optional | Zoho Books item id parameter |
| item_description | string | optional | Zoho Books item description parameter |
| reference_number | string | optional | Zoho Books reference number parameter |
| customer_name | string | optional | Zoho Books customer name parameter |
| string | optional | Zoho Books email parameter | |
| total | string | optional | Zoho Books total parameter |
| date | string | optional | Zoho Books date parameter |
| created_date | string | optional | Zoho Books created date parameter |
| shipment_date | string | optional | Zoho Books shipment date parameter |
| expiry_date_start | string | optional | Zoho Books expiry date start parameter |
| expiry_date_end | string | optional | Zoho Books expiry date end parameter |
| expiry_date_before | string | optional | Zoho Books expiry date before parameter |
| expiry_date_after | string | optional | Zoho Books expiry date after parameter |
| status | string | optional | Zoho Books status parameter |
| customer_id | string | optional | Zoho Books customer id parameter |
| salesperson_id | string | optional | Zoho Books salesperson id parameter |
| salesorder_ids | string | optional | Zoho Books salesorder ids parameter |
| zcrm_potential_id | string | optional | Zoho Books zcrm potential id parameter |
| last_modified_time | string | optional | Zoho Books last modified time parameter |
| accept | string | optional | Zoho Books accept parameter |
| string | optional | Zoho Books print parameter | |
| customview_id | string | optional | Zoho Books customview id parameter |
| location_ids | string | optional | Zoho Books location ids parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_sales_order
Create a sales order in Zoho Books
/salesorders
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| ignore_auto_number_generation | string | optional | Zoho Books ignore auto number generation parameter |
| can_send_in_mail | boolean | optional | Zoho Books can send in mail parameter |
| totalFiles | string | optional | Zoho Books totalfiles parameter |
| body | object | optional | JSON object matching Zoho Books' create a sales order request schema |
PUT
zoho_books_update_sales_order_using_custom_field
Update a sales order using a custom field's unique value in Zoho Books
/salesorders
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a sales order using a custom field's unique value request schema |
GET
zoho_books_get_sales_order
Get a sales order in Zoho Books
/salesorders/{salesorder_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| string | optional | Zoho Books print parameter | |
| accept | string | optional | Zoho Books accept parameter |
PUT
zoho_books_update_sales_order
Update a sales order in Zoho Books
/salesorders/{salesorder_id}
6 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| ignore_auto_number_generation | string | optional | Zoho Books ignore auto number generation parameter |
| can_send_in_mail | boolean | optional | Zoho Books can send in mail parameter |
| totalFiles | string | optional | Zoho Books totalfiles parameter |
| body | object | optional | JSON object matching Zoho Books' update a sales order request schema |
DELETE
zoho_books_delete_sales_order
Delete a sales order in Zoho Books
/salesorders/{salesorder_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_salesorder_customfields
Update custom field in existing salesorders in Zoho Books
/salesorder/{salesorder_id}/customfields
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | array | optional | JSON array matching Zoho Books' update custom field in existing salesorders request schema |
POST
zoho_books_mark_sales_order_as_open
Mark a sales order as open in Zoho Books
/salesorders/{salesorder_id}/status/open
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_sales_order_as_void
Mark a sales order as void in Zoho Books
/salesorders/{salesorder_id}/status/void
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' mark a sales order as void request schema |
POST
zoho_books_update_sales_order_sub_status
Update a sales order sub status in Zoho Books
/salesorders/{salesorder_id}/substatus/{status_code}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| status_code | string | required | Zoho Books status code |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_sales_order_email
Get sales order email content in Zoho Books
/salesorders/{salesorder_id}/email
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| email_template_id | string | optional | Zoho Books email template id parameter |
POST
zoho_books_email_sales_order
Email a sales order in Zoho Books
/salesorders/{salesorder_id}/email
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id parameter |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| send_attachment | string | optional | Zoho Books send attachment parameter |
| file_name | string | optional | Zoho Books file name parameter |
| body | object | optional | JSON object matching Zoho Books' email a sales order request schema |
POST
zoho_books_submit_sales_order
Submit a sales order for approval in Zoho Books
/salesorders/{salesorder_id}/submit
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_approve_sales_order
Approve a sales order. in Zoho Books
/salesorders/{salesorder_id}/approve
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_sales_order_billing_address
Update billing address in Zoho Books
/salesorders/{salesorder_id}/address/billing
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update billing address request schema |
PUT
zoho_books_update_sales_order_shipping_address
Update shipping address in Zoho Books
/salesorders/{salesorder_id}/address/shipping
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update shipping address request schema |
GET
zoho_books_list_sales_order_templates
List sales order templates in Zoho Books
/salesorders/templates
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_sales_order_template
Update sales order template in Zoho Books
/salesorders/{salesorder_id}/templates/{template_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| template_id | string | required | Zoho Books template id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_sales_order_attachment_preference
Update attachment preference in Zoho Books
/salesorders/{salesorder_id}/attachment
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| can_send_in_mail | boolean | required | Zoho Books can send in mail parameter |
DELETE
zoho_books_delete_sales_order_attachment
Delete an attachment in Zoho Books
/salesorders/{salesorder_id}/attachment
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_sales_order_comments
List sales order comments & history in Zoho Books
/salesorders/{salesorder_id}/comments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_sales_order_comment
Add comment in Zoho Books
/salesorders/{salesorder_id}/comments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add comment request schema |
PUT
zoho_books_update_sales_order_comment
Update comment in Zoho Books
/salesorders/{salesorder_id}/comments/{comment_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update comment request schema |
DELETE
zoho_books_delete_sales_order_comment
Delete a comment in Zoho Books
/salesorders/{salesorder_id}/comments/{comment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| salesorder_id | string | required | Zoho Books salesorder id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_tasks
List tasks in Zoho Books
/tasks
26 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| entity_id | string | optional | Zoho Books entity id parameter |
| sub_entity_id | string | optional | Zoho Books sub entity id parameter |
| owner_id | string | optional | Zoho Books owner id parameter |
| contact_id | string | optional | Zoho Books contact id parameter |
| client_id | string | optional | Zoho Books client id parameter |
| status | string | optional | Zoho Books status parameter |
| parent_status | string | optional | Zoho Books parent status parameter |
| search_text | string | optional | Zoho Books search text parameter |
| priority | string | optional | Zoho Books priority parameter |
| entity_type | string | optional | Zoho Books entity type parameter |
| title | string | optional | Zoho Books title parameter |
| task_description | string | optional | Zoho Books task description parameter |
| is_overdue | boolean | optional | Zoho Books is overdue parameter |
| created_by | string | optional | Zoho Books created by parameter |
| is_accountant_task | boolean | optional | Zoho Books is accountant task parameter |
| contact_ids | string | optional | Zoho Books contact ids parameter |
| client_ids | string | optional | Zoho Books client ids parameter |
| owner_ids | string | optional | Zoho Books owner ids parameter |
| date_start | string | optional | Zoho Books date start parameter |
| date_end | string | optional | Zoho Books date end parameter |
| task_number | string | optional | Zoho Books task number parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_add_task
Add a task in Zoho Books
/tasks
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add a task request schema |
PUT
zoho_books_update_tasks
Update tasks in Zoho Books
/tasks
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| bulk_update | string | required | Zoho Books bulk update parameter |
| body | array | optional | JSON array matching Zoho Books' update tasks request schema |
DELETE
zoho_books_delete_tasks
Delete tasks in Zoho Books
/tasks
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| task_ids | string | required | Zoho Books task ids parameter |
GET
zoho_books_get_task
Get a task in Zoho Books
/tasks/{task_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| task_id | string | required | Zoho Books task id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_a_task
Update a tasks in Zoho Books
/tasks/{task_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| task_id | string | required | Zoho Books task id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a tasks request schema |
DELETE
zoho_books_delete_task
Delete a tasks in Zoho Books
/tasks/{task_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| task_id | string | required | Zoho Books task id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_update_percentage_task
Update completed percentage in Zoho Books
/tasks/{task_id}/percentage
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| task_id | string | required | Zoho Books task id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update completed percentage request schema |
POST
zoho_books_mark_task_as_open
Mark task as open in Zoho Books
/tasks/{task_id}/markasopen
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| task_id | string | required | Zoho Books task id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_task_as_ongoing
Mark task as ongoing in Zoho Books
/tasks/{task_id}/markasongoing
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| task_id | string | required | Zoho Books task id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_task_as_completed
Mark task as completed in Zoho Books
/tasks/{task_id}/markascompleted
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| task_id | string | required | Zoho Books task id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_task_comments
List comments of task in Zoho Books
/tasks/{task_id}/comments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| task_id | string | required | Zoho Books task id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_task_comment
Add comment to task in Zoho Books
/tasks/{task_id}/comments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| task_id | string | required | Zoho Books task id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add comment to task request schema |
DELETE
zoho_books_delete_task_comment
Delete comment of task in Zoho Books
/tasks/{task_id}/comments/{comment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| task_id | string | required | Zoho Books task id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
DELETE
zoho_books_delete_task_document
Delete document of task in Zoho Books
/tasks/{task_id}/documents/{document_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| task_id | string | required | Zoho Books task id |
| document_id | string | required | Zoho Books document id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| un_associate | string | optional | Zoho Books un associate parameter |
GET
zoho_books_list_taxes
List taxes in Zoho Books
/settings/taxes
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_tax
Create a tax in Zoho Books
/settings/taxes
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a tax request schema |
GET
zoho_books_get_tax
Get a tax in Zoho Books
/settings/taxes/{tax_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| tax_id | string | required | Zoho Books tax id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_tax
Update a tax in Zoho Books
/settings/taxes/{tax_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| tax_id | string | required | Zoho Books tax id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a tax request schema |
DELETE
zoho_books_delete_tax
Delete a tax in Zoho Books
/settings/taxes/{tax_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| tax_id | string | required | Zoho Books tax id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_tax_group
Get a tax group in Zoho Books
/settings/taxgroups/{tax_group_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| tax_group_id | string | required | Zoho Books tax group id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_tax_group
Update a tax group in Zoho Books
/settings/taxgroups/{tax_group_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| tax_group_id | string | required | Zoho Books tax group id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a tax group request schema |
DELETE
zoho_books_delete_tax_group
Delete a tax group in Zoho Books
/settings/taxgroups/{tax_group_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| tax_group_id | string | required | Zoho Books tax group id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_create_tax_group
Create a tax group in Zoho Books
/settings/taxgroups
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a tax group request schema |
GET
zoho_books_list_tax_authorities
List tax authorities [US Edition only] in Zoho Books
/settings/taxauthorities
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_create_tax_authority
Create a tax authority [US and CA Edition only] in Zoho Books
/settings/taxauthorities
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a tax authority [us and ca edition only] request schema |
GET
zoho_books_get_tax_authority
Get a tax authority [US and CA Edition only] in Zoho Books
/settings/taxauthorities/{tax_authority_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| tax_authority_id | string | required | Zoho Books tax authority id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_tax_authority
Update a tax authority [US and CA Edition only] in Zoho Books
/settings/taxauthorities/{tax_authority_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| tax_authority_id | string | required | Zoho Books tax authority id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a tax authority [us and ca edition only] request schema |
DELETE
zoho_books_delete_tax_authority
Delete a tax authority [US and CA Edition only] in Zoho Books
/settings/taxauthorities/{tax_authority_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| tax_authority_id | string | required | Zoho Books tax authority id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_tax_exemptions
List tax exemptions [US Edition only] in Zoho Books
/settings/taxexemptions
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_create_tax_exemption
Create a tax exemption [US Edition only] in Zoho Books
/settings/taxexemptions
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a tax exemption [us edition only] request schema |
GET
zoho_books_get_tax_exemption
Get a tax exemption [US Edition only] in Zoho Books
/settings/taxexemptions/{tax_exemption_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| tax_exemption_id | string | required | Zoho Books tax exemption id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_tax_exemption
Update a tax exemption [US Edition only] in Zoho Books
/settings/taxexemptions/{tax_exemption_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| tax_exemption_id | string | required | Zoho Books tax exemption id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a tax exemption [us edition only] request schema |
DELETE
zoho_books_delete_tax_exemption
Delete a tax exemption [US Edition only] in Zoho Books
/settings/taxexemptions/{tax_exemption_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| tax_exemption_id | string | required | Zoho Books tax exemption id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_time_entries
List time entries. in Zoho Books
/projects/timeentries
9 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| from_date | string | optional | Zoho Books from date parameter |
| to_date | string | optional | Zoho Books to date parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| project_id | string | optional | Zoho Books project id parameter |
| user_id | string | optional | Zoho Books user id parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_time_entries
Log time entries in Zoho Books
/projects/timeentries
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' log time entries request schema |
DELETE
zoho_books_delete_time_entries
Delete time entries in Zoho Books
/projects/timeentries
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_time_entry
Get a time entry in Zoho Books
/projects/timeentries/{time_entry_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| time_entry_id | string | required | Zoho Books time entry id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_time_entry
Update time entry in Zoho Books
/projects/timeentries/{time_entry_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| time_entry_id | string | required | Zoho Books time entry id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update time entry request schema |
DELETE
zoho_books_delete_time_entry
Delete time entry in Zoho Books
/projects/timeentries/{time_entry_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| time_entry_id | string | required | Zoho Books time entry id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_start_entry_timer
Start timer in Zoho Books
/projects/timeentries/{time_entry_id}/timer/start
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| time_entry_id | string | required | Zoho Books time entry id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_stop_entry_timer
Stop timer in Zoho Books
/projects/timeentries/timer/stop
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_running_timer
Get timer in Zoho Books
/projects/timeentries/runningtimer/me
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_users
List Users in Zoho Books
/users
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| filter_by | string | optional | Zoho Books filter by parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_user
Create a user in Zoho Books
/users
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a user request schema |
GET
zoho_books_get_user
Get an user details in Zoho Books
/users/{user_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| user_id | string | required | Zoho Books user id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_user
Update a user in Zoho Books
/users/{user_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| user_id | string | required | Zoho Books user id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a user request schema |
DELETE
zoho_books_delete_user
Delete a user in Zoho Books
/users/{user_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| user_id | string | required | Zoho Books user id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_current_user
Get current user in Zoho Books
/users/me
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_invite_user
Invite a user in Zoho Books
/users/{user_id}/invite
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| user_id | string | required | Zoho Books user id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_user_active
Mark user as active in Zoho Books
/users/{user_id}/active
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| user_id | string | required | Zoho Books user id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_user_inactive
Mark user as inactive in Zoho Books
/users/{user_id}/inactive
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| user_id | string | required | Zoho Books user id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_vendor_credits
List vendor credits in Zoho Books
/vendorcredits
22 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| vendor_credit_number | string | optional | Zoho Books vendor credit number parameter |
| date | string | optional | Zoho Books date parameter |
| status | string | optional | Zoho Books status parameter |
| total | string | optional | Zoho Books total parameter |
| reference_number | string | optional | Zoho Books reference number parameter |
| customer_name | string | optional | Zoho Books customer name parameter |
| item_name | string | optional | Zoho Books item name parameter |
| item_description | string | optional | Zoho Books item description parameter |
| notes | string | optional | Zoho Books notes parameter |
| custom_field | string | optional | Zoho Books custom field parameter |
| last_modified_time | string | optional | Zoho Books last modified time parameter |
| customer_id | string | optional | Zoho Books customer id parameter |
| line_item_id | string | optional | Zoho Books line item id parameter |
| item_id | string | optional | Zoho Books item id parameter |
| tax_id | string | optional | Zoho Books tax id parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| search_text | string | optional | Zoho Books search text parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
| location_ids | string | optional | Zoho Books location ids parameter |
POST
zoho_books_create_vendor_credit
Create a vendor credit in Zoho Books
/vendorcredits
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| ignore_auto_number_generation | string | optional | Zoho Books ignore auto number generation parameter |
| bill_id | string | optional | Zoho Books bill id parameter |
| body | object | optional | JSON object matching Zoho Books' create a vendor credit request schema |
GET
zoho_books_get_vendor_credit
Get vendor credit in Zoho Books
/vendorcredits/{vendor_credit_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| string | optional | Zoho Books print parameter | |
| accept | string | optional | Zoho Books accept parameter |
PUT
zoho_books_update_vendor_credit
Update vendor credit in Zoho Books
/vendorcredits/{vendor_credit_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update vendor credit request schema |
DELETE
zoho_books_delete_vendor_credit
Delete vendor credit in Zoho Books
/vendorcredits/{vendor_credit_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_vendor_credit_open
Convert to open in Zoho Books
/vendorcredits/{vendor_credit_id}/status/open
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_mark_vendor_credit_void
Void vendor credit in Zoho Books
/vendorcredits/{vendor_credit_id}/status/void
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_submit_vendor_credit
Submit a Vendor credit for approval in Zoho Books
/vendorcredits/{vendor_credit_id}/submit
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_approve_vendor_credit
Approve a Vendor credit in Zoho Books
/vendorcredits/{vendor_credit_id}/approve
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_bills_credited
List bills credited in Zoho Books
/vendorcredits/{vendor_credit_id}/bills
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_apply_credits_to_a_bill
Apply credits to a bill in Zoho Books
/vendorcredits/{vendor_credit_id}/bills
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' apply credits to a bill request schema |
DELETE
zoho_books_delete_vendor_credit_bill
Delete bills credited in Zoho Books
/vendorcredits/{vendor_credit_id}/bills/{vendor_credit_bill_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| vendor_credit_bill_id | string | required | Zoho Books vendor credit bill id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_vendor_credit_refunds_of_a_vendor_credit
List refunds of a vendor credit in Zoho Books
/vendorcredits/{vendor_credit_id}/refunds
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_refund_vendor_credit
Refund a vendor credit in Zoho Books
/vendorcredits/{vendor_credit_id}/refunds
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' refund a vendor credit request schema |
GET
zoho_books_get_vendor_credit_refund
Get vendor credit refund in Zoho Books
/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| vendor_credit_refund_id | string | required | Zoho Books vendor credit refund id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_vendor_credit_refund
Update vendor credit refund in Zoho Books
/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| vendor_credit_refund_id | string | required | Zoho Books vendor credit refund id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update vendor credit refund request schema |
DELETE
zoho_books_delete_vendor_credit_refund
Delete vendor credit refund in Zoho Books
/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| vendor_credit_refund_id | string | required | Zoho Books vendor credit refund id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_vendor_credit_refunds_of_all_vendor_credits
List vendor credit refunds in Zoho Books
/vendorcredits/refunds
6 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| customer_id | string | optional | Zoho Books customer id parameter |
| last_modified_time | string | optional | Zoho Books last modified time parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
GET
zoho_books_list_vendor_credit_comments
List vendor credit comments & history in Zoho Books
/vendorcredits/{vendor_credit_id}/comments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_add_vendor_credit_comment
Add a comment in Zoho Books
/vendorcredits/{vendor_credit_id}/comments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' add a comment request schema |
DELETE
zoho_books_delete_vendor_credit_comment
Delete a comment in Zoho Books
/vendorcredits/{vendor_credit_id}/comments/{comment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| vendor_credit_id | string | required | Zoho Books vendor credit id |
| comment_id | string | required | Zoho Books comment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_vendor_payments
List vendor payments in Zoho Books
/vendorpayments
17 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| vendor_name | string | optional | Zoho Books vendor name parameter |
| reference_number | string | optional | Zoho Books reference number parameter |
| payment_number | string | optional | Zoho Books payment number parameter |
| date | string | optional | Zoho Books date parameter |
| amount | string | optional | Zoho Books amount parameter |
| payment_mode | string | optional | Zoho Books payment mode parameter |
| notes | string | optional | Zoho Books notes parameter |
| vendor_id | string | optional | Zoho Books vendor id parameter |
| last_modified_time | string | optional | Zoho Books last modified time parameter |
| bill_id | string | optional | Zoho Books bill id parameter |
| description | string | optional | Zoho Books description parameter |
| filter_by | string | optional | Zoho Books filter by parameter |
| search_text | string | optional | Zoho Books search text parameter |
| sort_column | string | optional | Zoho Books sort column parameter |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_create_vendor_payment
Create a vendor payment in Zoho Books
/vendorpayments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' create a vendor payment request schema |
PUT
zoho_books_update_vendor_payment_using_custom_field
Update an vendor payment using a custom field's unique value in Zoho Books
/vendorpayments
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update an vendor payment using a custom field's unique value request schema |
DELETE
zoho_books_bulk_delete_vendor_payments
Bulk delete vendor payments in Zoho Books
/vendorpayments
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| vendorpayment_id | string | required | Zoho Books vendorpayment id parameter |
| bulk_delete | string | required | Zoho Books bulk delete parameter |
GET
zoho_books_get_vendor_payment
Get a vendor payment in Zoho Books
/vendorpayments/{payment_id}
6 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| payment_id | string | required | Zoho Books payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| fetchTaxInfo | string | optional | Zoho Books fetchtaxinfo parameter |
| fetchstatementlineinfo | string | optional | Zoho Books fetchstatementlineinfo parameter |
| string | optional | Zoho Books print parameter | |
| is_bill_payment_id | boolean | optional | Zoho Books is bill payment id parameter |
PUT
zoho_books_update_vendor_payment
Update a vendor payment in Zoho Books
/vendorpayments/{payment_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| payment_id | string | required | Zoho Books payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a vendor payment request schema |
DELETE
zoho_books_delete_vendor_payment
Delete a vendor payment in Zoho Books
/vendorpayments/{payment_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| payment_id | string | required | Zoho Books payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_list_vendor_payment_refunds
List refunds of a vendor payment in Zoho Books
/vendorpayments/{payment_id}/refunds
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| payment_id | string | required | Zoho Books payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| page | integer | optional | Zoho Books page parameter |
| per_page | integer | optional | Zoho Books per page parameter |
POST
zoho_books_refund_excess_vendor_payment
Refund an excess vendor payment in Zoho Books
/vendorpayments/{payment_id}/refunds
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| payment_id | string | required | Zoho Books payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' refund an excess vendor payment request schema |
GET
zoho_books_get_vendor_payment_refund
Details of a refund in Zoho Books
/vendorpayments/{payment_id}/refunds/{vendorpayment_refund_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| payment_id | string | required | Zoho Books payment id |
| vendorpayment_refund_id | string | required | Zoho Books vendorpayment refund id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
PUT
zoho_books_update_vendor_payment_refund
Update a refund in Zoho Books
/vendorpayments/{payment_id}/refunds/{vendorpayment_refund_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| payment_id | string | required | Zoho Books payment id |
| vendorpayment_refund_id | string | required | Zoho Books vendorpayment refund id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| body | object | optional | JSON object matching Zoho Books' update a refund request schema |
DELETE
zoho_books_delete_vendor_payment_refund
Delete a refund in Zoho Books
/vendorpayments/{payment_id}/refunds/{vendorpayment_refund_id}
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| payment_id | string | required | Zoho Books payment id |
| vendorpayment_refund_id | string | required | Zoho Books vendorpayment refund id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
GET
zoho_books_get_vendor_payment_email_content
Get vendor payment email content in Zoho Books
/vendorpayments/{payment_id}/email
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| payment_id | string | required | Zoho Books payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
POST
zoho_books_email_vendor_payment
Email a vendor payment in Zoho Books
/vendorpayments/{payment_id}/email
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| payment_id | string | required | Zoho Books payment id |
| organization_id | string | required | Zoho Books organization ID from list_organizations |
| send_attachment | string | optional | Zoho Books send attachment parameter |
| file_name | string | optional | Zoho Books file name parameter |
| body | object | optional | JSON object matching Zoho Books' email a vendor payment request schema |