문서함

1. 문서함 보낸문서 상세 조회nhis_edi.document_box.sent_documents.detail

POSThttps://api.xdata.kr/v1/jobsX-Env-Scope: sandbox

샌드박스입니다. 실제 기관을 호출하지 않는 모의 응답이며 일일 한도가 없습니다.

보낸문서 1건의 BMAB_020 상세(datasets·visible_fields)를 조회합니다.

보낸 문서 목록을 먼저 조회하고 호출합니다. 생략하면 내부에서 자동으로 목록을 가져옵니다. [국민건강보험공단 EDI 로그인]
list 후 selector 생략 시 첫 list_rows 행을 자동 선택합니다.

Request

변수명	필수	설명
Authorization	Y	API 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다. 형식 : Basic base64("{client_id}:{client_secret}") [참고] 인증
X-Env-Scope	Y	호출 환경입니다. `sandbox`샌드박스 — 모의 응답 `real_test`데모 — 하루 100 사용 토큰 `production`정식 — 유료 플랜 전용 [참고] 환경
Idempotency-Key	Y	재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다. [참고] 재시도
Content-Type	Y	요청 본문 형식입니다. `application/json`고정값 (기본값)
X-Trace-Id	N	추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.

변수명	타입	길이	필수	설명
provider	string	-	Y	호출할 기관입니다. `nhis_edi`이 API 고정값 (기본값) 예시 : nhis_edi
action	string	-	Y	호출할 작업입니다. `nhis_edi.document_box.sent_documents.detail`이 API 고정값 (기본값) 예시 : nhis_edi.document_box.sent_documents.detail
account_link_id	string	36	조건부	등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다. 형식 : UUID v4 [참고] 자격증명 등록
params	object	-	Y	작업 파라미터입니다. 아래 params 파라미터 표의 필수 항목을 채워 보냅니다.
encrypted_fields	object	-	N	민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다. [참고] 암호화

변수명	타입	길이	필수	설명
from_date	string	8	N	보낸문서 목록 조회기간 시작일 미입력 시 화면 기본 범위 형식 : YYYYMMDD
to_date	string	8	N	보낸문서 목록 조회기간 종료일 미입력 시 화면 기본 범위 형식 : YYYYMMDD
form_name	string	-	N	상단 서식명 선택값. 예: 전체 또는 4대보험 기준소득월액/보수월액/월평균보수 변경신청서
gubun	string	-	N	상단 구분 선택값. 미입력 시 전체
ykiho	string	-	N	상단 요양기관기호/대상기관 필터
jumin_no	string	-	N	상단 주민등록번호 필터
include_form_options	boolean	-	N	상세 선택 전에 서식명 옵션 목록까지 포함해서 목록 조회할지 여부
row_index	number	-	N	보낸문서 목록에서 선택할 행 번호
row_key	string	-	N	보낸문서 목록 row 식별키
wrt_chasu	string	-	N	작성 차수 WRT_CHASU
wrt_dup_seq	string	-	N	작성 중복순번 WRT_DUP_SEQ
form_code	string	-	N	양식 DOCID. 현재 상세 지원은 BMAB_020만
firm_sym	string	-	N	사업장기호 FIRM_SYM
unit_firm_sym	string	-	N	단위사업장기호
efirm_sym	string	-	N	요양기관기호 EFIRM_SYM

bash

curl --request POST \
  --url 'https://api.xdata.kr/v1/jobs' \
  --header 'Authorization: Basic {base64(client_id:client_secret)}' \
  --header 'X-Env-Scope: sandbox' \
  --header 'Idempotency-Key: demo-detail-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nhis_edi",
  "action": "nhis_edi.document_box.sent_documents.detail",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'

Response

detail·datasets·visible_fields·screen를 확인합니다.

순번	변수명	설명
	detail	문서 상세 메타 객체
	datasets	데이터셋 배열
	visible_fields	화면 표시 필드 배열
	screen	화면 정보 객체
	row_index	행 번호
	row_key	행 키
	form_code	서식 코드
	document_id	기관 화면 문서 id
	document_name	문서 이름
	selected_row	선택한 행 원본
	detail_request	상세 조회 요청 값
	typed	형식을 맞춰 정리한 상세 값
	form_contract	화면 입력 계약 (항목 정의)
	screen_sections	화면 구역 구성
	business_info	사업장 정보 항목
	form_header	화면 머리 정보
	insurance_sections	보험별 구역 구성
	target_table	대상 표 이름
	excel_ready	엑셀 내려받기 준비 여부
	fields	입력 필드 정의 배열
	grid_columns	표 열 목록
	rows	조회 행
	bootstrap_datasets	화면 초기 로딩 데이터셋
	processing_datasets	처리 데이터셋
	processing_detail_rows	처리 상세 행
	processing_result	처리 결과
	support_datasets	보조 데이터셋
	support_detail_rows	보조 상세 행
	response_dataset_row_counts	데이터셋별 행 수
	detail_source	상세 데이터를 가져온 전략 이름
	detail_source_attempts	상세 조회 전략별 시도 결과
	notice_texts	화면에 표시된 안내 문구 목록
	transport_evidence	기관 통신 근거(요청·응답 URL, 크기, 상태 코드)
	visible_buttons	화면에 표시된 버튼 목록
	visible_text	화면에 표시된 값을 합친 텍스트

json

// result.data
{
  "detail": {},
  "datasets": {},
  "visible_fields": [],
  "screen": {},
  "row_index": 0,
  "row_key": "...",
  "form_code": "...",
  "document_id": "...",
  "document_name": "...",
  "selected_row": {},
  "detail_request": {},
  "typed": {},
  "form_contract": {},
  "screen_sections": [],
  "business_info": {},
  "form_header": {},
  "insurance_sections": {},
  "target_table": {},
  "excel_ready": {},
  "fields": [],
  "grid_columns": [],
  "rows": [
    {
      "row_index": 0,
      "row_key": "..."
    }
  ],
  "bootstrap_datasets": {},
  "processing_datasets": {},
  "processing_detail_rows": [],
  "processing_result": {},
  "support_datasets": {},
  "support_detail_rows": [],
  "response_dataset_row_counts": {},
  "detail_source": "...",
  "detail_source_attempts": [],
  "notice_texts": [],
  "transport_evidence": {},
  "visible_buttons": [],
  "visible_text": "..."
}

순번	오류 코드	발생 조건
	PROVIDER_VALIDATION_ERROR	행 없음 — 조건에 맞는 행을 찾지 못했습니다.
	PROVIDER_VALIDATION_ERROR	양식 미지원 — 상세 조회는 BMAB_020 양식만 지원합니다.
	PROVIDER_VALIDATION_ERROR	키 부족 — 상세 조회에 필요한 값(WRT_CHASU · WRT_DUP_SEQ · FIRM_SYM)을 요청과 선택한 행에서 찾지 못했습니다.

2. 문서함 보낸문서 목록 조회nhis_edi.document_box.sent_documents.list

POSThttps://api.xdata.kr/v1/jobsX-Env-Scope: sandbox

샌드박스입니다. 실제 기관을 호출하지 않는 모의 응답이며 일일 한도가 없습니다.

문서함 WETC_100 보낸문서 목록(list_rows)·양식 옵션(form_options)을 조회합니다.

로그인을 먼저 호출해 세션을 만든 뒤, 같은 account_link_id 로 호출합니다. [국민건강보험공단 EDI 로그인]
row_count=0 — 별도 error_code 없음.
params 는 빈 객체로 보내도 호출됩니다. from_date 와 to_date 를 지정하지 않으면 3개월 전부터 오늘까지 조회합니다. form_code 는 기본값이 00000000, include_form_options 는 기본값이 true 입니다.

Request

변수명	필수	설명
Authorization	Y	API 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다. 형식 : Basic base64("{client_id}:{client_secret}") [참고] 인증
X-Env-Scope	Y	호출 환경입니다. `sandbox`샌드박스 — 모의 응답 `real_test`데모 — 하루 100 사용 토큰 `production`정식 — 유료 플랜 전용 [참고] 환경
Idempotency-Key	Y	재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다. [참고] 재시도
Content-Type	Y	요청 본문 형식입니다. `application/json`고정값 (기본값)
X-Trace-Id	N	추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.

변수명	타입	길이	필수	설명
provider	string	-	Y	호출할 기관입니다. `nhis_edi`이 API 고정값 (기본값) 예시 : nhis_edi
action	string	-	Y	호출할 작업입니다. `nhis_edi.document_box.sent_documents.list`이 API 고정값 (기본값) 예시 : nhis_edi.document_box.sent_documents.list
account_link_id	string	36	조건부	등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다. 형식 : UUID v4 [참고] 자격증명 등록
params	object	-	Y	작업 파라미터입니다. 아래 params 파라미터 표의 필수 항목을 채워 보냅니다.
encrypted_fields	object	-	N	민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다. [참고] 암호화

변수명	타입	길이	필수	설명
from_date	string	8	N	조회기간 시작일 미입력 시 오늘 기준 3개월 전 형식 : YYYYMMDD
to_date	string	8	N	조회기간 종료일 미입력 시 오늘 형식 : YYYYMMDD
form_code	string	-	N	양식 DOCID. 미입력 시 00000000(전체)
form_name	string	-	N	양식명으로 form_code 자동 해석
gubun	string	-	N	문서 구분. 미입력 시 0(전체)
ykiho	string	-	N	요양기관기호(EFIRM_SYM/YKIHO)
jumin_no	string	-	N	주민등록번호 13자리
include_form_options	boolean	-	N	양식 옵션 목록 포함 여부

bash

curl --request POST \
  --url 'https://api.xdata.kr/v1/jobs' \
  --header 'Authorization: Basic {base64(client_id:client_secret)}' \
  --header 'X-Env-Scope: sandbox' \
  --header 'Idempotency-Key: demo-list-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nhis_edi",
  "action": "nhis_edi.document_box.sent_documents.list",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'

Response

list_rows·form_options·category_options·filters를 확인합니다.

순번	변수명	설명
	list_rows	보낸문서 행 배열
	form_options	양식 옵션 배열
	category_options	카테고리 옵션 배열
	filters	필터 정보 객체
	resolved_selection	실제로 선택된 문서 값
	row_count	반환 행 수
	response_dataset_row_counts	데이터셋별 행 수
	transport_evidence	기관 통신 근거(요청·응답 URL, 크기, 상태 코드)

json

// result.data
{
  "list_rows": [
    {
      "row_index": 0,
      "row_key": "..."
    }
  ],
  "form_options": [],
  "category_options": [],
  "filters": {},
  "resolved_selection": {},
  "row_count": 1,
  "response_dataset_row_counts": {},
  "transport_evidence": {}
}

순번	오류 코드	발생 조건
	PROVIDER_UNAVAILABLE	사업장 정보 없음 — 세션에서 사업장 정보를 불러오지 못했습니다.
	PROVIDER_VALIDATION_ERROR	양식명 오류 — form_name 에 해당하는 양식을 찾지 못했습니다.