Get Accounting Information

Description

取得帳務資訊。

Resource

GET /v1/report/accounting_information

Authorization

採用 OAuth 2.0 Bearer Token，詳細使用流程請參考 Auth Login。

Query Parameters

Name	Type	Description
store_id	string	門市編號
start_date	string	開始日期 (例：2021-12-31)
end_date	string	結束日期 (例：2021-12-31)
machine_id	string	機號 (optional)

Request

GET /v1/report/accounting_information?store_id=0&start_date=2021-12-31&end_date=2021-12-31 &machine_id=K1

Response Body Parameters

Name	Type	Description
revenue	Revenue	營業額
discount	Money	總折扣讓
total_sale	Money	銷售總額
receipt	Receipt	銷售總額
other	Receipt	其他

Response Body Parameters - Revenue

Name	Type	Description
revenue_items	List[Revenue Item ]	營業總表
total_revenue	Money	營業總額

Response Body Parameters - Revenue Item

Name	Type	Description
type	Payment	付款方式
payment_amount	Money	支付金額

Request Body Parameters - Payment Instruction

type	name
LINE_PAY	LINE Pay
PI_PAY	Pi Pay
CREDIT_CARD	信用卡
EASY_CARD	悠遊卡
CASH	臨櫃結帳
MWD_PAY	麥味登Pay
Easy_Wallet	悠遊付
APPLE_PAY	Apple Pay
GOOGLE_PAY	Google Pay
NCCC_EASY_CARD	NCCC悠遊卡
NCCC_IPASS	NCCC一卡通
NCCC_ICASH	NCCC iCash
NCCC_HAPPY_CASH	NCCC有錢卡
CASH_CAR	現金
CHARGE_CARD	簽帳
MOTORCADE	車隊
CREDIT_CARD_CAR	信用卡
CTBC_CARD	中信卡
BARCODE_PAY	條碼支付
TAIWAN_PAY	台灣 Pay
JkoPay	街口支付
CUSTOMIZE	自定義金流
TK01	門票折抵
HAO_SPEED	全家外送自取
EC	EC
PX_PAY	全支付
HSA_EXTRA	異質POS
NEWEB_PAY	藍新金流

Response Body Parameters - Money

Name	Type	Description
amount	float	最小單位金額
currency_code	string	貨幣代碼 ISO 4217 code
formatted_amount	string	顯示用金額

Response Body Parameters - Receipt

Name	Type	Description
count	integer	發票張數
receipt_amount	Money	發票金額
void_receipt_count	integer	作廢發票張數
void_receipt_amount	Money	作廢發票金額

Response Body Parameters - Other

Name	Type	Description
customer_count	integer	來客數
sale_count	integer	銷售數量
average_price	float	平均客單價

Response

{
  "revenue": {
    "revenue_items": [
      {
        "type": "CASH",
        "payment_amount": {
          "amount": 512,
          "currency_code": "TWD",
          "formatted_amount": "512"
        }
      },
      {
        "type": "CREDIT_CARD",
        "payment_amount": {
          "amount": 100,
          "currency_code": "TWD",
          "formatted_amount": "100"
        }
      },
      {
        "type": "LINE_PAY",
        "payment_amount": {
          "amount": 200,
          "currency_code": "TWD",
          "formatted_amount": "200"
        }
      },
      {
        "type": "Easy_Wallet",
        "payment_amount": {
          "amount": 100,
          "currency_code": "TWD",
          "formatted_amount": "100"
        }
      }
    ],
    "total_revenue": {
      "amount": 1012,
      "currency_code": "TWD",
      "formatted_amount": "1012"
    }
  },
  "discount": {
    "amount": 650,
    "currency_code": "TWD",
    "formatted_amount": "650"
  },
  "total_sale": {
    "amount": 1662,
    "currency_code": "TWD",
    "formatted_amount": "1662"
  },
  "receipt": {
    "count": 20,
    "receipt_amount": {
      "amount": 1012,
      "currency_code": "TWD",
      "formatted_amount": "1012"
    },
    "void_receipt_count": 0,
    "void_receipt_amount": {
      "amount": 0,
      "currency_code": "TWD",
      "formatted_amount": "0"
    }
  },
  "other": {
    "customer_count": 20,
    "sale_count": 79,
    "average_price": 58.0
  }
}