{
  "opencollection": "1.0.0",
  "info": {
    "name": "batches vendor-credits API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "vendor-credits",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List vendor credits",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits",
            "params": [
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              },
              {
                "name": "vendor_credit_number",
                "value": "DN-00002",
                "type": "query",
                "description": "Search vendor credits by vendor credit number. Variants: <code>vendor_credit_number_startswith</code> and <code>vendor_credit_number_contains</code>"
              },
              {
                "name": "date",
                "value": "2014-08-28",
                "type": "query",
                "description": "General Format: yyyy-mm-dd. Search vendor credits by date. Variants: <code>date.start</code>, <code>date.end</code>, <code>date.before</code> and <code>date.after</code>"
              },
              {
                "name": "status",
                "value": "open",
                "type": "query",
                "description": "Search vendor credits by vendor credit status. Allowed statuses are open, closed and void. Allowed Values: <code>open</code>, <code>closed</code> and <code>void</code>"
              },
              {
                "name": "total",
                "value": "30",
                "type": "query",
                "description": "Search vendor credits by total amount. Variants: <code>total_start</code>, <code>total_end</code>, <code>total_less_than</code>, <code>total_less_equals</code>, <code>total_greater_than</code> and <code>total_greater_equals</code>"
              },
              {
                "name": "reference_number",
                "value": "",
                "type": "query",
                "description": "Search vendor credits by vendor credit reference number. Variants: <code>reference_number_startswith</code> and <code>reference_number_contains</code>"
              },
              {
                "name": "customer_name",
                "value": "Bowman and Co",
                "type": "query",
                "description": "Search vendor credits by vendor name. Variants: <code>customer_name_startswith</code> and <code>customer_name_contains</code>"
              },
              {
                "name": "item_name",
                "value": "",
                "type": "query",
                "description": "Search vendor credits by item name. Variants: <code>item_name_startswith</code> and <code>item_name_contains</code>"
              },
              {
                "name": "item_description",
                "value": "",
                "type": "query",
                "description": "Search vendor credits by vendor credit item description. Variants: <code>item_description_startswith</code> and <code>item_description_contains</code>"
              },
              {
                "name": "notes",
                "value": "",
                "type": "query",
                "description": "Search vendor credits by vendor credit notes. Variants: <code>notes_startswith</code> and <code>notes_contains</code>"
              },
              {
                "name": "custom_field",
                "value": "",
                "type": "query",
                "description": "Search vendor credits by custom field. Variants : <code>custom_field_startswith</code> and <code>custom_field_contains</code>"
              },
              {
                "name": "last_modified_time",
                "value": "2014-08-28T22:53:31-0700",
                "type": "query",
                "description": "Search vendor credits by vendor credit last modfified time"
              },
              {
                "name": "customer_id",
                "value": "",
                "type": "query",
                "description": "Search vendor credits by vendor credit customer ID"
              },
              {
                "name": "line_item_id",
                "value": "460000000020077",
                "type": "query",
                "description": "Search vendor credits by vendor credit line item ID"
              },
              {
                "name": "item_id",
                "value": "460000000020071",
                "type": "query",
                "description": "Search vendor credits by vendor credit item ID"
              },
              {
                "name": "tax_id",
                "value": "",
                "type": "query",
                "description": "Search vendor credits by vendor credit tax ID"
              },
              {
                "name": "filter_by",
                "value": "",
                "type": "query",
                "description": "Filter vendor credits by statuses. Allowed Values: <code>Status.All</code>, <code>Status.Open</code>, <code>Status.Draft</code>, <code>Status.Closed</code> and <code>Status.Void</code>."
              },
              {
                "name": "search_text",
                "value": "",
                "type": "query",
                "description": "Search vendor credits by vendor credit number or vendor name or vendor credit reference number."
              },
              {
                "name": "sort_column",
                "value": "created_time",
                "type": "query",
                "description": "Sort vendor credits by following columns vendor_name, vendorcredit_number, balance, total, date and created_time. Allowed Values: <code>vendor_name</code>, <code>vendor_credit_number</code>, <code>balance</code>, <code>total</code>, <code>date</code>, <code>created_time</code>, <code>last_modified_time</code> and <code>reference_number</code>."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Page number to be fetched. Default value is 1."
              },
              {
                "name": "per_page",
                "value": "200",
                "type": "query",
                "description": "Number of records to be fetched per page. Default value is 200."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "List vendor credits with pagination."
        },
        {
          "info": {
            "name": "Create a vendor credit",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits",
            "params": [
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              },
              {
                "name": "ignore_auto_number_generation",
                "value": "",
                "type": "query",
                "description": "Ignore auto number generation for this vendor credit only. On enabling this option vendor credit number is mandatory."
              },
              {
                "name": "bill_id",
                "value": "460000000057075",
                "type": "query",
                "description": "Bill Associated with the Vendor Credit"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Create a vendor credit for a vendor."
        },
        {
          "info": {
            "name": "Get vendor credit",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              },
              {
                "name": "print",
                "value": "",
                "type": "query",
                "description": "Export vendor credit pdf with default print option. Allowed Values: <code>true</code>, <code>false</code>, <code>on</code> and <code>off</code>."
              },
              {
                "name": "accept",
                "value": "",
                "type": "query",
                "description": "You can get vendor credit details as json/pdf/html. Default format is html. Allowed Values: <code>json</code>, <code>xml</code>, <code>csv</code>, <code>xls</code>, <code>pdf</code>, <code>html</code> and <code>jhtml</code>."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Get details of a vendor credit."
        },
        {
          "info": {
            "name": "Update vendor credit",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Update an existing vendor credit."
        },
        {
          "info": {
            "name": "Delete vendor credit",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Delete a vendor credit."
        },
        {
          "info": {
            "name": "Convert to open",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/status/open",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Change an existing vendor credit status to open."
        },
        {
          "info": {
            "name": "Void vendor credit",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/status/void",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Mark an existing vendor credit as void."
        },
        {
          "info": {
            "name": "Submit a Vendor credit for approval",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/submit",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Submit a Vendor credit for approval."
        },
        {
          "info": {
            "name": "Approve a Vendor credit",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/approve",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Approve a Vendor credit."
        },
        {
          "info": {
            "name": "List bills credited",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/bills",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "List bills to which the vendor credit is applied."
        },
        {
          "info": {
            "name": "Apply credits to a bill",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/bills",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Apply vendor credit to existing bills."
        },
        {
          "info": {
            "name": "Delete bills credited",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/bills/:vendor_credit_bill_id",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              },
              {
                "name": "vendor_credit_bill_id",
                "value": "460000000057075",
                "type": "path",
                "description": "Unique identifier of the vendor credit bill."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Delete the credits applied to a bill."
        },
        {
          "info": {
            "name": "List refunds of a vendor credit",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/refunds",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Page number to be fetched. Default value is 1."
              },
              {
                "name": "per_page",
                "value": "200",
                "type": "query",
                "description": "Number of records to be fetched per page. Default value is 200."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "List all refunds of an existing vendor credit."
        },
        {
          "info": {
            "name": "Refund a vendor credit",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/refunds",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Refund vendor credit amount."
        },
        {
          "info": {
            "name": "Get vendor credit refund",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/refunds/:vendor_credit_refund_id",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              },
              {
                "name": "vendor_credit_refund_id",
                "value": "3000000003151",
                "type": "path",
                "description": "Unique identifier of the vendor credit refund."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Get refund of a particular vendor credit."
        },
        {
          "info": {
            "name": "Update vendor credit refund",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/refunds/:vendor_credit_refund_id",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              },
              {
                "name": "vendor_credit_refund_id",
                "value": "3000000003151",
                "type": "path",
                "description": "Unique identifier of the vendor credit refund."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Update the refunded transaction."
        },
        {
          "info": {
            "name": "Delete vendor credit refund",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/refunds/:vendor_credit_refund_id",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              },
              {
                "name": "vendor_credit_refund_id",
                "value": "3000000003151",
                "type": "path",
                "description": "Unique identifier of the vendor credit refund."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Delete a vendor credit refund."
        },
        {
          "info": {
            "name": "List vendor credit refunds",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/refunds",
            "params": [
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              },
              {
                "name": "customer_id",
                "value": "",
                "type": "query",
                "description": "Search vendor credits by vendor credit customer ID"
              },
              {
                "name": "last_modified_time",
                "value": "2014-08-28T22:53:31-0700",
                "type": "query",
                "description": "Search vendor credits by vendor credit last modfified time"
              },
              {
                "name": "sort_column",
                "value": "created_time",
                "type": "query",
                "description": "Sort vendor credits by following columns vendor_name, vendorcredit_number, balance, total, date and created_time. Allowed Values: <code>vendor_name</code>, <code>vendor_credit_number</code>, <code>balance</code>, <code>total</code>, <code>date</code>, <code>created_time</code>, <code>last_modified_time</code> and <code>reference_number</code>."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Page number to be fetched. Default value is 1."
              },
              {
                "name": "per_page",
                "value": "200",
                "type": "query",
                "description": "Number of records to be fetched per page. Default value is 200."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "List all refunds with pagination."
        },
        {
          "info": {
            "name": "List vendor credit comments & history",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/comments",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Get history and comments of a vendor credit."
        },
        {
          "info": {
            "name": "Add a comment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/comments",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Add a comment to an existing vendor credit."
        },
        {
          "info": {
            "name": "Delete a comment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://www.zohoapis.com/inventory/v1/vendorcredits/:vendor_credit_id/comments/:comment_id",
            "params": [
              {
                "name": "vendor_credit_id",
                "value": "3000000002075",
                "type": "path",
                "description": "Unique identifier of the vendor credit."
              },
              {
                "name": "organization_id",
                "value": "10234695",
                "type": "query",
                "description": "ID of the organization"
              },
              {
                "name": "comment_id",
                "value": "3000000002089",
                "type": "path",
                "description": "Unique identifier of the comment."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Delete a vendor credit comment."
        }
      ]
    }
  ],
  "bundled": true
}