POPBill Developers
API Reference
e-Commercial Invoice
API Reference e-Commercial Invoice Webhook Event

Webhook Event

Webhook Header

Field Mandatory Description Example
Pb-Webhook-Type Y Webhook type STATEMENT.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 / Cancel / OPEN

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

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

Event Type Description
Issue a seller issues an invoice
Cancel a seller cancels the issuance of an invoice
OPEN a receiver clicks the ‘전자명세서 보기(view the invoice)’ button on the notification mail

Issuance

This Event will be initiated when a seller issues an invoice.

Event body
No. Field Type Length Mandatory Description
corpNum string 10 Y [Seller] business registration number
itemKey string 18 Y POPBiLL ID
POPBiLL automatically assigns this value when issuing an invoice
invoiceNum string 24 Y Confirmation number
POPBiLL automatically assigns this value when issuing an invoice
stateCode string 3 Y Status code
[Status Code for invoice]
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
a unique value that can be entered with alphanumeric values and special characters(‘-’, ‘_’)
eventDT string 14 Y Date and time of the initiation of an Event
format : yyyyMMddHHmmss
eventType string 30 Y Event type
Issueissuance of an invoice
itemCode number 3 Y Type of invoice
121transaction details
122bill
123estimate
124purchase order
125deposit slip
126receipt
interOPYN boolean - Y Whether e-Tax invoice is issued by API or not
trueissued via API
falseissued via POPBiLL service website
stateMemo string 200 N Memo about status information
Example of Event
{
  "corpNum": "1234567890",
  "itemKey": "022111416074100001",
  "invoiceNum": "123456789020221114000001",
  "stateCode": 300,
  "stateDT": "20221114160743",
  "issueDT": "20221114160743",
  "eventDT": "20221114160743",
  "eventType": "Issue",
  "itemCode": 121,
  "interOPYN": false
}

Issuance Cancelled

This Event will be initiated when a seller cancels the issuance of an invoice.

Event body
No. Field Type Length Mandatory Description
corpNum string 10 Y [Seller] business registration number
itemKey string 18 Y POPBiLL ID
POPBiLL automatically assigns this value when issuing an invoice
invoiceNum string 24 Y Confirmation number
POPBiLL automatically assigns this value when issuing an invoice
stateCode string 3 Y Status code
[Status Code for invoice]
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
a unique value that can be entered with alphanumeric values and special characters(‘-’, ‘_’)
eventDT string 14 Y Date and time of the initiation of an Event
format : yyyyMMddHHmmss
eventType string 30 Y Event type
Cancelcancel the issuance of an invoice
itemCode number 3 Y Type of invoice
121transaction details
122bill
123estimate
124purchase order
125deposit slip
126receipt
interOPYN boolean - Y Whether e-Tax invoice is issued by API or not
trueissued via API
falseissued via POPBiLL service website
stateMemo string 200 N Memo about status information
Example of Event
{
  "corpNum": "1234567890",
  "itemKey": "022111416205800001",
  "invoiceNum": "123456789020221114000002",
  "stateCode": 500,
  "stateDT": "20221114162103",
  "issueDT": "20221114162100",
  "eventDT": "20221114162103",
  "eventType": "Cancel",
  "itemCode": 121,
  "interOPYN": false
}

Check the Notification Mail

This Event will be initiated when a receiver clicks the ‘전자명세서 보기(view the invoice)’ button on the notification mail.

Event body
No. Field Type Length Mandatory Description
corpNum string 10 Y [Seller] business registration number
itemKey string 18 Y POPBiLL ID
POPBiLL automatically assigns this value when issuing an invoice
invoiceNum string 24 Y Confirmation number
POPBiLL automatically assigns this value when issuing an invoice
stateCode string 3 Y Status code
[Status Code for invoice]
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
a unique value that can be entered with alphanumeric values and special characters(‘-’, ‘_’)
eventDT string 14 Y Date and time of the initiation of an Event
format : yyyyMMddHHmmss
eventType string 30 Y Event type
OPENa buyer opens a notification mail
itemCode number 3 Y Type of invoice
121transaction details
122bill
123estimate
124purchase order
125deposit slip
126receipt
interOPYN boolean - Y Whether e-Tax invoice is issued by API or not
trueissued via API
falseissued via POPBiLL service website
stateMemo string 200 N Memo about status information
Example of Event
{
  "corpNum": "1234567890",
  "itemKey": "022111416074100001",
  "invoiceNum": "123456789020221114000001",
  "stateCode": 300,
  "stateDT": "20221114160743",
  "issueDT": "20221114160743",
  "eventDT": "20221114161852",
  "eventType": "OPEN",
  "itemCode": 121,
  "interOPYN": false
}