URL: https://api.kometsales.com/api/credit.details.list

Method: POST

Content-Type: application/JSON

Input parameters

authenticationToken (required)(string:50)

Komet Sales security token.

creditDateFrom (required)(date)

Credit starting date.

Date format: YYYY-MM-DD

creditDateTo (required)(date)

Credit expiring date.

Date format: YYYY-MM-DD

itemType (required)(string)

The item type.

Valid values: box | UN (unit) | all

status (optional)(integer:1)

Credit status.

If this field is empty, the system will return every credit order for the used filters.

Valid values: 1 = New | 2 = Pending Review | 3 = Approved | 4 = Rejected | 5 = Resubmitted

customer (optional)(string:200)

Customer name or code.

customerId (optional)(integer:20)

Customer ID. Use this field to search orders related to a specific Customer.

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

carrierName (optional)(string:200)

Carrier name.

carrierId (optional)(integer:20)

Carrier ID. Use this field to search orders related to a specific Carrier.

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

product (optional)(string:200)

Product description.

number (optional)(integer:10)

Credit Order number, this number is the same as the Invoice number.

locationId (optional)(integer:20)

Location ID. This filter is used if your company is Multi Location.

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

externalSystemSynced (optional)(boolean)

Search credits by synchronization status.

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

status (integer:1)

Transaction status. 1 = Success | 0 = Failure

message (string:500)

Transaction status description.

credits (array)

An array containing Customer Credits.

id (integer:20)

Komet Sales internal Credit ID.

creditNumber (string:10)

Credit number.

customerId (integer:20)

Komet Sales internal Customer ID.

customerName (string:200)

Customer name.

shipDate (date)

Order shipping date.

Date format: YYYY-MM-DD

orderNumber (integer:10)

Order number associated to the credit.

carrierId (integer:20)

Komet Sales internal Carrier ID.

carrierName (string:200)

Carrier name.

salesPersonId (integer:20)

Komet Sales internal salesperson ID.

salesPersonName (string:200)

Invoice salesperson name.

customerSalesPersonName (string:200)

Name of the salesperson associated to the Customer.

locationId (integer:20)

Komet Sales internal Location ID.

locationName (string:200)

Location name.

customerPONumber (string:20)

Customer PO #.

totalBoxesOrder (decimal:10,2)

Number of boxes sold in the order.

totalOrder (decimal:10,2)

Total amount of the order.

Calculated with: Flowers Sale + Additional Charges + Taxes

totalCredit (decimal:10,2)

Total credit amount.

returnedTax (decimal:10,2)

Reimbursed tax.

approvedDate (date)

Credit approval date.

Date format: YYYY-MM-DD

externalSystemSynced (boolean)

If the credit is synchronized with an external system.

Valid values: 1 = Yes | 0 = No

syncDate (datetime)

Date and time when the credit was synchronized with an external system.

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

Time zone is GMT.

status (string:20)

Credit status.

additionalChargesDetails (array)

An array containing additional charges in the credit.

name (string:200)

Additional charge name.

amount (decimal:10,2)

Additional charge credit amount.

accountingCode (string:20)

Additional charge accounting code.

 details (array)

An array containing order details.

detailId (integer:20)

Komet Sales internal Credit item ID.

awb (string:20)

AWB number.

productId (integer:20)

Komet Sales internal Product ID.

productDescription (string:200)

Product description.

categoryAccountingCode (string:20)

Category accounting code. 

growerId (integer:20)

Komet Sales internal Vendor ID.

growerName (string:200)

Vndor or Grower name.

boxTypeId (integer:20)

Komet Sales internal Box Type ID.

boxType (string:3)

Box Type code.

quantityBoxes (integer:10)

Number of boxes sold in the invoice line.

flowerSales (decimal:10,2)

Flower sales.

creditUnits (integer:10)

Number of units in the credit.

creditAmount (decimal:10,2)

Flower credit total amount.

creditReasons (string:500)

Specified credit reason list.

supportDocuments (array)

An array of support documents associated with the credit.

description (string:200)

Credit document name.

documentUrl (URL)

Credit document public URL.

detailsUnits (array)

An array containing order unit details.

detailId (integer:20)

Komet Sales internal Credit item ID.

awb (string:20)

AWB number.

productId (integer:20)

Komet Sales internal product ID.

productDescription (string:200)

Product description.

categoryAccountingCode (string:20)

Category accounting code.

growerId (integer:20)

Komet Sales internal Vendor ID.

growerName (string:200)

Vendor or Grower name.

totalUnits (integer:10)

Number of Units sold in the Invoice line.

flowerSales (decimal:10,2)

Flower sales.

unitCost (decimal:10,2)

Unit cost.

creditUnits (integer:10)

Number of units in the credit.

creditAmount (decimal:10,2)

Flower credit total amount.

creditReasons (string:500)

List of specified credit reasons.

comments (array)

An array containing additional comments.

comment (string:500)

Comment text.

createdBy (string:200)

Name of the user that posted the comment.

createdOn (date)

Date when the comment was posted.

Date format: YYYY-MM-DD