Create settlements for invoices with finances
post
/service/v1/createSettlementsForAutoDebit
This endpoint is used to create settlements for invoices with finances.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId(required): string
appId
-
branchCode(required): string
branchCode
-
userId(required): string
userId
Request Body that contains workflow model
Root Schema : ConductorWorkflowModel
Type:
object
ConductorWorkflowModel
Show Source
-
amount:
number
amount
-
appId:
string
AppId of Workflow Service
-
applicationCode:
string
Application code
-
applicationNumber:
string
Reference number without seqno
-
branchCode:
string
Branch Code
-
businessDate:
string
Business Date
-
channel:
string
Channel
-
currencyCode:
string
currencyCode
-
customerNumber:
string
customerNumber
-
discountOffer:
object DiscountingModel
DiscountingModel
-
errorCode:
string
Error Code
-
errorDesc:
string
Error Desc
-
event:
string
event
-
fciMessageModel:
object FCIMessageModel
FCIMessageModel
-
financeModel:
object FinanceModel
FinanceModel
-
instrumentModel:
object InstrumentModel
InstrumentModel model
-
isFcubsIntegrationReqd:
string
isFcubsIntegrationReqd
-
isInProgKafkaTaskReqd:
string
isInProgKafkaTaskReqd
-
manualReconModel:
object ManualReconModel
ManualReconModel
-
marginRefundModel:
object MarginRefundModel
MarginRefundModel
-
priority:
string
priority
-
processCode:
string
Process Code to identify workflow
-
processingDate:
string
Processing Date
-
processName:
string
Process Name to identify workflow
-
product:
string
Product type to identify service for instrument
-
productCategory:
string
productCategory
-
productCode:
string
productCode
-
purgeAcctEntries:
string
purgeAcctEntries
-
refundModel:
object RefundModel
RefundModel
-
server:
string
server
-
stageDescription:
string
Stage desc
-
stageId:
string
Stage Id
-
taskInstanceId:
string
Task Instance Id
-
transactionReferenceNo:
string
Transaction Referenec No
-
uri:
string
EndPoint of Workflow Service
-
userId:
string
User Id
-
workflowInstanceId:
string
Workflow Instance Id
-
workflowType:
string
workflowType
Nested Schema : DiscountingModel
Type:
object
DiscountingModel
Show Source
-
additionalDetails:
object additionalDetails
additionalDetails
-
additionalProperties:
object additionalProperties
additionalProperties
-
discountRuleId:
string
discountRuleId
-
isAutoAuth:
string
isAutoAuth
Nested Schema : FCIMessageModel
Type:
object
FCIMessageModel
Show Source
-
fciMessageType:
string
Fci Message Type
-
invoiceNumber:
string
Invoice Number
-
messageRefId:
string
Message Ref Id
Nested Schema : FinanceModel
Type:
object
FinanceModel
Show Source
-
additionalDetails:
object additionalDetails
additionalDetails
-
additionalProperties:
object additionalProperties
additionalProperties
-
blockLimitsProcessingReqd:
string
Limits Flag
-
financeRefNo:
string
financeRefNo
-
financeRefNoSeqNo:
string
financeRefNoSeqNo
-
financeSeqNo:
integer(int64)
financeSeqNo
-
isAccEntriesPostRequired:
string
isAccEntriesPostRequired flag
-
isAccountingApplicable:
string
Accounting Applicable Flag
-
isAccountingSynchronous:
string
isAccountingSynchronous
-
isAlertsAndNotificationReqd:
string
isAlertsAndNotificationReqd flag
-
isAuthRequired:
string
isAuthRequired flag
-
isAutoProcessing:
string
isAutoProcessing flag
-
isExternalPaymentRequired:
string
isExternalPaymentRequired flag
-
isExtPaymentSynchronous:
string
isExtPaymentSynchronous
-
isInstrumentUpdateReqd:
string
isInstrumentUpdateReqd flag
-
isLimitApplicable:
string
Limit Applicable Flag
-
isLimitBlockReqd:
string
isLimitBlockReqd flag
-
isLimitUtilReleaseRequired:
string
isLimitUtilReleaseRequired flag
-
isObclTxnUpdateReqd:
string
isObclTxnUpdateReqd flag
-
isPrePostApplicable:
string
isPrePostApplicable
-
isPrePostConversionException:
string
isPrePostConversionException
-
isUpdateFinanceMasterReqd:
string
isUpdateFinanceMasterReqd flag
Nested Schema : InstrumentModel
Type:
object
InstrumentModel model
Show Source
-
accountingDetails:
object AccountingTransactionCollection
Collection of Accounting Transaction Models.
-
accountType:
string
accountType
-
actualCreditDate:
string(date)
Actual Credit Date
-
actualCreditDateString:
string
ActualCredit Date String
-
actualCreditReversalDate:
string(date)
Actual Credit Reversal Date
-
actualCreditReversalDateString:
string
Actual Credit Reversal Date String
-
adhocCharges:
string
adhocCharges
-
arrangementCode:
string
arrangementCode
-
arrangementCreditDate:
string(date)
arrangementCreditDate
-
arrangementCreditDateString:
string
ArrangementCredit Date String
-
arrangementDays:
integer
arrangementDays
-
arrangementDesc:
string
arrangementDesc
-
arrangementRefBasis:
string
arrangementRefBasis
-
certificateExtensionDays:
integer
certificateExtensionDays
-
checkerDtStamp:
string(date)
checkerDtStamp
-
checkerId:
string
checkerId
-
chgCalc:
string
Charges Calculation flag as Y or N
-
clearingNetworkCode:
string
Clearing Network Code
-
clearingNetworkDesc:
string
Clearing Network Desc
-
coreBankBranchCode:
string
coreBankBranchCode
-
corporateRefNo:
string
Corporate Ref No
-
corporateReleaseDays:
integer
corporateReleaseDays
-
corrBankCode:
string
corrBankCode
-
creditAccountNo:
string
Credit Account No
-
creditACCY:
string
Credit Currency Amount
-
creditStatus:
string
creditStatus
-
depositSlipNo:
string
no of the DepositSlipNo
-
depositSlipRefNo:
string
deposit Slip Ref No of the Instrument
-
divisionCode:
string
Division Code
-
divisionCodeDesc:
string
Division Code Desc
-
drawerAcName:
string
Drawer Ac Name
-
drawerAcNo:
string
Drawer Ac No
-
drawerId:
string
Drawer Id
-
drawerName:
string
Drawer Name
-
drawnOnBankCode:
string
Drawn on Bank Code
-
drawnOnBankName:
string
Drawn on Bank Name
-
drawnOnBranchCode:
string
Drawn on Branch Code
-
drawnOnBranchName:
string
Drawn on Branch Name
-
holdUntillDate:
string(date)
holdUntillDate
-
holdUntillDateString:
string
HoldUntill Date String
-
id:
string
Id of the Instrument
-
instMgmtCourierCode:
string
instMgmtCourierCode
-
instMgmtCourierPodNumber:
string
instMgmtCourierPodNumber
-
instrumentAdFields:
object InstrumentModelAdditionalInfoCollection
Collection of DepositSlips
-
instrumentAmountValue:
number
Instrument Amount Value
-
instrumentAmt:
number
Instrument Amount
-
instrumentAmtCcy:
string
Instrument Amount ccy
-
instrumentCount:
number
Instrument Count
-
instrumentDate:
string(date)
Instrument Date
-
instrumentDateString:
string
Instrument Date String
-
instrumentManagementBatchRefNo:
string
instrumentManagementBatchRefNo
-
instrumentNo:
string
no of the Instrument
-
instrumentRefNo:
string
Instrument Ref No of the Instrument
-
instrumentStatus:
string
Instrument Status
-
instrumentType:
string
Instrument Type
-
instTxnStatus:
string
instTxnStatus
-
isCentralizedSchedule:
string
isCentralizedSchedule
-
isCustomerCredited:
string
isCustomerCredited
-
isPDCChecked:
string
Is PDC Checked
-
lostExtensionDays:
integer
lostExtensionDays
-
makerDtStamp:
string(date)
makerDtStamp
-
makerId:
string
makerId
-
misc1:
string
misc1
-
misc10:
string
misc10
-
misc11:
string
misc11
-
misc12:
string
misc12
-
misc13:
string
misc13
-
misc14:
string
misc14
-
misc15:
string
misc15
-
misc16:
string
misc16
-
misc17:
string
misc17
-
misc18:
string
misc18
-
misc19:
string
misc19
-
misc2:
string
misc2
-
misc20:
string
misc20
-
misc21:
string
misc21
-
misc22:
string
misc22
-
misc23:
string
misc23
-
misc24:
string
misc24
-
misc25:
string
misc25
-
misc26:
string
misc26
-
misc27:
string
misc27
-
misc28:
string
misc28
-
misc29:
string
misc29
-
misc3:
string
misc3
-
misc30:
string
misc30
-
misc4:
string
misc4
-
misc5:
string
misc5
-
misc6:
string
misc6
-
misc7:
string
misc7
-
misc8:
string
misc8
-
misc9:
string
misc9
-
noOfMiscFields:
number
noOfMiscFields
-
payableAtLocationCode:
string
Payable at Location Code
-
payableAtLocationDesc:
string
Payable at Location Desc
-
payableAtLocClusterCode:
string
Payable at Loc Cluster Code
-
payableAtLocClusterDesc:
string
Payable at Loc Cluster Desc
-
presentationDate:
string(date)
presentationDate
-
presentationDateString:
string
PresentationDate Date String
-
productCode:
string
Product Code
-
productDesc:
string
Product Desc
-
realisationAmount:
number
Realisation Amount
-
realisationDate:
string(date)
Realisation Date
-
realisationDateString:
string
Realisation Date String
-
referenceNum:
string
Reference Num of the batch
-
rejectReason:
string
Reject Reason
-
remarks:
string
remarks
-
returnExtensionDays:
integer
returnExtensionDays
-
returningDate:
string(date)
returningDate
-
returningDateString:
string
Returning Date String
-
routingNumber:
number
Routing number
-
scheduleDestinationBank:
string
scheduleDestinationBank
-
scheduleDestinationBankDescription:
string
scheduleDestinationBankDescription
-
scheduleDestinationBranch:
string
scheduleDestinationBranch
-
scheduleDestinationBranchDescription:
string
scheduleDestinationBranchDescription
-
scheduleGenerationDate:
string(date)
scheduleGenerationDate
-
scheduleGenerationDateString:
string
Schedule Generation Date String
-
scheduleOriginationBank:
string
scheduleOriginationBank
-
scheduleOriginationBranch:
string
scheduleOriginationBranch
-
scheduleReceiptDate:
string(date)
Schedule Receipt Date
-
scheduleReceiptDateString:
string
ScheduleReceipt Date String
-
scheduleRefNo:
string
Schedule RefNo
-
seqNo:
integer(int64)
Seq No of the Instrument
-
stage:
string
stage
-
vaFlagYN:
string
Virtual Account flag as Y or N
-
vaultBoxDescription:
string
Vault Box Description
-
vaultBoxNumber:
string
Vault Box Number
-
vaultBranch:
string
Vault Branch
Nested Schema : ManualReconModel
Type:
object
ManualReconModel
Show Source
-
additionalDetails:
object additionalDetails
additionalDetails
-
additionalProperties:
object additionalProperties
additionalProperties
-
invAcquireTaskReqd:
string
Flag for to acquire invoice task
-
isAutoAuth:
string
Is Auto Auth
-
isFinanceIntegrationReqd:
string
Flag for finance settlement
-
isVamIntegrationReqd:
string
Flag for Reference Number
-
reconTxnRefNo:
string
Transaction Reference Number
Nested Schema : MarginRefundModel
Type:
object
MarginRefundModel
Show Source
-
buyer:
string
Buyer Name
-
instrumentType:
string
Instrument Type
-
isExternalPmtReqd:
string
External Payment Required Flag
-
isExtPaymentSynchronous:
string
External Payment Synchronous Flag
-
marginRefNo:
string
Margin Reference Number
-
marginType:
string
Margin Type
-
supplier:
string
Supplier Name
Nested Schema : RefundModel
Type:
object
RefundModel
Show Source
-
action:
string
Action
-
instrumentType:
string
instrumentType
-
isAutoAuthApplicableForRefund:
string
isAutoAuthApplicableForRefund
-
isExternalPaymentReqd:
string
isExternalPaymentReqd
-
isExtPaymentSynchronous:
string
isExtPaymentSynchronous
-
isFcubsIntegrationReqd:
string
isFcubsIntegrationReqd
-
paymentNumberIR:
string
paymentNumberIR
-
paymentRefNo:
string
paymentRefNo
-
refundParty:
string
refundParty
-
refundRefNoSeqNo:
string
Refund Reference Number Sequence No
-
taskName:
string
Task Name
Nested Schema : additionalDetails
Type:
object
additionalDetails
Nested Schema : additionalProperties
Type:
object
additionalProperties
Nested Schema : additionalDetails
Type:
object
additionalDetails
Nested Schema : additionalProperties
Type:
object
additionalProperties
Nested Schema : AccountingTransactionCollection
Type:
object
Collection of Accounting Transaction Models.
Show Source
Nested Schema : InstrumentModelAdditionalInfoCollection
Type:
object
Collection of DepositSlips
Show Source
Nested Schema : accountingTransactionList
Type:
Show Source
array
-
Array of:
object AccountingTransactionModel
Accounting Transaction Model
Nested Schema : AccountingTransactionModel
Type:
object
Accounting Transaction Model
Show Source
-
accClass:
string
Account Class
-
accEntryDesc:
string
-
accEntrySeq:
integer(int64)
-
accountCcy:
string
-
accountingEntryCode:
string
-
accountNo:
string
-
accPartyId:
string
-
accPartyType:
string
-
accRoleCode:
string
-
accRoleDesc:
string
-
accSettMethod:
string
-
accType:
string
-
amount:
number
-
amountAccCcy:
number
-
amountCcy:
string
-
amountType:
string
-
applicationCode:
string
Application Code
-
drCrIndicator:
string
-
ecaRefNo:
string
-
errorCode:
string
-
errorDesc:
string
-
eventCode:
string
Event Code
-
eventSrNo:
number
-
exchangeRate:
number
-
externalAccount:
string
-
externalAccountCcy:
string
-
externalBankId:
string
-
externalBankName:
string
-
externalBranchCode:
string
-
externalBranchName:
string
-
externalBranchRoutingCode:
integer(int64)
-
id:
string
-
instDepRefNo:
string
-
paymentMode:
string
-
poolingLevelType:
string
-
processingDate:
string
Processing date
-
productCode:
string
Product code
-
refNo:
string
-
seqNo:
integer(int64)
-
status:
string
-
txnBranchCode:
string
Transaction Branch Code
-
valueDate:
string
Value Date
Nested Schema : InstrumentModelAdditionalInfoList
Type:
Show Source
array
-
Array of:
object InstrumentAdditionalInfoModel
DataSlips additional Field
Nested Schema : InstrumentAdditionalInfoModel
Type:
object
DataSlips additional Field
Show Source
-
adfRowNo:
integer(int64)
Row no of this additional Field
-
depositSlipRefNo:
string
deposit Slip Ref No of the slip
-
id:
string
Id of the DepositSlip
-
instrumentNo:
string
No of the instrument
-
instrumentRefNo:
string
No of the instrumentRefNo
-
referenceNum:
string
Reference Num of the DepositSlip
-
seqNo:
integer(int64)
Seq No of the DepositSlip
-
udf1:
string
User Defined Field 1
-
udf10:
string
User Defined Field 10
-
udf11:
string
User Defined Field 11
-
udf12:
string
User Defined Field 12
-
udf13:
string
User Defined Field 13
-
udf14:
string
User Defined Field 14
-
udf15:
string
User Defined Field 15
-
udf16:
string
User Defined Field 16
-
udf17:
string
User Defined Field 17
-
udf18:
string
User Defined Field 18
-
udf19:
string
User Defined Field 19
-
udf2:
string
User Defined Field 2
-
udf20:
string
User Defined Field 20
-
udf21:
string
User Defined Field 21
-
udf22:
string
User Defined Field 22
-
udf23:
string
User Defined Field 23
-
udf24:
string
User Defined Field 24
-
udf25:
string
User Defined Field 25
-
udf26:
string
User Defined Field 26
-
udf27:
string
User Defined Field 27
-
udf28:
string
User Defined Field 28
-
udf29:
string
User Defined Field 29
-
udf3:
string
User Defined Field 3
-
udf30:
string
User Defined Field 30
-
udf4:
string
User Defined Field 4
-
udf5:
string
User Defined Field 5
-
udf6:
string
User Defined Field 6
-
udf7:
string
User Defined Field 7
-
udf8:
string
User Defined Field 8
-
udf9:
string
User Defined Field 9
Nested Schema : additionalDetails
Type:
object
additionalDetails
Nested Schema : additionalProperties
Type:
object
additionalProperties
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns true for Successful update
Root Schema : ConductorWorkflowModel
Type:
object
ConductorWorkflowModel
Show Source
-
amount:
number
amount
-
appId:
string
AppId of Workflow Service
-
applicationCode:
string
Application code
-
applicationNumber:
string
Reference number without seqno
-
branchCode:
string
Branch Code
-
businessDate:
string
Business Date
-
channel:
string
Channel
-
currencyCode:
string
currencyCode
-
customerNumber:
string
customerNumber
-
discountOffer:
object DiscountingModel
DiscountingModel
-
errorCode:
string
Error Code
-
errorDesc:
string
Error Desc
-
event:
string
event
-
fciMessageModel:
object FCIMessageModel
FCIMessageModel
-
financeModel:
object FinanceModel
FinanceModel
-
instrumentModel:
object InstrumentModel
InstrumentModel model
-
isFcubsIntegrationReqd:
string
isFcubsIntegrationReqd
-
isInProgKafkaTaskReqd:
string
isInProgKafkaTaskReqd
-
manualReconModel:
object ManualReconModel
ManualReconModel
-
marginRefundModel:
object MarginRefundModel
MarginRefundModel
-
priority:
string
priority
-
processCode:
string
Process Code to identify workflow
-
processingDate:
string
Processing Date
-
processName:
string
Process Name to identify workflow
-
product:
string
Product type to identify service for instrument
-
productCategory:
string
productCategory
-
productCode:
string
productCode
-
purgeAcctEntries:
string
purgeAcctEntries
-
refundModel:
object RefundModel
RefundModel
-
server:
string
server
-
stageDescription:
string
Stage desc
-
stageId:
string
Stage Id
-
taskInstanceId:
string
Task Instance Id
-
transactionReferenceNo:
string
Transaction Referenec No
-
uri:
string
EndPoint of Workflow Service
-
userId:
string
User Id
-
workflowInstanceId:
string
Workflow Instance Id
-
workflowType:
string
workflowType
Nested Schema : DiscountingModel
Type:
object
DiscountingModel
Show Source
-
additionalDetails:
object additionalDetails
additionalDetails
-
additionalProperties:
object additionalProperties
additionalProperties
-
discountRuleId:
string
discountRuleId
-
isAutoAuth:
string
isAutoAuth
Nested Schema : FCIMessageModel
Type:
object
FCIMessageModel
Show Source
-
fciMessageType:
string
Fci Message Type
-
invoiceNumber:
string
Invoice Number
-
messageRefId:
string
Message Ref Id
Nested Schema : FinanceModel
Type:
object
FinanceModel
Show Source
-
additionalDetails:
object additionalDetails
additionalDetails
-
additionalProperties:
object additionalProperties
additionalProperties
-
blockLimitsProcessingReqd:
string
Limits Flag
-
financeRefNo:
string
financeRefNo
-
financeRefNoSeqNo:
string
financeRefNoSeqNo
-
financeSeqNo:
integer(int64)
financeSeqNo
-
isAccEntriesPostRequired:
string
isAccEntriesPostRequired flag
-
isAccountingApplicable:
string
Accounting Applicable Flag
-
isAccountingSynchronous:
string
isAccountingSynchronous
-
isAlertsAndNotificationReqd:
string
isAlertsAndNotificationReqd flag
-
isAuthRequired:
string
isAuthRequired flag
-
isAutoProcessing:
string
isAutoProcessing flag
-
isExternalPaymentRequired:
string
isExternalPaymentRequired flag
-
isExtPaymentSynchronous:
string
isExtPaymentSynchronous
-
isInstrumentUpdateReqd:
string
isInstrumentUpdateReqd flag
-
isLimitApplicable:
string
Limit Applicable Flag
-
isLimitBlockReqd:
string
isLimitBlockReqd flag
-
isLimitUtilReleaseRequired:
string
isLimitUtilReleaseRequired flag
-
isObclTxnUpdateReqd:
string
isObclTxnUpdateReqd flag
-
isPrePostApplicable:
string
isPrePostApplicable
-
isPrePostConversionException:
string
isPrePostConversionException
-
isUpdateFinanceMasterReqd:
string
isUpdateFinanceMasterReqd flag
Nested Schema : InstrumentModel
Type:
object
InstrumentModel model
Show Source
-
accountingDetails:
object AccountingTransactionCollection
Collection of Accounting Transaction Models.
-
accountType:
string
accountType
-
actualCreditDate:
string(date)
Actual Credit Date
-
actualCreditDateString:
string
ActualCredit Date String
-
actualCreditReversalDate:
string(date)
Actual Credit Reversal Date
-
actualCreditReversalDateString:
string
Actual Credit Reversal Date String
-
adhocCharges:
string
adhocCharges
-
arrangementCode:
string
arrangementCode
-
arrangementCreditDate:
string(date)
arrangementCreditDate
-
arrangementCreditDateString:
string
ArrangementCredit Date String
-
arrangementDays:
integer
arrangementDays
-
arrangementDesc:
string
arrangementDesc
-
arrangementRefBasis:
string
arrangementRefBasis
-
certificateExtensionDays:
integer
certificateExtensionDays
-
checkerDtStamp:
string(date)
checkerDtStamp
-
checkerId:
string
checkerId
-
chgCalc:
string
Charges Calculation flag as Y or N
-
clearingNetworkCode:
string
Clearing Network Code
-
clearingNetworkDesc:
string
Clearing Network Desc
-
coreBankBranchCode:
string
coreBankBranchCode
-
corporateRefNo:
string
Corporate Ref No
-
corporateReleaseDays:
integer
corporateReleaseDays
-
corrBankCode:
string
corrBankCode
-
creditAccountNo:
string
Credit Account No
-
creditACCY:
string
Credit Currency Amount
-
creditStatus:
string
creditStatus
-
depositSlipNo:
string
no of the DepositSlipNo
-
depositSlipRefNo:
string
deposit Slip Ref No of the Instrument
-
divisionCode:
string
Division Code
-
divisionCodeDesc:
string
Division Code Desc
-
drawerAcName:
string
Drawer Ac Name
-
drawerAcNo:
string
Drawer Ac No
-
drawerId:
string
Drawer Id
-
drawerName:
string
Drawer Name
-
drawnOnBankCode:
string
Drawn on Bank Code
-
drawnOnBankName:
string
Drawn on Bank Name
-
drawnOnBranchCode:
string
Drawn on Branch Code
-
drawnOnBranchName:
string
Drawn on Branch Name
-
holdUntillDate:
string(date)
holdUntillDate
-
holdUntillDateString:
string
HoldUntill Date String
-
id:
string
Id of the Instrument
-
instMgmtCourierCode:
string
instMgmtCourierCode
-
instMgmtCourierPodNumber:
string
instMgmtCourierPodNumber
-
instrumentAdFields:
object InstrumentModelAdditionalInfoCollection
Collection of DepositSlips
-
instrumentAmountValue:
number
Instrument Amount Value
-
instrumentAmt:
number
Instrument Amount
-
instrumentAmtCcy:
string
Instrument Amount ccy
-
instrumentCount:
number
Instrument Count
-
instrumentDate:
string(date)
Instrument Date
-
instrumentDateString:
string
Instrument Date String
-
instrumentManagementBatchRefNo:
string
instrumentManagementBatchRefNo
-
instrumentNo:
string
no of the Instrument
-
instrumentRefNo:
string
Instrument Ref No of the Instrument
-
instrumentStatus:
string
Instrument Status
-
instrumentType:
string
Instrument Type
-
instTxnStatus:
string
instTxnStatus
-
isCentralizedSchedule:
string
isCentralizedSchedule
-
isCustomerCredited:
string
isCustomerCredited
-
isPDCChecked:
string
Is PDC Checked
-
lostExtensionDays:
integer
lostExtensionDays
-
makerDtStamp:
string(date)
makerDtStamp
-
makerId:
string
makerId
-
misc1:
string
misc1
-
misc10:
string
misc10
-
misc11:
string
misc11
-
misc12:
string
misc12
-
misc13:
string
misc13
-
misc14:
string
misc14
-
misc15:
string
misc15
-
misc16:
string
misc16
-
misc17:
string
misc17
-
misc18:
string
misc18
-
misc19:
string
misc19
-
misc2:
string
misc2
-
misc20:
string
misc20
-
misc21:
string
misc21
-
misc22:
string
misc22
-
misc23:
string
misc23
-
misc24:
string
misc24
-
misc25:
string
misc25
-
misc26:
string
misc26
-
misc27:
string
misc27
-
misc28:
string
misc28
-
misc29:
string
misc29
-
misc3:
string
misc3
-
misc30:
string
misc30
-
misc4:
string
misc4
-
misc5:
string
misc5
-
misc6:
string
misc6
-
misc7:
string
misc7
-
misc8:
string
misc8
-
misc9:
string
misc9
-
noOfMiscFields:
number
noOfMiscFields
-
payableAtLocationCode:
string
Payable at Location Code
-
payableAtLocationDesc:
string
Payable at Location Desc
-
payableAtLocClusterCode:
string
Payable at Loc Cluster Code
-
payableAtLocClusterDesc:
string
Payable at Loc Cluster Desc
-
presentationDate:
string(date)
presentationDate
-
presentationDateString:
string
PresentationDate Date String
-
productCode:
string
Product Code
-
productDesc:
string
Product Desc
-
realisationAmount:
number
Realisation Amount
-
realisationDate:
string(date)
Realisation Date
-
realisationDateString:
string
Realisation Date String
-
referenceNum:
string
Reference Num of the batch
-
rejectReason:
string
Reject Reason
-
remarks:
string
remarks
-
returnExtensionDays:
integer
returnExtensionDays
-
returningDate:
string(date)
returningDate
-
returningDateString:
string
Returning Date String
-
routingNumber:
number
Routing number
-
scheduleDestinationBank:
string
scheduleDestinationBank
-
scheduleDestinationBankDescription:
string
scheduleDestinationBankDescription
-
scheduleDestinationBranch:
string
scheduleDestinationBranch
-
scheduleDestinationBranchDescription:
string
scheduleDestinationBranchDescription
-
scheduleGenerationDate:
string(date)
scheduleGenerationDate
-
scheduleGenerationDateString:
string
Schedule Generation Date String
-
scheduleOriginationBank:
string
scheduleOriginationBank
-
scheduleOriginationBranch:
string
scheduleOriginationBranch
-
scheduleReceiptDate:
string(date)
Schedule Receipt Date
-
scheduleReceiptDateString:
string
ScheduleReceipt Date String
-
scheduleRefNo:
string
Schedule RefNo
-
seqNo:
integer(int64)
Seq No of the Instrument
-
stage:
string
stage
-
vaFlagYN:
string
Virtual Account flag as Y or N
-
vaultBoxDescription:
string
Vault Box Description
-
vaultBoxNumber:
string
Vault Box Number
-
vaultBranch:
string
Vault Branch
Nested Schema : ManualReconModel
Type:
object
ManualReconModel
Show Source
-
additionalDetails:
object additionalDetails
additionalDetails
-
additionalProperties:
object additionalProperties
additionalProperties
-
invAcquireTaskReqd:
string
Flag for to acquire invoice task
-
isAutoAuth:
string
Is Auto Auth
-
isFinanceIntegrationReqd:
string
Flag for finance settlement
-
isVamIntegrationReqd:
string
Flag for Reference Number
-
reconTxnRefNo:
string
Transaction Reference Number
Nested Schema : MarginRefundModel
Type:
object
MarginRefundModel
Show Source
-
buyer:
string
Buyer Name
-
instrumentType:
string
Instrument Type
-
isExternalPmtReqd:
string
External Payment Required Flag
-
isExtPaymentSynchronous:
string
External Payment Synchronous Flag
-
marginRefNo:
string
Margin Reference Number
-
marginType:
string
Margin Type
-
supplier:
string
Supplier Name
Nested Schema : RefundModel
Type:
object
RefundModel
Show Source
-
action:
string
Action
-
instrumentType:
string
instrumentType
-
isAutoAuthApplicableForRefund:
string
isAutoAuthApplicableForRefund
-
isExternalPaymentReqd:
string
isExternalPaymentReqd
-
isExtPaymentSynchronous:
string
isExtPaymentSynchronous
-
isFcubsIntegrationReqd:
string
isFcubsIntegrationReqd
-
paymentNumberIR:
string
paymentNumberIR
-
paymentRefNo:
string
paymentRefNo
-
refundParty:
string
refundParty
-
refundRefNoSeqNo:
string
Refund Reference Number Sequence No
-
taskName:
string
Task Name
Nested Schema : additionalDetails
Type:
object
additionalDetails
Nested Schema : additionalProperties
Type:
object
additionalProperties
Nested Schema : additionalDetails
Type:
object
additionalDetails
Nested Schema : additionalProperties
Type:
object
additionalProperties
Nested Schema : AccountingTransactionCollection
Type:
object
Collection of Accounting Transaction Models.
Show Source
Nested Schema : InstrumentModelAdditionalInfoCollection
Type:
object
Collection of DepositSlips
Show Source
Nested Schema : accountingTransactionList
Type:
Show Source
array
-
Array of:
object AccountingTransactionModel
Accounting Transaction Model
Nested Schema : AccountingTransactionModel
Type:
object
Accounting Transaction Model
Show Source
-
accClass:
string
Account Class
-
accEntryDesc:
string
-
accEntrySeq:
integer(int64)
-
accountCcy:
string
-
accountingEntryCode:
string
-
accountNo:
string
-
accPartyId:
string
-
accPartyType:
string
-
accRoleCode:
string
-
accRoleDesc:
string
-
accSettMethod:
string
-
accType:
string
-
amount:
number
-
amountAccCcy:
number
-
amountCcy:
string
-
amountType:
string
-
applicationCode:
string
Application Code
-
drCrIndicator:
string
-
ecaRefNo:
string
-
errorCode:
string
-
errorDesc:
string
-
eventCode:
string
Event Code
-
eventSrNo:
number
-
exchangeRate:
number
-
externalAccount:
string
-
externalAccountCcy:
string
-
externalBankId:
string
-
externalBankName:
string
-
externalBranchCode:
string
-
externalBranchName:
string
-
externalBranchRoutingCode:
integer(int64)
-
id:
string
-
instDepRefNo:
string
-
paymentMode:
string
-
poolingLevelType:
string
-
processingDate:
string
Processing date
-
productCode:
string
Product code
-
refNo:
string
-
seqNo:
integer(int64)
-
status:
string
-
txnBranchCode:
string
Transaction Branch Code
-
valueDate:
string
Value Date
Nested Schema : InstrumentModelAdditionalInfoList
Type:
Show Source
array
-
Array of:
object InstrumentAdditionalInfoModel
DataSlips additional Field
Nested Schema : InstrumentAdditionalInfoModel
Type:
object
DataSlips additional Field
Show Source
-
adfRowNo:
integer(int64)
Row no of this additional Field
-
depositSlipRefNo:
string
deposit Slip Ref No of the slip
-
id:
string
Id of the DepositSlip
-
instrumentNo:
string
No of the instrument
-
instrumentRefNo:
string
No of the instrumentRefNo
-
referenceNum:
string
Reference Num of the DepositSlip
-
seqNo:
integer(int64)
Seq No of the DepositSlip
-
udf1:
string
User Defined Field 1
-
udf10:
string
User Defined Field 10
-
udf11:
string
User Defined Field 11
-
udf12:
string
User Defined Field 12
-
udf13:
string
User Defined Field 13
-
udf14:
string
User Defined Field 14
-
udf15:
string
User Defined Field 15
-
udf16:
string
User Defined Field 16
-
udf17:
string
User Defined Field 17
-
udf18:
string
User Defined Field 18
-
udf19:
string
User Defined Field 19
-
udf2:
string
User Defined Field 2
-
udf20:
string
User Defined Field 20
-
udf21:
string
User Defined Field 21
-
udf22:
string
User Defined Field 22
-
udf23:
string
User Defined Field 23
-
udf24:
string
User Defined Field 24
-
udf25:
string
User Defined Field 25
-
udf26:
string
User Defined Field 26
-
udf27:
string
User Defined Field 27
-
udf28:
string
User Defined Field 28
-
udf29:
string
User Defined Field 29
-
udf3:
string
User Defined Field 3
-
udf30:
string
User Defined Field 30
-
udf4:
string
User Defined Field 4
-
udf5:
string
User Defined Field 5
-
udf6:
string
User Defined Field 6
-
udf7:
string
User Defined Field 7
-
udf8:
string
User Defined Field 8
-
udf9:
string
User Defined Field 9
Nested Schema : additionalDetails
Type:
object
additionalDetails
Nested Schema : additionalProperties
Type:
object
additionalProperties
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