Overview

Returns a list of invoices.

Request

https://api.kometsales.com/api/invoice.list

  • Method: GET
  • Content-Type: URL Params

Input parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • orderDateFrom (required) (date): shipping date from (date format YYYY-MM-DD).
  • orderDateTo (required) (date): shipping date to (date format YYYY-MM-DD).
  • status: (optional)(integer:1) status of the order (0=Pending Approval,1=Confirmed), if this filter is not given, the system will return all the orders from the orderDate specified.
  • customer (optional)(string:200): customer name or code. You can obtain this value from the customer.list API method.
  • customerId (optional)(integer:20): customer Komet Sales internal ID. You can obtain this value from the customer.list API method.
  • locationId (optional)(integer:20): location Komet Sales internal ID. You can obtain this value from the location.list API method. This only applies for companies in Multi Location mode. 
  • carrierName (optional) (string:200): carrier name.
  • carrierId (optional)(integer:20): carrier ID. You can obtain this value from the carrier.list API method.
  • product (optional)(string:200): product description.
  • order (optional)(integer:10): order number.
  • orderId (optional)(integer:10): Komet Sales Order Id.
  • isEcommerce (optional)(boolean): true for E-commerce orders. false for regular phone orders. 
  • updatedAsOf (optional) (datetime) (date format YYYY-MM-DD hh:mm:ss): When provided it will force the method to only return orders that have been updated as of the date/time that is specified. Time must be in the GMT time zone
  • locationIds (optional)(integer:20): Komet Sales internal IDs of locations. You are able to enter several locations ID. You can obtain this value from the location.list API method. This only applies for companies in Multi Location mode.

You can send parameters such as the status, customer, customerId and product in order to filter the results. Filtering by status, carrierId or customerId the system uses an exact match. Filtering by customer and product uses a "LIKE" expression. Filters are not case sensitive. If you use the orderId and order filters, the system will ignore the orderDateFrom and orderDateTo filters. 

Sample 1
https://api.kometsales.com/api/invoice.list?authenticationToken=token_info_goes_here&orderDateFrom=2016-07-01&orderDateTo=2016-07-30

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.
  • message (string:500): description of the status of the transaction.
  • invoices: array of invoices
    • id (integer:20): Komet Sales internal invoice ID.
    • number (integer:10): invoice number.
    • customerId (integer:20): Komet Sales internal customer ID.
    • customerName (string:200): name of the customer.
    • customerCode (string:20): code of the customer.
    • billCity (string:200): billing city name.
    • billState (string:200): billing state name.
    • billAddress (string:200): billing address.
    • billZipCode (string:10): billing Zip Code.
    • billCountry (string:200): billing country name.
    • orderRef (string:20): reference order number.
    • shipName (string:200): Ship To name.
    • shipCity (string:200): ship city name.
    • shipState (string:200): ship state name.
    • shipAddress (string:200): ship address.
    • shipZipCode (string:10): ship zip code.
    • shipCountry (string:200): ship country name.
    • shipDate (date): ship date of the order. (date format YYYY-MM-DD).
    • carrierId (integer:20): carrier Komet Sales internal ID.
    • carrierName (string:200): carrier name.
    • carrierCode (string:20): carrier code.
    • salesPersonId (integer:20): salesperson Komet Sales internal ID.
    • salesPersonName (string:200): salesperson name.
    • locationId (integer:20): location Komet Sales internal ID.
    • locationName (string:200): location name.
    • customerPONumber (string:20): customer PO #.
    • totalBoxes (integer:10): total of boxes.
    • subtotal (decimal:10,2): total of the order. This amount does not include Additional Charges nor taxes.
    • additionalCharges (decimal:10,2): total of additional charges.
    • taxes (decimal:10,2): total of taxes.
    • total (decimal:10,2): total of the order. Subtotal + additionalCharges + taxes.
    • status (string:20): status of the order (Draft, Pending Approval, Confirmed)
    • countConfirmed (integer:10): number of times that the order has been confirmed.
    • isEcommerce (string:3): it will return "Yes" when the order was entered from the E-commerce site, otherwise it will be "No".
    • updatedOn (datetime): last time when the order was updated. (date format YYYY-MM-DD'T'hh:mm:ss). Time will be in the GMT time zone.
    • createdOn (datetime): time when the invoice was created. (date format YYYY-MM-DD'T'hh:mm:ss). Time will be in the GMT time zone
    • warehouseInstructions (string: 200): Order notes / instructions for the warehouse. 
    • invoiceNotes (string:200) Order notes for the customer that appear on the Invoice
    • customerGroup (string:20): Name of the Customer group to which the customer belongs.
    • customerMainLocationId (integer:20): Komet Sales internal ID of the customer's main location.