DealPOS API (3.1.0)

Welcome Developer

This page lists the reference documentation for DealPOS APIs. For guides and tutorials.

Download OpenAPI description

openapi.json

openapi.yaml

Overview

URL https://www.dealpos.com

Customer Support info@dealpos.com

License

Servers

Production Server

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

Token

Operations related to authentication tokens

Operations

Product

Operations related to product, including create, get, etc

Operations

Variant

Operations related to variant, including create, get, etc

Operations

Serial

Operation related to Serial product type

Operations

Estimate

Operations related to estimate, including create, get, etc

Operations

Sales Order

Operations related to sales order, including create, get, etc

Operations

Invoice

Operations related to invoice, including create, get, etc

Operations

Shift

Operation related to shift, including create, get, etc

Operations

Report

Operations related to report page, including create, get, etc

Operations

Customer

Operations related to customer data, including create, get, etc

Operations

Comment

Operations related to comment (Contact Feedback), including create, get, etc

Operations

Supplier

Operations related to supplier data, including create, get, etc

Operations

Invoice Payment

Operations related to invoice payment, including create, get, etc

Operations

Bill Payment

Operations related to bill payment, including create, get, etc

Operations

Invoice Write Off

Operations related to invoice write off, including create, get, etc

Operations

Inventory

Operations related to inventory, including create, get, etc

Operations

Inventory Log

Operations related to inventory log, including create, get, etc

Operations

Inventory Adjustment

Operations related to inventory adjustment, including create, get, etc

Operations

Bill

Operations related to bill, including create, get, etc

Operations

Create a Bill

Request

Create a Supplier Bill

You must have "CREATE" role in "Buy" Module OR "EDIT" role in "Global" Module

Bodyapplication/json

Outletstringrequired

Name of the outlet

Numberstringrequired

Unique number for the transaction

Datestring(date)required

Transaction date

DueDatestring(date)

Due date for the transaction

TaxTypestring

Type of tax applied

Discount1number

Percentage of the discount

DiscountAmountnumber

Total discount amount

Notestring

Bill notes

Deliverystringrequired

Delivery status

Supplierobject

VariantsArray of objects

List of product variants

PaymentsArray of objects

List of payments made

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Bill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "05.23.2018.0001",
    "Date": "2018-02-23",
    "DueDate": "2018-08-25",
    "TaxType": "PPN 10%",
    "Discount1": 5,
    "DiscountAmount": 10000,
    "Note": "Test note Outlet1",
    "Delivery": "Waiting",
    "Supplier": {
      "Name": "Supplier A",
      "Email": "supplier@dealpos.com",
      "Phone": "085741254",
      "Address": "JL. Muara Karang Cantik Blok P3 Timur No. 30",
      "Gender": "Male"
    },
    "Variants": [
      {
        "Code": "2005",
        "Quantity": "10",
        "Price": "102000",
        "Discount": 10,
        "Note": "Cotton Combet 30'\''s"
      },
      {
        "Code": "2002",
        "Quantity": "10",
        "Price": "120000",
        "Discount": 5,
        "Note": "Denim Shirt(M)"
      }
    ],
    "Payments": [
      {
        "Date": "2018-02-23",
        "Amount": "2150610",
        "Method": "Cash"
      }
    ]
  }'

Responses

Bodyapplication/json

IDstring

Response

application/json

{
  "ID": "410ba2b7-8eff-4759-b5f1-cf47b33ef1cc"
}

Update a Bill

Request

Update a Supplier Bill based on number.

You must have "EDIT" role in "Orders" Module OR "EDIT" role in "Global" Module

Bodyapplication/json

Outletstringrequired

Name of the outlet

Numberstringrequired

Unique number for the transaction

Datestring(date)required

Transaction date

DueDatestring(date)

Due date for the transaction

TaxTypestring

Type of tax applied

Discount1number

Percentage of the discount

DiscountAmountnumber

Total discount amount

Notestring

Bill notes

Deliverystringrequired

Delivery status

Supplierobject

VariantsArray of objects

List of product variants

PaymentsArray of objects

List of payments made

curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Bill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "05.23.2018.0001",
    "Date": "2018-02-23",
    "DueDate": "2018-08-25",
    "TaxType": "PPN 10%",
    "Discount1": 5,
    "DiscountAmount": 10000,
    "Note": "Test note Outlet1",
    "Delivery": "Waiting",
    "Supplier": {
      "Name": "Supplier A",
      "Email": "supplier@dealpos.com",
      "Phone": "085741254",
      "Address": "JL. Muara Karang Cantik Blok P3 Timur No. 30",
      "Gender": "Male"
    },
    "Variants": [
      {
        "Code": "2005",
        "Quantity": "10",
        "Price": "102000",
        "Discount": 10,
        "Note": "Cotton Combet 30'\''s"
      },
      {
        "Code": "2002",
        "Quantity": "10",
        "Price": "120000",
        "Discount": 5,
        "Note": "Denim Shirt(M)"
      }
    ],
    "Payments": [
      {
        "Date": "2018-02-23",
        "Amount": "2150610",
        "Method": "Cash"
      }
    ]
  }'

Responses

Bodyapplication/json

IDstring

Response

application/json

{
  "ID": "410ba2b7-8eff-4759-b5f1-cf47b33ef1cc"
}

List Bills

Request

Also available as HTTP POST (endpoint: /api/v3/Bill/p)

Get List of Supplier Bills based on Outlet

You must have "SupplierBill" role in "Orders" Module

Bodyapplication/json

Fromstringrequired

From date(yyyy/mm/dd)

Default "format : yyyy-mm-dd"

Tostringrequired

To date(yyyyy/mm/dd)

Default "format : yyyy-mm-dd"

Outletstringrequired

The name of the outlet making a purchase order. This is primary key for the object

PageNumbernumberrequired

The number of page data to be displayed

PageSizenumberrequired

The number of rows returned by the API

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Bill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": "2020-06-01",
    "To": "2020-06-30",
    "Outlet": "Outlet1",
    "PageNumber": 1,
    "PageSize": 10
  }'

Responses

Bodyapplication/jsonArray [

IDstring

ID of supplier bill that created

Outletstring

Outlet Name of bill transaction created

Numberstring

Bill number transaction

Supplierstring

Supplier Name

Typeinteger

Type of Supplier Bill

Datestring

Bill transaction created date

Duestring

Due Date of payment

Amountinteger

Total purchase amount

Deliverystring

Delivery state of shipping

Enum"Waiting""Received""Partial"

Paymentstring

Status payment of bill transaction

Createdstring

Bill created time

]

Response

application/json

[
  {
    "ID": "d688ff9e-0671-456a-b6f0-223acaa5ee7b",
    "Outlet": "Outlet1",
    "Number": "20.06.00004",
    "Supplier": "hendry",
    "Type": 1,
    "Date": "2020-06-24T00:00:00",
    "Due": "2020-06-24T00:00:00",
    "Amount": 100000,
    "Delivery": "Received",
    "Payment": "Paid",
    "Created": "2020-06-24T13:36:12.97"
  },
  {
    "ID": "ed6ffe55-f08e-4806-be1d-e55f3927e11b",
    "Outlet": "Outlet1",
    "Number": "20.06.00003",
    "Supplier": "PT ABC",
    "Type": 1,
    "Date": "2020-06-24T00:00:00",
    "Due": "2020-06-24T00:00:00",
    "Amount": 100000,
    "Delivery": "Received",
    "Payment": "Paid",
    "Created": "2020-06-24T11:40:27.703"
  },
  {
    "ID": "8169eac5-c2a7-4845-8f96-0b5a8980957a",
    "Outlet": "Outlet1",
    "Number": "20.06.00002",
    "Supplier": "PT ABC",
    "Type": 1,
    "Date": "2020-06-24T00:00:00",
    "Due": "2020-06-24T00:00:00",
    "Amount": 100000,
    "Delivery": "Received",
    "Payment": "Paid",
    "Created": "2020-06-24T11:24:53.027"
  },
  {
    "ID": "057a8d3f-3927-4d61-a533-cd554d2c01e8",
    "Outlet": "Outlet1",
    "Number": "OTL01-20-06-02",
    "Supplier": "PT ABC",
    "Type": 1,
    "Date": "2020-06-19T00:00:00",
    "Due": "2020-06-19T00:00:00",
    "Amount": 87289,
    "Delivery": "Received",
    "Payment": "Paid",
    "Created": "2020-06-19T14:13:13.817"
  },
  {
    "ID": "1b5f9f1f-e836-4330-b79d-9e7737893a78",
    "Outlet": "Outlet1",
    "Number": "OTL01-20-06-01",
    "Supplier": "PT ABC",
    "Type": 1,
    "Date": "2020-06-08T00:00:00",
    "Due": "2020-06-08T00:00:00",
    "Amount": 3138,
    "Delivery": "Received",
    "Payment": "Paid",
    "Created": "2020-06-08T08:40:54.55"
  }
]

Delete a Bill

Request

Delete a Supplier Bill based on Outlet and Number

You must have role "DELETE" role in "Buy" Module

Bodyapplication/json

Outletstringrequired

The name of the outlet making a purchase order

Numberstringrequired

Number of Supplier bill. This is primary key for the object

curl -i -X DELETE \
  https://subdomain.dealpos.net/api/v3/Bill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "18.10.00009"
  }'

Responses

Bodyapplication/json

Messagestring

Response

application/json

{
  "Message": "Supplier bill has been deleted!"
}

Get a Bill By Number

Request

Also available as HTTP POST with the same endpoint

Get a Supplier Bill detail based on bill number.

You must have "SupplierBill" role in "Orders" Module

Bodyapplication/json

Outletstringrequired

Outlet name

Numberstringrequired

Number of supplier bill. This is primary key for the object

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Bill/Number \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "19.11.14.000000003"
  }'

Responses

Bodyapplication/json

IDstring

Outletstring

Outlet Name of bill crated

Numberstring

Bill number transaction

Datestring

Bill transaction date(yyyy/mm/dd)

DueDatestring

Due date Bill transaction date(yyyy/mm/dd)

Supplierobject

Detail personal info of supplier

CreatorIDstring

ID of the user that create the supplier bill

Createdstring

Bill created datetime

Discount1integer

Discount percentage that given in bill

DiscountAmountnumber

Discount amount that given in bill

Grossnumber

Total amount before discount

DiscountTotalnumber

Total discount in bill

TaxTypestring

Tax type assigned

Taxinteger

Tax Percentage

Purchasenumber

total nett purchase amount

PurchaseNTaxnumber

Total amount in bill after tax

Deliverystring

Delivery State

Enum"Waiting""Received""Partial"

VariantsArray of objects

PaymentsArray of objects

Response

application/json

{
  "ID": "ff7448c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Outlet": "Outlet1",
  "Number": "19.11.14.000000003",
  "Date": "2019-11-14T00:00:00",
  "DueDate": "2020-08-25T00:00:00",
  "Supplier": {},
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2019-11-14T14:19:44.25",
  "Discount1": 0,
  "DiscountAmount": 0,
  "Gross": 2660000,
  "DiscountTotal": -166854688,
  "TaxType": "No Tax",
  "Tax": 0,
  "Purchase": 169514688,
  "PurchaseNTax": 169514688,
  "Delivery": "Received",
  "Variants": [
    { … },
    { … },
    { … }
  ],
  "Payments": [
    { … }
  ]
}

List Bills With Total Count

Request

Also available as HTTP POST with the same endpoint

Get list of Supplier Bill detail with Total Count

You must have "SupplierBill" role in "Orders" Module

Bodyapplication/json

Fromstring

From date (format: yyyy-mm-dd)

Tostring

To date (format: yyyy-mm-dd)

Outletstring

Name of the outlet

PageNumbernumberrequired

The number of page data to be displayed

PageSizenumberrequired

The number of rows returned by the API

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Bill/WithTotalCount \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": "2020-06-01",
    "To": "2020-06-30",
    "Outlet": "Outlet1",
    "PageNumber": 1,
    "PageSize": 10
  }'

Responses

Bodyapplication/json

DataArray of objects

TotalCountinteger

Total count of the result

Response

application/json

{
  "Data": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "TotalCount": 100
}

Bill Count

Request

Count total bill with multiple outlet

Also available as HTTP POST with the same endpoint

Bodyapplication/json

Fromstringrequired

yyyy/mm/dd

Tostringrequired

yyyy/mm/dd

OutletArray of stringsrequired

List of multiple outlets

PaymentStatestring

Payment status / progress of the bill

Enum"Paid""Partial""Unpaid"

DeliveryStatestring

Delivery status / progress of the bill

Enum"Waiting""Partial""Received"

Binboolean

Invoice in bin or not

Default false

Enumtruefalse

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Bill/GetCountMultipleOutlet \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": "2021/01/01",
    "To": "2021/01/31",
    "Outlet": [
      "Outlet 1",
      "Outlet 2"
    ],
    "PaymentState": "Paid",
    "DeliveryState": "Received",
    "Bin": false
  }'

Responses

Bodyapplication/json

Countnumber

Response

application/json

{
  "Count": 37
}

Get a Bill by ID

Request

Get a Supplier Bill detail based on bill ID.

You must have "SupplierBill" role in "Orders" Module

Bodyapplication/json

IDstringrequired

Supplier bill ID

Example: "ff7448c9-21f1-4c05-ac9e-1e71d829cc9c"

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Bill/ID \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ID": "ff7448c9-21f1-4c05-ac9e-1e71d829cc9c"
  }'

Responses

Bodyapplication/json

IDstring

Supplier bill ID

Outletstring

Outlet name

Numberstring

Supplier bill number

Datestring

Supplier bill date

DueDatestring

Supplier bill due date

Supplierobject

Supplier name

CreatorIDstring

Creator ID

Createdstring

Created time

Discount1integer

Discount percentage that given in bill

DiscountAmountinteger

Discount amount that given in bill

Grossinteger

Total amount before discount

DiscountTotalinteger

Total discount in bill

TaxTypestring

Tax type assigned

Taxinteger

Tax Percentage

Purchaseinteger

Total nett purchase amount

PurchaseNTaxinteger

Total amount in bill after tax

Deliverystring

Delivery State

VariantsArray of objects

Variants detail

PaymentsArray of objects

Response

application/json

{
  "ID": "ff7448c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Outlet": "Outlet1",
  "Number": "19.11.14.000000003",
  "Date": "2019-11-14T00:00:00",
  "DueDate": "2020-08-25T00:00:00",
  "Supplier": {},
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2019-11-14T14:19:44.25",
  "Discount1": 0,
  "DiscountAmount": 0,
  "Gross": 2660000,
  "DiscountTotal": -166854688,
  "TaxType": "No Tax",
  "Tax": 0,
  "Purchase": 169514688,
  "PurchaseNTax": 169514688,
  "Delivery": "Received",
  "Variants": [
    { … },
    { … },
    { … }
  ],
  "Payments": [
    { … }
  ]
}

OutboundLogistic

Operations related to outbound logistic, including create, get, etc

Operations

InboundLogistic

Operations related to inbound logistic, including create, get, etc

Operations

TransferOrder

Operations related to transfer order, including create, get, etc

Operations

Fulfillment

Operations related to fulfillment, including create, get, etc

Operations

Prepaid Package

Operations related to prepaid package, including create, get, etc

Operations

Promotion Coupon

Operations related to promotion coupon, including create, get, etc

Operations

Promotion Event

Operations related to promotion event, including create, get, etc

Operations

Outlet

Operations related to outlet, including create, get, etc

Operations

Outlet Price

Operations related to outlet price, including create, get, etc

Operations

Loyalty Point

Operations related to loyalty point, including create, get, etc

Operations

Notification

Operations related to notification, including create, get, etc

Operations

Payment Method

Operations related to payment method, including create, get, etc

Operations

Invoice Write Off Option

Operations related to invoice write off option, including create, get, etc

Operations

Tax

Operations related to tax, including create, get, etc

Operations

Logistics Service

Operations related to logistics service, including create, get, etc

Operations

Midtrans Payment Gateway

Operations related to Midtrans Payment Gateway, including create, get, etc

Operations

Apps

Operations related to Apps, including create, get, etc

Operations

Barcode

Operations related to barcode, including create, get, etc

Operations

Client Secret

Operations related to client secret, including create, get, etc

Operations

Rate Limit

Operations related to rate limit, including create, get, etc

Operations

Deprecated API

Operations

DealPOS API (3.1.0)

Welcome Developer

Token

Category

Product

Variant

Serial

Estimate

Sales Order

Invoice

Shift

Report

Customer

Comment

Supplier

Invoice Payment

Bill Payment

Invoice Write Off

Inventory

Inventory Log

Inventory Adjustment

Bill

Create a Bill

RequestExpand all

Responses

Was this helpful?

Update a Bill

RequestExpand all

Responses

Was this helpful?

List Bills

Request

Responses

Was this helpful?

Delete a Bill

Request

Responses

Was this helpful?

Get a Bill By Number

Request

Responses

Was this helpful?

List Bills With Total Count

Request

Responses

Was this helpful?

Bill Count

Request

Responses

Was this helpful?

Get a Bill by ID

Request

Responses

Was this helpful?

OutboundLogistic

InboundLogistic

TransferOrder

Fulfillment

Prepaid Package

Promotion Coupon

Promotion Event

Outlet

Outlet Price

Loyalty Point

Notification

Payment Method

Invoice Write Off Option

Tax

Logistics Service

Midtrans Payment Gateway

Apps

Barcode

Client Secret

Rate Limit

Deprecated API

Request

Request