Retrieves the list of existing invoices
get
/obscfcm-instruments-receivables-services/service/v2/invoiceSearch
This endpoint is used to retrieve the list of existing invoices.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
anchorId(optional): string
-
anyOfferLinked: string
-
assignmentParty(optional): string
-
buyerDivCode(optional): string
-
buyerId(optional): string
-
buyerName(optional): string
-
currency(optional): string
-
discountOfferStatus: string
-
fileName(optional): string
-
fileRef(optional): string
-
finTxnStatus(optional): string
-
fundingReqDateFrom(optional): string
-
fundingReqDateTo(optional): string
-
indicator(optional): string
-
invoiceAmountFrom(optional): number
-
invoiceAmountTo(optional): number
-
invoiceDateFrom(optional): string
-
invoiceDateTo(optional): string
-
invoiceDueDateFrom(optional): string
-
invoiceDueDateTo(optional): string
-
invoiceId: string
-
invoiceNumber(optional): string
-
invoiceProcessStatus(optional): string
-
invoiceRefNo(optional): string
-
invoiceStatus(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
-
linkedProgram(optional): string
-
netAmountFrom(optional): number
-
netAmountTo(optional): number
-
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
-
requestorPartyId: string
-
sourceTxnId: string
-
spokeId(optional): string
-
staleStatus(optional): string
-
status: string
-
supplierDivCode(optional): string
-
supplierId(optional): string
-
supplierName(optional): string
-
transactionRefNo: string
Header Parameters
Back to Top
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successful performs the operation
Nested Schema : invoiceList
Type:
Show Source
array
-
Array of:
object InvoiceModelResponse
Service Get API Invoice model
Nested Schema : paging
Type:
object
Nested Schema : InvoiceModelResponse
Type:
object
Service Get API Invoice 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
-
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
-
fileName(optional):
string
File Name
-
fileRef(optional):
string
File Reference
-
filler1(optional):
string
Filler 1
-
filler2(optional):
string
Filler 2
-
filler3(optional):
string
Filler 3
-
filler4(optional):
string
Filler 4
-
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
-
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
-
isAccepted(optional):
string
Is Accepted
-
isAssigned(optional):
string
Is Assigned
-
isAutoAuth(optional):
string
-
isDisputed(optional):
string
Is Disputed
-
isDisputeResolvedWriteOff(optional):
string
Is Dispute Resolved Writeoff
-
isFinanced(optional):
string
Is Financed
-
isNettingFlag(optional):
string
Netting Flag
-
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
-
netInvoiceAmount(optional):
number
-
newFundingReqDate(optional):
string
-
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):
string
-
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
-
totalInvoiceAmount(optional):
number
Total Invoice Amount
-
transactionRefNo(optional):
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.
Nested Schema : ScfNonCustomerAddressModel
Type:
Show Source
object
-
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
Nested Schema : InvoiceCommodityGridServiceModel
Type:
Show Source
object
-
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
Nested Schema : InvoiceOfferDTO
Type:
Show Source
object
-
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
Nested Schema : InvoiceOfferTenorParameterModel
Type:
Show Source
object
-
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
Nested Schema : LinkedInvoiceModel
Type:
Show Source
object
-
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
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
object
Discriminator:
resource_type
Nested Schema : ProductMasterDTO-allOf[1]
Type:
Show Source
object
-
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
Nested Schema : SpokeHierarchyParamsModel
Type:
Show Source
object
-
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
Nested Schema : ProgramSpokeCodeModel
Type:
Show Source
object
-
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
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error