Fetch Credit Note Details

### Get Credit Note Details This endpoint retrieves detailed information about a specific credit note identified by its unique `id`. It provides comprehensive data related to the credit note, including associated vendor, invoice, and tax information. #### Request - **Method**: GET - **Endpoint**: `{{host}}/apis/external/vendor/creditNote/:id/getCreditNoteDetails` - **Path Parameter**: - `id` (required): The unique identifier of the credit note for which details are being requested. #### Response - **Status Code**: 200 - **Content-Type**: application/json #### Example Response ``` json { "id": 0, "creditNoteId": "", "billNo": "", "date": 0, "createdAt": 0, "updatedAt": 0, "amount": 0, "currencyAmount": 0, "currency": "", "stage": "", "status": "", "service": "", "categoryId": 0, "owner": { "id": 0, "ownerType": "", "ownerId": "", "ownerName": "" }, "invoice": { "id": 0, "invoiceId": "", "billNumber": "", "billNo": "", "amount": 0, "currencyAmount": 0, "owner": { "ownerType": "", "ownerId": "", "ownerName": "" }, "status": "", "date": 0, "createdAt": 0, "invoice_type": "" }, "vendor": { "id": 0, "registeredId": "", "name": "", "pan": "", "rcVendor": true, "address": { "id": "", "address": "", "city": "", "state": "", "country": "", "pincode": "", "gstin": "", "gstinValid": true, "businessAddress": true, "attrs": {}, "forms": [], "locationId": "", "filterKey": "", "bankIds": [] } }, "officeData": { "id": 0, "name": "", "gstin": "", "registeredName": "", "address": "", "tags": {} }, "shipToData": { "id": 0, "name": "", "gstin": "", "registeredName": "", "address": "", "tags": {} }, "name": "", "poId": 0, "tag": "", "fraud": true, "duplicates": [], "taxInfo": { "render": "", "currency": "", "gst": 0, "vendorGstin": "", "igst": 0, "utgst": 0, "sgst": 0, "discount": 0, "discountAmount": 0, "cgst": 0, "taxId": 0, "tds": 0, "tdsSlab": 0, "cessAmount": 0, "baseAmount": 0, "grossAmount": 0, "roundOff": 0, "total": 0, "paidAmount": 0, "sameState": true }, "config": { "files": [], "comments": [], "items": [], "penalty": 0, "tdsMasterId": 0, "tdsSection": "", "tdsDescription": "", "independentCreditNote": true, "financeActions": [], "costAllocationDone": true, "logs": [], "invoices": [] }, "data": [], "timelines": [], "attrs": {}, "items": [], "integrationData": { "attrs": {}, "postingTriggered": true, "paymentTriggered": true, "postingFailed": true, "paymentFailed": true, "postingSynced": true, "paymentSynced": true }, "independentCreditNote": true } ``` This response structure includes various nested objects and arrays, providing detailed information about the credit note, its associated vendor, invoice, and other relevant data. This endpoint retrieves detailed information about a specific credit note identified by its unique ID. It provides comprehensive data regarding the credit note, including its associated invoice, vendor, and tax information. #### Request Format - **Method**: GET - **Endpoint**: `{{host}}/apis/external/vendor/creditNote/:id/getCreditNoteDetails` - **Path Parameter**: - `id`: The unique identifier of the credit note for which details are being requested. #### Response Structure Upon a successful request, the server responds with a JSON object containing the following fields: - **id**: Unique identifier for the credit note. - **creditNoteId**: Identifier for the credit note. - **billNo**: The bill number associated with the credit note. - **date**: The date of the credit note. - **createdAt**: Timestamp of when the credit note was created. - **updatedAt**: Timestamp of the last update to the credit note. - **amount**: Total amount of the credit note. - **currencyAmount**: Amount in the specified currency. - **currency**: Currency type for the transaction. - **stage**: Current stage of the credit note. - **status**: Status of the credit note. - **service**: Service associated with the credit note. - **categoryId**: Identifier for the category of the credit note. - **owner**: Object containing details about the owner of the credit note. - **invoice**: Object containing details about the associated invoice. - **vendor**: Object containing details about the vendor related to the credit note. - **officeData**: Information about the office associated with the credit note. - **shipToData**: Information about the shipping address. - **name**: Name associated with the credit note. - **poId**: Purchase order ID related to the credit note. - **tag**: Tags associated with the credit note. - **fraud**: Boolean indicating if the credit note is marked for fraud. - **duplicates**: List of duplicate entries related to the credit note. - **taxInfo**: Object containing tax-related information. - **config**: Configuration details including items and actions related to the credit note. - **timelines**: Array of actions and events related to the credit note. - **attrs**: Additional attributes related to the credit note. - **items**: Array of items included in the credit note. - **integrationData**: Data related to integration status and actions. This detailed structure allows consumers of the API to understand the various aspects of the credit note and its associated entities, facilitating better integration and usage of the credit note data.