Bill

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
License
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

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

Create a Bill

Request

Create a Supplier Bill

You must have "CREATE" role in "Buy" Module OR "EDIT" role in "Global" Module

Bodyapplication/json
Outletstringrequired

Name of the outlet

Numberstringrequired

Unique number for the transaction

Datestring(date)required

Transaction date

DueDatestring(date)

Due date for the transaction

TaxTypestring

Type of tax applied

Discount1number

Percentage of the discount

DiscountAmountnumber

Total discount amount

Notestring

Bill notes

Deliverystringrequired

Delivery status

Supplierobject
VariantsArray of objects

List of product variants

PaymentsArray of objects

List of payments made

curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/Bill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "05.23.2018.0001",
    "Date": "2018-02-23",
    "DueDate": "2018-08-25",
    "TaxType": "PPN 10%",
    "Discount1": 5,
    "DiscountAmount": 10000,
    "Note": "Test note Outlet1",
    "Delivery": "Waiting",
    "Supplier": {
      "Name": "Supplier A",
      "Email": "supplier@dealpos.com",
      "Phone": "085741254",
      "Address": "JL. Muara Karang Cantik Blok P3 Timur No. 30",
      "Gender": "Male"
    },
    "Variants": [
      {
        "Code": "2005",
        "Quantity": "10",
        "Price": "102000",
        "Discount": 10,
        "Note": "Cotton Combet 30'\''s"
      },
      {
        "Code": "2002",
        "Quantity": "10",
        "Price": "120000",
        "Discount": 5,
        "Note": "Denim Shirt(M)"
      }
    ],
    "Payments": [
      {
        "Date": "2018-02-23",
        "Amount": "2150610",
        "Method": "Cash"
      }
    ]
  }'

Responses

Bodyapplication/json
IDstring
Response
application/json
{
  "ID": "410ba2b7-8eff-4759-b5f1-cf47b33ef1cc"
}

Update a Bill

Request

Update a Supplier Bill based on number.

You must have "EDIT" role in "Orders" Module OR "EDIT" role in "Global" Module

Bodyapplication/json
Outletstringrequired

Name of the outlet

Numberstringrequired

Unique number for the transaction

Datestring(date)required

Transaction date

DueDatestring(date)

Due date for the transaction

TaxTypestring

Type of tax applied

Discount1number

Percentage of the discount

DiscountAmountnumber

Total discount amount

Notestring

Bill notes

Deliverystringrequired

Delivery status

Supplierobject
VariantsArray of objects

List of product variants

PaymentsArray of objects

List of payments made

curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/Bill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "Number": "05.23.2018.0001",
    "Date": "2018-02-23",
    "DueDate": "2018-08-25",
    "TaxType": "PPN 10%",
    "Discount1": 5,
    "DiscountAmount": 10000,
    "Note": "Test note Outlet1",
    "Delivery": "Waiting",
    "Supplier": {
      "Name": "Supplier A",
      "Email": "supplier@dealpos.com",
      "Phone": "085741254",
      "Address": "JL. Muara Karang Cantik Blok P3 Timur No. 30",
      "Gender": "Male"
    },
    "Variants": [
      {
        "Code": "2005",
        "Quantity": "10",
        "Price": "102000",
        "Discount": 10,
        "Note": "Cotton Combet 30'\''s"
      },
      {
        "Code": "2002",
        "Quantity": "10",
        "Price": "120000",
        "Discount": 5,
        "Note": "Denim Shirt(M)"
      }
    ],
    "Payments": [
      {
        "Date": "2018-02-23",
        "Amount": "2150610",
        "Method": "Cash"
      }
    ]
  }'

Responses

Bodyapplication/json
IDstring
Response
application/json
{
  "ID": "410ba2b7-8eff-4759-b5f1-cf47b33ef1cc"
}

List Bills

Request

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


Get List of Supplier Bills based on Outlet

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

Bodyapplication/json
Fromstringrequired

From date(yyyy/mm/dd)

Default "format : yyyy-mm-dd"
Tostringrequired

To date(yyyyy/mm/dd)

Default "format : yyyy-mm-dd"
Outletstringrequired

The name of the outlet making a purchase order. This is primary key for the object

PageNumbernumberrequired

The number of page data to be displayed

PageSizenumberrequired

The number of rows returned by the API

curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/Bill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "From": "2020-06-01",
    "To": "2020-06-30",
    "Outlet": "Outlet1",
    "PageNumber": 1,
    "PageSize": 10
  }'

Responses

Bodyapplication/jsonArray [
IDstring

ID of supplier bill that created

Outletstring

Outlet Name of bill transaction created

Numberstring

Bill number transaction

Supplierstring

Supplier Name

Typeinteger

Type of Supplier Bill

Datestring

Bill transaction created date

Duestring

Due Date of payment

Amountinteger

Total purchase amount

Deliverystring

Delivery state of shipping

Enum"Waiting""Received""Partial"
Paymentstring

Status payment of bill transaction

Createdstring

Bill created time

]
Response
application/json
[
  {
    "ID": "d688ff9e-0671-456a-b6f0-223acaa5ee7b",
    "Outlet": "Outlet1",
    "Number": "20.06.00004",
    "Supplier": "hendry",
    "Type": 1,
    "Date": "2020-06-24T00:00:00",
    "Due": "2020-06-24T00:00:00",
    "Amount": 100000,
    "Delivery": "Received",
    "Payment": "Paid",
    "Created": "2020-06-24T13:36:12.97"
  },
  {
    "ID": "ed6ffe55-f08e-4806-be1d-e55f3927e11b",
    "Outlet": "Outlet1",
    "Number": "20.06.00003",
    "Supplier": "PT ABC",
    "Type": 1,
    "Date": "2020-06-24T00:00:00",
    "Due": "2020-06-24T00:00:00",
    "Amount": 100000,
    "Delivery": "Received",
    "Payment": "Paid",
    "Created": "2020-06-24T11:40:27.703"
  },
  {
    "ID": "8169eac5-c2a7-4845-8f96-0b5a8980957a",
    "Outlet": "Outlet1",
    "Number": "20.06.00002",
    "Supplier": "PT ABC",
    "Type": 1,
    "Date": "2020-06-24T00:00:00",
    "Due": "2020-06-24T00:00:00",
    "Amount": 100000,
    "Delivery": "Received",
    "Payment": "Paid",
    "Created": "2020-06-24T11:24:53.027"
  },
  {
    "ID": "057a8d3f-3927-4d61-a533-cd554d2c01e8",
    "Outlet": "Outlet1",
    "Number": "OTL01-20-06-02",
    "Supplier": "PT ABC",
    "Type": 1,
    "Date": "2020-06-19T00:00:00",
    "Due": "2020-06-19T00:00:00",
    "Amount": 87289,
    "Delivery": "Received",
    "Payment": "Paid",
    "Created": "2020-06-19T14:13:13.817"
  },
  {
    "ID": "1b5f9f1f-e836-4330-b79d-9e7737893a78",
    "Outlet": "Outlet1",
    "Number": "OTL01-20-06-01",
    "Supplier": "PT ABC",
    "Type": 1,
    "Date": "2020-06-08T00:00:00",
    "Due": "2020-06-08T00:00:00",
    "Amount": 3138,
    "Delivery": "Received",
    "Payment": "Paid",
    "Created": "2020-06-08T08:40:54.55"
  }
]

Delete a Bill

Request

Delete a Supplier Bill based on Outlet and Number

You must have role "DELETE" role in "Buy" Module

Bodyapplication/json
Outletstringrequired

The name of the outlet making a purchase order

Numberstringrequired

Number of Supplier bill. This is primary key for the object

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

Responses

Bodyapplication/json
Messagestring
Response
application/json
{
  "Message": "Supplier bill has been deleted!"
}

Get a Bill By Number

Request

Also available as HTTP POST with the same endpoint


Get a Supplier Bill detail based on bill number.

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

Bodyapplication/json
Outletstringrequired

Outlet name