Report

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

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

Get Sales Invoice

Request

Also available as HTTP POST with the same endpoint


Get Sales Transaction

Required Group Role: "Report" - "VIEW"

Bodyapplication/json
One of:
Outletstringrequired

Outlet Name

Example: "Outlet1"
Fromstringrequired

From date

Example: "2021-03-01T00:00:00"
Tostringrequired

To date

Example: "2021-03-31T00:00:00"
Emailstring

Customer email address

PageNumberinteger

The Number of page data to be displayed

Example: 1
PageSizeinteger

The number of rows returned by the API

Example: 100
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Report \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "From": "2021-03-01T00:00:00",
    "To": "2021-03-31T00:00:00",
    "PageNumber": 1,
    "PageSize": 100
  }'

Responses

Body
DataArray of objects
TotalRowinteger

Total count of the result

Response
{
  "Data": [
    { … }
  ],
  "TotalRow": 1
}

Get Sales Invoice by Sales Person

Request

Also available as HTTP POST with the same endpoint


Get Sales Invoice Transaction by Sales Person

Required Group Role: "Report" - "VIEW"

Bodyapplication/json
Outletstringrequired

Outlet Name

Fromstringrequired

From date

Tostringrequired

To date

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Report/SalesPerson \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet 1",
    "From": "2021-01-01",
    "To": "2021-01-31"
  }'

Responses

Bodyapplication/jsonArray [
SalesPersonstring
Transactioninteger
Quantityinteger
Salesinteger
Taxinteger
SalesNTaxinteger
Costinteger
Profitinteger
]
Response
application/json
[
  {
    "SalesPerson": "James",
    "Transaction": 1,
    "Quantity": 1,
    "Sales": 8000,
    "Tax": 0,
    "SalesNTax": 8000,
    "Cost": 2000,
    "Profit": 6000
  },
  {
    "SalesPerson": "Ferdiansyah Rahman",
    "Transaction": 1,
    "Quantity": 2,
    "Sales": 20000,
    "Tax": 0,
    "SalesNTax": 20000,
    "Cost": 1000000,
    "Profit": -980000
  }
]

Get Outlet Performance

Request

Also available as HTTP POST with the same endpoint


Get Report Sales Performance by Outlet

Required Group Role: "Report" - "VIEW"

Bodyapplication/json
Outletstring

Outlet name

Fromstringrequired

From date

Tostringrequired

to date

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Report/OutletPerformance \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "From": "2021-01-01",
    "To": "2021-01-31"
  }'

Responses

Bodyapplication/jsonArray [
Outletstring

the outlet of the reports that shown

Transactioninteger

Total Transaction per Outlet

Salesnumber

Total Amount after discount in invoice

Taxnumber

Tax value in invoice

SalesNTaxnumber

Total Sales + Tax from invoice

Costnumber

Total Cost per outlet transaction

Profitnumber

Total profit of the outlet transaction

]
Response
application/json
[
  {
    "Outlet": "Outlet2",
    "Transaction": 4,
    "Sales": 25120260,
    "Tax": 0,
    "SalesNTax": 25120260,
    "Cost": 10123590.91,
    "Profit": 14996669.09
  },
  {
    "Outlet": "Outlet1",
    "Transaction": 23,
    "Sales": 10024000,
    "Tax": 0,
    "SalesNTax": 10024000,
    "Cost": 5835862.6,
    "Profit": 4188137.4
  }
]

Get Sales Invoice With Item Net Sales

Request

Also available as HTTP POST with the same endpoint


Get Sales Invoice based on prorate nett sales calculation

Required Group Role: "Report" - "VIEW"

Bodyapplication/json
Outletstring

Outlet Name

Fromstringrequired

From Date

Tostringrequired

To Date

PageNumberintegerrequired

Page number of get inventory

PageSizeintegerrequired

Row count of get inventory

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

Responses

Bodyapplication/json
DataArray of objects
TotalRowinteger
Response
application/json
{
  "Data": [
    { … }
  ],
  "TotalRow": 1
}

Get Daily Sales By Month

Request

Also available as HTTP POST with the same endpoint


Get Daily Sales Transaction by Month

Required Group Role: "Report" - "VIEW"

Bodyapplication/json
OutletArray of strings

List of Outlets Name

Yearintegerrequired

Year of date (format: (YYYY))

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Report/DailySales \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": [
      "Outlet1"
    ],
    "Year": 2021
  }'

Responses

Bodyapplication/jsonArray [
Monthstring

List of Months of selected Year

Transinteger

Total count of Invoice Transactions

SalesNTaxnumber

Total Accumulation of Sales and Taxes

Costnumber

Total accumulation of costs

]
Response
application/json
[
  {
    "Month": "January",
    "Trans": 34,
    "SalesNTax": 1021000,
    "Cost": 881615.75
  },
  {
    "Month": "February",
    "Trans": 376,
    "SalesNTax": 135397168.68,
    "Cost": 97501389.32
  },
  {
    "Month": "March",
    "Trans": 311,
    "SalesNTax": 45215217.85,
    "Cost": 34635477.25
  },
  {
    "Month": "April",
    "Trans": 86,
    "SalesNTax": 18103161.03,
    "Cost": 17157404.54
  },
  {
    "Month": "May",
    "Trans": 5,
    "SalesNTax": 247000.12,
    "Cost": 90522.17
  },
  {
    "Month": "June",
    "Trans": 94,
    "SalesNTax": 13250883.61,
    "Cost": 18746522.55
  },
  {
    "Month": "July",
    "Trans": 139,
    "SalesNTax": 14682156.82,
    "Cost": 17858903.23
  },
  {
    "Month": "August",
    "Trans": 38,
    "SalesNTax": 1573348.5,
    "Cost": 9734012.73
  },
  {
    "Month": "September",
    "Trans": 108,
    "SalesNTax": 468493094.25,
    "Cost": 17126179.21
  },
  {
    "Month": "October",
    "Trans": 152,
    "SalesNTax": 34584026.75,
    "Cost": 4806827.8
  },
  {
    "Month": "November",
    "Trans": 166,
    "SalesNTax": 26655324,
    "Cost": 14904432.27
  }
]