Check the result
1. Search - Check the result of the data crawling
- This API checks the crawled sales/purchase cash receipts with an active JobID request that is validated via [GetJobState – Check the data crawling status] API.
HTCashbillSearchResult search(String CorpNum, String JobID, String[] TradeUsage, String[] TradeType, Integer Page, Integer PerPage, String Order, String UserID) throws PopbillException
- We recommend to use this API when a user implements the list of sales/purchase cash receipts with items related to the page (variables : Page, perPage, Order).
Parameters
Parameters
| No. | Field | Type | Length | Mandatory | Description |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y |
Business registration number
10-digits except (‘-’)
|
|
| JobID | String | 18 | Y |
Request ID(JobID)
returned value of [RequestJob – Request for data crawling] API
|
|
| TradeUsage | String[ ] | N |
Purpose of issuance (multiple choice is possible)
Pincome deduction usage
Cproof of purchase usage
search all if not entered
|
||
| TradeType | String[ ] | N |
Type of cash receipt (multiple choice is possible)
Ngeneral cash receipt
Ccash receipt for revocation
search all if not entered
|
||
| Page | Integer | - | N |
Page number of a list of cash receipts.
default : 1
|
|
| PerPage | Integer | - | N |
The number of list to be displayed per page
default : 500
maximum : 1,000
|
|
| Order | String | 1 | N |
Sort order related to the value of {Dtype}
Ddescending (default)
Aascending
|
|
| UserID | String | 50 | N | User’s POPBiLL ID | |
Return
HTCashbillSearchResult
| No. | Field | Type | Length | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | long | - | API response code | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| message | String | - | API response message | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| total | long | - | Total number of search results | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| perPage | long | - | Number of search result per page | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| pageNum | long | - | Page number | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| pageCount | long | - | Number of pages | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| list | List<HTCashbill> |
Summarized information of cash receipts
maximum : 1,000 cash receipts
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HTCashbill
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. Summary - Check the summarized information for the data crawling result
-
This API checks the summarized information of crawled sales/purchase cash receipts with an active JobID request that is validated via [GetJobState – Check the data crawling status] API.
※ content of information : number of crawled cash receipts, total amount of supplyCost, tax, serviceFee, and totalAmount
HTCashbillSummary summary(String CorpNum, String JobID, String[] TradeUsage, String[] TradeType, String UserID) throws PopbillException
Parameters
Parameters
| No. | Field | Type | Length | Mandatory | Description |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y |
Business registration number
10-digits except (‘-’)
|
|
| JobID | String | 18 | Y |
Request ID(JobID)
returned value of [RequestJob – Request for data crawling] API
|
|
| TradeUsage | String[ ] | N |
Purpose of issuance (multiple choice is possible)
Pincome deduction usage
Cproof of purchase usage
search all if not entered
|
||
| TradeType | String[ ] | N |
Type of cash receipt (multiple choice is possible)
Ngeneral cash receipt
Ccash receipt for revocation
search all if not entered
|
||
| UserID | String | 50 | N | User’s POPBiLL ID | |
Return
HTCashbillSummary
| No. | Field | Type | Length | Description |
|---|---|---|---|---|
| count | long | - | Number of crawled cash receipts | |
| supplyCostTotal | long | 18 | Sum of supply values | |
| taxTotal | long | 18 | Sum of tax amount | |
| serviceFeeTotal | long | 18 | Sum of service fee | |
| amountTotal | long | 18 | Total amount |
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 |

