Check the result

1. Search - Check the result of the data crawling

This API checks the crawled sales/purchase tax invoices with an active JobID request that is validated via [GetJobState – Check the data crawling status] API.

HTTaxinvoiceSearchResult search(String CorpNum, String JobID, String[] Type, String[] TaxType, String[] PurposeType, String TaxRegIDYN, String TaxRegIDType, String TaxRegID, Integer Page, Integer PerPage, String Order, String UserID, String SearchString) 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

Field	Type	Length	Mandatory	Description
CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
JobID	String	18	Y	Request ID(JobID) returned value of [RequestJob – Request for data crawling] API
Type	String[ ]		N	Type of e-Tax invoice (multiple choice is possible) Ngeneral M[revised] e-Tax invoice search all if not entered
TaxType	String[ ]		N	Taxation Type (multiple choice is possible) Ttaxable Nexempted Zzero-rated search all if not entered
PurposeType	String[ ]		N	Payments received or not (multiple choice is possible) Rpayment received Cpayment not received Nnone search all if not entered
TaxRegIDYN	String	1	N	Whether the Identification number for branch place exists or not. 0does not exist 1exist search all if not entered
TaxRegIDType	String	1	N	Type of the Identification number branch place Sseller Bbuyer Tconsigned search all if not entered
TaxRegID	String	-	N	Identification number for branch place more than one number must be separated with a comma(‘,’) e.g., 1234, 1110 search all if not entered
Page	Integer	-	N	Page number default value : 1
PerPage	Integer	-	N	The number of list to be displayed per page default value : 1 maximum : 1,000
Order	String	1	N	Sort order related to the value of {DType} Ddescending (default) Aascending
UserID	String	50	N	User’s POPBiLL ID
SearchString	String	13	N	Search information └ company name └ business registration number └ resident registration number └ 9999999999999 : foreigner enter registration number without a hyphen(‘-’) search all if not entered

Return

HTTaxinvoiceSearchResult

No.

Field

Type

Length

Description

code

long

API response code

message

String

API response message

total

long

Total number of search results

perPage

long

Number of search result per page

pageNum

long

Page number

pageCount

long

Number of pages

list

List<HTTaxinvoiceAbbr>

Summarized information of tax invoice

maximum : 1,000 invoices

Field	Type	Length	Description
ntsconfirmNum	String	24	NTS confirmation number
writeDate	String	8	Date of preparation format : yyyyMMdd
issueDate	String	8	Date of issuance format : yyyyMMdd
sendDate	String	8	Date of filing format : yyyyMMdd
taxType	String	2	Taxation type 과세taxable 영세zero-rated 면세exempted
purposeType	String	2	Payments received or not 영수payment received 청구payment not received 없음none
supplyCostTotal	String	18	Sum of supply values
taxTotal	String	18	Sum of tax amount
totalAmount	String	18	Total amount
remark1	String	450	Remark Remark1+Remark2+Remark3
invoiceType	String	2	Type of the e-Tax invoice 매출sales 매입purchase
modifyYN	Boolean	-	Whether a type of invoice is a revised invoice or not true[revised] tax invoice falsenot a revised invoice
orgNTSConfirmNum	String	24	NTS confirmation number of the original tax invoice
purchaseDate	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
invoicerCorpNum	String	10	[Seller] business registration number
invoicerTaxRegID	String	4	[Seller] identification number of a branch place 4 digits
invoicerCorpName	String	200	[Seller] company name
invoicerCEOName	String	100	[Seller] CEO name
invoicerEmail	String	100	[Seller] email of the person in charge
invoiceeCorpNum	String	13	[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
invoiceeType	String	3	[Buyer] type of customer 사업자business proprietor 개인individual 외국인foreigner
invoiceeTaxRegID	String	4	[Buyer] identification number of a branch place 4 digits
invoiceeCorpName	String	200	[Buyer] company name
invoiceeCEOName	String	100	[Buyer] CEO name
invoiceeEmail1	String	100	[Buyer] email of the person in charge
invoiceeEmail2	String	70	[Buyer] email of the ASP business partner
trusteeCorpNum	String	10	[Consignee] business registration number
trusteeTaxRegID	String	4	[Consignee] identification number of a branch place
trusteeCorpName	String	200	[Consignee] company name
trusteeCEOName	String	100	[Consignee] CEO name
trusteeEmail	String	100	[Consignee] 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

2. Summary - Check the summarized information for the data crawling result

This API checks the summarized information of crawled sales/purchase tax invoices with an active JobID request that is validated via [GetJobState – Check the data crawling status] API.
※ content of information : number of crawled tax invoices, supplyCostTotal, taxTotal, totalAmount

HTTaxinvoiceSummary summary(String CorpNum, String JobID, String[] Type, String[] TaxType, String[] PurposeType, String TaxRegIDYN, String TaxRegIDType, String TaxRegID, String UserID, String SearchString) throws PopbillException

Parameters

Field	Type	Length	Mandatory	Description
CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
JobID	String	18	Y	Request ID(JobID) returned value of [RequestJob – Request for data crawling] API
Type	String[ ]		N	Type of e-Tax invoice (multiple choice is possible) Ngeneral M[revised] e-Tax invoice search all if not entered
TaxType	String[ ]		N	Taxation Type (multiple choice is possible) Ttaxable Nexempted Zzero-rated search all if not entered
PurposeType	String[ ]		N	Payments received or not (multiple choice is possible) Rpayment received Cpayment not received Nnone search all if not entered
TaxRegIDYN	String	1	N	Whether the Identification number for branch place exists or not. 0does not exist 1exist search all if not entered
TaxRegIDType	String	1	N	Type of the Identification number branch place Sseller Bbuyer Tconsigned search all if not entered
TaxRegID	String	-	N	Identification number for branch place more than one number must be separated with a comma(‘,’) e.g., 1234, 1110 search all if not entered
UserID	String	50	N	User’s POPBiLL ID
SearchString	String	13	N	Search information └ company name └ business registration number └ resident registration number └ 9999999999999 : foreigner enter registration number without a hyphen(‘-’) search all if not entered

Return

HTTaxinvoiceSummary

Field	Type	Length	Description
count	long	-	Number of crawled tax invoices
supplyCostTotal	long	18	Sum of supply values
taxTotal	long	18	Sum of tax amount
amountTotal	long	18	Total amount

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. GetTaxinvoice - Check the detailed information of an e-Tax invoice (JSON)

This API checks the crawled sales/purchase tax invoices with an active JobID request that is validated via [GetJobState – Check the data crawling status] API.

HTTaxinvoice getTaxinvoice(String CorpNum, String NTSConfirmNum, String UserID) throws PopbillException

Parameters

Field	Type	Length	Mandatory	Description
CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
NTSConfirmNum	String	24	Y	NTS confirmation number
UserID	String	50	N	User’s POPBiLL ID

Return

HTTaxinvoice

No.

Field

Type

Length

Description

writeDate

String

Date of preparation

format : yyyyMMdd

issueDT

String

Date and time of issuance

format : yyyyMMddHHmmss

invoiceType

Short

Types of e-Tax invoice

101general tax invoice

102zero-rated tax invoice

103consigned tax invoice

104import tax invoice

105consigned tax invoice(zero-rated)

201[revised] tax invoice

202[revised] tax invoice(zero-rated)

203[revised] tax invoice(consigned)

204[revised] tax invoice(import)

205[revised] tax invoice(zero-rated, consigned)

301general invoice(tax exemption)

303consigned invoice(tax exemption)

304import invoice(tax exemption)

401[revised] general invoice(tax exemption)

403[revised] consigned invoice(tax exemption)

404[revised] import invoice(tax exemption)

taxType

String

Taxation type

과세taxable

영세zero-rated

면세exempted

taxTotal

String

Sum of tax amount

supplyCostTotal

String

Sum of supply values

totalAmount

String

Total amount

purposeType

String

Payments received or not

영수payment received

청구payment not received

없음none

serialNum

String

Serial number

cash

String

Cash

chkBill

String

Check

credit

String

Credit

note

String

Note

remark1

String

150

Remark 1

remark2

String

150

Remark 2

remark3

String

150

Remark 3

ntsconfirmNum

String

NTS confirmation number

invoicerCorpNum

String

[Seller] business registration number

invoicerMgtKey

String

[Seller] document ID

invoicerTaxRegID

String

[Seller] identification number of a branch place

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

invoicerEmail

String

100

[Seller] email of the person in charge

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

invoiceeType

String

[Buyer] type of customer

사업자business proprietor

개인individual

외국인foreigner

invoiceeMgtKey

String

[Buyer] document ID

invoiceeTaxRegID

String

[Buyer] identification number of a branch place

4 digits

invoiceeCorpName

String

200

[Buyer] company name

invoicerCEOName

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

invoiceeContactName1

String

100

[Buyer] name of the primary person in charge

invoiceeDeptName1

String

100

[Buyer] department of the primary person in charge

invoiceeTEL1

String

[Buyer] contact number of the primary person in charge

invoiceeEmail1

String

100

[Buyer] email of the primary person in charge

invoiceeContactName2

String

100

[Buyer] name of the secondary person in charge

invoiceeDeptName2

String

100

[Buyer] department of the secondary person in charge

invoiceeTEL2

String

[Buyer] contact number of the secondary person in charge

invoiceeEmail2

String

100

[Buyer] email of the secondary person in charge

trusteeCorpNum

String

[Consignee] business registration number

trusteeMgtKey

String

[Consignee] document ID

trusteeTaxRegID

String

[Consignee] identification number of a branch place

4 digits

trusteeCorpName

String

200

[Consignee] company name

trusteeCEOName

String

100

[Consignee] CEO name

trusteeAddr

String

300

[Consignee] company address

trusteeBizType

String

100

[Consignee] type of business

trusteeBizClass

String

100

[Consignee] items of business

trusteeContactName

String

100

[Consignee] name of the person in charge

trusteeDeptName

String

100

[Consignee] department of the person in charge

trusteeTEL

String

[Consignee] contact number of the person in charge

trusteeEmail

String

100

[Consignee] email of the person in charge

modifyCode

Short

Reason for revocation

1correction of errors

2change in supply values

3return

4cancellation of contract

5post opening of local letter of credit

6duplicated issuance

orgNTSConfirmNum

String

NTS confirmation number of the original tax invoice

detailList

List<HTTaxinvoiceDetail>

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

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

HTTaxinvoiceXMLResponse getXML(String CorpNum, String NTSConfirmNum, String UserID) throws PopbillException

Parameters

Field	Type	Length	Mandatory	Description
CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
NTSConfirmNum	String	24	Y	NTS confirmation number
UserID	String	50	N	User’s POPBiLL ID

Return

HTTaxinvoiceXMLResponse

Field	Type	Length	Description
ResultCode	long	-	Number of crawled tax invoices
Message	String	24	API response message
retObject	String	-	XML file of an e-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. GetPopUpURL - URL to view the crawled e-Tax invoice

This API returns a URL to check the detailed information of a single crawled e-Tax invoice.
Returned URL is valid for 30 seconds and after that you cannot access to the page.

String getPopUpURL(String CorpNum, String NTSConfirmNum, String UserID) throws PopbillException

Parameters

Field	Type	Length	Mandatory	Description
CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
NTSConfirmNum	String	24	Y	NTS confirmation number
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

6. GetPrintURL - URL to print the crawled e-Tax invoice

This API returns a URL to print the detailed information of a single crawled e-Tax invoice.
Returned URL is valid for 30 seconds and after that you cannot access to the page.

String getPrintURL(String CorpNum, String NTSConfirmNum, String UserID) throws PopbillException

Parameters

Field	Type	Length	Mandatory	Description
CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
NTSConfirmNum	String	24	Y	NTS confirmation number
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