Overview


Returns a list of customer credits with their corresponding details.

 


Request

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 date from (date format YYYY-MM-DD).
  • creditDateTo (required) (date)Credit date to (date format YYYY-MM-DD).
  • itemType (string 3): the item type. Possible values: box or UN (unit). By default will be box. Type "all" to include all the box types.
  • status (optional)(integer:1): credit status (1 = New, 2 = Pending Review, 3 = Approved, 4 = Rejected, 5 = Resubmitted). If empty, it will return all the credit orders for the filters given.
  • customer (optional)(string:200): customer name or code.
  • customerId (optional)(integer:20): customer ID, used to search orders from only one customer. You can obtain this value from the customer.list API method.
  • carrierName (optional)(string:200): carrier name.
  • carrierId (optional)(integer:20): carrier ID, used to search orders from only one carrier. You can obtain this value from the carrier.list API method.
  • product (optional)(string:200): product description.
  • number (optional)(integer:10): Credit Order number, which 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 obtain this value from the location.list API method.
  • externalSystemSynced (optional)(boolean): 1 if you want to search only the credits that were marked as synchronized. 0 for credits pending to be synchronized. 


Sample 1
{"authenticationToken": "token_info_goes_here", "creditDatefrom":"2018-04-12", "creditDateTo":"2018-05-12"}

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.
  • message (string:500): description of the status of the transaction.
  • credits: an array of credits
    • id (integer:20): Komet Sales internal Credit ID.
    • creditNumber (string:10): the credit number.
    • customerId (integer:20): Komet Sales internal customer ID.
    • customerName (string:200): name of the customer.
    • shipDate (date): order date. (Date format YYYY-MM-DD).
    • orderNumber (integer:10): the number of the order 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): Name of the salesperson associated to the invoice.
    • 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): PO number given by the customer.
    • totalBoxesOrder (decimal:10,2): number of boxes sold in the order.
    • totalOrder (decimal:10,2): total amount of the order (Flowers Sale + Add Charges + Taxes).
    • totalCredit (decimal:10,2): total amount of the credit.
    • returnedTax (decimal:10,2): returned tax.
    • approvedDate: (date): date when the credit was approved. (Date format YYYY-MM-DD).
    • externalSystemSynced (boolean): 1 or 0. Indicates if the credit was marked as synchronized. 
    • syncDate (datetime): date and time when the credit was synchronized with an external system. (date format YYYY-MM-DD'T'hh:mm:ss). Time will be in the GMT time zone. 
    • status (string:20): the credit status.
    • additionalChargesDetails: array of additional charges in the credit.
      • name (string:200): name of the additional charge.
      • amount (decimal:10,2): additional charge credit amount.
      • accountingCode (string:20): additional charge accounting code. 
    • details: an array of order details
      • detailId (integer:20): Komet Sales internal Credit item ID.
      • awb (string:20): Air Way Bill 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.
      • 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 of the credit.
      • creditAmount (decimal:10,2): amount for the flower credit.
      • creditReasons (string:500): list of credit reasons specified.
    • detailsUnits: an array of order details
      • detailId (integer:20): Komet Sales internal Credit item ID.
      • awb (string:20): Air Way Bill 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 of the credit.
      • creditAmount (decimal:10,2): amount for the flower credit.
      • creditReasons (string:500): list of credit reasons specified.
    • comments: an array of comments.
      • comment (string:500): comment text.
      • createdBy (string:200): name of the user that posted the comment.
      • createdOn (date): date the comment was posted on. (Date format YYYY-MM-DD).