Retrieve the list of existing invoices
get
/service/v1/invoiceSearch
This endpoint is used to retrieve the list of existing invoices.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
anchorId: string
anchorId
-
buyerDivCode: string
buyerDivCode
-
buyerId: string
buyerId
-
buyerName: string
buyerName
-
currency: string
currency
-
fileName: string
fileName
-
fileRef: string
fileRef
-
indicator: string
indicator
-
invoiceAmountFrom: number
invoiceAmountFrom
-
invoiceAmountTo: number
invoiceAmountTo
-
invoiceDateFrom: string
invoiceDateFrom
-
invoiceDateTo: string
invoiceDateTo
-
invoiceDueDateFrom: string
invoiceDueDateFrom
-
invoiceDueDateTo: string
invoiceDueDateTo
-
invoiceNumber: string
invoiceNumber
-
invoiceProcessStatus: string
invoiceProcessStatus
-
invoiceRefNo: string
invoiceRefNo
-
invoiceStatus: string
invoiceStatus
-
isDisputed: string
isDisputed
-
linkedProgram: string
linkedProgram
-
outstandingAmountFrom: number
outstandingAmountFrom
-
outstandingAmountTo: number
outstandingAmountTo
-
paidAmountFrom: number
paidAmountFrom
-
paidAmountTo: number
paidAmountTo
-
paymentStatus: string
paymentStatus
-
programCode: string
programCode
-
recordStat: string
recordStat
-
spokeId: string
spokeId
-
supplierDivCode: string
supplierDivCode
-
supplierId: string
supplierId
-
supplierName: string
supplierName
Header Parameters
-
appId(required): string
appId
-
branchCode(required): string
branchCode
-
userId(required): 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:
objectService Get API Invoice model
Show Source
-
acceptanceAmount:
number
Acceptance Amount
-
amount:
number
Amount
-
anchorId:
string
Anchor Id
-
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
-
countryOfOrigin:
string
-
currency:
string
Currency
-
discountAllowed:
string
-
discountAmount:
number
-
discountPercentage:
number
-
discrepancyCode:
string
Discrepancy Code
-
disputedAmount:
number
Disputed amount
-
disputeResolveRemarks:
string
Dispute Resolve Remarks
-
divisionCode:
string
-
fileName:
string
File Name
-
fileRef:
string
File Reference
-
filler1:
string
Filler1
-
filler10:
string
Filler10
-
filler2:
string
Filler2
-
filler3:
string
Filler3
-
filler4:
string
Filler4
-
filler5:
string
Filler5
-
filler6:
string
Filler6
-
filler7:
string
Filler7
-
filler8:
string
Filler8
-
filler9:
string
Filler9
-
financeableAmount:
number
-
financeAmount:
number
-
financePercentage:
number
-
finTxnStatus:
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
-
invoiceProcessStatus:
string
Invoice Process Status
-
invoiceRefNo:
string
Invoice Reference Number
-
invoiceStatus:
string
Invoice Status
-
isAccepted:
string
Is Accepted
-
isAssigned:
string
Is Assigned
-
isAutoAuth:
string
-
isDisputed:
string
Is Disputed
-
isDisputeResolvedWriteOff:
string
Is Dispute Resolved Write Off
-
isFinanced:
string
Is Financed
-
isOverdue:
string
Is Overdue
-
linkedDocs:
string
Linked Docs
-
maxFinancePercentage:
number
Maximum Finance Percentage
-
minFinancePercentage:
number
Minimum Finance Percentage
-
miscCharge1:
number
-
miscCharge1Amount:
number
-
miscCharge1Desc:
string
-
miscCharge2:
number
-
miscCharge2Amount:
number
-
miscCharge2Desc:
string
-
netInvoiceAmount:
number
-
outstandingAmount:
number
-
paidAmount:
number
Paid Amount
-
paymentDueDate:
string
Payment Due Date
-
paymentStatus:
string
Payment Status
-
paymentTerms:
string
-
poNumber:
string
Po Number
-
preAccepted:
string
-
productCode:
string
Product Code
-
productType:
string
Product Type
-
programCode:
string
Program Code
-
programName:
string
-
purchaseOrderDate:
string
-
reasonCode:
string
Reason Code
-
reasonForExport:
string
-
relationCode:
string
Relation Code
-
remarks:
string
Remarks
-
repayAccountNo:
string
-
routingCode:
string
-
seqNo:
integer(int64)
-
shipmentAddress:
string
-
shipmentCountry:
string
-
shipmentDate:
string
-
shipmentNo:
string
-
shipmentRefNo:
string
-
spokeId:
string
Spoke Id
-
staleStatus:
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 : ScfNonCustomerAddress
Type:
Show Source
object-
addressLine1:
string
Address Line1
-
addressLine2:
string
Address Line2
-
addressLine3:
string
Address Line3
-
addressLine4:
string
Address Line4
-
country:
string
Country
-
pin:
string
Pin
-
street:
string
Street
Nested Schema : InvoiceCommodityGridModel
Type:
Show Source
object-
ccy:
string
-
commodityCode:
string
Commodity Code
-
commodityDesc:
string
-
commodityName:
string
-
costPerUnit:
number
Cost Per unit
-
costPerUnitInInvCcy:
number
Cost Per unit In Invoice currency
-
descriptionOfGoods:
string
-
discountAmount:
number
-
discountAmountInInvCcy:
number
Discount Amount In Invoice currency
-
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
-
isInherited:
string
-
netCost:
number
Net Cost
-
netCostInInvCcy:
number
Net Cost In Invoice currency
-
poExternalNumber:
string
-
poInternalNumber:
string
-
quantity:
number
Quantity
-
seqNo:
integer(int64)
-
taxAmount:
number
Tax Amount
-
taxAmountInInvCcy:
number
Tax Amount In Invoice currency
-
taxPercentage:
number
-
totalCost:
number
Total Cost
-
totalCostInInvCcy:
number
Total Cost In Invoice currency
-
totalWeight:
number
-
transactionRefNo:
string
-
unit:
string
-
unitWeight:
number
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error