Retrieves the list of existing invoices
post
/service/v3/invoiceSearch
This service is used to retrieves the list of existing invoices.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
limit: integer
limit is maximum no of records to be fetched
-
offset: integer
offset is starting no of records to be fetched
-
orderBy: string
order By Parameter
Header Parameters
Request Body that contains data required for searching invoices.
Root Schema : InvoiceSearchDTO
Type:
objectCollection of Main Invoices.
Show Source
-
action:
string
-
anchorId:
string
Anchor Id
-
anyOfferLinked:
string
-
assignmentParty:
string
-
buyerDivCode:
string
-
buyerId:
string
-
buyerName:
string
-
channel:
string
Channel
-
currency:
string
-
discountOfferId:
string
-
discountOfferStatus:
string
-
fileName:
string
-
fileRef:
string
-
finTxnStatus:
string
-
fundingReqDateFrom:
string
-
fundingReqDateTo:
string
-
indicator:
string
-
invoiceAmountFrom:
number
-
invoiceAmountTo:
number
-
invoiceDateFrom:
string
-
invoiceDateTo:
string
-
invoiceDueDateFrom:
string
-
invoiceDueDateTo:
string
-
invoiceId:
string
-
invoiceNumber:
string
-
invoiceProcessStatus:
string
-
invoiceRefNo:
string
-
invoiceStatus:
string
-
invoiceStatusOther:
string
-
isAccepted:
string
-
isAssigned:
string
-
isDiscOfferAccepted:
string
-
isDisputed:
string
-
isDisputeResolvedWriteOff:
string
-
isFinanced:
string
-
isIndirectPayment:
string
-
isNettingFlag:
string
Is Netting Flag
-
isOverdue:
string
-
isPUA:
string
-
linkedProgram:
string
-
maxTenor:
number
-
minTenor:
number
-
netAmountFrom:
number
-
netAmountTo:
number
-
outstandingAmountFrom:
number
-
outstandingAmountTo:
number
-
paidAmountFrom:
number
-
paidAmountTo:
number
-
paymentStatus:
string
-
programCode:
string
-
recordStat:
string
-
requestorPartyId:
string
-
sourceTxnId:
string
-
spokeId:
string
-
staleStatus:
string
-
status:
string
-
supplierDivCode:
string
-
supplierId:
string
-
supplierName:
string
-
transactionRefNo:
string
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successful performs the operation
Nested Schema : invoiceList
Type:
Show Source
array-
Array of:
object InvoiceResponseModel
Service Post API Invoice model
Nested Schema : paging
Type:
objectNested Schema : InvoiceResponseModel
Type:
objectService Post API Invoice model
Show Source
-
acceptanceAmount:
number
Acceptance Amount
-
action:
string
-
adjustmentReason:
string
-
amount:
number
Amount
-
anchorId:
string
Anchor Id
-
assignableAmount:
number
-
assignmentAmount:
number
Assignment Amount
-
assignmentParty:
string
Assignment Party
-
bank:
string
-
borrower:
string
Borrower
-
branch:
string
-
buyerAddress:
array buyerAddress
-
buyerCode:
string
-
buyerDivCode:
string
Buyer Division Code
-
buyerDivName:
string
Buyer Division Name
-
buyerId:
string
Buyer Id
-
buyerName:
string
Buyer Name
-
channel:
string
-
countryOfOrigin:
string
-
currency:
string
Currency
-
discountAllowed:
string
-
discountAmount:
number
-
discountPercentage:
number
-
discrepancyCode:
string
Discrepancy Code
-
disputedAmount:
number
-
disputeResolveRemarks:
string
Dispute Resolve Remarks
-
divisionCode:
string
-
fileName:
string
File Name
-
fileRef:
string
File Reference
-
filler1:
string
Filler 1
-
filler2:
string
Filler 2
-
filler3:
string
Filler 3
-
filler4:
string
Filler 4
-
financeableAmount:
number
-
financeAmount:
number
-
financePercentage:
number
-
finTxnStatus:
string
-
fundingReqAmt:
number
-
fundingReqDate:
string
-
id:
string
-
indicator:
string
Indicator
-
invAcceptanceDate:
string
Invoice Acceptance Date
-
invoiceCommodityGridList:
array invoiceCommodityGridList
-
invoiceDate:
string
Invoice Date
-
invoiceDueDate:
string
Invoice Due Date
-
invoiceId:
string
Id of the Invoice
-
invoiceNumber:
string
Invoice Number
-
invoiceOfferList:
array invoiceOfferList
-
invoiceOfferTenorParameterList:
array invoiceOfferTenorParameterList
-
invoiceProcessStatus:
string
Invoice Process Status
-
invoiceRefNo:
string
Invoice Reference Number
-
invoiceStatus:
string
Invoice Status
-
invoiceStatusOther:
string
Invoice Status Other
-
isAccepted:
string
Is Accepted
-
isApproved:
string
Is Approved
-
isAssigned:
string
Is Assigned
-
isAutoAuth:
string
-
isDisputed:
string
Is Disputed
-
isDisputeResolvedWriteOff:
string
Is Dispute Resolved Writeoff
-
isFinanced:
string
Is Financed
-
isIndirectPayment:
string
Is Indirect Payment
-
isNettingFlag:
string
Netting Flag
-
isOverdue:
string
Is Overdue
-
isPUA:
string
Is PUA
-
linkedDocs:
string
Linked Docs
-
linkedInvoiceList:
array linkedInvoiceList
-
linkedInvoices:
string
-
linkedPo:
array linkedPo
-
maxFinancePercentage:
number
Maximum Finance Percentage
-
minFinancePercentage:
number
Minimum Finance Percentage
-
miscCharge1:
number
-
miscCharge1Amount:
number
-
miscCharge1Desc:
string
-
miscCharge2:
number
-
miscCharge2Amount:
number
-
miscCharge2Desc:
string
-
netInvoiceAmount:
number
-
nettingTxnPayableStatus:
string
Netting Txn Payable Status
-
nettingTxnReceivableStatus:
string
Netting Txn Receivable Status
-
newFundingReqDate:
string
-
outstandingAmount:
number
-
paidAmount:
number
Paid Amount
-
paymentStatus:
string
Payment Status
-
paymentTerms:
string
-
poNumber:
string
Po Number
-
preAccepted:
string
-
productCode:
string
Product Code
-
productParameters:
object ProductMasterDTO
-
productType:
string
Product Type
-
programCode:
string
Program Code
-
programName:
string
-
programParameters:
object ProgramSpoke
Scf Program Spoke Response
-
purchaseOrderDate:
string
-
reasonCode:
string
Reason Code
-
reasonForExport:
string
-
relationCode:
string
Relation Code
-
remarks:
string
Remarks
-
repayAccountNo:
string
-
routingCode:
string
-
seqNo:
integer(int64)
-
shipmentAddress:
string
-
shipmentCity:
string
-
shipmentCountry:
string
-
shipmentDate:
string
-
shipmentNo:
string
-
shipmentPhoneNumber:
string
-
shipmentRefNo:
string
-
shipmentTaxId:
string
-
shipmentZipCode:
string
-
sourceTxnId:
string
-
spokeId:
string
Spoke Id
-
stageId:
string
Stage Id
-
staleStatus:
string
-
status:
string
-
supplierAddress:
array supplierAddress
-
supplierCode:
string
-
supplierDivCode:
string
Supplier Division Code
-
supplierDivName:
string
Supplier Division Name
-
supplierId:
string
Supplier Id
-
supplierName:
string
Supplier Name
-
taxAmount:
number
Tax Amount
-
taxPercentage:
number
-
termsOfSale:
string
-
totalInvoiceAmount:
number
Total Invoice Amount
-
transactionRefNo:
string
-
useEarmarkedLimits:
string
Nested Schema : ProgramSpoke
Type:
objectScf Program Spoke Response
Show Source
-
anchorId:
string
Configured value which will be used in rest of application.
-
programCode:
string
Id of the Parameter
-
programName:
string
Key for the parameter.This is a unique constraint
-
spokeHierarchyParams:
object SpokeHierarchyParamsModel
-
spokeId:
string
Configured value which will be used in rest of application.
Nested Schema : ScfNonCustAddressModel
Type:
Show Source
object-
addressLine1:
string
Address Line 1
-
addressLine2:
string
Address Line 2
-
addressLine3:
string
Address Line 3
-
addressLine4:
string
Address Line 4
-
country:
string
Country
-
pin:
string
Pin
-
street:
string
Street
Nested Schema : InvoiceCommodityGridServiceModel
Type:
Show Source
object-
ccy:
string
-
commodityCode:
string
Commodity Code
-
commodityDesc:
string
-
commodityName:
string
-
costPerUnit:
number
Cost Per Unit
-
descriptionOfGoods:
string
-
discountAmount:
number
-
discountPercentage:
number
-
id:
string
-
invoiceCommodityGridId:
string
Read Only:
trueId of the Invoice Commodity Grid -
invoiceMasterId:
string
Invoice Master Id
-
invoiceNumber:
string
Invoice Number
-
invoiceRefNo:
string
Invoice Reference Number
-
netCost:
number
Net Cost
-
quantity:
number
Quantity
-
seqNo:
integer(int64)
-
taxAmount:
number
Tax Amount
-
taxPercentage:
number
-
totalCost:
number
Total Cost
-
totalWeight:
number
-
transactionRefNo:
string
-
unit:
string
-
unitWeight:
number
Nested Schema : InvoiceOfferDTO
Type:
Show Source
object-
applicabilityBasis:
string
Applicability Basis
-
chgPriceTemplateId:
string
Charge Price Template Id
-
currency:
string
Currency
-
discountAmount:
number
Discount Amount
-
discountOfferActiveStatus:
string
Discount Offer Active Status
-
discountOfferStatus:
string
Discount Offer Status
-
discountPercentage:
number
Discount Percentage
-
discountRuleDesc:
string
Discount Rule Desc
-
discountRuleId:
string
Discount Rule Id
-
earlyPaymentDate:
string
Early Payment Date
-
id:
string
Id
-
invoiceMasterId:
string
Invoice Master id
-
invoiceOfferAction:
string
Invoice Offer Action
-
invoiceOfferTenorParameterList:
array invoiceOfferTenorParameterList
-
invoiceRefNo:
string
Invoice Reference No
-
isDiscOfferAccepted:
string
Is Discount Offer Accepted
-
notionalEarlyPayAmt:
number
Notional Early Pay Amount
-
requestorPartyId:
string
Requestor Party Id
-
requestorPartyRole:
string
Requestor Party Role
-
seqNo:
integer(int64)
Sequence Number
-
slidingScaleApplicable:
string
Sliding Scale Applicable
-
transactionRefNo:
string
Transaction Reference No
Nested Schema : InvoiceOfferTenorParameterModel
Type:
Show Source
object-
currency:
string
-
daysElapsedFrom:
number
-
daysElapsedTo:
number
-
discountPercentage:
number
-
discountRuleDescription:
string
-
discountRuleId:
string
-
discountTenorAmount:
number
discount tenor amount
-
invoiceMasterId:
string
-
invoiceOfferTenorParametersScheduleList:
array invoiceOfferTenorParametersScheduleList
-
invoiceRefNo:
string
Invoice Reference Number
-
isTenorSelected:
string
-
lowerDiscountRateThreshold:
number
-
paymentDateFrom:
string
-
paymentDateTo:
string
-
slidingScaleApplicableTenor:
string
-
transactionRefNo:
string
-
upperDiscountRateThreshold:
number
Nested Schema : LinkPoDetils
Type:
Show Source
object-
externalNumber:
string
externalNumber
-
financeStatus:
string
finance status
-
internalNumber:
string
internalNumber
-
invoiceRefNo:
string
invoiceRefNo
-
status:
string
status
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
objectDiscriminator:
resource_typeNested Schema : ProductMasterDTO-allOf[1]
Type:
Show Source
object-
appropriationSeqAftDueDate:
string
Appropriation Sequence After Due Date
-
appropriationSeqBefDueDate:
string
Appropriation Sequence Before Due Date
-
appropriationSeqOnDueDate:
string
Appropriation Sequence On Due Date
-
autoAcceptanceDays:
number
Auto Acceptance Days
-
autoDebitApplicable:
string
Auto Debit Applicable
-
autoFinanceApplicable:
string
Auto Finance Applicable
-
autoSettlementApplicable:
string
Auto Settlement Applicable
-
branchCode:
string
Branch Code
-
creditLimitUtilization:
string
Credit Limit Utilization
-
debitAcctTypeAfterDueDate:
string
Debit Account Type After Due Date
-
debitAcctTypeOnDueDate:
string
Debit Account Type On Due Date
-
debitPartyAfterDueDate:
string
Debit Party After Due Date
-
debitPartyOnDueDate:
string
Debit Party On Due Date
-
debtor:
string
Debtor
-
effectiveFrom:
string(date)
Effective From
-
expiresOn:
string(date)
Expires On
-
graceDays:
number
-
holidayTreatment:
string
Holiday Treatment
-
interestRefundHandling:
string
-
interestRefundPaymentMode:
string
-
isAcceptanceApplicable:
string
Is Acceptance Applicable
-
isAccountingApplicable:
string
Is Accounting Applicable
-
isAssignmentApplicable:
string
Is Assignment Applicable
-
isAutoAcceptance:
string
Is Auto Acceptance
-
isAutoAssignment:
string
Is Auto Assignment
-
isCreditLimitApplicable:
string
Is Credit Limit Applicable
-
isDisbursementAuthRequired:
string
Is Disbursement Auth Required
-
isDisbursementAutoProcessing:
string
Is Disbursement Auto Processing
-
isSettlementAuthRequired:
string
Is Settlement Authorized Required
-
isSettlementAutoProcessing:
string
Is Settlement Auto Processing
-
marginHandling:
string
-
marginPaymentMode:
string
-
maturityDateCalculation:
string
Maturity Date Calculation
-
maxFinancePercentage:
number
Maximum Finance Percentage
-
maxTenorAllowed:
number
Maximum Tenor Allowed
-
minFinancePercentage:
number
Minimum Finance Percentage
-
minTenorAllowed:
number
Minimum Tenor Allowed
-
minWaitingPeriod:
number
Minimum Waiting Period
-
multipleDisbursementAllowed:
string
Multiple Disbursement Allowed
-
npaAppropriationSeq:
string
Npa Appropriation Sequence
-
partRepaymentAllowed:
string
Part Repayment Allowed
-
preferredDisbursementMode:
string
Preferred Disbursement Mode
-
preferredSettlementMode:
string
Preferred Settlement Mode
-
prePaymentAllowed:
string
Pre Payment Allowed
-
productCategory:
string
Product Category
-
productCode:
string
Product Code
-
productDescription:
string
Product Description
-
productType:
string
Product Type
-
reconciliationTowards:
string
-
stalePeriod:
number
Stale Period
-
withRecourse:
string
With Recourse
Nested Schema : SpokeHierarchyParamsModel
Type:
Show Source
object-
authorizationRequired:
string
Authorization Required
-
autoDebitApplicable:
string
Auto Debit Applicable
-
autoFinanceApplicable:
string
Auto Finance Applicable
-
autoSettlementApplicable:
string
Auto Settlement Applicable
-
disbursementCcy:
string
Auto Debit Applicable
-
graceDays:
number
-
importFactorId:
string
Import Factor Id
-
importFactorName:
string
Import Factor Name
-
insuranceCoId:
string
Insurance Co Id
-
insuranceCoName:
string
Insurance Co Name
-
interestBearingParty:
string
Interest Bearing Party
-
interestRefundHandling:
string
Interest Refund Handling
-
interestRefundPaymentMode:
string
Interest Refund Payment Mode
-
marginHandling:
string
Margin Handling
-
marginPaymentMode:
string
Margin Payment Mode
-
maxFinancePercentage:
number
Maximum Finance Percentage
-
maxTenorAllowed:
number
Maximum Tenor Allowed
-
minFinancePercentage:
number
Minimum Finance Percentage
-
minTenorAllowed:
number
Minimum Tenor Allowed
-
preferredDisbursementMode:
string
Preferred Disbursement Mode
-
preferredSettlementMode:
string
Preferred Settlement Mode
-
programCode:
string
Program Code
-
programSpokeCodeList:
array programSpokeCodeList
-
spokeId:
string
Spoke Id
-
spokeName:
string
Spoke Name
-
withRecourse:
string
With Recourse
Nested Schema : ProgramSpokeCodeModel
Type:
Show Source
object-
anchorDivisionCode:
string
Anchor Division Code
-
anchorDivisionName:
string
Anchor Division Name
-
id:
string
Id
-
programCode:
string
Program Code
-
spokeDivisionCode:
string
Spoke Division Code
-
spokeDivisionName:
string
Spoke Division Name
-
spokeExternalCode:
string
Spoke External Code
-
spokeId:
string
Spoke Id
-
spokeMasterId:
string
Spoke Master Id
-
spokeName:
string
Spoke Name
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error