Report
/
Get Sales Invoice With Item Net Sales Complete

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

Get Sales Invoice With Item Net Sales Complete

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/WithItemNetSalesComplete \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "From": "2021-11-11",
    "To": "2021-11-11",
    "PageNumber": 1,
    "PageSize": 20
  }'

Responses

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

Get Product Sold

Request

Also available as HTTP POST with the same endpoint


Get Product Sold

Required Group Role: "Report" - "VIEW"

Bodyapplication/json
One of:
Outletstring

The outlet name

Example: "Outlet 1"
Categorystring

The product category

Example: "Shirt"
Codestring

The variant code

Example: "Shirt"
Salesstring

The sales person / employee

Example: "Ferdi"
CustomerEmailstring

The customer email

Example: "yansen@dealpos.com"
Tagsstring

The products tags

Example: "Summer"
Fromstringrequired

The beginning of the date range

Example: "2020-06-24"
Tostringrequired

The end of the date range

Example: "2020-06-24"
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Report/ProductSold \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet 1",
    "Category": "Shirt",
    "Code": "Shirt",
    "Sales": "Ferdi",
    "CustomerEmail": "yansen@dealpos.com",
    "Tags": "Summer",
    "From": "2020-06-24",
    "To": "2020-06-24"
  }'

Responses

Bodyapplication/jsonArray [
Namestring

Name of the Product

Codestring

Code of the Product

Quantityinteger

Total Quantity of the Product sold

Costinteger

Cost of the product

Salesinteger

Sales of the product

Profitinteger

Profit of the product transaction

]
Response
application/json
[
  {
    "Name": "Baju Summer",
    "Code": "SummerShirt",
    "Quantity": 12,
    "Cost": 10000,
    "Sales": 15000,
    "Profit": 5000
  },
  {
    "Name": "Baju Winter",
    "Code": "WinterShirt",
    "Quantity": 15,
    "Cost": 20000,
    "Sales": 30000,
    "Profit": 10000
  }
]

Get Sales Group by Outlet Tag

Request

Also available as HTTP POST with the same endpoint


Chart for Sales Transaction in omni.dealpos.app

Required Group Role: "Report" - "VIEW"

Bodyapplication/json
Fromstring
Tostring
OutletArray of strings
TagArray of strings
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Report/InvoiceGroupByOutletNTag \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": "2022-12-25",
    "To": "2022-12-31",
    "Outlet": [
      "Outlet1",
      "Outlet2"
    ],
    "Tag": [
      "Shopee",
      "Tokopedia",
      "TikTok"
    ]
  }'

Responses

Bodyapplication/jsonArray [
Outletstring

Outlet Name

Tagstring

Channel Tagging System

Datestring

Transactions Date

Sumnumber

Total Amount invoice in date range period

Countinteger

Total invoice in date range period

]
Response
application/json
[
  {
    "Outlet": "Outlet1",
    "Tag": "Shopee",
    "Date": "2023-03-10T00:00:00",
    "Sum": 450000,
    "Count": 2
  },
  {
    "Outlet": "Outlet1",
    "Tag": "Tokopedia",
    "Date": "2023-03-10T00:00:00",
    "Sum": 550000,
    "Count": 10
  },
  {
    "Outlet": "Outlet2",
    "Tag": "Shopee",
    "Date": "2023-03-10T00:00:00",
    "Sum": 4500000,
    "Count": 22
  },
  {
    "Outlet": "Outlet2",
    "Tag": "Tokopedia",
    "Date": "2023-03-10T00:00:00",
    "Sum": 55000,
    "Count": 1
  }
]

Get Product Sales by SKU Group by Day

Request

Also available as HTTP POST with the same endpoint


Get Quantity Product Sales by SKU Group by Day

Required Group Role: "Report" - "VIEW"

Bodyapplication/json
One of:
Fromstring

From Date

Example: "2023-02-28"
Tostring

To Date

Example: "2023-03-28"
Codestring

Variant SKU

Example: "BAG01"
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Report/ProductSold/BySKUGroupDay \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Code": "BAG01",
    "From": "2023-02-28",
    "To": "2023-03-28"
  }'

Responses

Bodyapplication/jsonArray [
Datestring

Transaction Date

Quantityinteger

Total Qty product sales in a day

]
Response
application/json
[
  {
    "Date": "2023-02-28",
    "Quantity": 10
  },
  {
    "Date": "2023-03-01 ",
    "Quantity": 15
  },
  {
    "Date": "2023-03-05",
    "Quantity": 17
  },
  {
    "Date": "2023-03-09",
    "Quantity": 20
  },
  {
    "Date": "2023-03-14",
    "Quantity": 22
  },
  {
    "Date": "2023-03-18",
    "Quantity": 8
  },
  {
    "Date": "2023-03-21",
    "Quantity": 50
  },
  {
    "Date": "2023-03-27",
    "Quantity": 10
  },
  {
    "Date": "2023-03-28",
    "Quantity": 29
  }
]

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