{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Vendor Credits", "description": "Vendor credits are credits that you receive from your vendor, and is treated as an equivalent of physical cash that the vendor owes you. This helps you track the money you're owed until it is either paid by said vendor at a later date i.e refunded, or subtracted from any future bill amount due to that vendor.", "definitions": { "gendoc-attributes-schema": { "$ref": "#/components/schemas/vendor_credit-response" }, "vendor_credit-response": { "type": "object", "properties": { "vendor_credit_id": { "$ref": "#/components/schemas/vendor_credit_id" }, "vendor_credit_number": { "$ref": "#/components/schemas/vendor_credit_number" }, "date": { "$ref": "#/components/schemas/date" }, "source_of_supply": { "$ref": "#/components/schemas/source_of_supply" }, "destination_of_supply": { "$ref": "#/components/schemas/destination_of_supply" }, "place_of_supply": { "$ref": "#/components/schemas/place_of_supply" }, "gst_no": { "$ref": "#/components/schemas/gst_no" }, "gst_treatment": { "$ref": "#/components/schemas/gst_treatment" }, "tax_treatment": { "$ref": "#/components/schemas/tax_treatment" }, "pricebook_id": { "$ref": "#/components/schemas/pricebook_id" }, "is_reverse_charge_applied": { "$ref": "#/components/schemas/is_reverse_charge_applied" }, "status": { "$ref": "#/components/schemas/status" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "vendor_id": { "$ref": "#/components/schemas/vendor_id" }, "vendor_name": { "$ref": "#/components/schemas/vendor_name" }, "currency_id": { "$ref": "#/components/schemas/currency_id" }, "currency_code": { "$ref": "#/components/schemas/currency_code" }, "exchange_rate": { "$ref": "#/components/schemas/exchange_rate" }, "price_precision": { "$ref": "#/components/schemas/price_precision" }, "vat_treatment": { "$ref": "#/components/schemas/vat_treatment" }, "filed_in_vat_return_id": { "$ref": "#/components/schemas/filed_in_vat_return_id" }, "filed_in_vat_return_name": { "$ref": "#/components/schemas/filed_in_vat_return_name" }, "filed_in_vat_return_type": { "$ref": "#/components/schemas/filed_in_vat_return_type" }, "is_inclusive_tax": { "$ref": "#/components/schemas/is_inclusive_tax" }, "location_id": { "$ref": "#/components/schemas/location_id" }, "location_name": { "$ref": "#/components/schemas/location_name" }, "line_items": { "description": "Line items of a vendor credit.", "type": "object", "properties": { "item_id": { "$ref": "#/components/schemas/item_id" }, "line_item_id": { "$ref": "#/components/schemas/line_item_id" }, "sku": { "$ref": "#/components/schemas/sku" }, "account_id": { "$ref": "#/components/schemas/account_id" }, "product_type": { "$ref": "#/components/schemas/product_type" }, "location_id": { "$ref": "#/components/schemas/location_id" }, "location_name": { "$ref": "#/components/schemas/location_name" }, "reverse_charge_tax_id": { "$ref": "#/components/schemas/reverse_charge_tax_id" }, "reverse_charge_tax_name": { "$ref": "#/components/schemas/reverse_charge_tax_name" }, "reverse_charge_tax_percentage": { "$ref": "#/components/schemas/reverse_charge_tax_percentage" }, "reverse_charge_tax_amount": { "$ref": "#/components/schemas/reverse_charge_tax_amount" }, "account_name": { "$ref": "#/components/schemas/account_name" }, "name": { "$ref": "#/components/schemas/name" }, "description": { "$ref": "#/components/schemas/description" }, "item_order": { "$ref": "#/components/schemas/item_order" }, "quantity": { "$ref": "#/components/schemas/quantity" }, "unit": { "$ref": "#/components/schemas/unit" }, "bcy_rate": { "$ref": "#/components/schemas/bcy_rate" }, "rate": { "$ref": "#/components/schemas/rate" }, "tax_id": { "$ref": "#/components/schemas/tax_id" }, "tds_tax_id": { "$ref": "#/components/schemas/tds_tax_id" }, "tax_treatment_code": { "$ref": "#/components/schemas/tax_treatment_code" }, "tax_exemption_id": { "$ref": "#/components/schemas/tax_exemption_id" }, "tax_exemption_code": { "$ref": "#/components/schemas/tax_exemption_code" }, "tax_name": { "$ref": "#/components/schemas/tax_name" }, "tax_type": { "$ref": "#/components/schemas/tax_type" }, "tax_percentage": { "$ref": "#/components/schemas/tax_percentage" }, "item_total": { "$ref": "#/components/schemas/item_total" }, "item_total_inclusive_of_tax": { "$ref": "#/components/schemas/item_total_inclusive_of_tax" }, "hsn_or_sac": { "$ref": "#/components/schemas/hsn_or_sac" }, "acquisition_vat_id": { "$ref": "#/components/schemas/acquisition_vat_id" }, "acquisition_vat_name": { "$ref": "#/components/schemas/acquisition_vat_name" }, "acquisition_vat_percentage": { "$ref": "#/components/schemas/acquisition_vat_percentage" }, "acquisition_vat_amount": { "$ref": "#/components/schemas/acquisition_vat_amount" }, "reverse_charge_vat_id": { "$ref": "#/components/schemas/reverse_charge_vat_id" }, "reverse_charge_vat_name": { "$ref": "#/components/schemas/reverse_charge_vat_name" }, "reverse_charge_vat_percentage": { "$ref": "#/components/schemas/reverse_charge_vat_percentage" }, "reverse_charge_vat_amount": { "$ref": "#/components/schemas/reverse_charge_vat_amount" }, "stock_on_hand": { "$ref": "#/components/schemas/stock_on_hand" }, "tags": { "$ref": "#/components/schemas/tags" }, "item_custom_fields": { "$ref": "#/components/schemas/item_custom_fields" } } }, "acquisition_vat_summary": { "$ref": "#/components/schemas/acquisition_vat_summary" }, "acquisition_vat_total": { "$ref": "#/components/schemas/acquisition_vat_total" }, "reverse_charge_vat_summary": { "$ref": "#/components/schemas/reverse_charge_vat_summary" }, "reverse_charge_vat_total": { "$ref": "#/components/schemas/reverse_charge_vat_total" }, "documents": { "$ref": "#/components/schemas/documents" }, "custom_fields": { "$ref": "#/components/schemas/custom_fields" }, "sub_total": { "$ref": "#/components/schemas/sub_total" }, "total": { "$ref": "#/components/schemas/total" }, "total_credits_used": { "$ref": "#/components/schemas/total_credits_used" }, "total_refunded_amount": { "$ref": "#/components/schemas/total_refunded_amount" }, "balance": { "$ref": "#/components/schemas/balance" }, "notes": { "$ref": "#/components/schemas/notes" }, "comments": { "$ref": "#/components/schemas/comments" }, "vendor_credit_refunds": { "$ref": "#/components/schemas/vendor_credit_refunds" }, "bills_credited": { "$ref": "#/components/schemas/bills_credited" }, "created_time": { "$ref": "#/components/schemas/created_time" }, "last_modified_time": { "$ref": "#/components/schemas/last_modified_time" } } }, "ignore_auto_number_generation": { "description": "Ignore auto number generation for this vendor credit only. On enabling this option vendor credit number is mandatory.", "type": "boolean" }, "bill_id": { "description": "Bill Associated with the Vendor Credit", "type": "string", "example": "460000000057075" }, "amount_applied": { "description": "Amount applied to the bill.", "type": "number", "format": "double", "example": 10 }, "bills": { "description": "Amount applied from vendor credits to specified bills.", "type": "array", "items": { "type": "object", "properties": { "bill_id": { "$ref": "#/components/schemas/bill_id" }, "amount_applied": { "$ref": "#/components/schemas/amount_applied" } } } }, "gst_treatment": { "description": "Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .", "type": "string", "example": "business_gst", "x-node_available_in": [ "in" ], "x-node_unavailable_in": [] }, "tax_treatment": { "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.", "type": "string", "example": "vat_registered", "x-node_available_in": [ "gcc", "mx" ], "x-node_unavailable_in": [] }, "gst_no": { "description": "15 digit GST identification number of the vendor.", "type": "string", "example": "22AAAAA0000A1Z5", "x-node_available_in": [ "in" ], "x-node_unavailable_in": [] }, "source_of_supply": { "description": "Place from where the goods/services are supplied. (If not given, place of contact given for the contact will be taken)", "type": "string", "example": "TN", "x-node_available_in": [ "in" ], "x-node_unavailable_in": [] }, "destination_of_supply": { "description": "Place where the goods/services are supplied to. (If not given, organisation's home state will be taken)", "type": "string", "example": "TN", "x-node_available_in": [ "in" ], "x-node_unavailable_in": [] }, "place_of_supply": { "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.", "type": "string", "example": "DU", "x-node_available_in": [ "gcc" ], "x-node_unavailable_in": [] }, "reverse_charge_tax_id": { "description": "ID of the reverse charge tax", "type": "string", "example": 460000000057089, "x-node_available_in": [ "in", "gcc" ], "x-node_unavailable_in": [] }, "location_id": { "description": "Location ID", "type": "string", "example": "460000000038080" }, "location_name": { "description": "Name of the location.", "type": "string" }, "pricebook_id": { "description": "ID of the pricebook", "type": "string" }, "reverse_charge_tax_name": { "description": "Enter the tax name of the reverse charge", "type": "string", "example": "intra", "x-node_available_in": [ "in" ], "x-node_unavailable_in": [] }, "reverse_charge_tax_percentage": { "description": "Tax percentage of the reverse charge", "type": "number", "format": "double", "example": 10, "x-node_available_in": [ "in" ], "x-node_unavailable_in": [] }, "reverse_charge_tax_amount": { "description": "Tax amount of the reverse charge", "type": "number", "format": "double", "example": 100, "x-node_available_in": [ "in" ], "x-node_unavailable_in": [] }, "project_id": { "description": "ID of the project", "type": "string", "example": 90300000087378 }, "project_name": { "description": "Name of the project.", "type": "string", "example": "Sample Project" }, "is_reverse_charge_applied": { "description": "Applicable for transactions where you pay reverse charge", "type": "boolean", "example": true, "x-node_available_in": [ "in" ], "x-node_unavailable_in": [] }, "apply_to_bills": { "type": "object", "properties": { "bills": { "$ref": "#/components/schemas/bills" } } }, "vendor_credit_number": { "description": "Number of the Vendor Credit", "type": "string", "example": "DN-00002" }, "date": { "description": "The date the vendor credit is created. [yyyy-mm-dd]", "type": "string", "example": "2014-08-28" }, "status": { "type": "string", "example": "open" }, "reference_number": { "description": "Reference number for the refund recorded.", "type": "string" }, "vendor_id": { "description": "ID of the vendor the vendor credit associated with the Vendor Credit", "type": "string", "example": "460000000020029" }, "vendor_name": { "description": "Name of the Vendor Associated with the Vendor Credit", "type": "string", "example": "Bowman and Co" }, "currency_id": { "description": "ID of the Currency Involved in the Vendor Credit", "type": "string", "example": "3000000000083" }, "currency_code": { "description": "Code of the Currency Involved in the Vendor Credit", "type": "string", "example": "USD" }, "exchange_rate": { "description": "Exchange rate of the currency.", "type": "number", "format": "double", "example": 1 }, "price_precision": { "type": "integer", "example": 2 }, "is_inclusive_tax": { "description": "Used to specify whether the line item rates are inclusive or exclusive of tax.", "type": "boolean", "example": false, "x-node_available_in": [], "x-node_unavailable_in": [ "us" ] }, "document_id": { "description": "ID of the Document", "type": "string" }, "file_name": { "description": "Name of the file", "type": "string" }, "documents": { "type": "array", "description": "List of documents associated with the vendor credit", "items": { "type": "object", "properties": { "document_id": { "$ref": "#/components/schemas/document_id" }, "file_name": { "$ref": "#/components/schemas/file_name" } } } }, "custom_fields": { "type": "array", "description": "List of custom fields associated with the vendor credit", "items": { "type": "object", "properties": { "customfield_id": { "$ref": "#/components/schemas/customfield_id" }, "label": { "$ref": "#/components/schemas/label" }, "value": { "$ref": "#/components/schemas/value" } } } }, "sub_total": { "type": "number", "format": "double", "example": 30 }, "total": { "type": "number", "format": "double", "example": 30 }, "total_credits_used": { "type": "number", "format": "double", "example": 0 }, "total_refunded_amount": { "type": "number", "format": "double", "example": 0 }, "balance": { "description": "Balance in the Vendor Credit", "type": "number", "format": "double", "example": 30 }, "tax_name": { "description": "Name of the Tax", "type": "string" }, "tax_amount": { "description": "Amount of the Tax", "type": "number", "format": "double" }, "taxes": { "type": "array", "items": { "type": "object", "properties": { "tax_name": { "$ref": "#/components/schemas/tax_name" }, "tax_amount": { "$ref": "#/components/schemas/tax_amount" } } } }, "tax": { "type": "object", "properties": { "tax_name": { "$ref": "#/components/schemas/tax_name" }, "tax_amount": { "$ref": "#/components/schemas/tax_amount" } } }, "notes": { "description": "Notes for the Vendor Credit", "type": "string" }, "vendor_credit_bill_id": { "description": "ID of the Vendor Credited Bill ID", "type": "string" }, "bills_credited": { "type": "array", "items": { "type": "object", "properties": { "bill_id": { "description": "ID of the Bill Credited", "type": "string", "example": "460000000057075" }, "vendor_credit_bill_id": { "$ref": "#/components/schemas/vendor_credit_bill_id" }, "date": { "description": "Date of the Bill Credit", "type": "string", "example": "2014-08-30" }, "bill_number": { "description": "Number of the Bill Credited", "type": "string" }, "amount": { "description": "Amount that is credited in the bill", "type": "number", "format": "double", "example": 13 } } } }, "created_time": { "description": "Time of Vendor Credit Creation", "type": "string", "example": "2014-08-28T22:53:31-0700" }, "last_modified_time": { "description": "Last Modified Time of Vendor Credit", "type": "string", "example": "2014-08-28T22:53:31-0700" }, "item_id": { "description": "ID of the item.", "type": "string", "example": "460000000020071" }, "line_item_id": { "description": "ID of the Line Item", "type": "string", "example": "460000000020077" }, "sku": { "description": "SKU of the Item", "type": "string" }, "account_id": { "description": "ID of the account, the line item is associated with", "type": "string", "example": "460000000020097" }, "account_name": { "description": "Name of the account the line item is associated with", "type": "string", "example": "IT and Internet Expenses" }, "name": { "description": "Name of the line item.", "type": "string", "example": "Premium Plan - Web hosting" }, "description": { "description": "Description of the line item.", "type": "string" }, "item_order": { "description": "Order of the line item", "type": "integer", "example": 0 }, "quantity": { "description": "Quantity of the line item.", "type": "number", "format": "double", "example": 1 }, "unit": { "description": "Unit of the line item e.g. kgs, Nos.", "type": "string", "example": "Nos" }, "bcy_rate": { "description": "Rate of the Item in Base Currency", "type": "number", "format": "double", "example": 30 }, "rate": { "description": "Rate of the line item.", "type": "number", "format": "double", "example": 30 }, "amount": { "type": "number", "format": "double", "description": "Amount that is credited in the bill", "example": 13 }, "tax_id": { "description": "ID of the Tax associated with the Vendor Credit", "type": "string" }, "tds_tax_id": { "description": "TDS Tax ID of the Tax associated with the Vendor Credit", "type": "string", "x-node_available_in": [ "mx" ], "x-node_unavailable_in": [] }, "tax_treatment_code": { "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.", "type": "string", "example": "uae_others", "x-node_available_in": [ "gcc" ], "x-node_unavailable_in": [] }, "tax_exemption_id": { "description": "ID of the Tax Exemption associated", "type": "string", "x-node_available_in": [ "in", "au" ], "x-node_unavailable_in": [] }, "tax_exemption_code": { "description": "Code of the Tax Exemption associated", "type": "string", "x-node_available_in": [ "in", "au" ], "x-node_unavailable_in": [] }, "tax_type": { "description": "Type of the Tax", "type": "string" }, "tax_percentage": { "description": "Percentage of Tax", "type": "number", "format": "double" }, "item_total": { "description": "Total price of the Item", "type": "number", "format": "double", "example": 30 }, "item_total_inclusive_of_tax": { "description": "Total price of the Item inclusive of Tax", "type": "number", "format": "double", "example": 30 }, "product_type": { "description": "Type of the product. Allowed Values: goods, digital_service and service.", "type": "string", "x-node_available_in": [ "uk", "eu" ], "x-node_unavailable_in": [] }, "hsn_or_sac": { "description": "HSN Code", "type": "string", "x-node_available_in": [ "in" ], "x-node_unavailable_in": [] }, "acquisition_vat_id": { "description": "ID of the VAT Acquistion", "type": "string", "x-node_available_in": [ "uk", "eu" ], "x-node_unavailable_in": [] }, "acquisition_vat_name": { "description": "Name of the VAT Acquistion", "type": "string", "x-node_available_in": [ "uk", "eu" ], "x-node_unavailable_in": [] }, "acquisition_vat_percentage": { "description": "Percentage of the VAT Acquistion", "type": "string", "x-node_available_in": [ "uk", "eu" ], "x-node_unavailable_in": [] }, "acquisition_vat_amount": { "description": "Amount of the VAT Acquistion", "type": "string", "x-node_available_in": [ "uk", "eu" ], "x-node_unavailable_in": [] }, "acquisition_vat_summary": { "description": "Summary of the VAT Acquistion", "x-node_available_in": [ "uk", "eu" ], "x-node_unavailable_in": [], "type": "array", "items": { "type": "object", "properties": { "tax": { "$ref": "#/components/schemas/tax" } } } }, "reverse_charge_vat_summary": { "description": "Summary of the Reverse Charge", "type": "array", "items": { "type": "object", "properties": { "tax": { "$ref": "#/components/schemas/tax" } } }, "x-node_available_in": [ "uk", "eu" ], "x-node_unavailable_in": [] }, "acquisition_vat_total": { "description": "Total of the VAT Acquistion", "type": "number", "format": "double", "x-node_available_in": [ "uk", "eu" ], "x-node_unavailable_in": [] }, "reverse_charge_vat_total": { "description": "Total of the Reverse Charge", "type": "number", "format": "double", "x-node_available_in": [ "uk", "eu" ], "x-node_unavailable_in": [] }, "reverse_charge_vat_id": { "description": "ID of the Reverse Charge", "type": "string", "x-node_available_in": [ "uk", "eu" ], "x-node_unavailable_in": [] }, "reverse_charge_vat_name": { "description": "Name of the Reverse Charge", "type": "string", "x-node_available_in": [ "uk", "eu" ], "x-node_unavailable_in": [] }, "reverse_charge_vat_percentage": { "description": "Percentage of the Reverse Charge", "type": "string", "x-node_available_in": [ "uk", "eu" ], "x-node_unavailable_in": [] }, "reverse_charge_vat_amount": { "description": "Percentage of the Reverse Charge", "type": "string", "x-node_available_in": [ "uk", "eu" ], "x-node_unavailable_in": [] }, "tag_id": { "description": "ID of the tag", "type": "string" }, "tag_option_id": { "description": "ID of the tag option", "type": "string" }, "tags": { "type": "array", "description": "List of tags associated with the line item", "items": { "type": "object", "properties": { "tag_id": { "$ref": "#/components/schemas/tag_id" }, "tag_option_id": { "$ref": "#/components/schemas/tag_option_id" } } } }, "customfield_id": { "description": "ID of the Custom Field", "type": "string" }, "value": { "description": "Value of the Custom Field", "type": "string" }, "label": { "description": "Label of the Custom Field", "type": "string" }, "item_custom_fields": { "type": "array", "description": "List of custom fields associated with the line item", "items": { "type": "object", "properties": { "label": { "$ref": "#/components/schemas/label" }, "value": { "$ref": "#/components/schemas/value" } } } }, "serial_numbers": { "description": "Serial numbers for the line item. Applicable only for items with serial tracking enabled.", "type": "array", "items": { "type": "string", "example": "ARMP-0078" } }, "batches": { "description": "Batch details for the line item. Reference an existing batch using batch_id. Applicable only for items with batch tracking enabled.", "type": "array", "items": { "type": "object", "required": [ "batch_id", "out_quantity" ], "properties": { "batch_id": { "description": "Unique identifier of an existing batch.", "type": "string", "example": "6780203000000214019" }, "out_quantity": { "description": "Quantity removed from the batch.", "type": "number", "format": "float", "example": 2 }, "storages": { "description": "Bin/storage locations from which stock was issued for this batch.", "type": "array", "x-node_available_in": [ "Batch with Bin tracked items" ], "items": { "type": "object", "required": [ "storage_id", "out_quantity" ], "properties": { "storage_id": { "description": "Unique identifier of the bin/storage location.", "type": "string", "example": "6780203000000093226" }, "out_quantity": { "description": "Quantity removed from the bin.", "type": "number", "format": "float", "example": 2 } } } } } } }, "storages": { "description": "Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.", "type": "array", "items": { "type": "object", "required": [ "storage_id", "out_quantity" ], "properties": { "storage_id": { "description": "Unique identifier of the bin/storage location.", "type": "string", "example": "6780203000000093225" }, "out_quantity": { "description": "Quantity removed from the bin.", "type": "number", "format": "float", "example": 2 }, "serial_numbers": { "description": "Serial numbers allocated to this bin.", "type": "array", "x-node_available_in": [ "Serial with Bin tracked items" ], "items": { "type": "string", "example": "ARMP-0078" } } } } }, "batches-update": { "description": "Batch details for the line item. Reference an existing batch using batch_id. Applicable only for items with batch tracking enabled.", "type": "array", "items": { "type": "object", "required": [ "batch_id", "out_quantity" ], "properties": { "batch_id": { "description": "Unique identifier of an existing batch.", "type": "string", "example": "6780203000000214019" }, "out_quantity": { "description": "Quantity removed from the batch.", "type": "number", "format": "float", "example": 2 }, "storages": { "description": "Bin/storage locations from which stock was issued for this batch.", "type": "array", "x-node_available_in": [ "Batch with Bin tracked items" ], "items": { "type": "object", "required": [ "storage_id", "out_quantity" ], "properties": { "storage_id": { "description": "Unique identifier of the bin/storage location.", "type": "string", "example": "6780203000000093226" }, "out_quantity": { "description": "Quantity removed from the bin.", "type": "number", "format": "float", "example": 2 }, "storage_out_id": { "description": "Unique identifier of the storage record. Applicable only when updating an existing storage entry.", "type": "string", "example": "6780203000000997441" } } } } } } }, "storages-update": { "description": "Bin/storage locations allocated (or consumed, for assemblies) for the line item. Applicable only for items with bin tracking enabled.", "type": "array", "items": { "type": "object", "required": [ "storage_id", "out_quantity" ], "properties": { "storage_id": { "description": "Unique identifier of the bin/storage location.", "type": "string", "example": "6780203000000093225" }, "out_quantity": { "description": "Quantity removed from the bin.", "type": "number", "format": "float", "example": 2 }, "storage_out_id": { "description": "Unique identifier of the storage record. Applicable only when updating an existing storage entry.", "type": "string", "example": "6780203000000997440" }, "serial_numbers": { "description": "Serial numbers allocated to this bin.", "type": "array", "x-node_available_in": [ "Serial with Bin tracked items" ], "items": { "type": "string", "example": "ARMP-0078" } } } } }, "batches-response": { "description": "Batches tracked for the line item. Returned for items with batch tracking enabled.", "type": "array", "items": { "type": "object", "properties": { "batch_id": { "description": "Unique identifier of the batch.", "type": "string", "example": "6780203000000214019" }, "batch_number": { "description": "Batch number.", "type": "string", "example": "BTC-TL-890" }, "external_batch_number": { "description": "External batch number from the manufacturer.", "type": "string", "example": "MFR-TL-890" }, "manufacturer_date": { "description": "Manufacturing date of the batch.", "type": "string", "example": "2026-05-12" }, "expiry_date": { "description": "Expiration date of the batch.", "type": "string", "example": "2026-12-24" }, "out_quantity": { "description": "Quantity removed from the batch.", "type": "number", "format": "float", "example": 2 }, "storages": { "description": "Bin/storage locations from which stock was issued for this batch.", "type": "array", "x-node_available_in": [ "Batch with Bin tracked items" ], "items": { "type": "object", "properties": { "storage_id": { "description": "Unique identifier of the bin/storage location.", "type": "string", "example": "6780203000000093226" }, "storage_name": { "description": "Display name of the bin/storage location.", "type": "string", "example": "Bin A1" }, "out_quantity": { "description": "Quantity removed from the bin.", "type": "number", "format": "float", "example": 2 }, "storage_out_id": { "description": "Unique identifier of the storage entry on the line item.", "type": "string", "example": "6780203000000997441" } } } } } } }, "storages-response": { "description": "Bin/storage locations tracked for the line item. Returned for items with bin tracking enabled.", "type": "array", "items": { "type": "object", "properties": { "storage_id": { "description": "Unique identifier of the bin/storage location.", "type": "string", "example": "6780203000000093225" }, "storage_name": { "description": "Display name of the bin/storage location.", "type": "string", "example": "Bin A2" }, "out_quantity": { "description": "Quantity removed from the bin.", "type": "number", "format": "float", "example": 2 }, "storage_out_id": { "description": "Unique identifier of the storage entry on the line item.", "type": "string", "example": "6780203000000997440" }, "serial_numbers": { "description": "Serial numbers allocated to this bin.", "type": "array", "x-node_available_in": [ "Serial with Bin tracked items" ], "items": { "type": "string", "example": "ARMP-0078" } } } } }, "stock_on_hand": { "description": "Stock on Hand for that Item", "type": "string" }, "comment_id": { "description": "ID of the Comment", "type": "string", "example": "3000000002089" }, "vendor_credit_id": { "description": "ID of the Vendor Credit", "type": "string", "example": "3000000002075" }, "commented_by_id": { "description": "ID of the User who caused the comment", "type": "string", "example": "3000000000741" }, "commented_by": { "description": "Name of the User who caused the comment", "type": "string", "example": "rajdeep.a" }, "comment_type": { "description": "Type of the comment", "type": "string", "example": "system" }, "date_description": { "description": "Description of the Date of the Comment", "type": "string", "example": "32 minutes ago" }, "time": { "description": "Time of the Comment", "type": "string", "example": "10:52 PM" }, "operation_type": { "description": "Type of operation that caused the Comment", "type": "string", "example": "Added" }, "transaction_id": { "description": "Transaction ID that caused the Comment", "type": "string", "example": "460000000069087" }, "transaction_type": { "description": "Transaction Type that caused the Comment", "type": "string", "example": "vendor_credit" }, "page": { "type": "integer", "example": 1 }, "per_page": { "type": "integer", "example": 200 }, "has_more_page": { "type": "boolean", "example": false }, "report_name": { "type": "string", "example": "Bills" }, "applied_filter": { "type": "string", "example": "Status.All" }, "sort_order": { "type": "string", "example": "D" }, "has_attachment": { "description": "Check if Vendor Credit has attachment", "type": "boolean", "example": false }, "print": { "description": "Export vendor credit pdf with default print option. Allowed Values: true, false, on and off.", "type": "boolean" }, "accept": { "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.", "type": "string" }, "item_name": { "description": "Search vendor credits by item name. Variants: item_name_startswith and item_name_contains.", "type": "string" }, "item_description": { "description": "Search vendor credits by vendor credit item description. Variants: item_description_startswith and item_description_contains.", "type": "string" }, "filter_by": { "description": "Filter vendor credits by statuses. Allowed Values: Status.All, Status.Open, Status.Draft, Status.Closed and Status.Void.", "type": "string" }, "search_text": { "description": "Search vendor credits by vendor credit number or vendor name or vendor credit reference number.", "type": "string" }, "sort_column": { "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.", "type": "string", "example": "created_time" }, "bill_number": { "type": "string" }, "due_date": { "type": "string", "example": "2014-08-30" }, "due_days": { "type": "string", "example": "Due Today" }, "attachment_name": { "type": "string" }, "vendor_credit_refund_id": { "description": "ID of the Vendor Credit Refund", "type": "string", "example": "3000000003151" }, "refund_mode": { "description": "Mode of Refund", "type": "string", "example": "cash" }, "amount_bcy": { "description": "Refund Amount in Base Currency", "type": "number", "format": "double", "example": 13 }, "amount_fcy": { "description": "Refund Amount in Foreign Currency", "type": "number", "format": "double", "example": 13 }, "customer_name": { "description": "Vendor associated with the Entity", "type": "string", "example": "Bowman and Co" }, "is_update_customer": { "description": "Check if customer should be updated", "type": "boolean", "example": false }, "vat_treatment": { "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).", "type": "string", "x-node_available_in": [ "uk" ], "x-node_unavailable_in": [] }, "filed_in_vat_return_id": { "description": "ID of the VAT Return the Vendor Credit is filed in", "type": "string", "x-node_available_in": [ "uk" ], "x-node_unavailable_in": [] }, "filed_in_vat_return_name": { "description": "Name of the VAT Return the Vendor Credit is filed in", "type": "string", "x-node_available_in": [ "uk" ], "x-node_unavailable_in": [] }, "filed_in_vat_return_type": { "description": "Type of the VAT Return the Vendor Credit is filed in", "type": "string", "x-node_available_in": [ "uk" ], "x-node_unavailable_in": [] }, "imported_transaction_id": { "description": "ID of the Imported Transaction", "type": "string", "example": "460000000013297" }, "payee": { "description": "Payee of the Transaction", "type": "string", "example": "John Roberts" }, "imported_transactions": { "type": "array", "items": { "type": "object", "properties": { "imported_transaction_id": { "$ref": "#/components/schemas/imported_transaction_id" }, "date": { "$ref": "#/components/schemas/date" }, "amount": { "$ref": "#/components/schemas/amount" }, "payee": { "$ref": "#/components/schemas/payee" }, "description": { "$ref": "#/components/schemas/description" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "status": { "$ref": "#/components/schemas/status" }, "account_id": { "$ref": "#/components/schemas/account_id" } } } }, "vendor_credit_refunds": { "type": "array", "items": { "type": "object", "properties": { "vendor_credit_refund_id": { "$ref": "#/components/schemas/vendor_credit_refund_id" }, "vendor_credit_id": { "$ref": "#/components/schemas/vendor_credit_id" }, "date": { "$ref": "#/components/schemas/date" }, "refund_mode": { "$ref": "#/components/schemas/refund_mode" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "description": { "$ref": "#/components/schemas/description" }, "amount_bcy": { "$ref": "#/components/schemas/amount_bcy" }, "amount_fcy": { "$ref": "#/components/schemas/amount_fcy" }, "filed_in_vat_return_id": { "$ref": "#/components/schemas/filed_in_vat_return_id" }, "filed_in_vat_return_name": { "$ref": "#/components/schemas/filed_in_vat_return_name" }, "filed_in_vat_return_type": { "$ref": "#/components/schemas/filed_in_vat_return_type" } } } }, "vendor_credit_refund": { "type": "object", "properties": { "vendor_credit_refund_id": { "$ref": "#/components/schemas/vendor_credit_refund_id" }, "vendor_credit_id": { "$ref": "#/components/schemas/vendor_credit_id" }, "date": { "$ref": "#/components/schemas/date" }, "refund_mode": { "$ref": "#/components/schemas/refund_mode" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "amount": { "$ref": "#/components/schemas/amount" }, "exchange_rate": { "$ref": "#/components/schemas/exchange_rate" }, "account_id": { "$ref": "#/components/schemas/account_id" }, "account_name": { "$ref": "#/components/schemas/account_name" }, "description": { "$ref": "#/components/schemas/description" }, "imported_transactions": { "$ref": "#/components/schemas/imported_transactions" } } }, "line_items": { "description": "Line items of a vendor credit.", "type": "array", "items": { "type": "object", "properties": { "item_id": { "$ref": "#/components/schemas/item_id" }, "line_item_id": { "$ref": "#/components/schemas/line_item_id" }, "account_id": { "$ref": "#/components/schemas/account_id" }, "name": { "$ref": "#/components/schemas/name" }, "hsn_or_sac": { "$ref": "#/components/schemas/hsn_or_sac" }, "reverse_charge_tax_id": { "$ref": "#/components/schemas/reverse_charge_tax_id" }, "location_id": { "$ref": "#/components/schemas/location_id" }, "description": { "$ref": "#/components/schemas/description" }, "item_order": { "$ref": "#/components/schemas/item_order" }, "quantity": { "$ref": "#/components/schemas/quantity" }, "unit": { "$ref": "#/components/schemas/unit" }, "rate": { "$ref": "#/components/schemas/rate" }, "tax_id": { "$ref": "#/components/schemas/tax_id" }, "tds_tax_id": { "$ref": "#/components/schemas/tds_tax_id" }, "tax_treatment_code": { "$ref": "#/components/schemas/tax_treatment_code" }, "tags": { "$ref": "#/components/schemas/tags" }, "item_custom_fields": { "$ref": "#/components/schemas/item_custom_fields" }, "serial_numbers": { "$ref": "#/components/schemas/serial_numbers" }, "batches": { "$ref": "#/components/schemas/batches-response" }, "storages": { "$ref": "#/components/schemas/storages-response" }, "project_id": { "$ref": "#/components/schemas/project_id" }, "project_name": { "$ref": "#/components/schemas/project_name" } } } }, "comments": { "type": "array", "items": { "type": "object", "properties": { "comment_id": { "$ref": "#/components/schemas/comment_id" }, "vendor_credit_id": { "$ref": "#/components/schemas/vendor_credit_id" }, "description": { "$ref": "#/components/schemas/description" }, "commented_by_id": { "$ref": "#/components/schemas/commented_by_id" }, "commented_by": { "$ref": "#/components/schemas/commented_by" }, "comment_type": { "$ref": "#/components/schemas/comment_type" }, "date": { "$ref": "#/components/schemas/date" }, "date_description": { "$ref": "#/components/schemas/date_description" }, "time": { "$ref": "#/components/schemas/time" }, "operation_type": { "$ref": "#/components/schemas/operation_type" }, "transaction_id": { "$ref": "#/components/schemas/transaction_id" }, "transaction_type": { "$ref": "#/components/schemas/transaction_type" } } } }, "vendor_credit": { "type": "object", "properties": { "vendor_credit_id": { "$ref": "#/components/schemas/vendor_credit_id" }, "vendor_credit_number": { "$ref": "#/components/schemas/vendor_credit_number" }, "date": { "$ref": "#/components/schemas/date" }, "status": { "$ref": "#/components/schemas/status" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "vendor_id": { "$ref": "#/components/schemas/vendor_id" }, "vendor_name": { "$ref": "#/components/schemas/vendor_name" }, "currency_id": { "$ref": "#/components/schemas/currency_id" }, "currency_code": { "$ref": "#/components/schemas/currency_code" }, "exchange_rate": { "$ref": "#/components/schemas/exchange_rate" }, "price_precision": { "$ref": "#/components/schemas/price_precision" }, "vat_treatment": { "$ref": "#/components/schemas/vat_treatment" }, "filed_in_vat_return_id": { "$ref": "#/components/schemas/filed_in_vat_return_id" }, "filed_in_vat_return_name": { "$ref": "#/components/schemas/filed_in_vat_return_name" }, "filed_in_vat_return_type": { "$ref": "#/components/schemas/filed_in_vat_return_type" }, "is_inclusive_tax": { "$ref": "#/components/schemas/is_inclusive_tax" }, "location_id": { "$ref": "#/components/schemas/location_id" }, "location_name": { "$ref": "#/components/schemas/location_name" }, "line_items": { "$ref": "#/components/schemas/line_items" }, "acquisition_vat_summary": { "$ref": "#/components/schemas/acquisition_vat_summary" }, "acquisition_vat_total": { "$ref": "#/components/schemas/acquisition_vat_total" }, "reverse_charge_vat_summary": { "$ref": "#/components/schemas/reverse_charge_vat_summary" }, "reverse_charge_vat_total": { "$ref": "#/components/schemas/reverse_charge_vat_total" }, "documents": { "$ref": "#/components/schemas/documents" }, "custom_fields": { "$ref": "#/components/schemas/custom_fields" }, "sub_total": { "$ref": "#/components/schemas/sub_total" }, "total": { "$ref": "#/components/schemas/total" }, "total_credits_used": { "$ref": "#/components/schemas/total_credits_used" }, "total_refunded_amount": { "$ref": "#/components/schemas/total_refunded_amount" }, "balance": { "$ref": "#/components/schemas/balance" }, "notes": { "$ref": "#/components/schemas/notes" }, "comments": { "$ref": "#/components/schemas/comments" }, "vendor_credit_refunds": { "$ref": "#/components/schemas/vendor_credit_refunds" }, "bills_credited": { "$ref": "#/components/schemas/bills_credited" }, "created_time": { "$ref": "#/components/schemas/created_time" }, "last_modified_time": { "$ref": "#/components/schemas/last_modified_time" } } }, "page_context": { "type": "object", "properties": { "page": { "$ref": "#/components/schemas/page" }, "per_page": { "$ref": "#/components/schemas/per_page" }, "has_more_page": { "$ref": "#/components/schemas/has_more_page" }, "report_name": { "$ref": "#/components/schemas/report_name" }, "applied_filter": { "$ref": "#/components/schemas/applied_filter" }, "sort_column": { "$ref": "#/components/schemas/sort_column" }, "sort_order": { "$ref": "#/components/schemas/sort_order" } } }, "customer_id": { "description": "Search vendor credits by vendor credit customer ID", "type": "string" }, "custom_field": { "description": "Search vendor credits by custom field. Variants : custom_field_startswith and custom_field_contains", "type": "string" }, "create-a-vendor-credit-request": { "required": [ "vendor_id" ], "type": "object", "properties": { "vendor_id": { "$ref": "#/components/schemas/vendor_id" }, "vat_treatment": { "$ref": "#/components/schemas/vat_treatment" }, "vendor_credit_number": { "description": "Mandatory if auto number generation is disabled.", "type": "string", "example": "DN-00002" }, "gst_treatment": { "$ref": "#/components/schemas/gst_treatment" }, "tax_treatment": { "$ref": "#/components/schemas/tax_treatment" }, "gst_no": { "$ref": "#/components/schemas/gst_no" }, "source_of_supply": { "$ref": "#/components/schemas/source_of_supply" }, "destination_of_supply": { "$ref": "#/components/schemas/destination_of_supply" }, "place_of_supply": { "$ref": "#/components/schemas/place_of_supply" }, "pricebook_id": { "$ref": "#/components/schemas/pricebook_id" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "is_update_customer": { "$ref": "#/components/schemas/is_update_customer" }, "date": { "$ref": "#/components/schemas/date" }, "exchange_rate": { "$ref": "#/components/schemas/exchange_rate" }, "is_inclusive_tax": { "$ref": "#/components/schemas/is_inclusive_tax" }, "location_id": { "$ref": "#/components/schemas/location_id" }, "line_items": { "description": "Line items of a vendor credit.", "type": "array", "items": { "type": "object", "properties": { "item_id": { "$ref": "#/components/schemas/item_id" }, "line_item_id": { "$ref": "#/components/schemas/line_item_id" }, "account_id": { "$ref": "#/components/schemas/account_id" }, "name": { "$ref": "#/components/schemas/name" }, "hsn_or_sac": { "$ref": "#/components/schemas/hsn_or_sac" }, "reverse_charge_tax_id": { "$ref": "#/components/schemas/reverse_charge_tax_id" }, "location_id": { "$ref": "#/components/schemas/location_id" }, "description": { "$ref": "#/components/schemas/description" }, "item_order": { "$ref": "#/components/schemas/item_order" }, "quantity": { "$ref": "#/components/schemas/quantity" }, "unit": { "$ref": "#/components/schemas/unit" }, "rate": { "$ref": "#/components/schemas/rate" }, "tax_id": { "$ref": "#/components/schemas/tax_id" }, "tds_tax_id": { "$ref": "#/components/schemas/tds_tax_id" }, "tax_treatment_code": { "$ref": "#/components/schemas/tax_treatment_code" }, "tags": { "$ref": "#/components/schemas/tags" }, "item_custom_fields": { "$ref": "#/components/schemas/item_custom_fields" }, "project_id": { "$ref": "#/components/schemas/project_id" }, "project_name": { "$ref": "#/components/schemas/project_name" }, "serial_numbers": { "$ref": "#/components/schemas/serial_numbers" }, "batches": { "$ref": "#/components/schemas/batches" }, "storages": { "$ref": "#/components/schemas/storages" } } } }, "notes": { "$ref": "#/components/schemas/notes" }, "documents": { "$ref": "#/components/schemas/documents" }, "custom_fields": { "$ref": "#/components/schemas/custom_fields" } } }, "create-a-vendor-credit-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "Vendor credit has been created.", "readOnly": true }, "vendor_credit": { "$ref": "#/components/schemas/vendor_credit-response" } } }, "list-vendor-credits-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "success", "readOnly": true }, "vendorcredits": { "type": "array", "items": { "type": "object", "properties": { "vendor_credit_id": { "$ref": "#/components/schemas/vendor_credit_id" }, "vendor_credit_number": { "$ref": "#/components/schemas/vendor_credit_number" }, "status": { "$ref": "#/components/schemas/status" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "date": { "$ref": "#/components/schemas/date" }, "total": { "$ref": "#/components/schemas/total" }, "balance": { "$ref": "#/components/schemas/balance" }, "vendor_id": { "$ref": "#/components/schemas/vendor_id" }, "vendor_name": { "$ref": "#/components/schemas/vendor_name" }, "currency_id": { "$ref": "#/components/schemas/currency_id" }, "currency_code": { "$ref": "#/components/schemas/currency_code" }, "created_time": { "$ref": "#/components/schemas/created_time" }, "last_modified_time": { "$ref": "#/components/schemas/last_modified_time" }, "has_attachment": { "$ref": "#/components/schemas/has_attachment" }, "exchange_rate": { "$ref": "#/components/schemas/exchange_rate" } } } } } }, "update-vendor-credit-request": { "required": [ "vendor_id" ], "type": "object", "properties": { "vendor_id": { "$ref": "#/components/schemas/vendor_id" }, "vat_treatment": { "$ref": "#/components/schemas/vat_treatment" }, "vendor_credit_number": { "description": "Mandatory if auto number generation is disabled.", "type": "string", "example": "DN-00002" }, "gst_treatment": { "$ref": "#/components/schemas/gst_treatment" }, "tax_treatment": { "$ref": "#/components/schemas/tax_treatment" }, "gst_no": { "$ref": "#/components/schemas/gst_no" }, "source_of_supply": { "$ref": "#/components/schemas/source_of_supply" }, "destination_of_supply": { "$ref": "#/components/schemas/destination_of_supply" }, "place_of_supply": { "$ref": "#/components/schemas/place_of_supply" }, "pricebook_id": { "$ref": "#/components/schemas/pricebook_id" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "is_update_customer": { "$ref": "#/components/schemas/is_update_customer" }, "date": { "$ref": "#/components/schemas/date" }, "exchange_rate": { "$ref": "#/components/schemas/exchange_rate" }, "is_inclusive_tax": { "$ref": "#/components/schemas/is_inclusive_tax" }, "location_id": { "$ref": "#/components/schemas/location_id" }, "line_items": { "description": "Line items of a vendor credit.", "type": "array", "items": { "type": "object", "properties": { "item_id": { "$ref": "#/components/schemas/item_id" }, "line_item_id": { "$ref": "#/components/schemas/line_item_id" }, "account_id": { "$ref": "#/components/schemas/account_id" }, "name": { "$ref": "#/components/schemas/name" }, "hsn_or_sac": { "$ref": "#/components/schemas/hsn_or_sac" }, "reverse_charge_tax_id": { "$ref": "#/components/schemas/reverse_charge_tax_id" }, "location_id": { "$ref": "#/components/schemas/location_id" }, "description": { "$ref": "#/components/schemas/description" }, "item_order": { "$ref": "#/components/schemas/item_order" }, "quantity": { "$ref": "#/components/schemas/quantity" }, "unit": { "$ref": "#/components/schemas/unit" }, "rate": { "$ref": "#/components/schemas/rate" }, "tax_id": { "$ref": "#/components/schemas/tax_id" }, "tds_tax_id": { "$ref": "#/components/schemas/tds_tax_id" }, "tax_treatment_code": { "$ref": "#/components/schemas/tax_treatment_code" }, "tags": { "$ref": "#/components/schemas/tags" }, "item_custom_fields": { "$ref": "#/components/schemas/item_custom_fields" }, "project_id": { "$ref": "#/components/schemas/project_id" }, "project_name": { "$ref": "#/components/schemas/project_name" }, "serial_numbers": { "$ref": "#/components/schemas/serial_numbers" }, "batches": { "$ref": "#/components/schemas/batches-update" }, "storages": { "$ref": "#/components/schemas/storages-update" } } } }, "notes": { "$ref": "#/components/schemas/notes" }, "documents": { "$ref": "#/components/schemas/documents" }, "custom_fields": { "$ref": "#/components/schemas/custom_fields" } } }, "update-vendor-credit-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "Vendor credit information has been updated.", "readOnly": true }, "vendor_credit": { "type": "object", "properties": { "vendor_credit_id": { "$ref": "#/components/schemas/vendor_credit_id" }, "vendor_credit_number": { "$ref": "#/components/schemas/vendor_credit_number" }, "date": { "$ref": "#/components/schemas/date" }, "source_of_supply": { "$ref": "#/components/schemas/source_of_supply" }, "destination_of_supply": { "$ref": "#/components/schemas/destination_of_supply" }, "place_of_supply": { "$ref": "#/components/schemas/place_of_supply" }, "gst_no": { "$ref": "#/components/schemas/gst_no" }, "gst_treatment": { "$ref": "#/components/schemas/gst_treatment" }, "tax_treatment": { "$ref": "#/components/schemas/tax_treatment" }, "pricebook_id": { "$ref": "#/components/schemas/pricebook_id" }, "is_reverse_charge_applied": { "$ref": "#/components/schemas/is_reverse_charge_applied" }, "status": { "$ref": "#/components/schemas/status" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "vendor_id": { "$ref": "#/components/schemas/vendor_id" }, "vendor_name": { "$ref": "#/components/schemas/vendor_name" }, "currency_id": { "$ref": "#/components/schemas/currency_id" }, "currency_code": { "$ref": "#/components/schemas/currency_code" }, "exchange_rate": { "$ref": "#/components/schemas/exchange_rate" }, "price_precision": { "$ref": "#/components/schemas/price_precision" }, "vat_treatment": { "$ref": "#/components/schemas/vat_treatment" }, "taxes": { "$ref": "#/components/schemas/taxes" }, "is_inclusive_tax": { "$ref": "#/components/schemas/is_inclusive_tax" }, "location_id": { "$ref": "#/components/schemas/location_id" }, "location_name": { "$ref": "#/components/schemas/location_name" }, "line_items": { "description": "Line items of a vendor credit.", "type": "object", "properties": { "item_id": { "$ref": "#/components/schemas/item_id" }, "line_item_id": { "$ref": "#/components/schemas/line_item_id" }, "sku": { "$ref": "#/components/schemas/sku" }, "location_id": { "$ref": "#/components/schemas/location_id" }, "location_name": { "$ref": "#/components/schemas/location_name" }, "account_id": { "$ref": "#/components/schemas/account_id" }, "product_type": { "$ref": "#/components/schemas/product_type" }, "reverse_charge_tax_id": { "$ref": "#/components/schemas/reverse_charge_tax_id" }, "reverse_charge_tax_name": { "$ref": "#/components/schemas/reverse_charge_tax_name" }, "reverse_charge_tax_percentage": { "$ref": "#/components/schemas/reverse_charge_tax_percentage" }, "reverse_charge_tax_amount": { "$ref": "#/components/schemas/reverse_charge_tax_amount" }, "account_name": { "$ref": "#/components/schemas/account_name" }, "name": { "$ref": "#/components/schemas/name" }, "description": { "$ref": "#/components/schemas/description" }, "item_order": { "$ref": "#/components/schemas/item_order" }, "quantity": { "$ref": "#/components/schemas/quantity" }, "unit": { "$ref": "#/components/schemas/unit" }, "bcy_rate": { "$ref": "#/components/schemas/bcy_rate" }, "rate": { "$ref": "#/components/schemas/rate" }, "tax_id": { "$ref": "#/components/schemas/tax_id" }, "tds_tax_id": { "$ref": "#/components/schemas/tds_tax_id" }, "tax_treatment_code": { "$ref": "#/components/schemas/tax_treatment_code" }, "tax_exemption_id": { "$ref": "#/components/schemas/tax_exemption_id" }, "tax_exemption_code": { "$ref": "#/components/schemas/tax_exemption_code" }, "tax_name": { "$ref": "#/components/schemas/tax_name" }, "tax_type": { "$ref": "#/components/schemas/tax_type" }, "tax_percentage": { "$ref": "#/components/schemas/tax_percentage" }, "item_total": { "$ref": "#/components/schemas/item_total" }, "item_total_inclusive_of_tax": { "$ref": "#/components/schemas/item_total_inclusive_of_tax" }, "hsn_or_sac": { "$ref": "#/components/schemas/hsn_or_sac" }, "acquisition_vat_id": { "$ref": "#/components/schemas/acquisition_vat_id" }, "acquisition_vat_name": { "$ref": "#/components/schemas/acquisition_vat_name" }, "acquisition_vat_percentage": { "$ref": "#/components/schemas/acquisition_vat_percentage" }, "acquisition_vat_amount": { "$ref": "#/components/schemas/acquisition_vat_amount" }, "reverse_charge_vat_id": { "$ref": "#/components/schemas/reverse_charge_vat_id" }, "reverse_charge_vat_name": { "$ref": "#/components/schemas/reverse_charge_vat_name" }, "reverse_charge_vat_percentage": { "$ref": "#/components/schemas/reverse_charge_vat_percentage" }, "reverse_charge_vat_amount": { "$ref": "#/components/schemas/reverse_charge_vat_amount" }, "stock_on_hand": { "$ref": "#/components/schemas/stock_on_hand" }, "tags": { "$ref": "#/components/schemas/tags" }, "item_custom_fields": { "$ref": "#/components/schemas/item_custom_fields" } } }, "acquisition_vat_summary": { "$ref": "#/components/schemas/acquisition_vat_summary" }, "acquisition_vat_total": { "$ref": "#/components/schemas/acquisition_vat_total" }, "reverse_charge_vat_summary": { "$ref": "#/components/schemas/reverse_charge_vat_summary" }, "reverse_charge_vat_total": { "$ref": "#/components/schemas/reverse_charge_vat_total" }, "documents": { "$ref": "#/components/schemas/documents" }, "custom_fields": { "$ref": "#/components/schemas/custom_fields" }, "sub_total": { "$ref": "#/components/schemas/sub_total" }, "total": { "$ref": "#/components/schemas/total" }, "total_credits_used": { "$ref": "#/components/schemas/total_credits_used" }, "total_refunded_amount": { "$ref": "#/components/schemas/total_refunded_amount" }, "balance": { "$ref": "#/components/schemas/balance" }, "notes": { "$ref": "#/components/schemas/notes" }, "comments": { "$ref": "#/components/schemas/comments" }, "vendor_credit_refunds": { "type": "array", "items": { "type": "object", "properties": { "vendor_credit_refund_id": { "$ref": "#/components/schemas/vendor_credit_refund_id" }, "vendor_credit_id": { "$ref": "#/components/schemas/vendor_credit_id" }, "date": { "description": "Date of the Vendor Credit Refund", "type": "string" }, "refund_mode": { "$ref": "#/components/schemas/refund_mode" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "description": { "$ref": "#/components/schemas/description" }, "amount_bcy": { "$ref": "#/components/schemas/amount_bcy" }, "amount_fcy": { "$ref": "#/components/schemas/amount_fcy" } } } }, "bills_credited": { "$ref": "#/components/schemas/bills_credited" }, "created_time": { "$ref": "#/components/schemas/created_time" }, "last_modified_time": { "$ref": "#/components/schemas/last_modified_time" } } } } }, "get-vendor-credit-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "success", "readOnly": true }, "vendor_credit": { "type": "object", "properties": { "vendor_credit_id": { "$ref": "#/components/schemas/vendor_credit_id" }, "vendor_credit_number": { "$ref": "#/components/schemas/vendor_credit_number" }, "date": { "$ref": "#/components/schemas/date" }, "status": { "$ref": "#/components/schemas/status" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "source_of_supply": { "$ref": "#/components/schemas/source_of_supply" }, "destination_of_supply": { "$ref": "#/components/schemas/destination_of_supply" }, "place_of_supply": { "$ref": "#/components/schemas/place_of_supply" }, "gst_no": { "$ref": "#/components/schemas/gst_no" }, "gst_treatment": { "$ref": "#/components/schemas/gst_treatment" }, "tax_treatment": { "$ref": "#/components/schemas/tax_treatment" }, "pricebook_id": { "$ref": "#/components/schemas/pricebook_id" }, "is_reverse_charge_applied": { "$ref": "#/components/schemas/is_reverse_charge_applied" }, "vendor_id": { "$ref": "#/components/schemas/vendor_id" }, "vendor_name": { "$ref": "#/components/schemas/vendor_name" }, "currency_id": { "$ref": "#/components/schemas/currency_id" }, "currency_code": { "$ref": "#/components/schemas/currency_code" }, "exchange_rate": { "$ref": "#/components/schemas/exchange_rate" }, "price_precision": { "$ref": "#/components/schemas/price_precision" }, "vat_treatment": { "$ref": "#/components/schemas/vat_treatment" }, "filed_in_vat_return_id": { "$ref": "#/components/schemas/filed_in_vat_return_id" }, "filed_in_vat_return_name": { "$ref": "#/components/schemas/filed_in_vat_return_name" }, "filed_in_vat_return_type": { "$ref": "#/components/schemas/filed_in_vat_return_type" }, "is_inclusive_tax": { "$ref": "#/components/schemas/is_inclusive_tax" }, "location_id": { "$ref": "#/components/schemas/location_id" }, "location_name": { "$ref": "#/components/schemas/location_name" }, "line_items": { "description": "Line items of a vendor credit.", "type": "object", "properties": { "item_id": { "$ref": "#/components/schemas/item_id" }, "line_item_id": { "$ref": "#/components/schemas/line_item_id" }, "sku": { "$ref": "#/components/schemas/sku" }, "location_id": { "$ref": "#/components/schemas/location_id" }, "location_name": { "$ref": "#/components/schemas/location_name" }, "account_id": { "$ref": "#/components/schemas/account_id" }, "product_type": { "$ref": "#/components/schemas/product_type" }, "reverse_charge_tax_id": { "$ref": "#/components/schemas/reverse_charge_tax_id" }, "reverse_charge_tax_name": { "$ref": "#/components/schemas/reverse_charge_tax_name" }, "reverse_charge_tax_percentage": { "$ref": "#/components/schemas/reverse_charge_tax_percentage" }, "reverse_charge_tax_amount": { "$ref": "#/components/schemas/reverse_charge_tax_amount" }, "account_name": { "$ref": "#/components/schemas/account_name" }, "name": { "$ref": "#/components/schemas/name" }, "description": { "$ref": "#/components/schemas/description" }, "item_order": { "$ref": "#/components/schemas/item_order" }, "quantity": { "$ref": "#/components/schemas/quantity" }, "unit": { "$ref": "#/components/schemas/unit" }, "bcy_rate": { "$ref": "#/components/schemas/bcy_rate" }, "rate": { "$ref": "#/components/schemas/rate" }, "tax_id": { "$ref": "#/components/schemas/tax_id" }, "tax_treatment_code": { "$ref": "#/components/schemas/tax_treatment_code" }, "tax_exemption_id": { "$ref": "#/components/schemas/tax_exemption_id" }, "tax_exemption_code": { "$ref": "#/components/schemas/tax_exemption_code" }, "tax_name": { "$ref": "#/components/schemas/tax_name" }, "tax_type": { "$ref": "#/components/schemas/tax_type" }, "tax_percentage": { "$ref": "#/components/schemas/tax_percentage" }, "item_total": { "$ref": "#/components/schemas/item_total" }, "item_total_inclusive_of_tax": { "$ref": "#/components/schemas/item_total_inclusive_of_tax" }, "hsn_or_sac": { "$ref": "#/components/schemas/hsn_or_sac" }, "acquisition_vat_id": { "$ref": "#/components/schemas/acquisition_vat_id" }, "acquisition_vat_name": { "$ref": "#/components/schemas/acquisition_vat_name" }, "acquisition_vat_percentage": { "$ref": "#/components/schemas/acquisition_vat_percentage" }, "acquisition_vat_amount": { "$ref": "#/components/schemas/acquisition_vat_amount" }, "reverse_charge_vat_id": { "$ref": "#/components/schemas/reverse_charge_vat_id" }, "reverse_charge_vat_name": { "$ref": "#/components/schemas/reverse_charge_vat_name" }, "reverse_charge_vat_percentage": { "$ref": "#/components/schemas/reverse_charge_vat_percentage" }, "reverse_charge_vat_amount": { "$ref": "#/components/schemas/reverse_charge_vat_amount" }, "stock_on_hand": { "$ref": "#/components/schemas/stock_on_hand" }, "tags": { "$ref": "#/components/schemas/tags" }, "item_custom_fields": { "$ref": "#/components/schemas/item_custom_fields" }, "project_id": { "$ref": "#/components/schemas/project_id" }, "project_name": { "$ref": "#/components/schemas/project_name" } } }, "acquisition_vat_summary": { "$ref": "#/components/schemas/acquisition_vat_summary" }, "acquisition_vat_total": { "$ref": "#/components/schemas/acquisition_vat_total" }, "reverse_charge_vat_summary": { "$ref": "#/components/schemas/reverse_charge_vat_summary" }, "reverse_charge_vat_total": { "$ref": "#/components/schemas/reverse_charge_vat_total" }, "documents": { "$ref": "#/components/schemas/documents" }, "custom_fields": { "$ref": "#/components/schemas/custom_fields" }, "sub_total": { "$ref": "#/components/schemas/sub_total" }, "total": { "$ref": "#/components/schemas/total" }, "total_credits_used": { "$ref": "#/components/schemas/total_credits_used" }, "total_refunded_amount": { "$ref": "#/components/schemas/total_refunded_amount" }, "balance": { "$ref": "#/components/schemas/balance" }, "notes": { "$ref": "#/components/schemas/notes" }, "comments": { "$ref": "#/components/schemas/comments" }, "vendor_credit_refunds": { "$ref": "#/components/schemas/vendor_credit_refunds" }, "bills_credited": { "$ref": "#/components/schemas/bills_credited" }, "created_time": { "$ref": "#/components/schemas/created_time" }, "last_modified_time": { "$ref": "#/components/schemas/last_modified_time" } } } } }, "delete-vendor-credit-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "The vendor credit has been deleted.", "readOnly": true } } }, "convert-to-open-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "The status of the vendor credit has been changed to open.", "readOnly": true } } }, "void-vendor-credit-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "The vendor credit has been voided.", "readOnly": true } } }, "submit-a-vendor-credit-for-approval-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "The vendor credit has been submitted for approval successfully.", "readOnly": true } } }, "approve-a-vendor-credit-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "You have approved the vendor credit.", "readOnly": true } } }, "list-bills-credited-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "success", "readOnly": true }, "bills_credited": { "type": "array", "items": { "type": "object", "properties": { "vendor_credit_id": { "$ref": "#/components/schemas/vendor_credit_id" }, "bill_id": { "$ref": "#/components/schemas/bill_id" }, "vendor_credit_bill_id": { "$ref": "#/components/schemas/vendor_credit_bill_id" }, "date": { "$ref": "#/components/schemas/date" }, "bill_number": { "$ref": "#/components/schemas/bill_number" } } } } } }, "apply-credits-to-a-bill-request": { "required": [ "bills" ], "type": "object", "properties": { "bills": { "description": "Amount applied from vendor credits to specified bills.", "type": "array", "items": { "type": "object", "required": [ "bill_id", "amount_applied" ], "properties": { "bill_id": { "description": "Bill Associated with the Vendor Credit", "type": "string", "example": "460000000057075" }, "amount_applied": { "description": "Amount applied to the bill.", "type": "number", "format": "double", "example": 10 } } } } } }, "apply-credits-to-a-bill-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "Credits have been applied to the bill(s).", "readOnly": true }, "bills": { "description": "Amount applied from vendor credits to specified bills." } } }, "delete-bills-credited-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "Credits applied to the bill have been deleted.", "readOnly": true } } }, "refund-a-vendor-credit-request": { "required": [ "date", "amount", "account_id" ], "type": "object", "properties": { "date": { "description": "Date of Vendor Credit Refund", "type": "string", "example": "2014-08-30" }, "refund_mode": { "$ref": "#/components/schemas/refund_mode" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "amount": { "$ref": "#/components/schemas/amount" }, "exchange_rate": { "$ref": "#/components/schemas/exchange_rate" }, "account_id": { "$ref": "#/components/schemas/account_id" }, "description": { "$ref": "#/components/schemas/description" } } }, "refund-a-vendor-credit-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "The refund information for this vendor credit has been saved.", "readOnly": true }, "vendor_credit_refund": { "$ref": "#/components/schemas/vendor_credit_refund" } } }, "list-refunds-of-a-vendor-credit-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "success", "readOnly": true }, "vendor_credit_refunds": { "type": "array", "items": { "type": "object", "properties": { "vendor_credit_refund_id": { "$ref": "#/components/schemas/vendor_credit_refund_id" }, "vendor_credit_id": { "$ref": "#/components/schemas/vendor_credit_id" }, "date": { "description": "Date of the Vendor Credit Refund", "type": "string", "example": "2017-01-22" }, "refund_mode": { "$ref": "#/components/schemas/refund_mode" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "amount": { "$ref": "#/components/schemas/amount" }, "vendor_credit_number": { "$ref": "#/components/schemas/vendor_credit_number" }, "customer_name": { "$ref": "#/components/schemas/customer_name" }, "description": { "description": "Description of the Vendor Credit Refund", "type": "string", "example": "Cheque deposit" }, "amount_bcy": { "$ref": "#/components/schemas/amount_bcy" }, "amount_fcy": { "$ref": "#/components/schemas/amount_fcy" } } } } } }, "update-vendor-credit-refund-request": { "required": [ "date", "amount", "account_id" ], "type": "object", "properties": { "date": { "$ref": "#/components/schemas/date" }, "refund_mode": { "$ref": "#/components/schemas/refund_mode" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "amount": { "$ref": "#/components/schemas/amount" }, "exchange_rate": { "$ref": "#/components/schemas/exchange_rate" }, "account_id": { "$ref": "#/components/schemas/account_id" }, "description": { "$ref": "#/components/schemas/description" } } }, "update-vendor-credit-refund-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "The refund information has been saved.", "readOnly": true }, "vendor_credit_refund": { "$ref": "#/components/schemas/vendor_credit_refund" } } }, "get-vendor-credit-refund-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "success", "readOnly": true }, "vendor_credit_refund": { "$ref": "#/components/schemas/vendor_credit_refund" } } }, "delete-vendor-credit-refund-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "The refund has been successfully deleted.", "readOnly": true } } }, "list-vendor-credit-refunds-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "success", "readOnly": true }, "vendor_credit_refunds": { "type": "array", "items": { "type": "object", "properties": { "vendor_credit_refund_id": { "$ref": "#/components/schemas/vendor_credit_refund_id" }, "vendor_credit_id": { "$ref": "#/components/schemas/vendor_credit_id" }, "date": { "description": "Date of the Vendor Credit Refund", "type": "string", "example": "2017-01-22" }, "refund_mode": { "$ref": "#/components/schemas/refund_mode" }, "reference_number": { "$ref": "#/components/schemas/reference_number" }, "amount": { "$ref": "#/components/schemas/amount" }, "vendor_credit_number": { "$ref": "#/components/schemas/vendor_credit_number" }, "customer_name": { "$ref": "#/components/schemas/customer_name" }, "description": { "description": "Description of the Vendor Credit Refund", "type": "string", "example": "Cheque deposit" }, "amount_bcy": { "$ref": "#/components/schemas/amount_bcy" }, "amount_fcy": { "$ref": "#/components/schemas/amount_fcy" } } } } } }, "add-a-comment-request": { "required": [ "description" ], "type": "object", "properties": { "description": { "description": "Description of the Comment", "type": "string", "example": "Credits applied to Bill 1" } } }, "add-a-comment-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "Comments added.", "readOnly": true }, "comment": { "type": "object", "properties": { "comment_id": { "$ref": "#/components/schemas/comment_id" }, "vendor_credit_id": { "$ref": "#/components/schemas/vendor_credit_id" }, "description": { "description": "Description of the Comment", "type": "string", "example": "Credits applied to Bill 1" }, "commented_by_id": { "$ref": "#/components/schemas/commented_by_id" }, "commented_by": { "$ref": "#/components/schemas/commented_by" }, "date": { "description": "Date of the Comment", "type": "string", "example": "2017-01-18" } } } } }, "list-vendor-credit-comments-and-history-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "success", "readOnly": true }, "comments": { "type": "array", "items": { "type": "object", "properties": { "comment_id": { "$ref": "#/components/schemas/comment_id" }, "vendor_credit_id": { "$ref": "#/components/schemas/vendor_credit_id" }, "description": { "description": "Description of the Comment", "type": "string", "example": "Credits applied to Bill 1" }, "commented_by_id": { "$ref": "#/components/schemas/commented_by_id" }, "commented_by": { "$ref": "#/components/schemas/commented_by" }, "comment_type": { "$ref": "#/components/schemas/comment_type" }, "date": { "description": "Date of the Comment", "type": "string", "example": "2017-01-18" }, "date_description": { "$ref": "#/components/schemas/date_description" }, "time": { "$ref": "#/components/schemas/time" }, "operation_type": { "$ref": "#/components/schemas/operation_type" }, "transaction_id": { "$ref": "#/components/schemas/transaction_id" }, "transaction_type": { "$ref": "#/components/schemas/transaction_type" } } } } } }, "delete-a-comment-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "The comment has been deleted.", "readOnly": true } } } } }