POPBill Developers
SDK Reference
Cash Receipt
Java
SDK Reference Cash Receipt Java Webhook Event

Webhook Event

Webhook Header

Field Mandatory Description Example
Pb-Webhook-Type Y Webhook type CASHBILL.STATE
Pb-Webhook-MID Y Identification value for Event 016120000002-1777d55c2c41492ab06826d
Pb-Webhook-Corpnum Y POPBiLL business registration number 6798700433
Content-Type Y Body type for Webhook message application/json
Authorization N Based 64-encoded BASIC authentication information Basic VEVTVDoxMjM=
└ additional item if using HTTP authentication
X-Api-Key N API Key authentication information TESTAPIKEY
└ additional item if using HTTP authentication
Pb-Webhook-EventType N Event type of Webhook message Event type
└ Issue / NTS

Depending on the partner’s operational environment, POPBiLL additionally provides custom field other than the default Header field. If you need to request one, please contact the partner center.

Docs State - Single

This Event will be initiated when a seller issues a cash receipt.
Each event time can be checked [How to Issue].

Event Type Description
Issue a seller issues a cash receipt
NTS the status of a document changes into 304 (succeeded) and 305(failed)

Issuance

This Event will be initiated when a seller issues a cash receipt.

Event body
No. Field Type Length Mandatory Description
corpNum string 10 Y Business registration number
entered when registering a bulk submission
franchiseCorpNum string 10 Y Business registration number
itemKey string 18 Y Identification number assigned by POPBiLL for internal management
tradeDate string 8 Y Date of trade
format : yyyyMMdd
confirmNum string 9 Y NTS confirmation number
ntssendDT string 14 N Date and time of the NTS filing
format : yyyyMMddHHmmss
ntsresultDT string 14 N Date and time of receiving NTS filing result
format : yyyyMMddHHmmss
ntsresultCode string 4 N NTS filing result code
[ntsresultCode]
stateCode number 3 Y Status code
[stateCode]
stateDT string 14 Y Date and time of the status change
format : yyyyMMddHHmmss
issueDT string 14 Y Date and time of issuance
format : yyyyMMddHHmmss
mgtKey string 24 N [Seller] document ID
eventDT string 14 Y Date and time of the initiation of an Event
format : yyyyMMddHHmmss
eventType string 30 Y Event type
Issue
interOPYN boolean - Y Whether e-Tax invoice is issued by API or not
trueissued via API
falseissued via POPBiLL service website
Example of Event
{
  "corpNum": "1234567890",
  "franchiseCorpNum": "1234567890",
  "itemKey": "022122116193800001",
  "tradeDate": "20221221",
  "confirmNum": "TB0001147",
  "stateCode": 300,
  "stateDT": "20221221161938",
  "issueDT": "20221221161938",
  "mgtKey": "2021121-002",
  "eventDT": "20221221161938",
  "eventType": "Issue",
  "interOPYN": true
}

NTS Filing Status

This Event will be initiated when the status of a document changes into 304 (succeeded), 305(failed).

Event body
No. Field Type Length Mandatory Description
corpNum string 10 Y Business registration number
entered when registering a bulk submission
franchiseCorpNum string 10 Y Business registration number
itemKey string 18 Y Identification number assigned by POPBiLL for internal management
tradeDate string 8 Y Date of trade
format : yyyyMMdd
confirmNum string 9 Y NTS confirmation number
ntssendDT string 14 N Date and time of the NTS filing
format : yyyyMMddHHmmss
ntsresultDT string 14 N Date and time of receiving NTS filing result
format : yyyyMMddHHmmss
ntsresultCode string 4 N NTS filing result code
[ntsresultCode]
stateCode number 3 Y Status code
[stateCode]
stateDT string 14 Y Date and time of the status change
format : yyyyMMddHHmmss
issueDT string 14 Y Date and time of issuance
format : yyyyMMddHHmmss
mgtKey string 24 N [Seller] document ID
eventDT string 14 Y Date and time of the initiation of an Event
format : yyyyMMddHHmmss
eventType string 30 Y Event type
NTS
interOPYN boolean - Y Whether e-Tax invoice is issued by API or not
trueissued via API
falseissued via POPBiLL service website
Example of Event
{
  "corpNum": "1234567890",
  "franchiseCorpNum": "1234567890",
  "itemKey": "022122116191200001",
  "tradeDate": "20221221",
  "confirmNum": "TB0001146",
  "ntssendDT": "20221222000000",
  "ntsresultDT": "20221222100033",
  "ntsresultCode": "0000",
  "stateCode": 304,
  "stateDT": "20221221161912",
  "issueDT": "20221221161912",
  "mgtKey": "20221221-001",
  "eventDT": "20221222100033",
  "eventType": "NTS",
  "interOPYN": true
}

Docs State - Bulk

This Event will be initiated when a seller issues bulk cash receipts.
Each event time can be checked [Bulk Issuance].

Event Type Description
BULK.RESULT a seller completes the bulk submission request
NTS the status of a document changes into 304 (succeeded) and 305(failed)

Submission Result

This Event will be initiated when a seller completes the bulk submission request.

Event body
No. Field Type Length Mandatory Description
corpNum string 10 Y Business registration number
entered when registering a bulk submission
submitID string 36 Y Submission ID
assigned by a program provider/partner
receiptID string 36 Y Receipt ID
POPBiLL automatically assigns when submission is processed
receiptDT string 14 Y Date and time of the submission
format : yyyyMMddHHmmss
eventType string - Y Type of Event
BULK.RESULT
eventDT string 14 Y Date and time of the initiation of an Event
format : yyyyMMddHHmmss
submitCount number - Y Number of cash receipt submissions
successCount number - Y Number of succeeded cash receipt issuance
failCount number - Y Number of failed cash receipt issuance
txState number 1 Y Submission status
0 submitted
1 in progress
2 completed
txResultCode number - N Submission result code
txStartDT string 14 N Start date and time of submission process
format : yyyyMMddHHmmss
txEndDT string 14 N End date and time of submission process
format : yyyyMMddHHmmss
issueResult array 100 N Issuance result
issueResult
No. Field Type Length Mandatory Description
code number - Y API response code
returns 1 if the process result is successful
returns error code( 8 digits that start with “-”) if the process result is failed
message string - N API response message
confirmNum string 9 N NTS confirmation number
assigned automatically by POPBiLL when issuing a cash receipt
tradeDate string 8 N Date of trade
format : yyyyMMdd
issueDT string 14 N Date and time of issuance
format : yyyyMMddHHmmss
mgtKey string 24 N Document ID
assigned by a program provider/partner
Example of Event
{
  "corpNum": "1234567890",
  "submitID": "20221013-TEST-2",
  "receiptID": "0221013-4e1a30b927ab4f88ad3d3f4a7ed9",
  "receiptDT": "20221013154838",
  "eventType": "BULK.RESULT",
  "eventDT": "20221013154839",
  "submitCount": 5,
  "successCount": 5,
  "failCount": 0,
  "txState": 2,
  "txResultCode": 1,
  "txStartDT": "20221013154839",
  "txEndDT": "20221013154839",
  "issueResult":
    [
      {
        "code": 1,
        "issueDT": "20221013154839"
        "ntsconfirmNum": "202210138888888800000068",
        "invoicerMgtKey": "20221013-TEST-2-0",
      },
      {
        "code": 1,
        "issueDT": "20221013154839"
        "ntsconfirmNum": "202210138888888800000069",
        "invoicerMgtKey": "20221013-TEST-2-1",
      },
      ...
    ]
}

NTS Filing Result

This Event will be initiated when the NTS filing process is completed for the bulk submission. The list of up to 500 invoices will be processed sequentially.

Event body
No. Field Type Length Mandatory Description
header object - Y header
header
No. Field Type Length Mandatory Description
QMNum string 24 Y NTS confirmation number
POPBiLL automatically assigns this when issuing a cash receipt
CORPNUM string 10 Y business registration number of a seller
TYPE string - Y Webhook type
CASHBILL.STATE
body object - Y body
body
No. Field Type Length Mandatory Description
corpNum string 10 Y Business registration number
entered when registering a bulk submission
itemKey string 18 Y Document ID
POPBiLL automatically assigns this when issuing a cash receipt
confirmNum string 24 Y NTS confirmation number
ntssendDT string 14 N Date and time of the NTS filing
format : yyyyMMddHHmmss
ntsresultDT string 14 N Date and time of receiving NTS filing result
format : yyyyMMddHHmmss
ntsresultCode string - N NTS filing result code
[ntsresultCode]
stateCode number 3 Y Status code
[stateCode]
stateDT string 14 Y Date and time of the status change
format : yyyyMMddHHmmss
issueDT string 14 Y Date and time of issuance
format : yyyyMMddHHmmss
mgtKey string 24 N Document ID
assigned by a program provider/partner when issuing a cash receipt
eventDT string 14 Y Date and time of the initiation of an Event
format : yyyyMMddHHmmss
eventType string 30 Y Event type
NTS
interOPYN boolean - Y Whether cash receipt is issued by API or not
trueissued via API
falseissued via POPBiLL service website
Example of Event
[
  {
    "header": {
      "QMNum": "TB0000045",
      "CORPNUM": "1234567890",
      "TYPE": "CASHBILL.STATE"
    },
    "body": {
      "corpNum": "1234567890",
      "itemKey": "022110814151400002",
      "confirmNum": "TB0000045",
      "ntssendDT": "20221109000207",
      "ntsresultDT": "20221109100017",
      "ntsresultCode": "0000",
      "ntsresultMessage": "더미승인",
      "stateCode": 304,
      "stateDT": "20221108141514",
      "issueDT": "20221108141514",
      "mgtKey": "20221108-JSP-BULK-2",
      "eventDT": "20221109100017",
      "eventType": "NTS",
      "interOPYN": true
    }
  },
  {
    "header": {
      "QMNum": "TB0000044",
      "CORPNUM": "1234567890",
      "TYPE": "CASHBILL.STATE"
    },
    "body": {
      "corpNum": "1234567890",
      "itemKey": "022110814151400001",
      "confirmNum": "TB0000044",
      "ntssendDT": "20221109000207",
      "ntsresultDT": "20221109100017",
      "ntsresultCode": "0000",
      "ntsresultMessage": "더미승인",
      "stateCode": 304,
      "stateDT": "20221108141514",
      "issueDT": "20221108141514",
      "mgtKey": "20221108-JSP-BULK-1",
      "eventDT": "20221109100017",
      "eventType": "NTS",
      "interOPYN": true
    }
  },
  {
    "header": {
      "QMNum": "TB0000048",
      "CORPNUM": "1234567890",
      "TYPE": "CASHBILL.STATE"
    },
    "body": {
      "corpNum": "1234567890",
      "itemKey": "022110814151400005",
      "confirmNum": "TB0000048",
      "ntssendDT": "20221109000207",
      "ntsresultDT": "20221109100017",
      "ntsresultCode": "0000",
      "ntsresultMessage": "더미승인",
      "stateCode": 304,
      "stateDT": "20221108141514",
      "issueDT": "20221108141514",
      "mgtKey": "20221108-JSP-BULK-5",
      "eventDT": "20221109100017",
      "eventType": "NTS",
      "interOPYN": true
    }
  }
]