POST POS/v3.2/Sales/Invoices/Search Try Now

Request Information

URI Parameters

None.

Body Parameters

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.
IncludeItems
boolean
None.
OrderBy
Sets the order by.(Note: Please use column Name Given in Response only,Don't use "Page" or "ItemsPerPage").
string
None.
SortOrder
The SortOrder i.e. "ASC" or "DESC"
string
None.
DateUpdated
Set Date Updated you can use either Date Updated Or UpdatedSince.
date
None.
UpdatedSince
Set From Date and To Date value. Return result for between date , From Date And To Date.
DateValue
None.
Page
Sets the page.
integer
None.
ItemsPerPage
Sets the items per page.
integer
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-10-18T15:58",
    "ToDate": "2019-10-18T15:59",
    "FilterByTime": true
  },
  "DateAdded": {
    "FromDate": "2019-10-18T15:58",
    "ToDate": "2019-10-18T15:59",
    "FilterByTime": true
  },
  "Tags": [
    ""
  ],
  "Location": "",
  "TrackingNumber": "",
  "IncludeItems": true,
  "OrderBy": "",
  "SortOrder": null,
  "DateUpdated": "2019-10-18T15:58",
  "UpdatedSince": {
    "FromDate": "2019-10-18T15:58",
    "ToDate": "2019-10-18T15:59",
    "FilterByTime": true
  },
  "Page": 13,
  "ItemsPerPage": 14
}

Response Information

Resource Description

NameDescriptionTypeAdditional information
InvoiceId
string
None.
InvoiceNumber
long
None.
InvoiceStatus
InvoiceStatus
None.
InvoiceDate
date
None.
DateExpected
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.
Items
Collection of InvoiceItemReponse
None.

Response Formats

application/json, text/json

Sample:
{
  "InvoiceId": "",
  "InvoiceNumber": 2,
  "InvoiceStatus": "Any",
  "InvoiceDate": "2019-10-18T15:58",
  "DateExpected": "2019-10-18T15:58",
  "DateUpdated": "2019-10-18T15:58",
  "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-10-18T15:58",
    "LabelId": ""
  },
  "Notes": "",
  "VoidReason": "",
  "Version": 13,
  "Currency": "",
  "DateVoided": "2019-10-18T15:58",
  "Tags": [
    ""
  ],
  "Items": [
    {
      "InvoiceId": "",
      "InvoiceItemId": "",
      "TicketNumber": 3,
      "Quantity": 4,
      "EventId": "",
      "VenueId": "",
      "Event": "",
      "Venue": "",
      "EventDate": "2019-10-18T15:58",
      "Section": "",
      "Row": "",
      "LowSeat": 12,
      "HighSeat": 13,
      "Seats": "",
      "Seating": "Any",
      "DateAdded": "2019-10-18T15:58",
      "TicketType": "Any",
      "PDFStatus": "Any",
      "BarcodeStatus": "Any",
      "Stock": "Any",
      "InHand": {
        "InHandStatus": "Any",
        "InHandDate": "2019-10-18T15:58"
      },
      "SubTotal": {
        "Currency": "",
        "Amount": 1.0
      },
      "Tax": {
        "Currency": "",
        "Amount": 1.0
      },
      "UnitPrice": {
        "Currency": "",
        "Amount": 1.0
      },
      "PurchasePrice": {
        "Currency": "",
        "Amount": 1.0
      },
      "SellPrice": {
        "Currency": "",
        "Amount": 1.0
      },
      "FacePrice": {
        "Currency": "",
        "Amount": 1.0
      },
      "Notes": "",
      "Location": "",
      "IsActive": true,
      "DateUpdated": "2019-10-18T15:58",
      "DeliveryMethod": "None"
    }
  ]
}