Update invoice in settlement
put
/service/v1/settlementStatusUpd
This endpoint is used to update invoice in settlement.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
Request Body with attributes picked from model.
Root Schema : FinanceTransactionModel
Type:
objectFinance Transaction Model
Show Source
-
accountType:
string
Account Type
-
appropPaymentAmt:
number
Appropriate Payment Amount
-
appropriated:
integer
Default Value:
2is Appropiration done on the finance -
appropriationSequence:
string
Appropriation Sequence
-
authDateStamp:
string
Authorization Date Stamp
-
authId:
string
Authorization Id
-
autoSettleNFinRefNoList:
array autoSettleNFinRefNoList
Auto settle N finance ref no
-
balanceAmtToBeAllocated:
number
Balance Amount To Be Allocated
-
branchCode:
string
Branch Code
-
buyerDivCode:
string
Buyer Division Code
-
buyerDivName:
string
Buyer Division Name
-
buyerId:
string
Buyer Id
-
buyerName:
string
Buyer Name
-
channel:
string
Channel
-
chgCalc:
string
Charge Calculation
-
clRefNo:
string
Cl Reference Number
-
creditAccount:
string
Credit Account
-
creditReceived:
string
Credit Received
-
debtor:
string
Debtor
-
debtorName:
string
Debtor Name
-
delinquencyStatus:
string
Delinquency Status
-
docRefNo:
string
Document Reference Number
-
earliestScheduleDate:
string
earliest Unpaid Schedule Date
-
errorCode:
string
Error Code
-
errorDescription:
string
Error Description
-
exchangeRate:
number
Exchange Rate
-
financeAmt:
number
Finance Amount
-
financeAmtCcy:
string
Finance Amount Currency
-
financePCT:
number
Finance PCT
-
financeRefNo:
string
Finance Reference Number
-
financeStatus:
string
Finance Status
-
fundingReqDate:
string
-
graceDays:
number
Grace Days
-
holidayTreatment:
string
Holiday Treatment
-
id:
string
Id
-
inProgressSettlementsFound:
boolean
Flag for inProgressSettlements
-
instrumentDate:
string
-
intCalcBasisAmt:
number
Int Calc Basis Amt
-
interestAmortized:
number
Interest Amortized
-
interestBearingPartyRole:
string
Interest Bearing Party Role
-
interestCollFreq:
string
Interest Collection Frequency
-
interestDueAmount:
number
Monthly Interest Due Amount
-
interestOSAmount:
number
Interest OS Amount
-
interestPaidUpfront:
number
Interest Paid Upfront
-
interestRefundAmt:
number
Interest Refund Amount
-
interestRefundHandling:
string
Interest Refund Handling
-
interestRefundPmtMode:
string
Interest Refund Payment Mode
-
interestType:
string
Interest Type
-
intgStatusCode:
string
External Integration Status
-
isAdhocTxn:
string
Is Adhoc Txn
-
isFromRecon:
string
Is From Recon
-
isLimitsApplicable:
boolean
Limit applicable flag
-
isOverdue:
string
Overdue flag
-
isSplitTxn:
string
Is Split Txn
-
makerDateStamp:
string
Maker Date Stamp
-
makerId:
string
Maker Id
-
manualAllocation:
string
Manual Allocation
-
maturityDate:
string
Pattern:
([0-9]{4})-([0-9]{2})-([0-9]{2})Maturity Date -
maxFinanciableAmt:
number
Maximum Financiable Amount
-
maxFinPCT:
number
Maximum Finance PCT
-
maxReFinPCT:
number
Maximum ReFin PCT
-
maxTenorAllowed:
number
Maximum Tenor Allowed
-
minFinanciableAmt:
number
Minimum Financiable Amount
-
minFinPCT:
number
Minimum Finance PCT
-
minReFinPCT:
number
Minimum ReFin PCT
-
minTenorAllowed:
number
Minimum Tenor Allowed
-
odIntCalcBasisAmt:
number
OdInt Calc Basis Amt
-
operationCode:
string
Operation Code
-
overdueIntOSAmt:
number
Overdue Interest OS Amount
-
parentRefNo:
string
Parent Reference Number
-
partRepaymentAllowed:
string
Part Repayment Allowed
-
pastDueDate:
string
Pattern:
([0-9]{4})-([0-9]{2})-([0-9]{2})Past Due Date -
paymentAmt:
number
Payment Amount
-
paymentParty:
string
Payment Party
-
paymentRefNo:
string
Payment Reference Number
-
penIntCalcBasisAmt:
number
Pen Int Calc Basis Amt
-
penIntOSAmt:
number
Pen Interest OS Amount
-
pmtToIntDue:
number
Payment Towards Interest Due Amount
-
pmtToIntOS:
number
Payment To Interest OS
-
pmtToOverdueIntOS:
number
Payment To Overdue Interest OS
-
pmtToPenOnIntOS:
number
Payment To Pen On Interest OS
-
pmtToPrncplOS:
number
Payment To Principle OS
-
preferredDisbursementMode:
string
Preferred Disbursement Mode
-
prePostConversion:
string
prePostConversion
-
preShipFinanceRefNo:
array preShipFinanceRefNo
Pre shipment POs
-
principalOSAmount:
number
Principal OS Amount
-
principalOSAmountForCalc:
number
Principal OS Amount For Calculation
-
processingDate:
string
Pattern:
([0-9]{4})-([0-9]{2})-([0-9]{2})Processing Date -
productCategory:
string
Product Category
-
productCode:
string
Product Code
-
productDescription:
string
Product Description
-
productType:
string
Product Type
-
programCode:
string
Program Code
-
programName:
string
Program Name
-
refund:
number
Refund
-
requestDate:
string
Pattern:
([0-9]{4})-([0-9]{2})-([0-9]{2})Request Date -
requestId:
string
Request Id
-
seqNo:
integer(int64)
Sequence Number
-
settleFinExcRate:
number
Settlement Finance Exchange Rate
-
settlementAmtAllocated:
number
Settlement Amount Allocated
-
settlementAmtAllocation:
string
Settlement Amount Allocation
-
settlementCcy:
string
Settlement Currency
-
settlementExchangeRate:
number
Settlement Exchange Rate
-
settlementMethod:
string
Settlement Method
-
settlementProcessingDate:
string
Pattern:
([0-9]{4})-([0-9]{2})-([0-9]{2})Settlement Processing Date -
settlementRefNo:
string
Settlement Reference Number
-
stageId:
string
Stage Id
-
staleStatus:
string
Stale Status
-
startDate:
string
Pattern:
([0-9]{4})-([0-9]{2})-([0-9]{2})Start Date -
statusSortingComparator:
number
-
supplierDivCode:
string
Supplier Division Code
-
supplierDivName:
string
Supplier Division Name
-
supplierId:
string
Supplier Id
-
supplierName:
string
Supplier Name
-
tenor:
integer(int64)
Tenor
-
totalInstrumentAmt:
number
Total Instrument Amount
-
totalInstrumentAmtCcy:
string
Total Instrument Amount Currency
-
totalMarginAmount:
number
Total Margin Amount
-
totalNetInvoiceAmt:
number
Total Net Invoice Amount
-
totalOSAmount:
number
Total OS Amount
-
totalOSAmountForCalc:
number
Total Os Amount For Calculation
-
totalOSAmountSettlementCcy:
number
Total OS Amount Settlement Currency
-
totalOSPostAllocation:
number
Total OS Post Allocation
-
totalSettlementAmt:
number
Total Settlement Amount
-
transactionFlow:
string
Transaction Flow
-
useEarmarkedLimits:
string
Use Earmarked Limits
-
utrRefNo:
string
Utr Reference Number
-
valueDate:
string
Pattern:
([0-9]{4})-([0-9]{2})-([0-9]{2})Value Date -
valueDtdIntDueAmt:
number
Value Dated Monthly Interest Due Amount
-
valueDtdIntDueAmtForCalc:
number
Value Dated Monthly Interest Due Amount For Calculation
-
valueDtdIntOSAmt:
number
Value Dated Interest OS Amount
-
valueDtdIntOSAmtForCalc:
number
Value Dated Interest OS Amount For Calculation
-
valueDtdOverdueIntOSAmt:
number
Value Dated Overdue Interest OS Amount
-
valueDtdOverdueIntOSAmtForCalc:
number
Value Dated Overdue Interest Os Amount For Calculation
-
valueDtdPenIntOSAmt:
number
Value Dated Pen Interest OS Amount
-
valueDtdPenIntOSAmtForCalc:
number
Value Dated Pen Interest OS Amount For Calculation
-
withRecourse:
string
With Recourse
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns the Id of the newly created record
Root Schema : schema
Type:
string400 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