Invoice Payment

/

Payment Updated

Product Webhook API (1.0.0)

Webhook that triggers when a new product is created

Download OpenAPI description

Servers

Production Server

https://{subdomain}/api/v3/

Product

Webhook for product events

Webhooks

Invoice

Webhook for invoice events

Webhooks

Customer

Webhook for customer events

Webhooks

Supplier

Webhook for supplier events

Webhooks

Bill

Webhook for bill events

Webhooks

Transfer Order

Webhook for transfer order events

Webhooks

Outbound Logistic

Webhook for outbound logistic events

Webhooks

Inbound Logistic

Webhook for inbound logistic events

Webhooks

Adjustment

Webhook for adjustment events

Webhooks

Invoice Payment

Webhook for invoice payment events

Webhooks

Payment CreatedWebhook

Request

This webhook is triggered when a payment is created.

Bodyapplication/jsonrequired

IDstringnon-emptyrequired

Unique ID of the payment

InvoiceIDstringnon-emptyrequired

Unique invoice ID of the payment

Outletstringnon-emptyrequired

Origin outlet of the payment

Numberstringnon-emptyrequired

Number of the transaction

Amountnumberrequired

Total amount of the payment

Methodstringnon-emptyrequired

Type/method of the payment

Datestring(date)non-emptyrequired

Date of the payment made

Createdstring(date)non-emptyrequired

Created date of the payment

Creatorstringnon-emptyrequired

Name of person who created the payment

CreatorIDstringnon-empty

Unique ID of the person who created the payment

application/json

{
  "ID": "1c2a88a6-d99c-4915-91af-a36110c34c7a",
  "InvoiceID": "008cdf4c-f5c1-449c-94dd-c2f3741fb1ab",
  "Outlet": "Outlet1",
  "Number": "2020.07.0001",
  "Amount": 100000,
  "Method": "Cash",
  "Date": "2020-07-01",
  "Created": "2020-07-31",
  "Creator": "Hendry",
  "CreatorID": "71e6e3df-257e-4a56-90ad-f6214b267aee"
}

Responses

Webhook received successfully

Bodyapplication/json

statusstring

Example: "success"

Response

application/json

{
  "status": "success"
}

Payment DeletedWebhook

Request

This webhook is triggered when a payment is removed from the Orders Menu (InvoiceInfo).

Bodyapplication/jsonrequired

IDstringnon-emptyrequired

Unique ID of the payment

InvoiceIDstringnon-emptyrequired

Unique invoice ID of the payment

Outletstringnon-emptyrequired

Origin outlet of the payment

Numberstringnon-emptyrequired

Number of the transaction

Amountnumberrequired

Total amount of the payment

Methodstringnon-emptyrequired

Type or method of the payment

Datestring(date)required

Date when the payment was made

Createdstring(date-time)required

Creation timestamp of the payment

Creatorstringnon-emptyrequired

Name of the person who created the payment

CreatorIDstringnon-empty

Unique ID of the person who created the payment

application/json

{
  "ID": "1c2a88a6-d99c-4915-91af-a36110c34c7a",
  "InvoiceID": "008cdf4c-f5c1-449c-94dd-c2f3741fb1ab",
  "Outlet": "Outlet1",
  "Number": "2020.07.0001",
  "Amount": 100000,
  "Method": "Cash",
  "Date": "2020-07-01",
  "Created": "2020-07-31",
  "Creator": "Hendry",
  "CreatorID": "71e6e3df-257e-4a56-90ad-f6214b267aee"
}

Responses

Webhook received successfully

Bodyapplication/json

statusstring

Example: "success"

Response

application/json

{
  "status": "success"
}

Payment UpdatedWebhook

Request

This webhook is triggered when a payment transaction is updated in the Orders Menu.

Bodyapplication/jsonrequired

IDstringnon-emptyrequired

Unique ID of the payment

InvoiceIDstringnon-emptyrequired

Unique invoice ID of the payment

Outletstringnon-emptyrequired

Origin outlet of the payment

Numberstringnon-emptyrequired

Number of the transaction

Amountnumberrequired

Total amount of the payment

Methodstringnon-emptyrequired

Type or method of the payment

Datestring(date)required

Date when the payment was made

Createdstring(date-time)required

Creation timestamp of the payment

Creatorstringnon-emptyrequired

Name of the person who created the payment

CreatorIDstringnon-empty

Unique ID of the person who created the payment

application/json

{
  "ID": "1c2a88a6-d99c-4915-91af-a36110c34c7a",
  "InvoiceID": "008cdf4c-f5c1-449c-94dd-c2f3741fb1ab",
  "Outlet": "Outlet1",
  "Number": "2020.07.0001",
  "Amount": 100000,
  "Method": "Cash",
  "Date": "2020-07-01",
  "Created": "2020-07-31",
  "Creator": "Hendry",
  "CreatorID": "71e6e3df-257e-4a56-90ad-f6214b267aee"
}

Responses

Webhook received successfully

Bodyapplication/json

statusstring

Example: "success"

Response

application/json

{
  "status": "success"
}

Payment Write OffWebhook

Request

Triggered when a payment transaction is written off.

Bodyapplication/jsonrequired

IDstringnon-emptyrequired

Unique ID of the payment

InvoiceIDstringnon-emptyrequired

Unique invoice ID of the payment

Outletstringnon-emptyrequired

Origin outlet of the payment

Numberstringnon-emptyrequired

Number of the transaction

Amountnumberrequired

Total amount of the payment

Methodstringnon-emptyrequired

Type/method of the payment

Datestringnon-emptyrequired

Date of the payment made

Createdstringnon-emptyrequired

Created date of the payment

Creatorstringnon-emptyrequired

Name of person who created the payment

CreatorIDstringnon-empty

Unique ID of the person who created the payment

TagIDstringnon-empty

Unique ID of the tag of Write Off associated with the payment

application/json

{
  "ID": "1c2a88a6-d99c-4915-91af-a36110c34c7a",
  "InvoiceID": "008cdf4c-f5c1-449c-94dd-c2f3741fb1ab",
  "Outlet": "Outlet1",
  "Number": "2020.07.0001",
  "Amount": 100000,
  "Method": "Cash",
  "Date": "2020-07-01",
  "Created": "2020-07-31",
  "Creator": "Hendry",
  "CreatorID": "71e6e3df-257e-4a56-90ad-f6214b267aee",
  "TagID": "1c2a88a6-d99c-4915-91af-a36110c34c7a"
}

Responses

Successful processing of the write-off .

Bill Payment

Webhook for bill payment events

Webhooks

Shift

Webhook for shift events

Webhooks

Outlet

Webhook for outlet events

Webhooks

Sales Order

Webhook for sales order events

Webhooks

Loyalty Provider

Use this section to integrate external coupon provider to DealPOS

Go to Developer Menu -> Tab Promotion Coupon Provider then click button Add and fill with your endpoint. Loyalty Image

Webhooks