POPBill Developers
SDK Reference
Java

Issue

1. RegistIssue - Issue the Invoice

  • This API issues the invoice and process it as “issued”.
  • The POPBiLL service website provides an automatic approval option to allow the issuance to return the document status as “pending for approval” instead of “issued” by modifying the option setting via [명세서(Invoice)] > [환경설정(Preference)] menu.
Response registIssue(String CorpNum, Statement statement, String memo, String UserID, String emailSubject) throws PopbillException
  • When issuing an Invoice via [RegistIssue – Issue the invoice] API, service points will be deducted, and a notification mail will be sent to the buyer’s email address.
Parameters
Parameters
No.FieldTypeLengthMandatoryDescription
CorpNum String 10 Y Business registration number
10-digits except (‘-’)
statement Statement - Y Object information for invoice
Statement
No. Field Type Length Mandatory Description
itemCode Short 3 Y Types of invoices
121transaction details
122bill
123estimate
124purchase order
125deposit slip
126receipt
mgtKey String 24 Y Document ID
a unique value that can be entered with alphanumeric values and special characters(‘-’, ‘_’)
formCode String 8 N Code for customized template
POPBiLL default template will be applied if not entered.
writeDate String 8 Y Date of preparation
format : yyyyMMdd
taxType String 2 Conditional Taxation type
과세taxable
영세zero-rated
면세exempted
mandatory if the value of {itemCode} = 121.
purposeType String - N Payments received or not
영수payment received
청구payment not received
없음none
serialNum String 30 N Serial number
taxTotal String 18 Y Sum of tax amount
integer values(+/-) only
decimals will be automatically truncated
supplyCostTotal String 18 Y Sum of supply values
integer values(+/-) only
decimals will be automatically truncated
totalAmount String 18 N Total amount
integer values(+/-) only
decimals will be automatically truncated
remark1 String 150 N Remark 1
remark2 String 150 N Remark 2
remark3 String 150 N Remark 3
senderCorpNum String 10 Y [Seller] business registration number
10 digits except a hyphen(‘-’)
senderTaxRegID String 4 N [Seller] identification number of a branch place
4 digits
senderCorpName String 200 N [Seller] company name
senderCEOName String 100 N [Seller] CEO name
senderAddr String 300 N [Seller] company address
senderBizType String 100 N [Seller] type of business
senderBizClass String 100 N [Seller] items of business
senderContactName String 100 N [Seller] name of the person in charge
senderDeptName String 40 N [Seller] department of the person in charge
senderTEL String 20 N [Seller] contact number of the person in charge
senderHP String 20 N [Seller] cell phone number of the person in charge
senderEmail String 100 N [Seller] email of the person in charge
senderFAX String 20 N [Seller] FAX number of the person in charge
receiverCorpNum String 10 Y [Buyer] business registration number
receiverTaxRegID String 4 N [Buyer] identification number of a branch place
4 digits
receiverCorpName String 200 Y [Buyer] company name
receiverCEOName String 100 N [Buyer] CEO name
receiverAddr String 300 N [Buyer] company address
receiverBizType String 100 N [Buyer] type of business
receiverBizClass String 100 N [Buyer] items of business
receiverContactName String 100 Y [Buyer] name of the person in charge
receiverDeptName String 40 N [Buyer] department of the person in charge
receiverTEL String 20 N [Buyer] contact number of the person in charge
receiverHP String 20 N [Buyer] telephone number of the person in charge
receiverEmail String 100 N [Buyer] email of the person in charge
receiverFAX String 20 N [Buyer] FAX number of the person in charge
propertyBag HashMap - N 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> N Detailed list of items
no limit on length
StatementDetail
No. Field Type Length Mandatory Description
serialNum Short - Y Serial number
purchaseDT String 8 N Date of trade
format : yyyyMMdd
itemName String 100 N Order product name
spec String 60 N Specification
qty String 12 N Quantity
allowed to enter two decimal places
unitCost String 18 N Unit price
allowed to enter two decimal places.
allowed to enter (-) integer values.
supplyCost String 18 N Supply values
integer values(+/-) only
decimals will be automatically truncated
tax String 18 N Tax amount
integer values(+/-) only
decimals will be automatically truncated
remark String 100 N Remark
spare1 String 100 N Spare 1
spare2 String 100 N Spare 2
spare3 String 100 N Spare 3
spare4 String 100 N Spare 4
spare5 String 100 N Spare 5
spare6 String 100 N Spare 6
spare7 String 100 N Spare 7
spare8 String 100 N Spare 8
spare9 String 100 N Spare 9
spare10 String 100 N Spare 10
spare11 String 100 N Spare 11
spare12 String 100 N Spare 12
spare13 String 100 N Spare 13
spare14 String 100 N Spare 14
spare15 String 100 N Spare 15
spare16 String 100 N Spare 16
spare17 String 100 N Spare 17
spare18 String 100 N Spare 18
spare19 String 100 N Spare 19
spare20 String 100 N Spare 20
memo String 200 N Memo for user’s convenience
UserID String 50 N User’s POPBiLL ID
emailSubject String 300 N Title of a notification mail sent to a buyer
POPBiLL default email title will be assigned if not entered
Return
SMTIssueResponse
No.FieldTypeLengthDescription
code long - API response code
message String - API response message
invoiceNum String 24 POPBiLL confirm number
POPBiLL automatically assigns this when issuing an 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

2. Cancel - Cancel the issuance of invoice

  • This API processes an invoice of a status “issued” as “cancelled”.
  • You can reuse a document ID if you delete a “cancelled” invoice.
Response cancel(String CorpNum, int ItemCode, String MgtKey, String Memo, String UserID) throws PopbillException
Parameters
Parameters
No.FieldTypeLengthMandatoryDescription
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
Memo String 200 N Memo for user’s convenience
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

3. Delete - Delete a revocable invoice

  • This API deletes a revocable invoice.

    ※ available status to delete : “cancelled”

Response delete(String CorpNum, int ItemCode, String MgtKey) throws PopbillException
  • Recommend to implement this API only if you need to reuse a document ID of an invoice.
Parameters
Parameters
No.FieldTypeLengthMandatoryDescription
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
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