Check the information

1. GetInfo - Check the status of an e-Tax invoice

This API checks the status and summarized information of a single tax invoice.
Check variable 'stateCode' of returned TaxinvoiceInfo to confirm status of e-Tax invoice.

TaxinvoiceInfo getInfo(String CorpNum, MgtKeyType KeyType, String MgtKey) throws PopbillException

Parameters

No.

Field

Type

Length

Mandatory

Description

CorpNum

String

Business registration number

10-digits except (‘-’)

KeyType

MgtKeyType

Type of the e-Tax invoice

SELL sales

No.	Field	Type	Length	Description
	SELL	enum	-	Sales

MgtKey

String

Document ID

Return

TaxinvoiceInfo

Field	Type	Length	Description
itemKey	String	18	Identification number assigned by POPBiLL
taxType	String	2	Taxation type 과세taxable 영세zero-rated 면세exempted
writeDate	String	8	Date of preparation format : yyyyMMdd
regDT	String	14	Date of registration as a draft format : yyyyMMddHHmmss
issueType	String	3	Issuance type 정발행general issuance
supplyCostTotal	String	18	Sum of supply values integer values(+/-) only decimals will be automatically truncated
taxTotal	String	18	Sum of tax amount integer values(+/-) only decimals will be automatically truncated
purposeType	String	2	Payments received or not 영수payment received 청구payment not received 없음none
issueDT	String	14	Date and time of the issuance format : yyyyMMddHHmmss
lateIssueYN	String	-	Whether e-Tax invoice is issued after the due or not trueissued after the due date falseissued within the due date
openYN	boolean	-	Whether a buyer viewed an issued e-Tax invoice via notification mail or not trueviewed falsedid not view The status is changed to 'Checked' when buyer checks the details of e-Tax invoice via the notification mail clicking the button on the bottom
openDT	String	14	Date and time of checking an e-Tax invoice format : yyyyMMddHHmmss
stateMemo	String	200	Memo about status information
stateCode	Integer	3	Status code refer to [Status Code]
stateDT	String	14	Date and time of the status change format : yyyyMMddHHmmss
ntsconfirmNum	String	24	NTS confirmation number POPBiLL automatically assigns this when issuing a tax invoice.
ntsresult	String	6	Filing result from the NTS
ntssendDT	String	14	Date and time of the NTS filing format : yyyyMMddHHmmss
ntsresultDT	String	14	Date and time of receiving NTS filing result format : yyyyMMddHHmmss
ntssendErrCode	String	6	NTS filing result code Refer to [ntssendErrCode]
modifyCode	Integer	1	Reason for revocation Refer to [Revised Invoice]
interOPYN	boolean	-	Whether e-Tax invoice is issued by API or not trueissued via API falseissued via POPBiLL service website
invoicerCorpName	String	200	[Seller] company name
invoicerCorpNum	String	10	[Seller] business registration number 10 digits except a hyphen(‘-’)
invoicerMgtKey	String	24	[Seller] document ID a unique value that can be entered with alphanumeric values and special characters(‘-’, ‘_’)
invoicerPrintYN	boolean	-	[Seller] whether e-Tax invoice is printed or not trueprinted falsenot printed
invoiceeCorpName	String	200	[Buyer] company name
invoiceeCorpNum	String	10	[Buyer] business registration number - if {invoiceeType} = 사업자(business proprietor type) : business registration number, 10 digits except a hyphen(‘-’) - if {invoiceeType} = 개인(individual type) : resident registration number, 13 digits except a hyphen(‘-’) - if {invoiceeType} = 외국인(foreigner type) : 9999999999999
invoiceePrintYN	boolean	-	[Buyer] whether e-Tax invoice is printed or not trueprinted falsenot printed
closeDownState	Integer	1	[Buyer] status of the business nullprocessing 0unregistered 1in business 2closed 3suspended 4failed to check
closeDownStateDate	String	8	[Buyer] date of the business closure 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

2. GetInfos - Check the status of bulk submission for e-tax invoices

This API checks the status and summarized information of multiple e-Tax invoices. (Maximum : 1,000 invoices)
Check variable 'stateCode' of returned TaxinvoiceInfo to confirm status of e-Tax invoice.

TaxinvoiceInfo[] getInfos(String CorpNum, MgtKeyType KeyType, String[] MgtKeyList) throws PopbillException

We recommend to use this API when a user implements the list of e-Tax invoices with document IDs.

Parameters

No.

Field

Type

Length

Mandatory

Description

CorpNum

String

Business registration number

10-digits except (‘-’)

KeyType

MgtKeyType

Type of the e-Tax invoice

SELL sales

No.	Field	Type	Length	Description
	SELL	enum	-	Sales

MgtKeyList

String[ ]

Document ID of tax invoice to view

maximum : 1,000 invoices

Return

TaxinvoiceInfo

Field	Type	Length	Description
itemKey	String	18	Identification number assigned by POPBiLL
taxType	String	2	Taxation type 과세taxable 영세zero-rated 면세exempted
writeDate	String	8	Date of preparation format : yyyyMMdd
regDT	String	14	Date of registration as a draft format : yyyyMMddHHmmss
issueType	String	3	Issuance type 정발행general issuance
supplyCostTotal	String	18	Sum of supply values integer values(+/-) only decimals will be automatically truncated
taxTotal	String	18	Sum of tax amount integer values(+/-) only decimals will be automatically truncated
purposeType	String	2	Payments received or not 영수payment received 청구payment not received 없음none
issueDT	String	14	Date and time of the issuance format : yyyyMMddHHmmss
lateIssueYN	String	-	Whether e-Tax invoice is issued after the due or not trueissued after the due date falseissued within the due date
openYN	boolean	-	Whether a buyer viewed an issued e-Tax invoice via notification mail or not trueviewed falsedid not view The status is changed to 'Checked' when buyer checks the details of e-Tax invoice via the notification mail clicking the button on the bottom
openDT	String	14	Date and time of checking an e-Tax invoice format : yyyyMMddHHmmss
stateMemo	String	200	Memo about status information
stateCode	Integer	3	Status code refer to [Status Code]
stateDT	String	14	Date and time of the status change format : yyyyMMddHHmmss
ntsconfirmNum	String	24	NTS confirmation number POPBiLL automatically assigns this when issuing a tax invoice.
ntsresult	String	6	Filing result from the NTS
ntssendDT	String	14	Date and time of the NTS filing format : yyyyMMddHHmmss
ntsresultDT	String	14	Date and time of receiving NTS filing result format : yyyyMMddHHmmss
ntssendErrCode	String	6	NTS filing result code Refer to [ntssendErrCode]
modifyCode	Integer	1	Reason for revocation Refer to [Revised Invoice]
interOPYN	boolean	-	Whether e-Tax invoice is issued by API or not trueissued via API falseissued via POPBiLL service website
invoicerCorpName	String	200	[Seller] company name
invoicerCorpNum	String	10	[Seller] business registration number 10 digits except a hyphen(‘-’)
invoicerMgtKey	String	24	[Seller] document ID a unique value that can be entered with alphanumeric values and special characters(‘-’, ‘_’)
invoicerPrintYN	boolean	-	[Seller] whether e-Tax invoice is printed or not trueprinted falsenot printed
invoiceeCorpName	String	200	[Buyer] company name
invoiceeCorpNum	String	10	[Buyer] business registration number - if {invoiceeType} = 사업자(business proprietor type) : business registration number, 10 digits except a hyphen(‘-’) - if {invoiceeType} = 개인(individual type) : resident registration number, 13 digits except a hyphen(‘-’) - if {invoiceeType} = 외국인(foreigner type) : 9999999999999
invoiceePrintYN	boolean	-	[Buyer] whether e-Tax invoice is printed or not trueprinted falsenot printed
closeDownState	Integer	1	[Buyer] status of the business nullprocessing 0unregistered 1in business 2closed 3suspended 4failed to check
closeDownStateDate	String	8	[Buyer] date of the business closure 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. GetDetailInfo - Check the detailed information of the e-Tax invoice

This API checks the detailed information of a single tax invoice.

Taxinvoice getDetailInfo(String CorpNum, MgtKeyType KeyType, String MgtKey) throws PopbillException

Parameters

No.

Field

Type

Length

Mandatory

Description

CorpNum

String

Business registration number

10-digits except (‘-’)

KeyType

MgtKeyType

Type of the e-Tax invoice

SELL sales

No.	Field	Type	Length	Description
	SELL	enum	-	Sales

MgtKey

String

Document ID

Return

Taxinvoice

No.

Field

Type

Length

Description

ntsconfirmNum

String

NTS confirmation number

POPBiLL automatically assigns this when issuing a tax invoice.

issueType

String

Issuance type

정발행general issuance

taxType

String

Taxation type

과세taxable

영세zero-rated

면세exempted

chargeDirection

String

Charging Direction

정과금Paid by seller

serialNum

String

Serial number

item to manage the list of e-Tax invoice

kwon

Short

Volume of a book

item to manage the list of e-Tax invoice

Short

Number of a book

item to manage the list of e-Tax invoice

writeDate

String

Date of preparation

format : yyyyMMdd

purposeType

String

Payments received or not

영수payment received

청구payment not received

없음none

supplyCostTotal

String

Sum of supply values

taxTotal

String

Sum of tax amount

totalAmount

String

Total amount

cash

String

Payment method – ‘cash’

chkBill

String

Payment method – ‘check’

credit

String

Payment method – ‘credit’

note

String

Payment method – ‘note’

remark1

String

150

1st Remark

if {invoiceeType} = "외국인(foreigner)", alien registration number or passport number will be returned

remark2

String

150

2nd Remark

remark3

String

150

3rd Remark

invoicerMgtKey

String

[Seller] document ID

invoicerCorpNum

String

[Seller] business registration number

10 digits except a hyphen(‘-’)

invoicerTaxRegID

String

[Seller] identification number of a branch place

4 digits

invoicerCorpName

String

200

[Seller] company name

invoicerCEOName

String

100

[Seller] CEO name

invoicerAddr

String

300

[Seller] company address

invoicerBizType

String

100

[Seller] type of business

invoicerBizClass

String

100

[Seller] items of business

invoicerContactName

String

100

[Seller] name of the person in charge

invoicerDeptName

String

100

[Seller] department of the person in charge

invoicerTEL

String

[Seller] contact number of the person in charge

invoicerHP

String

[Seller] cell phone number of the person in charge

invoicerEmail

String

100

[Seller] email of the person in charge

invoiceeType

String

[Buyer] type of customer

사업자business proprietor

개인individual

외국인foreigner

invoiceeCorpNum

String

[Buyer] business registration number
- if {invoiceeType} = 사업자(business proprietor type) : business registration number, 10 digits except a hyphen(‘-’)
- if {invoiceeType} = 개인(individual type) : resident registration number, 13 digits except a hyphen(‘-’)
- if {invoiceeType} = 외국인(foreigner type) : 9999999999999

invoiceeTaxRegID

String

[Buyer] identification number of a branch place

4 digits

invoiceeCorpName

String

200

[Buyer] company name

invoiceeCEOName

String

100

[Buyer] CEO name

invoiceeAddr

String

300

[Buyer] company address

invoiceeBizType

String

100

[Buyer] type of business

invoiceeBizClass

String

100

[Buyer] items of business

closeDownState

Integer

[Buyer] status of the business

nullprocessing
0unregistered
1in business
2closed
3suspended
4failed to check

POPBiLL automatically executes this process when an e-Tax invoice is issued.

closeDownStateDate

String

[Buyer] date of the business closure

format : yyyyMMdd

if {closedownState} value = 2 or 3, this value will be returned

invoiceeContactName1

String

100

[Buyer] name of the person in charge

invoiceeDeptName1

String

100

[Buyer] department of the person in charge

invoiceeTEL1

String

[Buyer] contact number of the person in charge

invoiceeHP1

String

[Buyer] telephone number of the person in charge

invoiceeEmail1

String

100

[Buyer] email of the person in charge

modifyCode

Short

Reason for revocation

returns this for a revised invoice only
Refer to [Revised Invoice]

orgNTSConfirmNum

String

NTS confirmation number of the original tax invoice

returns this for a revised invoice only

detailList

List<TaxinvoiceDetail>

Detailed list of items

maximum : 99

Field	Type	Length	Description
serialNum	Short	2	Serial number
purchaseDT	String	8	Date of trade format : yyyyMMdd
itemName	String	100	Item name
spec	String	60	Specification
qty	String	12	Quantity
unitCost	String	18	Unit price
supplyCost	String	18	Supply values
tax	String	18	Tax amount
remark	String	100	Remark

addContactList

List<TaxinvoiceAddContact>

Additional person in charge information of the buyer

use this when sending notification mails to multiple persons in charge
maximum : 5

Field	Type	Length	Description
serialNum	int	1	Serial number
contactName	String	100	Name of the person in charge
email	String	100	Email of the person in charge

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. GetXML - Return an e-Tax invoice into an XML file

This API returns the detailed information of a single tax invoice into an XML file.

TaxinvoiceXML getXML(String CorpNum, MgtKeyType KeyType, String MgtKey, String UserID) throws PopbillException

Parameters

No.

Field

Type

Length

Mandatory

Description

CorpNum

String

Business registration number

10-digits except (‘-’)

KeyType

MgtKeyType

Type of the e-Tax invoice

SELL sales

No.	Field	Type	Length	Description
	SELL	enum	-	Sales

MgtKey

String

Document ID

UserID

String

User’s POPBiLL ID

Return

TaxinvoiceXML

Field	Type	Length	Description
code	long	-	API response code
message	String	-	API response message
retObject	String	-	XML file of the tax invoice

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. Search - Search the list of e-Tax invoices

This API searches an e-Tax invoice corresponded to the search criteria. (Maximum search scope of period : 6 months)

TISearchResult Search(String CorpNum, MgtKeyType KeyType, String DType, String SDate, String EDate, String[] State, String[] Type, String[] TaxType, String[] IssueType, Boolean LateOnly, String TaxRegIDType, String TaxRegID, String TaxRegIDYN, String QString, Integer Page, Integer PerPage, String Order, String InterOPYN, String[] RegType, String[] CloseDownState, String MgtKey) throws PopbillException

We recommend to use this API when a user implements the list of e-Tax invoices with items related to the page (variables : Page, perPage, Order).

Parameters

No.

Field

Type

Length

Mandatory

Description

CorpNum

String

Business registration number

10-digits except (‘-’)

KeyType

MgtKeyType

Type of the e-Tax invoice

SELL sales

No.	Field	Type	Length	Description
	SELL	enum	-	Sales

DType

String

Date type in search criteria

R date of registration

W date of preparation

I issuance date

SDate

String

Initial date of search scope

format : yyyyMMdd

EDate

String

Last date of search scope

format : yyyyMMdd

State

String[ ]

e-Tax invoice status code

wild card(*) can be put on 2nd, 3rd letter
e.g., "3**", "6**"

search all if not entered

Type

String[ ]

Type of e-Tax invoice (multiple choice is possible)

Ngeneral

M[revised] e-Tax invoice

search all if not entered

TaxType

String[ ]

Taxation Type (multiple choice is possible)

Ttaxable

Nexempted

Zzero-rated

search all if not entered

IssueType

String[ ]

Issuance Type

Ngeneral issuance

search all if not entered

LateOnly

Boolean

Whether e-Tax invoice is issued after the due or not

trueissued after the due date

falseissued within the due date

search all if not entered

TaxRegIDType

String

Type of the Identification number branch place

Sseller

Bbuyer

search all if not entered

TaxRegID

String

Identification number for branch place

more than one number must be separated with a comma(‘,’)
e.g., 1234, 1110

search all if not entered

TaxRegIDYN

String

Whether the Identification number for branch place exists or not

0does not exist

1exist

search all if not entered

QString

String

Search Criteria (do not enter hyphen)
- buyer’s company name
- business Registration Number (for company)
- residential Registration Number (for individual)
- 9999999999999 (for foreigner)

search all if not entered

Page

Integer

Page number

default value : 1

PerPage

Integer

The number of list to be displayed per page

maximum value : 1,000

default value : 500

Order

String

Sort order related to the value of {DType}

Ddescending (default)

Aascending

InterOPYN

String

Whether an e-Tax invoice is issued by API or not

0issued via POPBiLL service website

1issued via API

search all if not entered

RegType

String[ ]

Registration type of e-Tax invoice (multiple choice is possible)

Pregistered in POPBiLL

Hregistered(issued) in Hometax or another ASP

search all if not entered

CloseDownState

String[ ]

Business status (multiple choice is possible)

Nprocessing

0unregistered

1in business

2closed

3suspended

4failed to check

search all if not entered

MgtKey

String

Search criteria for an e-Tax invoice
└ Document ID
└ NTS Confirmation number

search all if not entered

UserID

String

User’s POPBiLL ID

Return

TISearchResult

No.

Field

Type

Length

Description

code

long

API response code

message

String

API response message

total

String

Total number of search results

perPage

String

Number of search result per page

pageNum

String

Page number

pageCount

String

Number of pages

list

List<TaxinvoiceInfo>

Status/summarized info of tax invoice

The configuration is same as the returned value of [GetInfo – Check the status of an e-Tax invoice] API.
maximum : 1,000 invoices

Field	Type	Length	Description
itemKey	String	18	Identification number assigned by POPBiLL
taxType	String	2	Taxation type 과세taxable 영세zero-rated 면세exempted
writeDate	String	8	Date of preparation format : yyyyMMdd
regDT	String	14	Date of registration as a draft format : yyyyMMddHHmmss
issueType	String	3	Issuance type 정발행general issuance
supplyCostTotal	String	18	Sum of supply values integer values(+/-) only decimals will be automatically truncated
taxTotal	String	18	Sum of tax amount integer values(+/-) only decimals will be automatically truncated
purposeType	String	2	Payments received or not 영수payment received 청구payment not received 없음none
issueDT	String	14	Date and time of the issuance format : yyyyMMddHHmmss
lateIssueYN	String	-	Whether e-Tax invoice is issued after the due or not trueissued after the due date falseissued within the due date
openYN	boolean	-	Whether a buyer viewed an issued e-Tax invoice via notification mail or not trueviewed falsedid not view The status is changed to 'Checked' when buyer checks the details of e-Tax invoice via the notification mail clicking the button on the bottom
openDT	String	14	Date and time of checking an e-Tax invoice format : yyyyMMddHHmmss
stateMemo	String	200	Memo about status information
stateCode	Integer	3	Status code refer to [Status Code]
stateDT	String	14	Date and time of the status change format : yyyyMMddHHmmss
ntsconfirmNum	String	24	NTS confirmation number POPBiLL automatically assigns this when issuing a tax invoice.
ntsresult	String	6	Filing result from the NTS
ntssendDT	String	14	Date and time of the NTS filing format : yyyyMMddHHmmss
ntsresultDT	String	14	Date and time of receiving NTS filing result format : yyyyMMddHHmmss
ntssendErrCode	String	6	NTS filing result code Refer to [ntssendErrCode]
modifyCode	Integer	1	Reason for revocation Refer to [Revised Invoice]
interOPYN	boolean	-	Whether e-Tax invoice is issued by API or not trueissued via API falseissued via POPBiLL service website
invoicerCorpName	String	200	[Seller] company name
invoicerCorpNum	String	10	[Seller] business registration number 10 digits except a hyphen(‘-’)
invoicerMgtKey	String	24	[Seller] document ID a unique value that can be entered with alphanumeric values and special characters(‘-’, ‘_’)
invoicerPrintYN	boolean	-	[Seller] whether e-Tax invoice is printed or not trueprinted falsenot printed
invoiceeCorpName	String	200	[Buyer] company name
invoiceeCorpNum	String	10	[Buyer] business registration number - if {invoiceeType} = 사업자(business proprietor type) : business registration number, 10 digits except a hyphen(‘-’) - if {invoiceeType} = 개인(individual type) : resident registration number, 13 digits except a hyphen(‘-’) - if {invoiceeType} = 외국인(foreigner type) : 9999999999999
invoiceePrintYN	boolean	-	[Buyer] whether e-Tax invoice is printed or not trueprinted falsenot printed
closeDownState	Integer	1	[Buyer] status of the business nullprocessing 0unregistered 1in business 2closed 3suspended 4failed to check
closeDownStateDate	String	8	[Buyer] date of the business closure 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

6. GetLogs - Check the log of e-Tax invoice status changes

This API checks the log of status changes of an e-Tax invoice.

TaxinvoiceLog[] getLogs(String CorpNum, MgtKeyType KeyType, String MgtKey) throws PopbillException

Parameters

No.

Field

Type

Length

Mandatory

Description

CorpNum

String

Business registration number

10-digits except (‘-’)

KeyType

MgtKeyType

Type of the e-Tax invoice

SELL sales

No.	Field	Type	Length	Description
	SELL	enum	-	Sales

MgtKey

String

Document ID

Return

TaxinvoiceLog

Field	Type	Length	Description
docLogType	Integer	3	Log type 102Checked 103Received 111Resend a mail 124Result of company status check 125Assign an Invoice ID 230Issued 240Cancelled 250Registered in filing list 251Waiting for filing 252Processing for Filing 253Delivered to NTS 254Succeeded 255Failed
log	String	2000	Log information
procType	String	3	Handling type 연동processed via API 일반processed via POPBiLL service website 시스템processed via POPBiLL system
procCorpName	String	70	Name of the company in charge of processing
procContactName	String	30	Name of the person in charge of processing
procMemo	String	200	Memo on processing
regDT	String	14	Date and time of the registration format : yyyyMMddHHmmss
ip	String	39	IP address

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. GetURL - URL for an e-Tax invoice menu

This API returns the URL to access the menu related to an e-Tax invoice of POPBiLL service website in login status.
Returned URL is valid for 30 seconds and after that you cannot access to the page.

String getURL(String CorpNum, String UserID, String TOGO) throws PopbillException

Parameters

Field	Type	Length	Mandatory	Description
CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
UserID	String	50	N	User’s POPBiLL ID
TOGO	String	-	Y	Targeted Menu SBOXsales document box WRITEcreate a tax invoice

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

8. GetPDF - e-Tax invoice PDF Download

Download 1 e-Tax invoice PDF.

byte[] getPDF(String CorpNum, MgtKeyType KeyType, String MgtKey, String UserID) throws PopbillException

Parameters

No.

Field

Type

Length

Mandatory

Description

CorpNum

String

Business registration number

10-digits except (‘-’)

KeyType

MgtKeyType

Type of the e-Tax invoice

SELL sales

No.	Field	Type	Length	Description
	SELL	enum	-	Sales

MgtKey

String

Document ID

UserID

String

POPBiLL member ID

Return

byte[] - e-Tax invoice PDF binary

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