Zoho Books integration: operations for AI agents
Zoho Books connects to Type.com as an integration. This page lists the 885 operations documented for Claude and Codex in Type.com: 271 read, 334 write, 280 destructive.
About Zoho Books
Zoho Books handles accounting, invoicing, and expense tracking, offering real-time collaboration and integrations within the Zoho ecosystem
Categories: Finance & Accounting
How to connect Zoho Books to Type.com
- Access
- Organization connection: one shared account for the workspace.
- MCP
- Selected payment-processing operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.
To add the connection, follow the steps in Space connections.
Documented operations
885 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
885 operations listed.
Organizations
- Read
List organizations
Get the list of organizations.
- Read
Get an organization
Get the details of an organization.
- Read
List organizations for a user
Retrieve the list of organizations accessible to a user. Use the query parameters to filter the organizations returned.
- Read
Get the organization address
Retrieve the address of the organization.
- Write
Create an organization
Create an organization.
- Write
Create the organization address
Add an address for the organization.
- Write
Copy settings to an organization
Copy the specified settings to an organization.
- Write
Downgrade an organization to Zoho Invoice
Downgrade an organization from Zoho Books to Zoho Invoice.
- Write
Upgrade an organization to Zoho Books
Upgrade an organization from Zoho Invoice to Zoho Books.
- Write
Mark an organization as inactive
Mark an organization as inactive.
- Destructive
Update an organization
Update the details of an organization.
- Destructive
Update the organization address
Update an existing address of the organization.
- Destructive
Delete the organization address
Delete an existing address of the organization.
Contacts
- Read
List Contacts
Retrieve a comprehensive list of all contacts with advanced filters. This operation supports multiple search criteria including contact name, company name, address, email, phone, and general text search.
- Read
Verify a Contact Address
Validate a contact address against the provided address fields. Use this before creating or updating a contact to confirm that the address is valid.
- Read
List Auto-bill Recurring Invoices for a Contact Card
Retrieve the recurring invoices set to be auto-billed against a specific card of a contact. Use this to review which recurring invoices are linked to a contact card for automatic payment.
- Read
Get Contact
Retrieve comprehensive details of a specific contact. This operation provides complete contact details such as basic information, addresses, contact persons, payment terms, tax settings, custom fields, and financial data including outstanding amounts, credit limits, and transact…
- Read
Get Statement Mail Content
Get the statement mail content.
- Read
Get contact email content
Retrieve the default email content used when emailing a contact.
- Read
List Comments
List recent activities of a contact.
- Read
Get Contact Addresses
Get addresses of a contact including its Shipping Address, Billing Address and other additional addresses.
- Read
List credit note refunds for a contact
List the credit note refunds issued to a contact.
- Read
Get Unused Retainer Payments
Retrieve information about unused retainer payments for a specific contact. This endpoint returns details of retainer payments that have been made but not yet applied to invoices, providing insight into available credit balances from retainer payments.
- Read
Get a contact bank account
Retrieve the details of a bank account associated with a contact.
- Read
List contact bank accounts
List all bank accounts associated with a contact.
- Read
List all contact bank accounts
List bank accounts across all contacts in the organization.
- Read
Get a contact card
Retrieve the details of a card associated with a contact.
- Read
List contact cards
List all cards associated with a contact.
- Read
Get contact card count
Retrieve the number of saved cards across contacts in the organization.
- Read
List all contact persons
List contact persons across all contacts in the organization.
- Read
Get a contact person of a contact
Retrieve a specific contact person of a contact.
- Read
Get a contact document
Retrieve a document attached to a contact.
- Read
List contact tax information
List the tax information records of a contact.
- Read
List contact addresses
List addresses across contacts in the organization.
- Read
Get bulk contact SMS content
Retrieve the SMS content used when notifying multiple contacts.
- Read
Get contact SMS content
Retrieve the SMS content used when notifying a contact.
- Read
Get a contact by reference
Retrieve a contact using its reference ID from an external system.
- Read
Get a contact statement
Retrieve the account statement of a contact.
- Read
Get unused credits of a contact
Retrieve the unused customer credits available for a contact.
- Read
List payment refunds of a contact
List the payment refunds issued to a contact.
- Read
Get contact income and expense
Retrieve the income and expense summary of a contact.
- Read
Get contact profit and loss
Retrieve the profit and loss summary of a contact.
- Read
Get contact inventory summary
Retrieve the inventory summary for a contact.
- Read
Get contact opening balances
Retrieve the opening balances of a contact.
- Read
Get client review email content
Retrieve the email content for a contact client review.
- Read
Get payment method email content
Retrieve the email content requesting a payment method from a contact.
- Read
Get vendor statement email content
Retrieve the email content for a vendor statement.
- Write
Create a Contact
Create a new contact with comprehensive business information. This operation allows you to create a customer or vendor by providing details such as contact name, company information, addresses, contact persons, payment terms, tax settings, and custom fields.
- Write
Assign an Owner to a Contact
Assign a user as the owner of a specific contact. Use this when a contact must be associated with a particular user for ownership and access purposes.
- Write
Assign an Owner to Multiple Contacts
Assign a user as the owner of multiple contacts in a single request. Use this to bulk-assign ownership for a set of contacts.
- Write
Mark Multiple Contacts for 1099 Tracking
Enable 1099 tracking for multiple contacts in a single request. Applicable to organizations in the United States edition that report vendor payments for 1099 purposes.
- Write
Verify a Contact Bank Account
Verify a contact bank account using the two micro-deposit amounts credited to the account. Provide the deposit amounts to confirm ownership of the bank account.
- Write
Mark as Active
Mark a contact as active.
- Write
Mark as Inactive
Mark a contact as inactive.
- Write
Enable Portal Access
Enable portal access for a contact.
- Write
Enable Payment Reminders
Enable automated payment reminders for a contact.
- Write
Disable Payment Reminders
Disable automated payment reminders for a contact.
- Write
Email Statement
Email statement to the contact. If JSONString is not inputted, mail will be sent with the default mail content.
- Write
Email Contact
Send email to contact.
- Write
Add a comment to a contact
Add a comment to a contact.
- Write
Add Additional Address
Add an additional address for a contact using the arguments below.
- Write
Track 1099
Track a contact for 1099 reporting: (Note: This API is only available when the organization's country is U.S.A).
- Write
Untrack 1099
Use this API to stop tracking payments to a vendor for 1099 reporting. (Note: This API is only available when the organization's country is U.S.A).
- Write
Add a bank account to a contact
Add a bank account for a contact to enable automatic payment collection through ACH or bank transfer.
- Write
Approve a contact bank account
Approve a bank account added for a contact.
- Write
Decline a contact bank account
Decline a bank account added for a contact.
- Write
Add a card to a contact
Add a credit or debit card for a contact to enable automatic payment collection.
- Write
Invite a contact person to the portal
Send a client portal invitation to a contact person.
- Write
Resend a portal invite
Resend the client portal invitation to a contact person.
- Write
Enable SMS for a contact person
Enable SMS notifications for a contact person.
- Write
Disable SMS for a contact person
Disable SMS notifications for a contact person.
- Write
Restore contact documents
Restore previously deleted contact documents.
- Write
Add contact tax information
Add a tax information record to a contact.
- Write
Mark an address as billing
Set a contact address as the billing address.
- Write
Mark an address as shipping
Set a contact address as the shipping address.
- Write
Verify a contact address
Verify a specific address of a contact.
- Write
Add an attachment to a contact
Attach a file to a contact.
- Write
Merge contacts
Merge a duplicate contact into another contact.
- Write
Verify contact e-invoice details
Verify the e-invoice details of a contact. For India: verifies GST registration on the IRP. For UAE: verifies Peppol network registration status.
- Write
Disable the contact portal
Disable client portal access for a contact.
- Write
Send SMS to contacts
Send an SMS notification to multiple contacts.
- Write
Send SMS to a contact
Send an SMS notification to a contact.
- Write
Update contact TRN status
Update the tax registration number (TRN) verification status of a contact.
- Write
Send a client review email
Send the client review email to a contact.
- Write
Send a payment method request email
Send an email requesting a payment method from a contact.
- Write
Send a vendor statement email
Send the vendor statement email to a contact.
- Destructive
Update a contact using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a contact by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header.
- Destructive
Delete contacts
Delete one or more contacts.
- Destructive
Update a Contact
Update an existing contact with comprehensive business information. This operation allows you to modify all contact details including basic information, addresses, contact persons, payment terms, tax settings, and custom fields.
- Destructive
Delete a Contact
Delete an existing contact.
- Destructive
Edit Additional Address
Edit the additional address of a contact using the arguments below.
- Destructive
Delete Additional Address
Delete the additional address of a contact.
- Destructive
Update a contact bank account
Update the details of a bank account associated with a contact.
- Destructive
Delete a contact bank account
Delete a bank account associated with a contact.
- Destructive
Update a contact card
Update the details of a card associated with a contact.
- Destructive
Delete a contact card
Delete a card associated with a contact.
- Destructive
Delete a contact comment
Delete a comment added to a contact.
- Destructive
Update a contact document
Update a document attached to a contact.
- Destructive
Delete a contact document
Delete a document attached to a contact.
- Destructive
Update contact tags
Update the reporting tags associated with a contact.
- Destructive
Delete a contact tag
Remove a reporting tag from a contact.
- Destructive
Update contact tax information
Update a tax information record of a contact.
- Destructive
Delete contact tax information
Delete a tax information record of a contact.
- Destructive
update an Estimate using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update an estimate by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header.
Estimates
- Read
List estimates
List all estimates with pagination.
- Read
Get an estimate
Get the details of an estimate.
- Read
Get estimate email content
Get the email content of an estimate.
- Read
Bulk export estimates
Maximum of 25 estimates can be exported in a single pdf.
- Read
Bulk print estimates
Export estimates as pdf and print them. Maximum of 25 estimates can be printed.
- Read
List estimate template
Get all estimate pdf templates.
- Read
List estimate comments & history
Get the complete history and comments of an estimate.
- Write
Create an Estimate
Create an estimate for your customer.
- Write
Mark an estimate as sent
Mark a draft estimate as sent.
- Write
Mark an estimate as accepted
Mark a sent estimate as accepted if the customer has accepted it.
- Write
Mark an estimate as declined
Mark a sent estimate as declined if the customer has rejected it.
- Write
Submit an estimate for approval
Submit an estimate for approval.
- Write
Approve an estimate.
Approve an estimate.
- Write
Email an estimate
Email an estimate to the customer. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content.
- Write
Email multiple estimates
Send estimates to your customers by email. Maximum of 10 estimates can be sent at once.
- Write
Add Comments
Add a comment for an estimate.
- Destructive
Update an Estimate
Update an existing estimate. To delete a line item just remove it from the lineitems list.
- Destructive
Delete an Estimate
Delete an existing estimate.
- Destructive
Update custom field in existing estimates
Update the value of the custom field in existing estimates.
- Destructive
Update billing address
Updates the billing address for this estimate alone.
- Destructive
Update shipping address
Updates the shipping address for an existing estimate alone.
- Destructive
Update estimate template
Update the pdf template associated with the estimate.
- Destructive
Update comment
Update an existing comment of an estimate.
- Destructive
Delete a comment
Delete an estimate comment.
Contact persons
- Read
List contact persons
List all contacts with pagination.
- Read
Get a contact person
Get the contact person details.
- Write
Create a contact person
Create a contact person for contact.
- Write
Mark as primary contact person
Mark a contact person as primary for the contact.
- Destructive
Update a contact person
Update an existing contact person.
- Destructive
Delete a contact person
Delete an existing contact person.
Sales order
- Read
List sales orders
List all sales orders.
- Read
Get a sales order
Get the details of a sales order.
- Read
Get sales order email content
Get the email content of a sales order.
- Read
Bulk export sales orders
Maximum of 25 sales orders can be exported in a single pdf.
- Read
Bulk print sales orders
Export sales orders as pdf and print them. Maximum of 25 sales orders can be printed.
- Read
List sales order templates
Get all sales order pdf templates.
- Read
Get a sales order attachment
Returns the file attached to the sales order.
- Read
List sales order comments & history
Get the complete history and comments of sales order.
- Write
Create a sales order
Create a sales order for your customer.
- Write
Mark a sales order as open
Mark a draft sales order as open.
- Write
Mark a sales order as void
Mark a sales order as void.
- Write
Update a sales order sub status
Update a sales order sub status.
- Write
Email a sales order
Email a sales order to the customer. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content.
- Write
Submit a sales order for approval
Submit a sales order for approval.
- Write
Approve a sales order.
Approve a sales order.
- Write
Add attachment to a sales order
Attach a file to a sales order.
- Write
Add comment
Add a comment for a sales order.
- Destructive
Update a sales order using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a sales order by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header.
- Destructive
Update a sales order
Update an existing sales order. To delete a line item just remove it from the lineitems list.
- Destructive
Delete a sales order
Delete an existing sales order. Invoiced sales order cannot be deleted.
- Destructive
Update custom field in existing salesorders
Update the value of the custom field in existing salesorders.
- Destructive
Update billing address
Updates the billing address for this sales order alone.
- Destructive
Update shipping address
Updates the shipping address for this sales order alone.
- Destructive
Update sales order template
Update the pdf template associated with the sales order.
- Destructive
Update attachment preference
Set whether you want to send the attached file while emailing the sales order.
- Destructive
Delete an attachment
Delete the file attached to the sales order.
- Destructive
Update comment
Update existing comment of a sales order.
- Destructive
Delete a comment
Delete a sales order comment.
Sales receipt
- Read
List sales receipts
List all sales receipts.
- Read
Get a sales receipt
Get the details of a sales receipt.
- Write
Create a sales receipt
Create a sales receipt for immediate payment transactions.
- Write
Email a sales receipt
Email a sales receipt to the customer.
- Destructive
Update a sales receipt
Update an existing sales receipt.
- Destructive
Delete a sales receipt
Delete an existing sales receipt.
Invoices
- Read
List invoices
Get a list of invoices with helpful pagination, filtering, search, and sorting features. Perfect for viewing your invoice data in organized ways, whether you need to find specific invoices or browse through your records.
- Read
Get an invoice
Get the details of an invoice.
- Read
Get invoice email content
Get the email content of an invoice.
- Read
Get payment reminder mail content
Get the mail content of the payment reminder.
- Read
Bulk export Invoices
Maximum of 25 invoices can be exported in a single pdf.
- Read
Bulk print invoices
Export invoices as pdf and print them. Maximum of 25 invoices can be printed.
- Read
List invoice templates
Get all invoice pdf templates.
- Read
List invoice payments
Get the list of payments made for an invoice.
- Read
List credits applied
Get the list of credits applied for an invoice.
- Read
Get last attached attachment
Returns the file attached to the invoice.
- Read
Retrieve Invoice Document
Retrieve a specific document attached to an invoice with advanced retrieval options.
- Read
List invoice comments & history
Get the complete history and comments of an invoice.
- Read
Generate payment link
This API generates a payment link for the invoice with an expiry date.
- Read
Get delivery notes for invoices
Retrieve the delivery notes for one or more invoices. Use this to generate or print delivery notes for the specified invoices.
- Read
Get packing slips for invoices
Retrieve the packing slips for one or more invoices. Use this to generate or print packing slips for the specified invoices.
- Read
Preview invoice with coupons
Preview the effect of applying coupons to an invoice before it is created.
- Read
Get invoice dashboard
Retrieve the invoice dashboard with summary metrics for invoices.
- Read
Get an invoice by reference
Retrieve an invoice using its reference ID from an external system.
- Read
Get invoice custom fields
Retrieve the custom fields configured for an invoice.
- Read
Get invoice advanced tracking details
Retrieve the advanced inventory tracking details (batches or serial numbers) of the line items in an invoice.
- Read
Print invoice delivery note
Export the delivery note of an invoice as a PDF file.
- Read
Print invoice packing slip
Export the packing slip of an invoice as a PDF file.
- Read
Get invoice QR code
Retrieve the QR code generated for an invoice.
- Read
Get invoice SMS content
Retrieve the default SMS content used when sending an invoice notification by SMS.
- Read
Get invoice signature template
Retrieve the digital signature template configured for an invoice.
- Read
Get invoice online payment QR code
Retrieve the QR code that the customer can scan to pay an invoice online.
- Read
Get invoice online payment QR status
Retrieve the payment status of an invoice online payment QR code.
- Read
Get invoice metadata
Retrieve a metadata value stored against an invoice.
- Read
List invoice e-invoices
Retrieve the e-invoice details of invoices.
- Read
Get an invoice e-invoice
Retrieve the e-invoice JSON data generated for an invoice.
- Read
Fetch an invoice e-invoice
Fetch the latest e-invoice status of an invoice from the Invoice Registration Portal (IRP).
- Write
Create an invoice
Create an invoice for your customer.
- Write
Mark an invoice as sent
Mark a draft invoice as sent.
- Write
Mark as draft
Mark a voided invoice as draft.
- Write
Email multiple invoices
Send invoices to your customers by email. Maximum of 10 invoices can be sent at once.
- Write
Create an instant invoice
Create an instant invoice for all the confirmed sales orders you have selected.
- Write
Associate invoices with sales order
Associate one or more existing invoices with a sales orders.
- Write
Submit an invoice for approval
Submit an invoice for approval.
- Write
Approve an invoice.
Approve an invoice.
- Write
Email an invoice
Email an invoice to the customer. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content.
- Write
Remind Customer
Remind your customer about an unpaid invoice by email. Reminder will be sent, only for the invoices which are in open or overdue status.
- Write
Bulk invoice reminder
Remind your customer about an unpaid invoices by email. Reminder mail will be send, only for the invoices is in open or overdue status. Maximum 10 invoices can be reminded at once.
- Write
Disable payment reminder
Disable automated payment reminders for an invoice.
- Write
Enable payment reminder
Enable automated payment reminders for an invoice.
- Write
Write off invoice
Write off the invoice balance amount of an invoice.
- Write
Apply credits
Apply the customer credits either from credit notes or excess customer payments to an invoice. Multiple credits can be applied at once.
- Write
Add attachment to an invoice
Attach a file to an invoice.
- Write
Add a document to an invoice
Attach a document to a specific document slot of an invoice.
- Write
Add comment
Add a comment for an invoice.
- Write
Approve invoices
Approve multiple invoices in a single request. Use this to approve invoices that are pending approval in bulk.
- Write
Mark invoices as void
Mark multiple invoices as void in a single request. Voided invoices are retained for record-keeping but are excluded from receivables.
- Write
Create invoices from projects
Create invoices from one or more projects. Use this to bill unbilled project time and expenses by generating invoices directly from the selected projects.
- Write
Finalize approval of an invoice
Give the final approval for an invoice in a multi-level approval flow. Use this when an invoice requires a final approval step after the initial approval.
- Write
Reject an invoice
Reject an invoice that is pending approval. Optionally provide a reason for the rejection.
- Write
Send an invoice via snail mail
Send a physical copy of an invoice to the customer through snail mail.
- Write
Add a bank account for invoice online payments
Associate a bank account with an invoice to receive online payments. Use this to configure the bank account into which online payments for the invoice are deposited.
- Write
Submit invoices for approval
Submit one or more invoices for approval.
- Write
Mark invoices as sent
Change the status of one or more invoices to sent.
- Write
Write off invoices
Write off the balance amount of one or more invoices.
- Write
Mark invoices as shipped
Mark one or more invoices as shipped.
- Write
Mark invoices as unshipped
Revert the shipped status of one or more invoices.
- Write
Create invoices from estimates
Create one or more invoices from the selected estimates.
- Write
Send invoice by SMS
Send an invoice notification to the customer by SMS.
- Write
Add a digital signature to an invoice
Send an invoice for digital signature.
- Write
Upload a signed invoice
Upload the digitally signed copy of an invoice.
- Write
Upload an invoice document file
Upload the file content for a document attached to an invoice.
- Write
Update an invoice CFDI status
Update the CFDI (Comprobante Fiscal Digital por Internet) status of an invoice for the Mexico edition.
- Write
Mark an invoice as ready to push
Mark an invoice e-invoice as ready to be pushed to the Invoice Registration Portal (IRP).
- Write
Apply a sub-status to an invoice
Apply a custom sub-status to an invoice.
- Write
Schedule an invoice email
Schedule an invoice to be emailed to the customer at a future date and time.
- Write
Force pay an invoice
Charge a saved payment method to collect payment for an invoice immediately.
- Write
Email an invoice as PDF
Email the PDF copy of an invoice to the customer.
- Write
Process a synchronous online payment for an invoice
Charge a card synchronously to collect an online payment for an invoice.
- Write
Process an asynchronous online payment for an invoice
Collect an online payment for an invoice asynchronously through a payment gateway.
- Write
Send invoice dunning notifications
Send dunning notifications to the customer for an overdue invoice.
- Write
Resend invoice payment SMS
Resend the online payment SMS notification for an invoice.
- Write
Push invoice e-invoices
Push the e-invoices of multiple invoices to the Invoice Registration Portal (IRP) for India or the Peppol network for UAE.
- Write
Push an invoice e-invoice
Push the e-invoice of an invoice to the Invoice Registration Portal (IRP) for India or the Peppol network for UAE.
- Write
Mark an invoice e-invoice as manually pushed
Record that an invoice e-invoice was pushed to the Invoice Registration Portal (IRP) outside of Zoho Books, by supplying the acknowledgement details.
- Write
Mark an invoice e-invoice as cancelled
Record that an invoice e-invoice was cancelled on the Invoice Registration Portal (IRP) outside of Zoho Books.
- Write
Recall an invoice e-invoice status
Revert the manually updated e-invoice status of an invoice.
- Destructive
Update an invoice using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update an invoice by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header.
- Destructive
Delete invoices
Delete one or more invoices. Only invoices that are not part of a closed accounting period can be deleted.
- Destructive
Update an invoice
Update an existing invoice. To delete a line item just remove it from the lineitems list.
- Destructive
Delete an invoice
Delete an existing invoice. Invoices which have payment or credits note applied cannot be deleted.
- Destructive
Void an invoice
Mark an invoice status as void. Upon voiding, the payments and credits associated with the invoices will be unassociated and will be under customer credits.
- Destructive
Cancel write off
Cancel the write off amount of an invoice.
- Destructive
Update billing address
Updates the billing address for this invoice alone.
- Destructive
Update shipping address
Updates the shipping address for this invoice alone.
- Destructive
Update invoice template
Update the pdf template associated with the invoice.
- Destructive
Delete a payment
Delete a payment made to an invoice.
- Destructive
Delete applied credit
Delete a particular credit applied to an invoice.
- Destructive
Update attachment preference
Set whether you want to send the attached file while emailing the invoice.
- Destructive
Delete last attached attachment
Delete the file attached to the invoice.
- Destructive
Delete Invoice attachment
Delete a specific document attached to an invoice. This operation permanently removes the document from the invoice and cannot be undone. Only documents that are not system-generated can be deleted.
- Destructive
Delete the expense receipt
Delete the expense receipts attached to an invoice which is raised from an expense.
- Destructive
Update custom field in existing invoices
Update the value of the custom field in existing invoices.
- Destructive
Update comment
Update an existing comment of an invoice.
- Destructive
Delete a comment
Delete an invoice comment.
- Destructive
Apply a price book to an invoice
Apply a price book to an invoice so that the price book rates are used for the invoice line items.
- Destructive
Unmap invoices from sales orders
Remove the mapping between invoices and their associated sales orders.
- Destructive
Update invoice advanced tracking details
Update the advanced inventory tracking details (batches or serial numbers) of the line items in an invoice.
- Destructive
Cancel an invoice
Change the status of an invoice to cancelled.
- Destructive
Delete an invoice sub-status
Remove a custom sub-status applied to an invoice.
- Destructive
Delete an invoice line item
Delete a specific line item from an invoice.
- Destructive
Cancel a scheduled invoice email
Cancel a previously scheduled invoice email.
- Destructive
Update invoice metadata
Update a metadata value stored against an invoice.
- Destructive
Cancel invoice e-invoices
Cancel the e-invoices of multiple invoices on the Invoice Registration Portal (IRP).
- Destructive
Cancel an invoice e-invoice
Cancel the e-invoice of an invoice on the Invoice Registration Portal (IRP).
- Destructive
Delete an invoice e-invoice status
Delete the locally stored e-invoice status of an invoice.
- Destructive
Update an invoice e-invoice payment status
Update the payment status of an invoice e-invoice on the Invoice Registration Portal (IRP).
- Destructive
Cancel an e-invoice invoice
Cancel the e-invoice generated for an invoice on the Invoice Registration Portal (IRP).
Delivery challans
- Read
List delivery challans
Retrieve a list of delivery challans with pagination. Filter by status, customer, date, and more.
- Read
Retrieve a delivery challan
Retrieve the details of an existing delivery challan.
- Read
Get a delivery challan attachment
Retrieve an attachment.
- Read
List delivery challan templates
Retrieve a list of available templates for delivery challans.
- Write
Create a delivery challan
Create a new delivery challan for a customer. The customer ID is required.
- Write
Mark a delivery challan as open
Change the status of a delivery challan to open.
- Write
Mark a delivery challan as delivered
Change the status of a delivery challan to delivered.
- Write
Mark a delivery challan as returned
Change the status of a delivery challan to returned.
- Write
Mark a delivery challan as undelivered
Change the status of a delivery challan to undelivered.
- Write
Add attachment to a delivery challan
Attach files to an existing delivery challan (maximum of 20 files).'
- Destructive
Update a delivery challan
Update an existing delivery challan.
- Destructive
Delete a delivery challan
Delete an existing delivery challan.
- Destructive
Return delivery challans
Partially return one or more delivery challans by specifying the line items and quantities to return.
- Destructive
Undo return of delivery challans
Undo a previously applied return for one or more delivery challans.
- Destructive
Delete a delivery challan attachment
Delete an attachment.
- Destructive
Update a delivery challan template
Assign a different template to an existing delivery challan.
- Destructive
Update shipping address
Update the shipping address of an existing delivery challan.
Recurring invoices
- Read
List all Recurring Invoice
List the details of all recurring invoice.
- Read
Get a Recurring Invoice
Get the details of a recurring invoice.
- Read
List Recurring Invoice History
Get the complete history and comments of a recurring invoice.
- Write
Create a Recurring Invoice
Creating a new recurring invoice.
- Write
Stop a Recurring Invoice
Stop an active recurring invoice.
- Write
Resume a Recurring Invoice
Resume a stopped recurring invoice.
- Destructive
Update a recurring invoice using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values.
- Destructive
Update Recurring Invoice
Update the recurring invoice.
- Destructive
Delete a Recurring Invoice
Delete an existing recurring invoice.
- Destructive
Update Recurring Invoice template
Update the pdf template associated with the recurring invoice.
Recurringinvoices
- Read
Get the recurring invoices dashboard
Retrieve the dashboard summary for recurring invoices, including aggregated metrics for the recurring invoice profiles.
- Read
List invoices created from a recurring invoice
Retrieve the list of invoices generated from a recurring invoice profile. Use the filter and search parameters to narrow the results.
- Write
Resume recurring invoices
Resume multiple stopped recurring invoices in a single request. The recurring invoices resume generating child invoices on their schedule.
- Write
Stop recurring invoices
Stop multiple active recurring invoices in a single request. The recurring invoices stop generating child invoices until they are resumed.
- Write
Enable auto-bill for a recurring invoice
Enable auto-bill for a recurring invoice so that generated invoices are charged automatically to the associated card or bank account.
- Write
Disable auto-bill for a recurring invoice
Disable auto-bill for a recurring invoice so that generated invoices are no longer charged automatically.
- Write
Associate a bank account with a recurring invoice
Associate a bank account with a recurring invoice for auto-bill so that generated invoices are charged to this bank account.
- Write
Associate a card with a recurring invoice
Associate a card with a recurring invoice for auto-bill so that generated invoices are charged to this card.
- Destructive
Delete the bank account of a recurring invoice
Remove the bank account associated with a recurring invoice for auto-bill.
- Destructive
Delete the card of a recurring invoice
Remove the card associated with a recurring invoice for auto-bill.
Credit notes
- Read
List all Credit Notes
Retrieve a paginated list of credit notes with comprehensive filtering, sorting, and search capabilities. Use query parameters to filter by date, status, amount, customer details, items, taxes, and custom fields.
- Read
Get a credit note
Details of an existing creditnote.
- Read
Get email content
Get email content of a credit note.
- Read
Email history
Get email history of a credit code.
- Read
List credit note template
Get all credit note pdf templates.
- Read
List invoices credited
List invoices to which the credit note is applied.
- Read
List credit note comments & history
Get history and comments of a credit note.
- Read
List credit note refunds
List all refunds with pagination.
- Read
List refunds of a credit note
List all refunds of an existing credit note.
- Read
Get credit note refund
Get refund of a particular credit note.
- Write
Create a credit note
Create a new credit note to record credits issued to customers for returned items, overpayments, or adjustments. Supports multi-currency transactions, custom line items, tax calculations, and workflows.
- Write
Email a credit note
Email a credit note.
- Write
Convert Credit Note to Draft.
Convert a voided credit note to Draft.
- Write
Convert to Open
Convert a credit note in Draft status to Open.
- Write
Submit a credit note for approval
Submit an estimate for approval.
- Write
Approve a credit note.
Approve a credit note.
- Write
Credit to an invoice
Apply credit note to existing invoices.
- Write
Add a comment
Add a comment to an existing credit note.
- Write
Refund credit note
Refund credit note amount.
- Destructive
Update a credit note using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a credit note by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header.
- Destructive
Update a credit note
Details of an existing creditnote.
- Destructive
Delete a credit note
Delete an existing credit note.
- Destructive
Void a Credit Note
Mark the credit note as Void.
- Destructive
Update billing address
Updates the billing address for an existing credit note alone.
- Destructive
Update Shipping address
Updates the shipping address for an existing credit note alone.
- Destructive
Update a credit note template
Update the pdf template associated with the credit note.
- Destructive
Delete invoices credited
Delete the credits applied to an invoice.
- Destructive
Delete a Comment
Delete a credit note comment.
- Destructive
Update credit note refund
Update the refunded transaction.
- Destructive
Delete credit note refund
Delete a credit note refund.
Creditnotes
- Read
Get the digital signature template of a credit note
Retrieve the digital signature template details associated with a credit note.
- Read
Print credit notes
Export the selected credit notes as a single PDF file. Use this to print or download one or more credit notes together.
- Read
Retrieve a credit note document
Retrieve a specific document attached to a credit note. The document can be returned as JSON metadata or as the raw file (PDF or image).
- Read
Get credit note custom fields
Retrieve the custom fields configured for a credit note.
- Read
Get credit note email content
Retrieve the default email content (subject and body) used when emailing a credit note.
- Read
Get a credit note refund
Retrieve the details of a specific credit note refund using its refund ID.
- Read
List credit note e-invoices
Retrieve the e-invoice details of credit notes.
- Read
Get a credit note e-invoice
Retrieve the e-invoice JSON data generated for a credit note.
- Read
Fetch a credit note e-invoice
Fetch the latest e-invoice status of a credit note from the Invoice Registration Portal (IRP).
- Write
Approve credit notes
Approve multiple credit notes in a single request. Use this to approve credit notes that are pending approval in bulk.
- Write
Submit credit notes for approval
Submit multiple credit notes for approval in a single request. Use this to send credit notes for approval in bulk.
- Write
Finalize approval of a credit note
Give the final approval for a credit note in a multi-level approval flow. Use this when a credit note requires a final approval step after the initial approval.
- Write
Reject a credit note
Reject a credit note that is pending approval. Optionally provide a reason for the rejection.
- Write
Add attachment to a credit note
Attach a file to a credit note.
- Write
Update credit note custom fields
Update the values of the custom fields associated with a credit note.
- Write
Add a digital signature to a credit note
Send a credit note for digital signature.
- Write
Upload a signed credit note
Upload the digitally signed copy of a credit note.
- Write
Apply a sub-status to a credit note
Apply a custom sub-status to a credit note.
- Write
Push credit note e-invoices
Push the e-invoices of multiple credit notes to the Invoice Registration Portal (IRP) for India or the Peppol network for UAE.
- Write
Push a credit note e-invoice
Push the e-invoice of a credit note to the Invoice Registration Portal (IRP) for India or the Peppol network for UAE.
- Write
Mark a credit note e-invoice as manually pushed
Record that a credit note e-invoice was pushed to the Invoice Registration Portal (IRP) outside of Zoho Books, by supplying the acknowledgement details.
- Write
Mark a credit note e-invoice as cancelled
Record that a credit note e-invoice was cancelled on the Invoice Registration Portal (IRP) outside of Zoho Books.
- Write
Recall a credit note e-invoice status
Revert the manually updated e-invoice status of a credit note.
- Write
Push a credit note refund e-invoice
Push the e-invoice of a credit note refund to the Invoice Registration Portal (IRP).
- Write
Mark a credit note as ready to push
Mark a credit note e-invoice as ready to be pushed to the Invoice Registration Portal (IRP).
- Write
Update a credit note CFDI status
Update the CFDI (Comprobante Fiscal Digital por Internet) status of a credit note for the Mexico edition.
- Destructive
Update a credit note document
Update a document attached to a credit note.
- Destructive
Delete a credit note document
Delete a document attached to a credit note.
- Destructive
Delete a credit note sub-status
Remove a custom sub-status applied to a credit note.
- Destructive
Cancel credit note e-invoices
Cancel the e-invoices of multiple credit notes on the Invoice Registration Portal (IRP).
- Destructive
Cancel a credit note e-invoice
Cancel the e-invoice of a credit note on the Invoice Registration Portal (IRP).
- Destructive
Delete a credit note e-invoice status
Delete the locally stored e-invoice status of a credit note.
- Destructive
Cancel an e-invoice credit note
Cancel the e-invoice generated for a credit note on the Invoice Registration Portal (IRP).
Customer debit notes
- Read
List customer debit notes
Get a list of customer debit notes with helpful pagination, filtering, search, and sorting features. Perfect for viewing your debit note data in organized ways, whether you need to find specific debit notes or browse through your records.
- Read
Get a customer debit note
Get the details of a customer debit note.
- Write
Create a customer debit note
Create a customer debit note for additional charges or adjustments to be made to the original invoice.
- Destructive
Update a customer debit note
Update an existing customer debit note. To delete a line item just remove it from the lineitems list.
- Destructive
Delete a customer debit note
Delete an existing customer debit note. Debit notes which have payment or credits note applied cannot be deleted.
Customer payments
- Read
List Customer Payments
List all the payments made by your customer.
- Read
Retrieve a payment
Details of an existing payment.
- Read
List refunds of a customer payment
List all the refunds pertaining to an existing customer payment.
- Read
Details of a refund
Obtain details of a particular refund of a customer payment.
- Write
Create a payment
Create a new payment.
- Write
Refund an excess customer payment
Refund the excess amount paid by the customer.
- Destructive
Update a payment using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a payment by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header.
- Destructive
Bulk delete Customer payments
Delete multiple customer payments.
- Destructive
Update a payment
Update an existing payment information.
- Destructive
Delete a payment
Delete an existing payment.
- Destructive
Update custom field in existing customerpayments
Update the value of the custom field in existing customerpayments.
- Destructive
Update a refund
Update the refunded transaction.
- Destructive
Delete a Refund
Delete refund pertaining to an existing customer payment.
Expenses
- Read
List Expenses
List all the Expenses with pagination.
- Read
Get an Expense
Get the details of the Expense.
- Read
List expense History & Comments
Get history and comments of expense.
- Read
List employees
List employees with pagination.
- Read
Get an employee
Get the details of the employee.
- Read
Get an expense receipt
Returns the receipt attached to the expense.
- Write
Create an Expense
Create billable or non-billable expense.
- Write
Create an employee
Create an employee for an expense.
- Write
Add receipt to an expense.
Attach a receipt to an expense.
- Write
Add attachment to an expense
Attach one or multiple files to an expense. This endpoint allows you to attach various types of documents to support your expense records. Returns document details for the uploaded attachments.
- Destructive
Update an expense using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a expense by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header.
- Destructive
Update an Expense
Update an existing Expense.
- Destructive
Delete an Expense
Delete an existing expense.
- Destructive
Delete an employee
Delete an existing employee.
- Destructive
Delete a receipt
Delete the receipt attached to the expense.
Recurring expenses
- Read
List recurring expenses
List all the Expenses with pagination.
- Read
Get a recurring expense
Get the details of the recurring expense.
- Read
List child expenses created
List child expenses created from recurring expense.
- Read
List recurring expense history
Get history and comments of a recurring expense.
- Write
Create a recurring expense
Create a recurring expense.
- Write
Stop a recurring expense
Stop an active recurring expense.
- Write
Resume a recurring Expense
Resume a stopped recurring expense.
- Destructive
Update an recurring expense using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values.
- Destructive
Update a recurring expense
Update a recurring expense.
- Destructive
Delete a recurring expense
Deleting an existing recurring expense.
Retainer invoices
- Read
List a retainer invoices
List all retainer invoices with pagination.
- Read
Get a retainer invoice
Get the details of a retainer invoice.
- Read
Get retainer invoice email content
Get the email content of a retainer invoice.
- Read
List retainer invoice templates
Get all retainer invoice pdf templates.
- Read
Get a retainer invoice attachment
Returns the file attached to the retainer invoice.
- Read
List retainer invoice comments & history
Get the complete history and comments of a retainer invoice.
- Write
Create a retainerinvoice
Create a retainer invoice for your customer.
- Write
Mark a retainer invoice as sent
Mark a draft retainer invoice as sent.
- Write
Mark as draft
Mark a voided retainer invoice as draft.
- Write
Submit a retainer invoice for approval
Submit a retainer invoice for approval.
- Write
Approve a retainer invoice.
Approve a retainer invoice.
- Write
Email a retainer invoice
Email a retainer invoice to the customer. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content.
- Write
Add attachment to a retainer invoice
Attach a file to an invoice.
- Write
Add comment
Add a comment for a retainer invoice.
- Destructive
update a retainerinvoice
Update an existing invoice.
- Destructive
Delete a retainer invoice
Delete an existing retainer invoice. Invoices which have payment or credits note applied cannot be deleted.
- Destructive
Update retainer invoice template
Update the pdf template associated with the retainer invoice.
- Destructive
Void a retainer invoice
Mark an invoice status as void. Upon voiding, the payments and credits associated with the retainer invoices will be unassociated and will be under customer credits.
- Destructive
Update billing address
Updates the billing address for this retainer invoice alone.
- Destructive
Delete an attachment
Delete the file attached to the retainer invoice.
- Destructive
Update comment
Update an existing comment of a retainer invoice.
- Destructive
Delete a comment
Delete a retainer invoice comment.
Retainerinvoices
- Write
Apply retainer invoice payments to invoices
Apply the advance payments collected against a retainer invoice to one or more invoices.
- Write
Record an asynchronous online payment for a retainer invoice
Record an online payment for a retainer invoice and process it asynchronously.
- Destructive
Delete a retainer payment applied to an invoice
Delete a retainer invoice payment that was applied to an invoice.
Purchase order
- Read
List purchase orders
List all purchase orders.
- Read
Get a purchase order
Get the details of a purchase order.
- Read
Get purchase order email content
Get the email content of a purchase order.
- Read
List purchase order templates
Get all purchase order pdf templates.
- Read
Get a purchase order attachment
Returns the file attached to the purchase order.
- Read
List purchase order comments & history
Get the complete history and comments of purchase order.
- Write
Create a purchase order
Create a purchase order for your vendor.
- Write
Mark a purchase order as open
Mark a draft purchase order as open.
- Write
Mark as billed
Mark a purchase order as billed.
- Write
Submit a purchase order for approval
Submit a purchase order for approval.
- Write
Approve a purchase order
Approve a purchase order.
- Write
Email a purchase order
Email a purchase order to the vendor. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content.
- Write
Add attachment to a purchase order
Attach a file to a purchase order.
- Write
Add comment
Add a comment for a purchase order.
- Write
Reject Purchase Order
Reject a purchase order.
- Destructive
Update a purchase order using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a purchase order by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header.
- Destructive
Update a purchase order
Update an existing purchase order.
- Destructive
Delete purchase order
Delete an existing purchase order.
- Destructive
Update custom field in existing purchaseorders
Update the value of the custom field in existing purchaseorders.
- Destructive
Cancel a purchase order
Mark a purchase order as cancelled.
- Destructive
Update billing address
Updates the billing address for this purchase order alone.
- Destructive
Update purchase order template
Update the pdf template associated with the purchase order.
- Destructive
Update attachment preference
Set whether you want to send the attached file while emailing the purchase order.
- Destructive
Delete an attachment
Delete the file attached to the purchase order.
- Destructive
Update comment
Update an existing comment of a purchase order.
- Destructive
Delete a comment
Delete a purchase order comment.
Purchase returns
- Read
List purchase returns
List all purchase returns. Use query parameters to filter by status, vendor, date range, and other criteria.
- Read
Retrieve a purchase return
Retrieve the details of an existing purchase return.
- Write
Create a purchase return
Create a new purchase return for a vendor. A purchase return can be created standalone or from a purchase order.
- Write
Confirm a purchase return
Change the status of a draft purchase return to confirmed.
- Write
Fulfill a purchase return
Mark the items in a purchase return as fulfilled (shipped back to the vendor).
- Write
Unfulfill a purchase return
Reverse the fulfillment of items in a purchase return.
- Write
Email a purchase return
Send a purchase return via email to the vendor or specified recipients.
- Write
Add attachment to a purchase return
Attach a file to a purchase return. The file must be multipart/form-data. Allowed extensions: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc, docx, xml, csv, txt, tif, tiff, msg, eml, dwg. Maximum file size is 10 MB.
- Destructive
Update a purchase return
Update an existing purchase return.
- Destructive
Delete a purchase return
Delete an existing purchase return.
- Destructive
Void a purchase return
Mark an existing purchase return as void.
- Destructive
Close a purchase return
Mark one or more purchase returns as closed. Closing a purchase return cancels the remaining unfulfilled quantities.
- Destructive
Reopen a purchase return
Reopen one or more closed purchase returns.
- Destructive
Update shipping address
Update the shipping address of a purchase return.
- Destructive
Update billing address
Update the billing address of a purchase return.
- Destructive
Delete an attachment
Delete a file attached to a purchase return.
Bills
- Read
List bills
List all bills with pagination.
- Read
Get a bill
Get the details of a bill.
- Read
List bill payments
Get the list of payments made for a bill.
- Read
Get a bill attachment
Returns the file attached to the bill.
- Read
List bill comments & history
Get the complete history and comments of a bill.
- Read
Convert PO to Bill
Create a bill for the selected purchase orders. Use this api to fetch the Bill payload by passing the purchaseorderids in the query parameters and then use the create bill api and pass the payload to create a bill Create bill API Endpoint .
- Write
Create a bill
Create a bill received from your vendor.
- Write
Mark a bill as open
Mark a void bill as open.
- Write
Submit a bill for approval
Submit a bill for approval.
- Write
Approve a bill
Approve a bill.
- Write
Apply credits
Apply the vendor credits from excess vendor payments to a bill. Multiple credits can be applied at once.
- Write
Add attachment to a bill
Attach a file to a bill.
- Write
Add comment
Add a comment for a bill.
- Destructive
Update a bill using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a bill by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header.
- Destructive
Update a bill
Update a bill. To delete a line item just remove it from the lineitems list.
- Destructive
Delete a bill
Delete an existing bill. Bills which have payments applied cannot be deleted.
- Destructive
Update custom field in existing bills
Update the value of the custom field in existing bills.
- Destructive
Void a bill
Mark a bill status as void.
- Destructive
Update billing address
Updates the billing address for this bill.
- Destructive
Delete a payment
Delete a payment made to a bill.
- Destructive
Delete an attachment
Delete the file attached to a bill.
- Destructive
Delete a comment
Delete a bill comment.
Self billed invoices
- Read
List Self-Billed Invoices
Retrieve a paginated list of self-billed invoices. Use the entitytype=selfbilledinvoice query parameter to filter self-billed invoices only.
- Read
Get a Self-Billed Invoice
Fetch the details of a self-billed invoice.
- Write
Create a Self-Billed Invoice
Create a new self-billed invoice. Set entitytype to selfbilledinvoice to identify it as a self-billed invoice.
- Write
Push a self-billed invoice e-invoice
Push the e-invoice of a self-billed invoice. Rate limit: 150 requests per minute. Exceeding this limit triggers a 30-minute lock-out.
- Destructive
Update a Self-Billed Invoice
Update the details of an existing self-billed invoice.
- Destructive
Delete a Self-Billed Invoice
Delete an existing self-billed invoice.
Recurring bills
- Read
List recurring bills
List all recurring bills with pagination.
- Read
Get a recurring bill
Get the details of a recurring bill.
- Read
List recurring bill history
Get history and comments of a recurring bill.
- Write
Create a recurring bill
Create a recurring bill.
- Write
Stop a recurring bill
Stop an active recurring bill.
- Write
Resume a recurring Bill
Resume a stopped recurring bill.
- Destructive
Update a recurring bill using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a recurring bill by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header.
- Destructive
Update a recurring bill
Update a recurring bill. To delete a line item just remove it from the lineitems list.
- Destructive
Delete a recurring bill
Delete an existing recurring bill.
Vendor credits
- Read
List vendor credits
Retrieve a paginated list of vendor credits with comprehensive filtering, sorting, and search capabilities. Use query parameters to filter by date, status, amount, vendor details, items, taxes, and custom fields.
- Read
Get vendor credit
Get details of a vendor credit.
- Read
List bills credited
List bills to which the vendor credit is applied.
- Read
List refunds of a vendor credit
List all refunds of an existing vendor credit.
- Read
Get vendor credit refund
Get refund of a particular vendor credit.
- Read
List vendor credit refunds
List all refunds with pagination.
- Read
List vendor credit comments & history
Get history and comments of a vendor credit.
- Write
Create a vendor credit
Create a new vendor credit to record credits issued by vendors for returned items, overpayments, or adjustments. Supports multi-currency transactions, custom line items, tax calculations, and workflows.
- Write
Convert to open
Change an existing vendor credit status to open.
- Write
Submit a Vendor credit for approval
Submit a Vendor credit for approval.
- Write
Approve a Vendor credit
Approve a Vendor credit.
- Write
Apply credits to a bill
Apply vendor credit to existing bills.
- Write
Refund a vendor credit
Refund vendor credit amount.
- Write
Add a comment
Add a comment to an existing vendor credit.
- Destructive
Update vendor credit
Update an existing vendor credit.
- Destructive
Delete vendor credit
Delete a vendor credit.
- Destructive
Void vendor credit
Mark an existing vendor credit as void.
- Destructive
Delete bills credited
Delete the credits applied to a bill. Note: You should pass the vendorcreditbillid from "Get vendor credits bills credited vendorcreditbillid" section
- Destructive
Update vendor credit refund
Update the refunded transaction.
- Destructive
Delete vendor credit refund
Delete a vendor credit refund.
- Destructive
Delete a comment
Delete a vendor credit comment.
Vendor payments
- Read
List vendor payments
List all the payments made to your vendor.
- Read
Get a vendor payment
Get the details of a vendor payment.
- Read
List refunds of a vendor payment
List all the refunds pertaining to an existing vendor payment.
- Read
Details of a refund
Obtain details of a particular refund of a vendor payment.
- Read
Get vendor payment email content
Retrieve the pre-populated email content for a vendor payment, including subject, body, recipient contacts, sender options, and attachment details. This endpoint provides all the necessary information to compose and send a vendor payment receipt email.
- Write
Create a vendor payment
Create a payment made to your vendor and you can also apply them to bills either partially or fully.
- Write
Refund an excess vendor payment
Refund the excess amount paid to the vendor.
- Write
Email a vendor payment
Send a vendor payment receipt to the vendor via email. You can customize the email content, attach files, and control sender preferences.
- Destructive
Update an vendor payment using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a vendor payment by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header.
- Destructive
Bulk delete vendor payments
Delete multiple vendor payments.
- Destructive
Update a vendor payment
Update an existing vendor payment. You can also modify the amount applied to the bills.
- Destructive
Delete a vendor payment
Delete an existing vendor payment.
- Destructive
Update a refund
Update the refunded transaction.
- Destructive
Delete a refund
Delete refund pertaining to an existing vendor payment.
Custom modules
- Read
List custom modules
List all custom module configurations in the organization. This returns the module definitions including field configurations, permissions, and portal settings.
- Read
Get a custom module
Get the configuration details of a specific custom module.
- Write
Create a custom module
Create a new custom module configuration. Define the module name, fields, permissions, and other settings.
- Destructive
Update a custom module
Update the configuration of an existing custom module.
- Destructive
Delete a custom module
Delete an existing custom module configuration and all its records.
Custom module records
- Read
List custom module records
Get the list of records of a custom module.
- Read
Get a custom module record
Get the details of an individual record in a custom module.
- Write
Create a custom module record
Create a new record in a custom module.
- Destructive
Bulk update custom module records
Update existing custom module records in bulk.
- Destructive
Delete custom module records
Delete records from a custom module.
- Destructive
Update a custom module record
Update an existing record in a custom module.
- Destructive
Delete a custom module record
Delete an individual record from a custom module.
Bank accounts
- Read
List view of accounts
List all bank and credit card accounts for your organization.
- Read
Get account details
Get a detailed look of the account specified.
- Read
Get last imported statement
Get the details of previously imported statement for the account.
- Write
Create a bank account
Create a bank account or a credit card account for your organization.
- Write
Deactivate account.
Make an account inactive.
- Write
Activate account
Make an account active.
- Write
Import a Bank/Credit Card Statement
Import your bank/credit card feeds into your account.
- Destructive
Update bank account
Modify the account that was created.
- Destructive
Delete an account
Delete a bank account from your organization.
- Destructive
Delete last imported statement
Delete the statement that was previously imported.
Bankaccounts
- Read
List bank reconciliations
List the reconciliations of a bank account.
- Read
Get a bank reconciliation
Retrieve the details of a bank reconciliation.
- Read
Get a reconciliation document
Retrieve a document attached to a bank reconciliation.
- Read
List bank account balances
Retrieve the balances of all bank accounts.
- Read
Get bank accounts overview
Retrieve an overview of all bank accounts.
- Read
Get a bank account balance
Retrieve the balance of a bank account.
- Read
Get bank account balances
Retrieve the balance breakdown of a bank account.
- Read
Get bank account insights
Retrieve cash-flow insights for a bank account.
- Read
Get a bank account overview
Retrieve an overview of a bank account.
- Read
Get a bank statement summary
Retrieve the statement summary of a bank account.
- Read
List bank account sub-accounts
List the sub-accounts of a bank account.
- Read
List bank account statements
List the imported statements of a bank account.
- Read
List unreviewed bank statements
List the unreviewed statement transactions of a bank account.
- Read
List bank account transactions
List the transactions of a bank account.
- Read
Get bank account preferences
Retrieve the preferences of a bank account.
- Read
Get bank statement import encryption key
Retrieve the public key used to encrypt bank statement files before import.
- Write
Create a bank reconciliation
Reconcile the transactions of a bank account for a statement period.
- Write
Add a reconciliation attachment
Attach a file to a bank reconciliation.
- Destructive
Update a bank reconciliation
Update a bank reconciliation.
- Destructive
Delete a bank reconciliation
Delete a bank reconciliation.
- Destructive
Save a bank reconciliation as draft
Save the progress of a bank reconciliation as a draft.
- Destructive
Delete a reconciliation document
Delete a document attached to a bank reconciliation.
- Destructive
Update bank account preferences
Update the preferences of a bank account.
Bank transactions
- Read
Get transactions list
Get all the transaction details involved in an account.
- Read
Get transaction
Fetch the details of a transaction by specifying the transactionid.
- Read
Get matching transactions
Provide criteria to search for matching uncategorised transactions. The list of transactions can also include invoices/bills/credit-notes which will not be matched directly. Instead, a new (payment/refund) transaction is recorded and matched.
- Write
Create a transaction for an account
Create a bank transaction based on the allowed transaction types.
- Write
Match a transaction
Match an uncategorized transaction with an existing transaction in the account.
- Write
Unmatch a matched transaction
Unmatch a transaction that was previously matched and make it uncategorized.
- Write
Exclude a transaction
Exclude a transaction from your bank or credit card account.
- Write
Restore a transaction
Restore an excluded transaction in your account.
- Write
Categorize an uncategorized transaction
Categorize an uncategorized transaction by creating a new transaction.
- Write
Categorize as expense
Categorize an Uncategorized transaction as expense.
- Write
Uncategorize a categorized transaction
Revert a categorized transaction as uncategorized.
- Write
Categorize a vendor payment
Categorize an uncategorized transaction as Vendor Payment.
- Write
Categorize as customer payment
Categorize an uncategorized transaction as Customer Payment.
- Write
Categorize as credit note refunds
Categorize an Uncategorized transaction as a refund from a credit note.
- Write
Categorize as vendor credit refunds
Categorize an uncategorized transaction as a refund from a vendor credit.
- Write
Categorize as Customer Payment refund
Categorizing bank transactions as Payment Refund.
- Write
Categorize as Vendor Payment refund
Categorizing bank transactions as Vendor Payment Refund.
- Destructive
Update a transaction
Make changes in the applicable fields of a transaction and update it.
- Destructive
Delete a transaction
Delete a transaction from an account by specifying the transactionid.
Bank rules
- Read
Get Rules List
Fetch all the rules created in the organization.
- Read
Get a rule
Get details of a specific rule.
- Read
List match filters
List the match filters used to identify bank transactions for rules.
- Write
Create a rule
Create a rule and apply it on deposit/withdrawal for bank accounts and on refund/charges for credit card accounts.
- Write
Reorder rules
Change the order in which bank rules are evaluated.
- Write
Skip a suggested rule
Dismiss a bank rule suggested by Zoho Books.
- Write
Create a match filter
Create a match filter used to identify bank transactions for rules.
- Destructive
Bulk update rules
Update multiple bank rules in a single request.
- Destructive
Bulk delete rules
Delete multiple bank rules in a single request.
- Destructive
Update a rule
Make changes to the rule, add or modify it and update.
- Destructive
Delete a rule
Delete a rule from your account and make it no longer applicable on the transactions.
- Destructive
Update a match filter
Update a match filter used to identify bank transactions for rules.
- Destructive
Delete a match filter
Delete a match filter.
Chart of accounts
- Read
List chart of accounts
List all chart of accounts along with pagination.
- Read
Get an account
Gets the details of an account.
- Read
List of transactions for an account
List all involved transactions for the given account.
- Write
Create an account
Creates an account with the given account type.
- Write
Mark an account as active
Updates the account status as active.
- Write
Mark an account as inactive
Updates the account status as inactive.
- Write
Bulk mark accounts as active
Marks multiple accounts as active.
- Write
Bulk mark accounts as inactive
Marks multiple accounts as inactive.
- Destructive
Update an account
Updates the account information.
- Destructive
Delete an account
Deletes the given account. Accounts associated in any transaction/products could not be deleted.
- Destructive
Bulk delete accounts
Deletes multiple accounts.
- Destructive
Delete a transaction
Deletes the transaction.
Registers
- Read
List register transactions
Retrieve transactions for a chart of accounts register (account) as a report view with optional grouping, column selection, and print preferences.
- Read
List register bulk action history
List bulk update and bulk delete history for the given account register.
- Read
Get register bulk action history details
Retrieve details of a single bulk action on the account register, including affected transactions.
- Read
Get register bulk update edit page
Returns metadata for fields supported when bulk updating transactions on an account register.
- Read
Get register budget vs actuals
Retrieve budget versus actuals for an account register. When budgetid is provided, returns detailed period breakdown.
- Destructive
Bulk update register transactions
Bulk update transactions on the account register (for example, change account, branch, or date on selected entities).
- Destructive
Bulk delete register transactions
Bulk delete selected transactions on the account register.
Journals
- Read
Get journal list
Get journal list.
- Read
Get journal
Get the details of the journal.
- Read
List available credits of a journal
Lists available credits of a journal.
- Read
List recurring journals
Lists all recurring journals.
- Read
Get a recurring journal
Gets the details of a recurring journal.
- Read
List child journals of a recurring journal
Lists all child journals created from a recurring journal.
- Read
Get journal view of a transaction
Gets the journal view of a transaction.
- Write
Create a journal
Create a journal.
- Write
Mark a journal as published
Mark a draft journal as published.
- Write
Add attachment to a journal
Attach a file to a journal.
- Write
Add comment
Add a comment for a journal.
- Write
Reverse a journal
Reverses a journal entry.
- Write
Submit a journal for approval
Submits a journal for approval.
- Write
Approve a journal
Approves a journal.
- Write
Reject a journal
Rejects a journal.
- Write
Apply journal credits to invoices
Applies available journal credits to invoices.
- Write
Apply journal credits to bills
Applies available journal credits to bills.
- Write
Bulk submit journals for approval
Submits multiple journals for approval.
- Write
Bulk approve journals
Approves multiple journals.
- Write
Bulk publish journals
Publishes multiple draft journals.
- Write
Create a recurring journal
Creates a recurring journal.
- Write
Resume a recurring journal
Resumes a stopped recurring journal.
- Write
Stop a recurring journal
Stops an active recurring journal.
- Destructive
Update a journal
Updates the journal with given information.
- Destructive
Delete a journal
Deletes the given journal.
- Destructive
Delete a comment
Delete a jounral comment.
- Destructive
Delete applied credits from receivables
Deletes applied journal credits from receivables.
- Destructive
Delete applied credits from payables
Deletes applied journal credits from payables.
- Destructive
Bulk delete journals
Deletes multiple journals.
- Destructive
Update a recurring journal
Updates an existing recurring journal.
- Destructive
Delete a recurring journal
Deletes a recurring journal.
Fixed assets
- Read
Get fixed asset list
fixed asset list.
- Read
Get fixed asset
Get the details of the fixed asset.
- Read
Get fixed asset history
It displays a detailed summary of the asset from acquisition till write off.
- Read
Get fixed asset's forecast depreciation
It displays a detailed summary of the asset's future depreciation rates.
- Read
Get fixed asset type list
fixed asset type list.
- Write
Create a fixed asset
Create a fixed asset.
- Write
Mark fixed asset as active
Mark the fixed asset as active to start calculating depreciation for the asset.
- Write
Mark fixed asset as draft
Mark the fixed asset as draft.
- Write
Write off fixed asset
Write off the fixed asset.
- Write
Sell fixed asset
Sell the fixed asset.
- Write
Add a comment
Add a comment to the fixed asset.
- Write
Create a fixed asset type
Create a fixed asset type.
- Destructive
Update a fixed asset
Updates the fixed asset with given information.
- Destructive
Delete a fixed asset
Deletes the given fixed asset.
- Destructive
Cancel fixed asset
Cancel the fixed asset.
- Destructive
Delete a comment
Delete the comment of the fixed asset.
- Destructive
Update a fixed asset type
Updates the fixed asset type with given information.
- Destructive
Delete a fixed asset type
Deletes the given fixed asset type.
Base currency adjustment
- Read
List base currency adjustment
Lists base currency adjustment.
- Read
Get a base currency adjustment
Get the base currency adjustment details.
- Read
List account details for base currency adjustment
List of accounts having transaction with effect to the given exchange rate.
- Read
List contact details for base currency adjustment
List contacts having transactions with effect to the given exchange rate for a specific account.
- Write
Create a base currency adjustment
Creates a base currency adjustment for the given information.
- Write
Reevaluate a base currency adjustment
Reevaluates a base currency adjustment.
- Destructive
Delete a base currency adjustment
Deletes the base currency adjustment.
- Destructive
Bulk delete base currency adjustments
Deletes multiple base currency adjustments.
Projects
- Read
List projects
List all projects with pagination.
- Read
Get a project
Get the details of a project.
- Read
List Users
Get list of users associated with a project.
- Read
Get a Project User
Get details of a user in project.
- Read
List comments
Get comments for a project.
- Read
List invoices
Lists invoices created for this project.
- Write
Create a project
Create a project.
- Write
Activate project
Mark project as active.
- Write
Inactivate a project
Marking a project as inactive.
- Write
Clone project
Cloning a project.
- Write
Assign users
Assign a users to a project.
- Write
Invite user
Invite and user to the project.
- Write
Post comment
Post comment to a project.
- Destructive
Update a project using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a project by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header.
- Destructive
Update project
Update details of a project.
- Destructive
Delete project
Deleting a existing project.
- Destructive
Update user
Update details of a user.
- Destructive
Delete user
Remove user from a project.
- Destructive
Delete comment
Deleting a comment.
Tasks
- Read
List project tasks
Get list of tasks added to a project.
- Read
Get a project task
Get the details of a project task.
- Read
List tasks
List a task.
- Read
Get a task
Get a task.
- Read
List comments of task
List comments of a task.
- Read
Get document of task
Get a document of a task.
- Write
Add a project task
The project task has been added.
- Write
Add a task
Add a task.
- Write
Update completed percentage
Update completed percentage of a task.
- Write
Mark task as open
Mark a task as open.
- Write
Mark task as ongoing
Mark a task as ongoing.
- Write
Mark task as completed
Mark a task as completed.
- Write
Add comment to task
Add comment to a task.
- Write
Add attachment to task
Add attachment to a task.
- Destructive
Update a project task
Update the details of a project task.
- Destructive
Delete project Task
Delete a task added to a project.
- Destructive
Update tasks
Update tasks.
- Destructive
Delete tasks
Delete tasks.
- Destructive
Update a tasks
Update a tasks.
- Destructive
Delete a tasks
Delete a tasks.
- Destructive
Delete comment of task
Delete a comment of a task.
- Destructive
Delete document of task
Delete a document of a task.
Time entries
- Read
List time entries.
List all time entries with pagination.
- Read
Get a time entry
Get details of a time entry.
- Read
Get timer
Get current running timer.
- Write
Log time entries
Logging time entries.
- Write
Start timer
Start tracking time spent.
- Write
Stop timer
Stop tracking time, say taking a break or leaving.
- Destructive
Delete time entries
Deleting time entries.
- Destructive
Update time entry
Update logged time entry.
- Destructive
Delete time entry
Deleting a logged time entry.
Users
- Read
List Users
Get the list of all users in the organization.
- Read
Get an user details
Get the details of a user.
- Read
Get current user
Get the details of the current user.
- Write
Create a user
Create a user for your organization.
- Write
Invite a user
Send invitation email to a user.
- Write
Mark user as active
Mark an inactive user as active.
- Write
Mark user as inactive
Mark an active user as inactive.
- Destructive
Update a user
Update the details of a user.
- Destructive
Delete a user
Delete a user associated to the organization.
Items
- Read
List items
Get the list of all active items with pagination.
- Read
Bulk fetch item details
Fetch item details for the mentioned item IDs
- Read
Get an item
Details of an existing item.
- Read
List items
Lists all items in the organization. Supports filters, search, and pagination.
- Read
Retrieve an item
Fetches the details of an existing item.
- Read
List item variants
Lists all item variants in the organization. Supports filters, search, and pagination.
- Read
Retrieve an item variant
Fetches the details of an existing item variant.
- Write
Create an Item
Create a new item.
- Write
Mark as active
Mark an inactive item as active.
- Write
Mark as inactive
Mark an active item as inactive.
- Write
Create an item
Creates a new item in Zoho Books. You can attach an image by passing the form-data parameter image .
- Write
Bulk mark items as active
Changes the status of multiple items to active.
- Write
Bulk mark items as inactive
Changes the status of multiple items to inactive.
- Write
Mark an item as active
Changes the status of an item to active.
- Write
Mark an item as inactive
Changes the status of an item to inactive.
- Write
Create an item variant
Creates a new item variant in Zoho Books. You can attach an image by passing the form-data parameter image .
- Write
Bulk mark item variants as active
Changes the status of multiple item variants to active.
- Write
Bulk mark item variants as inactive
Changes the status of multiple item variants to inactive.
- Write
Mark an item variant as active
Changes the status of an item variant to active.
- Write
Mark an item variant as inactive
Changes the status of an item variant to inactive.
- Write
Mark item variants as single items
Marks the specified item variants as single items.
- Destructive
Update an item using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update an item by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header.
- Destructive
Update an item
Update the details of an item.
- Destructive
Delete an item
Delete the item created.items that are part of transaction cannot be deleted.
- Destructive
Update custom field in existing items
Update the value of the custom field in existing items.
- Destructive
Update an item
Updates the details of an existing item. You can attach or replace an image by passing the form-data parameter image .
- Destructive
Delete an item
Deletes an existing item.
- Destructive
Bulk delete item variants
Deletes multiple item variants.
- Destructive
Update an item variant
Updates the details of an existing item variant. You can attach or replace an image by passing the form-data parameter image .
- Destructive
Delete an item variant
Deletes an existing item variant.
- Destructive
Move an item variant
Moves an item variant to another item. The request body follows the item variant create or update structure and must include the target grouping fields.
Categories
- Read
List categories
List all categories with filters and pagination. Results are returned in hierarchical order when not filtered by specific category IDs.
- Read
Get a category
Retrieve details of a category, including ancestors and children.
- Write
Create a category
Create a new category.
- Destructive
Update a category
Update an existing category.
- Destructive
Delete a category
Delete a category. Optionally delete its subcategories.
Pricelists
- Read
List all pricebooks
List all the available pricebooks in your zoho books organization.
- Write
Create a pricebook
create a new pricebook.
- Write
Mark as Active
Mark the pricebook as Active.
- Write
Mark as Inactive
Mark the pricebook as Inactive.
- Destructive
Update pricebook
update existing pricebook.
- Destructive
Delete the pricebook
Delete the pricebook.
Locations
- Read
List all locations
List all the available locations in your zoho inventory.
- Write
Enable Locations
Enable Locations for an organisation.
- Write
Create a location
Create a location.
- Write
Mark as Active
Mark location as Active.
- Write
Mark as Inactive
Mark location as Inactive.
- Write
Mark as Primary
Mark location as primary.
- Destructive
Update location
Update location
- Destructive
Delete a location
Delete a location.
Currency
- Read
List Currencies
Get list of currencies configured.
- Read
Get a Currency
Get the details of a currency.
- Read
List exchange rates
List of exchange rates configured for the currency.
- Read
Get an exchange rate.
Get the details of an exchange rate that has been asscoiated to the currency.
- Write
Create a Currency
Create a currency for transaction.
- Write
Create an exchange rate
Create an exchange rate for the specified currency.
- Destructive
Update a Currency
Update the details of a currency.
- Destructive
Delete a currency
Delete a currency. Currency that is associated to transactions cannot be deleted.
- Destructive
Update an exchange rate
Update the details of exchange rate for a currency.
- Destructive
Delete an exchage rate
Delete an exchange rate for the specified currency.
Taxes
- Read
List taxes
List of simple and compound taxes with pagination. Note: You have to enable Sales Tax in order to perform tax related operations.
- Read
Get a tax
Get the details of a simple or compound tax. Note: You have to enable Sales Tax in order to perform tax related operations.
- Read
Get a tax group
Get the details of a tax group. Note: You have to enable Sales Tax in order to perform tax related operations.
- Read
List tax authorities [US Edition only]
List of tax authorities. Note: You have to enable Sales Tax in order to perform tax related operations.
- Read
Get a tax authority [US and CA Edition only]
Get the details of a tax authority. Note: You have to enable Sales Tax in order to perform tax related operations.
- Read
List tax exemptions [US Edition only]
List of tax exemptions. Note: You have to enable Sales Tax in order to perform tax related operations.
- Read
Get a tax exemption [US Edition only]
Get the details of a tax exemption. Note: You have to enable Sales Tax in order to perform tax related operations.
- Write
Create a tax
Create a tax which can be associated with an item. Note: You have to enable Sales Tax in order to perform tax related operations.
- Write
Create a tax group
Create a tax group associating multiple taxes. Note: You have to enable Sales Tax in order to perform tax related operations.
- Write
Create a tax authority [US and CA Edition only]
Create a tax authority. Note: You have to enable Sales Tax in order to perform tax related operations.
- Write
Create a tax exemption [US Edition only]
Create a tax exemption. Note: You have to enable Sales Tax in order to perform tax related operations.
- Destructive
Update a tax
Update the details of a simple or compound tax. Note: You have to enable Sales Tax in order to perform tax related operations.
- Destructive
Delete a tax
Delete a simple or compound tax. Note: You have to enable Sales Tax in order to perform tax related operations.
- Destructive
Update a tax group
Update the details of the tax group. Note: You have to enable Sales Tax in order to perform tax related operations.
- Destructive
Delete a tax group
Delete a tax group. Tax group that is associated to transactions cannot be deleted. Note: You have to enable Sales Tax in order to perform tax related operations.
- Destructive
Update a tax authority [US and CA Edition only]
Update the details of a tax authority. Note: You have to enable Sales Tax in order to perform tax related operations.
- Destructive
Delete a tax authority [US and CA Edition only]
Delete a tax authority. Note: You have to enable Sales Tax in order to perform tax related operations.
- Destructive
Update a tax exemption [US Edition only]
Update the details of a tax exemption. Note: You have to enable Sales Tax in order to perform tax related operations.
- Destructive
Delete a tax exemption [US Edition only]
Delete a tax exemption. Note: You have to enable Sales Tax in order to perform tax related operations.
Opening balance
- Read
Get opening balance
Get opening balance.
- Read
List opening balance account details
Lists the opening balance details for a specific account.
- Read
List opening balance transactions
Lists the opening balance transactions for a specific account.
- Write
Create opening balance
Creates opening balance with the given information.
- Write
Write off an opening balance
Writes off an opening balance entry.
- Destructive
Update opening balance
Updates the existing opening balance information.
- Destructive
Delete opening balance
Delete the entered opening balance.
- Destructive
Cancel a write-off
Cancels a previously written-off opening balance.
Transaction locking
- Read
Get transaction lock details
Get the details of financial transaction locking.
- Read
Get transaction lock for an accounting period
Get transaction locking details for an accounting period.
- Read
List transaction locks
List all transaction locks with pagination.
- Destructive
Update transaction lock
Update transaction lock settings.
- Destructive
Delete a transaction lock
Delete a transaction lock entry.
- Destructive
Update partial unlock settings
Update partial unlock settings for transaction locking.
Integration
- Write
Import a customer using the CRM account ID
Zoho Books must be integrated with Zoho CRM using Accounts and Contacts sync or using Accounts only sync to import a customer from CRM with its CRM account ID. Note: You can get a contact by CRM account ID by using this API Endpoint
- Write
Import a customer using CRM contact ID
Zoho Books must be integrated with Zoho CRM using Contacts only sync or Accounts & their Contacts and Include contacts that are not associated to any accounts sync type contacts that are not associated to any accounts in Zoho CRM to import a customer from CRM with its CRM contac…
- Write
Import a vendor using the CRM vendor ID
Zoho Books must be integrated with Zoho CRM using Vendor only sync to import a vendor from CRM with its CRM vendor ID.
- Write
Import an item using the CRM product ID
Zoho Books must be integrated with Zoho CRM using Products only sync to import an item from CRM with its CRM product ID.
Reporting tags
- Read
List of all Reporting Tags
Get a list of all reporting tags in the preferred order that you can set.
- Read
Get Reporting Tags Options Detail Page
Get the options and its criteria details of a reporting tag. For each page, you can retrieve only 200 options.
- Read
Get all Options
Get all options for a reporting tag.
- Write
Create Reporting Tag
Create a reporting tag
- Write
Mark an option as default for a reporting tag
Mark an option as the default option or clear default option for a reporting tag.
- Write
Mark Reporting Tag as active
Mark a reporting tag as active so that you can use it on entities which you allowed. A newly created tag will be in draft state. Use this to mark that tag as ready.
- Write
Mark Reporting Tag as inactive
Mark a reporting tag as inactive.
- Write
Mark an option as active
Mark a reporting tag's option as active.
- Write
Mark an option as inactive
Mark a reporting tag's option as inactive.
- Destructive
Update Reporting Tag
Update a reporting tag
- Destructive
Delete a reporting tag
Delete a reporting tag. If there are any usages of the reporting tag in transactions, custom views or workflows, you will not be able to delete the tag.
- Destructive
Update Reporting Tag Options
Create, update or delete the options of a reporting tag. Reorder and arrange them in an hierarchical structure as per your organization requirements. NOTE: An option cannot be a child option beyond five hierarchical level.
- Destructive
Update Reporting Tag - Visibility Conditions
Update the visibility conditions (or filter in some places) of a reporting tag. You can set other tags or location as filters for a tag. Check our help document to know about the requirements of a tag to be associated as a filter to another tag.
- Destructive
Reorder Reporting Tags
Reorder the reporting tags in your organization. The order of tags will be followed in transactions and reports.
No operations match.
See How connections work for access and permissions, or browse all integrations.