Rest API for Oracle Banking Cash Management

Enrich the invoice with necessary fields for creation

post

/service/v1/enrichment

This endpoint is used to enrich the invoice with necessary fields for creation.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId: string
branchCode: string
userId: string

Request Body with ML attributes picked from model.

Root Schema : ScfMLTagsModel

Type: object

ScfMLTags Model

Show Source

applicationNumber(optional): string
docId(optional): string
docType(optional): string
enrichedTags(optional): array enrichedTags
event(optional): string
id(optional): string
isOverdue(optional): string

Is it an overdue receivable
keyvals(optional): array keyvals
processCode(optional): string
processRefNumber(optional): string
seqNo(optional): integer(int64)
srcAppCd(optional): string
taskInstanceId(optional): string
text(optional): string
validateForOverdue(optional): string

Whether validation for Overdue required or not
workflowInstanceId(optional): string

{
    "description":"ScfMLTags Model",
    "type":"object",
    "properties":{
        "srcAppCd":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64"
        },
        "docId":{
            "type":"string"
        },
        "docType":{
            "type":"string"
        },
        "keyvals":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TagValueModel"
            }
        },
        "text":{
            "type":"string"
        },
        "processCode":{
            "type":"string"
        },
        "applicationNumber":{
            "type":"string"
        },
        "processRefNumber":{
            "type":"string"
        },
        "enrichedTags":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TagValueModel"
            }
        },
        "event":{
            "type":"string"
        },
        "workflowInstanceId":{
            "type":"string"
        },
        "taskInstanceId":{
            "type":"string"
        },
        "validateForOverdue":{
            "type":"string",
            "description":"Whether validation for Overdue required or not"
        },
        "isOverdue":{
            "type":"string",
            "description":"Is it an overdue receivable"
        }
    }
}

Nested Schema : enrichedTags

Type: array

Show Source

Array of: object TagValueModel

Payload from ML Service

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

Nested Schema : keyvals

Type: array

Show Source

Array of: object TagValueModel

Payload from ML Service

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

Nested Schema : TagValueModel

Type: object

Payload from ML Service

Show Source

annotateTag(optional): string
displayLabel(optional): string
endIndex(optional): number
startIndex(optional): number
tagDfltVal(optional): string
tagDispSeq(optional): number
tagName(optional): string
value(optional): string

{
    "description":"Payload from ML Service",
    "type":"object",
    "properties":{
        "tagDispSeq":{
            "type":"number"
        },
        "displayLabel":{
            "type":"string"
        },
        "tagName":{
            "type":"string"
        },
        "annotateTag":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "startIndex":{
            "type":"number"
        },
        "endIndex":{
            "type":"number"
        },
        "tagDfltVal":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Enriched invoice Model with required fields

Root Schema : ResponseDtoWrapper

Type: object

Show Source

data(optional): object ResponseResourceSupport
messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

codes(optional): array codes
id(optional): string
requestId(optional): string
status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

arg(optional): string
args(optional): array args
Code(optional): string
Desc(optional): string
Language(optional): string
Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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