Versions Compared

Key

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

Anchor
topofpage
topofpage

Excerpt

In this article, you will learn how to set up the Inbound Truck Reconciliation webhook and enable email notifications to notify salespeople if there is an error during the synchronization process with an external system so they take appropriate action.

Tip

Valid Tokens: Admin and Setup.

The link to download invoices will only be active for six hours.

Table of Contents

Table of Contents
minLevel1
maxLevel2
outlinefalse
excludeTable of Contents
typelist
printablefalse

Step one: Create the

Order cancellation

Inbound Truck Reconciliation Webhook in Your System

When creating the endpoint in your system, it is important to consider the following details:

URL: https://theexternalsystem.com

Content-Type: application/JSON

Method: POST


id (integer:1)

Transaction status. 1 = Success | 0 = Failure


loadNumber ()


arrivalDate (date)

Order arrival date.

Date format: YYYY-MM-DD


boxes (integer)

Total boxes in the order.


fbe (number)

Full box equivalent.


freightCost (number)

Freight cost.


location (array)

Location details.


code (string)

Location code.


name (string)

Location name..


id (integer)

Location ID.


carrier (array)

Carrier details.


name (string)

Carrier name.


id (integer)

Carrier ID..


freight/fbe (number)

.


vendorInvoices (array)

N.


invoiceNumber (integer)

Invoice number.


invoiceDate (date)

Invoice creation date.

Date format: YYYY-MM-DD


description (string)

Invoice description.


amount (number)

Invoice total.


file (url)

URL to download the invoice.


vendor (array)

Array containing vendor information.


code (string)

Vendor code.


name (string)

Vendor name.


id (integer)

Vendor ID.


type (string)

Vendor type.


vendorAccountingCode ()

Vendor accounting code.


type (array)

.


code (string)

N.


name (string)

N.


Code Block
{
   "id":9,
   "loadNumber":"",
   "arrivalDate":"2024-08-02",
   "boxes":20,
   "fbe":10.0,
   "freightCost":30.0,
   "location":{
      "code":"08",
      "name":"Austin",
      "id":9
   },
   "carrier":{
      "name":"Armellini",
      "id":1357
   },
   "freight/fbe":3.0,
   "vendorInvoices":[
      {
         "invoiceNumber":"12345",
         "invoiceDate":"2024-08-02",
         "description":"Invoice for 12 dozens of 50 roses to Mr. Fresh",
         "amount":30.0,
         "file":"http://kometsales-app-dev.s3.amazonaws.com/7030/inbound-bills/9/it_1722646461343.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240803T005625Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604799&X-Amz-Credential=AKIAUYFGZJ2AJCTMF75N%2F20240803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=a1de3f60e106168739402ae896a103add995a4802dc084c084f727bdd29781f3",
         "vendor":{
            "code":"A630",
            "name":"Apex Floral Inc.",
            "id":25216,
            "type":"Freight / Handling",
            "vendorAccountingCode":null
         },
         "type":{
            "code":"INV1",
            "name":"invoice 1 "
         }
      }
   ]
}

Back to top


Step two: Set up the Inbound Truck Reconciliation Webhook

Once you have created the endpoint in your system, you need to add it to your Komet Sales account. To add your endpoint, do the following instructions:

  1. Go to Setup and select Settings.

  2. Click on Webhooks from the Integrations group of settings.

  3. Select Inbound Truck Reconciliation Invoices from the dropdown list.

  4. Enter the URL that Komet Sales will call when this webhook is triggered.

  5. Select your authentication type:

    1. Basic. Enter your username and password.

    2. Bearer Token. Enter your authentication token.

  6. Enter the email addresses that the system will notify when an error occurs in the external system in the Error Notification field. You can enter up to 5 email addresses.

  7. Click on Save.

Info

This URL is the one you created from your external system in step one.

webhook config.gif

Back to top


Notification sample

This is an example of the email notification the users will receive.

37c9056e-3eaa-42fe-a021-bd64d5cf7a54.png

Back to top


Filter by label (Content by label)
showLabelsfalse
max5
titleRelated Articles
cqllabel in ( "company-token" , "vendor-token" , "customer-token" )