--- agentTools: projectIndex: https://ledgers.readme.io/llms.txt --- # View Credit Note # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Production with User Token", "version": "3-India" }, "servers": [ { "url": "https://in-api.ledgers.cloud/v3" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "name": "x-api-key", "in": "header" }, "sec1": { "type": "apiKey", "name": "api-token", "in": "header" } } }, "security": [ { "sec0": [], "sec1": [] } ], "paths": { "/credit-note/{id}": { "get": { "summary": "View Credit Note", "description": "", "operationId": "view-credit-note", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the credit note you wish to view.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "\n \"status\": 200,\n \"data\": [\n {\n \"creditnote_id\": 1098,\n \"creditnote_number\": \"2025-248\",\n \"creditnote_date\": \"2024-11-14\",\n \"document_info\": {\n \"id\": 9656,\n \"type\": \"INV\",\n \"number\": \"GST3\"\n },\n \"document_id\": 9656,\n \"document_number\": \"GST3\",\n \"seller_info\": {\n \"business_name\": \"STOCK HOLDING CORPORATION OF INDIA LIMITED\",\n \"gstin\": \"27AVXPM6863B2ZZ\",\n \"branch_id\": \"412\",\n \"address\": {\n \"address_line_1\": \"Gold Hill Supreme, 252\",\n \"address_line_2\": \"Shantipura Cross Roads\",\n \"city\": \"Electronic City Phase 2\",\n \"state\": \"MAHARASHTRA\",\n \"country\": \"India\",\n \"pincode\": \"400123\"\n }\n },\n \"customer_info\": {\n \"id\": 5484,\n \"name\": \"Add Reverse Charge\",\n \"email\": \"adc@gmail.com\",\n \"business_name\": \"ADC\",\n \"pos\": \"MAHARASHTRA\",\n \"billing_details\": {\n \"bill_city\": \"Chennai\",\n \"bill_addr1\": \"\",\n \"bill_addr2\": \"Chennai - Trichy Highway\",\n \"bill_email\": \"\",\n \"bill_gstin\": \"\",\n \"bill_state\": \"MAHARASHTRA\",\n \"bill_mobile\": \"\",\n \"bill_country\": \"INDIA\",\n \"bill_pincode\": \"600027\",\n \"bill_mobile_suffix\": \"\"\n },\n \"shipping_details\": {\n \"ship_city\": \"Chennai\",\n \"ship_addr1\": \"\",\n \"ship_addr2\": \"Chennai - Trichy Highway\",\n \"ship_email\": \"\",\n \"ship_gstin\": \"\",\n \"ship_state\": \"MAHARASHTRA\",\n \"ship_mobile\": \"\",\n \"ship_country\": \"INDIA\",\n \"ship_pincode\": \"600027\",\n \"ship_mobile_suffix\": \"\"\n }\n },\n \"creditnote_items\": [\n {\n \"product_id\": 3834,\n \"variant_id\": 1,\n \"item_name\": \"Ceiling Fan\",\n \"item_type\": 1,\n \"item_code\": 8414,\n \"price_type\": 0,\n \"quantity\": 1,\n \"units\": \"UNT-UNITS\",\n \"rate\": 1941.75,\n \"taxable_amt\": 1941.75,\n \"non_taxable_amt\": 0,\n \"discount\": 0,\n \"gst_rate\": 7.5,\n \"sgst_amt\": 72.815,\n \"cgst_amt\": 72.815,\n \"igst_amt\": 0,\n \"cess_amt\": 0,\n \"tax_info\": {\n \"gst_type\": 1,\n \"cgst_rate\": 3.75,\n \"igst_rate\": 7.5,\n \"sgst_rate\": 3.75,\n \"cess_amount\": 0,\n \"cgst_amount\": 72.815,\n \"igst_amount\": 0,\n \"sgst_amount\": 72.815\n },\n \"item_total_amt\": 2087.38\n }\n ],\n \"creditnote_others\": [],\n \"total_taxable_amount\": 1941.75,\n \"total_non_taxable_amount\": 0,\n \"total_gst_amount\": 145.63,\n \"total_cess_amount\": 0,\n \"total_adjust_amount\": 0,\n \"total_addvalue_amount\": 0,\n \"total_amount\": 2087.38,\n \"added_by\": 1501425402,\n \"added_on\": \"2025-12-10 17:32:53\",\n \"creditnote_status\": 1,\n \"export_details\": {\n \"export_lut\": 0,\n \"export_type\": \"\",\n \"export_port\": \"\",\n \"special_supply\": \"0\"\n },\n \"billing_currency\": \"INR\",\n \"terms_conditions\": \"\",\n \"billing_currency_info\": {\n \"name\": \"INR\",\n \"exchange_rate\": 1,\n \"exchnage_time\": \"2025-12-10 17:28:52\"\n },\n \"tax_info\": {\n \"gst_type\": 1,\n \"cess_amount\": 0,\n \"cgst_amount\": 72.815,\n \"igst_amount\": 0,\n \"sgst_amount\": 72.815\n },\n \"payment_info\": [],\n \"data_source\": 1,\n \"auto_mode\": 1,\n \"added_by_name\": \"naresh e\",\n \"recon_details\": []\n }\n ]\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "The request was unacceptable, often due to missing a required parameter." } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"errorCode\": \"E0401\",\n \"errorMessage\": \"x-API-key or API-token authentication failed. Contact LEDGERS Developer Support.\"\n}" } }, "schema": { "type": "object", "properties": { "errorCode": { "type": "string", "example": "E0401" }, "errorMessage": { "type": "string", "example": "x-API-key or API-token authentication failed. Contact LEDGERS Developer Support." } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"errorCode\": \"E0403\",\n \"errorMessage\": \"The API key doesn't have permission to perform the request. Contact LEDGERS Developer Support\"\n}" } }, "schema": { "type": "object", "properties": { "errorCode": { "type": "string", "example": "E0403" }, "errorMessage": { "type": "string", "example": "The API key doesn't have permission to perform the request. Contact LEDGERS Developer Support" } } } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Result": { "value": "Something went wrong on Ledgers end." } } } } }, "501": { "description": "501", "content": { "application/json": { "examples": { "Result": { "value": "Something went wrong on Ledgers end.502" } } } } }, "502": { "description": "502", "content": { "application/json": { "examples": { "Result": { "value": "Something went wrong on Ledgers end." } } } } }, "503": { "description": "503", "content": { "application/json": { "examples": { "Result": { "value": "Server cannot handle the request." } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true, "_id": "673ef64e825a22001fb16a5f:680789f9be286f002a37b84b" } ```