{
"title": "Zoho Inventory API Vocabulary",
"description": "Terms, operations, schemas, and properties extracted from Zoho Inventory OpenAPI specifications",
"source": "https://www.zoho.com/inventory/api/v1/introduction/",
"terms": {
"batches": {
"type": "schema",
"module": "vendor-credits",
"description": "Batch details for the line item. Reference an existing batch using batch_id. Applicable only for items with batch tracking enabled."
},
"create_a_batch": {
"type": "operation",
"method": "POST",
"path": "/items/batches",
"summary": "Create a batch",
"description": "Create a new batch for an item that has batch tracking enabled."
},
"list_batches": {
"type": "operation",
"method": "GET",
"path": "/items/batches",
"summary": "List all batches",
"description": "List all batches available for a given item."
},
"item_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the item."
},
"include_empty_batches": {
"type": "parameter",
"in": "query",
"description": "Include batches that have zero quantity. Allowed values true and false."
},
"warehouse_id": {
"type": "schema",
"module": "storagelocations",
"description": "Unique identifier of the warehouse."
},
"location_id": {
"type": "schema",
"module": "vendor-credits",
"description": "Location ID"
},
"batch_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of batch IDs to mark as inactive."
},
"search_text": {
"type": "schema",
"module": "vendor-credits",
"description": "Search vendor credits by vendor credit number or vendor name or vendor credit reference number."
},
"status": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"filter_by": {
"type": "schema",
"module": "vendor-credits",
"description": "Filter vendor credits by statuses. Allowed Values: Status.All, Status.Open, Status.Draft, Status.Closed and Status.Void."
},
"sort_column": {
"type": "schema",
"module": "vendor-credits",
"description": "Sort vendor credits by following columns vendor_name, vendorcredit_number, balance, total, date and created_time. Allowed Values: vendor_name, vendor_credit_number, balance, total, date, created_time, last_modified_time and reference_number."
},
"sort_order": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"page": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"per_page": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"bulk_delete_batches": {
"type": "operation",
"method": "DELETE",
"path": "/items/batches",
"summary": "Bulk delete batches",
"description": "Delete multiple batches in a single request. Batches with associated transactions cannot be deleted."
},
"retrieve_a_batch": {
"type": "operation",
"method": "GET",
"path": "/items/batches/{batch_id}",
"summary": "Retrieve a batch",
"description": "Fetch the details of a specific batch."
},
"update_a_batch": {
"type": "operation",
"method": "PUT",
"path": "/items/batches/{batch_id}",
"summary": "Update a batch",
"description": "Update the details of an existing batch."
},
"delete_a_batch": {
"type": "operation",
"method": "DELETE",
"path": "/items/batches/{batch_id}",
"summary": "Delete a batch",
"description": "Delete a single batch. The batch must not have any associated transactions."
},
"mark_batch_as_active": {
"type": "operation",
"method": "POST",
"path": "/items/batches/{batch_id}/active",
"summary": "Mark a batch as active",
"description": "Mark a specific batch as active."
},
"mark_batch_as_inactive": {
"type": "operation",
"method": "POST",
"path": "/items/batches/{batch_id}/inactive",
"summary": "Mark a batch as inactive",
"description": "Mark a specific batch as inactive."
},
"mark_batches_as_active": {
"type": "operation",
"method": "POST",
"path": "/items/batches/active",
"summary": "Mark batches as active",
"description": "Mark multiple batches as active in a single request."
},
"mark_batches_as_inactive": {
"type": "operation",
"method": "POST",
"path": "/items/batches/inactive",
"summary": "Mark batches as inactive",
"description": "Mark multiple batches as inactive in a single request."
},
"gendoc-attributes-schema": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"batch_id": {
"type": "parameter",
"in": "query",
"description": "Filter bin locations by batch ID."
},
"batch_in_id": {
"type": "schema",
"module": "batches",
"description": "Unique identifier of the inward batch entry created when stock was received."
},
"batch_number": {
"type": "schema",
"module": "serialnumbers",
"description": "Batch number the serial number belongs to."
},
"internal_batch_number": {
"type": "schema",
"module": "batches",
"description": "Internal batch number generated by the system."
},
"manufacturer_batch_number": {
"type": "schema",
"module": "batches",
"description": "Manufacturer-provided batch number."
},
"external_batch_number": {
"type": "schema",
"module": "batches",
"description": "External batch number from the manufacturer."
},
"manufactured_date": {
"type": "schema",
"module": "batches",
"description": "Manufacturing date of the batch."
},
"manufacturer_date": {
"type": "schema",
"module": "batches",
"description": "Manufacturing date of the batch. Legacy alias retained for backward compatibility; prefer manufactured_date."
},
"expiry_date": {
"type": "schema",
"module": "batches",
"description": "Expiration date of the batch."
},
"in_quantity": {
"type": "schema",
"module": "batches",
"description": "Quantity received into the batch when stock was added."
},
"balance_quantity": {
"type": "schema",
"module": "batches",
"description": "Quantity currently available in the batch."
},
"balance_quantity_unit": {
"type": "schema",
"module": "batches",
"description": "Unit of measurement for the balance quantity."
},
"associated_locations": {
"type": "schema",
"module": "batches",
"description": "Locations where stock for this batch is available, with the inward and balance quantity at each location."
},
"sales_rate": {
"type": "schema",
"module": "landedcosts",
"description": "Updated sales rate for the bill line item after the landed cost is applied."
},
"label_rate": {
"type": "schema",
"module": "landedcosts",
"description": "Updated label (MRP) rate for the bill line item after the landed cost is applied. Returned only when MRP is enabled for the organization."
},
"custom_field_id": {
"type": "schema",
"module": "serialnumbers",
"description": "Unique identifier of the custom field."
},
"label": {
"type": "schema",
"module": "vendor-credits",
"description": "Label of the Custom Field"
},
"value": {
"type": "schema",
"module": "vendor-credits",
"description": "Value of the Custom Field"
},
"batch_custom_fields": {
"type": "schema",
"module": "serialnumbers",
"description": "Custom fields configured for the batch the serial number belongs to."
},
"batch-response": {
"type": "schema",
"module": "batches",
"description": "Details of a batch."
},
"batch-response.batch_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"batch-response.item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"batch-response.batch_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"batch-response.manufacturer_batch_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"batch-response.manufactured_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"batch-response.expiry_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"batch-response.balance_quantity": {
"type": "property",
"dataType": "string",
"description": ""
},
"batch-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"batch-response.batch_custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item": {
"type": "schema",
"module": "batches",
"description": "Details of a batch as returned in the list batches response."
},
"list-batches-item.batch_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.batch_in_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.batch_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.internal_batch_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.external_batch_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.manufacturer_batch_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.manufacturer_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.manufactured_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.expiry_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.in_quantity": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.balance_quantity": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.balance_quantity_unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.associated_locations": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.batch_custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-batches-item.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-batch-request": {
"type": "schema",
"module": "batches",
"description": ""
},
"create-a-batch-request.item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-batch-request.batch_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-batch-request.manufacturer_batch_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-batch-request.manufactured_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-batch-request.expiry_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-batch-request.sales_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-batch-request.label_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-batch-request.batch_custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-batch-response": {
"type": "schema",
"module": "batches",
"description": ""
},
"create-a-batch-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-batch-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-batch-response.batch": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-batches-response": {
"type": "schema",
"module": "batches",
"description": ""
},
"list-all-batches-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-batches-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-batches-response.batches": {
"type": "property",
"dataType": "array",
"description": ""
},
"retrieve-a-batch-response": {
"type": "schema",
"module": "batches",
"description": ""
},
"retrieve-a-batch-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieve-a-batch-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-a-batch-response.batch": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-batch-request": {
"type": "schema",
"module": "batches",
"description": ""
},
"update-a-batch-request.batch_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-batch-request.manufacturer_batch_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-batch-request.manufactured_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-batch-request.expiry_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-batch-request.sales_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-batch-request.label_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-batch-request.batch_custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-batch-response": {
"type": "schema",
"module": "batches",
"description": ""
},
"update-a-batch-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-batch-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-batch-response.batch": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-a-batch-response": {
"type": "schema",
"module": "batches",
"description": ""
},
"delete-a-batch-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-batch-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"bulk-delete-batches-response": {
"type": "schema",
"module": "batches",
"description": ""
},
"bulk-delete-batches-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"bulk-delete-batches-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-a-batch-as-active-response": {
"type": "schema",
"module": "batches",
"description": ""
},
"mark-a-batch-as-active-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-a-batch-as-active-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-a-batch-as-inactive-response": {
"type": "schema",
"module": "batches",
"description": ""
},
"mark-a-batch-as-inactive-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-a-batch-as-inactive-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-batches-as-active-response": {
"type": "schema",
"module": "batches",
"description": ""
},
"mark-batches-as-active-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-batches-as-active-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-batches-as-inactive-response": {
"type": "schema",
"module": "batches",
"description": ""
},
"mark-batches-as-inactive-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-batches-as-inactive-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"bills": {
"type": "schema",
"module": "vendor-credits",
"description": "Amount applied from vendor credits to specified bills."
},
"create_bill": {
"type": "operation",
"method": "POST",
"path": "/bills",
"summary": "Create a Bill",
"description": "Creates a Bill in Zoho Inventory. Description about the extra parameter attachment Allowed extensions are gif, png, jpeg, jpg, bmp and pdf."
},
"list_bills": {
"type": "operation",
"method": "GET",
"path": "/bills",
"summary": "List all Bills.",
"description": "Lists all the Bills in Zoho Inventory."
},
"get_bill": {
"type": "operation",
"method": "GET",
"path": "/bills/{bill_id}",
"summary": "Retrieve a Bill",
"description": "Fetches the details of a Bill."
},
"update_bill": {
"type": "operation",
"method": "PUT",
"path": "/bills/{bill_id}",
"summary": "Update a Bill",
"description": "Updates the details of an existing Bill."
},
"delete_bill": {
"type": "operation",
"method": "DELETE",
"path": "/bills/{bill_id}",
"summary": "Delete a Bill.",
"description": "Deletes a Bill from Zoho Inventory."
},
"update_custom_field_in_bill": {
"type": "operation",
"method": "PUT",
"path": "/bill/{bill_id}/customfields",
"summary": "Update custom field in existing bills",
"description": "Update the value of the custom field in existing bills."
},
"bill_id": {
"type": "schema",
"module": "vendor-credits",
"description": "Bill Associated with the Vendor Credit"
},
"mark_bill_as_open": {
"type": "operation",
"method": "POST",
"path": "/bills/{bill_id}/status/open",
"summary": "Mark as Open",
"description": "Marks a Bill as Open."
},
"mark_bill_as_void": {
"type": "operation",
"method": "POST",
"path": "/bills/{bill_id}/status/void",
"summary": "Mark as Void",
"description": "Marks a Bill as Void."
},
"submit_bill": {
"type": "operation",
"method": "POST",
"path": "/bills/{bill_id}/submit",
"summary": "Submit a bill for approval",
"description": "Submit a bill for approval workflow."
},
"approve_bill": {
"type": "operation",
"method": "POST",
"path": "/bills/{bill_id}/approve",
"summary": "Approve a bill",
"description": "Approve a submitted bill."
},
"approve_bill_final": {
"type": "operation",
"method": "POST",
"path": "/bills/{bill_id}/approve/final",
"summary": "Final approval of a bill",
"description": "Perform the final approval of a bill (admin only)."
},
"reject_bill": {
"type": "operation",
"method": "POST",
"path": "/bills/{bill_id}/reject",
"summary": "Reject a bill",
"description": "Reject a submitted bill."
},
"bulk_submit_bills": {
"type": "operation",
"method": "POST",
"path": "/bills/submit",
"summary": "Bulk submit bills for approval",
"description": "Submit multiple bills for approval workflow at once."
},
"bill_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of bill IDs whose details are to be fetched. A maximum of 200 bill IDs can be passed in a single call."
},
"bulk_approve_bills": {
"type": "operation",
"method": "POST",
"path": "/bills/approve",
"summary": "Bulk approve bills",
"description": "Approve multiple submitted bills at once."
},
"bill-response": {
"type": "schema",
"module": "bills",
"description": ""
},
"bill-response.bill_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.purchaseorder_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.vendor_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.unused_credits_payable_amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.bill_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.due_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.due_by_days": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.currency_symbol": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.price_precision": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.is_item_level_tax_calc": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.line_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.taxes": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.vendor_credits_applied": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.sub_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.tax_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.balance": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.billing_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.payments": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.vendor_credits": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.reference_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.attachment_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.open_purchaseorders_count": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.source_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.destination_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.is_pre_gst": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill-response.is_reverse_charge_applied": {
"type": "property",
"dataType": "string",
"description": ""
},
"location_name": {
"type": "schema",
"module": "vendor-credits",
"description": "Name of the location."
},
"purchaseorder_id": {
"type": "schema",
"module": "purchasereceives",
"description": "Unique ID generated by the server for the Purchase Order."
},
"vendor_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the vendor the vendor credit associated with the Vendor Credit"
},
"vendor_name": {
"type": "schema",
"module": "vendor-credits",
"description": "Name of the Vendor Associated with the Vendor Credit"
},
"unused_credits_payable_amount": {
"type": "schema",
"module": "bills",
"description": "Unused credit payable amount."
},
"bill_number": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"date": {
"type": "schema",
"module": "vendor-credits",
"description": "The date the vendor credit is created. [yyyy-mm-dd]"
},
"due_date": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"reference_number": {
"type": "schema",
"module": "vendor-credits",
"description": "Reference number for the refund recorded."
},
"due_by_days": {
"type": "schema",
"module": "bills",
"description": "Number of days by which the Bill is due."
},
"currency_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the Currency Involved in the Vendor Credit"
},
"currency_code": {
"type": "schema",
"module": "vendor-credits",
"description": "Code of the Currency Involved in the Vendor Credit"
},
"currency_symbol": {
"type": "schema",
"module": "shipmentorders",
"description": "The symbol for the selected currency."
},
"exchange_rate": {
"type": "schema",
"module": "vendor-credits",
"description": "Exchange rate of the currency."
},
"price_precision": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"is_item_level_tax_calc": {
"type": "schema",
"module": "bills",
"description": "Checks whether item level tax is calculated or not."
},
"purchaseorder_item_id": {
"type": "schema",
"module": "bills",
"description": "Unique ID generated for a line item in the Purchase Order."
},
"receive_item_id": {
"type": "schema",
"module": "bills",
"description": "Unique ID generated by the server for the receive."
},
"line_item_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the Line Item"
},
"name": {
"type": "schema",
"module": "vendor-credits",
"description": "Name of the line item."
},
"account_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the account, the line item is associated with"
},
"account_name": {
"type": "schema",
"module": "vendor-credits",
"description": "Name of the account the line item is associated with"
},
"description": {
"type": "schema",
"module": "vendor-credits",
"description": "Description of the line item."
},
"bcy_rate": {
"type": "schema",
"module": "vendor-credits",
"description": "Rate of the Item in Base Currency"
},
"rate": {
"type": "schema",
"module": "vendor-credits",
"description": "Rate of the line item."
},
"quantity": {
"type": "schema",
"module": "vendor-credits",
"description": "Quantity of the line item."
},
"tax_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the Tax associated with the Vendor Credit"
},
"tds_tax_id": {
"type": "schema",
"module": "vendor-credits",
"description": "TDS Tax ID of the Tax associated with the Vendor Credit"
},
"tax_name": {
"type": "schema",
"module": "vendor-credits",
"description": "Name of the Tax"
},
"tax_type": {
"type": "schema",
"module": "vendor-credits",
"description": "Type of the Tax"
},
"tax_percentage": {
"type": "schema",
"module": "vendor-credits",
"description": "Percentage of Tax"
},
"item_total": {
"type": "schema",
"module": "vendor-credits",
"description": "Total price of the Item"
},
"item_order": {
"type": "schema",
"module": "vendor-credits",
"description": "Order of the line item"
},
"unit": {
"type": "schema",
"module": "vendor-credits",
"description": "Unit of the line item e.g. kgs, Nos."
},
"image_id": {
"type": "schema",
"module": "salesorders",
"description": "Unique ID generated by the server for the item image. This is used an identifier."
},
"image_name": {
"type": "schema",
"module": "salesorders",
"description": "Name of the image of the line item."
},
"image_type": {
"type": "schema",
"module": "salesorders",
"description": "The type (file format) of the image."
},
"hsn_or_sac": {
"type": "schema",
"module": "vendor-credits",
"description": "HSN Code"
},
"tax_exemption_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the Tax Exemption associated"
},
"tax_exemption_code": {
"type": "schema",
"module": "vendor-credits",
"description": "Code of the Tax Exemption associated"
},
"reverse_charge_tax_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the reverse charge tax"
},
"reverse_charge_tax_name": {
"type": "schema",
"module": "vendor-credits",
"description": "Enter the tax name of the reverse charge"
},
"reverse_charge_tax_percentage": {
"type": "schema",
"module": "vendor-credits",
"description": "Tax percentage of the reverse charge"
},
"reverse_charge_tax_amount": {
"type": "schema",
"module": "vendor-credits",
"description": "Tax amount of the reverse charge"
},
"customfield_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the Custom Field"
},
"custom_fields": {
"type": "schema",
"module": "vendor-credits",
"description": "List of custom fields associated with the vendor credit"
},
"update-an-bill-customfield-response": {
"type": "schema",
"module": "bills",
"description": ""
},
"update-an-bill-customfield-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-an-bill-customfield-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"item_custom_fields": {
"type": "schema",
"module": "vendor-credits",
"description": "List of custom fields associated with the line item"
},
"line_items": {
"type": "schema",
"module": "vendor-credits",
"description": "Line items of a vendor credit."
},
"tax_amount": {
"type": "schema",
"module": "vendor-credits",
"description": "Amount of the Tax"
},
"taxes": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"vendor_credits_applied": {
"type": "schema",
"module": "bills",
"description": "Vendor credits applied to the Bill."
},
"sub_total": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"tax_total": {
"type": "schema",
"module": "shipmentorders",
"description": "Tax total of the Sales Order."
},
"balance": {
"type": "schema",
"module": "vendor-credits",
"description": "Balance in the Vendor Credit"
},
"address": {
"type": "schema",
"module": "shipmentorders",
"description": "Name of the street of the customer's billing address."
},
"city": {
"type": "schema",
"module": "shipmentorders",
"description": "Name of the city of the customer's billing address."
},
"state": {
"type": "schema",
"module": "shipmentorders",
"description": "Name of the state of the customer's billing address."
},
"zip": {
"type": "schema",
"module": "shipmentorders",
"description": "Zip code of the customer's billing address."
},
"country": {
"type": "schema",
"module": "taxes",
"description": "Country to which the tax belongs."
},
"fax": {
"type": "schema",
"module": "shipmentorders",
"description": "Fax number of the customer's billing address."
},
"billing_address": {
"type": "schema",
"module": "shipmentorders",
"description": "Customer's billing address. It contains - address, city, state, zip, country and fax."
},
"vendor_credit_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the Vendor Credit"
},
"vendor_credit_bill_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the Vendor Credited Bill ID"
},
"vendor_credit_number": {
"type": "schema",
"module": "vendor-credits",
"description": "Number of the Vendor Credit"
},
"amount": {
"type": "schema",
"module": "vendor-credits",
"description": "Amount that is credited in the bill"
},
"vendor_credits": {
"type": "schema",
"module": "bills",
"description": "The available Vendor Credits."
},
"payment_id": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"bill_payment_id": {
"type": "schema",
"module": "bills",
"description": "Bill payment ID"
},
"payment_mode": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"payment_number": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"paid_through_account_id": {
"type": "schema",
"module": "bills",
"description": "ID for the account through which the payment is made."
},
"paid_through_account_name": {
"type": "schema",
"module": "bills",
"description": "Name of the account."
},
"is_single_bill_payment": {
"type": "schema",
"module": "bills",
"description": "Checks whether the payment is for single bills or multiple bills."
},
"payments": {
"type": "schema",
"module": "invoices",
"description": "The list of payments"
},
"created_time": {
"type": "schema",
"module": "vendor-credits",
"description": "Time of Vendor Credit Creation"
},
"last_modified_time": {
"type": "schema",
"module": "vendor-credits",
"description": "Last Modified Time of Vendor Credit"
},
"reference_id": {
"type": "schema",
"module": "bills",
"description": "Unique ID generated by the server for the reference."
},
"notes": {
"type": "schema",
"module": "vendor-credits",
"description": "Notes for the Vendor Credit"
},
"terms": {
"type": "schema",
"module": "salesorders",
"description": "Terms for the Sales Order."
},
"is_inclusive_tax": {
"type": "schema",
"module": "vendor-credits",
"description": "Used to specify whether the line item rates are inclusive or exclusive of tax."
},
"attachment_name": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"open_purchaseorders_count": {
"type": "schema",
"module": "bills",
"description": "Number of Purchase Orders that are associated with this Bill and open."
},
"source_of_supply": {
"type": "schema",
"module": "vendor-credits",
"description": "Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken)"
},
"destination_of_supply": {
"type": "schema",
"module": "vendor-credits",
"description": "Place where the goods/services are supplied to. (If not given, organisation's home state will be taken)"
},
"gst_treatment": {
"type": "schema",
"module": "vendor-credits",
"description": "Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer ."
},
"tax_treatment": {
"type": "schema",
"module": "vendor-credits",
"description": "VAT treatment for the vendor credit. Choose whether the vendor falls under: vat_registered,vat_not_registered,gcc_vat_not_registered,gcc_vat_registered,non_gcc.dz_vat_registered and dz_vat_not_registered are supported only for UAE.home_country_mexico,border_region_mexico,non_mexico supported only for MX."
},
"gst_no": {
"type": "schema",
"module": "vendor-credits",
"description": "15 digit GST identification number of the vendor."
},
"is_pre_gst": {
"type": "schema",
"module": "salesorders",
"description": "Applicable for transactions that fall before july 1, 2017"
},
"is_reverse_charge_applied": {
"type": "schema",
"module": "vendor-credits",
"description": "Applicable for transactions where you pay reverse charge"
},
"serial_numbers": {
"type": "schema",
"module": "vendor-credits",
"description": "Serial numbers for the line item. Applicable only for items with serial tracking enabled."
},
"storages": {
"type": "schema",
"module": "vendor-credits",
"description": "Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled."
},
"batches-update": {
"type": "schema",
"module": "vendor-credits",
"description": "Batch details for the line item. Reference an existing batch using batch_id. Applicable only for items with batch tracking enabled."
},
"storages-update": {
"type": "schema",
"module": "vendor-credits",
"description": "Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled."
},
"batches-response": {
"type": "schema",
"module": "vendor-credits",
"description": "Batches tracked for the line item. Returned for items with batch tracking enabled."
},
"storages-response": {
"type": "schema",
"module": "vendor-credits",
"description": "Bin/storage locations tracked for the line item. Returned for items with bin tracking enabled."
},
"create-a-bill-request": {
"type": "schema",
"module": "bills",
"description": ""
},
"create-a-bill-request.purchaseorder_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.bill_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.due_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.is_item_level_tax_calc": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.line_items": {
"type": "property",
"dataType": "array",
"description": "The line items for a Bill."
},
"create-a-bill-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.source_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-request.destination_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-response": {
"type": "schema",
"module": "bills",
"description": ""
},
"create-a-bill-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-bill-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-bill-response.bill": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-bills-response": {
"type": "schema",
"module": "bills",
"description": ""
},
"list-all-bills-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-bills-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-bills-response.bills": {
"type": "property",
"dataType": "array",
"description": ""
},
"retrieve-a-bill-response": {
"type": "schema",
"module": "bills",
"description": ""
},
"retrieve-a-bill-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieve-a-bill-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-a-bill-response.bill": {
"type": "property",
"dataType": "object",
"description": ""
},
"update-a-bill-request": {
"type": "schema",
"module": "bills",
"description": ""
},
"update-a-bill-request.purchaseorder_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.bill_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.due_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.is_item_level_tax_calc": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.line_items": {
"type": "property",
"dataType": "array",
"description": "The line items for a Bill."
},
"update-a-bill-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.source_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.destination_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.is_pre_gst": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-request.is_reverse_charge_applied": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-response": {
"type": "schema",
"module": "bills",
"description": ""
},
"update-a-bill-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-bill-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-bill-response.bill": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-bill-response": {
"type": "schema",
"module": "bills",
"description": ""
},
"delete-a-bill-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-bill-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-as-open-response": {
"type": "schema",
"module": "bills",
"description": ""
},
"mark-as-open-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-as-open-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-as-void-response": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"mark-as-void-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-as-void-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"approval-action-response": {
"type": "schema",
"module": "transferorders",
"description": ""
},
"approval-action-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"approval-action-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"reject-request": {
"type": "schema",
"module": "transferorders",
"description": ""
},
"reject-request.reason": {
"type": "property",
"dataType": "string",
"description": "Reason for rejecting the transfer order. Max-length [500]."
},
"compositeitems": {
"type": "tag",
"description": "CompositeItems Module"
},
"create_composite_item": {
"type": "operation",
"method": "POST",
"path": "/compositeitems",
"summary": "Creating a Composite Item",
"description": "A new composite item can be created after creating items that we want to associcate with composite item. User can attach image for composite item by calling Different API 'https://www.zohoapis.com/inventory/v1/compositeitems/{composite_item_id}/image', passing form-data parameter image i.e. -F image=bag_s.jpg"
},
"list_composite_items": {
"type": "operation",
"method": "GET",
"path": "/compositeitems",
"summary": "List All Composite Items",
"description": "List of all composite items."
},
"usestate": {
"type": "schema",
"module": "compositeitems",
"description": "Whether current filter needs to be saved"
},
"response_option": {
"type": "schema",
"module": "compositeitems",
"description": "response format number"
},
"name_contains": {
"type": "parameter",
"in": "query",
"description": "Filter by item name that contains the given value."
},
"name_startswith": {
"type": "parameter",
"in": "query",
"description": "Filter by item name that starts with the given value."
},
"sku": {
"type": "schema",
"module": "vendor-credits",
"description": "SKU of the Item"
},
"sku_contains": {
"type": "parameter",
"in": "query",
"description": "Filter by SKU that contains the given value."
},
"category_id": {
"type": "parameter",
"in": "query",
"description": "Filter by category ID."
},
"combo_type": {
"type": "schema",
"module": "salesreturns",
"description": "Type of the composite item. Allowed values are assembly and kit."
},
"purchase_account_id": {
"type": "schema",
"module": "items",
"description": "Unique ID generated by the server for the Purchase account."
},
"get_composite_item": {
"type": "operation",
"method": "GET",
"path": "/compositeitems/{composite_item_id}",
"summary": "Retrieving a Composite Item",
"description": "Retrieving details of an existing compostie item."
},
"update_composite_item": {
"type": "operation",
"method": "PUT",
"path": "/compositeitems/{composite_item_id}",
"summary": "Updating a composite item",
"description": "Updating details of an existing composite item."
},
"delete_composite_item": {
"type": "operation",
"method": "DELETE",
"path": "/compositeitems/{composite_item_id}",
"summary": "Deleting a Composite Item",
"description": "Deleting an existing Composite Item."
},
"mark_composite_item_active": {
"type": "operation",
"method": "POST",
"path": "/compositeitems/{composite_item_id}/active",
"summary": "Mark as Active",
"description": "Changing status of an existing composite item to active."
},
"mark_composite_item_inactive": {
"type": "operation",
"method": "POST",
"path": "/compositeitems/{composite_item_id}/inactive",
"summary": "Mark as Inactive",
"description": "Changing status of an existing composite item to inactive."
},
"upload_composite_item_image": {
"type": "operation",
"method": "POST",
"path": "/compositeitems/{composite_item_id}/image",
"summary": "Upload Composite Item Images",
"description": "Uploads an image for a composite item. Accepted image formats: gif, png, jpeg, jpg, bmp, webp. Maximum file size is 7 MB."
},
"delete_composite_item_image": {
"type": "operation",
"method": "DELETE",
"path": "/compositeitems/{composite_item_id}/image",
"summary": "Delete Composite Item Image",
"description": "Deletes the images associated with a composite item."
},
"create_assemblies": {
"type": "operation",
"method": "POST",
"path": "/bundles",
"summary": "Create Assemblies",
"description": "Assemblies is the technique of putting together different components in desired quantities to produce a single commodity. These components could be goods, services and other non-inventory items of your choice."
},
"ignore_auto_number_generation": {
"type": "schema",
"module": "vendor-credits",
"description": "Ignore auto number generation for this vendor credit only. On enabling this option vendor credit number is mandatory."
},
"list_assemblies": {
"type": "operation",
"method": "GET",
"path": "/bundles",
"summary": "Assemblies History",
"description": "List of all Assemblies of a given composite item."
},
"composite_item_id": {
"type": "schema",
"module": "compositeitems",
"description": "Unique ID generated for the composite item by the server. This is used as identifier"
},
"project_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the project"
},
"reference_number_contains": {
"type": "parameter",
"in": "query",
"description": "Filter by reference number contains."
},
"date_start": {
"type": "parameter",
"in": "query",
"description": "Filter from this date (inclusive). Format yyyy-mm-dd."
},
"date_end": {
"type": "parameter",
"in": "query",
"description": "Filter up to this date (inclusive). Format yyyy-mm-dd."
},
"get_assembly": {
"type": "operation",
"method": "GET",
"path": "/bundles/{bundle_id}",
"summary": "Retrieve Assemblies",
"description": "Fetches the details for an existing Assemblies."
},
"update_assembly": {
"type": "operation",
"method": "PUT",
"path": "/bundles/{bundle_id}",
"summary": "Update an Assembly",
"description": "Updates the details of an existing assembly."
},
"delete_assembly": {
"type": "operation",
"method": "DELETE",
"path": "/bundles/{bundle_id}",
"summary": "Delete Assemblies",
"description": "Deletes an existing Assemblies from Zoho Inventory."
},
"mark_assembly_as_built": {
"type": "operation",
"method": "POST",
"path": "/bundles/{bundle_id}/bundled",
"summary": "Mark Assembly as Assembled",
"description": "Marks an existing assembly as built, indicating that the composite item has been assembled from its components."
},
"mark_assembly_as_confirmed": {
"type": "operation",
"method": "POST",
"path": "/bundles/{bundle_id}/confirmed",
"summary": "Mark Assembly as Confirmed",
"description": "Marks an existing assembly as confirmed."
},
"composite_item_name": {
"type": "schema",
"module": "compositeitems",
"description": "Name of the composite item"
},
"composite_item_sku": {
"type": "schema",
"module": "compositeitems",
"description": "Stock Keeping Unit value of the composite item. It should be unique throughout the product"
},
"purchase_description": {
"type": "schema",
"module": "items",
"description": "The description for the purchase information. This will be displayed to the vendor in your purchase order."
},
"bundle_id": {
"type": "schema",
"module": "compositeitems",
"description": "Unique ID generated for the Assemblies by the server. This is used as identifier"
},
"pricebook_rate": {
"type": "schema",
"module": "pricelists",
"description": "Rate of the price book for the Items"
},
"purchase_rate": {
"type": "schema",
"module": "purchaseorders",
"description": "Purchase Price of the line item."
},
"initial_stock": {
"type": "schema",
"module": "items",
"description": "The opening stock of the item."
},
"initial_stock_rate": {
"type": "schema",
"module": "items",
"description": "The opening stock value of the item."
},
"upc": {
"type": "schema",
"module": "items",
"description": "The 12 digit Unique Product Code (UPC) of the item."
},
"ean": {
"type": "schema",
"module": "items",
"description": "Unique EAN value for the Item."
},
"isbn": {
"type": "schema",
"module": "items",
"description": "Unique ISBN value for the Item."
},
"part_number": {
"type": "schema",
"module": "items",
"description": "Part Number of the Item."
},
"is_combo_product": {
"type": "schema",
"module": "salesreturns",
"description": "Indicates whether the line item is a composite product."
},
"item_type": {
"type": "schema",
"module": "items",
"description": "Item type can be inventory, sales, purchases or sales_and_purchases. If item is associated with a group, then type should be inventory."
},
"is_taxable": {
"type": "schema",
"module": "items",
"description": "Boolean to track the taxability of the item."
},
"reorder_level": {
"type": "schema",
"module": "items",
"description": "Reorder level of the item."
},
"quantity_to_bundle": {
"type": "schema",
"module": "compositeitems",
"description": "Quantity of Assembly to be Assembled."
},
"quantity_consumed": {
"type": "schema",
"module": "compositeitems",
"description": "Quantity of item to be Assembled."
},
"operation_type": {
"type": "schema",
"module": "vendor-credits",
"description": "Type of operation that caused the Comment"
},
"available_stock": {
"type": "schema",
"module": "items",
"description": "Stock based on Shipments and Receives"
},
"actual_available_stock": {
"type": "schema",
"module": "items",
"description": "Stock based on Shipments and Receives minus ordered stock"
},
"purchase_account_name": {
"type": "schema",
"module": "items",
"description": "Name of the Purchase Account"
},
"inventory_account_id": {
"type": "schema",
"module": "items",
"description": "Uniquq ID generated by the server for the Inventory account."
},
"inventory_account_name": {
"type": "schema",
"module": "compositeitems",
"description": "Name of inventory type"
},
"product_type": {
"type": "schema",
"module": "vendor-credits",
"description": "Type of the product. Allowed Values: goods, digital_service and service."
},
"source": {
"type": "schema",
"module": "items",
"description": "The source of the Item Group."
},
"stock_on_hand": {
"type": "schema",
"module": "vendor-credits",
"description": "Stock on Hand for that Item"
},
"asset_value": {
"type": "schema",
"module": "compositeitems",
"description": "value of the composite items based on purchase rate"
},
"mapped_items": {
"type": "schema",
"module": "salesreturns",
"description": "Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item."
},
"tax_specification": {
"type": "schema",
"module": "items",
"description": "Type of tax. It can be intra or inter"
},
"item_tax_preferences": {
"type": "schema",
"module": "items",
"description": "List of tax preferences of the item."
},
"is_completed": {
"type": "schema",
"module": "compositeitems",
"description": "Denotes the status of the assemblies. Currently, this has to be true since we didnt support any other status as of now."
},
"composite_item": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"composite_item.composite_item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.tax_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.tax_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.tax_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.purchase_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.purchase_account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.inventory_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.inventory_account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.source": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.is_combo_product": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.item_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.pricebook_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.purchase_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.reorder_level": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.initial_stock": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.initial_stock_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.vendor_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.stock_on_hand": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.asset_value": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.available_stock": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.actual_available_stock": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.sku": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.upc": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.ean": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.isbn": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.part_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.image_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.image_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.image_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.is_taxable": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.product_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.purchase_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.category_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the category."
},
"composite_item.category_name": {
"type": "property",
"dataType": "string",
"description": "Name of the category."
},
"composite_item.combo_type": {
"type": "property",
"dataType": "string",
"description": "Type of composite item. Allowed values: assembly, kit."
},
"composite_item.brand": {
"type": "property",
"dataType": "string",
"description": "Brand name of the composite item."
},
"composite_item.manufacturer": {
"type": "property",
"dataType": "string",
"description": "Manufacturer of the composite item."
},
"composite_item.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.mapped_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.item_tax_preferences": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.hsn_or_sac": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"composite_item.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"creating-a-composite-item-request.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.mapped_items": {
"type": "property",
"dataType": "array",
"description": "Items that are associated with the composite item"
},
"creating-a-composite-item-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.is_combo_product": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.purchase_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.purchase_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.initial_stock": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.initial_stock_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.sku": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.isbn": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.ean": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.part_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.reorder_level": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.upc": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.item_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.label_rate": {
"type": "property",
"dataType": "number",
"description": "Label rate (MRP) of the composite item."
},
"creating-a-composite-item-request.is_taxable": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.tax_exemption_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax exemption."
},
"creating-a-composite-item-request.brand": {
"type": "property",
"dataType": "string",
"description": "Brand name of the composite item."
},
"creating-a-composite-item-request.manufacturer": {
"type": "property",
"dataType": "string",
"description": "Manufacturer of the composite item."
},
"creating-a-composite-item-request.alias_name": {
"type": "property",
"dataType": "string",
"description": "Alias name for the composite item."
},
"creating-a-composite-item-request.category_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the category."
},
"creating-a-composite-item-request.can_be_sold": {
"type": "property",
"dataType": "boolean",
"description": "Whether the composite item can be sold."
},
"creating-a-composite-item-request.can_be_purchased": {
"type": "property",
"dataType": "boolean",
"description": "Whether the composite item can be purchased."
},
"creating-a-composite-item-request.is_returnable": {
"type": "property",
"dataType": "boolean",
"description": "Whether the composite item is returnable."
},
"creating-a-composite-item-request.minimum_order_quantity": {
"type": "property",
"dataType": "number",
"description": "Minimum order quantity for the composite item."
},
"creating-a-composite-item-request.maximum_order_quantity": {
"type": "property",
"dataType": "number",
"description": "Maximum order quantity for the composite item."
},
"creating-a-composite-item-request.track_serial_number": {
"type": "property",
"dataType": "boolean",
"description": "Whether serial number tracking is enabled for the composite item."
},
"creating-a-composite-item-request.track_batch_number": {
"type": "property",
"dataType": "boolean",
"description": "Whether batch number tracking is enabled for the composite item."
},
"creating-a-composite-item-request.package_details": {
"type": "property",
"dataType": "object",
"description": "Package details of the composite item."
},
"creating-a-composite-item-request.tags": {
"type": "property",
"dataType": "array",
"description": "Tags associated with the composite item (reporting tags)."
},
"creating-a-composite-item-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.purchase_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.inventory_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.item_tax_preferences": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.hsn_or_sac": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-request.product_type": {
"type": "property",
"dataType": "string",
"description": "Type of the product."
},
"creating-a-composite-item-request.combo_type": {
"type": "property",
"dataType": "string",
"description": "Type of composite item. Allowed values: assembly, kit."
},
"creating-a-composite-item-response": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"creating-a-composite-item-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"creating-a-composite-item-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-composite-item-response.composite_item": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-composite-items-response": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"list-all-composite-items-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-composite-items-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-composite-items-response.composite_items": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-all-composite-items-response.page_context": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"retrieving-a-composite-item-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieving-a-composite-item-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.composite_item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.source": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.tax_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.tax_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.tax_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.purchase_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.purchase_account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.inventory_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.inventory_account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.is_combo_product": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.item_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.pricebook_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.purchase_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.reorder_level": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.initial_stock": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.initial_stock_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.vendor_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.stock_on_hand": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.asset_value": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.available_stock": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.actual_available_stock": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.sku": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.upc": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.ean": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.isbn": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.part_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.image_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.image_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.purchase_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.mapped_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.is_taxable": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.product_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.image_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.category_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the category."
},
"retrieving-a-composite-item-response.category_name": {
"type": "property",
"dataType": "string",
"description": "Name of the category."
},
"retrieving-a-composite-item-response.combo_type": {
"type": "property",
"dataType": "string",
"description": "Type of composite item. Allowed values: assembly, kit."
},
"retrieving-a-composite-item-response.brand": {
"type": "property",
"dataType": "string",
"description": "Brand name of the composite item."
},
"retrieving-a-composite-item-response.manufacturer": {
"type": "property",
"dataType": "string",
"description": "Manufacturer of the composite item."
},
"retrieving-a-composite-item-response.alias_name": {
"type": "property",
"dataType": "string",
"description": "Alias name for the composite item."
},
"retrieving-a-composite-item-response.assembly_type": {
"type": "property",
"dataType": "string",
"description": "Assembly type of the composite item."
},
"retrieving-a-composite-item-response.label_rate": {
"type": "property",
"dataType": "number",
"description": "Label rate (MRP) of the composite item."
},
"retrieving-a-composite-item-response.sales_rate": {
"type": "property",
"dataType": "number",
"description": "Selling rate of the composite item."
},
"retrieving-a-composite-item-response.can_be_sold": {
"type": "property",
"dataType": "boolean",
"description": "Whether the composite item can be sold."
},
"retrieving-a-composite-item-response.can_be_purchased": {
"type": "property",
"dataType": "boolean",
"description": "Whether the composite item can be purchased."
},
"retrieving-a-composite-item-response.track_inventory": {
"type": "property",
"dataType": "boolean",
"description": "Whether inventory tracking is enabled for the composite item."
},
"retrieving-a-composite-item-response.is_returnable": {
"type": "property",
"dataType": "boolean",
"description": "Whether the composite item is returnable."
},
"retrieving-a-composite-item-response.tax_exemption_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax exemption."
},
"retrieving-a-composite-item-response.tax_exemption_code": {
"type": "property",
"dataType": "string",
"description": "Tax exemption code."
},
"retrieving-a-composite-item-response.minimum_order_quantity": {
"type": "property",
"dataType": "number",
"description": "Minimum order quantity for the composite item."
},
"retrieving-a-composite-item-response.maximum_order_quantity": {
"type": "property",
"dataType": "number",
"description": "Maximum order quantity for the composite item."
},
"retrieving-a-composite-item-response.committed_stock": {
"type": "property",
"dataType": "number",
"description": "Stock committed against sales orders."
},
"retrieving-a-composite-item-response.available_for_sale_stock": {
"type": "property",
"dataType": "number",
"description": "Stock available for sale after deducting committed stock."
},
"retrieving-a-composite-item-response.track_serial_number": {
"type": "property",
"dataType": "boolean",
"description": "Whether serial number tracking is enabled for the composite item."
},
"retrieving-a-composite-item-response.track_batch_number": {
"type": "property",
"dataType": "boolean",
"description": "Whether batch number tracking is enabled for the composite item."
},
"retrieving-a-composite-item-response.is_linked_with_zohocrm": {
"type": "property",
"dataType": "boolean",
"description": "Whether the composite item is linked with Zoho CRM."
},
"retrieving-a-composite-item-response.package_details": {
"type": "property",
"dataType": "object",
"description": "Package details of the composite item."
},
"retrieving-a-composite-item-response.tags": {
"type": "property",
"dataType": "array",
"description": "Tags associated with the composite item (reporting tags)."
},
"retrieving-a-composite-item-response.item_tax_preferences": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.hsn_or_sac": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-composite-item-response.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"updating-a-composite-item-request.composite_item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.tax_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.tax_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.tax_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.purchase_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.purchase_account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.inventory_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.inventory_account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.source": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.is_combo_product": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.item_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.pricebook_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.purchase_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.reorder_level": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.initial_stock": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.initial_stock_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.vendor_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.stock_on_hand": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.asset_value": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.available_stock": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.actual_available_stock": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.sku": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.upc": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.ean": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.isbn": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.part_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.image_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.image_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.purchase_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.mapped_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.item_tax_preferences": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.hsn_or_sac": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-request.product_type": {
"type": "property",
"dataType": "string",
"description": "Type of the product."
},
"updating-a-composite-item-request.combo_type": {
"type": "property",
"dataType": "string",
"description": "Type of composite item. Allowed values: assembly, kit."
},
"updating-a-composite-item-response": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"updating-a-composite-item-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"updating-a-composite-item-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-composite-item-response.composite_item": {
"type": "property",
"dataType": "string",
"description": ""
},
"deleting-a-composite-item-response": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"deleting-a-composite-item-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"deleting-a-composite-item-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-as-active-response": {
"type": "schema",
"module": "pricelists",
"description": ""
},
"mark-as-active-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-as-active-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-as-inactive-response": {
"type": "schema",
"module": "pricelists",
"description": ""
},
"mark-as-inactive-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-as-inactive-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"finished_product_serial_numbers": {
"type": "schema",
"module": "compositeitems",
"description": "Serial numbers to be assigned to the finished product. Use when the composite item has serial tracking enabled."
},
"finished_product_batches": {
"type": "schema",
"module": "compositeitems",
"description": "Batches to be created for the finished product. Use when the composite item has batch tracking enabled."
},
"finished_product_storages": {
"type": "schema",
"module": "compositeitems",
"description": "Bin/storage locations to store the finished product. Use when the composite item has bin tracking enabled."
},
"create-bundle-request": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"create-bundle-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-request.composite_item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-request.composite_item_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-request.composite_item_sku": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-request.quantity_to_bundle": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-request.status": {
"type": "property",
"dataType": "string",
"description": "Status of the assembly. Allowed values: draft, confirmed, bundled."
},
"create-bundle-request.warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Warehouse ID for the assembly."
},
"create-bundle-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-request.line_items": {
"type": "property",
"dataType": "array",
"description": "A assemblies can contain multiple line items. Each line item contains item_id,name,description,quantity_consumed,unit,account_id,location_id."
},
"create-bundle-request.finished_product_serial_numbers": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-request.finished_product_batches": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-request.finished_product_storages": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-request.is_completed": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-request.custom_fields": {
"type": "property",
"dataType": "array",
"description": "Custom fields for the assembly."
},
"create-bundle-response": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"create-bundle-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-bundle-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-response.bundle_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-response.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-response.transaction_number": {
"type": "property",
"dataType": "string",
"description": "Auto-generated transaction number."
},
"create-bundle-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-response.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-response.composite_item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-response.composite_item_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-response.composite_item_sku": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-response.quantity_to_bundle": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-response.status": {
"type": "property",
"dataType": "string",
"description": "Status of the assembly."
},
"create-bundle-response.total": {
"type": "property",
"dataType": "number",
"description": "Total cost of the assembly."
},
"create-bundle-response.warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Warehouse ID associated with the assembly."
},
"create-bundle-response.warehouse_name": {
"type": "property",
"dataType": "string",
"description": "Warehouse name associated with the assembly."
},
"create-bundle-response.is_completed": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-response.line_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-response.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bundle-response.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"bundling-history-response": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"bundling-history-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"bundling-history-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"bundling-history-response.bundles": {
"type": "property",
"dataType": "array",
"description": ""
},
"bundling-history-response.page_context": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-bundle-response": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"retrieve-bundle-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieve-bundle-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-bundle-response.bundle": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-bundle-response": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"delete-bundle-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-bundle-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"page_context": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"page_context.page": {
"type": "property",
"dataType": "string",
"description": ""
},
"page_context.per_page": {
"type": "property",
"dataType": "string",
"description": ""
},
"page_context.has_more_page": {
"type": "property",
"dataType": "string",
"description": ""
},
"page_context.report_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"page_context.applied_filter": {
"type": "property",
"dataType": "string",
"description": ""
},
"page_context.sort_column": {
"type": "property",
"dataType": "string",
"description": ""
},
"page_context.sort_order": {
"type": "property",
"dataType": "string",
"description": ""
},
"upload-composite-item-image-response": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"upload-composite-item-image-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"upload-composite-item-image-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-composite-item-image-response": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"delete-composite-item-image-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-composite-item-image-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-bundle-request": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"update-bundle-response": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"update-bundle-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-bundle-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-bundle-response.bundle": {
"type": "property",
"dataType": "object",
"description": ""
},
"mark-assembly-as-built-response": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"mark-assembly-as-built-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-assembly-as-built-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-assembly-as-built-response.bundle": {
"type": "property",
"dataType": "object",
"description": ""
},
"mark-assembly-as-confirmed-response": {
"type": "schema",
"module": "compositeitems",
"description": ""
},
"mark-assembly-as-confirmed-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-assembly-as-confirmed-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-assembly-as-confirmed-response.bundle": {
"type": "property",
"dataType": "object",
"description": ""
},
"contact-persons": {
"type": "tag",
"description": "Contact-Persons Module"
},
"create_contact_person": {
"type": "operation",
"method": "POST",
"path": "/contacts/contactpersons",
"summary": "Create a contact person",
"description": "Create a contact person for contact."
},
"update_contact_person": {
"type": "operation",
"method": "PUT",
"path": "/contacts/contactpersons/{contact_person_id}",
"summary": "Update a contact person",
"description": "Update details of an existing contact person."
},
"delete_contact_person": {
"type": "operation",
"method": "DELETE",
"path": "/contacts/contactpersons/{contact_person_id}",
"summary": "Delete a contact person",
"description": "Delete an existing contact person."
},
"list_contact_persons": {
"type": "operation",
"method": "GET",
"path": "/contacts/{contact_id}/contactpersons",
"summary": "List contact persons",
"description": "List all contacts with pagination."
},
"get_contact_person": {
"type": "operation",
"method": "GET",
"path": "/contacts/{contact_id}/contactpersons/{contact_person_id}",
"summary": "Get a contact person",
"description": "Get the details of a contact person."
},
"contact_person_id": {
"type": "schema",
"module": "shipmentorders",
"description": "Unique ID generated by the server for the contact person"
},
"mark_contact_person_as_primary": {
"type": "operation",
"method": "POST",
"path": "/contacts/contactpersons/{contact_person_id}/primary",
"summary": "Mark as primary contact person",
"description": "Mark a contact person as primary for contact."
},
"contact_person-response": {
"type": "schema",
"module": "contact-persons",
"description": ""
},
"contact_person-response.contact_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_person-response.contact_person_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_person-response.salutation": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_person-response.first_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_person-response.last_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_person-response.email": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_person-response.phone": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_person-response.mobile": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_person-response.is_primary_contact": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_person-response.skype": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_person-response.designation": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_person-response.department": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_person-response.is_added_in_portal": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_person-response.communication_preference": {
"type": "property",
"dataType": "string",
"description": ""
},
"salutation": {
"type": "schema",
"module": "salesorders",
"description": "Salutation of the Contact Person"
},
"contact_id": {
"type": "schema",
"module": "tasks",
"description": "ID of the contact associated with the task."
},
"has_more_page": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"first_name": {
"type": "schema",
"module": "salesorders",
"description": "First Name of the Contact Person"
},
"last_name": {
"type": "schema",
"module": "salesorders",
"description": "Last Name of the Contact Person"
},
"is_primary_contact": {
"type": "schema",
"module": "invoices",
"description": "To mark contact person as primary for contact"
},
"email": {
"type": "schema",
"module": "users",
"description": "email address of the user"
},
"phone": {
"type": "schema",
"module": "salesorders",
"description": "Phone Number of the Contact Person"
},
"mobile": {
"type": "schema",
"module": "salesorders",
"description": "Mobile Number of the Contact Person"
},
"skype": {
"type": "schema",
"module": "contact-persons",
"description": "skype address of the contact person. Maximum length [50]"
},
"designation": {
"type": "schema",
"module": "contact-persons",
"description": "designation of the contact person in the organisation. Maximum length [50]"
},
"department": {
"type": "schema",
"module": "contact-persons",
"description": "department to which the contact person belongs. Maximum length [50]"
},
"enable_portal": {
"type": "schema",
"module": "contact-persons",
"description": "option to enable or disable portal access the contact person. allowed values true,false"
},
"is_added_in_portal": {
"type": "schema",
"module": "contact-persons",
"description": "tells whether the contact person has portal access or not"
},
"is_sms_enabled": {
"type": "schema",
"module": "salesorders",
"description": "Used to check if SMS communication preference is enabled for the contact person at transaction level."
},
"is_whatsapp_enabled": {
"type": "schema",
"module": "salesorders",
"description": "Used to check if WhatsApp communication preference is enabled for the contact person at transaction level."
},
"communication_preference": {
"type": "schema",
"module": "salesorders",
"description": "Preferred modes of communication for the contact person at transaction level."
},
"communication_preference.is_sms_enabled": {
"type": "property",
"dataType": "string",
"description": ""
},
"communication_preference.is_whatsapp_enabled": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_persons": {
"type": "schema",
"module": "shipmentorders",
"description": "Array of contact person IDs."
},
"contact_persons.salutation": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_persons.first_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_persons.last_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_persons.email": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_persons.phone": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_persons.mobile": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_persons.is_primary_contact": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_persons.communication_preference": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-person-request": {
"type": "schema",
"module": "contact-persons",
"description": ""
},
"create-a-contact-person-request.contact_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-person-request.salutation": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-person-request.first_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-person-request.last_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-person-request.email": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-person-request.phone": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-person-request.mobile": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-person-request.skype": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-person-request.designation": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-person-request.department": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-person-request.enable_portal": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-person-request.communication_preference": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-person-response": {
"type": "schema",
"module": "contact-persons",
"description": ""
},
"create-a-contact-person-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-contact-person-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-person-response.contact_person": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-a-contact-person-request": {
"type": "schema",
"module": "contact-persons",
"description": ""
},
"update-a-contact-person-request.contact_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-person-request.salutation": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-person-request.first_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-person-request.last_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-person-request.email": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-person-request.phone": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-person-request.mobile": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-person-request.skype": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-person-request.designation": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-person-request.department": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-person-request.enable_portal": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-person-request.communication_preference": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-person-response": {
"type": "schema",
"module": "contact-persons",
"description": ""
},
"update-a-contact-person-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-contact-person-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-person-response.contact_person": {
"type": "property",
"dataType": "array",
"description": ""
},
"delete-a-contact-person-response": {
"type": "schema",
"module": "contact-persons",
"description": ""
},
"delete-a-contact-person-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-contact-person-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-contact-persons-response": {
"type": "schema",
"module": "contact-persons",
"description": ""
},
"list-contact-persons-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-contact-persons-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-contact-persons-response.contact_persons": {
"type": "property",
"dataType": "array",
"description": ""
},
"get-a-contact-person-response": {
"type": "schema",
"module": "contact-persons",
"description": ""
},
"get-a-contact-person-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-contact-person-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-contact-person-response.contact_person": {
"type": "property",
"dataType": "object",
"description": ""
},
"mark-as-primary-contact-person-response": {
"type": "schema",
"module": "contact-persons",
"description": ""
},
"mark-as-primary-contact-person-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-as-primary-contact-person-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"contacts": {
"type": "schema",
"module": "invoices",
"description": "Contacts to whom email or snail mail has to be sent."
},
"create_contact": {
"type": "operation",
"method": "POST",
"path": "/contacts",
"summary": "Create a Contact",
"description": "Create a contact with given information."
},
"list_contacts": {
"type": "operation",
"method": "GET",
"path": "/contacts",
"summary": "List contacts",
"description": "List all contacts with pagination."
},
"contact_name": {
"type": "schema",
"module": "tasks",
"description": "Name of the contact associated with the task."
},
"company_name": {
"type": "schema",
"module": "contacts",
"description": "Name of the conact's company. Maximum length [200]"
},
"update_contact": {
"type": "operation",
"method": "PUT",
"path": "/contacts/{contact_id}",
"summary": "Update a contact",
"description": "Update an existing contact. To delete a contact person remove it from the contact_persons list."
},
"get_contact": {
"type": "operation",
"method": "GET",
"path": "/contacts/{contact_id}",
"summary": "Get contact",
"description": "Get details of a contact."
},
"delete_contact": {
"type": "operation",
"method": "DELETE",
"path": "/contacts/{contact_id}",
"summary": "Delete a contact",
"description": "Delete an existing contact."
},
"get_contact_address": {
"type": "operation",
"method": "GET",
"path": "/contacts/{contact_id}/address",
"summary": "Get contact address",
"description": "Get the billing and shipping address of an existing contact"
},
"mark_contact_as_active": {
"type": "operation",
"method": "POST",
"path": "/contacts/{contact_id}/active",
"summary": "Mark as active",
"description": "Mark a contact as active."
},
"mark_contact_as_inactive": {
"type": "operation",
"method": "POST",
"path": "/contacts/{contact_id}/inactive",
"summary": "Mark as Inactive",
"description": "Mark a contact as inactive."
},
"email_statement": {
"type": "operation",
"method": "POST",
"path": "/contacts/{contact_id}/statements/email",
"summary": "Email statement",
"description": "Email statement to the contact. If JSONString is not inputted, mail will be sent with the default mail content."
},
"start_date": {
"type": "schema",
"module": "contacts",
"description": "If start_date and end_date are not given, current month's statement will be sent to contact."
},
"end_date": {
"type": "schema",
"module": "contacts",
"description": "End date for statement."
},
"multipart_or_formdata": {
"type": "schema",
"module": "contacts",
"description": "Files to be attached along with the statement."
},
"get_statement_mail_content": {
"type": "operation",
"method": "GET",
"path": "/contacts/{contact_id}/statements/email",
"summary": "Get Statement mail content",
"description": "Get the mail content of a contacts billing statement."
},
"email_contact": {
"type": "operation",
"method": "POST",
"path": "/contacts/{contact_id}/email",
"summary": "Email contact",
"description": "Send email to contact."
},
"send_customer_statement": {
"type": "schema",
"module": "retainer-invoices",
"description": "Send customer statement pdf a with email."
},
"list_contact_comments": {
"type": "operation",
"method": "GET",
"path": "/contacts/{contact_id}/comments",
"summary": "List Comments",
"description": "List recent activities of a contact."
},
"contact-response": {
"type": "schema",
"module": "contacts",
"description": ""
},
"contact-response.contact_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.contact_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.company_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.has_transaction": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.contact_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.is_linked_with_zohocrm": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.website": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.primary_contact_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.payment_terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.payment_terms_label": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.currency_symbol": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.language_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.outstanding_receivable_amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.outstanding_receivable_amount_bcy": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.unused_credits_receivable_amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.unused_credits_receivable_amount_bcy": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.payment_reminder_enabled": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.opening_balances": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.billing_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.shipping_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.facebook": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.twitter": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.contact_persons": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.default_templates": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.is_taxable": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.tax_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.tax_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.tax_authority_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.tax_exemption_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.tax_authority_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.tax_exemption_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.place_of_contact": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.vat_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.tax_regime": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.legal_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.is_tds_registered": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact-response.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote_refunds": {
"type": "schema",
"module": "contacts",
"description": "Details of credit notes refunded"
},
"creditnote_refund_id": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"creditnote_id": {
"type": "schema",
"module": "salesreturns",
"description": "Unique ID of the credit note generated by the server."
},
"refund_mode": {
"type": "schema",
"module": "vendor-credits",
"description": "Mode of Refund"
},
"creditnote_number": {
"type": "schema",
"module": "salesreturns",
"description": "Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Max-Length [100]"
},
"customer_name": {
"type": "schema",
"module": "vendor-credits",
"description": "Vendor associated with the Entity"
},
"amount_bcy": {
"type": "schema",
"module": "vendor-credits",
"description": "Refund Amount in Base Currency"
},
"amount_fcy": {
"type": "schema",
"module": "vendor-credits",
"description": "Refund Amount in Foreign Currency"
},
"applied_filter": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"report_name": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"comment_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the Comment"
},
"commented_by_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the User who caused the comment"
},
"date_description": {
"type": "schema",
"module": "vendor-credits",
"description": "Description of the Date of the Comment"
},
"commented_by": {
"type": "schema",
"module": "vendor-credits",
"description": "Name of the User who caused the comment"
},
"time": {
"type": "schema",
"module": "vendor-credits",
"description": "Time of the Comment"
},
"transaction_id": {
"type": "schema",
"module": "vendor-credits",
"description": "Transaction ID that caused the Comment"
},
"transaction_type": {
"type": "schema",
"module": "vendor-credits",
"description": "Transaction Type that caused the Comment"
},
"is_entity_deleted": {
"type": "schema",
"module": "contacts",
"description": "Boolean check to check entity availability"
},
"attachments": {
"type": "schema",
"module": "retainer-invoices",
"description": "Files to be attached to the email"
},
"file_name": {
"type": "schema",
"module": "vendor-credits",
"description": "Name of the file"
},
"data": {
"type": "schema",
"module": "contacts",
"description": "Data of the email"
},
"user_name": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"error_list": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"send_from_org_email_id": {
"type": "schema",
"module": "retainer-invoices",
"description": "Boolean to trigger the email from the organization's email address"
},
"to_mail_ids": {
"type": "schema",
"module": "retainer-invoices",
"description": "Array of email address of the recipients."
},
"cc_mail_ids": {
"type": "schema",
"module": "retainer-invoices",
"description": "Array of email address of the recipients to be cced."
},
"subject": {
"type": "schema",
"module": "retainer-invoices",
"description": "The subject of the mail"
},
"body": {
"type": "schema",
"module": "retainer-invoices",
"description": "The body of the mail"
},
"address_id": {
"type": "schema",
"module": "contacts",
"description": "Address ID of the contact"
},
"contact_type": {
"type": "schema",
"module": "tasks",
"description": "Type of the contact associated with the task. Allowed values are customer and vendor"
},
"payment_terms": {
"type": "schema",
"module": "invoices",
"description": "Payment terms in days e.g. 15, 30, 60. Invoice due date will be calculated based on this. Maximum length [100]"
},
"payment_terms_label": {
"type": "schema",
"module": "invoices",
"description": "Used to override the default payment terms label. Default value for 15 days is \"Net 15 Days\". Maximum length [100]"
},
"selected": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"facebook": {
"type": "schema",
"module": "contacts",
"description": "Facebook profile account of the contact. Maximum length [100]"
},
"twitter": {
"type": "schema",
"module": "contacts",
"description": "Twitter account of the contact. MAximum length [100]"
},
"invoice_template_id": {
"type": "schema",
"module": "contacts",
"description": "ID of the Invoice template used"
},
"invoice_template_name": {
"type": "schema",
"module": "contacts",
"description": "Name of the invoice template used"
},
"estimate_template_id": {
"type": "schema",
"module": "contacts",
"description": "ID of the estimate template used"
},
"estimate_template_name": {
"type": "schema",
"module": "contacts",
"description": "Name of the estimate template used"
},
"creditnote_template_id": {
"type": "schema",
"module": "contacts",
"description": "ID of teh credit note template used"
},
"creditnote_template_name": {
"type": "schema",
"module": "contacts",
"description": "Name of the credit note template used"
},
"invoice_email_template_id": {
"type": "schema",
"module": "contacts",
"description": "ID of the invoice email tempalte used"
},
"invoice_email_template_name": {
"type": "schema",
"module": "contacts",
"description": "Name of the Invoice email template used"
},
"estimate_email_template_id": {
"type": "schema",
"module": "contacts",
"description": "ID of the estimate email template used"
},
"estimate_email_template_name": {
"type": "schema",
"module": "contacts",
"description": "Name of the estimate email template used"
},
"creditnote_email_template_id": {
"type": "schema",
"module": "contacts",
"description": "ID of the credit note email template"
},
"creditnote_email_template_name": {
"type": "schema",
"module": "contacts",
"description": "Name of the credit note email template"
},
"has_transaction": {
"type": "schema",
"module": "contacts",
"description": "Boolean to check if the customer has a history of transaction"
},
"is_linked_with_zohocrm": {
"type": "schema",
"module": "items",
"description": "Denotes if the item is linked to Zoho CRM"
},
"primary_contact_id": {
"type": "schema",
"module": "contacts",
"description": "Primary contact ID for a contact. This can be a contact person's ID as well."
},
"outstanding_receivable_amount": {
"type": "schema",
"module": "contacts",
"description": "Outsatnding amount with the contact, which is due for receipt"
},
"outstanding_receivable_amount_bcy": {
"type": "schema",
"module": "contacts",
"description": "outstanding receivable in base currency"
},
"unused_credits_receivable_amount": {
"type": "schema",
"module": "contacts",
"description": "Our Unused credits with the vendor which is receivable"
},
"unused_credits_receivable_amount_bcy": {
"type": "schema",
"module": "contacts",
"description": "receivable unused credits in base currency"
},
"payment_reminder_enabled": {
"type": "schema",
"module": "invoices",
"description": "Boolean to check if reminders have been enabled"
},
"street2": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"website": {
"type": "schema",
"module": "organizations",
"description": "Organisation's website"
},
"index": {
"type": "schema",
"module": "organizations",
"description": "Index used to list"
},
"opening_balance_amount": {
"type": "schema",
"module": "contacts",
"description": "Opening balance amount for a contact."
},
"opening_balances": {
"type": "schema",
"module": "contacts",
"description": "List of opening balances"
},
"tax_authority_id": {
"type": "schema",
"module": "taxes",
"description": "ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority."
},
"avatax_use_code": {
"type": "schema",
"module": "invoices",
"description": "Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Maximum length [25]"
},
"avatax_exempt_no": {
"type": "schema",
"module": "invoices",
"description": "Exemption certificate number of the customer. Maximum length [25]"
},
"vat_treatment": {
"type": "schema",
"module": "vendor-credits",
"description": "VAT treatment for the invoice. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the vendor is in an EU country & VAT registered, you are resides in Northen Ireland and purchasing Goods then his VAT treatment is eu_vat_registered and if he resides outside the EU then his VAT treatment is overseas(For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu)."
},
"tax_regime": {
"type": "schema",
"module": "contacts",
"description": "Tax Regime of the contact.Allowed Values: general_legal_person, legal_entities_non_profit, resident_abroad, production_cooperative_societies, agricultural_livestock, optional_group_of_companies, coordinated, simplified_trust, wages_salaries_income, lease, property_disposal_acquisition, other_income, resident_abroad, divident_income, individual_business_professional, interest_income, income_obtaining_price, no_tax_obligation, tax_incorporation, income_through_technology_platform, simplified_trust."
},
"legal_name": {
"type": "schema",
"module": "contacts",
"description": "Legal Name of the contact."
},
"is_tds_registered": {
"type": "schema",
"module": "contacts",
"description": "Boolean to check if tax is registered."
},
"country_code": {
"type": "schema",
"module": "taxes",
"description": "Two letter country code for the EU country to which the tax belongs."
},
"vat_reg_no": {
"type": "schema",
"module": "credit-notes",
"description": "Enter VAT registration number."
},
"tax_reg_no": {
"type": "schema",
"module": "contacts",
"description": "12 digit Tax Registration number of a contact with Tax treatment as home_country_mexico, border_region_mexico, non_mexico. Consumers generic RFC: XAXX010101000, Overseas generic RFC: XEXX010101000"
},
"street": {
"type": "schema",
"module": "contacts",
"description": "Street of the customer's billing address."
},
"state_code": {
"type": "schema",
"module": "locations",
"description": "State code of the location."
},
"s_street": {
"type": "schema",
"module": "contacts",
"description": "Street of the customer's billing address."
},
"s_city": {
"type": "schema",
"module": "contacts",
"description": "City of the customer's billing address."
},
"s_state": {
"type": "schema",
"module": "contacts",
"description": "State of the customer's billing address."
},
"s_zip": {
"type": "schema",
"module": "contacts",
"description": "Zip code of the customer's billing address."
},
"s_country": {
"type": "schema",
"module": "contacts",
"description": "Country of the customer's billing address."
},
"s_fax": {
"type": "schema",
"module": "contacts",
"description": "Customer's fax number."
},
"attention": {
"type": "schema",
"module": "purchaseorders",
"description": "Name of the person, whose attention is required."
},
"billing_address.attention": {
"type": "property",
"dataType": "string",
"description": ""
},
"billing_address.address": {
"type": "property",
"dataType": "string",
"description": ""
},
"billing_address.street2": {
"type": "property",
"dataType": "string",
"description": ""
},
"billing_address.city": {
"type": "property",
"dataType": "string",
"description": ""
},
"billing_address.state": {
"type": "property",
"dataType": "string",
"description": ""
},
"billing_address.zip": {
"type": "property",
"dataType": "string",
"description": ""
},
"billing_address.country": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipping_address": {
"type": "schema",
"module": "shipmentorders",
"description": "Customer's shipping address. It contains - address, city, state, zip, country and fax."
},
"shipping_address.attention": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipping_address.address": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipping_address.street2": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipping_address.city": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipping_address.state": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipping_address.zip": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipping_address.country": {
"type": "property",
"dataType": "string",
"description": ""
},
"default_templates": {
"type": "schema",
"module": "contacts",
"description": ""
},
"default_templates.invoice_template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"default_templates.invoice_template_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"default_templates.estimate_template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"default_templates.estimate_template_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"default_templates.creditnote_template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"default_templates.creditnote_template_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"default_templates.invoice_email_template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"default_templates.invoice_email_template_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"default_templates.estimate_email_template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"default_templates.estimate_email_template_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"default_templates.creditnote_email_template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"default_templates.creditnote_email_template_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"from_emails": {
"type": "schema",
"module": "invoices",
"description": "Email sender address"
},
"to_contacts": {
"type": "schema",
"module": "invoices",
"description": "Email recepients"
},
"contact_comments": {
"type": "schema",
"module": "contacts",
"description": "Comments added by a contact"
},
"language_code": {
"type": "schema",
"module": "organizations",
"description": "Language for use"
},
"place_of_contact": {
"type": "schema",
"module": "contacts",
"description": "Location of the contact. (This node identifies the place of supply and source of supply when invoices/bills are raised for the customer/vendor respectively. This is not applicable for Overseas contacts)"
},
"tax_authority_name": {
"type": "schema",
"module": "taxes",
"description": "Name of the TAX authority"
},
"create-a-contact-request": {
"type": "schema",
"module": "contacts",
"description": ""
},
"create-a-contact-request.contact_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.company_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.payment_terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.website": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.contact_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.custom_fields": {
"type": "property",
"dataType": "array",
"description": "Custom fields or Additional of the contact which we can create to add more information."
},
"create-a-contact-request.opening_balances": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.billing_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.shipping_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.contact_persons": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.default_templates": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.language_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.vat_reg_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.tax_reg_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.country_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.vat_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.tax_regime": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.legal_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.is_tds_registered": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.avatax_exempt_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.avatax_use_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.tax_exemption_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.tax_authority_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.is_taxable": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.facebook": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.twitter": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.place_of_contact": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.tax_authority_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-request.tax_exemption_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-response": {
"type": "schema",
"module": "contacts",
"description": ""
},
"create-a-contact-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-contact-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-contact-response.contact": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-contacts-response": {
"type": "schema",
"module": "contacts",
"description": ""
},
"list-contacts-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-contacts-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-contacts-response.contacts": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-a-contact-request": {
"type": "schema",
"module": "contacts",
"description": ""
},
"update-a-contact-request.contact_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.company_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.payment_terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.contact_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.website": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.opening_balances": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.billing_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.shipping_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.contact_persons": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.default_templates": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.language_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.vat_reg_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.tax_reg_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.country_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.tax_regime": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.legal_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.is_tds_registered": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.vat_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.avatax_exempt_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.avatax_use_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.tax_exemption_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.tax_authority_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.is_taxable": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.facebook": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.twitter": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.place_of_contact": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.tax_authority_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-request.tax_exemption_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-response": {
"type": "schema",
"module": "contacts",
"description": ""
},
"update-a-contact-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-contact-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-contact-response.contact": {
"type": "property",
"dataType": "object",
"description": ""
},
"get-contact-response": {
"type": "schema",
"module": "contacts",
"description": ""
},
"get-contact-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-contact-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-contact-response.contact": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-contact-response": {
"type": "schema",
"module": "contacts",
"description": ""
},
"delete-a-contact-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-contact-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-contact-address-response": {
"type": "schema",
"module": "contacts",
"description": ""
},
"get-contact-address-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-contact-address-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-contact-address-response.addresses": {
"type": "property",
"dataType": "array",
"description": ""
},
"email-statement-request": {
"type": "schema",
"module": "contacts",
"description": ""
},
"email-statement-request.send_from_org_email_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-statement-request.to_mail_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-statement-request.cc_mail_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-statement-request.subject": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-statement-request.body": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-statement-response": {
"type": "schema",
"module": "contacts",
"description": ""
},
"email-statement-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"email-statement-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-statement-mail-content-response": {
"type": "schema",
"module": "contacts",
"description": ""
},
"get-statement-mail-content-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-statement-mail-content-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-statement-mail-content-response.body": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-statement-mail-content-response.subject": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-statement-mail-content-response.to_contacts": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-statement-mail-content-response.file_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-statement-mail-content-response.from_emails": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-statement-mail-content-response.contact_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-contact-request": {
"type": "schema",
"module": "contacts",
"description": ""
},
"email-contact-request.to_mail_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-contact-request.subject": {
"type": "property",
"dataType": "string",
"description": "Subject of an email has to be sent. Maximum length [1000]"
},
"email-contact-request.body": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-contact-request.attachments": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-contact-response": {
"type": "schema",
"module": "contacts",
"description": ""
},
"email-contact-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"email-contact-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-comments-response": {
"type": "schema",
"module": "contacts",
"description": ""
},
"list-comments-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-comments-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-comments-response.contact_comments": {
"type": "property",
"dataType": "string",
"description": ""
},
"credit-notes": {
"type": "tag",
"description": "Credit-Notes Module"
},
"create_credit_note": {
"type": "operation",
"method": "POST",
"path": "/creditnotes",
"summary": "Create a credit note",
"description": "To create a credit note for a customer."
},
"invoice_id": {
"type": "schema",
"module": "salesorders",
"description": "Unique ID generated by the server for the invoice. This is used as an identifier."
},
"list_credit_notes": {
"type": "operation",
"method": "GET",
"path": "/creditnotes",
"summary": "List all Credit Notes",
"description": "List all the Credit Notes."
},
"total": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"item_name": {
"type": "schema",
"module": "vendor-credits",
"description": "Search vendor credits by item name. Variants: item_name_startswith and item_name_contains."
},
"customer_id": {
"type": "schema",
"module": "vendor-credits",
"description": "Search vendor credits by vendor credit customer ID"
},
"item_description": {
"type": "schema",
"module": "vendor-credits",
"description": "Search vendor credits by vendor credit item description. Variants: item_description_startswith and item_description_contains."
},
"update_credit_note": {
"type": "operation",
"method": "PUT",
"path": "/creditnotes/{creditnote_id}",
"summary": "Update a credit note",
"description": "To update the details of an existing creditnote."
},
"get_credit_note": {
"type": "operation",
"method": "GET",
"path": "/creditnotes/{creditnote_id}",
"summary": "Get a credit note",
"description": "Fetch the details of an existing creditnote."
},
"print": {
"type": "schema",
"module": "vendor-credits",
"description": "Export vendor credit pdf with default print option. Allowed Values: true, false, on and off."
},
"accept": {
"type": "schema",
"module": "vendor-credits",
"description": "You can get vendor credit details as json/pdf/html. Default format is html. Allowed Values: json, xml, csv, xls, pdf, html and jhtml."
},
"delete_credit_note": {
"type": "operation",
"method": "DELETE",
"path": "/creditnotes/{creditnote_id}",
"summary": "Delete a credit note",
"description": "Delete an existing credit note."
},
"email_credit_note": {
"type": "operation",
"method": "POST",
"path": "/creditnotes/{creditnote_id}/email",
"summary": "Email a credit note",
"description": "Email a credit note."
},
"get_credit_note_email_content": {
"type": "operation",
"method": "GET",
"path": "/creditnotes/{creditnote_id}/email",
"summary": "Get email content",
"description": "Get email content of a credit note."
},
"email_template_id": {
"type": "schema",
"module": "retainer-invoices",
"description": "Get the email content based on a specific email template. If this param is not inputted, then the content will be based on the email template associated with the customer. If no template is associated with the customer, then default template will be used."
},
"mark_credit_note_as_void": {
"type": "operation",
"method": "POST",
"path": "/creditnotes/{creditnote_id}/void",
"summary": "Void a Credit Note",
"description": "Mark the credit note as Void."
},
"mark_credit_note_as_draft": {
"type": "operation",
"method": "POST",
"path": "/creditnotes/{creditnote_id}/draft",
"summary": "Convert Credit Note to Draft.",
"description": "Convert a voided credit note to Draft."
},
"mark_credit_note_as_open": {
"type": "operation",
"method": "POST",
"path": "/creditnotes/{creditnote_id}/converttoopen",
"summary": "Convert credit note to Open",
"description": "Convert a credit note in Draft status to Open."
},
"submit_credit_note": {
"type": "operation",
"method": "POST",
"path": "/creditnotes/{creditnote_id}/submit",
"summary": "Submit a credit note for approval",
"description": "Submit a credit note for approval."
},
"approve_credit_note": {
"type": "operation",
"method": "POST",
"path": "/creditnotes/{creditnote_id}/approve",
"summary": "Approve a credit note.",
"description": "Approve a credit note."
},
"get_credit_note_email_history": {
"type": "operation",
"method": "GET",
"path": "/creditnotes/{creditnote_id}/emailhistory",
"summary": "Email history",
"description": "Get email history of a credit code."
},
"update_credit_note_billing_address": {
"type": "operation",
"method": "PUT",
"path": "/creditnotes/{creditnote_id}/address/billing",
"summary": "Update billing address",
"description": "Updates the billing address for an existing credit note."
},
"update_credit_note_shipping_address": {
"type": "operation",
"method": "PUT",
"path": "/creditnotes/{creditnote_id}/address/shipping",
"summary": "Update Shipping address",
"description": "Updates the shipping address for an existing credit note."
},
"list_credit_note_templates": {
"type": "operation",
"method": "GET",
"path": "/creditnotes/templates",
"summary": "List the credit note templates",
"description": "Get all credit note pdf templates."
},
"update_credit_note_template": {
"type": "operation",
"method": "PUT",
"path": "/creditnotes/{creditnote_id}/templates/{template_id}",
"summary": "Update a credit note template",
"description": "Update the pdf template associated with the credit note."
},
"template_id": {
"type": "schema",
"module": "tasks",
"description": "ID of the template used for the task."
},
"list_invoices_credited": {
"type": "operation",
"method": "GET",
"path": "/creditnotes/{creditnote_id}/invoices",
"summary": "List invoices credited",
"description": "List invoices to which the credit note is applied."
},
"apply_credits_to_invoices": {
"type": "operation",
"method": "POST",
"path": "/creditnotes/{creditnote_id}/invoices",
"summary": "Apply credits to invoices",
"description": "Apply credit note to existing invoices."
},
"delete_credits_applied_to_invoice": {
"type": "operation",
"method": "DELETE",
"path": "/creditnotes/{creditnote_id}/invoices/{creditnote_invoice_id}",
"summary": "Delete credits applied to an invoice",
"description": "Delete the credits applied to an invoice."
},
"list_credit_note_comments": {
"type": "operation",
"method": "GET",
"path": "/creditnotes/{creditnote_id}/comments",
"summary": "List credit note comments & history",
"description": "Get history and comments of a credit note."
},
"create_credit_note_comment": {
"type": "operation",
"method": "POST",
"path": "/creditnotes/{creditnote_id}/comments",
"summary": "Add a comment",
"description": "Add a comment to an existing credit note."
},
"delete_credit_note_comment": {
"type": "operation",
"method": "DELETE",
"path": "/creditnotes/{creditnote_id}/comments/{comment_id}",
"summary": "Delete a Comment",
"description": "Delete a credit note comment."
},
"list_credit_note_refunds_of_all_credit_notes": {
"type": "operation",
"method": "GET",
"path": "/creditnotes/refunds",
"summary": "List credit note refunds",
"description": "List all refunds with pagination."
},
"list_credit_note_refunds_of_a_credit_notes": {
"type": "operation",
"method": "GET",
"path": "/creditnotes/{creditnote_id}/refunds",
"summary": "List refunds of a credit note",
"description": "List all refunds of an existing credit note."
},
"create_credit_note_refund": {
"type": "operation",
"method": "POST",
"path": "/creditnotes/{creditnote_id}/refunds",
"summary": "Refund credit note",
"description": "Refund credit note amount."
},
"get_credit_note_refund": {
"type": "operation",
"method": "GET",
"path": "/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id}",
"summary": "Get credit note refund",
"description": "Fetch the refund of a particular credit note."
},
"update_credit_note_refund": {
"type": "operation",
"method": "PUT",
"path": "/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id}",
"summary": "Update credit note refund",
"description": "Update the refunded transaction."
},
"delete_credit_note_refund": {
"type": "operation",
"method": "DELETE",
"path": "/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id}",
"summary": "Delete credit note refund",
"description": "Delete a credit note refund."
},
"creditnote-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"creditnote-response.creditnote_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.creditnote_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.is_pre_gst": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.vat_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.vat_reg_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.cfdi_usage": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.cfdi_reference_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.customer_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.email": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.total": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.balance": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.line_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.invoices": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.taxes": {
"type": "property",
"dataType": "array",
"description": "Taxes associated with the subscription."
},
"creditnote-response.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.currency_symbol": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.billing_address": {
"type": "property",
"dataType": "object",
"description": ""
},
"creditnote-response.shipping_address": {
"type": "property",
"dataType": "object",
"description": ""
},
"creditnote-response.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.updated_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.template_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"creditnote-response.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"cfdi_usage": {
"type": "schema",
"module": "invoices",
"description": "Choose CFDI Usage. Allowed values:acquisition_of_merchandise, return_discount_bonus, general_expense, buildings, furniture_office_equipment, transport_equipment, computer_equipmentdye_molds_tools, telephone_communication, satellite_communication, other_machinery_equipment, hospital_expense, medical_expense_disability, funeral_expense, donation, interest_mortage_loans, contribution_sar, medical_expense_insurance_pormium, school_transportation_expense, deposit_saving_account, payment_educational_service, no_tax_effect, payment, payroll."
},
"cfdi_reference_type": {
"type": "schema",
"module": "invoices",
"description": "Choose CFDI Reference Type. Allowed values:return_of_merchandise, substitution_previous_cfdi, transfer_of_goods, invoice_generated_from_order, cfdi_for_advance."
},
"place_of_supply": {
"type": "schema",
"module": "vendor-credits",
"description": "The place of supply is where a transaction is considered to have occurred for VAT purposes. For the supply of goods, the place of supply is the location of the goods when the supply occurs. For the supply of services, the place of supply should be where the supplier is established. (If not given, place of contact given for the contact will be taken)
Supported codes for UAE emirates are : Abu Dhabi - AB,Ajman - AJ,Dubai - DU,Fujairah - FU,Ras al-Khaimah - RA,Sharjah - SH,Umm al-Quwain - UM.
Supported codes for the GCC countries are : United Arab Emirates - AE,Saudi Arabia - SA,Bahrain - BH,Kuwait - KW,Oman - OM,Qatar - QA."
},
"sat_item_key_code": {
"type": "schema",
"module": "salesorders",
"description": "Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs."
},
"unitkey_code": {
"type": "schema",
"module": "salesorders",
"description": "Add SAT Unit Key Code for your goods/services. Download the CFDI Catalogs."
},
"discount": {
"type": "schema",
"module": "shipmentorders",
"description": "Discount applied to the shipment order, which can be either a percentage or a flat amount. For percentage discounts, the value should include the % symbol (e.g., 10%). For example, on Rs.1000, a 10% discount results in Rs.900, while a flat Rs.200 discount results in Rs.800."
},
"from_account_id": {
"type": "schema",
"module": "credit-notes",
"description": "The account from which credit note is refunded."
},
"is_draft": {
"type": "schema",
"module": "reporting-tags",
"description": "Is tag still in draft state"
},
"comment_type": {
"type": "schema",
"module": "vendor-credits",
"description": "Type of the comment"
},
"code": {
"type": "schema",
"module": "serialnumbers",
"description": "Code of the serial number. Same value as serialnumber."
},
"amount_applied": {
"type": "schema",
"module": "vendor-credits",
"description": "Amount applied to the bill."
},
"type": {
"type": "schema",
"module": "taxes",
"description": "Type of the tax exemption, can be customer or item."
},
"template_name": {
"type": "schema",
"module": "shipmentorders",
"description": "Name of the template used for the Shipment."
},
"invoice_number": {
"type": "schema",
"module": "salesorders",
"description": "The number of the Invoice."
},
"invoices": {
"type": "schema",
"module": "salesorders",
"description": "Invoices created for the Sales Order. Each invoice contains - invoice_id, invoice_number, status, date, due_date, total, balance."
},
"from": {
"type": "schema",
"module": "credit-notes",
"description": "The email ID from which the credit note is to be mailed."
},
"updated_time": {
"type": "schema",
"module": "customer-payments",
"description": "Time when the payment details were last updated."
},
"from_mail_id_alias": {
"type": "schema",
"module": "credit-notes",
"description": "The email ID from which the credit note is to be mailed."
},
"to_mail_ids_alias": {
"type": "schema",
"module": "credit-notes",
"description": "The email IDs to which the credit note is to be mailed."
},
"cc_mail_ids_alias": {
"type": "schema",
"module": "credit-notes",
"description": "The email IDs that have to be copied when the credit note is to be mailed."
},
"subject_alias": {
"type": "schema",
"module": "credit-notes",
"description": "The subject of the email."
},
"body_alias": {
"type": "schema",
"module": "credit-notes",
"description": "The body of the email."
},
"contact_person_name": {
"type": "schema",
"module": "salesorders",
"description": "Name of the Contact Person"
},
"contact_person_email": {
"type": "schema",
"module": "salesorders",
"description": "Email ID of the Contact Person."
},
"is_email_enabled": {
"type": "schema",
"module": "salesorders",
"description": "Used to check if Email communication preference is enabled for the contact person at transaction level."
},
"communication_preference.is_email_enabled": {
"type": "property",
"dataType": "string",
"description": ""
},
"contact_persons_associated": {
"type": "schema",
"module": "salesorders",
"description": "Contact Persons associated with the sales order."
},
"contact_persons_associated_payload": {
"type": "schema",
"module": "salesorders",
"description": "Contact Persons associated with the sales order."
},
"avatax_tax_code": {
"type": "schema",
"module": "invoices",
"description": "A tax code is a unique label used to group Items (products, services, or charges) together. Refer the [link][2] for more deails. Maximum length [25]"
},
"data_type": {
"type": "schema",
"module": "packages",
"description": "Data type of the custom field"
},
"creditnote_invoice_id": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"credited_amount": {
"type": "schema",
"module": "credit-notes",
"description": "The total amount that is credited."
},
"mailhistory_id": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"mapped_items_create": {
"type": "schema",
"module": "salesreturns",
"description": "Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item."
},
"mapped_items_update": {
"type": "schema",
"module": "salesreturns",
"description": "Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item."
},
"template-id": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"template_type": {
"type": "schema",
"module": "shipmentorders",
"description": "Type of the template."
},
"invoice_item_id": {
"type": "schema",
"module": "credit-notes",
"description": "line_item_id of the underlying items in the invoice. This node is used when an invoice (of a sales order) or a sales return is converted to a credit note. Along with this node, the invoice_id and the is_item_shipped nodes are mandatory to create a credit note from an invoice and the nodes invoice_id, is_item_shipped, is_returned_to_stock and salesreturn_item_id are required to create a credit note from sales return."
},
"is_item_shipped": {
"type": "schema",
"module": "credit-notes",
"description": "Defines the shipping status of the line item in the corresponding sales order. The value of this node should be 'True' in order to create a credit note from sales return since a sales return can only be created for shipped goods. The value of this node should be 'False' to create a credit note from an invoice since the unshipped items are allowed to be cancelled in the sales order. Along with this node, invoice_id and invoice_item_id nodes are mandatory to create a credit note from an invoice and the nodes invoice_id, invoice_item_id, is_returned_to_stock and salesreturn_item_id are required to create a credit note from sales return."
},
"is_returned_to_stock": {
"type": "schema",
"module": "credit-notes",
"description": "Defines the receivability of the items in the sales return. For example, if a sales return has been raised for five units of an item where three units are receivable and two are credit-only, then that sales return line item has to be split in to two line items in the credit note - receivable quantity and the credit-only quantity. The value of this node has to be true for receivable line item and false for credit-only line item in Credit note. Along with this node, invoice_id, invoice_item_id, is_item_shipped, salesreturn_item_id are also needed to create credit note from Sales Return."
},
"salesreturn_item_id": {
"type": "schema",
"module": "credit-notes",
"description": "line_item_id of the underlying items in the sales return. This node is needed for converting sales return to credit note. Other nodes such as invoice_id, invoice_item_id, is_item_shipped, is_returned_to_stock are also needed to create credit note from Sales Return."
},
"create-a-credit-note-request": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"create-a-credit-note-request.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.is_draft": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Line items of a credit note."
},
"create-a-credit-note-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.creditnote_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.cfdi_usage": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.cfdi_reference_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.ignore_auto_number_generation": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.tax_authority_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.tax_exemption_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.avatax_use_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.avatax_exempt_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.vat_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-request.avatax_tax_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"create-a-credit-note-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-credit-note-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-credit-note-response.creditnote": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-credit-notes-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"list-all-credit-notes-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-credit-notes-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-credit-notes-response.creditnotes": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-a-credit-note-request": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"update-a-credit-note-request.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.is_draft": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Line items of a credit note."
},
"update-a-credit-note-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.creditnote_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.cfdi_usage": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.cfdi_reference_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.ignore_auto_number_generation": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.tax_authority_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.tax_exemption_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.avatax_use_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.avatax_exempt_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.vat_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.avatax_tax_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-request.quantity": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"update-a-credit-note-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-credit-note-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-credit-note-response.creditnote": {
"type": "property",
"dataType": "object",
"description": ""
},
"get-a-credit-note-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"get-a-credit-note-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-credit-note-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-credit-note-response.creditnote": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-credit-note-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"delete-a-credit-note-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-credit-note-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-a-credit-note-request": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"email-a-credit-note-request.to_mail_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-a-credit-note-request.cc_mail_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-a-credit-note-request.subject": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-a-credit-note-request.body": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-a-credit-note-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"email-a-credit-note-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"email-a-credit-note-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-email-content-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"get-email-content-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-email-content-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-email-content-response.data": {
"type": "property",
"dataType": "array",
"description": ""
},
"void-a-credit-note-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"void-a-credit-note-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"void-a-credit-note-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"convert-credit-note-to-draft-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"convert-credit-note-to-draft-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"convert-credit-note-to-draft-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"convert-credit-note-to-open-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"convert-credit-note-to-open-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"convert-credit-note-to-open-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"submit-a-credit-note-for-approval-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"submit-a-credit-note-for-approval-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"submit-a-credit-note-for-approval-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"approve-a-credit-note-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"approve-a-credit-note-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"approve-a-credit-note-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-history-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"email-history-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"email-history-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-history-response.email_history": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-billing-address-request": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"update-billing-address-request.address": {
"type": "property",
"dataType": "string",
"description": "address of the customer"
},
"update-billing-address-request.city": {
"type": "property",
"dataType": "string",
"description": "city of the customer"
},
"update-billing-address-request.state": {
"type": "property",
"dataType": "string",
"description": "state of the customer"
},
"update-billing-address-request.zip": {
"type": "property",
"dataType": "string",
"description": "zip of the customer"
},
"update-billing-address-request.country": {
"type": "property",
"dataType": "string",
"description": "country of the customer"
},
"update-billing-address-request.fax": {
"type": "property",
"dataType": "string",
"description": "fax of the customer"
},
"update-billing-address-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"update-billing-address-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-billing-address-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-shipping-address-request": {
"type": "schema",
"module": "invoices",
"description": ""
},
"update-shipping-address-request.address": {
"type": "property",
"dataType": "string",
"description": "Shipping address of the customer"
},
"update-shipping-address-request.city": {
"type": "property",
"dataType": "string",
"description": "City of the contact's shipping address"
},
"update-shipping-address-request.state": {
"type": "property",
"dataType": "string",
"description": "State of the Contact's shipping address"
},
"update-shipping-address-request.zip": {
"type": "property",
"dataType": "string",
"description": "ZIP code of the contact's shipping address"
},
"update-shipping-address-request.country": {
"type": "property",
"dataType": "string",
"description": "Contact's country for the given shipping address"
},
"update-shipping-address-request.fax": {
"type": "property",
"dataType": "string",
"description": "FAX number of the contact"
},
"update-shipping-address-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"update-shipping-address-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-shipping-address-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-the-credit-note-templates-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"list-the-credit-note-templates-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-the-credit-note-templates-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-the-credit-note-templates-response.templates": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-a-credit-note-template-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"update-a-credit-note-template-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-credit-note-template-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-invoices-credited-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"list-invoices-credited-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-invoices-credited-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-invoices-credited-response.invoices_credited": {
"type": "property",
"dataType": "array",
"description": ""
},
"apply-credits-to-invoices-request": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"apply-credits-to-invoices-request.invoices": {
"type": "property",
"dataType": "array",
"description": "List of invoices for which the credit note has been raised. This contains invoice_id and amount."
},
"apply-credits-to-invoices-request.invoice_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"apply-credits-to-invoices-request.amount_applied": {
"type": "property",
"dataType": "string",
"description": ""
},
"apply-credits-to-invoices-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"apply-credits-to-invoices-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"apply-credits-to-invoices-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-credits-applied-to-an-invoice-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"delete-credits-applied-to-an-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-credits-applied-to-an-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-credit-note-comments-and-history-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"list-credit-note-comments-and-history-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-credit-note-comments-and-history-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-credit-note-comments-and-history-response.comments": {
"type": "property",
"dataType": "array",
"description": ""
},
"add-a-comment-request": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"add-a-comment-request.description": {
"type": "property",
"dataType": "string",
"description": "Description of the Comment"
},
"add-a-comment-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"add-a-comment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"add-a-comment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-a-comment-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"delete-a-comment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-comment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-credit-note-refunds-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"list-credit-note-refunds-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-credit-note-refunds-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-credit-note-refunds-response.creditnote_refunds": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-credit-note-refunds-response.page_context": {
"type": "property",
"dataType": "object",
"description": ""
},
"list-refunds-of-a-credit-note-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"list-refunds-of-a-credit-note-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-refunds-of-a-credit-note-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-refunds-of-a-credit-note-response.creditnote_refunds": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-refunds-of-a-credit-note-response.page_context": {
"type": "property",
"dataType": "object",
"description": ""
},
"refund-credit-note-request": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"refund-credit-note-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-credit-note-request.refund_mode": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-credit-note-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-credit-note-request.amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-credit-note-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-credit-note-request.from_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-credit-note-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-credit-note-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"refund-credit-note-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"refund-credit-note-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-credit-note-response.creditnote_refund": {
"type": "property",
"dataType": "object",
"description": ""
},
"get-credit-note-refund-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"get-credit-note-refund-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-credit-note-refund-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-credit-note-refund-response.creditnote_refund": {
"type": "property",
"dataType": "object",
"description": ""
},
"update-credit-note-refund-request": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"update-credit-note-refund-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-credit-note-refund-request.refund_mode": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-credit-note-refund-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-credit-note-refund-request.amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-credit-note-refund-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-credit-note-refund-request.from_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-credit-note-refund-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-credit-note-refund-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"update-credit-note-refund-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-credit-note-refund-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-credit-note-refund-response.creditnote_refund": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-credit-note-refund-response": {
"type": "schema",
"module": "credit-notes",
"description": ""
},
"delete-credit-note-refund-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-credit-note-refund-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"currency": {
"type": "tag",
"description": "Currency Module"
},
"create_currency": {
"type": "operation",
"method": "POST",
"path": "/settings/currencies",
"summary": "Create a Currency",
"description": "Create a currency for transaction."
},
"list_currencies": {
"type": "operation",
"method": "GET",
"path": "/settings/currencies",
"summary": "List Currency",
"description": "Get list of currencies configured."
},
"update_currency": {
"type": "operation",
"method": "PUT",
"path": "/settings/currencies/{currency_id}",
"summary": "Update a Currency",
"description": "Update the details of a currency."
},
"get_currency": {
"type": "operation",
"method": "GET",
"path": "/settings/currencies/{currency_id}",
"summary": "Get a Currency",
"description": "Get the details of a currency."
},
"delete_currency": {
"type": "operation",
"method": "DELETE",
"path": "/settings/currencies/{currency_id}",
"summary": "Delete a currency",
"description": "Delete a currency. Currency that is associated to any transaction cannot be deleted."
},
"currency-response": {
"type": "schema",
"module": "currency",
"description": ""
},
"currency-response.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"currency-response.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"currency-response.currency_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"currency-response.currency_symbol": {
"type": "property",
"dataType": "string",
"description": ""
},
"currency-response.price_precision": {
"type": "property",
"dataType": "string",
"description": ""
},
"currency-response.currency_format": {
"type": "property",
"dataType": "string",
"description": ""
},
"currency-response.is_base_currency": {
"type": "property",
"dataType": "string",
"description": ""
},
"currency_name": {
"type": "schema",
"module": "currency",
"description": "The name for the currency."
},
"currency_format": {
"type": "schema",
"module": "organizations",
"description": "Format of the organisation's currency"
},
"is_base_currency": {
"type": "schema",
"module": "currency",
"description": "If the specified currency is the base currency of the organization or not."
},
"effective_date": {
"type": "schema",
"module": "currency",
"description": "Date from when the currency will be in effect."
},
"create-a-currency-request": {
"type": "schema",
"module": "currency",
"description": ""
},
"create-a-currency-request.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-currency-request.currency_symbol": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-currency-request.price_precision": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-currency-request.currency_format": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-currency-response": {
"type": "schema",
"module": "currency",
"description": ""
},
"create-a-currency-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-currency-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-currency-response.currency": {
"type": "property",
"dataType": "array",
"description": "A legal money issued by government of a country"
},
"list-currency-response": {
"type": "schema",
"module": "currency",
"description": ""
},
"list-currency-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-currency-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-currency-response.currencies": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-a-currency-request": {
"type": "schema",
"module": "currency",
"description": ""
},
"update-a-currency-request.currency_code": {
"type": "property",
"dataType": "string",
"description": "Unique code representing a currency"
},
"update-a-currency-request.currency_symbol": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-currency-request.price_precision": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-currency-request.currency_format": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-currency-response": {
"type": "schema",
"module": "currency",
"description": ""
},
"update-a-currency-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-currency-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-currency-response.currency": {
"type": "property",
"dataType": "array",
"description": "List the details of a currency"
},
"get-a-currency-response": {
"type": "schema",
"module": "currency",
"description": ""
},
"get-a-currency-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-currency-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-currency-response.currency": {
"type": "property",
"dataType": "array",
"description": "List of currencies"
},
"delete-a-currency-response": {
"type": "schema",
"module": "currency",
"description": ""
},
"delete-a-currency-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-currency-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"customer-payments": {
"type": "tag",
"description": "Customer-Payments Module"
},
"create_customer_payment": {
"type": "operation",
"method": "POST",
"path": "/customerpayments",
"summary": "Create a payment",
"description": "Create a new payment."
},
"list_customer_payments": {
"type": "operation",
"method": "GET",
"path": "/customerpayments",
"summary": "List Customer Payments",
"description": "List all the payments made by your customer."
},
"update_custom_field_in_customer_payment": {
"type": "operation",
"method": "PUT",
"path": "/customerpayment/{customer_payment_id}/customfields",
"summary": "Update custom field in existing customerpayments",
"description": "Update the value of the custom field in existing customerpayments."
},
"customer_payment_id": {
"type": "parameter",
"in": "path",
"description": "Unique identifier of the customer payment."
},
"update_customer_payment": {
"type": "operation",
"method": "PUT",
"path": "/customerpayments/{payment_id}",
"summary": "Update a payment",
"description": "Update an existing payment information. "
},
"retrieve_customer_payment": {
"type": "operation",
"method": "GET",
"path": "/customerpayments/{payment_id}",
"summary": "Retrieve a payment",
"description": "Details of an existing payment. "
},
"delete_customer_payment": {
"type": "operation",
"method": "DELETE",
"path": "/customerpayments/{payment_id}",
"summary": "Delete a payment",
"description": "Delete an existing payment."
},
"payment-response": {
"type": "schema",
"module": "customer-payments",
"description": "Payment details of the transaction"
},
"payment-response.payment_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.payment_mode": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.amount_refunded": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.bank_charges": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.customer_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.email": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.tax_amount_withheld": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.invoices": {
"type": "property",
"dataType": "array",
"description": "Invoice related to a payment"
},
"payment-response.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.currency_symbol": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.tax_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.tax_account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.unused_amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.last_four_digits": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment-response.custom_fields": {
"type": "property",
"dataType": "array",
"description": "Additional field for a payment"
},
"amount_refunded": {
"type": "schema",
"module": "customer-payments",
"description": "Amount that is refunded. Refunds are applicable only for payments whose payment_mode is autotransaction. Refunds would be made to the respective card provided by the customer."
},
"autotransaction": {
"type": "schema",
"module": "customer-payments",
"description": "If the payment mode is autotransaction, autotransaction information will be displayed in the autotransaction object. It contains autotransaction_id, payment_gateway, gateway_transaction_id, card_id, last_four_digits, expiry_month and expiry_year."
},
"autotransaction_id": {
"type": "schema",
"module": "customer-payments",
"description": "Auto-transaction ID generated for the payment made."
},
"payment_gateway": {
"type": "schema",
"module": "customer-payments",
"description": "Name of the payment gateway associated with payment."
},
"gateway_transaction_id": {
"type": "schema",
"module": "customer-payments",
"description": "Transaction ID provided by the gateway for the transaction."
},
"gateway_error_message": {
"type": "schema",
"module": "customer-payments",
"description": "Gateway error message for a failed transaction."
},
"card_id": {
"type": "schema",
"module": "customer-payments",
"description": "Card ID of the card associated with the transaction."
},
"last_four_digits": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"expiry_month": {
"type": "schema",
"module": "customer-payments",
"description": "Expiry month of the card."
},
"expiry_year": {
"type": "schema",
"module": "customer-payments",
"description": "Expiry year of the card."
},
"invoice_amount": {
"type": "schema",
"module": "customer-payments",
"description": "Total amount raised for the invoice."
},
"balance_amount": {
"type": "schema",
"module": "customer-payments",
"description": "Unpaid amount of the invoice."
},
"payment_form": {
"type": "schema",
"module": "customer-payments",
"description": "Mode of Vendor Payment"
},
"bank_charges": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"tax_amount_withheld": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"unused_amount": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"custom_fields_update": {
"type": "schema",
"module": "invoices",
"description": "Custom fields for an invoice."
},
"update-an-customerpayment-customfield-response": {
"type": "schema",
"module": "customer-payments",
"description": ""
},
"update-an-customerpayment-customfield-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-an-customerpayment-customfield-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment_refund_id": {
"type": "schema",
"module": "customer-payments",
"description": "A unique ID for the payment refund generated by the server."
},
"bcy_amount": {
"type": "schema",
"module": "customer-payments",
"description": ""
},
"tax_account_id": {
"type": "schema",
"module": "taxes",
"description": ""
},
"tax_account_name": {
"type": "schema",
"module": "customer-payments",
"description": "Name of the tax account, in case of withholding tax."
},
"create-a-payment-request": {
"type": "schema",
"module": "customer-payments",
"description": ""
},
"create-a-payment-request.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-payment-request.payment_mode": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-payment-request.amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-payment-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-payment-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-payment-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-payment-request.invoices": {
"type": "property",
"dataType": "array",
"description": "List of invoices associated with the payment. Each invoice object contains invoice_id, invoice_number, date, invoice_amount, amount_applied and balance_amount."
},
"create-a-payment-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-payment-request.payment_form": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-payment-request.bank_charges": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-payment-request.account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-payment-request.tax_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-payment-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-payment-request.custom_fields": {
"type": "property",
"dataType": "array",
"description": "Additional fields for the payments."
},
"create-a-payment-response": {
"type": "schema",
"module": "customer-payments",
"description": ""
},
"create-a-payment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-payment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-payment-response.payment": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-customer-payments-response": {
"type": "schema",
"module": "customer-payments",
"description": ""
},
"list-customer-payments-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-customer-payments-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-customer-payments-response.customerpayments": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-a-payment-request": {
"type": "schema",
"module": "customer-payments",
"description": ""
},
"update-a-payment-request.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-payment-request.payment_mode": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-payment-request.amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-payment-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-payment-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-payment-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-payment-request.invoices": {
"type": "property",
"dataType": "array",
"description": "List of invoices associated with the payment. Each invoice object contains invoice_id, invoice_number, date, invoice_amount, amount_applied and balance_amount."
},
"update-a-payment-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-payment-request.payment_form": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-payment-request.bank_charges": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-payment-request.account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-payment-request.tax_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-payment-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-payment-request.custom_fields": {
"type": "property",
"dataType": "array",
"description": "Additional fields for the payments."
},
"update-a-payment-response": {
"type": "schema",
"module": "customer-payments",
"description": ""
},
"update-a-payment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-payment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-payment-response.payment": {
"type": "property",
"dataType": "object",
"description": "Payment details of the customer"
},
"retrieve-a-payment-response": {
"type": "schema",
"module": "customer-payments",
"description": ""
},
"retrieve-a-payment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieve-a-payment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-a-payment-response.payment": {
"type": "property",
"dataType": "object",
"description": "Payment details of the invoice"
},
"delete-a-payment-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"delete-a-payment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-payment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"delivery-challans": {
"type": "tag",
"description": "Delivery Challans Module"
},
"list_delivery_challans": {
"type": "operation",
"method": "GET",
"path": "/deliverychallans",
"summary": "List delivery challans",
"description": "Retrieve a list of delivery challans with pagination. Filter by status, customer, date, and more."
},
"create_delivery_challan": {
"type": "operation",
"method": "POST",
"path": "/deliverychallans",
"summary": "Create a delivery challan",
"description": "Create a new delivery challan for a customer. The customer ID is required."
},
"get_delivery_challan": {
"type": "operation",
"method": "GET",
"path": "/deliverychallans/{deliverychallan_id}",
"summary": "Retrieve a delivery challan",
"description": "Retrieve the details of an existing delivery challan."
},
"update_delivery_challan": {
"type": "operation",
"method": "PUT",
"path": "/deliverychallans/{deliverychallan_id}",
"summary": "Update a delivery challan",
"description": "Update an existing delivery challan."
},
"delete_delivery_challan": {
"type": "operation",
"method": "DELETE",
"path": "/deliverychallans/{deliverychallan_id}",
"summary": "Delete a delivery challan",
"description": "Delete an existing delivery challan."
},
"mark_delivery_challan_as_open": {
"type": "operation",
"method": "POST",
"path": "/deliverychallans/{deliverychallan_id}/status/open",
"summary": "Mark a delivery challan as open",
"description": "Change the status of a delivery challan to open."
},
"mark_delivery_challan_as_delivered": {
"type": "operation",
"method": "POST",
"path": "/deliverychallans/{deliverychallan_id}/status/delivered",
"summary": "Mark a delivery challan as delivered",
"description": "Change the status of a delivery challan to delivered."
},
"mark_delivery_challan_as_returned": {
"type": "operation",
"method": "POST",
"path": "/deliverychallans/{deliverychallan_id}/status/returned",
"summary": "Mark a delivery challan as returned",
"description": "Change the status of a delivery challan to returned."
},
"mark_delivery_challan_as_undelivered": {
"type": "operation",
"method": "POST",
"path": "/deliverychallans/{deliverychallan_id}/status/undelivered",
"summary": "Mark a delivery challan as undelivered",
"description": "Change the status of a delivery challan to undelivered."
},
"return_delivery_challans": {
"type": "operation",
"method": "PUT",
"path": "/deliverychallans/return",
"summary": "Return delivery challans",
"description": "Partially return one or more delivery challans by specifying the line items and quantities to return."
},
"deliverychallan_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of delivery challan IDs to undo return."
},
"undo_return_delivery_challans": {
"type": "operation",
"method": "PUT",
"path": "/deliverychallans/undo/return",
"summary": "Undo return of delivery challans",
"description": "Undo a previously applied return for one or more delivery challans."
},
"add_attachment_to_delivery_challan": {
"type": "operation",
"method": "POST",
"path": "/deliverychallans/{deliverychallan_id}/attachment",
"summary": "Add attachment to a delivery challan",
"description": "Attach a file to an existing delivery challan. Maximum 20 files, 10 MB each."
},
"get_delivery_challan_attachment": {
"type": "operation",
"method": "GET",
"path": "/deliverychallans/{deliverychallan_id}/documents/{document_id}",
"summary": "Get a delivery challan attachment",
"description": "Download or view an attachment of a delivery challan. Returns the file content directly."
},
"document_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the Document"
},
"delete_delivery_challan_attachment": {
"type": "operation",
"method": "DELETE",
"path": "/deliverychallans/{deliverychallan_id}/documents/{document_id}",
"summary": "Delete a delivery challan attachment",
"description": "Delete an attachment from a delivery challan."
},
"list_delivery_challan_templates": {
"type": "operation",
"method": "GET",
"path": "/deliverychallans/templates",
"summary": "List delivery challan templates",
"description": "Retrieve a list of available templates for delivery challans."
},
"update_delivery_challan_template": {
"type": "operation",
"method": "PUT",
"path": "/deliverychallans/{deliverychallan_id}/templates/{template_id}",
"summary": "Update a delivery challan template",
"description": "Assign a different template to an existing delivery challan."
},
"update_delivery_challan_shipping_address": {
"type": "operation",
"method": "PUT",
"path": "/deliverychallans/{deliverychallan_id}/address/shipping",
"summary": "Update shipping address",
"description": "Update the shipping address of an existing delivery challan."
},
"delivery-challan-response": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"delivery-challan-response.deliverychallan_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the delivery challan."
},
"delivery-challan-response.deliverychallan_number": {
"type": "property",
"dataType": "string",
"description": "Delivery challan number."
},
"delivery-challan-response.date": {
"type": "property",
"dataType": "string",
"description": "Date of the delivery challan in YYYY-MM-DD format."
},
"delivery-challan-response.challan_type": {
"type": "property",
"dataType": "string",
"description": "Type of delivery challan."
},
"delivery-challan-response.reference_number": {
"type": "property",
"dataType": "string",
"description": "Reference number."
},
"delivery-challan-response.status": {
"type": "property",
"dataType": "string",
"description": "Status of the delivery challan."
},
"delivery-challan-response.customer_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the customer."
},
"delivery-challan-response.customer_name": {
"type": "property",
"dataType": "string",
"description": "Name of the customer."
},
"delivery-challan-response.currency_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the currency."
},
"delivery-challan-response.currency_code": {
"type": "property",
"dataType": "string",
"description": "Currency code."
},
"delivery-challan-response.currency_symbol": {
"type": "property",
"dataType": "string",
"description": "Currency symbol."
},
"delivery-challan-response.exchange_rate": {
"type": "property",
"dataType": "number",
"description": "Exchange rate for the currency."
},
"delivery-challan-response.is_discount_before_tax": {
"type": "property",
"dataType": "boolean",
"description": "Whether discount is applied before tax."
},
"delivery-challan-response.discount_type": {
"type": "property",
"dataType": "string",
"description": "Type of discount."
},
"delivery-challan-response.is_inclusive_tax": {
"type": "property",
"dataType": "boolean",
"description": "Whether prices are inclusive of tax."
},
"delivery-challan-response.discount": {
"type": "property",
"dataType": "number",
"description": "Discount applied."
},
"delivery-challan-response.place_of_supply": {
"type": "property",
"dataType": "string",
"description": "Place of supply (applicable for India edition)."
},
"delivery-challan-response.gst_no": {
"type": "property",
"dataType": "string",
"description": "GST number (applicable for India edition)."
},
"delivery-challan-response.gst_treatment": {
"type": "property",
"dataType": "string",
"description": "GST treatment (applicable for India edition)."
},
"delivery-challan-response.tax_treatment": {
"type": "property",
"dataType": "string",
"description": "Tax treatment."
},
"delivery-challan-response.line_items": {
"type": "property",
"dataType": "array",
"description": ""
},
"delivery-challan-response.sub_total": {
"type": "property",
"dataType": "number",
"description": "Sub total of the delivery challan."
},
"delivery-challan-response.tax_total": {
"type": "property",
"dataType": "number",
"description": "Total tax amount."
},
"delivery-challan-response.total": {
"type": "property",
"dataType": "number",
"description": "Total amount of the delivery challan."
},
"delivery-challan-response.adjustment": {
"type": "property",
"dataType": "number",
"description": "Adjustment amount."
},
"delivery-challan-response.adjustment_description": {
"type": "property",
"dataType": "string",
"description": "Description for the adjustment."
},
"delivery-challan-response.shipping_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"delivery-challan-response.notes": {
"type": "property",
"dataType": "string",
"description": "Customer notes for the delivery challan."
},
"delivery-challan-response.terms": {
"type": "property",
"dataType": "string",
"description": "Terms and conditions."
},
"delivery-challan-response.template_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the template."
},
"delivery-challan-response.template_name": {
"type": "property",
"dataType": "string",
"description": "Name of the template."
},
"delivery-challan-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": "Custom fields associated with the delivery challan."
},
"delivery-challan-response.has_qty_returned": {
"type": "property",
"dataType": "boolean",
"description": "Whether any quantity has been returned."
},
"delivery-challan-response.branch_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the branch."
},
"delivery-challan-response.branch_name": {
"type": "property",
"dataType": "string",
"description": "Name of the branch."
},
"delivery-challan-response.location_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the location."
},
"delivery-challan-response.location_name": {
"type": "property",
"dataType": "string",
"description": "Name of the location."
},
"delivery-challan-response.created_time": {
"type": "property",
"dataType": "string",
"description": "Time at which the delivery challan was created."
},
"delivery-challan-response.last_modified_time": {
"type": "property",
"dataType": "string",
"description": "Time at which the delivery challan was last modified."
},
"delivery-challan-response.created_by_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the user who created the delivery challan."
},
"line-item-response": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"line-item-response.line_item_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the line item."
},
"line-item-response.item_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the item."
},
"line-item-response.name": {
"type": "property",
"dataType": "string",
"description": "Name of the item."
},
"line-item-response.sku": {
"type": "property",
"dataType": "string",
"description": "SKU of the item."
},
"line-item-response.description": {
"type": "property",
"dataType": "string",
"description": "Description of the line item."
},
"line-item-response.item_order": {
"type": "property",
"dataType": "integer",
"description": "Display order of the line item."
},
"line-item-response.rate": {
"type": "property",
"dataType": "number",
"description": "Rate of the item."
},
"line-item-response.bcy_rate": {
"type": "property",
"dataType": "number",
"description": "Rate in base currency."
},
"line-item-response.quantity": {
"type": "property",
"dataType": "number",
"description": "Quantity."
},
"line-item-response.unit": {
"type": "property",
"dataType": "string",
"description": "Unit of measurement."
},
"line-item-response.discount": {
"type": "property",
"dataType": "number",
"description": "Discount applied."
},
"line-item-response.tax_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax."
},
"line-item-response.tax_name": {
"type": "property",
"dataType": "string",
"description": "Name of the tax."
},
"line-item-response.tax_type": {
"type": "property",
"dataType": "string",
"description": "Type of the tax."
},
"line-item-response.tax_percentage": {
"type": "property",
"dataType": "number",
"description": "Tax percentage."
},
"line-item-response.item_total": {
"type": "property",
"dataType": "number",
"description": "Total for this line item."
},
"line-item-response.hsn_or_sac": {
"type": "property",
"dataType": "string",
"description": "HSN or SAC code (applicable for India edition)."
},
"line-item-response.tax_exemption_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax exemption."
},
"line-item-response.tax_exemption_code": {
"type": "property",
"dataType": "string",
"description": "Tax exemption code."
},
"line-item-response.warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the warehouse."
},
"line-item-response.warehouse_name": {
"type": "property",
"dataType": "string",
"description": "Name of the warehouse."
},
"line-item-response.quantity_invoiced": {
"type": "property",
"dataType": "number",
"description": "Quantity invoiced for this line item."
},
"line-item-response.quantity_returned": {
"type": "property",
"dataType": "number",
"description": "Quantity returned for this line item."
},
"line-item-response.is_combo_product": {
"type": "property",
"dataType": "string",
"description": ""
},
"line-item-response.combo_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"line-item-response.mapped_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"line-item-response.line_item_taxes": {
"type": "property",
"dataType": "array",
"description": ""
},
"line-item-response.item_custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"line-item-tax": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"line-item-tax.tax_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax."
},
"line-item-tax.tax_name": {
"type": "property",
"dataType": "string",
"description": "Name of the tax."
},
"line-item-tax.tax_amount": {
"type": "property",
"dataType": "number",
"description": "Tax amount."
},
"address-detail": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"address-detail.address": {
"type": "property",
"dataType": "string",
"description": "Address line."
},
"address-detail.street2": {
"type": "property",
"dataType": "string",
"description": "Second address line."
},
"address-detail.city": {
"type": "property",
"dataType": "string",
"description": "City."
},
"address-detail.state": {
"type": "property",
"dataType": "string",
"description": "State."
},
"address-detail.zip": {
"type": "property",
"dataType": "string",
"description": "Postal or ZIP code."
},
"address-detail.country": {
"type": "property",
"dataType": "string",
"description": "Country."
},
"address-detail.fax": {
"type": "property",
"dataType": "string",
"description": "Fax number."
},
"address-detail.phone": {
"type": "property",
"dataType": "string",
"description": "Phone number."
},
"address-detail.attention": {
"type": "property",
"dataType": "string",
"description": "Attention."
},
"list-delivery-challans-response": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"list-delivery-challans-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-delivery-challans-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-delivery-challans-response.deliverychallans": {
"type": "property",
"dataType": "array",
"description": "List of delivery challans."
},
"list-delivery-challans-response.page_context": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-delivery-challan-response": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"get-delivery-challan-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-delivery-challan-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-delivery-challan-response.deliverychallan": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-delivery-challan-response": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"create-delivery-challan-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-delivery-challan-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-delivery-challan-response.deliverychallan": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-delivery-challan-response": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"update-delivery-challan-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-delivery-challan-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-delivery-challan-response.deliverychallan": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-delivery-challan-response": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"delete-delivery-challan-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-delivery-challan-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"action-delivery-challan-response": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"action-delivery-challan-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"action-delivery-challan-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-templates-response": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"list-templates-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-templates-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-templates-response.templates": {
"type": "property",
"dataType": "array",
"description": ""
},
"create-delivery-challan-request": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"create-delivery-challan-request.customer_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the customer."
},
"create-delivery-challan-request.currency_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the currency."
},
"create-delivery-challan-request.deliverychallan_number": {
"type": "property",
"dataType": "string",
"description": "Delivery challan number. Max-length [50]"
},
"create-delivery-challan-request.reference_number": {
"type": "property",
"dataType": "string",
"description": "Reference number. Max-length [50]"
},
"create-delivery-challan-request.template_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the template."
},
"create-delivery-challan-request.date": {
"type": "property",
"dataType": "string",
"description": "Date of the delivery challan in YYYY-MM-DD format."
},
"create-delivery-challan-request.challan_type": {
"type": "property",
"dataType": "string",
"description": "Type of delivery challan. Max-length [200]"
},
"create-delivery-challan-request.discount": {
"type": "property",
"dataType": "string",
"description": "Discount applied at the entity level."
},
"create-delivery-challan-request.is_discount_before_tax": {
"type": "property",
"dataType": "boolean",
"description": "Whether discount is applied before tax."
},
"create-delivery-challan-request.discount_type": {
"type": "property",
"dataType": "string",
"description": "Type of discount."
},
"create-delivery-challan-request.place_of_supply": {
"type": "property",
"dataType": "string",
"description": "Place of supply state code (applicable for India edition). Max-length [5]"
},
"create-delivery-challan-request.exchange_rate": {
"type": "property",
"dataType": "number",
"description": "Exchange rate for the currency."
},
"create-delivery-challan-request.is_inclusive_tax": {
"type": "property",
"dataType": "boolean",
"description": "Whether prices are inclusive of tax."
},
"create-delivery-challan-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": "GST treatment (applicable for India edition)."
},
"create-delivery-challan-request.tax_treatment": {
"type": "property",
"dataType": "string",
"description": "Tax treatment."
},
"create-delivery-challan-request.gst_no": {
"type": "property",
"dataType": "string",
"description": "GST number (applicable for India edition). Max-length [15]"
},
"create-delivery-challan-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Line items of the delivery challan."
},
"create-delivery-challan-request.notes": {
"type": "property",
"dataType": "string",
"description": "Customer notes. Max-length [5000]"
},
"create-delivery-challan-request.terms": {
"type": "property",
"dataType": "string",
"description": "Terms and conditions. Max-length [10000]"
},
"create-delivery-challan-request.adjustment": {
"type": "property",
"dataType": "number",
"description": "Adjustment amount."
},
"create-delivery-challan-request.adjustment_description": {
"type": "property",
"dataType": "string",
"description": "Adjustment description. Max-length [200]"
},
"create-delivery-challan-request.tax_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax."
},
"create-delivery-challan-request.tax_authority_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax authority."
},
"create-delivery-challan-request.tax_exemption_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax exemption."
},
"create-delivery-challan-request.shipping_address_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the shipping address."
},
"create-delivery-challan-request.pricebook_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the price book."
},
"create-delivery-challan-request.branch_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the branch."
},
"create-delivery-challan-request.location_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the location."
},
"create-delivery-challan-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-delivery-challan-request": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"update-delivery-challan-request.customer_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the customer."
},
"update-delivery-challan-request.currency_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the currency."
},
"update-delivery-challan-request.deliverychallan_number": {
"type": "property",
"dataType": "string",
"description": "Delivery challan number. Max-length [50]"
},
"update-delivery-challan-request.reference_number": {
"type": "property",
"dataType": "string",
"description": "Reference number. Max-length [50]"
},
"update-delivery-challan-request.template_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the template."
},
"update-delivery-challan-request.date": {
"type": "property",
"dataType": "string",
"description": "Date of the delivery challan in YYYY-MM-DD format."
},
"update-delivery-challan-request.challan_type": {
"type": "property",
"dataType": "string",
"description": "Type of delivery challan. Max-length [200]"
},
"update-delivery-challan-request.discount": {
"type": "property",
"dataType": "string",
"description": "Discount applied at the entity level."
},
"update-delivery-challan-request.is_discount_before_tax": {
"type": "property",
"dataType": "boolean",
"description": "Whether discount is applied before tax."
},
"update-delivery-challan-request.discount_type": {
"type": "property",
"dataType": "string",
"description": "Type of discount."
},
"update-delivery-challan-request.place_of_supply": {
"type": "property",
"dataType": "string",
"description": "Place of supply state code (applicable for India edition). Max-length [5]"
},
"update-delivery-challan-request.exchange_rate": {
"type": "property",
"dataType": "number",
"description": "Exchange rate for the currency."
},
"update-delivery-challan-request.is_inclusive_tax": {
"type": "property",
"dataType": "boolean",
"description": "Whether prices are inclusive of tax."
},
"update-delivery-challan-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": "GST treatment (applicable for India edition)."
},
"update-delivery-challan-request.tax_treatment": {
"type": "property",
"dataType": "string",
"description": "Tax treatment."
},
"update-delivery-challan-request.gst_no": {
"type": "property",
"dataType": "string",
"description": "GST number (applicable for India edition). Max-length [15]"
},
"update-delivery-challan-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Line items of the delivery challan."
},
"update-delivery-challan-request.notes": {
"type": "property",
"dataType": "string",
"description": "Customer notes. Max-length [5000]"
},
"update-delivery-challan-request.terms": {
"type": "property",
"dataType": "string",
"description": "Terms and conditions. Max-length [10000]"
},
"update-delivery-challan-request.adjustment": {
"type": "property",
"dataType": "number",
"description": "Adjustment amount."
},
"update-delivery-challan-request.adjustment_description": {
"type": "property",
"dataType": "string",
"description": "Adjustment description. Max-length [200]"
},
"update-delivery-challan-request.tax_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax."
},
"update-delivery-challan-request.tax_authority_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax authority."
},
"update-delivery-challan-request.tax_exemption_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax exemption."
},
"update-delivery-challan-request.shipping_address_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the shipping address."
},
"update-delivery-challan-request.pricebook_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the price book."
},
"update-delivery-challan-request.branch_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the branch."
},
"update-delivery-challan-request.location_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the location."
},
"line-item-request": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"line-item-request.item_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the item."
},
"line-item-request.name": {
"type": "property",
"dataType": "string",
"description": "Name of the item. Max-length [200]"
},
"line-item-request.sku": {
"type": "property",
"dataType": "string",
"description": "SKU of the item. Max-length [200]"
},
"line-item-request.description": {
"type": "property",
"dataType": "string",
"description": "Description of the line item. Max-length [6000]"
},
"line-item-request.item_order": {
"type": "property",
"dataType": "integer",
"description": "Display order of the item."
},
"line-item-request.rate": {
"type": "property",
"dataType": "number",
"description": "Rate of the item."
},
"line-item-request.quantity": {
"type": "property",
"dataType": "number",
"description": "Quantity."
},
"line-item-request.unit": {
"type": "property",
"dataType": "string",
"description": "Unit of measurement. Max-length [120]"
},
"line-item-request.discount": {
"type": "property",
"dataType": "string",
"description": "Discount for this line item."
},
"line-item-request.tax_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax."
},
"line-item-request.tax_exemption_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax exemption."
},
"line-item-request.tax_exemption_code": {
"type": "property",
"dataType": "string",
"description": "Tax exemption code. Max-length [50]"
},
"line-item-request.hsn_or_sac": {
"type": "property",
"dataType": "string",
"description": "HSN or SAC code (applicable for India edition)."
},
"line-item-request.pricebook_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the price book."
},
"line-item-request.warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the warehouse."
},
"line-item-request.location_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the location."
},
"line-item-request.mapped_items": {
"type": "property",
"dataType": "array",
"description": "Mapped items of a composite item."
},
"line-item-request-update": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"line-item-request-update.item_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the item."
},
"line-item-request-update.line_item_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the line item."
},
"line-item-request-update.name": {
"type": "property",
"dataType": "string",
"description": "Name of the item. Max-length [200]"
},
"line-item-request-update.sku": {
"type": "property",
"dataType": "string",
"description": "SKU of the item. Max-length [200]"
},
"line-item-request-update.description": {
"type": "property",
"dataType": "string",
"description": "Description of the line item. Max-length [6000]"
},
"line-item-request-update.item_order": {
"type": "property",
"dataType": "integer",
"description": "Display order of the item."
},
"line-item-request-update.rate": {
"type": "property",
"dataType": "number",
"description": "Rate of the item."
},
"line-item-request-update.quantity": {
"type": "property",
"dataType": "number",
"description": "Quantity."
},
"line-item-request-update.unit": {
"type": "property",
"dataType": "string",
"description": "Unit of measurement. Max-length [120]"
},
"line-item-request-update.discount": {
"type": "property",
"dataType": "string",
"description": "Discount for this line item."
},
"line-item-request-update.tax_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax."
},
"line-item-request-update.tax_exemption_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the tax exemption."
},
"line-item-request-update.tax_exemption_code": {
"type": "property",
"dataType": "string",
"description": "Tax exemption code. Max-length [50]"
},
"line-item-request-update.hsn_or_sac": {
"type": "property",
"dataType": "string",
"description": "HSN or SAC code (applicable for India edition)."
},
"line-item-request-update.pricebook_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the price book."
},
"line-item-request-update.warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the warehouse."
},
"line-item-request-update.location_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the location."
},
"line-item-request-update.mapped_items": {
"type": "property",
"dataType": "array",
"description": "Mapped items of a composite item."
},
"line-item-request-update.item_custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"return-delivery-challan-request": {
"type": "schema",
"module": "delivery-challans",
"description": ""
},
"return-delivery-challan-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Line items with return quantities."
},
"update-shipping-address-request.street2": {
"type": "property",
"dataType": "string",
"description": "Second address line."
},
"update-shipping-address-request.phone": {
"type": "property",
"dataType": "string",
"description": "Phone number."
},
"update-shipping-address-request.attention": {
"type": "property",
"dataType": "string",
"description": "Attention."
},
"inventoryadjustments": {
"type": "tag",
"description": "Inventory Adjustments Module"
},
"create_inventory_adjustment": {
"type": "operation",
"method": "POST",
"path": "/inventoryadjustments",
"summary": "Create an inventory adjustment",
"description": "Creates a new inventory adjustment in Zoho Inventory."
},
"list_inventory_adjustments": {
"type": "operation",
"method": "GET",
"path": "/inventoryadjustments",
"summary": "List all the inventory adjustments",
"description": "Lists all the inventory adjustments present in Zoho Inventory."
},
"get_inventory_adjustment": {
"type": "operation",
"method": "GET",
"path": "/inventoryadjustments/{inventory_adjustment_id}",
"summary": "Retrieve an inventory adjustment",
"description": "Fetches the details for an existing inventory adjustment."
},
"update_inventory_adjustment": {
"type": "operation",
"method": "PUT",
"path": "/inventoryadjustments/{inventory_adjustment_id}",
"summary": "Update an inventory adjustment",
"description": "Update the details of an existing inventory adjustment by quantity."
},
"delete_inventory_adjustment": {
"type": "operation",
"method": "DELETE",
"path": "/inventoryadjustments/{inventory_adjustment_id}",
"summary": "Delete an inventory adjustment",
"description": "Deletes an existing inventory adjustment from Zoho Inventory."
},
"submit_inventoryadjustment": {
"type": "operation",
"method": "POST",
"path": "/inventoryadjustments/{inventory_adjustment_id}/submit",
"summary": "Submit an inventory adjustment for approval",
"description": "Submit an inventory adjustment for approval workflow."
},
"inventory_adjustment_id": {
"type": "schema",
"module": "inventoryadjustments",
"description": "Unique ID generated by the server for the inventory adjustment. This is used as an identifier."
},
"approve_inventoryadjustment": {
"type": "operation",
"method": "POST",
"path": "/inventoryadjustments/{inventory_adjustment_id}/approve",
"summary": "Approve an inventory adjustment",
"description": "Approve a submitted inventory adjustment."
},
"approve_inventory_adjustment_final": {
"type": "operation",
"method": "POST",
"path": "/inventoryadjustments/{inventory_adjustment_id}/approve/final",
"summary": "Final approval of an inventory adjustment",
"description": "Perform the final approval of an inventory adjustment (admin only)."
},
"reject_inventoryadjustment": {
"type": "operation",
"method": "POST",
"path": "/inventoryadjustments/{inventory_adjustment_id}/reject",
"summary": "Reject an inventory adjustment",
"description": "Reject a submitted inventory adjustment."
},
"inventory_adjustment-response": {
"type": "schema",
"module": "inventoryadjustments",
"description": ""
},
"inventory_adjustment-response.inventory_adjustment_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"inventory_adjustment-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"inventory_adjustment-response.reason": {
"type": "property",
"dataType": "string",
"description": ""
},
"inventory_adjustment-response.reason_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"inventory_adjustment-response.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"inventory_adjustment-response.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"inventory_adjustment-response.adjustment_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"inventory_adjustment-response.line_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"inventory_adjustment-response.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"inventory_adjustment-response.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"inventory_adjustment-response.total": {
"type": "property",
"dataType": "string",
"description": ""
},
"inventory_adjustment-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"reason": {
"type": "parameter",
"in": "query",
"description": "Filter by reason text (same family of search operators as transfer order number)."
},
"reason_id": {
"type": "schema",
"module": "inventoryadjustments",
"description": "Unique ID generated by the server for the reason. This is used as an identifier."
},
"adjustment_type": {
"type": "schema",
"module": "inventoryadjustments",
"description": "The adjustment type should be either quantity or value.Allowed values are quantity and value only."
},
"quantity_adjusted": {
"type": "schema",
"module": "inventoryadjustments",
"description": "The adjusted quantity of the line item.It depends on adjustment_type and should be given only when adjustment_type is given as quantity."
},
"value_adjusted": {
"type": "schema",
"module": "inventoryadjustments",
"description": "The adjusted value of the line item.It depends on adjustment_type and should be given only when adjustment_type is given as value."
},
"adjustment_account_id": {
"type": "schema",
"module": "inventoryadjustments",
"description": "Unique ID generated by the server for the Adjustment account."
},
"adjustment_account_name": {
"type": "schema",
"module": "inventoryadjustments",
"description": "Name of the Adjustment Account."
},
"create-an-inventory-adjustment-request": {
"type": "schema",
"module": "inventoryadjustments",
"description": ""
},
"create-an-inventory-adjustment-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-inventory-adjustment-request.reason": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-inventory-adjustment-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-inventory-adjustment-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-inventory-adjustment-request.adjustment_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-inventory-adjustment-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-inventory-adjustment-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-inventory-adjustment-request.line_items": {
"type": "property",
"dataType": "array",
"description": "An inventory adjustment can contain multiple line items. Each line item contains item_id,name,description,quantity_adjusted,unit,adjustment_account_id,location_id."
},
"create-an-inventory-adjustment-response": {
"type": "schema",
"module": "inventoryadjustments",
"description": ""
},
"create-an-inventory-adjustment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-an-inventory-adjustment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-inventory-adjustment-response.inventory_adjustment": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-the-inventory-adjustments-response": {
"type": "schema",
"module": "inventoryadjustments",
"description": ""
},
"list-all-the-inventory-adjustments-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-the-inventory-adjustments-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-the-inventory-adjustments-response.inventory_adjustments": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-an-inventory-adjustment-request": {
"type": "schema",
"module": "inventoryadjustments",
"description": ""
},
"update-an-inventory-adjustment-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-inventory-adjustment-request.reason": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-inventory-adjustment-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-inventory-adjustment-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-inventory-adjustment-request.adjustment_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-inventory-adjustment-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-inventory-adjustment-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-inventory-adjustment-request.line_items": {
"type": "property",
"dataType": "array",
"description": "An inventory adjustment can contain multiple line items. Each line item contains item_id,line_item_id,name,description,quantity_adjusted,unit,adjustment_account_id,location_id."
},
"update-an-inventory-adjustment-response": {
"type": "schema",
"module": "inventoryadjustments",
"description": ""
},
"update-an-inventory-adjustment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-an-inventory-adjustment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-inventory-adjustment-response.inventory_adjustment": {
"type": "property",
"dataType": "object",
"description": ""
},
"retrieve-an-inventory-adjustment-response": {
"type": "schema",
"module": "inventoryadjustments",
"description": ""
},
"retrieve-an-inventory-adjustment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieve-an-inventory-adjustment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-inventory-adjustment-response.inventory_adjustment": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-an-inventory-adjustment-response": {
"type": "schema",
"module": "inventoryadjustments",
"description": ""
},
"delete-an-inventory-adjustment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-an-inventory-adjustment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create_invoice": {
"type": "operation",
"method": "POST",
"path": "/invoices",
"summary": "Create an invoice",
"description": "Create an invoice for your customer."
},
"send": {
"type": "schema",
"module": "invoices",
"description": "Send the invoice to the contact person(s) associated with the invoice. Allowed values true and false."
},
"list_invoices": {
"type": "operation",
"method": "GET",
"path": "/invoices",
"summary": "List invoices",
"description": "List all invoices with pagination."
},
"recurring_invoice_id": {
"type": "schema",
"module": "invoices",
"description": "ID of the recurring invoice from which the invoice is created."
},
"custom_field": {
"type": "schema",
"module": "vendor-credits",
"description": "Search vendor credits by custom field. Variants : custom_field_startswith and custom_field_contains"
},
"update_invoice": {
"type": "operation",
"method": "PUT",
"path": "/invoices/{invoice_id}",
"summary": "Update an invoice",
"description": "Update an existing invoice. To delete a line item just remove it from the line_items list."
},
"get_invoice": {
"type": "operation",
"method": "GET",
"path": "/invoices/{invoice_id}",
"summary": "Get an invoice",
"description": "Get the details of an invoice."
},
"delete_invoice": {
"type": "operation",
"method": "DELETE",
"path": "/invoices/{invoice_id}",
"summary": "Delete an invoice",
"description": "Delete an existing invoice. Invoices which have payment or credits note applied cannot be deleted."
},
"update_custom_field_in_invoice": {
"type": "operation",
"method": "PUT",
"path": "/invoice/{invoice_id}/customfields",
"summary": "Update custom field in existing invoices",
"description": "Update the value of the custom field in existing invoices."
},
"mark_invoice_as_sent": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/status/sent",
"summary": "Mark an invoice as sent",
"description": "Mark a draft invoice as sent."
},
"mark_invoice_as_void": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/status/void",
"summary": "Void an invoice",
"description": "Mark an invoice status as void. Upon voiding, the payments and credits associated with the invoices will be unassociated and will be under customer credits."
},
"mark_invoice_as_draft": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/status/draft",
"summary": "Mark as draft",
"description": "Mark a voided invoice as draft."
},
"email_invoice": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/email",
"summary": "Email an invoice",
"description": "Email an invoice to the customer. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content."
},
"send_attachment": {
"type": "schema",
"module": "retainer-invoices",
"description": "Send the retainer invoice attachment a with the email."
},
"get_invoice_email_content": {
"type": "operation",
"method": "GET",
"path": "/invoices/{invoice_id}/email",
"summary": "Get invoice email content",
"description": "Get the email content of an invoice."
},
"email_invoices": {
"type": "operation",
"method": "POST",
"path": "/invoices/email",
"summary": "Email invoices",
"description": "Send invoices to your customers by email. Maximum of 10 invoices can be sent at once."
},
"invoice_ids": {
"type": "schema",
"module": "invoices",
"description": "Comma separated invoice ids which are to be emailed."
},
"get_invoice_reminder_mail_content": {
"type": "operation",
"method": "GET",
"path": "/invoices/{invoice_id}/paymentreminder",
"summary": "Get payment reminder mail content",
"description": "Get the mail content of the payment reminder."
},
"bulk_export_invoices": {
"type": "operation",
"method": "GET",
"path": "/invoices/pdf",
"summary": "Bulk export Invoices",
"description": "Maximum of 25 invoices can be exported in a single pdf."
},
"bulk_print_invoices": {
"type": "operation",
"method": "GET",
"path": "/invoices/print",
"summary": "Bulk print invoices",
"description": "Export invoices as pdf and print them. Maximum of 25 invoices can be printed."
},
"disable_invoice_payment_reminder": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/paymentreminder/disable",
"summary": "Disable payment reminder",
"description": "Disable automated payment reminders for an invoice."
},
"enable_invoice_payment_reminder": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/paymentreminder/enable",
"summary": "Enable payment reminder",
"description": "Enable automated payment reminders for an invoice."
},
"write_off_invoice": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/writeoff",
"summary": "Write off invoice",
"description": "Write off the invoice balance amount of an invoice."
},
"cancel_write_off_invoice": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/writeoff/cancel",
"summary": "Cancel write off",
"description": "Cancel the write off amount of an invoice."
},
"update_invoice_billing_address": {
"type": "operation",
"method": "PUT",
"path": "/invoices/{invoice_id}/address/billing",
"summary": "Update billing address",
"description": "Updates the billing address for this invoice alone."
},
"update_invoice_shipping_address": {
"type": "operation",
"method": "PUT",
"path": "/invoices/{invoice_id}/address/shipping",
"summary": "Update shipping address",
"description": "Updates the shipping address for this invoice alone."
},
"list_invoice_templates": {
"type": "operation",
"method": "GET",
"path": "/invoices/templates",
"summary": "List invoice templates",
"description": "Get all invoice pdf templates."
},
"update_invoice_template": {
"type": "operation",
"method": "PUT",
"path": "/invoices/{invoice_id}/templates/{template_id}",
"summary": "Update invoice template",
"description": "Update the pdf template associated with the invoice."
},
"list_invoice_payments": {
"type": "operation",
"method": "GET",
"path": "/invoices/{invoice_id}/payments",
"summary": "List invoice payments",
"description": "Get the list of payments made for an invoice."
},
"list_credits_applied": {
"type": "operation",
"method": "GET",
"path": "/invoices/{invoice_id}/creditsapplied",
"summary": "List credits applied",
"description": "Get the list of credits applied for an invoice."
},
"apply_credits_to_invoice": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/credits",
"summary": "Apply credits",
"description": "Apply the customer credits either from credit notes or excess customer payments to an invoice. Multiple credits can be applied at once."
},
"delete_invoice_payment": {
"type": "operation",
"method": "DELETE",
"path": "/invoices/{invoice_id}/payments/{invoice_payment_id}",
"summary": "Delete a payment",
"description": "Delete a payment made to an invoice."
},
"invoice_payment_id": {
"type": "schema",
"module": "invoices",
"description": "The invoice payment ID"
},
"delete_applied_credit_to_invoice": {
"type": "operation",
"method": "DELETE",
"path": "/invoices/{invoice_id}/creditsapplied/{creditnotes_invoice_id}",
"summary": "Delete applied credit",
"description": "Delete a particular credit applied to an invoice."
},
"creditnotes_invoice_id": {
"type": "schema",
"module": "invoices",
"description": "The creditnotes invoice ID"
},
"get_invoice_attachment": {
"type": "operation",
"method": "GET",
"path": "/invoices/{invoice_id}/attachment",
"summary": "Get an invoice attachment",
"description": "Returns the file attached to the invoice."
},
"preview": {
"type": "schema",
"module": "retainer-invoices",
"description": "Get the thumbnail of the attachment."
},
"add_attachment_to_invoice": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/attachment",
"summary": "Add attachment to an invoice",
"description": "Attach a file to an invoice."
},
"can_send_in_mail": {
"type": "schema",
"module": "salesorders",
"description": "Checks whether the sales order can be sent as a mail or not."
},
"attachment": {
"type": "parameter",
"in": "query",
"description": "The file to be attached.Allowed Extensions: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc, docx, xml, csv, txt, tif and tiff"
},
"update_invoice_attachment": {
"type": "operation",
"method": "PUT",
"path": "/invoices/{invoice_id}/attachment",
"summary": "Update attachment preference",
"description": "Set whether you want to send the attached file while emailing the invoice."
},
"delete_invoice_attachment": {
"type": "operation",
"method": "DELETE",
"path": "/invoices/{invoice_id}/attachment",
"summary": "Delete an attachment",
"description": "Delete the file attached to the invoice."
},
"list_invoice_comments": {
"type": "operation",
"method": "GET",
"path": "/invoices/{invoice_id}/comments",
"summary": "List invoice comments & history",
"description": "Get the complete history and comments of an invoice."
},
"create_invoice_comment": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/comments",
"summary": "Add comment",
"description": "Add a comment for an invoice."
},
"update_invoice_comment": {
"type": "operation",
"method": "PUT",
"path": "/invoices/{invoice_id}/comments/{comment_id}",
"summary": "Update comment",
"description": "Update an existing comment of an invoice."
},
"delete_invoice_comment": {
"type": "operation",
"method": "DELETE",
"path": "/invoices/{invoice_id}/comments/{comment_id}",
"summary": "Delete a comment",
"description": "Delete an invoice comment."
},
"submit_invoice": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/submit",
"summary": "Submit an invoice for approval",
"description": "Submit an invoice for approval workflow."
},
"approve_invoice": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/approve",
"summary": "Approve an invoice",
"description": "Approve a submitted invoice."
},
"approve_invoice_final": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/approve/final",
"summary": "Final approval of an invoice",
"description": "Perform the final approval of an invoice (admin only)."
},
"reject_invoice": {
"type": "operation",
"method": "POST",
"path": "/invoices/{invoice_id}/reject",
"summary": "Reject an invoice",
"description": "Reject a submitted invoice."
},
"bulk_submit_invoices": {
"type": "operation",
"method": "POST",
"path": "/invoices/submit",
"summary": "Bulk submit invoices for approval",
"description": "Submit multiple invoices for approval workflow at once."
},
"bulk_approve_invoices": {
"type": "operation",
"method": "POST",
"path": "/invoices/approve",
"summary": "Bulk approve invoices",
"description": "Approve multiple submitted invoices at once."
},
"invoice-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"invoice-response.invoice_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.ach_payment_initiated": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.invoice_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.payment_terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.payment_terms_label": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.due_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.payment_expected_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.last_payment_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.customer_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.discount": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.is_discount_before_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.discount_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.recurring_invoice_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.is_viewed_by_client": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.has_attachment": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.client_viewed_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.line_items": {
"type": "property",
"dataType": "array",
"description": "Items listed in invoice"
},
"invoice-response.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.shipping_charge": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.adjustment": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.adjustment_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.sub_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.tax_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.total": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.taxes": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.payment_reminder_enabled": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.payment_made": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.credits_applied": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.tax_amount_withheld": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.balance": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.write_off_amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.allow_partial_payments": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.price_precision": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.payment_options": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.is_emailed": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.reminders_sent": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.last_reminder_sent_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.billing_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.shipping_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.template_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.attachment_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.can_send_in_mail": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.salesperson_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.salesperson_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.invoice_url": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.is_pre_gst": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.cfdi_usage": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.cfdi_reference_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"invoice-response.reference_invoice_id": {
"type": "property",
"dataType": "string",
"description": "Associate the reference invoice."
},
"show_comment_to_clients": {
"type": "schema",
"module": "retainer-invoices",
"description": "Boolean to check if the comment to be shown to the clients"
},
"organization_contact_id": {
"type": "schema",
"module": "invoices",
"description": "ID of the contact's organisation"
},
"is_org_email_id": {
"type": "schema",
"module": "invoices",
"description": "To check if the email ID belongs to the organisation"
},
"comments": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"online_transaction_id": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"invoice_payments": {
"type": "schema",
"module": "invoices",
"description": "Invoice payment list"
},
"apply_creditnotes": {
"type": "schema",
"module": "invoices",
"description": "Apply existing credit note of a customer against the invoice"
},
"credits": {
"type": "schema",
"module": "invoices",
"description": "The list of credits"
},
"creditnotes_number": {
"type": "schema",
"module": "invoices",
"description": "The creditnotes Number"
},
"credited_date": {
"type": "schema",
"module": "invoices",
"description": "The date of credit"
},
"is_single_invoice_payment": {
"type": "schema",
"module": "invoices",
"description": "To check if invoice is paid in a single payment or multiple payments"
},
"to_mails_str": {
"type": "schema",
"module": "invoices",
"description": "Mail recepients"
},
"cc_mails_str": {
"type": "schema",
"module": "invoices",
"description": "Mail recepients who need to be CC'd"
},
"from_email": {
"type": "schema",
"module": "invoices",
"description": "Mail sender"
},
"from_address": {
"type": "schema",
"module": "invoices",
"description": "Sender's email address"
},
"emailtemplate_documents": {
"type": "schema",
"module": "invoices",
"description": "Email templates used"
},
"file_name_without_extension": {
"type": "schema",
"module": "invoices",
"description": "Name of file included"
},
"templates": {
"type": "schema",
"module": "invoices",
"description": ""
},
"emailtemplates": {
"type": "schema",
"module": "invoices",
"description": "Email template used to send invoice"
},
"gateways_configured": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"deprecated_placeholders_used": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"snail_mail": {
"type": "schema",
"module": "invoices",
"description": "the boolean check for snail mail"
},
"custom_subject": {
"type": "schema",
"module": "invoices",
"description": "Customized Subject line"
},
"custom_body": {
"type": "schema",
"module": "invoices",
"description": "Customized email content"
},
"invoiced_estimate_id": {
"type": "schema",
"module": "invoices",
"description": "ID of the invoice from which the invoice is created."
},
"invoice_url": {
"type": "schema",
"module": "invoices",
"description": "Url of invoice as a link"
},
"salesperson_id": {
"type": "schema",
"module": "salesorders",
"description": "Unique ID generated by the server for the sales person. This is used as an identifier."
},
"salesperson_name": {
"type": "schema",
"module": "salesorders",
"description": "Name of the Sales Person."
},
"bcc_mails": {
"type": "schema",
"module": "invoices",
"description": "Bcc mail details"
},
"gateways_associated": {
"type": "schema",
"module": "invoices",
"description": "List of Payment gateways associated"
},
"bcc_mails_str": {
"type": "schema",
"module": "invoices",
"description": "Bcc mails content"
},
"attach_pdf": {
"type": "schema",
"module": "invoices",
"description": "check if PDF attachment"
},
"entity_id": {
"type": "parameter",
"in": "query",
"description": "Search tasks by entity ID."
},
"show_on_pdf": {
"type": "schema",
"module": "retainer-invoices",
"description": "Boolean value to check if the custom field is to be dispplayed on the pdf."
},
"billing_address_id": {
"type": "schema",
"module": "salesorders",
"description": "Unique Id generated by the server for address in contacts page. To add a billing address to sales order, send the address_id using this node. Else, the default billing address for that contact is used"
},
"shipping_address_id": {
"type": "schema",
"module": "salesorders",
"description": "Unique Id generated by the server for address in contacts page. To add a shipping address to sales order, send the address_id using this node. Else, the default shipping address for that contact is used"
},
"is_emailed": {
"type": "schema",
"module": "shipmentorders",
"description": "Checks whether the Package has been emailed to the customer or not."
},
"reminders_sent": {
"type": "schema",
"module": "invoices",
"description": "The number of reminders sent"
},
"last_reminder_sent_date": {
"type": "schema",
"module": "invoices",
"description": "The date the last email was sent"
},
"salesorder_item_id": {
"type": "schema",
"module": "salesreturns",
"description": "Unique ID generated by the server for each line item in a sales order."
},
"shipping_charge": {
"type": "schema",
"module": "shipmentorders",
"description": "Shipping charges that are applied to the Shipment."
},
"adjustment": {
"type": "schema",
"module": "salesorders",
"description": "Adjustment on the Sales Order's total."
},
"adjustment_description": {
"type": "schema",
"module": "salesorders",
"description": "Description for the adjustment."
},
"payment_made": {
"type": "schema",
"module": "retainer-invoices",
"description": "The amount paid"
},
"credits_applied": {
"type": "schema",
"module": "invoices",
"description": "The credits applied"
},
"write_off_amount": {
"type": "schema",
"module": "invoices",
"description": "The write off amount. i.e. the amount which is not expected to be returned. Like a bad debt"
},
"allow_partial_payments": {
"type": "schema",
"module": "retainer-invoices",
"description": "Boolean to check if partial payments are allowed for the contact"
},
"configured": {
"type": "schema",
"module": "retainer-invoices",
"description": "Boolean check to see if a payment gateway ahs been configured"
},
"additional_field1": {
"type": "schema",
"module": "retainer-invoices",
"description": "Paypal payment method. Allowed Values: standard and adaptive"
},
"gateway_name": {
"type": "schema",
"module": "retainer-invoices",
"description": "Name of the payment gateway associated with the retainer invoice. E.g. paypal, stripe.Allowed Values: paypal, authorize_net, payflow_pro, stripe, 2checkout and braintree"
},
"is_discount_before_tax": {
"type": "schema",
"module": "shipmentorders",
"description": "Used to check whether the discount is applied before tax or after tax."
},
"discount_type": {
"type": "schema",
"module": "shipmentorders",
"description": "Type of discount"
},
"time_entry_ids": {
"type": "schema",
"module": "invoices",
"description": "Unique ID's of all the time entries associated to the linked project"
},
"expense_id": {
"type": "schema",
"module": "invoices",
"description": "Unique ID of the expenses associated"
},
"expense_receipt_name": {
"type": "schema",
"module": "invoices",
"description": "Name of the expense receipt associated"
},
"discount_amount": {
"type": "schema",
"module": "shipmentorders",
"description": "Discount to be applied on the Sales Order."
},
"due_days": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"payment_expected_date": {
"type": "schema",
"module": "retainer-invoices",
"description": "The date on which the payment is expected to be received for the retainer invoice."
},
"last_payment_date": {
"type": "schema",
"module": "retainer-invoices",
"description": "The last payment date of the retainer invoice"
},
"ach_payment_initiated": {
"type": "schema",
"module": "invoices",
"description": "To check initiation of ACH Payment"
},
"schedule_time": {
"type": "schema",
"module": "invoices",
"description": "Schedule time for payment"
},
"is_viewed_by_client": {
"type": "schema",
"module": "retainer-invoices",
"description": "Boolean is retainer invoice viewed by client in client portal."
},
"has_attachment": {
"type": "schema",
"module": "vendor-credits",
"description": "Check if Vendor Credit has attachment"
},
"client_viewed_time": {
"type": "schema",
"module": "retainer-invoices",
"description": "client viewed time for retainer invoice in client portal."
},
"documents": {
"type": "schema",
"module": "vendor-credits",
"description": "List of documents associated with the vendor credit"
},
"update-an-invoice-customfield-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"update-an-invoice-customfield-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-an-invoice-customfield-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"billing_address.fax": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipping_address.fax": {
"type": "property",
"dataType": "string",
"description": ""
},
"payment_gateways": {
"type": "schema",
"module": "retainer-invoices",
"description": "Online payment gateways through which payment can be made."
},
"payment_options": {
"type": "schema",
"module": "retainer-invoices",
"description": "Payment options for the retainer invoice, online payment gateways and bank accounts. Will be displayed in the pdf."
},
"payment_options.payment_gateways": {
"type": "property",
"dataType": "string",
"description": ""
},
"reference_invoice_id": {
"type": "schema",
"module": "invoices",
"description": "Associate the reference invoice."
},
"create-an-invoice-request": {
"type": "schema",
"module": "invoices",
"description": ""
},
"create-an-invoice-request.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.invoice_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.payment_terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.payment_terms_label": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.due_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.discount": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.is_discount_before_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.discount_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.recurring_invoice_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.invoiced_estimate_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.salesperson_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.project_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Line items of an invoice."
},
"create-an-invoice-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.payment_options": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.allow_partial_payments": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.custom_body": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.custom_subject": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.shipping_charge": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.adjustment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.adjustment_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.reason": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.tax_authority_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.tax_exemption_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.avatax_use_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.avatax_exempt_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.vat_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.billing_address_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.shipping_address_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-request.cfdi_usage": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"create-an-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-an-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-invoice-response.invoice": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-invoices-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"list-invoices-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-invoices-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-invoices-response.invoices": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-an-invoice-request": {
"type": "schema",
"module": "invoices",
"description": ""
},
"update-an-invoice-request.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.invoice_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.payment_terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.payment_terms_label": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.due_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.discount": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.is_discount_before_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.discount_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.recurring_invoice_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.invoiced_estimate_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.salesperson_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.project_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Line items of an invoice."
},
"update-an-invoice-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.payment_options": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.allow_partial_payments": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.custom_body": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.custom_subject": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.shipping_charge": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.adjustment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.adjustment_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.reason": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.tax_authority_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.tax_exemption_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.avatax_use_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.avatax_exempt_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.vat_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.billing_address_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.shipping_address_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.cfdi_usage": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.cfdi_reference_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-request.reference_invoice_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"update-an-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-an-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-invoice-response.invoice": {
"type": "property",
"dataType": "object",
"description": ""
},
"get-an-invoice-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"get-an-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-an-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-an-invoice-response.invoice": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-an-invoice-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"delete-an-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-an-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-an-invoice-as-sent-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"mark-an-invoice-as-sent-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-an-invoice-as-sent-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"void-an-invoice-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"void-an-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"void-an-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-as-draft-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"mark-as-draft-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-as-draft-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-an-invoice-request": {
"type": "schema",
"module": "invoices",
"description": ""
},
"email-an-invoice-request.send_from_org_email_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-an-invoice-request.to_mail_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-an-invoice-request.cc_mail_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-an-invoice-request.subject": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-an-invoice-request.body": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-an-invoice-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"email-an-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"email-an-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-invoice-email-content-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"get-invoice-email-content-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-invoice-email-content-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-invoice-email-content-response.data": {
"type": "property",
"dataType": "object",
"description": "content of the emails"
},
"email-invoices-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"email-invoices-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"email-invoices-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-payment-reminder-mail-content-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"get-payment-reminder-mail-content-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-payment-reminder-mail-content-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-payment-reminder-mail-content-response.data": {
"type": "property",
"dataType": "object",
"description": "Date of the email"
},
"bulk-export-invoices-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"bulk-export-invoices-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"bulk-export-invoices-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"bulk-print-invoices-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"bulk-print-invoices-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"bulk-print-invoices-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"disable-payment-reminder-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"disable-payment-reminder-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"disable-payment-reminder-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"enable-payment-reminder-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"enable-payment-reminder-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"enable-payment-reminder-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"write-off-invoice-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"write-off-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"write-off-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"cancel-write-off-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"cancel-write-off-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"cancel-write-off-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-invoice-templates-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"list-invoice-templates-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-invoice-templates-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-invoice-templates-response.templates": {
"type": "property",
"dataType": "array",
"description": "Temlpates used"
},
"update-invoice-template-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"update-invoice-template-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-invoice-template-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-invoice-payments-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"list-invoice-payments-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-invoice-payments-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-invoice-payments-response.payments": {
"type": "property",
"dataType": "array",
"description": "List of payments received"
},
"list-credits-applied-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"list-credits-applied-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-credits-applied-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-credits-applied-response.credits": {
"type": "property",
"dataType": "array",
"description": ""
},
"apply-credits-request": {
"type": "schema",
"module": "invoices",
"description": ""
},
"apply-credits-request.invoice_payments": {
"type": "property",
"dataType": "array",
"description": "Invoice payment list"
},
"apply-credits-request.apply_creditnotes": {
"type": "property",
"dataType": "array",
"description": "Apply existing credit note of a customer against the invoice"
},
"apply-credits-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"apply-credits-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"apply-credits-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-applied-credit-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"delete-applied-credit-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-applied-credit-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-an-invoice-attachment-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"get-an-invoice-attachment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-an-invoice-attachment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-attachment-to-an-invoice-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"add-attachment-to-an-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"add-attachment-to-an-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-attachment-preference-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"update-attachment-preference-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-attachment-preference-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-an-attachment-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"delete-an-attachment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-an-attachment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-invoice-comments-and-history-response": {
"type": "schema",
"module": "invoices",
"description": ""
},
"list-invoice-comments-and-history-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-invoice-comments-and-history-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-invoice-comments-and-history-response.comments": {
"type": "property",
"dataType": "array",
"description": "Comments made"
},
"create-a-comment-request": {
"type": "schema",
"module": "invoices",
"description": ""
},
"create-a-comment-request.description": {
"type": "property",
"dataType": "string",
"description": "The description of the comment."
},
"create-a-comment-request.payment_expected_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-comment-request.show_comment_to_clients": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-comment-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"add-comment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"add-comment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-comment-request": {
"type": "schema",
"module": "invoices",
"description": ""
},
"update-a-comment-request.description": {
"type": "property",
"dataType": "string",
"description": "The description of the comment."
},
"update-a-comment-request.show_comment_to_clients": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-comment-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"update-comment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-comment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-comment-response.comment_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-comment-response.invoice_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-comment-response.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-comment-response.commented_by_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-comment-response.commented_by": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-comment-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-comment-response.date_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-comment-response.time": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-comment-response.comment_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"itemgroups": {
"type": "tag",
"description": "ItemGroups Module"
},
"create_item_group": {
"type": "operation",
"method": "POST",
"path": "/itemgroups",
"summary": "Create an Item Group",
"description": "A new Item Group can a be created. While creating items, user can attach image for product group by passing form-data parameter image i.e., -F image=bag_s.jpg."
},
"list_item_groups": {
"type": "operation",
"method": "GET",
"path": "/itemgroups",
"summary": "List all Item Groups",
"description": "Lists all the Item Groups that are present in the Zoho Inventory organization."
},
"get_item_group": {
"type": "operation",
"method": "GET",
"path": "/itemgroups/{itemgroup_id}",
"summary": "Retrieve an Item Group",
"description": "Fetches the details for an existing Item Group."
},
"update_item_group": {
"type": "operation",
"method": "PUT",
"path": "/itemgroups/{itemgroup_id}",
"summary": "Update an Item Group",
"description": "Updates the details of an existing Item Group."
},
"delete_item_group": {
"type": "operation",
"method": "DELETE",
"path": "/itemgroups/{itemgroup_id}",
"summary": "Delete an Item Group",
"description": "Deletes an existing Item Group from Zoho Inventory."
},
"mark_item_group_active": {
"type": "operation",
"method": "POST",
"path": "/itemgroups/{itemgroup_id}/active",
"summary": "Mark as Active",
"description": "Marks an Item group as Active."
},
"mark_item_group_inactive": {
"type": "operation",
"method": "POST",
"path": "/itemgroups/{itemgroup_id}/inactive",
"summary": "Mark as Inactive.",
"description": "Marks as Item Group as Inactive."
},
"group_id": {
"type": "schema",
"module": "items",
"description": "Unique ID generated by the server for the group to which the item belongs, if any. This is used as an identifier."
},
"group_name": {
"type": "schema",
"module": "items",
"description": "Name of product group"
},
"brand": {
"type": "schema",
"module": "itemgroups",
"description": "Brand of the Item Group."
},
"manufacturer": {
"type": "schema",
"module": "itemgroups",
"description": "Manufacturer of Item Group."
},
"attribute_id1": {
"type": "schema",
"module": "items",
"description": "Unique ID used by the server. This is used as an identifier."
},
"attribute_name1": {
"type": "schema",
"module": "items",
"description": "Name of the attribute present in the Item Group."
},
"attribute_option_id1": {
"type": "schema",
"module": "items",
"description": "Unique ID generated by the server for the attribute's options. This is used as an identifier."
},
"attribute_option_name1": {
"type": "schema",
"module": "items",
"description": "Name of the attribute's option."
},
"id": {
"type": "schema",
"module": "itemgroups",
"description": "Unique ID generated by the server for the attribute. This is used as an identifier."
},
"items": {
"type": "tag",
"description": "Items Module"
},
"options": {
"type": "schema",
"module": "itemgroups",
"description": "The options present for each attribute."
},
"attributes": {
"type": "schema",
"module": "itemgroups",
"description": "All the attributes present in the Item Group. Each attribute will have its own option."
},
"create-an-item-group-request": {
"type": "schema",
"module": "itemgroups",
"description": ""
},
"create-an-item-group-request.group_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-request.brand": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-request.manufacturer": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-request.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-request.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-request.attribute_name1": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-request.items": {
"type": "property",
"dataType": "array",
"description": "The items present in the Item Group."
},
"create-an-item-group-request.attributes": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response": {
"type": "schema",
"module": "itemgroups",
"description": ""
},
"create-an-item-group-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-an-item-group-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.group_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.group_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.documents": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.brand": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.manufacturer": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.is_taxable": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.tax_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.tax_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.tax_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.attribute_id1": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.attribute_name1": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.source": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.image_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.image_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.image_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-group-response.items": {
"type": "property",
"dataType": "object",
"description": "The items present in the Item Group."
},
"create-an-item-group-response.attributes": {
"type": "property",
"dataType": "object",
"description": "All the attributes present in the Item Group. Each attribute will have its own option."
},
"list-all-item-groups-response": {
"type": "schema",
"module": "itemgroups",
"description": ""
},
"list-all-item-groups-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-item-groups-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-item-groups-response.itemgroups": {
"type": "property",
"dataType": "array",
"description": ""
},
"retrieve-an-item-group-response": {
"type": "schema",
"module": "itemgroups",
"description": ""
},
"retrieve-an-item-group-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieve-an-item-group-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.group_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.group_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.brand": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.manufacturer": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.is_taxable": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.tax_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.tax_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.tax_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.attribute_id1": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.attribute_name1": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.source": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.image_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.image_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.image_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-group-response.items": {
"type": "property",
"dataType": "object",
"description": "The items present in the Item Group."
},
"retrieve-an-item-group-response.attributes": {
"type": "property",
"dataType": "object",
"description": "All the attributes present in the Item Group. Each attribute will have its own option."
},
"retrieve-an-item-group-response.options": {
"type": "property",
"dataType": "object",
"description": "The options present for each attribute."
},
"update-an-item-group-request": {
"type": "schema",
"module": "itemgroups",
"description": ""
},
"update-an-item-group-request.group_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-request.brand": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-request.manufacturer": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-request.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-request.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-request.attribute_name1": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-request.name": {
"type": "property",
"dataType": "string",
"description": "Name of the Item."
},
"update-an-item-group-request.rate": {
"type": "property",
"dataType": "number",
"description": "Sales price of the Item."
},
"update-an-item-group-request.purchase_rate": {
"type": "property",
"dataType": "number",
"description": "Purchase price of the Item."
},
"update-an-item-group-request.sku": {
"type": "property",
"dataType": "string",
"description": "The Stock Keeeping Unit (SKU) of an item. This is unique for every item in the Inventory."
},
"update-an-item-group-response": {
"type": "schema",
"module": "itemgroups",
"description": ""
},
"update-an-item-group-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-an-item-group-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.group_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.group_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.brand": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.manufacturer": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.is_taxable": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.tax_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.tax_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.tax_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.attribute_id1": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.attribute_name1": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.source": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.image_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.image_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-group-response.image_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-an-item-group-response": {
"type": "schema",
"module": "itemgroups",
"description": ""
},
"delete-an-item-group-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-an-item-group-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create_item": {
"type": "operation",
"method": "POST",
"path": "/items",
"summary": "Create an item",
"description": "Creates a new item in Zoho Inventory."
},
"list_items": {
"type": "operation",
"method": "GET",
"path": "/items",
"summary": "List all the items",
"description": "Lists all the items present in Zoho Inventory."
},
"sku_startswith": {
"type": "parameter",
"in": "query",
"description": "Filter by SKU that starts with the given value."
},
"rate_less_than": {
"type": "parameter",
"in": "query",
"description": "Filter by selling rate less than the given value."
},
"rate_less_equals": {
"type": "parameter",
"in": "query",
"description": "Filter by selling rate less than or equal to the given value."
},
"rate_greater_than": {
"type": "parameter",
"in": "query",
"description": "Filter by selling rate greater than the given value."
},
"rate_greater_equals": {
"type": "parameter",
"in": "query",
"description": "Filter by selling rate greater than or equal to the given value."
},
"purchase_rate_less_than": {
"type": "parameter",
"in": "query",
"description": "Filter by purchase rate less than the given value."
},
"purchase_rate_less_equals": {
"type": "parameter",
"in": "query",
"description": "Filter by purchase rate less than or equal to the given value."
},
"purchase_rate_greater_than": {
"type": "parameter",
"in": "query",
"description": "Filter by purchase rate greater than the given value."
},
"purchase_rate_greater_equals": {
"type": "parameter",
"in": "query",
"description": "Filter by purchase rate greater than or equal to the given value."
},
"customview_id": {
"type": "parameter",
"in": "query",
"description": "Custom view ID to apply."
},
"zcrm_product_id": {
"type": "parameter",
"in": "query",
"description": "Filter by Zoho CRM product ID."
},
"brand_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of brand IDs to filter by."
},
"manufacturer_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of manufacturer IDs to filter by."
},
"bulk_delete_items": {
"type": "operation",
"method": "DELETE",
"path": "/items",
"summary": "Delete multiple items",
"description": "Deletes multiple items from Zoho Inventory."
},
"item_ids": {
"type": "parameter",
"in": "query",
"description": "List of item ids separated by comma"
},
"list_item_details": {
"type": "operation",
"method": "GET",
"path": "/itemdetails",
"summary": "Bulk fetch item details",
"description": "Fetch item details for the mentioned item IDs"
},
"get_item": {
"type": "operation",
"method": "GET",
"path": "/items/{item_id}",
"summary": "Retrieve an item",
"description": "Fetches the details for an existing item."
},
"update_item": {
"type": "operation",
"method": "PUT",
"path": "/items/{item_id}",
"summary": "Update an item",
"description": "Update the details of an item."
},
"delete_item": {
"type": "operation",
"method": "DELETE",
"path": "/items/{item_id}",
"summary": "Delete an item",
"description": "Deletes an existing item from Zoho Inventory."
},
"update_custom_field_in_item": {
"type": "operation",
"method": "PUT",
"path": "/item/{item_id}/customfields",
"summary": "Update custom field in existing items",
"description": "Update the value of the custom field in existing items."
},
"upload_item_image": {
"type": "operation",
"method": "POST",
"path": "/items/{item_id}/image",
"summary": "Upload an item image",
"description": "Uploads an image for an item in Zoho Inventory. Allowed formats: gif, png, jpeg, jpg, bmp, webp. Maximum size: 7 MB."
},
"get_item_image": {
"type": "operation",
"method": "GET",
"path": "/items/{item_id}/image",
"summary": "Retrieve an item image",
"description": "Retrieves the image associated with an item."
},
"delete_item_image": {
"type": "operation",
"method": "DELETE",
"path": "/items/{item_id}/image",
"summary": "Delete an item image",
"description": "Deletes the image associated for an item in Zoho Inventory."
},
"mark_item_as_active": {
"type": "operation",
"method": "POST",
"path": "/items/{item_id}/active",
"summary": "Mark as active",
"description": "Changes the status of an item to active."
},
"mark_item_as_inactive": {
"type": "operation",
"method": "POST",
"path": "/items/{item_id}/inactive",
"summary": "Mark as inactive",
"description": "Mark an item as inactive."
},
"get_variant_opening_stock": {
"type": "operation",
"method": "GET",
"path": "/variants/{variant_id}/openingstock",
"summary": "Retrieve variant opening stock",
"description": "Fetches the opening stock details of a variant, including batches, serial numbers, and warehouse details."
},
"update_variant_opening_stock": {
"type": "operation",
"method": "PUT",
"path": "/variants/{variant_id}/openingstock",
"summary": "Update variant opening stock",
"description": "Updates the opening stock details of a variant."
},
"upload_item_images": {
"type": "operation",
"method": "POST",
"path": "/items/{item_id}/images",
"summary": "Upload multiple item images",
"description": "Uploads multiple images for an item. Allowed formats: gif, png, jpeg, jpg, bmp, webp. Maximum size: 7 MB per image."
},
"document_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of document IDs to delete."
},
"remove_all": {
"type": "parameter",
"in": "query",
"description": "Set to true to remove all existing images before uploading."
},
"update_primary_image": {
"type": "parameter",
"in": "query",
"description": "Set to true to update the primary image."
},
"delete_item_images": {
"type": "operation",
"method": "DELETE",
"path": "/items/{item_id}/images",
"summary": "Delete multiple item images",
"description": "Deletes multiple images associated with an item."
},
"reorder_item_images": {
"type": "operation",
"method": "POST",
"path": "/items/{item_id}/images/reorder",
"summary": "Reorder item images",
"description": "Reorders the images associated with an item."
},
"upload_item_back_image": {
"type": "operation",
"method": "POST",
"path": "/items/{item_id}/backimage",
"summary": "Upload an item back image",
"description": "Uploads a back image for an item. Allowed formats: gif, png, jpeg, jpg, bmp, webp. Maximum size: 7 MB."
},
"delete_item_back_image": {
"type": "operation",
"method": "DELETE",
"path": "/items/{item_id}/backimage",
"summary": "Delete an item back image",
"description": "Deletes the back image associated with an item."
},
"mark_image_as_back_image": {
"type": "operation",
"method": "PUT",
"path": "/items/{item_id}/images/{image_id}/backimage",
"summary": "Mark an image as back image",
"description": "Marks an existing item image as the rear/back image."
},
"bulk_mark_items_active": {
"type": "operation",
"method": "POST",
"path": "/items/active",
"summary": "Bulk mark items as active",
"description": "Changes the status of multiple items to active."
},
"bulk_mark_items_inactive": {
"type": "operation",
"method": "POST",
"path": "/items/inactive",
"summary": "Bulk mark items as inactive",
"description": "Changes the status of multiple items to inactive."
},
"ungroup_items": {
"type": "operation",
"method": "POST",
"path": "/items/ungroup",
"summary": "Ungroup items",
"description": "Ungroups the specified items from their variant grouping."
},
"composite_item_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of composite item IDs to ungroup."
},
"enable_storage_location": {
"type": "operation",
"method": "POST",
"path": "/items/enablestoragelocation",
"summary": "Enable storage location for items",
"description": "Enables storage location tracking for the specified items."
},
"disable_storage_location": {
"type": "operation",
"method": "POST",
"path": "/items/disablestoragelocation",
"summary": "Disable storage location for items",
"description": "Disables storage location tracking for the specified items."
},
"move_item": {
"type": "operation",
"method": "PUT",
"path": "/items/move/{item_id}",
"summary": "Move an item",
"description": "Moves an item to a different group or location."
},
"group_items": {
"type": "operation",
"method": "PUT",
"path": "/items/grouping/{group_id}",
"summary": "Group items",
"description": "Groups items together as variants under a single item."
},
"update_item_location_permissions": {
"type": "operation",
"method": "PUT",
"path": "/items/{item_id}/locations/permissions",
"summary": "Update item location permissions",
"description": "Updates the location access permissions for an item."
},
"associated_with_all_locations": {
"type": "parameter",
"in": "query",
"description": "Set to true to associate the item with all locations."
},
"allowed_location_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of allowed location IDs."
},
"bulk_update_item_location_permissions": {
"type": "operation",
"method": "PUT",
"path": "/items/locations/permissions",
"summary": "Bulk update item location permissions",
"description": "Updates location access permissions for multiple items at once."
},
"overwrite": {
"type": "parameter",
"in": "query",
"description": "Set to true to overwrite existing permissions."
},
"validate_serial_numbers": {
"type": "operation",
"method": "POST",
"path": "/items/{item_id}/serialnumber/validate",
"summary": "Validate serial numbers",
"description": "Checks serial number availability for outgoing transactions."
},
"entity_type": {
"type": "parameter",
"in": "query",
"description": "Search tasks by entity type."
},
"validate_and_map_serial_numbers": {
"type": "operation",
"method": "POST",
"path": "/items/{item_id}/serialnumber/validateandmap",
"summary": "Validate and map serial numbers",
"description": "Validates serial number availability and maps them with bin locations for outgoing transactions."
},
"list_item_sales_orders": {
"type": "operation",
"method": "GET",
"path": "/items/transactions/salesorders",
"summary": "List sales orders for an item",
"description": "Lists all sales orders associated with a particular item."
},
"sales_channel": {
"type": "schema",
"module": "salesorders",
"description": "From which channel the saleorder was obtained"
},
"list_item_purchase_orders": {
"type": "operation",
"method": "GET",
"path": "/items/transactions/purchaseorders",
"summary": "List purchase orders for an item",
"description": "Lists all purchase orders associated with a particular item."
},
"list_item_invoices": {
"type": "operation",
"method": "GET",
"path": "/items/transactions/invoices",
"summary": "List invoices for an item",
"description": "Lists all invoices associated with a particular item."
},
"list_item_delivery_challans": {
"type": "operation",
"method": "GET",
"path": "/items/transactions/deliverychallans",
"summary": "List delivery challans for an item",
"description": "Lists all delivery challans associated with a particular item."
},
"list_item_sales_receipts": {
"type": "operation",
"method": "GET",
"path": "/items/transactions/salesreceipts",
"summary": "List sales receipts for an item",
"description": "Lists all sales receipts associated with a particular item."
},
"list_item_move_orders": {
"type": "operation",
"method": "GET",
"path": "/items/transactions/moveorders",
"summary": "List move orders for an item",
"description": "Lists all move orders associated with a particular item."
},
"list_item_putaways": {
"type": "operation",
"method": "GET",
"path": "/items/transactions/putaways",
"summary": "List putaways for an item",
"description": "Lists all putaways associated with a particular item."
},
"item-response": {
"type": "schema",
"module": "items",
"description": ""
},
"item-response.group_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.group_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.unit_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.unit_group_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.unit_group_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.default_sales_unit_conversion_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.default_purchase_unit_conversion_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.item_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.product_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.can_be_sold": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.can_be_purchased": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.track_inventory": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.is_taxable": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.documents": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.tax_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.tax_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.tax_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.purchase_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.purchase_account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.inventory_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.attribute_id1": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.attribute_name1": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.source": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.pricebook_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.purchase_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.reorder_level": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.vendor_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.locations": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.sku": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.upc": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.ean": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.isbn": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.part_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.attribute_option_id1": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.attribute_option_name1": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.image_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.image_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.purchase_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.image_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.item_tax_preferences": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.hsn_or_sac": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.sat_item_key_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.unitkey_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"item-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"unit_id": {
"type": "schema",
"module": "items",
"description": "Unique ID of the unit associated with the item."
},
"unit_group_id": {
"type": "schema",
"module": "items",
"description": "Unique ID of the unit group associated with the item. Applicable when unit conversion is enabled."
},
"unit_group_name": {
"type": "schema",
"module": "items",
"description": "Name of the unit group associated with the item. Applicable when unit conversion is enabled."
},
"default_sales_unit_conversion_id": {
"type": "schema",
"module": "items",
"description": "Unique ID of the default sales unit conversion. Applicable when unit conversion is enabled."
},
"default_purchase_unit_conversion_id": {
"type": "schema",
"module": "items",
"description": "Unique ID of the default purchase unit conversion. Applicable when unit conversion is enabled."
},
"can_be_sold": {
"type": "schema",
"module": "items",
"description": "Boolean to indicate whether the item can be sold."
},
"can_be_purchased": {
"type": "schema",
"module": "items",
"description": "Boolean to indicate whether the item can be purchased."
},
"track_inventory": {
"type": "schema",
"module": "items",
"description": "Boolean to indicate whether inventory tracking is enabled for the item."
},
"is_primary": {
"type": "schema",
"module": "locations",
"description": "Whether it is primary location or not"
},
"location_stock_on_hand": {
"type": "schema",
"module": "items",
"description": "Current available stock in your location."
},
"location_available_stock": {
"type": "schema",
"module": "items",
"description": "Available stock in your location."
},
"location_actual_available_stock": {
"type": "schema",
"module": "items",
"description": "Actual available stock in your location."
},
"locations": {
"type": "schema",
"module": "locations",
"description": ""
},
"update-an-item-customfield-response": {
"type": "schema",
"module": "items",
"description": ""
},
"update-an-item-customfield-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-an-item-customfield-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request": {
"type": "schema",
"module": "items",
"description": ""
},
"create-an-item-request.group_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.group_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.unit_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.unit_group_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.default_sales_unit_conversion_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.default_purchase_unit_conversion_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.documents": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.item_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.product_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.can_be_sold": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.can_be_purchased": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.track_inventory": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.is_taxable": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.purchase_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.inventory_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.attribute_name1": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.purchase_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.reorder_level": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.locations": {
"type": "property",
"dataType": "array",
"description": "List of locations."
},
"create-an-item-request.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.vendor_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.sku": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.upc": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.ean": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.isbn": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.part_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.attribute_option_name1": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.purchase_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.item_tax_preferences": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.hsn_or_sac": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.sat_item_key_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.unitkey_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-response": {
"type": "schema",
"module": "items",
"description": ""
},
"create-an-item-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-an-item-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-item-response.item": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-the-items-response": {
"type": "schema",
"module": "items",
"description": ""
},
"list-all-the-items-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-the-items-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-the-items-response.items": {
"type": "property",
"dataType": "array",
"description": ""
},
"bulk-fetch-item-details-response": {
"type": "schema",
"module": "items",
"description": ""
},
"bulk-fetch-item-details-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"bulk-fetch-item-details-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"bulk-fetch-item-details-response.items": {
"type": "property",
"dataType": "array",
"description": ""
},
"retrieve-an-item-response": {
"type": "schema",
"module": "items",
"description": ""
},
"retrieve-an-item-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieve-an-item-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-an-item-response.item": {
"type": "property",
"dataType": "object",
"description": ""
},
"update-an-item-request": {
"type": "schema",
"module": "items",
"description": ""
},
"update-an-item-request.group_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.group_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.unit_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.unit_group_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.default_sales_unit_conversion_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.default_purchase_unit_conversion_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.item_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.product_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.can_be_sold": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.can_be_purchased": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.track_inventory": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.is_taxable": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.tax_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.tax_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.tax_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.purchase_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.purchase_account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.inventory_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.attribute_id1": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.attribute_name1": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.source": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.pricebook_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.purchase_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.reorder_level": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.locations": {
"type": "property",
"dataType": "array",
"description": "List of locations."
},
"update-an-item-request.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.vendor_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.sku": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.upc": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.ean": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.isbn": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.part_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.attribute_option_id1": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.attribute_option_name1": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.image_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.image_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.purchase_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.image_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.item_tax_preferences": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.hsn_or_sac": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.sat_item_key_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.unitkey_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-response": {
"type": "schema",
"module": "items",
"description": ""
},
"update-an-item-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-an-item-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-item-response.item": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-an-item-response": {
"type": "schema",
"module": "items",
"description": ""
},
"delete-an-item-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-an-item-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-an-item-image-response": {
"type": "schema",
"module": "items",
"description": ""
},
"delete-an-item-image-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-an-item-image-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-variant-opening-stock-request": {
"type": "schema",
"module": "items",
"description": "The request body structure varies based on the item tracking configuration. When warehouse/location is not enabled, use top-level initial_stock, initial_stock_rate, serial_numbers, and batches. When warehouse/location is enabled, use the locations array with nested tracking details. These two modes are mutually exclusive \u2014 do not send top-level stock fields and locations together."
},
"update-variant-opening-stock-request.initial_stock": {
"type": "property",
"dataType": "number",
"description": "Opening stock quantity. Applicable only when warehouse/location is not enabled. Must not be sent when locations is provided."
},
"update-variant-opening-stock-request.initial_stock_rate": {
"type": "property",
"dataType": "number",
"description": "Opening stock rate per unit. Applicable only when warehouse/location is not enabled. Must not be sent when locations is provided."
},
"update-variant-opening-stock-request.serial_numbers": {
"type": "property",
"dataType": "array",
"description": "List of serial numbers. Applicable only when the item is serial tracked and warehouse/location is not enabled. Must not be sent when locations is provided."
},
"update-variant-opening-stock-request.batches": {
"type": "property",
"dataType": "array",
"description": "List of batches. Applicable only when the item is batch tracked and warehouse/location is not enabled. Must not be sent when locations is provided. Maximum 5000 batches per request."
},
"update-variant-opening-stock-request.locations": {
"type": "property",
"dataType": "array",
"description": "Location-level stock details. Applicable when warehouse/location is enabled."
},
"get-variant-opening-stock-response": {
"type": "schema",
"module": "items",
"description": ""
},
"get-variant-opening-stock-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-variant-opening-stock-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-variant-opening-stock-response.opening_stock": {
"type": "property",
"dataType": "object",
"description": ""
},
"update-variant-opening-stock-response": {
"type": "schema",
"module": "items",
"description": ""
},
"update-variant-opening-stock-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-variant-opening-stock-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"upload-item-image-response": {
"type": "schema",
"module": "items",
"description": ""
},
"upload-item-image-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"upload-item-image-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"upload-item-images-response": {
"type": "schema",
"module": "items",
"description": ""
},
"upload-item-images-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"upload-item-images-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"reorder-item-images-request": {
"type": "schema",
"module": "items",
"description": ""
},
"reorder-item-images-request.documents": {
"type": "property",
"dataType": "array",
"description": "List of documents with their display order."
},
"reorder-item-images-response": {
"type": "schema",
"module": "items",
"description": ""
},
"reorder-item-images-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"reorder-item-images-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"upload-item-back-image-response": {
"type": "schema",
"module": "items",
"description": ""
},
"upload-item-back-image-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"upload-item-back-image-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-item-images-response": {
"type": "schema",
"module": "items",
"description": ""
},
"delete-item-images-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-item-images-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-item-back-image-response": {
"type": "schema",
"module": "items",
"description": ""
},
"delete-item-back-image-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-item-back-image-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-image-as-back-image-response": {
"type": "schema",
"module": "items",
"description": ""
},
"mark-image-as-back-image-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-image-as-back-image-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"bulk-mark-items-active-response": {
"type": "schema",
"module": "items",
"description": ""
},
"bulk-mark-items-active-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"bulk-mark-items-active-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"bulk-mark-items-inactive-response": {
"type": "schema",
"module": "items",
"description": ""
},
"bulk-mark-items-inactive-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"bulk-mark-items-inactive-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"ungroup-items-response": {
"type": "schema",
"module": "items",
"description": ""
},
"ungroup-items-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"ungroup-items-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"bulk-delete-items-response": {
"type": "schema",
"module": "items",
"description": ""
},
"bulk-delete-items-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"bulk-delete-items-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"enable-storage-location-response": {
"type": "schema",
"module": "items",
"description": ""
},
"enable-storage-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"enable-storage-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"disable-storage-location-response": {
"type": "schema",
"module": "items",
"description": ""
},
"disable-storage-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"disable-storage-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-item-request": {
"type": "schema",
"module": "items",
"description": ""
},
"move-item-request.group_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the destination group."
},
"move-item-request.attribute_name1": {
"type": "property",
"dataType": "string",
"description": "Name of the first attribute. Required if the destination group has attributes defined."
},
"move-item-request.attribute_option_name1": {
"type": "property",
"dataType": "string",
"description": "Option value for the first attribute."
},
"move-item-request.attribute_name2": {
"type": "property",
"dataType": "string",
"description": "Name of the second attribute. Required if the destination group has a second attribute defined."
},
"move-item-request.attribute_option_name2": {
"type": "property",
"dataType": "string",
"description": "Option value for the second attribute."
},
"move-item-request.attribute_name3": {
"type": "property",
"dataType": "string",
"description": "Name of the third attribute. Required if the destination group has a third attribute defined."
},
"move-item-request.attribute_option_name3": {
"type": "property",
"dataType": "string",
"description": "Option value for the third attribute."
},
"move-item-response": {
"type": "schema",
"module": "items",
"description": ""
},
"move-item-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-item-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"group-items-request": {
"type": "schema",
"module": "items",
"description": "Either group_name or group_id is required. Pass group_name to create a new group with up to 3 attributes and an items array, or pass group_id to associate the item with an existing group and map its attributes."
},
"group-items-request.group_name": {
"type": "property",
"dataType": "string",
"description": "Name of the new group to create. Required when creating a new group."
},
"group-items-request.group_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of an existing group. Required when associating the item with an existing group."
},
"group-items-request.unit": {
"type": "property",
"dataType": "string",
"description": "Unit of measurement for the group."
},
"group-items-request.attribute_name1": {
"type": "property",
"dataType": "string",
"description": "Name of the first attribute (e.g., Size)."
},
"group-items-request.attribute_name2": {
"type": "property",
"dataType": "string",
"description": "Name of the second attribute (e.g., Color)."
},
"group-items-request.attribute_name3": {
"type": "property",
"dataType": "string",
"description": "Name of the third attribute."
},
"group-items-request.items": {
"type": "property",
"dataType": "array",
"description": "List of items to include in the group, each with their attribute option mappings."
},
"group-items-response": {
"type": "schema",
"module": "items",
"description": ""
},
"group-items-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"group-items-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-item-location-permissions-response": {
"type": "schema",
"module": "items",
"description": ""
},
"update-item-location-permissions-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-item-location-permissions-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"bulk-update-item-location-permissions-response": {
"type": "schema",
"module": "items",
"description": ""
},
"bulk-update-item-location-permissions-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"bulk-update-item-location-permissions-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"validate-serial-numbers-response": {
"type": "schema",
"module": "items",
"description": ""
},
"validate-serial-numbers-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"validate-serial-numbers-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"validate-and-map-serial-numbers-request": {
"type": "schema",
"module": "items",
"description": ""
},
"validate-and-map-serial-numbers-request.entity_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the entity."
},
"validate-and-map-serial-numbers-request.warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the warehouse."
},
"validate-and-map-serial-numbers-request.location_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the location."
},
"validate-and-map-serial-numbers-request.entity_type": {
"type": "property",
"dataType": "string",
"description": "Type of the entity."
},
"validate-and-map-serial-numbers-request.serial_numbers": {
"type": "property",
"dataType": "array",
"description": "List of serial numbers to validate and map."
},
"validate-and-map-serial-numbers-response": {
"type": "schema",
"module": "items",
"description": ""
},
"validate-and-map-serial-numbers-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"validate-and-map-serial-numbers-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-item-sales-orders-response": {
"type": "schema",
"module": "items",
"description": ""
},
"list-item-sales-orders-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-item-sales-orders-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-item-sales-orders-response.salesorders": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-item-purchase-orders-response": {
"type": "schema",
"module": "items",
"description": ""
},
"list-item-purchase-orders-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-item-purchase-orders-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-item-purchase-orders-response.purchaseorders": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-item-invoices-response": {
"type": "schema",
"module": "items",
"description": ""
},
"list-item-invoices-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-item-invoices-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-item-invoices-response.invoices": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-item-delivery-challans-response": {
"type": "schema",
"module": "items",
"description": ""
},
"list-item-delivery-challans-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-item-delivery-challans-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-item-delivery-challans-response.deliverychallans": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-item-sales-receipts-response": {
"type": "schema",
"module": "items",
"description": ""
},
"list-item-sales-receipts-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-item-sales-receipts-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-item-sales-receipts-response.sales_receipts": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-item-move-orders-response": {
"type": "schema",
"module": "items",
"description": ""
},
"list-item-move-orders-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-item-move-orders-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-item-move-orders-response.moveorders": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-item-putaways-response": {
"type": "schema",
"module": "items",
"description": ""
},
"list-item-putaways-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-item-putaways-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-item-putaways-response.putaways": {
"type": "property",
"dataType": "array",
"description": ""
},
"landedcosts": {
"type": "tag",
"description": "LandedCosts Module"
},
"create_landed_cost_for_bill": {
"type": "operation",
"method": "POST",
"path": "/bills/{bill_id}/landedcosts",
"summary": "Creates a landed cost for a bill.",
"description": "Create a landed cost for a bill. Use this to record additional charges such as shipping, customs, or handling against a bill, and allocate those charges across the line items of the bill using the chosen allocation method."
},
"get_landed_cost_for_bill": {
"type": "operation",
"method": "GET",
"path": "/bills/{bill_id}/landedcosts/{landed_cost_id}",
"summary": "Retrieves the details of a specific landed cost",
"description": "Retrieve the details of a specific landed cost recorded against a bill, including the cost allocations across the bill line items."
},
"update_landed_cost_for_bill": {
"type": "operation",
"method": "PUT",
"path": "/bills/{bill_id}/landedcosts/{landed_cost_id}",
"summary": "Updates an existing landed cost on a bill.",
"description": "Update an existing landed cost on a bill. The full landed cost record, including its allocations across the bill line items, is replaced with the values provided in the request body."
},
"delete_landed_cost_for_bill": {
"type": "operation",
"method": "DELETE",
"path": "/bills/{bill_id}/landedcosts/{landed_cost_id}",
"summary": "Deletes a landed cost from a bill.",
"description": "Delete a landed cost from a bill. The allocated amounts are removed from the bill line items."
},
"create_bulk_landed_costs": {
"type": "operation",
"method": "POST",
"path": "/bills/bulklandedcosts",
"summary": "Create bulk landed costs",
"description": "Create a landed cost from a single source transaction (such as a bill, bill of entry, or self-billed invoice) and allocate it across multiple bills in one call. Use this when a single charge, for example a freight invoice, needs to be distributed across more than one downstream bill."
},
"get_bill_details_for_bulk_landed_cost": {
"type": "operation",
"method": "GET",
"path": "/landedcosts/billdetails",
"summary": "Get bill details for bulk landed cost",
"description": "Retrieve the bill and line item details for one or more bills. Use this before calling the bulk landed cost endpoint to fetch the bill items that the landed cost can be allocated against."
},
"landed-cost-for-bill-response": {
"type": "schema",
"module": "landedcosts",
"description": ""
},
"landed-cost-for-bill-response.bill_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.bill_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.landed_cost_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.vendor_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.reference_entity_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.reference_item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.reference_entity_type": {
"type": "property",
"dataType": "string",
"description": "Type of the source transaction. Allowed values bill, bill_of_entry and self_billed_invoice."
},
"landed-cost-for-bill-response.reference_entity_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.price_precision": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.currency_symbol": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.allocation_method": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed-cost-for-bill-response.cost_allocations": {
"type": "property",
"dataType": "string",
"description": ""
},
"landed_cost_id": {
"type": "schema",
"module": "landedcosts",
"description": "Unique identifier of the landed cost generated by the server."
},
"reference_entity_id": {
"type": "schema",
"module": "landedcosts",
"description": "Unique identifier of the source transaction (for example, the bill or self-billed invoice) from which the landed cost is recorded."
},
"reference_item_id": {
"type": "schema",
"module": "landedcosts",
"description": "Unique identifier of the line item in the source transaction that represents the landed cost."
},
"reference_entity_number": {
"type": "schema",
"module": "landedcosts",
"description": "Number of the source transaction (for example, the bill number) from which the landed cost is recorded."
},
"allocation_method": {
"type": "schema",
"module": "landedcosts",
"description": "Method used to distribute the landed cost across the bill line items. Allowed values quantity, amount, dimension and weight."
},
"bill_item_id": {
"type": "schema",
"module": "landedcosts",
"description": "Unique identifier of the bill line item that the landed cost is allocated to."
},
"allocated_amount": {
"type": "schema",
"module": "landedcosts",
"description": "Amount of the landed cost allocated to the bill line item, in the currency of the bill."
},
"line_item_name": {
"type": "schema",
"module": "landedcosts",
"description": "Name of the bill line item."
},
"line_item_description": {
"type": "schema",
"module": "landedcosts",
"description": "Description of the bill line item."
},
"line_item_quantity": {
"type": "schema",
"module": "landedcosts",
"description": "Quantity of the bill line item."
},
"line_item_rate": {
"type": "schema",
"module": "landedcosts",
"description": "Unit rate of the bill line item in the currency of the bill."
},
"line_item_total": {
"type": "schema",
"module": "landedcosts",
"description": "Sub-total of the bill line item in the currency of the bill."
},
"package_length": {
"type": "schema",
"module": "landedcosts",
"description": "Length of the item package."
},
"package_width": {
"type": "schema",
"module": "landedcosts",
"description": "Width of the item package."
},
"package_height": {
"type": "schema",
"module": "landedcosts",
"description": "Height of the item package."
},
"package_weight": {
"type": "schema",
"module": "landedcosts",
"description": "Weight of the item package."
},
"weight_unit": {
"type": "schema",
"module": "landedcosts",
"description": "Unit of measure for the package weight."
},
"dimension_unit": {
"type": "schema",
"module": "landedcosts",
"description": "Unit of measure for the package dimensions."
},
"package_details": {
"type": "schema",
"module": "landedcosts",
"description": "Package dimensions and weight of the item, used when the allocation method is dimension or weight. Returned only when Zoho Inventory is enabled."
},
"package_details.length": {
"type": "property",
"dataType": "string",
"description": ""
},
"package_details.width": {
"type": "property",
"dataType": "string",
"description": ""
},
"package_details.height": {
"type": "property",
"dataType": "string",
"description": ""
},
"package_details.weight": {
"type": "property",
"dataType": "string",
"description": ""
},
"package_details.weight_unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"package_details.dimension_unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"cost_allocations_for_bill": {
"type": "schema",
"module": "landedcosts",
"description": "Distribution of the landed cost across the line items of the bill. Each entry contains the bill line item identifier and the amount allocated to it."
},
"cost_allocation_for_bill_request": {
"type": "schema",
"module": "landedcosts",
"description": ""
},
"cost_allocation_for_bill_request.bill_item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"cost_allocation_for_bill_request.allocated_amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"cost_allocation_for_bill_request.sales_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"cost_allocation_for_bill_request.label_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_line_item": {
"type": "schema",
"module": "landedcosts",
"description": ""
},
"bill_line_item.bill_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_line_item.bill_item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_line_item.item_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the item."
},
"bill_line_item.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_line_item.sku": {
"type": "property",
"dataType": "string",
"description": "Stock keeping unit of the item. Returned only when SKU is enabled for the organization."
},
"bill_line_item.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_line_item.quantity": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_line_item.unit": {
"type": "property",
"dataType": "string",
"description": "Unit of measure of the line item."
},
"bill_line_item.item_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_line_item.package_details": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_details": {
"type": "schema",
"module": "landedcosts",
"description": ""
},
"bill_details.bill_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_details.bill_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_details.date": {
"type": "property",
"dataType": "string",
"description": "Date of the bill in yyyy-mm-dd format."
},
"bill_details.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_details.vendor_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_details.status": {
"type": "property",
"dataType": "string",
"description": "Current status of the bill."
},
"bill_details.total": {
"type": "property",
"dataType": "number",
"description": "Total amount of the bill in the currency of the bill."
},
"bill_details.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_details.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_details.currency_symbol": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_details.exchange_rate": {
"type": "property",
"dataType": "number",
"description": "Exchange rate of the currency of the bill against the base currency of the organization."
},
"bill_details.price_precision": {
"type": "property",
"dataType": "string",
"description": ""
},
"bill_details.line_items": {
"type": "property",
"dataType": "array",
"description": "Line items of the bill that the landed cost can be allocated to."
},
"create-a-landed-cost-for-bill-request": {
"type": "schema",
"module": "landedcosts",
"description": ""
},
"create-a-landed-cost-for-bill-request.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-landed-cost-for-bill-request.reference_entity_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-landed-cost-for-bill-request.reference_item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-landed-cost-for-bill-request.reference_entity_type": {
"type": "property",
"dataType": "string",
"description": "Type of the source transaction. Allowed values bill, bill_of_entry and self_billed_invoice."
},
"create-a-landed-cost-for-bill-request.account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-landed-cost-for-bill-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-landed-cost-for-bill-request.allocation_method": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-landed-cost-for-bill-request.cost_allocations": {
"type": "property",
"dataType": "array",
"description": "Distribution of the landed cost across the line items of the bill. At least one entry is required."
},
"update-a-landed-cost-for-bill-request": {
"type": "schema",
"module": "landedcosts",
"description": ""
},
"create-a-landed-cost-for-bill-response": {
"type": "schema",
"module": "landedcosts",
"description": ""
},
"create-a-landed-cost-for-bill-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-landed-cost-for-bill-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-landed-cost-for-bill-response.landed_cost": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-landed-cost-for-bill-response": {
"type": "schema",
"module": "landedcosts",
"description": ""
},
"get-a-landed-cost-for-bill-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-landed-cost-for-bill-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-landed-cost-for-bill-response.landed_cost": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-landed-cost-for-bill-response": {
"type": "schema",
"module": "landedcosts",
"description": ""
},
"update-a-landed-cost-for-bill-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-landed-cost-for-bill-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-landed-cost-for-bill-response.landed_cost": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-a-landed-cost-for-bill-response": {
"type": "schema",
"module": "landedcosts",
"description": ""
},
"delete-a-landed-cost-for-bill-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-landed-cost-for-bill-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-bill-details-for-bulk-landed-cost-response": {
"type": "schema",
"module": "landedcosts",
"description": ""
},
"get-bill-details-for-bulk-landed-cost-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-bill-details-for-bulk-landed-cost-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-bill-details-for-bulk-landed-cost-response.bills": {
"type": "property",
"dataType": "array",
"description": "Bill details for each requested bill, including the line items the landed cost can be allocated against."
},
"bulk-landed-cost-bill-allocation": {
"type": "schema",
"module": "landedcosts",
"description": ""
},
"bulk-landed-cost-bill-allocation.bill_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the bill that the landed cost is being allocated to."
},
"bulk-landed-cost-bill-allocation.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"bulk-landed-cost-bill-allocation.cost_allocations": {
"type": "property",
"dataType": "array",
"description": "Distribution of the landed cost across the line items of the bill. At least one entry is required."
},
"create-bulk-landed-costs-request": {
"type": "schema",
"module": "landedcosts",
"description": ""
},
"create-bulk-landed-costs-request.reference_entity_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bulk-landed-costs-request.reference_item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bulk-landed-costs-request.reference_entity_type": {
"type": "property",
"dataType": "string",
"description": "Type of the source transaction from which the bulk landed cost is recorded. Allowed values bill, bill_of_entry and self_billed_invoice."
},
"create-bulk-landed-costs-request.account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bulk-landed-costs-request.description": {
"type": "property",
"dataType": "string",
"description": "Description of the bulk landed cost."
},
"create-bulk-landed-costs-request.allocation_method": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-bulk-landed-costs-request.bills": {
"type": "property",
"dataType": "array",
"description": "Bills that the landed cost is allocated to. A maximum of 100 bills can be passed in a single call."
},
"create-bulk-landed-costs-response": {
"type": "schema",
"module": "landedcosts",
"description": ""
},
"create-bulk-landed-costs-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-bulk-landed-costs-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"enable_locations": {
"type": "operation",
"method": "POST",
"path": "/settings/locations/enable",
"summary": "Enable Locations",
"description": "Enable Locations for an organisation."
},
"create_location": {
"type": "operation",
"method": "POST",
"path": "/locations",
"summary": "Create a location",
"description": "Create a location."
},
"list_locations": {
"type": "operation",
"method": "GET",
"path": "/locations",
"summary": "List all locations",
"description": "List all the available locations in your zoho inventory."
},
"is_hierarchical_response": {
"type": "parameter",
"in": "query",
"description": "When set to true, returns the locations in a parent-child hierarchical structure instead of a flat list."
},
"location_type": {
"type": "parameter",
"in": "query",
"description": "Filter locations by type. Allowed Values: general and line_item_only."
},
"get_location": {
"type": "operation",
"method": "GET",
"path": "/locations/{location_id}",
"summary": "Get a location",
"description": "Get the details of a location."
},
"update_location": {
"type": "operation",
"method": "PUT",
"path": "/locations/{location_id}",
"summary": "Update location",
"description": "Update location"
},
"delete_location": {
"type": "operation",
"method": "DELETE",
"path": "/locations/{location_id}",
"summary": "Delete a location",
"description": "Delete a location."
},
"mark_location_as_active": {
"type": "operation",
"method": "POST",
"path": "/locations/{location_id}/active",
"summary": "Mark as Active",
"description": "Mark location as Active."
},
"mark_location_as_inactive": {
"type": "operation",
"method": "POST",
"path": "/locations/{location_id}/inactive",
"summary": "Mark as Inactive",
"description": "Mark location as Inactive."
},
"mark_location_as_primary": {
"type": "operation",
"method": "POST",
"path": "/locations/{location_id}/markasprimary",
"summary": "Mark as Primary",
"description": "Mark location as primary."
},
"list_users_of_a_location": {
"type": "operation",
"method": "GET",
"path": "/locations/{location_id}/users",
"summary": "List users of a location",
"description": "List the users associated with a location."
},
"parent_location_id": {
"type": "schema",
"module": "locations",
"description": "Parent Location ID"
},
"tax_settings_id": {
"type": "schema",
"module": "locations",
"description": "Tax Settings ID"
},
"street_address1": {
"type": "schema",
"module": "organizations",
"description": "Street name of the Billing address of the Organisation"
},
"street_address2": {
"type": "schema",
"module": "organizations",
"description": "Continyed billing address of the organisation"
},
"autonumbergenerationgroup_id": {
"type": "schema",
"module": "locations",
"description": "Autonumber generation group ID"
},
"address.city": {
"type": "property",
"dataType": "string",
"description": ""
},
"address.state": {
"type": "property",
"dataType": "string",
"description": ""
},
"address.country": {
"type": "property",
"dataType": "string",
"description": ""
},
"address.attention": {
"type": "property",
"dataType": "string",
"description": ""
},
"address.state_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"address.street_address1": {
"type": "property",
"dataType": "string",
"description": ""
},
"address.street_address2": {
"type": "property",
"dataType": "string",
"description": ""
},
"associated_series_ids": {
"type": "schema",
"module": "locations",
"description": "List of associated series IDs"
},
"user_id": {
"type": "schema",
"module": "users",
"description": "Unique ID of the user"
},
"user_ids": {
"type": "schema",
"module": "locations",
"description": "Comma separated user ids."
},
"is_all_users_selected": {
"type": "schema",
"module": "locations",
"description": "Whether all users are selected or not"
},
"locations.address": {
"type": "property",
"dataType": "string",
"description": ""
},
"locations.email": {
"type": "property",
"dataType": "string",
"description": ""
},
"locations.is_primary": {
"type": "property",
"dataType": "string",
"description": ""
},
"locations.phone": {
"type": "property",
"dataType": "string",
"description": ""
},
"locations.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"locations.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"locations.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"locations.type": {
"type": "property",
"dataType": "string",
"description": ""
},
"locations.parent_location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"locations.associated_series_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"locations.auto_number_generation_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"locations.associated_users": {
"type": "property",
"dataType": "array",
"description": ""
},
"locations.tax_settings_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"enable-location-response": {
"type": "schema",
"module": "locations",
"description": ""
},
"enable-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"enable-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-location-request": {
"type": "schema",
"module": "locations",
"description": ""
},
"create-a-location-request.type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-location-request.email": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-location-request.phone": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-location-request.address": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-location-request.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-location-request.tax_settings_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-location-request.parent_location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-location-request.associated_series_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-location-request.auto_number_generation_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-location-request.is_all_users_selected": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-location-request.user_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-location-response": {
"type": "schema",
"module": "locations",
"description": ""
},
"create-a-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-location-response.locations": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-location-response": {
"type": "schema",
"module": "locations",
"description": ""
},
"list-all-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-location-response.locations": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-location-request": {
"type": "schema",
"module": "locations",
"description": ""
},
"update-location-request.type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-location-request.email": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-location-request.phone": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-location-request.address": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-location-request.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-location-request.tax_settings_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-location-request.parent_location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-location-request.associated_series_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-location-request.auto_number_generation_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-location-request.is_all_users_selected": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-location-request.user_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-location-response": {
"type": "schema",
"module": "locations",
"description": ""
},
"update-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-location-response.locations": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-a-location-response": {
"type": "schema",
"module": "locations",
"description": ""
},
"delete-a-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-as-primary-response": {
"type": "schema",
"module": "locations",
"description": ""
},
"mark-as-primary-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-as-primary-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-details": {
"type": "schema",
"module": "locations",
"description": ""
},
"location-details.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-details.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-details.type": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-details.parent_location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-details.address": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-details.phone": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-details.fax": {
"type": "property",
"dataType": "string",
"description": "Fax number for the location."
},
"location-details.email": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-details.website": {
"type": "property",
"dataType": "string",
"description": "Website of the location."
},
"location-details.tax_settings_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-details.tax_reg_no": {
"type": "property",
"dataType": "string",
"description": "Tax registration number of the location."
},
"location-details.is_primary_location": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-details.is_location_active": {
"type": "property",
"dataType": "boolean",
"description": "Whether the location is currently active."
},
"location-details.autonumbergenerationgroup_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-details.autonumbergenerationgroup_name": {
"type": "property",
"dataType": "string",
"description": "Name of the auto number generation group associated with the location."
},
"location-details.associated_series_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-details.customer_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the customer associated with the location."
},
"location-details.customer_name": {
"type": "property",
"dataType": "string",
"description": "Name of the customer associated with the location."
},
"location-details.vendor_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the vendor associated with the location."
},
"location-details.vendor_name": {
"type": "property",
"dataType": "string",
"description": "Name of the vendor associated with the location."
},
"location-details.is_all_users_selected": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-details.associated_users": {
"type": "property",
"dataType": "array",
"description": ""
},
"location-details.location_identification_number": {
"type": "property",
"dataType": "string",
"description": "Unique identification number assigned to the location."
},
"location-details.location_identification_label": {
"type": "property",
"dataType": "string",
"description": "Label used to identify the location."
},
"get-a-location-response": {
"type": "schema",
"module": "locations",
"description": ""
},
"get-a-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-location-response.location": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-user": {
"type": "schema",
"module": "locations",
"description": ""
},
"location-user.user_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"location-user.name": {
"type": "property",
"dataType": "string",
"description": "Name of the user."
},
"location-user.email": {
"type": "property",
"dataType": "string",
"description": "Email address of the user."
},
"location-user.mobile": {
"type": "property",
"dataType": "string",
"description": "Mobile number of the user."
},
"location-user.user_role": {
"type": "property",
"dataType": "string",
"description": "Role assigned to the user."
},
"location-user.status": {
"type": "property",
"dataType": "string",
"description": "Status of the user. Allowed Values: active, inactive, invited."
},
"location-user.photo_url": {
"type": "property",
"dataType": "string",
"description": "URL of the user's photo."
},
"page-context": {
"type": "schema",
"module": "locations",
"description": ""
},
"page-context.page": {
"type": "property",
"dataType": "integer",
"description": "Current page number."
},
"page-context.per_page": {
"type": "property",
"dataType": "integer",
"description": "Number of records returned per page."
},
"page-context.has_more_page": {
"type": "property",
"dataType": "boolean",
"description": "Whether more pages of results are available."
},
"page-context.report_name": {
"type": "property",
"dataType": "string",
"description": "Name of the report."
},
"page-context.sort_column": {
"type": "property",
"dataType": "string",
"description": "Column used to sort the results."
},
"page-context.sort_order": {
"type": "property",
"dataType": "string",
"description": "Order in which the results are sorted. Allowed Values: A (ascending), D (descending)."
},
"list-users-of-a-location-response": {
"type": "schema",
"module": "locations",
"description": ""
},
"list-users-of-a-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-users-of-a-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-users-of-a-location-response.users": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-users-of-a-location-response.page_context": {
"type": "property",
"dataType": "string",
"description": ""
},
"moveorders": {
"type": "tag",
"description": "MoveOrders Module"
},
"create_move_order": {
"type": "operation",
"method": "POST",
"path": "/moveorders",
"summary": "Create a move order",
"description": "Creates a new move order in Zoho Inventory."
},
"list_move_orders": {
"type": "operation",
"method": "GET",
"path": "/moveorders",
"summary": "List all move orders",
"description": "Lists move orders with optional filters, search options, and pagination."
},
"moveorder_number": {
"type": "parameter",
"in": "query",
"description": "Search by move order number."
},
"moveorder_number_startswith": {
"type": "parameter",
"in": "query",
"description": "Match move order numbers that start with this value."
},
"moveorder_number_contains": {
"type": "parameter",
"in": "query",
"description": "Match move order numbers that contain this substring."
},
"assignee_id": {
"type": "parameter",
"in": "query",
"description": "Filter picklists by the assigned user."
},
"delete_move_orders": {
"type": "operation",
"method": "DELETE",
"path": "/moveorders",
"summary": "Delete move orders",
"description": "Deletes move orders."
},
"get_move_order": {
"type": "operation",
"method": "GET",
"path": "/moveorders/{moveorder_id}",
"summary": "Retrieve a move order",
"description": "Fetches details of an existing move order, including line items."
},
"include": {
"type": "parameter",
"in": "query",
"description": "When set to HTML, additional HTML content may be included in the response when supported."
},
"update_move_order": {
"type": "operation",
"method": "PUT",
"path": "/moveorders/{moveorder_id}",
"summary": "Update a move order",
"description": "Updates an existing move order."
},
"delete_move_order": {
"type": "operation",
"method": "DELETE",
"path": "/moveorders/{moveorder_id}",
"summary": "Delete a move order",
"description": "Deletes a single move order."
},
"list_move_order_comments": {
"type": "operation",
"method": "GET",
"path": "/moveorders/{moveorder_id}/comments",
"summary": "List comments for a move order",
"description": "Returns all comments recorded on a move order."
},
"mark_move_order_as_confirmed": {
"type": "operation",
"method": "POST",
"path": "/moveorders/{moveorder_id}/markasconfirmed",
"summary": "Mark move order as confirmed",
"description": "Updates the move order status to confirmed."
},
"mark_move_order_as_in_progress": {
"type": "operation",
"method": "POST",
"path": "/moveorders/{moveorder_id}/markasinprogress",
"summary": "Mark move order as in progress",
"description": "Updates the move order status to in progress."
},
"mark_move_order_as_completed": {
"type": "operation",
"method": "POST",
"path": "/moveorders/{moveorder_id}/markascompleted",
"summary": "Mark move order as completed",
"description": "Updates the move order status to completed. A completion date is required."
},
"completed_date": {
"type": "parameter",
"in": "query",
"description": "Completion date (yyyy-mm-dd)."
},
"add_move_order_attachment": {
"type": "operation",
"method": "POST",
"path": "/moveorders/{moveorder_id}/attachment",
"summary": "Attach files to a move order",
"description": "Uploads one or more files and associates them with the move order."
},
"get_move_order_document": {
"type": "operation",
"method": "GET",
"path": "/moveorders/{moveorder_id}/documents/{document_id}",
"summary": "Download a move order document",
"description": "Returns the binary content of an attached document (image or PDF)."
},
"image_size": {
"type": "parameter",
"in": "query",
"description": "Size of the image to be fetched. Allowed values are xlarge, large, small and tiny."
},
"inline": {
"type": "parameter",
"in": "query",
"description": "Indicate whether the document should be displayed inline. Allowed values are true and false."
},
"delete_move_order_document": {
"type": "operation",
"method": "DELETE",
"path": "/moveorders/{moveorder_id}/documents/{document_id}",
"summary": "Remove an attachment from a move order",
"description": "Deletes or unlinks a document from the specified move order."
},
"un_associate": {
"type": "parameter",
"in": "query",
"description": "Indicates whether the document should be unassociated from the task. Allowed values are true and false."
},
"get_move_order_settings": {
"type": "operation",
"method": "GET",
"path": "/settings/moveorders",
"summary": "Get move order auto number generation settings",
"description": "Returns auto number generation preferences for move orders."
},
"move-order-settings": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"move-order-settings.auto_generate": {
"type": "property",
"dataType": "boolean",
"description": "Whether move order numbers are auto-generated."
},
"move-order-settings.prefix_string": {
"type": "property",
"dataType": "string",
"description": "Prefix for auto-generated move order numbers."
},
"move-order-settings.next_number": {
"type": "property",
"dataType": "string",
"description": "Next number in the auto-number sequence."
},
"move-order-line-batch-node": {
"type": "schema",
"module": "moveorders",
"description": "One batch allocation on a move-order line. Use either an existing batch_id or new batch attributes as required by your org and item settings (see server BatchNumberCreate / BatchNumberEdit)."
},
"move-order-line-batch-node.batch_id": {
"type": "property",
"dataType": "integer",
"description": "Existing inventory batch ID when selecting stock from an existing batch."
},
"move-order-line-batch-node.batch_in_id": {
"type": "property",
"dataType": "integer",
"description": "Batch-in row reference when supplied by the client."
},
"move-order-line-batch-node.batch_number": {
"type": "property",
"dataType": "string",
"description": "Batch number for a new batch line when not using an existing batch_id."
},
"move-order-line-batch-node.manufacturer_batch_number": {
"type": "property",
"dataType": "string",
"description": "Manufacturer or external batch reference."
},
"move-order-line-batch-node.manufactured_date": {
"type": "property",
"dataType": "string",
"description": "Manufacturing date (yyyy-mm-dd)."
},
"move-order-line-batch-node.expiry_date": {
"type": "property",
"dataType": "string",
"description": "Expiry date (yyyy-mm-dd)."
},
"move-order-line-batch-node.in_quantity": {
"type": "property",
"dataType": "number",
"description": "Quantity for this batch when the line quantity is split across batches."
},
"move-order-line-batch-node.sales_rate": {
"type": "property",
"dataType": "number",
"description": "Selling rate for the batch when batch pricing is enabled."
},
"move-order-line-batch-node.label_rate": {
"type": "property",
"dataType": "number",
"description": "Label (MRP) rate for the batch when applicable."
},
"move-order-line-batch-node.balance_quantity": {
"type": "property",
"dataType": "number",
"description": "On read, returns the remaining quantity in the batch."
},
"move-order-line-batch-node.status": {
"type": "property",
"dataType": "string",
"description": "On read, batch status when returned by the service."
},
"move-order-line-storage-node": {
"type": "schema",
"module": "moveorders",
"description": "Storage-bin allocation for source (from_storages) or destination (to_storages) on a line when storage tracking is enabled."
},
"move-order-line-storage-node.storage_id": {
"type": "property",
"dataType": "integer",
"description": "Storage location ID."
},
"move-order-line-storage-node.quantity": {
"type": "property",
"dataType": "number",
"description": "Quantity moved from or into this storage for the line."
},
"move-order-line-serial-node": {
"type": "schema",
"module": "moveorders",
"description": "Serial number row returned on a line when serial tracking is enabled."
},
"move-order-line-serial-node.serialnumber_id": {
"type": "property",
"dataType": "integer",
"description": "Serial number master record ID."
},
"move-order-line-serial-node.serial_number": {
"type": "property",
"dataType": "string",
"description": "Serial code."
},
"move-order-line-serial-node.status": {
"type": "property",
"dataType": "string",
"description": "Serial status when returned by the service."
},
"move-order-document-attachment": {
"type": "schema",
"module": "moveorders",
"description": "File attached to a move order (DocumentDetailsForEntity)."
},
"move-order-document-attachment.document_id": {
"type": "property",
"dataType": "integer",
"description": "Attachment document ID; use with GET/DELETE `/moveorders/{moveorder_id}/documents/{document_id}`."
},
"move-order-document-attachment.file_name": {
"type": "property",
"dataType": "string",
"description": "Original file name."
},
"move-order-document-attachment.file_type": {
"type": "property",
"dataType": "string",
"description": "MIME or file type classification."
},
"move-order-document-attachment.file_size": {
"type": "property",
"dataType": "integer",
"description": "File size in bytes."
},
"move-order-document-attachment.file_size_formatted": {
"type": "property",
"dataType": "string",
"description": "Human-readable file size."
},
"move-order-line-item-request": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"move-order-line-item-request.line_item_id": {
"type": "property",
"dataType": "integer",
"description": "Line item ID returned by the server. Required on update when modifying existing line items."
},
"move-order-line-item-request.item_id": {
"type": "property",
"dataType": "integer",
"description": "Item (product) ID for this line. Required for every line item (same role as item_id on transfer order line items)."
},
"move-order-line-item-request.description": {
"type": "property",
"dataType": "string",
"description": "Line-level description or notes for the item. Optional."
},
"move-order-line-item-request.quantity_transferred": {
"type": "property",
"dataType": "number",
"description": "Quantity to move for this line. Required for every line item (same role as quantity_transfer on transfer orders)."
},
"move-order-line-item-request.batches": {
"type": "property",
"dataType": "array",
"description": "Batch details when batch tracking is enabled."
},
"move-order-line-item-request.from_storages": {
"type": "property",
"dataType": "array",
"description": "Source storage allocations when storage tracking is enabled."
},
"move-order-line-item-request.to_storages": {
"type": "property",
"dataType": "array",
"description": "Destination storage allocations when storage tracking is enabled."
},
"create-a-move-order-request": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"create-a-move-order-request.moveorder_number": {
"type": "property",
"dataType": "string",
"description": "Move order number; optional when auto-generation is enabled."
},
"create-a-move-order-request.date": {
"type": "property",
"dataType": "string",
"description": "Transaction date (yyyy-mm-dd)."
},
"create-a-move-order-request.completed_date": {
"type": "property",
"dataType": "string",
"description": "Completed date when applicable (yyyy-mm-dd)."
},
"create-a-move-order-request.assignee_id": {
"type": "property",
"dataType": "integer",
"description": "User ID of the assignee for this move order."
},
"create-a-move-order-request.warehouse_id": {
"type": "property",
"dataType": "integer",
"description": "Warehouse ID when warehouses are enabled."
},
"create-a-move-order-request.location_id": {
"type": "property",
"dataType": "integer",
"description": "Location (branch) ID when locations are enabled."
},
"create-a-move-order-request.notes": {
"type": "property",
"dataType": "string",
"description": "Internal notes for the move order."
},
"create-a-move-order-request.status": {
"type": "property",
"dataType": "string",
"description": "Move order status when supplied on create or update."
},
"create-a-move-order-request.line_items": {
"type": "property",
"dataType": "array",
"description": "A move order can contain multiple line items. Each object must include item_id and quantity_transferred. Optional fields: line_item_id (required on update for existing lines), description, batches, from_storages, and to_storages when batch or bin storage tracking applies in your organization."
},
"update-a-move-order-request": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"move-order-comment": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"move-order-comment.comment_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-comment.moveorder_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-comment.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-comment.commented_by_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-comment.commented_by": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-comment.comment_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-comment.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-comment.date_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-comment.time": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-comment.operation_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-line-item-response": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"move-order-line-item-response.line_item_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-line-item-response.item_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-line-item-response.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-line-item-response.sku": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-line-item-response.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-line-item-response.unit_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-line-item-response.image_document_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-line-item-response.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-line-item-response.quantity_transferred": {
"type": "property",
"dataType": "number",
"description": ""
},
"move-order-line-item-response.track_serial_number": {
"type": "property",
"dataType": "boolean",
"description": ""
},
"move-order-line-item-response.track_batch_number": {
"type": "property",
"dataType": "boolean",
"description": ""
},
"move-order-line-item-response.serial_numbers": {
"type": "property",
"dataType": "array",
"description": ""
},
"move-order-line-item-response.batches": {
"type": "property",
"dataType": "array",
"description": ""
},
"move-order-line-item-response.is_combo_product": {
"type": "property",
"dataType": "boolean",
"description": ""
},
"move-order-line-item-response.from_storages": {
"type": "property",
"dataType": "array",
"description": ""
},
"move-order-line-item-response.to_storages": {
"type": "property",
"dataType": "array",
"description": ""
},
"move-order-line-item-response.is_storage_location_enabled": {
"type": "property",
"dataType": "boolean",
"description": ""
},
"move-order-response": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"move-order-response.moveorder_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-response.moveorder_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-response.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-response.completed_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-response.assignee_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-response.assignee_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-response.created_by_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-response.created_by_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-response.warehouse_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-response.warehouse_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-response.location_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-response.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-response.html_string": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-response.comments": {
"type": "property",
"dataType": "array",
"description": ""
},
"move-order-response.line_items": {
"type": "property",
"dataType": "array",
"description": ""
},
"move-order-response.documents": {
"type": "property",
"dataType": "array",
"description": "Attachments on the move order when returned by the service."
},
"move-order-list-row": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"move-order-list-row.moveorder_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-list-row.moveorder_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-list-row.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-list-row.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-list-row.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-list-row.assignee_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-list-row.assignee_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-list-row.warehouse_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-list-row.warehouse_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-list-row.location_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-list-row.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-list-row.has_attachment": {
"type": "property",
"dataType": "boolean",
"description": ""
},
"move-order-list-row.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-list-row.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-move-order-response": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"create-a-move-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-move-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-move-order-response.moveorder": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-move-orders-response": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"list-move-orders-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-move-orders-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-move-orders-response.moveorders": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-move-orders-response.page_context": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-move-order-response": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"get-a-move-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-move-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-move-order-response.moveorder": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-move-order-response": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"delete-a-move-order-response": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"delete-a-move-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-move-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-a-move-order-document-response": {
"type": "schema",
"module": "moveorders",
"description": "Returned when a document is removed from a move order."
},
"delete-a-move-order-document-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-move-order-document-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-move-order-comments-response": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"list-move-order-comments-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-move-order-comments-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-move-order-comments-response.comments": {
"type": "property",
"dataType": "array",
"description": ""
},
"move-order-status-response": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"move-order-status-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-status-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-attachment-response": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"move-order-attachment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"move-order-attachment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"move-order-attachment-response.document": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-move-order-settings-response": {
"type": "schema",
"module": "moveorders",
"description": ""
},
"get-move-order-settings-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-move-order-settings-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-move-order-settings-response.moveorder_settings": {
"type": "property",
"dataType": "string",
"description": ""
},
"organizations": {
"type": "schema",
"module": "organizations",
"description": "List of organisatiions under an account"
},
"create_organization": {
"type": "operation",
"method": "POST",
"path": "/organizations",
"summary": "Create an organization",
"description": "Create an organization."
},
"list_organizations": {
"type": "operation",
"method": "GET",
"path": "/organizations",
"summary": "List organizations",
"description": "Get the list of organizations."
},
"update_organization": {
"type": "operation",
"method": "PUT",
"path": "/organizations/{organization_id}",
"summary": "Update an organization",
"description": "Update the details of an organization."
},
"get_organization": {
"type": "operation",
"method": "GET",
"path": "/organizations/{organization_id}",
"summary": "Get an organization",
"description": "Get the details of an organization."
},
"organization-response": {
"type": "schema",
"module": "organizations",
"description": "List of Organisation - details"
},
"organization-response.organization_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.is_logo_uploaded": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.is_default_org": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.user_role": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.account_created_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.time_zone": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.language_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.date_format": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.field_separator": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.fiscal_year_start_month": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.tax_group_enabled": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.user_status": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.contact_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.industry_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization-response.address": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization_id": {
"type": "schema",
"module": "organizations",
"description": "ID of the organisation generated by the server"
},
"is_logo_uploaded": {
"type": "schema",
"module": "organizations",
"description": "Boolean to check if logo of the organisation if available"
},
"user_role": {
"type": "schema",
"module": "users",
"description": "The role of the user"
},
"user_status": {
"type": "schema",
"module": "organizations",
"description": "Status of the user"
},
"is_default_org": {
"type": "schema",
"module": "organizations",
"description": ""
},
"plan_type": {
"type": "schema",
"module": "organizations",
"description": "Type of the plan subscribed"
},
"tax_group_enabled": {
"type": "schema",
"module": "organizations",
"description": ""
},
"zi_migration_status": {
"type": "schema",
"module": "organizations",
"description": ""
},
"plan_name": {
"type": "schema",
"module": "organizations",
"description": "Name of the subscribed plan"
},
"plan_period": {
"type": "schema",
"module": "organizations",
"description": "Duration/Cycle of the plan cycle"
},
"fiscal_year_start_month": {
"type": "schema",
"module": "organizations",
"description": "Starting month of teh financial year"
},
"account_created_date": {
"type": "schema",
"module": "organizations",
"description": "Date of creation of the account"
},
"account_created_date_formatted": {
"type": "schema",
"module": "organizations",
"description": ""
},
"time_zone": {
"type": "schema",
"module": "organizations",
"description": "Time Zone of the Organisation's country"
},
"is_org_active": {
"type": "schema",
"module": "organizations",
"description": ""
},
"portal_name": {
"type": "schema",
"module": "organizations",
"description": "Poratal name for the organisation. Length of the portal name should be greater than 4 and less than 31. Allowed chars [a-z][A-Z][0-9]"
},
"date_format": {
"type": "schema",
"module": "organizations",
"description": ""
},
"field_separator": {
"type": "schema",
"module": "organizations",
"description": "Separator used to classify fields"
},
"industry_type": {
"type": "schema",
"module": "organizations",
"description": "Business type"
},
"industry_size": {
"type": "schema",
"module": "organizations",
"description": "The size of the industry. The possibe values could be \"small scale\", \"medium scale\", \"large scale\""
},
"unverified_email": {
"type": "schema",
"module": "organizations",
"description": "To verify email address of the organisation's contact"
},
"is_transaction_available": {
"type": "schema",
"module": "organizations",
"description": "To check for transaction history of the organisation"
},
"show_org_address_as_one_field": {
"type": "schema",
"module": "organizations",
"description": "Display the complete address of the organisation in one box"
},
"links": {
"type": "schema",
"module": "organizations",
"description": "External links of the organisation"
},
"company_id_label": {
"type": "schema",
"module": "organizations",
"description": "Label denoting company ID"
},
"company_id_value": {
"type": "schema",
"module": "organizations",
"description": "Value in the label \"company ID\""
},
"tax_id_label": {
"type": "schema",
"module": "organizations",
"description": "Label in \"Tax ID\" field"
},
"tax_id_value": {
"type": "schema",
"module": "organizations",
"description": "Value in the tax ID field"
},
"org_address": {
"type": "schema",
"module": "organizations",
"description": "Billing address of the organisation"
},
"remit_to_address": {
"type": "schema",
"module": "organizations",
"description": "Shipping address of the organisation"
},
"companyid_label": {
"type": "schema",
"module": "organizations",
"description": "Label \" Company ID \""
},
"companyid_value": {
"type": "schema",
"module": "organizations",
"description": "value in field \"company ID\""
},
"taxid_label": {
"type": "schema",
"module": "organizations",
"description": "Label \"tax ID\""
},
"taxid_value": {
"type": "schema",
"module": "organizations",
"description": "Value in \"tax ID\""
},
"projects": {
"type": "schema",
"module": "organizations",
"description": "List of projects run by the organisation"
},
"address.zip": {
"type": "property",
"dataType": "string",
"description": ""
},
"organization": {
"type": "schema",
"module": "organizations",
"description": "List of Organisation - details"
},
"create-an-organization-request": {
"type": "schema",
"module": "organizations",
"description": ""
},
"create-an-organization-request.name": {
"type": "property",
"dataType": "string",
"description": "Name of the project."
},
"create-an-organization-request.fiscal_year_start_month": {
"type": "property",
"dataType": "string",
"description": "Fiscal or financial starting year of your business. Allowed Values: january, february, march, april, may, june, july, august, september, october, november and december"
},
"create-an-organization-request.currency_code": {
"type": "property",
"dataType": "string",
"description": "Standard code for currency."
},
"create-an-organization-request.time_zone": {
"type": "property",
"dataType": "string",
"description": "Time zone in with the organization is located geographically."
},
"create-an-organization-request.date_format": {
"type": "property",
"dataType": "string",
"description": "Format for representing the date."
},
"create-an-organization-request.field_separator": {
"type": "property",
"dataType": "string",
"description": "Field separator for components in date."
},
"create-an-organization-request.language_code": {
"type": "property",
"dataType": "string",
"description": "language code for organization.For instance en represents english."
},
"create-an-organization-request.industry_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-organization-request.industry_size": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-organization-request.portal_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-organization-request.org_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-organization-request.remit_to_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-organization-request.address": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-organization-response": {
"type": "schema",
"module": "organizations",
"description": ""
},
"create-an-organization-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-an-organization-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-an-organization-response.organization": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-organizations-response": {
"type": "schema",
"module": "organizations",
"description": ""
},
"list-organizations-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-organizations-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-organizations-response.organizations": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-an-organization-request": {
"type": "schema",
"module": "organizations",
"description": ""
},
"update-an-organization-request.name": {
"type": "property",
"dataType": "string",
"description": "Name of the project."
},
"update-an-organization-request.fiscal_year_start_month": {
"type": "property",
"dataType": "string",
"description": "Fiscal or financial starting year of your business. Allowed Values: january, february, march, april, may, june, july, august, september, october, november and december"
},
"update-an-organization-request.is_logo_uploaded": {
"type": "property",
"dataType": "boolean",
"description": "To determine whether logo is uploaded."
},
"update-an-organization-request.time_zone": {
"type": "property",
"dataType": "string",
"description": "Time zone in with the organization is located geographically."
},
"update-an-organization-request.date_format": {
"type": "property",
"dataType": "string",
"description": "Format for representing the date."
},
"update-an-organization-request.field_separator": {
"type": "property",
"dataType": "string",
"description": "Field separator for components in date."
},
"update-an-organization-request.language_code": {
"type": "property",
"dataType": "string",
"description": "language code for organization.For instance en represents english."
},
"update-an-organization-request.org_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-request.remit_to_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-request.address": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-request.contact_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-request.phone": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-request.fax": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-request.website": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-request.email": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-request.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-request.companyid_label": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-request.companyid_value": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-request.taxid_label": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-request.taxid_value": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-response": {
"type": "schema",
"module": "organizations",
"description": ""
},
"update-an-organization-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-an-organization-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-an-organization-response.organization": {
"type": "property",
"dataType": "object",
"description": "List of Organisation - details"
},
"get-an-organization-response": {
"type": "schema",
"module": "organizations",
"description": ""
},
"get-an-organization-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-an-organization-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-an-organization-response.organization": {
"type": "property",
"dataType": "object",
"description": "List of Organisation - details"
},
"packages": {
"type": "schema",
"module": "salesorders",
"description": "These are the packages created for Sales Orders. Each package contains - package_id,package_number,status,detailed_status,status_message,shipment_id,shipment_number,shipment_status,carrier,service,tracking_number,shipment_date,delivery_days and delivery_guarantee."
},
"create_package": {
"type": "operation",
"method": "POST",
"path": "/packages",
"summary": "Creating a package",
"description": "A new package can be created. To create package, URL parameter salesorder_id also needed."
},
"salesorder_id": {
"type": "schema",
"module": "shipmentorders",
"description": "Unique ID generated by the server for the Sales Order. This is used as identifier."
},
"list_packages": {
"type": "operation",
"method": "GET",
"path": "/packages",
"summary": "List all packages",
"description": "List all existing packages."
},
"packing_number_startswith": {
"type": "schema",
"module": "packages",
"description": "Used for searching package_id which starts with given number in advanced search option"
},
"packing_number_contains": {
"type": "schema",
"module": "packages",
"description": "Used for searching package_id which contains given number in advanced search option"
},
"salesorder_number_startswith": {
"type": "parameter",
"in": "query",
"description": "Filter picklists where the associated sales order number starts with the given value."
},
"salesorder_number_contains": {
"type": "parameter",
"in": "query",
"description": "Filter picklists where the associated sales order number contains the given value."
},
"shipment_date_start": {
"type": "schema",
"module": "packages",
"description": "Used for searching shipments from specified date Use the node as shipment_date_after if specified date is not to be considered"
},
"shipment_date_end": {
"type": "schema",
"module": "packages",
"description": "Used for searching shipments till specified date Use the node as shipment_date_before if specified date is not to be considered"
},
"customer_name_startswith": {
"type": "schema",
"module": "packages",
"description": "Used for searching salesorder_id which starts with given number in advanced search option"
},
"customer_name_contains": {
"type": "schema",
"module": "packages",
"description": "Used for searching salesorder_id which contains given number in advanced search option"
},
"delivery_method_startswith": {
"type": "schema",
"module": "packages",
"description": "Used for searching delivery_method which starts with given string in advanced search option"
},
"delivery_method_contains": {
"type": "schema",
"module": "packages",
"description": "Used for searching delivery_method which contains given string in advanced search option"
},
"get_package": {
"type": "operation",
"method": "GET",
"path": "/packages/{package_id}",
"summary": "Retrieving a package",
"description": "Retrieving details of existing package."
},
"update_package": {
"type": "operation",
"method": "PUT",
"path": "/packages/{package_id}",
"summary": "Updating a package",
"description": "Updating details of existing package."
},
"delete_package": {
"type": "operation",
"method": "DELETE",
"path": "/packages/{package_id}",
"summary": "Deleting a package",
"description": "Deleting an existing package."
},
"bulk_print_packages": {
"type": "operation",
"method": "GET",
"path": "/packages/print",
"summary": "Bulk print packages",
"description": "Print package slips."
},
"package_ids": {
"type": "schema",
"module": "shipmentorders",
"description": "Array of package_id(s) to be shipped"
},
"package-response": {
"type": "schema",
"module": "packages",
"description": ""
},
"package-response.billing_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.contact_persons": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.customer_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.email": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.is_emailed": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.line_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.mobile": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.package_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.package_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.phone": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.salesorder_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.salesorder_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.shipping_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.template_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.template_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.total_quantity": {
"type": "property",
"dataType": "string",
"description": ""
},
"package-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"package_number": {
"type": "schema",
"module": "salesorders",
"description": "Package number of the Sales Order."
},
"so_line_item_id": {
"type": "schema",
"module": "packages",
"description": "Unique ID generated by the server for items in sales order"
},
"billing_address.phone": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipping_address.phone": {
"type": "property",
"dataType": "string",
"description": ""
},
"carrier": {
"type": "schema",
"module": "shipmentorders",
"description": "Carrier used for shipment."
},
"delivery_days": {
"type": "schema",
"module": "shipmentorders",
"description": "Number of days taken by the courier for delivering in package"
},
"delivery_guarantee": {
"type": "schema",
"module": "shipmentorders",
"description": "guarantee assured by the courier. For guaranteed on-time deliveries, it is true else it is false"
},
"delivery_method": {
"type": "schema",
"module": "shipmentorders",
"description": "Delivery method of the shipment."
},
"delivery_method_id": {
"type": "schema",
"module": "shipmentorders",
"description": "Unique ID generated by the server for the delivery method. This is used as an identifier."
},
"detailed_status": {
"type": "schema",
"module": "shipmentorders",
"description": "Detailed shipment details received from the courier"
},
"is_invoiced": {
"type": "schema",
"module": "shipmentorders",
"description": "Checks whether the Sales Order has been invoiced or not."
},
"is_active": {
"type": "schema",
"module": "packages",
"description": ""
},
"placeholder": {
"type": "schema",
"module": "packages",
"description": "Placeholder for the custom field"
},
"show_in_all_pdf": {
"type": "schema",
"module": "packages",
"description": ""
},
"package_id": {
"type": "schema",
"module": "shipmentorders",
"description": "Unique ID generated by the server for packages"
},
"salesorder_number": {
"type": "schema",
"module": "shipmentorders",
"description": "The Sales Order number. This is unique for each sales order."
},
"service": {
"type": "schema",
"module": "shipmentorders",
"description": "Type of service selected for shipment"
},
"shipment_id": {
"type": "schema",
"module": "shipmentorders",
"description": "Unique ID generated by the server for the shipment. This is used as an identifier."
},
"shipment_number": {
"type": "schema",
"module": "shipmentorders",
"description": "Shipment number of the package."
},
"shipment_rate": {
"type": "schema",
"module": "packages",
"description": "Costs involved for shipment"
},
"shipping_date": {
"type": "schema",
"module": "packages",
"description": "Date on which package is shipped"
},
"tracking_number": {
"type": "parameter",
"in": "query",
"description": "Filter by tracking number."
},
"total_quantity": {
"type": "schema",
"module": "packages",
"description": "Total quantity in the package"
},
"shipment_order": {
"type": "schema",
"module": "packages",
"description": "Shipment details of the package"
},
"shipment_order.carrier": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order.delivery_days": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order.delivery_guarantee": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order.delivery_method": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order.delivery_method_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order.detailed_status": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order.service": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order.shipment_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order.shipment_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order.shipment_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order.shipping_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order.tracking_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"package": {
"type": "schema",
"module": "packages",
"description": ""
},
"creating-a-package-request": {
"type": "schema",
"module": "packages",
"description": ""
},
"creating-a-package-request.package_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-package-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-package-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-package-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Details of the items in this package"
},
"creating-a-package-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-package-response": {
"type": "schema",
"module": "packages",
"description": ""
},
"creating-a-package-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"creating-a-package-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"creating-a-package-response.package": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-packages-response": {
"type": "schema",
"module": "packages",
"description": ""
},
"list-all-packages-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-packages-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-packages-response.packagea": {
"type": "property",
"dataType": "array",
"description": ""
},
"retrieving-a-package-response": {
"type": "schema",
"module": "packages",
"description": ""
},
"retrieving-a-package-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieving-a-package-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieving-a-package-response.package": {
"type": "property",
"dataType": "array",
"description": ""
},
"updating-a-package-request": {
"type": "schema",
"module": "packages",
"description": ""
},
"updating-a-package-request.package_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-package-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-package-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-package-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Details of the items in this package"
},
"updating-a-package-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-package-response": {
"type": "schema",
"module": "packages",
"description": ""
},
"updating-a-package-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"updating-a-package-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"updating-a-package-response.package": {
"type": "property",
"dataType": "string",
"description": ""
},
"deleting-a-package-response": {
"type": "schema",
"module": "packages",
"description": ""
},
"deleting-a-package-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"deleting-a-package-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"bulk-print-packages-response": {
"type": "schema",
"module": "packages",
"description": ""
},
"bulk-print-packages-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"bulk-print-packages-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"picklists": {
"type": "tag",
"description": "Picklists Module"
},
"list_picklists": {
"type": "operation",
"method": "GET",
"path": "/picklists",
"summary": "List Picklists",
"description": "Retrieve the list of all picklists in the organization."
},
"purchase_return_number": {
"type": "parameter",
"in": "query",
"description": "Filter by purchase return number."
},
"purchase_return_number_startswith": {
"type": "parameter",
"in": "query",
"description": "Filter picklists where the associated purchase return number starts with the given value."
},
"purchase_return_number_contains": {
"type": "parameter",
"in": "query",
"description": "Filter picklists where the associated purchase return number contains the given value."
},
"picklist_number": {
"type": "schema",
"module": "picklists",
"description": "Unique number assigned to the picklist. Auto-generated unless overridden."
},
"picklist_number_startswith": {
"type": "parameter",
"in": "query",
"description": "Filter picklists where the picklist number starts with the given value."
},
"picklist_number_contains": {
"type": "parameter",
"in": "query",
"description": "Filter picklists where the picklist number contains the given value."
},
"create_picklist": {
"type": "operation",
"method": "POST",
"path": "/picklists",
"summary": "Create a Picklist",
"description": "Create a new picklist for picking items."
},
"bulk_delete_picklists": {
"type": "operation",
"method": "DELETE",
"path": "/picklists",
"summary": "Bulk Delete Picklists",
"description": "Delete multiple picklists at once."
},
"picklist_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of picklist IDs. Maximum 25 IDs."
},
"get_picklist": {
"type": "operation",
"method": "GET",
"path": "/picklists/{picklist_id}",
"summary": "Get a Picklist",
"description": "Retrieve the details of an existing picklist."
},
"update_picklist": {
"type": "operation",
"method": "PUT",
"path": "/picklists/{picklist_id}",
"summary": "Update a Picklist",
"description": "Update the details of an existing picklist."
},
"delete_picklist": {
"type": "operation",
"method": "DELETE",
"path": "/picklists/{picklist_id}",
"summary": "Delete a Picklist",
"description": "Delete an existing picklist."
},
"set_picklist_status": {
"type": "operation",
"method": "POST",
"path": "/picklists/{picklist_id}/setstatus",
"summary": "Set Status of a Picklist",
"description": "Update the status of a specific picklist."
},
"bulk_set_picklist_status": {
"type": "operation",
"method": "POST",
"path": "/picklists/setstatus",
"summary": "Bulk Set Status of Picklists",
"description": "Update the status of multiple picklists at once."
},
"picklist_item_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of picklist item IDs to update. Maximum 50 IDs."
},
"add_comment_to_picklist": {
"type": "operation",
"method": "POST",
"path": "/picklists/{picklist_id}/comments",
"summary": "Add a Comment to a Picklist",
"description": "Add a comment or note to an existing picklist."
},
"delete_picklist_comment": {
"type": "operation",
"method": "DELETE",
"path": "/picklists/{picklist_id}/comments/{comment_id}",
"summary": "Delete a Comment on a Picklist",
"description": "Delete a comment from an existing picklist."
},
"get_picklist_advanced_tracking_details": {
"type": "operation",
"method": "GET",
"path": "/picklists/{picklist_id}/advancedtrackingdetails",
"summary": "Get Advanced Tracking Details for a Picklist",
"description": "Retrieve the serial number and batch tracking details for a picklist."
},
"update_picklist_advanced_tracking_details": {
"type": "operation",
"method": "PUT",
"path": "/picklists/{picklist_id}/advancedtrackingdetails",
"summary": "Update Advanced Tracking Details for a Picklist",
"description": "Update serial number and batch tracking details for items in a picklist."
},
"search_so_line_items_for_picklist": {
"type": "operation",
"method": "GET",
"path": "/picklists/searchsolineitems",
"summary": "Search Sales Order Line Items",
"description": "Search for sales order line items that can be added to a picklist."
},
"customer_ids_in": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of customer IDs to filter by. Maximum 50."
},
"salesorder_ids_in": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of sales order IDs to filter by. Maximum 50."
},
"item_ids_in": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of item IDs to filter by. Maximum 50."
},
"line_item_location_id": {
"type": "parameter",
"in": "query",
"description": "Filter by the location associated with the line item."
},
"search_sales_orders_for_picklist": {
"type": "operation",
"method": "GET",
"path": "/picklists/searchso",
"summary": "Search Sales Orders",
"description": "Search for sales orders that can be used when creating a picklist."
},
"search_pr_line_items_for_picklist": {
"type": "operation",
"method": "GET",
"path": "/picklists/searchprlineitems",
"summary": "Search Purchase Return Line Items",
"description": "Search for purchase return line items that can be added to a picklist."
},
"vendor_ids_in": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of vendor IDs to filter by. Maximum 50."
},
"purchasereturn_ids_in": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of purchase return IDs to filter by. Maximum 50."
},
"picklist_id": {
"type": "schema",
"module": "picklists",
"description": "Unique ID generated by the server for the picklist."
},
"picklist-line-item": {
"type": "schema",
"module": "picklists",
"description": "A line item in a picklist representing one item to be picked.\n\nThe fields depend on `group_by`:\n\n- **`group_by=none` (flat)** - every pick-related fields below (item, quantities, tracking, storages, status, and similar) is added directly on the line item. `mapping_entity_details` is **not** used.\n- **`group_by=item` or `sales_order` (grouped)** - only the grouping fields (`line_item_id`, `assignee_id`, `assignee_name`, `parent_id`, `parent_name`, item-summary fields, and for `sales_order` also `customer_name`, `order_date`, `shipment_date`, `delivery_method`) are added on the parent. The actual per-pick fields (quantities, status, storages, tracking) are added inside `mapping_entity_details`.\n\n> Grouping is applicable only for sales-order picklists. Purchase-return picklists are always flat (`group_by=none`).\n"
},
"picklist-line-item.line_item_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the line item"
},
"picklist-line-item.parent_id": {
"type": "property",
"dataType": "string",
"description": "Grouping entity ID: the `item_id` for `group_by=item`, or the `salesorder_id` for `group_by=sales_order`. Returned only for grouped picklists."
},
"picklist-line-item.parent_name": {
"type": "property",
"dataType": "string",
"description": "Display name of the grouping entity (item name or sales order number). Returned only for grouped picklists."
},
"picklist-line-item.customer_name": {
"type": "property",
"dataType": "string",
"description": "Customer name of the grouped sales order. Returned only when `group_by=sales_order`."
},
"picklist-line-item.order_date": {
"type": "property",
"dataType": "string",
"description": "Date of the grouped sales order. Returned only when `group_by=sales_order`."
},
"picklist-line-item.shipment_date": {
"type": "property",
"dataType": "string",
"description": "Expected shipment date of the grouped sales order. Returned only when `group_by=sales_order`."
},
"picklist-line-item.delivery_method": {
"type": "property",
"dataType": "string",
"description": "Delivery method of the grouped sales order. Returned only when `group_by=sales_order`."
},
"picklist-line-item.assignee_id": {
"type": "property",
"dataType": "string",
"description": "ID of the user assigned to pick this line item. For grouped picklists this is the picker assigned to the entire group."
},
"picklist-line-item.assignee_name": {
"type": "property",
"dataType": "string",
"description": "Name of the assigned user."
},
"picklist-line-item.mapping_entity_details": {
"type": "property",
"dataType": "array",
"description": "Child pick entries grouped under this parent line item. Returned **only** for grouped picklists (`group_by=item` or `sales_order`). For `group_by=none`, this field is omitted and pick details are returned directly on the line item."
},
"picklist-line-item.salesorder_id": {
"type": "property",
"dataType": "string",
"description": "ID of the associated sales order. Returned for `group_by=none` and `group_by=sales_order`."
},
"picklist-line-item.salesorder_number": {
"type": "property",
"dataType": "string",
"description": "Number of the associated sales order. Returned only for `group_by=none`."
},
"picklist-line-item.purchasereturn_id": {
"type": "property",
"dataType": "string",
"description": "ID of the associated purchase return. Returned for purchase-return picklists."
},
"picklist-line-item.purchasereturn_number": {
"type": "property",
"dataType": "string",
"description": "Number of the associated purchase return. Returned for purchase-return picklists."
},
"picklist-line-item.so_line_item_id": {
"type": "property",
"dataType": "string",
"description": "ID of the underlying sales order line item. Returned only for `group_by=none`."
},
"picklist-line-item.pr_line_item_id": {
"type": "property",
"dataType": "string",
"description": "ID of the underlying purchase return line item. Returned for purchase-return picklists."
},
"picklist-line-item.item_id": {
"type": "property",
"dataType": "string",
"description": "ID of the item to be picked. Returned only for `group_by=none`."
},
"picklist-line-item.name": {
"type": "property",
"dataType": "string",
"description": "Name of the item. Returned only for `group_by=none`."
},
"picklist-line-item.sku": {
"type": "property",
"dataType": "string",
"description": "SKU of the item. Returned for `group_by=none` and `group_by=item`."
},
"picklist-line-item.is_storage_location_enabled": {
"type": "property",
"dataType": "boolean",
"description": "Whether storage location tracking is enabled for this item. Returned only when Zoho Inventory and storage tracking are enabled, and `group_by` is `none` or `item`."
},
"picklist-line-item.is_combo_product": {
"type": "property",
"dataType": "boolean",
"description": "Whether the item is a composite/combo product. Returned only when Zoho Inventory is enabled, and `group_by` is `none` or `item`."
},
"picklist-line-item.unit": {
"type": "property",
"dataType": "string",
"description": "Usage unit of the line item. Returned only for `group_by=none`."
},
"picklist-line-item.base_unit": {
"type": "property",
"dataType": "string",
"description": "Base unit configured on the item. Returned only for `group_by=none`."
},
"picklist-line-item.base_unit_id": {
"type": "property",
"dataType": "string",
"description": "ID of the base unit. Returned only when unit conversion is enabled and `group_by=none`."
},
"picklist-line-item.unit_conversion_id": {
"type": "property",
"dataType": "string",
"description": "ID of the unit conversion applied. Returned only when unit conversion is enabled and `group_by=none`."
},
"picklist-line-item.conversion_rate": {
"type": "property",
"dataType": "number",
"description": "Unit conversion rate. Returned only when unit conversion is enabled and `group_by=none`."
},
"picklist-line-item.quantity_decimal_place": {
"type": "property",
"dataType": "integer",
"description": "Number of decimal places used for quantity values on this line item. Returned only for `group_by=none`."
},
"picklist-line-item.description": {
"type": "property",
"dataType": "string",
"description": "Description of the line item. Returned only for `group_by=none`."
},
"picklist-line-item.image_name": {
"type": "property",
"dataType": "string",
"description": "File name of the item image. Returned only for `group_by=none`."
},
"picklist-line-item.image_type": {
"type": "property",
"dataType": "string",
"description": "File type of the item image. Returned only for `group_by=none`."
},
"picklist-line-item.image_document_id": {
"type": "property",
"dataType": "string",
"description": "Document ID of the item image. Returned only for `group_by=none`."
},
"picklist-line-item.quantity_ordered": {
"type": "property",
"dataType": "number",
"description": "Quantity ordered on the underlying sales order line item, normalized to the picking unit. Returned only for `group_by=none`."
},
"picklist-line-item.quantity_returned": {
"type": "property",
"dataType": "number",
"description": "Quantity on the underlying purchase return line item. Returned for purchase-return picklists."
},
"picklist-line-item.so_quantity_ordered": {
"type": "property",
"dataType": "number",
"description": "Total quantity ordered on the underlying sales order line item (in the SO unit). Returned only for `group_by=none`."
},
"picklist-line-item.pr_quantity_returned": {
"type": "property",
"dataType": "number",
"description": "Total quantity on the underlying purchase return line item. Returned for purchase-return picklists."
},
"picklist-line-item.so_quantity_picked": {
"type": "property",
"dataType": "number",
"description": "Quantity already picked across all picklists for the underlying sales order line item. Returned only for `group_by=none`."
},
"picklist-line-item.pr_quantity_picked": {
"type": "property",
"dataType": "number",
"description": "Quantity already picked across all picklists for the underlying purchase return line item. Returned for purchase-return picklists."
},
"picklist-line-item.quantity_to_be_picked": {
"type": "property",
"dataType": "number",
"description": "Quantity of the item to be picked. Returned only for `group_by=none`."
},
"picklist-line-item.quantity_picked": {
"type": "property",
"dataType": "number",
"description": "Quantity already picked. Returned only for `group_by=none`."
},
"picklist-line-item.quantity_picked_remaining": {
"type": "property",
"dataType": "number",
"description": "Remaining quantity yet to be picked. Returned only for `group_by=none`."
},
"picklist-line-item.quantity_packed": {
"type": "property",
"dataType": "number",
"description": "Quantity that has been packed. Returned only for `group_by=none`."
},
"picklist-line-item.quantity_manually_fulfilled": {
"type": "property",
"dataType": "number",
"description": "Quantity that was manually fulfilled. Returned only for `group_by=none`."
},
"picklist-line-item.rate": {
"type": "property",
"dataType": "number",
"description": "Unit price/rate of the underlying line item. Returned only for `group_by=none`."
},
"picklist-line-item.status": {
"type": "property",
"dataType": "string",
"description": "Status of the line item. Returned only for `group_by=none` (for grouped picklists, status lives on each child entry inside `mapping_entity_details`)."
},
"picklist-line-item.preferred_storage_id": {
"type": "property",
"dataType": "string",
"description": "ID of the preferred storage location for this item. Returned when storage tracking is enabled and `group_by` is `none` or `item`."
},
"picklist-line-item.preferred_storage_name": {
"type": "property",
"dataType": "string",
"description": "Name of the preferred storage location. Returned when storage tracking is enabled and `group_by` is `none` or `item`."
},
"picklist-line-item.storages": {
"type": "property",
"dataType": "array",
"description": "Storage location breakdown used for picking. Returned only when storage tracking is enabled and `group_by=none`."
},
"picklist-line-item.serial_numbers": {
"type": "property",
"dataType": "array",
"description": "Serial numbers picked. Returned only when serial-number tracking is enabled and `group_by=none`."
},
"picklist-line-item.batches": {
"type": "property",
"dataType": "array",
"description": "Batch details picked. Returned only when batch tracking is enabled and `group_by=none`."
},
"picklist-line-item.track_serial_number": {
"type": "property",
"dataType": "boolean",
"description": "Whether serial-number tracking is enabled for this item. Returned only when serial-number tracking is enabled and `group_by=none`."
},
"picklist-line-item.track_batch_number": {
"type": "property",
"dataType": "boolean",
"description": "Whether batch tracking is enabled for this item. Returned only when batch tracking is enabled and `group_by=none`."
},
"picklist-line-item.track_serial_for_package": {
"type": "property",
"dataType": "boolean",
"description": "Whether serial numbers are required at the package level for this line item. Returned only for `group_by=none`."
},
"picklist-line-item.track_batch_for_package": {
"type": "property",
"dataType": "boolean",
"description": "Whether batch numbers are required at the package level for this line item. Returned only for `group_by=none`."
},
"picklist-line-item.item_custom_fields": {
"type": "property",
"dataType": "array",
"description": "Custom field values for the picked item. Returned only for `group_by=none`."
},
"picklist-line-item.available_stock_for_picking": {
"type": "property",
"dataType": "number",
"description": "Stock currently available for picking. Returned only when `showAvailableStockForPicking` is enabled and `group_by` is `none` or `item`."
},
"picklist-line-item.advanced_tracking_missing_quantity": {
"type": "property",
"dataType": "number",
"description": "Quantity for which advanced tracking (serial / batch) details are missing. Returned only on create when tracking relaxation is enabled and `group_by=none`."
},
"picklist-line-item.upc": {
"type": "property",
"dataType": "string",
"description": "Universal Product Code of the item. Returned only when Zoho Inventory is enabled, the request is from a Zoho Books client, and `group_by=none`."
},
"picklist-line-item.ean": {
"type": "property",
"dataType": "string",
"description": "European Article Number of the item. Same return conditions as `upc`."
},
"picklist-line-item.isbn": {
"type": "property",
"dataType": "string",
"description": "International Standard Book Number of the item. Same return conditions as `upc`."
},
"picklist-line-item-mapping": {
"type": "schema",
"module": "picklists",
"description": "A child pick entry under a grouped picklist line item. Returned only for grouped picklists (`group_by=item` or `sales_order`). Each entry describes one underlying sales order line item being picked under the parent group, and carries the per-pick details (quantities, status, storages, tracking) that, in flat picklists, would live on the line item itself."
},
"picklist-line-item-mapping.mapping_line_item_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of this child mapping line item."
},
"picklist-line-item-mapping.mapping_entity_id": {
"type": "property",
"dataType": "string",
"description": "ID of the underlying child entity (sales order or item) this child entry belongs to."
},
"picklist-line-item-mapping.mapping_entity_name": {
"type": "property",
"dataType": "string",
"description": "Number / name of the underlying child entity (sales order number or item name)."
},
"picklist-line-item-mapping.mapping_entity_item_id": {
"type": "property",
"dataType": "string",
"description": "ID of the underlying sales order or purchase return line item being picked under this group."
},
"picklist-line-item-mapping.so_quantity_ordered": {
"type": "property",
"dataType": "number",
"description": "Total quantity ordered on the underlying sales order line item. Returned when the underlying entity is a sales order."
},
"picklist-line-item-mapping.quantity_ordered": {
"type": "property",
"dataType": "number",
"description": "Quantity ordered, normalized to the picking unit."
},
"picklist-line-item-mapping.so_quantity_picked": {
"type": "property",
"dataType": "number",
"description": "Quantity already picked across all picklists for the underlying sales order line item. Returned when the underlying entity is a sales order."
},
"picklist-line-item-mapping.item_id": {
"type": "property",
"dataType": "string",
"description": "ID of the item being picked. Returned when the parent group is grouped by sales order."
},
"picklist-line-item-mapping.name": {
"type": "property",
"dataType": "string",
"description": "Name of the item being picked."
},
"picklist-line-item-mapping.sku": {
"type": "property",
"dataType": "string",
"description": "SKU of the item being picked."
},
"picklist-line-item-mapping.is_storage_location_enabled": {
"type": "property",
"dataType": "boolean",
"description": "Whether storage location tracking is enabled for this item. Returned only when Zoho Inventory and storage tracking are enabled."
},
"picklist-line-item-mapping.is_combo_product": {
"type": "property",
"dataType": "boolean",
"description": "Whether the item is a composite/combo product. Returned only when Zoho Inventory is enabled."
},
"picklist-line-item-mapping.unit": {
"type": "property",
"dataType": "string",
"description": "Usage unit of the line item."
},
"picklist-line-item-mapping.base_unit": {
"type": "property",
"dataType": "string",
"description": "Base unit configured on the item."
},
"picklist-line-item-mapping.base_unit_id": {
"type": "property",
"dataType": "string",
"description": "ID of the base unit. Returned only when unit conversion is enabled."
},
"picklist-line-item-mapping.unit_conversion_id": {
"type": "property",
"dataType": "string",
"description": "ID of the unit conversion applied. Returned only when unit conversion is enabled."
},
"picklist-line-item-mapping.conversion_rate": {
"type": "property",
"dataType": "number",
"description": "Unit conversion rate. Returned only when unit conversion is enabled."
},
"picklist-line-item-mapping.quantity_decimal_place": {
"type": "property",
"dataType": "integer",
"description": "Number of decimal places used for quantity values on this line item."
},
"picklist-line-item-mapping.description": {
"type": "property",
"dataType": "string",
"description": "Description of the underlying line item."
},
"picklist-line-item-mapping.image_name": {
"type": "property",
"dataType": "string",
"description": "File name of the item image."
},
"picklist-line-item-mapping.image_type": {
"type": "property",
"dataType": "string",
"description": "File type of the item image."
},
"picklist-line-item-mapping.image_document_id": {
"type": "property",
"dataType": "string",
"description": "Document ID of the item image."
},
"picklist-line-item-mapping.quantity_to_be_picked": {
"type": "property",
"dataType": "number",
"description": "Quantity to be picked for this child entry."
},
"picklist-line-item-mapping.quantity_picked": {
"type": "property",
"dataType": "number",
"description": "Quantity already picked for this child entry."
},
"picklist-line-item-mapping.quantity_picked_remaining": {
"type": "property",
"dataType": "number",
"description": "Remaining quantity yet to be picked for this child entry."
},
"picklist-line-item-mapping.quantity_packed": {
"type": "property",
"dataType": "number",
"description": "Quantity already packed for this child entry."
},
"picklist-line-item-mapping.quantity_manually_fulfilled": {
"type": "property",
"dataType": "number",
"description": "Quantity that was manually fulfilled for this child entry."
},
"picklist-line-item-mapping.rate": {
"type": "property",
"dataType": "number",
"description": "Unit price/rate of the underlying line item."
},
"picklist-line-item-mapping.status": {
"type": "property",
"dataType": "string",
"description": "Status of this child mapping entry."
},
"picklist-line-item-mapping.preferred_storage_id": {
"type": "property",
"dataType": "string",
"description": "ID of the preferred storage location for this child entry."
},
"picklist-line-item-mapping.preferred_storage_name": {
"type": "property",
"dataType": "string",
"description": "Name of the preferred storage location."
},
"picklist-line-item-mapping.storages": {
"type": "property",
"dataType": "array",
"description": "Storage location breakdown used for picking this child entry."
},
"picklist-line-item-mapping.serial_numbers": {
"type": "property",
"dataType": "array",
"description": "Serial numbers picked for this child entry."
},
"picklist-line-item-mapping.batches": {
"type": "property",
"dataType": "array",
"description": "Batch details picked for this child entry."
},
"picklist-line-item-mapping.item_custom_fields": {
"type": "property",
"dataType": "array",
"description": "Custom field values for the picked item in this child entry."
},
"picklist-line-item-mapping.track_serial_number": {
"type": "property",
"dataType": "boolean",
"description": "Whether serial-number tracking is enabled for this item. Returned only when serial-number tracking is enabled in the org."
},
"picklist-line-item-mapping.track_batch_number": {
"type": "property",
"dataType": "boolean",
"description": "Whether batch tracking is enabled for this item. Returned only when batch tracking is enabled in the org."
},
"picklist-line-item-mapping.track_serial_for_package": {
"type": "property",
"dataType": "boolean",
"description": "Whether serial numbers are required at the package level for this line item."
},
"picklist-line-item-mapping.track_batch_for_package": {
"type": "property",
"dataType": "boolean",
"description": "Whether batch numbers are required at the package level for this line item."
},
"picklist-line-item-mapping.available_stock_for_picking": {
"type": "property",
"dataType": "number",
"description": "Stock currently available for picking. Returned only when `showAvailableStockForPicking` is enabled."
},
"picklist-line-item-mapping.advanced_tracking_missing_quantity": {
"type": "property",
"dataType": "number",
"description": "Quantity for which advanced tracking (serial / batch) details are missing. Returned only on create when tracking relaxation is enabled in the org."
},
"picklist-line-item-mapping.upc": {
"type": "property",
"dataType": "string",
"description": "Universal Product Code of the item. Returned only when Zoho Inventory is enabled and the request is from a Zoho Books client."
},
"picklist-line-item-mapping.ean": {
"type": "property",
"dataType": "string",
"description": "European Article Number of the item. Returned only when Zoho Inventory is enabled and the request is from a Zoho Books client."
},
"picklist-line-item-mapping.isbn": {
"type": "property",
"dataType": "string",
"description": "International Standard Book Number of the item. Returned only when Zoho Inventory is enabled and the request is from a Zoho Books client."
},
"picklist-line-item-mapping-request": {
"type": "schema",
"module": "picklists",
"description": "A child pick entry under a grouped picklist line item. Used only when `group_by` is `item` or `sales_order`. Provide one entry inside `mapping_entity_details` for every underlying sales order line item to be picked under the parent group."
},
"picklist-line-item-mapping-request.mapping_line_item_id": {
"type": "property",
"dataType": "string",
"description": "ID of an existing child entry. Pass on update to identify the row being modified; omit when adding a new one."
},
"picklist-line-item-mapping-request.mapping_entity_item_id": {
"type": "property",
"dataType": "string",
"description": "ID of the underlying sales order line item to be picked. Required when adding a new child entry."
},
"picklist-line-item-mapping-request.quantity_to_be_picked": {
"type": "property",
"dataType": "number",
"description": "Quantity to be picked for this child entry."
},
"picklist-line-item-mapping-request.quantity_picked": {
"type": "property",
"dataType": "number",
"description": "Quantity already picked for this child entry."
},
"picklist-line-item-mapping-request.status": {
"type": "property",
"dataType": "string",
"description": "Status of this child mapping entry."
},
"picklist-line-item-mapping-request.preferred_storage_id": {
"type": "property",
"dataType": "string",
"description": "ID of the preferred storage location for this child entry."
},
"picklist-line-item-mapping-request.storages": {
"type": "property",
"dataType": "array",
"description": "Storage location assignments for this child entry. Maximum 100."
},
"picklist-line-item-mapping-request.serial_numbers": {
"type": "property",
"dataType": "array",
"description": "Serial numbers picked for this child entry. Maximum 10000."
},
"picklist-line-item-mapping-request.batches": {
"type": "property",
"dataType": "array",
"description": "Batch details picked for this child entry. Maximum 100."
},
"picklist-line-item-mapping-request.item_custom_fields": {
"type": "property",
"dataType": "array",
"description": "Custom field values for the picked item in this child entry. Maximum 1000."
},
"picklist-line-item-request": {
"type": "schema",
"module": "picklists",
"description": "A line item in a picklist create/update request. Two mutually-exclusive shapes, controlled by `group_by`:\n\n- **Flat (`group_by=none`)** - populate pick fields (`quantity_to_be_picked`, `storages`, `serial_numbers`, `batches`, `status`, `preferred_storage_id`, `item_custom_fields`, the `*_line_item_id` references) directly on this object. Do **not** send `mapping_entity_details`.\n- **Grouped (`group_by=item` or `sales_order`)** - only `line_item_id` (on update), `assignee_id` and `mapping_entity_details` are valid here. All actual pick details belong to each child entry inside `mapping_entity_details`.\n"
},
"picklist-line-item-request.line_item_id": {
"type": "property",
"dataType": "string",
"description": "ID of an existing picklist line item. Pass on update to identify the row being modified; omit on create."
},
"picklist-line-item-request.salesorder_id": {
"type": "property",
"dataType": "string",
"description": "ID of the associated sales order. Flat mode or group by sales order."
},
"picklist-line-item-request.parent_entity_id": {
"type": "property",
"dataType": "string",
"description": "ID of the parent entity (sales order or purchase return). Flat mode only."
},
"picklist-line-item-request.so_line_item_id": {
"type": "property",
"dataType": "string",
"description": "ID of the underlying sales order line item. Flat mode only."
},
"picklist-line-item-request.pr_line_item_id": {
"type": "property",
"dataType": "string",
"description": "ID of the underlying purchase return line item. Flat mode only."
},
"picklist-line-item-request.parent_line_item_id": {
"type": "property",
"dataType": "string",
"description": "ID of the parent line item on the source entity. Flat mode only."
},
"picklist-line-item-request.quantity_to_be_picked": {
"type": "property",
"dataType": "number",
"description": "Quantity of the item to be picked. Flat mode only."
},
"picklist-line-item-request.quantity_picked": {
"type": "property",
"dataType": "number",
"description": "Quantity already picked. Flat mode only."
},
"picklist-line-item-request.status": {
"type": "property",
"dataType": "string",
"description": "Status of the line item. Flat mode only."
},
"picklist-line-item-request.preferred_storage_id": {
"type": "property",
"dataType": "string",
"description": "ID of the preferred storage location for this item. Flat mode or group by item."
},
"picklist-line-item-request.storages": {
"type": "property",
"dataType": "array",
"description": "Storage location assignments. Flat mode only. Maximum 100."
},
"picklist-line-item-request.serial_numbers": {
"type": "property",
"dataType": "array",
"description": "Serial numbers assigned to this line item. Flat mode only. Maximum 10000."
},
"picklist-line-item-request.batches": {
"type": "property",
"dataType": "array",
"description": "Batch details for this line item. Flat mode only. Maximum 100."
},
"picklist-line-item-request.item_custom_fields": {
"type": "property",
"dataType": "array",
"description": "Custom field values for the item. Flat mode only. Maximum 1000."
},
"picklist-line-item-request.assignee_id": {
"type": "property",
"dataType": "string",
"description": "ID of the user assigned to this line item. For grouped picklists, assigns the picker to the entire group. This is not used for non-grouped picklists."
},
"picklist-line-item-request.mapping_entity_details": {
"type": "property",
"dataType": "array",
"description": "Child pick entries grouped under this parent line item. **Required for grouped picklists** (`group_by=item` or `sales_order`) and must contain at least one entry. Must be omitted for `group_by=none`. Maximum 1000 entries."
},
"create-a-picklist-request": {
"type": "schema",
"module": "picklists",
"description": "Request body for creating a picklist."
},
"create-a-picklist-request.picklist_number": {
"type": "property",
"dataType": "string",
"description": "Custom picklist number. Used when `ignore_auto_number_generation` is true."
},
"create-a-picklist-request.date": {
"type": "property",
"dataType": "string",
"description": "Date of the picklist (yyyy-mm-dd)."
},
"create-a-picklist-request.location_id": {
"type": "property",
"dataType": "string",
"description": "ID of the location."
},
"create-a-picklist-request.parent_entity": {
"type": "property",
"dataType": "string",
"description": "Type of the parent entity associated with the picklist."
},
"create-a-picklist-request.group_by": {
"type": "property",
"dataType": "string",
"description": "Grouping strategy for picklist items. Controls the shape of `line_items`.
\n\nnone - flat picklist; each entry is a single pick row with all pick fields supplied directly on the line item.
\nitem - grouped by item; each entry represents one product, with the actual picks supplied as child entries inside `mapping_entity_details`.
\nsales_order - grouped by sales order; each entry represents one sales order, with picks supplied inside `mapping_entity_details`.
\n\nGrouping (`item` / `sales_order`) is supported only when `parent_entity` is `salesorder`. Picklists for `parent_entity=purchase_return` must use `group_by=none`.
\nCannot be changed after creation.\n"
},
"create-a-picklist-request.assignee_id": {
"type": "property",
"dataType": "string",
"description": "ID of the user to assign the picklist to."
},
"create-a-picklist-request.notes": {
"type": "property",
"dataType": "string",
"description": "Internal notes for the picklist."
},
"create-a-picklist-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Picklist line items. Shape depends on `group_by`. Min 1, Max 1000."
},
"create-a-picklist-request.custom_fields": {
"type": "property",
"dataType": "array",
"description": "Custom field values for the picklist."
},
"update-a-picklist-request": {
"type": "schema",
"module": "picklists",
"description": "Request body for updating a picklist."
},
"update-a-picklist-request.picklist_number": {
"type": "property",
"dataType": "string",
"description": "Custom picklist number. Used when `ignore_auto_number_generation` is true."
},
"update-a-picklist-request.date": {
"type": "property",
"dataType": "string",
"description": "Date of the picklist (yyyy-mm-dd)."
},
"update-a-picklist-request.location_id": {
"type": "property",
"dataType": "string",
"description": "ID of the location."
},
"update-a-picklist-request.parent_entity": {
"type": "property",
"dataType": "string",
"description": "Type of the parent entity associated with the picklist."
},
"update-a-picklist-request.group_by": {
"type": "property",
"dataType": "string",
"description": "Same semantics as on create; see `create-a-picklist-request.group_by`. Cannot be changed after creation; resend the original value."
},
"update-a-picklist-request.assignee_id": {
"type": "property",
"dataType": "string",
"description": "ID of the user to assign the picklist to."
},
"update-a-picklist-request.notes": {
"type": "property",
"dataType": "string",
"description": "Internal notes for the picklist."
},
"update-a-picklist-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Updated list of picklist line items. Shape depends on `group_by`. On update, pass `line_item_id` / `mapping_line_item_id` to update existing rows; omit them to add new rows. Rows not included are removed. Min 1, Max 1000."
},
"update-a-picklist-request.custom_fields": {
"type": "property",
"dataType": "array",
"description": "Custom field values for the picklist."
},
"picklist-object": {
"type": "schema",
"module": "picklists",
"description": "A picklist record."
},
"picklist-object.picklist_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"picklist-object.picklist_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"picklist-object.date": {
"type": "property",
"dataType": "string",
"description": "Date of the picklist."
},
"picklist-object.notes": {
"type": "property",
"dataType": "string",
"description": "Internal notes for the picklist."
},
"picklist-object.assignee_id": {
"type": "property",
"dataType": "string",
"description": "ID of the user assigned to the picklist."
},
"picklist-object.assignee_name": {
"type": "property",
"dataType": "string",
"description": "Name of the user assigned to the picklist."
},
"picklist-object.location_id": {
"type": "property",
"dataType": "string",
"description": "ID of the location."
},
"picklist-object.location_name": {
"type": "property",
"dataType": "string",
"description": "Name of the location."
},
"picklist-object.status": {
"type": "property",
"dataType": "string",
"description": "Current status of the picklist."
},
"picklist-object.created_time": {
"type": "property",
"dataType": "string",
"description": "Timestamp when the picklist was created."
},
"picklist-object.last_modified_time": {
"type": "property",
"dataType": "string",
"description": "Timestamp when the picklist was last modified."
},
"picklist-object.salesorder_numbers": {
"type": "property",
"dataType": "array",
"description": "List of sales order numbers associated with this picklist."
},
"picklist-object.purchase_return_numbers": {
"type": "property",
"dataType": "array",
"description": "List of purchase return numbers associated with this picklist."
},
"picklist-object.customer_names": {
"type": "property",
"dataType": "array",
"description": "List of customer names associated with this picklist."
},
"picklist-detail-object": {
"type": "schema",
"module": "picklists",
"description": "Detailed picklist record including line items and comments."
},
"list-picklists-response": {
"type": "schema",
"module": "picklists",
"description": "Response for listing picklists."
},
"list-picklists-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-picklists-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-picklists-response.picklists": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-picklists-response.page_context": {
"type": "property",
"dataType": "object",
"description": ""
},
"picklist-response": {
"type": "schema",
"module": "picklists",
"description": "Response containing a single picklist record."
},
"picklist-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"picklist-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"picklist-response.picklist": {
"type": "property",
"dataType": "string",
"description": ""
},
"message-response": {
"type": "schema",
"module": "picklists",
"description": "Generic success response with a message."
},
"message-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"message-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-comment-request": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"add-comment-request.description": {
"type": "property",
"dataType": "string",
"description": "The description of the comment. Max-length [2000]"
},
"comment-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"comment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"comment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"comment-response.comment": {
"type": "property",
"dataType": "object",
"description": ""
},
"advanced-tracking-response": {
"type": "schema",
"module": "picklists",
"description": "Response containing advanced tracking details for a picklist."
},
"advanced-tracking-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"advanced-tracking-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"advanced-tracking-response.transaction": {
"type": "property",
"dataType": "object",
"description": ""
},
"update-advanced-tracking-request": {
"type": "schema",
"module": "picklists",
"description": "Request body for updating advanced tracking details of a picklist."
},
"update-advanced-tracking-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Line items with updated tracking information."
},
"search-so-line-items-response": {
"type": "schema",
"module": "picklists",
"description": "Response containing sales order line items available for picklist creation."
},
"search-so-line-items-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"search-so-line-items-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"search-so-line-items-response.so_line_items": {
"type": "property",
"dataType": "array",
"description": ""
},
"search-sales-orders-response": {
"type": "schema",
"module": "picklists",
"description": "Response containing sales orders available for picklist creation."
},
"search-sales-orders-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"search-sales-orders-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"search-sales-orders-response.salesorders": {
"type": "property",
"dataType": "array",
"description": ""
},
"search-pr-line-items-response": {
"type": "schema",
"module": "picklists",
"description": "Response containing purchase return line items available for picklist creation."
},
"search-pr-line-items-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"search-pr-line-items-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"search-pr-line-items-response.pr_line_items": {
"type": "property",
"dataType": "array",
"description": ""
},
"pricelists": {
"type": "tag",
"description": "PriceLists Module"
},
"create_pricebook": {
"type": "operation",
"method": "POST",
"path": "/pricebooks",
"summary": "Create a pricebook",
"description": "create a new pricebook."
},
"list_pricebooks": {
"type": "operation",
"method": "GET",
"path": "/pricebooks",
"summary": "List all pricebooks",
"description": "List all the available pricebooks in your zoho inventory."
},
"update_pricebook": {
"type": "operation",
"method": "PUT",
"path": "/pricebooks/{pricebook_id}",
"summary": "Update pricebook",
"description": "update existing pricebook."
},
"delete_pricebook": {
"type": "operation",
"method": "DELETE",
"path": "/pricebooks/{pricebook_id}",
"summary": "Delete the pricebook",
"description": "Delete the pricebook."
},
"mark_pricebook_active": {
"type": "operation",
"method": "POST",
"path": "/pricebooks/{pricebook_id}/active",
"summary": "Mark as Active",
"description": "Mark the pricebook as Active."
},
"mark_pricebook_inactive": {
"type": "operation",
"method": "POST",
"path": "/pricebooks/{pricebook_id}/inactive",
"summary": "Mark as Inactive",
"description": "Mark the pricebook as Inactive."
},
"pricebook_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the pricebook"
},
"decimal_place": {
"type": "schema",
"module": "pricelists",
"description": "Decimal place for pricebook."
},
"is_default": {
"type": "schema",
"module": "pricelists",
"description": "To check the default pricebook.Allowed values: true,false"
},
"is_increase": {
"type": "schema",
"module": "pricelists",
"description": "Mark up or Mark down to discounts.Allowed values: true,false"
},
"percentage": {
"type": "schema",
"module": "pricelists",
"description": "About percentage of discounts"
},
"pricebook_type": {
"type": "schema",
"module": "pricelists",
"description": "Type of the pricebook.Allowed values: per_item,fixed_percentage"
},
"pricing_scheme": {
"type": "schema",
"module": "pricelists",
"description": "Applicable only when the price book type is per_item. Allowed values: unit, volume. unit: Uses pricebook_rate. volume: Uses price_brackets. Not applicable for fixed_percentage."
},
"rounding_type": {
"type": "schema",
"module": "pricelists",
"description": "Type of the rounding.Allowed values: no_rounding,round_to_dollor,round_to_dollar_minus_01,round_to_half_dollar,round_to_half_dollar_minus_01"
},
"sales_or_purchase_type": {
"type": "schema",
"module": "pricelists",
"description": "Whether its sales or purchase type.Allowed values: sales,purchases"
},
"pricebook_item_id": {
"type": "schema",
"module": "pricelists",
"description": "Unique ID generated by the server for each pricebook line item"
},
"pricebook_discount": {
"type": "schema",
"module": "pricelists",
"description": "Discount percentage for the line item or volume bracket. The value must include a percent sign. Examples: 5%, 10.5%, 0%."
},
"start_quantity": {
"type": "schema",
"module": "pricelists",
"description": "Lower bound of the quantity range for a volume bracket."
},
"end_quantity": {
"type": "schema",
"module": "pricelists",
"description": "Upper bound of the quantity range for a volume bracket."
},
"price_bracket": {
"type": "schema",
"module": "pricelists",
"description": "Represents a single tier in price_brackets for volume pricing. Includes: start_quantity, end_quantity, pricebook_rate, and optional pricebook_discount."
},
"price_bracket.pricebook_item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"price_bracket.start_quantity": {
"type": "property",
"dataType": "string",
"description": ""
},
"price_bracket.end_quantity": {
"type": "property",
"dataType": "string",
"description": ""
},
"price_bracket.pricebook_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"price_bracket.pricebook_discount": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook_items": {
"type": "schema",
"module": "pricelists",
"description": "Items included in the price book. Applicable when the price book type is set to per_item."
},
"pricebook": {
"type": "schema",
"module": "pricelists",
"description": "List all the pricebook details"
},
"pricebook.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.decimal_place": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.is_default": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.is_increase": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.pricebook_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.pricebook_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.pricebook_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.pricebook_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.pricing_scheme": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.rounding_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.sales_or_purchase_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"pricebook.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-pricebook-request": {
"type": "schema",
"module": "pricelists",
"description": ""
},
"create-a-pricebook-request.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-pricebook-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-pricebook-request.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-pricebook-request.pricebook_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-pricebook-request.percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-pricebook-request.pricebook_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-pricebook-request.pricing_scheme": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-pricebook-request.is_increase": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-pricebook-request.rounding_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-pricebook-request.decimal_place": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-pricebook-request.pricebook_items": {
"type": "property",
"dataType": "array",
"description": "Items included in the price book. Applicable when the price book type is set to per_item."
},
"create-a-pricebook-request.sales_or_purchase_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-pricebook-response": {
"type": "schema",
"module": "pricelists",
"description": ""
},
"create-a-pricebook-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-pricebook-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-pricebook-response.pricebook": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-pricebooks-response": {
"type": "schema",
"module": "pricelists",
"description": ""
},
"list-all-pricebooks-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-pricebooks-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-pricebooks-response.pricebooks": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-pricebook-request": {
"type": "schema",
"module": "pricelists",
"description": ""
},
"update-pricebook-request.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-pricebook-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-pricebook-request.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-pricebook-request.pricebook_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-pricebook-request.percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-pricebook-request.pricebook_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-pricebook-request.pricing_scheme": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-pricebook-request.is_increase": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-pricebook-request.rounding_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-pricebook-request.decimal_place": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-pricebook-request.pricebook_items": {
"type": "property",
"dataType": "array",
"description": "Items included in the price book. Applicable when the price book type is set to per_item."
},
"update-pricebook-request.sales_or_purchase_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-pricebook-response": {
"type": "schema",
"module": "pricelists",
"description": ""
},
"update-pricebook-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-pricebook-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-pricebook-response.pricebook": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-the-pricebook-response": {
"type": "schema",
"module": "pricelists",
"description": ""
},
"delete-the-pricebook-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-the-pricebook-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchaseorders": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"create_purchase_order": {
"type": "operation",
"method": "POST",
"path": "/purchaseorders",
"summary": "Create a Purchase Order",
"description": "Creates a new Purchase Order in Zoho Inventory. Description about extra parameter ignore_auto_number_generation - Ignore auto purchase order number generation for this Purchase order. This mandates the Purchase Order number to be entered. Allowed Values true and false."
},
"list_purchase_orders": {
"type": "operation",
"method": "GET",
"path": "/purchaseorders",
"summary": "List all Purchase Orders",
"description": "Lists all the Purchase Orders present in Zoho Inventory."
},
"get_purchase_order": {
"type": "operation",
"method": "GET",
"path": "/purchaseorders/{purchaseorder_id}",
"summary": "Retrieve a Purchase Order",
"description": "Retrieves the details for an existing Purchase Order."
},
"update_purchase_order": {
"type": "operation",
"method": "PUT",
"path": "/purchaseorders/{purchaseorder_id}",
"summary": "Update a Purchase Order",
"description": "Updates a new Purchase Order in Zoho Inventory. Description about extra parameter ignore_auto_number_generation - Ignore auto Purchase order number generation for this Purchase Order. This mandates the Purchase Order number to be entered. Allowed Values true and false."
},
"delete_purchase_order": {
"type": "operation",
"method": "DELETE",
"path": "/purchaseorders/{purchaseorder_id}",
"summary": "Delete a Purchase Order",
"description": "Deletes a Purchase Order from Zoho Inventory."
},
"mark_purchase_order_as_issued": {
"type": "operation",
"method": "POST",
"path": "/purchaseorders/{purchaseorder_id}/status/issued",
"summary": "Mark as Issued",
"description": "Marks a Purchase Order as Issued."
},
"mark_purchase_order_as_cancelled": {
"type": "operation",
"method": "POST",
"path": "/purchaseorders/{purchaseorder_id}/status/cancelled",
"summary": "Mark as Cancelled",
"description": "Marks a Purchase Order as Cancelled."
},
"submit_purchaseorder": {
"type": "operation",
"method": "POST",
"path": "/purchaseorders/{purchaseorder_id}/submit",
"summary": "Submit a purchase order for approval",
"description": "Submit a purchase order for approval workflow."
},
"approve_purchaseorder": {
"type": "operation",
"method": "POST",
"path": "/purchaseorders/{purchaseorder_id}/approve",
"summary": "Approve a purchase order",
"description": "Approve a submitted purchase order."
},
"reject_purchaseorder": {
"type": "operation",
"method": "POST",
"path": "/purchaseorders/{purchaseorder_id}/reject",
"summary": "Reject a purchase order",
"description": "Reject a submitted purchase order."
},
"final_approve_purchaseorder": {
"type": "operation",
"method": "POST",
"path": "/purchaseorders/{purchaseorder_id}/approve/final",
"summary": "Final-approve a purchase order",
"description": "Mark a submitted purchase order as final approved, bypassing the remaining approval sequence."
},
"bulk_submit_purchaseorders": {
"type": "operation",
"method": "POST",
"path": "/purchaseorders/submit",
"summary": "Bulk submit purchase orders for approval",
"description": "Submit multiple purchase orders for approval workflow at once."
},
"purchaseorder_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of purchase order IDs to approve."
},
"bulk_approve_purchaseorders": {
"type": "operation",
"method": "POST",
"path": "/purchaseorders/approve",
"summary": "Bulk approve purchase orders",
"description": "Approve multiple submitted purchase orders at once."
},
"purchase_order-response": {
"type": "schema",
"module": "purchaseorders",
"description": ""
},
"purchase_order-response.purchaseorder_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.documents": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.purchaseorder_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.expected_delivery_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.date_formatted": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.expected_delivery_date_formatted": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.delivery_date_formatted": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.status_formatted": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.billed_status": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.is_emailed": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.is_backorder": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.vendor_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.comments": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.currency_symbol": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.delivery_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.salesorder_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.is_drop_shipment": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.line_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.sub_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.sub_total_formatted": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.tax_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.total": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.taxes": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.price_precision": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.pricebook_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.billing_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.ship_via": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.ship_via_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.attention": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.delivery_org_address_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.delivery_customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.delivery_customer_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.delivery_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.attachment_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.can_send_in_mail": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.template_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.template_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.purchasereceives": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.bills": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.source_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.destination_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.is_pre_gst": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_order-response.is_reverse_charge_applied": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchaseorder_number": {
"type": "schema",
"module": "purchasereceives",
"description": "Purchase Order number."
},
"expected_delivery_date": {
"type": "schema",
"module": "purchaseorders",
"description": "Expected date of delivery for the items ordered."
},
"delivery_date": {
"type": "schema",
"module": "purchaseorders",
"description": "Date of delivery of the product."
},
"is_drop_shipment": {
"type": "schema",
"module": "salesorders",
"description": "Denotes if a SalesOrder is a drop shipment"
},
"quantity_received": {
"type": "schema",
"module": "purchaseorders",
"description": "Quantity invoiced of the line item."
},
"sub_total_formatted": {
"type": "schema",
"module": "purchaseorders",
"description": "Format of the sub total."
},
"tax_total_formatted": {
"type": "schema",
"module": "purchaseorders",
"description": "Format of the sub total."
},
"ship_via": {
"type": "schema",
"module": "purchaseorders",
"description": "Shipping method for the Purchase Order."
},
"ship_via_id": {
"type": "schema",
"module": "purchaseorders",
"description": "Unique ID generated by the server. This is used as identifier."
},
"delivery_org_address_id": {
"type": "schema",
"module": "purchaseorders",
"description": "Unique ID generated by the server. This is used as identifier."
},
"delivery_customer_id": {
"type": "schema",
"module": "purchaseorders",
"description": "Customer ID for delivery address"
},
"delivery_customer_name": {
"type": "schema",
"module": "purchaseorders",
"description": "Customer's name at the delivery address."
},
"delivery_address": {
"type": "schema",
"module": "purchaseorders",
"description": "Customer's delivery address. It contains - address, city, state, zip, country and fax."
},
"file_type": {
"type": "schema",
"module": "tasks",
"description": "Type of the file attached to the task."
},
"file_size_formatted": {
"type": "schema",
"module": "tasks",
"description": "Formatted size of the file attached to the task."
},
"attachment_order": {
"type": "schema",
"module": "tasks",
"description": "Order of the attachment in the task."
},
"file_size": {
"type": "schema",
"module": "tasks",
"description": "Size of the file attached to the task in bytes."
},
"is_backorder": {
"type": "schema",
"module": "salesorders",
"description": "Denotes if a SalesOrder is a backorder"
},
"can_mark_as_bill": {
"type": "schema",
"module": "purchaseorders",
"description": "Checks whether a Purchase Order can be converted to a Bill or not."
},
"can_mark_as_unbill": {
"type": "schema",
"module": "purchaseorders",
"description": "Checks whether a Purchase Order can be unbilled or not."
},
"receive_id": {
"type": "schema",
"module": "salesreturns",
"description": "Unique ID generated by the server for the Sales Return Receive. This is used as an identifier."
},
"receive_number": {
"type": "schema",
"module": "salesreturns",
"description": "Unique Sales Return Receive Number"
},
"purchasereceives": {
"type": "tag",
"description": "PurchaseReceives Module"
},
"date_formatted": {
"type": "schema",
"module": "purchaseorders",
"description": "Indicates the date format."
},
"expected_delivery_date_formatted": {
"type": "schema",
"module": "purchaseorders",
"description": "Indicates the date format."
},
"delivery_date_formatted": {
"type": "schema",
"module": "purchaseorders",
"description": "Indicates the delivery date format."
},
"status_formatted": {
"type": "schema",
"module": "purchaseorders",
"description": "Indicates the Format of the status."
},
"billed_status": {
"type": "schema",
"module": "purchaseorders",
"description": "Indiacates the Status of the bill."
},
"create-a-purchase-order-request": {
"type": "schema",
"module": "purchaseorders",
"description": ""
},
"create-a-purchase-order-request.purchaseorder_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.delivery_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.ship_via": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.salesorder_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.is_drop_shipment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.is_backorder": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.attention": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.delivery_org_address_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.delivery_customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.line_items": {
"type": "property",
"dataType": "array",
"description": "List of line items in a purchase order"
},
"create-a-purchase-order-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.documents": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.source_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-request.destination_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-response": {
"type": "schema",
"module": "purchaseorders",
"description": ""
},
"create-a-purchase-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-purchase-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-order-response.purchase_order": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-purchase-orders-response": {
"type": "schema",
"module": "purchaseorders",
"description": ""
},
"list-all-purchase-orders-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-purchase-orders-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-purchase-orders-response.purchaseorders": {
"type": "property",
"dataType": "array",
"description": ""
},
"retrieve-a-purchase-order-response": {
"type": "schema",
"module": "purchaseorders",
"description": ""
},
"retrieve-a-purchase-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieve-a-purchase-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-a-purchase-order-response.purchase_order": {
"type": "property",
"dataType": "object",
"description": ""
},
"update-a-purchase-order-request": {
"type": "schema",
"module": "purchaseorders",
"description": ""
},
"update-a-purchase-order-request.purchaseorder_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.expected_delivery_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.ship_via": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.salesorder_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.is_drop_shipment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.attention": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.delivery_org_address_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.delivery_customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.line_items": {
"type": "property",
"dataType": "array",
"description": "List of line items in a purchase order"
},
"update-a-purchase-order-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.source_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-request.destination_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-response": {
"type": "schema",
"module": "purchaseorders",
"description": ""
},
"update-a-purchase-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-purchase-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-order-response.purchase_order": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-purchase-order-response": {
"type": "schema",
"module": "purchaseorders",
"description": ""
},
"delete-a-purchase-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-purchase-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-as-issued-response": {
"type": "schema",
"module": "purchaseorders",
"description": ""
},
"mark-as-issued-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-as-issued-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-as-cancelled-response": {
"type": "schema",
"module": "purchaseorders",
"description": ""
},
"mark-as-cancelled-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-as-cancelled-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create_purchase_receive": {
"type": "operation",
"method": "POST",
"path": "/purchasereceives",
"summary": "Create a purchase receive",
"description": "A new purchase receive can a be created.To create Purchase receive, URL parameter purchaseorder_id is needed."
},
"get_purchase_receive": {
"type": "operation",
"method": "GET",
"path": "/purchasereceives/{purchasereceive_id}",
"summary": "Retrieve a Purchase Receive",
"description": "Fetches a Purchase Receive from Zoho Inventory."
},
"update_purchase_receive": {
"type": "operation",
"method": "PUT",
"path": "/purchasereceives/{purchasereceive_id}",
"summary": "Update a Purchase Receive",
"description": "Update a existing Purchase Receive from Zoho Inventory."
},
"delete_purchase_receive": {
"type": "operation",
"method": "DELETE",
"path": "/purchasereceives/{purchasereceive_id}",
"summary": "Delete a Purchase Receive",
"description": "Deletes a Purchase Receive from Zoho Inventory."
},
"submit_purchasereceive": {
"type": "operation",
"method": "POST",
"path": "/purchasereceives/{purchasereceive_id}/submit",
"summary": "Submit a purchase receive for approval",
"description": "Submit a purchase receive for approval workflow."
},
"purchasereceive_id": {
"type": "parameter",
"in": "path",
"description": "Unique ID of the purchase receive."
},
"approve_purchasereceive": {
"type": "operation",
"method": "POST",
"path": "/purchasereceives/{purchasereceive_id}/approve",
"summary": "Approve a purchase receive",
"description": "Approve a submitted purchase receive."
},
"approve_purchasereceive_final": {
"type": "operation",
"method": "POST",
"path": "/purchasereceives/{purchasereceive_id}/approve/final",
"summary": "Final approval of a purchase receive",
"description": "Perform the final approval of a purchase receive (admin only)."
},
"reject_purchasereceive": {
"type": "operation",
"method": "POST",
"path": "/purchasereceives/{purchasereceive_id}/reject",
"summary": "Reject a purchase receive",
"description": "Reject a submitted purchase receive."
},
"purchase_receive-response": {
"type": "schema",
"module": "purchasereceives",
"description": ""
},
"purchase_receive-response.purchaseorder_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_receive-response.purchaseorder_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_receive-response.receive_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_receive-response.receive_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_receive-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_receive-response.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_receive-response.vendor_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_receive-response.contact_persons": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_receive-response.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_receive-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_receive-response.line_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_receive-response.billing_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_receive-response.shipping_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_receive-response.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_receive-response.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-receive-request": {
"type": "schema",
"module": "purchasereceives",
"description": ""
},
"create-a-purchase-receive-request.receive_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-receive-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-receive-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-receive-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-receive-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Number of line items for purchase receive."
},
"create-a-purchase-receive-response": {
"type": "schema",
"module": "purchasereceives",
"description": ""
},
"create-a-purchase-receive-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-purchase-receive-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-purchase-receive-response.purchase_receive": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-a-purchase-receive-response": {
"type": "schema",
"module": "purchasereceives",
"description": ""
},
"retrieve-a-purchase-receive-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieve-a-purchase-receive-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-a-purchase-receive-response.purchase_receive": {
"type": "property",
"dataType": "object",
"description": ""
},
"update-a-purchase-receive-request": {
"type": "schema",
"module": "purchasereceives",
"description": ""
},
"update-a-purchase-receive-request.receive_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-receive-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-receive-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-receive-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-receive-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Number of line items for purchase receive."
},
"update-a-purchase-receive-response": {
"type": "schema",
"module": "purchasereceives",
"description": ""
},
"update-a-purchase-receive-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-purchase-receive-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-purchase-receive-response.purchase_receive": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-purchase-receive-response": {
"type": "schema",
"module": "purchasereceives",
"description": ""
},
"delete-a-purchase-receive-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-purchase-receive-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaways": {
"type": "tag",
"description": "Putaways Module"
},
"create_putaway": {
"type": "operation",
"method": "POST",
"path": "/putaways",
"summary": "Create a putaway",
"description": "Creates a new putaway transaction in Zoho Inventory."
},
"list_putaways": {
"type": "operation",
"method": "GET",
"path": "/putaways",
"summary": "List all putaways",
"description": "Lists putaway transactions with optional filters and pagination."
},
"putaway_number": {
"type": "parameter",
"in": "query",
"description": "Search by putaway number."
},
"get_putaway": {
"type": "operation",
"method": "GET",
"path": "/putaways/{putaway_id}",
"summary": "Retrieve a putaway",
"description": "Fetches details of an existing putaway, including line items."
},
"update_putaway": {
"type": "operation",
"method": "PUT",
"path": "/putaways/{putaway_id}",
"summary": "Update a putaway",
"description": "Updates an existing putaway transaction."
},
"delete_putaway": {
"type": "operation",
"method": "DELETE",
"path": "/putaways/{putaway_id}",
"summary": "Delete a putaway",
"description": "Deletes an existing putaway transaction."
},
"list_putaway_comments": {
"type": "operation",
"method": "GET",
"path": "/putaways/{putaway_id}/comments",
"summary": "List comments for a putaway",
"description": "Returns all comments recorded on a putaway."
},
"add_putaway_attachment": {
"type": "operation",
"method": "POST",
"path": "/putaways/{putaway_id}/attachment",
"summary": "Attach files to a putaway",
"description": "Uploads one or more files and associates them with the putaway."
},
"get_putaway_document": {
"type": "operation",
"method": "GET",
"path": "/putaways/{putaway_id}/documents/{document_id}",
"summary": "Download a putaway document",
"description": "Returns the binary content of an attached document (image or PDF)."
},
"delete_putaway_document": {
"type": "operation",
"method": "DELETE",
"path": "/putaways/{putaway_id}/documents/{document_id}",
"summary": "Remove an attachment from a putaway",
"description": "Deletes or unlinks a document from the putaway."
},
"get_putaway_settings": {
"type": "operation",
"method": "GET",
"path": "/settings/putaways",
"summary": "Get putaway auto number generation settings",
"description": "Returns auto number generation preferences for putaways."
},
"putaway-settings": {
"type": "schema",
"module": "putaways",
"description": ""
},
"putaway-settings.auto_generate": {
"type": "property",
"dataType": "boolean",
"description": "Whether putaway numbers are auto-generated."
},
"putaway-settings.prefix_string": {
"type": "property",
"dataType": "string",
"description": "Prefix for auto-generated putaway numbers."
},
"putaway-settings.next_number": {
"type": "property",
"dataType": "string",
"description": "Next number in the auto-number sequence."
},
"putaway-line-batch-node": {
"type": "schema",
"module": "putaways",
"description": "One batch allocation on a putaway line when batch tracking is enabled (see server BatchNumberCreate / BatchNumberEdit)."
},
"putaway-line-batch-node.batch_id": {
"type": "property",
"dataType": "integer",
"description": "Existing inventory batch ID when selecting stock from an existing batch."
},
"putaway-line-batch-node.batch_in_id": {
"type": "property",
"dataType": "integer",
"description": "Batch-in row reference when supplied by the client."
},
"putaway-line-batch-node.batch_number": {
"type": "property",
"dataType": "string",
"description": "Batch number for a new batch line when not using an existing batch_id."
},
"putaway-line-batch-node.manufacturer_batch_number": {
"type": "property",
"dataType": "string",
"description": "Manufacturer or external batch reference."
},
"putaway-line-batch-node.manufactured_date": {
"type": "property",
"dataType": "string",
"description": "Manufacturing date (yyyy-mm-dd)."
},
"putaway-line-batch-node.expiry_date": {
"type": "property",
"dataType": "string",
"description": "Expiry date (yyyy-mm-dd)."
},
"putaway-line-batch-node.in_quantity": {
"type": "property",
"dataType": "number",
"description": "Quantity for this batch when the line quantity is split across batches."
},
"putaway-line-batch-node.sales_rate": {
"type": "property",
"dataType": "number",
"description": "Selling rate for the batch when batch pricing is enabled."
},
"putaway-line-batch-node.label_rate": {
"type": "property",
"dataType": "number",
"description": "Label (MRP) rate for the batch when applicable."
},
"putaway-line-batch-node.balance_quantity": {
"type": "property",
"dataType": "number",
"description": "On read, returns the remaining quantity in the batch."
},
"putaway-line-batch-node.status": {
"type": "property",
"dataType": "string",
"description": "On read, batch status when returned by the service."
},
"putaway-line-serial-node": {
"type": "schema",
"module": "putaways",
"description": "Serial number row for a putaway line when serial tracking is enabled."
},
"putaway-line-serial-node.serialnumber_id": {
"type": "property",
"dataType": "integer",
"description": "Serial number master record ID."
},
"putaway-line-serial-node.serial_number": {
"type": "property",
"dataType": "string",
"description": "Serial code."
},
"putaway-line-serial-node.status": {
"type": "property",
"dataType": "string",
"description": "Serial status when returned by the service."
},
"putaway-line-storage-node": {
"type": "schema",
"module": "putaways",
"description": "Storage-bin allocation for a putaway line when storage tracking is enabled."
},
"putaway-line-storage-node.storage_id": {
"type": "property",
"dataType": "integer",
"description": "Storage location ID."
},
"putaway-line-storage-node.quantity": {
"type": "property",
"dataType": "number",
"description": "Quantity put away into this storage for the line."
},
"putaway-document-attachment": {
"type": "schema",
"module": "putaways",
"description": "File attached to a putaway (DocumentDetailsForEntity)."
},
"putaway-document-attachment.document_id": {
"type": "property",
"dataType": "integer",
"description": "Attachment document ID; use with GET/DELETE `/putaways/{putaway_id}/documents/{document_id}`."
},
"putaway-document-attachment.file_name": {
"type": "property",
"dataType": "string",
"description": "Original file name."
},
"putaway-document-attachment.file_type": {
"type": "property",
"dataType": "string",
"description": "MIME or file type classification."
},
"putaway-document-attachment.file_size": {
"type": "property",
"dataType": "integer",
"description": "File size in bytes."
},
"putaway-document-attachment.file_size_formatted": {
"type": "property",
"dataType": "string",
"description": "Human-readable file size."
},
"putaway-line-item-request": {
"type": "schema",
"module": "putaways",
"description": ""
},
"putaway-line-item-request.line_item_id": {
"type": "property",
"dataType": "integer",
"description": "Line item ID returned by the server. Required on update when modifying existing line items."
},
"putaway-line-item-request.item_id": {
"type": "property",
"dataType": "integer",
"description": "Item (product) ID for the line. Required for every line item (same role as item_id on transfer order line items)."
},
"putaway-line-item-request.description": {
"type": "property",
"dataType": "string",
"description": "Line-level description or notes for the item. Optional."
},
"putaway-line-item-request.quantity_transferred": {
"type": "property",
"dataType": "number",
"description": "Quantity put away for this line. Required for every line item (same role as quantity_transfer on transfer orders)."
},
"putaway-line-item-request.serial_numbers": {
"type": "property",
"dataType": "array",
"description": "Serial number details when serial tracking is enabled."
},
"putaway-line-item-request.batches": {
"type": "property",
"dataType": "array",
"description": "Batch details when batch tracking is enabled."
},
"putaway-line-item-request.storages": {
"type": "property",
"dataType": "array",
"description": "Storage bin allocations when storage tracking is enabled."
},
"create-a-putaway-request": {
"type": "schema",
"module": "putaways",
"description": ""
},
"create-a-putaway-request.putaway_number": {
"type": "property",
"dataType": "string",
"description": "Putaway number; optional when auto-generation is enabled."
},
"create-a-putaway-request.date": {
"type": "property",
"dataType": "string",
"description": "Transaction date (yyyy-mm-dd)."
},
"create-a-putaway-request.warehouse_id": {
"type": "property",
"dataType": "integer",
"description": "Warehouse ID when warehouses are enabled."
},
"create-a-putaway-request.location_id": {
"type": "property",
"dataType": "integer",
"description": "Location (branch) ID when locations are enabled."
},
"create-a-putaway-request.notes": {
"type": "property",
"dataType": "string",
"description": "Internal notes for the putaway."
},
"create-a-putaway-request.line_items": {
"type": "property",
"dataType": "array",
"description": "A putaway can contain multiple line items. Each object must include item_id and quantity_transferred. Optional fields: line_item_id (required on update for existing lines), description, serial_numbers, batches, and storages when serial, batch, or bin storage tracking applies in your organization."
},
"update-a-putaway-request": {
"type": "schema",
"module": "putaways",
"description": ""
},
"putaway-comment": {
"type": "schema",
"module": "putaways",
"description": ""
},
"putaway-comment.comment_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"putaway-comment.putaway_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"putaway-comment.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-comment.commented_by_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"putaway-comment.commented_by": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-comment.comment_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-comment.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-comment.date_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-comment.time": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-comment.operation_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-line-item-response": {
"type": "schema",
"module": "putaways",
"description": ""
},
"putaway-line-item-response.line_item_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"putaway-line-item-response.item_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"putaway-line-item-response.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-line-item-response.sku": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-line-item-response.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-line-item-response.image_document_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"putaway-line-item-response.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-line-item-response.quantity_transferred": {
"type": "property",
"dataType": "number",
"description": ""
},
"putaway-line-item-response.track_serial_number": {
"type": "property",
"dataType": "boolean",
"description": ""
},
"putaway-line-item-response.track_batch_number": {
"type": "property",
"dataType": "boolean",
"description": ""
},
"putaway-line-item-response.serial_numbers": {
"type": "property",
"dataType": "array",
"description": ""
},
"putaway-line-item-response.batches": {
"type": "property",
"dataType": "array",
"description": ""
},
"putaway-line-item-response.is_combo_product": {
"type": "property",
"dataType": "boolean",
"description": ""
},
"putaway-line-item-response.storages": {
"type": "property",
"dataType": "array",
"description": ""
},
"putaway-line-item-response.is_storage_location_enabled": {
"type": "property",
"dataType": "boolean",
"description": ""
},
"putaway-response": {
"type": "schema",
"module": "putaways",
"description": ""
},
"putaway-response.putaway_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"putaway-response.putaway_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-response.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-response.created_by_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"putaway-response.created_by_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-response.warehouse_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"putaway-response.warehouse_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-response.location_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"putaway-response.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-response.html_string": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-response.comments": {
"type": "property",
"dataType": "array",
"description": ""
},
"putaway-response.line_items": {
"type": "property",
"dataType": "array",
"description": ""
},
"putaway-response.documents": {
"type": "property",
"dataType": "array",
"description": "Attachments on the putaway when returned by the service."
},
"putaway-list-row": {
"type": "schema",
"module": "putaways",
"description": ""
},
"putaway-list-row.putaway_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"putaway-list-row.putaway_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-list-row.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-list-row.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-list-row.warehouse_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"putaway-list-row.warehouse_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-list-row.location_id": {
"type": "property",
"dataType": "integer",
"description": ""
},
"putaway-list-row.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-list-row.has_attachment": {
"type": "property",
"dataType": "boolean",
"description": ""
},
"putaway-list-row.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-list-row.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-putaway-response": {
"type": "schema",
"module": "putaways",
"description": ""
},
"create-a-putaway-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-putaway-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-putaway-response.putaway": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-putaways-response": {
"type": "schema",
"module": "putaways",
"description": ""
},
"list-putaways-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-putaways-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-putaways-response.putaways": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-putaways-response.page_context": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-putaway-response": {
"type": "schema",
"module": "putaways",
"description": ""
},
"get-a-putaway-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-putaway-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-putaway-response.putaway": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-putaway-response": {
"type": "schema",
"module": "putaways",
"description": ""
},
"delete-a-putaway-response": {
"type": "schema",
"module": "putaways",
"description": "Returned when a putaway is deleted."
},
"delete-a-putaway-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-putaway-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-a-putaway-document-response": {
"type": "schema",
"module": "putaways",
"description": "Returned when a document is removed from a putaway."
},
"delete-a-putaway-document-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-putaway-document-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-putaway-comments-response": {
"type": "schema",
"module": "putaways",
"description": ""
},
"list-putaway-comments-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-putaway-comments-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-putaway-comments-response.comments": {
"type": "property",
"dataType": "array",
"description": ""
},
"putaway-attachment-response": {
"type": "schema",
"module": "putaways",
"description": ""
},
"putaway-attachment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"putaway-attachment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"putaway-attachment-response.document": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-putaway-settings-response": {
"type": "schema",
"module": "putaways",
"description": ""
},
"get-putaway-settings-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-putaway-settings-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-putaway-settings-response.putaway_settings": {
"type": "property",
"dataType": "string",
"description": ""
},
"replenishment": {
"type": "tag",
"description": "Replenishment Module"
},
"list_item_location_replenishments": {
"type": "operation",
"method": "GET",
"path": "/items/{item_id}/locations/replenishments",
"summary": "Retrieve replenishment configurations for associated locations",
"description": "Fetches the replenishment configurations of the associated locations for an item."
},
"list_item_warehouse_replenishments": {
"type": "operation",
"method": "GET",
"path": "/items/{item_id}/warehouses/replenishments",
"summary": "Retrieve replenishment configurations for associated warehouses",
"description": "Fetches the replenishment configurations of the associated warehouses for an item. Applicable only when multi-warehouse is enabled for the organization."
},
"get_replenishment_configuration": {
"type": "operation",
"method": "GET",
"path": "/replenishments/{replenishment_configuration_id}",
"summary": "Retrieve a replenishment configuration",
"description": "Fetches the details of a replenishment configuration."
},
"update_replenishment_configuration": {
"type": "operation",
"method": "PUT",
"path": "/replenishments/{replenishment_configuration_id}",
"summary": "Update a replenishment configuration",
"description": "Updates an existing replenishment configuration."
},
"create_replenishment_configuration": {
"type": "operation",
"method": "POST",
"path": "/replenishments",
"summary": "Create a replenishment configuration",
"description": "Creates a replenishment configuration for an item."
},
"bulk_update_replenishments": {
"type": "operation",
"method": "PUT",
"path": "/replenishments",
"summary": "Bulk update replenishment configurations",
"description": "Updates replenishment configurations for the specified item and location combinations."
},
"location_ids": {
"type": "parameter",
"in": "query",
"description": "List of location ids separated by comma"
},
"list_replenishment_tasks": {
"type": "operation",
"method": "GET",
"path": "/replenishments/tasks",
"summary": "List all replenishment tasks",
"description": "Lists replenishment tasks in your organization."
},
"vendor_ids": {
"type": "parameter",
"in": "query",
"description": "List of vendor ids separated by comma"
},
"from_location_ids": {
"type": "parameter",
"in": "query",
"description": "List of source location ids separated by comma"
},
"order_type": {
"type": "parameter",
"in": "query",
"description": "Order type."
},
"get_replenishment_task": {
"type": "operation",
"method": "GET",
"path": "/replenishments/tasks/{task_id}",
"summary": "Retrieve a replenishment task",
"description": "Fetches the details of a replenishment task."
},
"dismiss_replenishment_task": {
"type": "operation",
"method": "PUT",
"path": "/replenishments/tasks/{task_id}/dismiss",
"summary": "Dismiss a replenishment task",
"description": "Dismisses a replenishment task."
},
"get_replenishment_task_for_item": {
"type": "operation",
"method": "GET",
"path": "/replenishments/tasks/details",
"summary": "Retrieve replenishment task details for an item",
"description": "Fetches the replenishment task details for the specified item."
},
"get_replenishment_order_details": {
"type": "operation",
"method": "GET",
"path": "/replenishments/orders",
"summary": "Retrieve replenishment order details",
"description": "Fetches the order details for a replenishment configuration."
},
"replenishment_configuration_id": {
"type": "parameter",
"in": "query",
"description": "Unique identifier of the replenishment configuration."
},
"pause_replenishment_configuration": {
"type": "operation",
"method": "PUT",
"path": "/replenishments/{replenishment_configuration_id}/pause",
"summary": "Pause a replenishment configuration",
"description": "Pauses a replenishment configuration until the specified date."
},
"pause_till_date": {
"type": "parameter",
"in": "query",
"description": "Date until which the replenishment configurations are paused."
},
"bulk_pause_replenishments": {
"type": "operation",
"method": "PUT",
"path": "/replenishments/pause",
"summary": "Bulk pause replenishment configurations",
"description": "Pauses replenishment configurations for the specified item and location combinations."
},
"resume_replenishment_configuration": {
"type": "operation",
"method": "PUT",
"path": "/replenishments/{replenishment_configuration_id}/resume",
"summary": "Resume a replenishment configuration",
"description": "Resumes a paused replenishment configuration."
},
"bulk_resume_replenishments": {
"type": "operation",
"method": "PUT",
"path": "/replenishments/resume",
"summary": "Bulk resume replenishment configurations",
"description": "Resumes paused replenishment configurations for the specified item and location combinations."
},
"bulk_dismiss_replenishment_tasks": {
"type": "operation",
"method": "PUT",
"path": "/replenishments/tasks/dismiss",
"summary": "Bulk dismiss replenishment tasks",
"description": "Dismisses the specified replenishment tasks."
},
"replenishment_task_ids": {
"type": "parameter",
"in": "query",
"description": "List of replenishment task ids separated by comma"
},
"generate_replenishment_task": {
"type": "operation",
"method": "POST",
"path": "/replenishments/{replenishment_configuration_id}/tasks/generate",
"summary": "Generate a replenishment task",
"description": "Generates a replenishment task for a replenishment configuration."
},
"bulk_generate_replenishment_tasks": {
"type": "operation",
"method": "POST",
"path": "/replenishments/tasks/generate",
"summary": "Bulk generate replenishment tasks",
"description": "Generates replenishment tasks for the specified items."
},
"get_replenishment_tasks_report": {
"type": "operation",
"method": "GET",
"path": "/reports/replenishments/tasks",
"summary": "Retrieve replenishment task details report",
"description": "Fetches the replenishment task details report."
},
"replenishment-configuration-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"replenishment-configuration-response.replenishment_configuration_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the replenishment configuration. This is used as an identifier."
},
"replenishment-configuration-response.item_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the item."
},
"replenishment-configuration-response.item_name": {
"type": "property",
"dataType": "string",
"description": "Name of the item."
},
"replenishment-configuration-response.unit": {
"type": "property",
"dataType": "string",
"description": "Unit of measurement for the item."
},
"replenishment-configuration-response.item_status": {
"type": "property",
"dataType": "string",
"description": "Status of the item."
},
"replenishment-configuration-response.location_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the location."
},
"replenishment-configuration-response.location_name": {
"type": "property",
"dataType": "string",
"description": "Name of the location."
},
"replenishment-configuration-response.location_status": {
"type": "property",
"dataType": "string",
"description": "Status of the location."
},
"replenishment-configuration-response.status": {
"type": "property",
"dataType": "string",
"description": "Status of the replenishment configuration. Allowed values: active and paused."
},
"replenishment-configuration-response.pause_till_date": {
"type": "property",
"dataType": "string",
"description": "Date until which the replenishment configuration is paused."
},
"replenishment-configuration-response.type": {
"type": "property",
"dataType": "string",
"description": "Mode in which replenishment tasks are generated. Allowed values: auto and manual."
},
"replenishment-configuration-response.order_type": {
"type": "property",
"dataType": "string",
"description": "Type of order generated for the replenishment configuration. Allowed values: purchase_order and transfer_order."
},
"replenishment-configuration-response.trigger": {
"type": "property",
"dataType": "string",
"description": "Trigger that determines when an automatic replenishment task is generated."
},
"replenishment-configuration-response.trigger_frequency": {
"type": "property",
"dataType": "string",
"description": "Frequency at which the replenishment task is triggered, expressed in the units specified by trigger_frequency_period."
},
"replenishment-configuration-response.trigger_frequency_period": {
"type": "property",
"dataType": "string",
"description": "Period for the trigger frequency. Allowed values: day, week, and month."
},
"replenishment-configuration-response.reorder_level": {
"type": "property",
"dataType": "number",
"description": "Stock level at which a replenishment task is generated for the item."
},
"replenishment-configuration-response.max_stock_level": {
"type": "property",
"dataType": "number",
"description": "Maximum stock level to be maintained for the item at the location."
},
"replenishment-configuration-response.order_multiple": {
"type": "property",
"dataType": "number",
"description": "Quantity multiple to which the replenishment quantity is rounded off."
},
"replenishment-configuration-response.max_order_quantity": {
"type": "property",
"dataType": "number",
"description": "Maximum quantity that can be ordered in a single replenishment task."
},
"replenishment-configuration-response.min_order_quantity": {
"type": "property",
"dataType": "number",
"description": "Minimum quantity that must be ordered in a single replenishment task."
},
"replenishment-configuration-response.preferred_vendor_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the preferred vendor."
},
"replenishment-configuration-response.preferred_vendor_name": {
"type": "property",
"dataType": "string",
"description": "Name of the preferred vendor."
},
"replenishment-configuration-response.preferred_vendor_status": {
"type": "property",
"dataType": "string",
"description": "Status of the preferred vendor."
},
"replenishment-configuration-response.preferred_location_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the preferred source location from which stock is replenished."
},
"replenishment-configuration-response.preferred_location_name": {
"type": "property",
"dataType": "string",
"description": "Name of the preferred source location from which stock is replenished."
},
"replenishment-configuration-response.preferred_location_status": {
"type": "property",
"dataType": "string",
"description": "Status of the preferred source location."
},
"replenishment-configuration-location-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"replenishment-configuration-location-response.location_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the location."
},
"replenishment-configuration-location-response.location_name": {
"type": "property",
"dataType": "string",
"description": "Name of the location."
},
"replenishment-configuration-location-response.replenishment_configuration": {
"type": "property",
"dataType": "string",
"description": "Replenishment configuration associated with the location."
},
"replenishment-configurations-associated-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"replenishment-configurations-associated-response.item_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the item."
},
"replenishment-configurations-associated-response.name": {
"type": "property",
"dataType": "string",
"description": "Name of the item."
},
"replenishment-configurations-associated-response.sku": {
"type": "property",
"dataType": "string",
"description": "Stock Keeping Unit (SKU) of the item."
},
"replenishment-configurations-associated-response.vendor_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the preferred vendor of the item."
},
"replenishment-configurations-associated-response.vendor_name": {
"type": "property",
"dataType": "string",
"description": "Name of the preferred vendor of the item."
},
"replenishment-configurations-associated-response.locations": {
"type": "property",
"dataType": "array",
"description": "List of associated locations and their replenishment configurations for the item."
},
"replenishment-order-detail-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"replenishment-order-detail-response.order_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the order created from the replenishment configuration."
},
"replenishment-order-detail-response.order_number": {
"type": "property",
"dataType": "string",
"description": "Number of the order created from the replenishment configuration."
},
"replenishment-order-detail-response.order_date": {
"type": "property",
"dataType": "string",
"description": "Date of the order."
},
"replenishment-order-detail-response.order_status": {
"type": "property",
"dataType": "string",
"description": "Status of the order."
},
"replenishment-order-detail-response.order_type": {
"type": "property",
"dataType": "string",
"description": "Type of the order. Allowed values: purchase_order and transfer_order."
},
"replenishment-task-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"replenishment-task-response.replenishment_task_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the replenishment task. This is used as an identifier."
},
"replenishment-task-response.entry_number": {
"type": "property",
"dataType": "string",
"description": "Entry number of the replenishment task."
},
"replenishment-task-response.item_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the item."
},
"replenishment-task-response.item_name": {
"type": "property",
"dataType": "string",
"description": "Name of the item."
},
"replenishment-task-response.item_status": {
"type": "property",
"dataType": "string",
"description": "Status of the item."
},
"replenishment-task-response.unit": {
"type": "property",
"dataType": "string",
"description": "Unit of measurement for the item."
},
"replenishment-task-response.location_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the location."
},
"replenishment-task-response.location_name": {
"type": "property",
"dataType": "string",
"description": "Name of the location."
},
"replenishment-task-response.location_status": {
"type": "property",
"dataType": "string",
"description": "Status of the location."
},
"replenishment-task-response.reorder_level": {
"type": "property",
"dataType": "number",
"description": "Stock level at which the replenishment task was generated for the item."
},
"replenishment-task-response.max_stock_level": {
"type": "property",
"dataType": "number",
"description": "Maximum stock level configured for the item at the location."
},
"replenishment-task-response.stock_available_for_sale": {
"type": "property",
"dataType": "number",
"description": "Stock available for sale at the location when the replenishment task was generated."
},
"replenishment-task-response.stock_yet_to_be_received": {
"type": "property",
"dataType": "number",
"description": "Stock that has been ordered but is yet to be received at the location when the replenishment task was generated."
},
"replenishment-task-response.stock_in_transit": {
"type": "property",
"dataType": "number",
"description": "Stock that is in transit to the location when the replenishment task was generated."
},
"replenishment-task-response.total_available_stock": {
"type": "property",
"dataType": "number",
"description": "Total available stock for the item at the location when the replenishment task was generated."
},
"replenishment-task-response.quantity_to_replenish": {
"type": "property",
"dataType": "number",
"description": "Quantity that needs to be replenished for the item at the location."
},
"replenishment-task-response.task_status": {
"type": "property",
"dataType": "string",
"description": "Status of the replenishment task. Allowed values: pending, replenished, completed, and dismissed."
},
"replenishment-task-response.sku": {
"type": "property",
"dataType": "string",
"description": "Stock Keeping Unit (SKU) of the item."
},
"replenishment-task-response.order_multiple": {
"type": "property",
"dataType": "number",
"description": "Quantity multiple to which the replenishment quantity is rounded off."
},
"replenishment-task-response.max_order_quantity": {
"type": "property",
"dataType": "number",
"description": "Maximum quantity that can be ordered in a single replenishment task."
},
"replenishment-task-response.min_order_quantity": {
"type": "property",
"dataType": "number",
"description": "Minimum quantity that must be ordered in a single replenishment task."
},
"replenishment-task-response.order_type": {
"type": "property",
"dataType": "string",
"description": "Type of order generated for the replenishment task. Allowed values: purchase_order and transfer_order."
},
"replenishment-task-response.preferred_vendor_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the preferred vendor."
},
"replenishment-task-response.preferred_vendor_name": {
"type": "property",
"dataType": "string",
"description": "Name of the preferred vendor."
},
"replenishment-task-response.preferred_vendor_status": {
"type": "property",
"dataType": "string",
"description": "Status of the preferred vendor."
},
"replenishment-task-response.source_location_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the source location from which stock is replenished."
},
"replenishment-task-response.source_location_name": {
"type": "property",
"dataType": "string",
"description": "Name of the source location from which stock is replenished."
},
"replenishment-task-response.source_location_status": {
"type": "property",
"dataType": "string",
"description": "Status of the source location."
},
"replenishment-task-response.source_warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the source warehouse from which stock is replenished. Applicable only when multi-warehouse is enabled for the organization."
},
"replenishment-task-response.source_warehouse_name": {
"type": "property",
"dataType": "string",
"description": "Name of the source warehouse from which stock is replenished. Applicable only when multi-warehouse is enabled for the organization."
},
"replenishment-task-response.source_warehouse_status": {
"type": "property",
"dataType": "string",
"description": "Status of the source warehouse. Applicable only when multi-warehouse is enabled for the organization."
},
"replenishment-task-response.current_stock_available_for_sale": {
"type": "property",
"dataType": "number",
"description": "Current stock available for sale at the location."
},
"replenishment-task-response.current_stock_yet_to_be_received": {
"type": "property",
"dataType": "number",
"description": "Current stock that has been ordered but is yet to be received at the location."
},
"replenishment-task-response.current_stock_in_transit": {
"type": "property",
"dataType": "number",
"description": "Current stock that is in transit to the location."
},
"replenishment-task-response.stock_from_draft_replenishment_purchase_orders": {
"type": "property",
"dataType": "number",
"description": "Stock from draft replenishment purchase orders for the item at the location."
},
"replenishment-task-response.stock_from_draft_replenishment_transfer_orders": {
"type": "property",
"dataType": "number",
"description": "Stock from draft replenishment transfer orders for the item at the location."
},
"replenishment-task-response.is_stock_updated": {
"type": "property",
"dataType": "boolean",
"description": "Indicates whether the stock figures shown for the task reflect the latest available values."
},
"comment-response.comment_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the comment."
},
"comment-response.description": {
"type": "property",
"dataType": "string",
"description": "Description of the comment."
},
"comment-response.commented_by_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the user who added the comment."
},
"comment-response.commented_by": {
"type": "property",
"dataType": "string",
"description": "Name of the user who added the comment."
},
"comment-response.comment_type": {
"type": "property",
"dataType": "string",
"description": "Type of the comment. Allowed values: system and user."
},
"comment-response.date": {
"type": "property",
"dataType": "string",
"description": "Date on which the comment was added."
},
"comment-response.date_with_time": {
"type": "property",
"dataType": "string",
"description": "Date and time at which the comment was added."
},
"comment-response.date_description": {
"type": "property",
"dataType": "string",
"description": "Human-readable description of when the comment was added."
},
"comment-response.time": {
"type": "property",
"dataType": "string",
"description": "Time at which the comment was added."
},
"comment-response.operation_type": {
"type": "property",
"dataType": "string",
"description": "Operation that triggered the comment."
},
"purchase-order-summary-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"purchase-order-summary-response.purchase_order_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the purchase order associated with the replenishment task."
},
"purchase-order-summary-response.purchase_order_number": {
"type": "property",
"dataType": "string",
"description": "Number of the purchase order."
},
"purchase-order-summary-response.date": {
"type": "property",
"dataType": "string",
"description": "Date of the purchase order."
},
"purchase-order-summary-response.vendor_name": {
"type": "property",
"dataType": "string",
"description": "Name of the vendor on the purchase order."
},
"purchase-order-summary-response.order_status": {
"type": "property",
"dataType": "string",
"description": "Status of the purchase order."
},
"transfer-order-summary-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"transfer-order-summary-response.transfer_order_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the transfer order associated with the replenishment task."
},
"transfer-order-summary-response.transfer_order_number": {
"type": "property",
"dataType": "string",
"description": "Number of the transfer order."
},
"transfer-order-summary-response.date": {
"type": "property",
"dataType": "string",
"description": "Date of the transfer order."
},
"transfer-order-summary-response.to_location_name": {
"type": "property",
"dataType": "string",
"description": "Name of the destination location to which stock is transferred."
},
"transfer-order-summary-response.from_location_name": {
"type": "property",
"dataType": "string",
"description": "Name of the source location from which stock is transferred."
},
"transfer-order-summary-response.status": {
"type": "property",
"dataType": "string",
"description": "Status of the transfer order."
},
"replenishment-task-detail-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"replenishment-task-detail-response.replenishment_task_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the replenishment task. This is used as an identifier."
},
"replenishment-task-detail-response.entry_number": {
"type": "property",
"dataType": "string",
"description": "Entry number of the replenishment task."
},
"replenishment-task-detail-response.item_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the item."
},
"replenishment-task-detail-response.item_name": {
"type": "property",
"dataType": "string",
"description": "Name of the item."
},
"replenishment-task-detail-response.sku": {
"type": "property",
"dataType": "string",
"description": "Stock Keeping Unit (SKU) of the item."
},
"replenishment-task-detail-response.item_status": {
"type": "property",
"dataType": "string",
"description": "Status of the item."
},
"replenishment-task-detail-response.unit": {
"type": "property",
"dataType": "string",
"description": "Unit of measurement for the item."
},
"replenishment-task-detail-response.location_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the location."
},
"replenishment-task-detail-response.location_name": {
"type": "property",
"dataType": "string",
"description": "Name of the location."
},
"replenishment-task-detail-response.location_status": {
"type": "property",
"dataType": "string",
"description": "Status of the location."
},
"replenishment-task-detail-response.status": {
"type": "property",
"dataType": "string",
"description": "Status of the replenishment task. Allowed values: pending, replenished, completed, and dismissed."
},
"replenishment-task-detail-response.order_type": {
"type": "property",
"dataType": "string",
"description": "Type of order generated for the replenishment task. Allowed values: purchase_order and transfer_order."
},
"replenishment-task-detail-response.reorder_level": {
"type": "property",
"dataType": "number",
"description": "Stock level at which the replenishment task was generated for the item."
},
"replenishment-task-detail-response.max_stock_level": {
"type": "property",
"dataType": "number",
"description": "Maximum stock level configured for the item at the location."
},
"replenishment-task-detail-response.order_multiple": {
"type": "property",
"dataType": "number",
"description": "Quantity multiple to which the replenishment quantity is rounded off."
},
"replenishment-task-detail-response.max_order_quantity": {
"type": "property",
"dataType": "number",
"description": "Maximum quantity that can be ordered in a single replenishment task."
},
"replenishment-task-detail-response.min_order_quantity": {
"type": "property",
"dataType": "number",
"description": "Minimum quantity that must be ordered in a single replenishment task."
},
"replenishment-task-detail-response.preferred_vendor_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the preferred vendor."
},
"replenishment-task-detail-response.preferred_vendor_name": {
"type": "property",
"dataType": "string",
"description": "Name of the preferred vendor."
},
"replenishment-task-detail-response.preferred_vendor_status": {
"type": "property",
"dataType": "string",
"description": "Status of the preferred vendor."
},
"replenishment-task-detail-response.preferred_location_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the preferred source location from which stock is replenished."
},
"replenishment-task-detail-response.preferred_location_name": {
"type": "property",
"dataType": "string",
"description": "Name of the preferred source location from which stock is replenished."
},
"replenishment-task-detail-response.preferred_location_status": {
"type": "property",
"dataType": "string",
"description": "Status of the preferred source location."
},
"replenishment-task-detail-response.stock_available_for_sale": {
"type": "property",
"dataType": "number",
"description": "Stock available for sale at the location when the replenishment task was generated."
},
"replenishment-task-detail-response.quantity_to_replenish": {
"type": "property",
"dataType": "number",
"description": "Quantity that needs to be replenished for the item at the location."
},
"replenishment-task-detail-response.date": {
"type": "property",
"dataType": "string",
"description": "Date on which the replenishment task was created."
},
"replenishment-task-detail-response.date_with_time": {
"type": "property",
"dataType": "string",
"description": "Date and time at which the replenishment task was created."
},
"replenishment-task-detail-response.comments": {
"type": "property",
"dataType": "array",
"description": "List of comments associated with the replenishment task."
},
"replenishment-task-detail-response.purchase_orders": {
"type": "property",
"dataType": "array",
"description": "List of purchase orders associated with the replenishment task."
},
"replenishment-task-detail-response.transfer_orders": {
"type": "property",
"dataType": "array",
"description": "List of transfer orders associated with the replenishment task."
},
"replenishment-task-report-detail-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"replenishment-task-report-detail-response.entry_number": {
"type": "property",
"dataType": "string",
"description": "Entry number of the replenishment task."
},
"replenishment-task-report-detail-response.item_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the item."
},
"replenishment-task-report-detail-response.item_name": {
"type": "property",
"dataType": "string",
"description": "Name of the item."
},
"replenishment-task-report-detail-response.sku": {
"type": "property",
"dataType": "string",
"description": "Stock Keeping Unit (SKU) of the item."
},
"replenishment-task-report-detail-response.warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the warehouse at which the replenishment task is recorded. Applicable only when multi-warehouse is enabled for the organization."
},
"replenishment-task-report-detail-response.warehouse": {
"type": "property",
"dataType": "string",
"description": "Name of the warehouse at which the replenishment task is recorded. Applicable only when multi-warehouse is enabled for the organization."
},
"replenishment-task-report-detail-response.location_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the location at which the replenishment task is recorded."
},
"replenishment-task-report-detail-response.location": {
"type": "property",
"dataType": "string",
"description": "Name of the location at which the replenishment task is recorded."
},
"replenishment-task-report-detail-response.status": {
"type": "property",
"dataType": "string",
"description": "Status of the replenishment task. Allowed values: pending, replenished, completed, and dismissed."
},
"replenishment-task-report-detail-response.order_type": {
"type": "property",
"dataType": "string",
"description": "Type of order generated for the replenishment task. Allowed values: purchase_order and transfer_order."
},
"replenishment-task-report-detail-response.reorder_level": {
"type": "property",
"dataType": "number",
"description": "Stock level at which the replenishment task was generated for the item."
},
"replenishment-task-report-detail-response.max_stock_level": {
"type": "property",
"dataType": "number",
"description": "Maximum stock level configured for the item at the location."
},
"replenishment-task-report-detail-response.order_multiple": {
"type": "property",
"dataType": "number",
"description": "Quantity multiple to which the replenishment quantity is rounded off."
},
"replenishment-task-report-detail-response.max_order_quantity": {
"type": "property",
"dataType": "number",
"description": "Maximum quantity that can be ordered in a single replenishment task."
},
"replenishment-task-report-detail-response.min_order_quantity": {
"type": "property",
"dataType": "number",
"description": "Minimum quantity that must be ordered in a single replenishment task."
},
"replenishment-task-report-detail-response.preferred_vendor_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the preferred vendor."
},
"replenishment-task-report-detail-response.preferred_vendor_name": {
"type": "property",
"dataType": "string",
"description": "Name of the preferred vendor."
},
"replenishment-task-report-detail-response.source_warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the source warehouse from which stock is replenished. Applicable only when multi-warehouse is enabled for the organization."
},
"replenishment-task-report-detail-response.source_warehouse_name": {
"type": "property",
"dataType": "string",
"description": "Name of the source warehouse from which stock is replenished. Applicable only when multi-warehouse is enabled for the organization."
},
"replenishment-task-report-detail-response.source_location_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the source location from which stock is replenished."
},
"replenishment-task-report-detail-response.source_location_name": {
"type": "property",
"dataType": "string",
"description": "Name of the source location from which stock is replenished."
},
"replenishment-task-report-detail-response.stock_available_for_sale": {
"type": "property",
"dataType": "number",
"description": "Stock available for sale at the location when the replenishment task was generated."
},
"replenishment-task-report-detail-response.quantity_to_replenish": {
"type": "property",
"dataType": "number",
"description": "Quantity that needs to be replenished for the item at the location."
},
"replenishment-task-report-detail-response.created_time": {
"type": "property",
"dataType": "string",
"description": "Date on which the replenishment task was created."
},
"replenishment-task-report-detail-response.last_modified_time": {
"type": "property",
"dataType": "string",
"description": "Date on which the replenishment task was last modified."
},
"create-a-replenishment-configuration-request": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"create-a-replenishment-configuration-request.replenishment_configuration_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the replenishment configuration. Provide this to update an existing replenishment configuration for the item and location combination."
},
"create-a-replenishment-configuration-request.item_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the item for which the replenishment configuration is being created."
},
"create-a-replenishment-configuration-request.location_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the location for which the replenishment configuration is being created."
},
"create-a-replenishment-configuration-request.warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the warehouse for which the replenishment configuration is being created. Applicable only when multi-warehouse is enabled for the organization."
},
"create-a-replenishment-configuration-request.status": {
"type": "property",
"dataType": "string",
"description": "Status of the replenishment configuration. Allowed values: active and paused."
},
"create-a-replenishment-configuration-request.type": {
"type": "property",
"dataType": "string",
"description": "Mode in which replenishment tasks are generated. Allowed values: auto and manual."
},
"create-a-replenishment-configuration-request.order_type": {
"type": "property",
"dataType": "string",
"description": "Type of order generated by the replenishment configuration. Allowed values: purchase_order and transfer_order."
},
"create-a-replenishment-configuration-request.trigger": {
"type": "property",
"dataType": "string",
"description": "Trigger that determines when an automatic replenishment task is generated."
},
"create-a-replenishment-configuration-request.trigger_frequency": {
"type": "property",
"dataType": "string",
"description": "Frequency at which the replenishment task is triggered, expressed in the units defined by the trigger."
},
"create-a-replenishment-configuration-request.reorder_level": {
"type": "property",
"dataType": "number",
"description": "Stock level at which a replenishment task is generated for the item."
},
"create-a-replenishment-configuration-request.max_stock_level": {
"type": "property",
"dataType": "number",
"description": "Maximum stock level to be maintained for the item at the location."
},
"create-a-replenishment-configuration-request.order_multiple": {
"type": "property",
"dataType": "number",
"description": "Quantity multiple to which the replenishment quantity is rounded off."
},
"create-a-replenishment-configuration-request.max_order_quantity": {
"type": "property",
"dataType": "number",
"description": "Maximum quantity that can be ordered in a single replenishment task."
},
"create-a-replenishment-configuration-request.min_order_quantity": {
"type": "property",
"dataType": "number",
"description": "Minimum quantity that must be ordered in a single replenishment task."
},
"create-a-replenishment-configuration-request.preferred_vendor_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the preferred vendor from which stock is replenished."
},
"create-a-replenishment-configuration-request.preferred_location_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the preferred source location from which stock is replenished."
},
"create-a-replenishment-configuration-request.preferred_warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the preferred source warehouse from which stock is replenished. Applicable only when multi-warehouse is enabled for the organization."
},
"update-a-replenishment-configuration-request": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"bulk-update-replenishment-configurations-request": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"bulk-update-replenishment-configurations-request.replenishment_configurations": {
"type": "property",
"dataType": "array",
"description": "List of replenishment configurations to update. Each entry specifies the values for an item and location (or warehouse) combination."
},
"retrieve-replenishment-configurations-for-associated-locations-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"retrieve-replenishment-configurations-for-associated-locations-response.code": {
"type": "property",
"dataType": "integer",
"description": "Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error."
},
"retrieve-replenishment-configurations-for-associated-locations-response.message": {
"type": "property",
"dataType": "string",
"description": "Message for the invoked API."
},
"retrieve-replenishment-configurations-for-associated-locations-response.replenishment_configurations": {
"type": "property",
"dataType": "string",
"description": "Replenishment configurations of the associated locations for the item."
},
"retrieve-replenishment-configurations-for-associated-warehouses-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"retrieve-replenishment-configurations-for-associated-warehouses-response.code": {
"type": "property",
"dataType": "integer",
"description": "Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error."
},
"retrieve-replenishment-configurations-for-associated-warehouses-response.message": {
"type": "property",
"dataType": "string",
"description": "Message for the invoked API."
},
"retrieve-replenishment-configurations-for-associated-warehouses-response.replenishment_configurations": {
"type": "property",
"dataType": "string",
"description": "Replenishment configurations of the associated warehouses for the item."
},
"retrieve-a-replenishment-configuration-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"retrieve-a-replenishment-configuration-response.code": {
"type": "property",
"dataType": "integer",
"description": "Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error."
},
"retrieve-a-replenishment-configuration-response.message": {
"type": "property",
"dataType": "string",
"description": "Message for the invoked API."
},
"retrieve-a-replenishment-configuration-response.replenishment_configuration": {
"type": "property",
"dataType": "string",
"description": "Details of the replenishment configuration."
},
"create-a-replenishment-configuration-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"create-a-replenishment-configuration-response.code": {
"type": "property",
"dataType": "integer",
"description": "Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error."
},
"create-a-replenishment-configuration-response.message": {
"type": "property",
"dataType": "string",
"description": "Message for the invoked API."
},
"create-a-replenishment-configuration-response.replenishment_configuration": {
"type": "property",
"dataType": "string",
"description": "Details of the created replenishment configuration."
},
"update-a-replenishment-configuration-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"update-a-replenishment-configuration-response.code": {
"type": "property",
"dataType": "integer",
"description": "Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error."
},
"update-a-replenishment-configuration-response.message": {
"type": "property",
"dataType": "string",
"description": "Message for the invoked API."
},
"update-a-replenishment-configuration-response.replenishment_configuration": {
"type": "property",
"dataType": "string",
"description": "Details of the updated replenishment configuration."
},
"bulk-update-replenishment-configurations-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"bulk-update-replenishment-configurations-response.code": {
"type": "property",
"dataType": "integer",
"description": "Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error."
},
"bulk-update-replenishment-configurations-response.message": {
"type": "property",
"dataType": "string",
"description": "Message for the invoked API."
},
"bulk-update-replenishment-configurations-response.replenishment_configurations": {
"type": "property",
"dataType": "array",
"description": "List of updated replenishment configurations."
},
"list-replenishment-tasks-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"list-replenishment-tasks-response.code": {
"type": "property",
"dataType": "integer",
"description": "Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error."
},
"list-replenishment-tasks-response.message": {
"type": "property",
"dataType": "string",
"description": "Message for the invoked API."
},
"list-replenishment-tasks-response.replenishment_tasks": {
"type": "property",
"dataType": "array",
"description": "List of replenishment tasks in the organization."
},
"list-replenishment-tasks-response.page_context": {
"type": "property",
"dataType": "object",
"description": "Pagination details for the list of replenishment tasks."
},
"retrieve-a-replenishment-task-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"retrieve-a-replenishment-task-response.code": {
"type": "property",
"dataType": "integer",
"description": "Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error."
},
"retrieve-a-replenishment-task-response.message": {
"type": "property",
"dataType": "string",
"description": "Message for the invoked API."
},
"retrieve-a-replenishment-task-response.task_details": {
"type": "property",
"dataType": "string",
"description": "Details of the replenishment task."
},
"retrieve-replenishment-order-details-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"retrieve-replenishment-order-details-response.code": {
"type": "property",
"dataType": "integer",
"description": "Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error."
},
"retrieve-replenishment-order-details-response.message": {
"type": "property",
"dataType": "string",
"description": "Message for the invoked API."
},
"retrieve-replenishment-order-details-response.replenishment_order_details": {
"type": "property",
"dataType": "array",
"description": "List of orders generated for the replenishment configuration."
},
"pause-a-replenishment-configuration-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"pause-a-replenishment-configuration-response.code": {
"type": "property",
"dataType": "integer",
"description": "Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error."
},
"pause-a-replenishment-configuration-response.message": {
"type": "property",
"dataType": "string",
"description": "Message for the invoked API."
},
"resume-a-replenishment-configuration-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"resume-a-replenishment-configuration-response.code": {
"type": "property",
"dataType": "integer",
"description": "Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error."
},
"resume-a-replenishment-configuration-response.message": {
"type": "property",
"dataType": "string",
"description": "Message for the invoked API."
},
"dismiss-a-replenishment-task-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"dismiss-a-replenishment-task-response.code": {
"type": "property",
"dataType": "integer",
"description": "Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error."
},
"dismiss-a-replenishment-task-response.message": {
"type": "property",
"dataType": "string",
"description": "Message for the invoked API."
},
"generate-replenishment-task-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"generate-replenishment-task-response.code": {
"type": "property",
"dataType": "integer",
"description": "Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error."
},
"generate-replenishment-task-response.message": {
"type": "property",
"dataType": "string",
"description": "Message for the invoked API."
},
"retrieve-replenishment-task-details-report-response": {
"type": "schema",
"module": "replenishment",
"description": ""
},
"retrieve-replenishment-task-details-report-response.code": {
"type": "property",
"dataType": "integer",
"description": "Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error."
},
"retrieve-replenishment-task-details-report-response.message": {
"type": "property",
"dataType": "string",
"description": "Message for the invoked API."
},
"retrieve-replenishment-task-details-report-response.replenishment_tasks": {
"type": "property",
"dataType": "array",
"description": "List of replenishment task entries in the report."
},
"retrieve-replenishment-task-details-report-response.page_context": {
"type": "property",
"dataType": "object",
"description": "Pagination details for the replenishment task details report."
},
"reporting-tags": {
"type": "tag",
"description": "Reporting Tags Module"
},
"get_tags": {
"type": "operation",
"method": "GET",
"path": "/reportingtags",
"summary": "List of all Reporting Tags",
"description": "Get a list of all reporting tags in the preferred order that you can set."
},
"create_tag": {
"type": "operation",
"method": "POST",
"path": "/reportingtags",
"summary": "Create Reporting Tag",
"description": "Create a reporting tag"
},
"mark_default_option": {
"type": "operation",
"method": "POST",
"path": "/reportingtags/{tag_id}",
"summary": "Mark an option as default for a reporting tag",
"description": "Mark an option as the default option or clear default option for a reporting tag."
},
"default_option_id": {
"type": "parameter",
"in": "query",
"description": "ID of the option to be marked as default. If this parameter is not sent or sent empty, the current default option of the tag will be removed."
},
"update_tag": {
"type": "operation",
"method": "PUT",
"path": "/reportingtags/{tag_id}",
"summary": "Update Reporting Tag",
"description": "Update a reporting tag"
},
"delete_tag": {
"type": "operation",
"method": "DELETE",
"path": "/reportingtags/{tag_id}",
"summary": "Delete a reporting tag",
"description": "Delete a reporting tag. If there are any usages of the reporting tag in transactions, custom views or workflows, you will not be able to delete the tag."
},
"update_tag_options": {
"type": "operation",
"method": "PUT",
"path": "/reportingtags/{tag_id}/options",
"summary": "Update Reporting Tag Options",
"description": "Create, update or delete the options of a reporting tag. Reorder and arrange them in an hierarchical structure as per your organization requirements.
NOTE:
null should be passed"
},
"filter_type": {
"type": "schema",
"module": "reporting-tags",
"description": "Type of filter entity. tag and Location location. all - Instead of selecting all options, you can send this flag to denote all options of the filter tag or location are selected for the filter to the respective tag. untagged - When you want to show an option when no option is selected for the filter tag. Note: This flag cannot be used for location filter."
},
"filter_option_name": {
"type": "schema",
"module": "reporting-tags",
"description": "Option Name for the filter. It can be an option name or flags. All - Instead of selecting all options, you can send this flag to denote all options of the filter tag or location are selected for the filter to the respective tag. Untagged - When you want to show an option when no option is selected for the filter tag. Note: This flag cannot be used for location filter."
},
"tag_is_active": {
"type": "schema",
"module": "reporting-tags",
"description": "Is the tag active"
},
"option_is_default": {
"type": "schema",
"module": "reporting-tags",
"description": "Is the option default for the tag"
},
"option_is_active": {
"type": "schema",
"module": "reporting-tags",
"description": "Is the option active for the tag"
},
"entities": {
"type": "schema",
"module": "reporting-tags",
"description": "Entities that can only be enabled or disabled which can also be called as mono-preference entities."
},
"multi_preference_entities": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"multi_preference_entities.preference": {
"type": "property",
"dataType": "string",
"description": "Preference type. Currently, only 'transaction' and 'line_item' is supported for this node"
},
"multi_preference_entities.entities": {
"type": "property",
"dataType": "array",
"description": "Entities that can only be enabled or disabled"
},
"criteria_tags": {
"type": "schema",
"module": "reporting-tags",
"description": "Filter tags and location"
},
"criteria_options": {
"type": "schema",
"module": "reporting-tags",
"description": "Options for criteria"
},
"tag_response": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"tag_response.tag_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"tag_response.tag_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"tag_response.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"tag_response.is_mandatory": {
"type": "property",
"dataType": "string",
"description": ""
},
"tag_response.entities": {
"type": "property",
"dataType": "string",
"description": ""
},
"tag_response.multi_preference_entities": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-reporting-tags-response": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"update-reporting-tag-request": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"update-reporting-tag-request.tag_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-reporting-tag-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-reporting-tag-request.is_mandatory": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-reporting-tag-request.entities": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-reporting-tag-request.multi_preference_entities": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-options-request": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"update-options-request.options": {
"type": "property",
"dataType": "array",
"description": "Options selected for the criteria"
},
"update-options-response": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"update-options-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"reporting-tags-response": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"reporting-tags-response.tag": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-criteria-request": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"update-criteria-request.criteria_tags": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-criteria-request.options": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-criteria-response": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"update-criteria-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-segmentation-response": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"update-segmentation-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"options-editpage-response": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"options-editpage-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"options-editpage-response.is_class": {
"type": "property",
"dataType": "string",
"description": ""
},
"options-editpage-response.is_draft": {
"type": "property",
"dataType": "string",
"description": ""
},
"options-editpage-response.is_filter_configured": {
"type": "property",
"dataType": "boolean",
"description": "If filter is configured for this tag, it will be true"
},
"options-editpage-response.tag_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"options-editpage-response.tag_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"options-editpage-response.options": {
"type": "property",
"dataType": "array",
"description": "Options selected for the criteria"
},
"editpage-segmentation-response": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"editpage-segmentation-response.is_class": {
"type": "property",
"dataType": "string",
"description": ""
},
"editpage-segmentation-response.is_draft": {
"type": "property",
"dataType": "string",
"description": ""
},
"editpage-segmentation-response.tag_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"editpage-segmentation-response.tag_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"dependent_tags": {
"type": "schema",
"module": "reporting-tags",
"description": "The tags and location that is associated as filter for the tag"
},
"possible_filter_tags": {
"type": "schema",
"module": "reporting-tags",
"description": "List of tags that can be used as filter for the tag"
},
"criteria_options_response": {
"type": "schema",
"module": "reporting-tags",
"description": "Options selected for the criteria"
},
"criteria_options_response_for_details_page": {
"type": "schema",
"module": "reporting-tags",
"description": "Options selected for the criteria"
},
"editpage-criteria-response": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"editpage-criteria-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"editpage-criteria-response.dependent_tags": {
"type": "property",
"dataType": "string",
"description": ""
},
"editpage-criteria-response.is_class": {
"type": "property",
"dataType": "string",
"description": ""
},
"editpage-criteria-response.is_draft": {
"type": "property",
"dataType": "string",
"description": ""
},
"editpage-criteria-response.tag_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"editpage-criteria-response.tag_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"editpage-criteria-response.tags": {
"type": "property",
"dataType": "string",
"description": ""
},
"editpage-criteria-response.options": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-default_option-response": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"mark-default_option-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-default_option-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"autocomplete_response": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"autocomplete_response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"autocomplete_response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"autocomplete_response.results": {
"type": "property",
"dataType": "array",
"description": "List of reporting tags matching the search criteria"
},
"all_options_response": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"all_options_response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"all_options_response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"all_options_response.results": {
"type": "property",
"dataType": "array",
"description": "List of all options under a reporting tag"
},
"options_detail_page_response": {
"type": "schema",
"module": "reporting-tags",
"description": ""
},
"options_detail_page_response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"options_detail_page_response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"options_detail_page_response.dependent_tags": {
"type": "property",
"dataType": "string",
"description": ""
},
"options_detail_page_response.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"options_detail_page_response.is_class": {
"type": "property",
"dataType": "string",
"description": ""
},
"options_detail_page_response.is_draft": {
"type": "property",
"dataType": "string",
"description": ""
},
"options_detail_page_response.tag_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"options_detail_page_response.tag_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"options_detail_page_response.options": {
"type": "property",
"dataType": "string",
"description": ""
},
"options_detail_page_response.page_context": {
"type": "property",
"dataType": "object",
"description": ""
},
"retainer-invoices": {
"type": "tag",
"description": "Retainer-Invoices Module"
},
"create_retainer_invoice": {
"type": "operation",
"method": "POST",
"path": "/retainerinvoices",
"summary": "Create a retainerinvoice",
"description": "Create a retainer invoice for your customer."
},
"list_retainer_invoices": {
"type": "operation",
"method": "GET",
"path": "/retainerinvoices",
"summary": "List a retainer invoices",
"description": "List all retainer invoices with pagination."
},
"update_retainer_invoice": {
"type": "operation",
"method": "PUT",
"path": "/retainerinvoices/{retainerinvoice_id}",
"summary": "update a retainerinvoice",
"description": "Update an existing invoice."
},
"get_retainer_invoice": {
"type": "operation",
"method": "GET",
"path": "/retainerinvoices/{retainerinvoice_id}",
"summary": "Get a retainer invoice",
"description": "Get the details of a retainer invoice."
},
"delete_retainer_invoice": {
"type": "operation",
"method": "DELETE",
"path": "/retainerinvoices/{retainerinvoice_id}",
"summary": "Delete a retainer invoice",
"description": "Delete an existing retainer invoice. Invoices which have payment or credits note applied cannot be deleted."
},
"mark_retainer_invoice_as_sent": {
"type": "operation",
"method": "POST",
"path": "/retainerinvoices/{retainerinvoice_id}/status/sent",
"summary": "Mark a retainer invoice as sent",
"description": "Mark a draft retainer invoice as sent."
},
"update_retainer_invoice_template": {
"type": "operation",
"method": "PUT",
"path": "/retainerinvoices/{retainerinvoice_id}/templates/{template_id}",
"summary": "Update retainer invoice template",
"description": "Update the pdf template associated with the retainer invoice."
},
"mark_retainer_invoice_as_void": {
"type": "operation",
"method": "POST",
"path": "/retainerinvoices/{retainerinvoice_id}/status/void",
"summary": "Void a retainer invoice",
"description": "Mark an invoice status as void. Upon voiding, the payments and credits associated with the retainer invoices will be unassociated and will be under customer credits."
},
"mark_retainer_invoice_as_draft": {
"type": "operation",
"method": "POST",
"path": "/retainerinvoices/{reatinerinvoice_id}/status/draft",
"summary": "Mark as draft",
"description": "Mark a voided retainer invoice as draft. "
},
"submit_retainer_invoice": {
"type": "operation",
"method": "POST",
"path": "/retainerinvoices/{reatinerinvoice_id}/submit",
"summary": "Submit a retainer invoice for approval",
"description": "Submit a retainer invoice for approval."
},
"approve_retainer_invoice": {
"type": "operation",
"method": "POST",
"path": "/retainerinvoices/{reatinerinvoice_id}/approve",
"summary": "Approve a retainer invoice.",
"description": "Approve a retainer invoice."
},
"email_retainer_invoice": {
"type": "operation",
"method": "POST",
"path": "/retainerinvoices/{retainerinvoice_id}/email",
"summary": "Email a retainer invoice",
"description": "Email a retainer invoice to the customer. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content."
},
"get_retainer_invoice_email_content": {
"type": "operation",
"method": "GET",
"path": "/retainerinvoices/{retainerinvoice_id}/email",
"summary": "Get retainer invoice email content",
"description": "Get the email content of a retainer invoice."
},
"update_retainer_invoice_billing_address": {
"type": "operation",
"method": "PUT",
"path": "/retainerinvoices/{retainerinvoice_id}/address/billing",
"summary": "Update billing address",
"description": "Updates the billing address for this retainer invoice alone."
},
"list_retainer_invoice_templates": {
"type": "operation",
"method": "GET",
"path": "/retainerinvoices/templates",
"summary": "List retainer invoice templates",
"description": "Get all retainer invoice pdf templates."
},
"get_retainer_invoice_attachment": {
"type": "operation",
"method": "GET",
"path": "/retainerinvoices/{retainerinvoice_id}/attachment",
"summary": "Get a retainer invoice attachment",
"description": "Returns the file attached to the retainer invoice."
},
"add_attachment_to_retainer_invoice": {
"type": "operation",
"method": "POST",
"path": "/retainerinvoices/{retainerinvoice_id}/attachment",
"summary": "Add attachment to a retainer invoice",
"description": "Attach a file to an invoice."
},
"delete_retainer_invoice_attachment": {
"type": "operation",
"method": "DELETE",
"path": "/retainerinvoices/{retainerinvoice_id}/documents/{document_id}",
"summary": "Delete an attachment",
"description": "Delete the file attached to the retainer invoice."
},
"list_retainer_invoice_comments": {
"type": "operation",
"method": "GET",
"path": "/retainerinvoices/{retainerinvoice_id}/comments",
"summary": "List retainer invoice comments & history",
"description": "Get the complete history and comments of a retainer invoice."
},
"create_retainer_invoice_comment": {
"type": "operation",
"method": "POST",
"path": "/retainerinvoices/{retainerinvoice_id}/comments",
"summary": "Add comment",
"description": "Add a comment for a retainer invoice."
},
"delete_retainer_invoice_comment": {
"type": "operation",
"method": "DELETE",
"path": "/retainerinvoices/{retainerinvoice_id}/comments/{comment_id}",
"summary": "Delete a comment",
"description": "Delete a retainer invoice comment."
},
"update_retainer_invoice_comment": {
"type": "operation",
"method": "PUT",
"path": "/retainerinvoices/{retainerinvoice_id}/comments/{comment_id}",
"summary": "Update comment",
"description": "Update an existing comment of a retainer invoice."
},
"retainerinvoice-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"retainerinvoice-response.retainerinvoice_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.retainerinvoice_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.is_pre_gst": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.project_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.project_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.last_payment_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.customer_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.currency_symbol": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.is_viewed_by_client": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.client_viewed_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.line_items": {
"type": "property",
"dataType": "array",
"description": "Line items of a retainer invoice."
},
"retainerinvoice-response.sub_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.total": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.taxes": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.payment_made": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.payment_drawn": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.balance": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.allow_partial_payments": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.price_precision": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.payment_options": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.is_emailed": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.documents": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.billing_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.shipping_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.template_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.page_width": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.page_height": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.orientation": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.template_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.created_by_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.attachment_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"retainerinvoice-response.can_send_in_mail": {
"type": "property",
"dataType": "string",
"description": ""
},
"project_name": {
"type": "schema",
"module": "vendor-credits",
"description": "Name of the project."
},
"retainerinvoice_id": {
"type": "schema",
"module": "retainer-invoices",
"description": "ID of the retainerinvoice"
},
"retainerinvoice_number": {
"type": "schema",
"module": "retainer-invoices",
"description": "number of the retainer invoice.Variants: retainerinvoice_number_startswith and retainerinvoice_number_contains. Max-length [100]"
},
"project_or_estimate_name": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"payment_drawn": {
"type": "schema",
"module": "retainer-invoices",
"description": "The amount drawn"
},
"page_width": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"page_height": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"orientation": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"created_by_id": {
"type": "schema",
"module": "tasks",
"description": "ID of the user who created the task."
},
"is_client_review_settings_enabled": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"retainerinvoice_total": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"retainerinvoice_balance": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"retainerinvoice_date": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"payment_refunds": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"html_string": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"is_payment_drawn_details_required": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"create-a-retainerinvoice-request": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"create-a-retainerinvoice-request.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-retainerinvoice-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-retainerinvoice-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-retainerinvoice-request.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-retainerinvoice-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-retainerinvoice-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-retainerinvoice-request.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-retainerinvoice-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-retainerinvoice-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Line items of a retainer invoice."
},
"create-a-retainerinvoice-request.payment_options": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-retainerinvoice-request.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-retainerinvoice-request.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-retainerinvoice-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"create-a-retainerinvoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-retainerinvoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-retainerinvoice-response.retainerinvoice": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-a-retainer-invoices-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"list-a-retainer-invoices-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-a-retainer-invoices-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-a-retainer-invoices-response.retainerinvoices": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-a-retainer-invoices-response.page_context": {
"type": "property",
"dataType": "object",
"description": ""
},
"update-a-retainerinvoice-request": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"update-a-retainerinvoice-request.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-retainerinvoice-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-retainerinvoice-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-retainerinvoice-request.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-retainerinvoice-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-retainerinvoice-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-retainerinvoice-request.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-retainerinvoice-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-retainerinvoice-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Line items of a retainer invoice."
},
"update-a-retainerinvoice-request.payment_options": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-retainerinvoice-request.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-retainerinvoice-request.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-retainerinvoice-request.project_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-retainerinvoice-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"update-a-retainerinvoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-retainerinvoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-retainerinvoice-response.retainerinvoice": {
"type": "property",
"dataType": "object",
"description": ""
},
"get-a-retainer-invoice-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"get-a-retainer-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-retainer-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-retainer-invoice-response.retainerinvoice": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-retainer-invoice-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"delete-a-retainer-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-retainer-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-a-retainer-invoice-as-sent-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"mark-a-retainer-invoice-as-sent-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-a-retainer-invoice-as-sent-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-retainer-invoice-template-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"update-retainer-invoice-template-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-retainer-invoice-template-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"void-a-retainer-invoice-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"void-a-retainer-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"void-a-retainer-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"submit-a-retainer-invoice-for-approval-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"submit-a-retainer-invoice-for-approval-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"submit-a-retainer-invoice-for-approval-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"approve-a-retainer-invoice-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"approve-a-retainer-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"approve-a-retainer-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-a-retainer-invoice-request": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"email-a-retainer-invoice-request.send_from_org_email_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-a-retainer-invoice-request.to_mail_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-a-retainer-invoice-request.cc_mail_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-a-retainer-invoice-request.subject": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-a-retainer-invoice-request.body": {
"type": "property",
"dataType": "string",
"description": ""
},
"email-a-retainer-invoice-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"email-a-retainer-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"email-a-retainer-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-retainer-invoice-email-content-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"get-retainer-invoice-email-content-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-retainer-invoice-email-content-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-retainer-invoice-email-content-response.gateways_configured": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-retainer-invoice-email-content-response.deprecated_placeholders_used": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-retainer-invoice-email-content-response.body": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-retainer-invoice-email-content-response.error_list": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-retainer-invoice-email-content-response.subject": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-retainer-invoice-email-content-response.to_contacts": {
"type": "property",
"dataType": "array",
"description": ""
},
"get-retainer-invoice-email-content-response.attachment_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-retainer-invoice-email-content-response.email_template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-retainer-invoice-email-content-response.file_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-retainer-invoice-email-content-response.from_emails": {
"type": "property",
"dataType": "array",
"description": ""
},
"get-retainer-invoice-email-content-response.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-retainer-invoice-templates-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"list-retainer-invoice-templates-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-retainer-invoice-templates-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-retainer-invoice-templates-response.templates": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-retainer-payments-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"list-retainer-payments-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-retainer-payments-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-retainer-payments-response.payments": {
"type": "property",
"dataType": "array",
"description": ""
},
"delete-a-retainer-payment-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"delete-a-retainer-payment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-retainer-payment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-retainer-invoice-attachment-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"get-a-retainer-invoice-attachment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-retainer-invoice-attachment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-attachment-to-a-retainer-invoice-request": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"add-attachment-to-a-retainer-invoice-request.can_send_in_mail": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-attachment-to-a-retainer-invoice-request.attachment": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-attachment-to-a-retainer-invoice-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"add-attachment-to-a-retainer-invoice-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"add-attachment-to-a-retainer-invoice-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-retainer-invoice-comments-and-history-response": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"list-retainer-invoice-comments-and-history-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-retainer-invoice-comments-and-history-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-retainer-invoice-comments-and-history-response.comments": {
"type": "property",
"dataType": "array",
"description": ""
},
"add-comment-request.payment_expected_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-comment-request.show_comment_to_clients": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-comment-request": {
"type": "schema",
"module": "retainer-invoices",
"description": ""
},
"update-comment-request.description": {
"type": "property",
"dataType": "string",
"description": "The comment on a retainer invoice"
},
"update-comment-request.show_comment_to_clients": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-comment-response.comment": {
"type": "property",
"dataType": "object",
"description": ""
},
"salesorders": {
"type": "tag",
"description": "SalesOrders Module"
},
"create_sales_order": {
"type": "operation",
"method": "POST",
"path": "/salesorders",
"summary": "Create a Sales Order",
"description": "Creates a new Sales Order in Zoho Inventory. Description about extra parameter ignore_auto_number_generation - Ignore auto sales order number generation for this sales order. This mandates the Sales Order number to be entered. Allowed Values true and false."
},
"list_sales_orders": {
"type": "operation",
"method": "GET",
"path": "/salesorders",
"summary": "List all Sales Orders",
"description": "Lists all the available Sales Orders in Zoho Inventory."
},
"bulk_delete_sales_orders": {
"type": "operation",
"method": "DELETE",
"path": "/salesorders",
"summary": "Bulk delete Sales Orders",
"description": "Bulk delete the selected Sales Orders."
},
"get_sales_order": {
"type": "operation",
"method": "GET",
"path": "/salesorders/{salesorder_id}",
"summary": "Retrieve a Sales Order",
"description": "Retrieves the details for an existing Sales Order."
},
"update_sales_order": {
"type": "operation",
"method": "PUT",
"path": "/salesorders/{salesorder_id}",
"summary": "Update a Sales Order",
"description": "Updates a new Sales Order in Zoho Inventory. Description about extra parameter ignore_auto_number_generation - Ignore auto sales order number generation for this sales order. This mandates the Sales Order number to be entered. Allowed Values true and false."
},
"delete_sales_order": {
"type": "operation",
"method": "DELETE",
"path": "/salesorders/{salesorder_id}",
"summary": "Delete a Sales Order",
"description": "Deletes an existing Sales Order from Zoho Inventory."
},
"mark_sales_order_as_confirmed": {
"type": "operation",
"method": "POST",
"path": "/salesorders/{salesorder_id}/status/confirmed",
"summary": "Mark as Confirmed",
"description": "Changes the status of a Sales Order to Confirmed."
},
"mark_sales_order_as_void": {
"type": "operation",
"method": "POST",
"path": "/salesorders/{salesorder_id}/status/void",
"summary": "Mark as Void",
"description": "Changes the status of a Sales Order to Void."
},
"bulk_confirm_sales_orders": {
"type": "operation",
"method": "POST",
"path": "/salesorders/status/confirmed",
"summary": "Bulk confirm Sales Orders",
"description": "Mark existing Sales Orders as confirmed in Zoho Inventory"
},
"salesorder_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of sales order IDs to approve."
},
"submit_salesorder": {
"type": "operation",
"method": "POST",
"path": "/salesorders/{salesorder_id}/submit",
"summary": "Submit a sales order for approval",
"description": "Submit a sales order for approval workflow."
},
"approve_salesorder": {
"type": "operation",
"method": "POST",
"path": "/salesorders/{salesorder_id}/approve",
"summary": "Approve a sales order",
"description": "Approve a submitted sales order."
},
"approve_salesorder_final": {
"type": "operation",
"method": "POST",
"path": "/salesorders/{salesorder_id}/approve/final",
"summary": "Final approval of a sales order",
"description": "Perform the final approval of a sales order (admin only)."
},
"reject_salesorder": {
"type": "operation",
"method": "POST",
"path": "/salesorders/{salesorder_id}/reject",
"summary": "Reject a sales order",
"description": "Reject a submitted sales order."
},
"bulk_submit_salesorders": {
"type": "operation",
"method": "POST",
"path": "/salesorders/submit",
"summary": "Bulk submit sales orders for approval",
"description": "Submit multiple sales orders for approval workflow at once."
},
"bulk_approve_salesorders": {
"type": "operation",
"method": "POST",
"path": "/salesorders/approve",
"summary": "Bulk approve sales orders",
"description": "Approve multiple submitted sales orders at once."
},
"sales_order-response": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"sales_order-response.salesorder_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.salesorder_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.shipment_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.customer_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.currency_symbol": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.discount_amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.discount": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.is_discount_before_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.discount_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.estimate_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.delivery_method": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.delivery_method_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.line_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.shipping_charge": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.adjustment": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.adjustment_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.sub_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.tax_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.total": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.taxes": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.price_precision": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.pricebook_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.shipping_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.billing_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.template_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.template_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.salesperson_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.salesperson_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.documents": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.is_pre_gst": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"sales_order-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_date": {
"type": "schema",
"module": "salesorders",
"description": "Shipment date of the Sales Order."
},
"estimate_id": {
"type": "schema",
"module": "shipmentorders",
"description": "Unique ID generated by the server from the Estimate created in Zoho Books. This is used as an identifier."
},
"quantity_invoiced": {
"type": "schema",
"module": "salesorders",
"description": "Quantity invoiced of the line item."
},
"quantity_packed": {
"type": "schema",
"module": "salesorders",
"description": "Quantity packed of the line item."
},
"quantity_shipped": {
"type": "schema",
"module": "salesorders",
"description": "Quantity shipped of the line item."
},
"status_message": {
"type": "schema",
"module": "shipmentorders",
"description": "Status message of the shipment."
},
"shipment_status": {
"type": "schema",
"module": "salesorders",
"description": "Shipment status of the package."
},
"shipment_days": {
"type": "schema",
"module": "salesorders",
"description": "Days of Shipment for the Order"
},
"bcy_total": {
"type": "schema",
"module": "salesorders",
"description": "Total in Base Currency of the Organisation"
},
"is_dropshipped": {
"type": "schema",
"module": "salesorders",
"description": "Denotes if a SalesOrder has been dropshipped"
},
"is_backordered": {
"type": "schema",
"module": "salesorders",
"description": "Denotes if a SalesOrder has been backordered"
},
"is_backorder_allowed": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"has_unconfirmed_line_item": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"create-a-sales-order-request": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"create-a-sales-order-request.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.salesorder_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.shipment_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.line_items": {
"type": "property",
"dataType": "array",
"description": "A sales order can contain multiple line items. Each line item contains item_id,name,description,rate,quantity,unit,tax_id,tax_name,tax_type,tax_percentage,item_total."
},
"create-a-sales-order-request.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.discount": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.is_discount_before_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.discount_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.shipping_charge": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.delivery_method": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.adjustment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.pricebook_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.salesperson_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.adjustment_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.documents": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.billing_address_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.shipping_address_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-request.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-response": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"create-a-sales-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-sales-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-order-response.sales_order": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-sales-orders-response": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"list-all-sales-orders-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-sales-orders-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-sales-orders-response.salesorders": {
"type": "property",
"dataType": "array",
"description": ""
},
"bulk-delete-sales-orders-response": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"bulk-delete-sales-orders-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"bulk-delete-sales-orders-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-a-sales-order-response": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"retrieve-a-sales-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieve-a-sales-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-a-sales-order-response.salesorder": {
"type": "property",
"dataType": "object",
"description": ""
},
"update-a-sales-order-request": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"update-a-sales-order-request.salesorder_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.shipment_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.contact_persons_associated": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.discount": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.is_discount_before_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.discount_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.delivery_method": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.shipping_charge": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.adjustment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.adjustment_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.pricebook_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.salesperson_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.terms": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.line_items": {
"type": "property",
"dataType": "array",
"description": "A sales order can contain multiple line items. Each line item contains item_id,name,description,rate,quantity,unit,tax_id,tax_name,tax_type,tax_percentage,item_total."
},
"update-a-sales-order-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.billing_address_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.shipping_address_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-request.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-response": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"update-a-sales-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-sales-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-order-response.sales_order": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-sales-order-response": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"delete-a-sales-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-sales-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-as-confirmed-response": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"mark-as-confirmed-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-as-confirmed-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"bulk-confirm-salesorders-response": {
"type": "schema",
"module": "salesorders",
"description": ""
},
"bulk-confirm-salesorders-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"bulk-confirm-salesorders-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"bulk-confirm-salesorders-response.data": {
"type": "property",
"dataType": "object",
"description": ""
},
"salesreturns": {
"type": "tag",
"description": "SalesReturns Module"
},
"create_sales_return": {
"type": "operation",
"method": "POST",
"path": "/salesreturns",
"summary": "Create a Sales Return",
"description": "Creation of Sales Return. Sales return can be created for all the shipped units of the items in a sales order."
},
"list_sales_returns": {
"type": "operation",
"method": "GET",
"path": "/salesreturns",
"summary": "List all Sales Returns",
"description": "Lists all the Sales Returns present in Zoho Inventory."
},
"update_sales_return": {
"type": "operation",
"method": "PUT",
"path": "/salesreturns/{salesreturn_id}",
"summary": "Update a Sales Return",
"description": "Updation of Sales Return."
},
"get_sales_return": {
"type": "operation",
"method": "GET",
"path": "/salesreturns/{salesreturn_id}",
"summary": "Retrieve a Sales Return",
"description": "Retrieves the details for an existing Sales Return."
},
"delete_sales_return": {
"type": "operation",
"method": "DELETE",
"path": "/salesreturns/{salesreturn_id}",
"summary": "Delete a Sales Return",
"description": "Deletes a Sales Return from Zoho Inventory."
},
"create_sales_return_receive": {
"type": "operation",
"method": "POST",
"path": "/salesreturnreceives",
"summary": "Create a Sales Return Receive",
"description": "Creating a sales return receive to mark the receivable goods as received."
},
"salesreturn_id": {
"type": "schema",
"module": "salesreturns",
"description": "Unique ID generated by the server for the Sales Return."
},
"delete_sales_return_receive": {
"type": "operation",
"method": "DELETE",
"path": "/salesreturnreceives/{salesreturnreceive_id}",
"summary": "Delete a Sales Return Receive",
"description": "Deletes the sales return receive of a sales return."
},
"salesreturn-response": {
"type": "schema",
"module": "salesreturns",
"description": ""
},
"salesreturn-response.salesreturn_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"salesreturn-response.salesreturn_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"salesreturn-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"salesreturn-response.reason": {
"type": "property",
"dataType": "string",
"description": ""
},
"salesreturn-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"salesreturn-response.line_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"salesreturn-response.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"salesreturn-response.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"salesreturn-response.comments": {
"type": "property",
"dataType": "string",
"description": ""
},
"salesreturn-response.salesreturn_status": {
"type": "property",
"dataType": "string",
"description": ""
},
"salesreturn-response.salesorder_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"salesreturn-response.salesorder_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"salesreturn_number": {
"type": "schema",
"module": "salesreturns",
"description": "Return Merchandise Authorisation (RMA) number of the Sales Return."
},
"non_receive_quantity": {
"type": "schema",
"module": "salesreturns",
"description": "The quantity that cannot be received for the line item."
},
"mapped_items_receive": {
"type": "schema",
"module": "salesreturns",
"description": "Items that are associated with the composite item (kit) in the line item. Applicable only when the line item is a kit type composite item."
},
"salesreturn_status": {
"type": "schema",
"module": "salesreturns",
"description": "Status of the Sales Return."
},
"receive_status": {
"type": "schema",
"module": "salesreturns",
"description": "Receive status of the Sales Return"
},
"refund_status": {
"type": "schema",
"module": "salesreturns",
"description": "Refund status of the Sales Return"
},
"refunded_amount": {
"type": "schema",
"module": "salesreturns",
"description": "Total amount refunded to the customer."
},
"salesreturnreceives": {
"type": "schema",
"module": "salesreturns",
"description": "List of sales return receives for the sales return"
},
"creditnotes": {
"type": "schema",
"module": "salesreturns",
"description": "List of credit notes associated with a sales return."
},
"create-a-sales-return-request": {
"type": "schema",
"module": "salesreturns",
"description": ""
},
"create-a-sales-return-request.salesreturn_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-return-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-return-request.reason": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-return-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-return-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-return-request.line_items": {
"type": "property",
"dataType": "array",
"description": "The underlying items in a Sales Return"
},
"create-a-sales-return-response": {
"type": "schema",
"module": "salesreturns",
"description": ""
},
"create-a-sales-return-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-sales-return-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-return-response.salesreturn": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-sales-returns-response": {
"type": "schema",
"module": "salesreturns",
"description": ""
},
"list-all-sales-returns-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-sales-returns-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-sales-returns-response.salesreturns": {
"type": "property",
"dataType": "object",
"description": ""
},
"update-a-sales-return-request": {
"type": "schema",
"module": "salesreturns",
"description": ""
},
"update-a-sales-return-request.salesreturn_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-return-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-return-request.reason": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-return-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-return-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-return-request.line_items": {
"type": "property",
"dataType": "array",
"description": "The underlying items in a Sales Return"
},
"update-a-sales-return-response": {
"type": "schema",
"module": "salesreturns",
"description": ""
},
"update-a-sales-return-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-sales-return-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-sales-return-response.salesreturn": {
"type": "property",
"dataType": "object",
"description": ""
},
"retrieve-a-sales-return-response": {
"type": "schema",
"module": "salesreturns",
"description": ""
},
"retrieve-a-sales-return-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieve-a-sales-return-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-a-sales-return-response.salesreturn": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-sales-return-response": {
"type": "schema",
"module": "salesreturns",
"description": ""
},
"delete-a-sales-return-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-sales-return-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-return-receive-request": {
"type": "schema",
"module": "salesreturns",
"description": ""
},
"create-a-sales-return-receive-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-return-receive-request.line_items": {
"type": "property",
"dataType": "array",
"description": "The underlying items in a Sales Return"
},
"create-a-sales-return-receive-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-return-receive-response": {
"type": "schema",
"module": "salesreturns",
"description": ""
},
"create-a-sales-return-receive-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-sales-return-receive-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-sales-return-receive-response.salesreturn": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-sales-return-receive-response": {
"type": "schema",
"module": "salesreturns",
"description": ""
},
"delete-a-sales-return-receive-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-sales-return-receive-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"serialnumbers": {
"type": "tag",
"description": "Serial Numbers Module"
},
"list_serial_numbers": {
"type": "operation",
"method": "GET",
"path": "/items/serialnumbers",
"summary": "List all serial numbers",
"description": "List all serial numbers available for a given item."
},
"show_transacted_out": {
"type": "parameter",
"in": "query",
"description": "Include serial numbers that have already been transacted out. Allowed values true and false."
},
"retrieve_a_serial_number": {
"type": "operation",
"method": "GET",
"path": "/items/serialnumbers/{serial_number_id}",
"summary": "Retrieve a serial number",
"description": "Fetch the details of a specific serial number."
},
"serialnumber_id": {
"type": "schema",
"module": "serialnumbers",
"description": "Unique identifier of the serial number."
},
"serialnumber": {
"type": "schema",
"module": "serialnumbers",
"description": "Serial number assigned to the unit."
},
"is_transacted_out": {
"type": "schema",
"module": "serialnumbers",
"description": "Indicates whether the serial number has been transacted out and is no longer available in stock."
},
"price": {
"type": "schema",
"module": "serialnumbers",
"description": "Price of the item associated with the serial number."
},
"serial-number-response": {
"type": "schema",
"module": "serialnumbers",
"description": "Details of a serial number."
},
"serial-number-response.serialnumber_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"serial-number-response.serialnumber": {
"type": "property",
"dataType": "string",
"description": ""
},
"serial-number-response.code": {
"type": "property",
"dataType": "string",
"description": ""
},
"serial-number-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"serial-number-response.is_transacted_out": {
"type": "property",
"dataType": "string",
"description": ""
},
"serial-number-response.item_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"serial-number-response.price": {
"type": "property",
"dataType": "string",
"description": ""
},
"serial-number-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-serial-numbers-item": {
"type": "schema",
"module": "serialnumbers",
"description": "Details of a serial number as returned in the list serial numbers response."
},
"list-serial-numbers-item.serialnumber_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-serial-numbers-item.serialnumber": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-serial-numbers-item.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-serial-numbers-item.is_transacted_out": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-serial-numbers-item.batch_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-serial-numbers-item.batch_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-serial-numbers-item.batch_custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-serial-numbers-item.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-serial-numbers-response": {
"type": "schema",
"module": "serialnumbers",
"description": ""
},
"list-all-serial-numbers-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-serial-numbers-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-serial-numbers-response.serial_numbers": {
"type": "property",
"dataType": "array",
"description": ""
},
"retrieve-a-serial-number-response": {
"type": "schema",
"module": "serialnumbers",
"description": ""
},
"retrieve-a-serial-number-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieve-a-serial-number-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-a-serial-number-response.serial_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipmentorders": {
"type": "tag",
"description": "ShipmentOrders Module"
},
"create_shipment_order": {
"type": "operation",
"method": "POST",
"path": "/shipmentorders",
"summary": "Create a Shipment Order",
"description": "A new shipment order can a be created. To create shipment, URL parameter's package_ids and salesorder_id are mandatory."
},
"get_shipment_order": {
"type": "operation",
"method": "GET",
"path": "/shipmentorders/{shipmentorder_id}",
"summary": "Retrieve a Shipment Order",
"description": "Retrieves details for an existing Shipment Orders."
},
"update_shipment_order": {
"type": "operation",
"method": "PUT",
"path": "/shipmentorders/{shipmentorder_id}",
"summary": "Update a Shipment Order",
"description": "Update details of an existing Shipment Order in Zoho Inventory."
},
"delete_shipment_order": {
"type": "operation",
"method": "DELETE",
"path": "/shipmentorders/{shipmentorder_id}",
"summary": "Delete a Shipment Order",
"description": "Deletes an existing Shipment Order."
},
"mark_shipment_order_as_delivered": {
"type": "operation",
"method": "POST",
"path": "/shipmentorders/{shipmentorder_id}/status/delivered",
"summary": "Mark as Delivered",
"description": "Change the status of the Shipment to delivered."
},
"shipment_order-response": {
"type": "schema",
"module": "shipmentorders",
"description": ""
},
"shipment_order-response.salesorder_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.salesorder_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.shipment_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.shipment_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.detailed_status": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.status_message": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.carrier": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.service": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.delivery_days": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.delivery_guarantee": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.customer_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.customer_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.contact_persons": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.currency_symbol": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.discount_amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.discount": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.is_discount_before_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.discount_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.estimate_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.delivery_method": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.delivery_method_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.tracking_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.line_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.shipping_charge": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.sub_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.tax_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.total": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.taxes": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.price_precision": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.is_emailed": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.billing_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.shipping_address": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.template_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.template_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.shipmentorder_custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"shipment_order-response.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-shipment-order-request": {
"type": "schema",
"module": "shipmentorders",
"description": ""
},
"create-a-shipment-order-request.shipment_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-shipment-order-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-shipment-order-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-shipment-order-request.contact_persons": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-shipment-order-request.delivery_method": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-shipment-order-request.tracking_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-shipment-order-request.shipping_charge": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-shipment-order-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-shipment-order-request.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-shipment-order-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-shipment-order-request.shipmentorder_custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-shipment-order-request": {
"type": "schema",
"module": "shipmentorders",
"description": ""
},
"update-a-shipment-order-request.shipment_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-shipment-order-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-shipment-order-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-shipment-order-request.contact_persons": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-shipment-order-request.delivery_method": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-shipment-order-request.tracking_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-shipment-order-request.shipping_charge": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-shipment-order-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-shipment-order-request.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-shipment-order-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-shipment-order-request.shipmentorder_custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-shipment-order-response": {
"type": "schema",
"module": "shipmentorders",
"description": ""
},
"create-a-shipment-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-shipment-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-shipment-order-response.shipment_order": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-shipment-order-response": {
"type": "schema",
"module": "shipmentorders",
"description": ""
},
"update-a-shipment-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-shipment-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-shipment-order-response.shipmentorder": {
"type": "property",
"dataType": "object",
"description": ""
},
"retrieve-a-shipment-order-response": {
"type": "schema",
"module": "shipmentorders",
"description": ""
},
"retrieve-a-shipment-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieve-a-shipment-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-a-shipment-order-response.shipment_order": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-shipment-order-response": {
"type": "schema",
"module": "shipmentorders",
"description": ""
},
"delete-a-shipment-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-shipment-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-as-delivered-response": {
"type": "schema",
"module": "shipmentorders",
"description": ""
},
"mark-as-delivered-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-as-delivered-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"storagelocations": {
"type": "tag",
"description": "Bin Locations Module"
},
"enable_storage_locations_for_warehouse": {
"type": "operation",
"method": "POST",
"path": "/settings/warehouses/{warehouse_id}/storagelocations/enable",
"summary": "Enables bin locations for a specific warehouse",
"description": "Enable bin locations for a specific warehouse so goods can be tracked."
},
"disable_storage_locations_for_warehouse": {
"type": "operation",
"method": "POST",
"path": "/settings/warehouses/{warehouse_id}/storagelocations/disable",
"summary": "Disable Bin Locations for a Warehouse",
"description": "Disable bin locations for a specific warehouse."
},
"enable_storage_locations_for_location": {
"type": "operation",
"method": "POST",
"path": "/locations/{location_id}/storagelocations/enable",
"summary": "Enable Bin Locations for a Location",
"description": "Enable bin locations for a specific location so goods can be tracked."
},
"disable_storage_locations_for_location": {
"type": "operation",
"method": "POST",
"path": "/locations/{location_id}/storagelocations/disable",
"summary": "Disable Bin Locations for a Location",
"description": "Disable bin locations for a specific location."
},
"create_storage_zone": {
"type": "operation",
"method": "POST",
"path": "/storagezones",
"summary": "Create a Zone",
"description": "Creates a zone for a specific location or warehouse."
},
"list_storage_zones": {
"type": "operation",
"method": "GET",
"path": "/storagezones",
"summary": "List all Zones",
"description": "List all zones configured for warehouses and locations in your Zoho Inventory organization."
},
"mark_storage_zones_as_active": {
"type": "operation",
"method": "PUT",
"path": "/storagezones/active",
"summary": "Mark Zones as Active",
"description": "Bulk mark zones as active."
},
"storage_zone_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of zone IDs to mark as inactive."
},
"mark_storage_zones_as_inactive": {
"type": "operation",
"method": "PUT",
"path": "/storagezones/inactive",
"summary": "Mark Zones as Inactive",
"description": "Bulk mark zones as inactive."
},
"get_storage_zone": {
"type": "operation",
"method": "GET",
"path": "/storagezones/{zone_id}",
"summary": "Get a Zone",
"description": "Retrieve the details of a specific zone and its bin hierarchy."
},
"update_storage_zone": {
"type": "operation",
"method": "PUT",
"path": "/storagezones/{zone_id}",
"summary": "Update a Zone",
"description": "Update and manage an existing zone and the hierarchy used to create bins within it."
},
"delete_storage_zone": {
"type": "operation",
"method": "DELETE",
"path": "/storagezones/{zone_id}",
"summary": "Delete a Zone",
"description": "Delete a specific zone when it is no longer needed."
},
"create_storage_location": {
"type": "operation",
"method": "POST",
"path": "/storagelocations",
"summary": "Create a Bin",
"description": "Create a bin within a zone so goods can be stored and tracked to the smallest unit space."
},
"list_storage_locations": {
"type": "operation",
"method": "GET",
"path": "/storagelocations",
"summary": "List all Bins",
"description": "List all bin locations available in your Zoho Inventory organization."
},
"storage_zone_id": {
"type": "schema",
"module": "storagelocations",
"description": "Unique ID generated by the server for the zone."
},
"show_stock_only_bins": {
"type": "parameter",
"in": "query",
"description": "When set to true, returns only bin locations that have stock."
},
"show_batches": {
"type": "parameter",
"in": "query",
"description": "When set to true, includes batch information in the response."
},
"exclude_zero_stock_bins": {
"type": "parameter",
"in": "query",
"description": "When set to true, excludes bin locations with zero stock."
},
"storage_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of bin location IDs to mark as inactive."
},
"bulk_delete_storage_locations": {
"type": "operation",
"method": "DELETE",
"path": "/storagelocations",
"summary": "Bulk Delete Bins",
"description": "Delete multiple bin locations in bulk."
},
"mark_storage_locations_as_active": {
"type": "operation",
"method": "POST",
"path": "/storagelocations/active",
"summary": "Mark Bins as Active",
"description": "Mark multiple bin locations as active."
},
"mark_storage_locations_as_inactive": {
"type": "operation",
"method": "POST",
"path": "/storagelocations/inactive",
"summary": "Mark Bins as Inactive",
"description": "Mark multiple bin locations as inactive."
},
"get_storage_location": {
"type": "operation",
"method": "GET",
"path": "/storagelocations/{storage_id}",
"summary": "Get a Bin",
"description": "Retrieve the details of a specific bin location."
},
"update_storage_location": {
"type": "operation",
"method": "PUT",
"path": "/storagelocations/{storage_id}",
"summary": "Update a Bin",
"description": "Update the details of an existing bin location."
},
"delete_storage_location": {
"type": "operation",
"method": "DELETE",
"path": "/storagelocations/{storage_id}",
"summary": "Delete a Bin",
"description": "Delete a specific bin location when it is no longer needed."
},
"get_item_storage_location_mappings": {
"type": "operation",
"method": "GET",
"path": "/items/{item_id}/storagelocationsmapping",
"summary": "Get Item Bin Mappings",
"description": "Retrieve the bins mapped to a specific item."
},
"update_item_storage_location_mappings": {
"type": "operation",
"method": "PUT",
"path": "/items/{item_id}/storagelocationsmapping",
"summary": "Update Item Bin Mappings",
"description": "Update the bin mappings for a specific item."
},
"get_item_default_storage_location": {
"type": "operation",
"method": "GET",
"path": "/items/{item_id}/defaultstoragemapping",
"summary": "Get Item Default Bin",
"description": "Retrieve the default bin mapping for a specific item."
},
"configure_item_default_storage_location": {
"type": "operation",
"method": "PUT",
"path": "/items/{item_id}/configure/defaultstorage",
"summary": "Configure Item Default Bin",
"description": "Configure the default bin per location for a specific item."
},
"get_composite_item_default_storage_location": {
"type": "operation",
"method": "GET",
"path": "/compositeitems/{item_id}/defaultstoragemapping",
"summary": "Get Composite Item Default Bin",
"description": "Retrieve the default bin mapping for a specific composite item."
},
"configure_composite_item_default_storage": {
"type": "operation",
"method": "PUT",
"path": "/compositeitems/{item_id}/configure/defaultstorage",
"summary": "Configure Composite Item Default Bin",
"description": "Configure the default bin per location for a specific composite item."
},
"zone_name": {
"type": "schema",
"module": "storagelocations",
"description": "Name of the zone."
},
"storage_id": {
"type": "schema",
"module": "storagelocations",
"description": "Unique ID generated by the server for the bin location."
},
"storage_location_name": {
"type": "schema",
"module": "storagelocations",
"description": "Name of the bin location."
},
"storage_location_description": {
"type": "schema",
"module": "storagelocations",
"description": "Description of the bin location."
},
"storage_zone_status": {
"type": "schema",
"module": "storagelocations",
"description": "Status of the zone. Allowed Values: active, inactive"
},
"storage_location_status": {
"type": "schema",
"module": "storagelocations",
"description": "Status of the bin location. Allowed Values: active, inactive"
},
"location_structure": {
"type": "schema",
"module": "storagelocations",
"description": "Defines a single level in the zone hierarchy used to generate bin locations."
},
"location_structure.location_structure_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the location structure level."
},
"location_structure.location_name": {
"type": "property",
"dataType": "string",
"description": "Name of this hierarchy level (e.g. Row, Rack, Bin)."
},
"location_structure.delimiter": {
"type": "property",
"dataType": "string",
"description": "Single character used to separate levels in the bin location name."
},
"location_structure.alias_name": {
"type": "property",
"dataType": "string",
"description": "Abbreviation used as prefix in the auto-generated location name for this level."
},
"location_structure.level": {
"type": "property",
"dataType": "integer",
"description": "Position of this level in the hierarchy (1 to 10)."
},
"location_structure.count": {
"type": "property",
"dataType": "integer",
"description": "Number of units at this level (1 to 200000)."
},
"storage_zone": {
"type": "schema",
"module": "storagelocations",
"description": "Details of a zone that contains multiple bin locations."
},
"storage_zone.storage_zone_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"storage_zone.zone_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"storage_zone.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"storage_zone.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"storage_zone.location_structures": {
"type": "property",
"dataType": "array",
"description": "Ordered list of hierarchy levels that define how bin locations are generated in this zone."
},
"storage_location": {
"type": "schema",
"module": "storagelocations",
"description": "Details of a bin location."
},
"storage_location.storage_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"storage_location.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"storage_location.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"storage_location.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"storage_location.zone_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"storage_location.zone_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"storage_location.storage_zone_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"storage_location.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"storage_location.balance_quantity": {
"type": "property",
"dataType": "number",
"description": "Current available quantity in the bin."
},
"storage_location.batches": {
"type": "property",
"dataType": "array",
"description": "Batch details available in this bin (returned when show_batches=true)."
},
"bin_batch": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"bin_batch.batch_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the batch."
},
"bin_batch.batch_number": {
"type": "property",
"dataType": "string",
"description": "Display number of the batch."
},
"enable-storage-locations-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"enable-storage-locations-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"enable-storage-locations-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"disable-storage-locations-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"disable-storage-locations-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"disable-storage-locations-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-storage-zone-request": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"create-a-storage-zone-request.zone_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-storage-zone-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-storage-zone-request.location_structures": {
"type": "property",
"dataType": "array",
"description": "Ordered list of hierarchy levels that define the naming pattern for bin locations in this zone. Maximum 50 levels."
},
"create-a-storage-zone-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"create-a-storage-zone-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-storage-zone-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-storage-zone-response.storage_zone": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-storage-zones-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"list-all-storage-zones-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-storage-zones-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-storage-zones-response.storage_zones": {
"type": "property",
"dataType": "array",
"description": ""
},
"get-a-storage-zone-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"get-a-storage-zone-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-storage-zone-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-storage-zone-response.storage_zone": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-storage-zone-request": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"update-a-storage-zone-request.zone_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-storage-zone-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-storage-zone-request.location_structures": {
"type": "property",
"dataType": "array",
"description": "Ordered list of hierarchy levels that define the naming pattern for bin locations in this zone. Maximum 50 levels."
},
"update-a-storage-zone-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"update-a-storage-zone-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-storage-zone-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-storage-zone-response.storage_zone": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-a-storage-zone-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"delete-a-storage-zone-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-storage-zone-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-storage-zones-as-active-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"mark-storage-zones-as-active-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-storage-zones-as-active-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-storage-zones-as-inactive-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"mark-storage-zones-as-inactive-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-storage-zones-as-inactive-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-storage-location-request": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"create-a-storage-location-request.storage_zone_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-storage-location-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-storage-location-request.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-storage-location-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-storage-location-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"create-a-storage-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-storage-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-storage-location-response.storage_location": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-storage-locations-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"list-all-storage-locations-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-storage-locations-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-storage-locations-response.storage_locations": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-all-storage-locations-response.page_context": {
"type": "property",
"dataType": "object",
"description": ""
},
"get-a-storage-location-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"get-a-storage-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-storage-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-storage-location-response.storage_location": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-storage-location-request": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"update-a-storage-location-request.storage_zone_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-storage-location-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-storage-location-request.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-storage-location-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-storage-location-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"update-a-storage-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-storage-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-storage-location-response.storage_location": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-a-storage-location-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"delete-a-storage-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-storage-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"bulk-delete-storage-locations-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"bulk-delete-storage-locations-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"bulk-delete-storage-locations-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-storage-locations-as-active-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"mark-storage-locations-as-active-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-storage-locations-as-active-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-storage-locations-as-inactive-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"mark-storage-locations-as-inactive-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-storage-locations-as-inactive-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"storage_location_product_mapping": {
"type": "schema",
"module": "storagelocations",
"description": "A mapping between a product and a bin location."
},
"storage_location_product_mapping.product_id": {
"type": "property",
"dataType": "string",
"description": "Unique identifier of the product (item)."
},
"storage_location_product_mapping.storage_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"storage_location_product_mapping.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"map-storage-locations-to-item-request": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"map-storage-locations-to-item-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"map-storage-locations-to-item-request.storage_locations_product_mapping": {
"type": "property",
"dataType": "array",
"description": "List of bin location mappings for the item. Maximum 10000 entries."
},
"get-item-storage-location-mappings-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"get-item-storage-location-mappings-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-item-storage-location-mappings-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-item-storage-location-mappings-response.storage_locations_product_mapping": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-item-storage-location-mappings-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"update-item-storage-location-mappings-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-item-storage-location-mappings-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"default_storage_location_mapping": {
"type": "schema",
"module": "storagelocations",
"description": "Default bin location assignment for a product per location."
},
"default_storage_location_mapping.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"default_storage_location_mapping.storage_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-item-default-storage-location-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"get-item-default-storage-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-item-default-storage-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-item-default-storage-location-response.default_storage_location_mapping": {
"type": "property",
"dataType": "array",
"description": ""
},
"configure-item-default-storage-location-request": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"configure-item-default-storage-location-request.default_storage_location_mapping": {
"type": "property",
"dataType": "array",
"description": "List of default bin location assignments per location for the item."
},
"configure-item-default-storage-location-response": {
"type": "schema",
"module": "storagelocations",
"description": ""
},
"configure-item-default-storage-location-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"configure-item-default-storage-location-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"tasks": {
"type": "tag",
"description": "Task Module"
},
"add_task": {
"type": "operation",
"method": "POST",
"path": "/tasks",
"summary": "Add a task",
"description": "Add a task."
},
"list_tasks": {
"type": "operation",
"method": "GET",
"path": "/tasks",
"summary": "List tasks",
"description": "List a task."
},
"sub_entity_id": {
"type": "parameter",
"in": "query",
"description": "Search tasks by sub entity ID."
},
"owner_id": {
"type": "schema",
"module": "tasks",
"description": "ID of the owner of the task."
},
"client_id": {
"type": "schema",
"module": "tasks",
"description": "ID of the client associated with the task."
},
"parent_status": {
"type": "schema",
"module": "tasks",
"description": "Parent status of the task."
},
"priority": {
"type": "schema",
"module": "tasks",
"description": "Priority of the task. Allowed values are normal, low, high, lowest and highest"
},
"title": {
"type": "schema",
"module": "tasks",
"description": "Title of the task."
},
"task_description": {
"type": "schema",
"module": "tasks",
"description": "Description of the task."
},
"is_overdue": {
"type": "schema",
"module": "tasks",
"description": "Indicates whether the task is overdue."
},
"created_by": {
"type": "parameter",
"in": "query",
"description": "Search tasks by the person who created them."
},
"is_accountant_task": {
"type": "schema",
"module": "tasks",
"description": "Indicates whether the task is an accountant task."
},
"contact_ids": {
"type": "parameter",
"in": "query",
"description": "Search tasks by contact IDs separated by comma."
},
"client_ids": {
"type": "parameter",
"in": "query",
"description": "Search tasks by client IDs separated by comma."
},
"owner_ids": {
"type": "schema",
"module": "tasks",
"description": "Comma separated list of owner IDs of the task."
},
"task_number": {
"type": "schema",
"module": "tasks",
"description": "Unique number assigned to the task."
},
"update_tasks": {
"type": "operation",
"method": "PUT",
"path": "/tasks",
"summary": "Update tasks",
"description": "Update tasks."
},
"bulk_update": {
"type": "parameter",
"in": "query",
"description": "Indicate whether the request is for bulk update. Allowed values are true and false."
},
"delete_tasks": {
"type": "operation",
"method": "DELETE",
"path": "/tasks",
"summary": "Delete tasks",
"description": "Delete tasks."
},
"task_ids": {
"type": "parameter",
"in": "query",
"description": "Comma separated list of task IDs to be deleted."
},
"get_task": {
"type": "operation",
"method": "GET",
"path": "/tasks/{task_id}",
"summary": "Get a task",
"description": "Get a task."
},
"update_a_task": {
"type": "operation",
"method": "PUT",
"path": "/tasks/{task_id}",
"summary": "Update a tasks",
"description": "Update a tasks."
},
"delete_task": {
"type": "operation",
"method": "DELETE",
"path": "/tasks/{task_id}",
"summary": "Delete a tasks",
"description": "Delete a tasks."
},
"update_percentage_task": {
"type": "operation",
"method": "POST",
"path": "/tasks/{task_id}/percentage",
"summary": "Update completed percentage",
"description": "Update completed percentage of a task."
},
"mark_task_as_open": {
"type": "operation",
"method": "POST",
"path": "/tasks/{task_id}/markasopen",
"summary": "Mark task as open",
"description": "Mark a task as open."
},
"mark_task_as_ongoing": {
"type": "operation",
"method": "POST",
"path": "/tasks/{task_id}/markasongoing",
"summary": "Mark task as ongoing",
"description": "Mark a task as ongoing."
},
"mark_task_as_completed": {
"type": "operation",
"method": "POST",
"path": "/tasks/{task_id}/markascompleted",
"summary": "Mark task as completed",
"description": "Mark a task as completed."
},
"add_task_comment": {
"type": "operation",
"method": "POST",
"path": "/tasks/{task_id}/comments",
"summary": "Add comment to task",
"description": "Add comment to a task."
},
"list_task_comments": {
"type": "operation",
"method": "GET",
"path": "/tasks/{task_id}/comments",
"summary": "List comments of task",
"description": "List comments of a task."
},
"delete_task_comment": {
"type": "operation",
"method": "DELETE",
"path": "/tasks/{task_id}/comments/{comment_id}",
"summary": "Delete comment of task",
"description": "Delete a comment of a task."
},
"add_task_attachment": {
"type": "operation",
"method": "POST",
"path": "/tasks/{task_id}/attachment",
"summary": "Add attachment to task",
"description": "Add attachment to a task."
},
"get_task_document": {
"type": "operation",
"method": "GET",
"path": "/tasks/{task_id}/documents/{document_id}",
"summary": "Get document of task",
"description": "Get a document of a task."
},
"delete_task_document": {
"type": "operation",
"method": "DELETE",
"path": "/tasks/{task_id}/documents/{document_id}",
"summary": "Delete document of task",
"description": "Delete a document of a task."
},
"task_id": {
"type": "schema",
"module": "tasks",
"description": "ID of the task."
},
"recurring_task_id": {
"type": "schema",
"module": "tasks",
"description": "ID of the recurring task."
},
"owner_name": {
"type": "schema",
"module": "tasks",
"description": "Name of the owner of the task."
},
"owners": {
"type": "schema",
"module": "tasks",
"description": "List of owners of the task."
},
"due_date_formatted": {
"type": "schema",
"module": "tasks",
"description": "Formatted due date of the task."
},
"color_code": {
"type": "schema",
"module": "tasks",
"description": "Color code of the task."
},
"parent_task_id": {
"type": "schema",
"module": "tasks",
"description": "ID of the parent task."
},
"related_entity_id": {
"type": "schema",
"module": "tasks",
"description": "ID of the related entity associated with the task."
},
"related_entity_type": {
"type": "schema",
"module": "tasks",
"description": "Type of the related entity associated with the task."
},
"related_entity": {
"type": "schema",
"module": "tasks",
"description": "Unique value assigned to each entity."
},
"related_entity_value": {
"type": "schema",
"module": "tasks",
"description": "Value of the related entity associated with the task."
},
"custom_status_id": {
"type": "schema",
"module": "tasks",
"description": "ID of the custom status of the task."
},
"billing_type": {
"type": "schema",
"module": "tasks",
"description": "Billing type of the task."
},
"is_billable": {
"type": "schema",
"module": "tasks",
"description": "Indicates whether the task is billable."
},
"task_rate": {
"type": "schema",
"module": "tasks",
"description": "Rate of the task."
},
"completion_percentage": {
"type": "schema",
"module": "tasks",
"description": "Completion percentage of the task."
},
"is_subtask": {
"type": "schema",
"module": "tasks",
"description": "Indicates whether the task is a subtask."
},
"reminder": {
"type": "schema",
"module": "tasks",
"description": "Details of the reminder set for the task."
},
"reminder.remind_before": {
"type": "property",
"dataType": "integer",
"description": "Number of days, months or years before the task due date to send a reminder."
},
"reminder.remind_at": {
"type": "property",
"dataType": "string",
"description": "Specific date to send the reminder."
},
"reminder.remind_at_formatted": {
"type": "property",
"dataType": "string",
"description": "Formatted date to send the reminder."
},
"reminder.remind_type": {
"type": "property",
"dataType": "string",
"description": "Type of reminder which can be days, months or years."
},
"reminder.remind_type_formatted": {
"type": "property",
"dataType": "string",
"description": "Formatted type of reminder which can be days, months or years."
},
"reminder.alert_type": {
"type": "property",
"dataType": "string",
"description": "Type of alert for the reminder."
},
"reminder.alert_type_formatted": {
"type": "property",
"dataType": "string",
"description": "Formatted type of alert for the reminder."
},
"send_email_notification": {
"type": "schema",
"module": "tasks",
"description": "Indicates whether to send email notification for the task."
},
"mail_id": {
"type": "schema",
"module": "tasks",
"description": "Email ID to which the notification has to be sent."
},
"email_account_type": {
"type": "schema",
"module": "tasks",
"description": "Email account type to which the notification has to be sent."
},
"email_folder_id": {
"type": "schema",
"module": "tasks",
"description": "Folder ID of the email account to which the notification has to be sent."
},
"email_account_id": {
"type": "schema",
"module": "tasks",
"description": "Email account ID to which the notification has to be sent."
},
"mail_attachments": {
"type": "schema",
"module": "tasks",
"description": "List of attachments to be sent along with the email notification."
},
"task_type": {
"type": "schema",
"module": "tasks",
"description": "Type of the task."
},
"is_sub_task": {
"type": "schema",
"module": "tasks",
"description": "Indicates whether the task is a sub task."
},
"subtask_count": {
"type": "schema",
"module": "tasks",
"description": "Number of subtasks under the task."
},
"related_sub_entity_id": {
"type": "schema",
"module": "tasks",
"description": "ID of the related sub entity associated with the task."
},
"related_sub_entity_type": {
"type": "schema",
"module": "tasks",
"description": "Type of the related sub entity associated with the task."
},
"client_name": {
"type": "schema",
"module": "tasks",
"description": "Name of the client associated with the task."
},
"task_number_prefix": {
"type": "schema",
"module": "tasks",
"description": "Prefix of the task number."
},
"task_number_suffix": {
"type": "schema",
"module": "tasks",
"description": "Suffix of the task number."
},
"can_push": {
"type": "schema",
"module": "tasks",
"description": "Indicates if the task can be sync to client"
},
"last_modified_by_id": {
"type": "schema",
"module": "tasks",
"description": "ID of the user who last modified the task."
},
"created_time_formatted": {
"type": "schema",
"module": "tasks",
"description": "Formatted creation time of the task."
},
"due_after": {
"type": "schema",
"module": "tasks",
"description": "Number of days after which the task is due."
},
"parent_task_name": {
"type": "schema",
"module": "tasks",
"description": "Name of the parent task."
},
"parent_task_number": {
"type": "schema",
"module": "tasks",
"description": "Number of the parent task."
},
"created_by_name": {
"type": "schema",
"module": "tasks",
"description": "Name of the user who created the task."
},
"can_show_in_portal": {
"type": "schema",
"module": "tasks",
"description": "Indicates whether the document can be shown in the customer portal."
},
"document": {
"type": "schema",
"module": "tasks",
"description": "Details of the document attached to the task."
},
"document.can_show_in_portal": {
"type": "property",
"dataType": "string",
"description": ""
},
"document.file_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"document.file_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"document.file_size": {
"type": "property",
"dataType": "string",
"description": ""
},
"document.file_size_formatted": {
"type": "property",
"dataType": "string",
"description": ""
},
"document.document_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"document.attachment_order": {
"type": "property",
"dataType": "string",
"description": ""
},
"statuses": {
"type": "schema",
"module": "tasks",
"description": "List of statuses for the task."
},
"is_system_task": {
"type": "schema",
"module": "tasks",
"description": "Indicates whether the task is a system task."
},
"system_task_type": {
"type": "schema",
"module": "tasks",
"description": "Type of the system task."
},
"comment": {
"type": "schema",
"module": "tasks",
"description": "Comment on the task."
},
"comment.comment_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"comment.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"comment.commented_by_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"comment.commented_by": {
"type": "property",
"dataType": "string",
"description": ""
},
"comment.comment_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"comment.date": {
"type": "property",
"dataType": "string",
"description": "Date when the comment was made."
},
"comment.date_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"comment.time": {
"type": "property",
"dataType": "string",
"description": ""
},
"comment.operation_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"comment.transaction_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"comment.transaction_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"parent_id": {
"type": "schema",
"module": "tasks",
"description": "ID of the parent task."
},
"entity_tags": {
"type": "schema",
"module": "tasks",
"description": "List of tags associated with the task."
},
"dependencies": {
"type": "schema",
"module": "tasks",
"description": "List of dependencies for the task."
},
"gendoc-attributes-schema.task_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.recurring_task_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.owner_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.owner_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.owner_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.owners": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.title": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.due_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.due_date_formatted": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.is_overdue": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.contact_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.contact_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.color_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.contact_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.parent_task_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.related_entity_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.related_entity_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.related_entity": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.related_entity_value": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.parent_status": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.custom_status_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.billing_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.is_billable": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.task_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.completion_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.is_subtask": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.priority": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.reminder": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.task_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.is_accountant_task": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.task_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.task_number_prefix": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.task_number_suffix": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.can_push": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.created_by_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.last_modified_by_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.due_after": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.parent_task_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.parent_task_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"gendoc-attributes-schema.created_by_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request": {
"type": "schema",
"module": "tasks",
"description": ""
},
"add-a-task-request.task_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.owner_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.owner_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.task_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.title": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.due_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.contact_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.contact_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.can_push": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.related_entity_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.related_entity_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.related_sub_entity_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.related_sub_entity_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.billing_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.is_billable": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.task_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.completion_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.priority": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.send_email_notification": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.mail_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.email_account_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.email_folder_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.email_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.mail_attachments": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.reminder": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.task_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.custom_fields": {
"type": "property",
"dataType": "array",
"description": "List of custom fields associated with the task"
},
"add-a-task-request.due_after": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.task_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.task_number_prefix": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.task_number_suffix": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.recurring_task_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.is_sub_task": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.parent_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.dependencies": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-request.entity_tags": {
"type": "property",
"dataType": "array",
"description": "List of tags to be associated with the task."
},
"add-a-task-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"add-a-task-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"add-a-task-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-a-task-response.task": {
"type": "property",
"dataType": "object",
"description": ""
},
"list-tasks-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"list-tasks-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-tasks-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-tasks-response.tasks": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-tasks-request": {
"type": "schema",
"module": "tasks",
"description": "List of tasks to be updated."
},
"update-tasks-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"update-tasks-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-tasks-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-tasks-response.tasks": {
"type": "property",
"dataType": "array",
"description": ""
},
"delete-tasks-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"delete-tasks-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-tasks-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-task-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"get-a-task-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-task-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-task-response.task": {
"type": "property",
"dataType": "object",
"description": ""
},
"update-a-task-request": {
"type": "schema",
"module": "tasks",
"description": ""
},
"update-a-task-request.task_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.owner_ids": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.owner_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.task_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.title": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.due_date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.contact_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.contact_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.can_push": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.related_entity_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.related_entity_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.related_sub_entity_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.related_sub_entity_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.billing_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.is_billable": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.task_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.completion_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.priority": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.send_email_notification": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.mail_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.email_account_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.email_folder_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.email_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.mail_attachments": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.reminder": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.task_description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.custom_fields": {
"type": "property",
"dataType": "array",
"description": "List of custom fields associated with the task"
},
"update-a-task-request.due_after": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.template_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.task_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.task_number_prefix": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.task_number_suffix": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.recurring_task_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.is_sub_task": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.parent_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.dependencies": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-request.entity_tags": {
"type": "property",
"dataType": "array",
"description": "List of tags to be associated with the task."
},
"update-a-task-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"update-a-task-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-task-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-task-response.task": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-task-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"delete-a-task-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-task-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-percentage-task-request": {
"type": "schema",
"module": "tasks",
"description": ""
},
"update-percentage-task-request.completion_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-percentage-task-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"update-percentage-task-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-percentage-task-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-percentage-task-response.task": {
"type": "property",
"dataType": "object",
"description": ""
},
"mark-open-task-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"mark-open-task-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-open-task-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-ongoing-task-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"mark-ongoing-task-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-ongoing-task-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-completed-task-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"mark-completed-task-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-completed-task-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-task-comment-request": {
"type": "schema",
"module": "tasks",
"description": ""
},
"add-task-comment-request.description": {
"type": "property",
"dataType": "string",
"description": "Description of the comment."
},
"add-task-comment-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"add-task-comment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"add-task-comment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-task-comment-response.comment": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-task-comments-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"list-task-comments-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-task-comments-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-task-comments-response.comments": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-task-comment-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"delete-task-comment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-task-comment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-task-attachment-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"add-task-attachment-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"add-task-attachment-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"add-task-attachment-response.documents": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-task-document-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"get-a-task-document-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-task-document-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-task-document-response.documents": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-task-document-response": {
"type": "schema",
"module": "tasks",
"description": ""
},
"delete-task-document-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-task-document-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create_tax": {
"type": "operation",
"method": "POST",
"path": "/settings/taxes",
"summary": "Create a tax",
"description": "Create a tax which can be associated with an item."
},
"list_taxes": {
"type": "operation",
"method": "GET",
"path": "/settings/taxes",
"summary": "List taxes",
"description": "List of simple and compound taxes with pagination."
},
"update_tax": {
"type": "operation",
"method": "PUT",
"path": "/settings/taxes/{tax_id}",
"summary": "Update a tax",
"description": "Update the details of a simple or compound tax."
},
"get_tax": {
"type": "operation",
"method": "GET",
"path": "/settings/taxes/{tax_id}",
"summary": "Get a tax",
"description": "Get the details of a simple or compound tax."
},
"delete_tax": {
"type": "operation",
"method": "DELETE",
"path": "/settings/taxes/{tax_id}",
"summary": "Delete a tax",
"description": "Delete a simple or compound tax."
},
"get_tax_group": {
"type": "operation",
"method": "GET",
"path": "/settings/taxgroups/{tax_group_id}",
"summary": "Get a tax group",
"description": "Get the details of a tax group."
},
"update_tax_group": {
"type": "operation",
"method": "PUT",
"path": "/settings/taxgroups/{tax_group_id}",
"summary": "Update a tax group",
"description": "Update the details of the tax group."
},
"delete_tax_group": {
"type": "operation",
"method": "DELETE",
"path": "/settings/taxgroups/{tax_group_id}",
"summary": "Delete a tax group",
"description": "Delete a tax group. Tax group that is associated to transactions cannot be deleted."
},
"create_tax_group": {
"type": "operation",
"method": "POST",
"path": "/settings/taxgroups",
"summary": "Create a tax group",
"description": "Create a tax group associating multiple taxes."
},
"create_tax_authority": {
"type": "operation",
"method": "POST",
"path": "/settings/taxauthorities",
"summary": "Create a tax authority [US and CA Edition only]",
"description": "Create a tax authority."
},
"list_tax_authorities": {
"type": "operation",
"method": "GET",
"path": "/settings/taxauthorities",
"summary": "List tax authorities [US Edition only]",
"description": "List of tax authorities."
},
"update_tax_authority": {
"type": "operation",
"method": "PUT",
"path": "/settings/taxauthorities/{tax_authority_id}",
"summary": "Update a tax authority [US and CA Edition only]",
"description": "Update the details of a tax authority."
},
"get_tax_authority": {
"type": "operation",
"method": "GET",
"path": "/settings/taxauthorities/{tax_authority_id}",
"summary": "Get a tax authority [US and CA Edition only]",
"description": "Get the details of a tax authority."
},
"delete_tax_authority": {
"type": "operation",
"method": "DELETE",
"path": "/settings/taxauthorities/{tax_authority_id}",
"summary": "Delete a tax authority [US and CA Edition only]",
"description": "Delete a tax authority."
},
"create_tax_exemption": {
"type": "operation",
"method": "POST",
"path": "/settings/taxexemptions",
"summary": "Create a tax exemption [US Edition only]",
"description": "Create a tax exemption."
},
"list_tax_exemptions": {
"type": "operation",
"method": "GET",
"path": "/settings/taxexemptions",
"summary": "List tax exemptions [US Edition only]",
"description": "List of tax exemptions."
},
"update_tax_exemption": {
"type": "operation",
"method": "PUT",
"path": "/settings/taxexemptions/{tax_exemption_id}",
"summary": "Update a tax exemption [US Edition only]",
"description": "Update the details of a tax exemption."
},
"get_tax_exemption": {
"type": "operation",
"method": "GET",
"path": "/settings/taxexemptions/{tax_exemption_id}",
"summary": "Get a tax exemption [US Edition only]",
"description": "Get the details of a tax exemption."
},
"delete_tax_exemption": {
"type": "operation",
"method": "DELETE",
"path": "/settings/taxexemptions/{tax_exemption_id}",
"summary": "Delete a tax exemption [US Edition only]",
"description": "Delete a tax exemption."
},
"tax-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"tax-response.tax_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax-response.tax_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax-response.tax_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax-response.tax_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax-response.tax_factor": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax-response.tds_payable_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax-response.tax_authority_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax-response.tax_authority_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax-response.is_value_added": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax-response.tax_specific_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax-response.country": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax-response.country_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax-response.purchase_tax_expense_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"purchase_tax_expense_account_id": {
"type": "schema",
"module": "taxes",
"description": "Account ID in which Purchase Tax will be Computed"
},
"tax_factor": {
"type": "schema",
"module": "taxes",
"description": "Tax Factor"
},
"output_tax_account_name": {
"type": "schema",
"module": "taxes",
"description": ""
},
"purchase_tax_account_name": {
"type": "schema",
"module": "taxes",
"description": ""
},
"purchase_tax_account_id": {
"type": "schema",
"module": "taxes",
"description": "ID of the tax account, in case of withholding tax."
},
"tds_payable_account_id": {
"type": "schema",
"module": "taxes",
"description": "Input Tax ID. The amount of money charged to you as Tax on your purchases."
},
"tax_account_tracking": {
"type": "schema",
"module": "taxes",
"description": ""
},
"tax_group_id": {
"type": "schema",
"module": "taxes",
"description": "the id of the tax group"
},
"tax_group_name": {
"type": "schema",
"module": "taxes",
"description": "Name of the tax group to be created."
},
"tax_group_percentage": {
"type": "schema",
"module": "taxes",
"description": "Number of percentage taxable."
},
"is_value_added": {
"type": "schema",
"module": "taxes",
"description": "Check if Tax is Value Added"
},
"tax_specific_type": {
"type": "schema",
"module": "taxes",
"description": "Type of Tax For Indian Edition. Allowed Values : igst ,cgst ,sgst ,nil, cess .Type of Tax for Mexico Edition. Allowed Values : isr, iva, ieps."
},
"is_default_tax": {
"type": "schema",
"module": "taxes",
"description": "Check if Tax is default"
},
"registration_number": {
"type": "schema",
"module": "taxes",
"description": "Registration Number of the Tax Authority"
},
"registration_number_label": {
"type": "schema",
"module": "taxes",
"description": "The registration number label of the tax authority"
},
"tax_authority": {
"type": "schema",
"module": "taxes",
"description": ""
},
"tax_authority.tax_authority_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax_authority.tax_authority_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax_authority.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax_authority.registration_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax_authority.registration_number_label": {
"type": "property",
"dataType": "string",
"description": ""
},
"is_editable": {
"type": "schema",
"module": "taxes",
"description": "To check if tax/tax rate is editable"
},
"update_draft_invoice": {
"type": "schema",
"module": "taxes",
"description": "Check if Draft Invoices should be updated"
},
"update_draft_so": {
"type": "schema",
"module": "taxes",
"description": "Check if Draft Sales Orders should be updated"
},
"tax": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"create-a-tax-request": {
"type": "schema",
"module": "taxes",
"description": ""
},
"create-a-tax-request.tax_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-request.tax_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-request.tax_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-request.tax_factor": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-request.tax_specific_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-request.tax_authority_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-request.tax_authority_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-request.country_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-request.purchase_tax_expense_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-request.is_value_added": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-request.update_draft_invoice": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-request.update_draft_so": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-request.is_editable": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"create-a-tax-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-tax-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-response.tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-taxes-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"list-taxes-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-taxes-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-taxes-response.taxes": {
"type": "property",
"dataType": "array",
"description": "Comma Seperated list of tax IDs that are to be associated to the tax group."
},
"list-taxes-response.page_context": {
"type": "property",
"dataType": "object",
"description": ""
},
"update-a-tax-request": {
"type": "schema",
"module": "taxes",
"description": ""
},
"update-a-tax-request.tax_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-request.tax_percentage": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-request.tax_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-request.tax_factor": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-request.tax_specific_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-request.tax_authority_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-request.tax_authority_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-request.country_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-request.purchase_tax_expense_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-request.is_value_added": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-request.update_draft_invoice": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-request.update_draft_so": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-request.is_editable": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-request.tds_payable_account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"update-a-tax-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-tax-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-response.tax": {
"type": "property",
"dataType": "object",
"description": ""
},
"get-a-tax-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"get-a-tax-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-tax-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-tax-response.tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-a-tax-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"delete-a-tax-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-tax-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-tax-group-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"get-a-tax-group-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-tax-group-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-tax-group-response.tax_group": {
"type": "property",
"dataType": "object",
"description": ""
},
"update-a-tax-group-request": {
"type": "schema",
"module": "taxes",
"description": ""
},
"update-a-tax-group-request.tax_group_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-group-request.taxes": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-group-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"update-a-tax-group-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-tax-group-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-group-response.tax_group": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-tax-group-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"delete-a-tax-group-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-tax-group-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-group-request": {
"type": "schema",
"module": "taxes",
"description": ""
},
"create-a-tax-group-request.tax_group_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-group-request.taxes": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-group-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"create-a-tax-group-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-tax-group-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-group-response.tax_group": {
"type": "property",
"dataType": "object",
"description": ""
},
"create-a-tax-authority-us-and-ca-edition-only-request": {
"type": "schema",
"module": "taxes",
"description": ""
},
"create-a-tax-authority-us-and-ca-edition-only-request.tax_authority_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-authority-us-and-ca-edition-only-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-authority-us-and-ca-edition-only-request.registration_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-authority-us-and-ca-edition-only-request.registration_number_label": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-authority-us-and-ca-edition-only-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"create-a-tax-authority-us-and-ca-edition-only-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-tax-authority-us-and-ca-edition-only-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-authority-us-and-ca-edition-only-response.tax_authority": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-tax-authorities-us-edition-only-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"list-tax-authorities-us-edition-only-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-tax-authorities-us-edition-only-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-tax-authorities-us-edition-only-response.tax_authorities": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-a-tax-authority-us-and-ca-edition-only-request": {
"type": "schema",
"module": "taxes",
"description": ""
},
"update-a-tax-authority-us-and-ca-edition-only-request.tax_authority_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-authority-us-and-ca-edition-only-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-authority-us-and-ca-edition-only-request.registration_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-authority-us-and-ca-edition-only-request.registration_number_label": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-authority-us-and-ca-edition-only-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"update-a-tax-authority-us-and-ca-edition-only-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-tax-authority-us-and-ca-edition-only-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-authority-us-and-ca-edition-only-response.tax_authority": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-tax-authority-us-and-ca-edition-only-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"get-a-tax-authority-us-and-ca-edition-only-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-tax-authority-us-and-ca-edition-only-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-tax-authority-us-and-ca-edition-only-response.tax_authority": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-a-tax-authority-us-and-ca-edition-only-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"delete-a-tax-authority-us-and-ca-edition-only-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-tax-authority-us-and-ca-edition-only-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-exemption-us-edition-only-request": {
"type": "schema",
"module": "taxes",
"description": ""
},
"create-a-tax-exemption-us-edition-only-request.tax_exemption_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-exemption-us-edition-only-request.description": {
"type": "property",
"dataType": "string",
"description": "Description"
},
"create-a-tax-exemption-us-edition-only-request.type": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-exemption-us-edition-only-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"create-a-tax-exemption-us-edition-only-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-tax-exemption-us-edition-only-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-tax-exemption-us-edition-only-response.tax_exemption": {
"type": "property",
"dataType": "object",
"description": ""
},
"list-tax-exemptions-us-edition-only-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"list-tax-exemptions-us-edition-only-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-tax-exemptions-us-edition-only-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-tax-exemptions-us-edition-only-response.tax_exemptions": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-a-tax-exemption-us-edition-only-request": {
"type": "schema",
"module": "taxes",
"description": ""
},
"update-a-tax-exemption-us-edition-only-request.tax_exemption_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-exemption-us-edition-only-request.description": {
"type": "property",
"dataType": "string",
"description": "Description"
},
"update-a-tax-exemption-us-edition-only-request.type": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-exemption-us-edition-only-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"update-a-tax-exemption-us-edition-only-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-tax-exemption-us-edition-only-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-tax-exemption-us-edition-only-response.tax_exemption": {
"type": "property",
"dataType": "object",
"description": ""
},
"get-a-tax-exemption-us-edition-only-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"get-a-tax-exemption-us-edition-only-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-tax-exemption-us-edition-only-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-tax-exemption-us-edition-only-response.tax_exemption": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-tax-exemption-us-edition-only-response": {
"type": "schema",
"module": "taxes",
"description": ""
},
"delete-a-tax-exemption-us-edition-only-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-tax-exemption-us-edition-only-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"transferorders": {
"type": "tag",
"description": "TransferOrders Module"
},
"create_transfer_order": {
"type": "operation",
"method": "POST",
"path": "/transferorders",
"summary": "Create a transfer order",
"description": "Creates a new transfer order in Zoho Inventory."
},
"list_transfer_orders": {
"type": "operation",
"method": "GET",
"path": "/transferorders",
"summary": "List all the transfer orders",
"description": "Lists transfer orders in the Organization. Supports pagination, sort, quick search, custom view, and filters such as status, date range, warehouse or location, item, and transfer order number."
},
"from_warehouse_id": {
"type": "parameter",
"in": "query",
"description": "Filter by source warehouse ID."
},
"from_warehouse_name": {
"type": "parameter",
"in": "query",
"description": "Filter by source warehouse name."
},
"to_warehouse_id": {
"type": "parameter",
"in": "query",
"description": "Filter by destination warehouse ID."
},
"to_warehouse_name": {
"type": "parameter",
"in": "query",
"description": "Filter by destination warehouse name."
},
"from_location_id": {
"type": "schema",
"module": "transferorders",
"description": "From Location ID"
},
"from_location_name": {
"type": "schema",
"module": "transferorders",
"description": "Name of the from location"
},
"to_location_id": {
"type": "schema",
"module": "transferorders",
"description": "To Location ID"
},
"to_location_name": {
"type": "schema",
"module": "transferorders",
"description": "Name of the to location"
},
"serial_number": {
"type": "parameter",
"in": "query",
"description": "Filter by serial number."
},
"transfer_order_number": {
"type": "schema",
"module": "transferorders",
"description": "The Transfer Order number. This is unique for each transfer order. This node is optional if auto number generation is enabled for transfer order."
},
"transfer_order_number_startswith": {
"type": "parameter",
"in": "query",
"description": "Filter by transfer order numbers that start with the given value."
},
"transfer_order_number_contains": {
"type": "parameter",
"in": "query",
"description": "Filter by transfer order numbers that contain the given value."
},
"date_before": {
"type": "parameter",
"in": "query",
"description": "Filter by dates before this date. Format yyyy-mm-dd."
},
"date_after": {
"type": "parameter",
"in": "query",
"description": "Filter by dates after this date. Format yyyy-mm-dd."
},
"bulk_delete_transfer_orders": {
"type": "operation",
"method": "DELETE",
"path": "/transferorders",
"summary": "Bulk delete transfer orders",
"description": "Deletes up to 25 transfer orders in one request. Pass comma-separated transfer order IDs."
},
"transfer_order_ids": {
"type": "parameter",
"in": "query",
"description": "Comma-separated list of transfer order IDs to delete. Minimum 1 and maximum 25 IDs."
},
"get_transfer_order": {
"type": "operation",
"method": "GET",
"path": "/transferorders/{transfer_order_id}",
"summary": "Retrieve a transfer order",
"description": "Fetches the details for an existing transfer order."
},
"update_transfer_order": {
"type": "operation",
"method": "PUT",
"path": "/transferorders/{transfer_order_id}",
"summary": "Update a transfer order",
"description": "Update an existing transfer order from Zoho Inventory."
},
"delete_transfer_order": {
"type": "operation",
"method": "DELETE",
"path": "/transferorders/{transfer_order_id}",
"summary": "Delete a transfer order",
"description": "Deletes an existing transfer order from Zoho Inventory."
},
"mark_transfer_order_as_received": {
"type": "operation",
"method": "POST",
"path": "/transferorders/{transfer_order_id}/markastransferred",
"summary": "Mark as Received",
"description": "Marks the transfer order as transferred for the Organization. You must pass the transferred date."
},
"mark_transfer_order_in_transit": {
"type": "operation",
"method": "POST",
"path": "/transferorders/{transfer_order_id}/intransit",
"summary": "Mark transfer order as in transit",
"description": "Marks the transfer order as in transit. Optionally specify whether prices are tax inclusive."
},
"is_tax_inclusive": {
"type": "parameter",
"in": "query",
"description": "Whether prices are inclusive of tax. Allowed values are true and false. This need to be passed only for IN edition org when marking inter GSTIN transfer order as in transit."
},
"submit_transferorder": {
"type": "operation",
"method": "POST",
"path": "/transferorders/{transfer_order_id}/submit",
"summary": "Submit a transfer order for approval",
"description": "Submit a transfer order for approval workflow."
},
"transfer_order_id": {
"type": "schema",
"module": "transferorders",
"description": "Unique ID generated by the server for the Transfer Order. This is used as identifier."
},
"approve_transferorder": {
"type": "operation",
"method": "POST",
"path": "/transferorders/{transfer_order_id}/approve",
"summary": "Approve a transfer order",
"description": "Approve a submitted transfer order."
},
"approve_transfer_order_final": {
"type": "operation",
"method": "POST",
"path": "/transferorders/{transfer_order_id}/approve/final",
"summary": "Final approval of a transfer order",
"description": "Perform the final approval of a transfer order (admin only)."
},
"reject_transferorder": {
"type": "operation",
"method": "POST",
"path": "/transferorders/{transfer_order_id}/reject",
"summary": "Reject a transfer order",
"description": "Reject a submitted transfer order."
},
"transfer_order-response": {
"type": "schema",
"module": "transferorders",
"description": ""
},
"transfer_order-response.transfer_order_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"transfer_order-response.transfer_order_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"transfer_order-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"transfer_order-response.from_location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"transfer_order-response.from_location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"transfer_order-response.to_location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"transfer_order-response.to_location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"transfer_order-response.line_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"transfer_order-response.is_intransit_order": {
"type": "property",
"dataType": "string",
"description": ""
},
"transfer_order-response.description": {
"type": "property",
"dataType": "string",
"description": "Notes or internal description for the transfer order."
},
"transfer_order-response.status": {
"type": "property",
"dataType": "string",
"description": "Current status of the transfer order."
},
"transfer_order-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"quantity_transfer": {
"type": "schema",
"module": "transferorders",
"description": "Quantity of the line item to be transferred."
},
"is_intransit_order": {
"type": "schema",
"module": "transferorders",
"description": "It states whether the transfer order is in transit or transferred.The default value is false."
},
"from_storages": {
"type": "schema",
"module": "transferorders",
"description": "Source bin/storage locations for the line item. Applicable only for items with bin tracking enabled."
},
"to_storages": {
"type": "schema",
"module": "transferorders",
"description": "Destination bin/storage locations for the line item. Applicable only for items with bin tracking enabled."
},
"from_storages-update": {
"type": "schema",
"module": "transferorders",
"description": "Source bin/storage locations for the line item. Applicable only for items with bin tracking enabled."
},
"to_storages-update": {
"type": "schema",
"module": "transferorders",
"description": "Destination bin/storage locations for the line item. Applicable only for items with bin tracking enabled."
},
"create-a-transfer-order-request": {
"type": "schema",
"module": "transferorders",
"description": ""
},
"create-a-transfer-order-request.transfer_order_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-transfer-order-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-transfer-order-request.description": {
"type": "property",
"dataType": "string",
"description": "Notes or internal description for the transfer order. Max-length 500."
},
"create-a-transfer-order-request.from_warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Source warehouse ID when multi-warehouse is enabled."
},
"create-a-transfer-order-request.to_warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Destination warehouse ID when multi-warehouse is enabled."
},
"create-a-transfer-order-request.from_location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-transfer-order-request.to_location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-transfer-order-request.line_items": {
"type": "property",
"dataType": "array",
"description": "A transfer can contain multiple line items. Each line item contains item_id,name,description,quantity_transfer,unit."
},
"create-a-transfer-order-request.is_intransit_order": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-transfer-order-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-transfer-order-response": {
"type": "schema",
"module": "transferorders",
"description": ""
},
"create-a-transfer-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-transfer-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-transfer-order-response.transfer_order": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-the-transfer-orders-response": {
"type": "schema",
"module": "transferorders",
"description": ""
},
"list-all-the-transfer-orders-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-all-the-transfer-orders-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-all-the-transfer-orders-response.page_context": {
"type": "property",
"dataType": "object",
"description": "Pagination and sort context for the list."
},
"list-all-the-transfer-orders-response.transfer_orders": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-a-transfer-order-request": {
"type": "schema",
"module": "transferorders",
"description": ""
},
"update-a-transfer-order-request.transfer_order_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-transfer-order-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-transfer-order-request.description": {
"type": "property",
"dataType": "string",
"description": "Notes or internal description for the transfer order. Max-length 500."
},
"update-a-transfer-order-request.from_warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Source warehouse ID when multi-warehouse is enabled."
},
"update-a-transfer-order-request.to_warehouse_id": {
"type": "property",
"dataType": "string",
"description": "Destination warehouse ID when multi-warehouse is enabled."
},
"update-a-transfer-order-request.from_location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-transfer-order-request.to_location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-transfer-order-request.line_items": {
"type": "property",
"dataType": "array",
"description": "A transfer can contain multiple line items. Each line item contains item_id,name,description,quantity_transfer,unit."
},
"update-a-transfer-order-request.is_intransit_order": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-transfer-order-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-transfer-order-response": {
"type": "schema",
"module": "transferorders",
"description": ""
},
"update-a-transfer-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-transfer-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-transfer-order-response.transfer_order": {
"type": "property",
"dataType": "object",
"description": ""
},
"retrieve-a-transfer-order-response": {
"type": "schema",
"module": "transferorders",
"description": ""
},
"retrieve-a-transfer-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"retrieve-a-transfer-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"retrieve-a-transfer-order-response.transfer_order": {
"type": "property",
"dataType": "object",
"description": ""
},
"retrieve-a-transfer-order-response.locations": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-transfer-order-response": {
"type": "schema",
"module": "transferorders",
"description": ""
},
"delete-a-transfer-order-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-transfer-order-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-as-received-response": {
"type": "schema",
"module": "transferorders",
"description": ""
},
"mark-as-received-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-as-received-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-in-transit-response": {
"type": "schema",
"module": "transferorders",
"description": ""
},
"mark-in-transit-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-in-transit-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"bulk-delete-transfer-orders-response": {
"type": "schema",
"module": "transferorders",
"description": ""
},
"bulk-delete-transfer-orders-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"bulk-delete-transfer-orders-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"unit_of_measurement": {
"type": "tag",
"description": "Units of Measurement Module"
},
"create_unit_group": {
"type": "operation",
"method": "POST",
"path": "/unitgroups",
"summary": "Create a unit group",
"description": "Creates a new unit group in Zoho Inventory."
},
"list_unit_groups": {
"type": "operation",
"method": "GET",
"path": "/unitgroups",
"summary": "List all unit groups",
"description": "Lists all the unit groups configured in Zoho Inventory."
},
"get_unit_group": {
"type": "operation",
"method": "GET",
"path": "/unitgroups/{unit_group_id}",
"summary": "Retrieve a unit group",
"description": "Fetches the details of an existing unit group."
},
"update_unit_group": {
"type": "operation",
"method": "PUT",
"path": "/unitgroups/{unit_group_id}",
"summary": "Update a unit group",
"description": "Updates the details of an existing unit group."
},
"delete_unit_group": {
"type": "operation",
"method": "DELETE",
"path": "/unitgroups/{unit_group_id}",
"summary": "Delete a unit group",
"description": "Deletes an existing unit group from Zoho Inventory."
},
"create_unit": {
"type": "operation",
"method": "POST",
"path": "/units",
"summary": "Create a unit",
"description": "Creates a new unit in Zoho Inventory."
},
"list_units": {
"type": "operation",
"method": "GET",
"path": "/units",
"summary": "List all units",
"description": "Lists all the units configured in Zoho Inventory."
},
"include_unit_conversions": {
"type": "parameter",
"in": "query",
"description": "If true, includes the unit conversions for each unit in the response."
},
"update_unit": {
"type": "operation",
"method": "PUT",
"path": "/units/{unit_id}",
"summary": "Update a unit",
"description": "Updates the details of an existing unit."
},
"delete_unit": {
"type": "operation",
"method": "DELETE",
"path": "/units/{unit_id}",
"summary": "Delete a unit",
"description": "Deletes an existing unit from Zoho Inventory."
},
"create_unit_conversion": {
"type": "operation",
"method": "POST",
"path": "/units/{unit_id}/unitconversions",
"summary": "Create a unit conversion",
"description": "Creates a new unit conversion for a unit."
},
"list_unit_conversions": {
"type": "operation",
"method": "GET",
"path": "/units/{unit_id}/unitconversions",
"summary": "List unit conversions",
"description": "Lists all the unit conversions for a unit."
},
"update_unit_conversion": {
"type": "operation",
"method": "PUT",
"path": "/units/{unit_id}/unitconversions/{unit_conversion_id}",
"summary": "Update a unit conversion",
"description": "Updates an existing unit conversion for a unit."
},
"delete_unit_conversion": {
"type": "operation",
"method": "DELETE",
"path": "/units/{unit_id}/unitconversions/{unit_conversion_id}",
"summary": "Delete a unit conversion",
"description": "Deletes an existing unit conversion from a unit."
},
"unit-group-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"unit-group-response.unit_group_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the unit group."
},
"unit-group-response.unit_group_name": {
"type": "property",
"dataType": "string",
"description": "Name of the unit group."
},
"unit-group-response.base_unit_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the base unit in the unit group."
},
"unit-group-response.base_unit_name": {
"type": "property",
"dataType": "string",
"description": "Name of the base unit."
},
"unit-group-response.base_unit": {
"type": "property",
"dataType": "string",
"description": "Short code of the base unit."
},
"unit-group-response.base_unit_decimal": {
"type": "property",
"dataType": "integer",
"description": "Number of decimal places for the base unit."
},
"unit-group-response.unit_conversions": {
"type": "property",
"dataType": "array",
"description": "List of unit conversions in the unit group."
},
"unit-conversion-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"unit-conversion-response.unit_conversion_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the unit conversion."
},
"unit-conversion-response.target_unit_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the target unit."
},
"unit-conversion-response.conversion_rate": {
"type": "property",
"dataType": "number",
"description": "Conversion rate from the base unit to the target unit."
},
"unit-conversion-response.target_unit_name": {
"type": "property",
"dataType": "string",
"description": "Name of the target unit."
},
"unit-conversion-response.target_unit": {
"type": "property",
"dataType": "string",
"description": "Short code of the target unit."
},
"unit-conversion-response.quantity_decimal_place": {
"type": "property",
"dataType": "integer",
"description": "Number of decimal places for the target unit."
},
"unit-groups-page-context": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"unit-groups-page-context.page": {
"type": "property",
"dataType": "integer",
"description": "Current page number."
},
"unit-groups-page-context.per_page": {
"type": "property",
"dataType": "integer",
"description": "Number of records per page."
},
"unit-groups-page-context.has_more_page": {
"type": "property",
"dataType": "boolean",
"description": "Indicates whether more pages are available."
},
"unit-groups-page-context.sort_column": {
"type": "property",
"dataType": "string",
"description": "Column by which the results are sorted."
},
"unit-groups-page-context.sort_order": {
"type": "property",
"dataType": "string",
"description": "Order in which the results are sorted."
},
"list-unit-groups-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"list-unit-groups-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-unit-groups-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-unit-groups-response.unit_groups": {
"type": "property",
"dataType": "array",
"description": ""
},
"list-unit-groups-response.page_context": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-unit-group-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"get-unit-group-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-unit-group-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-unit-group-response.unit_group": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-unit-group-request": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"create-unit-group-request.unit_group_name": {
"type": "property",
"dataType": "string",
"description": "Name of the unit group."
},
"create-unit-group-request.base_unit_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the base unit for the unit group."
},
"create-unit-group-request.unit_conversions": {
"type": "property",
"dataType": "array",
"description": "List of unit conversions to add to the unit group."
},
"create-unit-group-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"create-unit-group-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-unit-group-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-unit-group-response.unit_group": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-unit-group-request": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"update-unit-group-request.unit_group_name": {
"type": "property",
"dataType": "string",
"description": "Name of the unit group."
},
"update-unit-group-request.base_unit_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the base unit for the unit group."
},
"update-unit-group-request.unit_conversions": {
"type": "property",
"dataType": "array",
"description": "List of unit conversions in the unit group."
},
"update-unit-group-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"update-unit-group-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-unit-group-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-unit-group-response.unit_group": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-unit-group-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"delete-unit-group-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-unit-group-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"unit-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"unit-response.unit_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID generated by the server for the unit."
},
"unit-response.name": {
"type": "property",
"dataType": "string",
"description": "Name of the unit."
},
"unit-response.unit": {
"type": "property",
"dataType": "string",
"description": "Short code of the unit."
},
"unit-response.uqc": {
"type": "property",
"dataType": "string",
"description": "Unique Quantity Code of the unit."
},
"unit-response.quantity_decimal_place": {
"type": "property",
"dataType": "integer",
"description": "Number of decimal places for the unit."
},
"unit-response.unit_conversions": {
"type": "property",
"dataType": "array",
"description": "List of unit conversions for this unit. Returned only when include_unit_conversions is true."
},
"unit-conversion-detail-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"unit-conversion-detail-response.unit_conversion_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the unit conversion."
},
"unit-conversion-detail-response.target_unit_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the target unit."
},
"unit-conversion-detail-response.conversion_rate": {
"type": "property",
"dataType": "number",
"description": "Conversion rate from the base unit to the target unit."
},
"unit-conversion-detail-response.target_unit": {
"type": "property",
"dataType": "string",
"description": "Short code of the target unit."
},
"list-units-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"list-units-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-units-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-units-response.units": {
"type": "property",
"dataType": "array",
"description": ""
},
"create-unit-request": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"create-unit-request.name": {
"type": "property",
"dataType": "string",
"description": "Name of the unit."
},
"create-unit-request.unit": {
"type": "property",
"dataType": "string",
"description": "Short code of the unit."
},
"create-unit-request.uqc": {
"type": "property",
"dataType": "string",
"description": "Unique Quantity Code of the unit."
},
"create-unit-request.quantity_decimal_place": {
"type": "property",
"dataType": "integer",
"description": "Number of decimal places for the unit."
},
"create-unit-request.unit_conversions": {
"type": "property",
"dataType": "array",
"description": "List of unit conversions to add to the unit."
},
"create-unit-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"create-unit-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-unit-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-unit-response.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-unit-request": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"update-unit-request.name": {
"type": "property",
"dataType": "string",
"description": "Name of the unit."
},
"update-unit-request.unit": {
"type": "property",
"dataType": "string",
"description": "Short code of the unit."
},
"update-unit-request.uqc": {
"type": "property",
"dataType": "string",
"description": "Unique Quantity Code of the unit."
},
"update-unit-request.quantity_decimal_place": {
"type": "property",
"dataType": "integer",
"description": "Number of decimal places for the unit."
},
"update-unit-request.unit_conversions": {
"type": "property",
"dataType": "array",
"description": "List of unit conversions for this unit."
},
"update-unit-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"update-unit-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-unit-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-unit-response.unit": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-unit-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"delete-unit-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-unit-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-unit-conversion-request": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"create-unit-conversion-request.target_unit_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the target unit."
},
"create-unit-conversion-request.conversion_rate": {
"type": "property",
"dataType": "number",
"description": "Conversion rate from the base unit to the target unit."
},
"create-unit-conversion-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"create-unit-conversion-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-unit-conversion-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-unit-conversion-response.unit_conversion": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-unit-conversions-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"list-unit-conversions-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-unit-conversions-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-unit-conversions-response.unit_conversions": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-unit-conversion-request": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"update-unit-conversion-request.target_unit_id": {
"type": "property",
"dataType": "string",
"description": "Unique ID of the target unit."
},
"update-unit-conversion-request.conversion_rate": {
"type": "property",
"dataType": "number",
"description": "Conversion rate from the base unit to the target unit."
},
"update-unit-conversion-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"update-unit-conversion-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-unit-conversion-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-unit-conversion-response.unit_conversion": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-unit-conversion-response": {
"type": "schema",
"module": "unit_of_measurement",
"description": ""
},
"delete-unit-conversion-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-unit-conversion-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"users": {
"type": "tag",
"description": "Users Module"
},
"create_user": {
"type": "operation",
"method": "POST",
"path": "/users",
"summary": "Create a user",
"description": "Create a user for your organization."
},
"list_users": {
"type": "operation",
"method": "GET",
"path": "/users",
"summary": "List Users",
"description": "Get the list of all users in the organization."
},
"update_user": {
"type": "operation",
"method": "PUT",
"path": "/users/{user_id}",
"summary": "Update a user",
"description": "Update the details of a user."
},
"get_user": {
"type": "operation",
"method": "GET",
"path": "/users/{user_id}",
"summary": "Get a user",
"description": "Get the details of a user."
},
"delete_user": {
"type": "operation",
"method": "DELETE",
"path": "/users/{user_id}",
"summary": "Delete a user",
"description": "Delete a user associated to the organization."
},
"get_current_user": {
"type": "operation",
"method": "GET",
"path": "/users/me",
"summary": "Get current user",
"description": "Get the details of the current user."
},
"invite_user": {
"type": "operation",
"method": "POST",
"path": "/users/{user_id}/invite",
"summary": "Invite a user",
"description": "Send invitation email to a person, you wish to add as a user to your organisation. For example- an accountant."
},
"mark_user_as_active": {
"type": "operation",
"method": "POST",
"path": "/users/{user_id}/active",
"summary": "Mark user as active",
"description": "Mark an inactive user as active."
},
"mark_user_as_inactive": {
"type": "operation",
"method": "POST",
"path": "/users/{user_id}/inactive",
"summary": "Mark user as inactive",
"description": "Mark an active user as inactive."
},
"role_id": {
"type": "schema",
"module": "users",
"description": "Unique ID of the role, the user is playing"
},
"photo_url": {
"type": "schema",
"module": "users",
"description": "URL to profile photo of user."
},
"is_current_user": {
"type": "schema",
"module": "users",
"description": "to check if user is currently a part of task"
},
"is_selected": {
"type": "schema",
"module": "users",
"description": "to check is task is selected"
},
"email_ids": {
"type": "schema",
"module": "users",
"description": "Email Id's of users"
},
"is_customer_segmented": {
"type": "schema",
"module": "users",
"description": "to check if customer is segmented"
},
"is_vendor_segmented": {
"type": "schema",
"module": "users",
"description": "To check if vendor is segmented"
},
"user_type": {
"type": "schema",
"module": "users",
"description": "Type of user"
},
"is_claimant": {
"type": "schema",
"module": "users",
"description": "To check if user is a claimant"
},
"create-a-user-request": {
"type": "schema",
"module": "users",
"description": ""
},
"create-a-user-request.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-user-request.email": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-user-request.user_role": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-user-response": {
"type": "schema",
"module": "users",
"description": ""
},
"create-a-user-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-user-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-users-response": {
"type": "schema",
"module": "users",
"description": ""
},
"list-users-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-users-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-users-response.users": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-a-user-request": {
"type": "schema",
"module": "users",
"description": ""
},
"update-a-user-request.name": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-user-request.email": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-user-request.user_role": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-a-user-response": {
"type": "schema",
"module": "users",
"description": ""
},
"update-a-user-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-a-user-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-user-response": {
"type": "schema",
"module": "users",
"description": ""
},
"get-a-user-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-a-user-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-a-user-response.user": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-a-user-response": {
"type": "schema",
"module": "users",
"description": ""
},
"delete-a-user-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-a-user-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-current-user-response": {
"type": "schema",
"module": "users",
"description": ""
},
"get-current-user-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-current-user-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-current-user-response.user": {
"type": "property",
"dataType": "object",
"description": ""
},
"invite-a-user-response": {
"type": "schema",
"module": "users",
"description": ""
},
"invite-a-user-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"invite-a-user-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-user-as-active-response": {
"type": "schema",
"module": "users",
"description": ""
},
"mark-user-as-active-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-user-as-active-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"mark-user-as-inactive-response": {
"type": "schema",
"module": "users",
"description": ""
},
"mark-user-as-inactive-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"mark-user-as-inactive-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor-credits": {
"type": "tag",
"description": "Vendor-Credits Module"
},
"create_vendor_credit": {
"type": "operation",
"method": "POST",
"path": "/vendorcredits",
"summary": "Create a vendor credit",
"description": "Create a vendor credit for a vendor."
},
"list_vendor_credits": {
"type": "operation",
"method": "GET",
"path": "/vendorcredits",
"summary": "List vendor credits",
"description": "List vendor credits with pagination."
},
"update_vendor_credit": {
"type": "operation",
"method": "PUT",
"path": "/vendorcredits/{vendor_credit_id}",
"summary": "Update vendor credit",
"description": "Update an existing vendor credit."
},
"get_vendor_credit": {
"type": "operation",
"method": "GET",
"path": "/vendorcredits/{vendor_credit_id}",
"summary": "Get vendor credit",
"description": "Get details of a vendor credit."
},
"delete_vendor_credit": {
"type": "operation",
"method": "DELETE",
"path": "/vendorcredits/{vendor_credit_id}",
"summary": "Delete vendor credit",
"description": "Delete a vendor credit."
},
"mark_vendor_credit_as_open": {
"type": "operation",
"method": "POST",
"path": "/vendorcredits/{vendor_credit_id}/status/open",
"summary": "Convert to open",
"description": "Change an existing vendor credit status to open."
},
"mark_vendor_credit_as_void": {
"type": "operation",
"method": "POST",
"path": "/vendorcredits/{vendor_credit_id}/status/void",
"summary": "Void vendor credit",
"description": "Mark an existing vendor credit as void."
},
"submit_vendor_credit": {
"type": "operation",
"method": "POST",
"path": "/vendorcredits/{vendor_credit_id}/submit",
"summary": "Submit a Vendor credit for approval",
"description": "Submit a Vendor credit for approval."
},
"approve_vendor_credit": {
"type": "operation",
"method": "POST",
"path": "/vendorcredits/{vendor_credit_id}/approve",
"summary": "Approve a Vendor credit",
"description": "Approve a Vendor credit."
},
"list_vendor_credited_bills": {
"type": "operation",
"method": "GET",
"path": "/vendorcredits/{vendor_credit_id}/bills",
"summary": "List bills credited",
"description": "List bills to which the vendor credit is applied."
},
"apply_vendor_credit_to_bill": {
"type": "operation",
"method": "POST",
"path": "/vendorcredits/{vendor_credit_id}/bills",
"summary": "Apply credits to a bill",
"description": "Apply vendor credit to existing bills."
},
"delete_vendor_credited_bill": {
"type": "operation",
"method": "DELETE",
"path": "/vendorcredits/{vendor_credit_id}/bills/{vendor_credit_bill_id}",
"summary": "Delete bills credited",
"description": "Delete the credits applied to a bill."
},
"refund_vendor_credit": {
"type": "operation",
"method": "POST",
"path": "/vendorcredits/{vendor_credit_id}/refunds",
"summary": "Refund a vendor credit",
"description": "Refund vendor credit amount."
},
"list_refunds_of_a_vendor_credit": {
"type": "operation",
"method": "GET",
"path": "/vendorcredits/{vendor_credit_id}/refunds",
"summary": "List refunds of a vendor credit",
"description": "List all refunds of an existing vendor credit."
},
"update_vendor_credit_refund": {
"type": "operation",
"method": "PUT",
"path": "/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id}",
"summary": "Update vendor credit refund",
"description": "Update the refunded transaction."
},
"vendor_credit_refund_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the Vendor Credit Refund"
},
"get_vendor_credit_refund": {
"type": "operation",
"method": "GET",
"path": "/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id}",
"summary": "Get vendor credit refund",
"description": "Get refund of a particular vendor credit."
},
"delete_vendor_credit_refund": {
"type": "operation",
"method": "DELETE",
"path": "/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id}",
"summary": "Delete vendor credit refund",
"description": "Delete a vendor credit refund."
},
"list_refunds_of_all_vendor_credits": {
"type": "operation",
"method": "GET",
"path": "/vendorcredits/refunds",
"summary": "List vendor credit refunds",
"description": "List all refunds with pagination."
},
"add_vendor_credit_comment": {
"type": "operation",
"method": "POST",
"path": "/vendorcredits/{vendor_credit_id}/comments",
"summary": "Add a comment",
"description": "Add a comment to an existing vendor credit."
},
"list_vendor_credit_comments": {
"type": "operation",
"method": "GET",
"path": "/vendorcredits/{vendor_credit_id}/comments",
"summary": "List vendor credit comments & history",
"description": "Get history and comments of a vendor credit."
},
"delete_vendor_credit_comment": {
"type": "operation",
"method": "DELETE",
"path": "/vendorcredits/{vendor_credit_id}/comments/{comment_id}",
"summary": "Delete a comment",
"description": "Delete a vendor credit comment."
},
"vendor_credit-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"vendor_credit-response.vendor_credit_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.vendor_credit_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.source_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.destination_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.pricebook_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.is_reverse_charge_applied": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.vendor_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.price_precision": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.vat_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.filed_in_vat_return_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.filed_in_vat_return_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.filed_in_vat_return_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.line_items": {
"type": "property",
"dataType": "object",
"description": "Line items of a vendor credit."
},
"vendor_credit-response.acquisition_vat_summary": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.acquisition_vat_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.reverse_charge_vat_summary": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.reverse_charge_vat_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.documents": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.sub_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.total": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.total_credits_used": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.total_refunded_amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.balance": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.comments": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.vendor_credit_refunds": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.bills_credited": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit-response.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"apply_to_bills": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"apply_to_bills.bills": {
"type": "property",
"dataType": "string",
"description": ""
},
"total_credits_used": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"total_refunded_amount": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"tax.tax_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"tax.tax_amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"bills_credited": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"tax_treatment_code": {
"type": "schema",
"module": "vendor-credits",
"description": "Specify reason for using out of scope.Supported values for UAE are uae_same_tax_group, uae_reimbursed_expense and uae_others. Supported values for Bahrain are bahrain_same_tax_group, bahrain_transfer_of_concern, bahrain_disbursement, bahrain_head_to_branch_transaction and bahrain_others."
},
"item_total_inclusive_of_tax": {
"type": "schema",
"module": "vendor-credits",
"description": "Total price of the Item inclusive of Tax"
},
"acquisition_vat_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the VAT Acquistion"
},
"acquisition_vat_name": {
"type": "schema",
"module": "vendor-credits",
"description": "Name of the VAT Acquistion"
},
"acquisition_vat_percentage": {
"type": "schema",
"module": "vendor-credits",
"description": "Percentage of the VAT Acquistion"
},
"acquisition_vat_amount": {
"type": "schema",
"module": "vendor-credits",
"description": "Amount of the VAT Acquistion"
},
"acquisition_vat_summary": {
"type": "schema",
"module": "vendor-credits",
"description": "Summary of the VAT Acquistion"
},
"reverse_charge_vat_summary": {
"type": "schema",
"module": "vendor-credits",
"description": "Summary of the Reverse Charge"
},
"acquisition_vat_total": {
"type": "schema",
"module": "vendor-credits",
"description": "Total of the VAT Acquistion"
},
"reverse_charge_vat_total": {
"type": "schema",
"module": "vendor-credits",
"description": "Total of the Reverse Charge"
},
"reverse_charge_vat_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the Reverse Charge"
},
"reverse_charge_vat_name": {
"type": "schema",
"module": "vendor-credits",
"description": "Name of the Reverse Charge"
},
"reverse_charge_vat_percentage": {
"type": "schema",
"module": "vendor-credits",
"description": "Percentage of the Reverse Charge"
},
"reverse_charge_vat_amount": {
"type": "schema",
"module": "vendor-credits",
"description": "Percentage of the Reverse Charge"
},
"tag_option_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the tag option"
},
"is_update_customer": {
"type": "schema",
"module": "vendor-credits",
"description": "Check if customer should be updated"
},
"filed_in_vat_return_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the VAT Return the Vendor Credit is filed in"
},
"filed_in_vat_return_name": {
"type": "schema",
"module": "vendor-credits",
"description": "Name of the VAT Return the Vendor Credit is filed in"
},
"filed_in_vat_return_type": {
"type": "schema",
"module": "vendor-credits",
"description": "Type of the VAT Return the Vendor Credit is filed in"
},
"imported_transaction_id": {
"type": "schema",
"module": "vendor-credits",
"description": "ID of the Imported Transaction"
},
"payee": {
"type": "schema",
"module": "vendor-credits",
"description": "Payee of the Transaction"
},
"imported_transactions": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"vendor_credit_refunds": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"vendor_credit_refund": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"vendor_credit_refund.vendor_credit_refund_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit_refund.vendor_credit_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit_refund.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit_refund.refund_mode": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit_refund.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit_refund.amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit_refund.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit_refund.account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit_refund.account_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit_refund.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit_refund.imported_transactions": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"vendor_credit.vendor_credit_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.vendor_credit_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.status": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.vendor_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.currency_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.currency_code": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.price_precision": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.vat_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.filed_in_vat_return_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.filed_in_vat_return_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.filed_in_vat_return_type": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.location_name": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.line_items": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.acquisition_vat_summary": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.acquisition_vat_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.reverse_charge_vat_summary": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.reverse_charge_vat_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.documents": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.sub_total": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.total": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.total_credits_used": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.total_refunded_amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.balance": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.comments": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.vendor_credit_refunds": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.bills_credited": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.created_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"vendor_credit.last_modified_time": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"create-a-vendor-credit-request.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.vat_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.vendor_credit_number": {
"type": "property",
"dataType": "string",
"description": "Mandatory if auto number generation is disabled."
},
"create-a-vendor-credit-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.source_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.destination_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.pricebook_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.is_update_customer": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Line items of a vendor credit."
},
"create-a-vendor-credit-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.documents": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"create-a-vendor-credit-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"create-a-vendor-credit-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"create-a-vendor-credit-response.vendor_credit": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-vendor-credits-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"list-vendor-credits-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-vendor-credits-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-vendor-credits-response.vendorcredits": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-vendor-credit-request": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"update-vendor-credit-request.vendor_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.vat_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.vendor_credit_number": {
"type": "property",
"dataType": "string",
"description": "Mandatory if auto number generation is disabled."
},
"update-vendor-credit-request.gst_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.tax_treatment": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.gst_no": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.source_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.destination_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.place_of_supply": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.pricebook_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.is_update_customer": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.is_inclusive_tax": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.location_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.line_items": {
"type": "property",
"dataType": "array",
"description": "Line items of a vendor credit."
},
"update-vendor-credit-request.notes": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.documents": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-request.custom_fields": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"update-vendor-credit-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-vendor-credit-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-response.vendor_credit": {
"type": "property",
"dataType": "object",
"description": ""
},
"get-vendor-credit-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"get-vendor-credit-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-vendor-credit-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-vendor-credit-response.vendor_credit": {
"type": "property",
"dataType": "object",
"description": ""
},
"delete-vendor-credit-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"delete-vendor-credit-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-vendor-credit-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"convert-to-open-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"convert-to-open-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"convert-to-open-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"void-vendor-credit-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"void-vendor-credit-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"void-vendor-credit-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"submit-a-vendor-credit-for-approval-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"submit-a-vendor-credit-for-approval-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"submit-a-vendor-credit-for-approval-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"approve-a-vendor-credit-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"approve-a-vendor-credit-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"approve-a-vendor-credit-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-bills-credited-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"list-bills-credited-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-bills-credited-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-bills-credited-response.bills_credited": {
"type": "property",
"dataType": "array",
"description": ""
},
"apply-credits-to-a-bill-request": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"apply-credits-to-a-bill-request.bills": {
"type": "property",
"dataType": "array",
"description": "Amount applied from vendor credits to specified bills."
},
"apply-credits-to-a-bill-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"apply-credits-to-a-bill-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"apply-credits-to-a-bill-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"apply-credits-to-a-bill-response.bills": {
"type": "property",
"dataType": "string",
"description": "Amount applied from vendor credits to specified bills."
},
"delete-bills-credited-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"delete-bills-credited-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-bills-credited-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-a-vendor-credit-request": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"refund-a-vendor-credit-request.date": {
"type": "property",
"dataType": "string",
"description": "Date of Vendor Credit Refund"
},
"refund-a-vendor-credit-request.refund_mode": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-a-vendor-credit-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-a-vendor-credit-request.amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-a-vendor-credit-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-a-vendor-credit-request.account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-a-vendor-credit-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-a-vendor-credit-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"refund-a-vendor-credit-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"refund-a-vendor-credit-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"refund-a-vendor-credit-response.vendor_credit_refund": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-refunds-of-a-vendor-credit-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"list-refunds-of-a-vendor-credit-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-refunds-of-a-vendor-credit-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-refunds-of-a-vendor-credit-response.vendor_credit_refunds": {
"type": "property",
"dataType": "array",
"description": ""
},
"update-vendor-credit-refund-request": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"update-vendor-credit-refund-request.date": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-refund-request.refund_mode": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-refund-request.reference_number": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-refund-request.amount": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-refund-request.exchange_rate": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-refund-request.account_id": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-refund-request.description": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-refund-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"update-vendor-credit-refund-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"update-vendor-credit-refund-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"update-vendor-credit-refund-response.vendor_credit_refund": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-vendor-credit-refund-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"get-vendor-credit-refund-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"get-vendor-credit-refund-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"get-vendor-credit-refund-response.vendor_credit_refund": {
"type": "property",
"dataType": "string",
"description": ""
},
"delete-vendor-credit-refund-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"delete-vendor-credit-refund-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"delete-vendor-credit-refund-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-vendor-credit-refunds-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"list-vendor-credit-refunds-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-vendor-credit-refunds-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-vendor-credit-refunds-response.vendor_credit_refunds": {
"type": "property",
"dataType": "array",
"description": ""
},
"add-a-comment-response.comment": {
"type": "property",
"dataType": "object",
"description": ""
},
"list-vendor-credit-comments-and-history-response": {
"type": "schema",
"module": "vendor-credits",
"description": ""
},
"list-vendor-credit-comments-and-history-response.code": {
"type": "property",
"dataType": "integer",
"description": ""
},
"list-vendor-credit-comments-and-history-response.message": {
"type": "property",
"dataType": "string",
"description": ""
},
"list-vendor-credit-comments-and-history-response.comments": {
"type": "property",
"dataType": "array",
"description": ""
}
}
}