Retrieves the list of existing invoices with input parameters
get
/service/v1/invoiceSearch
This endpoint is used to retrieves the list of existing invoices with input parameters.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
anchorId(optional): string
anchorId
-
buyerDivCode(optional): string
buyerDivCode
-
buyerId(optional): string
buyerId
-
buyerName(optional): string
buyerName
-
currency(optional): string
currency
-
fileName(optional): string
fileName
-
fileRef(optional): string
fileRef
-
indicator(optional): string
indicator
-
invoiceAmountFrom(optional): number
invoiceAmountFrom
-
invoiceAmountTo(optional): number
invoiceAmountTo
-
invoiceDateFrom(optional): string
invoiceDateFrom
-
invoiceDateTo(optional): string
invoiceDateTo
-
invoiceDueDateFrom(optional): string
invoiceDueDateFrom
-
invoiceDueDateTo(optional): string
invoiceDueDateTo
-
invoiceNumber(optional): string
invoiceNumber
-
invoiceProcessStatus(optional): string
invoiceProcessStatus
-
invoiceRefNo(optional): string
invoiceRefNo
-
invoiceStatus(optional): string
invoiceStatus
-
isDisputed(optional): string
isDisputed
-
linkedProgram(optional): string
linkedProgram
-
outstandingAmountFrom(optional): number
outstandingAmountFrom
-
outstandingAmountTo(optional): number
outstandingAmountTo
-
paidAmountFrom(optional): number
paidAmountFrom
-
paidAmountTo(optional): number
paidAmountTo
-
paymentStatus(optional): string
paymentStatus
-
programCode(optional): string
programCode
-
recordStat(optional): string
recordStat
-
spokeId(optional): string
spokeId
-
supplierDivCode(optional): string
supplierDivCode
-
supplierId(optional): string
supplierId
-
supplierName(optional): string
supplierName
Header Parameters
-
appId: string
appId
-
branchCode: string
branchCode
-
userId: string
userId
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successful performs the operation
Nested Schema : invoiceList
Type:
Show Source
array
-
Array of:
object ServiceInvoiceModel
Service Get API Invoice model
Nested Schema : ServiceInvoiceModel
Type:
object
Service Get API Invoice model
Show Source
-
acceptanceAmount(optional):
number
Acceptance Amount
-
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
-
countryOfOrigin(optional):
string
-
currency(optional):
string
Currency
-
discountAllowed(optional):
string
-
discountAmount(optional):
number
-
discountPercentage(optional):
number
-
discrepancyCode(optional):
string
Discrepancy Code
-
disputedAmount(optional):
number
Disputed amount
-
disputeResolveRemarks(optional):
string
Dispute Resolve Remarks
-
divisionCode(optional):
string
-
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
-
financePercentage(optional):
number
-
finTxnStatus(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
-
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 Write Off
-
isFinanced(optional):
string
Is Financed
-
isOverdue(optional):
string
Is Overdue
-
linkedDocs(optional):
string
Linked Docs
-
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
-
outstandingAmount(optional):
number
-
paidAmount(optional):
number
Paid Amount
-
paymentDueDate(optional):
string
Payment Due Date
-
paymentStatus(optional):
string
Payment Status
-
paymentTerms(optional):
string
-
poNumber(optional):
string
Po Number
-
preAccepted(optional):
string
-
productCode(optional):
string
Product Code
-
productType(optional):
string
Product Type
-
programCode(optional):
string
Program Code
-
programName(optional):
string
-
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
-
shipmentCountry(optional):
string
-
shipmentDate(optional):
string
-
shipmentNo(optional):
string
-
shipmentRefNo(optional):
string
-
spokeId(optional):
string
Spoke Id
-
staleStatus(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 : ScfNonCustomerAddress
Type:
Show Source
object
-
addressLine1(optional):
string
Address Line1
-
addressLine2(optional):
string
Address Line2
-
addressLine3(optional):
string
Address Line3
-
addressLine4(optional):
string
Address Line4
-
country(optional):
string
Country
-
pin(optional):
string
Pin
-
street(optional):
string
Street
Nested Schema : InvoiceCommodityGridModel
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
-
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
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error