POPBill Developers
SDK Reference
e-Commercial Invoice
Java
SDK Reference e-Commercial Invoice Java User Setting

User Setting

1. CheckIsMember - Check if the member is registered

  • Checks whether a member is registered by business registration number.
Response checkIsMember(String CorpNum, String LinkID) throws PopbillException
Parameters
Parameters
No.FieldTypeLengthMandatoryDescription
CorpNum String 10 Y Business registration number
10-digits except (‘-’)
LinkID String - Y LinkID
API Key assigned by POPBiLL
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

2. CheckID - Check for duplicate ID

  • Checks whether the desired ID is already in use.
Response checkID(String CheckID) throws PopbillException
Parameters
Parameters
No.FieldTypeLengthMandatoryDescription
CheckID String 50 Y ID to check the availability
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

3. JoinMember - Register a new member

  • Registers the customer of a software provider as a linked member of POPBiLL.
Response joinMember(JoinForm joinInfo) throws PopbillException
Parameters
Parameters
No.FieldTypeLengthMandatoryDescription
joinInfo JoinForm - Y Object information of a user
JoinForm
No. Field Type Length Mandatory Description
ID String 50 Y ID
6 to 50 characters
Password String 20 Y Password
8 to 20 characters
Includes English letters, numbers, and special characters (~!@#$%^&*()_+)
LinkID String 20 Y Partner LinkID
LinkID issued by POPBiLL
CorpNum String 10 Y Business registration number
CEOName String 100 Y Representative's Name
CorpName String 200 Y Company Name
Addr String 300 Y Company Address
BizType String 100 Y Type of Business
BizClass String 100 Y Items of Business
ContactName String 100 Y Contact Name
ContactEmail String 100 Y Contact Email
ContactTEL String 20 Y Contact Phone Number
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. QuitMember - Delete member

Processes withdrawal of a linked member.

  • All contacts, including administrators, will be deleted together.
Response QuitMember(String CorpNum, String QuitReason, String UserID) throws PopbillException

If remaining points exist, it is recommended to implement the process as [Request Refund → Withdraw Member].
You can re-register with the same business registration number and ID immediately after withdrawal.

Parameters
Parameters
No.FieldTypeLengthMandatoryDescription
CorpNum String 10 Y Business registration number
10-digits except (‘-’)
QuitReason String 200 Y Reason for member withdrawal
UserID String 50 N User’s POPBiLL ID
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. GetCorpInfo - Retrieve company information

  • Retrieves the company information of a linked member.
CorpInfo getCorpInfo(String CorpNum, String UserID) throws PopbillException
Parameters
Parameters
No.FieldTypeLengthMandatoryDescription
CorpNum String 10 Y Business registration number
10-digits except (‘-’)
UserID String 50 N User’s POPBiLL ID
Return
CorpInfo
No. Field Type Length Mandatory Description
ceoname String 100 Y Representative's Name
corpName String 200 Y Company Name
addr String 300 Y Address
bizType String 100 Y Type of Business
bizClass String 100 Y Items of Business
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. UpdateCorpInfo - Update company information

  • Updates the company information of a linked member.
Response updateCorpInfo(String CorpNum, CorpInfo corpInfo, String UserID) throws PopbillException
Parameters
Parameters
No.FieldTypeLengthMandatoryDescription
CorpNum String 10 Y Business registration number
10-digits except (‘-’)
corpInfo CorpInfo - Y Object information of the company
CorpInfo
No. Field Type Length Mandatory Description
ceoname String 100 Y Representative's Name
corpName String 200 Y Company Name
addr String 300 Y Address
bizType String 100 Y Type of Business
bizClass String 100 Y Items of Business
UserID String 50 N User’s POPBiLL ID
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. RegistContact - Add contact

Adds a contact to a linked member.

Response registContact(String CorpNum, ContactInfo ContactInfo, String UserID) throws PopbillException
Parameters
Parameters
No.FieldTypeLengthMandatoryDescription
CorpNum String 10 Y Business registration number
10-digits except (‘-’)
ContactInfo ContactInfo - Y Contact object information
ContactInfo
No. Field Type Length Mandatory Description
ID String 50 Y ID
6 to 50 characters
Password String 20 Conditional Password
8 to 20 characters
Includes English letters, numbers, and special characters (~!@#$%^&*()_+)
Required when calling the function [RegistContact - Add contact].
personName String 100 Y Contact Name
tel String 20 Y Contact Phone Number
email String 100 Y Contact Email
searchRole Integer 1 N Permission level
1Personal
2Read-only
3Company (default)
UserID String 50 N User’s POPBiLL ID
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

8. GetContactInfo - Get contact details

Retrieves the contact information of a linked member.

ContactInfo getContactInfo(String CorpNum, String ContactID, String UserID) throws PopbillException
Parameters
Parameters
No.FieldTypeLengthMandatoryDescription
CorpNum String 10 Y Business registration number
10-digits except (‘-’)
ContactID String 50 Y Contact ID
UserID String 50 N User’s POPBiLL ID
Return
ContactInfo
No. Field Type Length Description
ID String 50 ID
personName String 100 Contact Name
tel String 20 Contact Phone Number
email String 100 Contact Email
regDT String 14 Registration date and time
format : yyyyMMddHHmmss
searchRole Integer 1 Permission level
1Personal
2Read-only
3Company (default)
mgrYN Boolean - Role
trueAdministrator
falseContact
Editable in [ Profile > Company > Users ] on the POPBiLL website.
state Integer 1 Account status
1Active
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

9. ListContact - List contacts

Retrieves the list of contacts added to a linked member.

ContactInfo[] listContact(String CorpNum, String UserID) throws PopbillException
Parameters
Parameters
No.FieldTypeLengthMandatoryDescription
CorpNum String 10 Y Business registration number
10-digits except (‘-’)
UserID String 50 N User’s POPBiLL ID
Return
ContactInfo
No. Field Type Length Description
ID String 50 ID
personName String 100 Contact Name
tel String 20 Contact Phone Number
email String 100 Contact Email
regDT String 14 Registration date and time
format : yyyyMMddHHmmss
searchRole Integer 1 Permission level
1Personal
2Read-only
3Company (default)
mgrYN Boolean - Role
trueAdministrator
falseContact
Editable in [ Profile > Company > Users ] on the POPBiLL website.
state Integer 1 Account status
1Active
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

10. UpdateContact - Update contact information

Updates the contact information of a linked member.

Response updateContact(String CorpNum, ContactInfo ContactInfo, String UserID) throws PopbillException
Parameters
Parameters
No.FieldTypeLengthMandatoryDescription
CorpNum String 10 Y Business registration number
10-digits except (‘-’)
ContactInfo ContactInfo - Y Contact object information
ContactInfo
No. Field Type Length Mandatory Description
ID String 50 Y ID
6 to 50 characters
Password String 20 Conditional Password
8 to 20 characters
Includes English letters, numbers, and special characters (~!@#$%^&*()_+)
Required when calling the function [RegistContact - Add contact].
personName String 100 Y Contact Name
tel String 20 Y Contact Phone Number
email String 100 Y Contact Email
searchRole Integer 1 N Permission level
1Personal
2Read-only
3Company (default)
UserID String 50 Y User’s POPBiLL ID
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

11. DeleteContact - Remove contact

Deletes a contact from a linked member.

Response deleteContact(String CorpNum, String ContactID, String UserID) throws PopbillException
Parameters
Parameters
No.FieldTypeLengthMandatoryDescription
CorpNum String 10 Y Business registration number
10-digits except (‘-’)
ContactID String 50 Y Contact ID
Admin cannot be deleted
UserID String 50 Y User’s POPBiLL ID
Only admin can request
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