Estimate

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
Languages
Servers
Production Server
https://{subdomain}/api/v3/

Token

Operations related to authentication tokens

Operations

Category

Operations related to category, including create, get, etc

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

Get Estimate List

Request

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


Get list of estimate order

Required Group Role: "Orders" - "VIEW"

Bodyapplication/json
PageNumberintegerrequired

The number of page data to be display

PageSizeintegerrequired

The number of rows returned by the API

Fromstring

From date. this is the primary key for tje object

Tostring

To date. this is primary key for the object

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Estimate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "PageNumber": 1,
    "PageSize": 20,
    "From": "2019-12-01T00:00:00",
    "To": "2019-12-31T23:59:59"
  }'

Responses

Bodyapplication/jsonArray [
Outletstring

Outlet name

Numberstring

Number of estimate order

Customerstring

Name of Customer

Datestring

Date of estimate order

Statusstring

Status of convert estimate order to sales order / invoice (Waiting / Approved)

Createdstring

Created Time estimate

]
Response
application/json
[
  {
    "Outlet": "Outlet1",
    "Number": "19.12.00102",
    "Customer": "Hendry",
    "Date": "2019-12-31T00:00:00",
    "Created": "2019-12-31T09:30:01"
  },
  {
    "Outlet": "Outlet1",
    "Number": "Estimate001",
    "Customer": "Hendry",
    "Date": "2019-12-05T00:00:00",
    "Status": "Approved",
    "Created": "2019-12-05T08:45:08"
  }
]

Update Estimate

Request

Update an Estimate based on order

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

Bodyapplication/json
Outletstringrequired

Outlet Name

Numberstringrequired

Estimate Number

Datestringrequired

Estimate Date Created

Discountnumber

Discount percentage given

DiscountAmountnumber

Discount amount given

TaxTypestring

Name of Taxtype

Tagstring

Channel Tagging system. (ex:Offline / Whatsapp / Shopee / Tokopedia) used in marketplace.dealpos.app. Backwards Compatibility with property request "SalesType"

Customerobject
VariantsArray of objects
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Estimate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet 1",
    "Number": "OTL1.23.01.005",
    "Date": "2023-01-20",
    "Discount": 20,
    "DiscountAmount": 10000,
    "TaxType": "No Tax",
    "Tag": "Walk In",
    "Customer": {
      "Email": "Hendry@dealpos.com",
      "Name": "Hendry",
      "Mobile": 85693145151,
      "Address": "Jl. Muara Karang P3T No.30",
      "Gender": "1",
      "Code": "HW001"
    },
    "Variants": [
      {
        "Code": "Bj001",
        "Quantity": 1,
        "Cost": 200000,
        "Price": 500000,
        "Discount": 10,
        "Note": "New Arrival"
      }
    ]
  }'

Responses

Bodyapplication/json
IDstring

Estimate has been updated

Response
application/json
{
  "ID": "c1b2c529-fa67-4e81-ac65-10d315051824"
}

Create an Estimate

Request

Create an estimate based on order

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

Bodyapplication/json
Outletstringrequired

Outlet Name

Numberstringrequired

Estimate Number

Datestringrequired

Estimate Date Created

Discountnumber

Discount percentage given

DiscountAmountnumber

Discount amount given

TaxTypestring

Name of Taxtype

Tagstring

Channel Tagging system. (ex:Offline / Whatsapp / Shopee / Tokopedia) used in marketplace.dealpos.app. Backwards Compatibility with property request "SalesType"

Customerobject
VariantsArray of objects
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Estimate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet 1",
    "Number": "OTL1.23.01.005",
    "Date": "2023-01-20",
    "Discount": 20,
    "DiscountAmount": 10000,
    "TaxType": "No Tax",
    "Tag": "Walk In",
    "Customer": {
      "Email": "Hendry@dealpos.com",
      "Name": "Hendry",
      "Mobile": 85693145151,
      "Address": "Jl. Muara Karang P3T No.30",
      "Gender": "1",
      "Code": "HW001"
    },
    "Variants": [
      {
        "Code": "Bj001",
        "Quantity": 1,
        "Cost": 200000,
        "Price": 500000,
        "Discount": 10,
        "Note": "New Arrival"
      }
    ]
  }'

Responses

Bodyapplication/json
IDstring

Estimate has been created

Response
application/json
{
  "ID": "5d76bd2f-43e1-401f-98ad-c159b8c6ac6c"
}

Delete Estimate

Request

Delete an estimate invoice

You must have "Delete" role in "Estimate" Module

Bodyapplication/json
Outletstring

Outlet Name

Numberstring

Estimer Number

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

Responses

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "Estimate befa74af-234f-4a43-bd87-054b41824a5e has been deleted!"
}

Get Estimate Detail

Request

Also available as HTTP POST with the same endpoint


Get an estimate detail

Required Group Role: "Orders" - "VIEW"

Bodyapplication/json
Outletstringrequired

outlet of the created estimate

Numberstringrequired

estimate number. this is primary key for the object

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

Responses

Bodyapplication/json
Outletstringrequired

Outlet Name

Numberstringrequired

Estimate Number

Datestringrequired

Estimate Date Created

Discountnumber

Discount percentage given

DiscountAmountnumber

Discount amount given

TaxTypestring

Name of Taxtype

Tagstring

Channel Tagging system. (ex:Offline / Whatsapp / Shopee / Tokopedia) used in marketplace.dealpos.app. Backwards Compatibility with property request "SalesType"

Customerobject
VariantsArray of objects
Response
application/json
{
  "Outlet": "Outlet 1",
  "Number": "OTL1.23.01.005",
  "Date": "2023-01-20",
  "Discount": 20,
  "DiscountAmount": 10000,
  "TaxType": "No Tax",
  "Tag": "Walk In",
  "Customer": {
    "Email": "Hendry@dealpos.com",
    "Name": "Hendry",
    "Mobile": 85693145151,
    "Address": "Jl. Muara Karang P3T No.30",
    "Gender": "1",
    "Code": "HW001"
  },
  "Variants": [
    { … }
  ]
}

List Estimate With Total Count

Request

Also available as HTTP POST with the same endpoint
Get list of estimate order with total count

Required Group Role: "Orders" - "VIEW"

Bodyapplication/json
PageNumberintegerrequired

The number of page data to be displayed

PageSizeintegerrequired

The number of rows returned by the API

Fromstring

From Date (format: yyyy-mm-dd)

Tostring

To Date (format: yyyy-mm-dd)

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Estimate/WithTotalCount \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "PageNumber": 1,
    "PageSize": 20,
    "From": "2019-12-01",
    "To": "2019-12-31"
  }'

Responses

Bodyapplication/json
DataArray of objects
TotalCountinteger

Total count of the result

Response
application/json
{
  "Data": [
    { … },
    { … }
  ],
  "TotalCount": 100
}

Convert To Sales Order

Request

Convert Estimate to Sales Order

Bodyapplication/json
Outletstringrequired

Outlet Name

Numberstringrequired

Estimate Number

OrderNumberstring

Sales Order Number. If the value with null, it will set with number the generate from system

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

Responses

OK

Bodyapplication/json
IDstring

ID of Sales Order created

Response
application/json
{
  "ID": "ea11903e-d396-44f4-8bb8-185cbaead18c"
}

Convert To Invoice

Request

Convert Estimate to Invoice

Bodyapplication/json
One of:
Outletstringrequired

Outlet Name

Example: "Outlet1"
Numberstringrequired

Estimate Number

Example: "23.03.0003"
OrderNumberstring

Invoice Number. If the value with null, it will set with number the generate from system

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

Responses

OK

Bodyapplication/json
IDstring

ID of Invoice Created

Response
application/json
{
  "ID": "ea11903e-d396-44f4-8bb8-185cbaead18c"
}

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

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