Skip to content
/
List Join Invoice

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

Erase Invoice

Request

Please keep in mind that erased Invoice cannot be restored

Permanently Delete Invoice if its already on Recycle Bin

You must have "DELETE" role in "ORDER" Module OR "DELETE" role in "Global" Module

Security
OAuth2_clientCredentials
Bodyapplication/json

Request can be send with payload Outlet+Number / OutletID + Number /InvoiceID only

One of:
Outletstringrequired

Outlet Name

Example: "Offline"
Numberstringrequired

Invoice Number

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

Responses

Bodyapplication/json
Messagestring

Success message

Response
application/json
{
  "Message": "Invoice has been Erased!"
}

List Join Invoice

Request

Get List of Join Invoice

Required Group Role: "Debt" - "View"

Security
OAuth2_clientCredentials
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 for filtering transactions.

Example: From=2020-08-01T00:00:00Z
Tostring(date-time)

End date for filtering transactions.

Example: To=2020-08-31T23:59:59Z
CustomerIDstring(guid)

Unique identifier for the customer.

Example: CustomerID=d4a2b6ea-bf51-4e14-9d82-685aed1b2936
Numberstring

Filter transactions by transaction number.

Example: Number=JI.25.04.00001
PaymentStatestring

Filter transactions by payment state. if not provided, all states will be included.

Enum"Paid""Unpaid""Partial""Exceed""Bulk""WriteOff"
Example: PaymentState=Paid
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Invoice/Join?PageNumber=1&PageSize=20&Outlet=Outlet1&From=2020-08-01T00%3A00%3A00Z&To=2020-08-31T23%3A59%3A59Z&CustomerID=d4a2b6ea-bf51-4e14-9d82-685aed1b2936&Number=JI.25.04.00001&PaymentState=Paid' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

A list of transactions.

Bodyapplication/json
DataArray of objects
Response
application/json
{
  "Data": [
    { … }
  ]
}

List Join Invoice with Total Count

Request

Get List of Join Invoice with Total Count

Required Group Role: "Debt" - "View"

Security
OAuth2_clientCredentials
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 for filtering transactions.

Example: From=2020-08-01T00:00:00Z
Tostring(date-time)

End date for filtering transactions.

Example: To=2020-08-31T23:59:59Z
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Invoice/Join/TotalCount?PageNumber=1&PageSize=20&Outlet=Outlet1&From=2020-08-01T00%3A00%3A00Z&To=2020-08-31T23%3A59%3A59Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

A list of transactions.

Bodyapplication/json
DataArray of objects
TotalCountinteger

Total number of transactions Join Invoice

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

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

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

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

Operations