Get a detailed Invoice list
- Andres Toledo
You can send parameters such as the status, customer, customerId and product in order to filter the results.
When you use filters, take the following statements into account:
Filtering by
status,carrierIdorcustomerIdthe system uses an exact match.Filtering by
customerandproductuses a "LIKE" expression.Filters are not case-sensitive.
Request
URL: https://api.kometsales.com/api/invoice.details.list
Method: GET
Content-Type: URL Parameters
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
includeMappingK2k (optional)(boolean)
Include the buyer’s company ID and PO item ID for K2K orders.
Valid values: 0 = No | 1 = Yes
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.
https://api.kometsales.com/api/invoice.details.list?
authenticationToken=YOUR_TOKEN_HERE&orderDate=2018-03-26&itemType=ALLResponse
invoices (array)
An array containing Invoices.
billState (string:200)
Billing address state.
customerCode (string:20)
Customer code.
taxes (decimal:10,2)
Total taxes.
shipName (string:200)
Ship To name.
totalBoxes (integer:10)
Total boxes.
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.
totalCubes (decimal:10,2)
Total cubes from all invoices in the response.
createdOn (date)
Invoice creation date.
Date format: YYYY-MM-DD:HH:MM:SS
shipCountry (string:200)
Ship To address country.
number (integer:10)
Invoice number.
total (decimal:10,2)
Order total.
Calculated with subtotal + additionalCharges + taxes
carrierName (string:200)
Carrier name.
carrierAccount (integer:20)
The carrier account number.
It only applies if the invoice has a carrier account assigned.
billZipCode (string:10)
Billing address ZIP code.
locationId (integer:20)
Komet Sales internal Location ID.
shipToCode (integer)
The code of the selected Ship To address.
customerId (integer:20)
Komet Sales internal Customer ID.
salesPersonName (string:200)
Salesperson name.
salesPersonCode (string)
Salesperson code.
details (array)
An array containing order details.
flowerCost (decimal:10,50)
Unit flower cost.
stemsBunch (integer:10)
Stems per Bunch.
notes (string:200)
Additional notes or label instructions.
Color (string)
Product color.
otherCharges (decimal:10,5)
Other cost charges per unit.
breakdowns (array)
An array containing breakdown information.
productId (integer:20)
Komet Sales internal Product ID.
stemsBunch (integer:10)
Stems per bunch.
bunches (integer:10)
Number of bunches.
price (decimal:10,2)
Unit price.
detailId (integer:20)
Komet Sales internal Order Line ID.
units (integer:10)
Units per Box.
totalBoxes (integer:10)
Number of boxes in the product line.
salesChannel (integer:1)
Sales channel.
Valid values: 0 = Web App. | 1 = Mobile | 2 = K2K
unitType (string:10)
Unit type.
Valid values: Stem or Bunch
totalCubes (decimal:10,2)
Total cubes in the invoice.
ref (string:20)
Product line reference number.
variety (string)
Product variety.
boxTypeId (integer:20)
Komet Sales internal Box Typed ID.
growerId (integer:20)
Komet Sales internal Grower or Vendor ID.
growerName (string:200)
Grower or Vendor name.
productDescription (string:200)
Product description.
salesType (string:1)
Sales type.
Valid values: M = Open Market | P = Prebook | S = Standing Order | L = Local
unitPrice (decimal:10,2)
Unit price.
boxes (array)
An array containing boxes.
statusId (integer:20)
Komet Sales internal Status ID.
statusName (string:20)
Status name.
Valid values: Farm Shipped, Received Warehouse, or Shipped Warehouse
detailId (integer:20)
Komet Sales internal Order Line ID.
inventoryLineId (integer:20)
Inventory line ID.
lotNumber (string)
Lot number.
boxCode (string:10)
Box code or box number.
amount (decimal:10,2)
The amount of the product line.
Calculated with: unitPrice x totalUnits
orderSource (string)
Order Source. It will only be populated if the order has an added source.
growerCode (string:50)
Grower or Vendor code.
growerName (string:200)
Grower or Vendor name.
landedCost (decimal:10,5)
Landed cost per unit.
productId (integer:20)
Product Komet Sales internal ID.
productCode (string:20)
Product code, also known as Product Legacy Code.
boxType (string:3)
Box type code.
awb (string:20)
AWB number or shipment reference number.
productAlias (string: 200)
Product alias specified by the salesperson.
totalUnits (integer:10)
Total units in the product line.
markCode (string:50)
Mark code.
grade (string)
Product grade.
markCode (string:50)
Mark code.
bunchesBox (integer:10)
Bunches per box.
prebookNumber (integer:10)
Prebook number associated to the invoice.
handling (decimal:10,5)
Handling cost per unit.
freightCost (decimal:10,5)
Freight cost per unit.
aging (integer:5)
Number of days that represents the age of the product based on the ship date of the order.
Category (string)
Product category name.
categoryAccountingCode (string:20)
Category accounting code.
growerId (integer:20)
Komet Sales internal Grower or Vendor ID.
totalCost (decimal:10,2)
Total cost of the order.
This includes the cost of the items in boxes, units, and hard goods.
duties (decimal:10,5)
Duties cost per unit.
id (integer:20)
Komet Sales internal Invoice ID.
shipZipCode (string:10)
Ship To address zip code.
salesPersonId (integer:20)
Komet Sales internal Salesperson ID.
shipCity (string:200)
Ship To address city.
isEcommerce (string:3)
If the order comes from the E-Commerce.
Valid values: Yes or No
detailsUnits (array)
An array containing Units details.
detailId (integer:20)
Komet Sales Internal Unit Line ID.
locationName(string:200)
Location name.
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.
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.
mainLocationName (string:200)
Main location name.
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.
mainLocationId (integer:20)
Komet Sales internal Main Location ID.
billCity (string:200)
Billing address city.
billCountry (string:200)
Billing address country.
shipDate (date)
Order shipping date.
Date format: YYYY-MM-DD
customerName (string:200)
Customer name.
warehouseInstructions(string: 200)
Order notes and instructions for the warehouse.
shipAddress (string:200)
Ship To address street.
invoiceNotes (string:200)
Order notes for the customer that appear on the Invoice.
additionalCharges (decimal:10,2)
Total additional charges.
orderRef (string:20)
Order reference number.
billAddress (string:200)
Billing address street.
customerPONumber (string:20)
Customer PO#.
subtotal (decimal:10,2)
Total of the order.
This amount does not include Additional Charges or taxes.
carrierCode (string:20)
Carrier code.
shipState (string:200)
Ship To address State.
shipToID (integer)
The ID of the selected Ship To address.
carrierId (integer:20)
Komet Sales internal Carrier ID.
totalBoxesWithoutCubes(integer:20)
Total boxes without cubes.
totalLandedCost (decimal:10,2)
Total landed cost of the order.
This total includes landed cost of the items in boxes, units and hard goods.
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.
buyerProductId (integer)
Buyer’s K2K product ID.
buyerPoItemId (integer)
K2K buyer purchase order product ID.
position (string:5)
Rack position or location.
categoryAccountingCode (string:20)
Category accounting code.
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.
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
message (string:500)
Transaction status description.
{
"invoices": [
{
"billState": "FL",
"customerCode": "3908",
"taxes": "0.00",
"shipName": "Toronto",
"totalBoxes": 2,
"externalSystemsSynced": [],
"totalCubes": 0.86,
"createdOn": "2024-06-04T15:49:16",
"shipCountry": "Canada",
"number": "4837",
"total": "119.31",
"carrierName": "Armellini",
"billZipCode": "33015",
"locationId": 2,
"shipToCode": "7475",
"customerId": "29687",
"salesPersonName": "Bill Doran Multi",
"salesPersonCode": "BDM"
"details": [
{
"flowerCost": "0.35000",
"stemsBunch": 25,
"notes": "",
"color": "Red",
"otherCharges": "0.01200",
"breakdowns": [],
"detailId": 3555380,
"units": 100,
"totalBoxes": 2,
"salesChannel": 0,
"unitType": "Stem",
"totalCubes": 0.86,
"ref": "",
"variety": "",
"boxTypeId": 1057,
"growerName": "Connectaflor",
"productDescription": "Roses Red 50 Cm",
"salesType": "M",
"unitPrice": "0.528",
"boxes": [
{
"statusId": 1,
"statusName": "Farm Shipped",
"detailId": 3555380,
"inventoryLineId": 3303323,
"lotNumber": "12287",
"boxCode": "MI12507069"
},
{
"statusId": 1,
"statusName": "Farm Shipped",
"detailId": 3555380,
"inventoryLineId": 3303323,
"lotNumber": "12287",
"boxCode": "MI12507070"
}
],
"amount": "105.60",
"orderSource": "Order Source 2",
"growerCode": "E680",
"landedCost": "0.42275",
"productId": 330081,
"boxType": "HB",
"awb": "777-7777-7777",
"productAlias": "",
"totalUnits": 200,
"markCode": "",
"grade": "50 Cm",
"bunchesBox": 4,
"prebookNumber": "",
"handling": "0.02000",
"freightCost": "0.02500",
"aging": "8",
"category": "Roses",
"growerId": 25245,
"totalCost": "0.00000",
"duties": "0.01575"
}
],
"id": 1875845,
"shipZipCode": "M5J 0A8 ",
"salesPersonId": "136",
"shipCity": "Toronto",
"isEcommerce": "No",
"detailsUnits": [],
"locationName": "Rockford",
"additionalChargesDetails": [
{
"amount": 3.15,
"accountingCode": "",
"name": "Duties"
},
{
"amount": 10.56,
"accountingCode": "",
"name": "IVA"
}
],
"taxesDetails": [],
"mainLocationId": 1,
"updatedOn": "2024-06-04T19:50:11",
"mainLocationName": "Bill Doran Company",
"billCity": "Hialeah",
"shipDate": "2024-06-04",
"customerName": "Any Flower For You LLC",
"warehouseInstructions": "",
"shipAddress": "120 Bremner Blvd., Suite 800",
"invoiceNotes": "",
"additionalCharges": "13.71",
"orderRef": "",
"billAddress": "16901 NW 75 Ct",
"customerPONumber": "",
"subtotal": "105.60",
"carrierCode": "AR",
"shipState": "ON",
"shipToId": "20281",
"carrierId": 1357,
"totalBoxesWithoutCubes": 1,
"totalLandedCost": "84.55",
"totalCost": "70.00",
"status": "Pending"
}
],
"message": "OK",
"status": 1
}
Related Articles
-
-
Set Up Additional Invoice Charges (Knowledge Base)
-
How Does the System Calculate the FOB price? (Knowledge Base)
-
-
Invoice Additional Charges (Knowledge Base)