POPBill Developers
API Reference

1. 전자명세서 발행

1.1. RegistIssue - 즉시 발행

  • 작성된 전자명세서 데이터를 팝빌에 저장과 동시에 발행하여, "발행완료" 상태로 처리합니다.
  • 팝빌 사이트 [전자명세서] > [환경설정] > [전자명세서 관리] 메뉴의 발행시 자동승인 옵션 설정을 통해 전자명세서를 "발행완료" 상태가 아닌 "승인대기" 상태로 발행 처리 할 수 있습니다.
statementService.function(CorpNum, Statement, Memo, UserID, EmailSubject, success, error)
  • 전자명세서 즉시 발행 함수 호출시 포인트가 과금되며, 수신자에게 발행 안내 메일이 발송됩니다.
Parameters
순번변수명타입길이필수설명
CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
Statement Statement - O 전자명세서 객체정보
Memo string 200 - 전자명세서 상태 이력을 관리하기 위한 메모
UserID string 50 - 팝빌회원 아이디
EmailSubject string 300 - 전자명세서 발행 안내메일 제목
※ 미입력시 팝빌에서 지정한 이메일 제목으로 전송
success function - O 성공에 대한 콜백 함수
error function - O 실패에 대한 콜백 함수
Return

IssueResponse

Throws

PopbillException

1.2. Register - 임시저장

  • 작성된 전자명세서 데이터를 팝빌에 저장합니다.
  • "임시저장" 상태의 전자명세서는 [Issue - 발행] 함수를 호출하여 "발행완료" 처리한 경우에만 수신자에게 발행 안내 메일이 발송됩니다.
statementService.register(CorpNum, Statement, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
Statement Statement - O 전자명세서 객체정보
UserID string 50 - 팝빌회원 아이디
success function - O 성공에 대한 콜백 함수
error function - O 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

1.3. Update - 수정

  • "임시저장" 상태의 전자명세서를 수정합니다.
statementService.update(CorpNum, ItemCode, MgtKey, Statement, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
ItemCode number 3 O 전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1
└ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
MgtKey string 24 O 파트너가 할당한 문서번호
Statement Statement - O 전자명세서 객체정보
UserID string 50 - 팝빌회원 아이디
success function - O 성공에 대한 콜백 함수
error function - O 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

1.4. Issue - 발행

  • "임시저장" 상태의 전자명세서를 발행하여, "발행완료" 상태로 처리합니다.
  • 팝빌 사이트 [전자명세서] > [환경설정] > [전자명세서 관리] 메뉴의 발행시 자동승인 옵션 설정을 통해 전자명세서를 "발행완료" 상태가 아닌 "승인대기" 상태로 발행 처리 할 수 있습니다.
statementService.issue(CorpNum, ItemCode, MgtKey, Memo, EmailSubject, UserID, success, error)
  • 전자명세서 발행 함수 호출시 포인트가 과금되며, 수신자에게 발행 안내 메일이 발송됩니다.
Parameters
순번변수명타입길이필수설명
CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
ItemCode number 3 O 전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1
└ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
MgtKey string 24 O 파트너가 할당한 문서번호
Memo string 200 - 메모, 상태확인(GetInfo API) stateMemo(상태메모) 확인 가능
EmailSubject string 300 - 전자명세서 발행 안내메일 제목
※ 미입력시 팝빌에서 지정한 이메일 제목으로 전송
UserID string 50 - 팝빌회원 아이디
success function - O 성공에 대한 콜백 함수
error function - O 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

1.5. Cancel - 발행취소

  • 발신자가 발행한 전자명세서를 발행취소합니다.
  • "발행취소" 상태의 전자명세서를 삭제하면, 전자명세서 관리를 위해 부여했던 문서번호를 재사용 할 수 있습니다.
statementService.cancel(CorpNum, ItemCode, MgtKey, Memo, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
ItemCode number 3 O 전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1
└ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
MgtKey string 24 O 파트너가 할당한 문서번호
Memo string 200 - 전자명세서 상태 이력을 관리하기 위한 메모
UserID string 50 - 팝빌회원 아이디
success function - O 성공에 대한 콜백 함수
error function - O 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException

1.6. Delete - 삭제

  • 삭제 가능한 상태의 전자명세서를 삭제합니다.

    ※ 삭제 가능한 상태: "임시저장", "취소", "승인거부", "발행취소"

statementService.delete(CorpNum, ItemCode, MgtKey, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10자리)
ItemCode number 3 O 전자명세서 문서유형 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1
└ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
MgtKey string 24 O 파트너가 할당한 문서번호
UserID string 50 - 팝빌회원 아이디
success function - O 성공에 대한 콜백 함수
error function - O 실패에 대한 콜백 함수
Return

Response

Throws

PopbillException