Create new credit note from external channels (V2)
post
/service/v2/createCreditNote
This endpoint is used to create new credit note from external channels (V2).
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId(required): string
Application Id
-
branchCode(required): string
Branch Code
-
userId(required): string
User Id
Request Body that contains data required for creating a new CreditNote.
Root Schema : CreditNoteCollection
Type:
objectList of Credit Notes
Show Source
-
action:
string
Is Auto Authorized
-
creditNoteList:
array creditNoteList
-
errorCode:
string
Error Code
-
errorDesc:
string
Error Desc
-
paging:
object PagingDto
-
sourceTxnId:
string
sourceTxnId
Nested Schema : creditNoteList
Type:
Show Source
array-
Array of:
object CreditNoteModel
Credit Note Model
Nested Schema : CreditNoteModel
Type:
objectCredit Note Model
Show Source
-
action:
string
action
-
adjustmentReason:
string
Adjustment Reason
-
amount:
number
Base Cn amount
-
buyerCode:
string
Buyer Code
-
buyerDivCode:
string
Buyer Division Code
-
buyerDivName:
string
Buyer Division Name
-
buyerId:
string
Buyer Id
-
buyerName:
string
Buyer Name
-
cnDate:
string
Cn Date
-
cnExpiryDate:
string
Cn Expiry Date
-
cnNumber:
string
Credit Note Reference Number
-
cnReconcilationStatus:
string
Cn Reconcilation Status
-
cnStatus:
string
Cn Status
-
commodityGridList:
array commodityGridList
-
creditNoteId:
string
Credit Note generated Id
-
creditNoteRefNo:
string
Credit Note System generated RefNo
-
currency:
string
Currency
-
discountAmount:
number
Discount Amount
-
discountPercentage:
number
Discount Percentage
-
expiresOn:
string
expiresOn
-
fileName:
string
File Name
-
filler1:
string
Filler1
-
filler10:
string
Filler10
-
filler2:
string
Filler2
-
filler3:
string
Filler3
-
filler4:
string
Filler4
-
filler5:
string
Filler5
-
filler6:
string
Filler6
-
filler7:
string
Filler7
-
filler8:
string
Filler8
-
filler9:
string
Filler9
-
isAutoAuth:
string
Is Auto Authorized
-
isAutoReconcile:
string
Is Auto Authorized
-
isRecon:
string
isRecon
-
isTxnCreationReqd:
string
is txn creation required
-
linkedInvoiceList:
array linkedInvoiceList
-
linkInvoiceNumber:
string
Pipe seperated invoice numbers
-
makerDtStamp:
string
Maker Date Stamp
-
makerId:
string
Maker Id
-
matchedAmount:
number
Matched Amount
-
miscCharge1Amount:
number
Miscellaneous Charge1 Amount
-
miscCharge1Desc:
string
Miscellaneous Charge1 Description
-
miscCharge2Amount:
number
Miscellaneous Charge2 Amount
-
miscCharge2Desc:
string
Miscellaneous Charge2 Description
-
netAmount:
number
Net Cn amount
-
procBranchCode:
string
Proc Branch Code
-
procBranchDate:
string
Proc Branch Date
-
programCode:
string
Program Code
-
programName:
string
Program Name
-
reasonCode:
string
Reason Code
-
reasonErrorCode:
string
Reason Error Code
-
reconciledPmtAmt:
number
reconciledPmtAmt
-
reconTxnStatus:
string
Recon Transaction Status
-
relationCode:
string
Relation Code
-
remarks:
string
Remarks
-
seqNo:
integer(int64)
seqNo
-
sourceTxnId:
string
Source Transaction Id
-
srcAppCd:
string
Source Application Code
-
stageId:
string
Stage Id
-
supplierCode:
string
Supplier code
-
supplierDivCode:
string
Supplier Division Code
-
supplierDivName:
string
Supplier Division Name
-
supplierId:
string
Supplier Id
-
supplierName:
string
Supplier Name
-
taxAmount:
number
Tax Amount
-
taxPercentage:
number
Tax Percentage
-
totalAmount:
number
Total Cn amount
-
transactionRefNo:
string
Transaction Reference Number
-
unmatchedAmount:
number
Unmatched Amount
Nested Schema : CnCommodityGridModel
Type:
Show Source
object-
commodityCode:
string
Commodity Code
-
commodityDesc:
string
Commodity Description
-
commodityName:
string
Commodity Name
-
costPerUnit:
number
Cost Per Unit
-
creditNoteRefNo:
string
Credit Note Reference Number
-
currency:
string
Currency
-
descriptionOfGoods:
string
Description of Goods
-
discountAmount:
number
Discount Amount
-
discountPercentage:
number
Discount Percentage
-
id:
string
id
-
invoiceNumber:
string
Invoice Number
-
netCost:
number
Net cost
-
quantity:
number
Quantity
-
seqNo:
integer(int64)
seqNo
-
taxAmount:
number
Tax Amount
-
taxPercentage:
number
Tax Percentage
-
totalCost:
number
Total Cost
-
totalWeight:
number
Total weight
-
transactionRefNo:
string
Transaction Reference Number
-
unit:
string
Unit
-
unitWeight:
number
Unit Weight
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns the details of the newly created credit note
Root Schema : CreateCreditNoteV2ResponseCollection
Type:
objectList of Create Credit Note Service Response
Show Source
Nested Schema : CreateCreditNoteV2Response
Type:
Show Source
object-
creditNoteResList:
array creditNoteResList
-
errCode:
string
errCode
-
errDesc:
string
errDesc
-
sourceTxnId:
string
sourceTxnId
-
transactionRefNo:
string
transactionRefNo
-
txnStatus:
string
txnStatus
Nested Schema : CreditNoteResponse
Type:
Show Source
object-
cnId:
string
cnId
-
cnNumber:
string
cnNumber
-
cnStatus:
string
cnStatus
-
creditNoteRefNo:
string
creditNoteRefNo
-
errCode:
string
errCode
-
errDesc:
string
errDesc
-
txnStatus:
string
txnStatus
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