POPBill Developers
API Reference
NTS Crawling
API Reference NTS Crawling Webhook Event

Webhook Event

Webhook Header

Field Mandatory Description Example
Pb-Webhook-Type Y Webhook type HT.TAXINVOICEXML
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

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.

Data Crawl

This Event will be initiated when POPBiLL automatically sends the crawled data to the registered CallBack URL at every 1 hour(at the exact hour).
Each event time can be checked [Data Crawling].

Event Type Description
HTTaxinvoice POPBiLL automatically sends the crawled data to the registered CallBack URL at every 1 hour(at the exact hour)

Sales/Purchase e-Tax Invoice Crawling Job

This Event will be initiated when POPBiLL automatically sends the crawled data to the registered CallBack URL at every 1 hour(at the exact hour).

Event body
No. Field Type Length Mandatory Description
writeDate string 8 Y Date of preparation
format : yyyyMMdd
ntsconfirmNum string 24 Y NTS confirmation number
issueDT string 14 Y Date and time of issuance
format : yyyyMMddHHmmss
sendDate string 8 Y Date of filing
format : yyyyMMdd
invoiceType number 3 Y Types of e-Tax invoice
101general tax invoice
102zero-rated tax invoice
103consigned tax invoice
104import tax invoice
105consigned tax invoice(zero-rated)
201[revised] invoice
202[revised] invoice(zero-rated)
203[revised] invoice(consigned)
204[revised] invoice(import)
205[revised] invoice(zero-rated, consigned)
301general invoice(tax exemption)
303consigned invoice(tax exemption)
304import invoice(tax exemption)
401[revised] general invoice(tax exemption)
403[revised] consigned invoice(tax exemption)
404[revised] import invoice(tax exemption)
taxType string 2 Y Taxation type
과세taxable
영세zero-rated
면세exempted
taxTotal string 18 Y Sum of tax amount
supplyCostTotal string 18 Y Sum of supply values
totalAmount string 18 Y Total amount
purposeType string 2 Y Payments received or not
영수payment received
청구payment not received
없음none
serialNum string 30 N Serial number
cash string 18 N Cash
chkBill string 18 N Check
credit string 18 N Credit
note string 18 N Note
remark1 string 150 Conditional Remark 1
foreigner registration number
passport number
mandatory if the invoiceeType is “외국인”(foreigner)
remark2 string 150 N Remark 2
remark3 string 150 N Remark 3
invoicerCorpNum string 10 Y [Seller] business registration number
invoicerMgtKey string 24 Conditional [Seller] document ID
Mandatory field for general invoice
invoicerTaxRegID string 4 N [Seller] identification number of a branch place
4-digits
invoicerCorpName string 200 Y [Seller] company name
invoicerCEOName string 100 Y [Seller] CEO name
invoicerAddr string 300 N [Seller] company address
invoicerBizType string 100 N [Seller] type of business
invoicerBizClass string 100 N [Seller] items of business
invoicerContactName string 100 N [Seller] name of the person in charge
invoicerDeptName string 100 N [Seller] department of the person in charge
invoicerTEL string 20 N [Seller] cell phone number of the person in charge
invoicerEmail string 100 N [Seller] email of the person in charge
invoiceeCorpNum string 10 Y [Seller] business registration number
invoiceeType string 3 Y [Buyer] type of customer
사업자business proprietor
개인individual
외국인foreigner
invoiceeMgtKey string 24 Conditional [Buyer] document ID
invoiceeTaxRegID string 4 N [Buyer] identification number of a branch place
4 digits
invoiceeCorpName string 200 Y [Buyer] company name
invoiceeCEOName string 100 Y [Buyer] CEO name
invoiceeAddr string 300 N [Buyer] company address
invoiceeBizType string 100 N [Buyer] type of business
invoiceeBizClass string 100 N [Buyer] items of business
invoiceeContactName1 string 100 N [Buyer] name of the primary person in charge
invoiceeDeptName1 string 100 N [Buyer] department of the primary person in charge
invoiceeTEL1 string 20 N [Buyer] contact number of the primary person in charge
invoiceeEmail1 string 100 N [Buyer] email of the primary person in charge
invoiceeContactName2 string 100 N [Buyer] name of the secondary person in charge
invoiceeDeptName2 string 100 N [Buyer] department of the secondary person in charge
invoiceeTEL2 string 20 N [Buyer] contact number of the secondary person in charge
invoiceeEmail2 string 100 N [Buyer] email of the secondary person in charge
trusteeCorpNum string 10 Conditional [Consignee] business registration number
Mandatory field for consigned invoice
trusteeMgtKey string 24 Conditional [Consignee] document ID
Mandatory field for consigned invoice
trusteeTaxRegID string 4 N [Consignee] identification number of a branch place
trusteeCorpName string 200 Conditional [Consignee] company name
Mandatory field for consigned invoice
trusteeCEOName string 100 Conditional [Consignee] CEO name
Mandatory field for consigned invoice
trusteeAddr string 300 N [Consignee] company address
trusteeBizType string 100 N [Consignee] type of business
trusteeBizClass string 100 N [Consignee] items of business
trusteeContactName string 100 N [Consignee] name of the person in charge
trusteeDeptName string 100 N [Consignee] department of the person in charge
trusteeTEL string 20 N [Consignee] contact number of the person in charge
trusteeEmail string 100 N [Consignee] email of the person in charge
modifyCode number 1 Conditional Reason for revocation
1correction of errors
2change in supply values
3return
4cancellation of contract
5post opening of local letter of credit
6duplicated issuance
returns when searching revised invoice types of e-Tax invoice
orgNTSConfirmNum string 24 Conditional NTS confirmation number of the original tax invoice
returns when searching revised invoice types of e-Tax invoice
detailList array 99 N Detailed list of items
detailList
No. Field Type Length Mandatory Description
serialNum number 2 Y Serial number
purchaseDT string 8 N Date of trade
format : yyyyMMdd
itemName string 100 N Item name
spec string 60 N Specification
qty string 12 N Quantity
unitCost string 18 N Unit price
supplyCost string 18 N Supply values
tax string 18 N Tax amount
remark string 100 N Remark
Example of Event
{
  "writeDate": "20221111",
  "sendDate": "20221111",
  "issueDT": "20221111112809",
  "invoiceType": 101,
  "taxType": "과세",
  "invoicerCorpNum": "6798700433",
  "invoicerCorpName": "(주)링크허브",
  "invoicerCEOName": "공급자 대표",
  "invoicerAddr": "Seller Address",
  "invoicerBizType": "공급자 업태",
  "invoicerBizClass": "공급자  종목",
  "invoicerContactName": "공급자  담당자 성명",
  "invoicerTEL": "공급자 담당자 연락처",
  "invoicerEmail": "공급자 담당자 이메일",
  "invoiceeCorpNum": "1234567890",
  "invoiceeType": "사업자",
  "invoiceeCorpName": "공급받는자 사업자",
  "invoiceeCEOName": "공급받는자 대표",
  "invoiceeAddr": "Buyer Address",
  "invoiceeBizType": "Buyer Business Type",
  "invoiceeBizClass": "공급받는자 종목",
  "invoiceeContactName1": "공급받는자 담당자 성명",
  "invoiceeEmail1": "공급받는자 담당자 이메일",
  "taxTotal": "20000",
  "supplyCostTotal": "200000",
  "totalAmount": "220000",
  "purposeType": "청구",
  "ntsconfirmNum": "202211114100020300000777",
  "detailList": [
    {
      "serialNum": 1,
      "purchaseDT": "20221111",
      "itemName": "테스트 결제",
      "supplyCost": "200000",
      "tax": "20000"
    }
  ]
}