Request
Parameters
Input parameters
authenticationToken (required)(string:50)
Komet Sales security token.
statusId (required)(integer:1)
Vendor Invoice status code.
Valid values: 1 = Pending Approval by Procurement
| 2
= Pending Approval by Accounting
| 3 = Approved | 4 = Sent to External System
| 5
= Failed
| 6
= Synchronized
poNumber (optional)(string:10)
Purchase
Order number.
arrivalDateFrom (
required if poNumber
or invoiceNumber
are not sent)(date)
Purchase Order Warehouse arrival date.
Date format: YYYY-MM-DD
The maximum range between arrivalDateFrom
and shipDateTo
is 45 days.
arrivalDateTo (Required if the poNumber nor invoiceNumber are provided)
Purchase Order Warehouse arrival date.
Date format: YYYY-MM-DD
The maximum range between arrivalDateFrom
and shipDateTo
is 45 days.
invoiceNumber (optional)(string:10)
Vendor
Invoice number.
vendorCode (optional)(string:20)
Komet Sales internal Vendor Code
.
You can
get this value from
the vendor.list
API method.
approvalDateFrom (optional)
Starting date when
Vendor Invoices were approved by procurement.
The maximum range between approvalDateFrom
and approvalDateTo
is 45 days.
approvalDateTo (optional)
Ending date when
Vendor Invoices were approved by procurement.
The maximum range between approvalDateFrom
and approvalDateTo
is 45 days.
locationId (optional)(integer: 20)
Location ID.
You can
get this value from
the location.list
API method.
curl
Code Block | ||
---|---|---|
| ||
https://api.kometsales.com/api/vendor.invoice.list?authenticationToken=token_info_goes_here& orderDateFrom=2016-07-01&orderDateTo=2016-07-30 |
Response
Output
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
message (string:500)
Transaction status description
.
vendorInvoices (array)
An array containing Vendor Invoices.
invoiceNumber (string:10)
Vendor
Invoice number.
locationId (integer:20)
Komet Sales internal
Location ID.
Only applies to Multi-Location Companies.
locationCode: locationCode (string:20)
AWB location code.
Only applies to Multi-Location
Companies.
locationName(string:200)
Location name.
Only applies to Multi-Location Companies.
poNumber (integer:10)
Purchase order number.
poShipDate (date)
Purchase order
Ship Date.
poArrivalDate (date)
Purchase
Order arrival date.
vendorId (integer:10)
Komet Sales internal
Vendor ID.
vendorCode (string:20)
Vendor code associated to the House number.
vendorName (string:200)
The name of the vendor.
vendorAccountingCode (string:50)
Vendor Accounting Code.
vendorType (string:20)
Product type provided by the
Vendor.
invoiceAmount (decimal:10,2)
Vendor invoice amount.
purchaseOrderSubtotal (decimal:10,2)
Purchase order subtotal (without additional charges).
totalAdditionalCharges (decimal:10,2)
Total additional charges.
purchaseOrderTotal (decimal:10,2)
Purchase order total amount.
purchaseOrderItems (array)
An array containing items within the
Purchase Orders.
categoryProcurementAccountingCode
Procuremente Accounting Category Code.
totalCost (decimal:10,2)
Total item cost.
Sample Response
Code Block |
---|
{
"vendorInvoices": [
{
"invoiceNumber": "01-P002271",
"locationId": 3,
"locationCode": "02",
"locationName": "Chicago",
"poNumber": "P002271",
"poShipDate": "2020-03-27",
"poArrivalDate": "2020-03-27",
"vendorId": 29697,
"vendorCode": "",
"vendorName": "Miami L Vendor",
"vendorAccountingCode": null,
"vendorType": "Fresh Cut",
"invoiceAmount": 109.0,
"purchaseOrderSubtotal": 636.90771,
"totalAdditionalCharges": 0.0,
"purchaseOrderTotal": 636.90771,
"purchaseOrderItems": [
{
"categoryProcurementAccountingCode": "CGEN",
"totalCost": 359.14546
},
{
"categoryProcurementAccountingCode": "PGEN",
"totalCost": 277.76225
}
]
},
{
"invoiceNumber": "02-P002271",
"locationId": 3,
"locationCode": "02",
"locationName": "Chicago",
"poNumber": "P002271",
"poShipDate": "2020-03-27",
"poArrivalDate": "2020-03-27",
"vendorId": 29697,
"vendorCode": "",
"vendorName": "Miami L Vendor",
"vendorAccountingCode": null,
"vendorType": "Fresh Cut",
"invoiceAmount": 143.0,
"purchaseOrderSubtotal": 636.90771,
"totalAdditionalCharges": 0.0,
"purchaseOrderTotal": 636.90771,
"purchaseOrderItems": [
{
"categoryProcurementAccountingCode": "CGEN",
"totalCost": 359.14546
},
{
"categoryProcurementAccountingCode": "PGEN",
"totalCost": 277.76225
}
]
},
{
"invoiceNumber": "03-P002271",
"locationId": 3,
"locationCode": "02",
"locationName": "Chicago",
"poNumber": "P002271",
"poShipDate": "2020-03-27",
"poArrivalDate": "2020-03-27",
"vendorId": 29697,
"vendorCode": "",
"vendorName": "Miami L Vendor",
"vendorAccountingCode": null,
"vendorType": "Fresh Cut",
"invoiceAmount": 196.0,
"purchaseOrderSubtotal": 636.90771,
"totalAdditionalCharges": 0.0,
"purchaseOrderTotal": 636.90771,
"purchaseOrderItems": [
{
"categoryProcurementAccountingCode": "CGEN",
"totalCost": 359.14546
},
{
"categoryProcurementAccountingCode": "PGEN",
"totalCost": 277.76225
}
]
}
],
"message": "OK",
"status": "1"
}
|
title | Related Articles |
---|