Roll-back the amount and status for payment and credit note
post
/service/v1/purgeInstrumentsRecon
This endpoint is used to roll-back the amount and status for payment and credit note for in progress reconciliation transactions basis recon transaction reference no which got generated during recon initiation. This is used internally within reconciliation workflow
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId: string
App Id
-
branchCode: string
branchCode
-
userId: string
userId
Request Body with attributes picked from model.
Root Schema : ScfInvPayReconDTO
Type:
objectResponse Model
Show Source
-
invoices(optional):
array invoices
InvoiceModel
Nested Schema : InvoiceModel
Invoice model
Match All
Show Source
-
object
TransactionModel
Discriminator:
model_Type -
object
InvoiceModel-allOf[1]
Nested Schema : TransactionModel
Type:
objectDiscriminator:
model_TypeNested Schema : InvoiceModel-allOf[1]
Type:
Show Source
object-
acceptanceAmount(optional):
number
Acceptance Amount
-
action(optional):
string
Action
-
adjustmentReason(optional):
integer
Adjustment Reason
-
amount(optional):
number
Amount
-
amountToBeFinanced(optional):
number
Amount To Be Financed
-
assignmentParty(optional):
string
Assignment Party
-
bank(optional):
string
Bank
-
branch(optional):
string
Branch
-
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
-
countryOfOrigin(optional):
string
Country Of Origin
-
currency(optional):
string
Currency
-
debitNoteId(optional):
string
Debit Note Id
-
discountAllowed(optional):
string
Discount Allowed
-
discountAmount(optional):
number
Discount Amount
-
discountPercentage(optional):
number
Discount Percentage
-
discrepancyCode(optional):
string
Discrepancy Code
-
disputedAmount(optional):
number
Disputed Amount
-
disputeResolveRemarks(optional):
string
Dispute Resolve Remarks
-
divisionCode(optional):
string
Division Code
-
fileName(optional):
string
File Name
-
fileRef(optional):
string
File Reference
-
filler1(optional):
string
Filler1
-
filler2(optional):
string
Filler2
-
filler3(optional):
string
Filler3
-
filler4(optional):
string
Filler4
-
financeableAmount(optional):
number
Financeable Amount
-
financeAmount(optional):
number
Finance Amount
-
financePercentage(optional):
number
Finance Percentage
-
finEligibilityAmt(optional):
number
Finance Eligibility Amount
-
finTxnStatus(optional):
string
Finance Transaction Status
-
fundingReqAmt(optional):
number
Funding Required Amount
-
importFactorId(optional):
string
Import Factor Id
-
importFactorName(optional):
string
Import Factor Name
-
indicator(optional):
string
Indicator
-
insuranceCoId(optional):
string
Insurance Co Id
-
insuranceCoName(optional):
string
Insurance Co Name
-
invAcceptanceDate(optional):
string
Invoice Acceptance Date
-
invoiceCommodityGridList(optional):
array invoiceCommodityGridList
-
invoiceDate(optional):
string
Invoice Date
-
invoiceDueDate(optional):
string
Invoice Due Date
-
invoiceId(optional):
string
Id of the Invoice
-
invoiceNumber(optional):
string
Invoice Number
-
invoiceProcessStatus(optional):
string
Invoice Process Status
-
invoiceRefNo(optional):
string
Invoice Reference Number
-
invoiceStatus(optional):
string
Invoice Status
-
isAccepted(optional):
string
Is Accepted
-
isApproved(optional):
string
Is Approved
-
isAssigned(optional):
string
Is Assigned
-
isAutoAuth(optional):
string
Is Auto Authorized
-
isDebitNote(optional):
string
Is Debit Note
-
isDisputed(optional):
string
Is Disputed
-
isDisputeResolvedWriteOff(optional):
string
Is Dispute Resolved Write Off
-
isFinanced(optional):
string
Is Financed
-
isIndirectPayment(optional):
string
Is Indirect Payment
-
isOverdue(optional):
string
Is Overdue
-
isPUA(optional):
string
Is PUA
-
linkedDocs(optional):
string
Linked Documents
-
makerDtStamp(optional):
string
Maker Date Stamp
-
makerId(optional):
string
Maker Id
-
maxFinancePercentage(optional):
number
Maximum Finance Percentage
-
miscCharge1(optional):
number
Miscellaneous Charge 1
-
miscCharge1Amount(optional):
number
Miscellaneous Charge 1 Amount
-
miscCharge1Desc(optional):
string
Miscellaneous Charge 1 Description
-
miscCharge2(optional):
number
Miscellaneous Charge 2
-
miscCharge2Amount(optional):
number
Miscellaneous Charge 2 Amount
-
miscCharge2Desc(optional):
string
Miscellaneous Charge 2 Description
-
netInvoiceAmount(optional):
number
Net Invoice Amount
-
oldAcceptanceAmount(optional):
number
Old Acceptance Amount
-
oldDisputeAmount(optional):
number
Old Dispute Amount
-
oldFinanceAmount(optional):
number
Old Finance Amount
-
oldInvoiceDueDate(optional):
string
Old Invoice Due Date
-
outstandingAmount(optional):
number
Outstanding Amount
-
paidAmount(optional):
number
Paid Amount
-
paymentDate(optional):
string
Payment date
-
paymentDueDate(optional):
string
Payment Due Date
-
paymentMode(optional):
string
Payment Mode
-
paymentParty(optional):
string
Payment party
-
paymentStatus(optional):
string
Payment Status
-
paymentTerms(optional):
string
Payment Terms
-
poNumber(optional):
string
PO Number
-
preAccepted(optional):
string
Pre Accepted
-
processingBranchCode(optional):
string
Processing Branch Code
-
processingDate(optional):
string
Processing Date
-
programCode(optional):
string
Program Code
-
programName(optional):
string
Program Name
-
purchaseOrderDate(optional):
string
Purchase Order Date
-
raisedBy(optional):
string
Raised By
-
reasonCode(optional):
string
Reason Code
-
reasonErrorCode(optional):
string
Reason Error Code
-
reasonForExport(optional):
string
Reason For Export
-
reasonForShipment(optional):
string
Reason For Shipment
-
reconPmtAmount(optional):
number
Recon Payment Amount
-
reconPmtAmountCcy(optional):
string
Recon Payment Amount Currency
-
reconTxnStatus(optional):
string
Recon Transaction Status
-
relationCode(optional):
string
Relation Code
-
remarks(optional):
string
Remarks
-
repayAccountNo(optional):
string
Repay Account Number
-
routingCode(optional):
number
Routing Code
-
seqNo(optional):
integer(int64)
Seq of the Invoice
-
shipmentAddress(optional):
string
Shipment Address
-
shipmentCountry(optional):
string
Shipment Country
-
shipmentDate(optional):
string
Shipment date
-
shipmentNo(optional):
string
Shipment Number
-
shipmentRefNo(optional):
string
Shipment Reference Number
-
sourceTxnId(optional):
string
Source Transaction Id
-
srcAppCd(optional):
string
Source Application Code
-
stageId(optional):
string
Stage Id
-
staleStatus(optional):
string
Stale Status
-
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
-
tcmId(optional):
string
Tcm Id
-
termsOfSale(optional):
string
Terms Of Sale
-
totalInvoiceAmount(optional):
number
Total Invoice Amount
-
transactionRefNo(optional):
string
Transaction Reference Number
-
virtualAcFlag(optional):
string
Virtual Account Flag
Nested Schema : InvoiceCommodityGridModel
Type:
Show Source
object-
ccy(optional):
string
Currency
-
commodityCode(optional):
string
Commodity Code
-
commodityDesc(optional):
string
Commodity Description
-
commodityName(optional):
string
Commodity Name
-
costPerUnit(optional):
number
Cost per Unit
-
descriptionOfGoods(optional):
string
Description Of Goods
-
discountAmount(optional):
number
Discount Amount
-
discountPercentage(optional):
number
Discount Percentage
-
invoiceCommodityGridId(optional):
string
Id of the Invoice Commodity Grid
-
invoiceNumber(optional):
string
Invoice Number
-
netCost(optional):
number
Net Cost
-
quantity(optional):
number
Quantity
-
taxAmount(optional):
number
Tax Amount
-
taxPercentage(optional):
number
Tax Percentage
-
totalCost(optional):
number
Total Cost
-
totalWeight(optional):
number
Total Weight
-
unit(optional):
string
Unit
-
unitWeight(optional):
number
Unit Weight
Response
Supported Media Types
- application/json
- application/xml
200 Response
Invoices rejected successfully
Root Schema : schema
Type:
boolean400 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