Zoho Inventory · Schema
Credit Notes
Credit notes are created when a refund is to be made to a customer. A credit note object allows you to keep track of all credit note related information. Note While creating credit notes from Sales Order Invoice or Sales Return, it is recommended to use the same values which are used in the Invoice for corresponding nodes in the credit note.
Inventory ManagementWarehousingSales OrdersPurchase OrdersStock AdjustmentShipmentsItemsE-commerce
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Credit Notes",
"description": "Credit notes are created when a refund is to be made to a customer. A credit note object allows you to keep track of all credit note related information. <code>Note</code> While creating credit notes from Sales Order Invoice or Sales Return, it is recommended to use the same values which are used in the Invoice for corresponding nodes in the credit note.",
"definitions": {
"gendoc-attributes-schema": {
"$ref": "#/components/schemas/creditnote-response"
},
"creditnote-response": {
"type": "object",
"properties": {
"creditnote_id": {
"$ref": "#/components/schemas/creditnote_id"
},
"creditnote_number": {
"$ref": "#/components/schemas/creditnote_number"
},
"contact_persons_associated": {
"$ref": "#/components/schemas/contact_persons_associated"
},
"date": {
"$ref": "#/components/schemas/date"
},
"is_pre_gst": {
"$ref": "#/components/schemas/is_pre_gst"
},
"place_of_supply": {
"$ref": "#/components/schemas/place_of_supply"
},
"vat_treatment": {
"$ref": "#/components/schemas/vat_treatment"
},
"vat_reg_no": {
"$ref": "#/components/schemas/vat_reg_no"
},
"gst_no": {
"$ref": "#/components/schemas/gst_no"
},
"cfdi_usage": {
"$ref": "#/components/schemas/cfdi_usage"
},
"cfdi_reference_type": {
"$ref": "#/components/schemas/cfdi_reference_type"
},
"gst_treatment": {
"$ref": "#/components/schemas/gst_treatment"
},
"tax_treatment": {
"$ref": "#/components/schemas/tax_treatment"
},
"status": {
"$ref": "#/components/schemas/status"
},
"customer_id": {
"$ref": "#/components/schemas/customer_id"
},
"customer_name": {
"$ref": "#/components/schemas/customer_name"
},
"custom_fields": {
"$ref": "#/components/schemas/custom_fields"
},
"reference_number": {
"$ref": "#/components/schemas/reference_number"
},
"email": {
"$ref": "#/components/schemas/email"
},
"total": {
"$ref": "#/components/schemas/total"
},
"balance": {
"$ref": "#/components/schemas/balance"
},
"line_items": {
"$ref": "#/components/schemas/line_items"
},
"location_id": {
"$ref": "#/components/schemas/location_id"
},
"location_name": {
"$ref": "#/components/schemas/location_name"
},
"invoices": {
"$ref": "#/components/schemas/invoices"
},
"taxes": {
"description": "Taxes associated with the subscription.",
"type": "array",
"items": {
"type": "object",
"properties": {
"tax_id": {
"$ref": "#/components/schemas/tax_id"
},
"tax_name": {
"$ref": "#/components/schemas/tax_name"
},
"tax_amount": {
"$ref": "#/components/schemas/tax_amount"
}
}
}
},
"currency_code": {
"$ref": "#/components/schemas/currency_code"
},
"currency_symbol": {
"$ref": "#/components/schemas/currency_symbol"
},
"billing_address": {
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/address"
},
"street2": {
"$ref": "#/components/schemas/street2"
},
"city": {
"$ref": "#/components/schemas/city"
},
"state": {
"$ref": "#/components/schemas/state"
},
"zip": {
"$ref": "#/components/schemas/zip"
},
"country": {
"$ref": "#/components/schemas/country"
},
"fax": {
"$ref": "#/components/schemas/fax"
}
}
},
"shipping_address": {
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/address"
},
"street2": {
"$ref": "#/components/schemas/street2"
},
"city": {
"$ref": "#/components/schemas/city"
},
"state": {
"$ref": "#/components/schemas/state"
},
"zip": {
"$ref": "#/components/schemas/zip"
},
"country": {
"$ref": "#/components/schemas/country"
},
"fax": {
"$ref": "#/components/schemas/fax"
}
}
},
"created_time": {
"$ref": "#/components/schemas/created_time"
},
"updated_time": {
"$ref": "#/components/schemas/updated_time"
},
"template_id": {
"$ref": "#/components/schemas/template_id"
},
"template_name": {
"$ref": "#/components/schemas/template_name"
},
"notes": {
"$ref": "#/components/schemas/notes"
},
"terms": {
"$ref": "#/components/schemas/terms"
}
}
},
"search_text": {
"description": "Search credit notes by credit note number or customer name or credit note reference number. Max-length [100]",
"type": "string"
},
"creditnote_id": {
"description": "Unique ID of the credit note generated by the server.",
"type": "string",
"example": "90300000072369"
},
"creditnote_number": {
"description": "Unique number generated (starts with CN) which will be displayed in the interface and credit notes. Max-Length [100]",
"type": "string",
"example": "CN-29"
},
"gst_treatment": {
"description": "Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are <code> business_gst </code> , <code> business_none </code> , <code> overseas </code> , <code> consumer </code>.",
"type": "string",
"example": "business_gst",
"x-node_available_in": [
"in"
],
"x-node_unavailable_in": []
},
"tax_treatment": {
"description": "VAT treatment for the credit note .Choose whether the contact falls under: <code>vat_registered</code>,<code>vat_not_registered</code>,<code>gcc_vat_not_registered</code>,<code>gcc_vat_registered</code>,<code>non_gcc</code>,<code>dz_vat_registered</code> and <code>dz_vat_not_registered</code>.</b></br><code>home_country_mexico</code>,<code>border_region_mexico</code>,<code>non_mexico</code> supported only for <b>MX</b>.",
"type": "string",
"x-node_available_in": [
"gcc",
"mx"
],
"x-node_unavailable_in": []
},
"gst_no": {
"description": "15 digit GST identification number of the customer.",
"type": "string",
"example": "22AAAAA0000A1Z5",
"x-node_available_in": [
"in"
],
"x-node_unavailable_in": []
},
"cfdi_usage": {
"description": "Choose CFDI Usage.</br>Allowed values: <code>acquisition_of_merchandise</code>, <code>return_discount_bonus</code>, <code>general_expense</code>, <code>buildings</code>, <code>furniture_office_equipment</code>, <code>transport_equipment</code>, <code>computer_equipmentdye_molds_tools</code>, <code>telephone_communication</code>, <code>satellite_communication</code>, <code>other_machinery_equipment</code>, <code>hospital_expense</code>, <code>medical_expense_disability</code>, <code>funeral_expense</code>, <code>donation</code>, <code>interest_mortage_loans</code>, <code>contribution_sar</code>, <code>medical_expense_insurance_pormium</code>, <code>school_transportation_expense</code>, <code>deposit_saving_account</code>, <code>payment_educational_service</code>, <code>no_tax_effect</code>, <code>payment</code>, <code>payroll</code>.",
"type": "string",
"example": "acquisition_of_merchandise",
"x-node_available_in": [
"mx"
],
"x-node_unavailable_in": []
},
"cfdi_reference_type": {
"description": "Choose CFDI Reference Type.</br>Allowed values: <code>credit_note</code>, <code>debit_note</code>, <code>return_of_merchandise</code>, <code>substitution_previous_cfdi</code>, <code>transfer_of_goods</code>, <code>invoice_generated_from_order</code>, <code>cfdi_for_advance</code>.",
"type": "string",
"example": "return_of_merchandise",
"x-node_available_in": [
"mx"
],
"x-node_unavailable_in": []
},
"place_of_supply": {
"description": "Place where the goods/services are supplied to. (If not given, <code>place of contact</code> given for the contact will be taken)<br/> <b>For GCC Edition:</b> Supported codes for UAE Emirates states include <code>AB</code>,<code>AJ</code>,<code>DU</code>,<code>FU</code>,<code>RA</code>,<code>SH</code>,<code>UM</code><br/> Supported codes for the GCC countries include <code>AE</code>,<code>SA</code>,<code>BH</code>,<code>KW</code>,<code>OM</code>,<code>QA</code>.",
"type": "string",
"example": "TN",
"x-node_available_in": [
"in",
"gcc"
],
"x-node_unavailable_in": []
},
"product_type": {
"description": "Enter goods/services",
"type": "string",
"example": "goods"
},
"hsn_or_sac": {
"description": "Add HSN/SAC code for your goods/services",
"type": "string",
"example": 80540,
"x-node_available_in": [
"in"
],
"x-node_unavailable_in": []
},
"sat_item_key_code": {
"description": "Add SAT Item Key Code for your goods/services. Download the <a href= http://omawww.sat.gob.mx/tramitesyservicios/Paginas/documentos/catCFDI_V_4_07122022.xls >CFDI Catalogs.</a>",
"type": "string",
"example": 71121206,
"x-node_available_in": [
"mx"
],
"x-node_unavailable_in": []
},
"unitkey_code": {
"description": "Add Unit Key Code for your goods/services. Download the <a href= http://omawww.sat.gob.mx/tramitesyservicios/Paginas/documentos/catCFDI_V_4_07122022.xls >CFDI Catalogs.</a>",
"type": "string",
"example": "box",
"x-node_available_in": [
"mx"
],
"x-node_unavailable_in": []
},
"location_id": {
"description": "Location ID",
"type": "string",
"example": "460000000038080"
},
"location_name": {
"description": "Name of the location",
"type": "string",
"example": "Head Office"
},
"item_order": {
"description": "Order of the item in the list of line items.",
"type": "integer",
"example": 0
},
"discount": {
"description": "Discount applied to the credit note, which can be either a percentage or a flat amount. For percentage discounts, the value should include the % symbol (e.g., 10%). For example, on Rs.1000, a 10% discount results in Rs.900, while a flat Rs.200 discount results in Rs.800.",
"type": "number",
"format": "double",
"example": 10
},
"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": "TC-IO-09"
}
},
"street2": {
"type": "string",
"example": "McMillan Avenue"
},
"vat_reg_no": {
"description": "Enter VAT registration number.",
"type": "string"
},
"is_pre_gst": {
"description": "Applicable for transactions that were created before July 1, 2017",
"type": "boolean",
"example": true,
"x-node_available_in": [
"in"
],
"x-node_unavailable_in": []
},
"ignore_auto_number_generation": {
"description": "Set to true if you need to provide your own credit note number.",
"type": "boolean",
"example": false
},
"from_account_id": {
"description": "The account from which credit note is refunded.",
"type": "string",
"example": " "
},
"filter_by": {
"description": "Filter credit notes 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>"
},
"date": {
"description": "The date on which the credit note was raised. Format [yyyy-mm-dd]",
"type": "string",
"example": "2016-06-05"
},
"status": {
"description": "Status of the credit note. This can be <code>open</code>, <code>closed</code> or <code>void</code>.",
"type": "string",
"example": "draft"
},
"is_draft": {
"description": "Set to true if credit note has to be created in draft status.",
"type": "boolean",
"example": true
},
"transaction_id": {
"description": "The transaction ID associated with the involved credit notes.",
"type": "string",
"example": "903000002072369"
},
"transaction_type": {
"type": "string",
"example": "email"
},
"comment_id": {
"description": "The unique ID for the comment generated by the server.",
"type": "string",
"example": "982000000570001"
},
"commented_by_id": {
"type": "string",
"example": "982000000554041"
},
"commented_by": {
"description": "The name of the user who commented.",
"type": "string",
"example": "John Smith"
},
"comment_type": {
"type": "string",
"example": "system"
},
"date_description": {
"type": "string",
"example": "7 hours ago"
},
"time": {
"type": "string",
"example": "10:43 PM"
},
"operation_type": {
"type": "string",
"example": "Updated"
},
"creditnote_refund_id": {
"type": "string",
"example": "982000000567158"
},
"amount_bcy": {
"type": "integer",
"example": 10
},
"amount_fcy": {
"type": "integer",
"example": 10
},
"page": {
"type": "integer",
"example": 1
},
"per_page": {
"type": "integer",
"example": 200
},
"report_name": {
"type": "string",
"example": "Credit Notes Refund"
},
"has_more_page": {
"type": "boolean",
"example": false
},
"sort_order": {
"type": "string",
"example": "D"
},
"sort_column": {
"description": "Sort the credit notes by the following columns - customer_name, creditnote_number, balance, total, date and created_time. Allowed Values <code>customer_name</code> <code>creditnote_number</code> <code>balance</code> <code>total</code> <code>date</code> and <code>created_time</code>",
"type": "string",
"example": "created_time"
},
"refund_mode": {
"description": "The method of refund.",
"type": "string",
"example": "cash"
},
"customer_id": {
"description": "Customer ID of the customer for whom the credit note is raised.",
"type": "string",
"example": "903000000000099"
},
"customer_name": {
"description": "Name of the customer to whom the credit note is raised. Max-Length [100]",
"type": "string",
"example": "Bowman Furniture"
},
"email": {
"description": "Email address of the customer.",
"type": "string",
"example": "[email protected]"
},
"total": {
"description": "Total credits raised in this credit note.",
"type": "number",
"format": "double",
"example": 450
},
"item_name": {
"description": "Search credit notes by item name.Max_length [100]",
"type": "string",
"example": "kit"
},
"balance": {
"description": "The unapplied credits.",
"type": "number",
"format": "double",
"example": 10
},
"email_template_id": {
"description": "Get the email content based on a specific email template. If this param is not inputted, then the content will be based on the email template associated with the customer. If no template is associated with the customer, then default template will be used.",
"type": "string",
"example": " "
},
"item_id": {
"description": "Unique string generated for the item for which a refund has to be made.",
"type": "string",
"example": "90300000081501"
},
"description": {
"description": "A brief description about the item.",
"type": "string",
"example": "prorated amount for items"
},
"code": {
"description": "Unique code for the underlying line item of a credit note.",
"type": "string",
"example": "basic-monthly"
},
"amount_applied": {
"description": "The total amount applied from the credit note on an invoice.",
"type": "number",
"format": "double",
"example": 41.82
},
"name": {
"description": "Name of the credit",
"type": "string",
"example": "Basic Monthly"
},
"type": {
"description": "Type of the creditnote line item.",
"type": "integer",
"example": 1
},
"account_id": {
"description": "Unique ID to denote the account.",
"type": "string",
"example": "903000000000388"
},
"account_name": {
"description": "Name of the account.",
"type": "string",
"example": "Sales"
},
"unit": {
"description": "Measurement unit of the line item. For example, kgs, Nos..",
"type": "string",
"example": "kgs"
},
"tax_id": {
"description": "Unique ID to denote the tax associated with the credit note.",
"type": "string",
"example": "903000000000356"
},
"tds_tax_id": {
"description": "Unique ID to denote the TDS tax associated to the creditnote",
"type": "string",
"example": "903000000000357",
"x-node_available_in": [
"mx"
],
"x-node_unavailable_in": []
},
"quantity": {
"description": "Quantity of the item included.",
"type": "integer",
"format": "int32",
"example": 1
},
"template_id": {
"description": "Unique ID of the creditnote template",
"type": "string",
"example": "90300000001336"
},
"template_name": {
"description": "Name of the default template of the creditnote.",
"type": "string",
"example": "Standard Template"
},
"avatax_use_code": {
"description": "Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Max-length [25]",
"type": "string",
"x-node_available_in": [
"Avalara Integration"
],
"x-node_unavailable_in": []
},
"avatax_exempt_no": {
"description": "Exemption certificate number of the customer. Max-length [25]",
"type": "string",
"x-node_available_in": [
"Avalara Integration"
],
"x-node_unavailable_in": []
},
"invoice_id": {
"description": "Invoice ID of the required invoice.",
"type": "string",
"example": "90300000079426"
},
"invoice_number": {
"description": "Invoice number of the required invoice.",
"type": "string",
"example": "INV-384"
},
"amount": {
"description": "Amount paid for the invoice.",
"type": "number",
"format": "double",
"example": 450
},
"invoices": {
"description": "List of invoices for which the credit note has been raised. This contains <code>invoice_id</code> and <code>amount</code>.",
"type": "array",
"items": {
"type": "object",
"properties": {
"invoice_id": {
"$ref": "#/components/schemas/invoice_id"
},
"invoice_number": {
"$ref": "#/components/schemas/invoice_number"
},
"amount": {
"$ref": "#/components/schemas/amount"
}
}
}
},
"currency_code": {
"description": "Customer's currency code. This currency code is used in credit notes.",
"type": "string",
"example": "USD"
},
"currency_symbol": {
"description": "Customer's currency symbol.",
"type": "string",
"example": "$"
},
"customfield_id": {
"type": "string",
"description": "Unique ID of the custom field."
},
"custom_fields": {
"description": "Additional fields for the Credit-Notes.",
"type": "array",
"items": {
"type": "object",
"properties": {
"customfield_id": {
"$ref": "#/components/schemas/customfield_id"
},
"value": {
"$ref": "#/components/schemas/value"
},
"label": {
"$ref": "#/components/schemas/label"
}
}
}
},
"label": {
"description": "Label of the custom field.",
"type": "string",
"example": "label"
},
"value": {
"description": "Value of the custom field.",
"type": "string",
"example": 129890
},
"reference_number": {
"description": "Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100]",
"type": "string",
"example": "INV-384"
},
"from": {
"description": "The email ID from which the credit note is to be mailed.",
"type": "string",
"example": "[email protected]"
},
"to_mail_ids": {
"description": "The email IDs to which the credit note is to be mailed.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"[email protected]",
"[email protected]"
]
},
"cc_mail_ids": {
"description": "The email IDs that have to be copied when the credit note is to be mailed.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"[email protected]"
]
},
"subject": {
"description": "The subject of the email. Max-length [1000]",
"type": "string",
"example": "Credit note for subscription."
},
"item_description": {
"description": "description for the item.Variants <code>item_description_startswith</code> and <code>item_description_contains</code>. Max-length [100]",
"type": "string",
"example": ""
},
"body": {
"description": "The body of the email. Max-length [5000]",
"type": "string",
"example": "Please find attached the credit note for your subscription."
},
"created_time": {
"description": "Time at which the credit note was created.",
"type": "string",
"example": "2016-06-05T02:30:08-0700"
},
"updated_time": {
"description": "Time at which the credit note details were last updated.",
"type": "string",
"example": "2016-06-05T02:30:08-0700"
},
"from_mail_id_alias": {
"description": "The email ID from which the credit note is to be mailed.",
"type": "string",
"example": true
},
"to_mail_ids_alias": {
"description": "The email IDs to which the credit note is to be mailed.",
"type": "array",
"items": {
"type": "string"
},
"example": true
},
"cc_mail_ids_alias": {
"description": "The email IDs that have to be copied when the credit note is to be mailed.",
"type": "array",
"items": {
"type": "string"
},
"example": true
},
"subject_alias": {
"description": "The subject of the email.",
"type": "string",
"example": true
},
"body_alias": {
"description": "The body of the email.",
"type": "string",
"example": true
},
"contact_person_name": {
"description": "Name of the Contact Person",
"type": "string",
"example": "David"
},
"first_name": {
"description": "First Name of the Contact Person.",
"type": "string",
"example": "David"
},
"contact_person_email": {
"description": "Email ID of the Contact Person.",
"type": "string",
"example": "[email protected]"
},
"phone": {
"description": "Phone Number of the Contact Person.",
"type": "string",
"example": "+1-925-921-9201"
},
"last_name": {
"description": "Last Name of the Contact Person.",
"type": "string",
"example": "John"
},
"salutation": {
"description": "Salutation of the Contact Person.",
"type": "string",
"example": "Mr"
},
"contact_person_id": {
"description": "Unique ID of the Contact Person.",
"type": "string",
"example": 982000000567003
},
"mobile": {
"description": "Mobile Number of the Contact Person.",
"type": "string",
"example": "+1-4054439562"
},
"is_email_enabled": {
"description": "Used to check if Email communication preference is enabled for the contact person at transaction level.",
"type": "boolean",
"example": true
},
"is_sms_enabled": {
"description": "Used to check if SMS communication preference is enabled for the contact person at transaction level.",
"type": "boolean",
"example": true,
"x-node_available_in": [
"SMS integration"
]
},
"is_whatsapp_enabled": {
"description": "Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.",
"type": "boolean",
"example": true,
"x-node_available_in": [
"WhatsApp integration"
]
},
"communication_preference": {
"description": "Preferred modes of communication for the contact person at transaction level.",
"type": "object",
"properties": {
"is_email_enabled": {
"$ref": "#/components/schemas/is_email_enabled"
},
"is_whatsapp_enabled": {
"$ref": "#/components/schemas/is_whatsapp_enabled"
}
}
},
"contact_persons_associated": {
"description": "Contact Persons associated with the credit note.",
"type": "array",
"items": {
"type": "object",
"properties": {
"contact_person_id": {
"$ref": "#/components/schemas/contact_person_id"
},
"contact_person_name": {
"$ref": "#/components/schemas/contact_person_name"
},
"first_name": {
"$ref": "#/components/schemas/first_name"
},
"last_name": {
"$ref": "#/components/schemas/last_name"
},
"contact_person_email": {
"$ref": "#/components/schemas/contact_person_email"
},
"phone": {
"$ref": "#/components/schemas/phone"
},
"mobile": {
"$ref": "#/components/schemas/mobile"
},
"communication_preference": {
"$ref": "#/components/schemas/communication_preference"
}
}
}
},
"contact_persons_associated_payload": {
"description": "Contact Persons associated with the credit note.",
"type": "array",
"items": {
"type": "object",
"properties": {
"contact_person_id": {
"$ref": "#/components/schemas/contact_person_id"
},
"communication_preference": {
"$ref": "#/components/schemas/communication_preference"
}
}
}
},
"rate": {
"description": "Rate of the line item.",
"type": "number",
"format": "double",
"example": 0
},
"exchange_rate": {
"description": "Exchange rate for the currency associated with the customer.",
"type": "string",
"example": "5.5"
},
"avatax_tax_code": {
"description": "A tax code is a unique label used to group Items (products, services, or charges) together. Refer the [link][2] for more deails. Max-length [25]",
"type": "string",
"x-node_available_in": [
"Avalara Integration"
],
"x-node_unavailable_in": []
},
"notes": {
"description": "A short note for the credit note. Max-length [5000]",
"type": "string",
"example": "Offer for the referral"
},
"terms": {
"description": "Terms & condition to be displayed in the credit note. Max-length [10000]",
"type": "string",
"example": ""
},
"data_type": {
"description": "Data type of the custom field.",
"type": "string",
"example": "text"
},
"vat_treatment": {
"description": "(Optional) VAT treatment for the credit notes. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is <code>uk</code>. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is <code>eu_vat_registered</code>, if he resides outside of the UK then his VAT treatment is <code>overseas</code> (For Pre Brexit, this can be split as <code>eu_vat_registered</code>, <code>eu_vat_not_registered</code> and <code>non_eu</code>).",
"type": "string",
"example": "overseas",
"x-node_available_in": [
"uk"
],
"x-node_unavailable_in": []
},
"tax_authority_id": {
"description": "Unique ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.",
"type": "string",
"example": "903000006345",
"x-node_available_in": [
"us"
],
"x-node_unavailable_in": []
},
"is_inclusive_tax": {
"description": "Used to specify whether the line item rates are inclusive(true) or exclusive(false) of tax.",
"type": "boolean",
"example": false,
"x-node_available_in": [],
"x-node_unavailable_in": [
"us",
"ca"
]
},
"tax_exemption_id": {
"description": "Unique ID of the tax exemption.",
"type": "string",
"example": "903000006345",
"x-node_available_in": [
"in",
"us",
"au",
"ca"
],
"x-node_unavailable_in": []
},
"tax_exemption_code": {
"description": "Unique code of the tax exemption.",
"type": "string",
"example": "GST FREE",
"x-node_available_in": [
"in",
"us",
"au",
"ca",
"mx"
],
"x-node_unavailable_in": []
},
"tax_name": {
"description": "Unique name for tax.",
"type": "string",
"example": "Basic Tax"
},
"tax_percentage": {
"description": "Percentage of tax",
"type": "string",
"example": "10%"
},
"tax_amount": {
"description": "Tax amount applied to the subscription.",
"type": "string",
"example": "2.50"
},
"creditnote_invoice_id": {
"type": "string",
"example": "982000000567172"
},
"credited_amount": {
"description": "The total amount that is credited.",
"type": "number",
"format": "double",
"example": 12.02
},
"print": {
"description": "Export credit note PDF using the default print option. The allowed values are <code>true</code>, <code>false</code>, <code>on</code> and <code>off</code>",
"type": "boolean",
"example": true
},
"accept": {
"description": "You can fetch the credit note details as json/pdf/html. The default format is html. The allowed values are <code>json</code>, <code>pdf</code> and <code>html</code>",
# --- truncated at 32 KB (121 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-inventory/refs/heads/main/json-schema/credit-notes.json