Preparation Operations / Searching Application Results of Letter Track Numbers

Application Scenarios

Before issuing or creating the e-invoice, it is regulated by Taiwanese regulations that every merchant or company should apply for the letter track numbers (in Chinese, it is called “字軌”). Normally, without value-adding centers, merchants or business corporations should complete many applications to the E-Platform of MOF, including uploading the e-invoice to the E-Platform, applying for the transmission software (i.e., the Turnkey), and applying for the certificates, etc. With ECPay as a value-adding center, merchants can authorize ECPay to handle these cumbersome applications.
When testing the API, if the API call is successful, merchants can see the result of letter track numbers assigned by the E-invoice Platform, which is a list of InvoiceInfo. Following details the data of API request and response.

Special Notes :

If no result in return, possible reasons might be that you have not yet commissioned or authorized ECPay to do the application for the letter track numbers, or the application is still in the process.

API URLs:

Stage: https://einvoice-stage.ecpay.com.tw/B2CInvoice/GetGovInvoiceWordSetting
Production: https://einvoice.ecpay.com.tw/B2CInvoice/GetGovInvoiceWordSetting

HTTPS format

Content Type ：application/json
HTTP Method ：POST

Request by Merchant (Json format)

PlatformID String(10)

This parameter is specifically designed for platform vendors collaborating with ECPay. It can only be utilized after applying for and activating the service.
If you are a general vendor, please leave the PlatformID empty.
When using this parameter, the MerchantID must be filled in with the specific store code bound to your PlatformID to prevent operation failures.
Please note that only the MerchantID of a bound sub-merchant can be used to avoid operational failures. For binding operations, please contact your business representative.

MerchantID String(10)
Required

RqHeader Object
Required

Request header

Timestamp Number
Required

Please convert the transmission time to a timestamp (GMT+8).
ECPay will use this parameter to convert the current time to Unix TimeStamp to verify the time interval of this connection.

Special Notes：

If ECPay receives the API call more than 10 minutes after the timestamp sent by merchants, this request will fail. Reference information is as follows：http://www.epochconverter.com/。
Merchants are advised to frequently synchronize their server’s time to the nearest time zone server.

Data String
Required

Message payload
This is the encrypted data in JSON format.
AES Encryption Description

Example

				
					{
    "MerchantID": "2000132",
    "RqHeader": {
        "Timestamp": 1525168923
    },
    "Data": "..."
}

Message payload of Data (JSON format): please urlencode the JSON string first and then do AES encryption

MerchantID String(10)
Required

InvoiceYear String(3)
Required

The year of the e-invoice (in “Republic Era”)
Only last year, this year and next year can be looked-up. The year is referred to the “Republic Era.”
For example, the year “2021” is the 110^th year of the Republic Era, so the value should be: “110”.

Example

				
					{
    "MerchantID": "2000132",
    "InvoiceYear": "110"
}

Response format

Content Type ：application/json
HTTP Method ：POST

Response by ECPay (Json format)

PlatformID String(10)

MerchantID String(10)
Required

RpHeader Object

Response header

Timestamp Number

Unix timestamp(GMT+8)

TransCode Int

Response code to indicate whether the payload is successfully accepted
Possible values:
1: Payload (i.e. MerchantID, RqHeader, and Data) is successfully accepted by ECPay.
Others: failed.

TransMsg String(200)

Response message to indicate whether the payload is successfully accepted

Data String

Message payload
Respond with relevant data, this is the encrypted JSON format data.
AES Encryption Description.

Example

				
					{
    "MerchantID": "2000132",
    "RpHeader": {
        "Timestamp": 1525169058
    },
    "TransCode": 1,
    "TransMsg": "",
    "Data": "..."
}

Message payload of Data (JSON format): please do AES decryption to the Data first and then perform urldecode

RtnCode Int

Return codes to indicate whether the API is successfully executed or not.
Possible values:
1: API is successfully executed.
Others: failed.
For more details, please see errors.

RtnMsg String(200)

Return messages indicating whether the API is successfully executed or not.

InvoiceInfo Array[Object]

List of the e-invoice numbers in units.

InvoiceTerm Int

Period of e-invoice
Each period spans two months, and the starting month is always an odd month (i.e. January, March, May, July, September and November). So in total there are six periods. Following lists the values standing for each period.
Possible values:
1: Jan.-Feb.
2: Mar.-Apr.
3: May-Jun.
4: Jul.-Aug.
5: Sep.-Oct.
6: Nov.-Dec.

InvType String(2)

Type of letter track of e-invoice
In general, there are 2 types: one is general tax and the other is special tax, depending on which business your company belongs to.
Possible values:
07: general tax (common business or e-commerce, which shall be no less than 5 %).
08: special tax (i.e. for special food and beverage services enterprises, such as night clubs or restaurants providing entertaining show programs, saloons and tea rooms and bars offering companionship services).

InvoiceHeader String(2)

The letter track of the e-invoice
The e-invoice letter track is a 2 uppercase English letters, which is assigned by the the E-invoice Platform of MOF.
For example, KK or KG.

InvoiceStart String(8)

Starting number of each unit.
An 8-digit number, the last 2 digits should be 00 or 50
(e.g. 10000000 or 10000050).

InvoiceEnd String(8)

Ending number of each unit.
An 8-digit number, the last 2 digits should be 49 or 99.

Special Notes：

Since on ECPay’s Stage there is no real application to the Platform, the InvoiceEnd in response of API request is dummy data only. On ECPay’s Production, InvoiceEnd will be the real data.

Number Int

The unit of e-invoice numbers.
Each unit contains 50 e-invoice numbers, which are assigned by the MOF.

Example

				
					{
    "RtnCode": 1,
    "RtnMsg": "成功",
    "InvoiceInfo": [
      {
        "InvoiceTerm": 1,
        "InvType": "07",
        "InvoiceHeader": "KK",
        "InvoiceStart": "10000000",
        "InvoiceEnd": "10000049",
        "Number": 1
      }
    ]
}

YAML

The provided YAML file is used to define the configuration, structure, operations, and infrastructure management information of the API, making it easier for developers to understand and use the API.

				
					openapi: 3.1.0
info:
  title: ECPay Ministry of Finance Allocation Result Inquiry API
  version: 1.0.0
servers:
  - url: https://einvoice.ecpay.com.tw
    description: Production Environment
  - url: https://einvoice-stage.ecpay.com.tw
    description: Testing Environment
paths:
  /B2CInvoice/GetGovInvoiceWordSetting:
    post:
      summary: Inquiry of Ministry of Finance Allocation Result
      description: Query the allocation result of invoice numbers from the Ministry of Finance.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - MerchantID
                - RqHeader
                - Data
              properties:
                PlatformID:
                  type: string
                  description: Platform identifier (optional)
                MerchantID:
                  type: string
                  description: Merchant identifier
                RqHeader:
                  type: object
                  properties:
                    Timestamp:
                      type: number
                      description: Timestamp of the request
                Data:
                  type: string
                  description: AES encrypted string (128 bit, CBC, PKCS7)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  PlatformID:
                    type: string
                    description: Platform identifier
                  MerchantID:
                    type: string
                    description: Merchant identifier
                  RpHeader:
                    type: object
                    properties:
                      Timestamp:
                        type: number
                        description: Timestamp of the response
                  TransCode:
                    type: integer
                    description: Transmission code
                  TransMsg:
                    type: string
                    description: Transmission message
                  Data:
                    type: string
                    description: Encrypted data in JSON format
        '400':
          description: Invalid request
        '500':
          description: Server error
components:
  schemas:
    requestBody.Data:
      type: object
      properties:
        MerchantID:
          type: string
          description: Merchant identifier
        InvoiceYear:
          type: string
          description: Invoice year (in ROC year format)
    responses.Data:
      type: object
      properties:
        RtnCode:
          type: integer
          description: Response code
        RtnMsg:
          type: string
          description: Response message
        InvoiceInfo:
          type: array
          properties:
              InvoiceTerm:
                type: integer
                description: Invoice term
              InvType:
                type: string
                description: Invoice type
              InvoiceHeader:
                type: string
                description: Invoice header
              InvoiceStart:
                type: string
                description: Starting invoice number
              InvoiceEnd:
                type: string
                description: Ending invoice number
              Number:
                type: integer
                description: Number of invoices

Green World