Rest API for Oracle Banking Cash Management

Adds a new Invoice in main table.

post

/service/v1/invoice

This endpoint is used to add a new Invoice.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId: string

appId
branchCode: string

branchCode
userId: string

user id for SMS

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

Root Schema : InvoiceCollection

Type: object

Collection of Invoices.

Show Source

invoiceList(optional): array invoiceList

{
    "description":"Collection of Invoices.",
    "type":"object",
    "properties":{
        "invoiceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Invoice"
            }
        }
    }
}

Nested Schema : invoiceList

Type: array

Show Source

Array of: object Invoice

Invoice model

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

Nested Schema : Invoice

Type: object

Invoice model

Show Source

acceptanceAmount(optional): number

Acceptance Amount
amount(optional): number

Amount
bank(optional): string
branch(optional): string
buyerCode(optional): string
buyerDivCode(optional): string

Buyer Division Code
buyerDivName(optional): string

Buyer Division Name
buyerId(optional): string

Buyer Id
buyerName(optional): string

Buyer Name
countryOfOrigin(optional): string
currency(optional): string

Currency
discountAllowed(optional): string
discountAmount(optional): number
discountPercentage(optional): number
discrepancyCode(optional): string

Discrepancy Code
disputeResolveRemarks(optional): string

Dispute Resolve Remarks
divisionCode(optional): string
fileName(optional): string

File Name
fileRef(optional): string

File Reference
filler1(optional): string

Filler1
filler2(optional): string

Filler2
filler3(optional): string

Filler3
filler4(optional): string

Filler4
financeableAmount(optional): number
financeAmount(optional): number

Finance Amount
financePercentage(optional): number

Finance Percentage
finEligibilityAmt(optional): number
finTxnStatus(optional): string
fundingReqAmt(optional): number
id(optional): string
indicator(optional): string

Indicator
invAcceptanceDate(optional): string

Invoice Acceptance Date
invoiceDate(optional): string

Invoice Date
invoiceDueDate(optional): string

Invoice Due Date
invoiceId(optional): string

Id of the Invoice
invoiceNumber(optional): string

Invoice Number
invoiceProcessStatus(optional): string

Invoice Process Status
invoiceRefNo(optional): string

Invoice Reference Number
invoiceStatus(optional): string

Invoice Status
isAutoAuth(optional): string
isDisputed(optional): string

Is Disputed
isFinanced(optional): string
maxFinancePercentage(optional): number

Maximum Finance Percentage
miscCharge1(optional): number
miscCharge1Amount(optional): number
miscCharge1Desc(optional): string
miscCharge2(optional): number
miscCharge2Amount(optional): number
miscCharge2Desc(optional): string
netInvoiceAmount(optional): number
outstandingAmount(optional): number
paidAmount(optional): number

Paid Amount
paymentDueDate(optional): string
paymentStatus(optional): string

Payment status
paymentTerms(optional): string
poNumber(optional): string

Po Number
preAccepted(optional): string
programCode(optional): string

Program Code
programName(optional): string
purchaseOrderDate(optional): string
raisedBy(optional): string
reasonCode(optional): string

Reason code
reasonErrorCode(optional): string
reasonForExport(optional): string
reasonForShipment(optional): string
reconTxnStatus(optional): string
relationCode(optional): string

Relation Code
remarks(optional): string

Remarks
repayAccountNo(optional): number
routingCode(optional): number
seqNo(optional): integer(int64)
shipmentAddress(optional): string
shipmentCountry(optional): string
shipmentDate(optional): string
shipmentNo(optional): string
shipmentRefNo(optional): string
staleStatus(optional): string
supplierCode(optional): string
supplierDivCode(optional): string

Supplier Division Code
supplierDivName(optional): string

Supplier Division Name
supplierId(optional): string

Supplier Id
supplierName(optional): string

Supplier Name
taxAmount(optional): number

Tax Amount
taxPercentage(optional): number
termsOfSale(optional): string
totalInvoiceAmount(optional): number

Total Invoice Amount
transactionRefNo(optional): string
virtualAcFlag(optional): string

{
    "description":"Invoice model",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64"
        },
        "invoiceId":{
            "description":"Id of the Invoice ",
            "type":"string"
        },
        "acceptanceAmount":{
            "type":"number",
            "description":"Acceptance Amount"
        },
        "amount":{
            "type":"number",
            "description":"Amount"
        },
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "buyerName":{
            "type":"string",
            "description":"Buyer Name"
        },
        "buyerDivCode":{
            "type":"string",
            "description":"Buyer Division Code"
        },
        "buyerDivName":{
            "type":"string",
            "description":"Buyer Division Name"
        },
        "currency":{
            "type":"string",
            "description":"Currency"
        },
        "isDisputed":{
            "type":"string",
            "description":"Is Disputed"
        },
        "discrepancyCode":{
            "type":"string",
            "description":"Discrepancy Code"
        },
        "disputeResolveRemarks":{
            "type":"string",
            "description":"Dispute Resolve Remarks"
        },
        "fileName":{
            "type":"string",
            "description":"File Name"
        },
        "fileRef":{
            "type":"string",
            "description":"File Reference"
        },
        "filler1":{
            "type":"string",
            "description":"Filler1"
        },
        "filler2":{
            "type":"string",
            "description":"Filler2"
        },
        "filler3":{
            "type":"string",
            "description":"Filler3"
        },
        "filler4":{
            "type":"string",
            "description":"Filler4"
        },
        "financeAmount":{
            "type":"number",
            "description":"Finance Amount"
        },
        "financePercentage":{
            "type":"number",
            "description":"Finance Percentage"
        },
        "indicator":{
            "type":"string",
            "description":"Indicator"
        },
        "invoiceDate":{
            "type":"string",
            "description":"Invoice Date"
        },
        "invoiceDueDate":{
            "type":"string",
            "description":"Invoice Due Date"
        },
        "invoiceNumber":{
            "type":"string",
            "description":"Invoice Number"
        },
        "invoiceProcessStatus":{
            "type":"string",
            "description":"Invoice Process Status"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Reference Number"
        },
        "invoiceStatus":{
            "type":"string",
            "description":"Invoice Status"
        },
        "invAcceptanceDate":{
            "type":"string",
            "description":"Invoice Acceptance Date"
        },
        "maxFinancePercentage":{
            "type":"number",
            "description":"Maximum Finance Percentage"
        },
        "paidAmount":{
            "type":"number",
            "description":"Paid Amount"
        },
        "paymentStatus":{
            "type":"string",
            "description":"Payment status"
        },
        "preAccepted":{
            "type":"string"
        },
        "poNumber":{
            "type":"string",
            "description":"Po Number"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "programName":{
            "type":"string"
        },
        "reasonCode":{
            "type":"string",
            "description":"Reason code"
        },
        "remarks":{
            "type":"string",
            "description":"Remarks"
        },
        "supplierId":{
            "type":"string",
            "description":"Supplier Id"
        },
        "supplierName":{
            "type":"string",
            "description":"Supplier Name"
        },
        "supplierDivCode":{
            "type":"string",
            "description":"Supplier Division Code"
        },
        "supplierDivName":{
            "type":"string",
            "description":"Supplier Division Name"
        },
        "taxAmount":{
            "type":"number",
            "description":"Tax Amount"
        },
        "totalInvoiceAmount":{
            "type":"number",
            "description":"Total Invoice Amount"
        },
        "paymentTerms":{
            "type":"string"
        },
        "shipmentDate":{
            "type":"string"
        },
        "outstandingAmount":{
            "type":"number"
        },
        "discountAllowed":{
            "type":"string"
        },
        "discountPercentage":{
            "type":"number"
        },
        "discountAmount":{
            "type":"number"
        },
        "taxPercentage":{
            "type":"number"
        },
        "purchaseOrderDate":{
            "type":"string"
        },
        "staleStatus":{
            "type":"string"
        },
        "divisionCode":{
            "type":"string"
        },
        "shipmentAddress":{
            "type":"string"
        },
        "shipmentCountry":{
            "type":"string"
        },
        "shipmentNo":{
            "type":"string"
        },
        "reasonForExport":{
            "type":"string"
        },
        "termsOfSale":{
            "type":"string"
        },
        "countryOfOrigin":{
            "type":"string"
        },
        "miscCharge1":{
            "type":"number"
        },
        "miscCharge1Amount":{
            "type":"number"
        },
        "miscCharge1Desc":{
            "type":"string"
        },
        "miscCharge2":{
            "type":"number"
        },
        "miscCharge2Amount":{
            "type":"number"
        },
        "miscCharge2Desc":{
            "type":"string"
        },
        "netInvoiceAmount":{
            "type":"number"
        },
        "financeableAmount":{
            "type":"number"
        },
        "finTxnStatus":{
            "type":"string"
        },
        "transactionRefNo":{
            "type":"string"
        },
        "relationCode":{
            "type":"string",
            "description":"Relation Code"
        },
        "supplierCode":{
            "type":"string"
        },
        "buyerCode":{
            "type":"string"
        },
        "shipmentRefNo":{
            "type":"string"
        },
        "repayAccountNo":{
            "type":"number"
        },
        "bank":{
            "type":"string"
        },
        "branch":{
            "type":"string"
        },
        "routingCode":{
            "type":"number"
        },
        "isAutoAuth":{
            "type":"string"
        },
        "reasonErrorCode":{
            "type":"string"
        },
        "finEligibilityAmt":{
            "type":"number"
        },
        "reconTxnStatus":{
            "type":"string"
        },
        "reasonForShipment":{
            "type":"string"
        },
        "virtualAcFlag":{
            "type":"string"
        },
        "fundingReqAmt":{
            "type":"number"
        },
        "raisedBy":{
            "type":"string"
        },
        "isFinanced":{
            "type":"string"
        },
        "paymentDueDate":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Returns the collection of the newly created invoices

Root Schema : CreateInvoiceResponseCollection

Type: object

List of Create Invoice Service Response

Show Source

createInvoiceList(optional): array createInvoiceList

{
    "description":"List of Create Invoice Service Response",
    "type":"object",
    "properties":{
        "createInvoiceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CreateInvoiceResponse"
            }
        }
    }
}

Nested Schema : createInvoiceList

Type: array

Show Source

Array of: object CreateInvoiceResponse

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

Nested Schema : CreateInvoiceResponse

Type: object

Show Source

errors(optional): array errors
feedSerialNo(optional): integer(int32)
invoiceId(optional): string
invoiceNumber(optional): string
invoiceProcessStatus(optional): string
invoiceRefNo(optional): string
invoiceStatus(optional): string
sourceTxnId(optional): string
supplierId(optional): string
transactionRefNo(optional): string

{
    "properties":{
        "invoiceNumber":{
            "type":"string"
        },
        "supplierId":{
            "type":"string"
        },
        "invoiceRefNo":{
            "type":"string"
        },
        "invoiceStatus":{
            "type":"string"
        },
        "invoiceProcessStatus":{
            "type":"string"
        },
        "invoiceId":{
            "type":"string"
        },
        "sourceTxnId":{
            "type":"string"
        },
        "transactionRefNo":{
            "type":"string"
        },
        "feedSerialNo":{
            "type":"integer",
            "format":"int32"
        },
        "errors":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errors

Type: array

Show Source

Array of: object Error

Error Model

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

Nested Schema : Error

Type: object

Error Model

Show Source

ecode(optional): string

Error Code
edesc(optional): string

Error Description
etype(optional): string

Error Type

{
    "type":"object",
    "description":"Error Model",
    "properties":{
        "ecode":{
            "type":"string",
            "description":"Error Code"
        },
        "etype":{
            "type":"string",
            "description":"Error Type"
        },
        "edesc":{
            "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