Invoice

Product Webhook API (1.0.0)

Webhook that triggers when a new product is created

Download OpenAPI description
webhook.json
webhook.yaml
Languages
Servers
Production Server
https://{subdomain}/api/v3/

Product

Webhooks

Invoice

Webhooks

Invoice CreatedWebhook

Request

This webhook is triggered when a new invoice is created.

Bodyapplication/json
IDstring

Unique ID of the invoice

Outletstring

Name of the outlet

Numberstring

Number of the invoice transaction

Datestring

Date of the invoice transaction

DueDatestring

Due date of the invoice transaction

Tagstring

Channel Tagging system (e.g., Take Away, Shopee)

Customerobject
CreatorIDstring

ID of the creator of the invoice

Createdstring

Date when the invoice was created

Discount1integer

Percentage of discount 1

Discount2integer

Percentage of discount 2

DiscountAmountinteger

Discount amount applied

Grossinteger

Total amount before discounts

DiscountTotalinteger

Total discount applied

TaxTypestring

Type of tax (e.g., No Tax)

TaxCalculationstring

Tax calculation method (e.g., Add or Include)

Taxinteger

Total tax applied

TaxRateinteger

Tax rate in percentage

Salesinteger

Total sales after discounts

Surchargeinteger

Additional surcharge (e.g., credit card fee)

SalesNTaxinteger

Sales total after tax

Couponstring

Coupon code used, if any

Notestring

Additional note for the invoice

PointUsedinteger

Total loyalty points used

PointsEarnedinteger

Total loyalty points earned

Deliverystring

Delivery status (Sent, Unsent, etc.)

Voidstring

Whether the invoice is voided (Yes/No)

VariantsArray of objects
OutboundLogisticsArray of objects
PaymentsArray of objects
ReferenceNumberstring

Reference number for the invoice

OrderFulfillmentRecipientobject
application/json
{
  "ID": "e0211b45-358e-4d5c-bf5b-8a31404b125e",
  "Outlet": "Outlet1",
  "Number": "20.09.00020",
  "Date": "2020-09-02T00:00:00",
  "DueDate": "0001-01-01T00:00:00",
  "Tag": "Take Away",
  "Customer": {
    "ID": "2774372b-0d5e-4171-8c83-dd66fbd4461e",
    "Name": "hendry",
    "Email": "henz2194w@gmail.com",
    "Phone": "0215851412",
    "Mobile": "0815161688",
    "Code": "HW0001",
    "Address": "Jl. Muara No. 3"
  },
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2020-09-02T13:52:18.33",
  "Discount1": 0,
  "Discount2": 0,
  "DiscountAmount": 0,
  "Gross": 100000,
  "DiscountTotal": 0,
  "TaxType": "No Tax",
  "TaxCalculation": "Add",
  "Tax": 0,
  "TaxRate": 0,
  "Sales": 100000,
  "Surcharge": 0,
  "SalesNTax": 100000,
  "Coupon": "XPPW123",
  "Note": "Note Test",
  "PointUsed": 0,
  "PointsEarned": 0,
  "Delivery": "Sent",
  "Void": "No",
  "Variants": [
    { … }
  ],
  "Payments": [
    { … }
  ],
  "OutboundLogistics": [
    { … }
  ]
}

Responses

Webhook received successfully

Bodyapplication/json
statusstring
Example: "success"
Response
application/json
{
  "status": "success"
}

Invoice DeletedWebhook

Request

This webhook is triggered when an existing customer invoice is deleted.

Bodyapplication/json
IDstring

The unique ID of the deleted invoice.

Outletstring

The name of the outlet where the invoice was created.

Numberstring

The invoice number.

Datestring(date-time)

The date the invoice was created.

DueDatestring(date-time)

The due date of the invoice.

SalesTypestring

The sales type associated with the invoice (e.g., Take Away).

Customerobject
CreatorIDstring

The unique ID of the user who created the invoice.

Createdstring(date-time)

The timestamp of when the invoice was created.

Discount1number

The first discount applied to the invoice.

Discount2number

The second discount applied to the invoice.

DiscountAmountnumber

The total discount amount.

Grossnumber

The gross amount of the invoice before tax and discounts.

DiscountTotalnumber

The total amount of discounts applied.

TaxTypestring

The type of tax applied to the invoice.

Taxnumber

The amount of tax applied to the invoice.

Salesnumber

The total sales amount (after discounts and taxes).

Surchargenumber

Any surcharge applied to the invoice.

SalesNTaxnumber

The total sales amount without tax.

Couponstring

Any coupon used for the invoice.

Notestring

Additional notes related to the invoice.

PointUsednumber

The number of loyalty points used in the invoice.

PointsEarnednumber

The number of loyalty points earned for the invoice.

Deliverystring

The delivery status of the invoice (e.g., Sent).

Voidstring

Whether the invoice was voided.

VariantsArray of objects
PaymentsArray of objects
application/json
{
  "ID": "e0211b45-358e-4d5c-bf5b-8a31404b125e",
  "Outlet": "Outlet1",
  "Number": "20.09.00020",
  "Date": "2020-09-02T00:00:00",
  "DueDate": "0001-01-01T00:00:00",
  "SalesType": "Take Away",
  "Customer": {
    "Name": "hendry",
    "Email": "henz2194w@gmail.com",
    "Phone": "084984984",
    "Mobile": "0815161688",
    "Code": "HW0001"
  },
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2020-09-02T13:52:18.33",
  "Discount1": 0,
  "Discount2": 0,
  "DiscountAmount": 0,
  "Gross": 100000,
  "DiscountTotal": 0,
  "TaxType": "No Tax",
  "Tax": 0,
  "Sales": 100000,
  "Surcharge": 0,
  "SalesNTax": 100000,
  "Coupon": "XAD12312",
  "Note": "TEST NOTE",
  "PointUsed": 0,
  "PointsEarned": 0,
  "Delivery": "Sent",
  "Void": "No",
  "Variants": [
    { … }
  ],
  "Payments": [
    { … }
  ]
}

Responses

Webhook received successfully

Bodyapplication/json
statusstring
Example: "success"
Response
application/json
{
  "status": "success"
}

Invoice ErasedWebhook

Request

This webhook is triggered when an existing customer invoice is erased (deleted permanently).

Bodyapplication/json
IDstring

The unique ID of the erased invoice.

Outletstring

The outlet where the invoice was created.

Numberstring

The invoice number.

Datestring(date-time)

The date when the invoice was created.

DueDatestring(date-time)

The due date of the invoice.

SalesTypestring

Type of sale (e.g., Take Away).

Customerobject
CreatorIDstring

The unique ID of the creator.

Createdstring(date-time)

The timestamp when the invoice was created.

Discount1number

The first discount applied to the invoice.

Discount2number

The second discount applied to the invoice.

DiscountAmountnumber

The total discount amount.

Grossnumber

The total gross amount of the invoice.

DiscountTotalnumber

The total discount applied.

TaxTypestring

Type of tax applied (e.g., No Tax).

Taxnumber

The amount of tax applied.

Salesnumber

The total sales amount.

Surchargenumber

Any surcharge applied.

SalesNTaxnumber

The sales amount excluding tax.

Couponstring

Any coupon applied to the invoice.

Notestring

Any notes attached to the invoice.

PointUsednumber

The loyalty points used for the invoice.

PointsEarnednumber

The loyalty points earned from the invoice.

Deliverystring

The delivery status of the invoice.

Voidstring

Whether the invoice is void (Yes/No).

VariantsArray of objects
PaymentsArray of objects
application/json
{
  "ID": "e0211b45-358e-4d5c-bf5b-8a31404b125e",
  "Outlet": "Outlet1",
  "Number": "20.09.00020",
  "Date": "2020-09-02T00:00:00",
  "DueDate": "0001-01-01T00:00:00",
  "SalesType": "Take Away",
  "Customer": {
    "Name": "hendry",
    "Email": "henz2194w@gmail.com",
    "Phone": "0815161688",
    "Mobile": "0815161688",
    "Code": "HW0001"
  },
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2020-09-02T13:52:18.33",
  "Discount1": 0,
  "Discount2": 0,
  "DiscountAmount": 0,
  "Gross": 100000,
  "DiscountTotal": 0,
  "TaxType": "No Tax",
  "Tax": 0,
  "Sales": 100000,
  "Surcharge": 0,
  "SalesNTax": 100000,
  "Coupon": "CASDASD13123",
  "Note": "TEST NOTE",
  "PointUsed": 0,
  "PointsEarned": 0,
  "Delivery": "Sent",
  "Void": "Yes",
  "Variants": [
    { … }
  ],
  "Payments": [
    { … }
  ]
}

Responses

Webhook received successfully

Bodyapplication/json
statusstring
Example: "success"
Response
application/json
{
  "status": "success"
}

Invoice RestoredWebhook

Request

This webhook is triggered when a voided order is restored in the Sell Menu.

Bodyapplication/json
IDstring

The unique ID of the restored invoice.

Outletstring

The outlet where the invoice was restored.

Numberstring

The invoice number.

Datestring(date-time)

The date when the invoice was created.

DueDatestring(date-time)

The due date of the invoice.

SalesTypestring

Type of sale (e.g., Take Away).

Customerobject
CreatorIDstring

The ID of the person who created the invoice.

Createdstring(date-time)

The timestamp when the invoice was created.

Discount1number

The first discount applied to the invoice.

Discount2number

The second discount applied to the invoice.

DiscountAmountnumber

The total discount amount.

Grossnumber

The total gross amount of the invoice.

DiscountTotalnumber

The total discount applied.

TaxTypestring

Type of tax applied (e.g., No Tax).

TaxCalculationstring

The method used to calculate tax (e.g., Add).

Taxnumber

The tax applied to the invoice.

TaxRatenumber

The tax rate applied.

Salesnumber

The total sales amount.

Surchargenumber

Any surcharge applied.

SalesNTaxnumber

The sales amount excluding tax.

Couponstring

Any coupon applied to the invoice.

Notestring

Additional notes attached to the invoice.

PointUsednumber

The loyalty points used for the invoice.

PointsEarnednumber

The loyalty points earned from the invoice.

Deliverystring

The delivery status of the invoice.

Voidstring

Whether the invoice was voided (Yes/No).

VariantsArray of objects
OutboundLogisticsArray of objects
PaymentsArray of objects
application/json
{
  "ID": "e0211b45-358e-4d5c-bf5b-8a31404b125e",
  "Outlet": "Outlet1",
  "Number": "20.09.00020",
  "Date": "2020-09-02T00:00:00",
  "DueDate": "0001-01-01T00:00:00",
  "SalesType": "Take Away",
  "Customer": {
    "ID": "2774372b-0d5e-4171-8c83-dd66fbd4461e",
    "Name": "hendry",
    "Email": "henz2194w@gmail.com",
    "Phone": "0215851412",
    "Mobile": "0815161688",
    "Code": "HW0001"
  },
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2020-09-02T13:52:18.33",
  "Discount1": 0,
  "Discount2": 0,
  "DiscountAmount": 0,
  "Gross": 100000,
  "DiscountTotal": 0,
  "TaxType": "No Tax",
  "TaxCalculation": "Add",
  "Tax": 0,
  "TaxRate": 0,
  "Sales": 100000,
  "Surcharge": 0,
  "SalesNTax": 100000,
  "Coupon": "XYZ123",
  "Note": "TEST NOTE",
  "PointUsed": 0,
  "PointsEarned": 0,
  "Delivery": "Sent",
  "Void": "No",
  "Variants": [
    { … }
  ],
  "OutboundLogistics": [
    { … }
  ],
  "Payments": [
    { … }
  ]
}

Responses

Webhook received successfully

Bodyapplication/json
statusstring
Example: "success"
Response
application/json
{
  "status": "success"
}

Invoice UpdatedWebhook

Request

This webhook is triggered when an existing customer invoice is updated.

Bodyapplication/json
IDstring

The unique ID of the invoice.

Outletstring

The outlet where the invoice was created.

Numberstring

The invoice number.

Datestring(date-time)

The date when the invoice was created.

DueDatestring(date-time)

The due date for the invoice.

SalesTypestring

The sales type (e.g., Take Away).

Customerobject
CreatorIDstring

The unique ID of the creator.

Createdstring(date-time)

The timestamp when the invoice was created.

Discount1number

The first discount percentage.

Discount2number

The second discount percentage.

DiscountAmountnumber

The total discount amount.

Grossnumber

The gross total amount of the invoice.

DiscountTotalnumber

The total discount applied to the invoice.

TaxTypestring

The type of tax applied to the invoice (e.g., No Tax).

Taxnumber

The tax amount applied to the invoice.

Salesnumber

The sales amount after applying discounts.

Surchargenumber

Any surcharge applied to the invoice.

SalesNTaxnumber

The sales total excluding tax.

Couponstring

The coupon code applied, if any.

Notestring

Any additional notes for the invoice.

PointUsednumber

The number of loyalty points used in the invoice.

PointsEarnednumber

The number of loyalty points earned from the invoice.

Deliverystring

The delivery status of the order (e.g., Sent).