Rest API for Oracle Banking Cash Management

Updates the invoices in work table

put

/obscfcm-instruments-receivables-services/service/v2/invoice

This endpoint is used to update the invoices in work table.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId: string
branchCode: string
userId: string

user id for SMS

Request Body that contains data required for creating a new Invoice.

Root Schema : InvoicePutModel

Type: object

Invoice put model

Show Source

action: string

Action for which invoices are getting saved
checkerId(optional): string

Checker Id from Portal
discountOfferPutModel(optional): object DiscountOfferPutModel
invoiceList(optional): array invoiceList
makerId(optional): string

Maker Id from Portal
processingBranchCode: string

Branch Code
processingDate: string

Processing Date
srcAppCd(optional): string

Source Application Code
srcAppRefNo(optional): string

Reference Number of Calling System

{
    "description":"Invoice put model",
    "type":"object",
    "required":[
        "action",
        "processingDate",
        "processingBranchCode"
    ],
    "properties":{
        "srcAppCd":{
            "type":"string",
            "description":"Source Application Code"
        },
        "srcAppRefNo":{
            "type":"string",
            "description":"Reference Number of Calling System"
        },
        "action":{
            "type":"string",
            "description":"Action for which invoices are getting saved"
        },
        "processingDate":{
            "type":"string",
            "description":"Processing Date"
        },
        "processingBranchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "makerId":{
            "type":"string",
            "description":"Maker Id from Portal"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker Id from Portal"
        },
        "invoiceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InvoiceUpdateModel2"
            }
        },
        "discountOfferPutModel":{
            "$ref":"#/definitions/DiscountOfferPutModel"
        }
    }
}

Nested Schema : DiscountOfferPutModel

Type: object

Show Source

applicabilityBasis(optional): string
discountRuleDesc(optional): string
discountRuleId(optional): string
earlyPaymentDate(optional): string
invoiceOfferAction(optional): string
invoiceOfferTenorParameterList(optional): array invoiceOfferTenorParameterList

{
    "type":"object",
    "properties":{
        "discountRuleId":{
            "type":"string"
        },
        "discountRuleDesc":{
            "type":"string"
        },
        "applicabilityBasis":{
            "type":"string"
        },
        "earlyPaymentDate":{
            "type":"string"
        },
        "invoiceOfferAction":{
            "type":"string"
        },
        "invoiceOfferTenorParameterList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InvoiceOfferTenorParameterModel"
            }
        }
    }
}

Nested Schema : invoiceList

Type: array

Show Source

Array of: object InvoiceUpdateModel2

Invoice Update model 2

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

Nested Schema : invoiceOfferTenorParameterList

Type: array

Show Source

Array of: object InvoiceOfferTenorParameterModel

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

Nested Schema : InvoiceOfferTenorParameterModel

Type: object

Show Source

currency(optional): string
daysElapsedFrom(optional): number
daysElapsedTo(optional): number
discountPercentage(optional): number
discountRuleDescription(optional): string
discountRuleId(optional): string
invoiceMasterId(optional): string
invoiceRefNo(optional): string

Invoice Reference Number
lowerDiscountRateThreshold(optional): number
paymentDateFrom(optional): string
paymentDateTo(optional): string
slidingScaleApplicable(optional): string
transactionRefNo(optional): string
upperDiscountRateThreshold(optional): number

{
    "type":"object",
    "properties":{
        "daysElapsedFrom":{
            "type":"number"
        },
        "daysElapsedTo":{
            "type":"number"
        },
        "discountPercentage":{
            "type":"number"
        },
        "upperDiscountRateThreshold":{
            "type":"number"
        },
        "lowerDiscountRateThreshold":{
            "type":"number"
        },
        "slidingScaleApplicable":{
            "type":"string"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Reference Number"
        },
        "transactionRefNo":{
            "type":"string"
        },
        "currency":{
            "type":"string"
        },
        "discountRuleId":{
            "type":"string"
        },
        "discountRuleDescription":{
            "type":"string"
        },
        "invoiceMasterId":{
            "type":"string"
        },
        "paymentDateFrom":{
            "type":"string"
        },
        "paymentDateTo":{
            "type":"string"
        }
    }
}

Nested Schema : InvoiceUpdateModel2

Type: object

Invoice Update model 2

Show Source

acceptanceAmount(optional): number

Acceptance Amount
discrepancyCd(optional): string

Discrepancy Cd
disputeAmount(optional): number

Dispute Amount
fundingReqDate(optional): string
invoiceDate(optional): string

Invoice Date
invoiceDueDate(optional): string

Invoice Due Date
invoiceRefNo(optional): string

Invoice Reference Number
isAutoAuth(optional): string

Is Auto Authorized
linkedDocs(optional): string

Linked Docs
newFundingReqDate(optional): string
oldAcceptanceAmount(optional): number

Old Acceptance Amount
oldDisputeAmount(optional): number

Old Dispute Amount
oldInvoiceDueDate(optional): string

Old Invoice Due Date
remarks(optional): string

Remarks
transactionRefNo(optional): string

{
    "description":"Invoice Update model 2",
    "type":"object",
    "properties":{
        "transactionRefNo":{
            "type":"string"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Reference Number"
        },
        "oldInvoiceDueDate":{
            "type":"string",
            "description":"Old Invoice Due Date"
        },
        "invoiceDueDate":{
            "type":"string",
            "description":"Invoice Due Date"
        },
        "invoiceDate":{
            "type":"string",
            "description":"Invoice Date"
        },
        "oldDisputeAmount":{
            "type":"number",
            "description":"Old Dispute Amount"
        },
        "disputeAmount":{
            "type":"number",
            "description":"Dispute Amount"
        },
        "oldAcceptanceAmount":{
            "type":"number",
            "description":"Old Acceptance Amount"
        },
        "acceptanceAmount":{
            "type":"number",
            "description":"Acceptance Amount"
        },
        "discrepancyCd":{
            "type":"string",
            "description":"Discrepancy Cd"
        },
        "remarks":{
            "type":"string",
            "description":"Remarks"
        },
        "linkedDocs":{
            "type":"string",
            "description":"Linked Docs"
        },
        "isAutoAuth":{
            "type":"string",
            "description":"Is Auto Authorized"
        },
        "fundingReqDate":{
            "type":"string"
        },
        "newFundingReqDate":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns the Id of the newly created invoice

Root Schema : UpdateInvoiceResponse

Type: object

Discrepancy Response model

Show Source

errorCode(optional): string

Error Code
errorDesc(optional): string

Error Description
processingDate(optional): string

Processing Date
refNoList(optional): array refNoList
srcAppRefNo(optional): string

Src App Reference Number
trnStatus(optional): string

Transaction Status

{
    "description":"Discrepancy Response model",
    "type":"object",
    "properties":{
        "srcAppRefNo":{
            "type":"string",
            "description":"Src App Reference Number"
        },
        "trnStatus":{
            "type":"string",
            "description":"Transaction Status"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description"
        },
        "processingDate":{
            "type":"string",
            "description":"Processing Date"
        },
        "refNoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransactionRefNoResponse"
            }
        }
    }
}

Nested Schema : refNoList

Type: array

Show Source

Array of: object TransactionRefNoResponse

List of Internal Reference Numbers

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

Nested Schema : TransactionRefNoResponse

Type: object

List of Internal Reference Numbers

Show Source

errorCode(optional): string

Error Code
errorDesc(optional): string

Error Description
invoiceRefNoList(optional): array invoiceRefNoList
trnRefNo(optional): string

Transaction Reference Number
trnStatus(optional): string

Transaction Status

{
    "description":"List of Internal Reference Numbers",
    "type":"object",
    "properties":{
        "trnRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "trnStatus":{
            "type":"string",
            "description":"Transaction Status"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description"
        },
        "invoiceRefNoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InvoiceRefNoResponse"
            }
        }
    }
}

Nested Schema : invoiceRefNoList

Type: array

Show Source

Array of: object InvoiceRefNoResponse

List of Internal Reference Numbers

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

Nested Schema : InvoiceRefNoResponse

Type: object

List of Internal Reference Numbers

Show Source

errorCode(optional): string

Error Code
errorDesc(optional): string

Error Description
invoiceRefNo(optional): string

Invoice Reference Number
trnStatus(optional): string

Transaction Status

{
    "description":"List of Internal Reference Numbers",
    "type":"object",
    "properties":{
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Reference Number"
        },
        "trnStatus":{
            "type":"string",
            "description":"Transaction Status"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description"
        }
    }
}

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