POPBill Developers
가이드

Webhook 발행 이벤트

Webhook Header

필드명 설명 필수 예시
Pb-Webhook-Type Webhook 유형 Y STATEMENT.STATE
Pb-Webhook-MID 이벤트 식별값 Y 016120000002-1777d55c2c41492ab06826d
Pb-Webhook-Corpnum 팝빌 사업자번호 Y 6798700433
Content-Type Webhook 메시지 Body 타입 Y application/json
Authorization Base64 인코딩한 BASIC 인증정보 N Basic VEVTVDoxMjM=
└ HTTP 인증 사용하는 경우 추가 항목
X-Api-Key API Key 인증정보 N TESTAPIKEY
└ HTTP 인증 사용하는 경우 추가 항목
Pb-Webhook-EventType Webhook 메시지 Event 타입N이벤트 유형
└ Issue / Cancel / OPEN

팝빌은 기본으로 제공되는 Header 필드 외 프로그램 공급사 운영환경에 맞춘 커스텀 필드 지원이 가능합니다.
커스텀 필드 추가가 필요한 경우 기술지원센터(1600-9854)로 문의주시기 바랍니다.

Webhook Body

필드명 타입 길이 필수 비고
corpNum String 10 Y 발행자 사업자번호
itemKey String 18 Y 팝빌번호 (팝빌에서 자동부여)
invoiceNum String 24 Y 팝빌에서 부여한 고유번호
stateCode String 3 Y 상태코드
└ ※ 전자명세서 상태 값은 작아지지 않음
[참고] 전자명세서 상태코드
stateDT String 14 Y 상태 변경일시 (형식 : yyyyMMddHHmmss)
issueDT String 14 Y 발행일시 (형식 : yyyyMMddHHmmss)
mgtKey String 24 N 파트너가 부여한 문서번호
eventDT String 14 Y 이벤트 실행일시 (형식 : yyyyMMddHHmmss)
eventType String 30 Y 이벤트 유형 : "Issue" / "Cancel" / "OPEN" 중 반환
└ "Issue" : 발행
└ "Cancel" : 발행취소
└ "OPEN" : 개봉
itemCode Number 3 Y 전자명세서 구분 : 121 / 122 / 123 / 124 / 125 / 126 중 반환
└ 121 : 거래명세서
└ 122 : 청구서
└ 123 : 견적서
└ 124 : 발주서
└ 125 : 입금표
└ 126 : 영수증
interOPYN Boolean - Y 연동문서 여부 : true / false 중 반환
└ true : API로 발행한 연동문서
└ false : 팝빌 사이트에서 발행한 일반문서
stateMemo String 200 N 상태메모

이벤트 예시

  • 발행

    발신자가 전자명세서를 작성하여 발행을 완료한 시점에 실행됩니다.

    {
        "corpNum": "1234567890",
        "itemKey": "022111416074100001",
        "invoiceNum": "123456789020221114000001",
        "stateCode": 300,
        "stateDT": "20221114160743",
        "issueDT": "20221114160743",
        "eventDT": "20221114160743",
        "eventType": "Issue",
        "itemCode": 121,
        "interOPYN": false
    }
  • 발행취소

    발신자가 전자명세서를 발행취소한 시점에 실행됩니다.

    {
        "corpNum": "1234567890",
        "itemKey": "022111416205800001",
        "invoiceNum": "123456789020221114000002",
        "stateCode": 500,
        "stateDT": "20221114162103",
        "issueDT": "20221114162100",
        "eventDT": "20221114162103",
        "eventType": "Cancel",
        "itemCode": 121,
        "interOPYN": false
    }
  • 발행 안내 메일 확인

    수신자가 발행 안내 메일의 '전자명세서 보기' 버튼을 클릭하는 시점에 실행됩니다.

    {
        "corpNum": "1234567890",
        "itemKey": "022111416074100001",
        "invoiceNum": "123456789020221114000001",
        "stateCode": 300,
        "stateDT": "20221114160743",
        "issueDT": "20221114160743",
        "eventDT": "20221114161852",
        "eventType": "OPEN",
        "itemCode": 121,
        "interOPYN": false
    }