개발자 문서
API 레퍼런스

연금보험료

1. 국민연금 고지 안내 문구nps_edi.b1.national_pension_premiums.guide

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

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

국민연금 EDI 고지 안내·도움말 텍스트를 조회합니다. 고지 선택과 무관합니다.

  • 로그인을 먼저 호출해 세션을 만든 뒤, 같은 account_link_id 로 호출합니다. [국민연금공단 EDI 로그인]
  • result.data.error_code=PENSION_GUIDE_DATASET_EMPTY.
  • params 는 빈 객체로 보냅니다. 고지 선택 단계는 필요하지 않습니다.
Request
순번변수명필수설명
AuthorizationYAPI 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다.

형식 : Basic base64("{client_id}:{client_secret}")

[참고] 인증

X-Env-ScopeY호출 환경입니다.
  • sandbox샌드박스 — 모의 응답
  • real_test데모 — 하루 100 사용 토큰
  • production정식 — 유료 플랜 전용

[참고] 환경

Idempotency-KeyY재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다.

[참고] 재시도

Content-TypeY요청 본문 형식입니다.
  • application/json고정값 (기본값)
X-Trace-IdN추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.
순번변수명타입길이필수설명
providerstring-Y호출할 기관입니다.
  • nps_edi이 API 고정값 (기본값)

예시 : nps_edi

actionstring-Y호출할 작업입니다.
  • nps_edi.b1.national_pension_premiums.guide이 API 고정값 (기본값)

예시 : nps_edi.b1.national_pension_premiums.guide

account_link_idstring36조건부등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다.

형식 : UUID v4

[참고] 자격증명 등록

paramsobject-N작업 파라미터입니다. 이 API 는 빈 객체로 호출할 수 있습니다.
encrypted_fieldsobject-N민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다.

[참고] 암호화

추가 파라미터가 없습니다. params 는 {} 로 보냅니다.

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-guide-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nps_edi",
  "action": "nps_edi.b1.national_pension_premiums.guide",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'
Response
  • rows를 확인합니다.
순번변수명설명
rows안내·도움말 텍스트 행 배열
json
// result.data
{
  "rows": [
    {
      "row_index": 0,
      "row_key": "..."
    }
  ]
}

2. 국민연금 납부와 징수 이력nps_edi.b1.national_pension_premiums.payment_history

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

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

선택한 고지의 납부·징수 이력을 조회합니다.

  • 요약 조회와 선행 조건이 같습니다. 대상을 먼저 선택하거나 선택 조건을 함께 보냅니다. [국민연금공단 EDI 로그인]
  • rows가 0이어도 success=true, error_code=null.
Request
순번변수명필수설명
AuthorizationYAPI 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다.

형식 : Basic base64("{client_id}:{client_secret}")

[참고] 인증

X-Env-ScopeY호출 환경입니다.
  • sandbox샌드박스 — 모의 응답
  • real_test데모 — 하루 100 사용 토큰
  • production정식 — 유료 플랜 전용

[참고] 환경

Idempotency-KeyY재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다.

[참고] 재시도

Content-TypeY요청 본문 형식입니다.
  • application/json고정값 (기본값)
X-Trace-IdN추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.
순번변수명타입길이필수설명
providerstring-Y호출할 기관입니다.
  • nps_edi이 API 고정값 (기본값)

예시 : nps_edi

actionstring-Y호출할 작업입니다.
  • nps_edi.b1.national_pension_premiums.payment_history이 API 고정값 (기본값)

예시 : nps_edi.b1.national_pension_premiums.payment_history

account_link_idstring36조건부등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다.

형식 : UUID v4

[참고] 자격증명 등록

paramsobject-Y작업 파라미터입니다. 아래 params 파라미터 표의 필수 항목을 채워 보냅니다.
encrypted_fieldsobject-N민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다.

[참고] 암호화

순번변수명타입길이필수설명
row_indexnumber-Nsearch/select 결과 options[].row_index. 지정 시 세션 cached selected_notice 재선택
row_keystring-Nsearch/select 결과 options[].row_key
notice_year_monthstring6N고지 연월 cached selected_notice와 불일치 시 재선택

형식 : YYYYMM

installment_roundstring-N고지 차수. 1=1차(ED02), 2=2차(ED08). 정수 · 문자열 모두 허용
template_codestring-N고지 양식 코드 (예: ED02)
row_text_containsstring-N행 텍스트 부분 일치 필터
cell_text_containsstring-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-payment_history-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nps_edi",
  "action": "nps_edi.b1.national_pension_premiums.payment_history",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'
Response
  • rows·page를 확인합니다.
순번변수명설명
rows납부·징수 이력 행 배열
page페이지네이션 정보 객체
workplace사업장 정보 (사업장관리번호, 사업자번호, 연금번호, 사업장명, 지사, 가입자 수)
notice선택한 고지 정보 (귀속 연월, 회차, 서식, 문서번호, 접수일)
json
// result.data
{
  "rows": [
    {
      "row_index": 0,
      "row_key": "..."
    }
  ],
  "page": {},
  "workplace": {},
  "notice": {}
}
순번오류 코드발생 조건
PROVIDER_VALIDATION_ERROR선택 오류 — 고지 내역을 먼저 선택(select)해야 하거나, 조건에 맞는 행을 찾지 못했습니다.

3. 국민연금 소급분과 추가징수 내역nps_edi.b1.national_pension_premiums.retro_payments

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

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

선택한 고지의 소급분·추가징수 내역을 조회합니다.

  • 요약 조회와 선행 조건이 같습니다. 대상을 먼저 선택하거나 선택 조건을 함께 보냅니다. [국민연금공단 EDI 로그인]
  • rows가 0이어도 success=true, error_code=null.
Request
순번변수명필수설명
AuthorizationYAPI 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다.

형식 : Basic base64("{client_id}:{client_secret}")

[참고] 인증

X-Env-ScopeY호출 환경입니다.
  • sandbox샌드박스 — 모의 응답
  • real_test데모 — 하루 100 사용 토큰
  • production정식 — 유료 플랜 전용

[참고] 환경

Idempotency-KeyY재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다.

[참고] 재시도

Content-TypeY요청 본문 형식입니다.
  • application/json고정값 (기본값)
X-Trace-IdN추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.
순번변수명타입길이필수설명
providerstring-Y호출할 기관입니다.
  • nps_edi이 API 고정값 (기본값)

예시 : nps_edi

actionstring-Y호출할 작업입니다.
  • nps_edi.b1.national_pension_premiums.retro_payments이 API 고정값 (기본값)

예시 : nps_edi.b1.national_pension_premiums.retro_payments

account_link_idstring36조건부등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다.

형식 : UUID v4

[참고] 자격증명 등록

paramsobject-Y작업 파라미터입니다. 아래 params 파라미터 표의 필수 항목을 채워 보냅니다.
encrypted_fieldsobject-N민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다.

[참고] 암호화

순번변수명타입길이필수설명
row_indexnumber-Nsearch/select 결과 options[].row_index. 지정 시 세션 cached selected_notice 재선택
row_keystring-Nsearch/select 결과 options[].row_key
notice_year_monthstring6N고지 연월 cached selected_notice와 불일치 시 재선택

형식 : YYYYMM

installment_roundstring-N고지 차수. 1=1차(ED02), 2=2차(ED08). 정수 · 문자열 모두 허용
template_codestring-N고지 양식 코드 (예: ED02)
row_text_containsstring-N행 텍스트 부분 일치 필터
cell_text_containsstring-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-retro_payments-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nps_edi",
  "action": "nps_edi.b1.national_pension_premiums.retro_payments",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'
Response
  • rows를 확인합니다.
순번변수명설명
rows소급분·추가징수 행 배열
workplace사업장 정보 (사업장관리번호, 사업자번호, 연금번호, 사업장명, 지사, 가입자 수)
notice선택한 고지 정보 (귀속 연월, 회차, 서식, 문서번호, 접수일)
json
// result.data
{
  "rows": [
    {
      "row_index": 0,
      "row_key": "..."
    }
  ],
  "workplace": {},
  "notice": {}
}
순번오류 코드발생 조건
PROVIDER_VALIDATION_ERROR선택 오류 — 고지 내역을 먼저 선택(select)해야 하거나, 조건에 맞는 행을 찾지 못했습니다.

4. 국민연금 가입자별 보험료 내역nps_edi.b1.national_pension_premiums.subscribers

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

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

선택한 고지의 가입자별 보험료 내역(members)을 조회합니다.

  • 요약 조회와 선행 조건이 같습니다. 대상을 먼저 선택하거나 선택 조건을 함께 보냅니다. [국민연금공단 EDI 로그인]
  • result.data.error_code=PENSION_SUBSCRIBER_DATASET_EMPTY.
Request
순번변수명필수설명
AuthorizationYAPI 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다.

형식 : Basic base64("{client_id}:{client_secret}")

[참고] 인증

X-Env-ScopeY호출 환경입니다.
  • sandbox샌드박스 — 모의 응답
  • real_test데모 — 하루 100 사용 토큰
  • production정식 — 유료 플랜 전용

[참고] 환경

Idempotency-KeyY재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다.

[참고] 재시도

Content-TypeY요청 본문 형식입니다.
  • application/json고정값 (기본값)
X-Trace-IdN추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.
순번변수명타입길이필수설명
providerstring-Y호출할 기관입니다.
  • nps_edi이 API 고정값 (기본값)

예시 : nps_edi

actionstring-Y호출할 작업입니다.
  • nps_edi.b1.national_pension_premiums.subscribers이 API 고정값 (기본값)

예시 : nps_edi.b1.national_pension_premiums.subscribers

account_link_idstring36조건부등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다.

형식 : UUID v4

[참고] 자격증명 등록

paramsobject-Y작업 파라미터입니다. 아래 params 파라미터 표의 필수 항목을 채워 보냅니다.
encrypted_fieldsobject-N민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다.

[참고] 암호화

순번변수명타입길이필수설명
row_indexnumber-Nsearch/select 결과 options[].row_index. 지정 시 세션 cached selected_notice 재선택
row_keystring-Nsearch/select 결과 options[].row_key
notice_year_monthstring6N고지 연월 cached selected_notice와 불일치 시 재선택

형식 : YYYYMM

installment_roundstring-N고지 차수. 1=1차(ED02), 2=2차(ED08). 정수 · 문자열 모두 허용
template_codestring-N고지 양식 코드 (예: ED02)
row_text_containsstring-N행 텍스트 부분 일치 필터
cell_text_containsstring-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-subscribers-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nps_edi",
  "action": "nps_edi.b1.national_pension_premiums.subscribers",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'
Response
  • members를 확인합니다.
순번변수명설명
members가입자별 보험료 내역 배열
workplace사업장 정보 (사업장관리번호, 사업자번호, 연금번호, 사업장명, 지사, 가입자 수)
notice선택한 고지 정보 (귀속 연월, 회차, 서식, 문서번호, 접수일)
summary가입자 합계 (인원수, 기준소득월액, 연금보험료, 근로자와 사업주 부담금)
json
// result.data
{
  "members": [
    {
      "row_index": 0,
      "row_key": "..."
    }
  ],
  "workplace": {},
  "notice": {},
  "summary": {}
}
순번오류 코드발생 조건
PROVIDER_VALIDATION_ERROR선택 오류 — 고지 내역을 먼저 선택(select)해야 하거나, 조건에 맞는 행을 찾지 못했습니다.

5. 국민연금 보험료 결정 요약nps_edi.b1.national_pension_premiums.summary

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

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

선택한 고지의 결정 요약(summary)을 조회합니다.

  • 고지 선택을 먼저 호출하거나, 선택 조건으로 고지를 지정합니다. [국민연금공단 EDI 로그인]
  • result.data.error_code=PENSION_SUMMARY_DATASET_EMPTY.
  • 선택을 먼저 하면 params 를 빈 객체로 보낼 수 있습니다. row_text_contains 만으로는 보험료를 다시 선택할 수 없습니다.
Request
순번변수명필수설명
AuthorizationYAPI 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다.

형식 : Basic base64("{client_id}:{client_secret}")

[참고] 인증

X-Env-ScopeY호출 환경입니다.
  • sandbox샌드박스 — 모의 응답
  • real_test데모 — 하루 100 사용 토큰
  • production정식 — 유료 플랜 전용

[참고] 환경

Idempotency-KeyY재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다.

[참고] 재시도

Content-TypeY요청 본문 형식입니다.
  • application/json고정값 (기본값)
X-Trace-IdN추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.
순번변수명타입길이필수설명
providerstring-Y호출할 기관입니다.
  • nps_edi이 API 고정값 (기본값)

예시 : nps_edi

actionstring-Y호출할 작업입니다.
  • nps_edi.b1.national_pension_premiums.summary이 API 고정값 (기본값)

예시 : nps_edi.b1.national_pension_premiums.summary

account_link_idstring36조건부등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다.

형식 : UUID v4

[참고] 자격증명 등록

paramsobject-Y작업 파라미터입니다. 아래 params 파라미터 표의 필수 항목을 채워 보냅니다.
encrypted_fieldsobject-N민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다.

[참고] 암호화

순번변수명타입길이필수설명
row_indexnumber-Nsearch/select 결과 options[].row_index. 지정 시 세션 cached selected_notice 재선택
row_keystring-Nsearch/select 결과 options[].row_key
notice_year_monthstring6N고지 연월 cached selected_notice와 불일치 시 재선택

형식 : YYYYMM

installment_roundstring-N고지 차수. 1=1차(ED02), 2=2차(ED08). 정수 · 문자열 모두 허용
template_codestring-N고지 양식 코드 (예: ED02)
row_text_containsstring-N행 텍스트 부분 일치 필터
cell_text_containsstring-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-summary-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nps_edi",
  "action": "nps_edi.b1.national_pension_premiums.summary",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'
Response
  • summary·notice를 확인합니다.
순번변수명설명
summary고지 결정 요약 객체
notice고지 기본정보 객체
workplace사업장 정보 (사업장관리번호, 사업자번호, 연금번호, 사업장명, 지사, 가입자 수)
selected_option선택한 고지 행 정보 (문서번호, 서식, 귀속 연월, 회차, 접수일)
json
// result.data
{
  "summary": {},
  "notice": {},
  "workplace": {},
  "selected_option": {}
}
순번오류 코드발생 조건
PROVIDER_VALIDATION_ERROR선택 오류 — 고지 내역을 먼저 선택(select)해야 하거나, 조건에 맞는 행을 찾지 못했습니다.

6. 국민연금 지원금과 보조 내역nps_edi.b1.national_pension_premiums.support_details

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

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

선택한 고지의 지원금·보조 내역을 조회합니다.

  • 요약 조회와 선행 조건이 같습니다. 대상을 먼저 선택하거나 선택 조건을 함께 보냅니다. [국민연금공단 EDI 로그인]
  • result.data.error_code=PENSION_SUPPORT_DATASET_EMPTY.
Request
순번변수명필수설명
AuthorizationYAPI 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다.

형식 : Basic base64("{client_id}:{client_secret}")

[참고] 인증

X-Env-ScopeY호출 환경입니다.
  • sandbox샌드박스 — 모의 응답
  • real_test데모 — 하루 100 사용 토큰
  • production정식 — 유료 플랜 전용

[참고] 환경

Idempotency-KeyY재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다.

[참고] 재시도

Content-TypeY요청 본문 형식입니다.
  • application/json고정값 (기본값)
X-Trace-IdN추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.
순번변수명타입길이필수설명
providerstring-Y호출할 기관입니다.
  • nps_edi이 API 고정값 (기본값)

예시 : nps_edi

actionstring-Y호출할 작업입니다.
  • nps_edi.b1.national_pension_premiums.support_details이 API 고정값 (기본값)

예시 : nps_edi.b1.national_pension_premiums.support_details

account_link_idstring36조건부등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다.

형식 : UUID v4

[참고] 자격증명 등록

paramsobject-Y작업 파라미터입니다. 아래 params 파라미터 표의 필수 항목을 채워 보냅니다.
encrypted_fieldsobject-N민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다.

[참고] 암호화

순번변수명타입길이필수설명
row_indexnumber-Nsearch/select 결과 options[].row_index. 지정 시 세션 cached selected_notice 재선택
row_keystring-Nsearch/select 결과 options[].row_key
notice_year_monthstring6N고지 연월 cached selected_notice와 불일치 시 재선택

형식 : YYYYMM

installment_roundstring-N고지 차수. 1=1차(ED02), 2=2차(ED08). 정수 · 문자열 모두 허용
template_codestring-N고지 양식 코드 (예: ED02)
row_text_containsstring-N행 텍스트 부분 일치 필터
cell_text_containsstring-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-support_details-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nps_edi",
  "action": "nps_edi.b1.national_pension_premiums.support_details",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'
Response
  • members·support_details를 확인합니다.
순번변수명설명
members가입자 지원금 내역 배열
support_details보조 지원 상세 객체
workplace사업장 정보 (사업장관리번호, 사업자번호, 연금번호, 사업장명, 지사, 가입자 수)
notice선택한 고지 정보 (귀속 연월, 회차, 서식, 문서번호, 접수일)
summary지원 요약 (가입자 수, 지원 내역 수, 지원금 합계)
json
// result.data
{
  "members": [
    {
      "row_index": 0,
      "row_key": "..."
    }
  ],
  "support_details": [],
  "workplace": {},
  "notice": {},
  "summary": {}
}
순번오류 코드발생 조건
PROVIDER_VALIDATION_ERROR선택 오류 — 고지 내역을 먼저 선택(select)해야 하거나, 조건에 맞는 행을 찾지 못했습니다.