Shift

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

Get List Of Shifts

Request

Required Group Role: "Shift" - "VIEW"

Bodyapplication/json
Outletstring

Outlet Name

Fromstring

Date From result of shift list shown

Tostring

Date To result of shift list shown

PageNumberinteger

Number of page begin

PageSizeinteger

The size of one page. Max=500

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

Responses

Bodyapplication/jsonArray [
Openstring

Opening date and time of the shift

Closestring

closing date and time of the shift

Cashierstring

the name of the cashier that open the shift

Numberstring

Shift Number

SalesNTaxnumber

total sales that was created on sales shift

TotalInvoiceinteger

total invoice was created on sales shift

Outletstring

outlet location of the shift

Registerstring

register information of the shift

Visitorsinteger

total visitor during sales shift

]
Response
application/json
[
  {
    "Open": "2020-05-28T15:24:45.293",
    "Close": "2020-05-28T15:25:27.68",
    "Cashier": "dealpos",
    "Number": "20.05.0001",
    "SalesNTax": 16062.75,
    "TotalInvoice": 1,
    "Outlet": "Outlet1",
    "Register": "Outlet1",
    "Visitors": 10
  },
  {
    "Open": "2020-05-29T15:24:05.13",
    "Close": "2020-05-29T15:24:15.887",
    "Cashier": "dealpos",
    "Number": "20.05.0002",
    "SalesNTax": 15000,
    "TotalInvoice": 1,
    "Outlet": "Outlet1",
    "Register": "Outlet1",
    "Visitors": 10
  }
]

Close register/end shift

Request

Required Group Role: "Shift" - "VIEW"

Bodyapplication/json
Registerstring

Register Name

curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Shift \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Register": "Outlet1"
  }'

Responses

Bodyapplication/jsonArray [
Numberstring

Shift Number

Salesinteger

Total Sales that was created on sales shift

Taxinteger

Total Tax Sales

Startstring

Opening date and time of the shift

Endstring

closing date and time of the shift

]
Response
application/json
[
  {
    "Number": "OLT1/21/12/0010",
    "Sales": 60000,
    "Tax": 2000,
    "Start": "2021-12-15T14:09:06.567",
    "End": "2021-12-15T14:09:13.8907518+07:00"
  }
]

Open Shift

Request

Required Group Role: "Shift" - "VIEW"

Bodyapplication/json
Registerstring

Register Name

OpAmountinteger

Opening Cash

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Shift \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Register": "Outlet1",
    "OpAmount": 100000
  }'

Responses

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "Shift success created"
}

Delete Shift

Request

Delete Previous Shift Invoice

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

Bodyapplication/json
Outletstring

Outlet Name

Numberstring

Shift Number

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

Responses

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "Shift 22b33f3d-e89a-4b4a-89f1-a704740bbbdc has been deleted!"
}

Get Shift Invoice Detail

Request

Also available as HTTP POST with the same endpoint


Get Shift Invoice Detail

Required Group Role: "Shift" - "VIEW"

Bodyapplication/json
Registerstring

Register Name based on its Outlet

Numberstring

Invoice Number of the transaction

PageNumberinteger

Page Number per-shift detail

PageSizeinteger

The size of one page. (default = 100) Max=500

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Shift/InvoiceDetail \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Register": "Outlet1",
    "Number": "21.03.00115",
    "PageNumber": 1,
    "PageSize": 100
  }'

Responses

Bodyapplication/json
DataArray of objects(ShiftDetail)

Array of data

TotalRowinteger

Total row of the data (invoice)

Response
application/json
{
  "Data": [
    { … },
    { … }
  ],
  "TotalRow": 2
}

Get Shift Invoice Detail With Note

Request

Also available as HTTP POST with the same endpoint


Get Shift Invoice Detail with Note
Bodyapplication/json
Registerstringrequired
Numberstringrequired
PageNumberinteger

Page Number per-shift detail

PageSizeinteger

The size of one page. (default = 100) Max=500

NoteVisiblebooleanrequired

Must be sent the object property to show note in response