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

IDstring(guid)

ID of 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",
    "ID": "22b33f3d-e89a-4b4a-89f1-a704740bbbdc",
    "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",
    "ID": "c428483a-055b-4123-8c1d-59eb35152830",
    "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 List Of Shifts with Total Count

Request

Required Group Role: "Shift" - "VIEW"

Query
PageNumberintegerrequired

The page number to retrieve.

Example: PageNumber=1
PageSizeintegerrequired

The number of transactions per page.

Example: PageSize=20
Outletstring

Filter transactions by outlet name.

Example: Outlet=Outlet1
Fromstring(date-time)

Start date of shift list shown

Example: From=2020-05-28
Tostring(date-time)

End date of shift list shown

Example: To=2020-05-29
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Shift/TotalCount?From=2020-05-28&Outlet=Outlet1&PageNumber=1&PageSize=20&To=2020-05-29' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
DataArray of objects
TotalCountinteger

Total count of shifts

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

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
IDstring

Unique ID of the shift

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 '{
    "ID": "98180136-e9e8-4f7f-ac00-afd45723ad62",
    "Register": "Outlet1",
    "Number": "21.03.00115",
    "PageNumber": 1,
    "PageSize": 100
  }'

Responses

Bodyapplication/json
DataArray of objects

Array of data

Openstring

Opening date and time of the shift

Closestring

Closing date and time of the shift

Cashierstring

Cashier name of the shift

Numberstring

Shift Number

Outletstring

Outlet Name of the shift

Registerstring

Register Name based on its Outlet

TotalInvoiceinteger

Total amount of invoice in the shift

SalesNTaxinteger

Total amount of sales in the shift

Visitorinteger

Total visitor in the shift

ARAmountinteger

Total amount of AR in the shift

ARTransactioninteger

Number of transaction of AR in the shift

TotalRowinteger

Total row of the data (invoice)

Response
application/json
{
  "Data": [
    { … },
    { … }
  ],
  "Open": "2020-05-27T11:10:50.57",
  "Close": "2020-05-27T11:10:50.57",
  "Cashier": "Jane",
  "Number": "20.05.00157",
  "Outlet": "Outlet1",
  "Register": "Outlet1",
  "TotalInvoice": 2,
  "SalesNTax": 102400,
  "Visitor": 2,
  "ARAmount": 500000,
  "ARTransaction": 2,
  "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

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

Responses

Bodyapplication/json
DataArray of objects

Array of data

Openstring

Opening date and time of the shift

Closestring

Closing date and time of the shift

Cashierstring

Cashier name of the shift

Numberstring

Shift Number

Outletstring

Outlet Name of the shift

Registerstring

Register Name based on its Outlet

TotalInvoiceinteger

Total amount of invoice in the shift

SalesNTaxinteger

Total amount of sales in the shift

Visitorinteger

Total visitor in the shift

ARAmountinteger

Total amount of AR in the shift

ARTransactioninteger

Number of transaction of AR in the shift

TotalRowinteger

Total row of the data (invoice)

Response
application/json
{
  "Data": [
    { … },
    { … }
  ],
  "Open": "2020-05-27T11:10:50.57",
  "Close": "2020-05-27T11:10:50.57",
  "Cashier": "Jane",
  "Number": "20.05.00157",
  "Outlet": "Outlet1",
  "Register": "Outlet1",
  "TotalInvoice": 2,
  "SalesNTax": 102400,
  "Visitor": 2,
  "ARAmount": 500000,
  "ARTransaction": 2,
  "TotalRow": 2
}

Get Shift By Number

Request

Also available as HTTP POST with the same endpoint


Get Shift By Number

Required Group Role: "Shift" - "VIEW"

Bodyapplication/json
Outletstringrequired

Outlet Name

Numberstringrequired

Shift Number

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

Responses

Bodyapplication/json
Openstring

Opening Date time of shift

Closestring

Closing date time of shift

Numberstring

shift number

Cashierstring

Cashier assigned at the shift

Registerstring

register of the shift

TotalInvoiceinteger

Total invoice in the shift

SalesNTaxinteger

Total amount of whole transactions in shift

Visitorinteger

Total visitor in shift

InvoiceArray of objects
PaymentsArray of objects
Response
application/json
{
  "Open": "14 Apr 2021 10:19",
  "Close": "14 Apr 2021 10:19",
  "Number": "21.04.002",
  "Cashier": "dealpos",
  "Register": "Outlet1",
  "TotalInvoice": 2,
  "SalesNTax": 75000,
  "Visitor": 2,
  "Invoice": [
    { … },
    { … }
  ],
  "Payments": [
    { … }
  ]
}

Void Previous Shift

Request

Void Previous Shift Invoice

You must have "Void" role in "Shift" Modul

Bodyapplication/json
Outletstringrequired

Outlet Name

Numberstringrequired

Shift Number

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

Responses

OK

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

Erase Previous Shift

Request

Erase (Delete Permanent) Previous Shift Invoice

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

Bodyapplication/json
Outletstringrequired

Outlet Name

Numberstringrequired

Shift Number

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

Responses

OK

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

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

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

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