Jump to

• Request
• Response

Creates a new Reconciliation Rule

post

/service/v2/autoRecon

This endpoint is used to create a new Reconciliation Rule.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

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

Body ()

Request Body that contains data required for creating a new autoRecon

Root Schema : ScfTmReconMasterWrapperDTO

Type: object

Show Source

• action(optional): string
  Action
• isAutoAuth(optional): string
  Is Auto Authorization
• modNo(optional): integer
  Mod Number
• partyId(optional): string
  Party Id
• partyName(optional): string
  Party Name
• ReconRuleMasterList(optional): array ReconRuleMasterList

{
    "type":"object",
    "properties":{
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "partyName":{
            "type":"string",
            "description":"Party Name"
        },
        "isAutoAuth":{
            "type":"string",
            "description":"Is Auto Authorization"
        },
        "action":{
            "type":"string",
            "description":"Action"
        },
        "modNo":{
            "type":"integer",
            "description":"Mod Number"
        },
        "ReconRuleMasterList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconRuleDefMasterDTO"
            }
        }
    }
}

Nested Schema : ReconRuleMasterList

Type: array

Show Source

• Array of: object ReconRuleDefMasterDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ReconRuleDefMasterDTO"
    }
}

Nested Schema : ReconRuleDefMasterDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object ReconRuleDefMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "ruleAction":{
                    "type":"string",
                    "description":"Rule action"
                },
                "id":{
                    "type":"string",
                    "description":"Id"
                },
                "priority":{
                    "type":"number",
                    "description":"Priority"
                },
                "baseEntity":{
                    "type":"string",
                    "description":"Base Entity"
                },
                "baseOnAttr":{
                    "type":"string",
                    "description":"Base on attribute"
                },
                "genericCriteria":{
                    "type":"string",
                    "description":"Generic Criteria"
                },
                "reconCategory":{
                    "type":"string",
                    "description":"Recon Category"
                },
                "reconType":{
                    "type":"string",
                    "description":"Recon Type"
                },
                "executeGeneric":{
                    "type":"string",
                    "description":"Execute Generic"
                },
                "ruleDescription":{
                    "type":"string",
                    "description":"Rule description"
                },
                "ruleId":{
                    "type":"string",
                    "description":"Rule Id"
                },
                "allocationBasis":{
                    "type":"string",
                    "description":"Allocation Basis"
                },
                "GroupsAndConditions":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/GroupsAndConditions"
                    }
                },
                "AllocationList":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/AllocationDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : ReconRuleDefMasterDTO-allOf[1]

Type: object

Show Source

• allocationBasis(optional): string
  Allocation Basis
• AllocationList(optional): array AllocationList
• baseEntity(optional): string
  Base Entity
• baseOnAttr(optional): string
  Base on attribute
• executeGeneric(optional): string
  Execute Generic
• genericCriteria(optional): string
  Generic Criteria
• GroupsAndConditions(optional): array GroupsAndConditions
• id(optional): string
  Id
• priority(optional): number
  Priority
• reconCategory(optional): string
  Recon Category
• reconType(optional): string
  Recon Type
• ruleAction(optional): string
  Rule action
• ruleDescription(optional): string
  Rule description
• ruleId(optional): string
  Rule Id

{
    "type":"object",
    "properties":{
        "ruleAction":{
            "type":"string",
            "description":"Rule action"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "priority":{
            "type":"number",
            "description":"Priority"
        },
        "baseEntity":{
            "type":"string",
            "description":"Base Entity"
        },
        "baseOnAttr":{
            "type":"string",
            "description":"Base on attribute"
        },
        "genericCriteria":{
            "type":"string",
            "description":"Generic Criteria"
        },
        "reconCategory":{
            "type":"string",
            "description":"Recon Category"
        },
        "reconType":{
            "type":"string",
            "description":"Recon Type"
        },
        "executeGeneric":{
            "type":"string",
            "description":"Execute Generic"
        },
        "ruleDescription":{
            "type":"string",
            "description":"Rule description"
        },
        "ruleId":{
            "type":"string",
            "description":"Rule Id"
        },
        "allocationBasis":{
            "type":"string",
            "description":"Allocation Basis"
        },
        "GroupsAndConditions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupsAndConditions"
            }
        },
        "AllocationList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AllocationDTO"
            }
        }
    }
}

Nested Schema : AllocationList

Type: array

Show Source

• Array of: object AllocationDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AllocationDTO"
    }
}

Nested Schema : GroupsAndConditions

Type: array

Show Source

• Array of: object GroupsAndConditions

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GroupsAndConditions"
    }
}

Nested Schema : AllocationDTO

Type: object

Show Source

• allocationParameter(optional): string
  Allocation Parameter
• id(optional): string
  Id
• percentage(optional): number
  Percentage

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "allocationParameter":{
            "type":"string",
            "description":"Allocation Parameter"
        },
        "percentage":{
            "type":"number",
            "description":"Percentage"
        }
    }
}

Nested Schema : GroupsAndConditions

Type: object

Show Source

• caseSensitive(optional): boolean
  Default Value: false

  Boolean value to identify whether this condition is case sensitive
• connectingOperator(optional): string
  Logical Operator applied between all groups, this is the connecting operator
• groupsAndConditions(optional): array groupsAndConditions
• id(optional): string
  Unique identifier for a group or condition
• isGroup(optional): boolean
  Boolean value to identify whether this child is a group or condition
• level(optional): number
  This helps to identify the nesting level.
• matchingCriteria(optional): string
  Matching Criteria
• patternTypeLHS(optional): object PatternTypeDTO
• patternTypeRHS(optional): object PatternTypeDTO
• reconEntityAttribLHS(optional): string
  Will be provided if Single entity is LHS entity or if single entity is N. Attribute which user wants to use for recon
• reconEntityAttribRHS(optional): string
  Will be provided if Single entity is RHS entity or if single entity is N. Attribute which user wants to use for recon
• reconEntityLHS(optional): string
  Should be null or not present if isGroup is true
• reconEntityRHS(optional): string
  Should be null or not present if isGroup is true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a group or condition"
        },
        "caseSensitive":{
            "type":"boolean",
            "description":"Boolean value to identify whether this condition is case sensitive",
            "default":false
        },
        "isGroup":{
            "type":"boolean",
            "description":"Boolean value to identify whether this child is a group or condition"
        },
        "connectingOperator":{
            "type":"string",
            "description":"Logical Operator applied between all groups, this is the connecting operator"
        },
        "level":{
            "type":"number",
            "description":"This helps to identify the nesting level."
        },
        "matchingCriteria":{
            "type":"string",
            "description":"Matching Criteria"
        },
        "reconEntityLHS":{
            "type":"string",
            "description":"Should be null or not present if isGroup is true"
        },
        "reconEntityAttribLHS":{
            "type":"string",
            "description":"Will be provided if Single entity is LHS entity or if single entity is N. Attribute which user wants to use for recon"
        },
        "reconEntityRHS":{
            "type":"string",
            "description":"Should be null or not present if isGroup is true"
        },
        "reconEntityAttribRHS":{
            "type":"string",
            "description":"Will be provided if Single entity is RHS entity or if single entity is N. Attribute which user wants to use for recon"
        },
        "patternTypeLHS":{
            "$ref":"#/definitions/PatternTypeDTO"
        },
        "patternTypeRHS":{
            "$ref":"#/definitions/PatternTypeDTO"
        },
        "groupsAndConditions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupsAndConditions"
            }
        }
    }
}

Nested Schema : groupsAndConditions

Type: array

Show Source

• Array of: object GroupsAndConditions

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GroupsAndConditions"
    }
}

Nested Schema : PatternTypeDTO

Type: object

Show Source

• inputValue1(optional): string
  Input Value1
• inputValue2(optional): string
  Input Value2
• type(optional): string
  Type

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Type"
        },
        "inputValue1":{
            "type":"string",
            "description":"Input Value1"
        },
        "inputValue2":{
            "type":"string",
            "description":"Input Value2"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Successfully saves a new reconcilation record

Headers

• Location: string
  URL of newly created autoReconRuleDef

Body ()

Root Schema : ResponseModel

Type: object

Response Model

Show Source

• data(optional): FinanceTransactionModel
  Finance Transaction Model
• errors(optional): object errors
• paging(optional): object paging

{
    "description":"Response Model",
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/FinanceTransactionModel"
        },
        "errors":{
            "type":"object"
        },
        "paging":{
            "type":"object"
        }
    }
}

Nested Schema : FinanceTransactionModel

Finance Transaction Model

Match All

Show Source

• object TransactionModel
  Discriminator: model_Type
• object FinanceTransactionModel-allOf[1]

{
    "description":"Finance Transaction Model",
    "allOf":[
        {
            "$ref":"#/definitions/TransactionModel"
        },
        {
            "type":"object",
            "properties":{
                "financeRefNo":{
                    "type":"string",
                    "description":"Finance Reference Number"
                },
                "requestId":{
                    "type":"string",
                    "description":"Request Id"
                },
                "productCode":{
                    "type":"string",
                    "description":"Product Code"
                },
                "operationCode":{
                    "type":"string",
                    "description":"Operation Code"
                },
                "programCode":{
                    "type":"string",
                    "description":"Program Code"
                },
                "programName":{
                    "type":"string",
                    "description":"Program Name"
                },
                "buyerId":{
                    "type":"string",
                    "description":"Buyer Id"
                },
                "buyerName":{
                    "type":"string",
                    "description":"Buyer Name"
                },
                "supplierId":{
                    "type":"string",
                    "description":"Supplier Id"
                },
                "supplierName":{
                    "type":"string",
                    "description":"Supplier Name"
                },
                "debtor":{
                    "type":"string",
                    "description":"Debtor"
                },
                "startDate":{
                    "type":"string",
                    "description":"Start Date"
                },
                "tenor":{
                    "type":"integer",
                    "format":"int64",
                    "description":"Tenor"
                },
                "maturityDate":{
                    "type":"string",
                    "description":"Maturity Date"
                },
                "invoiceAmtCcy":{
                    "type":"string",
                    "description":"Invoice Amount Currency"
                },
                "invoiceAmount":{
                    "type":"number",
                    "description":"Invoice Amount"
                },
                "financePCT":{
                    "type":"number",
                    "description":"Finance PCT"
                },
                "financeAmtCcy":{
                    "type":"string",
                    "description":"Finance Amount Currency"
                },
                "financeAmt":{
                    "type":"number",
                    "description":"Finance Amount"
                },
                "exchangeRate":{
                    "type":"number",
                    "description":"Exchange Rate"
                },
                "processingDate":{
                    "type":"string",
                    "description":"Processing Date"
                },
                "settlementProcessingDate":{
                    "type":"string",
                    "description":"Settlement Processing Date"
                },
                "makerId":{
                    "type":"string",
                    "description":"Maker Id"
                },
                "makerDateStamp":{
                    "type":"string",
                    "description":"Maker Date Stamp"
                },
                "authId":{
                    "type":"string",
                    "description":"Authorization id"
                },
                "authDateStamp":{
                    "type":"string",
                    "description":"Authorized Date Stamp"
                },
                "financeStatus":{
                    "type":"string",
                    "description":"Finance Status"
                },
                "clRefNo":{
                    "type":"string",
                    "description":"Cl Reference Number"
                },
                "settlementRefNo":{
                    "type":"string",
                    "description":"Settlement Reference Number"
                },
                "settlementMethod":{
                    "type":"string",
                    "description":"Settlement Method"
                },
                "totalSettlementAmt":{
                    "type":"number",
                    "description":"Total Settlement"
                },
                "creditReceived":{
                    "type":"string",
                    "description":"Credit Received"
                },
                "creditAccount":{
                    "type":"string",
                    "description":"Credit Account"
                },
                "paymentParty":{
                    "type":"string",
                    "description":"Payment Party"
                },
                "accountType":{
                    "type":"string",
                    "description":"Account Type"
                },
                "settlementAmtAllocated":{
                    "type":"number",
                    "description":"Settlement Amount Allocated"
                },
                "balanceAmtToBeAllocated":{
                    "type":"number",
                    "description":"Balance Amount To Be Allocated"
                },
                "settlementAmtAllocation":{
                    "type":"string",
                    "description":"Settlement Amount Allocation"
                },
                "manualAllocation":{
                    "type":"string",
                    "description":"Manual Allocation"
                },
                "pastDueDate":{
                    "type":"string",
                    "description":"Past Due Date"
                },
                "valueDate":{
                    "type":"string",
                    "description":"Value date"
                },
                "principalOSAmount":{
                    "type":"number",
                    "description":"Principal OS Amount"
                },
                "interestOSAmount":{
                    "type":"number",
                    "description":"Interest OS Amount"
                },
                "totalOSAmount":{
                    "type":"number",
                    "description":"Total OS Amount"
                },
                "valueDtdIntOSAmt":{
                    "type":"number",
                    "description":"Value Dated Interest OS Amount"
                },
                "pmtToPenOnIntOS":{
                    "type":"number",
                    "description":"Payment To Pen On Interest OS"
                },
                "interestPaidUpfront":{
                    "type":"number",
                    "description":"Interest Paid Upfront"
                },
                "overdueIntOSAmt":{
                    "type":"number",
                    "description":"Overdue Interest OS Amount"
                },
                "valueDtdOverdueIntOSAmt":{
                    "type":"number",
                    "description":"Value Dated Overdue Interest OS Amount"
                },
                "paymentAmt":{
                    "type":"number",
                    "description":"Payment Amount"
                },
                "appropPaymentAmt":{
                    "type":"number",
                    "description":"Appropriation Payment Amount"
                },
                "appropriationSequence":{
                    "type":"string",
                    "description":"Appropriation Sequence"
                },
                "pmtToPrncplOS":{
                    "type":"number",
                    "description":"Payment To Principal OS"
                },
                "pmtToIntOS":{
                    "type":"number",
                    "description":"Payment To Interest OS"
                },
                "pmtToOverdueIntOS":{
                    "type":"number",
                    "description":"Payment To Overdue Interest OS"
                },
                "productDescription":{
                    "type":"string",
                    "description":"Product Description"
                },
                "productCategory":{
                    "type":"string",
                    "description":"Product Category"
                },
                "maxTenorAllowed":{
                    "type":"number",
                    "description":"Maximum Tenor Allowed"
                },
                "minTenorAllowed":{
                    "type":"number",
                    "description":"Minimum Tenor Allowed"
                },
                "minFinPCT":{
                    "type":"number",
                    "description":"Minimum Finance PCT"
                },
                "maxFinPCT":{
                    "type":"number",
                    "description":"Maximum Finance PCT"
                },
                "holidayTreatment":{
                    "type":"string",
                    "description":"Holiday Treatment"
                },
                "productType":{
                    "type":"string",
                    "description":"Product Type"
                },
                "preferredDisbursementMode":{
                    "type":"string",
                    "description":"Preferred Disbursement Mode"
                },
                "settlementCcy":{
                    "type":"string",
                    "description":"Settlement Currency"
                },
                "totalOSAmountSettlementCcy":{
                    "type":"number",
                    "description":"Total OS Amount Settlement Currency"
                },
                "refund":{
                    "type":"number",
                    "description":"Refund"
                },
                "interestRefundAmt":{
                    "type":"number",
                    "description":"Interest Refund Amount"
                },
                "interestRefundPmtMode":{
                    "type":"string",
                    "description":"Interest Refund Payment Amount"
                },
                "settlementExchangeRate":{
                    "type":"number",
                    "description":"Settlement Exchange Rate"
                },
                "totalOSPostAllocation":{
                    "type":"number",
                    "description":"Total OS Post Allocation"
                },
                "errorCode":{
                    "type":"string",
                    "description":"Error Code"
                },
                "errorDescription":{
                    "type":"string",
                    "description":"Error Description"
                },
                "graceDays":{
                    "type":"number",
                    "description":"Grace Days"
                },
                "partRepaymentAllowed":{
                    "type":"string",
                    "description":"Part Repayment Allowed"
                },
                "staleStatus":{
                    "type":"string",
                    "description":"Stale Status"
                },
                "minFinanciableAmt":{
                    "type":"number",
                    "description":"Minimum Financiable Amount"
                },
                "maxFinanciableAmt":{
                    "type":"number",
                    "description":"Maximum Financiable Amount"
                },
                "minReFinPCT":{
                    "type":"number",
                    "description":"Minimum ReFinance PCT"
                },
                "maxReFinPCT":{
                    "type":"number",
                    "description":"Maximum ReFinance PCT"
                },
                "penIntOSAmt":{
                    "type":"number",
                    "description":"Pen Interest OS Amount"
                },
                "valueDtdPenIntOSAmt":{
                    "type":"number",
                    "description":"Value Dated Pen Interest OS Amount"
                },
                "interestAmortized":{
                    "type":"number",
                    "description":"Interest Amortized"
                },
                "withRecourse":{
                    "type":"string",
                    "description":"With Recourse"
                },
                "transactionFlow":{
                    "type":"string",
                    "description":"Transaction Flow"
                },
                "totalMarginAmount":{
                    "type":"number",
                    "description":"Total Margin Amount"
                },
                "interestType":{
                    "type":"string",
                    "description":"Interest Type"
                },
                "interestRefundHandling":{
                    "type":"string",
                    "description":"Interest Refund Handling"
                },
                "interestBearingPartyRole":{
                    "type":"string",
                    "description":"Interest Bearing Party Role"
                },
                "isFromRecon":{
                    "type":"string",
                    "description":"Is From Recon"
                },
                "isNPA":{
                    "type":"string",
                    "description":"Is NPA"
                }
            }
        }
    ]
}

Nested Schema : errors

Type: object

Nested Schema : paging

Type: object

Nested Schema : TransactionModel

Type: object

Discriminator: model_Type

Nested Schema : FinanceTransactionModel-allOf[1]

Type: object

Show Source

• accountType(optional): string
  Account Type
• appropPaymentAmt(optional): number
  Appropriation Payment Amount
• appropriationSequence(optional): string
  Appropriation Sequence
• authDateStamp(optional): string
  Authorized Date Stamp
• authId(optional): string
  Authorization id
• balanceAmtToBeAllocated(optional): number
  Balance Amount To Be Allocated
• buyerId(optional): string
  Buyer Id
• buyerName(optional): string
  Buyer Name
• clRefNo(optional): string
  Cl Reference Number
• creditAccount(optional): string
  Credit Account
• creditReceived(optional): string
  Credit Received
• debtor(optional): string
  Debtor
• errorCode(optional): string
  Error Code
• errorDescription(optional): string
  Error Description
• exchangeRate(optional): number
  Exchange Rate
• financeAmt(optional): number
  Finance Amount
• financeAmtCcy(optional): string
  Finance Amount Currency
• financePCT(optional): number
  Finance PCT
• financeRefNo(optional): string
  Finance Reference Number
• financeStatus(optional): string
  Finance Status
• graceDays(optional): number
  Grace Days
• holidayTreatment(optional): string
  Holiday Treatment
• interestAmortized(optional): number
  Interest Amortized
• interestBearingPartyRole(optional): string
  Interest Bearing Party Role
• interestOSAmount(optional): number
  Interest OS Amount
• interestPaidUpfront(optional): number
  Interest Paid Upfront
• interestRefundAmt(optional): number
  Interest Refund Amount
• interestRefundHandling(optional): string
  Interest Refund Handling
• interestRefundPmtMode(optional): string
  Interest Refund Payment Amount
• interestType(optional): string
  Interest Type
• invoiceAmount(optional): number
  Invoice Amount
• invoiceAmtCcy(optional): string
  Invoice Amount Currency
• isFromRecon(optional): string
  Is From Recon
• isNPA(optional): string
  Is NPA
• makerDateStamp(optional): string
  Maker Date Stamp
• makerId(optional): string
  Maker Id
• manualAllocation(optional): string
  Manual Allocation
• maturityDate(optional): string
  Maturity Date
• maxFinanciableAmt(optional): number
  Maximum Financiable Amount
• maxFinPCT(optional): number
  Maximum Finance PCT
• maxReFinPCT(optional): number
  Maximum ReFinance PCT
• maxTenorAllowed(optional): number
  Maximum Tenor Allowed
• minFinanciableAmt(optional): number
  Minimum Financiable Amount
• minFinPCT(optional): number
  Minimum Finance PCT
• minReFinPCT(optional): number
  Minimum ReFinance PCT
• minTenorAllowed(optional): number
  Minimum Tenor Allowed
• operationCode(optional): string
  Operation Code
• overdueIntOSAmt(optional): number
  Overdue Interest OS Amount
• partRepaymentAllowed(optional): string
  Part Repayment Allowed
• pastDueDate(optional): string
  Past Due Date
• paymentAmt(optional): number
  Payment Amount
• paymentParty(optional): string
  Payment Party
• penIntOSAmt(optional): number
  Pen Interest OS Amount
• pmtToIntOS(optional): number
  Payment To Interest OS
• pmtToOverdueIntOS(optional): number
  Payment To Overdue Interest OS
• pmtToPenOnIntOS(optional): number
  Payment To Pen On Interest OS
• pmtToPrncplOS(optional): number
  Payment To Principal OS
• preferredDisbursementMode(optional): string
  Preferred Disbursement Mode
• principalOSAmount(optional): number
  Principal OS Amount
• processingDate(optional): string
  Processing Date
• productCategory(optional): string
  Product Category
• productCode(optional): string
  Product Code
• productDescription(optional): string
  Product Description
• productType(optional): string
  Product Type
• programCode(optional): string
  Program Code
• programName(optional): string
  Program Name
• refund(optional): number
  Refund
• requestId(optional): string
  Request Id
• settlementAmtAllocated(optional): number
  Settlement Amount Allocated
• settlementAmtAllocation(optional): string
  Settlement Amount Allocation
• settlementCcy(optional): string
  Settlement Currency
• settlementExchangeRate(optional): number
  Settlement Exchange Rate
• settlementMethod(optional): string
  Settlement Method
• settlementProcessingDate(optional): string
  Settlement Processing Date
• settlementRefNo(optional): string
  Settlement Reference Number
• staleStatus(optional): string
  Stale Status
• startDate(optional): string
  Start Date
• supplierId(optional): string
  Supplier Id
• supplierName(optional): string
  Supplier Name
• tenor(optional): integer(int64)
  Tenor
• totalMarginAmount(optional): number
  Total Margin Amount
• totalOSAmount(optional): number
  Total OS Amount
• totalOSAmountSettlementCcy(optional): number
  Total OS Amount Settlement Currency
• totalOSPostAllocation(optional): number
  Total OS Post Allocation
• totalSettlementAmt(optional): number
  Total Settlement
• transactionFlow(optional): string
  Transaction Flow
• valueDate(optional): string
  Value date
• valueDtdIntOSAmt(optional): number
  Value Dated Interest OS Amount
• valueDtdOverdueIntOSAmt(optional): number
  Value Dated Overdue Interest OS Amount
• valueDtdPenIntOSAmt(optional): number
  Value Dated Pen Interest OS Amount
• withRecourse(optional): string
  With Recourse

{
    "type":"object",
    "properties":{
        "financeRefNo":{
            "type":"string",
            "description":"Finance Reference Number"
        },
        "requestId":{
            "type":"string",
            "description":"Request Id"
        },
        "productCode":{
            "type":"string",
            "description":"Product Code"
        },
        "operationCode":{
            "type":"string",
            "description":"Operation Code"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "programName":{
            "type":"string",
            "description":"Program Name"
        },
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "buyerName":{
            "type":"string",
            "description":"Buyer Name"
        },
        "supplierId":{
            "type":"string",
            "description":"Supplier Id"
        },
        "supplierName":{
            "type":"string",
            "description":"Supplier Name"
        },
        "debtor":{
            "type":"string",
            "description":"Debtor"
        },
        "startDate":{
            "type":"string",
            "description":"Start Date"
        },
        "tenor":{
            "type":"integer",
            "format":"int64",
            "description":"Tenor"
        },
        "maturityDate":{
            "type":"string",
            "description":"Maturity Date"
        },
        "invoiceAmtCcy":{
            "type":"string",
            "description":"Invoice Amount Currency"
        },
        "invoiceAmount":{
            "type":"number",
            "description":"Invoice Amount"
        },
        "financePCT":{
            "type":"number",
            "description":"Finance PCT"
        },
        "financeAmtCcy":{
            "type":"string",
            "description":"Finance Amount Currency"
        },
        "financeAmt":{
            "type":"number",
            "description":"Finance Amount"
        },
        "exchangeRate":{
            "type":"number",
            "description":"Exchange Rate"
        },
        "processingDate":{
            "type":"string",
            "description":"Processing Date"
        },
        "settlementProcessingDate":{
            "type":"string",
            "description":"Settlement Processing Date"
        },
        "makerId":{
            "type":"string",
            "description":"Maker Id"
        },
        "makerDateStamp":{
            "type":"string",
            "description":"Maker Date Stamp"
        },
        "authId":{
            "type":"string",
            "description":"Authorization id"
        },
        "authDateStamp":{
            "type":"string",
            "description":"Authorized Date Stamp"
        },
        "financeStatus":{
            "type":"string",
            "description":"Finance Status"
        },
        "clRefNo":{
            "type":"string",
            "description":"Cl Reference Number"
        },
        "settlementRefNo":{
            "type":"string",
            "description":"Settlement Reference Number"
        },
        "settlementMethod":{
            "type":"string",
            "description":"Settlement Method"
        },
        "totalSettlementAmt":{
            "type":"number",
            "description":"Total Settlement"
        },
        "creditReceived":{
            "type":"string",
            "description":"Credit Received"
        },
        "creditAccount":{
            "type":"string",
            "description":"Credit Account"
        },
        "paymentParty":{
            "type":"string",
            "description":"Payment Party"
        },
        "accountType":{
            "type":"string",
            "description":"Account Type"
        },
        "settlementAmtAllocated":{
            "type":"number",
            "description":"Settlement Amount Allocated"
        },
        "balanceAmtToBeAllocated":{
            "type":"number",
            "description":"Balance Amount To Be Allocated"
        },
        "settlementAmtAllocation":{
            "type":"string",
            "description":"Settlement Amount Allocation"
        },
        "manualAllocation":{
            "type":"string",
            "description":"Manual Allocation"
        },
        "pastDueDate":{
            "type":"string",
            "description":"Past Due Date"
        },
        "valueDate":{
            "type":"string",
            "description":"Value date"
        },
        "principalOSAmount":{
            "type":"number",
            "description":"Principal OS Amount"
        },
        "interestOSAmount":{
            "type":"number",
            "description":"Interest OS Amount"
        },
        "totalOSAmount":{
            "type":"number",
            "description":"Total OS Amount"
        },
        "valueDtdIntOSAmt":{
            "type":"number",
            "description":"Value Dated Interest OS Amount"
        },
        "pmtToPenOnIntOS":{
            "type":"number",
            "description":"Payment To Pen On Interest OS"
        },
        "interestPaidUpfront":{
            "type":"number",
            "description":"Interest Paid Upfront"
        },
        "overdueIntOSAmt":{
            "type":"number",
            "description":"Overdue Interest OS Amount"
        },
        "valueDtdOverdueIntOSAmt":{
            "type":"number",
            "description":"Value Dated Overdue Interest OS Amount"
        },
        "paymentAmt":{
            "type":"number",
            "description":"Payment Amount"
        },
        "appropPaymentAmt":{
            "type":"number",
            "description":"Appropriation Payment Amount"
        },
        "appropriationSequence":{
            "type":"string",
            "description":"Appropriation Sequence"
        },
        "pmtToPrncplOS":{
            "type":"number",
            "description":"Payment To Principal OS"
        },
        "pmtToIntOS":{
            "type":"number",
            "description":"Payment To Interest OS"
        },
        "pmtToOverdueIntOS":{
            "type":"number",
            "description":"Payment To Overdue Interest OS"
        },
        "productDescription":{
            "type":"string",
            "description":"Product Description"
        },
        "productCategory":{
            "type":"string",
            "description":"Product Category"
        },
        "maxTenorAllowed":{
            "type":"number",
            "description":"Maximum Tenor Allowed"
        },
        "minTenorAllowed":{
            "type":"number",
            "description":"Minimum Tenor Allowed"
        },
        "minFinPCT":{
            "type":"number",
            "description":"Minimum Finance PCT"
        },
        "maxFinPCT":{
            "type":"number",
            "description":"Maximum Finance PCT"
        },
        "holidayTreatment":{
            "type":"string",
            "description":"Holiday Treatment"
        },
        "productType":{
            "type":"string",
            "description":"Product Type"
        },
        "preferredDisbursementMode":{
            "type":"string",
            "description":"Preferred Disbursement Mode"
        },
        "settlementCcy":{
            "type":"string",
            "description":"Settlement Currency"
        },
        "totalOSAmountSettlementCcy":{
            "type":"number",
            "description":"Total OS Amount Settlement Currency"
        },
        "refund":{
            "type":"number",
            "description":"Refund"
        },
        "interestRefundAmt":{
            "type":"number",
            "description":"Interest Refund Amount"
        },
        "interestRefundPmtMode":{
            "type":"string",
            "description":"Interest Refund Payment Amount"
        },
        "settlementExchangeRate":{
            "type":"number",
            "description":"Settlement Exchange Rate"
        },
        "totalOSPostAllocation":{
            "type":"number",
            "description":"Total OS Post Allocation"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDescription":{
            "type":"string",
            "description":"Error Description"
        },
        "graceDays":{
            "type":"number",
            "description":"Grace Days"
        },
        "partRepaymentAllowed":{
            "type":"string",
            "description":"Part Repayment Allowed"
        },
        "staleStatus":{
            "type":"string",
            "description":"Stale Status"
        },
        "minFinanciableAmt":{
            "type":"number",
            "description":"Minimum Financiable Amount"
        },
        "maxFinanciableAmt":{
            "type":"number",
            "description":"Maximum Financiable Amount"
        },
        "minReFinPCT":{
            "type":"number",
            "description":"Minimum ReFinance PCT"
        },
        "maxReFinPCT":{
            "type":"number",
            "description":"Maximum ReFinance PCT"
        },
        "penIntOSAmt":{
            "type":"number",
            "description":"Pen Interest OS Amount"
        },
        "valueDtdPenIntOSAmt":{
            "type":"number",
            "description":"Value Dated Pen Interest OS Amount"
        },
        "interestAmortized":{
            "type":"number",
            "description":"Interest Amortized"
        },
        "withRecourse":{
            "type":"string",
            "description":"With Recourse"
        },
        "transactionFlow":{
            "type":"string",
            "description":"Transaction Flow"
        },
        "totalMarginAmount":{
            "type":"number",
            "description":"Total Margin Amount"
        },
        "interestType":{
            "type":"string",
            "description":"Interest Type"
        },
        "interestRefundHandling":{
            "type":"string",
            "description":"Interest Refund Handling"
        },
        "interestBearingPartyRole":{
            "type":"string",
            "description":"Interest Bearing Party Role"
        },
        "isFromRecon":{
            "type":"string",
            "description":"Is From Recon"
        },
        "isNPA":{
            "type":"string",
            "description":"Is NPA"
        }
    }
}

400 Response

Malformed syntax.

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