Skip to content

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

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

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

Create Adjustment by Updating Inventory

Request

Create an inventory adjustment by setting available quantities.

Requires one of the following roles: "ADD" in the "Adjustment" module or "EDIT" in the "Global" module.

Products with type "Composite" and "Non Inventory" cannot be adjusted.

When the InventoryAdjustment Approval config is enabled, newly created adjustments will be assigned StateID 1 (In Progress) or StateID 2 (Waiting for Approval).

Security
OAuth2_clientCredentials
Headers
CreateWhenQuantityMatchboolean

when true, even though the quantity submitted matches an inventory adjustment will be created (200 returned) when false no adjustment is created (202 returned)

Default false
Enumfalsetrue
Bodyapplication/json
Outletstringrequired

The name of the outlet that made the adjustment

Datestringrequired

Date of adjusment.(yyyy/mm/dd)

Numberstringrequired

Number of invoice adjusment. This is primary key for the object

StateIDnumber

State of Adjustment. it will be required if config with Approval is turned on. 1= InProgress, 2= Waiting

PICstring

The name of the PIC that made the adjustment

Notestring

Note of adjustment

CategoryIDstring(guid)

Category ID of variant

CategoryNamestring

Category Name of variant

ExpectedMethodstring

Data source of adjustment. None = data not shown, Counted = Counted by user, All = All variants can be adjusted

Enum"None""Counted""All"
CountMethodstring

Source of adjustment creation

Enum"web""csv""barcode""rfid"
VariantsArray of objectsrequired
Variants[].​Codestringrequired

Code of variant

Variants[].​Quantitynumberrequired

Variant's adjusted quantity

Variants[].​Notestring

Note of variant adjustment

Variants[].​TIDArray of strings

Tag ID for RFID (This property is used only for product Standard type and adjustment type Count)

Variants[].​SerialArray of objects(VariantSerial)

Use this property only for product type Serialized

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Adjustment/Set \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'CreateWhenQuantityMatch: false' \
  -d '{
    "Outlet": "Outlet1",
    "Date": "2023/09/01",
    "Number": "2023.09.00001",
    "StateID": 1,
    "PIC": "John Doe",
    "Note": "Adjustment for damaged goods",
    "CategoryID": "123e4567-e89b-12d3-a456-426614174000",
    "CategoryName": "Top",
    "ExpectedMethod": "Counted",
    "CountMethod": "rfid",
    "Variants": [
      {
        "Code": "907",
        "Quantity": 2,
        "Note": "Damaged during transport",
        "TID": [
          "ASDADKASKDAD021",
          "ASDADKASKDAD022"
        ]
      },
      {
        "Code": "908",
        "Quantity": 5,
        "Note": "Expired products",
        "TID": [
          "ASDADKASKDAD023",
          "ASDADKASKDAD024"
        ]
      }
    ]
  }'

Responses

Bodyapplication/json
IDstring

Adjustments ID has been created

Response
application/json
{
  "ID": "bcb2fff2-916a-4f60-9e12-36735d0790a9"
}

Update Adjustment with Type Count Quantity

Request

Update a count-type inventory adjustment by setting available quantities for draft adjustments. Requires one of the following roles: "ADD" in the "Adjustment" module or "EDIT" in the "Global" module. Products with type "Composite" and "Non Inventory" cannot be adjusted. When the InventoryAdjustment Approval config is enabled, updated adjustments may transition to StateID 1 (Draft) or StateID 2 (Pending).

Security
OAuth2_clientCredentials
Bodyapplication/json
Outletstringrequired

The name of the outlet that made the adjustment

Datestringrequired

Date of adjusment.(yyyy/mm/dd)

Numberstringrequired

Number of invoice adjusment. This is primary key for the object

PICstring

The name of the PIC that made the adjustment

Notestring

Note of adjustment

VariantsArray of objectsrequired
Variants[].​Codestringrequired

Code of variant

Variants[].​Quantitynumberrequired

Quantity of variant

Variants[].​Priceinteger

Price of variant

Variants[].​Notestring

Note of variant

curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Adjustment/Set \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Date": "2023/09/01",
    "Number": "2023.09.00001",
    "PIC": "John Doe",
    "Note": "Adjustment for damaged goods",
    "Variants": [
      {
        "Code": "907",
        "Quantity": 10
      },
      {
        "Code": "908",
        "Quantity": 5
      }
    ]
  }'

Responses

Bodyapplication/json
IDstring

Adjustments ID has been created

Response
application/json
{
  "ID": "bcb2fff2-916a-4f60-9e12-36735d0790a9"
}

Create Adjustment by Adjusting Differences

Request

Create an inventory adjustment by incrementing or decrementing quantities. Requires the "ADD" role in the "Adjustment" module or the "EDIT" role in the "Global" module.

Security
OAuth2_clientCredentials
Bodyapplication/json
Outletstringrequired

The name of the outlet that made the adjustment

Datestringrequired

Date of adjusment.(yyyy/mm/dd)

Numberstringrequired

Number of invoice adjusment. This is primary key for the object

StateIDnumber

State of Adjustment. it will be required if config with Approval is turned on. 1= InProgress, 2= Waiting

PICstring

The name of the PIC that made the adjustment

Notestring

Note of adjustment

CategoryIDstring(guid)

Category ID of variant

CategoryNamestring

Category Name of variant

ExpectedMethodstring

Data source of adjustment. None = data not shown, Counted = Counted by user, All = All variants can be adjusted

Enum"None""Counted""All"
CountMethodstring

Source of adjustment creation

Enum"web""csv""barcode""rfid"
VariantsArray of objectsrequired
Variants[].​Codestringrequired

Code of variant

Variants[].​Quantitynumberrequired

Variant's adjusted quantity

Variants[].​Notestring

Note of variant adjustment

Variants[].​TIDArray of strings

Tag ID for RFID (This property is used only for product Standard type and adjustment type Count)

Variants[].​SerialArray of objects(VariantSerial)

Use this property only for product type Serialized

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Adjustment \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Date": "2023/09/01",
    "Number": "2023.09.00001",
    "StateID": 1,
    "PIC": "John Doe",
    "Note": "Adjustment",
    "CountMethod": "barcode",
    "Variants": [
      {
        "Code": "907",
        "Quantity": 2,
        "Note": "Additional"
      }
    ]
  }'

Responses

Bodyapplication/json
IDstring

Adjustment ID has been created

Response
application/json
{
  "ID": "a0e9653b-dd54-47a9-9dba-fb81da33ca60"
}

Update an Adjustment

Request

Update an existing inventory adjustment for a specific outlet and number. Requires the "EDIT" role in the "Adjustment" module or the "EDIT" role in the "Global" module.

Security
OAuth2_clientCredentials
Bodyapplication/json
Outletstringrequired

The name of the outlet that made the adjustment

Example: "Outlet1"
Datestringrequired

Date of adjusment.(yyyy/mm/dd)

Example: "2023/09/01"
Numberstringrequired

Number of invoice adjusment. This is primary key for the object

Example: "2023.09.00001"
PICstring

The name of the PIC that made the adjustment

Example: "John Doe"
Notestring

Note of adjustment

Example: "Adjustment"
VariantsArray of objectsrequired
Example: [{"Code":907,"Quantity":10,"Cost":50000,"Price":100000,"Note":"Additional"}]
Variants[].​Codestringrequired

Code of variant

Variants[].​Quantitystringrequired

Quantity of variant

Variants[].​Priceinteger

Price of variant

Variants[].​Notestring

Note of variant

curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Adjustment \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Date": "2023/09/01",
    "Number": "2023.09.00001",
    "PIC": "John Doe",
    "Note": "Adjustment",
    "Variants": [
      {
        "Code": 907,
        "Quantity": 10,
        "Cost": 50000,
        "Price": 100000,
        "Note": "Additional"
      }
    ]
  }'

Responses

Bodyapplication/json
IDstring

the ID of the adjustment that has been updated

Response
application/json
{
  "ID": "a0e9653b-dd54-47a9-9dba-fb81da33ca60"
}

Delete an Adjustment

Request

Delete an inventory adjustment by number. Requires the "DELETE" role in the "Adjustment" module.

Security
OAuth2_clientCredentials
Bodyapplication/json
Outletstringrequired

The name of the outlet that made the adjustment

Example: "Outlet1"
Numberstringrequired

Number of adjusment invoice

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

Responses

Bodyapplication/json
string

adjustment has been deleted

Response
application/json
"adjustment has been deleted"

List Adjustment

Request

Also available as HTTP POST (endpoint: /api/v3/Adjustment/p)


Get List of Adjustment

Required Group Role: "Adjustment" - "VIEW"

Security
OAuth2_clientCredentials
Query
PageNumbernumberrequired

Start Page

Example: PageNumber=1
PageSizenumberrequired

Total data adjustment list will be shown

Example: PageSize=10
Fromstring

From date list adjustment list will be shown

Example: From=2023/09/01
Tostring

To date list adjustment list will be shown

Example: To=2023/09/30
Outletstring

The name of the outlet that made the adjustment

Example: Outlet=Outlet1
Statestring

Status of adjustment (Draft / Pending / Accepted / Rejected)

Example: State=Accepted
Typestring

Type of adjustment (Adjust / Count). If set to empty string or not send the property, it will show all adjustment

Enum"Adjust""Count"
Example: Type=Adjust
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Adjustment?PageNumber=1&PageSize=10&From=2023%2F09%2F01&To=2023%2F09%2F30&Outlet=Outlet1&State=Accepted&Type=Adjust' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
IDstring

ID of the adjustment

Outletstring

the adjustment outlet location

Datestring

the date of the adjustment (yyyy/mm/dd)

Numberstring

the adjustment number. This is primary key for the object

SKUCountnumber

Total SKU of the inventory adjustment

QuantitySUMnumber

Total Quantity of the inventory adjustment

Typestring

Adjustment Type

Enum"Adjust""Count"
TotalCostnumber

Total Cost of the inventory adjustment

PICstring

the person in charge of the adjustment

Notestring

the note of adjustment

Statestring

Adjustment Status

Enum"Draft""Pending""Accepted""Rejected"
]
Response
application/json
[
  {
    "ID": "a0e9653b-dd54-47a9-9dba-fb81da33ca60",
    "Outlet": "Outlet1",
    "Date": "2018-10-30T00:00:00",
    "Number": "2018/11/07.0001",
    "SKUCount": 2,
    "QuantitySUM": 18,
    "Type": "Adjust",
    "TotalCost": 1800000,
    "PIC": "John Doe",
    "Note": "Test Adjustment",
    "State": "Accepted"
  },
  {
    "ID": "1b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b",
    "Outlet": "Outlet1",
    "Date": "2018-10-29T00:00:00",
    "Number": "Oct 29, 2018.973265",
    "SKUCount": 5,
    "QuantitySUM": 12,
    "Type": "Count",
    "TotalCost": 200000,
    "PIC": "Royhan",
    "Note": "TestAdjustment",
    "State": "Accepted"
  }
]

Get Adjustment By

Request

Get adjustment details by number or ID. Requires the "VIEW" role in the "Adjustment" module.

Security
OAuth2_clientCredentials
Query
Outletstring

The name of the outlet that made the adjustment

Example: Outlet=Outlet1
Numberstring

Number of adjustment invoice

Example: Number=20.08.00014
IDstring

ID of adjustment invoice

Example: ID=7da1930f-7be5-4796-b55b-32dfbb0ac026
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Adjustment/Detail?Outlet=Outlet1&Number=20.08.00014&ID=7da1930f-7be5-4796-b55b-32dfbb0ac026' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
IDstring

Adjustment ID

Outletstring

Name of the outlet

Datestring

Date of the Adjustment

Numberstring

Number of the adjusment

PICstring

Person in charge of the Adjusment

Typestring

Type of the Adjusment

Enum"Adjust""Count"
Statestring

Progress/State of the adjusment

Enum"Draft""Pending""Accepted""Rejected"
Notestring

Adjusment Note

CountMethodstring

Source of adjustment creation

Enum"web""csv""barcode""rfid"
AdjustedInventoryArray of objects
CountedInventoryArray of objects
Response
application/json
{
  "ID": "7da1930f-7be5-4796-b55b-32dfbb0ac026",
  "Outlet": "Outlet1",
  "Date": "2020-08-31T00:00:00",
  "Number": "20.08.00014",
  "PIC": "Ferdi",
  "Type": "Count",
  "State": "Accepted",
  "Note": "",
  "CountMethod": "rfid",
  "AdjustedInventory": [
    { … }
  ],
  "CountedInventory": [
    { … }
  ]
}

Get Adjustment By ID

Request

Get adjustment detail by adjustment ID. Requires the "VIEW" role in the "Adjustment" group.

Security
OAuth2_clientCredentials
Query
IDstringrequired

ID of the adjustment

Example: ID=7da1930f-7be5-4796-b55b-32dfbb0ac026
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Adjustment/ID?ID=7da1930f-7be5-4796-b55b-32dfbb0ac026' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
IDstring

Adjustment ID

Outletstring

Name of the outlet

Datestring

Date of the Adjustment

Numberstring

Number of the adjusment

PICstring

Person in charge of the Adjusment

Typestring

Type of the Adjusment

Enum"Adjust""Count"
Statestring

Progress/State of the adjusment

Enum"Draft""Pending""Accepted""Rejected"
Notestring

Adjusment Note

ExpectedMethodstring

Data source of adjustment. None = data not shown, Counted = Counted by user, All = All variants can be adjusted

Enum"None""Counted""All"
CategoryIDstring(guid)

Category ID of variant

CategoryNamestring

Category Name of variant

CountMethodstring

Source of adjustment creation

Enum"web""csv""barcode""rfid"
CreatorIDstring(guid)

ID of the user who created the adjustment

AdjustedInventoryArray of objects
CountedInventoryArray of objects
Response
application/json
{
  "ID": "7da1930f-7be5-4796-b55b-32dfbb0ac026",
  "Outlet": "Outlet1",
  "Date": "2020-08-31T00:00:00",
  "Number": "20.08.00014",
  "PIC": "Ferdi",
  "Type": "Count",
  "State": "Accepted",
  "Note": "",
  "ExpectedMethod": "Counted",
  "CategoryID": "123e4567-e89b-12d3-a456-426614174000",
  "CategoryName": "Top",
  "CountMethod": "rfid",
  "CreatorID": "7da1930f-7be5-4796-b55b-32dfbb0ac026",
  "AdjustedInventory": [
    { … }
  ],
  "CountedInventory": [
    { … }
  ]
}

List Adjustment With Total Count

Request

Get a list of adjustments with total count, filterable by date range, page number, page size, and adjustment number. Requires the "VIEW" role in the "Adjustment" group.

Security
OAuth2_clientCredentials
Query
Fromstring(date-time)

Start date of adjustment list shown (format yyyy-mm-dd)

Example: From=2018-10-01
Tostring(date-time)

End date of adjustment list shown (format yyyy-mm-dd)

Example: To=2018-10-31
PageNumberintegerrequired

The number of page data to be displayed

Example: PageNumber=1
PageSizeintegerrequired

The number of rows returned by the API

Example: PageSize=20
Numberstring

Adjustment Number to filter. (Can search contain of the number)

Example: Number=2018/11/07.0001
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Adjustment/WithTotalCount?From=2018-10-01&To=2018-10-31&PageNumber=1&PageSize=20&Number=2018%2F11%2F07.0001' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
DataArray of objects
TotalCountinteger

Total count of the result

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

Get Adjustment Workflow

Request

Get the adjustment workflow configuration from system settings.

Security
OAuth2_clientCredentials
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Adjustment/Workflow \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
Workflowinteger

Workflow of the Adjustment (1 = No Approval (Instant), 2 = With Approval)

Enum12
Response
application/json
{
  "Workflow": 1
}

Submit Review Adjustment

Request

Submit a pending inventory adjustment for review by outlet and adjustment number. Requires the "APPROVAL" role in the "Adjustment" module.

Security
OAuth2_clientCredentials
Bodyapplication/json
Outletstringrequired

Outlet Name

Example: "Outlet1"
Numberstringrequired

Adjustment number

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

Responses

OK

Bodyapplication/json
Messagestring
Example: "Inventory Adjustment Number Adjustment001 already Submitted"
Response
application/json
{
  "Message": "Inventory Adjustment Number Adjustment001 already Submitted"
}

Accept Adjustment

Request

Accept an inventory adjustment by outlet and adjustment number. Requires the "APPROVAL" role in the "Adjustment" module.

Security
OAuth2_clientCredentials
Bodyapplication/json
Outletstringrequired

Outlet Name

Example: "Outlet1"
Numberstringrequired

Adjustment number

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

Responses

OK

Bodyapplication/json
Messagestring
Example: "Inventory Adjustment Number Adjustment001 Accepted"
Response
application/json
{
  "Message": "Inventory Adjustment Number Adjustment001 Accepted"
}

Reject Adjustment

Request

Reject an inventory adjustment by outlet and adjustment number. Requires the "APPROVAL" role in the "Adjustment" module.

Security
OAuth2_clientCredentials
Bodyapplication/json
Outletstring
Example: "Outlet1"
Numberstring
Example: "Adjustment001"
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Adjustment/Reject \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "Adjustment001"
  }'

Responses

OK

Bodyapplication/json
Messagestring
Example: "Inventory Adjustment Number Adjustment001 Accepted"
Response
application/json
{
  "Message": "Inventory Adjustment Number Adjustment001 Rejected"
}

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