Check for excess payment for a reconciliation transaction reference number
post
/service/v1/checkForExcessPayment
This endpoint is used to check for excess payment for a reconciliation transaction reference number.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId: string
App Id
-
branchCode: string
branchCode
-
userId: string
userId
Request Body that contains data required for updating an invoice based on Task
Root Schema : ConductorWorkflowModel
Type:
object
ConductorWorkflowModel
Show Source
-
acceptedInvoicesModel(optional):
object AcceptedInvoicesModel
AcceptedInvoicesModel
-
amount(optional):
number
Instrument Amount
-
appId(optional):
string
appId of Workflow Service
-
applicationCode(optional):
string
Application code
-
applicationNumber(optional):
string
Reference number without seqno
-
branchCode(optional):
string
Branch Code
-
businessDate(optional):
string
Business Date
-
cashManagementModel(optional):
object CashManagementModel
CashManagementModel
-
currencyCode(optional):
string
Instrument Currency
-
customerNumber(optional):
string
Customer Id
-
errorCode(optional):
string
Error Code
-
errorDesc(optional):
string
Error Desc
-
event(optional):
string
Event
-
exceptionQueue(optional):
string
-
fileUploadModel(optional):
object FileUploadModel
FileUploadModel
-
financeModel(optional):
object FinanceModel
FinanceModel
-
instrumentModel(optional):
object InstrumentModel
InstrumentModel
-
isAutoAuth(optional):
string
Is Auto Authorized
-
isReworkAllowed(optional):
string
Is Rework Allowed
-
manualReconModel(optional):
object ManualReconModel
ManualReconModel
-
priority(optional):
string
To decide the priority of the task
-
processCode(optional):
string
Process Code to identify workflow
-
processingDate(optional):
string
Processing Date
-
processName(optional):
string
Process Name to identify workflow
-
product(optional):
string
Product type to identify service for instrument
-
productCategory(optional):
string
Product category to identify datasegment
-
productCode(optional):
string
Product Code
-
refundModel(optional):
object RefundModel
RefundModel
-
stageDescription(optional):
string
Stage desc
-
stageId(optional):
string
Stage Id
-
taskInstanceId(optional):
string
Task Instance Id
-
transactionReferenceNo(optional):
string
Transaction Referenec No
-
uri(optional):
string
EndPoint of Workflow Service
-
userId(optional):
string
User Id
-
version(optional):
string
-
workflowInstanceId(optional):
string
Workflow Instance Id
-
workflowType(optional):
string
Workflow type
Nested Schema : AcceptedInvoicesModel
Type:
object
AcceptedInvoicesModel
Show Source
-
corporateId(optional):
string
Corporate Id
-
counterPartyId(optional):
string
CounterParty Id
-
invoiceDetails(optional):
array invoiceDetails
-
invoiceTransactionNo(optional):
string
Transaction No for invoices
-
nettingAmount(optional):
number
Netted Amount for transaction
-
nettingCcy(optional):
string
Netting Currency
-
nettingTransactionNo(optional):
string
Netting Transacation No
-
paymentTransactionNo(optional):
string
Payment Transaction No
-
relationShipCode(optional):
string
Relation Ship Code
Nested Schema : CashManagementModel
Type:
object
CashManagementModel
Show Source
-
additionalDetails(optional):
object additionalDetails
Additional Properties Allowed: additionalPropertiesDetails of other properties
-
channel(optional):
string
Channel
-
countOfDepositSlips(optional):
integer(int64)
Count of Deposit Slips
-
countOfInstruments(optional):
integer(int64)
Count of Instruments
-
instrumentType(optional):
string
Instrument Type
-
isAccEntryGenRequired(optional):
string
Is Acc Entry Gen Reqd flag
-
isArrAndPoolingReqd(optional):
string
isArrAndPoolingReqd flag
-
isAutoAuth(optional):
string
Is Auto Auth flag
-
isClearingRequired(optional):
string
Is Clearing Reqd flag
-
isManualEnrichmentReqd(optional):
string
Is Manual Enrichment Reqd flag
-
isOnlinePostingReqd(optional):
string
Is Online Posting Reqd flag
-
isPoolingRequired(optional):
string
Is Pooling Reqd flag
-
isScheduleGenerationRequired(optional):
string
Is Schedule Generation Reqd flag
-
isUpdateCheckReqd(optional):
string
isUpdateCheckReqd flag
-
operation(optional):
string
Operation
-
productGroup(optional):
string
Product Group
-
referenceNo(optional):
string
Reference No
-
seqNo(optional):
string
Seq No
Nested Schema : FileUploadModel
Type:
object
FileUploadModel
Show Source
-
additionalDetails(optional):
object additionalDetails
Additional Properties Allowed: additionalProperties
-
fileId(optional):
string
fileId
-
fileName(optional):
string
filePath
-
filePath(optional):
string
filePath
-
fileReference(optional):
string
fileReference
-
isAutoAuth(optional):
string
isAutoAuth
-
isResponseFileRequired(optional):
string
isResponseFileRequired
-
isRouteViaInstrumentWorkflow(optional):
string
isRouteViaInstrumentWorkflow
-
isRouteViaUpdateInstrumentWorkflow(optional):
string
isRouteViaUpdateInstrumentWorkflow
Nested Schema : FinanceModel
Type:
object
FinanceModel
Show Source
-
additionalDetails(optional):
object additionalDetails
Additional Properties Allowed: additionalProperties
-
financeRefNo(optional):
string
financeRefNo
-
financeRefNoSeqNo(optional):
string
financeRefNoSeqNo
-
financeSeqNo(optional):
integer(int64)
-
isAccEntriesPostRequired(optional):
string
isAccEntriesPostRequired flag
-
isAlertsAndNotificationReqd(optional):
string
isAlertsAndNotificationReqd flag
-
isAuthRequired(optional):
string
isAuthRequired flag
-
isAutoProcessing(optional):
string
isAutoProcessing flag
-
isExternalPaymentRequired(optional):
string
isExternalPaymentRequired flag
-
isInstrumentUpdateReqd(optional):
string
isInstrumentUpdateReqd flag
-
isLimitBlockReqd(optional):
string
isLimitBlockReqd flag
-
isLimitUtilReleaseRequired(optional):
string
isLimitUtilReleaseRequired flag
-
isObclTxnUpdateReqd(optional):
string
isObclTxnUpdateReqd flag
-
isUpdateFinanceMasterReqd(optional):
string
isUpdateFinanceMasterReqd flag
-
taskName(optional):
string
-
userAmount(optional):
number
-
userCcy(optional):
string
Nested Schema : InstrumentModel
Type:
object
InstrumentModel
Show Source
-
action(optional):
string
Action
-
additionalDetails(optional):
object additionalDetails
Additional Properties Allowed: additionalProperties
-
createCashflowFromInvoice(optional):
string
-
instrumentType(optional):
string
Instrument Type
-
isAccountingApplicable(optional):
string
Check if accounting applicable
-
isAutoAuth(optional):
string
IsAutoAuth
-
isAutoProcessingReqInv(optional):
string
Check if auto processing required
-
isFileAuthorized(optional):
string
isFileUpload
-
isFileUpload(optional):
string
isFileUpload
-
isFromML(optional):
string
Check if txn is from ML
-
isManualEnrichmentReqdInv(optional):
string
Check if manual processing required
-
isMLHumanTaskReqd(optional):
string
Check if ml txn requires human task
-
isPortalTxn(optional):
string
isPortalTxn
-
limitBlockReqdInv(optional):
string
Check if limits block required
-
limitUtilRelReqdInv(optional):
string
Check if limits util or release required
Nested Schema : ManualReconModel
Type:
object
ManualReconModel
Show Source
-
additionalDetails(optional):
object additionalDetails
Additional Properties Allowed: additionalProperties
-
createCashflowFromInvoice(optional):
string
-
invAcquireTaskReqd(optional):
string
Flag for to acquire invoice task
-
isAutoAuth(optional):
string
Is Auto Auth
-
isFinanceIntegrationReqd(optional):
string
Flag for finance settlement
-
isVamIntegrationReqd(optional):
string
Flag for Reference Number
-
reconTxnRefNo(optional):
string
Transaction Reference Number
Nested Schema : RefundModel
Type:
object
RefundModel
Show Source
-
action(optional):
string
Action
-
instrumentType(optional):
string
-
isAutoAuthApplicableForRefund(optional):
string
isAutoAuthApplicableForRefund
-
isExternalPaymentReqd(optional):
string
isExternalPaymentReqd
-
isExtPaymentSynchronous(optional):
string
isExtPaymentSynchronous
-
isFcubsIntegrationReqd(optional):
string
isFcubsIntegrationReqd
-
paymentRefNo(optional):
string
-
refundParty(optional):
string
-
refundRefNoSeqNo(optional):
string
Refund Reference Number Sequence No
-
taskName(optional):
string
Task Name
Nested Schema : NettingInvoicesModel
Type:
Show Source
object
-
id(optional):
string
Id
-
identifier(optional):
string
Identifier For Receivable or Payable
-
invoiceAmount(optional):
number
Invoice Amount
-
invoiceCcy(optional):
string
Invoice Currency
-
invoiceRefNo(optional):
string
Invoice Ref No
-
invoiceStatus(optional):
string
Invoice Status
-
nettedInvAmount(optional):
number
Netted Inv Amount
-
nettingStatus(optional):
string
Invoice Netting Status
-
nettingTxnNo(optional):
string
Netting Transaction Number
-
outStandingAmount(optional):
number
Invoice OutStanding Amount
-
paymentDueDate(optional):
string
Invoice Payment Due Date
-
paymentStatus(optional):
string
Invoice Payment Status
-
remainingOutStandingAmount(optional):
number
Remaining Out Standing Amount
-
sourceRefNo(optional):
string
Source Ref No
Nested Schema : additionalDetails
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties
Details of other properties
Nested Schema : additionalProperties
Type:
object
Additional Properties
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successful performs the operation
Nested Schema : ResponseResourceSupport
Type:
object
Nested Schema : items
Type:
object
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error