Purchase Order Reconciliation Webhook

In this article, you will learn how to set up the PO 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.

User Roles: Admin and Setup.

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


Step one: Create the AWB 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)

Purchase Order ID.


poNumber (string)

Purchase Order number.


shipDate (date)

Shipping date.

Date format: YYYY-MM-DD


arrivalDate (date)

Arrival date.

Date format: YYYY-MM-DD


subTotal (number)

Order subtotal before additional charges.


total (number)

Order total, including additional charges.


location (array)

An array containing location details.


id (integer)

Location ID.


code (integer)

Location code.


name (string)

Location name.


vendorInvoices (array)

An array containing vendor invoices of the purchase order.


invoiceNumber (string)

Invoice number ID.


invoiceAmount (number)

Total invoiced amount.


totalAdditionalCharges (number)

Additional charges.


file (url)

URL to download the invoice PDF.


vendor (array)

An array containing the invoice’s vendor information.


id (integer)

Vendor ID.


code (string)

Vendor code.


name (string)

Vendor name.


vendorAccountingCode (string)

Vendor accounting code.


type (string)

Vendor type.


purchaseOrderItems (array)

An array containing purchase order items.


categoryProcurementAccountingCode (string)

Product procurement code.


totalCost (number)

Product cost.


{ "id" : 12345, "poNumber": "P002271", "shipDate": "2020-03-27", "arrivalDate": "2020-03-27", "subtotal": 60.0, "total": 60.0, "location":{ "id": 3, "code": "02", "name": "Chicago" }, "vendorInvoices": [ { "invoiceNumber": "01-P002271", "invoiceAmount": 20.0, "totalAdditionalCharges": 0.0, "file": "www.kometsales.com/url", "vendor": { "id": 29697, "code": "AV", "name": "Miami L Vendor", "vendorAccountingCode": null, "type": "Fresh Cut", }, "purchaseOrderItems": [ { "categoryProcurementAccountingCode": "CGEN", "totalCost": 10.0 }, { "categoryProcurementAccountingCode": "PGEN", "totalCost": 10.0 } ] }, { "invoiceNumber": "01-P002272", "invoiceAmount": 30.0, "totalAdditionalCharges": 0.0, "file": "www.kometsales.com/url", "vendor": { "id": 29697, "code": "AV", "name": "Miami L Vendor", "vendorAccountingCode": null, "type": "Fresh Cut", }, "purchaseOrderItems": [ { "categoryProcurementAccountingCode": "CGEN", "totalCost": 10.0 }, { "categoryProcurementAccountingCode": "PGEN", "totalCost": 30.0 } ] }, { "invoiceNumber": "01-P002273", "invoiceAmount": 10.0, "totalAdditionalCharges": 0.0, "file": "www.kometsales.com/url", "vendor": { "id": 29697, "code": "AV", "name": "Miami L Vendor", "vendorAccountingCode": null, "type": "Fresh Cut", }, "purchaseOrderItems": [ { "categoryProcurementAccountingCode": "CGEN", "totalCost": 3.0 }, { "categoryProcurementAccountingCode": "PGEN", "totalCost": 7.0 } ] } ] }

Back to top


Step two: Set up the PO 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 PO 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.

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.

 

po-webhook-email.png

 

Back to top