Jump to

• Request
• Response

Retrieves the list of existing credit notes

get

/service/v1/creditNoteSearch

This endpoint is used to get the list of existing Credit Notes.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• action(optional): string
  action
• adjustmentReason(optional): string
  Adjustment Reason
• buyerId(optional): string
  Buyer Id
• cnAmountFrom(optional): number
  Credit Note Amount From
• cnAmountTo(optional): number
  Credit Note Amount To
• cnDateFrom(optional): string
  Credit Note Date From
• cnDateTo(optional): string
  Credit Note Date To
• cnExpiryDateFrom(optional): string
  Credit Note Expiry Date From
• cnExpiryDateTo(optional): string
  Credit Note Expiry Date To
• cnNumber(optional): string
  Credit Note Number
• cnReconcilationStatus(optional): string
  Credit Note Reconcilation Status
• cnStatus(optional): string
  Credit Note Status
• creditNoteRefNo(optional): string
  Credit Note Reference Number
• currency(optional): string
  Currency
• dateFrom(optional): string
  Date From for Reference Basis
• dateReferenceBasis(optional): string
  Date Reference Basis
• dateTo(optional): string
  Date To for Reference Basis
• fileName(optional): string
  File name which created the Credit Note
• forRecon(optional): boolean
  For Recon
• limit(optional): integer
  Limit
• linkInvoiceNumber(optional): string
  Link Invoice Number
• offset(optional): integer
  Offset
• programCode(optional): string
  Program Code
• relationCode(optional): string
  Relation Code
• remarks(optional): string
  Remarks
• sourceTxnId(optional): string
  Source Transaction Id
• srcAppCd(optional): string
  Source Application Code
• supplierId(optional): string
  Supplier Id
• transactionRefNo(optional): string
  Transaction Reference Number
• transactionStatus(optional): string
  Transaction Status

Header Parameters

• appId: string
  Application Id
• branchCode: string
  Branch Code
• userId: string
  User Id

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the details of the Credit Notes

Body ()

Root Schema : CreditNoteCollection

Type: object

List of Credit Notes

Show Source

• action(optional): string
  Is Auto Authorized
• creditNoteList(optional): array creditNoteList
• errorCode(optional): string
  Error Code
• errorDesc(optional): string
  Error Desc
• paging(optional): object PagingDto
  Paging DTO object
• sourceTxnId(optional): string
  sourceTxnId

{
    "description":"List of Credit Notes",
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "description":"Is Auto Authorized"
        },
        "sourceTxnId":{
            "type":"string",
            "description":"sourceTxnId"
        },
        "creditNoteList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CreditNoteModel"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Desc"
        }
    }
}

Nested Schema : creditNoteList

Type: array

Show Source

• Array of: object CreditNoteModel
  Credit Note Model

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

Nested Schema : PagingDto

Type: object

Paging DTO object

Show Source

• totalResults(optional): integer
  Total Results

{
    "description":"Paging DTO object",
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"Total Results",
            "type":"integer"
        }
    }
}

Nested Schema : CreditNoteModel

Type: object

Credit Note Model

Show Source

• action(optional): string
  action
• adjustmentReason(optional): string
  Adjustment Reason
• amount(optional): number
  Base Cn amount
• buyerCode(optional): string
  Buyer Code
• buyerDivCode(optional): string
  Buyer Division Code
• buyerDivName(optional): string
  Buyer Division Name
• buyerId(optional): string
  Buyer Id
• buyerName(optional): string
  Buyer Name
• cnDate(optional): string
  Cn Date
• cnExpiryDate(optional): string
  Cn Expiry Date
• cnNumber(optional): string
  Credit Note Reference Number
• cnReconcilationStatus(optional): string
  Cn Reconcilation Status
• cnStatus(optional): string
  Cn Status
• commodityGridList(optional): array commodityGridList
• creditNoteId(optional): string
  Credit Note generated Id
• creditNoteRefNo(optional): string
  Credit Note System generated RefNo
• currency(optional): string
  Currency
• discountAmount(optional): number
  Discount Amount
• discountPercentage(optional): number
  Discount Percentage
• expiresOn(optional): string
  expiresOn
• fileName(optional): string
  File Name
• filler1(optional): string
  Filler1
• filler10(optional): string
  Filler10
• filler2(optional): string
  Filler2
• filler3(optional): string
  Filler3
• filler4(optional): string
  Filler4
• filler5(optional): string
  Filler5
• filler6(optional): string
  Filler6
• filler7(optional): string
  Filler7
• filler8(optional): string
  Filler8
• filler9(optional): string
  Filler9
• isAutoAuth(optional): string
  Is Auto Authorized
• isAutoReconcile(optional): string
  Is Auto Authorized
• isRecon(optional): string
  isRecon
• isTxnCreationReqd(optional): string
  is txn creation required
• linkedInvoiceList(optional): array linkedInvoiceList
• linkInvoiceNumber(optional): string
  Pipe seperated invoice numbers
• makerDtStamp(optional): string
  Maker Date Stamp
• makerId(optional): string
  Maker Id
• matchedAmount(optional): number
  Matched Amount
• miscCharge1Amount(optional): number
  Miscellaneous Charge1 Amount
• miscCharge1Desc(optional): string
  Miscellaneous Charge1 Description
• miscCharge2Amount(optional): number
  Miscellaneous Charge2 Amount
• miscCharge2Desc(optional): string
  Miscellaneous Charge2 Description
• netAmount(optional): number
  Net Cn amount
• procBranchCode(optional): string
  Proc Branch Code
• procBranchDate(optional): string
  Proc Branch Date
• programCode(optional): string
  Program Code
• programName(optional): string
  Program Name
• reasonCode(optional): string
  Reason Code
• reasonErrorCode(optional): string
  Reason Error Code
• reconciledPmtAmt(optional): number
  reconciledPmtAmt
• reconTxnStatus(optional): string
  Recon Transaction Status
• relationCode(optional): string
  Relation Code
• remarks(optional): string
  Remarks
• seqNo(optional): integer(int64)
  seqNo
• sourceTxnId(optional): string
  Source Transaction Id
• srcAppCd(optional): string
  Source Application Code
• stageId(optional): string
  Stage Id
• supplierCode(optional): string
  Supplier code
• supplierDivCode(optional): string
  Supplier Division Code
• supplierDivName(optional): string
  Supplier Division Name
• supplierId(optional): string
  Supplier Id
• supplierName(optional): string
  Supplier Name
• taxAmount(optional): number
  Tax Amount
• taxPercentage(optional): number
  Tax Percentage
• totalAmount(optional): number
  Total Cn amount
• transactionRefNo(optional): string
  Transaction Reference Number
• unmatchedAmount(optional): number
  Unmatched Amount

{
    "description":"Credit Note Model",
    "type":"object",
    "properties":{
        "srcAppCd":{
            "type":"string",
            "description":"Source Application Code"
        },
        "creditNoteRefNo":{
            "type":"string",
            "description":"Credit Note System generated RefNo"
        },
        "creditNoteId":{
            "type":"string",
            "description":"Credit Note generated Id"
        },
        "cnNumber":{
            "type":"string",
            "description":"Credit Note Reference Number"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"seqNo"
        },
        "cnDate":{
            "type":"string",
            "description":"Cn Date"
        },
        "cnExpiryDate":{
            "type":"string",
            "description":"Cn Expiry Date"
        },
        "linkInvoiceNumber":{
            "type":"string",
            "description":"Pipe seperated invoice numbers"
        },
        "supplierId":{
            "type":"string",
            "description":"Supplier Id"
        },
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "supplierName":{
            "type":"string",
            "description":"Supplier Name"
        },
        "supplierDivCode":{
            "type":"string",
            "description":"Supplier Division Code"
        },
        "supplierDivName":{
            "type":"string",
            "description":"Supplier Division Name"
        },
        "buyerName":{
            "type":"string",
            "description":"Buyer Name"
        },
        "buyerDivCode":{
            "type":"string",
            "description":"Buyer Division Code"
        },
        "buyerDivName":{
            "type":"string",
            "description":"Buyer Division Name"
        },
        "relationCode":{
            "type":"string",
            "description":"Relation Code"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "programName":{
            "type":"string",
            "description":"Program Name"
        },
        "adjustmentReason":{
            "type":"string",
            "description":"Adjustment Reason"
        },
        "remarks":{
            "type":"string",
            "description":"Remarks"
        },
        "currency":{
            "type":"string",
            "description":"Currency"
        },
        "amount":{
            "type":"number",
            "description":"Base Cn amount"
        },
        "totalAmount":{
            "type":"number",
            "description":"Total Cn amount"
        },
        "netAmount":{
            "type":"number",
            "description":"Net Cn amount"
        },
        "taxAmount":{
            "type":"number",
            "description":"Tax Amount"
        },
        "discountPercentage":{
            "type":"number",
            "description":"Discount Percentage"
        },
        "discountAmount":{
            "type":"number",
            "description":"Discount Amount"
        },
        "taxPercentage":{
            "type":"number",
            "description":"Tax Percentage"
        },
        "fileName":{
            "type":"string",
            "description":"File Name"
        },
        "reasonCode":{
            "type":"string",
            "description":"Reason Code"
        },
        "reasonErrorCode":{
            "type":"string",
            "description":"Reason Error Code"
        },
        "filler1":{
            "type":"string",
            "description":"Filler1"
        },
        "filler2":{
            "type":"string",
            "description":"Filler2"
        },
        "filler3":{
            "type":"string",
            "description":"Filler3"
        },
        "filler4":{
            "type":"string",
            "description":"Filler4"
        },
        "filler5":{
            "type":"string",
            "description":"Filler5"
        },
        "filler6":{
            "type":"string",
            "description":"Filler6"
        },
        "filler7":{
            "type":"string",
            "description":"Filler7"
        },
        "filler8":{
            "type":"string",
            "description":"Filler8"
        },
        "filler9":{
            "type":"string",
            "description":"Filler9"
        },
        "filler10":{
            "type":"string",
            "description":"Filler10"
        },
        "cnStatus":{
            "type":"string",
            "description":"Cn Status"
        },
        "cnReconcilationStatus":{
            "type":"string",
            "description":"Cn Reconcilation Status"
        },
        "transactionRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "buyerCode":{
            "type":"string",
            "description":"Buyer Code"
        },
        "supplierCode":{
            "type":"string",
            "description":"Supplier code"
        },
        "sourceTxnId":{
            "type":"string",
            "description":"Source Transaction Id"
        },
        "makerId":{
            "type":"string",
            "description":"Maker Id"
        },
        "makerDtStamp":{
            "type":"string",
            "description":"Maker Date Stamp"
        },
        "miscCharge1Amount":{
            "type":"number",
            "description":"Miscellaneous Charge1 Amount"
        },
        "miscCharge1Desc":{
            "type":"string",
            "description":"Miscellaneous Charge1 Description"
        },
        "miscCharge2Amount":{
            "type":"number",
            "description":"Miscellaneous Charge2 Amount"
        },
        "miscCharge2Desc":{
            "type":"string",
            "description":"Miscellaneous Charge2 Description"
        },
        "matchedAmount":{
            "type":"number",
            "description":"Matched Amount"
        },
        "unmatchedAmount":{
            "type":"number",
            "description":"Unmatched Amount"
        },
        "procBranchCode":{
            "type":"string",
            "description":"Proc Branch Code"
        },
        "procBranchDate":{
            "type":"string",
            "description":"Proc Branch Date"
        },
        "stageId":{
            "type":"string",
            "description":"Stage Id"
        },
        "action":{
            "type":"string",
            "description":"action"
        },
        "reconTxnStatus":{
            "type":"string",
            "description":"Recon Transaction Status"
        },
        "isAutoAuth":{
            "type":"string",
            "description":"Is Auto Authorized"
        },
        "isAutoReconcile":{
            "type":"string",
            "description":"Is Auto Authorized"
        },
        "isTxnCreationReqd":{
            "type":"string",
            "description":"is txn creation required"
        },
        "commodityGridList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CnCommodityGridModel"
            }
        },
        "linkedInvoiceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkedInvoiceModel"
            }
        },
        "reconciledPmtAmt":{
            "type":"number",
            "description":"reconciledPmtAmt"
        },
        "isRecon":{
            "type":"string",
            "description":"isRecon"
        },
        "expiresOn":{
            "type":"string",
            "description":"expiresOn"
        }
    }
}

Nested Schema : commodityGridList

Type: array

Show Source

• Array of: object CnCommodityGridModel

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

Nested Schema : linkedInvoiceList

Type: array

Show Source

• Array of: object LinkedInvoiceModel

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

Nested Schema : CnCommodityGridModel

Type: object

Show Source

• commodityCode(optional): string
  Commodity Code
• commodityDesc(optional): string
  Commodity Description
• commodityName(optional): string
  Commodity Name
• costPerUnit(optional): number
  Cost Per Unit
• creditNoteRefNo(optional): string
  Credit Note Reference Number
• currency(optional): string
  Currency
• descriptionOfGoods(optional): string
  Description of Goods
• discountAmount(optional): number
  Discount Amount
• discountPercentage(optional): number
  Discount Percentage
• id(optional): string
  id
• invoiceNumber(optional): string
  Invoice Number
• netCost(optional): number
  Net cost
• quantity(optional): number
  Quantity
• seqNo(optional): integer(int64)
  seqNo
• taxAmount(optional): number
  Tax Amount
• taxPercentage(optional): number
  Tax Percentage
• totalCost(optional): number
  Total Cost
• totalWeight(optional): number
  Total weight
• transactionRefNo(optional): string
  Transaction Reference Number
• unit(optional): string
  Unit
• unitWeight(optional): number
  Unit Weight

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"seqNo"
        },
        "commodityCode":{
            "type":"string",
            "description":"Commodity Code"
        },
        "commodityName":{
            "type":"string",
            "description":"Commodity Name"
        },
        "currency":{
            "type":"string",
            "description":"Currency"
        },
        "commodityDesc":{
            "type":"string",
            "description":"Commodity Description"
        },
        "descriptionOfGoods":{
            "type":"string",
            "description":"Description of Goods"
        },
        "unit":{
            "type":"string",
            "description":"Unit"
        },
        "invoiceNumber":{
            "type":"string",
            "description":"Invoice Number"
        },
        "creditNoteRefNo":{
            "type":"string",
            "description":"Credit Note Reference Number"
        },
        "transactionRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "discountAmount":{
            "type":"number",
            "description":"Discount Amount"
        },
        "discountPercentage":{
            "type":"number",
            "description":"Discount Percentage"
        },
        "taxAmount":{
            "type":"number",
            "description":"Tax Amount"
        },
        "taxPercentage":{
            "type":"number",
            "description":"Tax Percentage"
        },
        "costPerUnit":{
            "type":"number",
            "description":"Cost Per Unit"
        },
        "totalCost":{
            "type":"number",
            "description":"Total Cost"
        },
        "netCost":{
            "type":"number",
            "description":"Net cost"
        },
        "quantity":{
            "type":"number",
            "description":"Quantity"
        },
        "unitWeight":{
            "type":"number",
            "description":"Unit Weight"
        },
        "totalWeight":{
            "type":"number",
            "description":"Total weight"
        }
    }
}

Nested Schema : LinkedInvoiceModel

Type: object

Show Source

• currency(optional): string
• invoiceAmount(optional): number
• invoiceDate(optional): string
• invoiceDueDate(optional): string
• invoiceNumber(optional): string
• invoiceRefNo(optional): string
• invoiceStatus(optional): string
• miscCharge1Amount(optional): number
• miscCharge2Amount(optional): number
• paymentStatus(optional): string

{
    "type":"object",
    "properties":{
        "invoiceNumber":{
            "type":"string"
        },
        "invoiceRefNo":{
            "type":"string"
        },
        "invoiceAmount":{
            "type":"number"
        },
        "miscCharge1Amount":{
            "type":"number"
        },
        "miscCharge2Amount":{
            "type":"number"
        },
        "invoiceDate":{
            "type":"string"
        },
        "invoiceDueDate":{
            "type":"string"
        },
        "invoiceStatus":{
            "type":"string"
        },
        "paymentStatus":{
            "type":"string"
        },
        "currency":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top