Manage Authentication
1. GetCertificatePopUpURL - URL to manage HomeTax authentication
- This API returns a URL to manage HomeTax authentication.
- Returned URL is valid for 30 seconds and after that you cannot access to the page.
String getCertificatePopUpURL(String CorpNum, String UserID) throws PopbillExceptionParameters
Parameters
| No. | Field | Type | Length | Mandatory | Description |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y |
Business registration number
10-digits except (‘-’)
|
|
| UserID | String | 50 | N | User’s POPBiLL ID |
Return
String - Returned URL of response on the request
Throws
PopbillException
| No. | Field | Type | Length | Description |
|---|---|---|---|---|
| code | long | - |
API response code
8 digits code that starts with (‘-’) [Error Code]
|
|
| message | String | - | Error message for any failed API process |
2. GetCertificateExpireDate - Check the expiration date of a certificate
- This API checks the expiration date of a HomeTax accredited certificate.
Date getCertificateExpireDate(String CorpNum) throws PopbillExceptionParameters
Parameters
| No. | Field | Type | Length | Mandatory | Description |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y |
Business registration number
10-digits except (‘-’)
|
Return
Date - Expiration date of a registered certificate (format : yyyyMMdd)
Throws
PopbillException
| No. | Field | Type | Length | Description |
|---|---|---|---|---|
| code | long | - |
API response code
8 digits code that starts with (‘-’) [Error Code]
|
|
| message | String | - | Error message for any failed API process |
3. CheckCertValidation - Validate the certificate with a login test
- This API validates the HomeTax accredited certificate with a HomeTax login test.
Response checkCertValidation(String CorpNum) throws PopbillExceptionParameters
Parameters
| No. | Field | Type | Length | Mandatory | Description |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y |
Business registration number
10-digits except (‘-’)
|
Return
Response
| No. | Field | Type | Length | Description |
|---|---|---|---|---|
| code | long | - | API response code | |
| message | String | - | API response message |
Throws
PopbillException
| No. | Field | Type | Length | Description |
|---|---|---|---|---|
| code | long | - |
API response code
8 digits code that starts with (‘-’) [Error Code]
|
|
| message | String | - | Error message for any failed API process |
4. RegistDeptUser - Register a department user account
- This API registers a department user account (cash receipt data inquiry type) in POPBiLL system to authenticate for HomeTax system.
Response registDeptUser(String CorpNum, String DeptUserID, String DeptUserPWD) throws PopbillExceptionParameters
Parameters
| No. | Field | Type | Length | Mandatory | Description |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y |
Business registration number
10-digits except (‘-’)
|
|
| DeptUserID | String | 50 | Y | ID of HomeTax department user account | |
| DeptUserPWD | String | 50 | Y | Password of HomeTax department user account |
Return
Response
| No. | Field | Type | Length | Description |
|---|---|---|---|---|
| code | long | - | API response code | |
| message | String | - | API response message |
Throws
PopbillException
| No. | Field | Type | Length | Description |
|---|---|---|---|---|
| code | long | - |
API response code
8 digits code that starts with (‘-’) [Error Code]
|
|
| message | String | - | Error message for any failed API process |
5. CheckDeptUser - Check the registered information of a department user account
- This API checks the registered information of a department user account (cash receipt data inquiry type).
Response checkCertValidation(String CorpNum) throws PopbillExceptionParameters
Parameters
| No. | Field | Type | Length | Mandatory | Description |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y |
Business registration number
10-digits except (‘-’)
|
Return
Response
| No. | Field | Type | Length | Description |
|---|---|---|---|---|
| code | long | - | API response code | |
| message | String | - | API response message |
Throws
PopbillException
| No. | Field | Type | Length | Description |
|---|---|---|---|---|
| code | long | - |
API response code
8 digits code that starts with (‘-’) [Error Code]
|
|
| message | String | - | Error message for any failed API process |
6. CheckLoginDeptUser - Validate the department user account with a login test
- This API validates the department user account with a HomeTax login test.
Response checkLoginDeptUser(String CorpNum) throws PopbillExceptionParameters
Parameters
| No. | Field | Type | Length | Mandatory | Description |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y |
Business registration number
10-digits except (‘-’)
|
Return
Response
| No. | Field | Type | Length | Description |
|---|---|---|---|---|
| code | long | - | API response code | |
| message | String | - | API response message |
Throws
PopbillException
| No. | Field | Type | Length | Description |
|---|---|---|---|---|
| code | long | - |
API response code
8 digits code that starts with (‘-’) [Error Code]
|
|
| message | String | - | Error message for any failed API process |
7. DeleteDeptUser - Delete the information of a department user account
- This API deletes the information of a registered department user account.
Response deleteDeptUser(String CorpNum) throws PopbillExceptionParameters
Parameters
| No. | Field | Type | Length | Mandatory | Description |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y |
Business registration number
10-digits except (‘-’)
|
Return
Response
| No. | Field | Type | Length | Description |
|---|---|---|---|---|
| code | long | - | API response code | |
| message | String | - | API response message |
Throws
PopbillException
| No. | Field | Type | Length | Description |
|---|---|---|---|---|
| code | long | - |
API response code
8 digits code that starts with (‘-’) [Error Code]
|
|
| message | String | - | Error message for any failed API process |