Sales Order

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

Create Sales Order

Request

Create Sales Order

You must have "Create" role in "Sell" Module OR "EDIT" role in "Global" Module

Bodyapplication/json
One of:
Outletstringrequired

Outlet Name

Example: "Outlet1"
Numberstringrequired

Invoice Number

Example: "20.06.00001"
Datestringrequired

Date of customer invoice created (YYYY-MM-DD)

Example: "2020-06-24"
SalesPersonstring

Sales Person name

Example: "Sales 1"
TaxTypestring

Tax Type

Example: "No Tax"
Discount1integer

Discount 1 percentage

Discount2integer

Discount 2 percentage

DiscountAmountinteger

Discount amount

LogisticServiceCodestring

Code of Logistic Service Option

Example: "JNE-R"
ReferenceNumberstring

Number that associated with a specific invoice issued to a customer which gets from invoice Marketplace channel. (Backwards Compatibility with property PurchaseOrderNumber)

Example: "TKPD-001"
Customerobject
Example: {"Name":"Hendry Wijaya","Email":"Hendry@dealpos.com","Phone":"02165498468","Mobile":"081514515156","Code":"HW021"}
VariantsArray of objects
Example: [{"Code":"200536","Quantity":"10","Price":"3500","Discount":0,"Note":"Item 1"},{"Code":"1315L","Quantity":"10","Price":"4000","Discount":0,"Note":"Item 2"}]
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/SalesOrder \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "20.06.00001",
    "Date": "2020-06-24",
    "SalesPerson": "Sales 1",
    "TaxType": "No Tax",
    "Discount1": 0,
    "Discount2": 0,
    "DiscountAmount": 0,
    "LogisticServiceCode": "JNE-R",
    "ReferenceNumber": "TKPD-001",
    "Customer": {
      "Name": "Hendry Wijaya",
      "Email": "Hendry@dealpos.com",
      "Phone": "02165498468",
      "Mobile": "081514515156",
      "Code": "HW021"
    },
    "Variants": [
      {
        "Code": "200536",
        "Quantity": "10",
        "Price": "3500",
        "Discount": 0,
        "Note": "Item 1"
      },
      {
        "Code": "1315L",
        "Quantity": "10",
        "Price": "4000",
        "Discount": 0,
        "Note": "Item 2"
      }
    ]
  }'

Responses

Bodyapplication/json
IDstring

Sales order ID which has been made

Numberstring

Sales Order Number which has been made

Response
application/json
{
  "ID": "21e0dbb6-f240-4bda-8f03-769362f88d10",
  "Number": "20.06.00001"
}

Delete Sales Order

Request

Delete Sales Order

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

Bodyapplication/json
One of:
Outletstringrequired

Outlet name

Example: "Outlet1"
Numberstringrequired

Invoice number to be deleted

Example: "20.06.00001"
OutletIDstringrequired

Guid of Outlet ID

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

Responses

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "SalesOrder  21.02.00011 has been deleted"
}

Convert Sales Order to Invoice

Request

Convert Sales Order to Invoice

You must have “Create” role in “Sell” Module OR “EDIT” role in “Global” Module

Bodyapplication/json
One of:
OutletIDstring

Guid of Outlet ID

Outletstringrequired

Outlet Name

Example: "Outlet1"
Numberstringrequired

Sales Order Number

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

Responses

Bodyapplication/json
IDstring

Invoice ID

Numberstring

Invoice Number

Response
application/json
{
  "ID": "21e0dbb6-f240-4bda-8f03-769362f88d10",
  "Number": "20.06.00001"
}

Get Sales Order By List Number

Request

Also available as HTTP POST with the same endpoint


Get Sales Order List based on Number

Required Group Role: "Orders" - "View"

Bodyapplication/json
One of:
Outletstringrequired

Outlet Name

Example: "Outlet1"
NumberArray of stringsrequired

Sales Order Numbers

Example: ["20.11.00003","20.11.00002","20.11.00001"]
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/SalesOrder/GetByListNumber \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": [
      "20.11.00003",
      "20.11.00002",
      "20.11.00001"
    ]
  }'

Responses

Bodyapplication/jsonArray [
Outletstring

Outlet name

Datestring

Sales order date

Numberstring

Sales order number

InvoicedStatestring

status progress of the sales order

DeliveryStatestring

delivery status progres of the sales order

Enum"Sent""Unsent""Partial"
PaymentStatestring

payment status progress of the sales order

Binboolean

Recycle bin status of the sales order

]
Response
application/json
[
  {
    "Outlet": "Outlet1",
    "Date": "2020-11-05T00:00:00",
    "Number": "20.11.00003",
    "InvoicedState": "Complete",
    "DeliveryState": "Sent",
    "PaymentState": "Paid",
    "Bin": false
  },
  {
    "Outlet": "Outlet1",
    "Date": "2020-11-05T00:00:00",
    "Number": "20.11.00002",
    "InvoicedState": "Complete",
    "DeliveryState": "Sent",
    "PaymentState": "Paid",
    "Bin": false
  },
  {
    "Outlet": "Outlet1",
    "Date": "2020-11-05T00:00:00",
    "Number": "20.11.00001",
    "InvoicedState": "Complete",
    "DeliveryState": "Sent",
    "PaymentState": "Paid",
    "Bin": false
  }
]

Get Sales Order ID by Number

Request

Also available as HTTP POST with the same endpoint


Get Sales Order ID by Number

Required Group Role: "Orders" - "View"

Bodyapplication/json
One of:
Outletstringrequired

Outlet Name

Example: "Outlet1"
Numberstringrequired

Sales Order Number

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

Responses

Bodyapplication/json
IDstring

Sales order ID

Response
application/json
{
  "ID": "90ad0fb6-0340-4254-90f5-15e213b95a82"
}

Get Sales Order Total Count

Request

Also available as HTTP POST with the same endpoint


Get Sales Order Total Count based on selected outlet(s).

Required Group Role: "Orders" - "View"

Bodyapplication/json
One of:
Fromstring(date)

Start Date of Sales Order Created

Tostring(date)

Till Date of Sales Order Created

ListOutletIDArray of strings

Array of List OutletID

OutletArray of strings

Outlet Name

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

Channel Tagging System

Example: ["Tokopedia","Shopee"]