Jump to

• Request
• Response

Retrieves the list of existing invoices

get

/service/v1/invoiceSearch

This endpoint is used to get the list of existing invoices.

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : ServiceInvoiceCollection

Type: object

Collection of Main Invoices.

Show Source

• invoiceList(optional): array invoiceList

{
    "description":"Collection of Main Invoices.",
    "type":"object",
    "properties":{
        "invoiceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ServiceInvoiceModel"
            }
        }
    }
}

Nested Schema : invoiceList

Type: array

Show Source

• Array of: object ServiceInvoiceModel
  Service Get API Invoice model

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

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

{
    "description":"Service Get API Invoice model",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64"
        },
        "invoiceId":{
            "description":"Id of the Invoice ",
            "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/ScfNonCustomerAddress"
            }
        },
        "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"
        },
        "filler5":{
            "type":"string",
            "description":"Filler5"
        },
        "filler6":{
            "type":"string",
            "description":"Filler6"
        },
        "filler7":{
            "type":"string",
            "description":"Filler7"
        },
        "filler8":{
            "type":"string",
            "description":"Filler8"
        },
        "filler9":{
            "type":"string",
            "description":"Filler9"
        },
        "filler10":{
            "type":"string",
            "description":"Filler10"
        },
        "financeAmount":{
            "type":"number"
        },
        "financePercentage":{
            "type":"number"
        },
        "indicator":{
            "type":"string",
            "description":"Indicator"
        },
        "invoiceDate":{
            "type":"string",
            "description":"Invoice date"
        },
        "invoiceDueDate":{
            "type":"string",
            "description":"Invoice due date"
        },
        "invoiceNumber":{
            "type":"string",
            "description":"Invoice Number"
        },
        "invoiceProcessStatus":{
            "type":"string",
            "description":"Invoice Process Status"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Reference Number"
        },
        "invoiceStatus":{
            "type":"string",
            "description":"Invoice Status"
        },
        "invAcceptanceDate":{
            "type":"string",
            "description":"Invoice 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/ScfNonCustomerAddress"
            }
        },
        "supplierDivCode":{
            "type":"string",
            "description":"Supplier Division Code"
        },
        "supplierDivName":{
            "type":"string",
            "description":"Supplier Division Name"
        },
        "taxAmount":{
            "type":"number",
            "description":"Tax Amount"
        },
        "totalInvoiceAmount":{
            "type":"number",
            "description":"Total Invoice 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"
        },
        "netInvoiceAmount":{
            "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"
        },
        "paymentDueDate":{
            "type":"string",
            "description":"Payment Due Date"
        },
        "disputedAmount":{
            "type":"number",
            "description":"Disputed amount"
        },
        "invoiceCommodityGridList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InvoiceCommodityGridModel"
            }
        }
    }
}

Nested Schema : buyerAddress

Type: array

Show Source

• Array of: object ScfNonCustomerAddress

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

Nested Schema : invoiceCommodityGridList

Type: array

Show Source

• Array of: object InvoiceCommodityGridModel

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

Nested Schema : supplierAddress

Type: array

Show Source

• Array of: object ScfNonCustomerAddress

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

Nested Schema : ScfNonCustomerAddress

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "addressLine1":{
            "type":"string",
            "description":"Address Line1"
        },
        "addressLine2":{
            "type":"string",
            "description":"Address Line2"
        },
        "addressLine3":{
            "type":"string",
            "description":"Address Line3"
        },
        "addressLine4":{
            "type":"string",
            "description":"Address Line4"
        },
        "country":{
            "type":"string",
            "description":"Country"
        },
        "pin":{
            "type":"string",
            "description":"Pin"
        },
        "street":{
            "type":"string",
            "description":"Street"
        }
    }
}

Nested Schema : InvoiceCommodityGridModel

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

{
    "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"
        },
        "isInherited":{
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top