연동매뉴얼

Index

1. 세금계산서 발행/전송

1.1. CheckMgtKeyInUse - 문서번호 사용 여부 확인

ㆍ파트너가 세금계산서 관리 목적으로 할당하는 문서번호의 사용여부를 확인합니다.

ㆍ이미 사용 중인 문서번호는 중복 사용이 불가하고, 세금계산서가 삭제된 경우에만 문서번호의 재사용이 가능합니다.

function CheckMgtKeyInUse(CorpNum : String; MgtKeyType:EnumMgtKeyType; MgtKey : String) : boolean

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 확인할 문서번호

Return

boolean - true : (사용중) / false : (미사용중)

Throws

EPopbillException

1.2. RegistIssue - 즉시 발행

ㆍ작성된 세금계산서 데이터를 팝빌에 저장과 동시에 발행(전자서명)하여 "발행완료" 상태로 처리합니다. [참고] 팝빌 국세청 전송 정책

ㆍ"발행완료"된 전자세금계산서는 국세청 전송 이전에 [1.6 CancelIssue – 발행취소] 함수로 국세청 신고 대상에서 제외할 수 있습니다.

※ [1.5. Register - 임시저장]와 [1.7. Issue - 발행] 함수 기능을 한 번의 프로세스로 처리합니다.

function RegistIssue(CorpNum : String; Taxinvoice : TTaxinvoice; writeSpecification : boolean = false; forceIssue : boolean = false; memo : String = ''; emailSubject : String = ''; dealInvoiceMgtKey : String = ''; UserID : String = '') : TIssueResponse
유의사항

ㆍ세금계산서 발행을 위해서 공급자의 인증서가 팝빌 인증서버에 사전등록 되어야 합니다.

※ 위수탁발행의 경우, 수탁자의 인증서 등록이 필요합니다.

ㆍ세금계산서 발행시 포인트가 과금되며, 공급받는자에게 발행 메일이 발송됩니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Taxinvoice TTaxinvoice - O 세금계산서 객체정보
3 writeSpecification boolean - - 거래명세서 동시작성 여부 : true (사용) / false (미사용) 중 택 1
4 forceIssue boolean - - 지연발행 가능여부 : true (가능) / false (불가능) 중 택 1
5 memo String 200 - 세금계산서 상태 이력을 관리하기 위한 메모
6 emailSubject String 300 - 세금계산서 발행 안내메일 제목
※ 미입력시 팝빌에서 설정한 기본값 사용
7 dealInvoiceMgtKey String 24 - {@no 3. WriteSpecification} = true 경우, 거래명세서 문서번호 할당
※ 미입력시 기본값 세금계산서 문서번호와 동일하게 할당
8 UserID String 50 - 팝빌회원 아이디

Return

TIssueResponse

Throws

EPopbillException

1.3. BulkSubmit - 초대량 발행 접수

ㆍ최대 100건의 세금계산서 발행을 한번의 요청으로 접수합니다.

function BulkSubmit(CorpNum : String; SubmitID : String; TaxinvoiceList : Array Of TTaxinvoice; forceIssue : boolean = false; UserID : String = '') : TBulkResponse;
유의사항

ㆍ세금계산서 발행을 위해서 공급자의 인증서가 팝빌 인증서버에 사전등록 되어야 합니다.

※ 위수탁발행의 경우, 수탁자의 인증서 등록이 필요합니다.

ㆍ세금계산서 발행시 포인트가 과금되며, 공급받는자에게 발행 메일이 발송됩니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 SubmitID String 36 O 제출아이디
└ 최대 36자리 영문, 숫자, '-' 조합으로 구성
3 taxinvoiceList Array Of TTaxinvoice 100 O [배열] 세금계산서 객체정보 목록
4 ForceIssue boolean - - 지연발행 가능여부 : true (가능) / false (불가능) 중 택 1
5 UserID String 50 - 팝빌회원 아이디

Return

TBulkResponse

Throws

EPopbillException

1.4. GetBulkResult - 초대량 접수결과 확인

ㆍ접수시 기재한 SubmitID를 사용하여 세금계산서 접수결과를 확인합니다.

ㆍ개별 세금계산서 처리상태는 접수상태(txState)가 완료(2) 시 반환됩니다.

function GetBulkResult(CorpNum : String; SubmitID : String; UserID : String = '') : TBulkTaxinvoiceResult;

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 SubmitID String 36 O 초대량 발행 접수시 기재한 제출아이디
3 UserID String 50 - 팝빌회원 아이디

Return

TBulkTaxinvoiceResult

Throws

EPopbillException

1.5. Register - 임시저장

ㆍ작성된 세금계산서 데이터를 팝빌에 저장합니다.

ㆍ"임시저장" 상태의 세금계산서는 [1.7. Issue - 발행]함수를 호출하여 "발행완료" 처리한 경우에만 국세청으로 전송됩니다.

function Register(CorpNum : String; Taxinvoice : TTaxinvoice; UserID : String = ''; writeSpecification : boolean = false) : TResponse
유의사항

ㆍ세금계산서 파일첨부 기능을 구현하는 경우, [1.5. Register – 임시저장] -> [4.3. AttachFile – 파일첨부] -> [1.7. Issue – 발행] 함수를 차례로 호출합니다.

ㆍ역발행 세금계산서를 저장하는 경우, 객체 'TTaxinvoice'의 변수 'chargeDirection' 값을 통해 과금 주체를 지정할 수 있습니다.

※ 정과금: 공급자 과금, 역과금: 공급받는자 과금

ㆍ임시저장된 세금계산서는 팝빌 사이트 '임시문서함'에서 확인 가능합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Taxinvoice TTaxinvoice - O 세금계산서 객체정보
3 UserID String 50 - 팝빌회원 아이디
4 writeSpecification boolean - - 거래명세서 동시작성 여부 : true (사용) / false (미사용) 중 택 1

Return

TResponse

Throws

EPopbillException

1.6. Update - 수정

ㆍ"임시저장" 상태의 세금계산서를 수정합니다.

function Update(CorpNum : String; MgtKeyType:EnumMgtKeyType; MgtKey : String; Taxinvoice : TTaxinvoice; UserID : String = ''; writeSpecification : boolean = false) : TResponse

ㆍ[2.1. GetInfo – 상태 확인] 또는 [2.2. GetInfos – 다수건 상태확인] 함수를 호출하여 세금계산서의 상태를 확인할 수 있습니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 Taxinvoice TTaxinvoice - O 수정사항이 반영된 세금계산서 객체정보
5 UserID String 50 - 팝빌회원 아이디
6 writeSpecification boolean - - 거래명세서 동시작성 여부 : true (사용) / false (미사용) 중 택 1

Return

TResponse

Throws

EPopbillException

1.7. Issue - 발행

ㆍ"임시저장" 또는 "(역)발행대기" 상태의 세금계산서를 발행(전자서명)하며, "발행완료" 상태로 처리합니다. [참고] 팝빌 국세청 전송 정책

ㆍ"발행완료"된 전자세금계산서는 국세청 전송 이전에 [1.6 CancelIssue – 발행취소] 함수로 국세청 신고 대상에서 제외할 수 있습니다.

function Issue(CorpNum : String; MgtKeyType:EnumMgtKeyType; MgtKey : String; Memo : String; EmailSubject : String; ForceIssue : Boolean; UserID : String = '') : TIssueResponse
유의사항

ㆍ세금계산서 발행을 위해서 공급자의 인증서가 팝빌 인증서버에 사전등록 되어야 합니다.

※ 위수탁발행의 경우, 수탁자의 인증서 등록이 필요합니다.

ㆍ세금계산서 발행시 포인트가 과금되며, 공급받는자에게 발행 메일이 발송됩니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 Memo String 200 - 세금계산서 상태 이력을 관리하기 위한 메모
5 EmailSubject String 300 - 세금계산서 발행 안내메일 제목
※ 미입력시 팝빌에서 설정한 기본값 사용
6 ForceIssue boolean - O 지연발행 가능여부 : true (가능) / false (불가능) 중 택 1
7 UserID String 50 - 팝빌회원 아이디

Return

TIssueResponse

Throws

EPopbillException

1.8. CancelIssue - 발행취소

ㆍ국세청 전송 이전 "발행완료" 상태의 전자세금계산서를 "발행취소"하고 국세청 신고대상에서 제외합니다.

function CancelIssue(CorpNum : String; MgtKeyType:EnumMgtKeyType; MgtKey : String; Memo : String; UserID : String = '') : TResponse

ㆍ[1.13. Delete – 삭제]함수를 호출하여 "발행취소" 상태의 전자세금계산서를 삭제하면, 문서번호 재사용이 가능합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 Memo String 200 - 세금계산서 상태 이력을 관리하기 위한 메모
5 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

1.9. RegistRequest - 역발행 즉시 요청

ㆍ공급받는자가 작성한 세금계산서 데이터를 팝빌에 저장하고 공급자에게 송부하여 발행을 요청합니다.

ㆍ역발행 요청된 세금계산서는 "(역)발행대기" 상태이며, 공급자가 팝빌 사이트 또는 함수를 호출하여 발행한 경우에만 국세청으로 전송됩니다.

ㆍ공급자는 팝빌 사이트의 "매출 발행 대기함"에서 발행대기 상태의 역발행 세금계산서를 확인할 수 있습니다.

※ [1.5. Register – 임시저장]와 [1.10. Request – 역발행 요청]함수 기능을 한 번의 프로세스로 처리합니다.

function RegistRequest(CorpNum : String; Taxinvoice : TTaxinvoice; Memo : String =''; UserID : String = '') : TResponse
유의사항

ㆍ역발행 요청시 공급자에게 역발행 요청 메일이 발송됩니다.

ㆍ공급자가 역발행 세금계산서 발행시 포인트가 과금되며, 객체 'TTaxinvoice'의 변수 'chargeDirection' 값에 따라 과금 주체를 변경할 수 있습니다.

※ 정과금 : 공급자 과금, 역과금 : 공급받는자 과금

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Taxinvoice TTaxinvoice - O 세금계산서 객체정보
3 Memo String 200 - 세금계산서 상태 이력을 관리하기 위한 메모
4 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

1.10. Request - 역발행 요청

ㆍ공급받는자가 저장된 역발행 세금계산서를 공급자에게 송부하여 발행 요청합니다.

ㆍ역발행 요청된 세금계산서는 "(역)발행대기" 상태이며, 공급자가 팝빌 사이트 또는 함수를 호출하여 발행한 경우에만 국세청으로 전송됩니다.

ㆍ공급자는 팝빌 사이트의 "매출 발행 대기함"에서 발행대기 상태의 역발행 세금계산서를 확인할 수 있습니다.

function Request(CorpNum : String; MgtKeyType:EnumMgtKeyType; MgtKey : String; Memo : String; UserID : String = '') : TResponse
유의사항

ㆍ역발행 요청시 공급자에게 역발행 요청 메일이 발송됩니다.

ㆍ공급자가 역발행 세금계산서 발행시 포인트가 과금됩니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : BUY (매입) 입력
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 Memo String 200 - 세금계산서 상태 이력을 관리하기 위한 메모
5 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

1.11. CancelRequest - 역발행 요청취소

ㆍ공급자가 요청받은 역발행 세금계산서를 발행하기 전, 공급받는자가 역발행요청을 취소합니다.

ㆍ함수 호출시 상태 값이 "취소"로 변경되고, 해당 역발행 세금계산서는 공급자에 의해 발행 될 수 없습니다.

function CancelRequest(CorpNum : String; MgtKeyType:EnumMgtKeyType; MgtKey : String; Memo : String; UserID : String = '') : TResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : BUY (매입) 입력
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 Memo String 200 - 세금계산서 상태 이력을 관리하기 위한 메모
5 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

1.12. Refuse - 역발행요청 거부

ㆍ공급자가 공급받는자에게 역발행 요청 받은 세금계산서의 발행을 거부합니다.

function Refuse(CorpNum : String; MgtKeyType:EnumMgtKeyType; MgtKey : String; Memo : String; UserID : String = '') : TResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL (매출) 입력
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 Memo String 200 - 세금계산서 상태 이력을 관리하기 위한 메모
5 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

1.13. Delete - 삭제

ㆍ삭제 가능한 상태의 세금계산서를 삭제합니다.

※ 삭제 가능한 상태: "임시저장", "발행취소", "역발행거부", "역발행취소", "전송실패"

function Delete(CorpNum : String; MgtKeyType:EnumMgtKeyType; MgtKey: String; UserID : String = '') : TResponse

ㆍ삭제처리된 세금계산서의 문서번호는 재사용이 가능합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

1.14. SendToNTS - 국세청 즉시 전송

ㆍ"발행완료" 상태의 전자세금계산서를 국세청에 즉시 전송하며, 함수 호출 후 최대 30분 이내에 전송 처리가 완료됩니다.

function SendToNTS(CorpNum : String; MgtKeyType:EnumMgtKeyType; MgtKey :String; UserID : String = '') : TResponse

ㆍ함수 [2.1. GetInfo – 상태확인]또는 Webhook를 통해 국세청 전송 결과를 확인 합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / TRUSTEE 중 택 1
└ SELL = 매출, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

2. 세금계산서 정보확인

2.1. GetInfo - 상태 확인

ㆍ세금계산서 1건의 상태 및 요약정보를 확인합니다.

ㆍ리턴값 'TTaxinvoiceInfo'의 변수 'stateCode'를 통해 세금계산서의 상태코드를 확인합니다. [참고] 세금계산서 상태코드

function GetInfo(CorpNum : string; MgtKeyType:EnumMgtKeyType; MgtKey: string) : TTaxinvoiceInfo

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호

Return

TTaxinvoiceInfo

Throws

EPopbillException

2.2. GetInfos - 다수건 상태 확인

ㆍ다수건의 세금계산서 상태 및 요약 정보를 확인합니다. (1회 호출 시 최대 1,000건 확인 가능)

ㆍ리턴값 'TTaxinvoiceInfo'의 변수 'stateCode'를 통해 세금계산서의 상태코드를 확인합니다. [참고] 세금계산서 상태코드

function GetInfos(CorpNum : string; MgtKeyType:EnumMgtKeyType; MgtKeyList: Array Of String) : TaxinvoiceInfoList

ㆍ문서번호를 통해 세금계산서 목록을 구현하는 경우 활용합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKeyList Array Of String 1000 O [배열] 조회할 세금계산서 문서번호 (최대 1,000건)

Return

TTaxinvoiceInfoList = Array of TTaxinvoiceInfo

Throws

EPopbillException

2.3. GetDetailInfo - 상세정보 확인

ㆍ세금계산서 1건의 상세정보를 확인합니다.

function GetDetailInfo(CorpNum : string; MgtKeyType:EnumMgtKeyType; MgtKey: string) : TTaxinvoice

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호

Return

TTaxinvoice

Throws

EPopbillException

2.4. GetXML - 상세정보 확인 (XML)

ㆍ세금계산서 1건의 상세정보를 XML로 반환합니다.

function GetXML(CorpNum : string; MgtKeyType:EnumMgtKeyType; MgtKey: string; UserID : String = '') : TTaxinvoiceXML

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

TTaxinvoiceXML

Throws

EPopbillException

2.5. Search - 목록 조회

ㆍ검색조건에 해당하는 세금계산서를 조회합니다. (조회기간 단위 : 최대 6개월)

function search(CorpNum : string; MgtKeyType:EnumMgtKeyType; DType:String; SDate: String; EDate:String; State : Array Of String; TType:Array Of String; TaxType : Array Of String; IssueType : Array Of String; LateOnly : String; TaxRegIDType : String; TaxRegID: String; TaxRegIDYN : string; QString : String; Page : Integer; PerPage : Integer; Order : String; InterOPYN : String; UserID : String; RegType : Array Of String; CloseDownState : Array Of String; MgtKey : String) : TSearchList

ㆍ페이지 관련 항목(Page, PerPage, Order)을 활용하여 세금계산서 목록을 구현할 수 있습니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 DType String 1 O 조회 기준일자 유형: 'R' / 'W' / 'I' 중 택 1
└ R = 등록일자, W = 작성일자, I = 발행일자
4 SDate String 8 O 조회 기간의 시작일자 (형식 : yyyyMMdd)
5 EDate String 8 O 조회 기간의 종료일자 (형식 : yyyyMMdd)
6 State Array Of String - O [배열] 세금계산서 상태코드
└ 상태코드 2, 3번째 자리에 와일드카드(*) 사용가능. 예) '3**', '60*' [참고] 세금계산서 상태코드
※ 미입력시 전체조회
7 TType Array Of String - O [배열] 세금계산서 문서유형 : 'N' / 'M' 중 선택 (다중 선택 가능)
└ N = 일반, M = 수정 세금계산서
※ 미입력시 전체조회
8 TaxType Array Of String - O [배열] 과세형태 : 'T' / 'N' / 'Z' 중 선택 (다중 선택 가능)
└ T = 과세, N = 면세, Z = 영세
※ 미입력시 전체조회
9 IssueType Array Of String - O [배열] 발행형태 : 'N' / 'R' / 'T' 중 선택 (다중 선택 가능)
└ N = 정발행, R = 역발행, T = 위수탁발행
※ 미입력시 전체조회
10 LateOnly String 1 O 지연발행 여부 : '' / '1' / '0' 중 택 1
└ '' = 전체, "1" = 지연발행, "0" = 정상발행
11 TaxRegIDType String 1 O 종사업자번호의 주체 : 'S' / 'B' / 'T' 중 택 1
└ S = 공급자, B = 공급받는자, T = 수탁자
※ 미입력시 전체조회
12 TaxRegID String - O 종사업장번호
└ 다수건 검색시 콤마(",")로 구분. 예) 1234,1000
※ 미입력시 전체조회
13 TaxRegIDYN String 1 O 종사업장번호 유무 : '' / '0' / '1' 중 택 1
└ '' = 전체, 0 = 없음, 1 = 있음
14 QString String - O 거래처 상호 / 사업자번호 (사업자) / 주민등록번호 (개인) / "9999999999999" (외국인) 중 검색하고자 하는 정보 입력
└ 사업자번호 / 주민등록번호는 하이픈('-')을 제외한 숫자만 입력
※ 미입력시 전체조회
15 Page Integer - O 목록 페이지번호
16 PerPage Integer - O 페이지당 표시할 목록 개수 (최대 1,000)
17 Order String 1 O {@no.3 DType} 값을 기준으로 하는 목록 정렬 방향 : 'D' / 'A' 중 택 1
└ D = 내림차순(기본값), A = 오름차순
18 InterOPYN String 1 O 연동문서 여부 : '' / '0' / '1' 중 택 1
└ '' = 전체, 0 = 일반문서, 1 = 연동문서
※ 일반문서는 팝빌 사이트를 통해 저장 또는 발행한 세금계산서, 연동문서는 팝빌 API를 통해 저장 또는 발행한 세금계산서
19 UserID String 50 - 팝빌회원 아이디
20 RegType Array Of String - - [배열] 전자세금계산서 등록 유형 : 'P' / 'H' 중 선택 (다중 선택 가능)
└ P = 팝빌에서 등록(발행), H = 홈택스 또는 ASP에서 등록(발행)
※ 미입력시 전체조회
21 CloseDownState Array Of String - - [배열] 휴폐업상태 : 'N' / '0' / '1' / '2' / '3' / '4' 중 선택 (다중 선택 가능)
└ N = 미확인, 0 = 미등록, 1 = 사업중, 2 = 폐업, 3 = 휴업, 4 = 확인실패
※ 미입력시 전체조회
22 MgtKey String - - 세금계산서의 문서번호 / 국세청 승인번호 중 검색하고자 하는 정보 입력
※ 미입력시 전체조회

Return

TSearchList

Throws

EPopbillException

2.6. GetLogs - 세금계산서 상태 변경이력 확인

ㆍ세금계산서의 상태에 대한 변경이력을 확인합니다.

function GetLogs(CorpNum : string; MgtKeyType:EnumMgtKeyType; MgtKey: string) : TTaxinvoiceLogList

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호

Return

TTaxinvoiceLogList = Array Of TTaxinvoiceLog

Throws

EPopbillException

2.7. GetURL - 팝빌 세금계산서 문서함 팝업 URL

ㆍ로그인 상태로 팝빌 사이트의 전자세금계산서 문서함 메뉴에 접근할 수 있는 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetURL(CorpNum : String; UserID : String; TOGO : String) : String

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디
3 TOGO String - O 접근 메뉴 : "TBOX" / "SWBOX" / "PWBOX" / "SBOX" / "PBOX" / "WRITE" 중 택 1
└ TBOX = 임시 문서함, SWBOX = 매출 발행 대기함, PWBOX = 매입 발행 대기함
└ SBOX = 매출 문서함, PBOX = 매입 문서함, WRITE = 매출 문서작성

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

3. 세금계산서 보기/인쇄

3.1. GetPopUpURL - 세금계산서 상세 정보 팝업 URL

ㆍ세금계산서 1건의 상세 정보 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetPopUpURL(CorpNum: string; MgtKeyType : EnumMgtKeyType; MgtKey : String; UserID: String = '') : string

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

3.2. GetViewURL - 세금계산서 상세 정보 팝업 URL [메뉴/버튼 제외]

ㆍ세금계산서 1건의 상세정보 페이지(사이트 상단, 좌측 메뉴 및 버튼 제외)의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetViewURL(CorpNum: string; MgtKeyType : EnumMgtKeyType; MgtKey : String; UserID: String = '') : string;

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

3.3. GetPrintURL - 세금계산서 인쇄 팝업 URL [공급자/공급받는자 용]

ㆍ세금계산서 1건을 인쇄하기 위한 페이지의 팝업 URL을 반환하며, 페이지내에서 인쇄 설정값을 "공급자" / "공급받는자" / "공급자+공급받는자"용 중 하나로 지정할 수 있습니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetPrintURL(CorpNum: string; MgtKeyType : EnumMgtKeyType; MgtKey : String; UserID: String = '') : string

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

3.4. GetOldPrintURL - 세금계산서 (구)인쇄 팝업 URL [공급자/공급받는자 용]

ㆍ세금계산서 1건을 구버전 양식으로 인쇄하기 위한 페이지의 팝업 URL을 반환하며, 페이지내에서 인쇄 설정값을 "공급자" / "공급받는자" / "공급자+공급받는자"용 중 하나로 지정할 수 있습니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetOldPrintURL(CorpNum: string; MgtKeyType : EnumMgtKeyType; MgtKey : String; UserID: String = '') : string

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

3.5. GetEPrintURL - 세금계산서 인쇄 팝업 URL [공급받는자 용]

ㆍ"공급받는자" 용 세금계산서 1건을 인쇄하기 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetEPrintURL(CorpNum: string; MgtKeyType : EnumMgtKeyType; MgtKey : String; UserID: String = '') : string

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

3.6. GetMassPrintURL - 세금계산서 대량 인쇄 팝업 URL

ㆍ다수건의 세금계산서를 인쇄하기 위한 페이지의 팝업 URL을 반환합니다. (최대 100건)

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetMassPrintURL(CorpNum: string; MgtKeyType : EnumMgtKeyType; MgtKeyList: Array Of String; UserID: String = '') : string

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKeyList Array Of String 100 O [배열] 인쇄할 세금계산서 문서번호 (최대 100건)
4 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

3.7. GetMailURL - 세금계산서 안내메일 버튼 팝업 URL

ㆍ전자세금계산서 안내메일의 상세보기 링크 URL을 반환합니다.

ㆍ함수 호출로 반환 받은 URL에는 유효시간이 없습니다.

function GetMailURL(CorpNum: string; MgtKeyType : EnumMgtKeyType; MgtKey : String; UserID: String = '') : string

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

3.8. GetPDFURL - 세금계산서 PDF 다운로드 URL

ㆍ전자세금계산서 PDF 파일을 다운 받을 수 있는 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetPDFURL(CorpNum: string; MgtKeyType : EnumMgtKeyType; MgtKey : String; UserID: String = '') : string

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

4. 부가기능

4.1. GetAccessURL - 팝빌 로그인 팝업 URL

ㆍ팝빌 사이트에 로그인 상태로 접근할 수 있는 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetAccessURL(CorpNum : String; UserID : String) : String

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

4.2. GetSealURL - 인감 및 첨부문서 등록 팝업 URL

ㆍ세금계산서에 첨부할 인감, 사업자등록증, 통장사본을 등록하는 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetSealURL(CorpNum : String; UserID : String) : String

ㆍ인감을 등록한 이후 세금계산서를 발행하는 경우, 자동으로 등록된 인감이 첨부되어 세금계산서가 발행됩니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

4.3. AttachFile - 파일 첨부

ㆍ"임시저장" 상태의 세금계산서에 1개의 파일을 첨부합니다. (최대 5개)

function AttachFile(CorpNum : String; MgtKeyType:EnumMgtKeyType; MgtKey : String; FilePath : String; UserID : String = '') : TResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 FilePath String - O 첨부파일 경로
5 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

4.4. DeleteFile - 첨부파일 삭제

ㆍ"임시저장" 상태의 세금계산서에 첨부된 1개의 파일을 삭제합니다.

ㆍ파일 식별을 위해 첨부시 부여되는 'FileID'는 함수 [4.5. GetFiles – 첨부파일 목록 확인] 를 호출하여 확인합니다.

function DeleteFile(CorpNum: string; MgtKeyType : EnumMgtKeyType; MgtKey : String; FileID : String; UserID : String = '') : TResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 FileID String 255 O 팝빌이 첨부파일 관리를 위해 할당하는 식별번호
└ 함수 [4.5. GetFiles – 첨부파일 목록 확인]의 리턴값 'AttachedFile'의 변수 'attachedFile'를 통해 확인 가능
5 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

4.5. GetFiles - 첨부파일 목록 확인

ㆍ세금계산서에 첨부된 파일목록을 확인합니다.

function GetFiles(CorpNum: String; MgtKeyType : EnumMgtKeyType; MgtKey : String) : TAttachedFileList

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호

Return

TAttachedFileList = Array of TAttachedFile

Throws

EPopbillException

4.6. SendEmail - 메일 재전송

ㆍ세금계산서와 관련된 안내 메일을 재전송 합니다.

function SendEmail(CorpNum : String; MgtKeyType:EnumMgtKeyType; MgtKey :String; Receiver:String; UserID : String = '') : TResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 Receiver String - O 수신자 이메일주소
5 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

4.7. SendSMS - 문자 재전송

ㆍ세금계산서와 관련된 안내 SMS(단문) 문자를 재전송하는 함수로, 팝빌 사이트 [문자·팩스] > [문자] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.

ㆍ메시지는 최대 90byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송합니다. (한글 최대 45자)

function SendSMS(CorpNum : String; MgtKeyType:EnumMgtKeyType; MgtKey :String; Sender:String; Receiver:String; Contents : String; UserID : String = '') : TResponse
유의사항

ㆍ함수 호출시 포인트가 과금됩니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 Sender String - O 발신번호
5 Receiver String - O 수신번호
6 Contents String 90 O 메시지 내용
※ 최대 90 byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송
7 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

4.8. SendFAX - 팩스 전송

ㆍ세금계산서를 팩스로 전송하는 함수로, 팝빌 사이트 [문자·팩스] > [팩스] > [전송내역] 메뉴에서 전송결과를 확인할 수 있습니다.

function SendFAX(CorpNum : String; MgtKeyType:EnumMgtKeyType; MgtKey :String; Sender:String; Receiver:String; UserID : String = '') : TResponse
유의사항

ㆍ함수 호출시 포인트가 과금됩니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 Sender String - O 발신번호
5 Receiver String - O 수신번호
6 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

4.9. AttachStatement - 전자명세서 첨부

ㆍ팝빌 전자명세서 API를 통해 발행한 전자명세서를 세금계산서에 첨부합니다.

function AttachStatement(CorpNum : String; MgtKeyType: EnumMgtKeyType; MgtKey : String; SubItemCode : Integer; SubMgtKey : String) : TResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 SubItemCode Integer 3 O 첨부할 전자명세서의 유형 코드 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1
└ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
※ 전자명세서 발행시 입력한 값과 동일하게 작성
5 SubMgtKey String 24 O 첨부할 전자명세서 문서번호

Return

TResponse

Throws

EPopbillException

4.10. DetachStatement - 전자명세서 첨부해제

ㆍ세금계산서에 첨부된 전자명세서를 해제합니다.

function DetachStatement(CorpNum : String; MgtKeyType: EnumMgtKeyType; MgtKey : String; SubItemCode : Integer; SubMgtKey : String) : TResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 MgtKey String 24 O 파트너가 할당한 문서번호
4 SubItemCode Integer 3 O 첨부해제할 전자명세서의 유형 코드 : 121 / 122 / 123 / 124 / 125 / 126 중 택 1
└ 121 = 거래명세서, 122 = 청구서, 123 = 견적서, 124 = 발주서, 125 = 입금표, 126 = 영수증
※ 전자명세서 발행시 입력한 값과 동일하게 작성
5 SubMgtKey String 24 O 첨부해제할 전자명세서 문서번호

Return

TResponse

Throws

EPopbillException

4.11. GetEmailPublicKeys - 유통사업자 메일 목록 확인

ㆍ전자세금계산서 유통사업자의 메일 목록을 확인합니다.

function GetEmailPublicKeys(CorpNum : String) : TEmailPublicKeyList

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

TEmailPublicKeyList = Array of TEmailPublicKey

Throws

EPopbillException

4.12. AssignMgtKey - 문서번호 할당

ㆍ팝빌 사이트를 통해 발행하여 문서번호가 부여되지 않은 세금계산서에 문서번호를 할당합니다.

function AssignMgtKey(CorpNum : String; MgtKeyType: EnumMgtKeyType; ItemKey : String; MgtKey : String; UserID: String = '') : TResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MgtKeyType EnumMgtKeyType - O 세금계산서 유형 : SELL / BUY / TRUSTEE 중 택 1
└ SELL = 매출, BUY = 매입, TRUSTEE = 위수탁
3 ItemKey String 18 O 팝빌에서 세금계산서 관리 목적으로 할당한 식별번호
└ 함수 [2.5. Search – 목록 조회]를 통하여 TTaxinvoiceInfo의 'itemKey'를 확인
4 MgtKey String 24 O 파트너가 할당한 문서번호
5 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

4.13. ListEmailConfig - 세금계산서 알림메일 발송설정 조회

ㆍ세금계산서 관련 메일 항목에 대한 발송설정을 확인합니다.

function ListEmailConfig(CorpNum : String; UserID : String = '') : TEmailConfigList

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디

Return

TEmailConfigList = Array of TEmailConfig

Throws

EPopbillException

4.14. UpdateEmailConfig - 세금계산서 알림메일 발송설정 수정

ㆍ세금계산서 관련 메일 항목에 대한 발송설정을 수정합니다.

function UpdateEmailConfig(CorpNum : String; EmailType : String; SendYN : Boolean; UserID : String = '') : TResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 EmailType String - O * 발송 메일 유형
  • 정발행
    • ∙TAX_ISSUE : 공급받는자에게 전자세금계산서가 발행 되었음을 알려주는 메일
    • ∙TAX_ISSUE_INVOICER : 공급자에게 전자세금계산서가 발행 되었음을 알려주는 메일
    • ∙TAX_CHECK : 공급자에게 전자세금계산서가 수신확인 되었음을 알려주는 메일
    • ∙TAX_CANCEL_ISSUE : 공급받는자에게 전자세금계산서가 발행취소 되었음을 알려주는 메일
  • 역발행
    • ∙TAX_REQUEST : 공급자에게 세금계산서를 전자서명 하여 발행을 요청하는 메일
    • ∙TAX_CANCEL_REQUEST : 공급받는자에게 세금계산서가 취소 되었음을 알려주는 메일
    • ∙TAX_REFUSE : 공급받는자에게 세금계산서가 거부 되었음을 알려주는 메일
  • 위수탁 발행
    • ∙TAX_TRUST_ISSUE : 공급받는자에게 전자세금계산서가 발행 되었음을 알려주는 메일
    • ∙TAX_TRUST_ISSUE_TRUSTEE : 수탁자에게 전자세금계산서가 발행 되었음을 알려주는 메일
    • ∙TAX_TRUST_ISSUE_INVOICER : 공급자에게 전자세금계산서가 발행 되었음을 알려주는 메일
    • ∙TAX_TRUST_CANCEL_ISSUE : 공급받는자에게 전자세금계산서가 발행취소 되었음을 알려주는 메일
    • ∙TAX_TRUST_CANCEL_ISSUE_INVOICER : 공급자에게 전자세금계산서가 발행취소 되었음을 알려주는 메일
  • 처리결과
    • ∙TAX_CLOSEDOWN : 거래처의 휴폐업 여부를 확인하여 안내하는 메일
    • ∙TAX_NTSFAIL_INVOICER : 전자세금계산서 국세청 전송실패를 안내하는 메일
  • 정기발송
    • ∙ETC_CERT_EXPIRATION : 팝빌에 등록된 인증서의 만료예정을 안내하는 메일
3 SendYN Boolean - O 메일 전송 여부 : true / false 중 택 1
└ true = 전송, false = 미전송
4 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

4.15. GetSendToNTSConfig - 국세청 전송 옵션 설정 상태 확인

ㆍ연동회원의 국세청 전송 옵션 설정 상태를 확인합니다. [참고] 팝빌 국세청 전송 정책

function GetSendToNTSConfig(CorpNum : String; UserID : String) : String
유의사항

ㆍ국세청 전송 옵션 설정은 팝빌 사이트 [전자세금계산서] > [환경설정] > [세금계산서 관리] 메뉴에서 설정할 수 있으며, API로 설정은 불가능 합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디

Return

boolean - true : (발행 즉시 전송) / false : (익일 자동 전송)

Throws

EPopbillException

5. 인증서 관리

5.1. GetTaxCertURL - 인증서 등록 팝업 URL

ㆍ전자세금계산서 발행에 필요한 인증서를 팝빌 인증서버에 등록하기 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetTaxCertURL(CorpNum : String; UserID : String) : String
유의사항

ㆍ인증서 갱신/재발급/비밀번호 변경한 경우, 변경된 인증서를 팝빌 인증서버에 재등록 해야합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

5.2. GetCertificateExpireDate - 인증서 만료일 확인

ㆍ팝빌 인증서버에 등록된 인증서의 만료일을 확인합니다.

function GetCertificateExpireDate(CorpNum : String) : string

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

String - 인증서 만료일자

Throws

EPopbillException

5.3. CheckCertValidation - 인증서 유효성 확인

ㆍ팝빌 인증서버에 등록된 인증서의 유효성을 확인합니다.

function CheckCertValidation(CorpNum : String; UserID : String = '') : TResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

5.4. GetTaxCertInfo - 인증서 정보 확인

ㆍ팝빌 인증서버에 등록된 공동인증서의 정보를 확인합니다.

function GetTaxCertInfo(CorpNum : String; UserID : String = '') : TTaxinvoiceCertificate

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디

Return

TTaxinvoiceCertificate

Throws

EPopbillException

6. 포인트 관리

6.1. GetBalance - 연동회원 잔여포인트 확인

ㆍ연동회원의 잔여포인트를 확인합니다.

function GetBalance(CorpNum: string): Double;

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

Double - 연동회원 잔여포인트

Throws

EPopbillException

6.2. GetChargeURL - 연동회원 포인트 충전 팝업 URL

ㆍ연동회원 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetChargeURL(CorpNum: string; UserID: string): string;

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

6.3. GetPaymentURL - 연동회원 포인트 결제내역 팝업 URL

ㆍ연동회원 포인트 결제내역 확인을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetPaymentURL(CorpNum : String; UserID : String) : String;

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

6.4. GetUseHistoryURL - 연동회원 포인트 사용내역 팝업 URL

ㆍ연동회원 포인트 사용내역 확인을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetUseHistoryURL(CorpNum : String; UserID : String) : String;

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

6.5. GetPartnerBalance - 파트너 잔여포인트 확인

ㆍ파트너의 잔여포인트를 확인합니다.

function GetPartnerBalance(CorpNum: string): Double;

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

Double - 파트너 잔여포인트

Throws

EPopbillException

6.6. GetPartnerURL - 파트너 포인트충전 팝업 URL

ㆍ파트너 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetPartnerURL(CorpNum: string; TOGO: string): string;

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TOGO String - O CHRG : 파트너 포인트 충전

Return

String - 요청에 대한 응답 URL

Throws

EPopbillException

6.7. GetUnitCost - 발행 단가 확인

ㆍ세금계산서 발행시 과금되는 포인트 단가를 확인합니다.

function GetUnitCost(CorpNum: string): Single

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

Single - 세금계산서 발행단가

Throws

EPopbillException

6.8. GetChargeInfo - 과금정보 확인

ㆍ팝빌 전자세금계산서 API 서비스 과금정보를 확인합니다.

function GetChargeInfo(CorpNum : string; UserID: string): TTaxinvoiceChargeInfo

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디

Return

TTaxinvoiceChargeInfo

Throws

EPopbillException

7. 회원정보

7.1. CheckIsMember - 연동회원 가입여부 확인

ㆍ사업자번호를 조회하여 연동회원 가입여부를 확인합니다.

function CheckIsMember(CorpNum: string; LinkID: string): TResponse;

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 LinkID String - O 링크아이디

Return

TResponse - code : 0 (미가입) / code : 1 (가입)

Throws

EPopbillException

7.2. CheckID - 아이디 중복 확인

ㆍ사용하고자 하는 아이디의 중복여부를 확인합니다.

function CheckID(ID: string): TResponse;

Parameters

순번 변수명 타입 길이 필수 설명
1 ID String 50 O 중복여부를 확인할 아이디

Return

TResponse - code : 0 (미사용중) / code : 1 (사용중)

Throws

EPopbillException

7.3. JoinMember - 연동회원 신규가입

ㆍ사용자를 연동회원으로 가입처리합니다.

function JoinMember(JoinInfo: TJoinForm): TResponse;

Parameters

순번 변수명 타입 길이 필수 설명
1 JoinInfo TJoinForm - O 연동회원 객체정보

Return

TResponse

Throws

EPopbillException

7.4. GetCorpInfo - 회사정보 확인

ㆍ연동회원의 회사정보를 확인합니다.

function GetCorpInfo(CorpNum: string; UserID: string): TCorpInfo

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디

Return

TCorpInfo

Throws

EPopbillException

7.5. UpdateCorpInfo - 회사정보 수정

ㆍ연동회원의 회사정보를 수정합니다.

function UpdateCorpInfo(CorpNum: string; CorpInfo: TCorpInfo; UserID: string): TResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 CorpInfo TCorpInfo - O 회사정보 객체
3 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

7.6. RegistContact - 담당자 등록

ㆍ연동회원 사업자번호에 담당자(팝빌 로그인 계정)를 추가합니다.

function RegistContact(CorpNum: string; JoinInfo: TJoinContact; UserID: string): TResponse

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 JoinInfo TJoinContact - O 담당자 정보 객체
3 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

7.7. GetContactInfo - 담당자 정보 확인

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 정보를 확인합니다.

function GetContactInfo(CorpNum : String; ContactID : String; UserID : String) : TContactInfo;

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ContactID String 50 O 확인할 담당자 아이디
3 UserID String 50 - 팝빌회원 아이디

Return

TContactInfo

Throws

EPopbillException

7.8. ListContact - 담당자 목록 확인

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 목록을 확인합니다.

function ListContact(CorpNum: string; UserID: string): TContactInfoList

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 UserID String 50 - 팝빌회원 아이디

Return

TContactInfoList = Array Of TContactInfo

Throws

EPopbillException

7.9. UpdateContact - 담당자 정보 수정

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 정보를 수정합니다.

function UpdateContact(CorpNum: string; CorpInfo: TContactInfo; UserID: string): TResponse;

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 CorpInfo TContactInfo - O 담당자 정보 객체
3 UserID String 50 - 팝빌회원 아이디

Return

TResponse

Throws

EPopbillException

A. 객체정보

A.1. TResponse

순번 변수명 항목명 타입 길이 비고
1 code 코드 LongInt - API 처리에 대한 응답코드
2 message 메시지 String - API 처리에 대한 응답메시지

A.2. TIssueResponse

순번 변수명 항목명 타입 길이 비고
1 code 코드 LongInt - API 처리에 대한 응답코드
2 message 메시지 String - API 처리에 대한 응답메시지
3 ntsConfirmNum 국세청 승인번호 String 24 세금계산서 발행 시점에 팝빌에서 자동으로 부여

A.3. EPopbillException

순번 변수명 항목명 타입 길이 비고
1 code 코드 LongInt - API 처리 실패에 대한 오류코드("-"로 시작하는 8자리 숫자값)
└ [참고] 오류코드
2 message 메시지 String - API 처리 실패에 대한 오류메시지

A.4. EnumMgtKeyType (enum)

순번 변수명 항목명 타입 길이 비고
1 SELL 매출 enum -
2 BUY 매입 enum -
3 TRUSTEE 수탁 enum -

A.5. TTaxinvoice

순번 변수명 항목명 타입 길이 필수 비고
1 ntsconfirmNum 국세청 승인번호 String 24 X 세금계산서 발행 시점에 팝빌에서 자동으로 부여
2 issueType 발행형태 String 3 O "정발행" / "역발행" / "위수탁" 중 택 1
3 taxType 과세형태 String 2 O "과세" / "영세" / "면세" 중 택 1
4 chargeDirection 과금방향 String 3 O "정과금" / "역과금" 중 택 1
└ 정과금 = 공급자 과금
└ 역과금 = 공급받는자 과금 : {@no 2. issueType} = "역발행" 인 경우만 가능
5 serialNum 일련번호 String 30 -
6 kwon 권 String 4 - 책번호 "권" 항목
7 ho 호 String 4 - 책번호 "호" 항목
8 writeDate 작성일자 String 8 O 형식 : yyyyMMdd
9 purposeType 영수/청구 String 2 O "영수" / "청구" / "없음" 중 택 1
10 supplyCostTotal 공급가액 합계 String 18 O 정수만 입력 가능
※ 마이너스 금액 입력 가능, 소수점 아래 자동 절사
11 taxTotal 세액 합계 String 18 O 정수만 입력 가능
※ 마이너스 금액 입력 가능, 소수점 아래 자동 절사
12 totalAmount 합계금액 String 18 O 정수만 입력 가능
※ 마이너스 금액 입력 가능, 소수점 아래 자동 절사
13 cash 현금 String 18 -
14 chkBill 수표 String 18 -
15 credit 외상 String 18 -
16 note 어음 String 18 -
17 remark1 비고1 String 150 △ {@no 35. invoiceeType} = "외국인" 인 경우 필수, 외국인 등록번호 또는 여권번호 입력
18 remark2 비고2 String 150 -
19 remark3 비고3 String 150 -
20 invoicerMgtKey 공급자 문서번호 String 24 △ 정발행시 필수, 공급자의 문서 관리를 위해 파트너가 할당하는 식별번호
└ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
21 invoicerCorpNum 공급자 사업자번호 String 10 O 하이픈('-') 제외 10자리 숫자값
22 invoicerTaxRegID 공급자 종사업장 식별번호 String 4 - 4자리 숫자값
23 invoicerCorpName 공급자 상호 String 200 O
24 invoicerCEOName 공급자 대표자 성명 String 100 O
25 invoicerAddr 공급자 주소 String 300 -
26 invoicerBizType 공급자 업태 String 100 -
27 invoicerBizClass 공급자 종목 String 100 -
28 invoicerContactName 공급자 담당자 성명 String 100 -
29 invoicerDeptName 공급자 담당자 부서명 String 100 -
30 invoicerTEL 공급자 담당자 연락처 String 20 -
31 invoicerHP 공급자 담당자 휴대폰 String 20 -
32 invoicerEmail 공급자 담당자 이메일 String 100 -
33 invoicerSMSSendYN 공급자 문자전송 여부 Boolean - - {@no 2. issueType} 값이 "정발행" 인 경우, 세금계산서 발행시 알림문자 전송여부 : true / false 중 택 1
└ true = 전송, false = 미전송
└ 공급받는자 (주)담당자 휴대폰번호 {@no 48. invoiceeHP1} 값으로 문자 전송
└ 전송시 포인트 차감되며, 실패시 환불 처리
34 invoiceeMgtKey 공급받는자 문서번호 String 24 △ 역발행시 필수, 공급받는자의 문서 관리를 위해 파트너가 부여하는 식별번호
└ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
35 invoiceeType 공급받는자 구분 String - O "사업자" / "개인" / "외국인" 중 택 1
36 invoiceeCorpNum 공급받는자 사업자번호 String - O {@no 35. invoiceeType} = "사업자" 인 경우, 사업자번호 (하이픈 ('-') 제외 10자리)
{@no 35. invoiceeType} = "개인" 인 경우, 주민등록번호 (하이픈 ('-') 제외 13자리)
{@no 35. invoiceeType} = "외국인" 인 경우, "9999999999999" (하이픈 ('-') 제외 13자리)
37 invoiceeTaxRegID 공급받는자 종사업장 식별번호 String 4 - 4자리 숫자값
38 invoiceeCorpName 공급받는자 상호 String 200 O
39 invoiceeCEOName 공급받는자 대표자 성명 String 100 O
40 invoiceeAddr 공급받는자 주소 String 300 -
41 invoiceeBizType 공급받는자 업태 String 100 -
42 invoiceeBizClass 공급받는자 종목 String 100 -
43 closeDownState 공급받는자 휴폐업상태 Integer 1 X 세금계산서 발행시 팝빌에서 휴폐업조회 하여 결과값 반환
└ null = 미확인, 0 = 미등록, 1 = 사업중, 2 = 폐업, 3 = 휴업, 4 = 확인실패
44 closeDownStateDate 공급받는자 휴폐업일자 String 8 X {@no 43. closeDownState} 값이 2 or 3일 경우 결과값 반환 (형식 : yyyyMMdd)
45 invoiceeContactName1 공급받는자 주) 담당자 성명 String 100 -
46 invoiceeDeptName1 공급받는자 주) 담당자 부서명 String 100 -
47 invoiceeTEL1 공급받는자 주) 담당자 연락처 String 20 -
48 invoiceeHP1 공급받는자 주) 담당자 휴대폰 String 20 -
49 invoiceeEmail1 공급받는자 주) 담당자 이메일 String 100 -
50 invoiceeContactName2 공급받는자 부) 담당자 성명 String 30 -
51 invoiceeDeptName2 공급받는자 부) 담당자 부서명 String 40 -
52 invoiceeTEL2 공급받는자 부) 담당자 연락처 String 20 -
53 invoiceeHP2 공급받는자 부) 담당자 휴대폰 String 20 -
54 invoiceeEmail2 공급받는자 부) 담당자 이메일 String 70 -
55 invoiceeSMSSendYN 공급받는자 문자전송 여부 Boolean - - {@no 2. issueType} 값이 "역발행" 인 경우, 세금계산서 역발행 요청시 알림문자 전송여부: true / false 중 택 1
└ true = 전송, false = 미전송
└ 공급자 담당자 휴대폰번호 {@no 31. invoicerHP} 값으로 문자 전송
└ 전송시 포인트 차감되며, 실패시 환불 처리
56 trusteeMgtKey 수탁자 문서번호 String 24 △ 위수탁발행시 필수, 수탁자의 문서 관리를 위해 파트너가 부여하는 식별번호
└ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
57 trusteeCorpNum 수탁자 사업자번호 String 10 △ 위수탁발행시 필수, 하이픈('-') 제외 10자리 숫자값
58 trusteeTaxRegID 수탁자 종사업장 식별번호 String 4 - 4자리 숫자값
59 trusteeCorpName 수탁자 상호 String 200 △ 위수탁발행시 필수
60 trusteeCEOName 수탁자 대표자 성명 String 100 △ 위수탁발행시 필수
61 trusteeAddr 수탁자 주소 String 300 -
62 trusteeBizType 수탁자 업태 String 100 -
63 trusteeBizClass 수탁자 종목 String 100 -
64 trusteeContactName 수탁자 담당자 성명 String 100 -
65 trusteeDeptName 수탁자 담당자 부서명 String 100 -
66 trusteeTEL 수탁자 담당자 연락처 String 20 -
67 trusteeHP 수탁자 담당자 휴대폰 String 20 -
68 trusteeEmail 수탁자 담당자 이메일 String 100 -
69 trusteeSMSSendYN 수탁자 문자전송 여부 Boolean - - {@no 2. issueType} 값이 "위수탁" 인 경우, 세금계산서 발행시 알림문자 전송여부: true / false 중 택 1
└ true = 전송, false = 미전송(기본값)
└ 공급받는자 (주)담당자 휴대폰번호 {@no 48. invoiceeHP1} 값으로 문자 전송
└ 전송시 포인트 차감되며, 실패시 환불 처리
70 modifyCode 수정 사유코드 Short 1 △ 수정세금계산서 작성시 필수
└ [참고] 수정세금계산서
71 orgNTSConfirmNum 원본 세금계산서
국세청 승인번호		 String 24 △ 수정세금계산서 작성시 필수
72 businessLicenseYN 사업자등록증 첨부 Boolean - - 팝빌에 등록된 사업자등록증 첨부 여부 : true / false 중 택 1
└ true = 첨부, false = 미첨부(기본값)
※ 팝빌 사이트 또는 [4.2. GetSealURL - 인감 및 첨부문서 등록 팝업 URL]을 이용하여 등록
73 bankBookYN 통장사본 첨부 Boolean - - 팝빌에 등록된 통장사본 첨부 여부 : true / false 중 택 1
└ true = 첨부, false = 미첨부(기본값)
※ 팝빌 사이트 또는 [4.2. GetSealURL - 인감 및 첨부문서 등록 팝업 URL]을 이용하여 등록
74 detailList 상세항목 TDetailList - [배열] 거래 물품 상세 정보 (최대 99건)
75 addContactList 추가담당자 TContactList - [배열] 공급받는자 담당자 정보 (최대 5명)
※ 여러 담당자에게 세금계산서 안내 메일을 보내야할 경우 사용

A.6. TDetailList

순번 변수명 항목명 타입 길이 필수 비고
1 serialNum 일련번호 Short - O 1부터 순차적으로 입력 (최대 99)
2 purchaseDT 거래일자 String 8 - 형식 : yyyyMMdd
3 itemName 품명 String 100 -
4 spec 규격 String 60 -
5 qty 수량 String 12 - 소수점 아래 2번째 자리까지 입력 가능
※ 마이너스 입력 가능
6 unitCost 단가 String 18 - 소수점 아래 2번째 자리까지 입력 가능
※ 마이너스 금액 입력 가능
7 supplyCost 공급가액 String 18 - 정수만 입력 가능
※ 마이너스 금액 입력 가능, 소수점 아래 자동 절사
8 tax 세액 String 18 - 정수만 입력 가능
※ 마이너스 금액 입력 가능, 소수점 아래 자동 절사
9 remark 비고 String 100 -

A.7. TContactList

순번 변수명 항목명 타입 길이 필수 비고
1 serialNum 일련번호 Integer - O 1부터 순차적으로 입력 (최대 5)
2 contactName 담당자 성명 String 100 O
3 email 이메일 String 100 O

A.8. TBulkResponse

순번 변수명 항목명 타입 길이 비고
1 code 코드 LongInt - API 처리에 대한 응답코드
2 message 응답메시지 String - API 처리에 대한 응답메시지
3 receiptID 접수아이디 String 24 접수 시점에 팝빌에서 자동으로 부여

A.9. TBulkTaxinvoiceResult

순번 변수명 항목명 타입 길이 비고
1 code 코드 LongInt - API 처리에 대한 응답코드
2 message 응답메시지 String - API 처리에 대한 응답메시지
3 submitID 제출아이디 String 36 접수 시점에 고객사에서 부여한 제출아이디
4 submitCount 세금계산서 접수 건수 Integer -
5 successCount 세금계산서 발행 성공 건수 Integer -
6 failCount 세금계산서 발행 실패 건수 Integer -
7 txState 접수상태코드 Integer - 0 : (접수) / 1 : (처리중) / 2 : (처리완료) 중 반환
8 txResultCode 접수 결과코드 Integer -
9 txStartDT 발행처리 시작일시 String 14 형식 : yyyyMMddHHmmss
10 txEndDT 발행처리 완료일시 String 14 형식 : yyyyMMddHHmmss
11 receiptDT 접수일시 String 14 형식 : yyyyMMddHHmmss
12 issueResult 발행결과 TBulkTaxinvoiceIssueResultList {@no.7 txState} = 2 경우 반환
13 receiptID 접수아이디 String 36 접수 시점에 팝빌에서 자동으로 부여

A.10. TBulkTaxinvoiceIssueResult

순번 변수명 항목명 타입 길이 비고
1 invoicerMgtKey 공급자 문서번호 String 24
2 trusteeMgtKey 수탁자 문서번호 String 24
3 code 코드 LongInt - API 처리에 대한 응답코드
4 message 메시지 String - API 처리에 대한 응답메시지
5 ntsconfirmNum 국세청승인번호 String 24
6 issueDT 발행일시 String 14 형식 : yyyyMMddHHmmss

A.11. TSearchList

순번 변수명 항목명 타입 길이 비고
1 code 코드 Integer - API 처리에 대한 응답코드
2 message 메시지 String - API 처리에 대한 응답메시지
3 total 총 검색결과 건수 Integer -
4 perPage 페이지당 검색개수 Integer -
5 pageNum 페이지 번호 Integer -
6 pageCount 페이지 개수 Integer -
7 list 세금계산서 상태/요약정보 TTaxinvoiceInfoList [배열] 최대 1,000건
└ 함수 [2.1. GetInfo – 상태 확인]의 리턴값 구성과 동일

A.12. TTaxinvoiceInfo

순번 변수명 항목명 타입 길이 비고
1 itemKey 팝빌번호 String 18 팝빌에서 세금계산서 관리 목적으로 할당한 식별번호
2 taxType 과세형태 String 2 "과세" / "영세" / "면세" 중 반환
3 writeDate 작성일자 String 8 형식 : yyyyMMdd
4 regDT 임시저장 일자 String 8 형식 : yyyyMMdd
5 issueType 발행형태 String 3 "정발행" / "역발행" / "위수탁" 중 반환
6 supplyCostTotal 공급가액 합계 String 18
7 taxTotal 세액 합계 String 18
8 purposeType 영수/청구 String 2 "영수" / "청구" / "없음" 중 반환
9 issueDT 발행일시 String 14 형식 : yyyyMMddHHmmss
10 lateIssueYN 지연발행 여부 boolean - true : (지연발행) / false : (정상발행) 중 반환
11 preIssueDT 발행예정일시 String 14 형식 : yyyyMMddHHmmss
12 openYN 개봉 여부 boolean - true : (개봉) / false : (미개봉) 중 반환
└ {@no.5 issueType} 값이 "정발행" or "위수탁" 인 경우, 공급받는자가 전자세금계산서 보기 버튼을 클릭한 경우 개봉 처리
└ {@no.5 issueType} 값이 "역발행" 인 경우, 공급자가 세금계산서 보기 버튼을 클릭한 경우 개봉 처리
13 openDT 개봉일시 String 14 형식 : yyyyMMddHHmmss
14 stateMemo 상태메모 String 200
15 stateCode 상태코드 Integer 3 [참고] 세금계산서 상태코드
16 stateDT 상태 변경일시 String 14 형식 : yyyyMMddHHmmss
17 ntsconfirmNum 국세청 승인번호 String 24
17 ntsresult 국세청 전송결과 String 6
19 ntssendDT 국세청 전송일시 String 14 형식 : yyyyMMddHHmmss
20 ntsresultDT 국세청 결과 수신일시 String 14 형식 : yyyyMMddHHmmss
21 ntssendErrCode 전송실패 사유코드 String 8 [참고] 국세청전송 결과코드
22 modifyCode 수정 사유코드 String 1 수정세금계산서 발행시 입력한 사유코드
└ [참고] 수정세금계산서
23 interOPYN 연동문서 여부 boolean - true : (API를 통해 발행한 연동문서) / false : (팝빌 사이트를 통해 발행한 문서) 중 반환
24 invoicerCorpName 공급자 상호 String 200
25 invoicerCorpNum 공급자 사업자번호 String 10
26 invoicerMgtKey 공급자 문서번호 String 24 파트너가 팝빌에 세금계산서를 임시저장 또는 발행시 할당한 문서번호
27 invoicerPrintYN 공급자 인쇄여부 boolean - true : (인쇄) / false : (미인쇄) 중 반환
28 invoiceeCorpName 공급받는자 상호 String 200
29 invoiceeCorpNum 공급받는자 사업자번호 String 10
30 invoiceeMgtKey 공급받는자 문서번호 String 24 파트너가 할당한 문서번호
31 invoiceePrintYN 공급받는자 인쇄여부 boolean - true : (인쇄) / false : (미인쇄) 중 반환
32 closeDownState 공급받는자 휴폐업상태 Integer 1 null : (미확인) / 0 : (미등록) / 1 : (사업중) / 2 : (폐업) / 3 : (휴업) / 4 : (확인실패) 중 반환
33 closeDownStateDate 공급받는자 휴폐업일자 String 8 형식 : yyyyMMdd
34 trusteeCorpName 수탁자 상호 String 200
35 trusteeCorpNum 수탁자 사업자번호 String 10
36 trusteeMgtKey 수탁자 문서번호 String 24 파트너가 할당한 문서번호
37 trusteePrintYN 수탁자 인쇄여부 boolean - true : (인쇄) / false : (미인쇄) 중 반환

A.13. TTaxinvoiceXML

순번 변수명 항목명 타입 길이 비고
1 code 응답코드 Integer - API 처리에 대한 응답코드
2 message 응답메시지 String - API 처리에 대한 응답메시지
3 retObject 전자세금계산서 XML 문서 String -

A.14. TTaxinvoiceLog

순번 변수명 항목명 타입 길이 비고
1 docLogType 로그타입 Integer 3 100 : (임시저장) / 101 : (수정) / 102 : (개봉) / 103 : (수신확인)
111 : (메일 재전송) / 112 : (문자 재전송) / 113 : (팩스 재전송) / 122 : (문자 전송결과)
123 : (팩스 전송결과) / 124 : (휴폐업 확인) / 125 : (관리번호 할당)
220 : (역발행요청) / 221 : (역발행요청 거부) / 222 : (역발행요청 취소) / 230 : (발행) / 240 : (발행취소)
250 : (국세청전송 요청) / 251 : (국세청전송 대기중) / 252 : (국세청전송 진행중)
253 : (국세청전송 접수) / 254 : (국세청전송 성공) / 255 : (국세청전송 실패) 중 반환
2 log 이력정보 String 2000
3 procType 처리형태 String 3 "연동" : (API로 처리함) / "일반" : (팝빌 사이트에서 처리함) / "시스템" : (팝빌이 처리함) 중 반환
4 procCorpName 처리회사명 String 70
5 procContactName 처리담당자 String 30
6 procMemo 처리메모 String 200
7 regDT 등록일시 String 14 형식 : yyyyMMddHHmmss
8 ip 아이피 String 39

A.15. TAttachedFile

순번 변수명 항목명 타입 길이 비고
1 serialNum 첨부파일 일련번호 Integer 1
2 attachedFile 파일아이디 String 255 팝빌이 첨부파일 관리를 위해 할당한 식별번호
└ 함수 [4.4. DeleteFile – 첨부파일 삭제]호출을 위한 필수값
3 displayName 첨부파일명 String 255
4 regDT 첨부일시 String 14

A.16. TEmailConfig

순번 변수명 항목명 타입 길이 비고
1 emailType 메일전송유형 String -
  • 정발행
    • ∙TAX_ISSUE : 공급받는자에게 전자세금계산서가 발행 되었음을 알려주는 메일
    • ∙TAX_ISSUE_INVOICER : 공급자에게 전자세금계산서가 발행 되었음을 알려주는 메일
    • ∙TAX_CHECK : 공급자에게 전자세금계산서가 수신확인 되었음을 알려주는 메일
    • ∙TAX_CANCEL_ISSUE : 공급받는자에게 전자세금계산서가 발행취소 되었음을 알려주는 메일
  • 역발행
    • ∙TAX_REQUEST : 공급자에게 세금계산서를 전자서명 하여 발행을 요청하는 메일
    • ∙TAX_CANCEL_REQUEST : 공급받는자에게 세금계산서가 취소 되었음을 알려주는 메일
    • ∙TAX_REFUSE : 공급받는자에게 세금계산서가 거부 되었음을 알려주는 메일
  • 위수탁 발행
    • ∙TAX_TRUST_ISSUE : 공급받는자에게 전자세금계산서가 발행 되었음을 알려주는 메일
    • ∙TAX_TRUST_ISSUE_TRUSTEE : 수탁자에게 전자세금계산서가 발행 되었음을 알려주는 메일
    • ∙TAX_TRUST_ISSUE_INVOICER : 공급자에게 전자세금계산서가 발행 되었음을 알려주는 메일
    • ∙TAX_TRUST_CANCEL_ISSUE : 공급받는자에게 전자세금계산서가 발행취소 되었음을 알려주는 메일
    • ∙TAX_TRUST_CANCEL_ISSUE_INVOICER : 공급자에게 전자세금계산서가 발행취소 되었음을 알려주는 메일
  • 처리결과
    • ∙TAX_CLOSEDOWN : 거래처의 휴폐업 여부를 확인하여 안내하는 메일
    • ∙TAX_NTSFAIL_INVOICER : 전자세금계산서 국세청 전송실패를 안내하는 메일
  • 정기발송
    • ∙ETC_CERT_EXPIRATION : 팝빌에 등록된 인증서의 만료예정을 안내하는 메일
2 sendYN 전송여부 Boolean - true : (전송) / false : (미전송) 중 반환

A.17. TTaxinvoiceCertificate

순번 변수명 항목명 타입 길이 비고
1 regDT 등록일시 String 14 인증서를 팝빌 인증서버에 등록한 시간
└형식 : yyyyMMddHHmmss
2 expireDT 만료일시 String 14 팝빌 인증서버에 등록된 인증서의 만료일시
└형식 : yyyyMMddHHmmss
3 issuerDN 인증서 발급자 DN String 200
4 subjectDN 등록된 인증서 DN String 200
5 issuerName 인증서 종류 String - "전자세금용 공동인증서" / "팝빌 특목용 공동인증서" / "기타" 중 반환
6 oid OID String 30
7 regContactName 등록 담당자 성명 String 100 팝빌 인증서버에 인증서를 등록한 담당자 성명
8 regContactID 등록 담당자 아이디 String 50 팝빌 인증서버에 인증서를 등록한 담당자 팝빌회원 아이디

A.18. TTaxinvoiceChargeInfo

순번 변수명 항목명 타입 길이 비고
1 unitCost 발행단가 String -
2 chargeMethod 과금유형 String - "연동" / "파트너" 중 반환
3 rateSystem 과금제도 String - "종량제" 반환

A.19. TJoinForm

순번 변수명 항목명 타입 길이 필수 비고
1 ID 아이디 String 50 O 6자 이상 50자 이하
2 Password 비밀번호 String 20 O 8자 이상 20자 이하
└ 영문, 숫자, 특수문자 조합
3 LinkID 파트너 링크아이디 String 20 O 연동신청시 팝빌에서 발급받은 링크아이디
4 CorpNum 사업자번호 String 10 O 하이픈 '-' 제외 10자리 숫자값
5 CEOName 대표자 성명 String 200 O
6 CorpName 회사명 String 200 O
7 Addr 사업장 주소 String 300 O
8 BizType 업태 String 100 O
9 BizClass 종목 String 100 O
10 ContactName 담당자 성명 String 100 O
11 ContactEmail 담당자 이메일 String 100 O
12 ContactTEL 담당자 연락처(전화번호) String 20 O

A.20. TCorpInfo

순번 변수명 항목명 타입 길이 필수 비고
1 ceoname 대표자 성명 String 100 O
2 corpName 회사명 String 200 O
3 addr 주소 String 300 O
4 bizType 업태 String 100 O
5 bizClass 종목 String 100 O

A.21. TJoinContact

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 String 50 O 6자 이상 50자 이하
2 Password 비밀번호 String 20 △ 8자 이상 20자 이하
└ 영문, 숫자, 특수문자 조합
3 personName 담당자 성명 String 100 O
4 tel 담당자 연락처(전화번호) String 20 O
5 email 담당자 이메일 String 100 O
6 searchRole 담당자 권한 String 1 - 1 : (개인권한) / 2 : (읽기권한) / 3 : (회사권한)

A.22. TContactInfo

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 String 50 O 6자 이상 50자 이하
2 personName 담당자 성명 String 100 O
3 tel 담당자 연락처(전화번호) String 20 O
4 email 담당자 이메일 String 100 O
5 regDT 등록일시 String 14 X 형식 : yyyyMMddHHmmss
6 searchRole 담당자 권한 String - - 1 : (개인권한) / 2 : (읽기권한) / 3 : (회사권한)
7 mgrYN 관리자 여부 Boolean - X true : (관리자) / false : (담당자) 중 반환
※ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
8 state 상태 integer 1 X 0 : (승인대기 - 관리자의 승인 후 이용가능) / 1 : (사용중) 중 반환

A.23. TEmailPublicKey

순번 변수명 항목명 타입 길이 비고
1 confirmNum 유통사업자 승인번호 String 8
2 email 유통사업자 이메일 String 40
3 regDT 등록일시 String 14 형식 : yyyyMMddHHmmss