부가기능
1. GetSealURL - 인감 및 첨부문서 등록 팝업 URL
GET
https://popbill-test.linkhub.co.kr/Member
GET
https://popbill.linkhub.co.kr/Member
- 전자명세서에 첨부될 인감, 사업자등록증, 통장사본을 등록하는 팝업 URL을 반환합니다.
- 권장 사이즈 : width = 600px / height = 755px
- 반환되는 URL은 30초 동안만 사용이 가능합니다.
- 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.
- 인감을 등록한 이후 전자명세서를 발행하는 경우, 자동으로 등록된 인감이 첨부되어 전자명세서가 발행됩니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Accept-Language | N |
응답 언어 설정
ko-KR: 기본값
en-US
|
|
| Accept-Encoding | N | 응답 압축 방식 gzip |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
Query 파라미터
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| TG | string | - | Y | 고정값 : SEAL |
요청 예시
curl --request GET \
--url 'https://{domain}/Member?TG=SEAL' \
--header 'Authorization: Bearer {token}'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| url | string | - | 인감 및 첨부문서 등록 팝업 URL |
응답 예시
{
"url": "https://test.popbill.com/App/API?T=FFXMY6SEHFVDD27TUYBESQ7...XYK2NPF5NLWKD2==="
}
2. AttachFile - 파일 첨부
POST
https://popbill-test.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}/Files
POST
https://popbill.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}/Files
- "임시저장" 상태의 명세서에 1개의 파일을 첨부합니다. (최대 5개)
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Content-Type | Y | 요청 본문 형식 multipart/form-data |
|
| Accept-Language | N |
응답 언어 설정
ko-KR: 기본값
en-US
|
|
| Accept-Encoding | N | 응답 압축 방식 gzip |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
Path 파라미터
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| ItemCode | number | - | Y |
전자명세서 문서 유형 (택 1)
|
|
| MgtKey | string | 24 | Y | 파트너가 할당한 문서번호 |
요청 본문
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| Filedata | file | - | Y | 파일 데이터 |
요청 예시
curl --request POST \
--url 'https://{domain}/Statement/{ItemCode}/{MgtKey}/Files' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: multipart/form-data' \
--form 'Filedata=@"/path/test.jpg"'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | number | - |
API 처리에 대한 응답코드
1성공
|
|
| message | string | - | API 처리에 대한 응답메시지 |
응답 예시
{
"code": 1,
"message": "첨부 완료"
}
3. DeleteFile - 첨부파일 삭제
POST
https://popbill-test.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}/Files/{FileID}
POST
https://popbill.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}/Files/{FileID}
- "임시저장" 상태의 전자명세서에 첨부된 1개의 파일을 삭제합니다.
- 파일 식별을 위해 첨부시 할당되는 FileID는 함수[GetFiles – 첨부파일 목록 확인] 를 호출하여 확인합니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Accept-Language | N |
응답 언어 설정
ko-KR: 기본값
en-US
|
|
| Accept-Encoding | N | 응답 압축 방식 gzip |
|
| X-HTTP-Method-Override | Y | 요청 메서드 재정의 DELETE |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
Path 파라미터
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| ItemCode | number | - | Y |
전자명세서 문서 유형 (택 1)
|
|
| MgtKey | string | 24 | Y | 파트너가 할당한 문서번호 | |
| FileID | string | 255 | Y |
팝빌이 할당한 파일 식별번호
[GetFiles – 첨부파일 목록 확인] API의 리턴값 중 attachedFile 필드 참조
|
요청 예시
curl --request POST \
--url 'https://{domain}/Taxinvoice/{MgtKeyType}/{MgtKey}/Files/{FileID}' \
--header 'Authorization: Bearer {token}' \
--header 'X-HTTP-Method-Override: DELETE'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | number | - |
API 처리에 대한 응답코드
1성공
|
|
| message | string | - | API 처리에 대한 응답메시지 |
응답 예시
{
"code": 1,
"message": "첨부삭제 완료"
}
4. GetFiles - 첨부파일 목록 확인
GET
https://popbill-test.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}/Files
GET
https://popbill.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}/Files
- 전자명세서에 첨부된 파일목록을 확인합니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Accept-Language | N |
응답 언어 설정
ko-KR: 기본값
en-US
|
|
| Accept-Encoding | N | 응답 압축 방식 gzip |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
Path 파라미터
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| ItemCode | number | - | Y |
전자명세서 문서 유형 (택 1)
|
|
| MgtKey | string | 24 | Y | 파트너가 할당한 문서번호 |
요청 예시
curl --request GET \
--url 'https://{domain}/Statement/{ItemCode}/{MgtKey}/Files' \
--header 'Authorization: Bearer {token}'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| serialNum | number | 1 | 첨부파일 일련번호 | |
| attachedFile | string | 255 | 팝빌이 할당한 파일 식별번호 | |
| displayName | string | 255 | 파일명 | |
| regDT | string | 14 |
첨부일시
형식 : yyyyMMddHHmmss
|
응답 예시
[
{
"displayName": "test.jpg",
"serialNum": 2,
"attachedFile": "B8930D66-6684-4B25-ABA0-3BD4E848ECAF.PBF",
"regDT": "20251022203916"
}
]
5. SendEmail - 메일 재전송
POST
https://popbill-test.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}
POST
https://popbill.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}
- "승인대기", "발행완료" 상태의 전자명세서와 관련된 발행 안내 메일을 재전송 합니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Content-Type | Y | 요청 본문 형식 application/json |
|
| Accept-Language | N |
응답 언어 설정
ko-KR: 기본값
en-US
|
|
| Accept-Encoding | N | 응답 압축 방식 gzip |
|
| X-HTTP-Method-Override | Y | 요청 메서드 재정의 EMAIL |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
Path 파라미터
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| ItemCode | number | - | Y |
전자명세서 문서 유형 (택 1)
|
|
| MgtKey | string | 24 | Y | 파트너가 할당한 문서번호 |
요청 본문
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| receiver | string | - | Y | 수신자 메일주소 |
요청 예시
curl --request POST \
--url 'https://{domain}/Statement/{ItemCode}/{MgtKey}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--header 'X-HTTP-Method-Override: EMAIL' \
--data '{
"receiver": "test@test.com"
}'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | number | - |
API 처리에 대한 응답코드
1성공
|
|
| message | string | - | API 처리에 대한 응답메시지 |
응답 예시
{
"code": 1,
"message": "이메일 재전송 완료"
}
6. SendSMS - 문자 재전송
POST
https://popbill-test.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}
POST
https://popbill.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}
- 전자명세서와 관련된 안내 SMS(단문) 문자를 재전송하는 함수로, 팝빌 사이트 [ 문자 > 결과 > 전송결과 ] 메뉴에서 전송결과를 확인할 수 있습니다.
- 메시지는 최대 90byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송합니다. (한글 최대 45자)
유의사항
- API 호출 시 포인트가 차감됩니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Content-Type | Y | 요청 본문 형식 application/json |
|
| Accept-Language | N |
응답 언어 설정
ko-KR: 기본값
en-US
|
|
| Accept-Encoding | N | 응답 압축 방식 gzip |
|
| X-HTTP-Method-Override | Y | 요청 메서드 재정의 SMS |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
Path 파라미터
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| ItemCode | number | - | Y |
전자명세서 문서 유형 (택 1)
|
|
| MgtKey | string | 24 | Y | 파트너가 할당한 문서번호 |
요청 본문
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| sender | string | - | Y | 발신번호 | |
| receiver | string | - | Y | 수신번호 | |
| contents | string | 90 | Y |
메시지 내용
최대 90 byte까지 입력 가능하고, 초과한 내용은 자동으로 삭제되어 전송
|
요청 예시
curl --request POST \
--url 'https://{domain}/Statement/{ItemCode}/{MgtKey}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--header 'X-HTTP-Method-Override: SMS' \
--data '{
"sender": "발신번호",
"receiver": "수신번호",
"contents": "메시지 내용"
}'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | number | - |
API 처리에 대한 응답코드
1성공
|
|
| message | string | - | API 처리에 대한 응답메시지 |
응답 예시
{
"code": 1,
"message": "문자알림 재전송 완료"
}
7. SendFAX - 팩스 전송
POST
https://popbill-test.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}
POST
https://popbill.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}
- 전자명세서를 팩스로 전송하는 함수로, 팝빌 사이트 [ 팩스 > 결과 > 전송결과 ] 메뉴에서 전송결과를 확인할 수 있습니다.
유의사항
- API 호출 시 포인트가 차감됩니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Content-Type | Y | 요청 본문 형식 application/json |
|
| Accept-Language | N |
응답 언어 설정
ko-KR: 기본값
en-US
|
|
| Accept-Encoding | N | 응답 압축 방식 gzip |
|
| X-HTTP-Method-Override | Y | 요청 메서드 재정의 FAX |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
Path 파라미터
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| ItemCode | number | - | Y |
전자명세서 문서 유형 (택 1)
|
|
| MgtKey | string | 24 | Y | 파트너가 할당한 문서번호 |
요청 본문
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| sender | string | - | Y | 발신번호 | |
| receiver | string | - | Y | 수신번호 |
요청 예시
curl --request POST \
--url 'https://{domain}/Statement/{ItemCode}/{MgtKey}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--header 'X-HTTP-Method-Override: FAX' \
--data '{
"sender": "발신번호",
"receiver": "수신번호"
}'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | number | - |
API 처리에 대한 응답코드
1성공
|
|
| message | string | - | API 처리에 대한 응답메시지 |
응답 예시
{
"code": 1,
"message": "팩스 재전송 완료"
}
8. FAXSend - 선팩스 전송
POST
https://popbill-test.linkhub.co.kr/Statement
POST
https://popbill.linkhub.co.kr/Statement
- 전자명세서를 팩스로 전송하는 함수로, 팝빌에 데이터를 저장하는 과정이 없습니다.
- 팝빌 사이트 [ 팩스 > 결과 > 전송결과 ] 메뉴에서 전송결과를 확인할 수 있습니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Content-Type | Y | 요청 본문 형식 application/json |
|
| Accept-Language | N |
응답 언어 설정
ko-KR: 기본값
en-US
|
|
| Accept-Encoding | N | 응답 압축 방식 gzip |
|
| X-HTTP-Method-Override | Y | 요청 메서드 재정의 FAX |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
요청 본문
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| itemCode | number | 3 | Y |
전자명세서 문서 유형 (택 1)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| mgtKey | string | 24 | Y |
문서번호
전자명세서 관리를 위해 파트너가 할당하는 식별번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| formCode | string | 8 | N |
맞춤양식 코드
기본값 : 팝빌에서 설정한 기본양식 사용
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| writeDate | string | 8 | Y |
작성일자
형식 : yyyyMMdd
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| taxType | string | 2 | 조건부 |
과세형태 (택 1)
과세
영세
면세
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| purposeType | string | - | Y |
영수/청구 (택 1)
영수
청구
없음
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| serialNum | string | 30 | N | 일련번호 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| taxTotal | string | 18 | Y |
세액 합계
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| supplyCostTotal | string | 18 | Y |
공급가액 합계
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| totalAmount | string | 18 | N |
합계금액
정수만 입력 가능
마이너스 금액 입력 가능, 소수점 아래 자동 절사 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| remark1 | string | 150 | N | 비고1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| remark2 | string | 150 | N | 비고2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| remark3 | string | 150 | N | 비고3 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| senderCorpNum | string | 10 | Y | 발신자 사업자번호 ('-' 제외) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| senderTaxRegID | string | 4 | N |
발신자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| senderCorpName | string | 200 | N | 발신자 상호 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| senderCEOName | string | 100 | N | 발신자 대표자성명 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| senderAddr | string | 300 | N | 발신자 주소 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| senderBizType | string | 100 | N | 발신자 업태 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| senderBizClass | string | 100 | N | 발신자 종목 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| senderContactName | string | 100 | N | 발신자 성명 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| senderDeptName | string | 40 | N | 발신자 부서명 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| senderTEL | string | 20 | N | 발신자 연락처 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| senderHP | string | 20 | N | 발신자 휴대전화 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| senderEmail | string | 100 | N | 발신자 메일주소 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| senderFAX | string | 20 | N | 발신자 팩스번호 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receiverCorpNum | string | 10 | N | 수신자 사업자번호 ('-' 제외) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receiverTaxRegID | string | 4 | N |
수신자 종사업장 식별번호
종사업장 식별번호는 4자리 숫자로만 구성
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receiverCorpName | string | 200 | N | 수신자 상호 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receiverCEOName | string | 100 | N | 수신자 대표자성명 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receiverAddr | string | 300 | N | 수신자 주소 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receiverBizType | string | 100 | N | 수신자 업태 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receiverBizClass | string | 100 | N | 수신자 종목 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receiverContactName | string | 100 | N | 수신자 성명 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receiverDeptName | string | 40 | N | 수신자 부서명 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receiverTEL | string | 20 | N | 수신자 연락처 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receiverHP | string | 20 | N | 수신자 휴대전화 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receiverEmail | string | 100 | N | 수신자 메일주소 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receiverFAX | string | 20 | N | 수신자 팩스번호 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| businessLicenseYN | boolean | - | N |
팝빌에 등록된 사업자등록증 첨부 여부
true첨부
false미첨부 : 기본값
팝빌 사이트 또는 [GetSealURL - 인감 및 첨부문서 등록 팝업 URL]을 이용하여 등록
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| bankBookYN | boolean | - | N |
팝빌에 등록된 통장사본 첨부 여부
true첨부
false미첨부 : 기본값
팝빌 사이트 또는 [GetSealURL - 인감 및 첨부문서 등록 팝업 URL]을 이용하여 등록
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| smssendYN | boolean | - | N |
알림문자 전송 여부
true전송
false미전송 : 기본값
수신자 : 수신자 휴대폰번호 {receiverHP}
문자 전송 포인트가 차감(단, 전송실패 건은 환불) |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| propertyBag | object | - | N |
추가속성
전자명세서 종류별 추가할 속성을 "key", "value" 형식으로 값을 입력
[참고] 기본양식 추가속성
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| detailList | array | - | N |
거래 물품 상세정보
길이 제한 없음
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sendNum | string | - | Y |
발신번호
팝빌에 사전등록되지 않은 발신번호를 입력시 '원발신번호'로 전송됨
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| receiveNum | string | - | Y | 수신번호 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
요청 예시
curl --request POST \
--url 'https://{domain}/Statement' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--header 'X-HTTP-Method-Override: FAX' \
--data '{
"itemCode": 121,
"mgtKey": "TEST00017",
"writeDate": "20251024",
"taxType": "과세",
"purposeType": "청구",
"taxTotal": "1000",
"supplyCostTotal": "10000",
"senderCorpNum": "1234567890",
"receiverCorpName": "수신자 상호",
"sendNum": "16009854",
"receiveNum": "02-6442-9700"
}'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| receiptNum | string | 18 | 접수번호 |
응답 예시
{
"receiptNum": "025102415352200002"
}
9. AttachStatement - 전자명세서 첨부
POST
https://popbill-test.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}/AttachStmt
POST
https://popbill.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}/AttachStmt
- 하나의 전자명세서에 다른 전자명세서를 첨부합니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Content-Type | Y | 요청 본문 형식 application/json |
|
| Accept-Language | N |
응답 언어 설정
ko-KR: 기본값
en-US
|
|
| Accept-Encoding | N | 응답 압축 방식 gzip |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
Path 파라미터
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| ItemCode | number | - | Y |
전자명세서 문서 유형 (택 1)
|
|
| MgtKey | string | 24 | Y | 파트너가 할당한 문서번호 |
요청 본문
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| ItemCode | number | - | Y |
첨부할 전자명세서 문서 유형 (택 1)
|
|
| MgtKey | string | 24 | Y | 첨부할 전자명세서 문서번호 |
요청 예시
curl --request POST \
--url 'https://{domain}/Statement/{ItemCode}/{MgtKey}/AttachStmt' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"ItemCode": 121,
"MgtKey": "TEST00001"
}'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | number | - |
API 처리에 대한 응답코드
1성공
|
|
| message | string | - | API 처리에 대한 응답메시지 |
응답 예시
{
"code": 1,
"message": "첨부 완료"
}
10. DetachStatement - 전자명세서 첨부해제
POST
https://popbill-test.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}/DetachStmt
POST
https://popbill.linkhub.co.kr/Statement/{ItemCode}/{MgtKey}/DetachStmt
- 하나의 전자명세서에 첨부된 다른 전자명세서를 해제합니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Content-Type | Y | 요청 본문 형식 application/json |
|
| Accept-Language | N |
응답 언어 설정
ko-KR: 기본값
en-US
|
|
| Accept-Encoding | N | 응답 압축 방식 gzip |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
Path 파라미터
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| ItemCode | number | - | Y |
전자명세서 문서 유형 (택 1)
|
|
| MgtKey | string | 24 | Y | 파트너가 할당한 문서번호 |
요청 본문
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| ItemCode | number | - | Y |
첨부해제할 전자명세서 문서 유형 (택 1)
|
|
| MgtKey | string | 24 | Y | 첨부해제할 전자명세서 문서번호 |
요청 예시
curl --request POST \
--url 'https://{domain}/Statement/{ItemCode}/{MgtKey}/DetachStmt' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"ItemCode": 121,
"MgtKey": "TEST00001"
}'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | number | - |
API 처리에 대한 응답코드
1성공
|
|
| message | string | - | API 처리에 대한 응답메시지 |
응답 예시
{
"code": 1,
"message": "첨부해제 완료"
}
11. ListEmailConfig - 알림메일 발송설정 조회
GET
https://popbill-test.linkhub.co.kr/Statement/EmailSendConfig
GET
https://popbill.linkhub.co.kr/Statement/EmailSendConfig
- 전자명세서 관련 메일 항목에 대한 발송설정을 확인합니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Accept-Language | N |
응답 언어 설정
ko-KR: 기본값
en-US
|
|
| Accept-Encoding | N | 응답 압축 방식 gzip |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
요청 예시
curl --request GET \
--url 'https://{domain}/Statement/EmailSendConfig' \
--header 'Authorization: Bearer {token}'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| emailType | string | 32 |
메일 전송 유형
SMT_ISSUE
수신자에게 전자명세서가 발행 되었음을 알려주는 메일
SMT_ACCEPT
발신자에게 전자명세서가 승인 되었음을 알려주는 메일
SMT_DENY
발신자에게 전자명세서가 거부 되었음을 알려주는 메일
SMT_CANCEL
수신자에게 전자명세서가 취소 되었음을 알려주는 메일
SMT_CANCEL_ISSUE
수신자에게 전자명세서가 발행취소 되었음을 알려주는 메일 |
|
| sendYN | boolean | - |
전송 여부
true전송
false미전송
|
응답 예시
[
{
"emailType": "SMT_ISSUE",
"sendYN": true
},
{
"emailType": "SMT_ACCEPT",
"sendYN": true
},
{
"emailType": "SMT_DENY",
"sendYN": true
},
{
"emailType": "SMT_CANCEL",
"sendYN": true
},
{
"emailType": "SMT_CANCEL_ISSUE",
"sendYN": true
}
]
12. UpdateEmailConfig - 알림메일 발송설정 수정
POST
https://popbill-test.linkhub.co.kr/Statement/EmailSendConfig
POST
https://popbill.linkhub.co.kr/Statement/EmailSendConfig
- 전자명세서 관련 메일 항목에 대한 발송설정을 수정합니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| Authorization | Y | 인증 토큰 | |
| Accept-Language | N |
응답 언어 설정
ko-KR: 기본값
en-US
|
|
| Accept-Encoding | N | 응답 압축 방식 gzip |
|
| X-PB-UserID | N | 팝빌회원 아이디 |
Query 파라미터
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| EmailType | string | - | Y |
메일 전송 유형
SMT_ISSUE
수신자에게 전자명세서가 발행 되었음을 알려주는 메일
SMT_ACCEPT
발신자에게 전자명세서가 승인 되었음을 알려주는 메일
SMT_DENY
발신자에게 전자명세서가 거부 되었음을 알려주는 메일
SMT_CANCEL
수신자에게 전자명세서가 취소 되었음을 알려주는 메일
SMT_CANCEL_ISSUE
수신자에게 전자명세서가 발행취소 되었음을 알려주는 메일 |
|
| SendYN | boolean | - | Y |
전송 여부
true전송
false미전송
|
요청 예시
curl --request POST \
--url 'https://{domain}/Statement/EmailSendConfig?EmailType={EmailType}&SendYN={SendYN}' \
--header 'Authorization: Bearer {token}'
Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | number | - |
API 처리에 대한 응답코드
1성공
|
|
| message | string | - | API 처리에 대한 응답메시지 |
응답 예시
{
"code": 1,
"message": "수정 완료"
}
