發票作業/作廢折讓

使用流程說明

營業人(特店)可使用此功能將折讓作廢參數傳送至綠界,由綠界暫存折讓作廢資料。
綠界於隔日將折讓作廢資料上傳至財政部電子發票整合服務平台,並通知消費者(買家)折讓發票已作廢。

應用場景

若特店開立折讓後,想取消折讓、或開立折讓錯誤..等,可使用此API將已開立折讓的部分作廢(不是整張發票作廢喔!)。此時會將折讓作廢發票參數傳送至綠界暫存。綠界會於隔日,將折讓作廢發票資訊上傳至財政部電子發票整合服務平台。

API介接網址

  • 測試環境:https://einvoice-stage.ecpay.com.tw/B2CInvoice/AllowanceInvalid
  • 正式環境:https://einvoice.ecpay.com.tw/B2CInvoice/AllowanceInvalid

HTTPS傳輸協定

  • Content Type :application/json
  • HTTP Method :POST

特店傳入參數(Json格式)

PlatformID String(10)
特約合作平台商代號

  • 這個參數是專為與綠界簽約的指定平台商所設計,只有在申請開通後才能使用。
  • 如果您是一般廠商,請在介接時將此參數欄位保留為空。
  • 對於平台商,在使用時需要在MerchantID(特店編號)欄位中填入與您已經完成綁定子廠商的MerchantID(特定編號)。
    請注意,只能使用已綁定的子廠商編號,以避免操作失敗。綁定作業請洽所屬業務。

MerchantID String(10)
特店編號 必填

RqHeader Object
傳入資料 必填

Timestamp Number
傳入時間 必填

請將傳輸時間轉換為時間戳(GMT+8),綠界會利用此參數將當下的時間轉為Unix TimeStamp來驗證此次介接的時間區間。

❗ 注意事項

  • 驗證時間區間暫訂為 10 分鐘內有效,若超過此驗證時間則此次訂單將無法建立,參考資料:http://www.epochconverter.com/
  • 合作特店須進行主機「時間校正」,避免主機產生時差,導致API無法正常運作。

Data String
加密資料 必填

此為加密過JSON格式的資料。加密方法說明

特店傳入參數範例(Json格式)

				
					{
    "MerchantID": "2000132",
    "RqHeader": {
        "Timestamp": 1525168923
    },
    "Data": "加密資料"
}

				
			

Data參數說明(Json格式) : 請先將Json字串進行urlencode後再進行AES加密

MerchantID String(10)
特店編號 必填

InvoiceNo String(10)
發票號碼 必填

長度固定為10碼

AllowanceNo String(16)
折讓編號 必填

Reason String(20)
作廢折讓原因 必填

Data參數範例(Json格式)

				
					{
   "MerchantID": 2000132,
    "InvoiceNo": "AA123456",
    "AllowanceNo": "2016022615195209",
    "Reason": ""
}
				
			

綠界回傳參數格式

  • Content Type :application/json
  • HTTP Method :POST

綠界回傳參數(Json格式)

PlatformID String(10)
特約合作平台商代號

MerchantID String(10)
特店編號 

RpHeader Object
回傳資料 

Timestamp Number
回傳時間

Unix timestamp(GMT+8)

TransCode Int
回傳代碼 

1 代表 API 傳輸資料(MerchantID, RqHeader, Data)接收成功,實際的 API 執行結果狀態請參考 RtnCode

TransMsg String(200)
回傳訊息 

Data String
加密資料 

回傳相關資料,此為加密過JSON格式的資料。加密方法說明

綠界回傳參數範例

				
					{
    "MerchantID": "2000132",
    "RpHeader": {
        "Timestamp": 1525169058
    },
    "TransCode": 1,
    "TransMsg": "",
    "Data": "加密資料"
}

				
			

Data參數說明(Json格式) : 請先將Data進行AES解密後再做urldecode

RtnCode Int
回應代碼

1 代表 API 執行成功,其餘代碼均為失敗。

RtnMsg String(200)
回應訊息

IA_Invoice_No String(10)
發票號碼

若作廢成功,則會回傳發票號碼;
若作廢失敗,則會回傳空值。

Data參數範例

				
					{
    "RtnCode": "1",
    "RtnMsg": "該折讓單已作廢",
    "IA_Invoice_No": "AA123456"
}
				
			

❗ 注意事項: 

每年奇數月的 13 號 23:59:59 以後,因已申報至財政部,無法作廢前兩個月開立的發票折讓。例如 3 月 14 號時,不能作廢 1、2 月所開立的發票折讓。

YAML

提供的 YAML 文件用於定義 API 的配置、結構、操作和基礎設施管理等資訊,方便開發人員理解和使用 API。

				
					openapi: 3.1.0
info:
  title: ECPay Void Allowance API
  version: 1.0.0
servers:
  - url: https://einvoice-stage.ecpay.com.tw
  - url: https://einvoice.ecpay.com.tw
paths:
  /B2CInvoice/AllowanceInvalid:
    post:
      summary: Void Allowance
      description: This API voids previously issued allowances.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - MerchantID
                - RqHeader
                - Data
              properties:
                MerchantID:
                  type: string
                  maxLength: 10
                  description: Merchant ID
                RqHeader:
                  type: object
                  required:
                    - Timestamp
                  properties:
                    Timestamp:
                      type: integer
                      description: Unix timestamp in GMT+8
                Data:
                  type: string
                  description: Encrypted data
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  MerchantID:
                    type: string
                    description: Merchant ID
                  RpHeader:
                    type: object
                    properties:
                      Timestamp:
                        type: integer
                        description: Unix timestamp in GMT+8
                  TransCode:
                    type: integer
                    description: Transmission code indicating success or failure
                  TransMsg:
                    type: string
                    maxLength: 200
                    description: Transmission message
                  Data:
                    type: string
                    description: Encrypted response data
components:
  schemas:
    requestBody.Data:
      type: object
      required:
                - MerchantID
                - InvoiceNo
                - AllowanceNo
                - Reason
      properties:
        MerchantID:
          type: string
          maxLength: 10
          description: Merchant ID
        InvoiceNo:
          type: string
          maxLength: 10
          description: Invoice number
        AllowanceNo:
          type: string
          maxLength: 16
          description: Allowance number
        Reason:
          type: string
          maxLength: 20
          description: Reason for voiding the allowance
    responses.Data:
      type: object
      properties:
        RtnCode:
          type: integer
          description: Response code indicating success or failure
        RtnMsg:
          type: string
          maxLength: 200
          description: Response message
        IA_Invoice_No:
          type: string
          maxLength: 10
          description: Invoice number

				
			

Copyright © Green World FinTech Service Co., Ltd. All rights reserved.

綠界官方網站