Check the information

1. GetInfo - Check the status of invoice

This API checks the status and summarized information of an invoice.

StatementInfo getInfo(String CorpNum, int ItemCode, String MgtKey) throws PopbillException

Parameters

Field	Type	Length	Mandatory	Description
CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
ItemCode	int	3	Y	Types of invoices 121transaction details 122bill 123estimate 124purchase order 125deposit slip 126receipt
MgtKey	String	24	Y	Document ID

Return

StatementInfo

Field	Type	Length	Description
itemCode	Short	3	Types of invoices 121transaction details 122bill 123estimate 124purchase order 125deposit slip 126receipt
itemKey	String	18	Identification number assigned by POPBiLL
invoiceNum	String	24	POPBiLL confirm number POPBiLL automatically assigns this when issuing a tax invoice.
mgtKey	String	24	Document ID a unique value that can be entered with alphanumeric values and special characters(‘-’, ‘_’)
taxType	String	2	Taxation type 과세taxable 영세zero-rated 면세exempted
writeDate	String	8	Date of preparation format : yyyyMMdd
regDT	String	14	Date and time of the preparation of a draft format : yyyyMMddHHmmss
senderCorpName	String	200	[Seller] company name
senderCorpNum	String	10	[Seller] business registration number
senderPrintYN	boolean	-	[Seller] whether an invoice is printed or not trueprinted falsenot printed
receiverCorpName	String	200	[Buyer] company name
receiverCorpNum	String	10	[Buyer] business registration number
receiverPrintYN	boolean	-	[Buyer] whether e-Tax invoice is printed or not trueprinted falsenot printed
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 issuance format : yyyyMMddHHmmss
stateCode	int	3	Status code refer to [Status Code]
stateDT	String	14	Date and time of the status change format : yyyyMMddHHmmss
stateMemo	String	200	Memo for user’s convenience
openYN	boolean	-	Whether a buyer opened an invoice or not trueopened falsedid not open
openDT	String	14	Date and time when a buyer opened an invoice format : yyyyMMddHHmmss

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 multiple submissions of invoice

This API checks the status and summarized information of multiple invoice (Maximum : 1,000 invoices).

StatementInfo[] getInfos(String CorpNum, int ItemCode, String[] MgtKeyList) throws PopbillException

Parameters

Field	Type	Length	Mandatory	Description
CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
ItemCode	int	3	Y	Types of invoices 121transaction details 122bill 123estimate 124purchase order 125deposit slip 126receipt
MgtKeyList	String[ ]		Y	Document ID of an invoice to view maximum : 1,000 invoices

Return

StatementInfo

Field	Type	Length	Description
itemCode	Short	3	Types of invoices 121transaction details 122bill 123estimate 124purchase order 125deposit slip 126receipt
itemKey	String	18	Identification number assigned by POPBiLL
invoiceNum	String	24	POPBiLL confirm number POPBiLL automatically assigns this when issuing a tax invoice.
mgtKey	String	24	Document ID a unique value that can be entered with alphanumeric values and special characters(‘-’, ‘_’)
taxType	String	2	Taxation type 과세taxable 영세zero-rated 면세exempted
writeDate	String	8	Date of preparation format : yyyyMMdd
regDT	String	14	Date and time of the preparation of a draft format : yyyyMMddHHmmss
senderCorpName	String	200	[Seller] company name
senderCorpNum	String	10	[Seller] business registration number
senderPrintYN	boolean	-	[Seller] whether an invoice is printed or not trueprinted falsenot printed
receiverCorpName	String	200	[Buyer] company name
receiverCorpNum	String	10	[Buyer] business registration number
receiverPrintYN	boolean	-	[Buyer] whether e-Tax invoice is printed or not trueprinted falsenot printed
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 issuance format : yyyyMMddHHmmss
stateCode	int	3	Status code refer to [Status Code]
stateDT	String	14	Date and time of the status change format : yyyyMMddHHmmss
stateMemo	String	200	Memo for user’s convenience
openYN	boolean	-	Whether a buyer opened an invoice or not trueopened falsedid not open
openDT	String	14	Date and time when a buyer opened an invoice format : yyyyMMddHHmmss

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 invoice

This API checks the detailed information of a single invoice.

Statement getDetailInfo(String CorpNum, int ItemCode, String MgtKey, String UserID) throws PopbillException

Parameters

Field	Type	Length	Mandatory	Description
CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
ItemCode	int	3	Y	Types of invoices 121transaction details 122bill 123estimate 124purchase order 125deposit slip 126receipt
MgtKey	String	24	Y	Document ID

Return

Statement

No.

Field

Type

Length

Description

itemCode

Short

Types of invoices

121transaction details

122bill

123estimate

124purchase order

125deposit slip

126receipt

mgtKey

String

Document ID

invoiceNum

String

POPBiLL confirm number

POPBiLL assigns this value when an invoice is issued

formCode

String

Code for customized template

POPBiLL default template will be applied if not entered.

writeDate

String

Date of preparation

format : yyyyMMdd

taxType

String

Taxation type

과세taxable

영세zero-rated

면세exempted

returns this if {itemCode} = 121

purposeType

String

Payments received or not

영수payment received

청구payment not received

없음none

serialNum

String

Serial number

taxTotal

String

Sum of tax amount

supplyCostTotal

String

Sum of supply values

totalAmount

String

Total amount

remark1

String

150

Remark 1

remark2

String

150

Remark 2

remark3

String

150

Remark 3

senderCorpNum

String

[Seller] business registration number

10 digits except a hyphen(‘-’)

senderTaxRegID

String

[Seller] identification number of a branch place

4 digits

senderCorpName

String

200

[Seller] company name

senderCEOName

String

100

[Seller] CEO name

senderAddr

String

300

[Seller] company address

senderBizType

String

100

[Seller] type of business

senderBizClass

String

100

[Seller] items of business

senderContactName

String

100

[Seller] name of the person in charge

senderDeptName

String

[Seller] department of the person in charge

senderTEL

String

[Seller] contact number of the person in charge

senderHP

String

[Seller] cell phone number of the person in charge

senderEmail

String

100

[Seller] email of the person in charge

senderFAX

String

[Seller] FAX number of the person in charge

receiverCorpNum

String

[Buyer] business registration number

receiverTaxRegID

String

[Buyer] identification number of a branch place

4 digits

receiverCorpName

String

200

[Buyer] company name

receiverCEOName

String

100

[Buyer] CEO name

receiverAddr

String

300

[Buyer] company address

receiverBizType

String

100

[Buyer] type of business

receiverBizClass

String

100

[Buyer] items of business

receiverContactName

String

100

[Buyer] name of the person in charge

receiverDeptName

String

[Buyer] department of the person in charge

receiverTEL

String

[Buyer] contact number of the person in charge

receiverHP

String

[Buyer] telephone number of the person in charge

receiverEmail

String

100

[Buyer] email of the person in charge

receiverFAX

String

[Buyer] FAX number of the person in charge

propertyBag

HashMap

Additional property

for each different type of invoice, enter property as “key”, “value” format.
refer to [Forms - Additional Properties for Standard Form]

detailList

List<StatementDetail>

Detailed list of items

no limit on length

Field	Type	Length	Description
serialNum	Short	-	Serial number enter consequently from 1
purchaseDT	String	8	Date of trade format : yyyyMMdd
itemName	String	100	Order product 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
spare1	String	100	Spare 1
spare2	String	100	Spare 2
spare3	String	100	Spare 3
spare4	String	100	Spare 4
spare5	String	100	Spare 5
spare6	String	100	Spare 6
spare7	String	100	Spare 7
spare8	String	100	Spare 8
spare9	String	100	Spare 9
spare10	String	100	Spare 10
spare11	String	100	Spare 11
spare12	String	100	Spare 12
spare13	String	100	Spare 13
spare14	String	100	Spare 14
spare15	String	100	Spare 15
spare16	String	100	Spare 16
spare17	String	100	Spare 17
spare18	String	100	Spare 18
spare19	String	100	Spare 19
spare20	String	100	Spare 20

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. Search - Search the list of invoice

This API searches a cash receipt corresponded to the search criteria ( maximum search scope of period : 6 months )

StmtSearchResult search(String CorpNum, String DType, String SDate, String EDate, String[] State, int[] ItemCode, String QString, int Page, int PerPage, String Order) throws PopbillException

We recommend to use this API when a user implements the list of 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 (‘-’)
DType	String	1	Y	Date type in search criteria Rdate of registration Wdate of preparation Idate of issuance
SDate	String	8	Y	Initial date of search scope format : yyyyMMdd
EDate	String	8	Y	Last date of search scope format : yyyyMMdd
State	String[ ]		N	Invoice status code wild card() can be put on 2nd, 3rd letter e.g., "3", "6*" refer to [Status Code] search all if not entered
ItemCode	int[ ]		Y	Types of invoices (multiple choice is possible) 121transaction details 122bill 123estimate 124purchase order 125deposit slip 126receipt
QString	String	-	N	Search the identification number of an invoice. └ buyer’s company name └ buyer’s business registration number search all if not entered
Page	int	-	Y	Page number of a list
PerPage	int	-	Y	The number of list to be displayed per page maximum : 1,000
Order	String	1	N	Sort order related to the value of {DType} Ddescending (default) Aascending

Return

StmtSearchResult

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<StatementInfo>

Status/summarized info of invoices

maximum : 1,000 invoices

the configuration is same as the return value of [GetInfo – Check the status of an invoice] API.

Field	Type	Length	Description
itemCode	Short	3	Types of invoices 121transaction details 122bill 123estimate 124purchase order 125deposit slip 126receipt
itemKey	String	18	Identification number assigned by POPBiLL
invoiceNum	String	24	POPBiLL confirm number POPBiLL automatically assigns this when issuing a tax invoice.
mgtKey	String	24	Document ID a unique value that can be entered with alphanumeric values and special characters(‘-’, ‘_’)
taxType	String	2	Taxation type 과세taxable 영세zero-rated 면세exempted
writeDate	String	8	Date of preparation format : yyyyMMdd
regDT	String	14	Date and time of the preparation of a draft format : yyyyMMddHHmmss
senderCorpName	String	200	[Seller] company name
senderCorpNum	String	10	[Seller] business registration number
senderPrintYN	boolean	-	[Seller] whether an invoice is printed or not trueprinted falsenot printed
receiverCorpName	String	200	[Buyer] company name
receiverCorpNum	String	10	[Buyer] business registration number
receiverPrintYN	boolean	-	[Buyer] whether e-Tax invoice is printed or not trueprinted falsenot printed
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 issuance format : yyyyMMddHHmmss
stateCode	int	3	Status code refer to [Status Code]
stateDT	String	14	Date and time of the status change format : yyyyMMddHHmmss
stateMemo	String	200	Memo for user’s convenience
openYN	boolean	-	Whether a buyer opened an invoice or not trueopened falsedid not open
openDT	String	14	Date and time when a buyer opened an invoice format : yyyyMMddHHmmss

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. GetLogs - Check the log of invoice status changes

This API checks the log of status changes of an invoice.

StatementLog[] getLogs(String CorpNum, int ItemCode, String MgtKey) throws PopbillException

Parameters

Field	Type	Length	Mandatory	Description
CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
ItemCode	int	3	Y	Types of invoices 121transaction details 122bill 123estimate 124purchase order 125deposit slip 126receipt
MgtKey	String	24	Y	Document ID

Return

StatementLog

Field	Type	Length	Description
docLogType	Integer	3	Type of log
log	String	2000	Log information
procType	String	3	Handling type 연동processed via API 일반processed via POPBiLL service website 시스템processed via POPBiLL system
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

6. GetURL - URL for invoice menu

This API returns the URL to access the menu related to an 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 SBOXissued invoice box

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