Get a Detailed K2K Invoice List

URL: https://api.kometsales.com/api/v2/invoice/k2k

Method: GET

Content-Type: application/JSON

Input parameters

authenticationToken (required)(string:50)

Komet Sales security token.

orderDate (required)(date)

Shipping date.

You can also use orderDateFrom, orderDateTo, order or orderId instead of this field.

Date format: YYYY-MM-DD

orderDateFrom (optional)(date)

Shipping date from.

The specified range must not exceed four days.

Date format: YYYY-MM-DD 

orderDateTo (optional)(date)

Shipping date to.

The specified date range must not exceed four days.

Date format: YYYY-MM-DD 

status (optional)(integer:1)

Order status.

If you leave this field empty, the system will return every order regardless of it’s status from the specified date range in orderDate.

Valid values: 0 = Pending Approval | 1 = Confirmed

customer (optional)(string:200)

Customer’s name or code.

You can get this value from the customer.list API method.

customerId (optional)(integer:20)

Komet Sales internal Customer ID.

You can get this value from the customer.list API method.

carrierName (optional)(string:200)

Carrier name.

carrierId (optional)(integer:20)

Carrier ID.

You can get 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 internal Order ID.

locationId (optional)(integer:20)

Komet Sales internal Location ID.

You can get this value from the location.list API method.

Only applies to Multi-Location Companies.

locationIds (optional)(integer:20)

List of Location IDs. Separate each ID with a comma.

You can get these values from the location.list API method.

Only applies to Multi-Location Companies.

updatedAsOf (optional)(datetime) 

Return only orders that were updated from a specific date.

Date format: YYYY-MM-DD hh:mm:ss

Time must be in the GMT time zone.

itemType (optional)(string:3)

Item type.

If you don’t send this parameter, the system will only return boxes and not units.

Valid values: box = Boxes | UN = Units | ALL = Every item

excludeCustomerIds (optional)(string:20)

List of Customer IDs that you want to exclude from the results.

excludeTransfer (optional)(boolean)

List only the header of transfer orders without details.

Valid values: 1 = Yes | 0 = Include all orders

Default is zero.

externalSystemSynced (optional)(boolean)

Include only orders according to their synchronization status.

Valid values: 1 = Synchronized orders | 0 = Pending Synchronization

excludeBoxesInfo (optional)(boolean)

Exclude the boxes array from the response.

Valid values: 1 = Yes | 0 = No

You can increase performance by excluding this array.

excludeBreakdownInfo (optional)(boolean)

Exclude the breakdown array from the response.

Valid values: 1 = Yes | 0 = No

You can increase performance by excluding this array.

status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure

message (string:500)

Transaction status description.

invoices (array)

An array containing 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)

Customer name.

customerCode (string:20)

Customer code.

carrierAccount (integer:20)

The carrier acount number.

Only applies if the invoice has a carrier acount assigned.

shipToCode (string:20)

The shipping address code.

billCity (string:200)

Billing address city.

billState (string:200)

Billing address state.

billAddress (string:200):

Billing address street.

billZipCode (string:10)

Billing address ZIP code.

billCountry (string:200)

Billing address country.

orderRef (string:20)

Order reference number.

shipName (string:200)

Ship To name.

shipCity (string:200)

Ship To address city.

shipState (string:200)

Ship To address State.

shipAddress (string:200)

Ship To address street.

shipZipCode (string:10)

Ship To address zip code.

shipCountry (string:200)

Ship To address country.

shipDate (date)

Order shipping date.

Date format: YYYY-MM-DD

carrierId (integer:20)

Komet Sales internal Carrier ID.

carrierName (string:200)

Carrier name.

carrierCode (string:20)

Carrier code.

salesPersonId (integer:20)

Komet Sales internal Salesperson ID.

salesPersonName (string:200)

Salesperson name.

locationName(string:200)

Location name.

locationId (integer:20)

Komet Sales internal Location ID.

mainLocationName (string:200)

Main location name.

mainLocationId (integer:20)

Komet Sales internal Main Location ID.

customerPONumber (string:20)

Customer PO#.

totalBoxes (integer:10)

Total boxes.

subtotal (decimal:10,2)

Total of the order.

This amount does not include Additional Charges or taxes.

additionalCharges (decimal:10,2)

Total additional charges.

additionalChargesDetails (array)

An array containing additional charges in the order.

name (string:200)

Additional charge name.

amount (decimal:10,2)

Additional charge amount.

accountingCode (string:20)

Additional charge accounting code. 

taxes (decimal:10,2)

Total taxes.

taxesDetails (array)

An array containing taxes in the order.

name (string:200)

Name of the tax.

percentage (decimal:10,2)

Current tax percentage.

accountingCode (string:20)

Tax accounting code. 

amount (decimal: 10,2)

Total tax amount.

total (decimal:10,2)

Order total.

Calculated with subtotal + additionalCharges + taxes

status (string:20)

Order status.

Valid values: Draft, Pending Approval, Confirmed

confirmedOn (datetime)

Date and time when the order was confirmed. 

Date format: YYYY-MM-DD'T'hh:mm:ss 

Time is in the GMT time zone.

countConfirmed (integer:10)

Number of times that the order has been confirmed.

isEcommerce (string:3)

If the order comes from the E-Commerce.

Valid values: Yes or No

externalSystemsSynced (array)

An array of external systems that have been marked as synced.

externalSystemId (internal:10)

External system ID

syncDate (date)

Date and time when the order was synced.

Time is in the UTC time zone.

updatedOn (datetime)

Last time when the order was updated.

Date format: YYYY-MM-DD'T'hh:mm:ss 

Time is in the GMT time zone.

warehouseInstructions(string: 200)

Order notes and instructions for the warehouse. 

invoiceNotes (string:200)

Order notes for the customer that appear on the Invoice.

totalCost (decimal:10,2)

Total cost of the order.

This includes cost of the items in boxes, units and hard goods. 

totalLandedCost (decimal:10,2)

Total landed cost of the order.

This total includes landed cost of the items in boxes, units and hard goods. 

details (array)

An array containing order details.

detailId (integer:20)

Komet Sales internal Order Line ID.

awb (string:20)

AWB number or shipment reference number.

ref (string:20)

Product line reference number.

productId (integer:20)

Product Komet Sales internal ID.

productDescription (string:200)

Product description.

productCode (string:20)

Product code, also known as Product Legacy Code. 

categoryAccountingCode (string:20)

Category accounting code. 

growerId (integer:20)

Komet Sales internal Grower or Vendor ID.

growerCode (string:50)

Grower or Vendor code.

growerName (string:200)

Grower or Vendor name.

totalBoxes (integer:10)

Number of boxes in the product line.

boxTypeId (integer:20)

Komet Sales internal Box Typed ID.

boxType (string:3)

Box type code.

units (integer:10)

Units per Box.

unitType (string:10)

Unit type.

Valid values: Stem or Bunch

totalUnits (integer:10)

Total units in the product line.

bunchesBox (integer:10)

Bunches per box.

stemsBunch (integer:10)

Stems per Bunch.

markCode (string:50)

Mark code.

notes (string:200)

Additional notes or label instructions.

unitPrice (decimal:10,2)

Unit price.

amount (decimal:10,2)

The amount of the product line.

Unit Price times total units.

salesType (string:1)

Sales type.

Valid values: M = Open Market | P = Prebook | S = Standing Order | L = Local

flowerCost (decimal:10,5)

Unit flower cost.

freightCost (decimal:10,5)

Freight cost per unit.

handling (decimal:10,5)

Handling cost per unit.

duties (decimal:10,5)

Duties cost per unit.

otherCharges (decimal:10,5)

Other cost charges per unit.

landedCost (decimal:10,5)

Landed cost per unit.

prebookNumber (integer:10)

Prebook number associated to the invoice. 

productAlias (string: 200)

Product alias specified by the salesperson.

salesChannel (integer:1)

Sales channel.

Valid values: 0 = Web App. | 1 = Mobile | 2 = K2K  

aging (integer: 5)

Number of days that represents the age of the product based on the ship date of the order.

breakdowns (array)

An array containing breakdown information.

detailId (integer:20)

Komet Sales internal Order Line ID.

productId (integer:20)

Komet Sales internal Product ID.

productDescription (string:200)

Product description.

stemsBunch (integer:10)

Stems per bunch.

bunches (integer:10)

Number of bunches.

price (decimal:10,2)

Unit price.

buyerCompanyId (integer:20)

The Company ID of the buyer party in the K2K transaction.

Only applies to K2K Orders.

buyerPoItemId (integer:20)

The ID of the product in the Purchase Order of a K2K transaction.

Only applies to K2K Orders.

boxes (array)

An array containing boxes.

detailId (integer:20)

Komet Sales Internal Order Line ID

boxCode (string:10)

Box code or box number.

inventoryLineId (integer:20)

Inventory line ID. 

lotNumber (string)

Lot number.

position (string:5)

Rack position or location.

statusId (integer:20)

Komet Sales internal Status ID.

statusName (string:20)

Status name.

Valid values: Farm Shipped, Received Warehouse, or Shipped Warehouse

detailsUnits (array)

An array containing Units details.

detailId (integer:20)

Komet Sales Internal Unit Line ID.

awb (string:20)

AWB number.

productId (integer:20)

Komet Sales internal Product ID.

productDescription (string:200)

Product description.

productCode (string:20)

Product code, also known as Product Legacy Code.

categoryAccountingCode (string:20)

Category accounting code. 

growerId (integer:20)

Komet Sales internal Grower or Vendor ID.

growerCode (string:50)

Grower or Vendor code.

growerName (string:200)

Grower or Vendor name.

totalUnits (array)

Number of Units in the product line.

stemsBunch (integer:10)

Stems per Bunch.

unitType (string:10)

Stem or Bunch.

totalUnits (integer:10)

Total units in the product line.

unitPrice (decimal:10,2)

Unit price.

amount (decimal:10,2)

The amount of the product line. 

Calculated with: unitPrice x totalUnits

markCode (string:50)

Mark code.

notes (string:200)

Additional notes or label instructions.

flowerCost (decimal:10,50)

Flower cost per Unit.

freightCost (decimal:10,5)

Freight cost per unit.

handling (decimal:10,5)

Handling cost per unit.

duties (decimal:10,5)

Duties cost per unit.

otherCharges (decimal:10,5)

Other cost charges per unit.

landedCost (decimal:10,5)

Landed cost per unit.

productAlias (string: 200)

Product alias specified by the salesperson.