Jump to

• Request
• Response

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

• appId: string
• branchCode: string
• userId: string

Body ()

Request Body with attributes picked from model.

Root Schema : FinanceTransactionModel

Type: object

Finance 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

{
    "description":"Finance Transaction Model",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "financeRefNo":{
            "type":"string"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64"
        },
        "requestId":{
            "type":"string"
        },
        "branchCode":{
            "type":"string"
        },
        "productCode":{
            "type":"string"
        },
        "operationCode":{
            "type":"string"
        },
        "programCode":{
            "type":"string"
        },
        "programName":{
            "type":"string"
        },
        "buyerId":{
            "type":"string"
        },
        "buyerName":{
            "type":"string"
        },
        "buyerDivCode":{
            "type":"string"
        },
        "buyerDivName":{
            "type":"string"
        },
        "supplierId":{
            "type":"string"
        },
        "supplierName":{
            "type":"string"
        },
        "supplierDivCode":{
            "type":"string"
        },
        "supplierDivName":{
            "type":"string"
        },
        "debtor":{
            "type":"string"
        },
        "debtorName":{
            "type":"string"
        },
        "startDate":{
            "type":"string"
        },
        "tenor":{
            "type":"integer",
            "format":"int64"
        },
        "maturityDate":{
            "type":"string"
        },
        "totalInstrumentAmtCcy":{
            "type":"string"
        },
        "totalInstrumentAmt":{
            "type":"number"
        },
        "financePCT":{
            "type":"number"
        },
        "financeAmtCcy":{
            "type":"string"
        },
        "financeAmt":{
            "type":"number"
        },
        "exchangeRate":{
            "type":"number"
        },
        "processingDate":{
            "type":"string"
        },
        "settlementProcessingDate":{
            "type":"string"
        },
        "makerId":{
            "type":"string"
        },
        "makerDateStamp":{
            "type":"string"
        },
        "authId":{
            "type":"string"
        },
        "authDateStamp":{
            "type":"string"
        },
        "financeStatus":{
            "type":"string"
        },
        "clRefNo":{
            "type":"string"
        },
        "settlementRefNo":{
            "type":"string"
        },
        "settlementMethod":{
            "type":"string"
        },
        "totalSettlementAmt":{
            "type":"number"
        },
        "creditReceived":{
            "type":"string"
        },
        "creditAccount":{
            "type":"string"
        },
        "paymentParty":{
            "type":"string"
        },
        "accountType":{
            "type":"string"
        },
        "settlementAmtAllocated":{
            "type":"number"
        },
        "balanceAmtToBeAllocated":{
            "type":"number"
        },
        "settlementAmtAllocation":{
            "type":"string"
        },
        "manualAllocation":{
            "type":"string"
        },
        "pastDueDate":{
            "type":"string"
        },
        "valueDate":{
            "type":"string"
        },
        "principalOSAmount":{
            "type":"number"
        },
        "interestOSAmount":{
            "type":"number"
        },
        "totalOSAmount":{
            "type":"number"
        },
        "valueDtdIntOSAmt":{
            "type":"number"
        },
        "overdueIntOSAmt":{
            "type":"number"
        },
        "valueDtdOverdueIntOSAmt":{
            "type":"number"
        },
        "paymentAmt":{
            "type":"number"
        },
        "appropPaymentAmt":{
            "type":"number"
        },
        "appropriationSequence":{
            "type":"string"
        },
        "pmtToPrncplOS":{
            "type":"number"
        },
        "pmtToIntOS":{
            "type":"number"
        },
        "pmtToOverdueIntOS":{
            "type":"number"
        },
        "productDescription":{
            "type":"string"
        },
        "productCategory":{
            "type":"string"
        },
        "maxTenorAllowed":{
            "type":"number"
        },
        "minTenorAllowed":{
            "type":"number"
        },
        "minFinPCT":{
            "type":"number"
        },
        "maxFinPCT":{
            "type":"number"
        },
        "holidayTreatment":{
            "type":"string"
        },
        "productType":{
            "type":"string"
        },
        "preferredDisbursementMode":{
            "type":"string"
        },
        "settlementCcy":{
            "type":"string"
        },
        "totalOSAmountSettlementCcy":{
            "type":"number"
        },
        "refund":{
            "type":"number"
        },
        "settlementExchangeRate":{
            "type":"number"
        },
        "totalOSPostAllocation":{
            "type":"number"
        },
        "settleFinExcRate":{
            "type":"number"
        },
        "stageId":{
            "type":"string"
        },
        "errorCode":{
            "type":"string"
        },
        "errorDescription":{
            "type":"string"
        },
        "graceDays":{
            "type":"number"
        },
        "partRepaymentAllowed":{
            "type":"string"
        },
        "staleStatus":{
            "type":"string"
        },
        "isOverdue":{
            "type":"string"
        },
        "minFinanciableAmt":{
            "type":"number"
        },
        "maxFinanciableAmt":{
            "type":"number"
        },
        "minReFinPCT":{
            "type":"number"
        },
        "maxReFinPCT":{
            "type":"number"
        },
        "withRecourse":{
            "type":"string"
        },
        "totalMarginAmount":{
            "type":"number"
        },
        "penIntOSAmt":{
            "type":"number"
        },
        "marginRefNo":{
            "type":"string"
        },
        "interestType":{
            "type":"string"
        },
        "interestRefundAmt":{
            "type":"number"
        },
        "interestRefundHandling":{
            "type":"string"
        },
        "interestRefundPmtMode":{
            "type":"string"
        },
        "interestBearingPartyRole":{
            "type":"string"
        },
        "isFromRecon":{
            "type":"string"
        },
        "interestPaidUpfront":{
            "type":"number"
        },
        "interestAmortized":{
            "type":"number"
        },
        "docRefNo":{
            "type":"string"
        },
        "requestDate":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the Id of the newly created record

Body ()

Root Schema : schema

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