Jump to

• Request
• Response

Updates a Invoice in main table

put

/service/v1/invoice/{invoiceRefNo}

This endpoint is used to updates a main Invoice.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• invoiceRefNo: string
  invoiceRefNo for which data needs to be fetched

Header Parameters

• appId: string
• branchCode: string
• userId: string
  user id for SMS

Body ()

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

Root Schema : InvoiceUpdateModel

Type: object

Invoice Update model

Show Source

• acceptanceAmount(optional): number
  Acceptance Amount
• fundingReqDate(optional): string
  Funding Request Date
• invoiceDueDate(optional): string
  Invoice Due Date
• invoiceRefNo(optional): string
  Invoice Reference Number
• invoiceStatus(optional): string
  Invoice Status
• isAutoAuth(optional): string
  Is Auto Authorized
• newFundingReqDate(optional): string
  New Funding Request Date
• remarks(optional): string
  Remarks
• seqNo(optional): integer(int64)

{
    "description":"Invoice Update model",
    "type":"object",
    "properties":{
        "invoiceStatus":{
            "type":"string",
            "description":"Invoice Status"
        },
        "acceptanceAmount":{
            "type":"number",
            "description":"Acceptance Amount"
        },
        "invoiceDueDate":{
            "type":"string",
            "description":"Invoice Due Date"
        },
        "isAutoAuth":{
            "type":"string",
            "description":"Is Auto Authorized"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Reference Number"
        },
        "remarks":{
            "type":"string",
            "description":"Remarks"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64"
        },
        "fundingReqDate":{
            "type":"string",
            "description":"Funding Request Date"
        },
        "newFundingReqDate":{
            "type":"string",
            "description":"New Funding Request Date"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the body of updated invoice

Body ()

Root Schema : InvoiceModel

Type: object

Invoice model

Show Source

• acceptanceAmount(optional): number
  Acceptance Amount
• action(optional): string
• adjustmentReason(optional): string
• amount(optional): number
  Amount
• amountToBeFinanced(optional): number
• assignmentParty(optional): string
• bank(optional): string
• branch(optional): string
• bunchIdentifier(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
• channel(optional): string
  Channel
• corporateId(optional): string
  CorporateId
• countryOfOrigin(optional): string
• currency(optional): string
  Currency
• discount1Days(optional): integer
  Discount 1 Days
• discount1Perc(optional): number
  Discount 1 Perc
• discount2Days(optional): integer
  Discount 2 Days
• discount2Perc(optional): number
  Discount 2 Perc
• discountAllowed(optional): string
• discountAmount(optional): number
• discountPercentage(optional): number
• discountType(optional): string
• discrepancyCode(optional): string
  Discrepancy Code
• disputedAmount(optional): number
• disputeResolveRemarks(optional): string
  Dispute Resolve Remarks
• divisionCode(optional): string
• expiresOn(optional): string
• exportFactorId(optional): string
  Export Factor Id
• feedSerialNo(optional): integer(int32)
• fileName(optional): string
  File Name
• fileRef(optional): string
  File Reference
• filler1(optional): string
  Filler1
• filler10(optional): string
  Filler10
• filler2(optional): string
  Filler2
• filler3(optional): string
  Filler3
• filler4(optional): string
  Filler4
• filler5(optional): string
  Filler5
• filler6(optional): string
  Filler6
• filler7(optional): string
  Filler7
• filler8(optional): string
  Filler8
• filler9(optional): string
  Filler9
• financeableAmount(optional): number
• financeAmount(optional): number
  Finance Amount
• financeOutstandingAmount(optional): number
  Outstanding Amount
• financePercentage(optional): number
  Finance Percentage
• financeStatus(optional): string
  Finance Status
• finEligibilityAmt(optional): number
• finSeqNo(optional): number
  Finance Sequence Number
• finTxnStatus(optional): string
• fundingReqAmt(optional): number
• fundingReqDate(optional): string
• id(optional): string
• importFactorId(optional): string
• importFactorName(optional): string
• indicator(optional): string
  Indicator
• insuranceCoId(optional): string
• insuranceCoName(optional): string
• interestBearingPartyRole(optional): string
  Interest bearing party role
• invAcceptanceDate(optional): string
  Invoice Acceptance Date
• invoiceCommodityGridList(optional): array invoiceCommodityGridList
• invoiceDate(optional): string
  Invoice Date
• invoiceDueDate(optional): string
  Invoice Due Date
• invoiceId(optional): string
  Id of the Invoice
• invoiceNumber(optional): string
  Invoice Number
• invoiceOfferList(optional): array invoiceOfferList
• invoiceOfferTenorParameterList(optional): array invoiceOfferTenorParameterList
• invoiceProcessStatus(optional): string
  Invoice Process Status
• invoiceRefNo(optional): string
  Invoice Reference Number
• invoiceStatus(optional): string
  Invoice Status
• invoiceValueDate(optional): string
  Invoice Value Date
• isAccepted(optional): string
• isApproved(optional): string
• isAssigned(optional): string
• isAutoAuth(optional): string
• isDisputed(optional): string
  Is Disputed
• isDisputeResolvedWriteOff(optional): string
• isFinanced(optional): string
• isIndirectPayment(optional): string
• isNettingFlag(optional): string
  Neeting Flag to indicate whether netting transaction is on going, Y indicates on going netting transaction
• isOverdue(optional): string
• isPUA(optional): string
• linkedDocs(optional): string
• linkedInvoiceList(optional): array linkedInvoiceList
• linkInvoiceNumber(optional): string
  Coma/Pipe seperated invoice numbers
• makerDtStamp(optional): string
• makerId(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
• newFundingReqDate(optional): string
• oldAcceptanceAmount(optional): number
• oldDisputeAmount(optional): number
• oldExpiryDate(optional): string
• oldFinanceAmount(optional): number
• oldInvoiceDueDate(optional): string
• outstandingAmount(optional): number
• paidAmount(optional): number
  Paid Amount
• paymentCondition(optional): integer
  Payment Condition
• paymentDate(optional): string
• paymentDueDate(optional): string
  Payment Due Date
• paymentMode(optional): string
• paymentParty(optional): string
• paymentStatus(optional): string
  Payment Status
• paymentTerms(optional): string
• paySeqNo(optional): number
  Payment Sequence Number
• poNumber(optional): string
  Po Number
• preAccepted(optional): string
• processingBranchCode(optional): string
• processingDate(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
• reconPmtAmount(optional): number
• reconPmtAmountCcy(optional): string
• reconTxnStatus(optional): string
• relationCode(optional): string
  Relation Code
• remarks(optional): string
  Remarks
• repayAccountNo(optional): string
• routingCode(optional): number
• seqNo(optional): integer(int64)
• shipmentAddress(optional): string
• shipmentCity(optional): string
  Destination City
• shipmentCountry(optional): string
• shipmentDate(optional): string
• shipmentNo(optional): string
• shipmentPhoneNumber(optional): string
  Contact Number of Addressee
• shipmentRefNo(optional): string
• shipmentTaxId(optional): string
  Tax ID
• shipmentZipCode(optional): string
  Destination Zip Code
• shipSeqNo(optional): number
  Shipment Sequence Number
• sourceTxnId(optional): string
• srcAppCd(optional): string
  Source Application Code
• stageId(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
• tcmId(optional): string
• termsOfSale(optional): string
• tmDrCrNoteLinkInvoiceList(optional): array tmDrCrNoteLinkInvoiceList
• totalInvoiceAmount(optional): number
  Total Invoice Amount
• transactionRefNo(optional): string
• validateForOverdue(optional): string
  Whether validation for Overdue required or not
• varianceAmount(optional): number
• virtualAcFlag(optional): string

{
    "description":"Invoice model",
    "type":"object",
    "properties":{
        "srcAppCd":{
            "type":"string",
            "description":"Source Application Code"
        },
        "id":{
            "type":"string"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64"
        },
        "invoiceId":{
            "description":"Id of the Invoice ",
            "type":"string"
        },
        "isNettingFlag":{
            "description":"Neeting Flag to indicate whether netting transaction is on going, Y indicates on going netting transaction",
            "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"
        },
        "filler5":{
            "type":"string",
            "description":"Filler5"
        },
        "filler6":{
            "type":"string",
            "description":"Filler6"
        },
        "filler7":{
            "type":"string",
            "description":"Filler7"
        },
        "filler8":{
            "type":"string",
            "description":"Filler8"
        },
        "filler9":{
            "type":"string",
            "description":"Filler9"
        },
        "filler10":{
            "type":"string",
            "description":"Filler10"
        },
        "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":"string"
        },
        "bank":{
            "type":"string"
        },
        "branch":{
            "type":"string"
        },
        "routingCode":{
            "type":"number"
        },
        "isAutoAuth":{
            "type":"string"
        },
        "reasonErrorCode":{
            "type":"string"
        },
        "isApproved":{
            "type":"string"
        },
        "shipmentCity":{
            "type":"string",
            "description":"Destination City"
        },
        "shipmentZipCode":{
            "type":"string",
            "description":"Destination Zip Code"
        },
        "shipmentPhoneNumber":{
            "type":"string",
            "description":"Contact Number of Addressee"
        },
        "shipmentTaxId":{
            "type":"string",
            "description":"Tax ID"
        },
        "financeStatus":{
            "type":"string",
            "description":"Finance Status"
        },
        "invoiceCommodityGridList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InvoiceCommodityGridModel"
            }
        },
        "finEligibilityAmt":{
            "type":"number"
        },
        "reconTxnStatus":{
            "type":"string"
        },
        "reasonForShipment":{
            "type":"string"
        },
        "virtualAcFlag":{
            "type":"string"
        },
        "fundingReqAmt":{
            "type":"number"
        },
        "raisedBy":{
            "type":"string"
        },
        "processingBranchCode":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "processingDate":{
            "type":"string"
        },
        "paymentDate":{
            "type":"string"
        },
        "disputedAmount":{
            "type":"number"
        },
        "linkedDocs":{
            "type":"string"
        },
        "isFinanced":{
            "type":"string"
        },
        "tcmId":{
            "type":"string"
        },
        "makerId":{
            "type":"string"
        },
        "makerDtStamp":{
            "type":"string"
        },
        "stageId":{
            "type":"string"
        },
        "isAccepted":{
            "type":"string"
        },
        "isDisputeResolvedWriteOff":{
            "type":"string"
        },
        "isAssigned":{
            "type":"string"
        },
        "assignmentParty":{
            "type":"string"
        },
        "isOverdue":{
            "type":"string"
        },
        "oldAcceptanceAmount":{
            "type":"number"
        },
        "oldFinanceAmount":{
            "type":"number"
        },
        "amountToBeFinanced":{
            "type":"number"
        },
        "oldInvoiceDueDate":{
            "type":"string"
        },
        "oldDisputeAmount":{
            "type":"number"
        },
        "sourceTxnId":{
            "type":"string"
        },
        "adjustmentReason":{
            "type":"string"
        },
        "linkInvoiceNumber":{
            "type":"string",
            "description":"Coma/Pipe seperated invoice numbers"
        },
        "paymentDueDate":{
            "type":"string",
            "description":"Payment Due Date"
        },
        "isPUA":{
            "type":"string"
        },
        "isIndirectPayment":{
            "type":"string"
        },
        "paymentParty":{
            "type":"string"
        },
        "importFactorId":{
            "type":"string"
        },
        "importFactorName":{
            "type":"string"
        },
        "insuranceCoId":{
            "type":"string"
        },
        "insuranceCoName":{
            "type":"string"
        },
        "paymentMode":{
            "type":"string"
        },
        "reconPmtAmount":{
            "type":"number"
        },
        "reconPmtAmountCcy":{
            "type":"string"
        },
        "varianceAmount":{
            "type":"number"
        },
        "linkedInvoiceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkedInvoiceModel"
            }
        },
        "invoiceOfferList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InvoiceOfferDTO"
            }
        },
        "feedSerialNo":{
            "type":"integer",
            "format":"int32"
        },
        "expiresOn":{
            "type":"string"
        },
        "fundingReqDate":{
            "type":"string"
        },
        "newFundingReqDate":{
            "type":"string"
        },
        "oldExpiryDate":{
            "type":"string"
        },
        "bunchIdentifier":{
            "type":"string"
        },
        "discountType":{
            "type":"string"
        },
        "invoiceOfferTenorParameterList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InvoiceOfferTenorParameterModel"
            }
        },
        "invoiceValueDate":{
            "type":"string",
            "description":"Invoice Value Date"
        },
        "discount1Days":{
            "type":"integer",
            "description":"Discount 1 Days"
        },
        "discount2Days":{
            "type":"integer",
            "description":"Discount 2 Days"
        },
        "discount1Perc":{
            "type":"number",
            "description":"Discount 1 Perc"
        },
        "discount2Perc":{
            "type":"number",
            "description":"Discount 2 Perc"
        },
        "paymentCondition":{
            "type":"integer",
            "description":"Payment Condition"
        },
        "exportFactorId":{
            "type":"string",
            "description":"Export Factor Id"
        },
        "validateForOverdue":{
            "type":"string",
            "description":"Whether validation for Overdue required or not"
        },
        "shipSeqNo":{
            "type":"number",
            "description":"Shipment Sequence Number"
        },
        "finSeqNo":{
            "type":"number",
            "description":"Finance Sequence Number"
        },
        "paySeqNo":{
            "type":"number",
            "description":"Payment Sequence Number"
        },
        "channel":{
            "type":"string",
            "description":"Channel"
        },
        "corporateId":{
            "type":"string",
            "description":"CorporateId"
        },
        "financeOutstandingAmount":{
            "type":"number",
            "description":"Outstanding Amount"
        },
        "interestBearingPartyRole":{
            "type":"string",
            "description":"Interest bearing party role"
        },
        "tmDrCrNoteLinkInvoiceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TmDrCrNoteLinkInvoiceModel"
            }
        }
    }
}

Nested Schema : invoiceCommodityGridList

Type: array

Show Source

• Array of: object InvoiceCommodityGridModel

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

Nested Schema : invoiceOfferList

Type: array

Show Source

• Array of: object InvoiceOfferDTO

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

Nested Schema : invoiceOfferTenorParameterList

Type: array

Show Source

• Array of: object InvoiceOfferTenorParameterModel

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

Nested Schema : linkedInvoiceList

Type: array

Show Source

• Array of: object LinkedInvoiceModel

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

Nested Schema : tmDrCrNoteLinkInvoiceList

Type: array

Show Source

• Array of: object TmDrCrNoteLinkInvoiceModel
  Model for TmDrCrNoteLinkInvoice

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

Nested Schema : InvoiceCommodityGridModel

Type: object

Show Source

• ccy(optional): string
• commodityCode(optional): string
  Commodity Code
• commodityDesc(optional): string
• commodityName(optional): string
• costPerUnit(optional): number
  Cost Per unit
• descriptionOfGoods(optional): string
• discountAmount(optional): number
• discountPercentage(optional): number
• id(optional): string
• invoiceCommodityGridId(optional): string
  Read Only: true

  Id of the Invoice Commodity Grid
• invoiceMasterId(optional): string
  Invoice Master Id
• invoiceNumber(optional): string
  Invoice Number
• invoiceRefNo(optional): string
  Invoice Reference Number
• isInherited(optional): string
• netCost(optional): number
  Net Cost
• quantity(optional): number
  Quantity
• seqNo(optional): integer(int64)
• taxAmount(optional): number
  Tax Amount
• taxPercentage(optional): number
• totalCost(optional): number
  Total Cost
• totalWeight(optional): number
• transactionRefNo(optional): string
• unit(optional): string
• unitWeight(optional): number

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64"
        },
        "commodityCode":{
            "type":"string",
            "description":"Commodity Code"
        },
        "quantity":{
            "type":"number",
            "description":"Quantity"
        },
        "commodityName":{
            "type":"string"
        },
        "commodityDesc":{
            "type":"string"
        },
        "costPerUnit":{
            "type":"number",
            "description":"Cost Per unit"
        },
        "totalCost":{
            "type":"number",
            "description":"Total Cost"
        },
        "taxAmount":{
            "type":"number",
            "description":"Tax Amount"
        },
        "netCost":{
            "type":"number",
            "description":"Net Cost"
        },
        "invoiceCommodityGridId":{
            "description":"Id of the Invoice Commodity Grid",
            "type":"string",
            "readOnly":true
        },
        "invoiceNumber":{
            "type":"string",
            "description":"Invoice Number"
        },
        "invoiceMasterId":{
            "type":"string",
            "description":"Invoice Master Id"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Reference Number"
        },
        "descriptionOfGoods":{
            "type":"string"
        },
        "totalWeight":{
            "type":"number"
        },
        "unitWeight":{
            "type":"number"
        },
        "ccy":{
            "type":"string"
        },
        "discountPercentage":{
            "type":"number"
        },
        "discountAmount":{
            "type":"number"
        },
        "taxPercentage":{
            "type":"number"
        },
        "unit":{
            "type":"string"
        },
        "transactionRefNo":{
            "type":"string"
        },
        "isInherited":{
            "type":"string"
        }
    }
}

Nested Schema : InvoiceOfferDTO

Type: object

Show Source

• applicabilityBasis(optional): string
  Applicability Basis
• chgPriceTemplateId(optional): string
  Charge Price Template Id
• currency(optional): string
  Currency
• discountAmount(optional): number
  Discount Amount
• discountOfferActiveStatus(optional): string
  Discount Offer Active Status
• discountOfferStatus(optional): string
  Discount Offer Status
• discountPercentage(optional): number
  Discount Percentage
• discountRuleDesc(optional): string
  Discount Rule Desc
• discountRuleId(optional): string
  Discount Rule Id
• earlyPaymentDate(optional): string
  Early Payment Date
• id(optional): string
  Id
• invoiceMasterId(optional): string
  Invoice Master id
• invoiceOfferAction(optional): string
  Invoice Offer Action
• invoiceRefNo(optional): string
  Invoice Reference No
• isDiscOfferAccepted(optional): string
  Is Discount Offer Accepted
• notionalEarlyPayAmt(optional): number
  Notional Early Pay Amount
• requestorPartyId(optional): string
  Requestor Party Id
• requestorPartyRole(optional): string
  Requestor Party Role
• seqNo(optional): integer(int64)
  Sequence Number
• transactionRefNo(optional): string
  Transaction Reference No

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"Sequence Number"
        },
        "earlyPaymentDate":{
            "type":"string",
            "description":"Early Payment Date"
        },
        "discountPercentage":{
            "type":"number",
            "description":"Discount Percentage"
        },
        "discountAmount":{
            "type":"number",
            "description":"Discount Amount"
        },
        "notionalEarlyPayAmt":{
            "type":"number",
            "description":"Notional Early Pay Amount"
        },
        "discountRuleId":{
            "type":"string",
            "description":"Discount Rule Id"
        },
        "discountRuleDesc":{
            "type":"string",
            "description":"Discount Rule Desc"
        },
        "requestorPartyRole":{
            "type":"string",
            "description":"Requestor Party Role"
        },
        "chgPriceTemplateId":{
            "type":"string",
            "description":"Charge Price Template Id"
        },
        "currency":{
            "type":"string",
            "description":"Currency"
        },
        "discountOfferStatus":{
            "type":"string",
            "description":"Discount Offer Status"
        },
        "discountOfferActiveStatus":{
            "type":"string",
            "description":"Discount Offer Active Status"
        },
        "requestorPartyId":{
            "type":"string",
            "description":"Requestor Party Id"
        },
        "isDiscOfferAccepted":{
            "type":"string",
            "description":"Is Discount Offer Accepted"
        },
        "applicabilityBasis":{
            "type":"string",
            "description":"Applicability Basis"
        },
        "invoiceOfferAction":{
            "type":"string",
            "description":"Invoice Offer Action"
        },
        "transactionRefNo":{
            "type":"string",
            "description":"Transaction Reference No"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Reference No"
        },
        "invoiceMasterId":{
            "type":"string",
            "description":"Invoice Master id"
        }
    }
}

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 : LinkedInvoiceModel

Type: object

Show Source

• currency(optional): string
• invoiceAmount(optional): number
• invoiceDate(optional): string
• invoiceDueDate(optional): string
• invoiceNumber(optional): string
• invoiceRefNo(optional): string
• invoiceStatus(optional): string
• miscCharge1Amount(optional): number
• miscCharge2Amount(optional): number
• paymentStatus(optional): string

{
    "type":"object",
    "properties":{
        "invoiceNumber":{
            "type":"string"
        },
        "invoiceRefNo":{
            "type":"string"
        },
        "invoiceAmount":{
            "type":"number"
        },
        "miscCharge1Amount":{
            "type":"number"
        },
        "miscCharge2Amount":{
            "type":"number"
        },
        "invoiceDate":{
            "type":"string"
        },
        "invoiceDueDate":{
            "type":"string"
        },
        "invoiceStatus":{
            "type":"string"
        },
        "paymentStatus":{
            "type":"string"
        },
        "currency":{
            "type":"string"
        }
    }
}

Nested Schema : TmDrCrNoteLinkInvoiceModel

Type: object

Model for TmDrCrNoteLinkInvoice

Show Source

• creditNotes(optional): array creditNotes
  creditNotes
• dcLinkId(optional): string
  Debit Credit Link Id
• financeRefNo(optional): string
  financeRefNo
• invoiceNumber(optional): string
  Invoice Number
• isAccountingApplicable(optional): string
  isAccountingApplicable
• isDnCn(optional): string
  Is DnCn
• isLimitsApplicable(optional): string
  isLimitsApplicable
• noteNumber(optional): string
  Note Number
• payments(optional): array payments
  payments
• reconTxnRefNo(optional): string
  reconTxnRefNo
• seqNo(optional): integer(int64)
  Sequence number
• status(optional): string
  status
• transactionRefNo(optional): string
  Transaction Reference Number

{
    "description":"Model for TmDrCrNoteLinkInvoice",
    "type":"object",
    "properties":{
        "dcLinkId":{
            "type":"string",
            "description":"Debit Credit Link Id"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"Sequence number"
        },
        "noteNumber":{
            "type":"string",
            "description":"Note Number"
        },
        "invoiceNumber":{
            "type":"string",
            "description":"Invoice Number"
        },
        "isDnCn":{
            "type":"string",
            "description":"Is DnCn"
        },
        "status":{
            "type":"string",
            "description":"status"
        },
        "transactionRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "payments":{
            "description":"payments",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfPaymentDTO"
            }
        },
        "creditNotes":{
            "description":"creditNotes",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CreditNoteModel"
            }
        },
        "reconTxnRefNo":{
            "type":"string",
            "description":"reconTxnRefNo"
        },
        "financeRefNo":{
            "type":"string",
            "description":"financeRefNo"
        },
        "isAccountingApplicable":{
            "type":"string",
            "description":"isAccountingApplicable"
        },
        "isLimitsApplicable":{
            "type":"string",
            "description":"isLimitsApplicable"
        }
    }
}

Nested Schema : creditNotes

Type: array

creditNotes

Show Source

• Array of: object CreditNoteModel
  Credit Note Model

{
    "description":"creditNotes",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CreditNoteModel"
    }
}

Nested Schema : payments

Type: array

payments

Show Source

• Array of: object ScfPaymentDTO
  Payment details for Payments Model

{
    "description":"payments",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScfPaymentDTO"
    }
}

Nested Schema : CreditNoteModel

Type: object

Credit Note Model

Show Source

• action(optional): string
  action
• adjustmentReason(optional): string
  Adjustment Reason
• amount(optional): number
  Base Cn amount
• buyerCode(optional): string
  Buyer Code
• buyerDivCode(optional): string
  Buyer Division Code
• buyerDivName(optional): string
  Buyer Division Name
• buyerId(optional): string
  Buyer Id
• buyerName(optional): string
  Buyer Name
• cnDate(optional): string
  Cn Date
• cnExpiryDate(optional): string
  Cn Expiry Date
• cnNumber(optional): string
  Credit Note Reference Number
• cnReconcilationStatus(optional): string
  Cn Reconcilation Status
• cnStatus(optional): string
  Cn Status
• commodityGridList(optional): array commodityGridList
• creditNoteId(optional): string
  Credit Note generated Id
• creditNoteRefNo(optional): string
  Credit Note System generated RefNo
• currency(optional): string
  Currency
• discountAmount(optional): number
  Discount Amount
• discountPercentage(optional): number
  Discount Percentage
• expiresOn(optional): string
  expiresOn
• fileName(optional): string
  File Name
• filler1(optional): string
  Filler1
• filler10(optional): string
  Filler10
• filler2(optional): string
  Filler2
• filler3(optional): string
  Filler3
• filler4(optional): string
  Filler4
• filler5(optional): string
  Filler5
• filler6(optional): string
  Filler6
• filler7(optional): string
  Filler7
• filler8(optional): string
  Filler8
• filler9(optional): string
  Filler9
• isAutoAuth(optional): string
  Is Auto Authorized
• isAutoReconcile(optional): string
  Is Auto Authorized
• isRecon(optional): string
  isRecon
• isTxnCreationReqd(optional): string
  is txn creation required
• linkedInvoiceList(optional): array linkedInvoiceList
• linkInvoiceNumber(optional): string
  Pipe seperated invoice numbers
• makerDtStamp(optional): string
  Maker Date Stamp
• makerId(optional): string
  Maker Id
• matchedAmount(optional): number
  Matched Amount
• miscCharge1Amount(optional): number
  Miscellaneous Charge1 Amount
• miscCharge1Desc(optional): string
  Miscellaneous Charge1 Description
• miscCharge2Amount(optional): number
  Miscellaneous Charge2 Amount
• miscCharge2Desc(optional): string
  Miscellaneous Charge2 Description
• netAmount(optional): number
  Net Cn amount
• procBranchCode(optional): string
  Proc Branch Code
• procBranchDate(optional): string
  Proc Branch Date
• programCode(optional): string
  Program Code
• programName(optional): string
  Program Name
• reasonCode(optional): string
  Reason Code
• reasonErrorCode(optional): string
  Reason Error Code
• reconciledPmtAmt(optional): number
  reconciledPmtAmt
• reconTxnStatus(optional): string
  Recon Transaction Status
• relationCode(optional): string
  Relation Code
• remarks(optional): string
  Remarks
• seqNo(optional): integer(int64)
  seqNo
• sourceTxnId(optional): string
  Source Transaction Id
• srcAppCd(optional): string
  Source Application Code
• stageId(optional): string
  Stage Id
• supplierCode(optional): string
  Supplier code
• 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
  Tax Percentage
• totalAmount(optional): number
  Total Cn amount
• transactionRefNo(optional): string
  Transaction Reference Number
• unmatchedAmount(optional): number
  Unmatched Amount

{
    "description":"Credit Note Model",
    "type":"object",
    "properties":{
        "srcAppCd":{
            "type":"string",
            "description":"Source Application Code"
        },
        "creditNoteRefNo":{
            "type":"string",
            "description":"Credit Note System generated RefNo"
        },
        "creditNoteId":{
            "type":"string",
            "description":"Credit Note generated Id"
        },
        "cnNumber":{
            "type":"string",
            "description":"Credit Note Reference Number"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"seqNo"
        },
        "cnDate":{
            "type":"string",
            "description":"Cn Date"
        },
        "cnExpiryDate":{
            "type":"string",
            "description":"Cn Expiry Date"
        },
        "linkInvoiceNumber":{
            "type":"string",
            "description":"Pipe seperated invoice numbers"
        },
        "supplierId":{
            "type":"string",
            "description":"Supplier Id"
        },
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "supplierName":{
            "type":"string",
            "description":"Supplier Name"
        },
        "supplierDivCode":{
            "type":"string",
            "description":"Supplier Division Code"
        },
        "supplierDivName":{
            "type":"string",
            "description":"Supplier Division Name"
        },
        "buyerName":{
            "type":"string",
            "description":"Buyer Name"
        },
        "buyerDivCode":{
            "type":"string",
            "description":"Buyer Division Code"
        },
        "buyerDivName":{
            "type":"string",
            "description":"Buyer Division Name"
        },
        "relationCode":{
            "type":"string",
            "description":"Relation Code"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "programName":{
            "type":"string",
            "description":"Program Name"
        },
        "adjustmentReason":{
            "type":"string",
            "description":"Adjustment Reason"
        },
        "remarks":{
            "type":"string",
            "description":"Remarks"
        },
        "currency":{
            "type":"string",
            "description":"Currency"
        },
        "amount":{
            "type":"number",
            "description":"Base Cn amount"
        },
        "totalAmount":{
            "type":"number",
            "description":"Total Cn amount"
        },
        "netAmount":{
            "type":"number",
            "description":"Net Cn amount"
        },
        "taxAmount":{
            "type":"number",
            "description":"Tax Amount"
        },
        "discountPercentage":{
            "type":"number",
            "description":"Discount Percentage"
        },
        "discountAmount":{
            "type":"number",
            "description":"Discount Amount"
        },
        "taxPercentage":{
            "type":"number",
            "description":"Tax Percentage"
        },
        "fileName":{
            "type":"string",
            "description":"File Name"
        },
        "reasonCode":{
            "type":"string",
            "description":"Reason Code"
        },
        "reasonErrorCode":{
            "type":"string",
            "description":"Reason Error Code"
        },
        "filler1":{
            "type":"string",
            "description":"Filler1"
        },
        "filler2":{
            "type":"string",
            "description":"Filler2"
        },
        "filler3":{
            "type":"string",
            "description":"Filler3"
        },
        "filler4":{
            "type":"string",
            "description":"Filler4"
        },
        "filler5":{
            "type":"string",
            "description":"Filler5"
        },
        "filler6":{
            "type":"string",
            "description":"Filler6"
        },
        "filler7":{
            "type":"string",
            "description":"Filler7"
        },
        "filler8":{
            "type":"string",
            "description":"Filler8"
        },
        "filler9":{
            "type":"string",
            "description":"Filler9"
        },
        "filler10":{
            "type":"string",
            "description":"Filler10"
        },
        "cnStatus":{
            "type":"string",
            "description":"Cn Status"
        },
        "cnReconcilationStatus":{
            "type":"string",
            "description":"Cn Reconcilation Status"
        },
        "transactionRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "buyerCode":{
            "type":"string",
            "description":"Buyer Code"
        },
        "supplierCode":{
            "type":"string",
            "description":"Supplier code"
        },
        "sourceTxnId":{
            "type":"string",
            "description":"Source Transaction Id"
        },
        "makerId":{
            "type":"string",
            "description":"Maker Id"
        },
        "makerDtStamp":{
            "type":"string",
            "description":"Maker Date Stamp"
        },
        "miscCharge1Amount":{
            "type":"number",
            "description":"Miscellaneous Charge1 Amount"
        },
        "miscCharge1Desc":{
            "type":"string",
            "description":"Miscellaneous Charge1 Description"
        },
        "miscCharge2Amount":{
            "type":"number",
            "description":"Miscellaneous Charge2 Amount"
        },
        "miscCharge2Desc":{
            "type":"string",
            "description":"Miscellaneous Charge2 Description"
        },
        "matchedAmount":{
            "type":"number",
            "description":"Matched Amount"
        },
        "unmatchedAmount":{
            "type":"number",
            "description":"Unmatched Amount"
        },
        "procBranchCode":{
            "type":"string",
            "description":"Proc Branch Code"
        },
        "procBranchDate":{
            "type":"string",
            "description":"Proc Branch Date"
        },
        "stageId":{
            "type":"string",
            "description":"Stage Id"
        },
        "action":{
            "type":"string",
            "description":"action"
        },
        "reconTxnStatus":{
            "type":"string",
            "description":"Recon Transaction Status"
        },
        "isAutoAuth":{
            "type":"string",
            "description":"Is Auto Authorized"
        },
        "isAutoReconcile":{
            "type":"string",
            "description":"Is Auto Authorized"
        },
        "isTxnCreationReqd":{
            "type":"string",
            "description":"is txn creation required"
        },
        "commodityGridList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CnCommodityGridModel"
            }
        },
        "linkedInvoiceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkedInvoiceModel"
            }
        },
        "reconciledPmtAmt":{
            "type":"number",
            "description":"reconciledPmtAmt"
        },
        "isRecon":{
            "type":"string",
            "description":"isRecon"
        },
        "expiresOn":{
            "type":"string",
            "description":"expiresOn"
        }
    }
}

Nested Schema : commodityGridList

Type: array

Show Source

• Array of: object CnCommodityGridModel

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

Nested Schema : linkedInvoiceList

Type: array

Show Source

• Array of: object LinkedInvoiceModel

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

Nested Schema : CnCommodityGridModel

Type: object

Show Source

• commodityCode(optional): string
  Commodity Code
• commodityDesc(optional): string
  Commodity Description
• commodityName(optional): string
  Commodity Name
• costPerUnit(optional): number
  Cost Per Unit
• creditNoteRefNo(optional): string
  Credit Note Reference Number
• currency(optional): string
  Currency
• descriptionOfGoods(optional): string
  Description of Goods
• discountAmount(optional): number
  Discount Amount
• discountPercentage(optional): number
  Discount Percentage
• id(optional): string
  id
• invoiceNumber(optional): string
  Invoice Number
• netCost(optional): number
  Net cost
• quantity(optional): number
  Quantity
• seqNo(optional): integer(int64)
  seqNo
• taxAmount(optional): number
  Tax Amount
• taxPercentage(optional): number
  Tax Percentage
• totalCost(optional): number
  Total Cost
• totalWeight(optional): number
  Total weight
• transactionRefNo(optional): string
  Transaction Reference Number
• unit(optional): string
  Unit
• unitWeight(optional): number
  Unit Weight

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"seqNo"
        },
        "commodityCode":{
            "type":"string",
            "description":"Commodity Code"
        },
        "commodityName":{
            "type":"string",
            "description":"Commodity Name"
        },
        "currency":{
            "type":"string",
            "description":"Currency"
        },
        "commodityDesc":{
            "type":"string",
            "description":"Commodity Description"
        },
        "descriptionOfGoods":{
            "type":"string",
            "description":"Description of Goods"
        },
        "unit":{
            "type":"string",
            "description":"Unit"
        },
        "invoiceNumber":{
            "type":"string",
            "description":"Invoice Number"
        },
        "creditNoteRefNo":{
            "type":"string",
            "description":"Credit Note Reference Number"
        },
        "transactionRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "discountAmount":{
            "type":"number",
            "description":"Discount Amount"
        },
        "discountPercentage":{
            "type":"number",
            "description":"Discount Percentage"
        },
        "taxAmount":{
            "type":"number",
            "description":"Tax Amount"
        },
        "taxPercentage":{
            "type":"number",
            "description":"Tax Percentage"
        },
        "costPerUnit":{
            "type":"number",
            "description":"Cost Per Unit"
        },
        "totalCost":{
            "type":"number",
            "description":"Total Cost"
        },
        "netCost":{
            "type":"number",
            "description":"Net cost"
        },
        "quantity":{
            "type":"number",
            "description":"Quantity"
        },
        "unitWeight":{
            "type":"number",
            "description":"Unit Weight"
        },
        "totalWeight":{
            "type":"number",
            "description":"Total weight"
        }
    }
}

Nested Schema : ScfPaymentDTO

Type: object

Payment details for Payments Model

Show Source

• accOwner(optional): string
  accOwner
• allocatedAmt(optional): number
  allocatedAmt
• allocationRequired(optional): string
  allocationRequired
• allocStatus(optional): string
  allocStatus
• autoReconcile(optional): string
  Auto Reconcile
• bankCode(optional): string
  Bank Code
• beneficiaryCode(optional): string
  Beneficiary Code
• beneficiaryId(optional): string
  Beneficiary Id
• beneficiaryName(optional): string
  Beneficiary Id
• beneficiaryRole(optional): string
  beneficiaryRole
• counterpartyCode(optional): string
  Counterparty Code
• counterpartyId(optional): string
  Counterparty Id
• counterpartyName(optional): string
  counterpartyName
• counterpartyRole(optional): string
  counterpartyRole
• creditAccNo(optional): string
  Credit Account Number
• creditNoteRefNo(optional): string
  Credit Note Reference Number
• dcIndicator(optional): string
  Dc Indicator
• derivedFlag(optional): string
  derivedFlag
• eftRefNo(optional): string
  Eft Reference Number
• entityRefNo(optional): string
  Entity Reference Number
• errorDesc(optional): string
  errorDesc
• excessHandling(optional): string
  excessHandling
• excessRefundParty(optional): string
  excessRefundParty
• excessRefundPartyId(optional): string
  excessRefundPartyId
• excessRefundPaymentMode(optional): string
  excessRefundPaymentMode
• fileName(optional): string
  File Name
• filler1(optional): string
  Filler 1
• filler10(optional): string
  Filler 10
• filler2(optional): string
  Filler 2
• filler3(optional): string
  Filler 3
• filler4(optional): string
  Filler 4
• filler5(optional): string
  Filler 5
• filler6(optional): string
  Filler 6
• filler7(optional): string
  Filler 7
• filler8(optional): string
  Filler 8
• filler9(optional): string
  Filler 9
• financeReferenceNo(optional): string
  financeReferenceNo
• flag(optional): string
  Flag
• genericAppropriation(optional): string
  Generic Appropriation
• indicator(optional): string
  Indicator
• instrumentBank(optional): string
  Instrument Bank
• instrumentBranch(optional): string
  Instrument Branch
• instrumentDate(optional): string
  Instrument Date
• isAutoAuth(optional): string
  isAutoAuth
• isIndirectPayment(optional): string
  isIndirectPayment
• isPUA(optional): string
  isPUA
• isRecon(optional): string
  isRecon
• lastActionPerformed(optional): string
  Last Action Performed
• mandateRefNo(optional): string
  Mandate Reference Number
• matchedAmount(optional): number
  matchedAmount
• parentPaymentRefNo(optional): string
  parentPaymentRefNo
• partyPaymentCode(optional): string
  Party Payment Code
• paymentAmount(optional): number
  Payment Amount
• paymentBusinessDate(optional): string
  paymentBusinessDate
• paymentCurrency(optional): string
  Payment Currency
• paymentDate(optional): string
  Payment Date
• paymentMode(optional): string
  Payment Mode
• paymentNumber(optional): string
  Payment Number
• paymentPartyCategory(optional): string
  paymentPartyCategory
• paymentPartyId(optional): string
  Payment Party id
• paymentPartyName(optional): string
• paymentPartyRole(optional): string
  paymentPartyRole
• paymentProcessStatus(optional): string
  Payment Process Status
• paymentRefNo(optional): string
  Payment Reference Number
• paymentStatus(optional): string
  Payment Status
• procBranchCode(optional): string
  procBranchCode
• procBranchDate(optional): string
  procBranchDate
• programCode(optional): string
  Program Code
• reasonCode(optional): string
  Reason Code
• reconciledPmtAmt(optional): number
  reconciledPmtAmt
• reconTxnStatus(optional): string
  reconTxnStatus
• refundAmount(optional): number
  refundAmount
• relationshipCode(optional): string
  relationshipCode
• remarks(optional): string
  Remarks
• remitterAccNo(optional): string
  Remitter Account Number
• seqNo(optional): integer(int64)
  seqNo
• sourceTxnId(optional): string
  Recon Txn Number
• specificAppropriation(optional): string
  Specific Appropriation
• stageId(optional): string
  stageId
• totalAllocatedAmt(optional): number
  totalAllocatedAmt
• transactionRefNo(optional): string
  transactionRefNo
• transactionStatus(optional): string
  transactionStatus
• unallocatedAmt(optional): number
  unallocatedAmt
• unmatchedAmount(optional): number
  unmatchedAmount
• virtualAcFlag(optional): string
  virtualAcFlag

{
    "description":"Payment details for Payments Model",
    "type":"object",
    "properties":{
        "autoReconcile":{
            "type":"string",
            "description":"Auto Reconcile"
        },
        "bankCode":{
            "type":"string",
            "description":"Bank Code"
        },
        "beneficiaryCode":{
            "type":"string",
            "description":"Beneficiary Code"
        },
        "beneficiaryId":{
            "type":"string",
            "description":"Beneficiary Id"
        },
        "beneficiaryName":{
            "type":"string",
            "description":"Beneficiary Id"
        },
        "counterpartyId":{
            "type":"string",
            "description":"Counterparty Id"
        },
        "counterpartyName":{
            "type":"string",
            "description":"counterpartyName"
        },
        "counterpartyCode":{
            "type":"string",
            "description":"Counterparty Code"
        },
        "creditAccNo":{
            "type":"string",
            "description":"Credit Account Number"
        },
        "creditNoteRefNo":{
            "type":"string",
            "description":"Credit Note Reference Number"
        },
        "dcIndicator":{
            "type":"string",
            "description":"Dc Indicator"
        },
        "eftRefNo":{
            "type":"string",
            "description":"Eft Reference Number"
        },
        "entityRefNo":{
            "type":"string",
            "description":"Entity Reference Number"
        },
        "filler1":{
            "type":"string",
            "description":"Filler 1"
        },
        "filler2":{
            "type":"string",
            "description":"Filler 2"
        },
        "filler3":{
            "type":"string",
            "description":"Filler 3"
        },
        "filler4":{
            "type":"string",
            "description":"Filler 4"
        },
        "filler5":{
            "type":"string",
            "description":"Filler 5"
        },
        "filler6":{
            "type":"string",
            "description":"Filler 6"
        },
        "filler7":{
            "type":"string",
            "description":"Filler 7"
        },
        "filler8":{
            "type":"string",
            "description":"Filler 8"
        },
        "filler9":{
            "type":"string",
            "description":"Filler 9"
        },
        "filler10":{
            "type":"string",
            "description":"Filler 10"
        },
        "flag":{
            "type":"string",
            "description":"Flag"
        },
        "genericAppropriation":{
            "type":"string",
            "description":"Generic Appropriation"
        },
        "specificAppropriation":{
            "type":"string",
            "description":"Specific Appropriation"
        },
        "indicator":{
            "type":"string",
            "description":"Indicator"
        },
        "instrumentBank":{
            "type":"string",
            "description":"Instrument Bank"
        },
        "instrumentBranch":{
            "type":"string",
            "description":"Instrument Branch"
        },
        "instrumentDate":{
            "type":"string",
            "description":"Instrument Date"
        },
        "mandateRefNo":{
            "type":"string",
            "description":"Mandate Reference Number"
        },
        "paymentAmount":{
            "type":"number",
            "description":"Payment Amount"
        },
        "paymentCurrency":{
            "type":"string",
            "description":"Payment Currency"
        },
        "paymentDate":{
            "type":"string",
            "description":"Payment Date"
        },
        "paymentMode":{
            "type":"string",
            "description":"Payment Mode"
        },
        "paymentNumber":{
            "type":"string",
            "description":"Payment Number"
        },
        "partyPaymentCode":{
            "type":"string",
            "description":"Party Payment Code"
        },
        "paymentPartyId":{
            "type":"string",
            "description":"Payment Party id"
        },
        "paymentPartyName":{
            "type":"string"
        },
        "paymentProcessStatus":{
            "type":"string",
            "description":"Payment Process Status"
        },
        "paymentRefNo":{
            "type":"string",
            "description":"Payment Reference Number"
        },
        "paymentStatus":{
            "type":"string",
            "description":"Payment Status"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "remarks":{
            "type":"string",
            "description":"Remarks"
        },
        "remitterAccNo":{
            "type":"string",
            "description":"Remitter Account Number"
        },
        "fileName":{
            "type":"string",
            "description":"File Name"
        },
        "reasonCode":{
            "type":"string",
            "description":"Reason Code"
        },
        "lastActionPerformed":{
            "type":"string",
            "description":"Last Action Performed"
        },
        "matchedAmount":{
            "type":"number",
            "description":"matchedAmount"
        },
        "unmatchedAmount":{
            "type":"number",
            "description":"unmatchedAmount"
        },
        "reconTxnStatus":{
            "type":"string",
            "description":"reconTxnStatus"
        },
        "isAutoAuth":{
            "type":"string",
            "description":"isAutoAuth"
        },
        "virtualAcFlag":{
            "type":"string",
            "description":"virtualAcFlag"
        },
        "paymentBusinessDate":{
            "type":"string",
            "description":"paymentBusinessDate"
        },
        "counterpartyRole":{
            "type":"string",
            "description":"counterpartyRole"
        },
        "beneficiaryRole":{
            "type":"string",
            "description":"beneficiaryRole"
        },
        "paymentPartyRole":{
            "type":"string",
            "description":"paymentPartyRole"
        },
        "relationshipCode":{
            "type":"string",
            "description":"relationshipCode"
        },
        "errorDesc":{
            "type":"string",
            "description":"errorDesc"
        },
        "paymentPartyCategory":{
            "type":"string",
            "description":"paymentPartyCategory"
        },
        "derivedFlag":{
            "type":"string",
            "description":"derivedFlag"
        },
        "allocationRequired":{
            "type":"string",
            "description":"allocationRequired"
        },
        "allocStatus":{
            "type":"string",
            "description":"allocStatus"
        },
        "allocatedAmt":{
            "type":"number",
            "description":"allocatedAmt"
        },
        "unallocatedAmt":{
            "type":"number",
            "description":"unallocatedAmt"
        },
        "accOwner":{
            "type":"string",
            "description":"accOwner"
        },
        "procBranchCode":{
            "type":"string",
            "description":"procBranchCode"
        },
        "procBranchDate":{
            "type":"string",
            "description":"procBranchDate"
        },
        "transactionRefNo":{
            "type":"string",
            "description":"transactionRefNo"
        },
        "transactionStatus":{
            "type":"string",
            "description":"transactionStatus"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"seqNo"
        },
        "isPUA":{
            "type":"string",
            "description":"isPUA"
        },
        "isIndirectPayment":{
            "type":"string",
            "description":"isIndirectPayment"
        },
        "sourceTxnId":{
            "type":"string",
            "description":"Recon Txn Number"
        },
        "reconciledPmtAmt":{
            "type":"number",
            "description":"reconciledPmtAmt"
        },
        "totalAllocatedAmt":{
            "type":"number",
            "description":"totalAllocatedAmt"
        },
        "isRecon":{
            "type":"string",
            "description":"isRecon"
        },
        "financeReferenceNo":{
            "type":"string",
            "description":"financeReferenceNo"
        },
        "excessHandling":{
            "type":"string",
            "description":"excessHandling"
        },
        "excessRefundParty":{
            "type":"string",
            "description":"excessRefundParty"
        },
        "excessRefundPartyId":{
            "type":"string",
            "description":"excessRefundPartyId"
        },
        "excessRefundPaymentMode":{
            "type":"string",
            "description":"excessRefundPaymentMode"
        },
        "parentPaymentRefNo":{
            "type":"string",
            "description":"parentPaymentRefNo"
        },
        "refundAmount":{
            "type":"number",
            "description":"refundAmount"
        },
        "stageId":{
            "type":"string",
            "description":"stageId"
        }
    }
}

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

Back to Top