Jump to

• Request
• Response

Initiates the workflow from the conductor

post

/service/v1/initiateWorkflow

This endpoint is used to initiate the workflow from the conductor.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
• branchCode: string
• contentType(optional): string
• userId: string
  userId

Body ()

Request Body that contains data required for creating a new customer

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

{
    "description":"ConductorWorkflowModel",
    "type":"object",
    "properties":{
        "processCode":{
            "type":"string",
            "description":"Process Code to identify workflow"
        },
        "processName":{
            "type":"string",
            "description":"Process Name to identify workflow"
        },
        "userId":{
            "type":"string",
            "description":"User Id"
        },
        "stageId":{
            "type":"string",
            "description":"Stage Id"
        },
        "stageDescription":{
            "type":"string",
            "description":"Stage desc"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Desc"
        },
        "transactionReferenceNo":{
            "type":"string",
            "description":"Transaction Referenec No"
        },
        "processingDate":{
            "description":"Processing Date",
            "type":"string"
        },
        "businessDate":{
            "description":"Business Date",
            "type":"string"
        },
        "workflowInstanceId":{
            "description":"Workflow Instance Id",
            "type":"string"
        },
        "taskInstanceId":{
            "description":"Task Instance Id",
            "type":"string"
        },
        "uri":{
            "description":"EndPoint of Workflow Service",
            "type":"string"
        },
        "appId":{
            "description":"appId of Workflow Service",
            "type":"string"
        },
        "product":{
            "description":"Product type to identify service for instrument",
            "type":"string"
        },
        "productCategory":{
            "description":"Product category to identify datasegment",
            "type":"string"
        },
        "applicationNumber":{
            "description":"Reference number without seqno",
            "type":"string"
        },
        "customerNumber":{
            "description":"Customer Id",
            "type":"string"
        },
        "amount":{
            "type":"number",
            "description":"Instrument Amount"
        },
        "currencyCode":{
            "type":"string",
            "description":"Instrument Currency"
        },
        "priority":{
            "description":"To decide the priority of the task",
            "type":"string"
        },
        "applicationCode":{
            "description":"Application code",
            "type":"string"
        },
        "instrumentModel":{
            "$ref":"#/definitions/InstrumentModel"
        },
        "cashManagementModel":{
            "$ref":"#/definitions/CashManagementModel"
        },
        "fileUploadModel":{
            "$ref":"#/definitions/FileUploadModel"
        },
        "manualReconModel":{
            "$ref":"#/definitions/ManualReconModel"
        },
        "financeModel":{
            "$ref":"#/definitions/FinanceModel"
        },
        "workflowType":{
            "description":"Workflow type",
            "type":"string"
        },
        "productCode":{
            "description":"Product Code",
            "type":"string"
        },
        "event":{
            "description":"Event",
            "type":"string"
        },
        "isAutoAuth":{
            "description":"Is Auto Authorized",
            "type":"string"
        },
        "isReworkAllowed":{
            "description":"Is Rework Allowed",
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "exceptionQueue":{
            "type":"string"
        },
        "refundModel":{
            "$ref":"#/definitions/RefundModel"
        },
        "acceptedInvoicesModel":{
            "$ref":"#/definitions/AcceptedInvoicesModel"
        }
    }
}

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

{
    "description":"AcceptedInvoicesModel",
    "properties":{
        "nettingTransactionNo":{
            "description":"Netting Transacation No",
            "type":"string"
        },
        "nettingAmount":{
            "type":"number",
            "description":"Netted Amount for transaction"
        },
        "nettingCcy":{
            "description":"Netting Currency",
            "type":"string"
        },
        "corporateId":{
            "description":"Corporate Id",
            "type":"string"
        },
        "counterPartyId":{
            "description":"CounterParty Id",
            "type":"string"
        },
        "relationShipCode":{
            "description":"Relation Ship Code",
            "type":"string"
        },
        "paymentTransactionNo":{
            "type":"string",
            "description":"Payment Transaction No"
        },
        "invoiceTransactionNo":{
            "description":"Transaction No for invoices",
            "type":"string"
        },
        "invoiceDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NettingInvoicesModel"
            }
        }
    }
}

Nested Schema : CashManagementModel

Type: object

CashManagementModel

Show Source

• additionalDetails(optional): object additionalDetails
  Additional Properties Allowed: additionalProperties

  Details 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

{
    "description":"CashManagementModel",
    "properties":{
        "productGroup":{
            "type":"string",
            "description":"Product Group"
        },
        "channel":{
            "type":"string",
            "description":"Channel"
        },
        "operation":{
            "type":"string",
            "description":"Operation"
        },
        "referenceNo":{
            "type":"string",
            "description":"Reference No"
        },
        "seqNo":{
            "type":"string",
            "description":"Seq No"
        },
        "isAutoAuth":{
            "description":"Is Auto Auth flag",
            "type":"string"
        },
        "isManualEnrichmentReqd":{
            "description":"Is Manual Enrichment Reqd flag",
            "type":"string"
        },
        "isAccEntryGenRequired":{
            "description":"Is Acc Entry Gen Reqd flag",
            "type":"string"
        },
        "isOnlinePostingReqd":{
            "description":"Is Online Posting Reqd flag",
            "type":"string"
        },
        "isClearingRequired":{
            "description":"Is Clearing Reqd flag",
            "type":"string"
        },
        "isScheduleGenerationRequired":{
            "description":"Is Schedule Generation Reqd flag",
            "type":"string"
        },
        "isPoolingRequired":{
            "description":"Is Pooling Reqd flag",
            "type":"string"
        },
        "countOfDepositSlips":{
            "description":"Count of Deposit Slips",
            "type":"integer",
            "format":"int64"
        },
        "countOfInstruments":{
            "description":"Count of Instruments",
            "type":"integer",
            "format":"int64"
        },
        "instrumentType":{
            "type":"string",
            "description":"Instrument Type"
        },
        "isUpdateCheckReqd":{
            "type":"string",
            "description":"isUpdateCheckReqd flag"
        },
        "isArrAndPoolingReqd":{
            "type":"string",
            "description":"isArrAndPoolingReqd flag"
        },
        "additionalDetails":{
            "type":"object",
            "description":"Details of other properties",
            "additionalProperties":{
                "type":"object",
                "description":"Additional Properties"
            }
        }
    }
}

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

{
    "description":"FileUploadModel",
    "properties":{
        "fileId":{
            "type":"string",
            "description":"fileId"
        },
        "fileReference":{
            "type":"string",
            "description":"fileReference"
        },
        "isRouteViaInstrumentWorkflow":{
            "type":"string",
            "description":"isRouteViaInstrumentWorkflow"
        },
        "isAutoAuth":{
            "type":"string",
            "description":"isAutoAuth"
        },
        "isResponseFileRequired":{
            "type":"string",
            "description":"isResponseFileRequired"
        },
        "isRouteViaUpdateInstrumentWorkflow":{
            "type":"string",
            "description":"isRouteViaUpdateInstrumentWorkflow"
        },
        "filePath":{
            "type":"string",
            "description":"filePath"
        },
        "fileName":{
            "type":"string",
            "description":"filePath"
        },
        "additionalDetails":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

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

{
    "description":"FinanceModel",
    "properties":{
        "financeRefNo":{
            "type":"string",
            "description":"financeRefNo"
        },
        "financeRefNoSeqNo":{
            "type":"string",
            "description":"financeRefNoSeqNo"
        },
        "financeSeqNo":{
            "type":"integer",
            "format":"int64"
        },
        "taskName":{
            "type":"string"
        },
        "isAutoProcessing":{
            "type":"string",
            "description":"isAutoProcessing flag"
        },
        "isLimitBlockReqd":{
            "type":"string",
            "description":"isLimitBlockReqd flag"
        },
        "isAuthRequired":{
            "type":"string",
            "description":"isAuthRequired flag"
        },
        "isAccEntriesPostRequired":{
            "type":"string",
            "description":"isAccEntriesPostRequired flag"
        },
        "isExternalPaymentRequired":{
            "type":"string",
            "description":"isExternalPaymentRequired flag"
        },
        "isLimitUtilReleaseRequired":{
            "type":"string",
            "description":"isLimitUtilReleaseRequired flag"
        },
        "isUpdateFinanceMasterReqd":{
            "type":"string",
            "description":"isUpdateFinanceMasterReqd flag"
        },
        "isInstrumentUpdateReqd":{
            "type":"string",
            "description":"isInstrumentUpdateReqd flag"
        },
        "isObclTxnUpdateReqd":{
            "type":"string",
            "description":"isObclTxnUpdateReqd flag"
        },
        "isAlertsAndNotificationReqd":{
            "type":"string",
            "description":"isAlertsAndNotificationReqd flag"
        },
        "userAmount":{
            "type":"number"
        },
        "userCcy":{
            "type":"string"
        },
        "additionalDetails":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

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

{
    "description":"InstrumentModel",
    "properties":{
        "action":{
            "type":"string",
            "description":"Action"
        },
        "isAutoAuth":{
            "type":"string",
            "description":"IsAutoAuth"
        },
        "isFileUpload":{
            "type":"string",
            "description":"isFileUpload"
        },
        "isFileAuthorized":{
            "type":"string",
            "description":"isFileUpload"
        },
        "isPortalTxn":{
            "type":"string",
            "description":"isPortalTxn"
        },
        "instrumentType":{
            "type":"string",
            "description":"Instrument Type"
        },
        "isFromML":{
            "type":"string",
            "description":"Check if txn is from ML"
        },
        "isMLHumanTaskReqd":{
            "type":"string",
            "description":"Check if ml txn requires human task"
        },
        "isAutoProcessingReqInv":{
            "type":"string",
            "description":"Check if auto processing required"
        },
        "isManualEnrichmentReqdInv":{
            "type":"string",
            "description":"Check if manual processing required"
        },
        "limitBlockReqdInv":{
            "type":"string",
            "description":"Check if limits block required"
        },
        "limitUtilRelReqdInv":{
            "type":"string",
            "description":"Check if limits util or release required"
        },
        "isAccountingApplicable":{
            "type":"string",
            "description":"Check if accounting applicable"
        },
        "additionalDetails":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "createCashflowFromInvoice":{
            "type":"string"
        }
    }
}

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

{
    "description":"ManualReconModel",
    "properties":{
        "isAutoAuth":{
            "description":"Is Auto Auth",
            "type":"string"
        },
        "reconTxnRefNo":{
            "description":"Transaction Reference Number",
            "type":"string"
        },
        "isVamIntegrationReqd":{
            "description":"Flag for Reference Number",
            "type":"string"
        },
        "isFinanceIntegrationReqd":{
            "description":"Flag for finance settlement ",
            "type":"string"
        },
        "invAcquireTaskReqd":{
            "description":"Flag for to acquire invoice task",
            "type":"string"
        },
        "additionalDetails":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "createCashflowFromInvoice":{
            "type":"string"
        }
    }
}

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

{
    "description":"RefundModel",
    "properties":{
        "action":{
            "type":"string",
            "description":"Action"
        },
        "isFcubsIntegrationReqd":{
            "type":"string",
            "description":"isFcubsIntegrationReqd"
        },
        "isExternalPaymentReqd":{
            "type":"string",
            "description":"isExternalPaymentReqd"
        },
        "isExtPaymentSynchronous":{
            "type":"string",
            "description":"isExtPaymentSynchronous"
        },
        "isAutoAuthApplicableForRefund":{
            "type":"string",
            "description":"isAutoAuthApplicableForRefund"
        },
        "refundRefNoSeqNo":{
            "type":"string",
            "description":"Refund Reference Number Sequence No"
        },
        "taskName":{
            "type":"string",
            "description":"Task Name"
        },
        "instrumentType":{
            "type":"string"
        },
        "refundParty":{
            "type":"string"
        },
        "paymentRefNo":{
            "type":"string"
        }
    }
}

Nested Schema : invoiceDetails

Type: array

Show Source

• Array of: object NettingInvoicesModel

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

Nested Schema : NettingInvoicesModel

Type: object

Show Source

• 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

{
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "nettingTxnNo":{
            "type":"string",
            "description":"Netting Transaction Number"
        },
        "sourceRefNo":{
            "type":"string",
            "description":"Source Ref No"
        },
        "identifier":{
            "type":"string",
            "description":"Identifier For Receivable or Payable"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Ref No"
        },
        "invoiceStatus":{
            "type":"string",
            "description":"Invoice Status"
        },
        "paymentStatus":{
            "type":"string",
            "description":"Invoice Payment Status"
        },
        "nettingStatus":{
            "type":"string",
            "description":"Invoice Netting Status"
        },
        "outStandingAmount":{
            "type":"number",
            "description":"Invoice OutStanding Amount"
        },
        "invoiceAmount":{
            "type":"number",
            "description":"Invoice Amount"
        },
        "paymentDueDate":{
            "type":"string",
            "description":"Invoice Payment Due Date"
        },
        "nettedInvAmount":{
            "type":"number",
            "description":"Netted Inv Amount"
        },
        "remainingOutStandingAmount":{
            "type":"number",
            "description":"Remaining Out Standing Amount"
        },
        "invoiceCcy":{
            "type":"string",
            "description":"Invoice Currency"
        }
    }
}

Nested Schema : additionalDetails

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties

{
    "type":"object",
    "description":"Details of other properties",
    "additionalProperties":{
        "type":"object",
        "description":"Additional Properties"
    }
}

Details of other properties

Nested Schema : additionalProperties

Type: object

Additional Properties

Nested Schema : additionalDetails

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalDetails

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalDetails

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalDetails

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns the error code from service

Body ()

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

{
    "description":"ConductorWorkflowModel",
    "type":"object",
    "properties":{
        "processCode":{
            "type":"string",
            "description":"Process Code to identify workflow"
        },
        "processName":{
            "type":"string",
            "description":"Process Name to identify workflow"
        },
        "userId":{
            "type":"string",
            "description":"User Id"
        },
        "stageId":{
            "type":"string",
            "description":"Stage Id"
        },
        "stageDescription":{
            "type":"string",
            "description":"Stage desc"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Desc"
        },
        "transactionReferenceNo":{
            "type":"string",
            "description":"Transaction Referenec No"
        },
        "processingDate":{
            "description":"Processing Date",
            "type":"string"
        },
        "businessDate":{
            "description":"Business Date",
            "type":"string"
        },
        "workflowInstanceId":{
            "description":"Workflow Instance Id",
            "type":"string"
        },
        "taskInstanceId":{
            "description":"Task Instance Id",
            "type":"string"
        },
        "uri":{
            "description":"EndPoint of Workflow Service",
            "type":"string"
        },
        "appId":{
            "description":"appId of Workflow Service",
            "type":"string"
        },
        "product":{
            "description":"Product type to identify service for instrument",
            "type":"string"
        },
        "productCategory":{
            "description":"Product category to identify datasegment",
            "type":"string"
        },
        "applicationNumber":{
            "description":"Reference number without seqno",
            "type":"string"
        },
        "customerNumber":{
            "description":"Customer Id",
            "type":"string"
        },
        "amount":{
            "type":"number",
            "description":"Instrument Amount"
        },
        "currencyCode":{
            "type":"string",
            "description":"Instrument Currency"
        },
        "priority":{
            "description":"To decide the priority of the task",
            "type":"string"
        },
        "applicationCode":{
            "description":"Application code",
            "type":"string"
        },
        "instrumentModel":{
            "$ref":"#/definitions/InstrumentModel"
        },
        "cashManagementModel":{
            "$ref":"#/definitions/CashManagementModel"
        },
        "fileUploadModel":{
            "$ref":"#/definitions/FileUploadModel"
        },
        "manualReconModel":{
            "$ref":"#/definitions/ManualReconModel"
        },
        "financeModel":{
            "$ref":"#/definitions/FinanceModel"
        },
        "workflowType":{
            "description":"Workflow type",
            "type":"string"
        },
        "productCode":{
            "description":"Product Code",
            "type":"string"
        },
        "event":{
            "description":"Event",
            "type":"string"
        },
        "isAutoAuth":{
            "description":"Is Auto Authorized",
            "type":"string"
        },
        "isReworkAllowed":{
            "description":"Is Rework Allowed",
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "exceptionQueue":{
            "type":"string"
        },
        "refundModel":{
            "$ref":"#/definitions/RefundModel"
        },
        "acceptedInvoicesModel":{
            "$ref":"#/definitions/AcceptedInvoicesModel"
        }
    }
}

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

{
    "description":"AcceptedInvoicesModel",
    "properties":{
        "nettingTransactionNo":{
            "description":"Netting Transacation No",
            "type":"string"
        },
        "nettingAmount":{
            "type":"number",
            "description":"Netted Amount for transaction"
        },
        "nettingCcy":{
            "description":"Netting Currency",
            "type":"string"
        },
        "corporateId":{
            "description":"Corporate Id",
            "type":"string"
        },
        "counterPartyId":{
            "description":"CounterParty Id",
            "type":"string"
        },
        "relationShipCode":{
            "description":"Relation Ship Code",
            "type":"string"
        },
        "paymentTransactionNo":{
            "type":"string",
            "description":"Payment Transaction No"
        },
        "invoiceTransactionNo":{
            "description":"Transaction No for invoices",
            "type":"string"
        },
        "invoiceDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NettingInvoicesModel"
            }
        }
    }
}

Nested Schema : CashManagementModel

Type: object

CashManagementModel

Show Source

• additionalDetails(optional): object additionalDetails
  Additional Properties Allowed: additionalProperties

  Details 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

{
    "description":"CashManagementModel",
    "properties":{
        "productGroup":{
            "type":"string",
            "description":"Product Group"
        },
        "channel":{
            "type":"string",
            "description":"Channel"
        },
        "operation":{
            "type":"string",
            "description":"Operation"
        },
        "referenceNo":{
            "type":"string",
            "description":"Reference No"
        },
        "seqNo":{
            "type":"string",
            "description":"Seq No"
        },
        "isAutoAuth":{
            "description":"Is Auto Auth flag",
            "type":"string"
        },
        "isManualEnrichmentReqd":{
            "description":"Is Manual Enrichment Reqd flag",
            "type":"string"
        },
        "isAccEntryGenRequired":{
            "description":"Is Acc Entry Gen Reqd flag",
            "type":"string"
        },
        "isOnlinePostingReqd":{
            "description":"Is Online Posting Reqd flag",
            "type":"string"
        },
        "isClearingRequired":{
            "description":"Is Clearing Reqd flag",
            "type":"string"
        },
        "isScheduleGenerationRequired":{
            "description":"Is Schedule Generation Reqd flag",
            "type":"string"
        },
        "isPoolingRequired":{
            "description":"Is Pooling Reqd flag",
            "type":"string"
        },
        "countOfDepositSlips":{
            "description":"Count of Deposit Slips",
            "type":"integer",
            "format":"int64"
        },
        "countOfInstruments":{
            "description":"Count of Instruments",
            "type":"integer",
            "format":"int64"
        },
        "instrumentType":{
            "type":"string",
            "description":"Instrument Type"
        },
        "isUpdateCheckReqd":{
            "type":"string",
            "description":"isUpdateCheckReqd flag"
        },
        "isArrAndPoolingReqd":{
            "type":"string",
            "description":"isArrAndPoolingReqd flag"
        },
        "additionalDetails":{
            "type":"object",
            "description":"Details of other properties",
            "additionalProperties":{
                "type":"object",
                "description":"Additional Properties"
            }
        }
    }
}

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

{
    "description":"FileUploadModel",
    "properties":{
        "fileId":{
            "type":"string",
            "description":"fileId"
        },
        "fileReference":{
            "type":"string",
            "description":"fileReference"
        },
        "isRouteViaInstrumentWorkflow":{
            "type":"string",
            "description":"isRouteViaInstrumentWorkflow"
        },
        "isAutoAuth":{
            "type":"string",
            "description":"isAutoAuth"
        },
        "isResponseFileRequired":{
            "type":"string",
            "description":"isResponseFileRequired"
        },
        "isRouteViaUpdateInstrumentWorkflow":{
            "type":"string",
            "description":"isRouteViaUpdateInstrumentWorkflow"
        },
        "filePath":{
            "type":"string",
            "description":"filePath"
        },
        "fileName":{
            "type":"string",
            "description":"filePath"
        },
        "additionalDetails":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

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

{
    "description":"FinanceModel",
    "properties":{
        "financeRefNo":{
            "type":"string",
            "description":"financeRefNo"
        },
        "financeRefNoSeqNo":{
            "type":"string",
            "description":"financeRefNoSeqNo"
        },
        "financeSeqNo":{
            "type":"integer",
            "format":"int64"
        },
        "taskName":{
            "type":"string"
        },
        "isAutoProcessing":{
            "type":"string",
            "description":"isAutoProcessing flag"
        },
        "isLimitBlockReqd":{
            "type":"string",
            "description":"isLimitBlockReqd flag"
        },
        "isAuthRequired":{
            "type":"string",
            "description":"isAuthRequired flag"
        },
        "isAccEntriesPostRequired":{
            "type":"string",
            "description":"isAccEntriesPostRequired flag"
        },
        "isExternalPaymentRequired":{
            "type":"string",
            "description":"isExternalPaymentRequired flag"
        },
        "isLimitUtilReleaseRequired":{
            "type":"string",
            "description":"isLimitUtilReleaseRequired flag"
        },
        "isUpdateFinanceMasterReqd":{
            "type":"string",
            "description":"isUpdateFinanceMasterReqd flag"
        },
        "isInstrumentUpdateReqd":{
            "type":"string",
            "description":"isInstrumentUpdateReqd flag"
        },
        "isObclTxnUpdateReqd":{
            "type":"string",
            "description":"isObclTxnUpdateReqd flag"
        },
        "isAlertsAndNotificationReqd":{
            "type":"string",
            "description":"isAlertsAndNotificationReqd flag"
        },
        "userAmount":{
            "type":"number"
        },
        "userCcy":{
            "type":"string"
        },
        "additionalDetails":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        }
    }
}

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

{
    "description":"InstrumentModel",
    "properties":{
        "action":{
            "type":"string",
            "description":"Action"
        },
        "isAutoAuth":{
            "type":"string",
            "description":"IsAutoAuth"
        },
        "isFileUpload":{
            "type":"string",
            "description":"isFileUpload"
        },
        "isFileAuthorized":{
            "type":"string",
            "description":"isFileUpload"
        },
        "isPortalTxn":{
            "type":"string",
            "description":"isPortalTxn"
        },
        "instrumentType":{
            "type":"string",
            "description":"Instrument Type"
        },
        "isFromML":{
            "type":"string",
            "description":"Check if txn is from ML"
        },
        "isMLHumanTaskReqd":{
            "type":"string",
            "description":"Check if ml txn requires human task"
        },
        "isAutoProcessingReqInv":{
            "type":"string",
            "description":"Check if auto processing required"
        },
        "isManualEnrichmentReqdInv":{
            "type":"string",
            "description":"Check if manual processing required"
        },
        "limitBlockReqdInv":{
            "type":"string",
            "description":"Check if limits block required"
        },
        "limitUtilRelReqdInv":{
            "type":"string",
            "description":"Check if limits util or release required"
        },
        "isAccountingApplicable":{
            "type":"string",
            "description":"Check if accounting applicable"
        },
        "additionalDetails":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "createCashflowFromInvoice":{
            "type":"string"
        }
    }
}

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

{
    "description":"ManualReconModel",
    "properties":{
        "isAutoAuth":{
            "description":"Is Auto Auth",
            "type":"string"
        },
        "reconTxnRefNo":{
            "description":"Transaction Reference Number",
            "type":"string"
        },
        "isVamIntegrationReqd":{
            "description":"Flag for Reference Number",
            "type":"string"
        },
        "isFinanceIntegrationReqd":{
            "description":"Flag for finance settlement ",
            "type":"string"
        },
        "invAcquireTaskReqd":{
            "description":"Flag for to acquire invoice task",
            "type":"string"
        },
        "additionalDetails":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "createCashflowFromInvoice":{
            "type":"string"
        }
    }
}

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

{
    "description":"RefundModel",
    "properties":{
        "action":{
            "type":"string",
            "description":"Action"
        },
        "isFcubsIntegrationReqd":{
            "type":"string",
            "description":"isFcubsIntegrationReqd"
        },
        "isExternalPaymentReqd":{
            "type":"string",
            "description":"isExternalPaymentReqd"
        },
        "isExtPaymentSynchronous":{
            "type":"string",
            "description":"isExtPaymentSynchronous"
        },
        "isAutoAuthApplicableForRefund":{
            "type":"string",
            "description":"isAutoAuthApplicableForRefund"
        },
        "refundRefNoSeqNo":{
            "type":"string",
            "description":"Refund Reference Number Sequence No"
        },
        "taskName":{
            "type":"string",
            "description":"Task Name"
        },
        "instrumentType":{
            "type":"string"
        },
        "refundParty":{
            "type":"string"
        },
        "paymentRefNo":{
            "type":"string"
        }
    }
}

Nested Schema : invoiceDetails

Type: array

Show Source

• Array of: object NettingInvoicesModel

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

Nested Schema : NettingInvoicesModel

Type: object

Show Source

• 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

{
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "nettingTxnNo":{
            "type":"string",
            "description":"Netting Transaction Number"
        },
        "sourceRefNo":{
            "type":"string",
            "description":"Source Ref No"
        },
        "identifier":{
            "type":"string",
            "description":"Identifier For Receivable or Payable"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Ref No"
        },
        "invoiceStatus":{
            "type":"string",
            "description":"Invoice Status"
        },
        "paymentStatus":{
            "type":"string",
            "description":"Invoice Payment Status"
        },
        "nettingStatus":{
            "type":"string",
            "description":"Invoice Netting Status"
        },
        "outStandingAmount":{
            "type":"number",
            "description":"Invoice OutStanding Amount"
        },
        "invoiceAmount":{
            "type":"number",
            "description":"Invoice Amount"
        },
        "paymentDueDate":{
            "type":"string",
            "description":"Invoice Payment Due Date"
        },
        "nettedInvAmount":{
            "type":"number",
            "description":"Netted Inv Amount"
        },
        "remainingOutStandingAmount":{
            "type":"number",
            "description":"Remaining Out Standing Amount"
        },
        "invoiceCcy":{
            "type":"string",
            "description":"Invoice Currency"
        }
    }
}

Nested Schema : additionalDetails

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties

{
    "type":"object",
    "description":"Details of other properties",
    "additionalProperties":{
        "type":"object",
        "description":"Additional Properties"
    }
}

Details of other properties

Nested Schema : additionalProperties

Type: object

Additional Properties

Nested Schema : additionalDetails

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalDetails

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalDetails

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalDetails

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

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