| Excerpt | ||
|---|---|---|
Use this method to get a list with general information on several Invoices from a specific date range.
|
Filters are not case-sensitive.
| Filter by label (Content by label) | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Request
URL: https://api.kometsales.com/api/ invoice.accounting.details.list
Method: GET
Content-type: URL Parameters
Input parameters
authenticationToken (required)(string)
Komet Sales Security Token.
orderDateFrom (required)(date)
Shipping from date.
Date format: YYYY-MM-DD
The specified date range must not exceed 31 days.
orderDateTo (required) (date)
Shipping to date.
Date format: YYYY-MM-DD
The specified date range must not exceed 31 days.
status: (optional)(integer:1)
Order status.
Valid values: 1 = Confirmed | 0 = Pending Approval
If this filter is disabled; the system will return every order from the specified date range.
locationIds (optional)(integer:20)
List of Location IDs separated by colons.
You can get these values from the location.list API method.
Only applies to Multi-Location Companies.
excludeTransfer (optional)(boolean)
Exclude transfer order details.
Valid values: 1 = Only headers of transfer orders | 0 = Include every order detail
Default is 0.
externalSystemSynced (optional)(boolean)
Search only for orders according to their synchronization status.
Valid values: 1 = Synchronized | 0 = Pending
| Code Block | ||
|---|---|---|
| ||
https://api.kometsales.com/api/invoice.accounting.details.list
?authenticationToken={YOUR_TOKEN_HERE}
&orderDateFrom={2018-03-26}
&orderDateTo={2018-07-30} |
Response
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.
shipDate (date)
Order ship date.
Date format: YYYY-MM-DD
locationId (integer:20)
Komet Sales internal Location ID.
customerId (integer:20)
Komet Sales internal Customer ID.
customerName (string:200)
Customer name.
customerCode (string:20)
Customer code.
subtotal (decimal:10,2)
Order total before additional charges and taxes.
taxes (decimal:10,2)
Total taxes.
additionalCharges (decimal:10,2)
Total additional charges.
totalAmount (decimal:10,2)
Total of the order.
Calculated with: subtotal + additionalCharges + taxes
salesPersonName (string:200)
Name of the Salesperson on the order.
salesPersonCode (string:20)
Salesperson ID.
accountingCodeSummary (array)
An array containing accounting codes associated with the invoice.
accountingCode (string:20)
Accounting code associated with the product sold, additional charge, or tax.
amount (decimal:10,2)
Total amount of the accounting code under the invoice.
| Code Block |
|---|
{
"invoices": [
{
"id": 454438,
"number": 7134,
"shipDate": "2021-06-16",
"locationId": null,
"customerName": "Customer Credit New 14",
"customerCode": "CCN14",
"customerId": 29948,
"subtotal": 702.6,
"taxes": 0,
"additionalCharges": 112.46,
"totalAmount": 815.07,
"salesPersonName": "Catalina -",
"salesPersonCode": "CT",
"accountingCodeSummaries": [
{
"accountingCode": "AF999",
"amount": 5
},
{
"accountingCode": "UNKNOWN",
"amount": 810.07
}
]
}
],
"message": "OK",
"status": "1"
} |