Index
ㆍCheck whether an statement ID is in use or not.
ㆍThe statement ID is an unique value assigned by user to avoid duplicated issuance and organized e-Statement systematically.
boolean checkMgtKeyInUse(String CorpNum, int ItemCode, String MgtKey) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
Return
boolean - true (In use) / false (Out of use)
Throws
ㆍRegist and Issue the e-Statement. At the same time of issuance, points(fee) is charged and notification mail is sent to customer.
ㆍThe status of invoice is changed to 'Waiting for confirmation' when the result is returned successfully.
Response registIssue(String CorpNum, Statement statement, String memo, String UserID, String emailSubject) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | statement | Statement | - | O | Object of e-Statement |
| 3 | memo | String | 200 | - |
Memo for user's convenience
└ invisible to customer |
| 4 | UserID | String | 50 | - | User's POPBiLL ID |
| 5 | emailSubject | String | 300 | - |
Title of notification mail sent to customer
└ Default: a title POPBiLL set in advance |
Return
Throws
ㆍCancel the e-Statement in the state of '승인대기(Waiting for confirmation)' or '발행완료(Issued)'. The status is changed to '취소(Canceled before issuance)' and '발행취소(Canceled after issuance)' each.
ㆍHow to reuse an statement ID of canceled e-Statement : Delete canceled e-Statement calling [1.4. Delete]API.
Response cancel(String CorpNum, int ItemCode, String MgtKey, String Memo, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
| 4 | Memo | String | 200 | - |
Memo for user's convenience
└ invisible to customer |
| 5 | UserID | String | 50 | - | User's POPBiLL ID |
Return
Throws
ㆍDelete canceled e-Statement in deletable status. A statement ID of deleted e-Statement can be reused.
※ The deletable status : '취소'(Canceled before issuance), '승인거부'(Denied), '발행취소'(Canceled after issuance)
Response delete(String CorpNum, int ItemCode, String MgtKey) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
| 4 | UserID | String | 50 | - | User's POPBiLL ID |
Return
Throws
ㆍCheck the status of a single e-Statement and summarized information.
StatementInfo getInfo(String CorpNum, int ItemCode, String MgtKey) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
Return
Throws
ㆍCheck the status of bulk e-Statements and summarized information. (Maximum : 1000 statements)
StatementInfo[] getInfos(String CorpNum, int ItemCode, String[] MgtKeyList) throws PopbillExceptionㆍRecommend to use when user implements the list of e-Statement with statement ID.
Parameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKeyList | String[ ] | 1000 | O | [Array] Statement ID (Maximum : 1,000 statements) |
Return
Throws
ㆍCheck detailed information of a single e-Statement.
Statement getDetailInfo(String CorpNum, int ItemCode, String MgtKey, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
| 4 | UserID | String | 50 | - | User's POPBiLL ID |
Return
Throws
ㆍSearch e-Statements corresponded to the search criteria the user set.
ㆍDefault of optional fields is to 'search all'.
StmtSearchResult search(String CorpNum, String DType, String SDate, String EDate, String[] State, int[] ItemCode, String QString, int Page, int PerPage, String Order) throws PopbillExceptionㆍRecommend to use when you implement the list of e-Statements with lists related to the page(variable: Page, PerPage, Order)
Parameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | DType | String | 1 | O |
Date type in search criteria
└ Valid Value : R / W / I └ R = Date of registration, W = of preparation, I = of issuance |
| 3 | SDate | String | 8 | O | Start date of search scope (Format : yyyyMMdd) |
| 4 | EDate | String | 8 | O | End date of search scope (Format : yyyyMMdd) |
| 5 | State | String[ ] | - | - |
[Array] Status Code
└ Wild card(*) can be put on 2nd, 3rd letter – e.g. “3**”, “6**” [참고] 전자명세서 상태코드 |
| 6 | ItemCode | int[ ] | - | O |
[Array] Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 (multiple choice is possible) └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 7 | QString | String | - | - | Name or Business registration number of customer company |
| 8 | Page | int | - | O |
Page number
└ Default = 1 |
| 9 | PerPage | int | - | O |
The number of list to be displayed per page (Maximum : 1000)
└ Default = 500 |
| 10 | Order | String | 1 | - |
Sort direction (related to {no.2 DType})
└ Valid Value : D / A └ D = Descending(Default), A = Ascending |
Return
Throws
ㆍCheck the log of e-Statement's status change.
StatementLog[] getLogs(String CorpNum, int ItemCode, String MgtKey) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
Return
Throws
ㆍGet the URL to access the page 'e-Statement list' on POPBiLL website in login status.
ㆍReturned URL is valid for 30 seconds and after the valid time, page is not opened.
String getURL(String CorpNum, String UserID, String TOGO) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | UserID | String | 50 | - | User's POPBiLL ID |
| 3 | TOGO | String | - | O |
Targeted Menu
└ Valid Value : TBOX / SBOX └ TBOX = Draft list, SBOX = Sales list |
Return
String - Returned URL to response about the request
Throws
ㆍGet the popup URL to view a single e-Statement on POPBiLL website.
ㆍReturned URL is valid for 30 seconds and after the valid time, page is not opened.
String getPopUpURL(String CorpNum, int ItemCode, String MgtKey, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
| 4 | UserID | String | 50 | - | User's POPBiLL ID |
Return
String - Returned URL to response about the request
Throws
ㆍGet the popup URL to view a single e-Statement on POPBiLL website (showing a page without top, left menus and buttons)
ㆍReturned URL is valid for 30 seconds and after the valid time, page is not opened.
String getViewURL(String CorpNum, int ItemCode, String MgtKey, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
| 4 | UserID | String | 50 | - | User's POPBiLL ID |
Return
String - Returned URL to response about the request
Throws
ㆍGet the popup URL to print a single e-Statement. User can select a print option - for supplier/customer/both.
ㆍReturned URL is valid for 30 seconds and after the valid time, page is not opened.
String getPrintURL(String CorpNum, int ItemCode, String MgtKey, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
| 4 | UserID | String | 50 | - | User's POPBiLL ID |
Return
String - Returned URL to response about the request
Throws
ㆍGet the popup URL to print a single e-Statement for customer.
ㆍReturned URL is valid for 30 seconds and after the valid time, page is not opened.
String getEPrintURL(String CorpNum, int ItemCode, String MgtKey, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
| 4 | UserID | String | 50 | - | User's POPBiLL ID |
Return
String - Returned URL to response about the request
Throws
ㆍGet the popup URL to print e-Statements in bulk. (Maximum : 100 statements)
ㆍReturned URL is valid for 30 seconds and after the valid time, page is not opened.
String getMassPrintURL(String CorpNum, int ItemCode, String[] MgtKeyList, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKeyList | String[ ] | 100 | O | [Array] Statement ID (Maximum : 100 IDs) |
| 4 | UserID | String | 50 | - | User's POPBiLL ID |
Return
String - Returned URL to response about the request
Throws
ㆍGet the popup URL of button located on bottom of a notification mail sent to customer. User can access the page to check e-Statement in detail.
ㆍThere is no valid time.
String getMailURL(String CorpNum, int ItemCode, String MgtKey, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
| 4 | UserID | String | 50 | - | User's POPBiLL ID |
Return
String - Returned URL to response about the request
Throws
ㆍGet the popup URL to access POPBiLL website in login status.
ㆍReturned URL is valid for 30 seconds and after the valid time, page is not opened.
String getAccessURL(String CorpNum, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | UserID | String | 50 | - | User's POPBiLL ID |
Return
String - Returned URL to response about the request
Throws
ㆍResend a notification mail to customer. There's no minimum time required and no maximum number of calling API.
Response sendEmail(String CorpNum, int ItemCode, String MgtKey, String Receiver, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
| 4 | Receiver | String | - | O | Email address |
| 5 | UserID | String | 50 | - | User's POPBiLL ID |
Return
Throws
ㆍSend a SMS(short message) to notify issuance of e-Statement and the fee is charged.
ㆍUser can check the result of sending SMS on POPBiLL website [문자·팩스(Messaging/FAX) -> 문자(Messaging) -> 전송내역(Sending log)]
ㆍSMS's capacity is 90byte and exceeded contents are truncated automatically. (Maximum of Korean letters : 45)
Response sendSMS(String CorpNum, int ItemCode, String MgtKey, String Sender, String Receiver, String Contents, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
| 4 | Sender | String | - | O | Sender(Supplier)'s Number |
| 5 | Receiver | String | - | O | Receiver(Customer)'s Number |
| 6 | Contents | String | 90 | O |
Contents of SMS
(*Exceeded contents are truncated automatically) |
| 7 | UserID | String | 50 | - | User's POPBiLL ID |
Return
Throws
ㆍSend an e-Statement registered in POPBiLL and issued by fax and the fee is charged.
ㆍUser can check the result of sending fax on POPBiLL website [문자·팩스(Messaging/FAX) -> 팩스(FAX) -> 전송내역(Sending log)].
Response sendFAX(String CorpNum, int ItemCode, String MgtKey, String Sender, String Receiver, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
| 4 | Sender | String | - | O | Sender(Supplier)'s Number |
| 5 | Receiver | String | - | O | Receiver(Customer)'s Number |
| 6 | UserID | String | 50 | - | User's POPBiLL ID |
Return
Throws
ㆍSend an e-Statement by fax without registration in POPBiLL. User can directly send a fax with the statement data stored in their system.
ㆍThe user can check the result of sending fax on POPBiLL website [문자·팩스(Messaging/FAX) -> 팩스(FAX) -> 전송내역(Sending log)].
String FAXSend(String CorpNum, Statement statement, String sendNum, String receiveNum, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | statement | Statement | - | O | Object of e-Statement |
| 3 | sendNum | String | - | O | Sender(Supplier)'s Number |
| 4 | receiveNum | String | - | O | Receiver(Customer)'s Number |
| 5 | UserID | String | 50 | - | User's POPBiLL ID |
Return
Throws
ㆍAttach a statement issued through POPBiLL to the e-Statement.
Response attachStatement(String CorpNum, int ItemCode, String MgtKey, int SubItemCode, String SubMgtKey) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
| 4 | SubItemCode | int | 3 | O |
Type code of the statement to be attached
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 5 | SubMgtKey | String | 24 | O | Statement ID of the statement to be attached |
Return
Throws
ㆍDetach a statement issued through POPBiLL from the e-Statement.
Response detachStatement(String CorpNum, int ItemCode, String MgtKey, int SubItemCode, String SubMgtKey) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except '-') |
| 2 | ItemCode | int | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 3 | MgtKey | String | 24 | O | Statement ID |
| 4 | SubItemCode | int | 3 | O |
Type code of the statement to be detached
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 5 | SubMgtKey | String | 24 | O | Statement ID of the statement to be detached |
Return
Throws
| No. | Name | Type | Length | Description |
|---|---|---|---|---|
| 1 | code | long | - | Response code for API processing |
| 2 | message | String | - | Response message for API processing |
| No. | Name | Type | Length | Description |
|---|---|---|---|---|
| 1 | code | long | - |
Error code for failure of API process (8 digits starting with '-')
└ [Reference] Error codes |
| 2 | message | String | - | Error message for failure of API processing |
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | itemCode | Short | 3 | O |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 2 | mgtKey | String | 24 | O |
Statement ID assigned by partner(user)
└ An unique value to combine English letter, numeric and hyphen('-') *No redundancy |
| 3 | invoiceNum | String | 24 | X |
POPBiLL confirm number
└ Identification number assigned by POPBiLL after the issuance is completed |
| 4 | formCode | String | 8 | - |
Code for customized template
└ Default : Applying POPBiLL default template |
| 5 | writeDate | String | 8 | O |
Date of preparation
└ Format : yyyyMMdd |
| 6 | taxType | String | 4 | O |
Taxation Type
└ Valid Value : 과세 / 영세 / 면세 └ 과세 = Taxable, 영세 = Zero-rate, 면세 = Exempted |
| 7 | purposeType | String | - | - |
Type of the total amount
└ Valid Value : 영수 / 청구 / 없음 └ 영수 = Amount paid, 청구 = Amount due, 없음 = None |
| 8 | serialNum | String | 30 | - | Serial Number |
| 9 | taxTotal | String | 18 | O |
Sum of tax amount
└ Only positive(+)/negative(-) numbers and – (minus sign) are available |
| 10 | supplyCostTotal | String | 18 | O |
Sum of supply values
└ Only positive(+)/negative(-) numbers and – (minus sign) are available |
| 11 | totalAmount | String | 18 | - |
Total Amount
└ sum of {no.9 taxTotal} and {no.10 supplyCostTotal} └ Only positive(+)/negative(-) numbers and – (minus sign) are available |
| 12 | remark1 | String | 150 | - | 1st Remark |
| 13 | remark2 | String | 150 | - | 2nd Remark |
| 14 | remark3 | String | 150 | - | 3rd Remark |
| 15 | senderCorpNum | String | 10 | O |
[Supplier] Business registration number
└ 10 digits number except hyphen(‘-’) |
| 16 | senderTaxRegID | String | 4 | - |
[Supplier] Identification Number for minor place of business
└ 4 digits number |
| 17 | senderCorpName | String | 200 | - | [Supplier] Company name |
| 18 | senderCEOName | String | 100 | - | [Supplier] Representative name |
| 19 | senderAddr | String | 300 | - | [Supplier] Address |
| 20 | senderBizType | String | 100 | - | [Supplier] Business Type |
| 21 | senderBizClass | String | 100 | - | [Supplier] Business Item |
| 22 | senderContactName | String | 100 | - | [Supplier] Name of the person in charge |
| 23 | senderDeptName | String | 40 | - | [Supplier] Department of the person in charge |
| 24 | senderTEL | String | 20 | - | [Supplier] Contact of the person in charge |
| 25 | senderHP | String | 20 | - | [Supplier] Mobile of the person in charge |
| 26 | senderEmail | String | 100 | - | [Supplier] Email of the person in charge |
| 27 | senderFAX | String | 20 | - | [Supplier] Fax of the person in charge |
| 28 | receiverCorpNum | String | 10 | O |
[Customer] Business registration number
└ 10 digits number except hyphen(‘-’) |
| 29 | receiverTaxRegID | String | 4 | - |
[Customer] Identification Number for minor place of business
└ 4 digits number |
| 30 | receiverCorpName | String | 200 | O | [Customer] Company name |
| 31 | receiverCEOName | String | 100 | - | [Customer] Representative name |
| 32 | receiverAddr | String | 300 | - | [Customer] Address |
| 33 | receiverBizType | String | 100 | - | [Customer] Business Type |
| 34 | receiverBizClass | String | 100 | - | [Customer] Business Item |
| 35 | receiverContactName | String | 100 | O | [Customer] Name of the person in charge |
| 36 | receiverDeptName | String | 40 | - | [Customer] Department of the person in charge |
| 37 | receiverTEL | String | 20 | - | [Customer] Contact of the person in charge |
| 38 | receiverHP | String | 20 | - | [Customer] Mobile of the person in charge |
| 39 | receiverEmail | String | 100 | - | [Customer] Email of the person in charge |
| 40 | receiverFAX | String | 20 | - | [Customer] Fax of the person in charge |
| 41 | propertyBag | HashMap | - | - |
Additional property to be added
└ [Reference] Table of additional properties └ [Reference] Tutorial |
| 42 | businessLicenseYN | boolean | - | - |
Whether you attach registered business license
└ true : attach, false : not attach(Default) |
| 43 | bankBookYN | boolean | - | - |
Whether you attach registered copy of bankbook
└ true : attach, false : not attach(Default) |
| 44 | smssendYN | boolean | - | - |
Whether you send a notification SMS to customer’s mobile(no. 38 receiverHP) issuing an e-Statement.
└ true = send, false = not send(Default) └ Fee is charged to every SMS and is refunded if sending fails. |
| 45 | autoAcceptYN | boolean | - | - |
Whether delivered e-Statement is issued regardless of customer’s confirmation
└ Default : false = issue only after the customer confirmed |
| 46 | detailList | List<StatementDetail> | - |
[List] Detailed list of items
※ No length limit |
|
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | serialNum | Short | - | O |
Serial Number
└ Must write the number in a row starting from 1 |
| 2 | purchaseDT | String | 8 | - |
Date of preparation
└ Format : yyyyMMdd |
| 3 | itemName | String | 100 | - | Item name |
| 4 | spec | String | 60 | - | Specification |
| 5 | qty | String | 12 | - |
Quantity
└ Available to two decimal places └ Minus(Negative) amount is available |
| 6 | unitCost | String | 18 | - |
Unit price
└ Available to two decimal places └ Minus(Negative) amount is available |
| 7 | supplyCost | String | 18 | - |
Supply values
└ Unavailable to decimal places └ Minus(Negative) amount is available └ Below the decimal point is rounded off |
| 8 | tax | String | 18 | - |
Tax amount
└ Unavailable to decimal places └ Minus(Negative) amount is available └ Below the decimal point is rounded off |
| 9 | remark | String | 100 | - | Remark |
| 10 | spare1 | String | 100 | - | |
| 11 | spare2 | String | 100 | - | |
| 12 | spare3 | String | 100 | - | |
| 13 | spare4 | String | 100 | - | |
| 14 | spare5 | String | 100 | - | |
| 15 | spare6 | String | 100 | - | |
| 16 | spare7 | String | 100 | - | |
| 17 | spare8 | String | 100 | - | |
| 18 | spare9 | String | 100 | - | |
| 19 | spare10 | String | 100 | - | |
| 20 | spare11 | String | 100 | - | |
| 21 | spare12 | String | 100 | - | |
| 22 | spare13 | String | 100 | - | |
| 23 | spare14 | String | 100 | - | |
| 24 | spare15 | String | 100 | - | |
| 25 | spare16 | String | 100 | - | |
| 26 | spare17 | String | 100 | - | |
| 27 | spare18 | String | 100 | - | |
| 28 | spare19 | String | 100 | - | |
| 29 | spare20 | String | 100 | - |
| No. | Name | Type | Length | Description |
|---|---|---|---|---|
| 1 | code | long | - | Response code |
| 2 | message | String | - | Response message |
| 3 | total | String | - | The total number of search results |
| 4 | perPage | String | - | The number of search result per a page |
| 5 | pageNum | String | - | Page number |
| 6 | pageCount | String | - | The number of pages |
| 7 | list | List<StatementInfo> |
[List] e-Statement’s status info / Summarized info (Maximum : 1000 lists)
└ The configuration is same as a return value of [2.1. GetInfo] |
|
| No. | Name | Type | Length | Description |
|---|---|---|---|---|
| 1 | itemCode | Short | 3 |
Type of the e-Statement
└ Valid Value : 121 / 122 / 123 / 124 / 125 / 126 └ 121 = Transaction details, 122 = Bill, 123 = Estimate, 124 = Purchase order, 125 = Deposit slip, 126 = Receipt |
| 2 | itemKey | String | 18 | Statement ID assigned by POPBiLL for internal management |
| 3 | invoiceNum | String | 24 |
POPBiLL confirm number
└ Identification number assigned by POPBiLL after the issuance is completed |
| 4 | mgtKey | String | 24 |
Statement ID assigned by partner(user)
└ An unique value to combine English letter, numeric and hyphen(‘-’) *No redundancy |
| 5 | taxType | String | 2 |
Taxation Type
└ Valid Value : 과세 / 영세 / 면세 └ 과세 = Taxable, 영세 = Zero-rate, 면세 = Exempted |
| 6 | writeDate | String | 8 |
Date of preparation
└ Format : yyyyMMdd |
| 7 | regDT | String | 14 |
Date and Time of Registration as a draft
└ Format : yyyyMMddHHmmss |
| 8 | senderCorpName | String | 200 | [Supplier] Company name |
| 9 | senderCorpNum | String | 10 | [Supplier] Business registration number |
| 10 | senderPrintYN | boolean | - |
[Supplier] Whether e-Tax invoice is printed
└ true = printed, false = not printed |
| 11 | receiverCorpName | String | 200 | [Customer] Company name |
| 12 | receiverCorpNum | String | 10 | [Customer] Business registration number |
| 13 | receiverPrintYN | boolean | - |
[Customer] Whether e-Tax invoice is printed
└ true = printed, false = not printed |
| 14 | supplyCostTotal | String | 18 | Sum of supply values |
| 15 | taxTotal | String | 18 | Sum of tax amount |
| 16 | purposeType | String | 2 |
Type of the total amount
└ Valid Value : 영수 / 청구 / 없음 └ 영수 = Amount paid, 청구 = Amount due, 없음 = None |
| 17 | issueDT | String | 14 |
Date and Time of Issuance
└ Format : yyyyMMddHHmmss |
| 18 | stateCode | int | 3 |
Status code
[Reference] e-Statement Status Code |
| 19 | stateDT | String | 14 |
Date and Time of status change
└ Format : yyyyMMddHHmmss |
| 20 | stateMemo | String | 200 | Memo about status |
| 21 | openYN | boolean | - |
Whether an e-Tax invoice is checked
└ The status is changed to ‘Checked’ when customer(recipient) checks the details of e-Statement via the notification mail clicking the button on the bottom └ true = Check, false = Not Checked |
| 22 | openDT | String | 14 |
Date and Time of checking an e-Tax invoice
└ It’s returned only when {no.11 openYN} is ‘true’ └ Format : yyyyMMddHHmmss |