Fetch Debit Note Details

View as Markdown
### API Endpoint: Get Debit Note Details This endpoint retrieves detailed information about a specific debit note identified by its unique ID. It provides comprehensive data related to the debit note, including associated vendor, invoice, tax information, and itemized details. #### Request Format - **Method**: GET - **URL**: `{{host}}/apis/external/vendor/debitNote/:id/getDebitNoteDetails` - **Path Parameter**: - `id` (required): The unique identifier of the debit note for which details are to be fetched. #### Response Structure The response is a JSON object containing the following fields: - **id**: Unique identifier for the debit note. - **debitNoteId**: Identifier of the debit note. - **billNo**: Bill number associated with the debit note. - **date**: Date of the debit note. - **createdAt**: Timestamp of when the debit note was created. - **updatedAt**: Timestamp of the last update to the debit note. - **amount**: Total amount of the debit note. - **currencyAmount**: Amount in the specified currency. - **currency**: Currency type. - **stage**: Current stage of the debit note. - **status**: Current status of the debit note. - **service**: Service associated with the debit note. - **category**: Category of the debit note. - **categoryId**: Identifier for the category. - **owner**: Object containing details about the owner of the debit note (id, type, name). - **invoice**: Object containing details about the associated invoice (id, invoiceId, amount, currencyAmount, status, dates, owner). - **vendor**: Object containing vendor information (id, registeredId, name, tradeName, PAN). - **officeData**: Information about the office related to the debit note. - **shipToData**: Information about the shipping details. - **name**: Name associated with the debit note. - **poId**: Purchase order ID linked to the debit note. - **tag**: Tags associated with the debit note. - **fraud**: Boolean indicating if the debit note is flagged for fraud. - **duplicates**: Array of potential duplicate identifiers. - **taxInfo**: Object containing detailed tax information (GST, TDS, amounts). - **config**: Configuration details including files, comments, and items related to the debit note. - **data**: Additional data related to the debit note. - **timelines**: Array of timeline events related to the debit note. - **items**: Array of items associated with the debit note, each containing detailed attributes such as id, productId, name, price, quantity, tax details, and more. This endpoint is essential for retrieving comprehensive details of a debit note, which can be used for auditing, reporting, or further processing.

Path parameters

idstringRequired
Dice id, uniquely identifying a Credit Note stored in DB

Headers

DICE-APP-IDstringOptional
X-CLIENT-IDstringOptional
X-CLIENT-SECRETstringOptional

Response

OK
idinteger
debitNoteIdstring
billNostring
dateinteger
createdAtinteger
updatedAtinteger
amountinteger
currencyAmountinteger
currencystring
stagestring
statusstring
servicestring
categorystring
categoryIdinteger
ownerobject
invoiceobject
vendorobject
officeDataobject
shipToDataobject
namestring
poIdinteger
tagstring
fraudboolean
duplicateslist of strings
taxInfoobject
configobject
datalist of any
timelineslist of objects
itemslist of objects