Check the information

1. GetInfo - Check the status of a cash receipt

This API checks the status and summarized information of a single cash receipt.
Check variable 'stateCode' of returned CashbillInfo to confirm status of a cash receipt.

CashbillInfo getInfo(String CorpNum, String MgtKey) throws PopbillException

Parameters

No.	Field	Type	Length	Mandatory	Description
	CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
	MgtKey	String	24	Y	Document ID a unique value that can be entered with alphanumeric values and special characters(‘-’, ‘_’)

Return

CashbillInfo

Field	Type	Length	Description
itemKey	String	18	Identification number assigned by POPBiLL for internal management.
mgtKey	String	24	Document ID a unique value that can be entered with alphanumeric values and special characters(‘-’, ‘_’)
tradeDate	String	8	Date of trade format : yyyyMMdd
tradeDT	String	14	Date and time of the trade format : yyyyMMddHHmmss
tradeType	String	4	Type of cash receipt 승인거래general cash receipt 취소거래cash receipt for revocation
tradeUsage	String	5	Purpose of issuance 소득공제용income deduction usage 지출증빙용proof of purchase usage
tradeOpt	String	4	Trade type 일반general 도서공연book/performance 대중교통public transportation
taxationType	String	3	Taxation type 과세taxable 비과세exempted
totalAmount	String	9	Total amount
issueDT	String	14	Date and time of issuance format : yyyyMMddHHmmss
regDT	String	14	Date and time of the registration format : yyyyMMddHHmmss
stateCode	int	3	Status code Refer to [Status Code]
stateDT	String	14	Date and time of the status change format : yyyyMMddHHmmss
identityNum	String	19	[Buyer] Identification number └ if the value of {tradeUsage} is ‘소득공제용’(income deduction usage), enter one of the following options : resident registration number/ cell phone number/ card number/ 010-000-1234( identification number for voluntary issuance) └ if the value of {tradeUsage} is ‘지출증빙용’(proof of purchase usage), enter one of the following options : business registration number/cell phone number/ card number※ resident registration number : 13 digits, phone number : 10~11 digits, card number : 13~19 digits, business registration number : 10 digits
itemName	String	70	Order product name
customerName	String	70	[Buyer] Name of the customer
confirmNum	String	9	NTS confirmation number POPBiLL automatically assigns this when issuing a cash receipt
orgConfirmNum	String	9	NTS confirmation number of the original cash receipt this value only exists when the value of {tradeType} is ‘취소거래’(cash receipt for revocation).
orgTradeDate	String	8	Trade date of the original cash receipt this value only exists when the value of {tradeType} is ‘취소거래’(cash receipt for revocation).
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
ntsresultCode	String	4	NTS filing result code Refer to [ntsresultCode]
ntsresultMessage	String	30	NTS filing result message
printYN	boolean	-	Whether to print a cash receipt or not trueprint falsedo not print
interOPYN	boolean	-	Whether a cash receipt is issued via API or not trueissued via API falseissued via POPBiLL service website

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 cash receipts

This API checks the status and summarizes information of multiple cash receipts. (Maximum: 1,000 cash receipts)
Check variable 'stateCode' of returned CashbillInfo to confirm status of a cash receipt.

CashbillInfo[] getInfos(String CorpNum, String[] MgtKeyList) throws PopbillException

We recommend using this API when a user implements the list of cash receipts with document IDs.

Parameters

No.	Field	Type	Length	Mandatory	Description
	CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
	MgtKeyList	String[ ]		Y	Document ID of cash receipts to view maximum : 1,000 cash receipts

Return

CashbillInfo

Field	Type	Length	Description
itemKey	String	18	Identification number assigned by POPBiLL for internal management.
mgtKey	String	24	Document ID a unique value that can be entered with alphanumeric values and special characters(‘-’, ‘_’)
tradeDate	String	8	Date of trade format : yyyyMMdd
tradeDT	String	14	Date and time of the trade format : yyyyMMddHHmmss
tradeType	String	4	Type of cash receipt 승인거래general cash receipt 취소거래cash receipt for revocation
tradeUsage	String	5	Purpose of issuance 소득공제용income deduction usage 지출증빙용proof of purchase usage
tradeOpt	String	4	Trade type 일반general 도서공연book/performance 대중교통public transportation
taxationType	String	3	Taxation type 과세taxable 비과세exempted
totalAmount	String	9	Total amount
issueDT	String	14	Date and time of issuance format : yyyyMMddHHmmss
regDT	String	14	Date and time of the registration format : yyyyMMddHHmmss
stateCode	int	3	Status code Refer to [Status Code]
stateDT	String	14	Date and time of the status change format : yyyyMMddHHmmss
identityNum	String	19	[Buyer] Identification number └ if the value of {tradeUsage} is ‘소득공제용’(income deduction usage), enter one of the following options : resident registration number/ cell phone number/ card number/ 010-000-1234( identification number for voluntary issuance) └ if the value of {tradeUsage} is ‘지출증빙용’(proof of purchase usage), enter one of the following options : business registration number/cell phone number/ card number※ resident registration number : 13 digits, phone number : 10~11 digits, card number : 13~19 digits, business registration number : 10 digits
itemName	String	70	Order product name
customerName	String	70	[Buyer] Name of the customer
confirmNum	String	9	NTS confirmation number POPBiLL automatically assigns this when issuing a cash receipt
orgConfirmNum	String	9	NTS confirmation number of the original cash receipt this value only exists when the value of {tradeType} is ‘취소거래’(cash receipt for revocation).
orgTradeDate	String	8	Trade date of the original cash receipt this value only exists when the value of {tradeType} is ‘취소거래’(cash receipt for revocation).
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
ntsresultCode	String	4	NTS filing result code Refer to [ntsresultCode]
ntsresultMessage	String	30	NTS filing result message
printYN	boolean	-	Whether to print a cash receipt or not trueprint falsedo not print
interOPYN	boolean	-	Whether a cash receipt is issued via API or not trueissued via API falseissued via POPBiLL service website

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 cash receipt

This API checks the detailed information of a single cash receipt.

Cashbill getDetailInfo(String CorpNum, String MgtKey) throws PopbillException

Parameters

No.	Field	Type	Length	Mandatory	Description
	CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
	MgtKey	String	24	Y	Document ID

Return

Cashbill

Field	Type	Length	Description
mgtKey	String	24	Document ID
confirmNum	String	9	NTS confirmation number POPBiLL automatically assigns this when a cash receipt is issued combination of {tradeDate} and {confirmNum} must be used as a unique value for a cash receipt [How to Issue – Document ID Management System]
orgConfirmNum	String	9	NTS confirmation number of the original cash receipt
orgTradeDate	String	9	Trade date of the original cash receipt
tradeDT	String	14	Date and time of trade assigned by a user when issuing a cash receipt format : yyyyMMddHHmmss default : date and time of issuance
tradeDate	String	8	Date of trade assigned by POPBiLL when a cash receipt is issued this is the yyyyMMdd value of {tradeDT}
tradeType	String	4	Type of cash receipt 승인거래cash receipt for transaction approval 취소거래cash receipt for revocation
tradeUsage	String	-	Purpose of issuance 소득공제용income deduction usage 지출증빙용proof of purchase usage
tradeOpt	String	4	Trade type 일반general 도서공연book/performance 대중교통public transportation
taxationType	String	-	Taxation type 과세taxable 비과세exempted
totalAmount	String	9	Total amount
supplyCost	String	9	Supply values
tax	String	9	Tax amount
serviceFee	String	9	Service fee
franchiseCorpNum	String	10	[Seller] business registration number
franchiseTaxRegID	String	4	[Seller] identification number for a branch place 4 digits
franchiseCorpName	String	200	[Seller] company name
franchiseCEOName	String	100	[Seller] CEO name
franchiseAddr	String	400	[Seller] company address
franchiseTEL	String	20	[Seller] telephone number
identityNum	String	19	[Buyer] identification number └ if the value of {tradeUsage} is ‘소득공제용’(income deduction usage), enter one of the following options : resident registration number/ cell phone number/ card number/ 010-000-1234( identification number for voluntary issuance) └ if the value of {tradeUsage} is ‘지출증빙용’(proof of purchase usage), enter one of the following options : business registration number/ cell phone number/ card number resident registration number : 13 digits, phone number : 10~11 digits, card number : 13~19 digits, business registration number : 10 digits
customerName	String	70	[Buyer] name of the customer
itemName	String	70	Order product name
orderNumber	String	200	Order number
email	String	100	[Buyer] email
hp	String	20	[Buyer] cell phone number
cancelType	Integer	1	Reasons for revocation nullgeneral cash receipt 1transaction is returned/cancelled 2correction of errors 3other reasons

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 cash receipts

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

CBSearchResult search(String CorpNum, String DType, String SDate, String EDate, String[] State, String[] TradeType, String[] TradeUsage, String[] TradeOpt, String[] TaxationType, String QString, int Page, int PerPage, String Order, String FranchiseTaxRegID) throws PopbillException

We recommend to use this API when a user implements the list of cash receipts 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 Tdate of trade 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	Cash receipt status code wild card() can be put on 2nd, 3rd letter e.g., "3", "6*" search all if not entered
TradeType	String[ ]		N	Type of cash receipts (multiple choice is possible) Ngeneral cash receipt Ccash receipt for revocation search all if not entered
TradeUsage	String[ ]		N	Purpose of issuance (multiple choice is possible) Pincome deduction usage Cproof of purchase usage search all if not entered
TradeOpt	String[ ]		N	Trade type (multiple choice is possible) Ngeneral Bbook/performance Tpublic transportation search all if not entered
TaxationType	String[ ]		N	Taxation type (multiple choice is possible) Ttaxable Nexempted
QString	String	-	N	Search the identification number of a cash receipt. search all if not entered
Page	int	-	Y	Page number of a list of cash receipts.
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
FranchiseTaxRegID	String	-	N	Identification number for branch place when searching multiples, each must be distinguished with a comma(“,”) e.g., 1234,1000 search all if not entered

Return

CBSearchResult

No.

Field

Type

Length

Description

code

String

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

Status/summarized info of a cash receipt

maximum : 1,000 cash receipts

the configuration is same as the return value of [GetInfo – Check the status of a cash receipt] API

Field	Type	Length	Description
itemKey	String	18	Identification number assigned by POPBiLL for internal management.
mgtKey	String	24	Document ID a unique value that can be entered with alphanumeric values and special characters(‘-’, ‘_’)
tradeDate	String	8	Date of trade format : yyyyMMdd
tradeDT	String	14	Date and time of the trade format : yyyyMMddHHmmss
tradeType	String	4	Type of cash receipt 승인거래general cash receipt 취소거래cash receipt for revocation
tradeUsage	String	5	Purpose of issuance 소득공제용income deduction usage 지출증빙용proof of purchase usage
tradeOpt	String	4	Trade type 일반general 도서공연book/performance 대중교통public transportation
taxationType	String	3	Taxation type 과세taxable 비과세exempted
totalAmount	String	9	Total amount
issueDT	String	14	Date and time of issuance format : yyyyMMddHHmmss
regDT	String	14	Date and time of the registration format : yyyyMMddHHmmss
stateCode	int	3	Status code Refer to [Status Code]
stateDT	String	14	Date and time of the status change format : yyyyMMddHHmmss
identityNum	String	19	[Buyer] Identification number └ if the value of {tradeUsage} is ‘소득공제용’(income deduction usage), enter one of the following options : resident registration number/ cell phone number/ card number/ 010-000-1234( identification number for voluntary issuance) └ if the value of {tradeUsage} is ‘지출증빙용’(proof of purchase usage), enter one of the following options : business registration number/cell phone number/ card number※ resident registration number : 13 digits, phone number : 10~11 digits, card number : 13~19 digits, business registration number : 10 digits
itemName	String	70	Order product name
customerName	String	70	[Buyer] Name of the customer
confirmNum	String	9	NTS confirmation number POPBiLL automatically assigns this when issuing a cash receipt
orgConfirmNum	String	9	NTS confirmation number of the original cash receipt this value only exists when the value of {tradeType} is ‘취소거래’(cash receipt for revocation).
orgTradeDate	String	8	Trade date of the original cash receipt this value only exists when the value of {tradeType} is ‘취소거래’(cash receipt for revocation).
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
ntsresultCode	String	4	NTS filing result code Refer to [ntsresultCode]
ntsresultMessage	String	30	NTS filing result message
printYN	boolean	-	Whether to print a cash receipt or not trueprint falsedo not print
interOPYN	boolean	-	Whether a cash receipt is issued via API or not trueissued via API falseissued via POPBiLL service website

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. GetURL - URL for cash receipt menu

This API returns the URL to access the menu related to a cash receipt 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 PBOXIssued cash receipt box WRITEcreate a cash receipt

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. GetPDF - Cash receipt PDF Download

Download 1 Cash receipt PDF.

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

Parameters

Field	Type	Length	Mandatory	Description
CorpNum	String	10	Y	Business registration number 10-digits except (‘-’)
MgtKey	String	24	Y	Invoice ID allocated by Partner
UserID	String	50	N	POPBiLL member ID

Return

byte[] - Cash receipt 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