Searching Operations / Search Cancel E-invoices

Scenarios

Merchant(Business Entity) can use this API to query the invoice information, including output invoices and input invoices, and Green World will reply to the results as a return parameter.
This will help Merchant to integrate the inquiry mechanism regarding the canceled invoice into Merchant’s website and provide a quick inquiry service.

API URLs:

Stage: https://einvoice-stage.ecpay.com.tw/B2BInvoice/GetInvalid
Production: https://einvoice.ecpay.com.tw/B2BInvoice/GetInvalid

HTTPS format

Content Type ：application/json
HTTP Method ：POST

Request by Merchant (Json format)

PlatformID String(10)

Platform merchant ID
This parameter is provided by ECPAY to the platform vendor for project cooperation, please bring in the MerchantID bound with the platform vendor.
Please leave empty for general vendor.
When the platform vendor uses the MerchantID field, it can only bring in the MerchantID that has been bound as a sub-store, otherwise it will cause a failure.

MerchantID String(10)
Required

RqHeader
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 is more 10 minutes late than the timestamp sent by merchants, this request will be failed. Reference information is as follows：http://www.epochconverter.com/。
Merchants are suggested to frequently synchronize the time zone of server to another server of the nearest time zone.

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 firstly and then do AES encryption

MerchantID String(10)
Required

InvoiceCategory Int
Required

Possible values:

0: Output E-Invoices (Search the invoice issued to the Counterparty from the Merchant).
1: Input E-invoices (Search the invoice of the Counterparty to the Merchant)

InvoiceNumber String(10)

Invoice Number

If [RelateNumber]has no value, then this parameter is required

InvoiceDate String(20)

Invoice Issue date

The format is yyyy-mm-dd
If [InvoiceNumber] has the value, then this parameter is required

RelateNumber String(20)

Relate Number

If [InvoiceNumber]has no value, then this parameter is required

Example

				
					{
    "MerchantID": "2000132",
    "InvoiceCategory": 0,
    "InvoiceNumber": "SA37758327",
    "InvoiceDate": "2019-08-31"
}

Response format

Content Type ：application/json
HTTP Method ：POST

Response by ECPay (Json format)

PlatformID String(10)

MerchantID String(10)

RpHeader

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
Responde 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 firstly and then do urldecode.

RtnCode Int

Return codes to indicate whether the API is successfully executed or not.

Possible values:
- 1: API is successfully executed.
- Others: failed.

RtnMsg String(200)

Return messages to indicate whether the API is successfully executed or not.

RtnData String

Example

				
					{
    "RtnCode": 1,
    "RtnMsg": "Success",
    "RtnData": "..."
}

Parameters in RtnData

MerchantID String(10)

Merchant ID

InvoiceNumber String(10)

E-Invoice number

CancelDate String(20)

The format is yyyy-mm-dd

CancelTime String(10)

CancelReason String(20)

Cancel Reason

BuyerId String(8)

SellerId String(8)

Upload_Status String(1)

Upload status

If [InvoiceCategory]=1, then this parameter has no value.
0:Not Uploaded
1:Uploaded
2:Upload Failed

Upload_Date String(20)

E-Invoice upload time

Format is “yyyy-MM-dd HH:mm:ss”.
If [InvoiceCategory]=1, then this parameter has no value.

ConfirmDate String(20)

Confirm Date

1. The format is yyyy-mm-dd
2. If not set, then this parameter has no value.

ExchangeStatus String(1)

Cancel Confirm Status

If this parameter has no value, it is not set.
0:Not Confirmed
1:Confirmed

Remark String(200)

Invoice Remark

Example

				
					{
    "MerchantID": "2000132",
    "InvoiceNumber": "VG11000002",
    "BuyerId": "23165448",
    "SellerId": "",
    "CancelDate": "2019-09-23",
    "CancelTime": "13:39:24",
    "CancelReason": "",
    "Upload_Status": "",
    "Upload_Date": "2019-09-24",
    "ConfirmDate": "2019-09-25",
    "ExchangeStatus": "1",
    "Remark": ""
}

Green World