Index
ㆍCheck whether a cashbill ID is in use or not.
ㆍThe cashbill ID is a unique value assigned by user to avoid duplicated issuance and organized e-Cashbill systematically.
boolean checkMgtKeyInUse(String CorpNum, String MgtKey) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except ‘-’) |
| 2 | MgtKey | String | 24 | O | Cashbill ID |
Return
boolean - true : (In use) / false : (Out of use)
Throws
ㆍRegister and Issue the e-Cashbill. At the same time of issuance, points(fee) is charged and notification mail is sent to customer.
ㆍThe status of cashbill is changed to 'ISSUED' when the result is returned successfully.
CBIssueResponse registIssue(String CorpNum, Cashbill cashbill, String memo, String UserID, String emailSubject) throws PopbillExceptionㆍThe date of trading is automatically assigned as a day to call the function ‘RegistIssue’ and it’s not available to be modified.
ㆍFor Voluntary Issuance, ‘소득공제용’ (to deduct income tax) and ‘010-000-1234’ must be entered as a value of ‘tradeUsage’(The purpose of issuance) and ‘identityNum’(Customer’s identification number).
Parameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except ‘-’) |
| 2 | cashbill | Cashbill | - | O | Object of e-Cashbill |
| 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
ㆍSubmit the issuance of bulk cashbills. A single transaction processes maximum 100 cashbills.
ㆍDuplicated submission ID and e-Cashbill data are not accepted and it’s handled by returning registered submission ID, not the error code and message.
bulkResponse bulkSubmit(String CorpNum, String SubmitID, List<Cashbill> cashbillList, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except ‘-’) |
| 2 | SubmitID | String | 36 | O |
Submission ID
└ A unique value combined English letter, numeric, hyphen(‘-’) and underbar(‘_’) |
| 3 | cashbillList | List<Cashbill> | 100 | O | [List] Object of e-Cashbill |
| 4 | UserID | String | 50 | - | User’s POPBiLL ID |
Return
Throws
ㆍCheck the submission status for bulk issuance using SubmitID.
ㆍThe issuance result is returned when the submission status(variable: txState) is changed to ‘2’(successfully completed).
BulkCashbillResult getBulkResult(String CorpNum, String SubmitID, String UserID) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except ‘-’) |
| 2 | SubmitID | String | 36 | O | Assigned submission ID for the bulk issuance |
| 3 | UserID | String | 50 | - | User’s POPBiLL ID |
Return
Throws
ㆍDelete an e-Cashbill in status of ‘FAILED’ to reuse the cashbill ID of failed cashbill.
Response delete(String CorpNum, 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 | MgtKey | String | 24 | O | Cashbill ID |
| 3 | UserID | String | 50 | - | User’s POPBiLL ID |
Return
Throws
ㆍRegister and Issue an e-Cashbill for revocation with the cost information* as much as to be revoked. (*Supply values, Tax amount, Service fee and Total amount)
ㆍThe status of cashbill is changed to 'ISSUED' when the result is returned successfully
Response revokeRegistIssue(String CorpNum, String mgtKey, String orgConfirmNum, String orgTradeDate, Boolean smssendYN, String memo, Boolean isPartCancel, Integer cancelType, String supplyCost, String tax, String serviceFee, String totalAmount, String userID, String emailSubject, String tradeDT) throws PopbillExceptionㆍTotal amount of e-Cashbill for revocation must be the same or smaller than the original.
Parameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except ‘-’) |
| 2 | mgtKey | String | 24 | O |
Cashbill ID
└ A unique value combined English letter, numeric, hyphen(‘-’) and underbar(‘_’) |
| 3 | orgConfirmNum | String | 9 | O |
NTS Confirm Number of the Original
└ Refer {@no.18 confirmNum} of [A.9. CashbillInfo] returned by [2.1. GetInfo] |
| 4 | orgTradeDate | String | 8 | O |
Trade Date of the Original
└Refer {@no.3 tradeDate} of [A.9. CashbillInfo] returned by [2.1. GetInfo] |
| 5 | smssendYN | Boolean | - | - |
Whether user send a notification message
└ true = send, false = not send(Default) └ The message is sent to customer contact of the original |
| 6 | memo | String | 200 | - | Memo for user’s convenience
└ invisible to customer |
| 7 | isPartCancel | Boolean | - | △ |
Whether user revoke the whole of the trade or a part
└ true = a part, false = the whole(Default) |
| 8 | cancelType | Integer | 1 | - |
Reason for revocation
└ Valid value: 1 / 2 / 3 └ 1 = Return(Default), 2 = Error on filed e-Cashbill, 3 = etc. |
| 9 | supplyCost | String | 9 | △ |
Supply values
└ When {@no.7 isPartCancel} is ‘true’, enter the value as much as to be revoked └ When {@no.7 isPartCancel} is ‘false’, leave a blank |
| 10 | tax | String | 9 | △ |
Tax Amount
└ When {@no.7 isPartCancel} is ‘true’, enter the value as much as to be revoked └ When {@no.7 isPartCancel} is ‘false’, leave a blank |
| 11 | serviceFee | String | 9 | △ |
Service Fee
└ When {@no.7 isPartCancel} is ‘true’, enter the value as much as to be revoked └ When {@no.7 isPartCancel} is ‘false’, leave a blank |
| 12 | totalAmount | String | 9 | △ |
Total Amount
└ Sum of {@no.9 supplyCost}, {@no.10 tax} and {@no.11 serviceFee} └ When {@no.7 isPartCancel} is ‘true’, enter the value as much as to be revoked └ When {@no.7 isPartCancel} is ‘false’, leave a blank |
| 13 | userID | String | 50 | - | User’s POPBiLL ID |
| 14 | emailSubject | String | 300 | - |
Title of notification mail sent to customer
└ Default: a title POPBiLL set in advance |
| 15 | tradeDT | String | 14 | - |
The date and time of trading (Format : yyyyMMddHHmmss)
└ Valid Value : Today(Default) / Previous day |
Return
Throws
ㆍCheck the status of a single e-Cashbill and summarized information.
ㆍCheck variable ‘stateCode’ of returned ‘CashbillInfo’ to confirm the status of e-Cashbill.
CashbillInfo getInfo(String CorpNum, String MgtKey) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except ‘-’) |
| 2 | MgtKey | String | 24 | O | Cashbill ID |
Return
Throws
ㆍCheck the status of multiple e-Cashbills and summarized information. (Maximum : 1,000 cashbills)
ㆍCheck variable ‘stateCode’ of returned ‘CashbillInfo’ to confirm the status of e-Cashbill.
CashbillInfo[] getInfos(String CorpNum, String[] MgtKeyList) throws PopbillExceptionㆍRecommend to use when user implements the list of e-Cashbills with cashbill ID
Parameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except ‘-’) |
| 2 | MgtKeyList | String[ ] | 1000 | O | [Array] Cashbill ID |
Return
Throws
ㆍCheck detailed information of a single e-Cashbill.
Cashbill getDetailInfo(String CorpNum, String MgtKey) throws PopbillExceptionParameters
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | O | Business Registration Number of user (10 digits except ‘-’) |
| 2 | MgtKey | String | 24 | O | Cashbill ID |
Return
Throws
ㆍSearch e-Cashbill corresponded to the search criteria. (Maximum period for search scope : 6 months)
ㆍDefault of optional fields is ‘to search ALL’.
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ㆍRecommend to use when user implement the list of e-Cashbills with an item 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 / T / I └ R = Date of registration, W = of trading, I = of issuance |
| 3 | SDate | String | 8 | O | Initial date of search scope (Format : yyyyMMdd) |
| 4 | EDate | String | 8 | O | Last date of search scope (Format : yyyyMMdd) |
| 5 | State | String[ ] | - | - |
[Array] e-Cashbill Status Code
└ Wild card(*) can be put on 2nd, 3rd letter – e.g. "3**" |
| 6 | TradeType | String[ ] | - | - |
[Array] Type of e-Cashbill(document)
└ Valid Value : N / C (multiple choice is possible) └ N = Approval, C = Revocation |
| 7 | TradeUsage | String[ ] | - | - |
[Array] Purpose of issuance
└ Valid Value : P / C (multiple choice is possible) └ P = To deduct personal income tax, C = To proof the expenditure in business |
| 8 | TradeOpt | String[ ] | - | - |
[Array] Trade Type
└ Valid Value : N / B / T (multiple choice is possible) └ N = General, B = Book and Performance, T = Public Transportation |
| 9 | TaxationType | String[ ] | - | - |
[Array] Taxation Type
└ Valid Value : T / N (multiple choice is possible) └ T = Taxable, N = Non-taxable |
| 10 | QString | String | - | - |
Customer’s identification number : Business registration number(for company) / Resident registration number(for individual) / Mobile / (e-Cashbill) Card number
└ Do not enter hyphen('-') |
| 11 | Page | int | - | O |
Page number
└ Default = 1 |
| 12 | PerPage | int | - | O |
The number of list to be displayed per page (Maximum : 1,000)
└ Default = 500 |
| 13 | Order | String | 1 | - |
Sort Direction (related to {@no.2 DType})
└ Valid Value : D / A └ D = Descending(Default), A = Ascending |
| 14 | FranchiseTaxRegID | String | - | - |
Identification Number for minor place of business
└ 4 digits number └ one more numbers must be separated by comma(',') (e.g. 1234, 1110) |
Return
Throws
ㆍGet the URL to access the menu related to e-Cashbill of 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 / PBOX / WRITE └ TBOX = Draft list, PBOX = A list of issued e-Cashbill, WRTIE = Create an e-Cashbill |
Return
String - Returned URL to response about the request
Throws
ㆍGet the popup URL to view a single e-Cashbill on POPBiLL website.
ㆍReturned URL is valid for 30 seconds and after the valid time, page is not opened.
String getPopUpURL(String CorpNum, 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 | MgtKey | String | 24 | O | Cashbill ID |
| 3 | 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-Cashbill on POPBiLL website (showing a page without menus and buttons).
ㆍReturned URL is valid for 30 seconds and after the valid time, page is not opened.
String getViewURL(String CorpNum, 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 | MgtKey | String | 24 | O | Cashbill ID |
| 3 | 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-Cashbill.
ㆍReturned URL is valid for 30 seconds and after the valid time, page is not opened.
String getPrintURL(String CorpNum, 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 | MgtKey | String | 24 | O | Cashbill ID |
| 3 | UserID | String | 50 | - | User’s POPBiLL ID |
Return
String - Returned URL to response about the request
Throws
ㆍGet the popup URL to print e-Cashbills in bulk. (Maximum: 100 cashbills)
ㆍReturned URL is valid for 30 seconds and after the valid time, page is not opened.
String getMassPrintURL(String CorpNum, 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 | MgtKeyList | String[ ] | 100 | O | [Array] Cashbill ID |
| 3 | 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 the bottom of a notification mail sent to customer. User can access the page to check e-Cashbill in detail.
ㆍThere is no valid time.
String getMailURL(String CorpNum, 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 | MgtKey | String | 24 | O | Cashbill ID |
| 3 | UserID | String | 50 | - | User’s POPBiLL ID |
Return
String - Returned URL to response about the request
Throws
ㆍGet the popup URL to download the e-Cashbill in PDF format.
ㆍReturned URL is valid for 30 seconds and after the valid time, page is not opened.
String getPDFURL(String CorpNum, 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 | MgtKey | String | 24 | O | Cashbill ID |
| 3 | 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, 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 | MgtKey | String | 24 | O | Cashbill ID |
| 3 | Receiver | String | - | O | Email address |
| 4 | UserID | String | 50 | - | User’s POPBiLL ID |
Return
Throws
ㆍSend a SMS(short message) to notify issuance of e-Cashbill. To call this API, an additional cost is charged apart from the issuance cost.
ㆍ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, 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 | MgtKey | String | 24 | O | Cashbill ID |
| 3 | Sender | String | - | O | Sender’s number |
| 4 | Receiver | String | - | O | Receiver(Customer)’s number |
| 5 | Contents | String | 90 | O |
Contents of SMS
(*Exceeded contents are truncated automatically) |
| 6 | UserID | String | 50 | - | User’s POPBiLL ID |
Return
Throws
ㆍSend issued e-Cashbill by fax. To call this API, an additional cost is charged apart from the issuance cost.
ㆍUser can check the result of sending fax on POPBiLL website [문자·팩스(Messaging/FAX) -> 팩스(FAX) -> 전송내역(Sending log)].
Response sendFAX(String CorpNum, 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 | MgtKey | String | 24 | O | Cashbill ID |
| 3 | Sender | String | - | O | Sender’s number |
| 4 | Receiver | String | - | O | Receiver(Customer)’s number |
| 5 | UserID | String | 50 | - | User’s POPBiLL ID |
Return
Throws
ㆍAssign a cashbill ID(mgtKey) to e-Cashbill issued in POPBiLL website manually.
Response assignMgtKey(String corpNum, String itemKey, 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 | itemKey | String | 18 | O |
POPBiLL’s cashbill ID
└ Refer {@no 7. list} of [A.8. CBSearchResult] returned by [2.4. Search] |
| 3 | mgtKey | String | 24 | O | Cashbill ID |
| 5 | userID | String | 50 | - | User’s POPBiLL ID |
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 | - | Response code for API processing |
| 2 | message | String | - | Response message for API processing |
| 3 | confirmNum | String | 9 |
NTS Confirm Number
└ POPBiLL assigns when e-Cashbill is issued |
| 4 | tradeDate | String | 8 | (used in old version) Date of trading (Format : yyyyMMdd) |
| 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 process |
| No. | Name | Type | Length | Required | Description |
|---|---|---|---|---|---|
| 1 | mgtKey | String | 24 | O | Cashbill ID |
| 2 | confirmNum | String | 9 | X |
NTS Confirm Number
└ POPBiLL assigns when e-Cashbill is issued |
| 3 | orgConfirmNum | String | 9 | △ |
NTS Confirm Number of the Original
└ Mandatory value when {@no.7 tradeType} is “취소거래”(Revocation) |
| 4 | orgTradeDate | String | 8 | △ |
Trade Date of the Original
└ Mandatory value when {@no.7 tradeType} is “취소거래”(Revocation) |
| 5 | tradeDate | String | 8 | X | (used in old version) The date of trading (Format : yyyyMMdd) |
| 6 | tradeDT | String | 14 | - |
The date and time of trading (Format : yyyyMMddHHmmss)
└ Valid Value : Today(Default) / Previous day |
| 7 | tradeType | String | 4 | O |
Document Type
└ Valid Value : 승인거래 / 취소거래 └ 승인거래 = Approval(General), 취소거래 = Revocation(Cancellation) |
| 8 | tradeUsage | String | - | O |
Issuance Purpose
└ Valid Value : 소득공제용 / 지출증빙용 └ 소득공제용 = To deduct income tax, 지출증빙용 = To proof the expenditure in business |
| 9 | tradeOpt | String | 4 | - |
Trade Type
└ Valid Value : 일반 / 도서공연 / 대중교통 └ 일반 = General(Default), 도서공연 = Book and Performance, 대중교통 = Public Transportation |
| 10 | taxationType | String | - | O |
Taxation Type
└ Valid Value : 과세 / 비과세 └ 과세 = Taxable, 비과세 = Non-taxable |
| 11 | totalAmount | String | 9 | O |
Total Amount
└ Sum of {@no.12 supplyCost}, {@no.13 tax} and {@no.14 serviceFee} └ Only positive(+) number is available |
| 12 | supplyCost | String | 9 | O |
Supply values
└ Only positive(+) number is available |
| 13 | tax | String | 9 | O |
Tax Amount
└ Only positive(+) number is available |
| 14 | serviceFee | String | 9 | O |
Service Fee
└ Only positive(+) number is available |
| 15 | franchiseCorpNum | String | 10 | O | [Seller] Business Registration Number of user (10 digits except ‘-’) |
| 16 | franchiseTaxRegID | String | 4 | - |
[Seller] Identification Number for minor place of business
└ 4 digits number |
| 17 | franchiseCorpName | String | 200 | - | [Seller] Name of company |
| 18 | franchiseCEOName | String | 100 | - | [Seller] Name of representative |
| 19 | franchiseAddr | String | 400 | - | [Seller] Company Address |
| 20 | franchiseTEL | String | 20 | - | [Seller] Contact |
| 21 | identityNum | String | 19 | O |
[Customer] Identification Number
└ Case1. {@no.8 tradeUsage} = ‘소득공제용’(To deduct income tax) : Resident Registration Number / Mobile / (e-Cashbill) Card Number / 010-000-1234 (for voluntary issuance) └ Case2. {@no.8 tradeUsage} = ‘지출증빙용’(To proof the expenditure in business) : Business Registration Number / Resident Registration Number / Mobile / (e-Cashbill) Card Number └ Do not enter hyphen('-') |
| 22 | customerName | String | 70 | - | [Customer] Name |
| 23 | itemName | String | 70 | - | Item Name |
| 24 | orderNumber | String | 200 | - | Order Number |
| 25 | String | 100 | - | [Customer] Email address
└ To send a notification mail |
|
| 26 | hp | String | 20 | - | [Customer] Mobile
└ When {@no.27 smssendYN} = ‘true’, a message is sent to this value |
| 27 | smssendYN | boolean | - | - |
Whether user send a notification message
└ true = send, false = not send(Default) |
| 28 | faxsendYN | boolean | - | - |
Whether user send the e-Cashbill by fax
└ true = send, false = not send(Default) |
| 29 | cancelType | Integer | 1 | - |
Reason for revocation
└ Valid value: null / 1 / 2 / 3 └ null = General trade, 1 = Return, 2 = Error on filed e-Cashbill, 3 = etc. └ When {@no.7 tradeType} is ‘취소거래’(Revocation), the default is ‘1’ |
| No. | Name | Type | Length | Description |
|---|---|---|---|---|
| 1 | code | long | - | Response code for API processing |
| 2 | message | String | - | Response message for API |
| 3 | receiptID | String | 36 |
Receipt ID
└ assigned by POPBiLL when the receipt is processed |
| No. | Name | Type | Length | Description |
|---|---|---|---|---|
| 1 | code | long | - | Response code for API processing |
| 2 | message | String | - | Response message for API processing |
| 3 | submitID | String | 36 | Submission ID
└ assigned by user when the submission is processed |
| 4 | submitCount | long | - | The number of cashbills submitted for issuance |
| 5 | successCount | long | - | The number of cashbills issued successfully |
| 6 | failCount | long | - | The number of cashbills failed to issue |
| 7 | txState | long | - |
Status code of submission
└ Valid Value : 0 / 1 / 2 └ 0 = Submitted, 1 = In processing, 2 = Completed |
| 8 | txResultCode | long | - | Result code of submission |
| 9 | txStartDT | String | 14 |
Start date of submission process
└ Format : yyyyMMddHHmmss |
| 10 | txEndDT | String | 14 |
End date of submission process
└ Format : yyyyMMddHHmmss |
| 11 | receiptDT | String | 14 |
Date of receipt
└ Format : yyyyMMddHHmmss |
| 12 | issueResult | List<BulkCashbillIssueResult> | Returned when {@no.7 txState} is changed to 2 | |
| 13 | receiptID | String | 36 |
Receipt ID
└ assigned by POPBiLL when the receipt is processed |
| No. | Name | Type | Length | Description |
|---|---|---|---|---|
| 1 | code | long | - | Response code for API processing |
| 2 | mgtKey | String | 24 | Cashbill ID |
| 3 | confirmNum | String | 9 | NTS Confirm Number
└ POPBiLL assigns when e-Cashbill is issued |
| 4 | tradeDate | String | 8 | (used in old version) Date of trading (Format : yyyyMMdd) |
| 5 | issueDT | String | 14 |
Date and Time of issuance
└ Format : yyyyMMddHHmmss |
| No. | Name | Type | Length | Description |
|---|---|---|---|---|
| 1 | code | String | - | Response code for API processing |
| 2 | message | String | - | Response message for API processing |
| 3 | total | String | - | The total number of search results |
| 4 | perPage | String | - | The number of search result per page |
| 5 | pageNum | String | - | Page Number |
| 6 | pageCount | String | - | The number of |
| 7 | list | List<CashbillInfo> |
[LIst] e-Cashbill status/summarized information (Maximum : 1,000 cashbills)
└ The configuration is same as a return value of [2.1. GetInfo] |
|
| No. | Name | Type | Length | Description |
|---|---|---|---|---|
| 1 | itemKey | String | 18 | POPBiLL Cashbill ID |
| 2 | mgtKey | String | 24 | Cashbill ID |
| 3 | tradeDate | String | 8 | (used in old version) The date of trading
└ Format : yyyyMMdd |
| 4 | tradeDT | String | 14 |
The date and time of trading
└ Format : yyyyMMddHHmmss |
| 5 | tradeType | String | 4 | Document Type
└ Valid Value : 승인거래 / 취소거래 └ 승인거래 = Approval(General), 취소거래 = Revocation(Cancellation) |
| 6 | tradeUsage | String | 5 | Issuance Purpose
└ Valid Value : 소득공제용 / 지출증빙용 └ 소득공제용 = To deduct income tax, 지출증빙용 = To proof the expenditure in business |
| 7 | tradeOpt | String | 4 | Trade Type
└ Valid Value : 일반 / 도서공연 / 대중교통 └ 일반 = General, 도서공연 = Book and Performance, 대중교통 = Public Transportation |
| 8 | taxationType | String | 3 | Taxation Type
└ Valid Value : 과세 / 비과세 └ 과세 = Taxable, 비과세 = Non-taxable |
| 9 | totalAmount | String | 9 | Total Amount |
| 10 | issueDT | String | 14 | Date and Time of issuance
└ Format : yyyyMMddHHmmss |
| 11 | regDT | String | 14 | Date and Time of registration as a draft
└ Format : yyyyMMddHHmmss |
| 12 | stateMemo | String | 200 | Memo about status |
| 13 | stateCode | int | 3 |
Status Code
└ Valid Value : 300 / 304 / 305 └ 300 : Issued , 304 : Succeed , 305 : Failed |
| 14 | stateDT | String | 14 | Date and Time of Status Change
└ Format : yyyyMMddHHmmss |
| 15 | identityNum | String | 19 |
Customer Identification Number
└ Case1. {@no.6 tradeUsage} = ‘소득공제용’(To deduct income tax) : Resident Registration Number / Mobile / (e-Cashbill) Card Number / 010-000-1234(for voluntary issuance) └ Case2. {@no.6 tradeUsage} = ‘지출증빙용’(To proof the expenditure in business) : Business Registration Number / Resident Registration Number / Mobile / (e-Cashbill) Card Number └ Do not enter hyphen('-') |
| 16 | itemName | String | 70 | Item Name |
| 17 | customerName | String | 70 | Customer Name |
| 18 | confirmNum | String | 9 | NTS Confirm Number
└ POPBiLL assigns when e-Cashbill is issued |
| 19 | orgConfirmNum | String | 9 | NTS Confirm Number of the Original |
| 20 | orgTradeDate | String | 8 | Trade Date of the Original |
| 21 | ntssendDT | String | 14 | Date and Time of Filing to NTS
└ Format : yyyyMMddHHmmss |
| 22 | ntsresultDT | String | 14 | Date and Time of Receiving Filing Result
└ Format : yyyyMMddHHmmss |
| 23 | ntsresultCode | String | 4 | Result code of filing to NTS
└ [Reference] Result code of filing to NTS |
| 24 | ntsresultMessage | String | 30 | Result message of filing to NTS |
| 25 | printYN | boolean | - | Whether user print the e-Cashbill or not
└true = print, false = not print |