Skip to content
/
Get Invoice By Number

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

Create Multiple Invoice

Request

Create Multiples Invoices based on Number.

You must have "CREATE" role in "Orders" Module

Security
OAuth2_clientCredentials
Bodyapplication/json
One of:
Array [
Outletstringrequired

Outlet.Name
Not required when Outlet.ID is provided (required)

Numberstringrequired

Invoice number. this is primary key for the object

SalesPersonstring

Sales person name

TaxTypestring

Tax Type

Datestring

Date of sale(yyyy/mm/dd)

Discount1string

Discount 1 amount or percentage given

Discount2string

Discount 2 amount or percentage given

Deliverystring

Status of delivery

Enum"Sent""Unsent"
Customerobject
VariantsArray of objects
PaymentArray of objects
]
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Invoice/List \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "Outlet": "Outlet1",
      "Number": "18.10.00009",
      "SalesPerson": "Sales 10",
      "TaxType": "PPN 10%",
      "Date": "2018-09-07",
      "Discount1": "5",
      "Discount2": "2",
      "Delivery": "Sent",
      "Customer": {
        "Name": "Hendry",
        "Email": "hendry@dealpos.com",
        "Phone": "085710977713",
        "Address": "JL. Pluit Karang Jelita b5 no.51",
        "Gender": "Male"
      },
      "Variants": [
        {
          "Code": "2014",
          "Quantity": "10",
          "Price": "3500",
          "Discount": 5,
          "Note": "Item 1"
        },
        {
          "Code": "2018",
          "Quantity": "10",
          "Price": "4000",
          "Discount": 10,
          "Note": "Item 2"
        }
      ],
      "Payment": [
        {
          "Amount": "80000",
          "Method": "Cash"
        }
      ]
    },
    {
      "Outlet": "Outlet1",
      "Number": "18.10.00009",
      "SalesPerson": "Sales 10",
      "TaxType": "PPN 10%",
      "Date": "2018-09-07",
      "Discount1": "5",
      "Discount2": "2",
      "Delivery": "Sent",
      "Customer": {
        "Name": "Hendry",
        "Email": "hendry@dealpos.com",
        "Phone": "085710977713",
        "Address": "JL. Pluit Karang Jelita b5 no.51",
        "Gender": "Male"
      },
      "Variants": [
        {
          "Code": "2014",
          "Quantity": "10",
          "Price": "3500",
          "Discount": 5,
          "Note": "Item 1"
        },
        {
          "Code": "2018",
          "Quantity": "10",
          "Price": "4000",
          "Discount": 10,
          "Note": "Item 2"
        }
      ],
      "Payment": [
        {
          "Amount": "70918.93",
          "Method": "Cash"
        }
      ]
    },
    {
      "Outlet": "Outlet1",
      "Number": "18.10.00009",
      "SalesPerson": "Sales 10",
      "TaxType": "PPN 10%",
      "Date": "2018-09-07",
      "Discount1": "5",
      "Discount2": "2",
      "Delivery": "Sent",
      "Customer": {
        "Name": "Hendry",
        "Email": "hendry@dealpos.com",
        "Phone": "085710977713",
        "Address": "JL. Pluit Karang Jelita b5 no.51",
        "Gender": "Male"
      },
      "Variants": [
        {
          "Code": "2014",
          "Quantity": "10",
          "Price": "3500",
          "Discount": 5,
          "Note": "Item 1"
        },
        {
          "Code": "2018",
          "Quantity": "10",
          "Price": "4000",
          "Discount": 10,
          "Note": "Item 2"
        }
      ],
      "Payment": [
        {
          "Amount": "70918.93",
          "Method": "Cash"
        }
      ]
    }
  ]'

Responses

Bodyapplication/jsonArray [
IDstring

Unique identifier of the invoice.

Outletstring

Name of the outlet.

Numberstring

Invoice number.

Customerstring

Name of the customer (null if not applicable).

Datestring(date-time)

Invoice creation date.

EventDatestring(date-time)

Event date related to the invoice.

Duestring(date-time)

Due date of the invoice.

Amountnumber

Total amount for the invoice.

Paymentstring

Payment status of the invoice.

Fulfillmentstring

Fulfillment status of the invoice.

Createdstring(date-time)

Creation timestamp of the invoice.

]
Response
application/json
[
  {
    "ID": "3de705c4-53a0-4a66-8ab1-f9737e3ad6fb",
    "Outlet": "Outlet1",
    "Number": "18.10.00009",
    "Customer": "",
    "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": "",
    "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"
  }
]

Get Invoice By Number

Request

Also available as HTTP POST with the same endpoint


Get an Invoice based on Number

Required Group Role: "Orders" - "View"

Security
OAuth2_clientCredentials
Query
Numberstringrequired

Invoice number. This is the primary key for the object.

Outletstringrequired

Outlet name.

OutletIDstringrequired

GUID of Outlet ID.

curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Invoice/Number?Number=string&Outlet=string&OutletID=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
IDstring

Unique ID of the invoice

Outletstring

Name of the outlet

Numberstring

Number of the invoice transasction

Datestring

Sell date of the invoice transaction

DueDatestring

Due date of the invoice transaction

Tagstring

Channel Tagging system. (ex:Offline / Whatsapp / Shopee / Tokopedia) used in marketplace.dealpos.app. Backwards Compatibility with property request "SalesType"

SalesPersonstring

Sales person name of the invoice transaction

Customerobject
CreatorIDstring

Unique ID of the creator

Createdstring

Invoice created Transaction Date by system

Discount1integer

Percentage of discount 1

Discount2integer

Percentage of discount 2

DiscountAmountnumber

Amount of Discount amount-based

Grossnumber

Total amount of the transaction before discounted

DiscountTotalnumber

Total accumulation of the discounts

TaxTypestring

Type name of the tax

Taxnumber

Total amount of the taxes

TaxRatenumber

Rate of Tax in percentage

Salesnumber

Total amount of the sales after subtraction

Surchargenumber

Additional expense (ex: from credit card)

SalesNTaxnumber

Total amount of sales after taxes

Couponstring

Promotion Coupon Key

Notestring

Note of the invoice transaction

PointUsedinteger

Total point used in the transaction

PointsEarnedinteger

Total point earned from the transaction

Fulfillmentstring

delivery status / progres of the invoice

Enum"Sent""Unsent""Partial""Returned"
LogisticServiceCodestring

Code of Logistic Service Option

Paymentstring

payment status / state of the invoice

Voidstring

Void state / status of the invoice

Binboolean

Recycle bin state/status of the invoice

ReferenceInvoiceNumberstring

Another Invoice that is associated with this Invoice ex: SalesReturn scenario, null when it is normal Sales transaction

EReceiptstring

E-Receipt URL of the invoice transaction

VariantsArray of objects
OutboundLogisticsArray of objects
PaymentsArray of objects
Response
application/json
{
  "ID": "aad4a789-b802-49c1-b66f-f45fbc7ce17f",
  "Outlet": "Outlet1",
  "Number": "20.05.00157",
  "Date": "2020-05-27T00:00:00",
  "DueDate": "0001-01-01T00:00:00",
  "Tag": "Offline",
  "SalesPerson": "Sales 1",
  "Customer": {
    "Code": "HW0001",
    "Email": "hendry@dealpos.com",
    "Mobile": "0815161688",
    "Name": "hendry",
    "Phone": "0815161688"
  },
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2020-05-27T11:10:50.57",
  "Discount1": 20,
  "Discount2": 0,
  "DiscountAmount": 20000,
  "Gross": 100000,
  "DiscountTotal": 48800,
  "TaxType": "No Tax",
  "Tax": 0,
  "TaxRate": 0,
  "Sales": 51200,
  "Surcharge": 1000,
  "SalesNTax": 51200,
  "Coupon": "889977",
  "Note": "Test Note",
  "PointUsed": 0,
  "PointsEarned": 0,
  "Fulfillment": "Sent",
  "LogisticServiceCode": "JNE-R",
  "Payment": "Paid",
  "Void": "No",
  "Bin": false,
  "ReferenceInvoiceNumber": "20.05.00156",
  "EReceipt": "https://receipt.dealpos.app/receipt?Data=N2E0MDJmZWItY2U3Ni00MzA5LWJiMTUtOGIwZDQ5NTIwMWEyX3Rva29hYmFkaWRhYmkuZGVhbHBvcy5uZXQ%3D",
  "Variants": [
    { … }
  ],
  "OutboundLogistics": [
    { … }
  ],
  "Payments": [
    { … }
  ]
}

Get Invoice By ID

Request

Also available as HTTP POST with the same endpoint


Get an Invoice based on Invoice ID

Required Group Role: "Orders" - "View"

Security
OAuth2_clientCredentials
Query
IDstringrequired

Get from ID of Invoice that you want to get the detail . This is primary key for the object

Example: ID=aad4a789-b802-49c1-b66f-f45fbc7ce17f
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/Invoice/ID?ID=aad4a789-b802-49c1-b66f-f45fbc7ce17f' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
IDstring

Unique ID of the invoice

Outletstring

Name of the outlet

Numberstring

Number of the invoice transasction

Datestring

Sell date of the invoice transaction

DueDatestring

Due date of the invoice transaction

Tagstring

Channel Tagging system. (ex:Offline / Whatsapp / Shopee / Tokopedia) used in marketplace.dealpos.app. Backwards Compatibility with property request "SalesType"

SalesPersonstring

Sales person name of the invoice transaction

Customerobject
CreatorIDstring

Unique ID of the creator

Createdstring

Invoice created Transaction Date by system

Discount1integer

Percentage of discount 1

Discount2integer

Percentage of discount 2

DiscountAmountnumber

Amount of Discount amount-based

Grossnumber

Total amount of the transaction before discounted

DiscountTotalnumber

Total accumulation of the discounts

TaxTypestring

Type name of the tax

Taxnumber

Total amount of the taxes

Salesnumber

Total amount of the sales after subtraction

Surchargenumber

Additional expense (ex: from credit card)

SalesNTaxnumber

Total amount of sales after taxes

Couponstring

Registered Coupon Name/Code

Notestring

Note of the invoice transaction

PointUsedinteger

Total point used in the transaction

PointsEarnedinteger

Total point earned from the transaction

Fulfillmentstring

delivery status / progres of the invoice

Enum"Sent""Unsent""Partial""Returned"
Paymentstring

payment status / state of the invoice

Voidstring

Void state / status of the invoice

Binboolean

Recycle bin state/status of the invoice

ReferenceInvoiceNumberstring

Another Invoice that is associated with this Invoice ex: SalesReturn scenario, null when it is normal Sales transaction

ReferenceNumberstring

Reference Number of the Sales Order: ex PurchaseOrderNumber or Marketplace.OrderID

VariantsArray of objects
OutboundLogisticsArray of objects
PaymentsArray of objects
WriteOffobject
Response
application/json
{
  "ID": "aad4a789-b802-49c1-b66f-f45fbc7ce17f",
  "Outlet": "Outlet1",
  "Number": "20.05.00157",
  "Date": "2020-05-27T00:00:00",
  "DueDate": "0001-01-01T00:00:00",
  "Tag": "Offline",
  "SalesPerson": "Sales 1",
  "Customer": {
    "Code": "HW0001",
    "Email": "hendry@dealpos.com",
    "Mobile": "0815161688",
    "Name": "hendry",
    "Phone": "021234567"
  },
  "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
  "Created": "2020-05-27T11:10:50.57",
  "Discount1": 20,
  "Discount2": 0,
  "DiscountAmount": 20000,
  "Gross": 100000,
  "DiscountTotal": 48800,
  "TaxType": "No Tax",
  "Tax": 0,
  "Sales": 51200,
  "Surcharge": 1000,
  "SalesNTax": 51200,
  "Coupon": "223388",
  "Note": "Paid",
  "PointUsed": 0,
  "PointsEarned": 0,
  "Fulfillment": "Sent",
  "Payment": "Paid",
  "Void": "No",
  "Bin": false,
  "ReferenceInvoiceNumber": "20.05.00156",
  "ReferenceNumber": "TKPD-001",
  "Variants": [
    { … }
  ],
  "OutboundLogistics": [
    { … }
  ],
  "Payments": [
    { … }
  ],
  "WriteOff": {
    "ID": "d5f7c3e1-2f4b-4c5-9e2f-3b8f4e6c7a1b",
    "Amount": 2200,
    "Date": "2020-05-28T11:10:50.587",
    "Creator": "Yansen",
    "CreatorID": "ff7848c9-21f1-4c05-ac9e-1e71d829cc9c",
    "Created": "2020-05-28T11:10:50.587",
    "TagID": "a1b2c3d4-e5f6-4789-abcd-ef0123456789"
  }
}

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