Product Webhook API (1.0.0)

Webhook that triggers when a new product is created

Download OpenAPI description
Languages
Servers
Production Server
https://{subdomain}/api/v3/

Product

Webhooks

Invoice

Webhooks

Customer

Webhooks

Supplier

Webhooks

Bill

Webhooks

Transfer Order

Webhooks

Outbound Logistic

Webhooks

Inbound Logistic

Webhooks

Adjustment

Webhooks

Invoice Payment

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

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" }

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

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" }

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

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" }

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

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" }

Responses

Successful processing of the write-off .

Bill Payment

Webhooks

Shift

Webhooks

Loyalty Point

Webhooks

Outlet

Webhooks