Skip to content
/
List Invoices Return

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

List Invoice Multiple Outlet With Total Count

Request

Also available as HTTP POST with the same endpoint

Get Invoice List by Multiple Outlet with Total Count

Security
OAuth2_clientCredentials
Bodyapplication/json
One of:
PageNumbernumberrequired

The number of page data to be displayed

Example: 1
PageSizenumberrequired

The size of one page. Max=500

Example: 20
OutletArray of stringsrequired

List of multiple outlet names

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

List of multiple payment status

Example: "Paid"
Fulfillmentstring

delivery status / progres of the invoice

Enum"Sent""Partial""Unsent""Returned"
Statusstring

Filter Orders By their status (Active, Cancelled, Any.)

Default "Active"
Enum"Active""Cancelled""Any"
Example: "Active"
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Invoice/MultipleOutlet/WithTotalCount \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": "2020-08-01",
    "To": "2020-09-30",
    "PageNumber": 1,
    "PageSize": 20,
    "Outlet": [
      "Outlet1",
      "Outlet2"
    ],
    "PaymentState": "Paid",
    "DeliveryState": "Sent",
    "Status": "Active"
  }'

Responses

Bodyapplication/json
DataArray of objects
TotalCountinteger

Total count of the result

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

List Invoices Return

Request

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


Get List of Invoices Return

Required Group Role: "Orders" - "View"

Security
OAuth2_clientCredentials
Bodyapplication/json
One of:
Fromstring

From Date. this is primary key for the object

Default "format : yyyy-mm-dd"
Example: "2018-09-07"
Tostring

To Date. this is primary key for the object

Default "format: yyyy-mm-dd"
Example: "2018-10-17"
PageNumberintegerrequired

The number of page data to be displayed

Example: 1
PageSizeintegerrequired

The size of one page. Max=500

Example: 20
Outletstring

Outlet name. (Only for access outlet Read/Write that given to the user)

Example: "Outlet1"
TagArray of objects

Channel Tagging system. (ex:Offline / Whatsapp / Shopee / Tokopedia) used in marketplace.dealpos.app.

Example: ["Tokopedia","Shopee"]
Paymentstring

Payment State

Enum"Paid""Partial""Unpaid"
Example: "Paid"
Fulfillmentstring

Fulfillment State

Enum"Sent""Unsent"
Example: "Sent"
Emailstring

Email address of customer

Example: "Hendry@dealpos.com"
Mobilestring

Phone or mobile phone number of customer

Example: "08112345"
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Invoice/Return \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": "2018-09-07",
    "To": "2018-10-17",
    "PageNumber": 1,
    "PageSize": 20,
    "Outlet": "Outlet1",
    "Tag": [
      "Tokopedia",
      "Shopee"
    ],
    "Payment": "Paid",
    "Fulfillment": "Sent",
    "Email": "Hendry@dealpos.com",
    "Mobile": "08112345"
  }'

Responses

Bodyapplication/jsonArray [
IDstring

Invoice ID

Outletstring

Outlet Name

Numberstring

Number Of invoice info

Customerstring

Customer Name

Datestring

Invoice Date Transaction Date

EventDatestring

Due date of shipping delivery

Duestring

Due date of invoice

Amountnumber

Total amount transaction

Paymentstring

Payment State of invoice

Enum"Unpaid""Partial""Paid""Exceed"
Fulfillmentstring

Fulfillment Status of the invoice

Enum"Sent""Unsent"
Createdstring

Invoice created time

]
Response
application/json
[
  {
    "ID": "3de705c4-53a0-4a66-8ab1-f9737e3ad6fb",
    "Outlet": "Outlet1",
    "Number": "18.10.00009",
    "Customer": "Ferdi",
    "Date": "2018-10-17T00:00:00",
    "EventDate": "0001-01-01T00:00:00",
    "Due": "0001-01-01T00:00:00",
    "Amount": 120000,
    "Payment": "Paid",
    "Fulfillment": "Sent",
    "Created": "2019-08-28T11:00:20.34"
  },
  {
    "ID": "3de7eve4-53a0-tsw6-8ab1-f9737e3adweb",
    "Outlet": "Outlet1",
    "Number": "18.10.00002",
    "Customer": "Ferdi",
    "Date": "2018-10-16T00:00:00",
    "EventDate": "0001-01-01T00:00:00",
    "Due": "0001-01-01T00:00:00",
    "Amount": 150000,
    "Payment": "Paid",
    "Fulfillment": "Sent",
    "Created": "2019-08-28T11:00:20.34"
  }
]

List Invoice With Total Count

Request

Also available as HTTP POST with the same endpoints


List Invoices with Total Count

Required Group Role: "Orders" - "View"

Security
OAuth2_clientCredentials
Query
Fromstring

Selected start of a date range

Example: From=2018-09-07
Tostring

Selected end of a date range

Example: To=2018-10-17
PageNumberintegerrequired

The number of page data to be displayed

Example: PageNumber=1
PageSizeintegerrequired

The size of one page. Max=500

Example: PageSize=20
Outletstring

Outlet name. If you use this parameter, you don't need to use "OutletID" parameter

Example: Outlet=Outlet1
OutletIDstring

Guid of Outlet ID. If you use this parameter, you don't need to use "Outlet" parameter

Example: OutletID=0d46700d-35a3-4fb5-9b3a-644c370b5af1
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Invoice/WithTotalCount?From=2018-09-07&To=2018-10-17&PageNumber=1&PageSize=20&Outlet=Outlet1&OutletID=0d46700d-35a3-4fb5-9b3a-644c370b5af1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
DataArray of objects
TotalCountinteger

Total count of the result

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

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

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