Skip to content
/
Send Receipt By Email

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

Get Invoice ID By Number

Request

Also available as HTTP POST with the same endpoint


Get Invoice ID by Number to check that available in POS

Required Group Role: "Orders" - "View"

Security
OAuth2_clientCredentials
Query
OutletIDstringrequired

Outlet ID (Guid). If not provided, it will use property OutletName

Example: OutletID=aad4a789-b802-49c1-b66f-f45fbc7ce17f
Outletstringrequired

Outlet Name. If not provided, it will use property OutletID

Example: Outlet=Outlet1
Numberstringrequired

Invoice number. this is primary key for the object

Example: Number=18.10.00009
Bodyapplication/json
One of:
Outletstringrequired

Outlet Name

Example: "Outlet1"
Numberstringrequired

Invoice number. this is primary key for the object

Example: "18.10.00009"
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Invoice/IDByNumber?OutletID=aad4a789-b802-49c1-b66f-f45fbc7ce17f&Outlet=Outlet1&Number=18.10.00009' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "18.10.00009"
  }'

Responses

Bodyapplication/json
IDstring

Unique ID from Invoice

Response
application/json
{
  "ID": "aad4a789-b802-49c1-b66f-f45fbc7ce17f"
}

Send Receipt By Email

Request

Send Receipt to customer by email

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

Security
OAuth2_clientCredentials
Bodyapplication/json
One of:
Outletstringrequired

Outlet Name

Example: "Outlet1"
Numberstringrequired

Invoice number

Example: "18.10.00009"
Emailstringrequired

Email Customer will be sent the email. This is primary of the API

Example: "ezzan212@dealpos.com"
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Invoice/SendReceiptByEmail \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "18.10.00009",
    "Email": "ezzan212@dealpos.com"
  }'

Responses

Bodyapplication/json
Messagestring

Success message

Response
application/json
{
  "Message": "Sent to email success"
}

Invoice Count

Request

Count total invoice with multiple outlet

Also available as HTTP POST with the same endpoint

Security
OAuth2_clientCredentials
Bodyapplication/json
One of:
Fromstringrequired

yyyy/mm/dd

Example: "2022-09-01"
Tostringrequired

yyyy/mm/dd

Example: "2022-09-06"
OutletArray of stringsrequired

List of multiple outlets

Example: ["Outlet1","Outlet2"]
TagArray of stringsrequired

Channel Tagging system. (ex: Tokopedia, Shopee)

Example: ["Tokopedia","Shopee"]
PaymentStatestring

Payment status / progress of the invoice

Enum"Paid""Partial""Unpaid"
Example: "Paid"
Fulfillmentstring

Delivery status / progres of the invoice

Enum"Sent""Unsent""Partial""Returned"
Example: "Sent"
Binboolean

Invoice in bin or not

Default false
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Invoice/GetCountMultipleOutlet \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": "2022-09-01",
    "To": "2022-09-06",
    "Outlet": [
      "Outlet1",
      "Outlet2"
    ],
    "Tag": [
      "Tokopedia",
      "Shopee"
    ],
    "PaymentState": "Paid",
    "Fulfillment": "Sent",
    "Bin": false
  }'

Responses

Bodyapplication/json
Countnumber

Total invoice count

Response
application/json
{
  "Count": 37
}

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

Pricebook

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

Operations

Outlet

Operations related to outlet, including create, get, etc

Operations

User

Operations related to user, 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

Expense

Operations related to get expense

Operations

Logistics Service

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

Operations

Park Order Display

Operations related to parked order display, 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

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

Operations