Invoice Write Off
/
List WriteOff 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
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

Get WriteOff Invoice by Number

Request

Get detail of Write Off Invoice by Number

Query
Outletstringrequired

Outlet Name

Numberstringrequired

Number of invoice which want to cancel write off

OutletIDstringrequired

Guid of Outlet ID

Bodyapplication/json
object
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/WriteOff/Invoice/Number?Number=string&Outlet=string&OutletID=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Body
Numberstring

Number of Invoice

Example: "OLT1/22/12/0058"
Outletstring

Outlet Name

Example: "Outlet1"
Createdstring

Write off time created

Example: "2023-01-04T11:13:21.33"
CreatedBystring

User that write off the invoice

Example: "dealpos"
Amountinteger

Amount of write off payment

Example: 2000
Tagstring

Reason of WriteOff Invoice

Response
{
  "Number": "OLT1/22/12/0058",
  "Outlet": "Outlet1",
  "Created": "2023-01-04T11:13:21.33",
  "CreatedBy": "dealpos",
  "Amount": 2000,
  "Reason": "Logistics"
}

List WriteOff Invoice

Request

List of WriteOff Invoice can filter by date and outlet

Query
Fromstring(date)required

From Date (format: yyyy/mm/dd)

Example: From=2023-01-01
Tostring(date)

To Date (format: yyyy/mm/dd)

Example: To=2023-01-01
Outletstring

Outlet Name

Example: Outlet=Outlet1
OutletIDstring(uuid)

Guid of Outlet ID

Example: OutletID=123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  'https://subdomain.dealpos.net/api/v3/WriteOff/Invoice?From=2019-08-24&Outlet=Outlet1&OutletID=497f6eca-6276-4993-bfeb-53cbbbba6f08&To=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
Numberstring

Number of Invoice

Outletstring

Outlet Name

Customerstring

Customer's Name

Createdstring

Write off time created

CreatedBystring

User that write off the invoice

Amountinteger

Amount of write off payment

Tagstring

Reason of WriteOff Invoice

]
Response
application/json
[
  {
    "Number": "OLT1/22/12/0059",
    "Outlet": "Outlet1",
    "Customer": "John",
    "Created": "2023-01-04T11:13:21.33",
    "CreatedBy": "dealpos",
    "Amount": 5000,
    "Type": "Logistics"
  },
  {
    "Number": "OLT1/22/12/0058",
    "Outlet": "Outlet1",
    "Customer": "Jane",
    "Created": "2023-01-04T11:13:21.33",
    "CreatedBy": "dealpos",
    "Amount": 10000,
    "Type": "BadDebt"
  }
]

Update Write Off

Request

UpdateWrite Off Payment in Invoice. You must have "ADD" role in "Payment" Module

Bodyapplication/json
One of:
Datestring

Write Off date created (yyyy/mm/dd), if value is null it will be set to today

Outletstringrequired

Name of the outlet

Example: "Outlet1"
Numberstringrequired

Invoice number to be writed off

Example: "OLT1.02.01.23.004"
Tagstringrequired

Get from Write off list option

Notestring

Reason of write off

Example: "not paid"
curl -i -X PUT \
  https://subdomain.dealpos.net/api/v3/WriteOff/Invoice \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "date": "2024/02/28",
    "Outlet": "Outlet1",
    "Number": "OLT1.02.01.23.004",
    "Type": "logistic",
    "Note": "not paid"
  }'

Responses

OK

Bodyapplication/json
Messagestring
Example: "Your Invoice has been successfully Write Off"
Response
application/json
{
  "Message": "Your Invoice has been successfully Write Off"
}

Add Write Off

Request

Write Off Payment in Invoice. This API still backwards compatibility with Endpoint api/v3/Payment/Invoice/WriteOff.

You must have "ADD" role in "Payment" Module

Bodyapplication/json
One of:
Datestring

Write Off date created (yyyy/mm/dd), if value is null it will be set to today

Outletstringrequired

Name of the outlet

Example: "Outlet1"
Numberstringrequired

Invoice number to be writed off

Example: "OLT1.02.01.23.004"
Tagstringrequired

Get from Write off list option

Notestring

Reason of write off

Example: "not paid"
curl -i -X POST \
  https://subdomain.dealpos.net/api/v3/WriteOff/Invoice \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "date": "2024/02/28",
    "Outlet": "Outlet1",
    "Number": "OLT1.02.01.23.004",
    "Type": "logistic",
    "Note": "not paid"
  }'

Responses

OK

Bodyapplication/json
Messagestring
Example: "Your Invoice has been successfully Write Off"
Response
application/json
{
  "Message": "Your Invoice has been successfully Write Off"
}

Delete Write Off

Request

Delete WriteOff payment in Invoice

Query
Outletstringrequired

Outlet Name

Numberstringrequired

Number of invoice which want to cancel write off

OutletIDstringrequired

Guid of Outlet ID

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

Responses

OK

Bodyapplication/json
Messagestring
Example: "Write Off Invoice Number [OLT1/22/12/0058] has been cancelled"
Response
application/json
{
  "Message": "Write Off Invoice Number [OLT1/22/12/0058] has been cancelled"
}

Get WriteOff By List Invoice Number

Request

This APi is use for get WriteOff invoice by List Invoice Number

Bodyapplication/json
Outletstringrequired

Outlet Name

Example: "Outlet1"
InvoiceNumberArray of stringsrequired

List Invoice Number

Example: ["INV001","INV002","INV003"]
curl -i -X GET \
  https://subdomain.dealpos.net/api/v3/WriteOff/Invoice/ListInvoiceNumber \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Outlet": "Outlet1",
    "InvoiceNumber": [
      "INV001",
      "INV002",
      "INV003"
    ]
  }'

Responses

OK

Bodyapplication/jsonArray [
Numberstring

Number of Invoice

Outletstring

Outlet Name

Createdstring

Write off time created

CreatedBystring

User that write off the invoice

Amountinteger

Amount of write off payment

Tagstring

Reason of WriteOff Invoice

]
Response
application/json
[
  {
    "Number": "INV001",
    "Outlet": "Outlet1",
    "Created": "2023-01-04T11:13:21.33",
    "CreatedBy": "dealpos",
    "Amount": 2000,
    "Tag": "Logistics"
  },
  {
    "Number": "INV002",
    "Outlet": "Outlet1",
    "Created": "2023-01-04T11:13:21.33",
    "CreatedBy": "dealpos",
    "Amount": 2000,
    "Tag": "Logistics"
  },
  {
    "Number": "INV003",
    "Outlet": "Outlet1",
    "Created": "2023-01-04T11:13:21.33",
    "CreatedBy": "dealpos",
    "Amount": 2000,
    "Tag": "Logistics"
  }
]

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

Outlet

Operations related to outlet, 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

Logistics Service

Operations related to logistics service, 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 API

Operations