Skip to content
/
Get Reference Number By I...

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

Join Invoice Detail

Request

Get Join Invoice Detail based on ID Join Invoice.

Required Group Role: "Debt" - "View"

Security
OAuth2_clientCredentials
Path
idstring(guid)required

Unique identifier for the transaction

Example: d4a2b6ea-bf51-4e14-9d82-685aed1b2936
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Invoice/Join/Detail/d4a2b6ea-bf51-4e14-9d82-685aed1b2936 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Transaction details

Bodyapplication/json
IDstring

Join Invoice ID

Example: "d4a2b6ea-bf51-4e14-9d82-685aed1b2936"
OutletIDstring(guid)

Outlet ID

Example: "62844da2-47c8-43d1-b3f1-dfa5c014c872"
Outletstring

Name of the outlet

Example: "Outlet1"
Numberstring

Number of the join invoice

Example: "JI.25.04.00001"
Datestring(date-time)

Date of the join invoice

Example: "2020-08-17T00:00:00Z"
Customerstring

Name of the customer

Example: "Ferdian"
CreatorIDstring(guid)

ID of the user who created the join invoice

Example: "abc2b688-cd78-8118-9064-6123aed1b1234"
InvoiceArray of objects
PaymentArray of objects
Response
application/json
{
  "ID": "d4a2b6ea-bf51-4e14-9d82-685aed1b2936",
  "OutletID": "62844da2-47c8-43d1-b3f1-dfa5c014c872",
  "Outlet": "Outlet1",
  "Number": "JI.25.04.00001",
  "Date": "2020-08-17T00:00:00Z",
  "Customer": "Ferdian",
  "CreatorID": "abc2b688-cd78-8118-9064-6123aed1b1234",
  "Invoice": [
    { … }
  ],
  "Payment": [
    { … }
  ]
}

Get Reference Number By Invoice ID

Request

Get List Reference Number by Invoice ID

Security
OAuth2_clientCredentials
Bodyapplication/json
ListIDArray of strings

Array of List Invoice ID

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Invoice/GetReferenceNumber \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ListID": [
      "1e9c45af-9916-4131-a138-01ffd0ec1eba",
      "0b9657f4-5e12-4d4a-89d6-c104a55c6c49"
    ]
  }'

Responses

OK

Bodyapplication/jsonArray [
IDstring

ID of Invoice

ReferenceNumberstring

Number that associated with a specific invoice issued to a customer which gets from invoice Marketplace channel

]
Response
application/json
[
  {
    "ID": "1e9c45af-9916-4131-a138-01ffd0ec1eba",
    "ReferenceNumber": "TKPD-001"
  },
  {
    "ID": "0b9657f4-5e12-4d4a-89d6-c104a55c6c49",
    "ReferenceNumber": "TKPD-002"
  }
]

Update Note in Invoice

Request

Add / edit Invoice note

You must have "EDIT" role in "Sell" Modul

Security
OAuth2_clientCredentials
Bodyapplication/json
Outletstringrequired

Outlet Name

Numberstringrequired

Number Invoice

Notestringrequired

Invoice Note. (If send the request with empty string will replace invoice note to null value)

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

Responses

Success response

Bodyapplication/json
Messagestring

Success message

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

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