Update settlement status for invoice
put
/service/v1/settlementStatusUpd
This endpoint is used to update the status of the settlement for an invoice.
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(optional):
string
-
appropPaymentAmt(optional):
number
-
appropriationSequence(optional):
string
-
authDateStamp(optional):
string
-
authId(optional):
string
-
balanceAmtToBeAllocated(optional):
number
-
branchCode(optional):
string
-
buyerDivCode(optional):
string
-
buyerDivName(optional):
string
-
buyerId(optional):
string
-
buyerName(optional):
string
-
clRefNo(optional):
string
-
creditAccount(optional):
string
-
creditReceived(optional):
string
-
debtor(optional):
string
-
debtorName(optional):
string
-
docRefNo(optional):
string
-
errorCode(optional):
string
-
errorDescription(optional):
string
-
exchangeRate(optional):
number
-
financeAmt(optional):
number
-
financeAmtCcy(optional):
string
-
financePCT(optional):
number
-
financeRefNo(optional):
string
-
financeStatus(optional):
string
-
graceDays(optional):
number
-
holidayTreatment(optional):
string
-
id(optional):
string
-
interestAmortized(optional):
number
-
interestBearingPartyRole(optional):
string
-
interestOSAmount(optional):
number
-
interestPaidUpfront(optional):
number
-
interestRefundAmt(optional):
number
-
interestRefundHandling(optional):
string
-
interestRefundPmtMode(optional):
string
-
interestType(optional):
string
-
isFromRecon(optional):
string
-
isOverdue(optional):
string
-
makerDateStamp(optional):
string
-
makerId(optional):
string
-
manualAllocation(optional):
string
-
marginRefNo(optional):
string
-
maturityDate(optional):
string
-
maxFinanciableAmt(optional):
number
-
maxFinPCT(optional):
number
-
maxReFinPCT(optional):
number
-
maxTenorAllowed(optional):
number
-
minFinanciableAmt(optional):
number
-
minFinPCT(optional):
number
-
minReFinPCT(optional):
number
-
minTenorAllowed(optional):
number
-
operationCode(optional):
string
-
overdueIntOSAmt(optional):
number
-
partRepaymentAllowed(optional):
string
-
pastDueDate(optional):
string
-
paymentAmt(optional):
number
-
paymentParty(optional):
string
-
penIntOSAmt(optional):
number
-
pmtToIntOS(optional):
number
-
pmtToOverdueIntOS(optional):
number
-
pmtToPrncplOS(optional):
number
-
preferredDisbursementMode(optional):
string
-
principalOSAmount(optional):
number
-
processingDate(optional):
string
-
productCategory(optional):
string
-
productCode(optional):
string
-
productDescription(optional):
string
-
productType(optional):
string
-
programCode(optional):
string
-
programName(optional):
string
-
refund(optional):
number
-
requestDate(optional):
string
-
requestId(optional):
string
-
seqNo(optional):
integer(int64)
-
settleFinExcRate(optional):
number
-
settlementAmtAllocated(optional):
number
-
settlementAmtAllocation(optional):
string
-
settlementCcy(optional):
string
-
settlementExchangeRate(optional):
number
-
settlementMethod(optional):
string
-
settlementProcessingDate(optional):
string
-
settlementRefNo(optional):
string
-
stageId(optional):
string
-
staleStatus(optional):
string
-
startDate(optional):
string
-
supplierDivCode(optional):
string
-
supplierDivName(optional):
string
-
supplierId(optional):
string
-
supplierName(optional):
string
-
tenor(optional):
integer(int64)
-
totalInstrumentAmt(optional):
number
-
totalInstrumentAmtCcy(optional):
string
-
totalMarginAmount(optional):
number
-
totalOSAmount(optional):
number
-
totalOSAmountSettlementCcy(optional):
number
-
totalOSPostAllocation(optional):
number
-
totalSettlementAmt(optional):
number
-
valueDate(optional):
string
-
valueDtdIntOSAmt(optional):
number
-
valueDtdOverdueIntOSAmt(optional):
number
-
withRecourse(optional):
string
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