Jump to

• Request
• Response

Updates Debit Note in Tw table

put

/service/v1/debitNote

This endpoint is used to updates Debit note.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
• branchCode: string
• userId: string

Body ()

Request Body that contains data required for updating a new Debit note.

Root Schema : DebitNotePutModel

Type: object

Debit note put model

Show Source

• action: string
  Action for which debit note are getting saved
• checkerId(optional): string
  Checker Id from Portal
• debitNoteList(optional): array debitNoteList
• makerId(optional): string
  Maker Id from Portal
• processingBranchCode: string
  Branch Code
• processingDate: string
  Processing Date
• srcAppCd(optional): string
  Source Application Code
• srcAppRefNo(optional): string
  Reference Number of Calling System

{
    "description":"Debit note put model",
    "type":"object",
    "required":[
        "action",
        "processingDate",
        "processingBranchCode"
    ],
    "properties":{
        "srcAppCd":{
            "type":"string",
            "description":"Source Application Code"
        },
        "srcAppRefNo":{
            "type":"string",
            "description":"Reference Number of Calling System"
        },
        "action":{
            "type":"string",
            "description":"Action for which debit note are getting saved"
        },
        "processingDate":{
            "type":"string",
            "description":"Processing Date"
        },
        "processingBranchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "makerId":{
            "type":"string",
            "description":"Maker Id from Portal"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker Id from Portal"
        },
        "debitNoteList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DebitNoteUpdateModel2"
            }
        }
    }
}

Nested Schema : debitNoteList

Type: array

Show Source

• Array of: object DebitNoteUpdateModel2
  Debit note Update model 2

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DebitNoteUpdateModel2"
    }
}

Nested Schema : DebitNoteUpdateModel2

Type: object

Debit note Update model 2

Show Source

• acceptanceAmount(optional): number
• adjustmentReason(optional): string
• debitNoteDate(optional): string
• debitNoteDueDate(optional): string
• debitNoteRefNo(optional): string
• discrepancyCd(optional): string
• disputeAmount(optional): number
• invoiceCommodityGridList(optional): array invoiceCommodityGridList
• isAutoAuth(optional): string
• linkedDocs(optional): string
• linkInvoiceNumber(optional): string
• oldAcceptanceAmount(optional): number
• oldDebitNoteDueDate(optional): string
• oldDisputeAmount(optional): number
• remarks(optional): string
• transactionRefNo(optional): string

{
    "description":"Debit note Update model 2",
    "type":"object",
    "properties":{
        "debitNoteRefNo":{
            "type":"string",
            "description":""
        },
        "oldDebitNoteDueDate":{
            "type":"string",
            "description":""
        },
        "debitNoteDueDate":{
            "type":"string",
            "description":""
        },
        "debitNoteDate":{
            "type":"string",
            "description":""
        },
        "oldDisputeAmount":{
            "type":"number",
            "description":""
        },
        "disputeAmount":{
            "type":"number",
            "description":""
        },
        "oldAcceptanceAmount":{
            "type":"number",
            "description":""
        },
        "acceptanceAmount":{
            "type":"number",
            "description":""
        },
        "discrepancyCd":{
            "type":"string",
            "description":""
        },
        "remarks":{
            "type":"string",
            "description":""
        },
        "linkedDocs":{
            "type":"string",
            "description":""
        },
        "isAutoAuth":{
            "type":"string",
            "description":""
        },
        "adjustmentReason":{
            "type":"string",
            "description":""
        },
        "linkInvoiceNumber":{
            "type":"string",
            "description":""
        },
        "transactionRefNo":{
            "type":"string",
            "description":""
        },
        "invoiceCommodityGridList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InvoiceCommodityGridModel"
            }
        }
    }
}

Nested Schema : invoiceCommodityGridList

Type: array

Show Source

• Array of: object InvoiceCommodityGridModel

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/InvoiceCommodityGridModel"
    }
}

Nested Schema : InvoiceCommodityGridModel

Type: object

Show Source

• ccy(optional): string
• commodityCode(optional): string
  Commodity Code
• commodityDesc(optional): string
• commodityName(optional): string
• costPerUnit(optional): number
  Cost Per unit
• descriptionOfGoods(optional): string
• discountAmount(optional): number
• discountPercentage(optional): number
• id(optional): string
• invoiceCommodityGridId(optional): string
  Read Only: true

  Id of the Invoice Commodity Grid
• invoiceMasterId(optional): string
  Invoice Master Id
• invoiceNumber(optional): string
  Invoice Number
• invoiceRefNo(optional): string
  Invoice Reference Number
• isInherited(optional): string
• netCost(optional): number
  Net Cost
• quantity(optional): number
  Quantity
• seqNo(optional): integer(int64)
• taxAmount(optional): number
  Tax Amount
• taxPercentage(optional): number
• totalCost(optional): number
  Total Cost
• totalWeight(optional): number
• transactionRefNo(optional): string
• unit(optional): string
• unitWeight(optional): number

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64"
        },
        "commodityCode":{
            "type":"string",
            "description":"Commodity Code"
        },
        "quantity":{
            "type":"number",
            "description":"Quantity"
        },
        "commodityName":{
            "type":"string"
        },
        "commodityDesc":{
            "type":"string"
        },
        "costPerUnit":{
            "type":"number",
            "description":"Cost Per unit"
        },
        "totalCost":{
            "type":"number",
            "description":"Total Cost"
        },
        "taxAmount":{
            "type":"number",
            "description":"Tax Amount"
        },
        "netCost":{
            "type":"number",
            "description":"Net Cost"
        },
        "invoiceCommodityGridId":{
            "description":"Id of the Invoice Commodity Grid",
            "type":"string",
            "readOnly":true
        },
        "invoiceNumber":{
            "type":"string",
            "description":"Invoice Number"
        },
        "invoiceMasterId":{
            "type":"string",
            "description":"Invoice Master Id"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Reference Number"
        },
        "descriptionOfGoods":{
            "type":"string"
        },
        "totalWeight":{
            "type":"number"
        },
        "unitWeight":{
            "type":"number"
        },
        "ccy":{
            "type":"string"
        },
        "discountPercentage":{
            "type":"number"
        },
        "discountAmount":{
            "type":"number"
        },
        "taxPercentage":{
            "type":"number"
        },
        "unit":{
            "type":"string"
        },
        "transactionRefNo":{
            "type":"string"
        },
        "isInherited":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns the collection of the updated debit note

Body ()

Root Schema : UpdateDebitNoteResponse

Type: object

Debit note Response model

Show Source

• errorCode(optional): string
• errorDesc(optional): string
• processingDate(optional): string
• refNoList(optional): array refNoList
• srcAppRefNo(optional): string
• trnStatus(optional): string

{
    "description":"Debit note Response model",
    "type":"object",
    "properties":{
        "srcAppRefNo":{
            "type":"string",
            "description":""
        },
        "trnStatus":{
            "type":"string",
            "description":""
        },
        "errorCode":{
            "type":"string",
            "description":""
        },
        "errorDesc":{
            "type":"string",
            "description":""
        },
        "processingDate":{
            "type":"string",
            "description":""
        },
        "refNoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DebitNoteTranRefNoResponse"
            }
        }
    }
}

Nested Schema : refNoList

Type: array

Show Source

• Array of: object DebitNoteTranRefNoResponse
  List of Internal Reference Numbers

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DebitNoteTranRefNoResponse"
    }
}

Nested Schema : DebitNoteTranRefNoResponse

Type: object

List of Internal Reference Numbers

Show Source

• debitNoteRefNoList(optional): array debitNoteRefNoList
• errorCode(optional): string
• errorDesc(optional): string
• trnRefNo(optional): string
• trnStatus(optional): string

{
    "description":"List of Internal Reference Numbers",
    "type":"object",
    "properties":{
        "trnRefNo":{
            "type":"string",
            "description":""
        },
        "trnStatus":{
            "type":"string",
            "description":""
        },
        "errorCode":{
            "type":"string",
            "description":""
        },
        "errorDesc":{
            "type":"string",
            "description":""
        },
        "debitNoteRefNoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DebitNoteRefNoResponse"
            }
        }
    }
}

Nested Schema : debitNoteRefNoList

Type: array

Show Source

• Array of: object DebitNoteRefNoResponse
  List of Internal Reference Numbers

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DebitNoteRefNoResponse"
    }
}

Nested Schema : DebitNoteRefNoResponse

Type: object

List of Internal Reference Numbers

Show Source

• debitNoteRefNo(optional): string
• errorCode(optional): string
• errorDesc(optional): string
• trnStatus(optional): string

{
    "description":"List of Internal Reference Numbers",
    "type":"object",
    "properties":{
        "debitNoteRefNo":{
            "type":"string",
            "description":""
        },
        "trnStatus":{
            "type":"string",
            "description":""
        },
        "errorCode":{
            "type":"string",
            "description":""
        },
        "errorDesc":{
            "type":"string",
            "description":""
        }
    }
}

400 Response

Bad Request

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top