# Zoho Books Integration via LowCodeAPI
## Overview
Accounting software
## Base Endpoint
```
https://api.lowcodeapi.com/zohobooks/
```
## Authentication
LowCodeAPI handles authentication automatically. You only need to:
1. **Sign up** at [Zoho Books](https://www.zoho.com/books/)
2. **Get your credentials** from [credential page](https://api-console.zoho.com/)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests
**Auth Type**: OAUTH2.0
## API Categories
- **Bank Accounts** - 10 endpoints
- **Bank Rules** - 5 endpoints
- **Bank Transactions** - 19 endpoints
- **Base Currency Adjustment** - 5 endpoints
- **Bills** - 19 endpoints
- **Chart Of Accounts** - 9 endpoints
- **Contact Persons** - 6 endpoints
- **Contacts** - 21 endpoints
- **Credit Notes** - 29 endpoints
- **Currency** - 10 endpoints
- **Custom Modules** - 7 endpoints
- **Customer Payments** - 10 endpoints
- **Estimates** - 23 endpoints
- **Expenses** - 13 endpoints
- **Introduction** - 1 endpoints
- **Invoices** - 40 endpoints
- **Items** - 7 endpoints
- **Journals** - 9 endpoints
- **Opening Balance** - 4 endpoints
- **Projects** - 18 endpoints
- **Purchase Order** - 23 endpoints
- **Recurring Bills** - 8 endpoints
- **Recurring Expenses** - 9 endpoints
- **Recurring Invoices** - 9 endpoints
- **Retainer Invoices** - 22 endpoints
- **Sales Order** - 26 endpoints
- **Tasks** - 5 endpoints
- **Taxes** - 19 endpoints
- **Time Entries** - 9 endpoints
- **Users** - 9 endpoints
- **Vendor Credits** - 21 endpoints
- **Vendor Payments** - 10 endpoints
- **ZOHO CRM Integration** - 3 endpoints
## Common Endpoints
### Category: Bank Accounts
#### Create a bank account
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/bankaccounts`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankaccounts?api_token={api_token}
```
**Description**: Create a bank account or a credit card account for your organization
**Request Body**:
```json
{
"account_name": "<string>",
"account_type": "<string>"
}
```
---
#### List view of accounts
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/bankaccounts`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankaccounts?filter_by={filter_by}&sort_column={sort_column}&api_token={api_token}
```
**Description**: List all bank and credit card accounts for your organization
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter_by` | string | No | Filter the account by their status |
|`sort_column` | string | No | Sort the values based on the allowed values |
---
#### Update bank account
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/bankaccounts/account_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankaccounts/account_id?api_token={api_token}
```
**Description**: Modify the account that was created
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | No | Account Id |
**Request Body**:
```json
{
"account_name": "<string>",
"account_type": "<string>"
}
```
---
#### Get account details
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/bankaccounts/account_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankaccounts/account_id?api_token={api_token}
```
**Description**: Get a detailed look of the account specified
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | No | Account Id |
---
#### Delete an account
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/bankaccounts/account_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankaccounts/account_id?api_token={api_token}
```
**Description**: Delete a bank account from your organization
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | No | Account Id |
---
#### Deactivate account
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/bankaccounts/account_id/inactive`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankaccounts/account_id/inactive?api_token={api_token}
```
**Description**: Make an account inactive
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | No | Account Id |
---
#### Activate account
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/bankaccounts/account_id/active`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankaccounts/account_id/active?api_token={api_token}
```
**Description**: Make an account active
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | No | Account Id |
---
#### Import a Bank/Credit Card Statement
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/bankstatements`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankstatements?api_token={api_token}
```
**Description**: Import your bank/credit card feeds into your account
**Request Body**:
```json
{
"account_id": "<string>",
"transactions": "<array>"
}
```
---
#### Get last imported statement
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/bankaccounts/account_id/statement/lastimported`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankaccounts/account_id/statement/lastimported?api_token={api_token}
```
**Description**: Get the details of previously imported statement for the account
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | No | Account Id |
---
#### Delete last imported statement
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/bankaccounts/account_id/statement/statement_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankaccounts/account_id/statement/statement_id?api_token={api_token}
```
**Description**: Delete the statement that was previously imported
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | No | Account Id |
|`statement_id` | string | No | Statement Id |
---
### Category: Bank Rules
#### Create a rule
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/bankaccounts/rules`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankaccounts/rules?api_token={api_token}
```
**Description**: Create a rule and apply it on deposit/withdrawal for bank accounts and on refund/charges for credit card accounts
**Request Body**:
```json
{
"rule_name": "<string>",
"target_account_id": "<number>",
"apply_to": "<string>",
"criteria_type": "<string>",
"criterion": "<array>",
"record_as": "<string>"
}
```
---
#### Get Rules List
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/bankaccounts/rules`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankaccounts/rules?account_id={account_id}&api_token={api_token}
```
**Description**: Fetch all the rules created for a specified bank or credit card account ID
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | ID of the Bank Account |
---
#### Update a rule
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/bankaccounts/rules/rule_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankaccounts/rules/rule_id?api_token={api_token}
```
**Description**: Make changes to the rule, add or modify it and update
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`rule_id` | string | No | Rule Id |
**Request Body**:
```json
{
"rule_name": "<string>",
"target_account_id": "<number>",
"apply_to": "<string>",
"criteria_type": "<string>",
"criterion": "<array>",
"record_as": "<string>"
}
```
---
#### Get a rule
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/bankaccounts/rules/rule_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankaccounts/rules/rule_id?api_token={api_token}
```
**Description**: Get details of a specific rule
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`rule_id` | string | No | Rule Id |
---
#### Delete a rule
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/bankaccounts/rules/rule_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bankaccounts/rules/rule_id?api_token={api_token}
```
**Description**: Delete a rule from your account and make it no longer applicable on the transactions
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`rule_id` | string | No | Rule Id |
---
### Category: Bank Transactions
#### Create a transaction for an account
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/banktransactions`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions?api_token={api_token}
```
**Description**: Create a bank transaction based on the allowed transaction types
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Get transactions list
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/banktransactions`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions?account_id={account_id}&transaction_type={transaction_type}&date={date}&amount={amount}&status={status}&reference_number={reference_number}&filter_by={filter_by}&sort_column={sort_column}&transaction_status={transaction_status}&search_text={search_text}&api_token={api_token}
```
**Description**: Get all the transaction details involved in an account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | No | Account id |
|`transaction_type` | string | No | Transaction type |
|`date` | string | No | Start and end date, to provide a range within which the transaction date exist |
|`amount` | string | No | Start and end amount, to provide a range within which the transaction amount exist |
|`status` | string | No | Transaction status wise list view |
|`reference_number` | string | No | Search using Reference Number of the transaction |
|`filter_by` | string | No | Filters the transactions based on the allowed types |
|`sort_column` | string | No | Sorts the transactions based on the allowed sort types |
|`transaction_status` | string | No | Transaction status wise list view |
|`search_text` | string | No | Search Transactions by contact name or descriptionz |
---
#### Update a transaction
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/banktransactions/bank_transaction_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions/bank_transaction_id?api_token={api_token}
```
**Description**: Make changes in the applicable fields of a transaction and update it
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bank_transaction_id` | string | No | Bank Transaction Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Get transaction
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/banktransactions/bank_transaction_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions/bank_transaction_id?api_token={api_token}
```
**Description**: Fetch the details of a transaction by specifying the transaction_id
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bank_transaction_id` | string | No | Bank Transaction Id |
---
#### Delete a transaction
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/banktransactions/bank_transaction_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions/bank_transaction_id?api_token={api_token}
```
**Description**: Delete a transaction from an account by specifying the transaction_id
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bank_transaction_id` | string | No | Bank Transaction Id |
---
#### Match a transaction
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/banktransactions/uncategorized/transaction_id/match`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions/uncategorized/transaction_id/match?api_token={api_token}
```
**Description**: Match an uncategorized transaction with an existing transaction in the account
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transaction_id` | string | No | Transaction Id |
---
#### Get matching transactions
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/banktransactions/uncategorized/transaction_id/match`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions/uncategorized/transaction_id/match?transaction_type={transaction_type}&date_after={date_after}&date_before={date_before}&amount_start={amount_start}&amount_end={amount_end}&contact={contact}&reference_number={reference_number}&show_all_transactions={show_all_transactions}&api_token={api_token}
```
**Description**: Provide criteria to search for matching uncategorised transactions
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transaction_id` | string | No | Transaction Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transaction_type` | string | No | Type of the transaction |
|`date_after` | string | No | Date after which Transactions are to be filtered |
|`date_before` | string | No | Date before which Transactions are to be filtered |
|`amount_start` | string | No | Starting amout with which transactions are to be filtered |
|`amount_end` | string | No | Starting amout with which transactions are to be filtered |
|`contact` | string | No | Contact person name, involved in the transaction |
|`reference_number` | string | No | Reference Number of the transaction |
|`show_all_transactions` | string | No | Check if all transactions must be shown |
---
#### Unmatch a matched transaction
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/banktransactions/transaction_id/unmatch`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions/transaction_id/unmatch?api_token={api_token}
```
**Description**: Unmatch a transaction that was previously matched and make it uncategorized
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transaction_id` | string | No | Transaction Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Exclude a transaction
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/banktransactions/uncategorized/transaction_id/exclude`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions/uncategorized/transaction_id/exclude?api_token={api_token}
```
**Description**: Exclude a transaction from your bank or credit card account
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transaction_id` | string | No | Transaction Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Restore a transaction
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/banktransactions/uncategorized/transaction_id/restore`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions/uncategorized/transaction_id/restore?api_token={api_token}
```
**Description**: Restore an excluded transaction in your account
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transaction_id` | string | No | Transaction Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Categorize an uncategorized transaction
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/banktransactions/uncategorized/transaction_id/categorize`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions/uncategorized/transaction_id/categorize?api_token={api_token}
```
**Description**: Categorize an uncategorized transaction by creating a new transaction
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transaction_id` | string | No | Transaction Id |
---
#### Categorize as expense
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/banktransactions/uncategorized/transaction_id/categorize/expenses`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions/uncategorized/transaction_id/categorize/expenses?api_token={api_token}
```
**Description**: Categorize an Uncategorized transaction as expense
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transaction_id` | string | No | Transaction Id |
---
#### Uncategorize a categorized transaction
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/banktransactions/transaction_id/uncategorize`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions/transaction_id/uncategorize?api_token={api_token}
```
**Description**: Revert a categorized transaction as uncategorized
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transaction_id` | string | No | Transaction Id |
---
#### Categorize a vendor payment
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/banktransactions/uncategorized/transaction_id/categorize/vendorpayments`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions/uncategorized/transaction_id/categorize/vendorpayments?api_token={api_token}
```
**Description**: Categorize an uncategorized transaction as Vendor Payment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transaction_id` | string | No | Transaction Id |
---
#### Categorize as customer payment
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/banktransactions/uncategorized/transaction_id/categorize/customerpayments`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/banktransactions/uncategorized/transaction_id/categorize/customerpayments?api_token={api_token}
```
**Description**: Categorize an uncategorized transaction as Customer Payment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transaction_id` | string | No | Transaction Id |
---
*Note: Showing 15 of 19 endpoints in this category.*
---
### Category: Base Currency Adjustment
#### Create a base currency adjustment
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/basecurrencyadjustment`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/basecurrencyadjustment?api_token={api_token}
```
**Description**: Creates a base currency adjustment for the given information
**Request Body**:
```json
{
"currency_id": "<string>",
"adjustment_date": "<string>",
"exchange_rate": "<number>",
"notes": "<string>",
"account_ids": "<string>"
}
```
---
#### List base currency adjustment
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/basecurrencyadjustment`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/basecurrencyadjustment?filter_by={filter_by}&sort_column={sort_column}&last_modified_time={last_modified_time}&api_token={api_token}
```
**Description**: Lists base currency adjustment
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter_by` | string | No | Filter base currency adjustment list |
|`sort_column` | string | No | Sort base currency adjustment list |
|`last_modified_time` | string | No | Search using the Last Modified Time of the Base Currency Adjustment |
---
#### Get a base currency adjustment
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/basecurrencyadjustment/base_currency_adjustment_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/basecurrencyadjustment/base_currency_adjustment_id?api_token={api_token}
```
**Description**: Get the base currency adjustment details
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`base_currency_adjustment_id` | string | No | Base Currency Adjustment Id |
---
#### Delete a base currency adjustment
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/basecurrencyadjustment/base_currency_adjustment_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/basecurrencyadjustment/base_currency_adjustment_id?api_token={api_token}
```
**Description**: Deletes the base currency adjustment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`base_currency_adjustment_id` | string | No | Base Currency Adjustment Id |
---
#### List account details for base currency adjustment
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/basecurrencyadjustment/accounts`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/basecurrencyadjustment/accounts?currency_id={currency_id}&adjustment_date={adjustment_date}&exchange_rate={exchange_rate}¬es={notes}&api_token={api_token}
```
**Description**: List of accounts having transaction with effect to the given exchange rate
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`currency_id` | string | Yes | ID of currency for which we need to post adjustment |
|`adjustment_date` | string | Yes | Date of adjustment |
|`exchange_rate` | number | Yes | Exchange rate of the currency |
|`notes` | string | Yes | Notes for base currency adjustment |
---
### Category: Bills
#### Create a bill
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/bills`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills?api_token={api_token}
```
**Description**: Create a bill received from your vendor
**Request Body**:
```json
{
"vendor_id": "<string>",
"bill_number": "<string>"
}
```
---
#### List bills
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/bills`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills?bill_number={bill_number}&reference_number={reference_number}&date={date}&status={status}&description={description}&vendor_name={vendor_name}&total={total}&vendor_id={vendor_id}&item_id={item_id}&recurring_bill_id={recurring_bill_id}&purchaseorder_id={purchaseorder_id}&last_modified_time={last_modified_time}&filter_by={filter_by}&search_text={search_text}&sort_column={sort_column}&api_token={api_token}
```
**Description**: List all bills with pagination
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_number` | string | Yes | Search bills by bill number |
|`reference_number` | string | No | Search bills by reference_number number |
|`date` | string | No | Search bills by bill date |
|`status` | string | No | Search bills by bill status |
|`description` | string | No | Search bills by description |
|`vendor_name` | string | No | Search bills by vendor name |
|`total` | string | No | Search bills by bill total |
|`vendor_id` | string | No | Search bills by Vendor ID |
|`item_id` | string | No | Search bills by Item ID |
|`recurring_bill_id` | string | No | Search bills by Recurring Bill ID |
|`purchaseorder_id` | string | No | Search bills by Purchase Order ID |
|`last_modified_time` | string | No | Search bills by Last Modified Time |
|`filter_by` | string | No | Filter bills by any status |
|`search_text` | string | No | Search bills by bill number or reference number or vendor name |
|`sort_column` | string | No | Sort bills |
---
#### Update a bill
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/bills/bill_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills/bill_id?api_token={api_token}
```
**Description**: Update a bill. To delete a line item just remove it from the line_items list
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | No | Bill Id |
**Request Body**:
```json
{
"vendor_id": "<string>",
"bill_number": "<string>"
}
```
---
#### Get a bill
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/bills/bill_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills/bill_id?api_token={api_token}
```
**Description**: Get the details of a bill
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | No | Bill Id |
---
#### Delete a bill
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/bills/bill_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills/bill_id?api_token={api_token}
```
**Description**: Delete an existing bill. Bills which have payments applied cannot be deleted
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | No | Bill Id |
---
#### Void a bill
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/bills/bill_id/status/void`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills/bill_id/status/void?api_token={api_token}
```
**Description**: Mark a bill status as void
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | No | Bill Id |
---
#### Mark a bill as open
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/bills/bill_id/status/open`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills/bill_id/status/open?api_token={api_token}
```
**Description**: Mark a void bill as open
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | No | Bill Id |
---
#### Submit a bill for approval
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/bills/bill_id/submit`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills/bill_id/submit?api_token={api_token}
```
**Description**: Submit a bill for approval
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | No | Bill Id |
---
#### Approve a bill
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/bills/bill_id/approve`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills/bill_id/approve?api_token={api_token}
```
**Description**: Approve a bill
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | No | Bill Id |
---
#### Update billing address
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/bills/bill_id/address/billing`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills/bill_id/address/billing?api_token={api_token}
```
**Description**: Updates the billing address for this bill
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | No | Bill Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### List bill payments
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/bills/bill_id/payments`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills/bill_id/payments?api_token={api_token}
```
**Description**: Get the list of payments made for a bill
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | No | Bill Id |
---
#### Apply credits
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/bills/bill_id/credits`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills/bill_id/credits?api_token={api_token}
```
**Description**: Apply the vendor credits from excess vendor payments to a bill
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | No | Bill Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete a payment
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/bills/bill_id/payments/bill_payment_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills/bill_id/payments/bill_payment_id?api_token={api_token}
```
**Description**: Delete a payment made to a bill
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | No | Bill Id |
|`bill_payment_id` | string | No | Bill Payment Id |
---
#### Add attachment to a bill
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/bills/bill_id/attachment`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills/bill_id/attachment?api_token={api_token}
```
**Description**: Attach a file to a bill
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | No | Bill Id |
---
#### Get a bill attachment
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/bills/bill_id/attachment`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/bills/bill_id/attachment?preview={preview}&api_token={api_token}
```
**Description**: Returns the file attached to the bill
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | No | Bill Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`preview` | string | No | Get the thumbnail of the attachment |
---
*Note: Showing 15 of 19 endpoints in this category.*
---
### Category: Chart Of Accounts
#### Create an account
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/chartofaccounts`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/chartofaccounts?api_token={api_token}
```
**Description**: Creates an account with the given account type
**Request Body**:
```json
{
"key": "value"
}
```
---
#### List chart of accounts
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/chartofaccounts`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/chartofaccounts?showbalance={showbalance}&filter_by={filter_by}&sort_column={sort_column}&last_modified_time={last_modified_time}&api_token={api_token}
```
**Description**: List all chart of accounts along with pagination
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`showbalance` | string | No | Boolean to get current balance of accounts |
|`filter_by` | string | No | Filter accounts based on its account type and status |
|`sort_column` | string | No | Sort accounts |
|`last_modified_time` | string | No | Last modified time |
---
#### Update an account
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/chartofaccounts/account_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/chartofaccounts/account_id?api_token={api_token}
```
**Description**: Updates the account information
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | No | Account Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Get an account
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/chartofaccounts/account_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/chartofaccounts/account_id?api_token={api_token}
```
**Description**: Gets the details of an account
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | No | Account Id |
---
#### Delete an account
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/chartofaccounts/account_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/chartofaccounts/account_id?api_token={api_token}
```
**Description**: Deletes the given account. Accounts associated in any transaction/products could not be deleted
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | No | Account Id |
---
#### Mark an account as active
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/chartofaccounts/account_id/active`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/chartofaccounts/account_id/active?api_token={api_token}
```
**Description**: Updates the account status as active
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | No | Account Id |
---
#### Mark an account as inactive
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/chartofaccounts/account_id/inactive`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/chartofaccounts/account_id/inactive?api_token={api_token}
```
**Description**: Updates the account status as inactive
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | No | Account Id |
---
#### List of transactions for an account
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/chartofaccounts/transactions`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/chartofaccounts/transactions?account_id={account_id}&date={date}&amount={amount}&filter_by={filter_by}&transaction_type={transaction_type}&sort_column={sort_column}&api_token={api_token}
```
**Description**: List all involved transactions for the given account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | ID of the Account |
|`date` | string | No | Search account transactions with the given date range |
|`amount` | string | No | Search account transactions with given amount range |
|`filter_by` | string | No | Filter accounts based on its account type and status |
|`transaction_type` | string | No | Search transactions based on the given transaction type |
|`sort_column` | string | No | Sort accounts |
---
#### Delete a transaction
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/chartofaccounts/transactions/transaction_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/chartofaccounts/transactions/transaction_id?api_token={api_token}
```
**Description**: Deletes the transaction
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transaction_id` | string | No | Transaction Id |
---
### Category: Contact Persons
#### Create a contact person
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/contacts/contactpersons`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts/contactpersons?api_token={api_token}
```
**Description**: Create a contact person for contact
**Request Body**:
```json
{
"first_name": "<string>"
}
```
---
#### Update a contact person
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/contact/contactpersons/contact_person_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contact/contactpersons/contact_person_id?api_token={api_token}
```
**Description**: Update an existing contact person
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_person_id` | string | No | Contact Person Id |
**Request Body**:
```json
{
"contact_id": "<string>",
"first_name": "<string>"
}
```
---
#### Delete a contact person
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/contact/contactpersons/contact_person_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contact/contactpersons/contact_person_id?api_token={api_token}
```
**Description**: Delete an existing contact person
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_person_id` | string | No | Contact Person Id |
---
#### List contact persons
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/contact/contact_id/contactpersons`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contact/contact_id/contactpersons?api_token={api_token}
```
**Description**: List all contacts with pagination
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_person_id` | string | No | Contact Person Id |
---
#### Get a contact person
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/contact/contact_id/contactpersons/contact_person_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contact/contact_id/contactpersons/contact_person_id?api_token={api_token}
```
**Description**: Get the contact person details
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | No | Contact Id |
|`contact_person_id` | string | No | Contact Person Id |
---
#### Mark as primary contact person
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/contact/contactpersons/contact_person_id/primary`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contact/contactpersons/contact_person_id/primary?api_token={api_token}
```
**Description**: Mark a contact person as primary for the contact
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_person_id` | string | No | Contact Person Id |
---
### Category: Contacts
#### Create a Contact
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/contacts`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts?api_token={api_token}
```
**Description**: Create a contact with given information
**Request Body**:
```json
{
"contact_name": "<string>"
}
```
---
#### List Contacts
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/contacts`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts?contact_name={contact_name}&company_name={company_name}&first_name={first_name}&last_name={last_name}&address={address}&email={email}&phone={phone}&filter_by={filter_by}&search_text={search_text}&sort_column={sort_column}&zcrm_contact_id={zcrm_contact_id}&zcrm_account_id={zcrm_account_id}&api_token={api_token}
```
**Description**: List all contacts with pagination.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_name` | string | No | Search contacts by contact name |
|`company_name` | string | No | Search contacts by company name |
|`first_name` | string | No | Search contacts by first name of the contact person |
|`last_name` | string | No | Search contacts by last name of the contact person |
|`address` | string | No | Search contacts by any of the address fields |
|`email` | string | No | Search contacts by email of the contact person |
|`phone` | string | No | Search contacts by phone number of the contact person |
|`filter_by` | string | No | Filter contacts by status |
|`search_text` | string | No | Search contacts by contact name or notes |
|`sort_column` | string | No | Sort contacts |
|`zcrm_contact_id` | string | No | CRM Contact ID for the contact |
|`zcrm_account_id` | string | No | CRM Account ID for the contact |
---
#### Update a Contact
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/contacts/contact_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts/contact_id?api_token={api_token}
```
**Description**: Update an existing contact
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | No | Contact Id |
**Request Body**:
```json
{
"contact_name": "<string>"
}
```
---
#### Get Contact
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/contacts/contact_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts/contact_id?api_token={api_token}
```
**Description**: Get details of a contact
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | No | Contact Id |
---
#### Delete a Contact
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/contacts/contact_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts/contact_id?api_token={api_token}
```
**Description**: Delete an existing contact
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | No | Contact Id |
---
#### Mark as Active
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/contacts/contact_id/active`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts/contact_id/active?api_token={api_token}
```
**Description**: Mark a contact as active
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | No | Contact Id |
---
#### Mark as Inactive
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/contacts/contact_id/inactive`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts/contact_id/inactive?api_token={api_token}
```
**Description**: Mark a contact as inactive
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | No | Contact Id |
---
#### Enable Portal Access
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/contacts/contact_id/portal/enable`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts/contact_id/portal/enable?api_token={api_token}
```
**Description**: Enable portal access for a contact
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | No | Contact Id |
---
#### Enable Payment Reminders
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/contacts/contact_id/paymentreminder/enable`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts/contact_id/paymentreminder/enable?api_token={api_token}
```
**Description**: Enable automated payment reminders for a contact
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | No | Contact Id |
---
#### Disable Payment Reminders
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/contacts/contact_id/paymentreminder/disable`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts/contact_id/paymentreminder/disable?api_token={api_token}
```
**Description**: Disable automated payment reminders for a contact
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | No | Contact Id |
---
#### Email Statement
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/contacts/contact_id/statements/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts/contact_id/statements/email?api_token={api_token}
```
**Description**: Email statement to the contact
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | No | Contact Id |
**Request Body**:
```json
{
"to_mail_ids": "<array>",
"subject": "<string>",
"body": "<string>"
}
```
---
#### Get Statement Mail Content
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/contacts/contact_id/statements/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts/contact_id/statements/email?start_date={start_date}&end_date={end_date}&api_token={api_token}
```
**Description**: Get the statement mail content
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | No | Contact Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`start_date` | string | No | If start_date and end_date are not given, current month's statement will be sent to contact |
|`end_date` | array | No | End date for the statement |
---
#### Email Contact
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/contacts/contact_id/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts/contact_id/email?api_token={api_token}
```
**Description**: Send email to contact
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | No | Contact Id |
**Request Body**:
```json
{
"to_mail_ids": "<array>",
"subject": "<string>",
"body": "<string>"
}
```
---
#### List Comments
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/contacts/contact_id/comments`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts/contact_id/comments?api_token={api_token}
```
**Description**: List recent activities of a contact
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | No | Contact Id |
---
#### Add Additional Address
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/contacts/contact_id/address`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/contacts/contact_id/address?api_token={api_token}
```
**Description**: Add an additional address for a contact using the arguments below
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | No | Contact Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
*Note: Showing 15 of 21 endpoints in this category.*
---
### Category: Credit Notes
#### Create a credit note
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/creditnotes`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes?api_token={api_token}
```
**Description**: Details of an existing creditnote
**Request Body**:
```json
{
"customer_id": "<string>",
"date": "<string>",
"line_items": "<array>",
"creditnote_number": "<string>"
}
```
---
#### List all Credit Notes
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/creditnotes`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes?creditnote_number={creditnote_number}&date={date}&status={status}&total={total}&reference_number={reference_number}&customer_name={customer_name}&item_name={item_name}&customer_id={customer_id}&item_description={item_description}&item_id={item_id}&line_item_id={line_item_id}&tax_id={tax_id}&filter_by={filter_by}&search_text={search_text}&sort_column={sort_column}&api_token={api_token}
```
**Description**: List all the Credit Notes
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_number` | string | No | Unique number generated (starts with CN) which will be displayed in the interface and credit notes |
|`date` | string | No | The date on which credit note is raised |
|`status` | string | No | Status of the credit note |
|`total` | string | No | Total credits raised in this credit note |
|`reference_number` | string | No | Reference number generated for the payment |
|`customer_name` | string | No | Name of the customer to whom the credit note is raised |
|`item_name` | string | No | Search credit notes by item name |
|`customer_id` | string | No | Customer ID of the customer for whom the credit note is raised |
|`item_description` | string | No | description for the item |
|`item_id` | string | No | Unique string generated for the item to which a refund is to be made |
|`line_item_id` | string | No | Search credit notes by credit note line item id |
|`tax_id` | string | No | Unique to denote the tax associate dto the creditnote |
|`filter_by` | string | No | Filter credit notes by statuses |
|`search_text` | string | No | Search credit notes by credit note number or customer name or credit note reference number |
|`sort_column` | boolean | No | Sort credit notes by following columns customer_name, creditnote_number, balance, total, date and created_time |
---
#### Update a credit note
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/creditnotes/creditnote_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes/creditnote_id?api_token={api_token}
```
**Description**: Details of an existing creditnote
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | No | Creditnote Id |
**Request Body**:
```json
{
"customer_id": "<string>",
"date": "<string>",
"line_items": "<array>",
"creditnote_number": "<string>"
}
```
---
#### Get a credit note
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/creditnotes/creditnote_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes/creditnote_id?print={print}&accept={accept}&api_token={api_token}
```
**Description**: Details of an existing creditnote
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | No | Creditnote Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`print` | string | No | Export credit note pdf with default print option |
|`accept` | string | No | You can get credit note details as json/pdf/html |
---
#### Delete a credit note
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/creditnotes/creditnote_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes/creditnote_id?api_token={api_token}
```
**Description**: Delete an existing credit note
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | No | Creditnote Id |
---
#### Email a credit note
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/creditnotes/creditnote_id/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes/creditnote_id/email?api_token={api_token}
```
**Description**: Email a credit note
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | No | Creditnote Id |
**Request Body**:
```json
{
"to_mail_ids": "<array>"
}
```
---
#### Get email content
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/creditnotes/creditnote_id/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes/creditnote_id/email?email_template_id={email_template_id}&api_token={api_token}
```
**Description**: Get email content of a credit note
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | No | Creditnote Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`email_template_id` | string | No | Get the email content based on a specific email template |
---
#### Void a Credit Note
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/creditnotes/creditnote_id/status/void`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes/creditnote_id/status/void?api_token={api_token}
```
**Description**: Mark the credit note as Void
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | No | Creditnote Id |
---
#### Convert Credit Note to Draft.
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/creditnotes/creditnote_id/status/draft`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes/creditnote_id/status/draft?api_token={api_token}
```
**Description**: Convert a voided credit note to Draft
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | No | Creditnote Id |
---
#### Convert to Open
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/creditnotes/creditnote_id/status/open`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes/creditnote_id/status/open?api_token={api_token}
```
**Description**: Convert a credit note in Draft status to Open
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | No | Creditnote Id |
---
#### Submit a credit note for approval
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/creditnotes/creditnote_id/submit`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes/creditnote_id/submit?api_token={api_token}
```
**Description**: Submit an estimate for approval
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | No | Creditnote Id |
---
#### Approve a credit note
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/creditnotes/creditnote_id/approve`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes/creditnote_id/approve?api_token={api_token}
```
**Description**: Approve a credit note
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | No | Creditnote Id |
---
#### Email history
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/creditnotes/creditnote_id/emailhistory`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes/creditnote_id/emailhistory?api_token={api_token}
```
**Description**: Get email history of a credit code
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | No | Creditnote Id |
---
#### Update billing address
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/creditnotes/creditnote_id/address/billing`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes/creditnote_id/address/billing?api_token={api_token}
```
**Description**: Updates the billing address for an existing credit note alone
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | No | Creditnote Id |
---
#### Update Shipping address
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/creditnotes/creditnote_id/address/shipping`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/creditnotes/creditnote_id/address/shipping?api_token={api_token}
```
**Description**: Updates the shipping address for an existing credit note alone
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | No | Creditnote Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
*Note: Showing 15 of 29 endpoints in this category.*
---
### Category: Currency
#### Create a Currency
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/settings/currencies`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/currencies?api_token={api_token}
```
**Description**: Create a currency for transaction
**Request Body**:
```json
{
"currency_code": "<string>",
"currency_format": "<string>"
}
```
---
#### List Currencies
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/settings/currencies`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/currencies?filter_by={filter_by}&api_token={api_token}
```
**Description**: Get list of currencies configured
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter_by` | string | No | Filter currencies excluding base currency |
---
#### Update a Currency
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/settings/currencies/currency_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/currencies/currency_id?api_token={api_token}
```
**Description**: Update the details of a currency
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`currency_id` | string | No | Currency Id |
**Request Body**:
```json
{
"currency_code": "<string>",
"currency_format": "<string>"
}
```
---
#### Get a Currency
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/settings/currencies/currency_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/currencies/currency_id?api_token={api_token}
```
**Description**: Get the details of a currency
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`currency_id` | string | No | Currency Id |
---
#### Delete a currency
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/settings/currencies/currency_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/currencies/currency_id?api_token={api_token}
```
**Description**: Delete a currency. Currency that is associated to transactions cannot be deleted
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`currency_id` | string | No | Currency Id |
---
#### Create an exchange rate
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/settings/currencies/currency_id/exchangerates`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/currencies/currency_id/exchangerates?api_token={api_token}
```
**Description**: Create an exchange rate for the specified currency
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`currency_id` | string | No | Currency Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### List exchange rates
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/settings/currencies/currency_id/exchangerates`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/currencies/currency_id/exchangerates?from_date={from_date}&is_current_date={is_current_date}&sort_column={sort_column}&api_token={api_token}
```
**Description**: List of exchange rates configured for the currency
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`currency_id` | string | No | Currency Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from_date` | string | No | Returns the exchange rate details from the given date |
|`is_current_date` | string | No | To return the exchange rate only if available for current date |
|`sort_column` | string | No | Sorts the exchange rate according to this column |
---
#### Update an exchange rate
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/settings/currencies/currency_id/exchangerates/exchange_rate_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/currencies/currency_id/exchangerates/exchange_rate_id?api_token={api_token}
```
**Description**: Update the details of exchange rate for a currency
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`currency_id` | string | No | Currency Id |
|`exchange_rate_id` | string | No | Exchange Rate Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Get an exchange rate
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/settings/currencies/currency_id/exchangerates/exchange_rate_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/currencies/currency_id/exchangerates/exchange_rate_id?api_token={api_token}
```
**Description**: Get the details of an exchange rate that has been asscoiated to the currency
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`currency_id` | string | No | Currency Id |
|`exchange_rate_id` | string | No | Exchange Rate Id |
---
#### Delete an exchage rate
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/settings/currencies/currency_id/exchangerates/exchange_rate_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/currencies/currency_id/exchangerates/exchange_rate_id?api_token={api_token}
```
**Description**: Delete an exchange rate for the specified currency
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`currency_id` | string | No | Currency Id |
|`exchange_rate_id` | string | No | Exchange Rate Id |
---
### Category: Custom Modules
#### Create Custom Modules
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/module_name`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/module_name?api_token={api_token}
```
**Description**: To create a custom module, you can use the argument below
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module_name` | string | No | Module Name |
**Request Body**:
```json
{
"record_name": "<string>"
}
```
---
#### Bulk Update Custom Module
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/module_name`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/module_name?api_token={api_token}
```
**Description**: To update existing custom module reecords in bulk, use the argument below
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module_name` | string | No | Module Name |
**Request Body**:
```json
{
"record_name": "<string>"
}
```
---
#### Get Record List of a Custom Module
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/module_name`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/module_name?api_token={api_token}
```
**Description**: To get the list of records of a custom module, you can use the argument below
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module_name` | string | No | Module Name |
---
#### Delete Custom Modules
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/module_name`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/module_name?api_token={api_token}
```
**Description**: To delete a custom module, you can use the argument below
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module_name` | string | No | Module Name |
---
#### Update Custom Module
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/module_name/module_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/module_name/module_id?api_token={api_token}
```
**Description**: To update an existing custom module, use the argument below
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module_name` | string | No | Module Name |
|`module_id` | string | No | Module Id |
**Request Body**:
```json
{
"record_name": "<string>"
}
```
---
#### Get Individual Record Details
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/module_name/module_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/module_name/module_id?api_token={api_token}
```
**Description**: To get the details of an individual organisation, use the argument below
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module_name` | string | No | Module Name |
|`module_id` | string | No | Module Id |
---
#### Delete individual records
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/module_name/module_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/module_name/module_id?api_token={api_token}
```
**Description**: to delete individual records of a custom module, use the argument below
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module_name` | string | No | Module Name |
|`module_id` | string | No | Module Id |
---
### Category: Customer Payments
#### Create a payment
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/customerpayments`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/customerpayments?api_token={api_token}
```
**Description**: Create a new payment
**Request Body**:
```json
{
"customer_id": "<string>",
"payment_mode": "<string>",
"amount": "<number>",
"date": "<string>",
"invoices": "<array>",
"invoice_id": "<string>",
"amount_applied": "<number>"
}
```
---
#### List Customer Payments
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/customerpayments`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/customerpayments?customer_name={customer_name}&reference_number={reference_number}&date={date}&amount={amount}¬es={notes}&payment_mode={payment_mode}&filter_by={filter_by}&sort_column={sort_column}&search_text={search_text}&customer_id={customer_id}&api_token={api_token}
```
**Description**: List all the payments made by your customer
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`customer_name` | string | No | Search payments by customer name |
|`reference_number` | number | No | Search payments by reference number |
|`date` | string | No | Date |
|`amount` | string | No | Search payments by payment amount |
|`notes` | string | No | Search payments by customer notes |
|`payment_mode` | string | No | Search payments by payment mode |
|`filter_by` | string | No | Filter payments by mode |
|`sort_column` | string | No | Sort column |
|`search_text` | string | No | Search payments by reference number or customer name or payment description |
|`customer_id` | string | No | Customer ID of the customer involved in the payment |
---
#### Update a payment
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/customerpayments/payment_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/customerpayments/payment_id?api_token={api_token}
```
**Description**: Update an existing payment information
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`payment_id` | string | No | Payment Id |
**Request Body**:
```json
{
"customer_id": "<string>",
"payment_mode": "<string>",
"amount": "<number>",
"invoices": "<array>",
"invoice_id": "<string>",
"amount_applied": "<number>"
}
```
---
#### Retrieve a payment
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/customerpayments/payment_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/customerpayments/payment_id?api_token={api_token}
```
**Description**: Details of an existing payment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`payment_id` | string | No | Payment Id |
---
#### Delete a payment
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/customerpayments/payment_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/customerpayments/payment_id?api_token={api_token}
```
**Description**: Delete an existing payment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`payment_id` | string | No | Payment Id |
---
#### Refund an excess customer payment
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/customerpayments/customer_payment_id/refunds`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/customerpayments/customer_payment_id/refunds?api_token={api_token}
```
**Description**: Refund the excess amount paid by the customer
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`customer_payment_id` | string | No | Customer Payment Id |
**Request Body**:
```json
{
"date": "<string>",
"amount": "<number>",
"from_account_id": "<string>"
}
```
---
#### List refunds of a customer payment
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/customerpayments/customer_payment_id/refunds`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/customerpayments/customer_payment_id/refunds?api_token={api_token}
```
**Description**: List all the refunds pertaining to an existing customer payment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`customer_payment_id` | string | No | Customer Payment Id |
---
#### Update a refund
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/customerpayments/customer_payment_id/refunds/refund_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/customerpayments/customer_payment_id/refunds/refund_id?api_token={api_token}
```
**Description**: Update the refunded transaction
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`customer_payment_id` | string | No | Customer Payment Id |
**Request Body**:
```json
{
"date": "<string>",
"amount": "<number>",
"from_account_id": "<string>"
}
```
---
#### Details of a refund
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/customerpayments/customer_payment_id/refunds/refund_id a refund`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/customerpayments/customer_payment_id/refunds/refund_id a refund?api_token={api_token}
```
**Description**: Obtain details of a particular refund of a customer payment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`customer_payment_id` | string | No | Customer Payment Id |
---
#### Delete a Refund
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/customerpayments/customer_payment_id/refunds/refund_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/customerpayments/customer_payment_id/refunds/refund_id?api_token={api_token}
```
**Description**: Delete refund pertaining to an existing customer payment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`customer_payment_id` | string | No | Customer Payment Id |
---
### Category: Estimates
#### Create an Estimate
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/estimates`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates?api_token={api_token}
```
**Description**: Create an estimate for your customer
**Request Body**:
```json
{
"customer_id": "<string>"
}
```
---
#### List estimates
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/estimates`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates?estimate_number={estimate_number}&reference_number={reference_number}&customer_name={customer_name}&total={total}&customer_id={customer_id}&item_id={item_id}&item_description={item_description}&custom_field={custom_field}&expiry_date={expiry_date}&data={data}&status={status}&filter_by={filter_by}&search_text={search_text}&sort_column={sort_column}&zcrm_potential_id={zcrm_potential_id}&api_token={api_token}
```
**Description**: List all estimates with pagination.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`estimate_number` | string | No | Search estimates by estimate number |
|`reference_number` | string | No | Search estimates by reference number |
|`customer_name` | string | No | Search estimates by customer name |
|`total` | string | No | Search estimates by estimate total |
|`customer_id` | string | No | Search estimates by customer id. |
|`item_id` | string | No | ID of the item |
|`item_description` | string | No | Search estimates by item description |
|`custom_field` | string | No | Search estimates by custom field |
|`expiry_date` | string | No | The date of expiration of the estimates |
|`data` | string | No | Search estimates by estimate date |
|`status` | string | No | Search estimates by status |
|`filter_by` | string | No | Filter estimates by status |
|`search_text` | string | No | Search estimates by estimate number or reference or customer name |
|`sort_column` | string | No | Sort estimates |
|`zcrm_potential_id` | string | No | Potential ID of a Deal in CRM |
---
#### Update an Estimate
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/estimates/estimate_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates/estimate_id?api_token={api_token}
```
**Description**: Update an existing estimate
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`estimate_id` | string | No | Estimate Id |
---
#### Get an estimate
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/estimates/estimate_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates/estimate_id?print={print}&accept={accept}&api_token={api_token}
```
**Description**: Get the details of an estimate.
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`estimate_id` | string | No | Estimate Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`print` | string | No | Print the exported pdf |
|`accept` | string | No | Get the details of a particular estimate in formats such as json/ pdf/ html |
---
#### Delete an Estimate
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/estimates/estimate_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates/estimate_id?api_token={api_token}
```
**Description**: Delete an existing estimate
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`estimate_id` | string | No | Estimate Id |
---
#### Mark an estimate as sent
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/estimates/estimate_id/status/sent`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates/estimate_id/status/sent?api_token={api_token}
```
**Description**: Mark a draft estimate as sent
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`estimate_id` | string | No | Estimate Id |
---
#### Mark an estimate as accepted
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/estimates/estimate_id/status/accepted`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates/estimate_id/status/accepted?api_token={api_token}
```
**Description**: Mark a sent estimate as accepted if the customer has accepted it
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`estimate_id` | string | No | Estimate Id |
---
#### Mark an estimate as declined
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/estimates/estimate_id/status/declined`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates/estimate_id/status/declined?api_token={api_token}
```
**Description**: Mark a sent estimate as declined if the customer has rejected it
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`estimate_id` | string | No | Estimate Id |
---
#### Submit an estimate for approval
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/estimates/estimate_id/submit`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates/estimate_id/submit?api_token={api_token}
```
**Description**: Submit an estimate for approval
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`estimate_id` | string | No | Estimate Id |
---
#### Approve an estimate.
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/estimates/estimate_id/approve`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates/estimate_id/approve?api_token={api_token}
```
**Description**: Approve an estimate
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`estimate_id` | string | No | Estimate Id |
---
#### Email an estimate
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/estimates/estimate_id/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates/estimate_id/email?api_token={api_token}
```
**Description**: Email an estimate to the customer
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`estimate_id` | string | No | Estimate Id |
**Request Body**:
```json
{
"to_mail_ids": "<array>"
}
```
---
#### Get estimate email content
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/estimates/estimate_id/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates/estimate_id/email?email_template_id={email_template_id}&api_token={api_token}
```
**Description**: Get the email content of an estimate
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`estimate_id` | string | No | Estimate Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`email_template_id` | string | Yes | Get the email content based on a specific email template |
---
#### Email multiple estimates
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/estimates/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates/email?api_token={api_token}
```
**Description**: Send estimates to your customers by email
**Request Body**:
```json
{
"estimate_ids": "<string>"
}
```
---
#### Bulk export estimates
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/estimates/pdf`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates/pdf?estimate_ids={estimate_ids}&api_token={api_token}
```
**Description**: Maximum of 25 estimates can be exported in a single pdf
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`estimate_ids` | string | Yes | Comma separated estimate ids which are to be emailed |
---
#### Bulk print estimates
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/estimates/print`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/estimates/print?estimate_ids={estimate_ids}&api_token={api_token}
```
**Description**: Export estimates as pdf and print them
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`estimate_ids` | string | Yes | Comma separated estimate ids which are to be emailed |
---
*Note: Showing 15 of 23 endpoints in this category.*
---
### Category: Expenses
#### Create an Expense
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/expenses`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/expenses?api_token={api_token}
```
**Description**: Create billable or non-billable expense
**Request Body**:
```json
{
"account_id": "<string>",
"date": "<string>",
"amount": "<number>",
"paid_through_account_id": "<string>"
}
```
---
#### List Expenses
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/expenses`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/expenses?description={description}&reference_number={reference_number}&date={date}&status={status}&amount={amount}&account_name={account_name}&customer_name={customer_name}&vendor_name={vendor_name}&customer_id={customer_id}&vendor_id={vendor_id}&recurring_expense_id={recurring_expense_id}&paid_through_account_id={paid_through_account_id}&search_text={search_text}&sort_column={sort_column}&filter_by={filter_by}&api_token={api_token}
```
**Description**: List all the Expenses with pagination
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`description` | string | No | Search expenses by description |
|`reference_number` | string | No | Search expenses by reference number |
|`date` | string | No | Search expenses by expense date |
|`status` | string | No | Search expenses by expense status |
|`amount` | string | No | Search expenses by amount |
|`account_name` | string | No | Search expenses by expense account name |
|`customer_name` | string | No | Search expenses by customer name |
|`vendor_name` | string | No | Search expenses by vendor name |
|`customer_id` | string | No | ID of the expense account |
|`vendor_id` | string | No | ID of the vendor the expense is made |
|`recurring_expense_id` | string | No | Search expenses by recurring expense id |
|`paid_through_account_id` | string | No | Search expenses by paid through account id |
|`search_text` | string | No | Search expenses by account name or description |
|`sort_column` | string | No | Sort expenses |
|`filter_by` | string | No | Filter expenses by expense status |
---
#### Update an Expense
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/expenses/expense_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/expenses/expense_id?api_token={api_token}
```
**Description**: Update an existing Expense
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`expense_id` | string | No | Expense Id |
**Request Body**:
```json
{
"account_id": "<string>",
"date": "<string>",
"amount": "<number>",
"paid_through_account_id": "<string>"
}
```
---
#### Get an Expense
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/expenses/expense_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/expenses/expense_id?api_token={api_token}
```
**Description**: Get the details of the Expense
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`expense_id` | string | No | Expense Id |
---
#### Delete an Expense
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/expenses/expense_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/expenses/expense_id?api_token={api_token}
```
**Description**: Delete an existing expense
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`expense_id` | string | No | Expense Id |
---
#### List expense History & Comments
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/expenses/expense_id/comments`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/expenses/expense_id/comments?api_token={api_token}
```
**Description**: Get history and comments of expense
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`expense_id` | string | No | Expense Id |
---
#### Create an employee
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/employees`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/employees?api_token={api_token}
```
**Description**: Create an employee for an expense
**Request Body**:
```json
{
"name": "<string>",
"email": "<string>"
}
```
---
#### List employees
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/employees`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/employees?api_token={api_token}
```
**Description**: List employees with pagination
---
#### Get an employee
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/employees/employee_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/employees/employee_id?api_token={api_token}
```
**Description**: Get the details of the employee
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`expense_id` | string | No | Expense Id |
---
#### Delete an employee
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/employee/employee_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/employee/employee_id?api_token={api_token}
```
**Description**: Delete an existing employee
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`expense_id` | string | No | Expense Id |
---
#### Add receipt to an expense
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/expenses/expense_id/receipt`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/expenses/expense_id/receipt?api_token={api_token}
```
**Description**: Attach a receipt to an expens
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`expense_id` | string | No | Expense Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Get an expense receipt
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/expenses/expense_id/receipt`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/expenses/expense_id/receipt?preview={preview}&api_token={api_token}
```
**Description**: Returns the receipt attached to the expense
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`expense_id` | string | No | Expense Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`preview` | string | No | Get the thumbnail of the receip |
---
#### Delete a receipt
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/expenses/expense_id/receipt`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/expenses/expense_id/receipt?api_token={api_token}
```
**Description**: Delete the receipt attached to the expense
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`expense_id` | string | No | Expense Id |
---
### Category: Introduction
#### Organization ID
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/organizations`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/organizations?api_token={api_token}
```
**Description**: In Zoho Books, your business is termed as an organization
---
### Category: Invoices
#### Create an invoice
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/invoices`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices?api_token={api_token}
```
**Description**: Create an invoice for your customer
**Request Body**:
```json
{
"customer_id": "<string>",
"line_items": "<array>"
}
```
---
#### List invoices
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/invoices`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices?invoice_number={invoice_number}&item_name={item_name}&item_id={item_id}&item_description={item_description}&reference_number={reference_number}&customer_name={customer_name}&recurring_invoice_id={recurring_invoice_id}&email={email}&total={total}&balance={balance}&custom_field={custom_field}&date={date}&due_date={due_date}&last_modified_time={last_modified_time}&status={status}&customer_id={customer_id}&filter_by={filter_by}&search_text={search_text}&sort_column={sort_column}&Sort invoices={Sort invoices}&api_token={api_token}
```
**Description**: List all invoices with pagination
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_number` | string | No | Search invoices by invoice number |
|`item_name` | string | No | Search invoices by item name |
|`item_id` | string | No | Search invoices by item id |
|`item_description` | string | No | Search invoices by item description |
|`reference_number` | string | No | The reference number of the invoice |
|`customer_name` | string | No | The name of the customer |
|`recurring_invoice_id` | string | No | ID of the recurring invoice from which the invoice is created |
|`email` | string | No | Search contacts by email id |
|`total` | string | No | The total amount to be paid |
|`balance` | string | No | The unpaid amount |
|`custom_field` | string | No | Search invoices by custom fields |
|`date` | string | No | Search invoices by invoice date |
|`due_date` | string | No | Search invoices by due date |
|`last_modified_time` | string | No | Last modified time |
|`status` | string | No | Search invoices by invoice status |
|`customer_id` | string | No | ID of the customer the invoice has to be created |
|`filter_by` | string | No | Filter invoices by any status or payment expected date |
|`search_text` | string | No | Search invoices by invoice number or purchase order or customer name |
|`sort_column` | string | No | Sort invoices |
|`Sort invoices` | string | No | Potential ID of a Deal in CRM |
---
#### Update an invoice
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/invoices/invoice_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices/invoice_id?api_token={api_token}
```
**Description**: Update an existing invoice. To delete a line item just remove it from the line_items list
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | No | Invoice Id |
**Request Body**:
```json
{
"customer_id": "<string>",
"line_items": "<array>"
}
```
---
#### Get an invoice
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/invoices/invoice_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices/invoice_id?print={print}&accept={accept}&api_token={api_token}
```
**Description**: Get the details of an invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | No | Invoice Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`print` | string | No | Print the exported pdf |
|`accept` | string | No | Get the details of a particular invoice in formats such as json/ pdf/ html |
---
#### Delete an invoice
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/invoices/invoice_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices/invoice_id?api_token={api_token}
```
**Description**: Delete an existing invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | No | Invoice Id |
---
#### Mark an invoice as sent
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/invoices/invoice_id/status/sent`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices/invoice_id/status/sent?api_token={api_token}
```
**Description**: Mark a draft invoice as sent
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | No | Invoice Id |
---
#### Void an invoice
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/invoices/invoice_id/status/void`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices/invoice_id/status/void?api_token={api_token}
```
**Description**: Mark an invoice status as void
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | No | Invoice Id |
---
#### Mark as draft
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/invoices/invoice_id/status/draft`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices/invoice_id/status/draft?api_token={api_token}
```
**Description**: Mark a voided invoice as draft
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | No | Invoice Id |
---
#### Email invoices
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/invoices/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices/email?invoice_ids={invoice_ids}&api_token={api_token}
```
**Description**: Send invoices to your customers by email
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_ids` | string | Yes | Comma separated invoice ids which are to be emailed. |
**Request Body**:
```json
{
"contact_id": "<string>"
}
```
---
#### Submit an invoice for approval
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/invoices/invoice_id/submit`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices/invoice_id/submit?api_token={api_token}
```
**Description**: Submit an invoice for approval
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | No | Invoice Id |
---
#### Approve an invoice
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/invoices/invoice_id/approve`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices/invoice_id/approve?api_token={api_token}
```
**Description**: Approve an invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | No | Invoice Id |
---
#### Email an invoice
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/invoices/invoice_id/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices/invoice_id/email?api_token={api_token}
```
**Description**: Email an invoice to the customer
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | No | Invoice Id |
**Request Body**:
```json
{
"to_mail_ids": "<array>"
}
```
---
#### Get invoice email content
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/invoices/invoice_id/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices/invoice_id/email?email_template_id={email_template_id}&api_token={api_token}
```
**Description**: Get the email content of an invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | No | Invoice Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`email_template_id` | string | No | Get the email content based on a specific email template |
---
#### Remind Customer
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/invoices/invoice_id/paymentreminder`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices/invoice_id/paymentreminder?api_token={api_token}
```
**Description**: Remind your customer about an unpaid invoice by email
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | No | Invoice Id |
**Request Body**:
```json
{
"cc_mail_ids": "<array>"
}
```
---
#### Get payment reminder mail content
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/invoices/invoice_id/paymentreminder`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/invoices/invoice_id/paymentreminder?api_token={api_token}
```
**Description**: Get the mail content of the payment reminder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | No | Invoice Id |
---
*Note: Showing 15 of 40 endpoints in this category.*
---
### Category: Items
#### Create an Item
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/items`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/items?api_token={api_token}
```
**Description**: Create a new item
**Request Body**:
```json
{
"name": "<string>",
"rate": "<number>"
}
```
---
#### List items
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/items`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/items?name={name}&description={description}&rate={rate}&tax_id={tax_id}&tax_name={tax_name}&is_taxable={is_taxable}&tax_exemption_id={tax_exemption_id}&account_id={account_id}&filter_by={filter_by}&search_text={search_text}&sort_column={sort_column}&sat_item_key_code={sat_item_key_code}&unitkey_code={unitkey_code}&api_token={api_token}
```
**Description**: Get the list of all active items with pagination
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`name` | string | No | Search items by name |
|`description` | string | No | Search items by description |
|`rate` | string | No | Search items by rate |
|`tax_id` | string | No | Search items by tax id |
|`tax_name` | string | No | Tax name |
|`is_taxable` | string | No | Boolean to track the taxability of the item |
|`tax_exemption_id` | string | No | ID of the tax exemption |
|`account_id` | string | No | ID of the account to which the item has to be associated with |
|`filter_by` | string | No | Filter items by status |
|`search_text` | string | No | Search items by name or description |
|`sort_column` | string | No | Sort item |
|`sat_item_key_code` | string | No | SAT Item key code |
|`unitkey_code` | string | No | SAT Unit code |
---
#### Update an item
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/items/item_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/items/item_id?api_token={api_token}
```
**Description**: Update the details of an item
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`item_id` | string | No | Item Id |
**Request Body**:
```json
{
"name": "<string>",
"rate": "<number>"
}
```
---
#### Get an item
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/items/item_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/items/item_id?api_token={api_token}
```
**Description**: Details of an existing item
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`item_id` | string | No | Item Id |
---
#### Delete an item
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/items/item_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/items/item_id?api_token={api_token}
```
**Description**: Delete the item created.items that are part of transaction cannot be deleted
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`item_id` | string | No | Item Id |
---
#### Mark as active
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/items/item_id/active`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/items/item_id/active?api_token={api_token}
```
**Description**: Mark an inactive item as active
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`item_id` | string | No | Item Id |
---
#### Mark as inactive
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/items/item_id/inactive`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/items/item_id/inactive?api_token={api_token}
```
**Description**: Mark an active item as inactive
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`item_id` | string | No | Item Id |
---
### Category: Journals
#### Create a journal
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/journals`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/journals?api_token={api_token}
```
**Description**: Create a journal
**Request Body**:
```json
{
"journal_date": "<string>"
}
```
---
#### Get journal list
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/journals`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/journals?entry_number={entry_number}&reference_number={reference_number}&date={date}¬es={notes}&last_modified_time={last_modified_time}&total={total}&customer_id={customer_id}&vendor_id={vendor_id}&filter_by={filter_by}&sort_column={sort_column}&api_token={api_token}
```
**Description**: Get journal list
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`entry_number` | string | No | Search journals by journal entry number |
|`reference_number` | string | No | Search journals by journal reference numbe |
|`date` | string | No | Search journals by journal date |
|`notes` | string | No | Search journals by journal notes |
|`last_modified_time` | string | No | Search the journals using Last Modified Time |
|`total` | string | No | Search journals by journal total |
|`customer_id` | string | No | Search Journals using Customer ID |
|`vendor_id` | string | No | Search the journals using Vendor ID |
|`filter_by` | string | No | Filter journals by journal date |
|`sort_column` | string | No | Sort journal list |
---
#### Update a journal
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/journals/journal_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/journals/journal_id?api_token={api_token}
```
**Description**: Updates the journal with given information
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`journal_id` | string | No | Journal Id |
**Request Body**:
```json
{
"journal_date": "<string>"
}
```
---
#### Get journal
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/journals/journal_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/journals/journal_id?api_token={api_token}
```
**Description**: Get the details of the journa
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`journal_id` | string | No | Journal Id |
---
#### Delete a journal
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/journals/journal_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/journals/journal_id?api_token={api_token}
```
**Description**: Deletes the given journal
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`journal_id` | string | No | Journal Id |
---
#### Mark a journal as published
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/journals/journal_id/status/publish`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/journals/journal_id/status/publish?api_token={api_token}
```
**Description**: Mark a draft journal as published
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`journal_id` | string | No | Journal Id |
---
#### Add attachment to a journal
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/journals/journal_id/attachment`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/journals/journal_id/attachment?api_token={api_token}
```
**Description**: Attach a file to a journal
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`journal_id` | string | No | Journal Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Add comment
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/journals/jounral_id/comments`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/journals/jounral_id/comments?api_token={api_token}
```
**Description**: Add a comment for a journal
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`journal_id` | string | No | Journal Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Delete a comment
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/journals/jounral_id/comments/comment_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/journals/jounral_id/comments/comment_id?api_token={api_token}
```
**Description**: Delete a jounral comment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`journal_id` | string | No | Journal Id |
|`comment_id` | string | No | Comment Id |
---
### Category: Opening Balance
#### Create opening balance
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/settings/openingbalances`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/openingbalances?api_token={api_token}
```
**Description**: Creates opening balance with the given information
**Request Body**:
```json
{
"date": "<string>"
}
```
---
#### Update opening balance
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/settings/openingbalances`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/openingbalances?api_token={api_token}
```
**Description**: Updates the existing opening balance information
**Request Body**:
```json
{
"opening_balance_id": "<string>"
}
```
---
#### Get opening balance
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/settings/openingbalances`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/openingbalances?api_token={api_token}
```
**Description**: Get opening balance
---
#### Delete opening balance
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/settings/openingbalances`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/openingbalances?api_token={api_token}
```
**Description**: Delete the entered opening balance
---
### Category: Projects
#### Create a project
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/projects`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects?api_token={api_token}
```
**Description**: Create a project
**Request Body**:
```json
{
"project_name": "<string>",
"customer_id": "<string>",
"billing_type": "<string>",
"user_id": "<string>"
}
```
---
#### List projects
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/projects`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects?filter_by={filter_by}&customer_id={customer_id}&sort_column={sort_column}&api_token={api_token}
```
**Description**: List all projects with pagination
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter_by` | string | No | Filter projects by any status |
|`customer_id` | string | No | Search projects by customer id |
|`sort_column` | string | No | Sort projects |
---
#### Update project
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/projects/project_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id?api_token={api_token}
```
**Description**: Update details of a project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
**Request Body**:
```json
{
"project_name": "<string>",
"customer_id": "<string>",
"billing_type": "<string>",
"user_id": "<string>"
}
```
---
#### Get a project
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/projects/project_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id?api_token={api_token}
```
**Description**: Get the details of a project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
---
#### Delete project
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/projects/project_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id?api_token={api_token}
```
**Description**: Deleting a existing project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
---
#### Activate project
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/projects/project_id/active`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/active?api_token={api_token}
```
**Description**: Mark project as active
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
---
#### Inactivate a project
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/projects/project_id/inactive`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/inactive?api_token={api_token}
```
**Description**: Marking a project as inactive
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
---
#### Clone project
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/projects/project_id/clone`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/clone?api_token={api_token}
```
**Description**: Cloning a project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
**Request Body**:
```json
{
"project_name": "<string>"
}
```
---
#### Assign users
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/projects/project_id/users`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/users?api_token={api_token}
```
**Description**: Assign a users to a project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
**Request Body**:
```json
{
"cost_rate": "<double>"
}
```
---
#### List Users
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/projects/project_id/users`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/users?api_token={api_token}
```
**Description**: Get list of users associated with a project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
---
#### Invite user
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/projects/project_id/users/invite`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/users/invite?api_token={api_token}
```
**Description**: Invite and user to the project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
**Request Body**:
```json
{
"user_name": "<string>",
"email": "<string>"
}
```
---
#### Update user
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/projects/project_id/users/user_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/users/user_id?api_token={api_token}
```
**Description**: Update details of a user
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
|`user_id` | string | No | User Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Get a User
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/projects/project_id/users/user_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/users/user_id?api_token={api_token}
```
**Description**: Get details of a user in project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
|`user_id` | string | No | User Id |
---
#### Delete user
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/projects/project_id/users/user_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/users/user_id?api_token={api_token}
```
**Description**: Remove user from a project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
|`user_id` | string | No | User Id |
---
#### Post comment
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/projects/project_id/comments`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/comments?api_token={api_token}
```
**Description**: Post comment to a project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
**Request Body**:
```json
{
"description": "<string>"
}
```
---
*Note: Showing 15 of 18 endpoints in this category.*
---
### Category: Purchase Order
#### Create a purchase order
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/purchaseorders`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders?attachment={attachment}&ignore_auto_number_generation={ignore_auto_number_generation}&api_token={api_token}
```
**Description**: Create a purchase order for your vendor
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`attachment` | string | No | Allowed Extensions: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc and docx. |
|`ignore_auto_number_generation` | string | No | Ignore auto purchase order number generation for this purchase order number |
**Request Body**:
```json
{
"vendor_id": "<string>",
"line_items": "<array>"
}
```
---
#### List purchase orders
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/purchaseorders`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders?purchaseorder_number={purchaseorder_number}&reference_number={reference_number}&date={date}&status={status}&item_description={item_description}&vendor_name={vendor_name}&total={total}&vendor_id={vendor_id}&last_modified_time={last_modified_time}&item_id={item_id}&filter_by={filter_by}&search_text={search_text}&sort_column={sort_column}&custom_field={custom_field}&api_token={api_token}
```
**Description**: List all purchase orders
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchaseorder_number` | string | No | Search purchase order by purchase order number. Variants: purchaseorder_number.startswith and purchaseorder_number.contains |
|`reference_number` | string | No | Search purchase order by reference number. Variants: reference_number.startswith and reference_number.contains |
|`date` | string | No | The date the purchase order is created. |
|`status` | string | No | Search purchase order by purchase order status. Allowed Values: draft, open, billed and cancelled |
|`item_description` | string | No | Search purchase order by purchase order item description. Variants: item_description.startswith and item_description.contains |
|`vendor_name` | string | No | Search purchase order by vendor name. Variants: vendor_name.startswith and vendor_name.contains |
|`total` | string | No | Search purchase order by purchase order total. Variants: total.start, total.end, total.less_than, total.less_equals, total.greater_than and total.greater_equals |
|`vendor_id` | string | No | Search purchase order by vendor id. |
|`last_modified_time` | string | No | Search purchase order by last modified time. |
|`item_id` | string | No | Search purchase order by item id. |
|`filter_by` | string | No | Filter purchase order by any status. Allowed Values: Status.All, Status.Draft, Status.Open, Status.Billed and Status.Cancelled. |
|`search_text` | string | No | Search purchase order by purchase order number or reference number or vendor name. |
|`sort_column` | string | No | Sort purchase orders. Allowed Values: vendor_name, purchaseorder_number, date, delivery_date, total and created_time. |
|`custom_field` | string | No | Search purchase order by purchase order’s custom field. Variants: custom_field_startswith, custom_field_contains |
---
#### Update a purchase order
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/purchaseorders/purchase_order_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders/purchase_order_id?attachment={attachment}&ignore_auto_number_generation={ignore_auto_number_generation}&api_token={api_token}
```
**Description**: Update an existing purchase order
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchase_order_id` | string | No | Purchase Order Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`attachment` | string | No | Allowed Extensions : gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc and docx. |
|`ignore_auto_number_generation` | string | No | Ignore auto purchase order number generation for this purchase order number |
**Request Body**:
```json
{
"vendor_id": "<string>",
"line_items": "<array>"
}
```
---
#### Get a purchase order
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/purchaseorders/purchase_order_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders/purchase_order_id?print={print}&accept={accept}&api_token={api_token}
```
**Description**: Get the details of a purchase order
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchase_order_id` | string | No | Purchase Order Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`print` | string | No | Print the exported pdf |
|`accept` | string | No | Get the details of a particular purchase order in formats such as json/ pdf/ html |
---
#### Delete purchase order
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/purchaseorders/purchase_order_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders/purchase_order_id?api_token={api_token}
```
**Description**: Delete an existing purchase order
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchase_order_id` | string | No | Purchase Order Id |
---
#### Mark a purchase order as open
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/purchaseorders/purchaseorder_id/status/open`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders/purchaseorder_id/status/open?api_token={api_token}
```
**Description**: Mark a draft purchase order as open
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchase_order_id` | string | No | Purchase Order Id |
---
#### Mark as billed
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/purchaseorders/purchaseorder_id/status/billed`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders/purchaseorder_id/status/billed?api_token={api_token}
```
**Description**: Mark a purchase order as billed
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchase_order_id` | string | No | Purchase Order Id |
---
#### Cancel a purchase order
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/purchaseorders/purchaseorder_id/status/cancelled`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders/purchaseorder_id/status/cancelled?api_token={api_token}
```
**Description**: Mark a purchase order as cancelled
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchase_order_id` | string | No | Purchase Order Id |
---
#### Submit a purchase order for approval
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/purchaseorders/purchaseorder_id/submit`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders/purchaseorder_id/submit?api_token={api_token}
```
**Description**: Submit a purchase order for approval
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchase_order_id` | string | No | Purchase Order Id |
---
#### Approve a purchase order
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/purchaseorders/purchaseorder_id/approve`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders/purchaseorder_id/approve?api_token={api_token}
```
**Description**: Approve a purchase order
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchase_order_id` | string | No | Purchase Order Id |
---
#### Email a purchase order
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/purchaseorders/purchaseorder_id/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders/purchaseorder_id/email?attachments={attachments}&send_attachment={send_attachment}&file_name={file_name}&api_token={api_token}
```
**Description**: Email a purchase order to the vendor. Input json string is not mandatory
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchase_order_id` | string | No | Purchase Order Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`attachments` | file | No | The files to be attached with the email. |
|`send_attachment` | file | No | Send the purchase order attachment a with the email. |
|`file_name` | string | No | Name of the file. |
**Request Body**:
```json
{
"to_mail_ids": "<array>",
"body": "<string>"
}
```
---
#### Get purchase order email content
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/purchaseorders/purchaseorder_id/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders/purchaseorder_id/email?email_template_id={email_template_id}&api_token={api_token}
```
**Description**: Get the email content of a purchase order
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchase_order_id` | string | No | Purchase Order Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`email_template_id` | string | No | Get the email content based on a specific email template |
---
#### Update billing address
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/purchaseorders/purchaseorder_id/address/billing`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders/purchaseorder_id/address/billing?api_token={api_token}
```
**Description**: Updates the billing address for this purchase order alone
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchase_order_id` | string | No | Purchase Order Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### List purchase order templates
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/purchaseorders/templates`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders/templates?api_token={api_token}
```
**Description**: Get all purchase order pdf templates
---
#### Update purchase order template
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/purchaseorders/purchaseorder_id/templates/template_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/purchaseorders/purchaseorder_id/templates/template_id?api_token={api_token}
```
**Description**: Update the pdf template associated with the purchase order
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchase_order_id` | string | No | Purchase Order Id |
|`template_id` | string | No | Template Id |
---
*Note: Showing 15 of 23 endpoints in this category.*
---
### Category: Recurring Bills
#### Create a recurring bill
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/recurringbills`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringbills?api_token={api_token}
```
**Description**: Create a recurring bill
**Request Body**:
```json
{
"vendor_id": "<string>",
"recurrence_name": "<string>",
"start_date": "<string>",
"repeat_every": "<string>",
"recurrence_frequency": "<string>"
}
```
---
#### List recurring bills
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/recurringbills`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringbills?recurring_bill_id={recurring_bill_id}&vendor_id={vendor_id}&vendor_name={vendor_name}&status={status}&recurrence_name={recurrence_name}¤cy_id={currency_id}¤cy_code={currency_code}¤cy_symbol={currency_symbol}&start_date={start_date}&end_date={end_date}&source_of_supply={source_of_supply}&place_of_supply={place_of_supply}&destination_of_supply={destination_of_supply}&gst_treatment={gst_treatment}&gst_no={gst_no}&tax_treatment={tax_treatment}&vat_treatment={vat_treatment}&vat_reg_no={vat_reg_no}&is_abn_quoted={is_abn_quoted}&abn={abn}&is_reverse_charge_applied={is_reverse_charge_applied}&pricebook_id={pricebook_id}&pricebook_name={pricebook_name}&is_inclusive_tax={is_inclusive_tax}&is_tds_applied={is_tds_applied}¬es={notes}&terms={terms}&payment_terms={payment_terms}&payment_terms_label={payment_terms_label}&acquisition_vat_total={acquisition_vat_total}&reverse_charge_vat_total={reverse_charge_vat_total}&created_time={created_time}&created_by_id={created_by_id}&last_modified_time={last_modified_time}&discount={discount}&discount_account_id={discount_account_id}&is_discount_before_tax={is_discount_before_tax}&api_token={api_token}
```
**Description**: List all recurring bills with pagination
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_bill_id` | string | No | Recurring bill id |
|`vendor_id` | string | No | Search recurring bills by Vendor ID |
|`vendor_name` | string | No | Search recurring bills by vendor name. Variants: vendor_name_startswith and vendor_name_contains |
|`status` | string | No | Search recurring bills by recurring bill status. Allowed Values: active, stopped, expired |
|`recurrence_name` | string | No | Search recurring bills by recurrence number. Variants: recurrence_name_startswith and recurrence_name_contains |
|`currency_id` | string | No | ID of the Currency |
|`currency_code` | string | No | Code of the Currency |
|`currency_symbol` | string | No | Symbol of the Currency |
|`start_date` | string | No | Search recurring bills by recurring bill start date |
|`end_date` | string | No | Date on which recurring bill has to expire. Can be left as empty to run forever. Format [yyyy-mm-dd]. |
|`source_of_supply` | string | No | Place from where the goods/services are supplied |
|`place_of_supply` | string | No | The place of supply is where a transaction is considered. Supported codes for UAE emirates are : Abu Dhabi - AB, Ajman - AJ, Dubai - DU, Fujairah - FU, Ras al-Khaimah - RA, Sharjah - SH, Umm al-Quwain - UM. Supported codes for the GCC countries are : United Arab Emirates - AE, Saudi Arabia - SA, Bahrain - BH, Kuwait - KW, Oman - OM, Qatar - QA. |
|`destination_of_supply` | string | No | Place where the goods/services are supplied to. (If not given, organisation's home state will be taken) |
|`gst_treatment` | string | No | Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer. |
|`gst_no` | string | No | 15 digit GST identification number of the vendor |
|`tax_treatment` | string | No | VAT treatment for the bill.Choose whether the vendor falls under: vat_registered,vat_not_registered,gcc_vat_not_registered,gcc_vat_registered,non_gcc. dz_vat_registered and dz_vat_not_registered are supported only for UAE. |
|`vat_treatment` | string | No | (Optional) VAT treatment for the bill. VAT treatment denotes the location of the vendor, if the vendor resides in UK then the VAT treatment is uk. If the vendor is in an EU country & VAT registered, you are resides in Northen Ireland and purchasing Goods then his VAT treatment is eu_vat_registered and if he resides outside the UK then his VAT treatment is overseas(For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu). |
|`vat_reg_no` | string | No | For UK Edition: VAT Registration number of a contact with length should be between 2 and 12 characters. For Avalara: If you are doing sales in the European Union (EU) then provide VAT Registration Number of your customers here. This is used to calculate VAT for B2B sales, from Avalara. |
|`is_abn_quoted` | string | No | Is abn quoted. |
|`abn` | string | No | Abn. |
|`is_reverse_charge_applied` | string | No | Applicable for transactions where you pay reverse charge. |
|`pricebook_id` | string | No | Enter ID of the price book |
|`pricebook_name` | string | No | Name of the price book |
|`is_inclusive_tax` | string | No | Used to specify whether the line item rates are inclusive or exclusive of tax |
|`is_tds_applied` | string | No | Check if TDS is applied. |
|`notes` | string | No | Notes for the Bill |
|`terms` | string | No | Terms and Conditions for the Bill |
|`payment_terms` | string | No | Number Referring to Payment Terms |
|`payment_terms_label` | string | No | Label the Payment Terms |
|`acquisition_vat_total` | string | No | Total of the VAT Acquistion. |
|`reverse_charge_vat_total` | string | No | Total of the Reverse Charge. |
|`created_time` | string | No | Created time of the bill |
|`created_by_id` | string | No | Name of User who created the Bill |
|`last_modified_time` | string | No | Last Modified Time of the Bill |
|`discount` | string | No | Discount applied to the recurrence |
|`discount_account_id` | string | No | ID of the account associated with the discount account |
|`is_discount_before_tax` | string | No | To specify discount applied in before /after tax |
---
#### Update a recurring bill
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/recurringbills/recurring_bill_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringbills/recurring_bill_id?api_token={api_token}
```
**Description**: Update a recurring bill. To delete a line item just remove it from the line_items list
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_bill_id` | string | No | Recurring Id |
**Request Body**:
```json
{
"vendor_id": "<string>",
"recurrence_name": "<string>",
"start_date": "<string>",
"repeat_every": "<string>",
"recurrence_frequency": "<string>"
}
```
---
#### Get a recurring bill
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/recurring_bills/recurring_bill_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurring_bills/recurring_bill_id?api_token={api_token}
```
**Description**: Get the details of a recurring bill.
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_bill_id` | string | No | Recurring Id |
---
#### Delete a recurring bill
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/recurring_bills/recurring_bill_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurring_bills/recurring_bill_id?api_token={api_token}
```
**Description**: Delete an existing recurring bill
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_bill_id` | string | No | Recurring Id |
---
#### Stop a recurring bill
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/recurringbills/recurring_bill_id/status/stop`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringbills/recurring_bill_id/status/stop?api_token={api_token}
```
**Description**: Stop an active recurring bill
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_bill_id` | string | No | Recurring Id |
---
#### Resume a recurring Bill
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/recurringbills/recurring_bill_id/status/resume`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringbills/recurring_bill_id/status/resume?api_token={api_token}
```
**Description**: Resume a stopped recurring bill
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_bill_id` | string | No | Recurring Id |
---
#### List recurring bill history
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/recurringbills/recurring_bill_id/comments`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringbills/recurring_bill_id/comments?api_token={api_token}
```
**Description**: Get history and comments of a recurring bill
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_bill_id` | string | No | Recurring Id |
---
### Category: Recurring Expenses
#### Create a recurring expense
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/recurringexpenses`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringexpenses?api_token={api_token}
```
**Description**: Create a recurring expense
**Request Body**:
```json
{
"account_id": "<string>",
"recurrence_name": "<string>",
"start_date": "<string>",
"recurrence_frequency": "<string>",
"repeat_every": "<string>",
"amount": "<number>"
}
```
---
#### List recurring expenses
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/recurringexpenses`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringexpenses?recurrence_name={recurrence_name}&last_created_date={last_created_date}&next_expense_date={next_expense_date}&status={status}&account_id={account_id}&account_name={account_name}&amount={amount}&customer_name={customer_name}&customer_id={customer_id}&paid_through_account_id={paid_through_account_id}&ilter_by={ilter_by}&search_text={search_text}&sort_column={sort_column}&api_token={api_token}
```
**Description**: List all the Expenses with pagination
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurrence_name` | string | No | Search recurring expenses by recurring expense name |
|`last_created_date` | string | No | Search recurring expenses by date on when last expense was generated |
|`next_expense_date` | string | No | Search recurring expenses by date on which next expense will be generated |
|`status` | string | No | Search expenses by expense status |
|`account_id` | string | No | Account id |
|`account_name` | string | No | Search expenses by expense account name |
|`amount` | string | No | Search expenses by amount |
|`customer_name` | string | No | Search expenses by customer name |
|`customer_id` | string | No | Search expenses by customer id |
|`paid_through_account_id` | string | No | Search expenses by paid through account id |
|`ilter_by` | string | No | Filter expenses by expense status |
|`search_text` | string | No | Search expenses by account name or description |
|`sort_column` | string | No | Sort expenses |
---
#### Update a recurring expense
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/recurringexpenses/recurring_expense_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringexpenses/recurring_expense_id?api_token={api_token}
```
**Description**: Update a recurring expense
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_expense_id` | string | No | Recurring Expense Id |
**Request Body**:
```json
{
"recurrence_name": "<string>",
"start_date": "<string>",
"repeat_every": "<string>",
"amount": "<number>"
}
```
---
#### Get a recurring expense
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/recurringexpenses/recurring_expense_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringexpenses/recurring_expense_id?api_token={api_token}
```
**Description**: Get the details of the recurring expense
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_expense_id` | string | No | Recurring Expense Id |
---
#### Delete a recurring expense
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/recurringexpenses/recurring_expense_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringexpenses/recurring_expense_id?api_token={api_token}
```
**Description**: Deleting an existing recurring expense
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_expense_id` | string | No | Recurring Expense Id |
---
#### Stop a recurring expense
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/recurringexpenses/recurring_expense_id/status/stop`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringexpenses/recurring_expense_id/status/stop?api_token={api_token}
```
**Description**: Stop an active recurring expense
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_expense_id` | string | No | Recurring Expense Id |
---
#### Resume a recurring Expense
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/recurringexpenses/recurring_expense_id/status/resume`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringexpenses/recurring_expense_id/status/resume?api_token={api_token}
```
**Description**: Resume a stopped recurring expense
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_expense_id` | string | No | Recurring Expense Id |
---
#### List child expenses created
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/recurringexpenses/recurring_expense_id/expenses`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringexpenses/recurring_expense_id/expenses?sort_column={sort_column}&api_token={api_token}
```
**Description**: List child expenses created from recurring expense
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_expense_id` | string | No | Recurring Expense Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`sort_column` | string | No | Sort expenses |
---
#### List recurring expense history
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/recurringexpenses/recurring_expense_id/comments`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringexpenses/recurring_expense_id/comments?api_token={api_token}
```
**Description**: Get history and comments of a recurring expense
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_expense_id` | string | No | Recurring Expense Id |
---
### Category: Recurring Invoices
#### Create a Recurring Invoice
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/recurringinvoices`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringinvoices?api_token={api_token}
```
**Description**: Creating a new recurring invoice
**Request Body**:
```json
{
"recurrence_frequency": "<string>"
}
```
---
#### List all Recurring Invoice
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/recurringinvoices`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurringinvoices?recurrence_name={recurrence_name}&item_name={item_name}&item_description={item_description}&customer_name={customer_name}&line_item_id={line_item_id}&item_id={item_id}&tax_id={tax_id}¬es={notes}&start_date={start_date}&end_date={end_date}&status={status}&filter_by={filter_by}&search_text={search_text}&sort_column={sort_column}&api_token={api_token}
```
**Description**: List the details of all recurring invoice
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurrence_name` | string | No | Unique name for the recurring profile given by the user |
|`item_name` | string | No | Search recurring invoices by item name |
|`item_description` | string | No | Search recurring invoices by item description |
|`customer_name` | string | No | Name of the customer to whom the recurring invoice is raised |
|`line_item_id` | array | No | The line item id |
|`item_id` | string | No | Unique string generated for the item for which invoice is to be sent |
|`tax_id` | string | No | ID of the tax or tax group associated to the recurring invoice |
|`notes` | string | No | A short note for the recurring invoice |
|`start_date` | string | No | The date on which the recurring invoice starts |
|`end_date` | string | No | Customer ID of the customer for whom the recurring invoice is raised |
|`status` | string | No | Status of the recurring invoice |
|`filter_by` | string | No | Filter Recurring invoices by any status or payment expected date |
|`search_text` | string | No | Search invoices by invoice number or purchase order or customer name |
|`sort_column` | string | No | Sort column |
---
#### Update Recurring Invoice
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/recurring_invoice_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurring_invoice_id?api_token={api_token}
```
**Description**: Update the recurring invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_invoice_id` | string | No | Recurring Invoice Id |
**Request Body**:
```json
{
"recurrence_frequency": "<string>"
}
```
---
#### Get a Recurring Invoice
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/recurring_invoice_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurring_invoice_id?api_token={api_token}
```
**Description**: Get the details of a recurring invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_invoice_id` | string | No | Recurring Invoice Id |
---
#### Delete a Recurring Invoice
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/recurring_invoice_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurring_invoice_id?api_token={api_token}
```
**Description**: Delete an existing recurring invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_invoice_id` | string | No | Recurring Invoice Id |
---
#### Stop a Recurring Invoice
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/recurring_invoice_id/status/stop`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurring_invoice_id/status/stop?api_token={api_token}
```
**Description**: Stop an active recurring invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_invoice_id` | string | No | Recurring Invoice Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Resume a Recurring Invoice
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/recurring_invoice_id/status/resume`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurring_invoice_id/status/resume?api_token={api_token}
```
**Description**: Resume a stopped recurring invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_invoice_id` | string | No | Recurring Invoice Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Update Recurring Invoice template
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/recurring_invoice_id/templates/template_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurring_invoice_id/templates/template_id?api_token={api_token}
```
**Description**: Update the pdf template associated with the recurring invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_invoice_id` | string | No | Recurring Invoice Id |
|`template_id` | string | No | Template Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### List Recurring Invoice History
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/recurring_invoice_id/comments`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/recurring_invoice_id/comments?api_token={api_token}
```
**Description**: Get the complete history and comments of a recurring invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`recurring_invoice_id` | string | No | Recurring Invoice Id |
---
### Category: Retainer Invoices
#### Create a retainerinvoice
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/retainerinvoices`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices?api_token={api_token}
```
**Description**: Create a retainer invoice for your customer
**Request Body**:
```json
{
"customer_id": "<string>",
"line_items": "<array>"
}
```
---
#### List a retainer invoices
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/retainerinvoices`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices?print={print}&sort_column={sort_column}&filter_by={filter_by}&sort_order={sort_order}&page={page}&api_token={api_token}
```
**Description**: List all retainer invoices with pagination
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`print` | string | No | Print the exported pdf |
|`sort_column` | string | No | Sort retainer invoices |
|`filter_by` | string | No | Filter invoices by any status or payment expected date |
|`sort_order` | string | No | The order for sorting |
|`page` | string | No | Number of pages |
---
#### update a retainerinvoice
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/retainerinvoices/retainerinvoice_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices/retainerinvoice_id?customer_id={customer_id}&reference_number={reference_number}&date={date}&contact_persons={contact_persons}&custom_fields={custom_fields}¬es={notes}&terms={terms}&line_items={line_items}&payment_options={payment_options}&place_of_supply={place_of_supply}&project_id={project_id}&api_token={api_token}
```
**Description**: Update an existing invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | No | Retainerinvoice Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`customer_id` | string | Yes | ID of the customer the retainer invoice has to be created |
|`reference_number` | string | No | The reference number of the retainer invoice |
|`date` | string | No | The date of creation of the retainer invoice |
|`contact_persons` | array | No | Contact persons |
|`custom_fields` | array | No | Custom fields for a reatiner invoice |
|`notes` | string | No | The notes added below expressing gratitude or for conveying some information |
|`terms` | string | No | The terms added below expressing gratitude or for conveying some information |
|`line_items` | array | Yes | Line items of a retainer invoice |
|`payment_options` | string | No | ID of the pdf template associated with the retainer invoice |
|`place_of_supply` | string | No | Place where the goods/services are supplied to |
|`project_id` | string | No | ID of the project |
---
#### Get a retainer invoice
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/retainerinvoices/retainerinvoice_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices/retainerinvoice_id?api_token={api_token}
```
**Description**: Get the details of a retainer invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | No | Retainerinvoice Id |
---
#### Delete a retainer invoice
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/retainerinvoices/retainerinvoice_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices/retainerinvoice_id?api_token={api_token}
```
**Description**: Delete an existing retainer invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | No | Retainerinvoice Id |
---
#### Mark a retainer invoice as sent
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/retainerinvoices/retainerinvoice_id/status/sent`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices/retainerinvoice_id/status/sent?api_token={api_token}
```
**Description**: Mark a draft retainer invoice as sent
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | No | Retainerinvoice Id |
---
#### Update retainer invoice template
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/retainerinvoices/retainerinvoice_id/templates/template_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices/retainerinvoice_id/templates/template_id?api_token={api_token}
```
**Description**: Update the pdf template associated with the retainer invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | No | Retainerinvoice Id |
---
#### Void a retainer invoice
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/retainerinvoices/retainerinvoice_id/status/void`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices/retainerinvoice_id/status/void?api_token={api_token}
```
**Description**: Mark an invoice status as void
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | No | Retainerinvoice Id |
---
#### Mark as draft
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/retainerinvoices/reatinerinvoice_id/status/draft`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices/reatinerinvoice_id/status/draft?api_token={api_token}
```
**Description**: Mark a voided retainer invoice as draft
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | No | Retainerinvoice Id |
---
#### Submit a retainer invoice for approval
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/retainerinvoices/reatinerinvoice_id/submit`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices/reatinerinvoice_id/submit?api_token={api_token}
```
**Description**: Submit a retainer invoice for approval
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | No | Retainerinvoice Id |
---
#### Approve a retainer invoice.
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/retainerinvoices/reatinerinvoice_id/approve`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices/reatinerinvoice_id/approve?api_token={api_token}
```
**Description**: Approve a retainer invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | No | Retainerinvoice Id |
---
#### Email a retainer invoice
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/retainerinvoices/retainerinvoice_id/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices/retainerinvoice_id/email?api_token={api_token}
```
**Description**: Email a retainer invoice to the customer
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | No | Retainerinvoice Id |
**Request Body**:
```json
{
"to_mail_ids": "<array>"
}
```
---
#### Get retainer invoice email content
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/retainerinvoices/retainerinvoice_id/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices/retainerinvoice_id/email?api_token={api_token}
```
**Description**: Get the email content of a retainer invoice
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | No | Retainerinvoice Id |
---
#### Update billing address
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/retainerinvoices/retainerinvoice_id/address/billing`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices/retainerinvoice_id/address/billing?api_token={api_token}
```
**Description**: Updates the billing address for this retainer invoice alone.
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | No | Retainerinvoice Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### List retainer invoice templates
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/retainerinvoices/templates`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/retainerinvoices/templates?api_token={api_token}
```
**Description**: Get all retainer invoice pdf templates
---
*Note: Showing 15 of 22 endpoints in this category.*
---
### Category: Sales Order
#### Create a sales order
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/salesorders`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders?api_token={api_token}
```
**Description**: Create a sales order for your customer
**Request Body**:
```json
{
"customer_id": "<string>"
}
```
---
#### List sales orders
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/salesorders`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders?sort_column={sort_column}&search_text={search_text}&filter_by={filter_by}&salesorder_number={salesorder_number}&item_name={item_name}&item_id={item_id}&item_description={item_description}&reference_number={reference_number}&customer_name={customer_name}&total={total}&date={date}&shipment_date={shipment_date}&status={status}&customer_id={customer_id}&salesperson_id={salesperson_id}&salesorder_ids={salesorder_ids}&last_modified_time={last_modified_time}&accept={accept}&print={print}&customview_id={customview_id}&zcrm_potential_id={zcrm_potential_id}&api_token={api_token}
```
**Description**: List all sales orders
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`sort_column` | string | No | Sort sales orders |
|`search_text` | string | No | Search sales order by sales order number or reference number or customer name |
|`filter_by` | string | No | Filter sales order by status |
|`salesorder_number` | string | No | Search Sales Order by Sales Order Number |
|`item_name` | string | No | Search sales order by item name |
|`item_id` | string | No | Search Sales Order Based on Item ID |
|`item_description` | string | No | Search sales order by item description |
|`reference_number` | string | No | Search sales order by reference number |
|`customer_name` | string | No | Search sales order by customer name |
|`total` | string | No | Search sales order by sales order total |
|`date` | string | No | Search sales order by sales order date |
|`shipment_date` | string | No | Search sales order by sales order shipment date |
|`status` | string | No | Search sales order by sales order status |
|`customer_id` | string | No | Search Sales Order based on customer_id |
|`salesperson_id` | string | No | ID of the salesperson |
|`salesorder_ids` | string | No | ID's of the salesorder [Comma seperated values] |
|`last_modified_time` | string | No | Last Modified time of the Sales Order |
|`accept` | string | No | Get the details of a particular sales order in formats such as json/ pdf/ html |
|`print` | string | No | Print the exported pdf |
|`customview_id` | string | No | ID of the customview |
|`zcrm_potential_id` | string | No | Potential ID of a Deal in CRM |
---
#### Update a sales order
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/salesorders/salesorder_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders/salesorder_id?api_token={api_token}
```
**Description**: Update an existing sales order
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | No | Salesorder Id |
**Request Body**:
```json
{
"customer_id": "<string>"
}
```
---
#### Get a sales order
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/salesorders/salesorder_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders/salesorder_id?print={print}&accept={accept}&api_token={api_token}
```
**Description**: Get the details of a sales order
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | No | Salesorder Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`print` | string | No | Print the exported pdf |
|`accept` | string | No | Get the details of a particular sales order in formats such as json/ pdf/ html |
---
#### Delete a sales order
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/salesorders/salesorder_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders/salesorder_id?api_token={api_token}
```
**Description**: Delete an existing sales orde
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | No | Salesorder Id |
---
#### Mark a sales order as open
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/salesorders/salesorder_id/status/open`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders/salesorder_id/status/open?api_token={api_token}
```
**Description**: Mark a draft sales order as open
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | No | Salesorder Id |
---
#### Mark a sales order as void
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/salesorders/salesorder_id/status/void`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders/salesorder_id/status/void?api_token={api_token}
```
**Description**: Mark a sales order as void
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | No | Salesorder Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Update a sales order sub status
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/salesorders/salesorder_id/substatus/status_code`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders/salesorder_id/substatus/status_code?api_token={api_token}
```
**Description**: Update a sales order sub status
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | No | Salesorder Id |
|`status_code` | string | No | Status Code |
---
#### Email a sales order
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/salesorders/salesorder_id/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders/salesorder_id/email?api_token={api_token}
```
**Description**: Email a sales order to the customer
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | No | Salesorder Id |
**Request Body**:
```json
{
"from_address_id": "<string>",
"to_mail_ids": "<array>",
"subject": "<string>",
"body": "<string>"
}
```
---
#### Get sales order email content
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/salesorders/salesorder_id/email`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders/salesorder_id/email?email_template_id={email_template_id}&api_token={api_token}
```
**Description**: Get the email content of a sales order
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | No | Salesorder Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`email_template_id` | string | No | Get the email content based on a specific email template |
---
#### Submit a sales order for approval
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/salesorders/salesorder_id/submit`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders/salesorder_id/submit?api_token={api_token}
```
**Description**: Submit a sales order for approval
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | No | Salesorder Id |
---
#### Approve a sales order.
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/salesorders/salesorder_id/approve`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders/salesorder_id/approve?api_token={api_token}
```
**Description**: Approve a sales order
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | No | Salesorder Id |
---
#### Bulk export sales orders
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/salesorders/pdf`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders/pdf?api_token={api_token}
```
**Description**: Maximum of 25 sales orders can be exported in a single pdf
---
#### Bulk print sales orders
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/salesorders/print`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders/print?api_token={api_token}
```
**Description**: Export sales orders as pdf and print them
---
#### Update billing address
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/salesorders/salesorder_id/address/billing`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/salesorders/salesorder_id/address/billing?api_token={api_token}
```
**Description**: Updates the billing address for this sales order alone
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | No | Salesorder Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
*Note: Showing 15 of 26 endpoints in this category.*
---
### Category: Tasks
#### Add a task
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/projects/project_id/tasks`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/tasks?api_token={api_token}
```
**Description**: The task has been added
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
**Request Body**:
```json
{
"task_name": "<string>"
}
```
---
#### List tasks
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/projects/project_id/tasks`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/tasks?api_token={api_token}
```
**Description**: Get list of tasks added to a project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
---
#### Update a task
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/projects/project_id/tasks/task_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/tasks/task_id?api_token={api_token}
```
**Description**: Update the details of a task
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
|`task_id` | string | No | Task Id |
**Request Body**:
```json
{
"task_name": "<string>"
}
```
---
#### Get a task
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/projects/project_id/tasks/task_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/tasks/task_id?api_token={api_token}
```
**Description**: Get the details of a task
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
|`task_id` | string | No | Task Id |
---
#### Delete a task added to a project
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/projects/project_id/tasks/task_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/project_id/tasks/task_id?api_token={api_token}
```
**Description**: Delete a task added to a project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`project_id` | string | No | Project Id |
|`task_id` | string | No | Task Id |
---
### Category: Taxes
#### Create a tax
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/settings/taxes`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxes?api_token={api_token}
```
**Description**: Create a tax which can be associated with an item
**Request Body**:
```json
{
"key": "value"
}
```
---
#### List taxes
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/settings/taxes`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxes?api_token={api_token}
```
**Description**: List of simple and compound taxes with pagination
---
#### Update a tax
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/settings/taxes/tax_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxes/tax_id?api_token={api_token}
```
**Description**: Update the details of a simple or compound tax
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`tax_id` | string | No | Tax Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Get a tax
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/settings/taxes/tax_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxes/tax_id?api_token={api_token}
```
**Description**: Get the details of a simple or compound tax
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`tax_id` | string | No | Tax Id |
---
#### Delete a tax
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/settings/taxes/tax_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxes/tax_id?api_token={api_token}
```
**Description**: Delete a simple or compound tax
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`tax_id` | string | No | Tax Id |
---
#### Update a tax group
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/settings/taxgroups/tax_group_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxgroups/tax_group_id?api_token={api_token}
```
**Description**: Update the details of the tax group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`tax_group_id` | string | No | Tax Group Id |
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Get a tax group
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/settings/taxgroups/tax_group_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxgroups/tax_group_id?api_token={api_token}
```
**Description**: Get the details of a tax group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`tax_group_id` | string | No | Tax Group Id |
---
#### Delete a tax group
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/settings/taxgroups/tax_group_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxgroups/tax_group_id?api_token={api_token}
```
**Description**: Delete a tax group. Tax group that is associated to transactions cannot be deleted
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`tax_group_id` | string | No | Tax Group Id |
---
#### Create a tax group
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/settings/taxgroups`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxgroups?api_token={api_token}
```
**Description**: Create a tax group associating multiple taxes
**Request Body**:
```json
{
"key": "value"
}
```
---
#### Create a tax authority [US and CA Edition only]
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/settings/taxauthorities`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxauthorities?api_token={api_token}
```
**Description**: Create a tax authority
**Request Body**:
```json
{
"tax_authority_name": "<string>"
}
```
---
#### List tax authorities [US Edition only]
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/settings/taxauthorities`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxauthorities?api_token={api_token}
```
**Description**: List of tax authorities
---
#### Update a tax authority [US and CA Edition only]
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/settings/taxauthorities/tax_authority_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxauthorities/tax_authority_id?api_token={api_token}
```
**Description**: Update the details of a tax authority
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`tax_authority_id` | string | No | Tax Authority Id |
**Request Body**:
```json
{
"tax_authority_name": "<string>"
}
```
---
#### Get a tax authority [US and CA Edition only]
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/settings/taxauthorities/tax_authority_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxauthorities/tax_authority_id?api_token={api_token}
```
**Description**: Get the details of a tax authority
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`tax_authority_id` | string | No | Tax Authority Id |
---
#### Delete a tax authority [US and CA Edition only]
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/settings/taxauthorities/tax_authority_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxauthorities/tax_authority_id?api_token={api_token}
```
**Description**: Delete a tax authority
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`tax_authority_id` | string | No | Tax Authority Id |
---
#### Create a tax exemption [US Edition only]
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/settings/taxexemptions`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/settings/taxexemptions?api_token={api_token}
```
**Description**: Create a tax exemption
**Request Body**:
```json
{
"tax_exemption_code": "<string>",
"type": "<string>"
}
```
---
*Note: Showing 15 of 19 endpoints in this category.*
---
### Category: Time Entries
#### Log time entries
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/projects/timeentries`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/timeentries?api_token={api_token}
```
**Description**: Logging time entries
**Request Body**:
```json
{
"project_id": "<string>",
"task_id": "<string>",
"user_id": "<string>",
"log_date": "<string>"
}
```
---
#### List time entries
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/projects/timeentries`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/timeentries?from_date={from_date}&to_date={to_date}&filter_by={filter_by}&project_id={project_id}&user_id={user_id}&sort_column={sort_column}&api_token={api_token}
```
**Description**: List all time entries with pagination
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from_date` | string | No | Date from which the time entries logged to be fetched |
|`to_date` | string | No | Date up to which the time entries logged to be fetched |
|`filter_by` | string | No | Filter time entries by date and status |
|`project_id` | string | No | Search time entries by project_id |
|`user_id` | string | No | Search time entries by user_id |
|`sort_column` | string | No | Sort time entries |
---
#### Delete time entries
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/projects/timeentries`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/timeentries?api_token={api_token}
```
**Description**: Deleting time entries
---
#### Update time entry
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/projects/timeentries/time_entry_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/timeentries/time_entry_id?api_token={api_token}
```
**Description**: Update logged time entry
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`time_entry_id` | string | No | Time Entry Id |
**Request Body**:
```json
{
"project_id": "<string>",
"task_id": "<string>",
"user_id": "<string>",
"log_date": "<string>"
}
```
---
#### Get a time entry
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/projects/timeentries/time_entry_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/timeentries/time_entry_id?api_token={api_token}
```
**Description**: Get details of a time entry
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`time_entry_id` | string | No | Time Entry Id |
---
#### Delete time entry
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/projects/timeentries/time_entry_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/timeentries/time_entry_id?api_token={api_token}
```
**Description**: Deleting a logged time entry
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`time_entry_id` | string | No | Time Entry Id |
---
#### Start timer
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/projects/timeentries/time_entry_id/timer/start`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/timeentries/time_entry_id/timer/start?api_token={api_token}
```
**Description**: Start tracking time spent
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`time_entry_id` | string | No | Time Entry Id |
---
#### Stop timer
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/projects/timeentries/timer/stop`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/timeentries/timer/stop?api_token={api_token}
```
**Description**: Stop tracking time, say taking a break or leaving
---
#### Get timer
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/projects/timeentries/runningtimer/me`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/projects/timeentries/runningtimer/me?api_token={api_token}
```
**Description**: Get current running timer
---
### Category: Users
#### Create a user
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/users`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/users?api_token={api_token}
```
**Description**: Create a user for your organization.
**Request Body**:
```json
{
"name": "<string>",
"email": "<string>"
}
```
---
#### List Users
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/users`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/users?filter_by={filter_by}&sort_column={sort_column}&api_token={api_token}
```
**Description**: Get the list of all users in the organization
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`filter_by` | string | No | Allowed Values |
|`sort_column` | string | No | Sort users |
---
#### Update a user
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/users/user_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/users/user_id?api_token={api_token}
```
**Description**: Update the details of a user
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | No | User Id |
**Request Body**:
```json
{
"name": "<string>",
"email": "<string>"
}
```
---
#### Get a user
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/users/user_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/users/user_id?api_token={api_token}
```
**Description**: Get the details of a user
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | No | User Id |
---
#### Delete a user
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/users/user_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/users/user_id?api_token={api_token}
```
**Description**: Delete a user associated to the organization
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | No | User Id |
---
#### Get current user
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/users/me`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/users/me?api_token={api_token}
```
**Description**: Get the details of the current user
---
#### Invite a user
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/users/user_id/invite`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/users/user_id/invite?api_token={api_token}
```
**Description**: Send invitation email to a user
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | No | User Id |
---
#### Mark user as active
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/users/user_id/active`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/users/user_id/active?api_token={api_token}
```
**Description**: Mark an inactive user as active
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | No | User Id |
---
#### Mark user as inactive
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/users/user_id/inactive`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/users/user_id/inactive?api_token={api_token}
```
**Description**: Mark an active user as inactive
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | No | User Id |
---
### Category: Vendor Credits
#### Create a vendor credit
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits?api_token={api_token}
```
**Description**: Create a vendor credit for a vendor
**Request Body**:
```json
{
"vendor_id": "<string>"
}
```
---
#### List vendor credits
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits?vendor_credit_number={vendor_credit_number}&date={date}&status={status}&total={total}&reference_number={reference_number}&customer_name={customer_name}&item_name={item_name}&item_description={item_description}¬es={notes}&custom_field={custom_field}&last_modified_time={last_modified_time}&customer_id={customer_id}&line_item_id={line_item_id}&item_id={item_id}&tax_id={tax_id}&filter_by={filter_by}&search_text={search_text}&sort_column={sort_column}&api_token={api_token}
```
**Description**: List vendor credits with pagination
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_number` | string | No | Search vendor credits by vendor credit number |
|`date` | string | No | General Format: yyyy-mm-dd |
|`status` | string | No | Search vendor credits by vendor credit status |
|`total` | string | No | Search vendor credits by total amount |
|`reference_number` | string | No | Search vendor credits by vendor credit reference number |
|`customer_name` | string | No | Search vendor credits by vendor name |
|`item_name` | string | No | Search vendor credits by item name |
|`item_description` | string | No | Search vendor credits by vendor credit item description |
|`notes` | string | No | Search vendor credits by vendor credit notes |
|`custom_field` | string | No | Search vendor credits by custom field |
|`last_modified_time` | string | No | Search vendor credits by vendor credit last modfified time |
|`customer_id` | string | No | Search vendor credits by vendor credit customer ID |
|`line_item_id` | string | No | Search vendor credits by vendor credit line item ID |
|`item_id` | string | No | Search vendor credits by vendor credit item ID |
|`tax_id` | string | No | Search vendor credits by vendor credit tax ID |
|`filter_by` | string | No | Filter vendor credits by statuses |
|`search_text` | string | No | Search vendor credits by vendor credit numbe |
|`sort_column` | string | No | Sort vendor credits |
---
#### Update vendor credit
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits/vendor_credit_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits/vendor_credit_id?api_token={api_token}
```
**Description**: Update an existing vendor credit
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | No | Vendor Credit Id |
**Request Body**:
```json
{
"vendor_id": "<string>"
}
```
---
#### Get vendor credit
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits/vendor_credit_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits/vendor_credit_id?print={print}&accept={accept}&api_token={api_token}
```
**Description**: Get details of a vendor credit
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | No | Vendor Credit Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`print` | string | No | Export vendor credit pdf with default print option |
|`accept` | string | No | You can get vendor credit details as json/pdf/html |
---
#### Delete vendor credit
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits/vendor_credit_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits/vendor_credit_id?api_token={api_token}
```
**Description**: Delete a vendor credit
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | No | Vendor Credit Id |
---
#### Convert to open
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits/vendor_credit_id/status/open`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits/vendor_credit_id/status/open?api_token={api_token}
```
**Description**: Change an existing vendor credit status to open
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | No | Vendor Credit Id |
---
#### Void vendor credit
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits/vendor_credit_id/status/void`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits/vendor_credit_id/status/void?api_token={api_token}
```
**Description**: Mark an existing vendor credit as void
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | No | Vendor Credit Id |
---
#### Submit a Vendor credit for approval
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits/vendor_credit_id/submit`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits/vendor_credit_id/submit?api_token={api_token}
```
**Description**: Submit a Vendor credit for approval
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | No | Vendor Credit Id |
---
#### Approve a Vendor credit
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits/vendor_credit_id/approve`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits/vendor_credit_id/approve?api_token={api_token}
```
**Description**: Approve a Vendor credit
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | No | Vendor Credit Id |
---
#### Apply credits to a bill
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits/vendor_credit_id/bills`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits/vendor_credit_id/bills?api_token={api_token}
```
**Description**: Apply vendor credit to existing bills
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | No | Vendor Credit Id |
**Request Body**:
```json
{
"bills": "<array>"
}
```
---
#### List bills credited
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits/vendor_credit_id/bills`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits/vendor_credit_id/bills?api_token={api_token}
```
**Description**: List bills credited
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | No | Vendor Credit Id |
---
#### Delete bills credited
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits/vendor_credit_id/billvendor_credit_bill_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits/vendor_credit_id/billvendor_credit_bill_id?api_token={api_token}
```
**Description**: Delete the credits applied to a bill
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | No | Vendor Credit Id |
|`vendor_credit_bill_id` | string | No | Vendor Credit Bill Id |
---
#### Refund a vendor credit
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits/vendor_credit_id/refunds`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits/vendor_credit_id/refunds?api_token={api_token}
```
**Description**: Refund vendor credit amount
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | No | Vendor Credit Id |
**Request Body**:
```json
{
"date": "<string>",
"amount": "<number>",
"account_id": "<string>"
}
```
---
#### List refunds of a vendor credit
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits/vendor_credit_id/refunds`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits/vendor_credit_id/refunds?api_token={api_token}
```
**Description**: List all refunds of an existing vendor credit
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | No | Vendor Credit Id |
---
#### Update vendor credit refund
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3ddd/vendorcredits/vendor_credit_id/refunds/vendor_credit_refund_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3ddd/vendorcredits/vendor_credit_id/refunds/vendor_credit_refund_id?api_token={api_token}
```
**Description**: Update the refunded transaction
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | No | Vendor Credit Id |
|`vendor_credit_refund_id` | string | No | Vendor Credit Refund Id |
**Request Body**:
```json
{
"date": "<string>",
"amount": "<number>",
"account_id": "<string>"
}
```
---
*Note: Showing 15 of 21 endpoints in this category.*
---
### Category: Vendor Payments
#### Create a vendor payment
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/vendorpayments`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/vendorpayments?api_token={api_token}
```
**Description**: Create a payment made to your vendor and you can also apply them to bills either partially or fully
**Request Body**:
```json
{
"amount": "<number>"
}
```
---
#### List vendor payments
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/vendorpayments`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/vendorpayments?vendor_name={vendor_name}&reference_number={reference_number}&payment_number={payment_number}&date={date}&amount={amount}&payment_mode={payment_mode}¬es={notes}&vendor_id={vendor_id}&last_modified_time={last_modified_time}&bill_id={bill_id}&description={description}&filter_by={filter_by}&search_text={search_text}&sort_column={sort_column}&api_token={api_token}
```
**Description**: List all the payments made to your vendor
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_name` | string | No | Search payments by vendor name |
|`reference_number` | string | No | Search payments by reference number |
|`payment_number` | string | No | Search with Payment Number |
|`date` | string | No | Date the payment is made |
|`amount` | string | No | Payment amount made to the vendor |
|`payment_mode` | string | No | Search payments by payment mode |
|`notes` | string | No | Search with Payment Notes |
|`vendor_id` | string | No | ID of the vendor |
|`last_modified_time` | string | No | Search with the Last Modified Time of the Vendor Payment |
|`bill_id` | string | No | Search payments by Bill ID |
|`description` | string | No | Search payments by description |
|`filter_by` | string | No | Filter payments by mode |
|`search_text` | string | No | Search payments by reference number or vendor name or payment description |
|`sort_column` | string | No | Sort the payment list |
---
#### Update a vendor payment
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/vendorpayments/payment_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/vendorpayments/payment_id?api_token={api_token}
```
**Description**: Update an existing vendor payment. You can also modify the amount applied to the bills
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`payment_id` | string | No | Payment Id |
**Request Body**:
```json
{
"amount": "<number>"
}
```
---
#### Get a vendor payment
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/vendorpayments/payment_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/vendorpayments/payment_id?fetchTaxInfo={fetchTaxInfo}&fetchstatementlineinfo={fetchstatementlineinfo}&print={print}&is_bill_payment_id={is_bill_payment_id}&api_token={api_token}
```
**Description**: Get the details of a vendor payment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`payment_id` | string | No | Payment Id |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`fetchTaxInfo` | string | No | Check if tax information should be fetched |
|`fetchstatementlineinfo` | string | No | Check is Statement Line Information for Vendor Payment be fetched |
|`print` | string | No | Check if Vendor Payment must be printed |
|`is_bill_payment_id` | string | No | Check if the ID is Bill Payment or Vendor Payment |
---
#### Delete a vendor payment
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/vendorpayments/payment_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/vendorpayments/payment_id?api_token={api_token}
```
**Description**: Delete an existing vendor payment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`payment_id` | string | No | Payment Id |
---
#### Refund an excess vendor payment
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/vendorpayments/payment_id/refunds`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/vendorpayments/payment_id/refunds?api_token={api_token}
```
**Description**: Refund the excess amount paid to the vendor
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`payment_id` | string | No | Payment Id |
**Request Body**:
```json
{
"date": "<string>",
"amount": "<number>",
"to_account_id": "<string>"
}
```
---
#### List refunds of a vendor payment
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/vendorpayments/payment_id/refunds`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/vendorpayments/payment_id/refunds?api_token={api_token}
```
**Description**: List all the refunds pertaining to an existing vendor payment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`payment_id` | string | No | Payment Id |
---
#### Update a refund
**Method**: `PUT` | **LowCodeAPI Path**: `/books/v3/vendorpayments/payment_id/refunds/vendorpayment_refund_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/vendorpayments/payment_id/refunds/vendorpayment_refund_id?api_token={api_token}
```
**Description**: Update the refunded transaction
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`payment_id` | string | No | Payment Id |
|`vendorpayment_refund_id` | string | No | Vendorpayment Refund Id |
**Request Body**:
```json
{
"date": "<string>",
"amount": "<number>",
"to_account_id": "<string>"
}
```
---
#### Details of a refund
**Method**: `GET` | **LowCodeAPI Path**: `/books/v3/vendorpayments/payment_id/refunds/vendorpayment_refund_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/vendorpayments/payment_id/refunds/vendorpayment_refund_id?api_token={api_token}
```
**Description**: Obtain details of a particular refund of a vendor payment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`payment_id` | string | No | Payment Id |
|`vendorpayment_refund_id` | string | No | Vendorpayment Refund Id |
---
#### Delete a refund
**Method**: `DELETE` | **LowCodeAPI Path**: `/books/v3/vendorpayments/payment_id/refunds/vendorpayment_refund_id`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/vendorpayments/payment_id/refunds/vendorpayment_refund_id?api_token={api_token}
```
**Description**: Delete refund pertaining to an existing vendor payment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`payment_id` | string | No | Payment Id |
|`vendorpayment_refund_id` | string | No | Vendorpayment Refund Id |
---
### Category: ZOHO CRM Integration
#### Import a customer using the CRM account ID
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/crm/account/crm_account_id/import`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/crm/account/crm_account_id/import?api_token={api_token}
```
**Description**: 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
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`crm_account_id` | string | No | CRM Account Id |
---
#### Import a customer using CRM contact ID
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/crm/contact/crm_contact_id/import`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/crm/contact/crm_contact_id/import?api_token={api_token}
```
**Description**: Zoho Books must be integrated with Zoho CRM using Contacts only sync to import a customer from CRM with its CRM contact ID
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`crm_contactt_id` | string | No | CRM Contact Id |
---
#### Import a vendor using the CRM vendor ID
**Method**: `POST` | **LowCodeAPI Path**: `/books/v3/crm/vendor/crm_vendor_id/import`
**Full URL**:
```
https://api.lowcodeapi.com/zohobooks/books/v3/crm/vendor/crm_vendor_id/import?api_token={api_token}
```
**Description**: Zoho Books must be integrated with Zoho CRM using Vendor only sync to import a vendor from CRM with its CRM vendor ID
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`crm_vendo_id` | string | No | CRM Vendo Id |
---
## Complete Endpoint Reference
For a complete list of all 438 endpoints, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/zohobooks/definition`
- **Official Provider Documentation**: https://www.zoho.com/books/api/v3/