Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Returns a list of Vendor Invoices.

Excerpt

Use this method to get a list of Vendor Invoices

Tip

Valid Tokens: Company.


Filter by label (Content by label)
showLabelsfalse
max5
titleRelated Articles
cqllabel = "vendor-invoices"

Request


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

Method: GET

Content-Type: URL

Params

Parameters


Input parameters

authenticationToken (required)(string:50)

: Komet

Komet Sales security token.


statusId (required)(integer:1)

: the code of the vendor invoice status. Enter 1 for

Vendor Invoice status code.

Valid values: 1 = Pending Approval by Procurement

,

| 2

for Pending

= Pending Approval by Accounting

, 3 for Approved, 4 for Sent

| 3 = Approved | 4 = Sent to External System

,

| 5

for

= Failed

or

| 6

for Synchronized.

= Synchronized

poNumber  

poNumber (optional)(string:10)

:

Purchase

order

Order number.

 


arrivalDateFrom (

Required if the poNumber nor invoiceNumber are provided):  The date when the products within the purchase order arrives to the warehouse (date format YYYY-MM-DD). The difference between the arrivalDateFrom and shipDateTo must not exceed

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)

: The date when the products within the purchase order arrives to the warehouse  (date format

Purchase Order Warehouse arrival date.

Date format: YYYY-MM-DD

). The difference between the arrivalDateFrom and shipDateTo must not exceed

The maximum range between arrivalDateFrom and shipDateTo is 45 days.


invoiceNumber (optional)(string:10)

:

Vendor

invoice

Invoice number.


vendorCode (optional)(string:20)

:

Komet Sales internal Vendor Code

in Komet Sales

.

You can

obtain

get this value from

the  API

 API method.


approvalDateFrom (optional)

: Initial

Starting date when

vendor invoices

Vendor Invoices were approved by procurement.

 The difference between the approvalDateFrom and approvalDateTo must not exceed

 

The maximum range between approvalDateFrom and approvalDateTo is 45 days.


approvalDateTo (optional)

: Final

Ending date when

vendor invoices

Vendor Invoices were approved by procurement.

 The difference between the approvalDateFrom and approvalDateTo must not exceed

 

The maximum range between approvalDateFrom and approvalDateTo is 45 days.


locationId (optional)(integer: 20)

: company location

Location ID.

 You

 

You can

obtain

get this value from

the  API

 API method.

 

curl


Code Block
languagejs
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

Transaction status.

1 for success or 0 for failure/error.

Valid values: 1 = Success | 0 = Failure


message (string:500)

:

Transaction status description

of the request

.


vendorInvoices (array)

: array of vendor invoices

An array containing Vendor Invoices.


invoiceNumber (string:10)

:

Vendor

invoice

Invoice number.

 


locationId (integer:20)

:

Komet Sales internal

ID of the location

Location ID.

Only applies to Multi-Location Companies.


locationCode: locationCode (string:20)

: Location code of the AWB. It

AWB location code.

Only applies to Multi-Location

companies

Companies


locationName(string:200)

:

Location name.

Only applies to Multi-Location Companies.


poNumber (integer:10)

:

Purchase order number. 


poShipDate (date)

:

Purchase order

ship date

Ship Date.

 


poArrivalDate (date)

:

Purchase

order

Order arrival date.


vendorId (integer:10)

:

Komet Sales internal

vendor

Vendor ID.


vendorCode (string:20)

:

Vendor code associated to the House number. 


vendorName (string:200)

:

The name of the vendor.


vendorAccountingCode (string:50)

: The accounting code of the vendor

Vendor Accounting Code.


vendorType (string:20)

: The product

Product type provided by the

vendor

Vendor.


invoiceAmount (decimal:10,2)

:

Vendor invoice amount.


purchaseOrderSubtotal (decimal:10,2)

:

Purchase order subtotal (without additional charges).


totalAdditionalCharges (decimal:10,2)

: total amount of

Total additional charges.


purchaseOrderTotal (decimal:10,2)

:

Purchase order total amount.

purchaseOrderItems 

purchaseOrderItems (array)

: array of the

An array containing items within the

purchase orders

Purchase Orders.


categoryProcurementAccountingCode

: accounting procurement code of the category

Procuremente Accounting Category Code.


totalCost (decimal:10,2)

: total cost of the item

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"
}

Panel
titleRelated Articles
Filter by label (Content by label)showLabelsfalsemax10showSpacefalsesorttitlecqllabel in ( "invoice" , "order" , "invoice-creation" , "invoice-editing" )labelsinvoice invoice-creation order invoice-editing
We've encountered an issue exporting this macro. Please try exporting this page again later.