Jump to

• Request
• Response

Retrieves the list of existing debit notes

get

/service/v1/debitNoteSearch

This endpoint is used to get the list of existing debit notes.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• anchorId(optional): string
• assignmentParty(optional): string
• buyerDivCode(optional): string
• buyerId(optional): string
• buyerName(optional): string
• currency(optional): string
• debitNoteAmountFrom(optional): number
• debitNoteAmountTo(optional): number
• debitNoteDateFrom(optional): string
• debitNoteDateTo(optional): string
• debitNoteDueDateFrom(optional): string
• debitNoteDueDateTo(optional): string
• debitNoteId: string
• debitNoteNumber(optional): string
• debitNoteProcessStatus(optional): string
• debitNoteRefNo(optional): string
• debitNoteStatus(optional): string
• fileName(optional): string
• fileRef(optional): string
• isAccepted(optional): string
• isAssigned(optional): string
• isDisputeResolvedWriteOff(optional): string
• isDisputed(optional): string
• isFinanced(optional): string
• isOverdue(optional): string
• limit(optional): integer
  limit is maximum no of records to be fetched
• linkInvoiceNumber(optional): string
  Coma/Pipe seperated invoice numbers
• linkedProgram(optional): string
• offset(optional): integer
  offset is starting no of records to be fetched
• outstandingAmountFrom(optional): number
• outstandingAmountTo(optional): number
• paidAmountFrom(optional): number
• paidAmountTo(optional): number
• paymentStatus(optional): string
• programCode(optional): string
• recordStat(optional): string
• relationCode(optional): string
• sourceTxnId(optional): string
• spokeId(optional): string
• srcAppCd(optional): string
• staleStatus(optional): string
• status: string
• supplierDivCode(optional): string
• supplierId(optional): string
• supplierName(optional): string
• transactionRefNo: string

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : ServiceDebitNoteResponse

Type: object

Collection of Debit notes.

Show Source

• debitNoteList(optional): array debitNoteList
• paging(optional): object paging

{
    "description":"Collection of Debit notes.",
    "type":"object",
    "properties":{
        "debitNoteList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DebitNoteModelResponse"
            }
        },
        "paging":{
            "type":"object"
        }
    }
}

Nested Schema : debitNoteList

Type: array

Show Source

• Array of: object DebitNoteModelResponse
  Service Get API Debit Note model

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

Nested Schema : paging

Type: object

Nested Schema : DebitNoteModelResponse

Type: object

Service Get API Debit Note model

Show Source

• acceptanceAmount(optional): number
  Acceptance Amount
• action(optional): string
• adjustmentReason(optional): string
• amount(optional): number
  Amount
• anchorId(optional): string
  Anchor id
• assignmentParty(optional): string
  Assignment Party
• bank(optional): string
• borrower(optional): string
  Borrower
• branch(optional): string
• buyerAddress(optional): array buyerAddress
• 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
• countryOfOrigin(optional): string
• currency(optional): string
  Currency
• debitNoteDate(optional): string
  Debit Note Date
• debitNoteDueDate(optional): string
  Debit Note Due Date
• debitNoteId(optional): string
  Id of the debit note
• debitNoteNumber(optional): string
  Debit Note Number
• debitNoteProcessStatus(optional): string
  Debit Note Process Status
• debitNoteRefNo(optional): string
  Debit Note Reference Number
• debitNoteStatus(optional): string
  Debit Note Status
• discountAllowed(optional): string
• discountAmount(optional): number
• discountPercentage(optional): number
• discrepancyCode(optional): string
  Discrepancy Code
• disputedAmount(optional): number
• disputeResolveRemarks(optional): string
  Dispute Resolve Remarks
• divisionCode(optional): string
• dNoteAcceptanceDate(optional): string
  Debit Note Acceptance Date
• 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
• financePercentage(optional): number
• finTxnStatus(optional): string
• fundingReqAmt(optional): number
• fundingReqDate(optional): string
• id(optional): string
• indicator(optional): string
  Indicator
• invoiceCommodityGridList(optional): array invoiceCommodityGridList
• isAccepted(optional): string
  Is Accepted
• isAssigned(optional): string
  Is Assigned
• isAutoAuth(optional): string
• isDisputed(optional): string
  Is Disputed
• isDisputeResolvedWriteOff(optional): string
  Is Dispute Resolved Write Off
• isFinanced(optional): string
  Is Financed
• isOverdue(optional): string
  Is Overdue
• linkedDocs(optional): string
  Linked Docs
• linkedInvoiceList(optional): array linkedInvoiceList
• linkedInvoices(optional): string
• maxFinancePercentage(optional): number
  Maximum Finance Percentage
• minFinancePercentage(optional): number
  Minimum Finance Percentage
• miscCharge1(optional): number
• miscCharge1Amount(optional): number
• miscCharge1Desc(optional): string
• miscCharge2(optional): number
• miscCharge2Amount(optional): number
• miscCharge2Desc(optional): string
• netDebitNoteAmount(optional): number
• outstandingAmount(optional): number
• paidAmount(optional): number
  Paid Amount
• paymentStatus(optional): string
  Payment Status
• paymentTerms(optional): string
• poNumber(optional): string
  Po Number
• preAccepted(optional): string
• productCode(optional): string
  Product Code
• productParameters(optional): object ProductMasterDTO
• productType(optional): string
  Product Type
• programCode(optional): string
  Program Code
• programName(optional): string
• programParameters(optional): object ProgramSpokeResponse
  Scf Program Spoke Response
• purchaseOrderDate(optional): string
• reasonCode(optional): string
  Reason Code
• reasonForExport(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
• shipmentCountry(optional): string
• shipmentDate(optional): string
• shipmentNo(optional): string
• shipmentPhoneNumber(optional): integer
• shipmentRefNo(optional): string
• shipmentTaxId(optional): string
• shipmentZipCode(optional): string
• sourceTxnId(optional): string
• spokeId(optional): string
  Spoke Id
• staleStatus(optional): string
• status(optional): string
• supplierAddress(optional): array supplierAddress
• 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
• totalDebitNoteAmount(optional): number
  Total Debit Note Amount
• transactionRefNo(optional): string

{
    "description":"Service Get API Debit Note model",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64"
        },
        "debitNoteId":{
            "description":"Id of the debit note",
            "type":"string"
        },
        "acceptanceAmount":{
            "type":"number",
            "description":"Acceptance Amount"
        },
        "amount":{
            "type":"number",
            "description":"Amount"
        },
        "anchorId":{
            "type":"string",
            "description":"Anchor id"
        },
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "buyerName":{
            "type":"string",
            "description":"Buyer Name"
        },
        "buyerAddress":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfNonCustAddressModel"
            }
        },
        "buyerDivCode":{
            "type":"string",
            "description":"Buyer Division Code"
        },
        "buyerDivName":{
            "type":"string",
            "description":"Buyer Division Name"
        },
        "borrower":{
            "type":"string",
            "description":"Borrower"
        },
        "currency":{
            "type":"string",
            "description":"Currency"
        },
        "isDisputed":{
            "type":"string",
            "description":"Is Disputed"
        },
        "isDisputeResolvedWriteOff":{
            "type":"string",
            "description":"Is Dispute Resolved Write Off"
        },
        "isFinanced":{
            "type":"string",
            "description":"Is Financed"
        },
        "isOverdue":{
            "type":"string",
            "description":"Is Overdue"
        },
        "isAccepted":{
            "type":"string",
            "description":"Is Accepted"
        },
        "isAssigned":{
            "type":"string",
            "description":"Is Assigned"
        },
        "assignmentParty":{
            "type":"string",
            "description":"Assignment Party"
        },
        "linkedDocs":{
            "type":"string",
            "description":"Linked Docs"
        },
        "discrepancyCode":{
            "type":"string",
            "description":"Discrepancy Code"
        },
        "disputeResolveRemarks":{
            "type":"string",
            "description":"Dispute Resolve Remarks"
        },
        "fileRef":{
            "type":"string",
            "description":"File reference"
        },
        "fileName":{
            "type":"string",
            "description":"File Name"
        },
        "filler1":{
            "type":"string",
            "description":"Filler1"
        },
        "filler2":{
            "type":"string",
            "description":"Filler2"
        },
        "filler3":{
            "type":"string",
            "description":"Filler3"
        },
        "filler4":{
            "type":"string",
            "description":"Filler4"
        },
        "financeAmount":{
            "type":"number"
        },
        "financePercentage":{
            "type":"number"
        },
        "indicator":{
            "type":"string",
            "description":"Indicator"
        },
        "debitNoteDate":{
            "type":"string",
            "description":"Debit Note Date"
        },
        "debitNoteDueDate":{
            "type":"string",
            "description":"Debit Note Due Date"
        },
        "debitNoteNumber":{
            "type":"string",
            "description":"Debit Note Number"
        },
        "debitNoteProcessStatus":{
            "type":"string",
            "description":"Debit Note Process Status"
        },
        "debitNoteRefNo":{
            "type":"string",
            "description":"Debit Note Reference Number"
        },
        "debitNoteStatus":{
            "type":"string",
            "description":"Debit Note Status"
        },
        "dNoteAcceptanceDate":{
            "type":"string",
            "description":"Debit Note Acceptance Date"
        },
        "maxFinancePercentage":{
            "type":"number",
            "description":"Maximum Finance Percentage"
        },
        "minFinancePercentage":{
            "type":"number",
            "description":"Minimum Finance Percentage"
        },
        "paidAmount":{
            "type":"number",
            "description":"Paid Amount"
        },
        "paymentStatus":{
            "type":"string",
            "description":"Payment Status"
        },
        "preAccepted":{
            "type":"string"
        },
        "poNumber":{
            "type":"string",
            "description":"Po Number"
        },
        "productCode":{
            "type":"string",
            "description":"Product Code"
        },
        "productType":{
            "type":"string",
            "description":"Product Type"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "programName":{
            "type":"string"
        },
        "reasonCode":{
            "type":"string",
            "description":"Reason Code"
        },
        "remarks":{
            "type":"string",
            "description":"Remarks"
        },
        "spokeId":{
            "type":"string",
            "description":"Spoke Id"
        },
        "supplierId":{
            "type":"string",
            "description":"Supplier Id"
        },
        "supplierName":{
            "type":"string",
            "description":"Supplier Name"
        },
        "supplierAddress":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfNonCustAddressModel"
            }
        },
        "supplierDivCode":{
            "type":"string",
            "description":"Supplier Division Code"
        },
        "supplierDivName":{
            "type":"string",
            "description":"Supplier Division Name"
        },
        "taxAmount":{
            "type":"number",
            "description":"Tax Amount"
        },
        "totalDebitNoteAmount":{
            "type":"number",
            "description":"Total Debit Note 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"
        },
        "netDebitNoteAmount":{
            "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"
        },
        "channel":{
            "type":"string"
        },
        "sourceTxnId":{
            "type":"string"
        },
        "disputedAmount":{
            "type":"number"
        },
        "fundingReqAmt":{
            "type":"number"
        },
        "status":{
            "type":"string"
        },
        "adjustmentReason":{
            "type":"string"
        },
        "shipmentCity":{
            "type":"string"
        },
        "shipmentZipCode":{
            "type":"string"
        },
        "shipmentPhoneNumber":{
            "type":"integer"
        },
        "shipmentTaxId":{
            "type":"string"
        },
        "linkedInvoices":{
            "type":"string"
        },
        "fundingReqDate":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "programParameters":{
            "$ref":"#/definitions/ProgramSpokeResponse"
        },
        "productParameters":{
            "$ref":"#/definitions/ProductMasterDTO"
        },
        "invoiceCommodityGridList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InvoiceCommodityGridServiceModel"
            }
        },
        "linkedInvoiceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkedInvoiceModel"
            }
        }
    }
}

Nested Schema : buyerAddress

Type: array

Show Source

• Array of: object ScfNonCustAddressModel

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

Nested Schema : invoiceCommodityGridList

Type: array

Show Source

• Array of: object InvoiceCommodityGridServiceModel

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

Nested Schema : linkedInvoiceList

Type: array

Show Source

• Array of: object LinkedInvoiceModel

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

Nested Schema : ProductMasterDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object ProductMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "appropriationSeqAftDueDate":{
                    "type":"string",
                    "description":"Appropriation Sequence After Due Date"
                },
                "appropriationSeqBefDueDate":{
                    "type":"string",
                    "description":"Appropriation Sequence Before Due Date"
                },
                "appropriationSeqOnDueDate":{
                    "type":"string",
                    "description":"Appropriation Sequence On Due Date"
                },
                "autoDebitApplicable":{
                    "type":"string",
                    "description":"Auto Debit Applicable"
                },
                "autoFinanceApplicable":{
                    "type":"string",
                    "description":"Auto Finance Applicable"
                },
                "autoSettlementApplicable":{
                    "type":"string",
                    "description":"Auto Settlement Applicable"
                },
                "branchCode":{
                    "type":"string",
                    "description":"Branch Code"
                },
                "creditLimitUtilization":{
                    "type":"string",
                    "description":"Credit Limit Utilization"
                },
                "debitAcctTypeAfterDueDate":{
                    "type":"string",
                    "description":"Debit Account Type After Due Date"
                },
                "debitAcctTypeOnDueDate":{
                    "type":"string",
                    "description":"Debit Account Type On Due Date"
                },
                "debitPartyAfterDueDate":{
                    "type":"string",
                    "description":"Debit Party After Due Date"
                },
                "debitPartyOnDueDate":{
                    "type":"string",
                    "description":"Debit Party On Due Date"
                },
                "debtor":{
                    "type":"string",
                    "description":"Debtor"
                },
                "effectiveFrom":{
                    "type":"string",
                    "format":"date",
                    "description":"Effective From"
                },
                "expiresOn":{
                    "type":"string",
                    "format":"date",
                    "description":"Expires On"
                },
                "holidayTreatment":{
                    "type":"string",
                    "description":"Holiday Treatment"
                },
                "maturityDateCalculation":{
                    "type":"string",
                    "description":"Maturity Date Calculation"
                },
                "maxFinancePercentage":{
                    "type":"number",
                    "description":"Maximum Finance Percentage"
                },
                "maxTenorAllowed":{
                    "type":"number",
                    "description":"Maximum Tenor Allowed"
                },
                "minFinancePercentage":{
                    "type":"number",
                    "description":"Minimum Finance Percentage"
                },
                "minTenorAllowed":{
                    "type":"number",
                    "description":"Minimum Tenor Allowed"
                },
                "minWaitingPeriod":{
                    "type":"number",
                    "description":"Minimum Waiting Period"
                },
                "multipleDisbursementAllowed":{
                    "type":"string",
                    "description":"Multiple Disbursement Allowed"
                },
                "npaAppropriationSeq":{
                    "type":"string",
                    "description":"Npa Appropriation Sequence"
                },
                "partRepaymentAllowed":{
                    "type":"string",
                    "description":"Part Repayment Allowed"
                },
                "preferredDisbursementMode":{
                    "type":"string",
                    "description":"Preferred Disbursement Mode"
                },
                "preferredSettlementMode":{
                    "type":"string",
                    "description":"Preferred Settlement Mode"
                },
                "prePaymentAllowed":{
                    "type":"string",
                    "description":"Pre Payment Allowed"
                },
                "productCategory":{
                    "type":"string",
                    "description":"Product Category"
                },
                "productCode":{
                    "type":"string",
                    "description":"Product Code"
                },
                "productDescription":{
                    "type":"string",
                    "description":"Product Description"
                },
                "productType":{
                    "type":"string",
                    "description":"Product Type"
                },
                "stalePeriod":{
                    "type":"number",
                    "description":"Stale Period"
                },
                "withRecourse":{
                    "type":"string",
                    "description":"With Recourse"
                },
                "graceDays":{
                    "type":"number"
                },
                "interestRefundHandling":{
                    "type":"string"
                },
                "interestRefundPaymentMode":{
                    "type":"string"
                },
                "marginHandling":{
                    "type":"string"
                },
                "marginPaymentMode":{
                    "type":"string"
                },
                "isCreditLimitApplicable":{
                    "type":"string",
                    "description":"Is Credit Limit Applicable"
                },
                "isAccountingApplicable":{
                    "type":"string",
                    "description":"Is Accounting Applicable"
                },
                "isAssignmentApplicable":{
                    "type":"string",
                    "description":"Is Assignment Applicable"
                },
                "isAutoAssignment":{
                    "type":"string",
                    "description":"Is Auto Assignment"
                },
                "isAcceptanceApplicable":{
                    "type":"string",
                    "description":"Is Acceptance Applicable"
                },
                "isAutoAcceptance":{
                    "type":"string",
                    "description":"Is Auto Acceptance"
                },
                "isDisbursementAuthRequired":{
                    "type":"string",
                    "description":"Is Disbursement Auth Required"
                },
                "isDisbursementAutoProcessing":{
                    "type":"string",
                    "description":"Is Disbursement Auto Processing"
                },
                "isSettlementAuthRequired":{
                    "type":"string",
                    "description":"Is Settlement Authorized Required"
                },
                "isSettlementAutoProcessing":{
                    "type":"string",
                    "description":"Is Settlement Auto Processing"
                },
                "autoAcceptanceDays":{
                    "type":"number",
                    "description":"Auto Acceptance Days"
                },
                "reconciliationTowards":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : ProgramSpokeResponse

Type: object

Scf Program Spoke Response

Show Source

• anchorId(optional): string
  Configured value which will be used in rest of application.
• programCode(optional): string
  Id of the Parameter
• programName(optional): string
  Key for the parameter.This is a unique constraint
• spokeHierarchyParams(optional): object SpokeHierarchyParamsModel
• spokeId(optional): string
  Configured value which will be used in rest of application.

{
    "description":"Scf Program Spoke Response",
    "type":"object",
    "properties":{
        "programCode":{
            "description":"Id of the Parameter",
            "type":"string"
        },
        "programName":{
            "description":"Key for the parameter.This is a unique constraint",
            "type":"string"
        },
        "anchorId":{
            "description":"Configured value which will be used in rest of application.",
            "type":"string"
        },
        "spokeId":{
            "description":"Configured value which will be used in rest of application.",
            "type":"string"
        },
        "spokeHierarchyParams":{
            "$ref":"#/definitions/SpokeHierarchyParamsModel"
        }
    }
}

Nested Schema : supplierAddress

Type: array

Show Source

• Array of: object ScfNonCustAddressModel

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

Nested Schema : ScfNonCustAddressModel

Type: object

Show Source

• addressLine1(optional): string
  Address Line 1
• addressLine2(optional): string
  Address Line 2
• addressLine3(optional): string
  Address Line 3
• addressLine4(optional): string
  Address Line 4
• country(optional): string
  Country
• pin(optional): string
  Pin
• street(optional): string
  Street

{
    "type":"object",
    "properties":{
        "addressLine1":{
            "type":"string",
            "description":"Address Line 1"
        },
        "addressLine2":{
            "type":"string",
            "description":"Address Line 2"
        },
        "addressLine3":{
            "type":"string",
            "description":"Address Line 3"
        },
        "addressLine4":{
            "type":"string",
            "description":"Address Line 4"
        },
        "country":{
            "type":"string",
            "description":"Country"
        },
        "pin":{
            "type":"string",
            "description":"Pin"
        },
        "street":{
            "type":"string",
            "description":"Street"
        }
    }
}

Nested Schema : InvoiceCommodityGridServiceModel

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
• 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"
        }
    }
}

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

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : ProductMasterDTO-allOf[1]

Type: object

Show Source

• appropriationSeqAftDueDate(optional): string
  Appropriation Sequence After Due Date
• appropriationSeqBefDueDate(optional): string
  Appropriation Sequence Before Due Date
• appropriationSeqOnDueDate(optional): string
  Appropriation Sequence On Due Date
• autoAcceptanceDays(optional): number
  Auto Acceptance Days
• autoDebitApplicable(optional): string
  Auto Debit Applicable
• autoFinanceApplicable(optional): string
  Auto Finance Applicable
• autoSettlementApplicable(optional): string
  Auto Settlement Applicable
• branchCode(optional): string
  Branch Code
• creditLimitUtilization(optional): string
  Credit Limit Utilization
• debitAcctTypeAfterDueDate(optional): string
  Debit Account Type After Due Date
• debitAcctTypeOnDueDate(optional): string
  Debit Account Type On Due Date
• debitPartyAfterDueDate(optional): string
  Debit Party After Due Date
• debitPartyOnDueDate(optional): string
  Debit Party On Due Date
• debtor(optional): string
  Debtor
• effectiveFrom(optional): string(date)
  Effective From
• expiresOn(optional): string(date)
  Expires On
• graceDays(optional): number
• holidayTreatment(optional): string
  Holiday Treatment
• interestRefundHandling(optional): string
• interestRefundPaymentMode(optional): string
• isAcceptanceApplicable(optional): string
  Is Acceptance Applicable
• isAccountingApplicable(optional): string
  Is Accounting Applicable
• isAssignmentApplicable(optional): string
  Is Assignment Applicable
• isAutoAcceptance(optional): string
  Is Auto Acceptance
• isAutoAssignment(optional): string
  Is Auto Assignment
• isCreditLimitApplicable(optional): string
  Is Credit Limit Applicable
• isDisbursementAuthRequired(optional): string
  Is Disbursement Auth Required
• isDisbursementAutoProcessing(optional): string
  Is Disbursement Auto Processing
• isSettlementAuthRequired(optional): string
  Is Settlement Authorized Required
• isSettlementAutoProcessing(optional): string
  Is Settlement Auto Processing
• marginHandling(optional): string
• marginPaymentMode(optional): string
• maturityDateCalculation(optional): string
  Maturity Date Calculation
• maxFinancePercentage(optional): number
  Maximum Finance Percentage
• maxTenorAllowed(optional): number
  Maximum Tenor Allowed
• minFinancePercentage(optional): number
  Minimum Finance Percentage
• minTenorAllowed(optional): number
  Minimum Tenor Allowed
• minWaitingPeriod(optional): number
  Minimum Waiting Period
• multipleDisbursementAllowed(optional): string
  Multiple Disbursement Allowed
• npaAppropriationSeq(optional): string
  Npa Appropriation Sequence
• partRepaymentAllowed(optional): string
  Part Repayment Allowed
• preferredDisbursementMode(optional): string
  Preferred Disbursement Mode
• preferredSettlementMode(optional): string
  Preferred Settlement Mode
• prePaymentAllowed(optional): string
  Pre Payment Allowed
• productCategory(optional): string
  Product Category
• productCode(optional): string
  Product Code
• productDescription(optional): string
  Product Description
• productType(optional): string
  Product Type
• reconciliationTowards(optional): string
• stalePeriod(optional): number
  Stale Period
• withRecourse(optional): string
  With Recourse

{
    "type":"object",
    "properties":{
        "appropriationSeqAftDueDate":{
            "type":"string",
            "description":"Appropriation Sequence After Due Date"
        },
        "appropriationSeqBefDueDate":{
            "type":"string",
            "description":"Appropriation Sequence Before Due Date"
        },
        "appropriationSeqOnDueDate":{
            "type":"string",
            "description":"Appropriation Sequence On Due Date"
        },
        "autoDebitApplicable":{
            "type":"string",
            "description":"Auto Debit Applicable"
        },
        "autoFinanceApplicable":{
            "type":"string",
            "description":"Auto Finance Applicable"
        },
        "autoSettlementApplicable":{
            "type":"string",
            "description":"Auto Settlement Applicable"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "creditLimitUtilization":{
            "type":"string",
            "description":"Credit Limit Utilization"
        },
        "debitAcctTypeAfterDueDate":{
            "type":"string",
            "description":"Debit Account Type After Due Date"
        },
        "debitAcctTypeOnDueDate":{
            "type":"string",
            "description":"Debit Account Type On Due Date"
        },
        "debitPartyAfterDueDate":{
            "type":"string",
            "description":"Debit Party After Due Date"
        },
        "debitPartyOnDueDate":{
            "type":"string",
            "description":"Debit Party On Due Date"
        },
        "debtor":{
            "type":"string",
            "description":"Debtor"
        },
        "effectiveFrom":{
            "type":"string",
            "format":"date",
            "description":"Effective From"
        },
        "expiresOn":{
            "type":"string",
            "format":"date",
            "description":"Expires On"
        },
        "holidayTreatment":{
            "type":"string",
            "description":"Holiday Treatment"
        },
        "maturityDateCalculation":{
            "type":"string",
            "description":"Maturity Date Calculation"
        },
        "maxFinancePercentage":{
            "type":"number",
            "description":"Maximum Finance Percentage"
        },
        "maxTenorAllowed":{
            "type":"number",
            "description":"Maximum Tenor Allowed"
        },
        "minFinancePercentage":{
            "type":"number",
            "description":"Minimum Finance Percentage"
        },
        "minTenorAllowed":{
            "type":"number",
            "description":"Minimum Tenor Allowed"
        },
        "minWaitingPeriod":{
            "type":"number",
            "description":"Minimum Waiting Period"
        },
        "multipleDisbursementAllowed":{
            "type":"string",
            "description":"Multiple Disbursement Allowed"
        },
        "npaAppropriationSeq":{
            "type":"string",
            "description":"Npa Appropriation Sequence"
        },
        "partRepaymentAllowed":{
            "type":"string",
            "description":"Part Repayment Allowed"
        },
        "preferredDisbursementMode":{
            "type":"string",
            "description":"Preferred Disbursement Mode"
        },
        "preferredSettlementMode":{
            "type":"string",
            "description":"Preferred Settlement Mode"
        },
        "prePaymentAllowed":{
            "type":"string",
            "description":"Pre Payment Allowed"
        },
        "productCategory":{
            "type":"string",
            "description":"Product Category"
        },
        "productCode":{
            "type":"string",
            "description":"Product Code"
        },
        "productDescription":{
            "type":"string",
            "description":"Product Description"
        },
        "productType":{
            "type":"string",
            "description":"Product Type"
        },
        "stalePeriod":{
            "type":"number",
            "description":"Stale Period"
        },
        "withRecourse":{
            "type":"string",
            "description":"With Recourse"
        },
        "graceDays":{
            "type":"number"
        },
        "interestRefundHandling":{
            "type":"string"
        },
        "interestRefundPaymentMode":{
            "type":"string"
        },
        "marginHandling":{
            "type":"string"
        },
        "marginPaymentMode":{
            "type":"string"
        },
        "isCreditLimitApplicable":{
            "type":"string",
            "description":"Is Credit Limit Applicable"
        },
        "isAccountingApplicable":{
            "type":"string",
            "description":"Is Accounting Applicable"
        },
        "isAssignmentApplicable":{
            "type":"string",
            "description":"Is Assignment Applicable"
        },
        "isAutoAssignment":{
            "type":"string",
            "description":"Is Auto Assignment"
        },
        "isAcceptanceApplicable":{
            "type":"string",
            "description":"Is Acceptance Applicable"
        },
        "isAutoAcceptance":{
            "type":"string",
            "description":"Is Auto Acceptance"
        },
        "isDisbursementAuthRequired":{
            "type":"string",
            "description":"Is Disbursement Auth Required"
        },
        "isDisbursementAutoProcessing":{
            "type":"string",
            "description":"Is Disbursement Auto Processing"
        },
        "isSettlementAuthRequired":{
            "type":"string",
            "description":"Is Settlement Authorized Required"
        },
        "isSettlementAutoProcessing":{
            "type":"string",
            "description":"Is Settlement Auto Processing"
        },
        "autoAcceptanceDays":{
            "type":"number",
            "description":"Auto Acceptance Days"
        },
        "reconciliationTowards":{
            "type":"string"
        }
    }
}

Nested Schema : SpokeHierarchyParamsModel

Type: object

Show Source

• authorizationRequired(optional): string
  Authorization Required
• autoDebitApplicable(optional): string
  Auto Debit Applicable
• autoFinanceApplicable(optional): string
  Auto Finance Applicable
• autoSettlementApplicable(optional): string
  Auto Settlement Applicable
• disbursementCcy(optional): string
  Auto Debit Applicable
• graceDays(optional): number
• importFactorId(optional): string
  Import Factor Id
• importFactorName(optional): string
  Import Factor Name
• insuranceCoId(optional): string
  Insurance Co Id
• insuranceCoName(optional): string
  Insurance Co Name
• interestBearingParty(optional): string
  Interest Bearing Party
• interestRefundHandling(optional): string
  Interest Refund Handling
• interestRefundPaymentMode(optional): string
  Interest Refund Payment Mode
• marginHandling(optional): string
  Margin Handling
• marginPaymentMode(optional): string
  Margin Payment Mode
• maxFinancePercentage(optional): number
  Maximum Finance Percentage
• maxTenorAllowed(optional): number
  Maximum Tenor Allowed
• minFinancePercentage(optional): number
  Minimum Finance Percentage
• minTenorAllowed(optional): number
  Minimum Tenor Allowed
• preferredDisbursementMode(optional): string
  Preferred Disbursement Mode
• preferredSettlementMode(optional): string
  Preferred Settlement Mode
• programCode(optional): string
  Program Code
• programSpokeCodeList(optional): array programSpokeCodeList
• spokeId(optional): string
  Spoke Id
• spokeName(optional): string
  Spoke Name
• withRecourse(optional): string
  With Recourse

{
    "type":"object",
    "properties":{
        "authorizationRequired":{
            "type":"string",
            "description":"Authorization Required"
        },
        "autoFinanceApplicable":{
            "type":"string",
            "description":"Auto Finance Applicable"
        },
        "autoSettlementApplicable":{
            "type":"string",
            "description":"Auto Settlement Applicable"
        },
        "autoDebitApplicable":{
            "type":"string",
            "description":"Auto Debit Applicable"
        },
        "disbursementCcy":{
            "type":"string",
            "description":"Auto Debit Applicable"
        },
        "maxFinancePercentage":{
            "type":"number",
            "description":"Maximum Finance Percentage"
        },
        "maxTenorAllowed":{
            "type":"number",
            "description":"Maximum Tenor Allowed"
        },
        "minFinancePercentage":{
            "type":"number",
            "description":"Minimum Finance Percentage"
        },
        "minTenorAllowed":{
            "type":"number",
            "description":"Minimum Tenor Allowed"
        },
        "preferredDisbursementMode":{
            "type":"string",
            "description":"Preferred Disbursement Mode"
        },
        "preferredSettlementMode":{
            "type":"string",
            "description":"Preferred Settlement Mode"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "spokeId":{
            "type":"string",
            "description":"Spoke Id"
        },
        "spokeName":{
            "type":"string",
            "description":"Spoke Name"
        },
        "withRecourse":{
            "type":"string",
            "description":"With Recourse"
        },
        "graceDays":{
            "type":"number"
        },
        "interestBearingParty":{
            "type":"string",
            "description":"Interest Bearing Party"
        },
        "importFactorId":{
            "type":"string",
            "description":"Import Factor Id"
        },
        "importFactorName":{
            "type":"string",
            "description":"Import Factor Name"
        },
        "insuranceCoId":{
            "type":"string",
            "description":"Insurance Co Id"
        },
        "insuranceCoName":{
            "type":"string",
            "description":"Insurance Co Name"
        },
        "interestRefundHandling":{
            "type":"string",
            "description":"Interest Refund Handling"
        },
        "interestRefundPaymentMode":{
            "type":"string",
            "description":"Interest Refund Payment Mode"
        },
        "marginHandling":{
            "type":"string",
            "description":"Margin Handling"
        },
        "marginPaymentMode":{
            "type":"string",
            "description":"Margin Payment Mode"
        },
        "programSpokeCodeList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProgramSpokeCodeModel"
            }
        }
    }
}

Nested Schema : programSpokeCodeList

Type: array

Show Source

• Array of: object ProgramSpokeCodeModel

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

Nested Schema : ProgramSpokeCodeModel

Type: object

Show Source

• anchorDivisionCode(optional): string
  Anchor Division Code
• anchorDivisionName(optional): string
  Anchor Division Name
• id(optional): string
  Id
• programCode(optional): string
  Program Code
• spokeDivisionCode(optional): string
  Spoke Division Code
• spokeDivisionName(optional): string
  Spoke Division Name
• spokeExternalCode(optional): string
  Spoke External Code
• spokeId(optional): string
  Spoke Id
• spokeMasterId(optional): string
  Spoke Master Id
• spokeName(optional): string
  Spoke Name

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "spokeMasterId":{
            "type":"string",
            "description":"Spoke Master Id"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "spokeId":{
            "type":"string",
            "description":"Spoke Id"
        },
        "spokeName":{
            "type":"string",
            "description":"Spoke Name"
        },
        "spokeExternalCode":{
            "type":"string",
            "description":"Spoke External Code"
        },
        "spokeDivisionCode":{
            "type":"string",
            "description":"Spoke Division Code"
        },
        "spokeDivisionName":{
            "type":"string",
            "description":"Spoke Division Name"
        },
        "anchorDivisionCode":{
            "type":"string",
            "description":"Anchor Division Code"
        },
        "anchorDivisionName":{
            "type":"string",
            "description":"Anchor Division Name"
        }
    }
}

400 Response

Malformed syntax.

405 Response

Invalid input

500 Response

Internal error

Back to Top