POST POS/Sales/Invoices/Search Try Now

Search Invoice

Request Information

URI Parameters

NameDescriptionTypeAdditional information

Body Parameters

The request.

NameDescriptionTypeAdditional information
InvoiceId
string
None.
InvoiceNumber
long
None.
ExternalOrderNumber
string
None.
CustomerId
string
None.
Email
string
None.
Company
string
None.
ShippingStatus
Collection of ShippingStatus
None.
PaymentStatus
Collection of PaymentStatus
None.
InvoiceStatus
Collection of SearchInvoiceStatus
None.
ZoneCode
Zone
None.
InvoiceDate
DateValue
None.
DateAdded
DateValue
None.
Tags
Collection of string
None.
Location
string
None.
TrackingNumber
string
None.
Page
integer
None.
ItemsPerPage
integer
None.
OrderBy
string
None.
SortOrder
string
None.
DateUpdated
date
None.
UpdatedSince
DateValue
None.

Request Formats

application/json, text/json

Sample:
{
  "InvoiceId": "",
  "InvoiceNumber": 2,
  "ExternalOrderNumber": "",
  "CustomerId": "",
  "Email": "",
  "Company": "",
  "ShippingStatus": [
    "Any"
  ],
  "PaymentStatus": [
    "Any"
  ],
  "InvoiceStatus": [
    "Any"
  ],
  "ZoneCode": "Any",
  "InvoiceDate": {
    "FromDate": "2019-01-16T12:01",
    "ToDate": "2019-01-16T12:02",
    "FilterByTime": true
  },
  "DateAdded": {
    "FromDate": "2019-01-16T12:01",
    "ToDate": "2019-01-16T12:02",
    "FilterByTime": true
  },
  "Tags": [
    ""
  ],
  "Location": "",
  "TrackingNumber": "",
  "Page": 9,
  "ItemsPerPage": 10,
  "OrderBy": "",
  "SortOrder": null,
  "DateUpdated": "2019-01-16T12:01",
  "UpdatedSince": {
    "FromDate": "2019-01-16T12:01",
    "ToDate": "2019-01-16T12:02",
    "FilterByTime": true
  }
}

Response Information

Resource Description

NameDescriptionTypeAdditional information
InvoiceId
string
None.
InvoiceNumber
long
None.
InvoiceStatus
InvoiceStatus
None.
InvoiceDate
date
None.
DateExpected
date
None.
DateReceived
date
None.
DateUpdated
date
None.
CustomerId
string
None.
Company
string
None.
Phone
string
None.
Email
string
None.
PaymentStatus
PaymentStatus
None.
ZoneCode
Zone
None.
ExternalOrderNumber
string
None.
SubTotal
Money
None.
Tax
Money
None.
ServiceFee
Money
None.
Commission
Money
None.
Discount
Money
None.
GrandTotal
Money
None.
BalanceAmount
Money
None.
Shipping
ShippingInfo
None.
Notes
string
None.
VoidReason
string
None.
Version
integer
None.
Currency
string
None.
DateVoided
date
None.
Tags
Collection of string
None.

Response Formats

application/json, text/json

Sample:
{
  "InvoiceId": "",
  "InvoiceNumber": 2,
  "InvoiceStatus": "Any",
  "InvoiceDate": "2019-01-16T12:01",
  "DateExpected": "2019-01-16T12:01",
  "DateReceived": "2019-01-16T12:01",
  "DateUpdated": "2019-01-16T12:01",
  "CustomerId": "",
  "Company": "",
  "Phone": "",
  "Email": "",
  "PaymentStatus": "Any",
  "ZoneCode": "Any",
  "ExternalOrderNumber": "",
  "SubTotal": {
    "Currency": "",
    "Amount": 1.0
  },
  "Tax": {
    "Currency": "",
    "Amount": 1.0
  },
  "ServiceFee": {
    "Currency": "",
    "Amount": 1.0
  },
  "Commission": {
    "Currency": "",
    "Amount": 1.0
  },
  "Discount": {
    "Currency": "",
    "Amount": 1.0
  },
  "GrandTotal": {
    "Currency": "",
    "Amount": 1.0
  },
  "BalanceAmount": {
    "Currency": "",
    "Amount": 1.0
  },
  "Shipping": {
    "Cost": 1.0,
    "Status": "Any",
    "Type": "None",
    "Carrier": "None",
    "Service": "",
    "TrackingNumber": "",
    "DateShipped": "2019-01-16T12:01",
    "LabelId": ""
  },
  "Notes": "",
  "VoidReason": "",
  "Version": 14,
  "Currency": "",
  "DateVoided": "2019-01-16T12:01",
  "Tags": [
    ""
  ]
}