# Zoho Inventory Integration via LowCodeAPI

## Overview

Inventory management

## Base Endpoint

```
https://api.lowcodeapi.com/zohoinventory/
```

## Authentication

LowCodeAPI handles authentication automatically. You only need to:

1. **Sign up** at [Zoho Inventory](https://www.zoho.com/in/inventory)
2. **Get your credentials** from [credential page](https://accounts.zoho.com/developerconsole)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests

**Auth Type**: OAUTH2.0

## API Categories

- **Bills** - 7 endpoints
- **Composite Items** - 11 endpoints
- **Contact Persons** - 6 endpoints
- **Contacts** - 12 endpoints
- **Credit Notes** - 29 endpoints
- **Currency** - 5 endpoints
- **Customer Payments** - 5 endpoints
- **Invoices** - 35 endpoints
- **Item Adjustments** - 5 endpoints
- **Item Groups** - 7 endpoints
- **Items** - 9 endpoints
- **Organizations** - 4 endpoints
- **Packages** - 6 endpoints
- **Price Lists** - 6 endpoints
- **Purchase Orders** - 7 endpoints
- **Purchase Receives** - 3 endpoints
- **Retainer Invoices** - 22 endpoints
- **Sales Orders** - 9 endpoints
- **Sales Returns** - 7 endpoints
- **Shipment Orders** - 5 endpoints
- **Taxes** - 19 endpoints
- **Transfer Orders** - 6 endpoints
- **Users** - 9 endpoints
- **Vendor Credits** - 21 endpoints
- **Warehouse Settings** - 8 endpoints

## Common Endpoints

### Category: Bills

#### Create a Bill

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/bills`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/bills?api_token={api_token}
```

**Description**: Creates a Bill in Zoho Inventory

**Request Body**:
```json
{
  "vendor_id": "<number>",
  "bill_number": "<string>",
  "date": "<string>",
  "due_date": "<string>",
  "line_items": "<array>"
}
```

---

#### List all Bills

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/bills`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/bills?api_token={api_token}
```

**Description**: Lists all the Bills in Zoho Inventory

---

#### Update a Bill

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/bills/bill_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/bills/bill_id?api_token={api_token}
```

**Description**: Updates the details of an existing Bill

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | Yes | Bill Id |

**Request Body**:
```json
{
  "vendor_id": "<number>",
  "bill_number": "<string>",
  "date": "<string>",
  "due_date": "<string>",
  "line_items": "<array>"
}
```

---

#### Retrieve a Bill

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/bills/bill_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/bills/bill_id?api_token={api_token}
```

**Description**: Fetches the details of a Bill

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | Yes | Bill Id |

---

#### Delete a Bill

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/bills/bill_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/bills/bill_id?api_token={api_token}
```

**Description**: Deletes a Bill from Zoho Inventory

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | Yes | Bill Id |

---

#### Mark as Open

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/bills/bill_id/status/open`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/bills/bill_id/status/open?api_token={api_token}
```

**Description**: Marks a Bill as Open

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | Yes | Bill Id |

---

#### Mark as Void

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/bills/bill_id/status/void`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/bills/bill_id/status/void?api_token={api_token}
```

**Description**: Marks a Bill as Void

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bill_id` | string | Yes | Bill Id |

---

### Category: Composite Items

#### Creating a Composite Item

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/compositeitems`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/compositeitems?api_token={api_token}
```

**Description**: Creating a Composite Item

**Request Body**:
```json
{
  "name": "<string>",
  "mapped_items": "<array>",
  "sku": "<string>",
  "item_type": "<number>",
  "rate": "<number>",
  "product_type": "<string>"
}
```

---

#### List All Composite Items

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/compositeitems`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/compositeitems?page={page}&per_page={per_page}&sort_column={sort_column}&sort_order={sort_order}&filter_by={filter_by}&usestate={usestate}&response_option={response_option}&api_token={api_token}
```

**Description**: List of all composite items

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`page` | string | No | Page Number |
|`per_page` | string | No | Items to be displayed per page |
|`sort_column` | string | No | column to be used for sorting |
|`sort_order` | string | No | order used for sorting |
|`filter_by` | string | No | Filter items by status |
|`usestate` | string | No | Whether current filter needs to be saved |
|`response_option` | string | No | response format number |

---

#### Updating a composite item

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/compositeitems/composite_item_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/compositeitems/composite_item_id?api_token={api_token}
```

**Description**: Updating details of an existing composite item

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`composite_item_id` | string | Yes | Composite Item Id |

**Request Body**:
```json
{
  "name": "<string>",
  "item_type": "<string>",
  "rate": "<number>",
  "sku": "<string>",
  "mapped_items": "<array>",
  "product_type": "<string>"
}
```

---

#### Retrieving a Composite Item

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1 /compositeitems/composite_item_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1 /compositeitems/composite_item_id?api_token={api_token}
```

**Description**: Retrieving details of an existing compostie item

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`composite_item_id` | string | Yes | Composite Item Id |

---

#### Deleting a Composite Item

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/compositeitems/composite_item_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/compositeitems/composite_item_id?api_token={api_token}
```

**Description**: Deleting an existing Composite Item

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`composite_item_id` | string | Yes | Composite Item Id |

---

#### Mark as Active

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/compositeitems/composite_item_id/active`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/compositeitems/composite_item_id/active?api_token={api_token}
```

**Description**: Changing status of an existing composite item to active

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`composite_item_id` | string | Yes | Composite Item Id |

---

#### Mark as Inactive

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/compositeitems/composite_item_id/inactive`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/compositeitems/composite_item_id/inactive?api_token={api_token}
```

**Description**: Changing status of an existing composite item to inactive

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`composite_item_id` | string | Yes | Composite Item Id |

---

#### Create Bundle

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/bundles`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/bundles?api_token={api_token}
```

**Description**: Putting together different components in desired quantities

**Request Body**:
```json
{
  "reference_number": "<string>",
  "date": "<string>",
  "composite_item_id": "<number>",
  "composite_item_name": "<string>",
  "quantity_to_bundle": "<number>",
  "line_items": "<array>",
  "is_completed": "<boolean>"
}
```

---

#### Bundling History

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/bundles`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/bundles?composite_item_id={composite_item_id}&api_token={api_token}
```

**Description**: List of all bundles of a given composite item

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`composite_item_id` | string | Yes | Unique ID generated for the composite item by the server. This is used as identifier |

---

#### Retrieve Bundle

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/bundles/bundle_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/bundles/bundle_id?api_token={api_token}
```

**Description**: Fetches the details for an existing bundle

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bundle_id` | string | Yes | Bundle Id |

---

#### Delete Bundle

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/bundles/bundle_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/bundles/bundle_id?api_token={api_token}
```

**Description**: Deletes an existing bundle from Zoho Inventory

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bundle_id` | string | Yes | Bundle Id |

---

### Category: Contact Persons

#### Create a contact person

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/contacts/contactpersons`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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**: `/inventory/v1/contacts/contactpersons/contact_person_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contacts/contactpersons/contact_person_id?api_token={api_token}
```

**Description**: Update details of an existing contact person

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_person_id` | string | Yes | Contact Person Id |

**Request Body**:
```json
{
  "contact_id": "<string>",
  "first_name": "<string>"
}
```

---

#### Delete a contact person

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/contacts/contactpersons/contact_person_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contacts/contactpersons/contact_person_id?api_token={api_token}
```

**Description**: Delete an existing contact person

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_person_id` | string | Yes | Contact Person Id |

---

#### List contact persons

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/contacts/contact_id/contactpersons`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contacts/contact_id/contactpersons?api_token={api_token}
```

**Description**: List all contacts with pagination

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact Id |

---

#### Get a contact person

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/contacts/contact_id/contactpersons/contact_person_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contacts/contact_id/contactpersons/contact_person_id?api_token={api_token}
```

**Description**: Get the details of a contact person

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact Id |
|`contact_person_id` | string | Yes | Contact Person Id |

---

#### Mark as primary contact person

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/contacts/contactpersons/contact_person_id/primary`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contacts/contactpersons/contact_person_id/primary?api_token={api_token}
```

**Description**: Mark a contact person as primary for contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_person_id` | string | Yes | Contact Person Id |

---

### Category: Contacts

#### Create a Contact

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/contacts`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contacts?api_token={api_token}
```

**Description**: Create a contact with given information

**Request Body**:
```json
{
  "contact_name": "<string>"
}
```

---

#### List contacts

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/contacts`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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}&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 | Yes | Search contacts by company name |
|`first_name` | array | No | Search contacts by first name of the contact person |
|`last_name` | string | Yes | Search contacts by last name of the contact person |
|`address` | string | Yes | Search contacts by any of the address fields |
|`email` | string | No | Search contacts by email of the contact person |
|`phone` | array | No | Search contacts by phone number of the contact person |
|`filter_by` | object | No | Filter contacts by status. |
|`search_text` | object | No | Search contacts by contact name or notes |
|`sort_column` | array | No | Person/Individual who represents a company |

---

#### Update a contact

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/contacts/contact_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contacts/contact_id?api_token={api_token}
```

**Description**: Update an existing contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact Id |

**Request Body**:
```json
{
  "contact_name": "<string>"
}
```

---

#### Get contact

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/contacts/contact_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contacts/contact_id?api_token={api_token}
```

**Description**: Get details of a contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact Id |

---

#### Delete a contact

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/contacts/contact_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contacts/contact_id?api_token={api_token}
```

**Description**: Delete an existing contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact Id |

---

#### Get contact address

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/contact/contact_id/address`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contact/contact_id/address?api_token={api_token}
```

**Description**: Get the billing and shipping address of an existing contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact Id |

---

#### Mark as active

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/contact/contact_id/active`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contact/contact_id/active?api_token={api_token}
```

**Description**: Mark a contact as active

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact Id |

---

#### Mark as Inactive

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/contacts/contact_id/inactive`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contacts/contact_id/inactive?api_token={api_token}
```

**Description**: Mark a contact as inactive

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact Id |

---

#### Email statement

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/contacts/contact_id/statements/email`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contacts/contact_id/statements/email?start_date={start_date}&end_date={end_date}&multipart_or_formdata={multipart_or_formdata}&api_token={api_token}
```

**Description**: Email statement to the contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | 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` | string | No | End date for the statement |
|`multipart_or_formdata` | string | No | Files to be attached along with the statement |

**Request Body**:
```json
{
  "to_mail_ids": "<array>",
  "subject": "<string>",
  "body": "<string>"
}
```

---

#### Get Statement mail content

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/contacts/contact_id/statements/email`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contacts/contact_id/statements/email?start_date={start_date}&end_date={end_date}&api_token={api_token}
```

**Description**: Get the mail content of a contacts billing statement

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | 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` | string | No | End date for the statement |

---

#### Email contact

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/contacts/contact_id/email`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contacts/contact_id/email?send_customer_statement={send_customer_statement}&api_token={api_token}
```

**Description**: Send email to contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact Id |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`send_customer_statement` | string | No | Send customer statement pdf with email |

**Request Body**:
```json
{
  "to_mail_ids": "<array>",
  "subject": "<string>",
  "body": "<string>"
}
```

---

#### List Comments

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/contacts/contact_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/contacts/contact_id/comments?api_token={api_token}
```

**Description**: List recent activities of a contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact Id |

---

### Category: Credit Notes

#### Create a credit note

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/creditnotes`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/creditnotes?api_token={api_token}
```

**Description**: To create a credit note for a customer

**Request Body**:
```json
{
  "customer_id": "<string>",
  "date": "<string>",
  "line_items": "<array>",
  "creditnote_number": "<string>"
}
```

---

#### List all Credit Notes

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/creditnotes`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/creditnotes?api_token={api_token}
```

**Description**: List all the Credit Notes

---

#### Update a credit note

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/creditnotes/creditnote_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/creditnotes/creditnote_id?api_token={api_token}
```

**Description**: Update the details of an existing creditnote

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | Yes | Creditnote Id |

**Request Body**:
```json
{
  "customer_id": "<string>",
  "date": "<string>",
  "line_items": "<array>",
  "creditnote_number": "<string>"
}
```

---

#### Get a credit note

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/creditnotes/creditnote_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/creditnotes/creditnote_id?print={print}&accept={accept}&api_token={api_token}
```

**Description**: Fetch the details of an existing creditnote

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | Yes | Creditnote Id |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`print` | string | No | Export credit note PDF using the default print option |
|`accept` | string | No | You can fetch the credit note details as json/pdf/html |

---

#### Delete a credit note

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/creditnotes/creditnote_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/creditnotes/creditnote_id?api_token={api_token}
```

**Description**: Delete an existing credit note

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | Yes | Creditnote Id |

---

#### Email a credit note

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/creditnotes/creditnote_id/email`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/creditnotes/creditnote_id/email?api_token={api_token}
```

**Description**: Email a credit note

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | Yes | Creditnote Id |

**Request Body**:
```json
{
  "to_mail_ids": "<array>",
  "subject": "<string>",
  "body": "<string>"
}
```

---

#### Get email content

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/creditnotes/creditnote_id/email`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | 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**: `/inventory/v1/creditnotes/creditnote_id/void`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/creditnotes/creditnote_id/void?api_token={api_token}
```

**Description**: Mark the credit note as Void

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | Yes | Creditnote Id |

---

#### Convert Credit Note to Draft

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/creditnotes/creditnote_id/draft`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/creditnotes/creditnote_id/draft?api_token={api_token}
```

**Description**: Convert a voided credit note to Draft

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | Yes | Creditnote Id |

---

#### Convert credit note to Open

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/creditnotes/creditnote_id/converttoopen`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/creditnotes/creditnote_id/converttoopen?api_token={api_token}
```

**Description**: Convert a credit note in Draft status to Open

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | Yes | Creditnote Id |

---

#### Submit a credit note for approval

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/creditnotes/creditnote_id/submit`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/creditnotes/creditnote_id/submit?api_token={api_token}
```

**Description**: Submit a credit note for approval

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | Yes | Creditnote Id |

---

#### Approve a credit note

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/creditnotes/creditnote_id/approve`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/creditnotes/creditnote_id/approve?api_token={api_token}
```

**Description**: Approve a credit note

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | Yes | Creditnote Id |

---

#### Email history

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/creditnotes/creditnote_id/emailhistory`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Creditnote Id |

---

#### Update billing address

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/creditnotes/creditnote_id/address/billing`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/creditnotes/creditnote_id/address/billing?api_token={api_token}
```

**Description**: Updates the billing address for an existing credit note

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | Yes | Creditnote Id |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Update Shipping address

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/creditnotes/creditnote_id/address/shipping`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/creditnotes/creditnote_id/address/shipping?api_token={api_token}
```

**Description**: Updates the shipping address for an existing credit note.

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`creditnote_id` | string | Yes | 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**: `/inventory/v1/settings/currencies`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/settings/currencies?api_token={api_token}
```

**Description**: Create a currency for transaction

**Request Body**:
```json
{
  "currency_code": "<string>",
  "currency_symbol": "<string>"
}
```

---

#### List Currency

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/settings/currencies`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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**: `/inventory/v1/settings/currencies/currency_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/settings/currencies/currency_id?api_token={api_token}
```

**Description**: Update the details of a currency

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`currency_id` | string | Yes | Currency Id |

**Request Body**:
```json
{
  "currency_code": "<string>",
  "currency_symbol": "<string>"
}
```

---

#### Get a Currency

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/settings/currencies/currency_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/settings/currencies/currency_id?api_token={api_token}
```

**Description**: Get the details of a currency

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`currency_id` | string | Yes | Currency Id |

---

#### Delete a currency

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/settings/currencies/currency_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/settings/currencies/currency_id?api_token={api_token}
```

**Description**: Delete a currency. Currency that is associated to any transaction cannot be deleted

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`currency_id` | string | Yes | Currency Id |

---

### Category: Customer Payments

#### Create a payment

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/customerpayments`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/customerpayments?api_token={api_token}
```

**Description**: Create a new payment

**Request Body**:
```json
{
  "customer_id": "<string>",
  "payment_mode": "<string>",
  "amount": "<string>"
}
```

---

#### List Customer Payments

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/customerpayments`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/customerpayments?{
    "customer_name"={{
    "customer_name"}&"text"={"text"}&"reference_number"={"reference_number"}&"date"={"date"}&"amount"={"amount"}&amount_less_equals={amount_less_equals}&amount_greater_than and amount_greater_equals"
    }={amount_greater_than and amount_greater_equals"
    }}&"notes"={"notes"}&"payment_mode"={"payment_mode"}&"filter_by"={"filter_by"}&"sort_column"={"sort_column"}&"search_text"={"search_text"}&}={}}&api_token={api_token}
```

**Description**: List all the payments made by your customer

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`{
    "customer_name"` | {
        "type" | No |  |
|`"text"` | "Search payments by reference number or customer name or payment description"
    } | No |  |
|`"reference_number"` | {
        "type" | No |  |
|`"date"` | {
        "type" | No |  |
|`"amount"` | {
        "type" | No |  |
|`amount_less_equals` |  | No |  |
|`amount_greater_than and amount_greater_equals"
    }` |  | No |  |
|`"notes"` | {
        "type" | No |  |
|`"payment_mode"` | {
        "type" | No |  |
|`"filter_by"` | {
        "type" | No |  |
|`"sort_column"` | {
        "type" | No |  |
|`"search_text"` | {
        "type" | No |  |
|`}` |  | No |  |

---

#### Update a payment

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/customerpayments/payment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/customerpayments/payment_id?api_token={api_token}
```

**Description**: Update an existing payment information

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`payment_id` | string | Yes | Payment Id |

**Request Body**:
```json
{
  "customer_id": "<string>",
  "payment_mode": "<string>",
  "amount": "<number>"
}
```

---

#### Retrieve a payment

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/customerpayments/payment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/customerpayments/payment_id?api_token={api_token}
```

**Description**: Details of an existing payment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`payment_id` | string | Yes | Payment Id |

---

#### Delete a payment

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/customerpayments/payment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/customerpayments/payment_id?api_token={api_token}
```

**Description**: Delete a payment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`payment_id` | string | Yes | Payment Id |

---

### Category: Invoices

#### Create an invoice

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/invoices`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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**: `/inventory/v1/invoices`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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_fields={custom_fields}&date={date}&due_date={due_date}&status={status}&customer_id={customer_id}&filter_by={filter_by}&search_text={search_text}&sort_column={sort_column}&api_token={api_token}
```

**Description**: List all invoices with pagination

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_number` | string | No | An unique number given to the invoice. Maximum length [100] |
|`item_name` | string | No | item name.Variants: item_name_startswith and item_name_contains |
|`item_id` | string | No | Unique item id |
|`item_description` | string | No | Search invoices by item description.Variants: item_description_startswith and item_description_contains |
|`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 | contact's email id |
|`total` | string | No | The total amount to be paid |
|`balance` | number | No | The unpaid amount |
|`custom_fields` | array | No | custom fields for invoice. Variants: custom_field_startswith and custom_field_contains |
|`date` | string | No | invoice date. Default date format is yyyy-mm-dd. Variants: due_date_start, due_date_end, due_date_before and due_date_after |
|`due_date` | string | No | due date of the invoices. Default date format is yyyy-mm-dd. |
|`status` | string | No | Search invoices by invoice status.Allowed Values: sent, draft, overdue, paid, void, unpaid, partially_paid and viewed |
|`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.Allowed Values: Status.All, Status.Sent, Status.Draft, Status.OverDue, Status.Paid, Status.Void, Status.Unpaid, Status.PartiallyPaid, Status.Viewed and Date.PaymentExpectedDate |
|`search_text` | string | No | Search invoices by invoice number or purchase order or customer name |
|`sort_column` | number | No | Sort invoices.Allowed Values: customer_name, invoice_number, date, due_date, total, balance and created_time |

---

#### Update an invoice

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/invoices/invoice_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/invoices/invoice_id?api_token={api_token}
```

**Description**: Update an existing invoice

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | Yes | Invoice Id |

**Request Body**:
```json
{
  "customer_id": "<string>",
  "line_items": "<array>"
}
```

---

#### Get an invoice

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/invoices/invoice_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | 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. Default format is json. Allowed values json pdf and html |

---

#### Delete an invoice

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/invoices/invoice_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/invoices/invoice_id?api_token={api_token}
```

**Description**: Delete an existing invoice

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | Yes | Invoice Id |

---

#### Mark an invoice as sent

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/invoices/invoice_id/status/sent`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Invoice Id |

---

#### Void an invoice

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/invoices/invoice_id/status/void`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Invoice Id |

---

#### Mark as draft

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/invoices/invoice_id/status/draft`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Invoice Id |

---

#### Email an invoice

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/invoices/invoice_id/email`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/invoices/invoice_id/email?api_token={api_token}
```

**Description**: Email an invoice to the customer

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | Yes | Invoice Id |

**Request Body**:
```json
{
  "to_mail_ids": "<array>"
}
```

---

#### Get invoice email content

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/invoices/invoice_id/email`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Invoice Id |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`email_template_id` | string | No | Get the email content based on a specific email template |

---

#### Email invoices

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/invoices/email`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/invoices/email?api_token={api_token}
```

**Description**: Send invoices to your customers by email

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Get payment reminder mail content

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/invoices/invoice_id/paymentreminder`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Invoice Id |

---

#### Bulk export Invoices

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/invoices/pdf`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/invoices/pdf?invoice_ids={invoice_ids}&api_token={api_token}
```

**Description**: Maximum of 25 invoices can be exported in a single pdf

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_ids` | string | No | Comma separated invoice ids which are to be export as pdf |

---

#### Bulk print invoices

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/invoices/print`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/invoices/print?invoice_ids={invoice_ids}&api_token={api_token}
```

**Description**: Export invoices as pdf and print them

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_ids` | string | No | Export invoices as pdf and print them. Maximum of 25 invoices can be printe |

---

#### Disable payment reminder

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/invoices/invoice_id/paymentreminder/disable`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/invoices/invoice_id/paymentreminder/disable?api_token={api_token}
```

**Description**: Disable automated payment reminders for an invoice

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`invoice_id` | string | Yes | Invoice Id |

---

*Note: Showing 15 of 35 endpoints in this category.*

---

### Category: Item Adjustments

#### Create an item adjustment

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/inventoryadjustments`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/inventoryadjustments?api_token={api_token}
```

**Description**: Creates a new item adjustment

**Request Body**:
```json
{
  "date": "<string>",
  "reason": "<string>",
  "adjustment_type": "<string>",
  "line_items": "<array>"
}
```

---

#### List all the item adjustments

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/inventoryadjustments`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/inventoryadjustments?api_token={api_token}
```

**Description**: Lists all the item adjustments

---

#### Update an item adjustment

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/inventoryadjustments/inventory_adjustment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/inventoryadjustments/inventory_adjustment_id?api_token={api_token}
```

**Description**: Update the details of an existing item adjustment by quantity

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`inventory_adjustment_id` | string | Yes | Inventory Adjustment Id |

**Request Body**:
```json
{
  "date": "<string>",
  "reason": "<string>",
  "adjustment_type": "<string>",
  "line_items": "<array>"
}
```

---

#### Retrieve an item adjustment

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/inventoryadjustments/inventory_adjustment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/inventoryadjustments/inventory_adjustment_id?api_token={api_token}
```

**Description**: Fetches the details for an existing item adjustment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`inventory_adjustment_id` | string | Yes | Inventory Adjustment Id |

---

#### Delete an item adjustment

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/inventoryadjustments/inventory_adjustment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/inventoryadjustments/inventory_adjustment_id?api_token={api_token}
```

**Description**: Deletes an existing item adjustment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`inventory_adjustment_id` | string | Yes | Inventory Adjustment Id |

---

### Category: Item Groups

#### Create an Item Group

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/itemgroups`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/itemgroups?api_token={api_token}
```

**Description**: A new Item Group can a be created

**Request Body**:
```json
{
  "group_name": "<string>"
}
```

---

#### List all Item Groups

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/itemgroups`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/itemgroups?api_token={api_token}
```

**Description**: Lists all the Item Groups

---

#### Update an Item Group

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/itemgroups/itemgroup_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/itemgroups/itemgroup_id?api_token={api_token}
```

**Description**: Updates the details of an existing Item Group

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`itemgroup_id` | string | Yes | Itemgroup Id |

**Request Body**:
```json
{
  "group_name": "<string>",
  "name": "<string>",
  "rate": "<number>",
  "purchase_rate": "<number>",
  "sku": "<string>"
}
```

---

#### Retrieve an Item Group

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/itemgroups/itemgroup_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/itemgroups/itemgroup_id?api_token={api_token}
```

**Description**: Fetches the details for an existing Item Group

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`itemgroup_id` | string | Yes | Itemgroup Id |

---

#### Delete an Item Group

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/itemgroups/itemgroup_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/itemgroups/itemgroup_id?api_token={api_token}
```

**Description**: Deletes an existing Item Group from Zoho Inventory

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`itemgroup_id` | string | Yes | Itemgroup Id |

---

#### Mark as Active

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/itemgroups/itemgroup_id/active`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/itemgroups/itemgroup_id/active?api_token={api_token}
```

**Description**: Marks an Item group as Active

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`itemgroup_id` | string | Yes | Itemgroup Id |

---

#### Mark as Inactive

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/itemgroups/itemgroup_id/inactive`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/itemgroups/itemgroup_id/inactive?api_token={api_token}
```

**Description**: Marks as Item Group as Inactive

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`itemgroup_id` | string | Yes | Itemgroup Id |

---

### Category: Items

#### Create an item

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/items`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/items?api_token={api_token}
```

**Description**: Creates a new item in Zoho Inventory

**Request Body**:
```json
{
  "name": "<number>"
}
```

---

#### List all the items

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/items`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/items?api_token={api_token}
```

**Description**: Lists all the items present in Zoho Inventory

---

#### Bulk fetch item details

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/itemdetails`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/itemdetails?api_token={api_token}
```

**Description**: Fetch item details for the mentioned item IDs

---

#### Update an item

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/items/item_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/items/item_id?api_token={api_token}
```

**Description**: Update the details of an item.

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`item_id` | string | Yes | Item Id |

**Request Body**:
```json
{
  "name": "<number>"
}
```

---

#### Retrieve an item

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/items/item_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/items/item_id?api_token={api_token}
```

**Description**: Fetches the details for an existing item

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`item_id` | string | Yes | Item Id |

---

#### Delete an item

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/items/item_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/items/item_id?api_token={api_token}
```

**Description**: Deletes an existing item from Zoho Inventory

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`item_id` | string | Yes | Item Id |

---

#### Delete an item image

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/items/item_id/image`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/items/item_id/image?api_token={api_token}
```

**Description**: Deletes the image associated for an item 

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`item_id` | string | Yes | Item Id |

---

#### Mark as active

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/items/item_id/active`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/items/item_id/active?api_token={api_token}
```

**Description**: Changes the status of an item to active

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`item_id` | string | Yes | Item Id |

---

#### Mark as inactive

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/items/item_id/inactive`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/items/item_id/inactive?api_token={api_token}
```

**Description**: Mark an item as inactive

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`item_id` | string | Yes | Item Id |

---

### Category: Organizations

#### Create an organization

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/organizations`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/organizations?api_token={api_token}
```

**Description**: Create an organization

**Request Body**:
```json
{
  "name": "<string>",
  "currency_code": "<string>",
  "time_zone": "<string>",
  "portal_name": "<string>"
}
```

---

#### List organizations

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/organizations`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/organizations?api_token={api_token}
```

**Description**: Get the list of organizations

---

#### Update an organization

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/organizations/organization_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/organizations/organization_id?api_token={api_token}
```

**Description**: Update the details of an organization

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`organization_id` | string | Yes | Organization Id |

**Request Body**:
```json
{
  "time_zone": "<string>"
}
```

---

#### Get an organization

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/organizations/organization_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/organizations/organization_id?api_token={api_token}
```

**Description**: Get the details of an organization

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`organization_id` | string | Yes | Organization Id |

---

### Category: Packages

#### Creating a package

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/packages`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/packages?api_token={api_token}
```

**Description**: A new package can be created

**Request Body**:
```json
{
  "date": "<string>",
  "line_items": "<array>",
  "salesorder_id": "<string>"
}
```

---

#### List all packages

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/packages`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/packages?api_token={api_token}
```

**Description**: List all existing packages

---

#### Updating a package

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/packages/package_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/packages/package_id?api_token={api_token}
```

**Description**: Updating details of existing package

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`package_id` | string | Yes | Package Id |

---

#### Retrieving a package

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/packages/package_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/packages/package_id?api_token={api_token}
```

**Description**: Retrieving details of existing package

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`package_id` | string | Yes | Package Id |

---

#### Deleting a package

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/packages/package_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/packages/package_id?api_token={api_token}
```

**Description**: Deleting an existing package

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`package_id` | string | Yes | Package Id |

---

#### Bulk print packages

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/packages/print`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/packages/print?api_token={api_token}
```

**Description**: Print package slips

---

### Category: Price Lists

#### Create a pricebook

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/pricebooks`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/pricebooks?api_token={api_token}
```

**Description**: create a new pricebook

**Request Body**:
```json
{
  "name": "<string>",
  "currency_id": "<string>",
  "pricebook_type": "<string>",
  "sales_or_purchase_type": "<array>"
}
```

---

#### List all pricebooks

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/pricebooks`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/pricebooks?api_token={api_token}
```

**Description**: List all the available pricebooks in your zoho inventory

---

#### Update pricebook

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/pricebooks/pricebook_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/pricebooks/pricebook_id?api_token={api_token}
```

**Description**: update existing pricebook

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`pricebook_id` | string | Yes | Pricebook Id |

**Request Body**:
```json
{
  "name": "<string>",
  "currency_id": "<string>",
  "pricebook_type": "<string>",
  "sales_or_purchase_type": "<array>"
}
```

---

#### Delete the pricebook

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/pricebooks/pricebook_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/pricebooks/pricebook_id?api_token={api_token}
```

**Description**: Delete the pricebook

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`pricebook_id` | string | Yes | Pricebook Id |

---

#### Mark as Active

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/pricebooks/pricebook_id/active`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/pricebooks/pricebook_id/active?api_token={api_token}
```

**Description**: Mark the pricebook as Active

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`pricebook_id` | string | Yes | Pricebook Id |

---

#### Mark as Inactive

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/pricebooks/pricebook_id/inactive`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/pricebooks/pricebook_id/inactive?api_token={api_token}
```

**Description**: Mark the pricebook as Inactive

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`pricebook_id` | string | Yes | Pricebook Id |

---

### Category: Purchase Orders

#### Create a Purchase Order

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/purchaseorders`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/purchaseorders?api_token={api_token}
```

**Description**: Creates a new Sales Order in Zoho Inventory

**Request Body**:
```json
{
  "purchaseorder_number": "<string>",
  "vendor_id": "<number>",
  "line_items": "<array>"
}
```

---

#### List all Purchase Orders

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/purchaseorders`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/purchaseorders?api_token={api_token}
```

**Description**: Lists all the Purchase Orders present in Zoho Inventory

---

#### Update a Purchase Order

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/purchaseorders/purchaseorder_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/purchaseorders/purchaseorder_id?api_token={api_token}
```

**Description**: Updates a new Sales Order in Zoho Inventory

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchaseorder_id` | string | Yes | Purchase Order Id |

**Request Body**:
```json
{
  "purchaseorder_number": "<string>",
  "vendor_id": "<number>",
  "line_items": "<array>"
}
```

---

#### Retrieve a Purchase Order

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/purchaseorders/purchaseorder_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/purchaseorders/purchaseorder_id?api_token={api_token}
```

**Description**: Retrieves the details for an existing Purchase Order

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchaseorder_id` | string | Yes | Purchase Order Id |

---

#### Delete a Purchase Order

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/purchaseorders/purchaseorder_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/purchaseorders/purchaseorder_id?api_token={api_token}
```

**Description**: Deletes a Purchase Order from Zoho Inventory

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchaseorder_id` | string | Yes | Purchase Order Id |

---

#### Mark as Issued

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/purchaseorders/purchaseorder_id/status/issued`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/purchaseorders/purchaseorder_id/status/issued?api_token={api_token}
```

**Description**: Marks a Purchase Order as Issued

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchaseorder_id` | string | Yes | Purchase Order Id |

---

#### Mark as Cancelled

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/purchaseorders/purchaseorder_id/status/cancelled`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/purchaseorders/purchaseorder_id/status/cancelled?api_token={api_token}
```

**Description**: Marks a Purchase Order as Cancelled

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchaseorder_id` | string | Yes | Purchase Order Id |

---

### Category: Purchase Receives

#### Create a purchase receive

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/purchasereceives`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/purchasereceives?api_token={api_token}
```

**Description**: A new purchase receive can a be created

**Request Body**:
```json
{
  "line_items": "<array>"
}
```

---

#### Retrieve a Purchase Receive

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/purchasereceives/purchasereceive_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/purchasereceives/purchasereceive_id?api_token={api_token}
```

**Description**: Fetches a Purchase Receive from Zoho Inventory

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchasereceive_id` | string | Yes | Purchase Receive Id |

---

#### Delete a Purchase Receive

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/purchasereceives/purchasereceive_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/purchasereceives/purchasereceive_id?api_token={api_token}
```

**Description**: Deletes a Purchase Receive from Zoho Inventory

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`purchasereceive_id` | string | Yes | Purchase Receive Id |

---

### Category: Retainer Invoices

#### Create a retainerinvoice

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/retainerinvoices`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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**: `/inventory/v1/retainerinvoices`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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` | number | No | Sort invoices.Allowed Values: customer_name, invoice_number, date, due_date, total, balance and created_time |
|`filter_by` | string | No | Filter invoices by any status or payment expected date.Allowed Values: Status.All, Status.Sent, Status.Draft, Status.OverDue, Status.Paid, Status.Void, Status.Unpaid, Status.PartiallyPaid, Status.Viewed and Date.PaymentExpectedDate |
|`sort_order` | string | No | The order for sorting |
|`page` | string | No | Number of pages |

---

#### update a retainerinvoice

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/retainerinvoices/retainerinvoice_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/retainerinvoices/retainerinvoice_id?api_token={api_token}
```

**Description**: Update an existing invoice.

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | Yes | Retainerinvoice Id |

**Request Body**:
```json
{
  "customer_id": "<string>",
  "line_items": "<array>"
}
```

---

#### Get a retainer invoice

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/retainerinvoices/retainerinvoice_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/retainerinvoices/retainerinvoice_id?api_token={api_token}
```

**Description**: Get the details of a retainer invoice

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | Yes | Retainerinvoice Id |

---

#### Delete a retainer invoice

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/retainerinvoices/retainerinvoice_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/retainerinvoices/retainerinvoice_id?api_token={api_token}
```

**Description**: Delete an existing retainer invoice.

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | Yes | Retainerinvoice Id |

---

#### Mark a retainer invoice as sent

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/retainerinvoices/retainerinvoice_id/status/sent`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Retainerinvoice Id |

---

#### Update retainer invoice template

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/retainerinvoices/retainerinvoice_id/templates/template_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Retainerinvoice Id |
|`template_id` | string | Yes | Template Id |

---

#### Void a retainer invoice

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/retainerinvoices/retainerinvoice_id/status/void`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Retainerinvoice Id |

---

#### Mark as draft

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/retainerinvoices/reatinerinvoice_id/status/draft`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Retainerinvoice Id |

---

#### Submit a retainer invoice for approval

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/retainerinvoices/reatinerinvoice_id/submit`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/retainerinvoices/reatinerinvoice_id/submit?api_token={api_token}
```

**Description**: Submit a retainer invoice for approval

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | Yes | Retainerinvoice Id |

---

#### Approve a retainer invoice

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/retainerinvoices/reatinerinvoice_id/approve`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/retainerinvoices/reatinerinvoice_id/approve?api_token={api_token}
```

**Description**: Approve a retainer invoice

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`retainerinvoice_id` | string | Yes | Retainerinvoice Id |

---

#### Email a retainer invoice

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/retainerinvoices/retainerinvoice_id/email`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Retainerinvoice Id |

**Request Body**:
```json
{
  "to_mail_ids": "<array>"
}
```

---

#### Get retainer invoice email content

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/retainerinvoices/retainerinvoice_id/email`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Retainerinvoice Id |

---

#### Update billing address

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/retainerinvoices/retainerinvoice_id/address/billing`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Retainerinvoice Id |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### List retainer invoice templates

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/retainerinvoices/templates`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/retainerinvoices/templates?api_token={api_token}
```

**Description**: Get all retainer invoice pdf templates

---

*Note: Showing 15 of 22 endpoints in this category.*

---

### Category: Sales Orders

#### Create a Sales Order

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/salesorders`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesorders?api_token={api_token}
```

**Description**: Creates a new Sales Order in Zoho Inventory

**Request Body**:
```json
{
  "customer_id": "<number>",
  "salesorder_number": "<string>",
  "line_items": "<array>"
}
```

---

#### List all Sales Orders

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/salesorders`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesorders?api_token={api_token}
```

**Description**: Lists all the available Sales Orders in Zoho Inventory

---

#### Bulk delete Sales Orders

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/salesorders`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesorders?api_token={api_token}
```

**Description**: Bulk delete the selected Sales Orders

---

#### Update a Sales Order

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/salesorders/salesorder_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesorders/salesorder_id?api_token={api_token}
```

**Description**: Updates a new Sales Order in Zoho Inventory

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | Yes | Salesorder Id |

**Request Body**:
```json
{
  "salesorder_number": "<string>",
  "customer_id": "<number>",
  "line_items": "<array>"
}
```

---

#### Retrieve a Sales Order

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/salesorders/salesorder_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesorders/salesorder_id?api_token={api_token}
```

**Description**: Retrieves the details for an existing Sales Order

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | Yes | Salesorder Id |

---

#### Delete a Sales Order

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/salesorders/salesorder_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesorders/salesorder_id?api_token={api_token}
```

**Description**: Deletes an existing Sales Order from Zoho Inventory

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | Yes | Salesorder Id |

---

#### Mark as Confirmed

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/salesorders/salesorder_id/status/confirmed`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesorders/salesorder_id/status/confirmed?api_token={api_token}
```

**Description**: Changes the status of a Sales Order to Confirmed

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | Yes | Salesorder Id |

---

#### Mark as Void

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/salesorders/salesorder_id/status/void`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesorders/salesorder_id/status/void?api_token={api_token}
```

**Description**: Changes the status of a Sales Order to Void

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesorder_id` | string | Yes | Salesorder Id |

---

#### Bulk confirm Sales Orders

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/salesorders/status/confirmed`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesorders/status/confirmed?api_token={api_token}
```

**Description**: Mark existing Sales Orders as confirmed in Zoho Inventory

**Request Body**:
```json
{
  "salesorder_ids": "<string>",
  "organization_id": "<value>"
}
```

---

### Category: Sales Returns

#### Create a Sales Return

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/salesreturns`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesreturns?api_token={api_token}
```

**Description**: Creation of Sales Return

**Request Body**:
```json
{
  "line_items": "<array>"
}
```

---

#### List all Sales Returns

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/salesreturns`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesreturns?api_token={api_token}
```

**Description**: Lists all the Sales Returns present in Zoho Inventory

---

#### Update a Sales Return

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/salesreturns/salesreturn_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesreturns/salesreturn_id?api_token={api_token}
```

**Description**: Updation of Sales Return

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesreturn_id` | string | Yes | Sales Return Id |

**Request Body**:
```json
{
  "line_items": "<array>"
}
```

---

#### Retrieve a Sales Return

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/salesreturns/salesreturn_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesreturns/salesreturn_id?api_token={api_token}
```

**Description**: Retrieves the details for an existing Sales Return

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesreturn_id` | string | Yes | Sales Return Id |

---

#### Delete a Sales Return

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/salesreturns/salesreturn_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesreturns/salesreturn_id?api_token={api_token}
```

**Description**: Deletes a Sales Return from Zoho Inventory

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesreturn_id` | string | Yes | Sales Return Id |

---

#### Create a Sales Return Receive

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/salesreturnreceives`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesreturnreceives?api_token={api_token}
```

**Description**: Creating a sales return receive to mark the receivable goods as received

**Request Body**:
```json
{
  "line_items": "<array>"
}
```

---

#### Delete a Sales Return Receive

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/salesreturnreceives/salesreturnreceive_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/salesreturnreceives/salesreturnreceive_id?api_token={api_token}
```

**Description**: Deletes the sales return receive of a sales return

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`salesreturnreceive_id` | string | Yes | Sales Return Receive Id |

---

### Category: Shipment Orders

#### Create a Shipment Order

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/shipmentorders`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/shipmentorders?api_token={api_token}
```

**Description**: A new shipment order can a be created

**Request Body**:
```json
{
  "shipment_number": "<string>",
  "date": "<string>",
  "delivery_method": "<string>",
  "tracking_number": "<string>"
}
```

---

#### Update a Shipment Order

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/shipmentorders/shipmentorder_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/shipmentorders/shipmentorder_id?api_token={api_token}
```

**Description**: Update details of an existing Shipment Order in Zoho Inventory

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`shipmentorder_id` | string | Yes | Shipment Order Id |

**Request Body**:
```json
{
  "shipment_number": "<string>",
  "date": "<string>",
  "delivery_method": "<string>",
  "package_ids": "<string>",
  "salesorde_id": "<string>"
}
```

---

#### Retrieve a Shipment Order

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/shipmentorders/shipmentorder_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/shipmentorders/shipmentorder_id?api_token={api_token}
```

**Description**: Retrieves details for an existing Shipment Orders

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`shipmentorder_id` | string | Yes | Shipment Order Id |

---

#### Delete a Shipment Order

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/shipmentorders/shipmentorder_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/shipmentorders/shipmentorder_id?api_token={api_token}
```

**Description**: Deletes an existing Shipment Order

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`shipmentorder_id` | string | Yes | Shipment Order Id |

---

#### Mark as Delivered

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/shipmentorders/shipmentorder_id/status/delivered`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/shipmentorders/shipmentorder_id/status/delivered?api_token={api_token}
```

**Description**: Change the status of the Shipment to delivered

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`shipmentorder_id` | string | Yes | Shipment Order Id |

---

### Category: Taxes

#### Create a tax

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/settings/taxes`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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**: `/inventory/v1/settings/taxes`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/settings/taxes?api_token={api_token}
```

**Description**: List of simple and compound taxes with pagination

---

#### Update a tax

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/settings/taxes/tax_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Tax Id |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Get a tax

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/settings/taxes/tax_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Tax Id |

---

#### Delete a tax

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/settings/taxes/tax_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/settings/taxes/tax_id?api_token={api_token}
```

**Description**: Delete a simple or compound tax.


**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`tax_id` | string | Yes | Tax Id |

---

#### Update a tax group

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/settings/taxgroups/tax_group_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Tax Group Id |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Get a tax group

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/settings/taxgroups/tax_group_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Tax Group Id |

---

#### Delete a tax group

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/settings/taxgroups/tax_group_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Tax Group Id |

---

#### Create a tax group

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/settings/taxgroups`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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**: `/inventory/v1/settings/taxauthorities`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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**: `/inventory/v1/settings/taxauthorities`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/settings/taxauthorities?api_token={api_token}
```

**Description**: List of tax authorities.


---

#### Update a tax authority [US and CA Edition only]

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/settings/taxauthorities/tax_authority_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Tax Authority Id |

**Request Body**:
```json
{
  "tax_authority_name": "<string>"
}
```

---

#### Get a tax authority [US and CA Edition only]

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/settings/taxauthorities/tax_authority_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Tax Authority Id |

---

#### Delete a tax authority [US and CA Edition only]

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/settings/taxauthorities/tax_authority_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/settings/taxauthorities/tax_authority_id?api_token={api_token}
```

**Description**: Delete a tax authority

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`tax_authority_id` | string | Yes | Tax Authority Id |

---

#### Create a tax exemption [US Edition only]

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/settings/taxexemptions`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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: Transfer Orders

#### Create a transfer order

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/transferorders`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/transferorders?api_token={api_token}
```

**Description**: Creates a new transfer order in Zoho Inventory

**Request Body**:
```json
{
  "transfer_order_number": "<string>",
  "date": "<string>",
  "from_warehouse_id": "<number>",
  "to_warehouse_id": "<number>",
  "line_items": "<array>"
}
```

---

#### List all the transfer orders

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/transferorders`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/transferorders?api_token={api_token}
```

**Description**: Lists all the transfer orders

---

#### Update a transfer order

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/transferorders/transfer_order_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/transferorders/transfer_order_id?api_token={api_token}
```

**Description**: Update an existing transfer order from Zoho Inventory

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transfer_order_id` | string | Yes | Transfer Order Id |

**Request Body**:
```json
{
  "transfer_order_number": "<string>",
  "date": "<string>",
  "from_warehouse_id": "<number>",
  "to_warehouse_id": "<number>",
  "line_items": "<array>"
}
```

---

#### Retrieve a transfer order

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/transferorders/transfer_order_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/transferorders/transfer_order_id?api_token={api_token}
```

**Description**: Fetches the details for an existing transfer order

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transfer_order_id` | string | Yes | Transfer Order Id |

---

#### Delete a transfer order

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/transferorders/transfer_order_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/transferorders/transfer_order_id?api_token={api_token}
```

**Description**: Deletes an existing transfer order from Zoho Inventory

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transfer_order_id` | string | Yes | Transfer Order Id |

---

#### Mark as Received

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/transferorders/transfer_order_id/markastransferred`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/transferorders/transfer_order_id/markastransferred?api_token={api_token}
```

**Description**: Changes the status of a transfer order to Transferred

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`transfer_order_id` | string | Yes | Transfer Order Id |

---

### Category: Users

#### Create a user

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/users`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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**: `/inventory/v1/users`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Criteria used to filter |
|`sort_column` | string | No | Sort users |

---

#### Update a user

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/users/user_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/users/user_id?api_token={api_token}
```

**Description**: Update the details of a user

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User Id |

**Request Body**:
```json
{
  "name": "<string>",
  "email": "<string>"
}
```

---

#### Get a user

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/users/user_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/users/user_id?api_token={api_token}
```

**Description**: Get the details of a user

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User Id |

---

#### Delete a user

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/users/user_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/users/user_id?api_token={api_token}
```

**Description**: Delete a user associated to the organization

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User Id |

---

#### Get current user

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/users/me`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/users/me?api_token={api_token}
```

**Description**: Get the details of the current user

---

#### Invite a user

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/users/user_id/invite`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/users/user_id/invite?api_token={api_token}
```

**Description**: Send invitation email to a person, you wish to add as a user to your organisation.

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User Id |

---

#### Mark user as active

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/users/user_id/active`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/users/user_id/active?api_token={api_token}
```

**Description**: Mark an inactive user as active

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User Id |

---

#### Mark user as inactive

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/users/user_id/inactive`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/users/user_id/inactive?api_token={api_token}
```

**Description**: Mark an active user as inactive

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User Id |

---

### Category: Vendor Credits

#### Create a vendor credit

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/vendorcredits`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/vendorcredits?api_token={api_token}
```

**Description**: Create a vendor credit for a vendor

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### List vendor credits

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/vendorcredits`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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}&notes={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 numbe |
|`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 number or vendor name or vendor credit reference number |
|`sort_column` | string | No | Sort vendor credits by following columns vendor_name vendorcredit_number balance total date and created_time |

---

#### Update vendor credit

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/vendorcredits/vendor_credit_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/vendorcredits/vendor_credit_id?api_token={api_token}
```

**Description**: Update an existing vendor credit

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | Yes | Vendor Credit Id |

**Request Body**:
```json
{
  "vendor_id": "<string>"
}
```

---

#### Get vendor credit

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/vendorcredits/vendor_credit_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | 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**: `/inventory/v1/vendorcredits/vendor_credit_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/vendorcredits/vendor_credit_id?api_token={api_token}
```

**Description**: Delete a vendor credit

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | Yes | Vendor Credit Id |

---

#### Convert to open

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/vendorcredits/vendor_credit_id/status/open`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Vendor Credit Id |

---

#### Void vendor credit

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/vendorcredits/vendor_credit_id/status/void`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Vendor Credit Id |

---

#### Submit a Vendor credit for approval

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/vendorcredits/vendor_credit_id/submit`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Vendor Credit Id |

---

#### Approve a Vendor credit

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/vendorcredits/vendor_credit_id/approve`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/vendorcredits/vendor_credit_id/approve?api_token={api_token}
```

**Description**: Approve a Vendor credit

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | Yes | Vendor Credit Id |

---

#### Apply credits to a bill

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/vendorcredits/vendor_credit_id/bills`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Vendor Credit Id |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### List bills credited

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/vendorcredits/vendor_credit_id/bills`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/vendorcredits/vendor_credit_id/bills?api_token={api_token}
```

**Description**: List bills to which the vendor credit is applied

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | Yes | Vendor Credit Id |

---

#### Delete bills credited

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/vendorcredits/vendor_credit_id/bills/vendor_credit_bill_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/vendorcredits/vendor_credit_id/bills/vendor_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 | Yes | Vendor Credit Id |
|`vendor_credit_bill_id` | string | Yes | Vendor Credit Bill Id |

---

#### Refund a vendor credit

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/vendorcredits/vendor_credit_id/refunds`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/vendorcredits/vendor_credit_id/refunds?api_token={api_token}
```

**Description**: Refund vendor credit amount

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`vendor_credit_id` | string | Yes | Vendor Credit Id |

**Request Body**:
```json
{
  "date": "<string>",
  "amount": "<number>",
  "account_id": "<string>"
}
```

---

#### List refunds of a vendor credit

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/vendorcredits/vendor_credit_id/refunds`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Vendor Credit Id |

---

#### Update vendor credit refund

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/vendorcredits/vendor_credit_id/refunds/vendor_credit_refund_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/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 | Yes | Vendor Credit Id |
|`vendor_credit_refund_id` | string | Yes | Vendor Credit Refund Id |

**Request Body**:
```json
{
  "date": "<string>",
  "amount": "<number>",
  "account_id": "<string>"
}
```

---

*Note: Showing 15 of 21 endpoints in this category.*

---

### Category: Warehouse Settings

#### Enable Multi warehouse

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/settings/multiwarehouse/enable`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/settings/multiwarehouse/enable?api_token={api_token}
```

**Description**: Enable Multiple warehouse for an organisation

---

#### Create a Warehouse

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/settings/warehouses`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/settings/warehouses?api_token={api_token}
```

**Description**: reate a Warehouse

**Request Body**:
```json
{
  "warehouse_name": "<string>",
  "country": "<string>"
}
```

---

#### List all warehouses

**Method**: `GET` | **LowCodeAPI Path**: `/inventory/v1/settings/warehouses`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/settings/warehouses?api_token={api_token}
```

**Description**: List all the available warehouses in your zoho inventory

---

#### Update Warehouse

**Method**: `PUT` | **LowCodeAPI Path**: `/inventory/v1/settings/warehouses/warehouse_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/settings/warehouses/warehouse_id?api_token={api_token}
```

**Description**: Update Warehouse

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`warehouse_id` | string | Yes | Warehouse Id |

**Request Body**:
```json
{
  "warehouse_name": "<string>",
  "country": "<string>"
}
```

---

#### Delete a Warehouse

**Method**: `DELETE` | **LowCodeAPI Path**: `/inventory/v1/settings/warehouses/warehouse_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/settings/warehouses/warehouse_id?api_token={api_token}
```

**Description**: Delete a warehouse

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`warehouse_id` | string | Yes | Warehouse Id |

---

#### Mark as Active

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/warehouses/warehouse_id/active`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/warehouses/warehouse_id/active?api_token={api_token}
```

**Description**: Mark warehouse as Active

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`warehouse_id` | string | Yes | Warehouse Id |

---

#### Mark as Inactive

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/warehouses/warehouse_id/inactive`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/warehouses/warehouse_id/inactive?api_token={api_token}
```

**Description**: Mark warehouse as Inactiv

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`warehouse_id` | string | Yes | Warehouse Id |

---

#### Mark as Primary

**Method**: `POST` | **LowCodeAPI Path**: `/inventory/v1/settings/warehouses/warehouse_id/markasprimary`

**Full URL**:
```
https://api.lowcodeapi.com/zohoinventory/inventory/v1/settings/warehouses/warehouse_id/markasprimary?api_token={api_token}
```

**Description**: Mark warehouse as primary

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`warehouse_id` | string | Yes | Warehouse Id |

---

## Complete Endpoint Reference

For a complete list of all 263 endpoints, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/zohoinventory/definition`
- **Official Provider Documentation**: https://www.zoho.com/inventory/api/v1