Skip to content
/
Received by Outlet

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

Received by Outlet

Request

Get invoice payment summary grouped by outlet for a date range. Requires the "VIEW" role in the "Payment" module.

Security
OAuth2_clientCredentials
Query
Fromstringrequired

From date

Example: From=2023-01-01
Tostringrequired

To date

Example: To=2023-01-31
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Payment/Invoice?From=2023-01-01&To=2023-01-31' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
Outletstring

the outlet of the transaction

PaymentsArray of objects
]
Response
application/json
[
  {
    "Outlet": "Outlet1",
    "Payments": [ … ]
  },
  {
    "Outlet": "Outlet2",
    "Payments": [ … ]
  }
]

Add Payment

Request

Add payment(s) to an invoice, supporting validation and outlet ID options. Requires the "ADD" role in the "Payment" module or the "EDIT" role in the "Global" module.

Security
OAuth2_clientCredentials
Bodyapplication/json
One of:
Outletstringrequired

Outlet of transaction

Example: "Outlet1"
Numberstringrequired

Invoice transaction number

Example: "20.04.00019"
PaymentsArray of objects
Example: [{"Date":"2023-01-01","Amount":80000,"BuyerPaidAmount":100000,"Method":"Cash","Note":""},{"Date":"2023-01-01","Amount":100000,"BuyerPaidAmount":100000,"Method":"Debit - Outlet Outlet1","Note":""}]
UnpaidValidationboolean

If true, returns 409 when there's an existing payment

Default false
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Payment/Invoice \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "20.04.00019",
    "Payments": [
      {
        "Date": "2023-01-01",
        "Amount": 80000,
        "BuyerPaidAmount": 100000,
        "Method": "Cash",
        "Note": ""
      },
      {
        "Date": "2023-01-01",
        "Amount": 100000,
        "BuyerPaidAmount": 100000,
        "Method": "Debit - Outlet Outlet1",
        "Note": ""
      }
    ]
  }'

Responses

Bodyapplication/json
Messagestring

Invoice has been paid

Response
application/json
{
  "Message": "Invoice Number 20.04.00019 has successfully completed a Paid"
}

Delete Payment

Request

Delete Payment in invoice

You must have "Edit" role in "Payment" Module

Security
OAuth2_clientCredentials
Bodyapplication/json
One of:
Outletstringrequired

Outlet Name that you want to delete

Example: "Outlet1"
Numberstringrequired

Invoice number that you want to delete

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

Responses

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "Invoice Number .21.10.00001 has successfully deleted"
}

Payment Invoice Detail

Request

Get payment invoice detail by Invoice ID. Required Group Role: "Payment" - "VIEW"

Security
OAuth2_clientCredentials
Query
IDstring(guid)required

Invoice ID

Example: ID=f2296e61-e405-4884-9e54-55f14a91748b
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Payment/Invoice/Detail/ID?ID=f2296e61-e405-4884-9e54-55f14a91748b' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
Outletstring
Example: "Outlet1"
Numberstring
Example: "Invoice001"
InvoiceIDstring(guid)
Example: "f2296e61-e405-4884-9e54-55f14a91748b"
Methodstring
Example: "Cash"
Amountnumber
Example: 100000
Datestring(date-time)
Example: "2024-01-01T12:00:00Z"
Response
application/json
{
  "Outlet": "Outlet1",
  "Number": "Invoice001",
  "InvoiceID": "f2296e61-e405-4884-9e54-55f14a91748b",
  "Method": "Cash",
  "Amount": 100000,
  "Date": "2024-01-01T12:00:00Z"
}

Add Payment (Full Payment)

Request

Terminology Changes

StateFilter, will be changed into UnpaidValidation in the upcoming update, the old one will remain works.

This endpoint is a fractions from API/V3/Payment/Invoice. In This endpoint, you will not need to fill the exact payment amount in order to fill the entire payments (fully paid). You will only need to fill the Amount to 0 (zero). Please see the request example attached.

You must have "ADD" role in "Payment" Module OR "EDIT" role in "Global" Module

Security
OAuth2_clientCredentials
Bodyapplication/json
One of:
Numberstringrequired

Invoice transaction number

Example: "20.04.00019"
Outletstringrequired

Outlet of transaction

Example: "Outlet Name"
PaymentsArray of objects
Example: [{"Date":"2020-04-01","Amount":0,"Method":"Cash","Note":""}]
UnpaidValidationboolean

If true, returns 409 when there's an existing payment

Default false
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Payment/Invoice/AddPaymentFull \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Number": "20.04.00019",
    "Outlet": "Outlet Name",
    "Payments": [
      {
        "Date": "2020-04-01",
        "Amount": 0,
        "Method": "Cash",
        "Note": ""
      }
    ],
    "UnpaidValidation": false
  }'

Responses

Bodyapplication/json
Messagestring

Invoice has been paid

Response
application/json
{
  "Message": "Invoice Number 20.04.00019 has successfully completed a Paid"
}

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