16 Commits

Author SHA1 Message Date
GA Pro 2a27aa31a0 fix: 모집정산 재실행 시 1200% clip 분급 UNIQUE 충돌 — 멱등성 보강
CalcRecruitStep(Step4)이 1200%룰 clip 초과분을 installment_plan(7년)으로 생성할 때,
재계산을 위해 recruit_ledger는 deleteBySettleMonth로 지우면서 분급은 정리하지 않아
같은 정산월을 재실행하면 동일 계약이 또 clip되어 동일 분급키(contract_id,plan_year,
plan_month)로 INSERT → UNIQUE 충돌로 Job 실패하던 버그.

수정: insertBatch 직전에 clip된 계약들의 SCHEDULED(미지급) 분급을 먼저 삭제
(InstallmentPlanMapper.deleteScheduledByContractIds). PAID 분급 이력은 보존하여
PayInstallmentStep 지급분과 충돌하지 않음.

검증: CalcRecruitStepTest 멱등 테스트(clip 시 delete→insert 순서/대상계약 검증) 추가,
전체 build SUCCESS. 라이브 E2E: 202605 정산을 연속 2회 실행 → 둘 다 COMPLETED,
분급 196건 불변(중복 0), settle_master gross 동일, 무결성 유지.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-13 00:09:35 +09:00
GA Pro 17ab1098ec feat: 1200%룰 이연 분급 도래월 지급(PayInstallmentStep) + 코드베이스 신입교육 주석
PayInstallmentStep(Step 4.5): 1200%룰로 이연된 분급(installment_plan SCHEDULED)을
도래월(settle_month=정산월)에 recruit_ledger로 편입해 실제 지급. 이전엔 이연만 되고
도래월 지급 절차가 없어 차액이 영구 미지급되던 갭을 메움.
- BatchConfig job flow에 step4b(calcRecruit→payInstallment→calcMaintain) 등록
- InstallmentPlanMapper.resetPaidToScheduledByMonth(+XML)로 재실행 멱등
  (진입 시 PAID→SCHEDULED 역산, Step4 deleteBySettleMonth가 원장 정리)
- RecruitLedgerMapper insert에 reconcile_status 컬럼, SettlementContext.installmentPaidCount
- 단위테스트 3건(정상지급/멱등/계약미존재) GREEN

신입교육 주석: 컨트롤러/서비스/공통/프론트 전반에 도메인·코드 설명 주석 추가
(동작 변경 없음 — 빌드/테스트/타입체크 전부 GREEN으로 무회귀 확인).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-12 23:40:28 +09:00
GA Pro 5f43c945f0 동기화 2026-06-08 21:34:10 +09:00
GA Pro 711f3b5e16 docs: 수수료 레퍼런스에 갭보완 4종(§3-7) 반영 + 간이지급명세서 주민번호 화면 마스킹
- 수수료_계산공식_전체레퍼런스.md: §3-7 감사 보완 4종(A 지급보류/B 환수원천세역분개/
  C 환수채권연체이자/D 간이지급명세서) 추가, schema v126 표기
- SimplifiedPaymentReport: 화면 표시용 주민번호 마스킹(생년월일+성별구분 이후 *).
  엑셀 export는 국세청 제출용이라 원본 유지

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-08 21:27:26 +09:00
GA Pro fbbabf2d04 feat: 수수료 갭 보완 4종 — 지급보류/환수원천세역분개/연체이자/간이지급명세서 (V124~V126)
감사(서브에이전트 3영역)로 발견한 실제 결함/규제 갭만 선별 보완.

- A 지급보류(HOLD) 지급배치 누락 버그: PaymentBatchItemMapper.insertFromSettleMaster
  status NOT IN('PAID','HOLD') — 보류건이 지급배치에 포함되어 실제 이체되던 결함 수정
- B 환수 원천세 역분개: withholding_tax_adjustment(V124) 멱등 적재 +
  분기 원천세신고 집계 netting(payment UNION ALL adjustment). settle_master 금액흐름 불변
- C 환수채권 연체이자: clawback_receivable.accrued_interest + clawback_interest(V125) +
  ClawbackInterestCalculator(연율/1200), config 기본 0 = 안전폴백, 기존 FIFO 상계가 이자 회수
- D 사업소득 간이지급명세서(월별): commission_statement(MONTHLY) 위 읽기전용 리포트 +
  메뉴 REPORT_SIMPLIFIED_PAYMENT(V126) + 프론트 SimplifiedPaymentReport

검증: ./gradlew build 전모듈 GREEN, 신규 단위테스트 6건, ga-frontend tsc -b PASS,
Flyway V124~V126 운영DB 적용(v126), 적대리뷰 APPROVED(LOW 1건 GREATEST 클램프 즉수정),
B/C/D 라이브DB 검증(롤백) + D admin e2e list/export 200.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-08 21:22:13 +09:00
GA Pro ff6d399dd3 feat: 수수료 공식 갭 보완 + 8종 신규모듈 풀스택 (V116~V123)
수수료 공식 갭분석(5 병렬감사) 후 확정 버그 3건 수정 + 개념적으로 빠진 모듈 8종 풀스택 구현.

[확정 버그 3건]
- 1200% 누적한도(checkContractTotal)를 배치 CalcRecruitStep에 연결(기존 1차년 한도만 적용
  → 두 한도 중 더 제한적인 값으로 clip+이연). +CalcRecruitStepTest
- BatchInstallmentPlanGenerator planMonth 반영(하드코딩 1 제거, API판과 동일). +단위테스트
- PersistencyBonus 임계유지율 게이트 + FIXED 정액 룰 도출. +PersistencyBonusServiceTest

[신규 모듈 8종]
- MOD-1 도입수수료(recruiter/development) / MOD-2 선지급·차익정산 / MOD-3 환수 분할상환
- MOD-4 익월부활 재지급 / MOD-5 정산대사 입수 / MOD-6 환수 시효 / MOD-7 환수 감면
- MOD-8 채널별 수수료차등(sales_channel)
각 DB(테이블+메뉴+권한+공통코드)→VO/Mapper/Enum→Service/Controller→화면 풀스택.
배치 정산연계: AggregateStep에 도입/익월부활 가산(11종), 선지급 FIFO 상계(멱등 reverse),
MOD-8 채널 우선 요율조회(NULL 폴백 하위호환).

[검증]
- 전체 ./gradlew build(전 모듈+전 테스트) GREEN
- Flyway V116~V123 운영DB 적용(schema v115→v123)
- 라이브 스모크 8 GET=200, MOD-1 RATE공식 50000 실측, 액션 POST 5xx 0건
- 적대적 코드리뷰 APPROVED(MOD-8 계산기 미연결 버그 발견·수정)

스펙: docs/DOMAIN_GAP_MOD1-8.md

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-06 17:33:13 +09:00
GA Pro 00ead64c4c feat: P12(#2) 지급대상건 구성·수정 — 정산월 지급대상 배치 구성/확정 (PL 자율진행)
incar 지급대상건구성/수정/조회 대응. 기존 settle_master 건별 confirm/hold 위에
정산월 단위 지급대상 배치를 구성→포함/제외 편집→확정하는 워크플로우 레이어 추가
(AccountingClose DRAFT/마감 패턴 준용, settle_master 상태는 미변경=결합 최소화).

- DB(V115): payment_batch(배치 마스터, status DRAFT/FINALIZED/CANCELLED, total_count/
  total_payable) + payment_batch_item(건, settle_id FK, payable 스냅샷, included/exclude_reason,
  UNIQUE(batch_id,settle_id)) + 메뉴 PAYMENT_TARGET(GRP_SETTLE) + 권한 READ/CREATE/UPDATE/
  EXECUTE + 공통코드 PAYMENT_BATCH_STATUS.
- core: PaymentBatch/Item VO/Resp/SaveReq/SearchParam/Enum + Mapper. insertFromSettleMaster
  (INSERT-SELECT 자동채움: settle_month·payable>0·status!=PAID) + recalcTotals + updateInclude.
- api: PaymentBatchService create(자동채움+집계)/list/detail/updateItem(DRAFT만,재집계)/
  finalize(포함0건 거부)/cancel/export. Controller /api/payment-batches.
- frontend: PaymentTarget 화면(배치 목록 + 구성 모달 + 상세 Drawer items 포함/제외 토글 +
  합계 + 확정/취소/엑셀) + api 모듈 + App 라우트. export 권한 READ로 정렬.

검증: build+test SUCCESSFUL, Flyway V115(schema v115). 라이브 e2e: 202603 create→39건
자동채움(합 15,438,386.9) → 1건 제외 → 38건 재집계(정확히 −35,079) → finalize → 확정후
수정 400 차단 → cancel. 테스트 배치 정리. 스펙 docs/DOMAIN_GAP_P12.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-05 01:10:50 +09:00
GA Pro 934e45d295 feat: P11(#1) 시상/신인시상 환수 — award_ledger 환수 처리 (PL 자율진행)
incar 유지율시상환수/신인도입유치자시상환수 대응. award_ledger(V92)는 지급만 있고
환수가 없던 갭. 정착지원금/생보운영지원/지점장수당의 clawback_amount+net_amount 패턴으로
통일(신인시상=award_type NEW_RECRUIT로 기존재 → 별도 테이블 불필요).

- DB(V114): award_ledger에 clawback_amount/net_amount 컬럼 추가 + net=award 백필 +
  CHECK(clawback>=0) + status CHECK에 CLAWED_BACK 추가(pg_constraint 동적 탐색 DROP/재생성).
- core: AwardLedgerVO/Resp/SaveReq에 clawbackAmount/netAmount. AwardLedgerMapper
  aggregateByAgent SUM(award_amount)→SUM(net_amount), insert에 두 컬럼, applyClawback UPDATE.
- api: AwardService.createLedger가 net=award−clawback 계산(clawback≤award 검증). 신규
  applyClawback(ledgerId, {clawbackAmount,reason}) — 초과/취소상태 E411, status=CLAWED_BACK.
  PUT /api/awards/ledgers/{id}/clawback.
- frontend: Award 원장 그리드에 환수액/실지급 컬럼 + 합계 + 환수처리 모달(PermissionButton UPDATE).
- AggregateStep 무변경: aggregateByAgent가 net 반환 → 환수가 other_commission 자동 차감,
  net<0이면 P9 환수채권 이월에 자연 연계.

검증: build+test SUCCESSFUL, Flyway V114(schema v114). 라이브: award 100000 원장 →
clawback 30000 → net 70000·CLAWED_BACK, 초과환수 200000 → E411, aggregate net=70000 반영
확인. 테스트 데이터 정리. 스펙 docs/DOMAIN_GAP_P11.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-05 00:59:48 +09:00
GA Pro 284ecc4203 feat: P10(#3) 환수 보험사자료 업로드 — 보험사 통보 기반 chargeback 인입 (PL 자율진행)
incar '환수보험사자료 업로드' 대응. GA는 LAPSE 계약 기반 자동환수만 있고 보험사가
통보한 환수자료(증권번호+환수금액)를 직접 인입하는 경로가 없던 갭. 신규 테이블 없이
기존 chargeback(V6) 재사용.

- DB(V113): 메뉴 CHARGEBACK_DATA(환수자료관리, GRP_SETTLE, /settle/chargeback-data)
  + 권한 READ/CREATE/EXPORT + 역할부여.
- core: ChargebackUploadExcelVO(@ExcelColumn 증권번호/환수금액/실효월/환수율) +
  ChargebackResp/SearchParam + ChargebackMapper.selectList/countByCondition/
  existsByContractAndMonth + ContractMapper.selectByPolicyNo(contract_date 포함).
- api: ChargebackUploadService.upload(settleMonth,file) — ExcelService.importLargeExcel
  로 SAX 파싱, policy_no→contract/agent 해소(미존재=에러행), 중복(contract+월) skip,
  실효월 YYYYMM→경과월 변환(ChronoUnit), ChargebackVO status=NEW·remain=cb_amount
  insertBatch. ChargebackService.list/export. ChargebackController(/api/chargebacks
  /upload, GET 목록, export).
- frontend: ChargebackData 화면(정산월+파일 업로드, 결과 성공/스킵/에러행 표시, AG Grid
  목록 합계행, 엑셀) + api/chargeback.ts + App 라우트.

검증: build SUCCESSFUL, Flyway V113(schema v113). 라이브 업로드 e2e — 정상 2건 INSERT
(NEW, remain=cb_amount) + 미존재 증권번호 1건 에러행 리포트 + 중복 skip, GET 목록 200,
경과월 변환 동작 확인. 테스트 chargeback 전건 정리. 스펙 docs/DOMAIN_GAP_P10.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-05 00:51:08 +09:00
GA Pro 90256a19a1 feat: P9 #4 — 출금 가용한도를 환수채권 상계 후 실지급액(payable_amount)으로 전환
P9에서 산출하던 payable_amount(=환수 상계 후 실지급액)가 출금 한도에 미반영
(cosmetic)이던 것을 연결. 이제 환수채권 회수가 모바일 출금 가용액을 정확히 줄인다.

- V112: 기존 settle_master.payable_amount 백필 = GREATEST(net_amount,0)
  (V111에서 DEFAULT 0 추가됨 → 구 데이터 보정. clawback 무활동 행만 대상=멱등).
- core: SettleMasterMapper.xml cols에 clawback_recovered/carryover/payable_amount 추가,
  SettleMasterResp 3필드 노출.
- api: MobileMeService.withdrawableBalance 한도 산정을 net→payable_amount 기준으로
  (payable null이면 max(net,0) 폴백). WithdrawableBalance DTO에 payableAmount 추가,
  remainingAmount = payable − used. createWithdrawRequest 가드도 자동 반영.
- PWA: withdraw.ts 타입 + WithdrawCreate 드롭다운/카드를 '실지급가능(payable)' 표기로.

검증: ./gradlew build(test포함) SUCCESSFUL, PWA tsc 0오류. Flyway V112 적용(schema v112).
백필 150/150 행 payable==max(net,0). 라이브 agent01 withdrawable-balance가 payableAmount
노출 + remaining=payable−used(13492−151000=-137508) 정확.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-05 00:29:50 +09:00
GA Pro 51ee03453c feat: P9 환수채권 이월/미수금 관리 — 수수료 갭 풀스택 (PL 자율진행)
incar CMS 메뉴(환수이월관리/환수계약리스트/위촉중환수) ↔ GA 부재 + 코드 갭
(AggregateStep net<0 시 경고만, 미회수 환수 채권화·차월상계·대손 생애주기 전무)
을 도출해 풀스택 구현. 미회수 환수가 소실되던 재무 누락을 폐쇄.

- DB(V111): clawback_receivable(채권 마스터, UNIQUE agent+origin월) +
  clawback_recovery(상계 회수 이력) + settle_master 3컬럼(clawback_recovered/
  clawback_carryover/payable_amount) + 메뉴 CLAWBACK_RECEIVABLE + 권한 + 공통코드.
- core: VO/Resp/SaveReq/SearchParam/Enum/Mapper(.java/.xml) 2테이블 + MapStruct.
  outstandingBalance(origin<settleMonth 자기상계방지) / FIFO / upsertCarryover(멱등).
- api: ClawbackReceivableService/Controller(/api/clawback-receivables) — list/detail/
  summary/write-off(OUTSTANDING·RECOVERING만, CLEARED/WRITTEN_OFF 전이)/export(@Transactional).
- batch: AggregateStep 통합 — net<0 → carryover 채권화, net>0 → FIFO 상계회수,
  reverse-먼저 방식으로 동일월 재실행 멱등. net_amount 의미 불변(무결성 보존).
  payable_amount = max(0,net) − recovered.
- fix(잠복): SettleMasterMapper.xml upsert에 신규 3컬럼 누락 → INSERT/ON CONFLICT 추가
  (배치가 VO에 set해도 DEFAULT 0으로 미영속되던 버그, PL 검증서 발견).
- frontend: ClawbackReceivable 화면(AG Grid 합계행 + 회수이력 타임라인 Drawer +
  대손/상환 모달) + api 모듈 + App 라우트.

검증(PL 직접): ./gradlew build(test포함) SUCCESSFUL. Flyway V109~V111 운영DB 적용
(schema v111). 라이브 API: GET 목록/summary 200, write-off WRITTEN_OFF 200(한글사유
영속), 종결 재처리·잘못된 전이상태 E411 차단. 배치 이월/상계/멱등/부분상계 4시나리오
실 스키마 롤백 트랜잭션 검증 PASS(CHECK balance>=0 포함). 잔여 데이터 0.

스펙: docs/DOMAIN_GAP_P9_환수채권이월.md. 후속 갭(시상/인정실적 환수 ledger,
지급대상건 구성, 환수 보험사자료 업로드) 문서화.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-05 00:18:58 +09:00
GA Pro b12858c991 docs: 수수료 종류별 계산공식 전체 정리 + 신입교육 문서 보완
- docs/수수료_계산공식_전체레퍼런스.md 신규: 모든 수수료 종류의 실제 구현
  계산식(코드 기준, 감사 수정 반영) — 모집/유지 3곱, 지급성 11종, 조직·실적,
  횡단(1200%clip/분급/환수/세금/집계net/회계예수금분개).
- 신입교육_보험과수수료_완전기초.md 보완:
  - 6-A 수수료 종류별 계산식 하나씩(미니 숫자예시) — 생애주기/성과조직/소개지원/회사레벨
  - 6-B 기타수수료(예외 가감 PLUS/MINUS, 시책, 해촉정산, 본사정산, 보증보험)
  - 목차 갱신

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-03 16:41:36 +09:00
GA Pro e2fdc88754 fix: 잔여 백로그 전건 처리 — 회계 예수금/1200%clip/환수가드/net경보 (PL 자율진행)
- fix(a, MED): 회계 분개에 원천세 예수금 leg 분리. (차)8350 지급수수료 gross /
  (대)2530 미지급금 net + (대)2540 예수금 원천세. 기존엔 미지급금에 gross 계상 +
  원천세 분개 누락. account_code '2540' 예수금 추가(V110), 분개쿼리 2-leg 전환.
- fix(b, HIGH): 1200%룰 1차년 한도초과 시 clip+이연. 한도잔여까지만 당월 지급,
  초과분만 분급(7년)으로 이연. 전액 이연 시 당월 원장 미생성 + 세액 재계산.
  (기존: 전액지급 + 전액 분급계획 → 설계 불일치)
- fix(e/f, HIGH/MED): 정착지원금/생보운영지원 환수액 ≤ 지원금 검증으로 net 음수 차단.
  AggregateStep net 음수(공제>지급) 경보 로깅 추가.
- (g) 검토결과 무변경: TaxCalculator/BatchTaxCalculator는 의도된 동일로직 쌍둥이,
  V80 매직팩터는 샘플시드일 뿐 계산경로 아님. 두 쌍둥이 모두 음수가드 적용됨.
- (d) 무변경: 승계 "최신 to_agent=현재귀속자"는 다단계체인에 정합, from==agent_id
  가드는 체인 회귀 유발하므로 정책확정 전 보류(문서화).
- test: CalcRecruitStepTest(clip+이연), SettlingSupportServiceTest(환수>지원 거부).
- 전체 build+test GREEN: 155건 0실패.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-03 11:27:53 +09:00
GA Pro 60c4cbae78 fix: 오버라이드 insurance_type_cond 미적용 과지급 수정 (PL 우선순위 진행)
- fix(HIGH): CalcOverrideStep base 가 override_rule.insurance_type_cond 를 무시하고
  하위 설계사의 전 보험종류 실적 합계에 율을 곱해 과지급. 룰에 보험종류 조건이
  지정되면(LIFE 등) 해당 종류 실적만 base 로 집계하도록 수정.
  (현 시드는 insurance_type_cond NULL 이라 잠복상태였으나 종류한정 룰 도입 시 과지급)
- add: RecruitLedgerMapper/MaintainLedgerMapper.sumByAgentMonthAndType + XML
- test: CalcOverrideStepTest — LIFE 한정 룰 base 필터 검증
- 전체 build+test GREEN: 153건 0실패

잔여 백로그(정책결정 필요 — 자동수정 보류): 1200%룰 초과분 clip/이연(지급정책),
계약승계 from검증(다단계 체인+contract.agent_id 갱신정책), 정착지원금 환수공식(입력
스키마), 회계 원천세 예수금 분개(회계정책), net음수 클램프(이월저장), 세금 3중경로 통일.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-03 10:38:09 +09:00
GA Pro eac0b813d6 fix: 수수료 계산 전수감사 — 1200%룰 단위버그 외 5건 수정
적대적 코드감사(4영역)에서 검증된 정확성 결함 수정:
- fix(HIGH): 1200%룰 단위 불일치. regulatory_limit.limit_value(PERCENT:1200,35)를
  KRW 금액과 직접 비교 → 사실상 "1200원/35원 룰"로 망가져 거의 모든 계약이 위반
  처리. 연환산보험료×비율/100로 KRW 환산 후 비교. RegulatoryLimitChecker(api/batch)
  양쪽, ContractMapper 주입(시그니처 무변경).
- fix(HIGH): 음수 gross(환수>지급) 세금 계산이 음수 원천세 생성 → net 왜곡 +
  분기 원천세신고 SUM 잠식. gross<=0 시 세금0·net=원금 가드. Tax/BatchTaxCalculator.
- fix(HIGH): AwardService 시상 threshold_amount 미적용 → 기준 미달자에게 시상
  전액 지급. threshold 미만 차단 + FIXED award_fixed null 가드.
- fix(MED): 차등환수 최저구간 months_from 1→0(V109). 체결 1개월내 즉시해지가
  grade=null로 환수 0원 처리되던 누락 보정.
- fix(MED): company_rate/payout_rate NULL→0 폴백 무경보. log.warn 추가로
  데이터 공백에 의한 과소지급 추적 가능.

테스트 4건 추가(단위변환/음수세금/시상threshold 경계). 전체 build+test GREEN: 152건 0실패.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-03 10:19:53 +09:00
GA Pro 3d50286f4a test: E2E 수수료 정산 시나리오 테스트 + 엑셀업로드/분급 버그 수정
- 시나리오 문서: 보험 인입→수수료 지급 8단계 (docs/시나리오_E2E_보험인입_수수료정산.md)
- SettlementScenarioTest(9건): 계약1건 생애주기를 실제 계산기로 단계별 검증
- ExcelServiceImportTest(2건): 실 .xlsx 업로드 라운드트립 검증
- fix(CRITICAL): 엑셀 업로드 런타임 깨짐 — xlsx-streamer 2.2.0 ↔ poi 5.2.5
  비호환(NoSuchMethodError). excel-streaming-reader 4.3.0(유지보수 fork)로 교체.
  영향: ExcelService.importLargeExcel + UploadService(/api/upload 실엔드포인트)
- fix: 분급 계획 반올림 잔차로 분급합계≠원금(정산 무결성 위반). 비율합 100%
  정규스케줄일 때 마지막 회차가 잔차 흡수. ga-api/ga-batch 양쪽.
- 전체 build+test GREEN: 148건 0실패

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-03 10:02:55 +09:00
517 changed files with 18271 additions and 521 deletions
+1
View File
@@ -48,3 +48,4 @@ ga-frontend/dist/
login.json login.json
token.txt token.txt
__pycache__/ __pycache__/
.omc/
+168
View File
@@ -0,0 +1,168 @@
# DOMAIN_GAP_MOD1-8 — 수수료 갭 8종 신규모듈 권위 스펙
> 2026-06-06 갭분석 결과 "개념적으로 빠진" 수수료 모듈 8종. 업무 수치는 **데모 기본값**(운영 시 룰테이블 조정).
> 모든 레이어 에이전트는 이 문서를 단일 진실원으로 따른다. 테이블/컬럼/Enum/경로/메뉴코드명을 **그대로** 사용.
## 공통 규약 (기존 패턴 — V92/V95/V96 미러)
- PK `BIGSERIAL`, 금액 `NUMERIC(15,2)`, 율 `NUMERIC(7,4)`(0~1 소수), 정산월 `CHAR(6)`(YYYYMM).
- 감사: `created_at TIMESTAMP NOT NULL DEFAULT NOW()`, `created_by BIGINT`, `updated_at TIMESTAMP`.
- 모든 테이블 `COMMENT ON TABLE/COLUMN`, 인덱스 `idx_<약어>_...`.
- 메뉴: `menu`(parent=GRP_*, menu_type='PAGE', menu_level=2) + `menu_permission`(READ/CREATE/UPDATE/DELETE/EXPORT) + `role_menu_permission`(SUPER_ADMIN/ADMIN 전체, MANAGER READ/CREATE/UPDATE/EXPORT, AGENT READ). NOT EXISTS/ON CONFLICT 가드.
- 공통코드: `common_code_group` + `common_code`.
- core: `XxxVO`(전컬럼)/`XxxResp`(+조인명)/`XxxSaveReq`(입력)/`XxxSearchParam`(extends PageParam) + Mapper(.java/.xml, selectList/selectById/insert/update/delete + 도메인쿼리) + Enum(상태) + MapStruct(필요시). Mapper는 BaseMapper 상속 안 함(개별 정의, 기존 commission Mapper 미러).
- api: `XxxService`(@Service @Transactional(readOnly=true), 쓰기 @Transactional) + `XxxController`(@RestController @RequestMapping("/api/...") @RequirePermission, @DataChangeLog 쓰기, ApiResponse/PageResponse 반환). 기존 commission Controller 미러.
- frontend: `ga-frontend/src/pages/<area>/Xxx.tsx` + `api/<area>.ts` 함수 + `App.tsx` 라우트. 100건↑/셀편집/합계는 AG Grid, 단순 CRUD는 Ant Design DataTable.
- 마이그레이션 번호: MOD-1=V116, MOD-2=V117, MOD-3=V118, MOD-4=V119, MOD-5=V120, MOD-6=V121, MOD-7=V122, MOD-8=V123. (필요 시 모듈당 2파일 가능 — 예 V116_a 테이블 / 단일 파일에 메뉴·코드 포함 권장)
---
## MOD-1 — 슈퍼바이저/도입수수료 (recruiter/development commission) [V116]
설계사를 GA에 **도입(리크루팅)**한 상위 설계사에게 지급하는 별도 트랙(오버라이드와 무관, recruiter 관계 기반).
### DB V116
- `ALTER TABLE agent ADD COLUMN recruiter_agent_id BIGINT REFERENCES agent(agent_id);` (도입자, NULL 허용)
- `recruiter_commission_rule`(rule_id PK, recruiter_type VARCHAR(20) CHECK IN('NEW_RECRUIT','DEVELOPMENT','TRAINING'), calc_type VARCHAR(10) CHECK IN('RATE','FIXED'), commission_rate NUMERIC(7,4), fixed_amount NUMERIC(15,2), effective_from DATE NOT NULL, effective_to DATE, 감사컬럼). CHECK rate 0~1.
- `recruiter_commission_ledger`(ledger_id PK, recruiter_agent_id BIGINT NOT NULL REFERENCES agent, recruit_agent_id BIGINT NOT NULL REFERENCES agent, settle_month CHAR(6) NOT NULL, recruiter_type VARCHAR(20) NOT NULL, base_amount NUMERIC(15,2) NOT NULL, commission_amount NUMERIC(15,2) NOT NULL, status VARCHAR(20) NOT NULL DEFAULT 'CALCULATED' CHECK IN('CALCULATED','CONFIRMED','PAID','CANCELLED'), 감사). idx (recruiter_agent_id, settle_month).
- 메뉴 `RECRUITER_COMM`('도입수수료', '/commission/recruiter', 'commission/RecruiterCommission', GRP_COMMISSION, sort 150) + 권한 + 공통코드 `RECRUITER_TYPE`(NEW_RECRUIT 신인도입/DEVELOPMENT 육성/TRAINING 교육).
- 공식(데모): commission = base_amount × rule.commission_rate (RATE) / fixed_amount (FIXED). base_amount=도입 설계사의 당월 모집수수료 합(데모 입력 허용).
### core/api
- `RecruiterCommissionRule*` + `RecruiterCommissionLedger*` VO/Resp/SaveReq/SearchParam, Mapper(.java/.xml: selectList/selectById/insert/update/delete + `aggregateByAgent(settleMonth)` = SUM(commission_amount) GROUP BY recruiter_agent_id). Enum `RecruiterType`.
- `RecruiterCommissionService`: rule CRUD + ledger list/detail/createLedger(룰 calc_type 권위, ReferralCommissionService 미러) + aggregate. Controller `/api/recruiter-commissions` (rules/ledgers).
- **정산 반영**: `AggregateStep`에 recruiterCommissionMapper.aggregateByAgent 추가 → other_commission_total 합산(기존 9종 패턴 동일, recruiter_agent_id 기준 agentId). (지급성이므로 gross 가산.)
### frontend
- `pages/commission/RecruiterCommission.tsx`(룰 탭 + 원장 탭, 등록 모달), `api/commission.ts`에 함수 추가, App.tsx 라우트.
---
## MOD-2 — 선지급/차익정산 (advance payment recovery + delta settlement) [V117]
신입/램프업 설계사에 미리 지급한 **선지급금**을 확정수수료로 우선 회수, 차액만 실지급.
### DB V117 (GRP_SETTLE)
- `advance_payment`(advance_id PK, agent_id BIGINT NOT NULL REFERENCES agent, advance_month CHAR(6) NOT NULL, principal_amount NUMERIC(15,2) NOT NULL CHECK>0, recovered_amount NUMERIC(15,2) NOT NULL DEFAULT 0, balance NUMERIC(15,2) NOT NULL, status VARCHAR(20) NOT NULL DEFAULT 'OUTSTANDING' CHECK IN('OUTSTANDING','PARTIAL','CLEARED','WAIVED'), memo VARCHAR(200), 감사). CHECK balance>=0. idx(agent_id, status).
- `advance_recovery_ledger`(recovery_id PK, advance_id BIGINT NOT NULL REFERENCES advance_payment, settle_month CHAR(6) NOT NULL, recovery_amount NUMERIC(15,2) NOT NULL CHECK>0, 감사). idx(advance_id), idx(settle_month).
- 메뉴 `ADVANCE_PAYMENT`('선지급정산','/settle/advance-payment','settle/AdvancePayment', GRP_SETTLE, sort 적절) + 권한 + 공통코드 `ADVANCE_STATUS`(OUTSTANDING 미상환/PARTIAL 부분/CLEARED 완료/WAIVED 면제).
### core/api/batch
- `AdvancePayment*` + `AdvanceRecoveryLedger*` VO/Resp/SaveReq/SearchParam, Mapper. 도메인쿼리: `outstandingByAgent(agentId)`=SUM(balance) WHERE status IN('OUTSTANDING','PARTIAL'); aging은 advance_month 기준.
- `AdvancePaymentService`: 선지급 등록(balance=principal)/조회/aging 리포트/면제(waive). Controller `/api/advance-payments`.
- **정산 연계(AggregateStep)**: net(=tax후) 계산 직후, P9 환수상계와 **동일 위치/유사 패턴**으로 선지급 잔액 FIFO 우선상계. recovered_advance = min(payable, outstanding). 차익정산 delta = payable recovered_advance. payable 최종 = delta. advance_recovery_ledger 기록 + advance_payment.recovered/balance/status 갱신. **멱등**: 당월 recovery reverse 후 재적용(P9 reverseClawbackRecovery 패턴). 환수상계와 선지급상계 순서: 환수(채권) → 선지급. 둘 다 payable 차감.
- 주의: 기존 settle_master payable_amount 의미에 선지급 차감 반영. 새 컬럼 불필요(payable에 통합) — 단 advance_recovery_ledger로 추적.
### frontend
- `pages/settle/AdvancePayment.tsx`(선지급 목록+잔액/상태, 등록·면제 모달, 상계내역 Drawer), `api/settle.ts` 또는 `api/operation.ts` 함수.
---
## MOD-3 — 환수 분할상환 (installment clawback) [V118]
대액 환수채권을 N개월 분할 납부 계획으로.
### DB V118 (GRP_COMMISSION)
- `clawback_installment_plan`(plan_id PK, receivable_id BIGINT NOT NULL REFERENCES clawback_receivable(receivable_id), installment_no INT NOT NULL, installment_amount NUMERIC(15,2) NOT NULL CHECK>0, due_month CHAR(6) NOT NULL, status VARCHAR(20) NOT NULL DEFAULT 'SCHEDULED' CHECK IN('SCHEDULED','RECOVERED','CANCELLED'), recovered_at TIMESTAMP, 감사). UNIQUE(receivable_id, installment_no). idx(due_month, status).
- 메뉴 `CLAWBACK_INSTALLMENT`('환수분할상환','/commission/clawback-installment','commission/ClawbackInstallment', GRP_COMMISSION, sort) + 권한. 공통코드 `CB_INSTALLMENT_STATUS`(SCHEDULED 예정/RECOVERED 회수/CANCELLED 취소).
### core/api
- `ClawbackInstallmentPlan*` VO/Resp/SaveReq/SearchParam + Mapper(selectByReceivable, insertBatch, updateStatus).
- `ClawbackInstallmentService`: receivable 1건 + 회차수 N → 균등분할(마지막 회차 잔차흡수, InstallmentPlanGenerator 잔차패턴) 계획 생성. due_month=기준월+회차. list/detail/generate/cancel. Controller `/api/clawback-installments`.
- 월별 상계 연계는 데모 수준(계획 생성·조회·상태전이). (AggregateStep 통합은 선택 — 미연계 시 문서화.)
### frontend
- `pages/commission/ClawbackInstallment.tsx`(채권 선택→분할 생성, 회차 목록), `api/commission.ts`.
---
## MOD-4 — 익월 부활 재지급 (lapsed reinstatement repayment) [V119]
실효(보류)된 계약이 익월 부활 시 보류했던 수수료를 make-good 재지급.
### DB V119 (GRP_COMMISSION)
- `lapsed_reinstatement_recovery`(recovery_id PK, contract_id BIGINT NOT NULL REFERENCES contract(contract_id), agent_id BIGINT NOT NULL REFERENCES agent, lapsed_month CHAR(6) NOT NULL, reinstated_month CHAR(6) NOT NULL, withheld_amount NUMERIC(15,2) NOT NULL CHECK>=0, repaid_amount NUMERIC(15,2) NOT NULL DEFAULT 0, status VARCHAR(20) NOT NULL DEFAULT 'PENDING' CHECK IN('PENDING','REPAID','CANCELLED'), 감사). idx(agent_id, reinstated_month), idx(contract_id).
- 메뉴 `LAPSED_REINSTATEMENT`('익월부활재지급','/commission/lapsed-reinstatement','commission/LapsedReinstatement', GRP_COMMISSION, sort) + 권한. 공통코드 `LAPSE_RECOVERY_STATUS`(PENDING 대기/REPAID 재지급완료/CANCELLED 취소).
### core/api
- `LapsedReinstatementRecovery*` VO/Resp/SaveReq/SearchParam + Mapper(selectList/selectById/insert/updateStatus + aggregateByAgent=SUM(repaid_amount) WHERE status='REPAID' GROUP BY agent_id).
- `LapsedReinstatementService`: 부활 등록(withheld_amount=보류액, 데모 입력)/repay(상태 REPAID, repaid=withheld)/cancel. Controller `/api/lapsed-reinstatements`.
- **정산 반영(선택)**: aggregateByAgent를 AggregateStep other_commission_total에 가산(REPAID만). 미연계 시 문서화.
### frontend
- `pages/commission/LapsedReinstatement.tsx`, `api/commission.ts`.
---
## MOD-5 — 정산대사 입수 (carrier reconciliation IN) [V120]
보험사 통보 정산자료 vs GA 원장 대사 차이 산출.
### DB V120 (GRP_SETTLE)
- `carrier_reconciliation_in`(recon_id PK, company_id BIGINT NOT NULL REFERENCES insurance_company(company_id), settle_month CHAR(6) NOT NULL, file_name VARCHAR(200), record_count INT NOT NULL DEFAULT 0, reported_total NUMERIC(15,2) NOT NULL DEFAULT 0, system_total NUMERIC(15,2) NOT NULL DEFAULT 0, variance_amount NUMERIC(15,2) NOT NULL DEFAULT 0, status VARCHAR(20) NOT NULL DEFAULT 'RECEIVED' CHECK IN('RECEIVED','MATCHED','VARIANCE','APPROVED'), 감사). UNIQUE(company_id, settle_month). idx(settle_month).
- `reconciliation_variance`(variance_id PK, recon_id BIGINT NOT NULL REFERENCES carrier_reconciliation_in, policy_no VARCHAR(50), expected_amount NUMERIC(15,2), reported_amount NUMERIC(15,2), variance_reason VARCHAR(100), 감사). idx(recon_id).
- 메뉴 `CARRIER_RECON_IN`('정산대사입수','/settle/carrier-recon-in','settle/CarrierReconIn', GRP_SETTLE, sort) + 권한. 공통코드 `RECON_IN_STATUS`(RECEIVED 입수/MATCHED 일치/VARIANCE 차이/APPROVED 승인).
- insurance_company PK 컬럼명 확인 후 사용(company_id 가정, 다르면 실제명).
### core/api
- `CarrierReconciliationIn*` + `ReconciliationVariance*` VO/Resp/SaveReq/SearchParam + Mapper.
- `CarrierReconciliationInService`: 대사 등록(reported_total 입력)/reconcile(system_total=settle_master 또는 income_commission 집계, variance=reportedsystem, status 자동 MATCHED/VARIANCE)/approve. Controller `/api/carrier-recon-in`.
### frontend
- `pages/settle/CarrierReconIn.tsx`(대사 목록 + 차이내역 Drawer), `api/settle.ts`/`operation.ts`.
---
## MOD-6 — 환수 시효/소멸 (statute of limitations) [V121]
오래된 미결 환수채권을 만료개월 경과 시 자동 대손(WRITTEN_OFF/EXPIRED).
### DB V121 (GRP_COMMISSION)
- `statute_config`(config_id PK, entity_type VARCHAR(30) NOT NULL UNIQUE CHECK IN('CLAWBACK_RECEIVABLE'), expiration_months INT NOT NULL CHECK>0, is_active CHAR(1) NOT NULL DEFAULT 'Y', 감사). 시드 1행: ('CLAWBACK_RECEIVABLE', 36, 'Y').
- 메뉴 `STATUTE_CONFIG`('환수시효관리','/commission/statute','commission/StatuteConfig', GRP_COMMISSION, sort) + 권한.
- (별도 status 코드 불필요 — 기존 clawback_receivable status에 WRITTEN_OFF 존재 가정. 없으면 사유코드만 추가.)
### core/api
- `StatuteConfig*` VO/Resp/SaveReq + Mapper. clawback_receivable에 만료대상 조회/대손처리 쿼리(`selectExpired(beforeMonth)`, `writeOffExpired`) 추가(기존 ClawbackReceivableMapper에).
- `StatuteService`: config CRUD + `expireOverdue(baseMonth)` = origin_settle_month <= baseMonthexpiration_months AND status='OUTSTANDING' → WRITTEN_OFF(reason EXPIRED) + 카운트. Controller `/api/statute` (config + POST expire).
### frontend
- `pages/commission/StatuteConfig.tsx`(설정 + 만료실행 버튼 + 결과), `api/commission.ts`.
---
## MOD-7 — 환수 감면/면제 (chargeback waiver/reduction) [V122]
재직 설계사 환수에 대한 감면 신청·승인 워크플로.
### DB V122 (GRP_COMMISSION)
- `chargeback_waiver_request`(request_id PK, contract_id BIGINT NOT NULL REFERENCES contract, agent_id BIGINT NOT NULL REFERENCES agent, settle_month CHAR(6) NOT NULL, original_chargeback NUMERIC(15,2) NOT NULL CHECK>=0, waiver_amount NUMERIC(15,2) NOT NULL CHECK>=0, reason VARCHAR(200), approval_status VARCHAR(20) NOT NULL DEFAULT 'REQUESTED' CHECK IN('REQUESTED','APPROVED','REJECTED'), approver_id BIGINT, approved_at TIMESTAMP, 감사). CHECK waiver_amount<=original_chargeback. idx(agent_id, settle_month).
- 메뉴 `CHARGEBACK_WAIVER`('환수감면신청','/commission/chargeback-waiver','commission/ChargebackWaiver', GRP_COMMISSION, sort) + 권한. 공통코드 `WAIVER_STATUS`(REQUESTED 신청/APPROVED 승인/REJECTED 반려).
### core/api
- `ChargebackWaiverRequest*` VO/Resp/SaveReq/SearchParam + Mapper.
- `ChargebackWaiverService`: 신청(create)/approve(승인 시 approval_status, approver/approved_at; 환수액 조정은 데모 수준 — 승인분 추적)/reject. waiver<=original 검증. Controller `/api/chargeback-waivers`.
### frontend
- `pages/commission/ChargebackWaiver.tsx`(신청 목록 + 승인/반려 액션), `api/commission.ts`.
---
## MOD-8 — 채널별 수수료 차등 (channel-specific commission) [V123]
판매채널(직판/방카/홈쇼핑/제휴)별 요율 차등. **하위호환 필수**(channel NULL = 기존 동작).
### DB V123
- `ALTER TABLE contract ADD COLUMN sales_channel VARCHAR(20);` (NULL 허용, NULL=DIRECT 취급)
- 공통코드 `SALES_CHANNEL`(DIRECT 직판/BANCASSURANCE 방카/HOME_SHOPPING 홈쇼핑/PARTNERSHIP 제휴).
- commission_rate / payout_rule 룰 테이블에 `sales_channel VARCHAR(20)` 컬럼 추가(NULL=모든채널). **실제 룰 테이블명·조회 SQL 확인 필수**(CommissionCalculator가 쓰는 rate 조회). 조회 우선순위: channel 일치 룰 우선, 없으면 channel IS NULL 룰 폴백.
- 메뉴 신규 불필요(계약 화면에서 노출). 단 계약 등록/조회에 sales_channel 추가.
### core/api/batch
- ContractVO/Resp/SaveReq에 salesChannel. ContractMapper.xml insert/update/select에 sales_channel.
- rate 조회 Mapper SQL에 channel 파라미터 추가(`AND (sales_channel = #{channel} OR sales_channel IS NULL) ORDER BY sales_channel NULLS LAST` 패턴으로 channel 우선). CommissionCalculator가 contract.salesChannel 전달.
- **하위호환 회귀 필수 검증**: channel NULL 계약은 기존과 동일 rate. 기존 CommissionCalculatorTest 통과 유지.
### frontend
- 계약 페이지(`pages/contracts/...` 또는 product)에서 sales_channel select 노출(공통코드 SALES_CHANNEL).
---
## 실행 순서 (5-Wave, 레이어별 병렬)
1. **DBA**: V116~V123 작성 (dba-architect). → SQL 파싱/리뷰.
2. **CORE**: 8모듈 VO/Mapper/Enum/MapStruct (core-architect). → `:ga-core:compileJava` GREEN.
3. **API+BATCH**: Service/Controller (api-developer) ‖ AggregateStep/배치 연계 (batch-engineer). → `:ga-api:compileJava :ga-batch:compileJava` GREEN.
4. **FRONTEND**: 화면+api+라우트 (frontend-developer). → `tsc` GREEN.
5. **INFRA/검증**: `./gradlew build`(test) GREEN + Flyway 적용 + 스모크 (PL + infra-reviewer).
- 각 Wave 후 PL이 빌드로 직접 검증. 컬럼/이름 불일치는 PL이 즉시 수정.
@@ -0,0 +1,46 @@
# P10 — 환수 보험사자료 업로드 (#3)
작성: PL, 2026-06-04. 사용자 "후속 갭 3종 진행" 중 첫 번째.
근거: incar `환수보험사자료 업로드`. GA는 LAPSE 계약 기반 자동환수(ChargebackExceptionStep)만 있고,
보험사가 통보한 환수자료(증권번호+환수금액)를 직접 인입하는 경로가 없음.
범위: 풀스택(DB→Core→API→Frontend). 신규 테이블 없음 — 기존 `chargeback`(V6) 재사용.
Flyway: **V112 최신 → V113**(메뉴/권한만). 금액 NUMERIC(15,2).
## 1. chargeback 테이블 (기존, 재사용)
cb_id PK / contract_id FK(nullable) / agent_id FK NN / policy_no / lapse_month INT /
cb_rate / cb_amount NN / paid_amount(0) / remain_amount NN / settle_month CHAR(6) NN /
installment_no / max_installments / status('NEW') / created_at.
## 2. 업로드 설계
- **1 업로드 = 1 settleMonth**(요청 파라미터). 파일 각 행 = 계약별 환수 통보.
- 엑셀 헤더(ChargebackUploadExcelVO, @ExcelColumn): `증권번호`(policyNo, order1) / `환수금액`(cbAmount, order2) / `실효월`(lapseMonth YYYYMM 문자열, order3, 선택) / `환수율`(cbRate, order4, 선택).
- **agent/contract 해소**: policy_no → contract 조회 → contract_id + agent_id. 미발견 행은 에러행으로 수집(스킵, 결과에 행번호+사유 반환). ContractMapper에 `selectByPolicyNo(policyNo)` 없으면 core가 추가(contract 테이블 policy_no 컬럼 확인).
- 생성 ChargebackVO: contractId/agentId(해소), policyNo, lapseMonth(YYYYMM→INT 변환, '202401'→202401 또는 경과월? **chargeback.lapse_month는 INT**: 기존 의미가 경과월(month elapsed)인지 실효연월인지 ChargebackExceptionStep 확인 후 동일 의미로 — 자동환수와 일관성. 불명확하면 실효연월 YYYYMM의 끝2자리(월)이 아니라 **경과월**로: contract_date~lapse_date 개월수 계산. 단순화를 위해 파일에 없으면 null 허용), cbRate, cbAmount, paidAmount=0, remainAmount=cbAmount, settleMonth(param), status='NEW'.
- **주의**: 자동환수(ChargebackExceptionStep)와 동일 (contract, settleMonth) 중복 생성 방지 — 동일 contract_id+settle_month NEW 존재 시 스킵 또는 갱신(중복 인입 방지). core에 `existsByContractAndMonth` 또는 service에서 selectByAgent로 확인. 최소: 같은 정산월 재업로드 시 중복 INSERT 경고만(운영자 책임). **권장: contract_id+settle_month UNIQUE 부분 보장 위해 service가 사전 조회 후 skip + 결과 리포트.**
- ExcelService.importLargeExcel(file, ChargebackUploadExcelVO.class, 500, consumer) 사용. consumer에서 해소+검증+chargebackMapper.insertBatch. 트랜잭션: @Transactional.
## 3. 조회(List) — 신규
chargeback 목록 화면이 현재 없음. 추가:
- core: ChargebackResp(+agentName/contractNo 조인) / ChargebackSearchParam(settleMonth/agentId/status/policyNo) / ChargebackMapper.selectList + countByCondition. (기존 ChargebackVO 유지)
- api: ChargebackService.list(PageHelper) / detail. 업로드는 ChargebackUploadService.upload(settleMonth, file)→ExcelImportResult-유사(성공/에러행).
## 4. API
- `POST /api/chargebacks/upload?settleMonth=YYYYMM` (multipart file) — @RequirePermission(CHARGEBACK_DATA, CREATE), @DataChangeLog. 반환: {successCount, errorCount, errors[]}.
- `GET /api/chargebacks` — 목록(@RequirePermission READ, PageResponse).
- `GET /api/chargebacks/export` — 엑셀(@Transactional).
컨트롤러 위치 `controller/settle/ChargebackController` 또는 기존 chargeback 패키지 확인.
## 5. DB (V113)
- 메뉴 `CHARGEBACK_DATA`(환수자료관리), 상위 GRP_SETTLE, path `/settle/chargeback-data`, component `settle/ChargebackData`. (V97 단계마감 등 GRP_SETTLE 패턴)
- 권한 READ/CREATE/EXPORT + 역할부여 SUPER_ADMIN·ADMIN 전체, MANAGER READ.
- 공통코드 불필요(chargeback status는 기존 코드 재사용 여부 확인 — 없으면 생략).
## 6. Frontend
- `src/api/chargeback.ts` — list/upload(FormData)/export.
- `src/pages/settle/ChargebackData.tsx` — 상단 정산월 선택 + 파일 업로드 버튼(업로드 결과 성공/에러행 표시) + AG Grid 목록(증권번호/설계사/환수금액/잔여/상태/정산월) + 엑셀. 기존 업로드 화면(UploadPage 등) 결과표시 패턴 참고.
- App.tsx 라우트 `settle/chargeback-data`.
## 7. 검증(PL)
build+test, Flyway V113, GET 목록 200, **샘플 엑셀 업로드 실호출**(정상행 INSERT + 미존재 증권번호 에러행 리포트) 라이브 확인 후 테스트 chargeback 롤백/삭제.
</content>
+62
View File
@@ -0,0 +1,62 @@
# P11 — 시상/신인시상 환수 (#1)
작성: PL, 2026-06-04. 후속 갭 3종 중 두 번째.
근거: incar `유지율시상환수`/`신인도입유치자시상환수`/`시상내역 조회`. GA award_ledger(V92)는
지급만 있고 환수(clawback) 처리가 없음. 정착지원금/생보운영지원/지점장수당은 이미
`clawback_amount`+`net_amount` 패턴 보유 → **award_ledger도 동일 패턴으로 통일**.
신인시상은 award_type='NEW_RECRUIT'로 이미 존재 → 별도 테이블 불필요. 모든 award_type에 환수 적용.
Flyway: **V113 최신 → V114**. 금액 NUMERIC(15,2), HALF_UP.
## 1. 현재 award_ledger (V92)
ledger_id / agent_id / settle_month / award_type(NEW_RECRUIT/CORPORATE/RETENTION/PERFORMANCE) /
base_amount / award_amount / status(CALCULATED/CONFIRMED/PAID/CANCELLED) / created_at / updated_at.
aggregateByAgent = SUM(award_amount) WHERE status!=CANCELLED.
**문제**: clawback_amount/net_amount 없음. settling/life/branch는 net=supportclawback, aggregate=SUM(net).
## 2. 스키마 변경 (V114) — settling_support_ledger 패턴 미러
```sql
ALTER TABLE award_ledger
ADD COLUMN clawback_amount NUMERIC(15,2) NOT NULL DEFAULT 0,
ADD COLUMN net_amount NUMERIC(15,2) NOT NULL DEFAULT 0;
-- 기존 행 백필: 환수 없던 과거 = net = award
UPDATE award_ledger SET net_amount = award_amount WHERE net_amount = 0 AND clawback_amount = 0;
-- clawback 음수 방지 + 상태에 CLAWED_BACK 추가(settling 패턴과 통일)
ALTER TABLE award_ledger ADD CONSTRAINT chk_award_clawback CHECK (clawback_amount >= 0);
ALTER TABLE award_ledger DROP CONSTRAINT < status CHECK >; -- \d 로 확인 (예: award_ledger_status_check)
ALTER TABLE award_ledger ADD CONSTRAINT chk_award_status
CHECK (status IN ('CALCULATED','CONFIRMED','PAID','CANCELLED','CLAWED_BACK'));
```
> 기존 status CHECK 제약명은 `\d award_ledger` 또는 information_schema 로 정확히 확인 후 DROP. 추정명 사용 금지.
> net_amount는 음수 허용(환수>시상 시 음수 가능)이나, **§4 검증에서 clawback ≤ award_amount 강제**하므로 실제 net≥0. (지급성이므로 음수 차단 — settling 동일)
메뉴 변경 없음(award 화면 기존). 공통코드 AWARD_STATUS에 CLAWED_BACK 있으면 추가(없으면 생략).
## 3. Core
- AwardLedgerVO/Resp/SaveReq에 `clawbackAmount`, `netAmount` 추가.
- `AwardLedgerMapper.aggregateByAgent` XML: `SUM(award_amount)`**`SUM(net_amount)`** (net=awardclawback). status!=CANCELLED 유지.
- 신규 Mapper 메서드 `applyClawback(@Param ledgerId, @Param clawbackAmount, @Param netAmount, @Param status)` (+XML): clawback_amount/net_amount/status='CLAWED_BACK'/updated_at 갱신.
- createLedger 시 net_amount = award_amount clawback_amount 저장(insert XML에 두 컬럼 포함).
## 4. API (AwardService 확장)
- `createLedger`: clawback_amount(SaveReq, 기본0) 받아 **clawback ≤ award_amount 검증(초과 시 E411)**, net = award clawback 계산해 저장.
- **신규 액션** `applyClawback(ledgerId, AwardClawbackReq{clawbackAmount, reason})` @Transactional:
- 원장 조회(없으면 NOT_FOUND). 이미 CANCELLED면 E411.
- clawbackAmount > award_amount 면 E411("환수액이 시상액 초과").
- net = award_amount clawbackAmount. mapper.applyClawback(ledgerId, clawback, net, 'CLAWED_BACK').
- @DataChangeLog.
- Controller: `PUT /api/awards/ledgers/{id}/clawback` (@RequirePermission(menu=AWARD, action=UPDATE)). 기존 award 컨트롤러 경로 패턴 확인.
> **AggregateStep 무변경**: awardMapper.aggregateByAgent가 SUM(net_amount) 반환하므로 환수가 자동으로 other_commission 차감에 반영. net<0이면 P9 환수채권 이월에 자연 연계.
## 5. Frontend (기존 Award 화면 확장)
- award 원장 그리드에 환수액/실지급(net) 컬럼 추가.
- 행 액션 "환수처리"(PermissionButton UPDATE) → 모달(환수액 입력 + 사유) → PUT /clawback. 성공 시 invalidate.
- api 모듈에 applyClawback 추가. 기존 award api/페이지 파일명 확인 후 확장.
## 6. 검증(PL)
build+test, Flyway V114(award_ledger 컬럼/제약/백필), 라이브: award 원장 1건 생성(net=award) →
applyClawback(부분환수) → net 감소·status CLAWED_BACK 확인 → clawback>award E411 → aggregateByAgent
가 net 반영하는지 SQL 확인. 테스트 데이터 정리.
</content>
@@ -0,0 +1,65 @@
# P12 — 지급대상건 구성·수정 (#2)
작성: PL, 2026-06-04. 후속 갭 3종 중 마지막.
근거: incar `지급대상건구성`/`지급대상건수정`/`지급대상건조회`. GA는 settle_master를 건별
confirm/hold/release만 가능, **정산월 단위 지급대상 배치 구성(일괄 포함/제외 후 확정)** 레이어 부재.
범위: 풀스택. 기존 settle_master 위의 **구성/스냅샷 레이어**(settle_master 상태는 본 범위에서 변경 안 함 — 결합 최소화). Flyway: **V114 최신 → V115**. 금액 NUMERIC(15,2).
## 1. 개념
- 정산월의 지급대상(settle_master, payable_amount>0)을 모아 **배치(payment_batch)** 로 구성.
- 각 건(payment_batch_item)을 **포함/제외**(사유) 편집 → 합계 재계산.
- **확정(finalize)**: 배치 잠금(FINALIZED). 확정된 포함건 목록 = 지급대상 확정본(스냅샷).
- AccountingClose(V75 DRAFT/마감/재오픈) 패턴 준용. **settle_master.status는 본 범위에서 미변경**(향후 finalize→지급실행 연계는 별도).
## 2. 스키마 (V115)
### payment_batch (지급대상 배치)
| 컬럼 | 타입 | 설명 |
|---|---|---|
| batch_id | BIGSERIAL PK | |
| settle_month | CHAR(6) NN | |
| batch_name | VARCHAR(100) NN | |
| status | VARCHAR(20) NN DEFAULT 'DRAFT' | DRAFT/FINALIZED/CANCELLED |
| total_count | INT NN DEFAULT 0 | 포함건수 |
| total_payable | NUMERIC(15,2) NN DEFAULT 0 | 포함건 payable 합 |
| created_at/created_by/finalized_at/finalized_by/updated_at | | |
- idx(settle_month, status). CHECK status IN('DRAFT','FINALIZED','CANCELLED').
### payment_batch_item (지급대상건)
| 컬럼 | 타입 | 설명 |
|---|---|---|
| item_id | BIGSERIAL PK | |
| batch_id | BIGINT NN FK payment_batch | |
| settle_id | BIGINT NN FK settle_master | |
| agent_id | BIGINT NN FK agent | |
| payable_amount | NUMERIC(15,2) NN | settle_master.payable_amount 스냅샷 |
| included | BOOLEAN NN DEFAULT true | 포함여부 |
| exclude_reason | VARCHAR(300) | 제외사유 |
| created_at | | |
- UNIQUE(batch_id, settle_id). idx(batch_id).
### 메뉴/권한/코드
- 메뉴 `PAYMENT_TARGET`(지급대상관리), GRP_SETTLE, `/settle/payment-target`, `settle/PaymentTarget`.
- 권한 READ/CREATE/UPDATE/EXECUTE(확정) + 역할(SUPER_ADMIN·ADMIN 전체, MANAGER READ).
- 공통코드 PAYMENT_BATCH_STATUS(DRAFT=작성중/FINALIZED=확정/CANCELLED=취소).
## 3. API (PaymentBatchService, `/api/payment-batches`)
- `POST` create(settleMonth, batchName) @Transactional: payment_batch(DRAFT) INSERT → settle_master 조회(settle_month=, payable_amount>0, status != 'PAID') → 각 행 payment_batch_item(included=true, payable 스냅샷) INSERT → total_count/total_payable 집계 UPDATE. 동일월 DRAFT 중복 생성 허용(이름으로 구분).
- `GET` list(settleMonth/status 필터, PageResponse) / `GET /{id}` detail(배치 + items).
- `PUT /{id}/items/{itemId}` updateItem(included, excludeReason) @Transactional: DRAFT 배치만(FINALIZED/CANCELLED 시 E411). 항목 갱신 후 배치 total 재집계.
- `PUT /{id}/finalize` @Transactional, @RequirePermission EXECUTE: DRAFT→FINALIZED, finalized_at/by. 포함건 0이면 E411.
- `PUT /{id}/cancel`: DRAFT/FINALIZED→CANCELLED.
- `GET /{id}/export` 엑셀(@Transactional).
- @RequirePermission(PAYMENT_TARGET, *) + @DataChangeLog(쓰기).
총계 재집계: `total_count = COUNT(included=true)`, `total_payable = SUM(payable WHERE included)` — Mapper에 recalcTotals(batchId) 제공.
## 4. Frontend (PaymentTarget.tsx)
- 배치 목록(정산월/상태 필터) + "구성" 버튼(정산월+배치명 입력 → create).
- 배치 행 클릭 → 상세: 배치 헤더(상태/포함건수/합계) + items AG Grid(설계사/payable/포함체크/제외사유). DRAFT일 때 포함토글·사유 편집(PermissionButton UPDATE) → updateItem. 합계행.
- "확정" 버튼(PermissionButton EXECUTE, DRAFT만) → finalize. "취소" 버튼. 엑셀.
- React Query, 변경 후 invalidate.
## 5. 검증(PL)
build+test, Flyway V115, 라이브: create(특정월) → items 자동생성 확인 → updateItem 제외 → total 재집계 확인 → finalize → 잠금(이후 updateItem E411) → cancel. 테스트 데이터 정리.
</content>
+168
View File
@@ -0,0 +1,168 @@
# P9 — 환수채권 이월/미수금 관리 (Clawback Receivable Carry-forward)
작성: PL, 2026-06-04. 사용자 지시 "수수료 빠진 업무 찾아서 기획·설계 후 적용".
근거: incar CMS 메뉴(`환수이월관리`/`환수계약리스트`/`환수리스트`/`위촉중환수`) ↔ GA 부재 + 코드 갭
(`AggregateStep.java:197-199` — net<0 시 경고 로그만, 미회수 환수 채권화·차월상계·대손 생애주기 전무).
범위: 풀스택(DB→Core→API→Batch→Frontend). 패턴 100% 준수(template = 정착지원금 V90 / SettlingSupport*).
Flyway: **V110이 최신 → V111부터.** 금액 NUMERIC(15,2), HALF_UP.
**확정 FK**: agent(agent_id), settle_master(agent_id, settle_month).
---
## 1. 업무 정의 (표준 한국 GA 관행 — 데이터로 외부화)
조기해지 차등환수(chargeback)·공제가 당월 지급수수료(gross)를 초과하면 `net < 0`. 이 미회수분은 **설계사가 GA에 갚아야 할 미수채권(환수채권)** 이다. 표준 처리:
1. **이월(carryover)**: 당월 net<0 → 음수분(|net|)을 환수채권으로 신규 등록, 당월 실지급(payable)=0.
2. **상계 회수(recovery)**: 차월 이후 net>0이면 미결 채권을 **FIFO(오래된 origin월 우선)** 로 상계 회수. payable = net 회수액.
3. **대손/직접상환(write-off / direct settle)**: 장기 미회수 채권은 관리자가 대손(WRITTEN_OFF) 또는 외부 직접상환(CLEARED) 처리.
표준 가정(회사 정책 다르면 데이터/룰만 수정, 코드 불변):
- 상계 우선순위 = origin_settle_month ASC (FIFO).
- 회수는 당월 양수 net 한도 내에서만(설계사를 음수로 만들지 않음).
- 이자·연체료 없음(필요 시 후속).
---
## 2. 스키마 (V111)
### 2-1. clawback_receivable (환수채권 마스터)
| 컬럼 | 타입 | 설명 |
|---|---|---|
| receivable_id | BIGSERIAL PK | |
| agent_id | BIGINT NN FK agent | |
| origin_settle_month | CHAR(6) NN | 미수 발생 정산월 |
| original_amount | NUMERIC(15,2) NN | 발생액(양수, =당월 |net|) |
| recovered_amount | NUMERIC(15,2) NN DEFAULT 0 | 누적 상계 회수액 |
| balance | NUMERIC(15,2) NN | = original_amount recovered_amount |
| status | VARCHAR(20) NN DEFAULT 'OUTSTANDING' | OUTSTANDING/RECOVERING/CLEARED/WRITTEN_OFF |
| last_recovery_month | CHAR(6) | 최근 회수 정산월 |
| writeoff_reason | VARCHAR(300) | 대손/직접상환 사유 |
| written_off_at | TIMESTAMP | |
| written_off_by | BIGINT | |
| created_at | TIMESTAMP NN DEFAULT now() | |
| created_by | BIGINT | |
| updated_at | TIMESTAMP | |
- UNIQUE(agent_id, origin_settle_month) — 설계사·발생월당 1건(배치 upsert 멱등 키)
- CHECK status IN('OUTSTANDING','RECOVERING','CLEARED','WRITTEN_OFF')
- CHECK original_amount >= 0, balance >= 0
- idx: (agent_id, status), (status), (origin_settle_month)
### 2-2. clawback_recovery (상계 회수 이력)
| 컬럼 | 타입 | 설명 |
|---|---|---|
| recovery_id | BIGSERIAL PK | |
| receivable_id | BIGINT NN FK clawback_receivable | |
| settle_month | CHAR(6) NN | 회수(상계) 정산월 |
| recovered_amount | NUMERIC(15,2) NN | 이 월 이 채권에서 회수한 액 |
| created_at | TIMESTAMP NN DEFAULT now() | |
- idx: (receivable_id), (settle_month)
- **멱등 키**: 배치 재실행 시 동일 settle_month 회수분을 reverse(삭제+balance 복원) 후 재적용.
### 2-3. settle_master 컬럼 추가 (기존 의미 불변)
```sql
ALTER TABLE settle_master
ADD COLUMN clawback_recovered NUMERIC(15,2) NOT NULL DEFAULT 0, -- 당월 채권 상계 회수액
ADD COLUMN clawback_carryover NUMERIC(15,2) NOT NULL DEFAULT 0, -- 당월 발생→이월된 미수액
ADD COLUMN payable_amount NUMERIC(15,2) NOT NULL DEFAULT 0; -- 실지급(이체대상) = max(0,net) recovered
```
- `net_amount`(=gross−소득세−지방세+부가세−공제) 의미·계산 **불변**(무결성 Σ원장==Σsettle_master 보존).
- 실제 이체/출금 가용액은 `payable_amount` 사용(후속: withdraw 한도 검증을 payable_amount 기준으로 전환은 본 P9 범위 외, 문서화만).
### 2-4. 메뉴 / 권한 / 공통코드
- 메뉴 `CLAWBACK_RECEIVABLE` (환수채권관리), 상위 GRP_COMMISSION, path `/commission/clawback-receivable`, component `commission/ClawbackReceivable`.
- 권한 READ/UPDATE/EXPORT + 역할부여(SUPER_ADMIN·ADMIN 전체, MANAGER READ) — V54/V95 패턴.
- 공통코드 `CLAWBACK_RCV_STATUS`: OUTSTANDING=미회수/RECOVERING=회수중/CLEARED=상환완료/WRITTEN_OFF=대손.
---
## 3. 배치 통합 (AggregateStep, Step 8) — **핵심**
설계사 루프에서 `rawNet = tax.netAmount() deductionTotal` 계산 직후(현 196행), settle_master.upsert **이전**에 삽입:
```
priorBalance = receivableMapper.outstandingBalance(agentId, settleMonth)
// SUM(balance) WHERE agent_id=? AND status IN('OUTSTANDING','RECOVERING')
// AND origin_settle_month < settleMonth
recovered = 0; carryover = 0; payable = 0
if (rawNet.signum() >= 0) {
recovered = min(rawNet, priorBalance) // 양수 net에서 기존 채권 FIFO 상계
payable = rawNet - recovered
} else {
payable = 0
carryover = rawNet.negate() // 음수분 신규 채권화
}
vo.setNetAmount(rawNet) // 불변
vo.setClawbackRecovered(recovered)
vo.setClawbackCarryover(carryover)
vo.setPayableAmount(payable)
settleMapper.upsert(vo)
// settle_master upsert 가드(status NOT IN CONFIRMED/PAID)와 동일 행만 채권 부수효과 적용
if (settle_master 행이 갱신가능 상태였다면) {
clawbackService.applyCarryoverAndRecovery(agentId, settleMonth, carryover, recovered)
}
```
**applyCarryoverAndRecovery (배치 멱등 보장)** — ga-batch 내 헬퍼 또는 Mapper 직접:
1. **reverse**: 이 settleMonth의 기존 clawback_recovery 행 조회 → 각 receivable.balance += recovered_amount, recovered_amount -= , status 재계산(CLEARED→RECOVERING/OUTSTANDING) → recovery 행 삭제. (재실행 안전)
2. **carryover**: carryover>0 → upsert clawback_receivable (agent_id, origin=settleMonth) {original_amount=carryover, balance=carryover, recovered_amount=0, status=OUTSTANDING}. (ON CONFLICT 갱신)
3. **recovery**: recovered>0 → outstanding 채권 origin_month ASC FIFO 순회:
- take = min(recovered_remaining, rcv.balance); rcv.recovered_amount += take; rcv.balance -= take;
status = balance==0 ? CLEARED : RECOVERING; last_recovery_month=settleMonth;
INSERT clawback_recovery(receivable_id, settleMonth, take); recovered_remaining -= take;
- recovered_remaining==0 종료.
> reverse를 먼저 하므로 동일 월 재정산 시 회수 중복 없음. carryover는 UNIQUE upsert로 멱등.
> **주의**: priorBalance 조회는 `origin_settle_month < settleMonth` 로 당월 발생분 자기상계 방지.
배치 Step 순서: AggregateStep(8) 내부에서 처리(별도 Step 불필요). 회계분개(8b)·세금은 net_amount 기준 불변.
---
## 4. API (ga-api)
`ClawbackReceivableService` + `ClawbackReceivableController` (`/api/clawback-receivables`):
- `GET /api/clawback-receivables` — 목록(agentId/status/originMonth 필터, PageHelper, @RequirePermission READ)
- `GET /api/clawback-receivables/{id}` — 상세 + 회수이력(clawback_recovery 리스트)
- `GET /api/clawback-receivables/summary` — 설계사별 미결 잔액 집계(status OUTSTANDING/RECOVERING)
- `PUT /api/clawback-receivables/{id}/write-off` — 대손/직접상환 처리(@RequirePermission UPDATE, @DataChangeLog).
body {action: WRITTEN_OFF|CLEARED, reason}. balance→0, status 전이, writeoff_* 기록. **OUTSTANDING/RECOVERING만 허용**(CLEARED/WRITTEN_OFF 재처리 E411).
- `GET /api/clawback-receivables/export` — 엑셀(ExcelService, @Transactional).
- 표준 ApiResponse/PageResponse, MapStruct, BaseMapper 상속.
회수(recovery)는 **배치만** 생성(수동 회수 엔드포인트 없음 — 정산 상계로만 발생).
---
## 5. Frontend (ga-frontend)
- `src/api/clawbackReceivable.ts` — list/detail/summary/writeOff/export.
- `src/pages/commission/ClawbackReceivable.tsx` — AG Grid(목록 100건+ / status 컬러칩 / 합계행: original/recovered/balance) + 행 클릭 상세 Drawer(회수이력 타임라인) + 대손/상환 처리 버튼(PermissionButton UPDATE) + 엑셀 export.
- `App.tsx` 라우트 `commission/clawback-receivable` (lazy).
---
## 6. 검증 (PL 직접)
1. `./gradlew build`(test 포함) SUCCESSFUL, ga-frontend `npm run build` PASS.
2. Flyway V111 success, schema v111. 테이블 2개·컬럼 3개·메뉴 1·권한·공통코드 확인.
3. GET 3종 + write-off PUT 실호출 5xx 0.
4. **배치 e2e (핵심)**: 단일 트랜잭션 롤백 시나리오로
- (a) 특정 설계사에 chargeback>gross 인 net<0 상황 구성 → 202611 정산 → clawback_carryover 발생 + clawback_receivable OUTSTANDING 1건 + payable=0 확인.
- (b) 익월 202612 정산(양수 net) → clawback_recovered 상계 + receivable balance 감소/CLEARED + clawback_recovery 행 + payable=netrecovered 확인.
- (c) 동일월 재실행 → 회수 중복 없음(reverse 멱등) 확인.
- 부산물 전부 롤백, pre-e2e 복원.
---
## 7. 후속 갭 (본 P9 범위 외, 기록)
- 시상/인정실적 환수 ledger (incar `인정실적수수료환수`/`신인도입유치자시상환수`).
- 지급대상건 구성·수정(수동 포함/제외 워크플로우, incar `지급대상건구성/수정/조회`).
- 환수 보험사자료 업로드(incar `환수보험사자료 업로드` — 보험사 통보 기반 환수 인입).
- withdraw 가용한도 검증을 net_amount→payable_amount 로 전환.
</content>
</invoke>
@@ -0,0 +1,182 @@
# 수수료 계산 공식 전체 레퍼런스 (코드 기준)
> 모든 수수료 종류의 **실제 구현 계산식**을 정리한 문서입니다.
> 출처는 각 `*Service` / `*Calculator` / Step 코드이며, 2026-06 수수료 감사 수정분이 반영돼 있습니다.
> 공통 규칙: 모든 금액 `BigDecimal`, 반올림 `HALF_UP`. 금액 `NUMERIC(15,2)`(소수 2자리),
> 율 `NUMERIC(7,4)`. 원천세·환수 등 일부 집계는 원단위(scale 0).
---
## 0. 가장 기본 — 모집/유지 "세 번 곱하기"
`CommissionCalculator` (모집·유지 공통, 회차만 다름)
```
① 보험사지급액 = 보험료(premium) × 보험사요율(company_rate %) / 100
② 설계사수수료 = 보험사지급액 × 지급률(payout_rate %) / 100 ← gross(agent_amount)
③ 원장 원천세 = 설계사수수료 × 3.3% ← tax_amount
```
- `company_rate`: 상품 × 회차(commission_year) × 기준일로 조회
- `payout_rate` : 설계사등급 × 보험종류 × 회차로 조회 (등급 높을수록 ↑)
- 율이 NULL이면 0 폴백 + **경보 로그**(과소지급 추적). 금액 pct는 scale 2.
- **숫자 예시**: 보험료 1,000,000 × 60% = 600,000 → × 75% = 450,000 → 세금 14,850
| 종류 | 코드 | 회차(commission_year) | 귀속 |
|---|---|---|---|
| **모집수수료** | recruit | 1 (초년도) | 원 모집설계사 (승계돼도 잔류) |
| **유지수수료** | maintain | 2~ (`monthsElapsed/12 + 1`) | 현재 관리설계사 (승계 시 후임) |
---
## 1. 설계사 지급성 수수료 (settle_master gross 에 합산되는 9종 + 본 2종)
| # | 종류 | 코드 | 계산 공식 | 비고 |
|---|---|---|---|---|
| 1 | 모집수수료 | recruit | `premium × company_rate × payout_rate` | §0 |
| 2 | 유지수수료 | maintain | 〃 (회차만 다름) | §0 |
| 3 | **수금수수료** | collection | `commission = 보험료(premium_amount) × 수수료율(commission_rate)` | `CollectionCommissionService:89` |
| 4 | **갱신수수료** | renewal | `commission = req.commissionAmount` (룰의 rateValue/fixedAmount 참조, 원장은 입력액) | `RenewalCommissionService:91` |
| 5 | **부활수수료** | reinstatement | `net = commissionAmount + chargebackReversal` (부활 시 기환수액 일부 복원) | `ReinstatementCommissionService:88,100` |
| 6 | **지속수당(유지보너스)** | persistency_bonus | 유지율 ≥ `retention_rate_threshold` 일 때 `bonus_value` (RATE형 base×율 / FIXED형 정액) | 룰: 등급별 임계유지율 |
| 7 | **소개·이관수수료** | referral | RATE형 `base × rate` / FIXED형 `fixed_amount`. (RATE는 룰 rate 우선, 없으면 req) | `ReferralCommissionService:103,110,114` |
| 8 | **정착지원금** | settling_support | `net = support_amount clawback`. **환수액 ≤ 지원금 검증**(net 음수 차단) | `SettlingSupportService` |
| 9 | **시상** | award | `threshold_amount 이상`일 때만: RATE `base × award_rate` / FIXED `award_fixed` | `AwardService` (threshold 게이트) |
| 10 | **생보운영지원수수료** | life_support | `support = base × support_rate`, `net = support clawback`. **환수 ≤ support 검증** | `LifeSupportService` |
| 11 | **지점장수당** | branch_allowance | `allowance = min(base × allowance_rate, cap)`. cap=NULL이면 무제한. `net = allowance clawback` | `BranchAllowanceService:85-93` |
> settle_master 집계 시 9종(3~11, 모집·유지 제외)은 `other_commission_total` 로 합산돼 gross 에 더해진다.
---
## 2. 조직·실적 기반
| 종류 | 코드 | 계산 공식 | 비고 |
|---|---|---|---|
| **오버라이드** | override | `amount = min(base × override_pct, cap)`. **base = 하위설계사 모집+유지 합** (룰에 `insurance_type_cond` 있으면 해당 보험종류만 집계) | `CalcOverrideStep`. cap NULL=무제한. 조직트리 상향 탐색해 가장 가까운 `to_grade` 1명에 귀속 |
| **인정실적(환산보험료)** | recognized | `converted = premium × conversion_rate`, `recognized = converted × recognition_rate` | `RecognizedPerformanceService:85,89`. 시상·등급 산정 기초 |
| **수입수수료** | income | `income = premium × company_rate`. 수지차 `margin = Σincome Σpayout`, `marginRate = margin / Σincome` | `IncomeCommissionService:47,83,86`. 보험사→GA 수입 원장 |
| **등급평가** | grade_eval | `performance_score``selectActiveRuleByScore` → 매칭 룰의 `gradeId`로 등급 결정 (없으면 기존등급 유지) | `GradeEvaluationService:95-97` |
| **공동계약 지분** | joint_contract | 계약별 `Σ share_rate ≤ 1.0` 검증 (초과 시 E411). 각 설계사 몫 = 수수료 × 본인 share_rate | `JointContractService` |
| **준비금** | reserve_fund | `balance = (직전월 balance or 0) + reserve_in reserve_out` | `ReserveFundService:50` |
| **수수료 시뮬레이션** | simulation | `사수 = premium×company_rate×payout_rate`, `원천세 = 사수×3.3%`, `net = 사수−원천세`, `예상환수 = 사수×기본환수율(or 입력)` | `CommissionSimulationService` (조회 전용 미리보기) |
---
## 3. 횡단(cross-cutting) 규제·정산 계산
### 3-1. 1200% 룰 (RegulatoryLimitChecker) — **단위 환산 + clip+이연**
```
한도(KRW) = 연환산보험료 × 한도율(%) / 100 ← unit=PERCENT 일 때 (1200%, 1차년 35%)
위반조건 = (기지급 누적 + 추가분) > 한도(KRW)
```
- 1차년 한도 초과 시: **한도잔여까지만 당월 지급(clip)**, 초과분만 분급(7년)으로 **이연**, 세액 재계산.
전액 이연되면 당월 원장 미생성. (`CalcRecruitStep`)
### 3-2. 분급 (InstallmentPlanGenerator) — 7년 분할
```
회차별 지급 = 총수수료 × 회차비율(%) / 100 (표준 35/25/15/10/7/5/3)
```
- 비율 합이 정확히 100%이면 **마지막 회차가 반올림 잔차를 흡수**(분급 합 = 원금 보장).
### 3-3. 차등환수 (ChargebackCalculator) — 조기해지
```
경과월 = MONTHS_BETWEEN(계약일, 해지일)
환수액 = 기지급 모집수수료 × 환수율(경과월 구간)
```
| 경과월 | 환수율 |
|---|---|
| 0 ~ 12 | 100% |
| 13 ~ 24 | 50% |
| 25 ~ 36 | 25% |
| 37 ~ 84 | 10% |
| 85 ~ | 0% |
- (0개월 즉시해지도 100% 구간에 포함 — V109 보정)
### 3-4. 세금 (TaxCalculator / BatchTaxCalculator)
```
소득세 = gross × 소득세율(사업 3.3% / 기타 8.8%) (scale 0, 원단위)
지방세 = 소득세 × 10% (scale 0)
부가세 = gross × 10% (과세사업자 TAXABLE 만, 그 외 0)
net = gross − 소득세 − 지방세 + 부가세
```
- **gross ≤ 0(환수>지급)이면 세금 0, net = gross** (음수 원천세가 신고에 전파되는 것 차단)
### 3-5. 집계 → 실지급 (AggregateStep, settle_master)
```
gross = 모집 + 유지 + 오버라이드 + 예외(+) − 환수 − 예외() + 기타9종(other_commission_total)
tax = 소득세 + 지방세
net = gross − 소득세 − 지방세 + 부가세 − 공제(deduction)
```
- net < 0(공제>지급)이면 경보 로그(차월 이월 검토 대상).
- 무결성: 8단계 후 `Σ원장 == Σsettle_master`.
### 3-6. 회계 분개 (AccountingEntryGenerateStep) — **원천세 예수금 분리**
```
(차) 8350 지급수수료 gross
(대) 2530 미지급금 net (= gross 원천세)
(대) 2540 예수금 원천세(tax_amount) ← 원천세>0 일 때 leg 분리
```
- 차변합(gross) = 대변합(net + 원천세) 균형.
---
## 3-7. 2026-06 감사 보완 4종 (V124~V126)
설계사 지급성 수수료 종류는 사실상 완비된 상태에서, 감사로 발견한 **실제 결함·규제 갭**만 보완.
### 3-7-A. 지급보류(HOLD) 지급배치 제외 — **버그 수정**
```
지급배치 대상 = settle_master WHERE payable_amount>0 AND status NOT IN ('PAID','HOLD')
```
- 종전엔 `status != 'PAID'` 만 검사 → 운영자가 지급보류(HOLD)한 설계사도 펌뱅킹 이체에 포함되던 결함.
(`PaymentBatchItemMapper.insertFromSettleMaster`)
### 3-7-B. 환수 원천세 역분개 — 교차월 환수 시 기납부 원천세 보정
```
gross<0(상계되지 않은 환수분)인 월:
역분개 기준액 = |gross|
소득세 역분개 = −(|gross| × 소득세율) ← withholding_tax_adjustment (음수)
지방세 역분개 = −(소득세 역분개액 × 10%)
분기 원천세신고 = Σpayment(원천세) + Σadjustment(역분개, 음수) ← 과대신고 해소
```
- gross≥0(당월 환수가 양수분으로 상계)인 달은 당월 과세에 이미 반영 → **역분개 미발생**(이중계상 없음).
- settle_master gross/net/carryover/payable 흐름은 **불변**(역분개는 신고보정용 별도 레코드).
(`AggregateStep` gross<0 분기, `WithholdingTaxReportMapper.upsertQuarterlyAggregate`)
### 3-7-C. 환수채권 연체이자 — 미수채권 이월 시 월 단리 적립
```
당월 적립이자 = 채권잔액(balance) × 연체이자율(%) / 1200 (월 단리, scale 0)
적립조건 = origin_settle_month ≤ 당월 (거치기간+1)
balance += 적립이자 (→ 기존 FIFO 상계가 이자까지 회수)
```
- 이자율 `CLAWBACK_OVERDUE_INTEREST_RATE`(기본 0=미적립 안전폴백), 거치기간 `CLAWBACK_INTEREST_GRACE_MONTHS`(기본 0).
- 멱등: `clawback_interest` 이력으로 당월 적립분 reverse 후 재적립. (`AggregateStep.reverseAndAccrueClawbackInterest`)
### 3-7-D. 사업소득 간이지급명세서(월별) — 국세청 제출 대응
```
간이지급명세서 = commission_statement(MONTHLY) ⋈ agent
(소득자·주민/사업자번호·지급액·소득세·지방소득세·차인지급액)
```
- 신규 데이터테이블 없음(읽기전용 리포트). 조회 + 엑셀 export. (`ReportMapper.selectSimplifiedPayment`)
---
## 4. 실지급 흐름 한 장 요약
```
보험료 ─×보험사요율─▶ 보험사지급액 ─×지급률─▶ 설계사수수료(gross)
┌─ 1200%룰: 1차년 한도 clip + 초과분 7년 분급 이연 ─┐
└─ 조기해지: 차등환수(−) / 부활: 환수복원(+) ┘
gross − 소득세 − 지방세 (+부가세) − 공제 = net(실지급) ──▶ 펌뱅킹 이체
회계분개: (차)지급수수료 / (대)미지급금 net + 예수금 원천세
```
---
*기준 코드: CommissionCalculator, TaxCalculator, ChargebackCalculator, InstallmentPlanGenerator,
RegulatoryLimitChecker, CalcRecruit/Maintain/OverrideStep, AggregateStep, AccountingEntryGenerateStep,
P7/P8 12개 commission Service. schema v126. 2026-06 수수료 감사 수정 + 갭보완 4종(§3-7) 반영.*
@@ -0,0 +1,168 @@
# E2E 시나리오 — 보험이 어떻게 들어와서 수수료가 어떻게 나가는가
> 이 문서는 **계약 1건이 인입되어 설계사 통장에 돈이 꽂힐 때까지**의 전체 순서를
> "등장인물 + 숫자"로 따라가는 시나리오입니다.
> 각 단계는 실제 계산 코드(`CommissionCalculator`, `RegulatoryLimitChecker`,
> `InstallmentPlanGenerator`, `ChargebackCalculator`, `TaxCalculator`)와 1:1로 대응하며,
> 이 시나리오를 그대로 검증하는 단위테스트가 `SettlementScenarioTest` 입니다.
---
## 0. 등장인물 (이 시나리오의 테스트 데이터)
| 역할 | 식별자 | 속성 |
|---|---|---|
| 원 모집설계사 **김설계** | `agentId=10`, `gradeId=5` | 사업소득(BUSINESS_INCOME) · 과세사업자(TAXABLE) |
| 후임 승계설계사 **박승계** | `agentId=20`, `gradeId=3` | (계약 승계 단계에서 등장) |
| 상위 직책자 **이지점** | `agentId=30` | 오버라이드 수령 |
| 상품 **무배당 종신보험** | `productId=1`, `WHOLE_LIFE`, 카테고리 `LIFE` | |
| 계약 | `contractId=100`, `policyNo=POL-0001` | 연납보험료 **1,000,000원**, 계약일 **2024-01-15** |
기준 룰(테스트에서 Mock으로 주입하는 데이터):
| 룰 | 값 |
|---|---|
| 보험사요율(company_rate) 1차년 | 60% |
| 보험사요율 2차년 | 10% |
| 지급률(payout_rate) 등급5·WHOLE_LIFE·1차년 | 75% |
| 지급률 등급5·2차년 | 50% |
| 지급률 등급3(후임)·2차년 | 40% |
| 분급 비율(7년) | 35 / 25 / 15 / 10 / 7 / 5 / 3 (%) |
| 차등환수 13~24개월 구간 | 50% |
| 1200% 한도(TOTAL_RATIO) | 12,000,000원 (연납 1,000,000 × 1200%) |
| 원천세 | 사업소득 3.3% · 지방세 = 소득세 10% · 부가세 10%(과세사업자) |
---
## 1. 한눈에 보는 순서
```
[보험사] 실적데이터 인입
│ (Step1 receive → Step2 transform → Step3 reconcile)
① 모집수수료 원장 계산 (Step4 calcRecruit) ← premium × company_rate × payout_rate
② 1200% 룰 한도 체크 (RegulatoryLimitChecker) ← 누적이 한도를 넘으면 잘라냄
③ 분급(7년) 계획 생성 (InstallmentPlanGenerator) ← 큰 모집수수료를 7년에 나눠 지급
④ 유지수수료 원장 계산 (Step5 calcMaintain) ← 2차년 이후 매년
│ └ ⑤ 계약 승계 시 후임에게 귀속 전환 (모집은 원설계사 유지)
⑥ 오버라이드 계산 (Step7 calcOverride) ← 하위실적 × 율 (cap 제한)
⑦ 조기 해지 환수 (Step6 chargeback) ← 유지개월 짧을수록 많이 환수
⑧ 설계사×월 집계 (Step8 aggregate) ← gross 합산
│ └ 세금 원천징수 + 공제 차감 → net(실지급액)
[설계사 통장] ← 펌뱅킹 이체(KFTC)
```
---
## 2. 단계별 숫자 (시나리오 본문)
### ① 모집수수료 원장 계산 — 보험이 "들어오는" 첫 돈
계약이 인입되면 설계사 김설계(등급5)의 모집수수료 원장 1줄이 생긴다.
```
① 보험사지급액 = 보험료 1,000,000 × 보험사요율 60% = 600,000
② 설계사수수료 = 600,000 × 지급률 75% = 450,000 ← gross
③ 원장 원천세 = 450,000 × 3.3% = 14,850
```
→ 원장: `agent_id=10`, `commission_year=1`, `agent_amount=450,000`, `tax_amount=14,850`
### ② 1200% 룰 한도 체크
초년도 모집수수료 누적이 연납보험료의 1200%(=12,000,000)를 넘으면 안 된다.
- 현재 누적 0 + 450,000 = 450,000 ≤ 12,000,000 → **통과**
- 만약 추가분이 한도를 넘기면 `ViolationResult.violated` 로 막고 초과분을 잘라낸다.
### ③ 분급(7년 분할) 계획 생성
모집수수료 450,000을 한 번에 안 주고 7년에 나눈다.
| 차년 | 비율 | 지급액 |
|---|---|---|
| 1 | 35% | 157,500 |
| 2 | 25% | 112,500 |
| 3 | 15% | 67,500 |
| 4 | 10% | 45,000 |
| 5 | 7% | 31,500 |
| 6 | 5% | 22,500 |
| 7 | 3% | 13,500 |
| **합** | **100%** | **450,000** |
> **무결성 규칙:** 분급액의 **합은 원수수료와 정확히 같아야 한다.**
> 금액이 딱 나눠떨어지지 않을 때(예: 435,150원) 회차별 반올림 잔차가 생기는데,
> 이때는 **마지막 회차가 잔차를 흡수**해서 합계를 원금에 맞춘다. (→ §4 보완)
### ④ 유지수수료 (2차년)
계약이 유지되면 2차년부터 유지수수료가 매년 발생한다.
```
보험사지급액 = 1,000,000 × 10%(2차년 요율) = 100,000
설계사수수료 = 100,000 × 50%(등급5 2차년) = 50,000
```
### ⑤ 계약 승계 (김설계 해촉 → 박승계 후임)
김설계가 해촉되면 그 계약의 **유지수수료만** 후임 박승계(등급3)에게 넘어간다.
```
유지수수료(후임) = 100,000 × 40%(등급3 2차년) = 40,000 → 원장 agent_id = 20(박승계)
```
- **모집수수료는 원 모집설계사 김설계(10)에게 그대로 남는다.** (고아계약 승계 표준)
### ⑥ 오버라이드 (상위 직책자 이지점)
하위 김설계의 실적에 대해 상위 이지점이 받는 수당.
```
오버라이드 = 하위실적 2,000,000 × 4% = 80,000 (cap 100,000 미만이므로 그대로)
```
### ⑦ 조기 해지 환수 — 13개월차 해지
계약이 13개월차(2024-01-15 → 2025-02-15)에 깨지면 13~24개월 구간 환수율 50%.
```
환수액 = 기지급 모집수수료 450,000 × 50% = 225,000 ← 다음 정산에서 (−) 차감
```
### ⑧ 집계 → 세금 → 실지급액(net)
김설계 한 달치를 settle_master로 집계하고 세금·공제를 반영한다.
과세사업자(TAXABLE) gross 450,000 기준:
```
소득세 = 450,000 × 3.3% = 14,850
지방세 = 14,850 × 10% = 1,485
부가세 = 450,000 × 10% = 45,000 (과세사업자만 +)
실지급 = 450,000 14,850 1,485 + 45,000 = 478,665
```
- 여기에 가지급금 공제 100,000이 있으면 net = 478,665 100,000 = **378,665**
- 비과세(NONE) 설계사는 부가세가 없어 net = 450,000 14,850 1,485 = **433,665**
---
## 3. 시나리오 ↔ 코드 ↔ 테스트 대응표
| 단계 | 코드 | 테스트 메서드 |
|---|---|---|
| ① 모집수수료 | `CommissionCalculator.calcRecruitLedger` | `s1_보험인입_모집수수료_원장계산` |
| ② 1200% 룰 | `BatchRegulatoryLimitChecker.checkContractTotal` | `s2_규제_1200퍼센트_한도_통과및위반` |
| ③ 분급 7년 | `BatchInstallmentPlanGenerator.generate` | `s3_분급_7년_분할_합계100퍼센트` |
| ③ 분급 잔차 | 〃 | `s3b_분급_라운딩_잔차_마지막회차_흡수` |
| ④ 유지수수료 | `CommissionCalculator.calcMaintainLedger` | `s4_유지수수료_2차년` |
| ⑤ 계약 승계 | `CommissionCalculator.calcMaintainLedger(effectiveAgentId)` | `s5_계약승계_유지수수료_후임귀속` |
| ⑦ 차등 환수 | `BatchChargebackCalculator.calculate` | `s6_조기해지_차등환수_13개월_50퍼센트` |
| ⑧ 세금/실지급 | `BatchTaxCalculator.calculate` | `s7_세금_실지급액_과세사업자` / `s8_세금_비과세` |
---
## 4. 이 시나리오 작성 중 발견·보완한 사항
**분급 계획 합계 불일치(반올림 잔차) — 수정함.**
- 현상: 분급액을 회차별로 `총액 × 비율 / 100` 으로 각각 반올림하면,
원금이 7로 나눠떨어지지 않을 때 분급 합계가 원금과 1~수원 어긋났다.
(예: 435,150원 → 회차 합 435,153원, +3원 누수)
- 영향: 분급 총합 ≠ 원 모집수수료 → 정산 무결성(합계 일치) 위반, 과/미지급.
- 수정: **비율 합이 정확히 100%인 정규 스케줄**일 때 마지막 회차가
`원금 직전 회차 합` 으로 잔차를 흡수하도록 보정.
(비율 합이 100% 미만인 부분지급 스케줄은 기존 동작 유지 → 설계 의도 보존)
- 대상: `InstallmentPlanGenerator`(ga-api), `BatchInstallmentPlanGenerator`(ga-batch) 양쪽.
---
*기준: schema v108, DOMAIN_KNOWLEDGE.md 7장 공식. 모든 금액 BigDecimal HALF_UP.*
@@ -14,6 +14,8 @@
4. [수수료가 뭐고 왜 종류가 많은가](#4-수수료가-뭐고-왜-종류가-많은가) 4. [수수료가 뭐고 왜 종류가 많은가](#4-수수료가-뭐고-왜-종류가-많은가)
5. [수수료 종류 한눈에 (우리 시스템이 다루는 전부)](#5-수수료-종류-한눈에-우리-시스템이-다루는-전부) 5. [수수료 종류 한눈에 (우리 시스템이 다루는 전부)](#5-수수료-종류-한눈에-우리-시스템이-다루는-전부)
6. [수수료 계산의 핵심 공식 — "세 번 곱하기"](#6-수수료-계산의-핵심-공식--세-번-곱하기) 6. [수수료 계산의 핵심 공식 — "세 번 곱하기"](#6-수수료-계산의-핵심-공식--세-번-곱하기)
- 6-A. [수수료 종류별 계산식 — 하나씩 풀어보기](#6-a-수수료-종류별-계산식--하나씩-풀어보기--전부)
- 6-B. [기타수수료 — 예외 가감과 그 밖의 정산](#6-b-기타수수료--예외-가감과-그-밖의-정산--전부)
7. [숫자로 끝까지 따라가기 (한 계약의 일생)](#7-숫자로-끝까지-따라가기-한-계약의-일생) 7. [숫자로 끝까지 따라가기 (한 계약의 일생)](#7-숫자로-끝까지-따라가기-한-계약의-일생)
8. [그냥 곱하면 안 되는 이유 — 규제 3종](#8-그냥-곱하면-안-되는-이유--규제-3종) 8. [그냥 곱하면 안 되는 이유 — 규제 3종](#8-그냥-곱하면-안-되는-이유--규제-3종)
9. [세금과 공제 — 통장에 적게 들어오는 이유](#9-세금과-공제--통장에-적게-들어오는-이유) 9. [세금과 공제 — 통장에 적게 들어오는 이유](#9-세금과-공제--통장에-적게-들어오는-이유)
@@ -175,6 +177,125 @@
--- ---
## 6-A. 수수료 종류별 계산식 — 하나씩 풀어보기 (★ 전부)
5장 표의 "한 줄 공식"을 **실제 계산 방식 + 작은 숫자 예시**로 풀었습니다.
대부분 **"무엇 × 율"** 한 줄이고, 일부만 환수·한도·조건이 붙습니다.
(율은 코드에서 % 또는 소수로 들어오며, 모든 금액은 반올림 후 원 단위로 떨어집니다.)
### 계약 생애주기 기반
| 수수료 | 계산식 | 작은 예시 |
|---|---|---|
| **모집수수료** | 보험료 × 보험사요율 × 지급률 (세 번 곱하기, 1차년) | 100만 ×60% ×75% = **450,000** |
| **유지수수료** | 〃 (회차만 2차년 이후, 율이 더 낮음) | 100만 ×10% ×50% = **50,000** |
| **수금수수료** | 납입된 보험료 × 수금율 | 월납 100,000 ×5% = **5,000** |
| **갱신수수료** | 갱신보험료 × 갱신율 (실무는 확정 금액 입력) | 갱신 80만 ×3% = **24,000** |
| **부활수수료** | 부활 시 수수료 + **환수복원**(깎였던 환수 일부 되돌림) | 수수료 30,000 + 복원 10,000 = net **40,000** |
> **수금수수료가 왜 따로?** 계약만 따왔다고 끝이 아니라 **고객이 실제로 보험료를 내야** 돈이 들어옵니다. 그 "낸 보험료"에 비례해 주는 게 수금수수료입니다.
### 성과·조직 기반
| 수수료 | 계산식 | 작은 예시 |
|---|---|---|
| **오버라이드** | min(하위 설계사 실적 × 오버라이드율, **한도**) · 한도 없으면 무제한 | 하위 200만 ×4% = **80,000** (한도 10만 미만이라 그대로) |
| **지속수당** | 유지율이 **기준 이상**일 때만 → 실적×율 또는 등급별 정액 | 13회차 유지율 85% ≥ 기준 → 정액 **100,000** |
| **시상(Award)** | 실적이 **기준(threshold) 이상**일 때만 → 실적×시상율 또는 정액 | 기준 100만 **미달이면 0**, 충족 시 정액 **200,000** |
| **지점장수당** | min(조직 실적 × 수당율, 한도) − 환수 | 조직 1,000만 ×1% = 100,000, 한도 8만 → **80,000** |
> **오버라이드 핵심:** "내 밑의 설계사가 잘 팔면 그 일부를 팀장/지점장이 받는다." 단, 룰에 보험종류 조건(예: 생보만)이 있으면 **그 종류 실적만** 곱합니다. 한도(cap)를 넘으면 한도까지만.
> **시상·지속수당 핵심:** 기준(threshold·유지율)을 **넘어야만** 나옵니다. 못 넘으면 0원.
### 소개·이관·지원
| 수수료 | 계산식 | 작은 예시 |
|---|---|---|
| **소개수수료** | 기준금액 × 소개율 **또는** 정액 (룰이 RATE냐 FIXED냐) | 기준 100만 ×2% = **20,000** |
| **이관수수료** | 기준금액 × 이관율 | 기준 100만 ×1% = **10,000** |
| **정착지원금** | 등급별 월 정액 지급. 조기 해촉 시 **환수 = 정액 × (잔여약정개월 / 약정개월)**. net = 지급 − 환수 | 지급 50만, 환수 8만 → net **420,000** (환수는 지급액을 넘지 못함) |
| **생보운영지원수수료** | 생보 실적 × 지급률 − 환수 | 실적 200만 ×3% = 60,000 환수 0 = **60,000** |
> **정착지원금 환수:** 신입에게 "정착하라"고 미리 준 돈이라, 약정 기간을 못 채우고 나가면 **남은 기간만큼 비례로 토해냅니다.** 단, 환수액이 받은 지원금보다 클 수는 없습니다(net이 마이너스가 되지 않음).
### 회사(GA) 레벨
| 항목 | 계산식 | 작은 예시 |
|---|---|---|
| **수입수수료** | 보험료 × 보험사요율 (보험사 → GA로 들어온 돈) | 100만 ×60% = **600,000** |
| **수지차(마진)** | Σ수입 − Σ지급. 마진율 = 수지차 ÷ 수입 | 수입 600,000 지급 450,000 = **150,000** (마진율 25%) |
| **인정실적** | 환산보험료(= 보험료 × 환산율) × 인정율 | 100만 ×환산 100% ×인정 90% = **900,000** |
| **공동계약 배분** | 그 계약 수수료 × 본인 지분율 (지분 합은 100% 이하) | 450,000 ×지분 60% = **270,000** |
| **적립금 잔액** | 전월 잔액 + 이번 적립 사용 | 100,000 + 20,000 5,000 = **115,000** |
| **등급평가** | 실적 점수 → 점수 구간 룰 → 해당 등급 부여 | 점수 820 → "1등급" 구간 → 등급 상향 |
| **수수료 시뮬레이터** | 보험료·요율 입력 → 위 ①②③ + 세금·예상환수 미리 계산 | 입력만 하면 실지급까지 미리보기 |
> **수입 vs 지급, 수지차:** 보험사가 GA에 준 돈(**수입**)에서 설계사에게 나간 돈(**지급**)을 빼면 GA가 남긴 마진(**수지차**)입니다. 회사가 돈을 버는 핵심 지표예요. (자세히는 11장)
### 한 줄 정리
> **"무엇 × 율"이 기본.** 여기에 ① **조건**(시상·지속수당은 기준 넘어야), ② **한도**(오버라이드·지점장수당은 cap까지만), ③ **환수**(정착·생보지원은 토해내는 분 차감)만 더 붙는다고 보면 됩니다.
---
## 6-B. 기타수수료 — 예외 가감과 그 밖의 정산 (★ 전부)
위 "공식이 있는" 수수료 말고도, 매월 정산액에 **그때그때 더하거나 빼는 항목**들이 있습니다.
이걸 통틀어 **예외(가감) 항목**이라 부르고, "기타수수료"의 핵심입니다.
### 6-B-1. 예외 가감 (Exception) — 더하는 것(PLUS) / 빼는 것(MINUS)
공식으로 안 나오는 1회성·수동 항목입니다. **방향(direction)**이 PLUS면 지급에 더하고, MINUS면 빼냅니다.
| 코드 | 이름 | 방향 | 의미 |
|---|---|---|---|
| ADV | 선지급 | ➕ PLUS | 나중에 받을 걸 미리 줌 |
| PERF | 실적격려금 | ➕ PLUS | 실적 잘 낸 격려금 |
| AWARD | 시상금 | PLUS | 시상 인센티브 |
| SUPPORT | 운영지원금 | PLUS | 운영 보조 |
| REFUND | 환급금 | PLUS | 자동 환급(auto) |
| ETC | 기타 | PLUS | 그 외 잡다한 지급 |
| PEN | 제재금 | MINUS | 징계·벌과금 |
| PRECOL | 선차감 | MINUS | 전월 못 뗀 공제분 |
| LOAN | 대여금공제 | ➖ MINUS | 빌려준 돈 자동 회수 |
| TAX_ADJ | 세금조정 | MINUS | 세금 보정 |
- **계산:** 집계할 때 `+ 예외PLUS합 예외MINUS합` 으로 반영됩니다.
- `auto_calc_yn='Y'`(REFUND·LOAN·TAX_ADJ)는 **자동 생성**, 나머지는 **수동 입력 + 승인** 후 반영됩니다.
- `tax_included`(세금 포함 여부)에 따라 과세 대상인지 갈립니다.
- **예시:** 이번 달 수수료 450,000 + 실적격려금(PLUS) 100,000 대여금공제(MINUS) 50,000 = **500,000** (세전)
> **예외 항목이 왜 필요?** 모든 돈이 공식으로 딱 떨어지지 않습니다. "이번 달만 격려금 준다", "지난달 빠뜨린 공제 뗀다" 같은 **1회성 가감**을 처리하는 창구가 예외 항목입니다.
### 6-B-2. 시책·인센티브 (Incentive)
캠페인/목표 프로그램입니다. 프로그램 규칙대로 **기준실적(base) × 달성률** 또는 **확정 인센티브액**을 지급합니다.
- 예시: "이달 신계약 5건 이상 시 30만 원" → 달성하면 incentive_amount **300,000**
### 6-B-3. 해촉정산 (설계사가 그만둘 때 마지막 계산)
설계사가 해촉(퇴사)되면 그 시점에 한 번 **몰아서 정산**합니다.
```
최종 지급액 = 미지급분(미지급 모집 + 분급 잔액 + 미지급 시책)
− 환수 예정액 (+ 면제분 제외)
공제
```
- 미지급 분급(아직 안 준 7년치 잔액)과 환수 예정(곧 토해낼 것)을 **상계**해서 최종 한 번에 정리합니다.
- 예시: 미지급 200,000 환수예정 80,000 공제 20,000 = 최종 **100,000**
### 6-B-4. 본사정산 (회사 자체 손익)
설계사 지급과 **별개로**, GA 본사의 수입·비용을 집계합니다.
```
본사 손익(profit) = 수입(INCOME) 합 비용(EXPENSE) 합
```
- 설계사에게 나가는 돈이 아니라 **회사가 얼마 벌었나**를 보는 정산입니다. (수지차와 비슷한 회사 관점)
### 6-B-5. 보증보험 (수수료 아님 — 관리 항목)
설계사가 횡령·사고 대비로 드는 **신원보증보험**입니다. 돈을 주는 게 아니라 **보증금액(guarantee_amount)**을 관리만 합니다.
- 계산이 아니라 "이 설계사가 얼마짜리 보증보험에 가입돼 있나"를 기록하는 항목입니다.
### 한 줄 정리
> 공식 수수료(6-A)가 **본 메뉴**라면, 기타수수료는 **양념**입니다.
> ➕ 더하는 것(선지급·격려금·시상금·시책), ➖ 빼는 것(제재금·대여금·선차감), 그리고 **해촉 때 몰아서 정산**, **본사 손익**, **보증보험 관리**까지가 전부입니다.
---
## 7. 숫자로 끝까지 따라가기 (한 계약의 일생) ## 7. 숫자로 끝까지 따라가기 (한 계약의 일생)
연환산 보험료 **100만 원**짜리 계약 하나가 태어나서 깨질 때까지 따라가 봅시다. 연환산 보험료 **100만 원**짜리 계약 하나가 태어나서 깨질 때까지 따라가 봅시다.
@@ -18,6 +18,15 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
/**
* 회계 결산(accounting_close) 컨트롤러.
*
* <p>"결산"은 일정 기간(월/분기/연)의 회계 분개를 마감하고 계정과목별 잔액을 확정 저장하는 작업입니다.
* 흐름: DRAFT 생성(createDraft) → 마감 실행(close, 미전기 분개에 전표번호 부여 + 잔액 스냅샷 생성) → 필요 시 재오픈(reopen).
*
* <p>상태: DRAFT / REOPENED 에서만 마감 가능. 잔액 스냅샷(snapshots)은 계정과목별 차변·대변 합계입니다.
* 권한(menu=ACCOUNTING_CLOSE): 조회 READ, DRAFT생성 CREATE, 마감 EXECUTE, 재오픈 APPROVE.
*/
@Tag(name = "회계 결산") @Tag(name = "회계 결산")
@RestController @RestController
@RequestMapping("/api/accounting-closes") @RequestMapping("/api/accounting-closes")
@@ -6,6 +6,10 @@ import lombok.Data;
import java.util.List; import java.util.List;
/**
* 분개 마감 요청 DTO.
* entryIds: 마감할 분개 ID 목록(필수, 1건 이상). journalNo: 부여할 전표번호(필수).
*/
@Data @Data
public class CloseJournalReq { public class CloseJournalReq {
@NotEmpty @NotEmpty
@@ -13,6 +13,16 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 계약 회계 분개(contract_accounting_entry) 컨트롤러.
*
* <p>"분개"는 회계의 기본 기록 단위로, 거래 하나를 차변(빌린 곳)/대변(빌려준 곳) 두 계정으로 적는 것입니다.
* 여기서는 수수료 지급(payment) 건을 회계 분개로 자동 변환합니다.
* (차변: 8350 지급수수료 / 대변: 2530 미지급금)
*
* <p>generate: paymentIds 또는 settleMonth 기준으로 분개를 일괄 생성. close: 분개에 전표번호를 붙여 마감 처리.
* 권한(menu=ACCOUNTING_JOURNAL): 조회 READ, 분개생성 CREATE, 마감 UPDATE.
*/
@Tag(name = "계약 회계 분개") @Tag(name = "계약 회계 분개")
@RestController @RestController
@RequestMapping("/api/accounting-entries") @RequestMapping("/api/accounting-entries")
@@ -4,6 +4,10 @@ import lombok.Data;
import java.util.List; import java.util.List;
/**
* 자동 분개 생성 요청 DTO.
* paymentIds 가 있으면 해당 지급건들로, 없으면 settleMonth(정산월) 전체 지급건으로 분개를 생성합니다.
*/
@Data @Data
public class GenerateEntriesReq { public class GenerateEntriesReq {
private List<Long> paymentIds; private List<Long> paymentIds;
@@ -4,12 +4,20 @@ import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotNull; import jakarta.validation.constraints.NotNull;
import lombok.Data; import lombok.Data;
/**
* 결재 단계 진행(승인/반려) 요청 DTO.
*
* <p>결재자(approverId)가 현재 단계에 대해 action(APPROVE=승인 / REJECT=반려)을 처리할 때 전달된다.
* comment는 선택 입력이다.</p>
*/
@Data @Data
public class AdvanceReq { public class AdvanceReq {
/** 결재 처리자(user_id). */
@NotNull @NotNull
private Long approverId; private Long approverId;
/** APPROVE / REJECT */ /** APPROVE / REJECT */
@NotBlank @NotBlank
private String action; private String action;
/** 결재 코멘트(선택). */
private String comment; private String comment;
} }
@@ -13,6 +13,17 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
/**
* 전자결재 관리 API.
*
* <p>두 개념을 다룬다.
* <ul>
* <li>결재선(line): 결재 단계(step) 시퀀스의 템플릿. 각 단계는 결재 권한 역할(roleCode)로 정의된다.</li>
* <li>결재 요청(request): 특정 대상(출금/정산/이의신청/시책 등 targetType)에 대한 상신 건.
* 결재선을 따라 단계별로 진행(advance)되며, 최종 승인 시 대상 도메인에 후처리 콜백이 일어난다.</li>
* </ul>
* 메뉴 APPROVAL 권한으로 보호되며, 단계 진행만 APPROVE 권한을 요구한다.</p>
*/
@Tag(name = "결재 관리") @Tag(name = "결재 관리")
@RestController @RestController
@RequestMapping("/api/approvals") @RequestMapping("/api/approvals")
@@ -23,6 +34,7 @@ public class ApprovalController {
// ── 결재선 ───────────────────────────────────────────────────────────────── // ── 결재선 ─────────────────────────────────────────────────────────────────
/** 결재선 목록 조회(페이징). READ 권한 필요. */
@GetMapping("/lines") @GetMapping("/lines")
@RequirePermission(menu = "APPROVAL", perm = "READ") @RequirePermission(menu = "APPROVAL", perm = "READ")
public ApiResponse<PageResponse<ApprovalLineResp>> listLines( public ApiResponse<PageResponse<ApprovalLineResp>> listLines(
@@ -30,18 +42,21 @@ public class ApprovalController {
return ApiResponse.ok(service.listLines(param)); return ApiResponse.ok(service.listLines(param));
} }
/** 결재선 단건 상세 조회. READ 권한 필요. */
@GetMapping("/lines/{lineId}") @GetMapping("/lines/{lineId}")
@RequirePermission(menu = "APPROVAL", perm = "READ") @RequirePermission(menu = "APPROVAL", perm = "READ")
public ApiResponse<ApprovalLineResp> detailLine(@PathVariable Long lineId) { public ApiResponse<ApprovalLineResp> detailLine(@PathVariable Long lineId) {
return ApiResponse.ok(service.detailLine(lineId)); return ApiResponse.ok(service.detailLine(lineId));
} }
/** 특정 결재선의 단계(step) 목록 조회. READ 권한 필요. */
@GetMapping("/lines/{lineId}/steps") @GetMapping("/lines/{lineId}/steps")
@RequirePermission(menu = "APPROVAL", perm = "READ") @RequirePermission(menu = "APPROVAL", perm = "READ")
public ApiResponse<List<ApprovalLineStepResp>> stepsOfLine(@PathVariable Long lineId) { public ApiResponse<List<ApprovalLineStepResp>> stepsOfLine(@PathVariable Long lineId) {
return ApiResponse.ok(service.stepsOfLine(lineId)); return ApiResponse.ok(service.stepsOfLine(lineId));
} }
/** 결재선 신규 등록. CREATE 권한 필요. */
@PostMapping("/lines") @PostMapping("/lines")
@RequirePermission(menu = "APPROVAL", perm = "CREATE") @RequirePermission(menu = "APPROVAL", perm = "CREATE")
@DataChangeLog(menu = "APPROVAL", table = "approval_line") @DataChangeLog(menu = "APPROVAL", table = "approval_line")
@@ -49,6 +64,7 @@ public class ApprovalController {
return ApiResponse.ok(service.createLine(req)); return ApiResponse.ok(service.createLine(req));
} }
/** 결재선 수정. UPDATE 권한 필요. */
@PutMapping("/lines/{lineId}") @PutMapping("/lines/{lineId}")
@RequirePermission(menu = "APPROVAL", perm = "UPDATE") @RequirePermission(menu = "APPROVAL", perm = "UPDATE")
@DataChangeLog(menu = "APPROVAL", table = "approval_line") @DataChangeLog(menu = "APPROVAL", table = "approval_line")
@@ -58,6 +74,7 @@ public class ApprovalController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 결재선에 단계(step) 추가. 경로의 lineId를 요청에 주입한다. UPDATE 권한 필요. */
@PostMapping("/lines/{lineId}/steps") @PostMapping("/lines/{lineId}/steps")
@RequirePermission(menu = "APPROVAL", perm = "UPDATE") @RequirePermission(menu = "APPROVAL", perm = "UPDATE")
@DataChangeLog(menu = "APPROVAL", table = "approval_line_step") @DataChangeLog(menu = "APPROVAL", table = "approval_line_step")
@@ -70,6 +87,7 @@ public class ApprovalController {
// ── 결재 요청 ────────────────────────────────────────────────────────────── // ── 결재 요청 ──────────────────────────────────────────────────────────────
/** 결재 요청 전체 목록 조회(페이징). READ 권한 필요. */
@GetMapping("/requests") @GetMapping("/requests")
@RequirePermission(menu = "APPROVAL", perm = "READ") @RequirePermission(menu = "APPROVAL", perm = "READ")
public ApiResponse<PageResponse<ApprovalRequestResp>> listRequests( public ApiResponse<PageResponse<ApprovalRequestResp>> listRequests(
@@ -77,6 +95,7 @@ public class ApprovalController {
return ApiResponse.ok(service.listRequests(param)); return ApiResponse.ok(service.listRequests(param));
} }
/** 내가 상신한 결재 요청 목록. 현재 로그인 사용자로 필터된다. READ 권한 필요. */
@GetMapping("/requests/mine") @GetMapping("/requests/mine")
@RequirePermission(menu = "APPROVAL", perm = "READ") @RequirePermission(menu = "APPROVAL", perm = "READ")
public ApiResponse<PageResponse<ApprovalRequestResp>> myRequests( public ApiResponse<PageResponse<ApprovalRequestResp>> myRequests(
@@ -84,6 +103,7 @@ public class ApprovalController {
return ApiResponse.ok(service.myRequests(param)); return ApiResponse.ok(service.myRequests(param));
} }
/** 진행 중(PENDING) 결재 요청 목록. READ 권한 필요. */
@GetMapping("/requests/pending") @GetMapping("/requests/pending")
@RequirePermission(menu = "APPROVAL", perm = "READ") @RequirePermission(menu = "APPROVAL", perm = "READ")
public ApiResponse<PageResponse<ApprovalRequestResp>> pendingRequests( public ApiResponse<PageResponse<ApprovalRequestResp>> pendingRequests(
@@ -91,18 +111,21 @@ public class ApprovalController {
return ApiResponse.ok(service.pendingRequests(param)); return ApiResponse.ok(service.pendingRequests(param));
} }
/** 결재 요청 단건 상세 조회. READ 권한 필요. */
@GetMapping("/requests/{requestId}") @GetMapping("/requests/{requestId}")
@RequirePermission(menu = "APPROVAL", perm = "READ") @RequirePermission(menu = "APPROVAL", perm = "READ")
public ApiResponse<ApprovalRequestResp> detailRequest(@PathVariable Long requestId) { public ApiResponse<ApprovalRequestResp> detailRequest(@PathVariable Long requestId) {
return ApiResponse.ok(service.detailRequest(requestId)); return ApiResponse.ok(service.detailRequest(requestId));
} }
/** 결재 요청의 단계별 처리 이력 조회. READ 권한 필요. */
@GetMapping("/requests/{requestId}/history") @GetMapping("/requests/{requestId}/history")
@RequirePermission(menu = "APPROVAL", perm = "READ") @RequirePermission(menu = "APPROVAL", perm = "READ")
public ApiResponse<List<ApprovalHistoryResp>> historyOfRequest(@PathVariable Long requestId) { public ApiResponse<List<ApprovalHistoryResp>> historyOfRequest(@PathVariable Long requestId) {
return ApiResponse.ok(service.historyOfRequest(requestId)); return ApiResponse.ok(service.historyOfRequest(requestId));
} }
/** 결재 상신(요청 생성). PENDING 상태로 시작하며 1단계 결재자에게 알림이 발송된다. CREATE 권한 필요. */
@PostMapping("/requests") @PostMapping("/requests")
@RequirePermission(menu = "APPROVAL", perm = "CREATE") @RequirePermission(menu = "APPROVAL", perm = "CREATE")
@DataChangeLog(menu = "APPROVAL", table = "approval_request") @DataChangeLog(menu = "APPROVAL", table = "approval_request")
@@ -110,6 +133,7 @@ public class ApprovalController {
return ApiResponse.ok(service.createRequest(req)); return ApiResponse.ok(service.createRequest(req));
} }
/** 결재 단계 진행(승인/반려). 마지막 단계 승인 시 대상 도메인에 후처리 콜백이 일어난다. APPROVE 권한 필요. */
@PostMapping("/requests/{requestId}/advance") @PostMapping("/requests/{requestId}/advance")
@RequirePermission(menu = "APPROVAL", perm = "APPROVE") @RequirePermission(menu = "APPROVAL", perm = "APPROVE")
@DataChangeLog(menu = "APPROVAL", table = "approval_request") @DataChangeLog(menu = "APPROVAL", table = "approval_request")
@@ -119,6 +143,7 @@ public class ApprovalController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 결재 요청 취소. 진행 중(PENDING)인 건만 취소 가능. UPDATE 권한 필요. */
@PostMapping("/requests/{requestId}/cancel") @PostMapping("/requests/{requestId}/cancel")
@RequirePermission(menu = "APPROVAL", perm = "UPDATE") @RequirePermission(menu = "APPROVAL", perm = "UPDATE")
@DataChangeLog(menu = "APPROVAL", table = "approval_request") @DataChangeLog(menu = "APPROVAL", table = "approval_request")
@@ -23,6 +23,15 @@ import java.nio.file.Files;
import java.nio.file.Path; import java.nio.file.Path;
import java.util.List; import java.util.List;
/**
* 첨부파일 관리 API.
*
* <p>각종 도메인(refType + refId 조합)에 파일을 첨부·다운로드·삭제한다.
* refType은 "어떤 종류의 대상인지"(예: 계약/민원 등), refId는 그 대상의 PK다.
* 파일은 서버 디스크에 저장되고, 메타 정보(파일명/경로/크기/MIME)는 DB로 관리된다.</p>
*
* <p>메뉴 ATTACHMENT 권한으로 보호된다.</p>
*/
@Tag(name = "첨부파일") @Tag(name = "첨부파일")
@RestController @RestController
@RequestMapping("/api/attachments") @RequestMapping("/api/attachments")
@@ -31,12 +40,14 @@ public class AttachmentController {
private final AttachmentService service; private final AttachmentService service;
/** 첨부파일 메타 목록 조회(페이징). READ 권한 필요. */
@GetMapping @GetMapping
@RequirePermission(menu = "ATTACHMENT", perm = "READ") @RequirePermission(menu = "ATTACHMENT", perm = "READ")
public ApiResponse<PageResponse<AttachmentResp>> list(@ModelAttribute AttachmentSearchParam param) { public ApiResponse<PageResponse<AttachmentResp>> list(@ModelAttribute AttachmentSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 특정 대상(refType+refId)에 달린 첨부파일 목록 조회. READ 권한 필요. */
@GetMapping("/by-ref") @GetMapping("/by-ref")
@RequirePermission(menu = "ATTACHMENT", perm = "READ") @RequirePermission(menu = "ATTACHMENT", perm = "READ")
public ApiResponse<List<AttachmentResp>> listByRef(@RequestParam String refType, public ApiResponse<List<AttachmentResp>> listByRef(@RequestParam String refType,
@@ -44,12 +55,14 @@ public class AttachmentController {
return ApiResponse.ok(service.listByRef(refType, refId)); return ApiResponse.ok(service.listByRef(refType, refId));
} }
/** 첨부파일 메타 단건 조회. READ 권한 필요. */
@GetMapping("/{attachmentId}/meta") @GetMapping("/{attachmentId}/meta")
@RequirePermission(menu = "ATTACHMENT", perm = "READ") @RequirePermission(menu = "ATTACHMENT", perm = "READ")
public ApiResponse<AttachmentResp> detail(@PathVariable Long attachmentId) { public ApiResponse<AttachmentResp> detail(@PathVariable Long attachmentId) {
return ApiResponse.ok(service.detail(attachmentId)); return ApiResponse.ok(service.detail(attachmentId));
} }
/** 파일 업로드(multipart). 대상(refType+refId)에 연결해 저장한다. CREATE 권한 필요. */
@PostMapping(consumes = "multipart/form-data") @PostMapping(consumes = "multipart/form-data")
@RequirePermission(menu = "ATTACHMENT", perm = "CREATE") @RequirePermission(menu = "ATTACHMENT", perm = "CREATE")
@DataChangeLog(menu = "ATTACHMENT", table = "attachment") @DataChangeLog(menu = "ATTACHMENT", table = "attachment")
@@ -59,6 +72,7 @@ public class AttachmentController {
return ApiResponse.ok(service.upload(file, refType, refId)); return ApiResponse.ok(service.upload(file, refType, refId));
} }
/** 파일 다운로드. 메타의 MIME/파일명으로 응답 헤더를 구성하고 파일 스트림을 내려준다. READ 권한 필요. */
@GetMapping("/{attachmentId}/download") @GetMapping("/{attachmentId}/download")
@RequirePermission(menu = "ATTACHMENT", perm = "READ") @RequirePermission(menu = "ATTACHMENT", perm = "READ")
public void download(@PathVariable Long attachmentId, HttpServletResponse response) throws IOException { public void download(@PathVariable Long attachmentId, HttpServletResponse response) throws IOException {
@@ -75,6 +89,7 @@ public class AttachmentController {
} }
} }
/** 첨부파일 삭제(메타 + 실제 파일). DELETE 권한 필요. */
@DeleteMapping("/{attachmentId}") @DeleteMapping("/{attachmentId}")
@RequirePermission(menu = "ATTACHMENT", perm = "DELETE") @RequirePermission(menu = "ATTACHMENT", perm = "DELETE")
@DataChangeLog(menu = "ATTACHMENT", table = "attachment") @DataChangeLog(menu = "ATTACHMENT", table = "attachment")
@@ -50,12 +50,14 @@ public class BatchTriggerController {
return ApiResponse.ok(log.getJobId()); return ApiResponse.ok(log.getJobId());
} }
/** 특정 배치 잡의 최신 실행 상태 조회(기본 월정산). READ 권한 필요. */
@GetMapping("/status") @GetMapping("/status")
@RequirePermission(menu = "BATCH_RUN", perm = "READ") @RequirePermission(menu = "BATCH_RUN", perm = "READ")
public ApiResponse<BatchJobLogVO> latest(@RequestParam(defaultValue = "MONTHLY_SETTLEMENT") String jobName) { public ApiResponse<BatchJobLogVO> latest(@RequestParam(defaultValue = "MONTHLY_SETTLEMENT") String jobName) {
return ApiResponse.ok(jobLogMapper.selectLatest(jobName)); return ApiResponse.ok(jobLogMapper.selectLatest(jobName));
} }
/** 배치 실행 이력 목록 조회(잡명/정산월 필터). READ 권한 필요. */
@GetMapping("/jobs") @GetMapping("/jobs")
@RequirePermission(menu = "BATCH_RUN", perm = "READ") @RequirePermission(menu = "BATCH_RUN", perm = "READ")
public ApiResponse<List<BatchJobLogVO>> list(@RequestParam(required = false) String jobName, public ApiResponse<List<BatchJobLogVO>> list(@RequestParam(required = false) String jobName,
@@ -63,6 +65,7 @@ public class BatchTriggerController {
return ApiResponse.ok(jobLogMapper.selectList(jobName, settleMonth)); return ApiResponse.ok(jobLogMapper.selectList(jobName, settleMonth));
} }
/** 배치 실행 이력 단건 상세 조회. READ 권한 필요. */
@GetMapping("/jobs/{jobId}") @GetMapping("/jobs/{jobId}")
@RequirePermission(menu = "BATCH_RUN", perm = "READ") @RequirePermission(menu = "BATCH_RUN", perm = "READ")
public ApiResponse<BatchJobLogVO> detail(@PathVariable Long jobId) { public ApiResponse<BatchJobLogVO> detail(@PathVariable Long jobId) {
@@ -7,18 +7,27 @@ import lombok.Data;
import java.math.BigDecimal; import java.math.BigDecimal;
import java.time.LocalDate; import java.time.LocalDate;
/**
* 차등환수 금액 계산(시뮬레이션) 요청 DTO.
* 차등환수란 고객이 계약을 조기 해지하면 이미 지급한 수수료의 일부를 경과기간에 따라 차등 회수하는 것이다.
* (계약일~해지일 경과개월수가 짧을수록 환수율이 높다)
*/
@Data @Data
public class ChargebackCalculateReq { public class ChargebackCalculateReq {
/** 계약 체결일. 경과개월수 계산의 시작점. */
@NotNull @NotNull
private LocalDate contractDate; private LocalDate contractDate;
/** 해지일. 계약일과의 차이로 경과개월수를 구한다. */
@NotNull @NotNull
private LocalDate terminationDate; private LocalDate terminationDate;
/** 당초 지급했던 수수료 원금(양수). 여기에 환수율을 곱해 환수액을 산출한다. */
@NotNull @NotNull
@Positive @Positive
private BigDecimal originalCommission; private BigDecimal originalCommission;
/** 상품 분류. 분류별로 적용 환수율 구간(chargeback_grade)이 다르다. */
private String productCategory; private String productCategory;
} }
@@ -15,6 +15,12 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 차등환수 등급(chargeback_grade) 관리 REST 컨트롤러.
* 환수 등급표는 "경과개월 구간별 환수율(%)"을 정의하는 기준표이며, 조기해지 시 환수액 계산에 쓰인다.
* - gradeService : 환수 등급표 CRUD + 비활성화
* - calculator : 실제 계약 정보로 환수액을 계산(시뮬레이션)
*/
@Tag(name = "환수 등급 관리") @Tag(name = "환수 등급 관리")
@RestController @RestController
@RequestMapping("/api/chargeback-grades") @RequestMapping("/api/chargeback-grades")
@@ -24,18 +30,21 @@ public class ChargebackGradeController {
private final ChargebackGradeService gradeService; private final ChargebackGradeService gradeService;
private final ChargebackCalculator calculator; private final ChargebackCalculator calculator;
/** 환수 등급표 목록 페이징 조회. */
@GetMapping @GetMapping
@RequirePermission(menu = "CHARGEBACK_GRADE", perm = "READ") @RequirePermission(menu = "CHARGEBACK_GRADE", perm = "READ")
public ApiResponse<PageResponse<ChargebackGradeResp>> list(ChargebackGradeSearchParam param) { public ApiResponse<PageResponse<ChargebackGradeResp>> list(ChargebackGradeSearchParam param) {
return ApiResponse.ok(gradeService.list(param)); return ApiResponse.ok(gradeService.list(param));
} }
/** 환수 등급 단건 상세 조회. */
@GetMapping("/{gradeId}") @GetMapping("/{gradeId}")
@RequirePermission(menu = "CHARGEBACK_GRADE", perm = "READ") @RequirePermission(menu = "CHARGEBACK_GRADE", perm = "READ")
public ApiResponse<ChargebackGradeResp> detail(@PathVariable Long gradeId) { public ApiResponse<ChargebackGradeResp> detail(@PathVariable Long gradeId) {
return ApiResponse.ok(gradeService.detail(gradeId)); return ApiResponse.ok(gradeService.detail(gradeId));
} }
/** 환수 등급 신규 등록. */
@PostMapping @PostMapping
@RequirePermission(menu = "CHARGEBACK_GRADE", perm = "CREATE") @RequirePermission(menu = "CHARGEBACK_GRADE", perm = "CREATE")
@DataChangeLog(menu = "CHARGEBACK_GRADE", table = "chargeback_grade") @DataChangeLog(menu = "CHARGEBACK_GRADE", table = "chargeback_grade")
@@ -44,6 +53,7 @@ public class ChargebackGradeController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 환수 등급 수정. */
@PutMapping("/{gradeId}") @PutMapping("/{gradeId}")
@RequirePermission(menu = "CHARGEBACK_GRADE", perm = "UPDATE") @RequirePermission(menu = "CHARGEBACK_GRADE", perm = "UPDATE")
@DataChangeLog(menu = "CHARGEBACK_GRADE", table = "chargeback_grade") @DataChangeLog(menu = "CHARGEBACK_GRADE", table = "chargeback_grade")
@@ -53,6 +63,7 @@ public class ChargebackGradeController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 환수 등급 비활성화(사용 중지). 비활성 등급은 환수액 계산에서 제외된다. */
@PutMapping("/{gradeId}/deactivate") @PutMapping("/{gradeId}/deactivate")
@RequirePermission(menu = "CHARGEBACK_GRADE", perm = "UPDATE") @RequirePermission(menu = "CHARGEBACK_GRADE", perm = "UPDATE")
@DataChangeLog(menu = "CHARGEBACK_GRADE", table = "chargeback_grade") @DataChangeLog(menu = "CHARGEBACK_GRADE", table = "chargeback_grade")
@@ -61,6 +72,7 @@ public class ChargebackGradeController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 계약일·해지일·원수수료를 입력받아 환수액을 계산(시뮬레이션)한다. */
@PostMapping("/calculate") @PostMapping("/calculate")
@RequirePermission(menu = "CHARGEBACK_GRADE", perm = "READ") @RequirePermission(menu = "CHARGEBACK_GRADE", perm = "READ")
public ApiResponse<ChargebackResult> calculate(@Valid @RequestBody ChargebackCalculateReq req) { public ApiResponse<ChargebackResult> calculate(@Valid @RequestBody ChargebackCalculateReq req) {
@@ -0,0 +1,65 @@
package com.ga.api.controller.commission;
import com.ga.api.service.commission.AdvancePaymentService;
import com.ga.common.annotation.DataChangeLog;
import com.ga.common.annotation.RequirePermission;
import com.ga.common.model.ApiResponse;
import com.ga.common.model.PageResponse;
import com.ga.core.vo.commission.AdvancePaymentResp;
import com.ga.core.vo.commission.AdvancePaymentSaveReq;
import com.ga.core.vo.commission.AdvancePaymentSearchParam;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;
/**
* 선지급정산 API.
*
* 선지급(advance payment): 아직 확정되지 않은 미래 수수료를 설계사에게 미리 지급(가불)하는 것.
* 이후 실제 수수료가 발생하면 그 금액에서 차감(상계)하여 회수한다.
* - principalAmount(선지급 원금) / recoveredAmount(회수 누계) / balance(미상환 잔액)
* - status: OUTSTANDING(미상환) → PARTIAL(일부회수) → CLEARED(완전회수) 또는 WAIVED(면제)
*
* 권한: @RequirePermission(menu="ADVANCE_PAYMENT"), perm=READ/CREATE/UPDATE. 변경은 @DataChangeLog 로 감사 기록.
*/
@Tag(name = "선지급정산")
@RestController
@RequestMapping("/api/advance-payments")
@RequiredArgsConstructor
public class AdvancePaymentController {
private final AdvancePaymentService service;
/** 선지급 목록 조회(검색 + 페이징). 권한: ADVANCE_PAYMENT READ. */
@GetMapping
@RequirePermission(menu = "ADVANCE_PAYMENT", perm = "READ")
public ApiResponse<PageResponse<AdvancePaymentResp>> list(
@ModelAttribute AdvancePaymentSearchParam param) {
return ApiResponse.ok(service.list(param));
}
/** 선지급 단건 상세 조회. 권한: ADVANCE_PAYMENT READ. */
@GetMapping("/{advanceId}")
@RequirePermission(menu = "ADVANCE_PAYMENT", perm = "READ")
public ApiResponse<AdvancePaymentResp> detail(@PathVariable Long advanceId) {
return ApiResponse.ok(service.detail(advanceId));
}
/** 선지급 신규 등록. 등록 시 잔액=원금, 상태=OUTSTANDING. 응답: 생성된 advanceId. 권한: ADVANCE_PAYMENT CREATE. */
@PostMapping
@RequirePermission(menu = "ADVANCE_PAYMENT", perm = "CREATE")
@DataChangeLog(menu = "ADVANCE_PAYMENT", table = "advance_payment")
public ApiResponse<Long> create(@Valid @RequestBody AdvancePaymentSaveReq req) {
return ApiResponse.ok(service.create(req));
}
/** 선지급 면제 처리. 남은 잔액 회수를 포기(상태=WAIVED, 잔액=0). 권한: ADVANCE_PAYMENT UPDATE. */
@PostMapping("/{advanceId}/waive")
@RequirePermission(menu = "ADVANCE_PAYMENT", perm = "UPDATE")
@DataChangeLog(menu = "ADVANCE_PAYMENT", table = "advance_payment")
public ApiResponse<Void> waive(@PathVariable Long advanceId) {
service.waive(advanceId);
return ApiResponse.ok();
}
}
@@ -0,0 +1,25 @@
package com.ga.api.controller.commission;
import jakarta.validation.constraints.DecimalMin;
import jakarta.validation.constraints.NotNull;
import lombok.Data;
import java.math.BigDecimal;
/**
* 시상(award) 원장 환수 처리 요청 바디 (PUT /api/awards/ledgers/{id}/clawback).
*
* 환수(clawback): 이미 지급한 시상금을 일정 사유로 되돌려 받는 것.
* clawbackAmount(환수 금액, 0 이상 필수) + reason(환수 사유).
*/
@Data
public class AwardClawbackReq {
/** 환수 금액. 0 이상이어야 하며(@DecimalMin("0")) 필수값(@NotNull). */
@NotNull
@DecimalMin("0")
private BigDecimal clawbackAmount;
/** 환수 사유(선택). */
private String reason;
}
@@ -11,6 +11,15 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 시상(award) API.
*
* 시상: 일정 실적 조건을 달성한 설계사에게 지급하는 포상금/인센티브.
* - Rule(시상 규칙): 어떤 조건일 때 얼마를 지급하는지 정의(생성/수정/삭제 가능).
* - Ledger(시상 원장): 규칙에 따라 실제 산출/지급된 시상금 내역. clawback(환수)로 회수 가능.
*
* 권한: @RequirePermission(menu="AWARD"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 로 감사 기록.
*/
@Tag(name = "시상") @Tag(name = "시상")
@RestController @RestController
@RequestMapping("/api/awards") @RequestMapping("/api/awards")
@@ -19,8 +28,9 @@ public class AwardController {
private final AwardService service; private final AwardService service;
// ── Rule ────────────────────────────────────────────────────────────────── // ── Rule (시상 규칙) ────────────────────────────────────────────────────
/** 시상 규칙 목록 조회. 권한: AWARD READ. */
@GetMapping("/rules") @GetMapping("/rules")
@RequirePermission(menu = "AWARD", perm = "READ") @RequirePermission(menu = "AWARD", perm = "READ")
public ApiResponse<PageResponse<AwardRuleResp>> listRules( public ApiResponse<PageResponse<AwardRuleResp>> listRules(
@@ -28,12 +38,14 @@ public class AwardController {
return ApiResponse.ok(service.listRules(param)); return ApiResponse.ok(service.listRules(param));
} }
/** 시상 규칙 단건 상세. 권한: AWARD READ. */
@GetMapping("/rules/{ruleId}") @GetMapping("/rules/{ruleId}")
@RequirePermission(menu = "AWARD", perm = "READ") @RequirePermission(menu = "AWARD", perm = "READ")
public ApiResponse<AwardRuleResp> detailRule(@PathVariable Long ruleId) { public ApiResponse<AwardRuleResp> detailRule(@PathVariable Long ruleId) {
return ApiResponse.ok(service.detailRule(ruleId)); return ApiResponse.ok(service.detailRule(ruleId));
} }
/** 시상 규칙 신규 등록. 응답: 생성된 ruleId. 권한: AWARD CREATE. */
@PostMapping("/rules") @PostMapping("/rules")
@RequirePermission(menu = "AWARD", perm = "CREATE") @RequirePermission(menu = "AWARD", perm = "CREATE")
@DataChangeLog(menu = "AWARD", table = "award_rule") @DataChangeLog(menu = "AWARD", table = "award_rule")
@@ -41,6 +53,7 @@ public class AwardController {
return ApiResponse.ok(service.createRule(req)); return ApiResponse.ok(service.createRule(req));
} }
/** 시상 규칙 수정. 권한: AWARD UPDATE. */
@PutMapping("/rules/{ruleId}") @PutMapping("/rules/{ruleId}")
@RequirePermission(menu = "AWARD", perm = "UPDATE") @RequirePermission(menu = "AWARD", perm = "UPDATE")
@DataChangeLog(menu = "AWARD", table = "award_rule") @DataChangeLog(menu = "AWARD", table = "award_rule")
@@ -50,6 +63,7 @@ public class AwardController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 시상 규칙 삭제. 권한: AWARD DELETE. */
@DeleteMapping("/rules/{ruleId}") @DeleteMapping("/rules/{ruleId}")
@RequirePermission(menu = "AWARD", perm = "DELETE") @RequirePermission(menu = "AWARD", perm = "DELETE")
@DataChangeLog(menu = "AWARD", table = "award_rule") @DataChangeLog(menu = "AWARD", table = "award_rule")
@@ -58,8 +72,9 @@ public class AwardController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
// ── Ledger ──────────────────────────────────────────────────────────────── // ── Ledger (시상 원장) ──────────────────────────────────────────────────
/** 시상 원장 목록 조회. 권한: AWARD READ. */
@GetMapping("/ledgers") @GetMapping("/ledgers")
@RequirePermission(menu = "AWARD", perm = "READ") @RequirePermission(menu = "AWARD", perm = "READ")
public ApiResponse<PageResponse<AwardLedgerResp>> listLedgers( public ApiResponse<PageResponse<AwardLedgerResp>> listLedgers(
@@ -67,16 +82,28 @@ public class AwardController {
return ApiResponse.ok(service.listLedgers(param)); return ApiResponse.ok(service.listLedgers(param));
} }
/** 시상 원장 단건 상세. 권한: AWARD READ. */
@GetMapping("/ledgers/{ledgerId}") @GetMapping("/ledgers/{ledgerId}")
@RequirePermission(menu = "AWARD", perm = "READ") @RequirePermission(menu = "AWARD", perm = "READ")
public ApiResponse<AwardLedgerResp> detailLedger(@PathVariable Long ledgerId) { public ApiResponse<AwardLedgerResp> detailLedger(@PathVariable Long ledgerId) {
return ApiResponse.ok(service.detailLedger(ledgerId)); return ApiResponse.ok(service.detailLedger(ledgerId));
} }
/** 시상 원장 신규 등록(시상금 산출/지급 기록). 응답: 생성된 ledgerId. 권한: AWARD CREATE. */
@PostMapping("/ledgers") @PostMapping("/ledgers")
@RequirePermission(menu = "AWARD", perm = "CREATE") @RequirePermission(menu = "AWARD", perm = "CREATE")
@DataChangeLog(menu = "AWARD", table = "award_ledger") @DataChangeLog(menu = "AWARD", table = "award_ledger")
public ApiResponse<Long> createLedger(@Valid @RequestBody AwardLedgerSaveReq req) { public ApiResponse<Long> createLedger(@Valid @RequestBody AwardLedgerSaveReq req) {
return ApiResponse.ok(service.createLedger(req)); return ApiResponse.ok(service.createLedger(req));
} }
/** 시상금 환수(clawback) 적용. 이미 지급한 시상금을 일부/전부 회수한다. 권한: AWARD UPDATE. */
@PutMapping("/ledgers/{ledgerId}/clawback")
@RequirePermission(menu = "AWARD", perm = "UPDATE")
@DataChangeLog(menu = "AWARD", table = "award_ledger")
public ApiResponse<Void> applyClawback(@PathVariable Long ledgerId,
@Valid @RequestBody AwardClawbackReq req) {
service.applyClawback(ledgerId, req);
return ApiResponse.ok();
}
} }
@@ -11,6 +11,15 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 지점장수당 API.
*
* 지점장수당(branch manager allowance): 지점에 소속된 설계사들의 실적 합계에 따라
* 지점장에게 추가로 지급하는 수당. 상한(cap)이 적용될 수 있다.
* - Rule(수당 규칙): 지점 실적 대비 지급률/상한 정의. - Ledger(수당 원장): 실제 산출/지급 내역.
*
* 권한: @RequirePermission(menu="BRANCH_MGR_ALLOWANCE"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "지점장수당") @Tag(name = "지점장수당")
@RestController @RestController
@RequestMapping("/api/branch-allowances") @RequestMapping("/api/branch-allowances")
@@ -19,8 +28,9 @@ public class BranchAllowanceController {
private final BranchAllowanceService service; private final BranchAllowanceService service;
// ── Rule ────────────────────────────────────────────────────────────────── // ── Rule (수당 규칙) ────────────────────────────────────────────────────
/** 지점장수당 규칙 목록 조회. 권한: BRANCH_MGR_ALLOWANCE READ. */
@GetMapping("/rules") @GetMapping("/rules")
@RequirePermission(menu = "BRANCH_MGR_ALLOWANCE", perm = "READ") @RequirePermission(menu = "BRANCH_MGR_ALLOWANCE", perm = "READ")
public ApiResponse<PageResponse<BranchMgrAllowanceRuleResp>> listRules( public ApiResponse<PageResponse<BranchMgrAllowanceRuleResp>> listRules(
@@ -34,6 +44,7 @@ public class BranchAllowanceController {
return ApiResponse.ok(service.detailRule(ruleId)); return ApiResponse.ok(service.detailRule(ruleId));
} }
/** 지점장수당 규칙 신규 등록. 응답: ruleId. 권한: BRANCH_MGR_ALLOWANCE CREATE. */
@PostMapping("/rules") @PostMapping("/rules")
@RequirePermission(menu = "BRANCH_MGR_ALLOWANCE", perm = "CREATE") @RequirePermission(menu = "BRANCH_MGR_ALLOWANCE", perm = "CREATE")
@DataChangeLog(menu = "BRANCH_MGR_ALLOWANCE", table = "branch_mgr_allowance_rule") @DataChangeLog(menu = "BRANCH_MGR_ALLOWANCE", table = "branch_mgr_allowance_rule")
@@ -41,6 +52,7 @@ public class BranchAllowanceController {
return ApiResponse.ok(service.createRule(req)); return ApiResponse.ok(service.createRule(req));
} }
/** 지점장수당 규칙 수정. 권한: BRANCH_MGR_ALLOWANCE UPDATE. */
@PutMapping("/rules/{ruleId}") @PutMapping("/rules/{ruleId}")
@RequirePermission(menu = "BRANCH_MGR_ALLOWANCE", perm = "UPDATE") @RequirePermission(menu = "BRANCH_MGR_ALLOWANCE", perm = "UPDATE")
@DataChangeLog(menu = "BRANCH_MGR_ALLOWANCE", table = "branch_mgr_allowance_rule") @DataChangeLog(menu = "BRANCH_MGR_ALLOWANCE", table = "branch_mgr_allowance_rule")
@@ -50,6 +62,7 @@ public class BranchAllowanceController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 지점장수당 규칙 삭제. 권한: BRANCH_MGR_ALLOWANCE DELETE. */
@DeleteMapping("/rules/{ruleId}") @DeleteMapping("/rules/{ruleId}")
@RequirePermission(menu = "BRANCH_MGR_ALLOWANCE", perm = "DELETE") @RequirePermission(menu = "BRANCH_MGR_ALLOWANCE", perm = "DELETE")
@DataChangeLog(menu = "BRANCH_MGR_ALLOWANCE", table = "branch_mgr_allowance_rule") @DataChangeLog(menu = "BRANCH_MGR_ALLOWANCE", table = "branch_mgr_allowance_rule")
@@ -58,8 +71,9 @@ public class BranchAllowanceController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
// ── Ledger ──────────────────────────────────────────────────────────────── // ── Ledger (수당 원장) ──────────────────────────────────────────────────
/** 지점장수당 원장 목록 조회. 권한: BRANCH_MGR_ALLOWANCE READ. */
@GetMapping("/ledgers") @GetMapping("/ledgers")
@RequirePermission(menu = "BRANCH_MGR_ALLOWANCE", perm = "READ") @RequirePermission(menu = "BRANCH_MGR_ALLOWANCE", perm = "READ")
public ApiResponse<PageResponse<BranchMgrAllowanceLedgerResp>> listLedgers( public ApiResponse<PageResponse<BranchMgrAllowanceLedgerResp>> listLedgers(
@@ -67,12 +81,14 @@ public class BranchAllowanceController {
return ApiResponse.ok(service.listLedgers(param)); return ApiResponse.ok(service.listLedgers(param));
} }
/** 지점장수당 원장 단건 상세. 권한: BRANCH_MGR_ALLOWANCE READ. */
@GetMapping("/ledgers/{ledgerId}") @GetMapping("/ledgers/{ledgerId}")
@RequirePermission(menu = "BRANCH_MGR_ALLOWANCE", perm = "READ") @RequirePermission(menu = "BRANCH_MGR_ALLOWANCE", perm = "READ")
public ApiResponse<BranchMgrAllowanceLedgerResp> detailLedger(@PathVariable Long ledgerId) { public ApiResponse<BranchMgrAllowanceLedgerResp> detailLedger(@PathVariable Long ledgerId) {
return ApiResponse.ok(service.detailLedger(ledgerId)); return ApiResponse.ok(service.detailLedger(ledgerId));
} }
/** 지점장수당 원장 신규 등록(수당 산출/지급 기록). 응답: ledgerId. 권한: BRANCH_MGR_ALLOWANCE CREATE. */
@PostMapping("/ledgers") @PostMapping("/ledgers")
@RequirePermission(menu = "BRANCH_MGR_ALLOWANCE", perm = "CREATE") @RequirePermission(menu = "BRANCH_MGR_ALLOWANCE", perm = "CREATE")
@DataChangeLog(menu = "BRANCH_MGR_ALLOWANCE", table = "branch_mgr_allowance_ledger") @DataChangeLog(menu = "BRANCH_MGR_ALLOWANCE", table = "branch_mgr_allowance_ledger")
@@ -0,0 +1,73 @@
package com.ga.api.controller.commission;
import com.ga.api.service.commission.CarrierReconciliationInService;
import com.ga.common.annotation.DataChangeLog;
import com.ga.common.annotation.RequirePermission;
import com.ga.common.model.ApiResponse;
import com.ga.common.model.PageResponse;
import com.ga.core.vo.commission.CarrierReconciliationInResp;
import com.ga.core.vo.commission.CarrierReconciliationInSaveReq;
import com.ga.core.vo.commission.CarrierReconciliationInSearchParam;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;
/**
* 정산대사(입수) API.
*
* 정산대사(reconciliation): 보험사로부터 받은 정산 명세(입수 자료)와 우리 시스템이 계산한 금액을
* 서로 맞춰 보아(대사) 차이를 확인/확정하는 작업.
* - reconcile: 대사 실행(차이 비교) - approve: 대사 결과 승인(확정)
*
* 권한: @RequirePermission(menu="CARRIER_RECON_IN"), perm=READ/CREATE/UPDATE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "정산대사입수")
@RestController
@RequestMapping("/api/carrier-recon-in")
@RequiredArgsConstructor
public class CarrierReconciliationInController {
private final CarrierReconciliationInService service;
/** 대사 입수 자료 목록 조회. 권한: CARRIER_RECON_IN READ. */
@GetMapping
@RequirePermission(menu = "CARRIER_RECON_IN", perm = "READ")
public ApiResponse<PageResponse<CarrierReconciliationInResp>> list(
@ModelAttribute CarrierReconciliationInSearchParam param) {
return ApiResponse.ok(service.list(param));
}
/** 대사 입수 단건 상세. 권한: CARRIER_RECON_IN READ. */
@GetMapping("/{reconId}")
@RequirePermission(menu = "CARRIER_RECON_IN", perm = "READ")
public ApiResponse<CarrierReconciliationInResp> detail(@PathVariable Long reconId) {
return ApiResponse.ok(service.detail(reconId));
}
/** 대사 입수 자료 신규 등록. 응답: reconId. 권한: CARRIER_RECON_IN CREATE. */
@PostMapping
@RequirePermission(menu = "CARRIER_RECON_IN", perm = "CREATE")
@DataChangeLog(menu = "CARRIER_RECON_IN", table = "carrier_reconciliation_in")
public ApiResponse<Long> create(@Valid @RequestBody CarrierReconciliationInSaveReq req) {
return ApiResponse.ok(service.create(req));
}
/** 대사 실행. 보험사 명세와 시스템 계산액을 비교해 차이를 계산한다. 권한: CARRIER_RECON_IN UPDATE. */
@PostMapping("/{reconId}/reconcile")
@RequirePermission(menu = "CARRIER_RECON_IN", perm = "UPDATE")
@DataChangeLog(menu = "CARRIER_RECON_IN", table = "carrier_reconciliation_in")
public ApiResponse<Void> reconcile(@PathVariable Long reconId) {
service.reconcile(reconId);
return ApiResponse.ok();
}
/** 대사 결과 승인(확정). 권한: CARRIER_RECON_IN UPDATE. */
@PostMapping("/{reconId}/approve")
@RequirePermission(menu = "CARRIER_RECON_IN", perm = "UPDATE")
@DataChangeLog(menu = "CARRIER_RECON_IN", table = "carrier_reconciliation_in")
public ApiResponse<Void> approve(@PathVariable Long reconId) {
service.approve(reconId);
return ApiResponse.ok();
}
}
@@ -0,0 +1,73 @@
package com.ga.api.controller.commission;
import com.ga.api.service.commission.ChargebackWaiverService;
import com.ga.common.annotation.DataChangeLog;
import com.ga.common.annotation.RequirePermission;
import com.ga.common.model.ApiResponse;
import com.ga.common.model.PageResponse;
import com.ga.core.vo.commission.ChargebackWaiverRequestResp;
import com.ga.core.vo.commission.ChargebackWaiverRequestSaveReq;
import com.ga.core.vo.commission.ChargebackWaiverRequestSearchParam;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;
/**
* 환수감면신청 API.
*
* 환수(chargeback): 계약 해지/실효 등으로 이미 지급한 수수료를 설계사로부터 다시 회수하는 것.
* 환수감면(waiver): 특별한 사유가 인정되면 그 환수 금액을 줄이거나 면제해 달라고 신청하는 것.
* - approve: 감면 신청 승인 - reject: 감면 신청 반려
*
* 권한: @RequirePermission(menu="CHARGEBACK_WAIVER"), perm=READ/CREATE/UPDATE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "환수감면신청")
@RestController
@RequestMapping("/api/chargeback-waivers")
@RequiredArgsConstructor
public class ChargebackWaiverController {
private final ChargebackWaiverService service;
/** 환수감면 신청 목록 조회. 권한: CHARGEBACK_WAIVER READ. */
@GetMapping
@RequirePermission(menu = "CHARGEBACK_WAIVER", perm = "READ")
public ApiResponse<PageResponse<ChargebackWaiverRequestResp>> list(
@ModelAttribute ChargebackWaiverRequestSearchParam param) {
return ApiResponse.ok(service.list(param));
}
/** 환수감면 신청 단건 상세. 권한: CHARGEBACK_WAIVER READ. */
@GetMapping("/{requestId}")
@RequirePermission(menu = "CHARGEBACK_WAIVER", perm = "READ")
public ApiResponse<ChargebackWaiverRequestResp> detail(@PathVariable Long requestId) {
return ApiResponse.ok(service.detail(requestId));
}
/** 환수감면 신청 등록. 응답: requestId. 권한: CHARGEBACK_WAIVER CREATE. */
@PostMapping
@RequirePermission(menu = "CHARGEBACK_WAIVER", perm = "CREATE")
@DataChangeLog(menu = "CHARGEBACK_WAIVER", table = "chargeback_waiver_request")
public ApiResponse<Long> create(@Valid @RequestBody ChargebackWaiverRequestSaveReq req) {
return ApiResponse.ok(service.create(req));
}
/** 환수감면 신청 승인. 권한: CHARGEBACK_WAIVER UPDATE. */
@PostMapping("/{requestId}/approve")
@RequirePermission(menu = "CHARGEBACK_WAIVER", perm = "UPDATE")
@DataChangeLog(menu = "CHARGEBACK_WAIVER", table = "chargeback_waiver_request")
public ApiResponse<Void> approve(@PathVariable Long requestId) {
service.approve(requestId);
return ApiResponse.ok();
}
/** 환수감면 신청 반려. 권한: CHARGEBACK_WAIVER UPDATE. */
@PostMapping("/{requestId}/reject")
@RequirePermission(menu = "CHARGEBACK_WAIVER", perm = "UPDATE")
@DataChangeLog(menu = "CHARGEBACK_WAIVER", table = "chargeback_waiver_request")
public ApiResponse<Void> reject(@PathVariable Long requestId) {
service.reject(requestId);
return ApiResponse.ok();
}
}
@@ -0,0 +1,83 @@
package com.ga.api.controller.commission;
import com.ga.api.service.commission.ClawbackInstallmentService;
import com.ga.common.annotation.DataChangeLog;
import com.ga.common.annotation.RequirePermission;
import com.ga.common.model.ApiResponse;
import com.ga.common.model.PageResponse;
import com.ga.core.vo.commission.ClawbackInstallmentPlanResp;
import com.ga.core.vo.commission.ClawbackInstallmentPlanSearchParam;
import com.ga.core.vo.commission.ClawbackInstallmentPlanVO;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;
import java.util.List;
import java.util.Map;
/**
* 환수분할상환 API.
*
* 환수채권(받아야 할 환수 금액)을 한 번에 못 갚을 때, 여러 달에 나눠 갚도록(분할상환) 계획을 만든다.
* - generate: 환수채권(receivableId) 하나를 N개월(count)로 나눠 baseMonth 부터 매월 상환 계획을 생성
* - cancel: 특정 회차 계획 취소
*
* 권한: @RequirePermission(menu="CLAWBACK_INSTALLMENT"), perm=READ/CREATE/UPDATE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "환수분할상환")
@RestController
@RequestMapping("/api/clawback-installments")
@RequiredArgsConstructor
public class ClawbackInstallmentController {
private final ClawbackInstallmentService service;
/** 분할상환 계획 목록 조회. 권한: CLAWBACK_INSTALLMENT READ. */
@GetMapping
@RequirePermission(menu = "CLAWBACK_INSTALLMENT", perm = "READ")
public ApiResponse<PageResponse<ClawbackInstallmentPlanResp>> list(
@ModelAttribute ClawbackInstallmentPlanSearchParam param) {
return ApiResponse.ok(service.list(param));
}
/** 분할상환 계획 단건 상세. 권한: CLAWBACK_INSTALLMENT READ. */
@GetMapping("/{planId}")
@RequirePermission(menu = "CLAWBACK_INSTALLMENT", perm = "READ")
public ApiResponse<ClawbackInstallmentPlanResp> detail(@PathVariable Long planId) {
return ApiResponse.ok(service.detail(planId));
}
/** 특정 환수채권에 묶인 분할상환 회차 전체 조회. 권한: CLAWBACK_INSTALLMENT READ. */
@GetMapping("/by-receivable/{receivableId}")
@RequirePermission(menu = "CLAWBACK_INSTALLMENT", perm = "READ")
public ApiResponse<List<ClawbackInstallmentPlanVO>> listByReceivable(
@PathVariable Long receivableId) {
return ApiResponse.ok(service.listByReceivable(receivableId));
}
/**
* 분할상환 계획 생성. 환수채권을 N개월로 균등 분할해 baseMonth 부터 회차를 만든다.
* Request body: { "count": N(분할 개월 수), "baseMonth": "YYYYMM"(첫 회차 월) }
* 권한: CLAWBACK_INSTALLMENT CREATE.
*/
@PostMapping("/generate/{receivableId}")
@RequirePermission(menu = "CLAWBACK_INSTALLMENT", perm = "CREATE")
@DataChangeLog(menu = "CLAWBACK_INSTALLMENT", table = "clawback_installment_plan")
public ApiResponse<Void> generate(@PathVariable Long receivableId,
@RequestBody Map<String, Object> body) {
// body 의 count/baseMonth 를 꺼내 서비스로 전달 (JSON 값은 문자열로 변환 후 파싱)
int count = Integer.parseInt(body.get("count").toString());
String baseMonth = body.get("baseMonth").toString();
service.generate(receivableId, count, baseMonth);
return ApiResponse.ok();
}
/** 분할상환 회차 취소. 권한: CLAWBACK_INSTALLMENT UPDATE. */
@PostMapping("/{planId}/cancel")
@RequirePermission(menu = "CLAWBACK_INSTALLMENT", perm = "UPDATE")
@DataChangeLog(menu = "CLAWBACK_INSTALLMENT", table = "clawback_installment_plan")
public ApiResponse<Void> cancel(@PathVariable Long planId) {
service.cancel(planId);
return ApiResponse.ok();
}
}
@@ -0,0 +1,79 @@
package com.ga.api.controller.commission;
import com.ga.api.service.commission.ClawbackReceivableService;
import com.ga.common.annotation.DataChangeLog;
import com.ga.common.annotation.RequirePermission;
import com.ga.common.model.ApiResponse;
import com.ga.common.model.PageResponse;
import com.ga.common.util.SecurityUtil;
import com.ga.core.vo.commission.ClawbackReceivableResp;
import com.ga.core.vo.commission.ClawbackReceivableSaveReq;
import com.ga.core.vo.commission.ClawbackReceivableSearchParam;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;
import java.util.List;
import java.util.Map;
/**
* 환수채권 관리 API.
*
* 환수채권(clawback receivable): 환수가 확정되어 설계사로부터 "받아야 할 돈"(미수금).
* 발생액(original) 중 회수액(recovered)을 빼면 잔액(balance)이 남는다.
* - write-off(대손상각): 회수가 불가능하다고 판단된 잔액을 손실로 털어내는 처리.
* - summary: 상태/설계사별 집계, export: 엑셀 다운로드.
*
* 권한: @RequirePermission(menu="CLAWBACK_RECEIVABLE"), perm=READ/UPDATE/EXPORT. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "환수채권 관리")
@RestController
@RequestMapping("/api/clawback-receivables")
@RequiredArgsConstructor
public class ClawbackReceivableController {
private final ClawbackReceivableService service;
/** 환수채권 목록 조회(검색 + 페이징). 권한: CLAWBACK_RECEIVABLE READ. */
@GetMapping
@RequirePermission(menu = "CLAWBACK_RECEIVABLE", perm = "READ")
public ApiResponse<PageResponse<ClawbackReceivableResp>> list(
@ModelAttribute ClawbackReceivableSearchParam param) {
return ApiResponse.ok(service.list(param));
}
/** 환수채권 집계 요약(상태/그룹별 합계). 권한: CLAWBACK_RECEIVABLE READ. */
@GetMapping("/summary")
@RequirePermission(menu = "CLAWBACK_RECEIVABLE", perm = "READ")
public ApiResponse<List<Map<String, Object>>> summary(
@ModelAttribute ClawbackReceivableSearchParam param) {
return ApiResponse.ok(service.summary(param));
}
/** 환수채권 단건 상세. 권한: CLAWBACK_RECEIVABLE READ. */
@GetMapping("/{id}")
@RequirePermission(menu = "CLAWBACK_RECEIVABLE", perm = "READ")
public ApiResponse<ClawbackReceivableResp> detail(@PathVariable Long id) {
return ApiResponse.ok(service.detail(id));
}
/** 대손상각(write-off) 처리. 잔액을 손실 처리한다. 처리자(현재 로그인 사용자 ID)를 함께 기록. 권한: CLAWBACK_RECEIVABLE UPDATE. */
@PutMapping("/{id}/write-off")
@RequirePermission(menu = "CLAWBACK_RECEIVABLE", perm = "UPDATE")
@DataChangeLog(menu = "CLAWBACK_RECEIVABLE", table = "clawback_receivable")
public ApiResponse<Void> writeOff(@PathVariable Long id,
@Valid @RequestBody ClawbackReceivableSaveReq req) {
service.writeOff(id, req, SecurityUtil.getCurrentUserId());
return ApiResponse.ok();
}
/** 환수채권 목록 엑셀 다운로드. 응답 스트림(response)에 직접 파일을 쓴다. 권한: CLAWBACK_RECEIVABLE EXPORT. */
@GetMapping("/export")
@RequirePermission(menu = "CLAWBACK_RECEIVABLE", perm = "EXPORT")
public void export(@ModelAttribute ClawbackReceivableSearchParam param,
HttpServletResponse response) {
service.export(param, response);
}
}
@@ -11,6 +11,14 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 수금수수료 API.
*
* 수금수수료(collection commission): 설계사가 보험료를 정상적으로 수금(납입 유도/관리)한 것에 대해
* 지급하는 수수료. 규칙(Rule)에 따라 산출되어 원장(Ledger)에 기록된다.
*
* 권한: @RequirePermission(menu="COLLECT_COMM"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "수금수수료") @Tag(name = "수금수수료")
@RestController @RestController
@RequestMapping("/api/collection-commissions") @RequestMapping("/api/collection-commissions")
@@ -19,8 +27,9 @@ public class CollectionCommissionController {
private final CollectionCommissionService service; private final CollectionCommissionService service;
// ── Rule ────────────────────────────────────────────────────────────────── // ── Rule (수금수수료 규칙) ──────────────────────────────────────────────
/** 수금수수료 규칙 목록 조회. 권한: COLLECT_COMM READ. */
@GetMapping("/rules") @GetMapping("/rules")
@RequirePermission(menu = "COLLECT_COMM", perm = "READ") @RequirePermission(menu = "COLLECT_COMM", perm = "READ")
public ApiResponse<PageResponse<CollectionCommissionRuleResp>> listRules( public ApiResponse<PageResponse<CollectionCommissionRuleResp>> listRules(
@@ -28,12 +37,14 @@ public class CollectionCommissionController {
return ApiResponse.ok(service.listRules(param)); return ApiResponse.ok(service.listRules(param));
} }
/** 수금수수료 규칙 단건 상세. 권한: COLLECT_COMM READ. */
@GetMapping("/rules/{ruleId}") @GetMapping("/rules/{ruleId}")
@RequirePermission(menu = "COLLECT_COMM", perm = "READ") @RequirePermission(menu = "COLLECT_COMM", perm = "READ")
public ApiResponse<CollectionCommissionRuleResp> detailRule(@PathVariable Long ruleId) { public ApiResponse<CollectionCommissionRuleResp> detailRule(@PathVariable Long ruleId) {
return ApiResponse.ok(service.detailRule(ruleId)); return ApiResponse.ok(service.detailRule(ruleId));
} }
/** 수금수수료 규칙 신규 등록. 응답: ruleId. 권한: COLLECT_COMM CREATE. */
@PostMapping("/rules") @PostMapping("/rules")
@RequirePermission(menu = "COLLECT_COMM", perm = "CREATE") @RequirePermission(menu = "COLLECT_COMM", perm = "CREATE")
@DataChangeLog(menu = "COLLECT_COMM", table = "collection_commission_rule") @DataChangeLog(menu = "COLLECT_COMM", table = "collection_commission_rule")
@@ -41,6 +52,7 @@ public class CollectionCommissionController {
return ApiResponse.ok(service.createRule(req)); return ApiResponse.ok(service.createRule(req));
} }
/** 수금수수료 규칙 수정. 권한: COLLECT_COMM UPDATE. */
@PutMapping("/rules/{ruleId}") @PutMapping("/rules/{ruleId}")
@RequirePermission(menu = "COLLECT_COMM", perm = "UPDATE") @RequirePermission(menu = "COLLECT_COMM", perm = "UPDATE")
@DataChangeLog(menu = "COLLECT_COMM", table = "collection_commission_rule") @DataChangeLog(menu = "COLLECT_COMM", table = "collection_commission_rule")
@@ -50,6 +62,7 @@ public class CollectionCommissionController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 수금수수료 규칙 삭제. 권한: COLLECT_COMM DELETE. */
@DeleteMapping("/rules/{ruleId}") @DeleteMapping("/rules/{ruleId}")
@RequirePermission(menu = "COLLECT_COMM", perm = "DELETE") @RequirePermission(menu = "COLLECT_COMM", perm = "DELETE")
@DataChangeLog(menu = "COLLECT_COMM", table = "collection_commission_rule") @DataChangeLog(menu = "COLLECT_COMM", table = "collection_commission_rule")
@@ -58,8 +71,9 @@ public class CollectionCommissionController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
// ── Ledger ──────────────────────────────────────────────────────────────── // ── Ledger (수금수수료 원장) ────────────────────────────────────────────
/** 수금수수료 원장 목록 조회. 권한: COLLECT_COMM READ. */
@GetMapping("/ledgers") @GetMapping("/ledgers")
@RequirePermission(menu = "COLLECT_COMM", perm = "READ") @RequirePermission(menu = "COLLECT_COMM", perm = "READ")
public ApiResponse<PageResponse<CollectionCommissionLedgerResp>> listLedgers( public ApiResponse<PageResponse<CollectionCommissionLedgerResp>> listLedgers(
@@ -67,12 +81,14 @@ public class CollectionCommissionController {
return ApiResponse.ok(service.listLedgers(param)); return ApiResponse.ok(service.listLedgers(param));
} }
/** 수금수수료 원장 단건 상세. 권한: COLLECT_COMM READ. */
@GetMapping("/ledgers/{ledgerId}") @GetMapping("/ledgers/{ledgerId}")
@RequirePermission(menu = "COLLECT_COMM", perm = "READ") @RequirePermission(menu = "COLLECT_COMM", perm = "READ")
public ApiResponse<CollectionCommissionLedgerResp> detailLedger(@PathVariable Long ledgerId) { public ApiResponse<CollectionCommissionLedgerResp> detailLedger(@PathVariable Long ledgerId) {
return ApiResponse.ok(service.detailLedger(ledgerId)); return ApiResponse.ok(service.detailLedger(ledgerId));
} }
/** 수금수수료 원장 신규 등록. 응답: ledgerId. 권한: COLLECT_COMM CREATE. */
@PostMapping("/ledgers") @PostMapping("/ledgers")
@RequirePermission(menu = "COLLECT_COMM", perm = "CREATE") @RequirePermission(menu = "COLLECT_COMM", perm = "CREATE")
@DataChangeLog(menu = "COLLECT_COMM", table = "collection_commission_ledger") @DataChangeLog(menu = "COLLECT_COMM", table = "collection_commission_ledger")
@@ -14,6 +14,15 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
/**
* 수수료 마스터 API.
*
* 수수료 마스터(commission master): 설계사·정산월 단위로 각종 수수료(도입/소개/유지/시상 등)를
* 한데 모아 최종 지급액을 관리하는 핵심 원장. 여러 세부 원장이 이 마스터로 집계된다.
* - by-agent: 설계사+정산월의 수수료들, aggregated: 정산월 전체 집계, status: 정산 상태 변경(확정/지급 등).
*
* 권한: @RequirePermission(menu="COMM_MASTER"), perm=READ/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "수수료 마스터") @Tag(name = "수수료 마스터")
@RestController @RestController
@RequestMapping("/api/commissions") @RequestMapping("/api/commissions")
@@ -22,18 +31,21 @@ public class CommissionMasterController {
private final CommissionMasterService service; private final CommissionMasterService service;
/** 수수료 마스터 목록 조회(검색 + 페이징). 권한: COMM_MASTER READ. */
@GetMapping @GetMapping
@RequirePermission(menu = "COMM_MASTER", perm = "READ") @RequirePermission(menu = "COMM_MASTER", perm = "READ")
public ApiResponse<PageResponse<CommissionMasterResp>> list(@ModelAttribute CommissionMasterSearchParam param) { public ApiResponse<PageResponse<CommissionMasterResp>> list(@ModelAttribute CommissionMasterSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 수수료 마스터 단건 상세. 권한: COMM_MASTER READ. */
@GetMapping("/{masterId}") @GetMapping("/{masterId}")
@RequirePermission(menu = "COMM_MASTER", perm = "READ") @RequirePermission(menu = "COMM_MASTER", perm = "READ")
public ApiResponse<CommissionMasterResp> detail(@PathVariable Long masterId) { public ApiResponse<CommissionMasterResp> detail(@PathVariable Long masterId) {
return ApiResponse.ok(service.detail(masterId)); return ApiResponse.ok(service.detail(masterId));
} }
/** 특정 설계사(agentId)의 특정 정산월(settleMonth) 수수료 내역 조회. 권한: COMM_MASTER READ. */
@GetMapping("/by-agent") @GetMapping("/by-agent")
@RequirePermission(menu = "COMM_MASTER", perm = "READ") @RequirePermission(menu = "COMM_MASTER", perm = "READ")
public ApiResponse<List<CommissionMasterResp>> byAgent(@RequestParam Long agentId, public ApiResponse<List<CommissionMasterResp>> byAgent(@RequestParam Long agentId,
@@ -41,12 +53,14 @@ public class CommissionMasterController {
return ApiResponse.ok(service.listByAgentAndMonth(agentId, settleMonth)); return ApiResponse.ok(service.listByAgentAndMonth(agentId, settleMonth));
} }
/** 정산월 단위 전체 집계 조회. 권한: COMM_MASTER READ. */
@GetMapping("/aggregated") @GetMapping("/aggregated")
@RequirePermission(menu = "COMM_MASTER", perm = "READ") @RequirePermission(menu = "COMM_MASTER", perm = "READ")
public ApiResponse<List<CommissionMasterResp>> aggregated(@RequestParam String settleMonth) { public ApiResponse<List<CommissionMasterResp>> aggregated(@RequestParam String settleMonth) {
return ApiResponse.ok(service.aggregatedByMonth(settleMonth)); return ApiResponse.ok(service.aggregatedByMonth(settleMonth));
} }
/** 정산 상태 변경(예: 확정/지급 등). body의 "status" 값으로 갱신. 권한: COMM_MASTER UPDATE. */
@PutMapping("/{masterId}/status") @PutMapping("/{masterId}/status")
@RequirePermission(menu = "COMM_MASTER", perm = "UPDATE") @RequirePermission(menu = "COMM_MASTER", perm = "UPDATE")
@DataChangeLog(menu = "COMM_MASTER", table = "commission_master") @DataChangeLog(menu = "COMM_MASTER", table = "commission_master")
@@ -56,6 +70,7 @@ public class CommissionMasterController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 수수료 마스터 삭제. 권한: COMM_MASTER DELETE. */
@DeleteMapping("/{masterId}") @DeleteMapping("/{masterId}")
@RequirePermission(menu = "COMM_MASTER", perm = "DELETE") @RequirePermission(menu = "COMM_MASTER", perm = "DELETE")
@DataChangeLog(menu = "COMM_MASTER", table = "commission_master") @DataChangeLog(menu = "COMM_MASTER", table = "commission_master")
@@ -13,6 +13,14 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 수수료 시뮬레이터 API.
*
* 시뮬레이션(simulation): 실제 정산을 확정하기 전에 "이 조건이면 수수료가 얼마 나올까"를 미리 계산해 보는 기능.
* 결과는 저장되어 이력으로 조회할 수 있다(실제 지급에는 영향 없음).
*
* 권한: @RequirePermission(menu="COMM_SIMULATOR"), perm=READ/CREATE.
*/
@Tag(name = "수수료 시뮬레이터") @Tag(name = "수수료 시뮬레이터")
@RestController @RestController
@RequestMapping("/api/commission-simulations") @RequestMapping("/api/commission-simulations")
@@ -21,6 +29,7 @@ public class CommissionSimulationController {
private final CommissionSimulationService service; private final CommissionSimulationService service;
/** 시뮬레이션 이력 목록 조회. 권한: COMM_SIMULATOR READ. */
@GetMapping @GetMapping
@RequirePermission(menu = "COMM_SIMULATOR", perm = "READ") @RequirePermission(menu = "COMM_SIMULATOR", perm = "READ")
public ApiResponse<PageResponse<CommissionSimulationResp>> list( public ApiResponse<PageResponse<CommissionSimulationResp>> list(
@@ -28,12 +37,14 @@ public class CommissionSimulationController {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 시뮬레이션 단건 상세. 권한: COMM_SIMULATOR READ. */
@GetMapping("/{simId}") @GetMapping("/{simId}")
@RequirePermission(menu = "COMM_SIMULATOR", perm = "READ") @RequirePermission(menu = "COMM_SIMULATOR", perm = "READ")
public ApiResponse<CommissionSimulationResp> detail(@PathVariable Long simId) { public ApiResponse<CommissionSimulationResp> detail(@PathVariable Long simId) {
return ApiResponse.ok(service.detail(simId)); return ApiResponse.ok(service.detail(simId));
} }
/** 시뮬레이션 실행. 요청 조건으로 예상 수수료를 계산해 결과를 반환(및 이력 저장). 권한: COMM_SIMULATOR CREATE. */
@PostMapping("/simulate") @PostMapping("/simulate")
@RequirePermission(menu = "COMM_SIMULATOR", perm = "CREATE") @RequirePermission(menu = "COMM_SIMULATOR", perm = "CREATE")
@DataChangeLog(menu = "COMM_SIMULATOR", table = "commission_simulation") @DataChangeLog(menu = "COMM_SIMULATOR", table = "commission_simulation")
@@ -16,6 +16,15 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 등급평가 API.
*
* 등급평가(grade evaluation): 설계사의 실적 등을 기준 규칙(Rule)에 따라 평가해 등급을 매기는 기능.
* 등급은 수수료율·시상 등에 영향을 준다.
* - Rule(평가 규칙) CRUD - Evaluation(평가 결과): 생성 후 apply(적용)하면 실제 설계사 등급에 반영된다.
*
* 권한: @RequirePermission(menu="GRADE_EVAL"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "등급평가") @Tag(name = "등급평가")
@RestController @RestController
@RequestMapping("/api/grade-evaluations") @RequestMapping("/api/grade-evaluations")
@@ -24,20 +33,23 @@ public class GradeEvaluationController {
private final GradeEvaluationService service; private final GradeEvaluationService service;
// ── Rule ────────────────────────────────────────────────────────────────── // ── Rule (평가 규칙) ────────────────────────────────────────────────────
/** 등급평가 규칙 목록 조회. 권한: GRADE_EVAL READ. */
@GetMapping("/rules") @GetMapping("/rules")
@RequirePermission(menu = "GRADE_EVAL", perm = "READ") @RequirePermission(menu = "GRADE_EVAL", perm = "READ")
public ApiResponse<PageResponse<GradeEvalRuleResp>> listRules(@ModelAttribute GradeEvalRuleSearchParam param) { public ApiResponse<PageResponse<GradeEvalRuleResp>> listRules(@ModelAttribute GradeEvalRuleSearchParam param) {
return ApiResponse.ok(service.listRules(param)); return ApiResponse.ok(service.listRules(param));
} }
/** 등급평가 규칙 단건 상세. 권한: GRADE_EVAL READ. */
@GetMapping("/rules/{ruleId}") @GetMapping("/rules/{ruleId}")
@RequirePermission(menu = "GRADE_EVAL", perm = "READ") @RequirePermission(menu = "GRADE_EVAL", perm = "READ")
public ApiResponse<GradeEvalRuleResp> detailRule(@PathVariable Long ruleId) { public ApiResponse<GradeEvalRuleResp> detailRule(@PathVariable Long ruleId) {
return ApiResponse.ok(service.detailRule(ruleId)); return ApiResponse.ok(service.detailRule(ruleId));
} }
/** 등급평가 규칙 신규 등록. 응답: ruleId. 권한: GRADE_EVAL CREATE. */
@PostMapping("/rules") @PostMapping("/rules")
@RequirePermission(menu = "GRADE_EVAL", perm = "CREATE") @RequirePermission(menu = "GRADE_EVAL", perm = "CREATE")
@DataChangeLog(menu = "GRADE_EVAL", table = "grade_eval_rule") @DataChangeLog(menu = "GRADE_EVAL", table = "grade_eval_rule")
@@ -45,6 +57,7 @@ public class GradeEvaluationController {
return ApiResponse.ok(service.createRule(req)); return ApiResponse.ok(service.createRule(req));
} }
/** 등급평가 규칙 수정. 권한: GRADE_EVAL UPDATE. */
@PutMapping("/rules/{ruleId}") @PutMapping("/rules/{ruleId}")
@RequirePermission(menu = "GRADE_EVAL", perm = "UPDATE") @RequirePermission(menu = "GRADE_EVAL", perm = "UPDATE")
@DataChangeLog(menu = "GRADE_EVAL", table = "grade_eval_rule") @DataChangeLog(menu = "GRADE_EVAL", table = "grade_eval_rule")
@@ -54,6 +67,7 @@ public class GradeEvaluationController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 등급평가 규칙 삭제. 권한: GRADE_EVAL DELETE. */
@DeleteMapping("/rules/{ruleId}") @DeleteMapping("/rules/{ruleId}")
@RequirePermission(menu = "GRADE_EVAL", perm = "DELETE") @RequirePermission(menu = "GRADE_EVAL", perm = "DELETE")
@DataChangeLog(menu = "GRADE_EVAL", table = "grade_eval_rule") @DataChangeLog(menu = "GRADE_EVAL", table = "grade_eval_rule")
@@ -62,8 +76,9 @@ public class GradeEvaluationController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
// ── Evaluation ──────────────────────────────────────────────────────────── // ── Evaluation (평가 결과) ──────────────────────────────────────────────
/** 등급평가 결과 목록 조회. 권한: GRADE_EVAL READ. */
@GetMapping @GetMapping
@RequirePermission(menu = "GRADE_EVAL", perm = "READ") @RequirePermission(menu = "GRADE_EVAL", perm = "READ")
public ApiResponse<PageResponse<AgentGradeEvaluationResp>> listEvals( public ApiResponse<PageResponse<AgentGradeEvaluationResp>> listEvals(
@@ -71,12 +86,14 @@ public class GradeEvaluationController {
return ApiResponse.ok(service.listEvals(param)); return ApiResponse.ok(service.listEvals(param));
} }
/** 등급평가 결과 단건 상세. 권한: GRADE_EVAL READ. */
@GetMapping("/{evalId}") @GetMapping("/{evalId}")
@RequirePermission(menu = "GRADE_EVAL", perm = "READ") @RequirePermission(menu = "GRADE_EVAL", perm = "READ")
public ApiResponse<AgentGradeEvaluationResp> detailEval(@PathVariable Long evalId) { public ApiResponse<AgentGradeEvaluationResp> detailEval(@PathVariable Long evalId) {
return ApiResponse.ok(service.detailEval(evalId)); return ApiResponse.ok(service.detailEval(evalId));
} }
/** 등급평가 결과 신규 생성(아직 미적용 상태). 응답: evalId. 권한: GRADE_EVAL CREATE. */
@PostMapping @PostMapping
@RequirePermission(menu = "GRADE_EVAL", perm = "CREATE") @RequirePermission(menu = "GRADE_EVAL", perm = "CREATE")
@DataChangeLog(menu = "GRADE_EVAL", table = "agent_grade_evaluation") @DataChangeLog(menu = "GRADE_EVAL", table = "agent_grade_evaluation")
@@ -84,6 +101,7 @@ public class GradeEvaluationController {
return ApiResponse.ok(service.createEval(req)); return ApiResponse.ok(service.createEval(req));
} }
/** 등급평가 결과 적용. 평가된 등급을 실제 설계사 등급에 반영한다. 권한: GRADE_EVAL UPDATE. */
@PostMapping("/{evalId}/apply") @PostMapping("/{evalId}/apply")
@RequirePermission(menu = "GRADE_EVAL", perm = "UPDATE") @RequirePermission(menu = "GRADE_EVAL", perm = "UPDATE")
@DataChangeLog(menu = "GRADE_EVAL", table = "agent_grade_evaluation") @DataChangeLog(menu = "GRADE_EVAL", table = "agent_grade_evaluation")
@@ -92,6 +110,7 @@ public class GradeEvaluationController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 등급평가 결과 삭제. 권한: GRADE_EVAL DELETE. */
@DeleteMapping("/{evalId}") @DeleteMapping("/{evalId}")
@RequirePermission(menu = "GRADE_EVAL", perm = "DELETE") @RequirePermission(menu = "GRADE_EVAL", perm = "DELETE")
@DataChangeLog(menu = "GRADE_EVAL", table = "agent_grade_evaluation") @DataChangeLog(menu = "GRADE_EVAL", table = "agent_grade_evaluation")
@@ -13,6 +13,14 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 보증보험 API.
*
* 보증보험(guarantee insurance): 설계사가 선지급금 등을 갚지 못할 경우에 대비해 가입하는 보험.
* 설계사별 가입 정보(보험사/증권번호/보장한도/기간 등)를 관리한다.
*
* 권한: @RequirePermission(menu="GUARANTEE_INS"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "보증보험") @Tag(name = "보증보험")
@RestController @RestController
@RequestMapping("/api/guarantee-insurances") @RequestMapping("/api/guarantee-insurances")
@@ -21,6 +29,7 @@ public class GuaranteeInsuranceController {
private final GuaranteeInsuranceService service; private final GuaranteeInsuranceService service;
/** 보증보험 가입 목록 조회. 권한: GUARANTEE_INS READ. */
@GetMapping @GetMapping
@RequirePermission(menu = "GUARANTEE_INS", perm = "READ") @RequirePermission(menu = "GUARANTEE_INS", perm = "READ")
public ApiResponse<PageResponse<AgentGuaranteeInsuranceResp>> list( public ApiResponse<PageResponse<AgentGuaranteeInsuranceResp>> list(
@@ -28,12 +37,14 @@ public class GuaranteeInsuranceController {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 보증보험 단건 상세. 권한: GUARANTEE_INS READ. */
@GetMapping("/{guaranteeId}") @GetMapping("/{guaranteeId}")
@RequirePermission(menu = "GUARANTEE_INS", perm = "READ") @RequirePermission(menu = "GUARANTEE_INS", perm = "READ")
public ApiResponse<AgentGuaranteeInsuranceResp> detail(@PathVariable Long guaranteeId) { public ApiResponse<AgentGuaranteeInsuranceResp> detail(@PathVariable Long guaranteeId) {
return ApiResponse.ok(service.detail(guaranteeId)); return ApiResponse.ok(service.detail(guaranteeId));
} }
/** 보증보험 가입 등록. 응답: guaranteeId. 권한: GUARANTEE_INS CREATE. */
@PostMapping @PostMapping
@RequirePermission(menu = "GUARANTEE_INS", perm = "CREATE") @RequirePermission(menu = "GUARANTEE_INS", perm = "CREATE")
@DataChangeLog(menu = "GUARANTEE_INS", table = "agent_guarantee_insurance") @DataChangeLog(menu = "GUARANTEE_INS", table = "agent_guarantee_insurance")
@@ -41,6 +52,7 @@ public class GuaranteeInsuranceController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 보증보험 정보 수정. 권한: GUARANTEE_INS UPDATE. */
@PutMapping("/{guaranteeId}") @PutMapping("/{guaranteeId}")
@RequirePermission(menu = "GUARANTEE_INS", perm = "UPDATE") @RequirePermission(menu = "GUARANTEE_INS", perm = "UPDATE")
@DataChangeLog(menu = "GUARANTEE_INS", table = "agent_guarantee_insurance") @DataChangeLog(menu = "GUARANTEE_INS", table = "agent_guarantee_insurance")
@@ -50,6 +62,7 @@ public class GuaranteeInsuranceController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 보증보험 삭제. 권한: GUARANTEE_INS DELETE. */
@DeleteMapping("/{guaranteeId}") @DeleteMapping("/{guaranteeId}")
@RequirePermission(menu = "GUARANTEE_INS", perm = "DELETE") @RequirePermission(menu = "GUARANTEE_INS", perm = "DELETE")
@DataChangeLog(menu = "GUARANTEE_INS", table = "agent_guarantee_insurance") @DataChangeLog(menu = "GUARANTEE_INS", table = "agent_guarantee_insurance")
@@ -14,6 +14,14 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 본사정산 API.
*
* 본사정산(HQ settle): 본사 차원에서 발생하는 정산 항목(item)을 정산월 단위로 관리하고 합계(summary)를 낸다.
* 설계사 지급과 별개로 본사가 직접 가감하는 비용/수입 항목 등을 다룬다.
*
* 권한: @RequirePermission(menu="HQ_SETTLE"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "본사정산") @Tag(name = "본사정산")
@RestController @RestController
@RequestMapping("/api/hq-settles") @RequestMapping("/api/hq-settles")
@@ -22,24 +30,28 @@ public class HqSettleController {
private final HqSettleService service; private final HqSettleService service;
/** 본사정산 항목 목록 조회. 권한: HQ_SETTLE READ. */
@GetMapping @GetMapping
@RequirePermission(menu = "HQ_SETTLE", perm = "READ") @RequirePermission(menu = "HQ_SETTLE", perm = "READ")
public ApiResponse<PageResponse<HqSettleItemResp>> list(@ModelAttribute HqSettleItemSearchParam param) { public ApiResponse<PageResponse<HqSettleItemResp>> list(@ModelAttribute HqSettleItemSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 특정 정산월의 본사정산 합계 요약. 권한: HQ_SETTLE READ. */
@GetMapping("/summary") @GetMapping("/summary")
@RequirePermission(menu = "HQ_SETTLE", perm = "READ") @RequirePermission(menu = "HQ_SETTLE", perm = "READ")
public ApiResponse<HqSummaryResp> summary(@RequestParam String settleMonth) { public ApiResponse<HqSummaryResp> summary(@RequestParam String settleMonth) {
return ApiResponse.ok(service.summary(settleMonth)); return ApiResponse.ok(service.summary(settleMonth));
} }
/** 본사정산 항목 단건 상세. 권한: HQ_SETTLE READ. */
@GetMapping("/{itemId}") @GetMapping("/{itemId}")
@RequirePermission(menu = "HQ_SETTLE", perm = "READ") @RequirePermission(menu = "HQ_SETTLE", perm = "READ")
public ApiResponse<HqSettleItemResp> detail(@PathVariable Long itemId) { public ApiResponse<HqSettleItemResp> detail(@PathVariable Long itemId) {
return ApiResponse.ok(service.detail(itemId)); return ApiResponse.ok(service.detail(itemId));
} }
/** 본사정산 항목 신규 등록. 응답: itemId. 권한: HQ_SETTLE CREATE. */
@PostMapping @PostMapping
@RequirePermission(menu = "HQ_SETTLE", perm = "CREATE") @RequirePermission(menu = "HQ_SETTLE", perm = "CREATE")
@DataChangeLog(menu = "HQ_SETTLE", table = "hq_settle_item") @DataChangeLog(menu = "HQ_SETTLE", table = "hq_settle_item")
@@ -47,6 +59,7 @@ public class HqSettleController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 본사정산 항목 수정. 권한: HQ_SETTLE UPDATE. */
@PutMapping("/{itemId}") @PutMapping("/{itemId}")
@RequirePermission(menu = "HQ_SETTLE", perm = "UPDATE") @RequirePermission(menu = "HQ_SETTLE", perm = "UPDATE")
@DataChangeLog(menu = "HQ_SETTLE", table = "hq_settle_item") @DataChangeLog(menu = "HQ_SETTLE", table = "hq_settle_item")
@@ -56,6 +69,7 @@ public class HqSettleController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 본사정산 항목 삭제. 권한: HQ_SETTLE DELETE. */
@DeleteMapping("/{itemId}") @DeleteMapping("/{itemId}")
@RequirePermission(menu = "HQ_SETTLE", perm = "DELETE") @RequirePermission(menu = "HQ_SETTLE", perm = "DELETE")
@DataChangeLog(menu = "HQ_SETTLE", table = "hq_settle_item") @DataChangeLog(menu = "HQ_SETTLE", table = "hq_settle_item")
@@ -11,6 +11,17 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 수입수수료/수지차 API.
*
* - 수입수수료(income commission): GA가 보험사로부터 받는 수수료. "보험료 x 보험사 요율"로 계산되며,
* 설계사에게 지급하는 수수료(지출)의 재원이 된다.
* - 수지차(margin): 같은 정산월의 수입수수료 합계에서 설계사 지급액 합계를 뺀 GA의 마진.
* 양수면 흑자, 음수면 적자를 뜻한다.
*
* 모든 엔드포인트는 @RequirePermission(menu="INCOME_COMM")로 보호되며, perm 은 READ(조회)/CREATE(생성) 권한을 의미한다.
* 데이터 변경(POST)에는 @DataChangeLog 로 변경 이력(감사 로그)이 자동 기록된다.
*/
@Tag(name = "수입수수료/수지차") @Tag(name = "수입수수료/수지차")
@RestController @RestController
@RequestMapping("/api/income-commissions") @RequestMapping("/api/income-commissions")
@@ -19,8 +30,9 @@ public class IncomeCommissionController {
private final IncomeCommissionService service; private final IncomeCommissionService service;
// ── Income Ledger ──────────────────────────────────────────────────────── // ── Income Ledger (수입수수료 원장) ───────────────────────────────────────
/** 수입수수료 원장 목록 조회(검색조건 + 페이징). 권한: INCOME_COMM READ. */
@GetMapping("/ledgers") @GetMapping("/ledgers")
@RequirePermission(menu = "INCOME_COMM", perm = "READ") @RequirePermission(menu = "INCOME_COMM", perm = "READ")
public ApiResponse<PageResponse<IncomeCommissionLedgerResp>> listLedgers( public ApiResponse<PageResponse<IncomeCommissionLedgerResp>> listLedgers(
@@ -28,12 +40,14 @@ public class IncomeCommissionController {
return ApiResponse.ok(service.listLedgers(param)); return ApiResponse.ok(service.listLedgers(param));
} }
/** 수입수수료 원장 단건 상세 조회. 권한: INCOME_COMM READ. */
@GetMapping("/ledgers/{incomeId}") @GetMapping("/ledgers/{incomeId}")
@RequirePermission(menu = "INCOME_COMM", perm = "READ") @RequirePermission(menu = "INCOME_COMM", perm = "READ")
public ApiResponse<IncomeCommissionLedgerResp> detailLedger(@PathVariable Long incomeId) { public ApiResponse<IncomeCommissionLedgerResp> detailLedger(@PathVariable Long incomeId) {
return ApiResponse.ok(service.detailLedger(incomeId)); return ApiResponse.ok(service.detailLedger(incomeId));
} }
/** 수입수수료 원장 신규 등록. 등록 시 "보험료 x 보험사요율"로 수입액이 계산된다. 응답: 생성된 incomeId. 권한: INCOME_COMM CREATE. */
@PostMapping("/ledgers") @PostMapping("/ledgers")
@RequirePermission(menu = "INCOME_COMM", perm = "CREATE") @RequirePermission(menu = "INCOME_COMM", perm = "CREATE")
@DataChangeLog(menu = "INCOME_COMM", table = "income_commission_ledger") @DataChangeLog(menu = "INCOME_COMM", table = "income_commission_ledger")
@@ -41,8 +55,9 @@ public class IncomeCommissionController {
return ApiResponse.ok(service.createLedger(req)); return ApiResponse.ok(service.createLedger(req));
} }
// ── Margin Summary ─────────────────────────────────────────────────────── // ── Margin Summary (수지차 집계) ──────────────────────────────────────────
/** 수지차 집계 목록 조회. 권한: INCOME_COMM READ. */
@GetMapping("/margins") @GetMapping("/margins")
@RequirePermission(menu = "INCOME_COMM", perm = "READ") @RequirePermission(menu = "INCOME_COMM", perm = "READ")
public ApiResponse<PageResponse<MarginSummaryResp>> listMargins( public ApiResponse<PageResponse<MarginSummaryResp>> listMargins(
@@ -50,12 +65,17 @@ public class IncomeCommissionController {
return ApiResponse.ok(service.listMargins(param)); return ApiResponse.ok(service.listMargins(param));
} }
/** 수지차 집계 단건 상세 조회. 권한: INCOME_COMM READ. */
@GetMapping("/margins/{marginId}") @GetMapping("/margins/{marginId}")
@RequirePermission(menu = "INCOME_COMM", perm = "READ") @RequirePermission(menu = "INCOME_COMM", perm = "READ")
public ApiResponse<MarginSummaryResp> detailMargin(@PathVariable Long marginId) { public ApiResponse<MarginSummaryResp> detailMargin(@PathVariable Long marginId) {
return ApiResponse.ok(service.detailMargin(marginId)); return ApiResponse.ok(service.detailMargin(marginId));
} }
/**
* 수지차 재계산. 정산월(settleMonth) 기준으로 수입수수료 합 - 설계사 지급액 합을 다시 산출해 저장한다.
* agentId 가 주어지면 해당 설계사 지급분만 좁혀 집계한다(미지정 시 GA 월 전체). 응답: marginId. 권한: INCOME_COMM CREATE.
*/
@PostMapping("/margin/recalc") @PostMapping("/margin/recalc")
@RequirePermission(menu = "INCOME_COMM", perm = "CREATE") @RequirePermission(menu = "INCOME_COMM", perm = "CREATE")
@DataChangeLog(menu = "INCOME_COMM", table = "margin_summary") @DataChangeLog(menu = "INCOME_COMM", table = "margin_summary")
@@ -13,6 +13,14 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 공동계약 API.
*
* 공동계약(joint contract): 계약을 이상의 설계사가 함께 모집한 경우, 수수료를
* 약정 비율(지분)대로 나눠 갖도록 관리하는 기능. 비율 합이 100% 되도록 등록한다.
*
* 권한: @RequirePermission(menu="JOINT_CONTRACT"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "공동계약") @Tag(name = "공동계약")
@RestController @RestController
@RequestMapping("/api/joint-contracts") @RequestMapping("/api/joint-contracts")
@@ -21,18 +29,21 @@ public class JointContractController {
private final JointContractService service; private final JointContractService service;
/** 공동계약 목록 조회. 권한: JOINT_CONTRACT READ. */
@GetMapping @GetMapping
@RequirePermission(menu = "JOINT_CONTRACT", perm = "READ") @RequirePermission(menu = "JOINT_CONTRACT", perm = "READ")
public ApiResponse<PageResponse<JointContractResp>> list(@ModelAttribute JointContractSearchParam param) { public ApiResponse<PageResponse<JointContractResp>> list(@ModelAttribute JointContractSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 공동계약 단건 상세. 권한: JOINT_CONTRACT READ. */
@GetMapping("/{jointId}") @GetMapping("/{jointId}")
@RequirePermission(menu = "JOINT_CONTRACT", perm = "READ") @RequirePermission(menu = "JOINT_CONTRACT", perm = "READ")
public ApiResponse<JointContractResp> detail(@PathVariable Long jointId) { public ApiResponse<JointContractResp> detail(@PathVariable Long jointId) {
return ApiResponse.ok(service.detail(jointId)); return ApiResponse.ok(service.detail(jointId));
} }
/** 공동계약 신규 등록(설계사별 지분 비율 포함). 응답: jointId. 권한: JOINT_CONTRACT CREATE. */
@PostMapping @PostMapping
@RequirePermission(menu = "JOINT_CONTRACT", perm = "CREATE") @RequirePermission(menu = "JOINT_CONTRACT", perm = "CREATE")
@DataChangeLog(menu = "JOINT_CONTRACT", table = "joint_contract") @DataChangeLog(menu = "JOINT_CONTRACT", table = "joint_contract")
@@ -40,6 +51,7 @@ public class JointContractController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 공동계약 수정(지분 비율 변경 등). 권한: JOINT_CONTRACT UPDATE. */
@PutMapping("/{jointId}") @PutMapping("/{jointId}")
@RequirePermission(menu = "JOINT_CONTRACT", perm = "UPDATE") @RequirePermission(menu = "JOINT_CONTRACT", perm = "UPDATE")
@DataChangeLog(menu = "JOINT_CONTRACT", table = "joint_contract") @DataChangeLog(menu = "JOINT_CONTRACT", table = "joint_contract")
@@ -49,6 +61,7 @@ public class JointContractController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 공동계약 삭제. 권한: JOINT_CONTRACT DELETE. */
@DeleteMapping("/{jointId}") @DeleteMapping("/{jointId}")
@RequirePermission(menu = "JOINT_CONTRACT", perm = "DELETE") @RequirePermission(menu = "JOINT_CONTRACT", perm = "DELETE")
@DataChangeLog(menu = "JOINT_CONTRACT", table = "joint_contract") @DataChangeLog(menu = "JOINT_CONTRACT", table = "joint_contract")
@@ -0,0 +1,74 @@
package com.ga.api.controller.commission;
import com.ga.api.service.commission.LapsedReinstatementService;
import com.ga.common.annotation.DataChangeLog;
import com.ga.common.annotation.RequirePermission;
import com.ga.common.model.ApiResponse;
import com.ga.common.model.PageResponse;
import com.ga.core.vo.commission.LapsedReinstatementRecoveryResp;
import com.ga.core.vo.commission.LapsedReinstatementRecoverySaveReq;
import com.ga.core.vo.commission.LapsedReinstatementRecoverySearchParam;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;
/**
* 익월부활재지급 API.
*
* 실효(lapsed): 보험료 미납 등으로 계약 효력이 일시 정지된 상태. 실효가 나면 달에 지급했던 수수료를 환수한다.
* 부활(reinstatement): 실효된 계약이 다시 살아나는 . 다음 (익월) 부활하면 앞서 환수했던 수수료를
* 다시 지급(재지급) 준다. 도메인은 "환수 → 익월 부활 시 재지급(회수)" 흐름을 관리한다.
* - repay: 부활에 따른 재지급(회수) 확정 - cancel: 재지급 취소
*
* 권한: @RequirePermission(menu="LAPSED_REINSTATEMENT"), perm=READ/CREATE/UPDATE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "익월부활재지급")
@RestController
@RequestMapping("/api/lapsed-reinstatements")
@RequiredArgsConstructor
public class LapsedReinstatementController {
private final LapsedReinstatementService service;
/** 익월부활 재지급 대상 목록 조회. 권한: LAPSED_REINSTATEMENT READ. */
@GetMapping
@RequirePermission(menu = "LAPSED_REINSTATEMENT", perm = "READ")
public ApiResponse<PageResponse<LapsedReinstatementRecoveryResp>> list(
@ModelAttribute LapsedReinstatementRecoverySearchParam param) {
return ApiResponse.ok(service.list(param));
}
/** 재지급 건 단건 상세. 권한: LAPSED_REINSTATEMENT READ. */
@GetMapping("/{recoveryId}")
@RequirePermission(menu = "LAPSED_REINSTATEMENT", perm = "READ")
public ApiResponse<LapsedReinstatementRecoveryResp> detail(@PathVariable Long recoveryId) {
return ApiResponse.ok(service.detail(recoveryId));
}
/** 재지급 건 신규 등록. 응답: recoveryId. 권한: LAPSED_REINSTATEMENT CREATE. */
@PostMapping
@RequirePermission(menu = "LAPSED_REINSTATEMENT", perm = "CREATE")
@DataChangeLog(menu = "LAPSED_REINSTATEMENT", table = "lapsed_reinstatement_recovery")
public ApiResponse<Long> create(@Valid @RequestBody LapsedReinstatementRecoverySaveReq req) {
return ApiResponse.ok(service.create(req));
}
/** 부활에 따른 재지급(회수) 확정 처리. 권한: LAPSED_REINSTATEMENT UPDATE. */
@PostMapping("/{recoveryId}/repay")
@RequirePermission(menu = "LAPSED_REINSTATEMENT", perm = "UPDATE")
@DataChangeLog(menu = "LAPSED_REINSTATEMENT", table = "lapsed_reinstatement_recovery")
public ApiResponse<Void> repay(@PathVariable Long recoveryId) {
service.repay(recoveryId);
return ApiResponse.ok();
}
/** 재지급 취소 처리. 권한: LAPSED_REINSTATEMENT UPDATE. */
@PostMapping("/{recoveryId}/cancel")
@RequirePermission(menu = "LAPSED_REINSTATEMENT", perm = "UPDATE")
@DataChangeLog(menu = "LAPSED_REINSTATEMENT", table = "lapsed_reinstatement_recovery")
public ApiResponse<Void> cancel(@PathVariable Long recoveryId) {
service.cancel(recoveryId);
return ApiResponse.ok();
}
}
@@ -11,6 +11,15 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 생보운영지원수수료 API.
*
* 생명보험사 운영지원수수료(life operation support): 생보 상품 운영/관리 활동에 대해 지급하는 지원성 수수료.
* 규칙(Rule) 정의된 기준에 따라 산출되어 원장(Ledger) 기록된다.
*
* 구조는 "규칙(Rule) CRUD + 원장(Ledger) 조회/등록"으로, 다른 수수료 도메인과 동일한 패턴이다.
* 권한: @RequirePermission(menu="LIFE_OP_SUPPORT"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "생보운영지원수수료") @Tag(name = "생보운영지원수수료")
@RestController @RestController
@RequestMapping("/api/life-supports") @RequestMapping("/api/life-supports")
@@ -19,8 +28,9 @@ public class LifeSupportController {
private final LifeSupportService service; private final LifeSupportService service;
// Rule // Rule (지원수수료 규칙)
/** 규칙 목록 조회. 권한: LIFE_OP_SUPPORT READ. */
@GetMapping("/rules") @GetMapping("/rules")
@RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "READ") @RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "READ")
public ApiResponse<PageResponse<LifeSupportRuleResp>> listRules( public ApiResponse<PageResponse<LifeSupportRuleResp>> listRules(
@@ -28,12 +38,14 @@ public class LifeSupportController {
return ApiResponse.ok(service.listRules(param)); return ApiResponse.ok(service.listRules(param));
} }
/** 규칙 단건 상세. 권한: LIFE_OP_SUPPORT READ. */
@GetMapping("/rules/{ruleId}") @GetMapping("/rules/{ruleId}")
@RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "READ") @RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "READ")
public ApiResponse<LifeSupportRuleResp> detailRule(@PathVariable Long ruleId) { public ApiResponse<LifeSupportRuleResp> detailRule(@PathVariable Long ruleId) {
return ApiResponse.ok(service.detailRule(ruleId)); return ApiResponse.ok(service.detailRule(ruleId));
} }
/** 규칙 신규 등록. 응답: ruleId. 권한: LIFE_OP_SUPPORT CREATE. */
@PostMapping("/rules") @PostMapping("/rules")
@RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "CREATE") @RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "CREATE")
@DataChangeLog(menu = "LIFE_OP_SUPPORT", table = "life_support_rule") @DataChangeLog(menu = "LIFE_OP_SUPPORT", table = "life_support_rule")
@@ -41,6 +53,7 @@ public class LifeSupportController {
return ApiResponse.ok(service.createRule(req)); return ApiResponse.ok(service.createRule(req));
} }
/** 규칙 수정. 권한: LIFE_OP_SUPPORT UPDATE. */
@PutMapping("/rules/{ruleId}") @PutMapping("/rules/{ruleId}")
@RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "UPDATE") @RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "UPDATE")
@DataChangeLog(menu = "LIFE_OP_SUPPORT", table = "life_support_rule") @DataChangeLog(menu = "LIFE_OP_SUPPORT", table = "life_support_rule")
@@ -50,6 +63,7 @@ public class LifeSupportController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 규칙 삭제. 권한: LIFE_OP_SUPPORT DELETE. */
@DeleteMapping("/rules/{ruleId}") @DeleteMapping("/rules/{ruleId}")
@RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "DELETE") @RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "DELETE")
@DataChangeLog(menu = "LIFE_OP_SUPPORT", table = "life_support_rule") @DataChangeLog(menu = "LIFE_OP_SUPPORT", table = "life_support_rule")
@@ -58,8 +72,9 @@ public class LifeSupportController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
// Ledger // Ledger (지원수수료 원장)
/** 원장 목록 조회. 권한: LIFE_OP_SUPPORT READ. */
@GetMapping("/ledgers") @GetMapping("/ledgers")
@RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "READ") @RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "READ")
public ApiResponse<PageResponse<LifeSupportLedgerResp>> listLedgers( public ApiResponse<PageResponse<LifeSupportLedgerResp>> listLedgers(
@@ -67,12 +82,14 @@ public class LifeSupportController {
return ApiResponse.ok(service.listLedgers(param)); return ApiResponse.ok(service.listLedgers(param));
} }
/** 원장 단건 상세. 권한: LIFE_OP_SUPPORT READ. */
@GetMapping("/ledgers/{ledgerId}") @GetMapping("/ledgers/{ledgerId}")
@RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "READ") @RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "READ")
public ApiResponse<LifeSupportLedgerResp> detailLedger(@PathVariable Long ledgerId) { public ApiResponse<LifeSupportLedgerResp> detailLedger(@PathVariable Long ledgerId) {
return ApiResponse.ok(service.detailLedger(ledgerId)); return ApiResponse.ok(service.detailLedger(ledgerId));
} }
/** 원장 신규 등록(지원수수료 산출/지급 기록). 응답: ledgerId. 권한: LIFE_OP_SUPPORT CREATE. */
@PostMapping("/ledgers") @PostMapping("/ledgers")
@RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "CREATE") @RequirePermission(menu = "LIFE_OP_SUPPORT", perm = "CREATE")
@DataChangeLog(menu = "LIFE_OP_SUPPORT", table = "life_support_ledger") @DataChangeLog(menu = "LIFE_OP_SUPPORT", table = "life_support_ledger")
@@ -11,6 +11,16 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
/**
* 오버라이드 원장 API.
*
* 오버라이드(override): 상위 직급자(: 팀장/지점장) 자기 산하 하위 설계사의 실적에 대해
* 일정 비율로 추가로 받는 수수료. "하위가 판 만큼 상위에게도 얹어주는" 구조라 override 부른다.
* 원장은 누가(fromAgent) 누구에게(toAgentId) 얼마를 넘겨주는지를 기록한다.
* - summary: 수령자(상위자) 기준 집계.
*
* 권한: @RequirePermission(menu="OVERRIDE_LEDGER"), perm=READ. (조회 전용 - 생성/배치는 별도 계산 로직에서 처리)
*/
@Tag(name = "오버라이드 원장") @Tag(name = "오버라이드 원장")
@RestController @RestController
@RequestMapping("/api/override-ledgers") @RequestMapping("/api/override-ledgers")
@@ -19,24 +29,28 @@ public class OverrideLedgerController {
private final OverrideLedgerService service; private final OverrideLedgerService service;
/** 오버라이드 원장 목록 조회. 권한: OVERRIDE_LEDGER READ. */
@GetMapping @GetMapping
@RequirePermission(menu = "OVERRIDE_LEDGER", perm = "READ") @RequirePermission(menu = "OVERRIDE_LEDGER", perm = "READ")
public ApiResponse<PageResponse<OverrideLedgerResp>> list(@ModelAttribute OverrideLedgerSearchParam param) { public ApiResponse<PageResponse<OverrideLedgerResp>> list(@ModelAttribute OverrideLedgerSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 오버라이드 원장 단건 상세. 권한: OVERRIDE_LEDGER READ. */
@GetMapping("/{ledgerId}") @GetMapping("/{ledgerId}")
@RequirePermission(menu = "OVERRIDE_LEDGER", perm = "READ") @RequirePermission(menu = "OVERRIDE_LEDGER", perm = "READ")
public ApiResponse<OverrideLedgerResp> detail(@PathVariable Long ledgerId) { public ApiResponse<OverrideLedgerResp> detail(@PathVariable Long ledgerId) {
return ApiResponse.ok(service.detail(ledgerId)); return ApiResponse.ok(service.detail(ledgerId));
} }
/** 오버라이드 집계 목록(수령자별 합계 등). 권한: OVERRIDE_LEDGER READ. */
@GetMapping("/summary") @GetMapping("/summary")
@RequirePermission(menu = "OVERRIDE_LEDGER", perm = "READ") @RequirePermission(menu = "OVERRIDE_LEDGER", perm = "READ")
public ApiResponse<List<OverrideSummaryResp>> summaryList(@ModelAttribute OverrideSummarySearchParam param) { public ApiResponse<List<OverrideSummaryResp>> summaryList(@ModelAttribute OverrideSummarySearchParam param) {
return ApiResponse.ok(service.summaryList(param)); return ApiResponse.ok(service.summaryList(param));
} }
/** 특정 수령자(toAgentId)의 특정 정산월(settleMonth) 오버라이드 합계. 권한: OVERRIDE_LEDGER READ. */
@GetMapping("/summary/by-agent") @GetMapping("/summary/by-agent")
@RequirePermission(menu = "OVERRIDE_LEDGER", perm = "READ") @RequirePermission(menu = "OVERRIDE_LEDGER", perm = "READ")
public ApiResponse<OverrideSummaryResp> summaryByAgent(@RequestParam Long toAgentId, public ApiResponse<OverrideSummaryResp> summaryByAgent(@RequestParam Long toAgentId,
@@ -11,6 +11,15 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 유지보너스(유지보수수당) API.
*
* 유지율 보너스(persistency bonus): 계약이 일정 기간(: 13회차/25회차)까지 해지 없이 "유지"되면
* 유지 성과에 대해 설계사에게 지급하는 보너스. 유지율이 높을수록 보너스가 커진다.
* - Rule(보너스 규칙) CRUD - Bonus(보너스 산출 내역): upsert(있으면 갱신, 없으면 생성) 등록.
*
* 권한: @RequirePermission(menu="PERSIST_BONUS"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "유지보수수당") @Tag(name = "유지보수수당")
@RestController @RestController
@RequestMapping("/api/persistency-bonus") @RequestMapping("/api/persistency-bonus")
@@ -19,6 +28,7 @@ public class PersistencyBonusController {
private final PersistencyBonusService service; private final PersistencyBonusService service;
/** 유지보너스 규칙 목록 조회. 권한: PERSIST_BONUS READ. */
@GetMapping("/rules") @GetMapping("/rules")
@RequirePermission(menu = "PERSIST_BONUS", perm = "READ") @RequirePermission(menu = "PERSIST_BONUS", perm = "READ")
public ApiResponse<PageResponse<PersistencyBonusRuleResp>> listRules( public ApiResponse<PageResponse<PersistencyBonusRuleResp>> listRules(
@@ -26,12 +36,14 @@ public class PersistencyBonusController {
return ApiResponse.ok(service.listRules(param)); return ApiResponse.ok(service.listRules(param));
} }
/** 유지보너스 규칙 단건 상세. 권한: PERSIST_BONUS READ. */
@GetMapping("/rules/{ruleId}") @GetMapping("/rules/{ruleId}")
@RequirePermission(menu = "PERSIST_BONUS", perm = "READ") @RequirePermission(menu = "PERSIST_BONUS", perm = "READ")
public ApiResponse<PersistencyBonusRuleResp> detailRule(@PathVariable Long ruleId) { public ApiResponse<PersistencyBonusRuleResp> detailRule(@PathVariable Long ruleId) {
return ApiResponse.ok(service.detailRule(ruleId)); return ApiResponse.ok(service.detailRule(ruleId));
} }
/** 유지보너스 규칙 신규 등록. 응답: ruleId. 권한: PERSIST_BONUS CREATE. */
@PostMapping("/rules") @PostMapping("/rules")
@RequirePermission(menu = "PERSIST_BONUS", perm = "CREATE") @RequirePermission(menu = "PERSIST_BONUS", perm = "CREATE")
@DataChangeLog(menu = "PERSIST_BONUS", table = "persistency_bonus_rule") @DataChangeLog(menu = "PERSIST_BONUS", table = "persistency_bonus_rule")
@@ -39,6 +51,7 @@ public class PersistencyBonusController {
return ApiResponse.ok(service.createRule(req)); return ApiResponse.ok(service.createRule(req));
} }
/** 유지보너스 규칙 수정. 권한: PERSIST_BONUS UPDATE. */
@PutMapping("/rules/{ruleId}") @PutMapping("/rules/{ruleId}")
@RequirePermission(menu = "PERSIST_BONUS", perm = "UPDATE") @RequirePermission(menu = "PERSIST_BONUS", perm = "UPDATE")
@DataChangeLog(menu = "PERSIST_BONUS", table = "persistency_bonus_rule") @DataChangeLog(menu = "PERSIST_BONUS", table = "persistency_bonus_rule")
@@ -48,6 +61,7 @@ public class PersistencyBonusController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 유지보너스 규칙 삭제. 권한: PERSIST_BONUS DELETE. */
@DeleteMapping("/rules/{ruleId}") @DeleteMapping("/rules/{ruleId}")
@RequirePermission(menu = "PERSIST_BONUS", perm = "DELETE") @RequirePermission(menu = "PERSIST_BONUS", perm = "DELETE")
@DataChangeLog(menu = "PERSIST_BONUS", table = "persistency_bonus_rule") @DataChangeLog(menu = "PERSIST_BONUS", table = "persistency_bonus_rule")
@@ -56,6 +70,7 @@ public class PersistencyBonusController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 유지보너스 산출 내역 목록 조회. 권한: PERSIST_BONUS READ. */
@GetMapping("/bonuses") @GetMapping("/bonuses")
@RequirePermission(menu = "PERSIST_BONUS", perm = "READ") @RequirePermission(menu = "PERSIST_BONUS", perm = "READ")
public ApiResponse<PageResponse<PersistencyBonusResp>> listBonuses( public ApiResponse<PageResponse<PersistencyBonusResp>> listBonuses(
@@ -63,12 +78,14 @@ public class PersistencyBonusController {
return ApiResponse.ok(service.listBonuses(param)); return ApiResponse.ok(service.listBonuses(param));
} }
/** 유지보너스 산출 내역 단건 상세. 권한: PERSIST_BONUS READ. */
@GetMapping("/bonuses/{bonusId}") @GetMapping("/bonuses/{bonusId}")
@RequirePermission(menu = "PERSIST_BONUS", perm = "READ") @RequirePermission(menu = "PERSIST_BONUS", perm = "READ")
public ApiResponse<PersistencyBonusResp> detailBonus(@PathVariable Long bonusId) { public ApiResponse<PersistencyBonusResp> detailBonus(@PathVariable Long bonusId) {
return ApiResponse.ok(service.detailBonus(bonusId)); return ApiResponse.ok(service.detailBonus(bonusId));
} }
/** 유지보너스 산출 내역 upsert(동일 키가 있으면 갱신, 없으면 신규 생성). 권한: PERSIST_BONUS CREATE. */
@PostMapping("/bonuses") @PostMapping("/bonuses")
@RequirePermission(menu = "PERSIST_BONUS", perm = "CREATE") @RequirePermission(menu = "PERSIST_BONUS", perm = "CREATE")
@DataChangeLog(menu = "PERSIST_BONUS", table = "persistency_bonus") @DataChangeLog(menu = "PERSIST_BONUS", table = "persistency_bonus")
@@ -11,6 +11,16 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 인정실적 API.
*
* 인정실적(recognized performance): 실제 보험료를 그대로 실적으로 보지 않고, 상품 종류에 따른
* 환산율(product conversion rate) 곱해 "회사가 인정해 주는 실적"으로 환산한 .
* (: 보장성 100%, 저축성 30% . 같은 보험료라도 상품에 따라 인정실적이 달라진다.)
* - rates(환산율 규칙) CRUD - ledgers(인정실적 원장) 조회/등록.
*
* 권한: @RequirePermission(menu="RECOGNIZED_PERF"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "인정실적") @Tag(name = "인정실적")
@RestController @RestController
@RequestMapping("/api/recognized-performances") @RequestMapping("/api/recognized-performances")
@@ -19,8 +29,9 @@ public class RecognizedPerformanceController {
private final RecognizedPerformanceService service; private final RecognizedPerformanceService service;
// Product Conversion Rate (rule) // Product Conversion Rate (상품 환산율 규칙)
/** 상품 환산율 목록 조회. 권한: RECOGNIZED_PERF READ. */
@GetMapping("/rates") @GetMapping("/rates")
@RequirePermission(menu = "RECOGNIZED_PERF", perm = "READ") @RequirePermission(menu = "RECOGNIZED_PERF", perm = "READ")
public ApiResponse<PageResponse<ProductConversionRateResp>> listRates( public ApiResponse<PageResponse<ProductConversionRateResp>> listRates(
@@ -28,12 +39,14 @@ public class RecognizedPerformanceController {
return ApiResponse.ok(service.listRates(param)); return ApiResponse.ok(service.listRates(param));
} }
/** 상품 환산율 단건 상세. 권한: RECOGNIZED_PERF READ. */
@GetMapping("/rates/{rateId}") @GetMapping("/rates/{rateId}")
@RequirePermission(menu = "RECOGNIZED_PERF", perm = "READ") @RequirePermission(menu = "RECOGNIZED_PERF", perm = "READ")
public ApiResponse<ProductConversionRateResp> detailRate(@PathVariable Long rateId) { public ApiResponse<ProductConversionRateResp> detailRate(@PathVariable Long rateId) {
return ApiResponse.ok(service.detailRate(rateId)); return ApiResponse.ok(service.detailRate(rateId));
} }
/** 상품 환산율 신규 등록. 응답: rateId. 권한: RECOGNIZED_PERF CREATE. */
@PostMapping("/rates") @PostMapping("/rates")
@RequirePermission(menu = "RECOGNIZED_PERF", perm = "CREATE") @RequirePermission(menu = "RECOGNIZED_PERF", perm = "CREATE")
@DataChangeLog(menu = "RECOGNIZED_PERF", table = "product_conversion_rate") @DataChangeLog(menu = "RECOGNIZED_PERF", table = "product_conversion_rate")
@@ -41,6 +54,7 @@ public class RecognizedPerformanceController {
return ApiResponse.ok(service.createRate(req)); return ApiResponse.ok(service.createRate(req));
} }
/** 상품 환산율 수정. 권한: RECOGNIZED_PERF UPDATE. */
@PutMapping("/rates/{rateId}") @PutMapping("/rates/{rateId}")
@RequirePermission(menu = "RECOGNIZED_PERF", perm = "UPDATE") @RequirePermission(menu = "RECOGNIZED_PERF", perm = "UPDATE")
@DataChangeLog(menu = "RECOGNIZED_PERF", table = "product_conversion_rate") @DataChangeLog(menu = "RECOGNIZED_PERF", table = "product_conversion_rate")
@@ -50,6 +64,7 @@ public class RecognizedPerformanceController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 상품 환산율 삭제. 권한: RECOGNIZED_PERF DELETE. */
@DeleteMapping("/rates/{rateId}") @DeleteMapping("/rates/{rateId}")
@RequirePermission(menu = "RECOGNIZED_PERF", perm = "DELETE") @RequirePermission(menu = "RECOGNIZED_PERF", perm = "DELETE")
@DataChangeLog(menu = "RECOGNIZED_PERF", table = "product_conversion_rate") @DataChangeLog(menu = "RECOGNIZED_PERF", table = "product_conversion_rate")
@@ -58,8 +73,9 @@ public class RecognizedPerformanceController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
// Ledger // Ledger (인정실적 원장)
/** 인정실적 원장 목록 조회. 권한: RECOGNIZED_PERF READ. */
@GetMapping("/ledgers") @GetMapping("/ledgers")
@RequirePermission(menu = "RECOGNIZED_PERF", perm = "READ") @RequirePermission(menu = "RECOGNIZED_PERF", perm = "READ")
public ApiResponse<PageResponse<RecognizedPerformanceLedgerResp>> listLedgers( public ApiResponse<PageResponse<RecognizedPerformanceLedgerResp>> listLedgers(
@@ -67,12 +83,14 @@ public class RecognizedPerformanceController {
return ApiResponse.ok(service.listLedgers(param)); return ApiResponse.ok(service.listLedgers(param));
} }
/** 인정실적 원장 단건 상세. 권한: RECOGNIZED_PERF READ. */
@GetMapping("/ledgers/{ledgerId}") @GetMapping("/ledgers/{ledgerId}")
@RequirePermission(menu = "RECOGNIZED_PERF", perm = "READ") @RequirePermission(menu = "RECOGNIZED_PERF", perm = "READ")
public ApiResponse<RecognizedPerformanceLedgerResp> detailLedger(@PathVariable Long ledgerId) { public ApiResponse<RecognizedPerformanceLedgerResp> detailLedger(@PathVariable Long ledgerId) {
return ApiResponse.ok(service.detailLedger(ledgerId)); return ApiResponse.ok(service.detailLedger(ledgerId));
} }
/** 인정실적 원장 신규 등록(환산율 적용해 인정실적 산출). 응답: ledgerId. 권한: RECOGNIZED_PERF CREATE. */
@PostMapping("/ledgers") @PostMapping("/ledgers")
@RequirePermission(menu = "RECOGNIZED_PERF", perm = "CREATE") @RequirePermission(menu = "RECOGNIZED_PERF", perm = "CREATE")
@DataChangeLog(menu = "RECOGNIZED_PERF", table = "recognized_performance_ledger") @DataChangeLog(menu = "RECOGNIZED_PERF", table = "recognized_performance_ledger")
@@ -0,0 +1,99 @@
package com.ga.api.controller.commission;
import com.ga.api.service.commission.RecruiterCommissionService;
import com.ga.common.annotation.DataChangeLog;
import com.ga.common.annotation.RequirePermission;
import com.ga.common.model.ApiResponse;
import com.ga.common.model.PageResponse;
import com.ga.core.vo.commission.*;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;
/**
* 도입수수료 API.
*
* 도입수수료(recruiter commission): 설계사를 회사에 데려온(도입/리크루팅) 사람에게 지급하는 수수료.
* 도입한 설계사가 실적을 내면, 실적에 연동해 도입자에게도 일정 수수료가 발생한다.
* - Rule(도입수수료 규칙) CRUD - Ledger(도입수수료 원장) 조회/등록.
*
* 권한: @RequirePermission(menu="RECRUITER_COMM"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "도입수수료")
@RestController
@RequestMapping("/api/recruiter-commissions")
@RequiredArgsConstructor
public class RecruiterCommissionController {
private final RecruiterCommissionService service;
// Rule (도입수수료 규칙)
/** 도입수수료 규칙 목록 조회. 권한: RECRUITER_COMM READ. */
@GetMapping("/rules")
@RequirePermission(menu = "RECRUITER_COMM", perm = "READ")
public ApiResponse<PageResponse<RecruiterCommissionRuleResp>> listRules(
@ModelAttribute RecruiterCommissionRuleSearchParam param) {
return ApiResponse.ok(service.listRules(param));
}
/** 도입수수료 규칙 단건 상세. 권한: RECRUITER_COMM READ. */
@GetMapping("/rules/{ruleId}")
@RequirePermission(menu = "RECRUITER_COMM", perm = "READ")
public ApiResponse<RecruiterCommissionRuleResp> detailRule(@PathVariable Long ruleId) {
return ApiResponse.ok(service.detailRule(ruleId));
}
/** 도입수수료 규칙 신규 등록. 응답: ruleId. 권한: RECRUITER_COMM CREATE. */
@PostMapping("/rules")
@RequirePermission(menu = "RECRUITER_COMM", perm = "CREATE")
@DataChangeLog(menu = "RECRUITER_COMM", table = "recruiter_commission_rule")
public ApiResponse<Long> createRule(@Valid @RequestBody RecruiterCommissionRuleSaveReq req) {
return ApiResponse.ok(service.createRule(req));
}
/** 도입수수료 규칙 수정. 권한: RECRUITER_COMM UPDATE. */
@PutMapping("/rules/{ruleId}")
@RequirePermission(menu = "RECRUITER_COMM", perm = "UPDATE")
@DataChangeLog(menu = "RECRUITER_COMM", table = "recruiter_commission_rule")
public ApiResponse<Void> updateRule(@PathVariable Long ruleId,
@Valid @RequestBody RecruiterCommissionRuleSaveReq req) {
service.updateRule(ruleId, req);
return ApiResponse.ok();
}
/** 도입수수료 규칙 삭제. 권한: RECRUITER_COMM DELETE. */
@DeleteMapping("/rules/{ruleId}")
@RequirePermission(menu = "RECRUITER_COMM", perm = "DELETE")
@DataChangeLog(menu = "RECRUITER_COMM", table = "recruiter_commission_rule")
public ApiResponse<Void> deleteRule(@PathVariable Long ruleId) {
service.deleteRule(ruleId);
return ApiResponse.ok();
}
// Ledger (도입수수료 원장)
/** 도입수수료 원장 목록 조회. 권한: RECRUITER_COMM READ. */
@GetMapping("/ledgers")
@RequirePermission(menu = "RECRUITER_COMM", perm = "READ")
public ApiResponse<PageResponse<RecruiterCommissionLedgerResp>> listLedgers(
@ModelAttribute RecruiterCommissionLedgerSearchParam param) {
return ApiResponse.ok(service.listLedgers(param));
}
/** 도입수수료 원장 단건 상세. 권한: RECRUITER_COMM READ. */
@GetMapping("/ledgers/{ledgerId}")
@RequirePermission(menu = "RECRUITER_COMM", perm = "READ")
public ApiResponse<RecruiterCommissionLedgerResp> detailLedger(@PathVariable Long ledgerId) {
return ApiResponse.ok(service.detailLedger(ledgerId));
}
/** 도입수수료 원장 신규 등록. 응답: ledgerId. 권한: RECRUITER_COMM CREATE. */
@PostMapping("/ledgers")
@RequirePermission(menu = "RECRUITER_COMM", perm = "CREATE")
@DataChangeLog(menu = "RECRUITER_COMM", table = "recruiter_commission_ledger")
public ApiResponse<Long> createLedger(@Valid @RequestBody RecruiterCommissionLedgerSaveReq req) {
return ApiResponse.ok(service.createLedger(req));
}
}
@@ -11,6 +11,15 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 소개·이관수수료 API.
*
* 소개수수료(referral commission): 고객이나 계약을 다른 설계사에게 "소개·이관" 사람에게 지급하는 수수료.
* 소개 받은 설계사가 계약을 성사시키면, 소개해 사람에게 규칙(Rule) 따라 정액(FIXED) 또는 정률(RATE) 지급한다.
* - Rule(소개수수료 규칙) CRUD - Ledger(소개수수료 원장) 조회/등록.
*
* 권한: @RequirePermission(menu="REFERRAL_COMM"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "소개·이관수수료") @Tag(name = "소개·이관수수료")
@RestController @RestController
@RequestMapping("/api/referral-commissions") @RequestMapping("/api/referral-commissions")
@@ -19,8 +28,9 @@ public class ReferralCommissionController {
private final ReferralCommissionService service; private final ReferralCommissionService service;
// Rule // Rule (소개수수료 규칙)
/** 소개수수료 규칙 목록 조회. 권한: REFERRAL_COMM READ. */
@GetMapping("/rules") @GetMapping("/rules")
@RequirePermission(menu = "REFERRAL_COMM", perm = "READ") @RequirePermission(menu = "REFERRAL_COMM", perm = "READ")
public ApiResponse<PageResponse<ReferralCommissionRuleResp>> listRules( public ApiResponse<PageResponse<ReferralCommissionRuleResp>> listRules(
@@ -28,12 +38,14 @@ public class ReferralCommissionController {
return ApiResponse.ok(service.listRules(param)); return ApiResponse.ok(service.listRules(param));
} }
/** 소개수수료 규칙 단건 상세. 권한: REFERRAL_COMM READ. */
@GetMapping("/rules/{ruleId}") @GetMapping("/rules/{ruleId}")
@RequirePermission(menu = "REFERRAL_COMM", perm = "READ") @RequirePermission(menu = "REFERRAL_COMM", perm = "READ")
public ApiResponse<ReferralCommissionRuleResp> detailRule(@PathVariable Long ruleId) { public ApiResponse<ReferralCommissionRuleResp> detailRule(@PathVariable Long ruleId) {
return ApiResponse.ok(service.detailRule(ruleId)); return ApiResponse.ok(service.detailRule(ruleId));
} }
/** 소개수수료 규칙 신규 등록. 응답: ruleId. 권한: REFERRAL_COMM CREATE. */
@PostMapping("/rules") @PostMapping("/rules")
@RequirePermission(menu = "REFERRAL_COMM", perm = "CREATE") @RequirePermission(menu = "REFERRAL_COMM", perm = "CREATE")
@DataChangeLog(menu = "REFERRAL_COMM", table = "referral_commission_rule") @DataChangeLog(menu = "REFERRAL_COMM", table = "referral_commission_rule")
@@ -41,6 +53,7 @@ public class ReferralCommissionController {
return ApiResponse.ok(service.createRule(req)); return ApiResponse.ok(service.createRule(req));
} }
/** 소개수수료 규칙 수정. 권한: REFERRAL_COMM UPDATE. */
@PutMapping("/rules/{ruleId}") @PutMapping("/rules/{ruleId}")
@RequirePermission(menu = "REFERRAL_COMM", perm = "UPDATE") @RequirePermission(menu = "REFERRAL_COMM", perm = "UPDATE")
@DataChangeLog(menu = "REFERRAL_COMM", table = "referral_commission_rule") @DataChangeLog(menu = "REFERRAL_COMM", table = "referral_commission_rule")
@@ -50,6 +63,7 @@ public class ReferralCommissionController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 소개수수료 규칙 삭제. 권한: REFERRAL_COMM DELETE. */
@DeleteMapping("/rules/{ruleId}") @DeleteMapping("/rules/{ruleId}")
@RequirePermission(menu = "REFERRAL_COMM", perm = "DELETE") @RequirePermission(menu = "REFERRAL_COMM", perm = "DELETE")
@DataChangeLog(menu = "REFERRAL_COMM", table = "referral_commission_rule") @DataChangeLog(menu = "REFERRAL_COMM", table = "referral_commission_rule")
@@ -58,8 +72,9 @@ public class ReferralCommissionController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
// Ledger // Ledger (소개수수료 원장)
/** 소개수수료 원장 목록 조회. 권한: REFERRAL_COMM READ. */
@GetMapping("/ledgers") @GetMapping("/ledgers")
@RequirePermission(menu = "REFERRAL_COMM", perm = "READ") @RequirePermission(menu = "REFERRAL_COMM", perm = "READ")
public ApiResponse<PageResponse<ReferralCommissionLedgerResp>> listLedgers( public ApiResponse<PageResponse<ReferralCommissionLedgerResp>> listLedgers(
@@ -67,12 +82,14 @@ public class ReferralCommissionController {
return ApiResponse.ok(service.listLedgers(param)); return ApiResponse.ok(service.listLedgers(param));
} }
/** 소개수수료 원장 단건 상세. 권한: REFERRAL_COMM READ. */
@GetMapping("/ledgers/{ledgerId}") @GetMapping("/ledgers/{ledgerId}")
@RequirePermission(menu = "REFERRAL_COMM", perm = "READ") @RequirePermission(menu = "REFERRAL_COMM", perm = "READ")
public ApiResponse<ReferralCommissionLedgerResp> detailLedger(@PathVariable Long ledgerId) { public ApiResponse<ReferralCommissionLedgerResp> detailLedger(@PathVariable Long ledgerId) {
return ApiResponse.ok(service.detailLedger(ledgerId)); return ApiResponse.ok(service.detailLedger(ledgerId));
} }
/** 소개수수료 원장 신규 등록. 응답: ledgerId. 권한: REFERRAL_COMM CREATE. */
@PostMapping("/ledgers") @PostMapping("/ledgers")
@RequirePermission(menu = "REFERRAL_COMM", perm = "CREATE") @RequirePermission(menu = "REFERRAL_COMM", perm = "CREATE")
@DataChangeLog(menu = "REFERRAL_COMM", table = "referral_commission_ledger") @DataChangeLog(menu = "REFERRAL_COMM", table = "referral_commission_ledger")
@@ -11,6 +11,15 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 부활수수료 API.
*
* 부활(reinstatement): 실효(보험료 미납 등으로 효력 정지)됐던 계약이 밀린 보험료 납입 등으로 다시 살아나는 .
* 부활수수료: 계약을 부활시킨 설계사에게 규칙(Rule) 따라 지급하는 수수료.
* - Rule(부활수수료 규칙) CRUD - Ledger(부활수수료 원장) 조회/등록.
*
* 권한: @RequirePermission(menu="REINSTATE_COMM"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "부활수수료") @Tag(name = "부활수수료")
@RestController @RestController
@RequestMapping("/api/reinstatement-commissions") @RequestMapping("/api/reinstatement-commissions")
@@ -19,6 +28,7 @@ public class ReinstatementCommissionController {
private final ReinstatementCommissionService service; private final ReinstatementCommissionService service;
/** 부활수수료 규칙 목록 조회. 권한: REINSTATE_COMM READ. */
@GetMapping("/rules") @GetMapping("/rules")
@RequirePermission(menu = "REINSTATE_COMM", perm = "READ") @RequirePermission(menu = "REINSTATE_COMM", perm = "READ")
public ApiResponse<PageResponse<ReinstatementCommissionRuleResp>> listRules( public ApiResponse<PageResponse<ReinstatementCommissionRuleResp>> listRules(
@@ -26,12 +36,14 @@ public class ReinstatementCommissionController {
return ApiResponse.ok(service.listRules(param)); return ApiResponse.ok(service.listRules(param));
} }
/** 부활수수료 규칙 단건 상세. 권한: REINSTATE_COMM READ. */
@GetMapping("/rules/{ruleId}") @GetMapping("/rules/{ruleId}")
@RequirePermission(menu = "REINSTATE_COMM", perm = "READ") @RequirePermission(menu = "REINSTATE_COMM", perm = "READ")
public ApiResponse<ReinstatementCommissionRuleResp> detailRule(@PathVariable Long ruleId) { public ApiResponse<ReinstatementCommissionRuleResp> detailRule(@PathVariable Long ruleId) {
return ApiResponse.ok(service.detailRule(ruleId)); return ApiResponse.ok(service.detailRule(ruleId));
} }
/** 부활수수료 규칙 신규 등록. 응답: ruleId. 권한: REINSTATE_COMM CREATE. */
@PostMapping("/rules") @PostMapping("/rules")
@RequirePermission(menu = "REINSTATE_COMM", perm = "CREATE") @RequirePermission(menu = "REINSTATE_COMM", perm = "CREATE")
@DataChangeLog(menu = "REINSTATE_COMM", table = "reinstatement_commission_rule") @DataChangeLog(menu = "REINSTATE_COMM", table = "reinstatement_commission_rule")
@@ -39,6 +51,7 @@ public class ReinstatementCommissionController {
return ApiResponse.ok(service.createRule(req)); return ApiResponse.ok(service.createRule(req));
} }
/** 부활수수료 규칙 수정. 권한: REINSTATE_COMM UPDATE. */
@PutMapping("/rules/{ruleId}") @PutMapping("/rules/{ruleId}")
@RequirePermission(menu = "REINSTATE_COMM", perm = "UPDATE") @RequirePermission(menu = "REINSTATE_COMM", perm = "UPDATE")
@DataChangeLog(menu = "REINSTATE_COMM", table = "reinstatement_commission_rule") @DataChangeLog(menu = "REINSTATE_COMM", table = "reinstatement_commission_rule")
@@ -48,6 +61,7 @@ public class ReinstatementCommissionController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 부활수수료 규칙 삭제. 권한: REINSTATE_COMM DELETE. */
@DeleteMapping("/rules/{ruleId}") @DeleteMapping("/rules/{ruleId}")
@RequirePermission(menu = "REINSTATE_COMM", perm = "DELETE") @RequirePermission(menu = "REINSTATE_COMM", perm = "DELETE")
@DataChangeLog(menu = "REINSTATE_COMM", table = "reinstatement_commission_rule") @DataChangeLog(menu = "REINSTATE_COMM", table = "reinstatement_commission_rule")
@@ -56,6 +70,7 @@ public class ReinstatementCommissionController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 부활수수료 원장 목록 조회. 권한: REINSTATE_COMM READ. */
@GetMapping("/ledgers") @GetMapping("/ledgers")
@RequirePermission(menu = "REINSTATE_COMM", perm = "READ") @RequirePermission(menu = "REINSTATE_COMM", perm = "READ")
public ApiResponse<PageResponse<ReinstatementCommissionLedgerResp>> listLedgers( public ApiResponse<PageResponse<ReinstatementCommissionLedgerResp>> listLedgers(
@@ -63,12 +78,14 @@ public class ReinstatementCommissionController {
return ApiResponse.ok(service.listLedgers(param)); return ApiResponse.ok(service.listLedgers(param));
} }
/** 부활수수료 원장 단건 상세. 권한: REINSTATE_COMM READ. */
@GetMapping("/ledgers/{ledgerId}") @GetMapping("/ledgers/{ledgerId}")
@RequirePermission(menu = "REINSTATE_COMM", perm = "READ") @RequirePermission(menu = "REINSTATE_COMM", perm = "READ")
public ApiResponse<ReinstatementCommissionLedgerResp> detailLedger(@PathVariable Long ledgerId) { public ApiResponse<ReinstatementCommissionLedgerResp> detailLedger(@PathVariable Long ledgerId) {
return ApiResponse.ok(service.detailLedger(ledgerId)); return ApiResponse.ok(service.detailLedger(ledgerId));
} }
/** 부활수수료 원장 신규 등록. 응답: ledgerId. 권한: REINSTATE_COMM CREATE. */
@PostMapping("/ledgers") @PostMapping("/ledgers")
@RequirePermission(menu = "REINSTATE_COMM", perm = "CREATE") @RequirePermission(menu = "REINSTATE_COMM", perm = "CREATE")
@DataChangeLog(menu = "REINSTATE_COMM", table = "reinstatement_commission_ledger") @DataChangeLog(menu = "REINSTATE_COMM", table = "reinstatement_commission_ledger")
@@ -11,6 +11,15 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 갱신수수료 API.
*
* 갱신(renewal): 보험 기간이 끝난 계약을 같은 조건으로 다시 이어가는 (: 1년 갱신형 보험).
* 갱신수수료: 계약이 갱신될 유지·관리 대가로 설계사에게 지급하는 수수료.
* - Rule(갱신수수료 규칙) CRUD - Ledger(갱신수수료 원장) 조회/등록.
*
* 권한: @RequirePermission(menu="RENEWAL_COMM"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "갱신수수료") @Tag(name = "갱신수수료")
@RestController @RestController
@RequestMapping("/api/renewal-commissions") @RequestMapping("/api/renewal-commissions")
@@ -19,6 +28,7 @@ public class RenewalCommissionController {
private final RenewalCommissionService service; private final RenewalCommissionService service;
/** 갱신수수료 규칙 목록 조회. 권한: RENEWAL_COMM READ. */
@GetMapping("/rules") @GetMapping("/rules")
@RequirePermission(menu = "RENEWAL_COMM", perm = "READ") @RequirePermission(menu = "RENEWAL_COMM", perm = "READ")
public ApiResponse<PageResponse<RenewalCommissionRuleResp>> listRules( public ApiResponse<PageResponse<RenewalCommissionRuleResp>> listRules(
@@ -26,12 +36,14 @@ public class RenewalCommissionController {
return ApiResponse.ok(service.listRules(param)); return ApiResponse.ok(service.listRules(param));
} }
/** 갱신수수료 규칙 단건 상세. 권한: RENEWAL_COMM READ. */
@GetMapping("/rules/{ruleId}") @GetMapping("/rules/{ruleId}")
@RequirePermission(menu = "RENEWAL_COMM", perm = "READ") @RequirePermission(menu = "RENEWAL_COMM", perm = "READ")
public ApiResponse<RenewalCommissionRuleResp> detailRule(@PathVariable Long ruleId) { public ApiResponse<RenewalCommissionRuleResp> detailRule(@PathVariable Long ruleId) {
return ApiResponse.ok(service.detailRule(ruleId)); return ApiResponse.ok(service.detailRule(ruleId));
} }
/** 갱신수수료 규칙 신규 등록. 응답: ruleId. 권한: RENEWAL_COMM CREATE. */
@PostMapping("/rules") @PostMapping("/rules")
@RequirePermission(menu = "RENEWAL_COMM", perm = "CREATE") @RequirePermission(menu = "RENEWAL_COMM", perm = "CREATE")
@DataChangeLog(menu = "RENEWAL_COMM", table = "renewal_commission_rule") @DataChangeLog(menu = "RENEWAL_COMM", table = "renewal_commission_rule")
@@ -39,6 +51,7 @@ public class RenewalCommissionController {
return ApiResponse.ok(service.createRule(req)); return ApiResponse.ok(service.createRule(req));
} }
/** 갱신수수료 규칙 수정. 권한: RENEWAL_COMM UPDATE. */
@PutMapping("/rules/{ruleId}") @PutMapping("/rules/{ruleId}")
@RequirePermission(menu = "RENEWAL_COMM", perm = "UPDATE") @RequirePermission(menu = "RENEWAL_COMM", perm = "UPDATE")
@DataChangeLog(menu = "RENEWAL_COMM", table = "renewal_commission_rule") @DataChangeLog(menu = "RENEWAL_COMM", table = "renewal_commission_rule")
@@ -48,6 +61,7 @@ public class RenewalCommissionController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 갱신수수료 규칙 삭제. 권한: RENEWAL_COMM DELETE. */
@DeleteMapping("/rules/{ruleId}") @DeleteMapping("/rules/{ruleId}")
@RequirePermission(menu = "RENEWAL_COMM", perm = "DELETE") @RequirePermission(menu = "RENEWAL_COMM", perm = "DELETE")
@DataChangeLog(menu = "RENEWAL_COMM", table = "renewal_commission_rule") @DataChangeLog(menu = "RENEWAL_COMM", table = "renewal_commission_rule")
@@ -56,6 +70,7 @@ public class RenewalCommissionController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 갱신수수료 원장 목록 조회. 권한: RENEWAL_COMM READ. */
@GetMapping("/ledgers") @GetMapping("/ledgers")
@RequirePermission(menu = "RENEWAL_COMM", perm = "READ") @RequirePermission(menu = "RENEWAL_COMM", perm = "READ")
public ApiResponse<PageResponse<RenewalCommissionLedgerResp>> listLedgers( public ApiResponse<PageResponse<RenewalCommissionLedgerResp>> listLedgers(
@@ -63,12 +78,14 @@ public class RenewalCommissionController {
return ApiResponse.ok(service.listLedgers(param)); return ApiResponse.ok(service.listLedgers(param));
} }
/** 갱신수수료 원장 단건 상세. 권한: RENEWAL_COMM READ. */
@GetMapping("/ledgers/{ledgerId}") @GetMapping("/ledgers/{ledgerId}")
@RequirePermission(menu = "RENEWAL_COMM", perm = "READ") @RequirePermission(menu = "RENEWAL_COMM", perm = "READ")
public ApiResponse<RenewalCommissionLedgerResp> detailLedger(@PathVariable Long ledgerId) { public ApiResponse<RenewalCommissionLedgerResp> detailLedger(@PathVariable Long ledgerId) {
return ApiResponse.ok(service.detailLedger(ledgerId)); return ApiResponse.ok(service.detailLedger(ledgerId));
} }
/** 갱신수수료 원장 신규 등록. 응답: ledgerId. 권한: RENEWAL_COMM CREATE. */
@PostMapping("/ledgers") @PostMapping("/ledgers")
@RequirePermission(menu = "RENEWAL_COMM", perm = "CREATE") @RequirePermission(menu = "RENEWAL_COMM", perm = "CREATE")
@DataChangeLog(menu = "RENEWAL_COMM", table = "renewal_commission_ledger") @DataChangeLog(menu = "RENEWAL_COMM", table = "renewal_commission_ledger")
@@ -13,6 +13,14 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 적립금 API.
*
* 적립금(reserve fund): 향후 발생할 있는 환수 등에 대비해, 설계사 수수료 일부를 떼어 모아 두는 .
* 환수가 생기면 적립금에서 우선 충당할 있다. 설계사별 적립 내역을 관리한다.
*
* 권한: @RequirePermission(menu="RESERVE_FUND"), perm=READ/CREATE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "적립금") @Tag(name = "적립금")
@RestController @RestController
@RequestMapping("/api/reserve-funds") @RequestMapping("/api/reserve-funds")
@@ -21,18 +29,21 @@ public class ReserveFundController {
private final ReserveFundService service; private final ReserveFundService service;
/** 적립금 내역 목록 조회. 권한: RESERVE_FUND READ. */
@GetMapping @GetMapping
@RequirePermission(menu = "RESERVE_FUND", perm = "READ") @RequirePermission(menu = "RESERVE_FUND", perm = "READ")
public ApiResponse<PageResponse<AgentReserveFundResp>> list(@ModelAttribute AgentReserveFundSearchParam param) { public ApiResponse<PageResponse<AgentReserveFundResp>> list(@ModelAttribute AgentReserveFundSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 적립금 단건 상세. 권한: RESERVE_FUND READ. */
@GetMapping("/{reserveId}") @GetMapping("/{reserveId}")
@RequirePermission(menu = "RESERVE_FUND", perm = "READ") @RequirePermission(menu = "RESERVE_FUND", perm = "READ")
public ApiResponse<AgentReserveFundResp> detail(@PathVariable Long reserveId) { public ApiResponse<AgentReserveFundResp> detail(@PathVariable Long reserveId) {
return ApiResponse.ok(service.detail(reserveId)); return ApiResponse.ok(service.detail(reserveId));
} }
/** 적립금 내역 신규 등록(적립/사용 기록). 응답: reserveId. 권한: RESERVE_FUND CREATE. */
@PostMapping @PostMapping
@RequirePermission(menu = "RESERVE_FUND", perm = "CREATE") @RequirePermission(menu = "RESERVE_FUND", perm = "CREATE")
@DataChangeLog(menu = "RESERVE_FUND", table = "agent_reserve_fund") @DataChangeLog(menu = "RESERVE_FUND", table = "agent_reserve_fund")
@@ -11,6 +11,15 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 정착지원금 API.
*
* 정착지원금(settling support): 새로 들어온 설계사가 안정적으로 자리 잡을 때까지 일정 기간 지급하는 지원금.
* 보통 실적이 충분치 않은 초기 기간 동안 최소 수입을 보전해 준다(조건 미달 환수될 수도 있음).
* - Rule(지원금 규칙) CRUD - Ledger(지원금 원장) 조회/등록.
*
* 권한: @RequirePermission(menu="SETTLING_SUPPORT"), perm=READ/CREATE/UPDATE/DELETE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "정착지원금") @Tag(name = "정착지원금")
@RestController @RestController
@RequestMapping("/api/settling-supports") @RequestMapping("/api/settling-supports")
@@ -19,8 +28,9 @@ public class SettlingSupportController {
private final SettlingSupportService service; private final SettlingSupportService service;
// Rule // Rule (정착지원금 규칙)
/** 정착지원금 규칙 목록 조회. 권한: SETTLING_SUPPORT READ. */
@GetMapping("/rules") @GetMapping("/rules")
@RequirePermission(menu = "SETTLING_SUPPORT", perm = "READ") @RequirePermission(menu = "SETTLING_SUPPORT", perm = "READ")
public ApiResponse<PageResponse<SettlingSupportRuleResp>> listRules( public ApiResponse<PageResponse<SettlingSupportRuleResp>> listRules(
@@ -28,12 +38,14 @@ public class SettlingSupportController {
return ApiResponse.ok(service.listRules(param)); return ApiResponse.ok(service.listRules(param));
} }
/** 정착지원금 규칙 단건 상세. 권한: SETTLING_SUPPORT READ. */
@GetMapping("/rules/{ruleId}") @GetMapping("/rules/{ruleId}")
@RequirePermission(menu = "SETTLING_SUPPORT", perm = "READ") @RequirePermission(menu = "SETTLING_SUPPORT", perm = "READ")
public ApiResponse<SettlingSupportRuleResp> detailRule(@PathVariable Long ruleId) { public ApiResponse<SettlingSupportRuleResp> detailRule(@PathVariable Long ruleId) {
return ApiResponse.ok(service.detailRule(ruleId)); return ApiResponse.ok(service.detailRule(ruleId));
} }
/** 정착지원금 규칙 신규 등록. 응답: ruleId. 권한: SETTLING_SUPPORT CREATE. */
@PostMapping("/rules") @PostMapping("/rules")
@RequirePermission(menu = "SETTLING_SUPPORT", perm = "CREATE") @RequirePermission(menu = "SETTLING_SUPPORT", perm = "CREATE")
@DataChangeLog(menu = "SETTLING_SUPPORT", table = "settling_support_rule") @DataChangeLog(menu = "SETTLING_SUPPORT", table = "settling_support_rule")
@@ -41,6 +53,7 @@ public class SettlingSupportController {
return ApiResponse.ok(service.createRule(req)); return ApiResponse.ok(service.createRule(req));
} }
/** 정착지원금 규칙 수정. 권한: SETTLING_SUPPORT UPDATE. */
@PutMapping("/rules/{ruleId}") @PutMapping("/rules/{ruleId}")
@RequirePermission(menu = "SETTLING_SUPPORT", perm = "UPDATE") @RequirePermission(menu = "SETTLING_SUPPORT", perm = "UPDATE")
@DataChangeLog(menu = "SETTLING_SUPPORT", table = "settling_support_rule") @DataChangeLog(menu = "SETTLING_SUPPORT", table = "settling_support_rule")
@@ -50,6 +63,7 @@ public class SettlingSupportController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 정착지원금 규칙 삭제. 권한: SETTLING_SUPPORT DELETE. */
@DeleteMapping("/rules/{ruleId}") @DeleteMapping("/rules/{ruleId}")
@RequirePermission(menu = "SETTLING_SUPPORT", perm = "DELETE") @RequirePermission(menu = "SETTLING_SUPPORT", perm = "DELETE")
@DataChangeLog(menu = "SETTLING_SUPPORT", table = "settling_support_rule") @DataChangeLog(menu = "SETTLING_SUPPORT", table = "settling_support_rule")
@@ -58,8 +72,9 @@ public class SettlingSupportController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
// Ledger // Ledger (정착지원금 원장)
/** 정착지원금 원장 목록 조회. 권한: SETTLING_SUPPORT READ. */
@GetMapping("/ledgers") @GetMapping("/ledgers")
@RequirePermission(menu = "SETTLING_SUPPORT", perm = "READ") @RequirePermission(menu = "SETTLING_SUPPORT", perm = "READ")
public ApiResponse<PageResponse<SettlingSupportLedgerResp>> listLedgers( public ApiResponse<PageResponse<SettlingSupportLedgerResp>> listLedgers(
@@ -67,12 +82,14 @@ public class SettlingSupportController {
return ApiResponse.ok(service.listLedgers(param)); return ApiResponse.ok(service.listLedgers(param));
} }
/** 정착지원금 원장 단건 상세. 권한: SETTLING_SUPPORT READ. */
@GetMapping("/ledgers/{ledgerId}") @GetMapping("/ledgers/{ledgerId}")
@RequirePermission(menu = "SETTLING_SUPPORT", perm = "READ") @RequirePermission(menu = "SETTLING_SUPPORT", perm = "READ")
public ApiResponse<SettlingSupportLedgerResp> detailLedger(@PathVariable Long ledgerId) { public ApiResponse<SettlingSupportLedgerResp> detailLedger(@PathVariable Long ledgerId) {
return ApiResponse.ok(service.detailLedger(ledgerId)); return ApiResponse.ok(service.detailLedger(ledgerId));
} }
/** 정착지원금 원장 신규 등록. 응답: ledgerId. 권한: SETTLING_SUPPORT CREATE. */
@PostMapping("/ledgers") @PostMapping("/ledgers")
@RequirePermission(menu = "SETTLING_SUPPORT", perm = "CREATE") @RequirePermission(menu = "SETTLING_SUPPORT", perm = "CREATE")
@DataChangeLog(menu = "SETTLING_SUPPORT", table = "settling_support_ledger") @DataChangeLog(menu = "SETTLING_SUPPORT", table = "settling_support_ledger")
@@ -0,0 +1,83 @@
package com.ga.api.controller.commission;
import com.ga.api.service.commission.StatuteService;
import com.ga.common.annotation.DataChangeLog;
import com.ga.common.annotation.RequirePermission;
import com.ga.common.model.ApiResponse;
import com.ga.core.vo.commission.StatuteConfigResp;
import com.ga.core.vo.commission.StatuteConfigSaveReq;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import jakarta.validation.constraints.NotBlank;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;
import java.util.List;
import java.util.Map;
/**
* 환수시효관리 API.
*
* 시효(statute of limitations): 환수채권을 받아낼 있는 법적 기한. 기한이 지나면(시효 만료) 이상 회수할 없어
* 손실(대손) 처리해야 한다. 도메인은 시효 기준 설정(config) 만료 일괄 정리를 담당한다.
*
* 권한: @RequirePermission(menu="STATUTE_CONFIG"), perm=READ/CREATE/UPDATE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "환수시효관리")
@RestController
@RequestMapping("/api/statute")
@RequiredArgsConstructor
public class StatuteController {
private final StatuteService service;
/** 시효 설정 전체 목록 조회. 권한: STATUTE_CONFIG READ. */
@GetMapping
@RequirePermission(menu = "STATUTE_CONFIG", perm = "READ")
public ApiResponse<List<StatuteConfigResp>> list() {
return ApiResponse.ok(service.listConfigs());
}
/** 시효 설정 단건 상세. 권한: STATUTE_CONFIG READ. */
@GetMapping("/{configId}")
@RequirePermission(menu = "STATUTE_CONFIG", perm = "READ")
public ApiResponse<StatuteConfigResp> detail(@PathVariable Long configId) {
return ApiResponse.ok(service.detailConfig(configId));
}
/** 시효 설정 신규 등록. 응답: configId. 권한: STATUTE_CONFIG CREATE. */
@PostMapping
@RequirePermission(menu = "STATUTE_CONFIG", perm = "CREATE")
@DataChangeLog(menu = "STATUTE_CONFIG", table = "statute_config")
public ApiResponse<Long> create(@Valid @RequestBody StatuteConfigSaveReq req) {
return ApiResponse.ok(service.createConfig(req));
}
/** 시효 설정 수정. 권한: STATUTE_CONFIG UPDATE. */
@PutMapping("/{configId}")
@RequirePermission(menu = "STATUTE_CONFIG", perm = "UPDATE")
@DataChangeLog(menu = "STATUTE_CONFIG", table = "statute_config")
public ApiResponse<Void> update(@PathVariable Long configId,
@Valid @RequestBody StatuteConfigSaveReq req) {
service.updateConfig(configId, req);
return ApiResponse.ok();
}
/**
* 만료 대상 환수채권 일괄 대손 처리. 기준월(baseMonth)까지 시효가 지난 환수채권을 한꺼번에 손실 처리하고
* 처리 건수를 반환한다. baseMonth 미지정 현재 정산월을 사용한다.
* Request body: { "baseMonth": "YYYYMM" }
* 권한: STATUTE_CONFIG UPDATE.
*/
@PostMapping("/expire")
@RequirePermission(menu = "STATUTE_CONFIG", perm = "UPDATE")
@DataChangeLog(menu = "STATUTE_CONFIG", table = "clawback_receivable")
public ApiResponse<Integer> expire(@RequestBody Map<String, String> body) {
// baseMonth 비어 있으면 현재 정산월로 대체
String baseMonth = body.get("baseMonth");
if (baseMonth == null || baseMonth.isBlank()) {
baseMonth = com.ga.common.util.DateUtil.getSettleMonth();
}
return ApiResponse.ok(service.expireOverdue(baseMonth));
}
}
@@ -15,6 +15,15 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
/**
* 단계마감 API.
*
* 단계마감(step close): 정산을 여러 단계로 나눠, 단계가 끝나면 "마감"해서 이상 수정 하도록 잠그는 .
* 마감(close) 수정이 필요하면 다시 reopen(마감 해제) 있다. 마감/해제는 승인(APPROVE) 권한이 필요하다.
* - close: 단계 마감(잠금) - reopen: 마감 해제(다시 열기)
*
* 권한: @RequirePermission(menu="STEP_CLOSE"), perm=READ/UPDATE/APPROVE. 변경은 @DataChangeLog 기록.
*/
@Tag(name = "단계마감") @Tag(name = "단계마감")
@RestController @RestController
@RequestMapping("/api/step-closes") @RequestMapping("/api/step-closes")
@@ -23,24 +32,28 @@ public class StepCloseController {
private final StepCloseService service; private final StepCloseService service;
/** 단계마감 목록 조회. 권한: STEP_CLOSE READ. */
@GetMapping @GetMapping
@RequirePermission(menu = "STEP_CLOSE", perm = "READ") @RequirePermission(menu = "STEP_CLOSE", perm = "READ")
public ApiResponse<PageResponse<StepCloseResp>> list(@ModelAttribute StepCloseSearchParam param) { public ApiResponse<PageResponse<StepCloseResp>> list(@ModelAttribute StepCloseSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 특정 정산월(settleMonth)의 단계마감 현황 조회. 권한: STEP_CLOSE READ. */
@GetMapping("/by-month") @GetMapping("/by-month")
@RequirePermission(menu = "STEP_CLOSE", perm = "READ") @RequirePermission(menu = "STEP_CLOSE", perm = "READ")
public ApiResponse<List<StepCloseResp>> listByMonth(@RequestParam String settleMonth) { public ApiResponse<List<StepCloseResp>> listByMonth(@RequestParam String settleMonth) {
return ApiResponse.ok(service.listByMonth(settleMonth)); return ApiResponse.ok(service.listByMonth(settleMonth));
} }
/** 단계마감 단건 상세. 권한: STEP_CLOSE READ. */
@GetMapping("/{stepCloseId}") @GetMapping("/{stepCloseId}")
@RequirePermission(menu = "STEP_CLOSE", perm = "READ") @RequirePermission(menu = "STEP_CLOSE", perm = "READ")
public ApiResponse<StepCloseResp> detail(@PathVariable Long stepCloseId) { public ApiResponse<StepCloseResp> detail(@PathVariable Long stepCloseId) {
return ApiResponse.ok(service.detail(stepCloseId)); return ApiResponse.ok(service.detail(stepCloseId));
} }
/** 단계마감 항목 신규 생성(아직 미마감 상태). 응답: stepCloseId. 권한: STEP_CLOSE UPDATE. */
@PostMapping @PostMapping
@RequirePermission(menu = "STEP_CLOSE", perm = "UPDATE") @RequirePermission(menu = "STEP_CLOSE", perm = "UPDATE")
@DataChangeLog(menu = "STEP_CLOSE", table = "settlement_step_close") @DataChangeLog(menu = "STEP_CLOSE", table = "settlement_step_close")
@@ -48,6 +61,7 @@ public class StepCloseController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 단계 마감 확정(해당 단계 잠금). 승인 권한 필요. 권한: STEP_CLOSE APPROVE. */
@PostMapping("/{stepCloseId}/close") @PostMapping("/{stepCloseId}/close")
@RequirePermission(menu = "STEP_CLOSE", perm = "APPROVE") @RequirePermission(menu = "STEP_CLOSE", perm = "APPROVE")
@DataChangeLog(menu = "STEP_CLOSE", table = "settlement_step_close") @DataChangeLog(menu = "STEP_CLOSE", table = "settlement_step_close")
@@ -56,6 +70,7 @@ public class StepCloseController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 단계 마감 해제(다시 수정 가능 상태로). 승인 권한 필요. 권한: STEP_CLOSE APPROVE. */
@PostMapping("/{stepCloseId}/reopen") @PostMapping("/{stepCloseId}/reopen")
@RequirePermission(menu = "STEP_CLOSE", perm = "APPROVE") @RequirePermission(menu = "STEP_CLOSE", perm = "APPROVE")
@DataChangeLog(menu = "STEP_CLOSE", table = "settlement_step_close") @DataChangeLog(menu = "STEP_CLOSE", table = "settlement_step_close")
@@ -15,6 +15,15 @@ import org.springframework.web.bind.annotation.*;
import java.util.Map; import java.util.Map;
/**
* 민원 관리 API.
*
* <p>고객 민원을 접수·처리하는 도메인이다. 민원은 특정 보험계약(contractId)·담당 설계사(agentId) 연결되며,
* 상태는 OPEN(접수) CLOSED(처리완료) 전이된다. 환수 유발(chargebackTriggered=true) 민원은
* 처리 정산 배치(P5) 실제 수수료 환수(chargeback) 생성한다(여기서는 플래그만 관리).</p>
*
* <p>메뉴 COMPLAINT 권한으로 보호된다.</p>
*/
@Tag(name = "민원 관리") @Tag(name = "민원 관리")
@RestController @RestController
@RequestMapping("/api/complaints") @RequestMapping("/api/complaints")
@@ -23,18 +32,21 @@ public class ComplaintController {
private final ComplaintService service; private final ComplaintService service;
/** 민원 목록 조회(페이징). READ 권한 필요. */
@GetMapping @GetMapping
@RequirePermission(menu = "COMPLAINT", perm = "READ") @RequirePermission(menu = "COMPLAINT", perm = "READ")
public ApiResponse<PageResponse<ComplaintResp>> list(@ModelAttribute ComplaintSearchParam param) { public ApiResponse<PageResponse<ComplaintResp>> list(@ModelAttribute ComplaintSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 민원 단건 상세 조회. READ 권한 필요. */
@GetMapping("/{complaintId}") @GetMapping("/{complaintId}")
@RequirePermission(menu = "COMPLAINT", perm = "READ") @RequirePermission(menu = "COMPLAINT", perm = "READ")
public ApiResponse<ComplaintResp> detail(@PathVariable Long complaintId) { public ApiResponse<ComplaintResp> detail(@PathVariable Long complaintId) {
return ApiResponse.ok(service.detail(complaintId)); return ApiResponse.ok(service.detail(complaintId));
} }
/** 민원 신규 접수. 등록 시 OPEN 상태로 시작한다. CREATE 권한 필요. */
@PostMapping @PostMapping
@RequirePermission(menu = "COMPLAINT", perm = "CREATE") @RequirePermission(menu = "COMPLAINT", perm = "CREATE")
@DataChangeLog(menu = "COMPLAINT", table = "complaint") @DataChangeLog(menu = "COMPLAINT", table = "complaint")
@@ -42,6 +54,7 @@ public class ComplaintController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 민원 내용 수정. 상태는 변경하지 않는다(처리완료는 별도 엔드포인트). UPDATE 권한 필요. */
@PutMapping("/{complaintId}") @PutMapping("/{complaintId}")
@RequirePermission(menu = "COMPLAINT", perm = "UPDATE") @RequirePermission(menu = "COMPLAINT", perm = "UPDATE")
@DataChangeLog(menu = "COMPLAINT", table = "complaint") @DataChangeLog(menu = "COMPLAINT", table = "complaint")
@@ -51,6 +64,7 @@ public class ComplaintController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 민원 처리완료(status=CLOSED). 처리결과(resolution)를 기록하며 이미 완료된 건은 거부된다. UPDATE 권한 필요. */
@PostMapping("/{complaintId}/close") @PostMapping("/{complaintId}/close")
@RequirePermission(menu = "COMPLAINT", perm = "UPDATE") @RequirePermission(menu = "COMPLAINT", perm = "UPDATE")
@DataChangeLog(menu = "COMPLAINT", table = "complaint") @DataChangeLog(menu = "COMPLAINT", table = "complaint")
@@ -60,6 +74,7 @@ public class ComplaintController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 민원 레코드 삭제. DELETE 권한 필요. */
@DeleteMapping("/{complaintId}") @DeleteMapping("/{complaintId}")
@RequirePermission(menu = "COMPLAINT", perm = "DELETE") @RequirePermission(menu = "COMPLAINT", perm = "DELETE")
@DataChangeLog(menu = "COMPLAINT", table = "complaint") @DataChangeLog(menu = "COMPLAINT", table = "complaint")
@@ -15,6 +15,16 @@ import org.springframework.web.bind.annotation.*;
import java.util.Map; import java.util.Map;
/**
* 위촉계약 관리 API.
*
* <p>위촉계약(agent_contract) 설계사와 보험사(carrier) 사이의 모집 위탁 계약이다.
* 어떤 설계사가 어떤 보험사의 상품을 있는지를 정의하며, 유효기간(effectiveFrom~To)
* 정착지원금(onboardingBonusAmount) 등을 포함한다. 상태는 ACTIVE(유효)에서 TERMINATED(해촉) 전이된다.</p>
*
* <p>주의: 여기서 말하는 계약은 "설계사 위촉계약"이며, 고객이 가입한 "보험계약"과는 다르다.
* 메뉴 AGENT_CONTRACT 권한으로 보호된다.</p>
*/
@Tag(name = "위촉계약 관리") @Tag(name = "위촉계약 관리")
@RestController @RestController
@RequestMapping("/api/agent-contracts") @RequestMapping("/api/agent-contracts")
@@ -23,18 +33,21 @@ public class AgentContractController {
private final AgentContractService service; private final AgentContractService service;
/** 위촉계약 목록 조회(페이징). READ 권한 필요. */
@GetMapping @GetMapping
@RequirePermission(menu = "AGENT_CONTRACT", perm = "READ") @RequirePermission(menu = "AGENT_CONTRACT", perm = "READ")
public ApiResponse<PageResponse<AgentContractResp>> list(@ModelAttribute AgentContractSearchParam param) { public ApiResponse<PageResponse<AgentContractResp>> list(@ModelAttribute AgentContractSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 위촉계약 단건 상세 조회. READ 권한 필요. */
@GetMapping("/{contractId}") @GetMapping("/{contractId}")
@RequirePermission(menu = "AGENT_CONTRACT", perm = "READ") @RequirePermission(menu = "AGENT_CONTRACT", perm = "READ")
public ApiResponse<AgentContractResp> detail(@PathVariable Long contractId) { public ApiResponse<AgentContractResp> detail(@PathVariable Long contractId) {
return ApiResponse.ok(service.detail(contractId)); return ApiResponse.ok(service.detail(contractId));
} }
/** 위촉계약 신규 등록. 등록 시 ACTIVE 상태로 시작한다. CREATE 권한 필요. */
@PostMapping @PostMapping
@RequirePermission(menu = "AGENT_CONTRACT", perm = "CREATE") @RequirePermission(menu = "AGENT_CONTRACT", perm = "CREATE")
@DataChangeLog(menu = "AGENT_CONTRACT", table = "agent_contract") @DataChangeLog(menu = "AGENT_CONTRACT", table = "agent_contract")
@@ -42,6 +55,7 @@ public class AgentContractController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 위촉계약 수정. 상태는 변경하지 않는다(해촉은 별도 엔드포인트). UPDATE 권한 필요. */
@PutMapping("/{contractId}") @PutMapping("/{contractId}")
@RequirePermission(menu = "AGENT_CONTRACT", perm = "UPDATE") @RequirePermission(menu = "AGENT_CONTRACT", perm = "UPDATE")
@DataChangeLog(menu = "AGENT_CONTRACT", table = "agent_contract") @DataChangeLog(menu = "AGENT_CONTRACT", table = "agent_contract")
@@ -51,6 +65,7 @@ public class AgentContractController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 위촉계약 해촉(status=TERMINATED). 사유(reason)를 함께 기록하며 이미 해촉된 건은 거부된다. UPDATE 권한 필요. */
@PostMapping("/{contractId}/terminate") @PostMapping("/{contractId}/terminate")
@RequirePermission(menu = "AGENT_CONTRACT", perm = "UPDATE") @RequirePermission(menu = "AGENT_CONTRACT", perm = "UPDATE")
@DataChangeLog(menu = "AGENT_CONTRACT", table = "agent_contract") @DataChangeLog(menu = "AGENT_CONTRACT", table = "agent_contract")
@@ -60,6 +75,7 @@ public class AgentContractController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 위촉계약 레코드 삭제. DELETE 권한 필요. */
@DeleteMapping("/{contractId}") @DeleteMapping("/{contractId}")
@RequirePermission(menu = "AGENT_CONTRACT", perm = "DELETE") @RequirePermission(menu = "AGENT_CONTRACT", perm = "DELETE")
@DataChangeLog(menu = "AGENT_CONTRACT", table = "agent_contract") @DataChangeLog(menu = "AGENT_CONTRACT", table = "agent_contract")
@@ -13,6 +13,18 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 공제/차감(agent_deduction) 관리 컨트롤러.
*
* <p>"차감" 설계사에게 수수료에서 미리 빼야 금액(: 대출 상환, 가지급금 회수 ) 등록해 두는 것입니다.
* 여기서 PENDING(대기) 상태로 등록해 두면, 지급 처리 단계에서 실지급액(netAmount)에서 자동으로 차감됩니다.
*
* <p>상태 흐름(DeductionStatus): PENDING(대기) APPLIED(적용완료), 또는 CANCELLED(취소).
* 수정·취소는 아직 적용(APPLIED)되지 않은 PENDING 건만 가능합니다.
* 같은 설계사+정산월+차감유형 조합은 중복 등록이 거부됩니다.
*
* <p>권한(menu=DEDUCTION): 조회 READ, 등록 CREATE, 수정/취소 UPDATE.
*/
@Tag(name = "공제 관리") @Tag(name = "공제 관리")
@RestController @RestController
@RequestMapping("/api/deductions") @RequestMapping("/api/deductions")
@@ -21,18 +33,21 @@ public class DeductionController {
private final DeductionService deductionService; private final DeductionService deductionService;
/** 차감 목록 조회(검색 + 페이징). */
@GetMapping @GetMapping
@RequirePermission(menu = "DEDUCTION", perm = "READ") @RequirePermission(menu = "DEDUCTION", perm = "READ")
public ApiResponse<PageResponse<AgentDeductionResp>> list(@ModelAttribute AgentDeductionSearchParam param) { public ApiResponse<PageResponse<AgentDeductionResp>> list(@ModelAttribute AgentDeductionSearchParam param) {
return ApiResponse.ok(deductionService.list(param)); return ApiResponse.ok(deductionService.list(param));
} }
/** 차감 단건 상세 조회. */
@GetMapping("/{deductionId}") @GetMapping("/{deductionId}")
@RequirePermission(menu = "DEDUCTION", perm = "READ") @RequirePermission(menu = "DEDUCTION", perm = "READ")
public ApiResponse<AgentDeductionResp> detail(@PathVariable Long deductionId) { public ApiResponse<AgentDeductionResp> detail(@PathVariable Long deductionId) {
return ApiResponse.ok(deductionService.detail(deductionId)); return ApiResponse.ok(deductionService.detail(deductionId));
} }
/** 차감 등록(PENDING 상태). 동일 설계사+정산월+차감유형 중복은 거부됩니다. */
@PostMapping @PostMapping
@RequirePermission(menu = "DEDUCTION", perm = "CREATE") @RequirePermission(menu = "DEDUCTION", perm = "CREATE")
@DataChangeLog(menu = "DEDUCTION", table = "agent_deduction") @DataChangeLog(menu = "DEDUCTION", table = "agent_deduction")
@@ -40,6 +55,7 @@ public class DeductionController {
return ApiResponse.ok(deductionService.create(req)); return ApiResponse.ok(deductionService.create(req));
} }
/** 차감 금액·설명 수정. PENDING 상태에서만 가능합니다. */
@PutMapping("/{deductionId}") @PutMapping("/{deductionId}")
@RequirePermission(menu = "DEDUCTION", perm = "UPDATE") @RequirePermission(menu = "DEDUCTION", perm = "UPDATE")
@DataChangeLog(menu = "DEDUCTION", table = "agent_deduction") @DataChangeLog(menu = "DEDUCTION", table = "agent_deduction")
@@ -49,6 +65,7 @@ public class DeductionController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 차감 취소(→ CANCELLED). 이미 적용(APPLIED)된 차감은 취소할 수 없습니다. */
@PutMapping("/{deductionId}/cancel") @PutMapping("/{deductionId}/cancel")
@RequirePermission(menu = "DEDUCTION", perm = "UPDATE") @RequirePermission(menu = "DEDUCTION", perm = "UPDATE")
@DataChangeLog(menu = "DEDUCTION", table = "agent_deduction") @DataChangeLog(menu = "DEDUCTION", table = "agent_deduction")
@@ -16,6 +16,13 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
/**
* 데이터 사전(Data Dictionary) 관리 API.
*
* <p>DB 테이블/컬럼의 의미·도메인 코드 매핑 등을 문서화해 관리하는 메타데이터 도구다.
* 항목(dictId) 특정 테이블의 컬럼을 설명하며, 도메인 코드(domainCode) 연결될 있다.
* 메뉴 SYSTEM_DATA_DICT 권한으로 보호된다.</p>
*/
@Tag(name = "데이터 사전") @Tag(name = "데이터 사전")
@RestController @RestController
@RequestMapping("/api/data-dictionary") @RequestMapping("/api/data-dictionary")
@@ -24,18 +31,21 @@ public class DataDictionaryController {
private final DataDictionaryService dataDictionaryService; private final DataDictionaryService dataDictionaryService;
/** 데이터 사전 항목 목록 조회(페이징). READ 권한 필요. */
@GetMapping @GetMapping
@RequirePermission(menu = "SYSTEM_DATA_DICT", perm = "READ") @RequirePermission(menu = "SYSTEM_DATA_DICT", perm = "READ")
public ApiResponse<PageResponse<DataDictionaryResp>> list(@ModelAttribute DataDictionarySearchParam param) { public ApiResponse<PageResponse<DataDictionaryResp>> list(@ModelAttribute DataDictionarySearchParam param) {
return ApiResponse.ok(dataDictionaryService.list(param)); return ApiResponse.ok(dataDictionaryService.list(param));
} }
/** 사전에 등록된 테이블명 목록 조회. READ 권한 필요. */
@GetMapping("/tables") @GetMapping("/tables")
@RequirePermission(menu = "SYSTEM_DATA_DICT", perm = "READ") @RequirePermission(menu = "SYSTEM_DATA_DICT", perm = "READ")
public ApiResponse<List<String>> tables() { public ApiResponse<List<String>> tables() {
return ApiResponse.ok(dataDictionaryService.tables()); return ApiResponse.ok(dataDictionaryService.tables());
} }
/** 사전 뷰 기반 통합 조회(테이블명 선택 필터). 컬럼+도메인 결합 정보를 반환한다. READ 권한 필요. */
@GetMapping("/full") @GetMapping("/full")
@RequirePermission(menu = "SYSTEM_DATA_DICT", perm = "READ") @RequirePermission(menu = "SYSTEM_DATA_DICT", perm = "READ")
public ApiResponse<List<DataDictionaryFullResp>> full( public ApiResponse<List<DataDictionaryFullResp>> full(
@@ -43,12 +53,14 @@ public class DataDictionaryController {
return ApiResponse.ok(dataDictionaryService.full(tableName)); return ApiResponse.ok(dataDictionaryService.full(tableName));
} }
/** 데이터 사전 항목 단건 조회. READ 권한 필요. */
@GetMapping("/{dictId}") @GetMapping("/{dictId}")
@RequirePermission(menu = "SYSTEM_DATA_DICT", perm = "READ") @RequirePermission(menu = "SYSTEM_DATA_DICT", perm = "READ")
public ApiResponse<DataDictionaryResp> detail(@PathVariable Long dictId) { public ApiResponse<DataDictionaryResp> detail(@PathVariable Long dictId) {
return ApiResponse.ok(dataDictionaryService.detail(dictId)); return ApiResponse.ok(dataDictionaryService.detail(dictId));
} }
/** 데이터 사전 항목 등록. 도메인 코드를 지정하면 실존 여부를 검증한다. CREATE 권한 필요. */
@PostMapping @PostMapping
@RequirePermission(menu = "SYSTEM_DATA_DICT", perm = "CREATE") @RequirePermission(menu = "SYSTEM_DATA_DICT", perm = "CREATE")
@DataChangeLog(menu = "SYSTEM_DATA_DICT", table = "data_dictionary") @DataChangeLog(menu = "SYSTEM_DATA_DICT", table = "data_dictionary")
@@ -57,6 +69,7 @@ public class DataDictionaryController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 데이터 사전 항목 수정. UPDATE 권한 필요. */
@PutMapping("/{dictId}") @PutMapping("/{dictId}")
@RequirePermission(menu = "SYSTEM_DATA_DICT", perm = "UPDATE") @RequirePermission(menu = "SYSTEM_DATA_DICT", perm = "UPDATE")
@DataChangeLog(menu = "SYSTEM_DATA_DICT", table = "data_dictionary") @DataChangeLog(menu = "SYSTEM_DATA_DICT", table = "data_dictionary")
@@ -66,6 +79,7 @@ public class DataDictionaryController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 데이터 사전 항목 삭제. DELETE 권한 필요. */
@DeleteMapping("/{dictId}") @DeleteMapping("/{dictId}")
@RequirePermission(menu = "SYSTEM_DATA_DICT", perm = "DELETE") @RequirePermission(menu = "SYSTEM_DATA_DICT", perm = "DELETE")
@DataChangeLog(menu = "SYSTEM_DATA_DICT", table = "data_dictionary") @DataChangeLog(menu = "SYSTEM_DATA_DICT", table = "data_dictionary")
@@ -16,6 +16,13 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
/**
* 데이터 도메인 사전 관리 API.
*
* <p>도메인(domain) 컬럼들이 공통으로 따르는 데이터 타입/형식 규칙의 정의다(: 금액형, 날짜형 ).
* 데이터 사전(data_dictionary) 컬럼들이 도메인 코드를 참조한다. 식별자는 문자열 도메인 코드(domainCode).
* 메뉴 SYSTEM_DATA_DOMAIN 권한으로 보호된다.</p>
*/
@Tag(name = "데이터 도메인 사전") @Tag(name = "데이터 도메인 사전")
@RestController @RestController
@RequestMapping("/api/data-domains") @RequestMapping("/api/data-domains")
@@ -24,24 +31,28 @@ public class DataDomainController {
private final DataDomainService dataDomainService; private final DataDomainService dataDomainService;
/** 도메인 목록 조회(페이징). READ 권한 필요. */
@GetMapping @GetMapping
@RequirePermission(menu = "SYSTEM_DATA_DOMAIN", perm = "READ") @RequirePermission(menu = "SYSTEM_DATA_DOMAIN", perm = "READ")
public ApiResponse<PageResponse<DataDomainResp>> list(@ModelAttribute DataDomainSearchParam param) { public ApiResponse<PageResponse<DataDomainResp>> list(@ModelAttribute DataDomainSearchParam param) {
return ApiResponse.ok(dataDomainService.list(param)); return ApiResponse.ok(dataDomainService.list(param));
} }
/** 선택 옵션용 도메인 전체 목록(코드/명칭 등 경량 정보). READ 권한 필요. */
@GetMapping("/options") @GetMapping("/options")
@RequirePermission(menu = "SYSTEM_DATA_DOMAIN", perm = "READ") @RequirePermission(menu = "SYSTEM_DATA_DOMAIN", perm = "READ")
public ApiResponse<List<DataDomainOptionResp>> options() { public ApiResponse<List<DataDomainOptionResp>> options() {
return ApiResponse.ok(dataDomainService.options()); return ApiResponse.ok(dataDomainService.options());
} }
/** 도메인 단건 상세 조회(도메인 코드 기준). READ 권한 필요. */
@GetMapping("/{domainCode}") @GetMapping("/{domainCode}")
@RequirePermission(menu = "SYSTEM_DATA_DOMAIN", perm = "READ") @RequirePermission(menu = "SYSTEM_DATA_DOMAIN", perm = "READ")
public ApiResponse<DataDomainResp> detail(@PathVariable String domainCode) { public ApiResponse<DataDomainResp> detail(@PathVariable String domainCode) {
return ApiResponse.ok(dataDomainService.detail(domainCode)); return ApiResponse.ok(dataDomainService.detail(domainCode));
} }
/** 도메인 등록. 코드 중복이면 거부된다. CREATE 권한 필요. */
@PostMapping @PostMapping
@RequirePermission(menu = "SYSTEM_DATA_DOMAIN", perm = "CREATE") @RequirePermission(menu = "SYSTEM_DATA_DOMAIN", perm = "CREATE")
@DataChangeLog(menu = "SYSTEM_DATA_DOMAIN", table = "data_domain") @DataChangeLog(menu = "SYSTEM_DATA_DOMAIN", table = "data_domain")
@@ -50,6 +61,7 @@ public class DataDomainController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 도메인 수정. UPDATE 권한 필요. */
@PutMapping("/{domainCode}") @PutMapping("/{domainCode}")
@RequirePermission(menu = "SYSTEM_DATA_DOMAIN", perm = "UPDATE") @RequirePermission(menu = "SYSTEM_DATA_DOMAIN", perm = "UPDATE")
@DataChangeLog(menu = "SYSTEM_DATA_DOMAIN", table = "data_domain") @DataChangeLog(menu = "SYSTEM_DATA_DOMAIN", table = "data_domain")
@@ -59,6 +71,7 @@ public class DataDomainController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 도메인 삭제. 이 도메인을 참조하는 컬럼이 있으면 삭제 불가(서비스에서 검증). DELETE 권한 필요. */
@DeleteMapping("/{domainCode}") @DeleteMapping("/{domainCode}")
@RequirePermission(menu = "SYSTEM_DATA_DOMAIN", perm = "DELETE") @RequirePermission(menu = "SYSTEM_DATA_DOMAIN", perm = "DELETE")
@DataChangeLog(menu = "SYSTEM_DATA_DOMAIN", table = "data_domain") @DataChangeLog(menu = "SYSTEM_DATA_DOMAIN", table = "data_domain")
@@ -13,6 +13,15 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 계약 변경(배서, Endorsement) 관리 API.
*
* <p>배서란 이미 체결된 계약의 내용을 바꾸는 것을 말한다(: 보험료 증감, 피보험자/수익자 변경, 담보 추가 ).
* 변경 유형(endorsementType) 변경 / (oldValue/newValue) 기록하며,
* 보험료가 바뀌어 수수료 재계산이 필요한 경우(requiresCommissionRecalc) 정산 배치가 이를 반영한다.</p>
*
* <p>메뉴 ENDORSE 권한으로 보호된다.</p>
*/
@Tag(name = "계약 변경") @Tag(name = "계약 변경")
@RestController @RestController
@RequestMapping("/api/contract-endorsements") @RequestMapping("/api/contract-endorsements")
@@ -21,6 +30,7 @@ public class ContractEndorsementController {
private final ContractEndorsementService service; private final ContractEndorsementService service;
/** 배서 목록 조회(페이징). READ 권한 필요. */
@GetMapping @GetMapping
@RequirePermission(menu = "ENDORSE", perm = "READ") @RequirePermission(menu = "ENDORSE", perm = "READ")
public ApiResponse<PageResponse<ContractEndorsementResp>> list( public ApiResponse<PageResponse<ContractEndorsementResp>> list(
@@ -28,12 +38,14 @@ public class ContractEndorsementController {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 배서 단건 상세 조회. READ 권한 필요. */
@GetMapping("/{endorsementId}") @GetMapping("/{endorsementId}")
@RequirePermission(menu = "ENDORSE", perm = "READ") @RequirePermission(menu = "ENDORSE", perm = "READ")
public ApiResponse<ContractEndorsementResp> detail(@PathVariable Long endorsementId) { public ApiResponse<ContractEndorsementResp> detail(@PathVariable Long endorsementId) {
return ApiResponse.ok(service.detail(endorsementId)); return ApiResponse.ok(service.detail(endorsementId));
} }
/** 배서 등록. 등록 직후엔 미처리(processed=false) 상태다. CREATE 권한 필요. */
@PostMapping @PostMapping
@RequirePermission(menu = "ENDORSE", perm = "CREATE") @RequirePermission(menu = "ENDORSE", perm = "CREATE")
@DataChangeLog(menu = "ENDORSE", table = "contract_endorsement") @DataChangeLog(menu = "ENDORSE", table = "contract_endorsement")
@@ -41,6 +53,7 @@ public class ContractEndorsementController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 배서 처리 완료 표시(processed=true). 실제 수수료 재계산은 배치(P5)가 담당한다. UPDATE 권한 필요. */
@PostMapping("/{endorsementId}/process") @PostMapping("/{endorsementId}/process")
@RequirePermission(menu = "ENDORSE", perm = "UPDATE") @RequirePermission(menu = "ENDORSE", perm = "UPDATE")
@DataChangeLog(menu = "ENDORSE", table = "contract_endorsement") @DataChangeLog(menu = "ENDORSE", table = "contract_endorsement")
@@ -49,6 +62,7 @@ public class ContractEndorsementController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 배서 레코드 삭제. DELETE 권한 필요. */
@DeleteMapping("/{endorsementId}") @DeleteMapping("/{endorsementId}")
@RequirePermission(menu = "ENDORSE", perm = "DELETE") @RequirePermission(menu = "ENDORSE", perm = "DELETE")
@DataChangeLog(menu = "ENDORSE", table = "contract_endorsement") @DataChangeLog(menu = "ENDORSE", table = "contract_endorsement")
@@ -10,6 +10,13 @@ import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 외부연동 호출 이력 조회 API.
*
* <p>SMS/알림톡, 펌뱅킹, 푸시 외부 시스템 호출 결과를 감사용으로 기록한 이력을 조회한다(읽기 전용).
* 이력 적재 자체는 AOP가 자동 수행하며, 여기서는 운영/장애 추적용 조회만 제공한다.
* 메뉴 SYSTEM_EXTERNAL_CALL 권한으로 보호된다.</p>
*/
@Tag(name = "외부연동 호출이력") @Tag(name = "외부연동 호출이력")
@RestController @RestController
@RequiredArgsConstructor @RequiredArgsConstructor
@@ -17,12 +24,14 @@ public class ExternalCallLogController {
private final ExternalCallLogService service; private final ExternalCallLogService service;
/** 외부 호출 이력 목록 조회(페이징). READ 권한 필요. */
@GetMapping("/api/external-call-logs") @GetMapping("/api/external-call-logs")
@RequirePermission(menu = "SYSTEM_EXTERNAL_CALL", perm = "READ") @RequirePermission(menu = "SYSTEM_EXTERNAL_CALL", perm = "READ")
public ApiResponse<PageResponse<ExternalCallLogResp>> list(@ModelAttribute ExternalCallLogSearchParam param) { public ApiResponse<PageResponse<ExternalCallLogResp>> list(@ModelAttribute ExternalCallLogSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 외부 호출 이력 단건 상세 조회. READ 권한 필요. */
@GetMapping("/api/external-call-logs/{logId}") @GetMapping("/api/external-call-logs/{logId}")
@RequirePermission(menu = "SYSTEM_EXTERNAL_CALL", perm = "READ") @RequirePermission(menu = "SYSTEM_EXTERNAL_CALL", perm = "READ")
public ApiResponse<ExternalCallLogResp> detail(@PathVariable Long logId) { public ApiResponse<ExternalCallLogResp> detail(@PathVariable Long logId) {
@@ -12,6 +12,14 @@ import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* [연간 사업소득 API]
*
* 신입 개발자 안내:
* - 설계사별로 (연도) 동안의 사업소득과 떼인 원천세 등을 합산해 보관하는 자료다(연말정산/지급명세서의 기초).
* - 월별 지급/정산 데이터를 단위로 집계(regenerate)하여 agent_annual_income UPSERT 한다.
* - 상세는 (설계사ID, 정산연도) 조합으로 1건을 조회한다.
*/
@Tag(name = "연간 사업소득") @Tag(name = "연간 사업소득")
@RestController @RestController
@RequestMapping("/api/agent-annual-incomes") @RequestMapping("/api/agent-annual-incomes")
@@ -37,6 +45,7 @@ public class AgentAnnualIncomeController {
return ApiResponse.ok(service.detail(agentId, settleYear)); return ApiResponse.ok(service.detail(agentId, settleYear));
} }
// 지정 연도의 모든 설계사 연간소득을 다시 집계(UPSERT). 월별 데이터가 바뀌었을 다시 돌린다.
@PostMapping("/regenerate") @PostMapping("/regenerate")
@Operation(summary = "연도 전체 재집계") @Operation(summary = "연도 전체 재집계")
@RequirePermission(menu = "ANNUAL_INCOME", perm = "EXECUTE") @RequirePermission(menu = "ANNUAL_INCOME", perm = "EXECUTE")
@@ -18,6 +18,15 @@ import org.springframework.web.bind.annotation.*;
import java.util.Map; import java.util.Map;
/**
* [연말 지급명세서 API]
*
* 신입 개발자 안내:
* - 연말정산을 위해 "한 해 동안 이 설계사에게 얼마를 지급하고 세금을 얼마 뗐는지" 국세청 제출용으로 정리한 명세서다.
* - 데이터 출처: 연간 사업소득(agent_annual_income) 집계 결과를 기반으로 한다.
* - 흐름: regenerate(연도별 UPSERT 생성) generate(단건 파일 발급) send(설계사에게 발송 처리) export(엑셀 다운로드).
* - export 데이터가 많을 있어 Cursor 스트리밍(ExcelService.exportLargeExcel)으로 내려보낸다.
*/
@Tag(name = "연말 지급명세서") @Tag(name = "연말 지급명세서")
@RestController @RestController
@RequestMapping("/api/year-end-statements") @RequestMapping("/api/year-end-statements")
@@ -68,6 +77,7 @@ public class YearEndStatementController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
// 대용량 엑셀 다운로드: 조회 결과를 Cursor 스트리밍하며 번에 메모리에 올리지 않고 파일로 내려쓴다.
@GetMapping("/export") @GetMapping("/export")
@Operation(summary = "엑셀 다운로드") @Operation(summary = "엑셀 다운로드")
@RequirePermission(menu = "YEAR_END_STMT", perm = "EXPORT") @RequirePermission(menu = "YEAR_END_STMT", perm = "EXPORT")
@@ -7,18 +7,27 @@ import lombok.Data;
import java.math.BigDecimal; import java.math.BigDecimal;
import java.time.LocalDate; import java.time.LocalDate;
/**
* 분급(分給) 계획 생성 요청 DTO.
* 분급이란 총수수료를 번에 주지 않고 여러 회차로 나눠 지급하는 것으로,
* 요청을 받아 회차별 지급 스케줄(installment_plan) 자동 생성한다.
*/
@Data @Data
public class GeneratePlanReq { public class GeneratePlanReq {
/** 분급 대상 계약 ID. */
@NotNull @NotNull
private Long contractId; private Long contractId;
/** 나눠서 지급할 총수수료 금액(양수). 분급 비율에 따라 회차별로 쪼개진다. */
@NotNull @NotNull
@Positive @Positive
private BigDecimal totalCommission; private BigDecimal totalCommission;
/** 계약일. 회차별 지급 예정월 계산의 기준이 된다. */
@NotNull @NotNull
private LocalDate contractDate; private LocalDate contractDate;
/** 상품 분류. 분류에 따라 적용할 분급 비율표(installment_ratio)가 달라진다. */
private String productCategory; private String productCategory;
} }
@@ -15,6 +15,10 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
/**
* 분급(分給) 계획 관리 REST 컨트롤러.
* 총수수료를 여러 회차로 나눠 지급하는 분급 계획(installment_plan) 조회·생성·지급/이연/취소를 처리한다.
*/
@Tag(name = "분급 계획 관리") @Tag(name = "분급 계획 관리")
@RestController @RestController
@RequestMapping("/api/installment-plans") @RequestMapping("/api/installment-plans")
@@ -23,18 +27,21 @@ public class InstallmentController {
private final InstallmentService installmentService; private final InstallmentService installmentService;
/** 분급 계획(회차) 목록 페이징 조회. */
@GetMapping @GetMapping
@RequirePermission(menu = "INSTALLMENT_PLAN", perm = "READ") @RequirePermission(menu = "INSTALLMENT_PLAN", perm = "READ")
public ApiResponse<PageResponse<InstallmentPlanResp>> list(InstallmentPlanSearchParam param) { public ApiResponse<PageResponse<InstallmentPlanResp>> list(InstallmentPlanSearchParam param) {
return ApiResponse.ok(installmentService.list(param)); return ApiResponse.ok(installmentService.list(param));
} }
/** 분급 계획 단건 상세 조회. */
@GetMapping("/{planId}") @GetMapping("/{planId}")
@RequirePermission(menu = "INSTALLMENT_PLAN", perm = "READ") @RequirePermission(menu = "INSTALLMENT_PLAN", perm = "READ")
public ApiResponse<InstallmentPlanResp> detail(@PathVariable Long planId) { public ApiResponse<InstallmentPlanResp> detail(@PathVariable Long planId) {
return ApiResponse.ok(installmentService.detail(planId)); return ApiResponse.ok(installmentService.detail(planId));
} }
/** 분급 계획 생성. 총수수료를 분급 비율표에 따라 회차별 지급 스케줄로 자동 분해한다. */
@PostMapping("/generate") @PostMapping("/generate")
@RequirePermission(menu = "INSTALLMENT_PLAN", perm = "CREATE") @RequirePermission(menu = "INSTALLMENT_PLAN", perm = "CREATE")
@DataChangeLog(menu = "INSTALLMENT_PLAN", table = "installment_plan") @DataChangeLog(menu = "INSTALLMENT_PLAN", table = "installment_plan")
@@ -48,6 +55,7 @@ public class InstallmentController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 특정 회차 지급 완료 처리(지급건 ID와 지급액 기록). */
@PutMapping("/{planId}/pay") @PutMapping("/{planId}/pay")
@RequirePermission(menu = "INSTALLMENT_PLAN", perm = "UPDATE") @RequirePermission(menu = "INSTALLMENT_PLAN", perm = "UPDATE")
@DataChangeLog(menu = "INSTALLMENT_PLAN", table = "installment_plan") @DataChangeLog(menu = "INSTALLMENT_PLAN", table = "installment_plan")
@@ -57,6 +65,7 @@ public class InstallmentController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 특정 회차 지급 이연(다음 기회로 미룸) 처리. */
@PutMapping("/{planId}/defer") @PutMapping("/{planId}/defer")
@RequirePermission(menu = "INSTALLMENT_PLAN", perm = "UPDATE") @RequirePermission(menu = "INSTALLMENT_PLAN", perm = "UPDATE")
@DataChangeLog(menu = "INSTALLMENT_PLAN", table = "installment_plan") @DataChangeLog(menu = "INSTALLMENT_PLAN", table = "installment_plan")
@@ -65,6 +74,7 @@ public class InstallmentController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 특정 회차 지급 취소(예: 계약 해지로 향후 분급 중단). */
@PutMapping("/{planId}/cancel") @PutMapping("/{planId}/cancel")
@RequirePermission(menu = "INSTALLMENT_PLAN", perm = "UPDATE") @RequirePermission(menu = "INSTALLMENT_PLAN", perm = "UPDATE")
@DataChangeLog(menu = "INSTALLMENT_PLAN", table = "installment_plan") @DataChangeLog(menu = "INSTALLMENT_PLAN", table = "installment_plan")
@@ -73,6 +83,7 @@ public class InstallmentController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 특정 정산월(settleMonth)에 지급 예정인 분급 회차 목록 조회. 월 정산 배치가 이 목록을 사용한다. */
@GetMapping("/scheduled") @GetMapping("/scheduled")
@RequirePermission(menu = "INSTALLMENT_PLAN", perm = "READ") @RequirePermission(menu = "INSTALLMENT_PLAN", perm = "READ")
public ApiResponse<List<InstallmentPlanVO>> scheduled(@RequestParam String settleMonth) { public ApiResponse<List<InstallmentPlanVO>> scheduled(@RequestParam String settleMonth) {
@@ -13,6 +13,11 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 분급 비율(installment_ratio) 관리 REST 컨트롤러.
* 분급 비율표는 "총수수료를 몇 회차에 걸쳐, 각 회차 몇 %씩 지급할지" 정의하는 기준표이며,
* 분급 계획(installment_plan) 생성 비율이 적용된다.
*/
@Tag(name = "분급 비율 관리") @Tag(name = "분급 비율 관리")
@RestController @RestController
@RequestMapping("/api/installment-ratios") @RequestMapping("/api/installment-ratios")
@@ -21,12 +26,14 @@ public class InstallmentRatioController {
private final InstallmentService installmentService; private final InstallmentService installmentService;
/** 분급 비율표 목록 페이징 조회. */
@GetMapping @GetMapping
@RequirePermission(menu = "INSTALLMENT_RATIO", perm = "READ") @RequirePermission(menu = "INSTALLMENT_RATIO", perm = "READ")
public ApiResponse<PageResponse<InstallmentRatioResp>> list(InstallmentRatioSearchParam param) { public ApiResponse<PageResponse<InstallmentRatioResp>> list(InstallmentRatioSearchParam param) {
return ApiResponse.ok(installmentService.listRatios(param)); return ApiResponse.ok(installmentService.listRatios(param));
} }
/** 분급 비율표 신규 등록. */
@PostMapping @PostMapping
@RequirePermission(menu = "INSTALLMENT_RATIO", perm = "CREATE") @RequirePermission(menu = "INSTALLMENT_RATIO", perm = "CREATE")
@DataChangeLog(menu = "INSTALLMENT_RATIO", table = "installment_ratio") @DataChangeLog(menu = "INSTALLMENT_RATIO", table = "installment_ratio")
@@ -6,12 +6,18 @@ import lombok.Data;
import java.math.BigDecimal; import java.math.BigDecimal;
/**
* 분급 회차 지급 처리 요청 DTO.
* 특정 회차(plan) 실제로 지급 완료 처리할 , 어떤 지급건(paymentId)으로 얼마(paidAmount) 지급했는지 전달한다.
*/
@Data @Data
public class PayPlanReq { public class PayPlanReq {
/** 실제 지급이 일어난 지급(payment) 레코드 ID. */
@NotNull @NotNull
private Long paymentId; private Long paymentId;
/** 이번 회차에 지급한 금액(양수). */
@NotNull @NotNull
@Positive @Positive
private BigDecimal paidAmount; private BigDecimal paidAmount;
@@ -21,6 +21,7 @@ public class BankRetryController {
private final WithdrawBankRetryService bankRetryService; private final WithdrawBankRetryService bankRetryService;
/** 펌뱅킹 이체 실패(FAILED) 건을 즉시 1회 재시도하고 처리 건수를 반환한다. WITHDRAW EXECUTE 권한 필요. */
@PostMapping @PostMapping
@RequirePermission(menu = "WITHDRAW", perm = "EXECUTE") @RequirePermission(menu = "WITHDRAW", perm = "EXECUTE")
public ApiResponse<Integer> retry() { public ApiResponse<Integer> retry() {
@@ -21,6 +21,7 @@ public class BankSettleController {
private final WithdrawBankSettleService bankSettleService; private final WithdrawBankSettleService bankSettleService;
/** 펌뱅킹 입금 확정(SETTLED) 상태를 즉시 1회 동기화하고 처리 건수를 반환한다. WITHDRAW EXECUTE 권한 필요. */
@PostMapping @PostMapping
@RequirePermission(menu = "WITHDRAW", perm = "EXECUTE") @RequirePermission(menu = "WITHDRAW", perm = "EXECUTE")
public ApiResponse<Integer> sync() { public ApiResponse<Integer> sync() {
@@ -14,6 +14,10 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 차월(다음 ) KPI 예측 REST 컨트롤러.
* 과거 실적 데이터를 이동평균(SMA) 등으로 분석해 다음 실적 KPI를 미리 예측·관리한다.
*/
@Tag(name = "차월 KPI 예측") @Tag(name = "차월 KPI 예측")
@RestController @RestController
@RequestMapping("/api/forecast-kpi") @RequestMapping("/api/forecast-kpi")
@@ -22,6 +26,7 @@ public class ForecastKpiMonthlyController {
private final ForecastKpiMonthlyService service; private final ForecastKpiMonthlyService service;
/** 예측값 목록 페이징 조회. */
@GetMapping @GetMapping
@Operation(summary = "예측 목록") @Operation(summary = "예측 목록")
@RequirePermission(menu = "FORECAST_KPI", perm = "READ") @RequirePermission(menu = "FORECAST_KPI", perm = "READ")
@@ -29,6 +34,7 @@ public class ForecastKpiMonthlyController {
return ApiResponse.ok(service.list(p)); return ApiResponse.ok(service.list(p));
} }
/** 차월 예측 재산출(실적 변동 시 다시 계산). 갱신된 행 수를 반환한다. */
@PostMapping("/regenerate") @PostMapping("/regenerate")
@Operation(summary = "차월 예측 재산출") @Operation(summary = "차월 예측 재산출")
@RequirePermission(menu = "FORECAST_KPI", perm = "EXECUTE") @RequirePermission(menu = "FORECAST_KPI", perm = "EXECUTE")
@@ -16,6 +16,14 @@ import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController; import org.springframework.web.bind.annotation.RestController;
/**
* KPI 대시보드 REST 컨트롤러.
* 실적 집계(KPI) 여러 관점으로 조회하는 읽기 전용 화면용 API다.
* - monthly-summary : 월별 실적 요약
* - org-summary : 조직(지점/본부) 실적 요약
* - retention : 계약 유지율 지표
* - cumulative : 누적 실적 추이
*/
@Tag(name = "KPI 대시보드") @Tag(name = "KPI 대시보드")
@RestController @RestController
@RequestMapping("/api/kpi") @RequestMapping("/api/kpi")
@@ -24,24 +32,28 @@ public class KpiController {
private final KpiService service; private final KpiService service;
/** 월별 실적 요약 조회. */
@GetMapping("/monthly-summary") @GetMapping("/monthly-summary")
@RequirePermission(menu = "KPI_MONTHLY", perm = "READ") @RequirePermission(menu = "KPI_MONTHLY", perm = "READ")
public ApiResponse<PageResponse<KpiMonthlySummaryResp>> monthlySummary(@ModelAttribute KpiSearchParam param) { public ApiResponse<PageResponse<KpiMonthlySummaryResp>> monthlySummary(@ModelAttribute KpiSearchParam param) {
return ApiResponse.ok(service.monthlySummary(param)); return ApiResponse.ok(service.monthlySummary(param));
} }
/** 조직별 실적 요약 조회. */
@GetMapping("/org-summary") @GetMapping("/org-summary")
@RequirePermission(menu = "KPI_ORG", perm = "READ") @RequirePermission(menu = "KPI_ORG", perm = "READ")
public ApiResponse<PageResponse<KpiOrgSummaryResp>> orgSummary(@ModelAttribute KpiSearchParam param) { public ApiResponse<PageResponse<KpiOrgSummaryResp>> orgSummary(@ModelAttribute KpiSearchParam param) {
return ApiResponse.ok(service.orgSummary(param)); return ApiResponse.ok(service.orgSummary(param));
} }
/** 계약 유지율 지표 조회. */
@GetMapping("/retention") @GetMapping("/retention")
@RequirePermission(menu = "KPI_RETENTION", perm = "READ") @RequirePermission(menu = "KPI_RETENTION", perm = "READ")
public ApiResponse<PageResponse<KpiRetentionResp>> retention(@ModelAttribute KpiSearchParam param) { public ApiResponse<PageResponse<KpiRetentionResp>> retention(@ModelAttribute KpiSearchParam param) {
return ApiResponse.ok(service.retention(param)); return ApiResponse.ok(service.retention(param));
} }
/** 누적 실적 추이 조회. */
@GetMapping("/cumulative") @GetMapping("/cumulative")
@RequirePermission(menu = "KPI_CUMULATIVE", perm = "READ") @RequirePermission(menu = "KPI_CUMULATIVE", perm = "READ")
public ApiResponse<PageResponse<KpiCumulativeResp>> cumulative(@ModelAttribute KpiSearchParam param) { public ApiResponse<PageResponse<KpiCumulativeResp>> cumulative(@ModelAttribute KpiSearchParam param) {
@@ -15,6 +15,11 @@ import org.springframework.web.bind.annotation.*;
import java.util.Map; import java.util.Map;
/**
* 유지율 이상치(retention anomaly) 알림 REST 컨트롤러.
* 특정 조직/설계사의 계약 유지율이 평소 대비 비정상적으로 떨어진 경우를 탐지해 알림으로 관리한다.
* (유지율 급락은 부실모집/불완전판매 신호일 있어 모니터링 대상이다)
*/
@Tag(name = "유지율 이상치") @Tag(name = "유지율 이상치")
@RestController @RestController
@RequestMapping("/api/retention-anomalies") @RequestMapping("/api/retention-anomalies")
@@ -23,6 +28,7 @@ public class RetentionAnomalyAlertController {
private final RetentionAnomalyAlertService service; private final RetentionAnomalyAlertService service;
/** 이상치 알림 목록 페이징 조회. */
@GetMapping @GetMapping
@Operation(summary = "이상치 목록") @Operation(summary = "이상치 목록")
@RequirePermission(menu = "RETENTION_ANOMALY", perm = "READ") @RequirePermission(menu = "RETENTION_ANOMALY", perm = "READ")
@@ -30,6 +36,7 @@ public class RetentionAnomalyAlertController {
return ApiResponse.ok(service.list(p)); return ApiResponse.ok(service.list(p));
} }
/** 이상치 알림 단건 상세 조회. */
@GetMapping("/{id}") @GetMapping("/{id}")
@Operation(summary = "이상치 단건 상세") @Operation(summary = "이상치 단건 상세")
@RequirePermission(menu = "RETENTION_ANOMALY", perm = "READ") @RequirePermission(menu = "RETENTION_ANOMALY", perm = "READ")
@@ -37,6 +44,7 @@ public class RetentionAnomalyAlertController {
return ApiResponse.ok(service.detail(id)); return ApiResponse.ok(service.detail(id));
} }
/** 지정한 월(alertMonth)에 대해 이상치를 다시 탐지·저장한다. 새로 탐지된 건수를 반환. */
@PostMapping("/detect") @PostMapping("/detect")
@Operation(summary = "이상치 재탐지 (월 단위)") @Operation(summary = "이상치 재탐지 (월 단위)")
@RequirePermission(menu = "RETENTION_ANOMALY", perm = "UPDATE") @RequirePermission(menu = "RETENTION_ANOMALY", perm = "UPDATE")
@@ -45,6 +53,7 @@ public class RetentionAnomalyAlertController {
return ApiResponse.ok(service.detect(body.get("alertMonth"))); return ApiResponse.ok(service.detect(body.get("alertMonth")));
} }
/** 탐지된 이상치를 검토/완료 상태로 처리(담당자 확인 결과 기록). */
@PutMapping("/review") @PutMapping("/review")
@Operation(summary = "이상치 검토/완료 처리") @Operation(summary = "이상치 검토/완료 처리")
@RequirePermission(menu = "RETENTION_ANOMALY", perm = "UPDATE") @RequirePermission(menu = "RETENTION_ANOMALY", perm = "UPDATE")
@@ -15,6 +15,14 @@ import org.springframework.web.bind.annotation.*;
import java.util.Map; import java.util.Map;
/**
* 수수료 원장(ledger) 관리 REST 컨트롤러.
* 원장은 설계사에게 지급된/지급될 수수료 내역을 종류별로 기록하는 장부다.
* - 모집(recruit) : 신계약 체결로 발생한 모집수수료 원장
* - 유지(maintain) : 계약 유지에 따라 매월 발생하는 유지수수료 원장
* - 예외(exception) : 정상 계산에 잡히는 수기 조정 수수료(승인 절차 필요)
* 조회/상세 외에 대용량 엑셀 다운로드(exportLargeExcel: 커서 스트리밍) 제공한다.
*/
@Tag(name = "원장 관리") @Tag(name = "원장 관리")
@RestController @RestController
@RequestMapping("/api/ledger") @RequestMapping("/api/ledger")
@@ -24,7 +32,7 @@ public class LedgerController {
private final LedgerService service; private final LedgerService service;
private final ExcelService excelService; private final ExcelService excelService;
// ===== 모집 ===== // ===== 모집수수료 원장 =====
@GetMapping("/recruit") @GetMapping("/recruit")
@RequirePermission(menu = "LEDGER_RECRUIT", perm = "READ") @RequirePermission(menu = "LEDGER_RECRUIT", perm = "READ")
public ApiResponse<PageResponse<LedgerResp>> listRecruit(@ModelAttribute LedgerSearchParam param) { public ApiResponse<PageResponse<LedgerResp>> listRecruit(@ModelAttribute LedgerSearchParam param) {
@@ -37,6 +45,7 @@ public class LedgerController {
return ApiResponse.ok(service.detailRecruit(ledgerId)); return ApiResponse.ok(service.detailRecruit(ledgerId));
} }
/** 모집수수료 원장 엑셀 다운로드. 대용량 대비 커서로 한 건씩 흘려보내 메모리 폭증을 막는다. */
@GetMapping("/recruit/export") @GetMapping("/recruit/export")
@RequirePermission(menu = "LEDGER_RECRUIT", perm = "EXPORT") @RequirePermission(menu = "LEDGER_RECRUIT", perm = "EXPORT")
public void exportRecruit(@ModelAttribute LedgerSearchParam param, HttpServletResponse res) { public void exportRecruit(@ModelAttribute LedgerSearchParam param, HttpServletResponse res) {
@@ -44,7 +53,7 @@ public class LedgerController {
() -> service.exportRecruitCursor(param), res); () -> service.exportRecruitCursor(param), res);
} }
// ===== 유지 ===== // ===== 유지수수료 원장 =====
@GetMapping("/maintain") @GetMapping("/maintain")
@RequirePermission(menu = "LEDGER_MAINTAIN", perm = "READ") @RequirePermission(menu = "LEDGER_MAINTAIN", perm = "READ")
public ApiResponse<PageResponse<LedgerResp>> listMaintain(@ModelAttribute LedgerSearchParam param) { public ApiResponse<PageResponse<LedgerResp>> listMaintain(@ModelAttribute LedgerSearchParam param) {
@@ -57,6 +66,7 @@ public class LedgerController {
return ApiResponse.ok(service.detailMaintain(ledgerId)); return ApiResponse.ok(service.detailMaintain(ledgerId));
} }
/** 유지수수료 원장 엑셀 다운로드(커서 스트리밍). */
@GetMapping("/maintain/export") @GetMapping("/maintain/export")
@RequirePermission(menu = "LEDGER_MAINTAIN", perm = "EXPORT") @RequirePermission(menu = "LEDGER_MAINTAIN", perm = "EXPORT")
public void exportMaintain(@ModelAttribute LedgerSearchParam param, HttpServletResponse res) { public void exportMaintain(@ModelAttribute LedgerSearchParam param, HttpServletResponse res) {
@@ -64,7 +74,7 @@ public class LedgerController {
() -> service.exportMaintainCursor(param), res); () -> service.exportMaintainCursor(param), res);
} }
// ===== 예외 ===== // ===== 예외수수료 원장(수기 등록 + 승인) =====
@GetMapping("/exception") @GetMapping("/exception")
@RequirePermission(menu = "LEDGER_EXCEPTION", perm = "READ") @RequirePermission(menu = "LEDGER_EXCEPTION", perm = "READ")
public ApiResponse<PageResponse<ExceptionLedgerResp>> listException(@ModelAttribute LedgerSearchParam param) { public ApiResponse<PageResponse<ExceptionLedgerResp>> listException(@ModelAttribute LedgerSearchParam param) {
@@ -77,6 +87,7 @@ public class LedgerController {
return ApiResponse.ok(service.detailException(ledgerId)); return ApiResponse.ok(service.detailException(ledgerId));
} }
/** 예외수수료 원장 수기 등록. 등록 직후에는 승인대기(PENDING) 상태다. */
@PostMapping("/exception") @PostMapping("/exception")
@RequirePermission(menu = "LEDGER_EXCEPTION", perm = "CREATE") @RequirePermission(menu = "LEDGER_EXCEPTION", perm = "CREATE")
@DataChangeLog(menu = "LEDGER_EXCEPTION", table = "exception_ledger") @DataChangeLog(menu = "LEDGER_EXCEPTION", table = "exception_ledger")
@@ -84,6 +95,7 @@ public class LedgerController {
return ApiResponse.ok(service.createException(req)); return ApiResponse.ok(service.createException(req));
} }
/** 예외수수료 원장 승인/반려 처리(body 의 status: APPROVED 또는 REJECTED). */
@PutMapping("/exception/{ledgerId}/approve") @PutMapping("/exception/{ledgerId}/approve")
@RequirePermission(menu = "LEDGER_EXCEPTION", perm = "APPROVE") @RequirePermission(menu = "LEDGER_EXCEPTION", perm = "APPROVE")
@DataChangeLog(menu = "LEDGER_EXCEPTION", table = "exception_ledger") @DataChangeLog(menu = "LEDGER_EXCEPTION", table = "exception_ledger")
@@ -15,6 +15,13 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
/**
* 설계사 자격(License) 관리 API.
*
* <p>보험설계사는 판매 가능한 상품군별로 자격(생명/손해 licenseType) 보유해야 한다.
* 자격은 발급일(issuedDate)~만료일(expiresDate) 가지며 갱신(renewedFrom) 이력이 연결될 있다.
* 만료 임박 자격을 조회해 갱신을 독려하는 기능이 핵심이다. 메뉴 AGENT_LICENSE 권한으로 보호된다.</p>
*/
@Tag(name = "자격 관리") @Tag(name = "자격 관리")
@RestController @RestController
@RequestMapping("/api/agent-licenses") @RequestMapping("/api/agent-licenses")
@@ -23,18 +30,21 @@ public class AgentLicenseController {
private final AgentLicenseService service; private final AgentLicenseService service;
/** 자격 목록 조회(페이징). READ 권한 필요. */
@GetMapping @GetMapping
@RequirePermission(menu = "AGENT_LICENSE", perm = "READ") @RequirePermission(menu = "AGENT_LICENSE", perm = "READ")
public ApiResponse<PageResponse<AgentLicenseResp>> list(@ModelAttribute AgentLicenseSearchParam param) { public ApiResponse<PageResponse<AgentLicenseResp>> list(@ModelAttribute AgentLicenseSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 자격 단건 상세 조회. READ 권한 필요. */
@GetMapping("/{licenseId}") @GetMapping("/{licenseId}")
@RequirePermission(menu = "AGENT_LICENSE", perm = "READ") @RequirePermission(menu = "AGENT_LICENSE", perm = "READ")
public ApiResponse<AgentLicenseResp> detail(@PathVariable Long licenseId) { public ApiResponse<AgentLicenseResp> detail(@PathVariable Long licenseId) {
return ApiResponse.ok(service.detail(licenseId)); return ApiResponse.ok(service.detail(licenseId));
} }
/** 만료 임박 자격 조회(기본 30일 이내). 갱신 알림/관리에 사용한다. READ 권한 필요. */
@GetMapping("/expiring") @GetMapping("/expiring")
@RequirePermission(menu = "AGENT_LICENSE", perm = "READ") @RequirePermission(menu = "AGENT_LICENSE", perm = "READ")
public ApiResponse<List<AgentLicenseResp>> expiring( public ApiResponse<List<AgentLicenseResp>> expiring(
@@ -42,6 +52,7 @@ public class AgentLicenseController {
return ApiResponse.ok(service.expiring(days)); return ApiResponse.ok(service.expiring(days));
} }
/** 자격 등록. 등록 시 ACTIVE 상태로 시작한다. CREATE 권한 필요. */
@PostMapping @PostMapping
@RequirePermission(menu = "AGENT_LICENSE", perm = "CREATE") @RequirePermission(menu = "AGENT_LICENSE", perm = "CREATE")
@DataChangeLog(menu = "AGENT_LICENSE", table = "agent_license") @DataChangeLog(menu = "AGENT_LICENSE", table = "agent_license")
@@ -49,6 +60,7 @@ public class AgentLicenseController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 자격 수정. UPDATE 권한 필요. */
@PutMapping("/{licenseId}") @PutMapping("/{licenseId}")
@RequirePermission(menu = "AGENT_LICENSE", perm = "UPDATE") @RequirePermission(menu = "AGENT_LICENSE", perm = "UPDATE")
@DataChangeLog(menu = "AGENT_LICENSE", table = "agent_license") @DataChangeLog(menu = "AGENT_LICENSE", table = "agent_license")
@@ -58,6 +70,7 @@ public class AgentLicenseController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 자격 레코드 삭제. DELETE 권한 필요. */
@DeleteMapping("/{licenseId}") @DeleteMapping("/{licenseId}")
@RequirePermission(menu = "AGENT_LICENSE", perm = "DELETE") @RequirePermission(menu = "AGENT_LICENSE", perm = "DELETE")
@DataChangeLog(menu = "AGENT_LICENSE", table = "agent_license") @DataChangeLog(menu = "AGENT_LICENSE", table = "agent_license")
@@ -38,22 +38,26 @@ public class MobileMeController {
private final MobileMeService service; private final MobileMeService service;
/** 내 홈 요약(명세서 수/출금 신청 수/미읽음 알림 수). */
@GetMapping("/summary") @GetMapping("/summary")
public ApiResponse<MeSummary> summary() { public ApiResponse<MeSummary> summary() {
return ApiResponse.ok(service.summary()); return ApiResponse.ok(service.summary());
} }
/** 내 수수료 명세서 목록(서버가 본인 agentId로 강제 필터). */
@GetMapping("/statements") @GetMapping("/statements")
public ApiResponse<PageResponse<CommissionStatementResp>> statements( public ApiResponse<PageResponse<CommissionStatementResp>> statements(
@ModelAttribute CommissionStatementSearchParam param) { @ModelAttribute CommissionStatementSearchParam param) {
return ApiResponse.ok(service.statements(param)); return ApiResponse.ok(service.statements(param));
} }
/** 내 명세서 단건 상세. 본인 소유가 아니면 FORBIDDEN. */
@GetMapping("/statements/{statementId}") @GetMapping("/statements/{statementId}")
public ApiResponse<CommissionStatementResp> statementDetail(@PathVariable Long statementId) { public ApiResponse<CommissionStatementResp> statementDetail(@PathVariable Long statementId) {
return ApiResponse.ok(service.statementDetail(statementId)); return ApiResponse.ok(service.statementDetail(statementId));
} }
/** 내 명세서 엑셀 다운로드. 본인 소유 검증 후 파일 스트림을 내려준다. */
@GetMapping("/statements/{statementId}/download") @GetMapping("/statements/{statementId}/download")
public void downloadStatement(@PathVariable Long statementId, HttpServletResponse response) throws IOException { public void downloadStatement(@PathVariable Long statementId, HttpServletResponse response) throws IOException {
byte[] content = service.downloadStatement(statementId); byte[] content = service.downloadStatement(statementId);
@@ -65,33 +69,39 @@ public class MobileMeController {
response.getOutputStream().write(content); response.getOutputStream().write(content);
} }
/** 출금 신청 가능한 내 정산 마스터 목록(출금 폼 드롭다운용). */
@GetMapping("/settle-masters") @GetMapping("/settle-masters")
public ApiResponse<List<SettleMasterResp>> withdrawableSettleMasters() { public ApiResponse<List<SettleMasterResp>> withdrawableSettleMasters() {
return ApiResponse.ok(service.withdrawableSettleMasters()); return ApiResponse.ok(service.withdrawableSettleMasters());
} }
/** 특정 정산 마스터의 출금 가능 잔액 조회(출금 폼 미리 표시용). 본인 소유 검증 포함. */
@GetMapping("/settle-masters/{settleMasterId}/withdrawable-balance") @GetMapping("/settle-masters/{settleMasterId}/withdrawable-balance")
public ApiResponse<WithdrawableBalance> withdrawableBalance(@PathVariable Long settleMasterId) { public ApiResponse<WithdrawableBalance> withdrawableBalance(@PathVariable Long settleMasterId) {
return ApiResponse.ok(service.withdrawableBalance(settleMasterId)); return ApiResponse.ok(service.withdrawableBalance(settleMasterId));
} }
/** 내 출금 신청 목록(서버가 본인 agentId로 강제 필터). */
@GetMapping("/withdraw-requests") @GetMapping("/withdraw-requests")
public ApiResponse<PageResponse<WithdrawRequestResp>> withdrawRequests( public ApiResponse<PageResponse<WithdrawRequestResp>> withdrawRequests(
@ModelAttribute WithdrawRequestSearchParam param) { @ModelAttribute WithdrawRequestSearchParam param) {
return ApiResponse.ok(service.withdrawRequests(param)); return ApiResponse.ok(service.withdrawRequests(param));
} }
/** 출금 신청 등록. agentId/신청자는 토큰에서 강제 결정하고 잔액 한도를 검증한다. */
@PostMapping("/withdraw-requests") @PostMapping("/withdraw-requests")
public ApiResponse<Long> createWithdrawRequest(@Valid @RequestBody MobileWithdrawSaveReq req) { public ApiResponse<Long> createWithdrawRequest(@Valid @RequestBody MobileWithdrawSaveReq req) {
return ApiResponse.ok(service.createWithdrawRequest(req)); return ApiResponse.ok(service.createWithdrawRequest(req));
} }
/** 내 출금 신청 취소. 본인 소유 검증 후 취소한다. */
@PostMapping("/withdraw-requests/{requestId}/cancel") @PostMapping("/withdraw-requests/{requestId}/cancel")
public ApiResponse<Void> cancelWithdrawRequest(@PathVariable Long requestId) { public ApiResponse<Void> cancelWithdrawRequest(@PathVariable Long requestId) {
service.cancelMyWithdrawRequest(requestId); service.cancelMyWithdrawRequest(requestId);
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 내 전화번호 직접 수정(관리자 거치지 않음). */
@PutMapping("/profile/phone") @PutMapping("/profile/phone")
public ApiResponse<Void> updateMyPhone(@RequestBody PhoneReq req) { public ApiResponse<Void> updateMyPhone(@RequestBody PhoneReq req) {
service.updateMyPhone(req.getPhone()); service.updateMyPhone(req.getPhone());
@@ -103,18 +113,21 @@ public class MobileMeController {
private String phone; private String phone;
} }
/** 내 알림 목록(서버가 본인 userId로 강제 필터). */
@GetMapping("/notifications") @GetMapping("/notifications")
public ApiResponse<PageResponse<UserNotificationResp>> notifications( public ApiResponse<PageResponse<UserNotificationResp>> notifications(
@ModelAttribute UserNotificationSearchParam param) { @ModelAttribute UserNotificationSearchParam param) {
return ApiResponse.ok(service.notifications(param)); return ApiResponse.ok(service.notifications(param));
} }
/** 내 알림 단건 읽음 처리. */
@PostMapping("/notifications/{notificationId}/read") @PostMapping("/notifications/{notificationId}/read")
public ApiResponse<Void> markRead(@PathVariable Long notificationId) { public ApiResponse<Void> markRead(@PathVariable Long notificationId) {
service.markNotificationRead(notificationId); service.markNotificationRead(notificationId);
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 내 알림 전체 읽음 처리(처리 건수 반환). */
@PostMapping("/notifications/read-all") @PostMapping("/notifications/read-all")
public ApiResponse<Integer> markAllRead() { public ApiResponse<Integer> markAllRead() {
return ApiResponse.ok(service.markAllNotificationsRead()); return ApiResponse.ok(service.markAllNotificationsRead());
@@ -14,6 +14,16 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
/**
* 공지사항 사용자 알림 API.
*
* <p> 가지 도메인을 함께 다룬다.
* <ul>
* <li>공지사항(notice): 관리자가 등록하는 게시물. 기간(startDate~endDate) 활성여부로 노출을 제어한다.</li>
* <li>사용자 알림(user-notification): 개인에게 발송되는 알림. 읽음 처리/미읽음 개수 조회 등을 제공한다.</li>
* </ul>
* 모두 메뉴 NOTICE 권한으로 보호된다.</p>
*/
@Tag(name = "공지사항 & 알림") @Tag(name = "공지사항 & 알림")
@RestController @RestController
@RequiredArgsConstructor @RequiredArgsConstructor
@@ -23,24 +33,28 @@ public class NoticeController {
// Notice // Notice
/** 공지사항 목록 조회(페이징). READ 권한 필요. */
@GetMapping("/api/notices") @GetMapping("/api/notices")
@RequirePermission(menu = "NOTICE", perm = "READ") @RequirePermission(menu = "NOTICE", perm = "READ")
public ApiResponse<PageResponse<NoticeResp>> list(@ModelAttribute NoticeSearchParam param) { public ApiResponse<PageResponse<NoticeResp>> list(@ModelAttribute NoticeSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 현재 노출 기간이고 활성 상태인 공지만 조회. READ 권한 필요. */
@GetMapping("/api/notices/active") @GetMapping("/api/notices/active")
@RequirePermission(menu = "NOTICE", perm = "READ") @RequirePermission(menu = "NOTICE", perm = "READ")
public ApiResponse<List<NoticeResp>> activeList() { public ApiResponse<List<NoticeResp>> activeList() {
return ApiResponse.ok(service.activeList()); return ApiResponse.ok(service.activeList());
} }
/** 공지사항 단건 상세 조회. READ 권한 필요. */
@GetMapping("/api/notices/{noticeId}") @GetMapping("/api/notices/{noticeId}")
@RequirePermission(menu = "NOTICE", perm = "READ") @RequirePermission(menu = "NOTICE", perm = "READ")
public ApiResponse<NoticeResp> detail(@PathVariable Long noticeId) { public ApiResponse<NoticeResp> detail(@PathVariable Long noticeId) {
return ApiResponse.ok(service.detail(noticeId)); return ApiResponse.ok(service.detail(noticeId));
} }
/** 공지사항 등록. 등록 시 활성(isActive=true) 상태로 시작한다. CREATE 권한 필요. */
@PostMapping("/api/notices") @PostMapping("/api/notices")
@RequirePermission(menu = "NOTICE", perm = "CREATE") @RequirePermission(menu = "NOTICE", perm = "CREATE")
@DataChangeLog(menu = "NOTICE", table = "notice") @DataChangeLog(menu = "NOTICE", table = "notice")
@@ -48,6 +62,7 @@ public class NoticeController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 공지사항 수정. UPDATE 권한 필요. */
@PutMapping("/api/notices/{noticeId}") @PutMapping("/api/notices/{noticeId}")
@RequirePermission(menu = "NOTICE", perm = "UPDATE") @RequirePermission(menu = "NOTICE", perm = "UPDATE")
@DataChangeLog(menu = "NOTICE", table = "notice") @DataChangeLog(menu = "NOTICE", table = "notice")
@@ -57,6 +72,7 @@ public class NoticeController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 공지사항 삭제. DELETE 권한 필요. */
@DeleteMapping("/api/notices/{noticeId}") @DeleteMapping("/api/notices/{noticeId}")
@RequirePermission(menu = "NOTICE", perm = "DELETE") @RequirePermission(menu = "NOTICE", perm = "DELETE")
@DataChangeLog(menu = "NOTICE", table = "notice") @DataChangeLog(menu = "NOTICE", table = "notice")
@@ -67,6 +83,7 @@ public class NoticeController {
// UserNotification // UserNotification
/** 사용자 알림 목록 조회(페이징). READ 권한 필요. */
@GetMapping("/api/user-notifications") @GetMapping("/api/user-notifications")
@RequirePermission(menu = "NOTICE", perm = "READ") @RequirePermission(menu = "NOTICE", perm = "READ")
public ApiResponse<PageResponse<UserNotificationResp>> listNotifications( public ApiResponse<PageResponse<UserNotificationResp>> listNotifications(
@@ -74,6 +91,7 @@ public class NoticeController {
return ApiResponse.ok(service.listNotifications(param)); return ApiResponse.ok(service.listNotifications(param));
} }
/** 미읽음 알림 개수 조회. userId 미지정 시 현재 로그인 사용자 기준. READ 권한 필요. */
@GetMapping("/api/user-notifications/unread-count") @GetMapping("/api/user-notifications/unread-count")
@RequirePermission(menu = "NOTICE", perm = "READ") @RequirePermission(menu = "NOTICE", perm = "READ")
public ApiResponse<Integer> unreadCount(@RequestParam(required = false) Long userId) { public ApiResponse<Integer> unreadCount(@RequestParam(required = false) Long userId) {
@@ -81,6 +99,7 @@ public class NoticeController {
return ApiResponse.ok(service.unreadCount(target)); return ApiResponse.ok(service.unreadCount(target));
} }
/** 알림 단건 읽음 처리. userId 미지정 시 현재 로그인 사용자 기준. READ 권한 필요. */
@PostMapping("/api/user-notifications/{notificationId}/read") @PostMapping("/api/user-notifications/{notificationId}/read")
@RequirePermission(menu = "NOTICE", perm = "READ") @RequirePermission(menu = "NOTICE", perm = "READ")
public ApiResponse<Void> markRead(@PathVariable Long notificationId, public ApiResponse<Void> markRead(@PathVariable Long notificationId,
@@ -90,6 +109,7 @@ public class NoticeController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 해당 사용자의 모든 알림을 읽음 처리. READ 권한 필요. */
@PostMapping("/api/user-notifications/read-all") @PostMapping("/api/user-notifications/read-all")
@RequirePermission(menu = "NOTICE", perm = "READ") @RequirePermission(menu = "NOTICE", perm = "READ")
public ApiResponse<Void> markAllRead(@RequestParam Long userId) { public ApiResponse<Void> markAllRead(@RequestParam Long userId) {
@@ -16,6 +16,15 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
/**
* 설계사(보험모집인) 관리 API.
*
* <p>설계사는 GA(보험대리점) 소속되어 보험계약을 모집하는 사람이며, 수수료 정산의 기본 단위다.
* 설계사는 특정 조직(지점/본부) 직급(grade) 소속되며, 입사/전배/승진/퇴사 등의 이력이 관리된다.</p>
*
* <p>모든 엔드포인트는 {@code @RequirePermission}으로 메뉴(ORG_AGENT) 권한(READ/CREATE/UPDATE/EXPORT)
* 검증하며, 데이터 변경 작업은 {@code @DataChangeLog} 변경 이력을 자동 적재한다.</p>
*/
@Tag(name = "설계사 관리") @Tag(name = "설계사 관리")
@RestController @RestController
@RequestMapping("/api/agents") @RequestMapping("/api/agents")
@@ -25,18 +34,21 @@ public class AgentController {
private final AgentService agentService; private final AgentService agentService;
private final ExcelService excelService; private final ExcelService excelService;
/** 설계사 목록 조회(검색조건 + 페이징). READ 권한 필요. */
@GetMapping @GetMapping
@RequirePermission(menu = "ORG_AGENT", perm = "READ") @RequirePermission(menu = "ORG_AGENT", perm = "READ")
public ApiResponse<PageResponse<AgentResp>> list(@ModelAttribute AgentSearchParam param) { public ApiResponse<PageResponse<AgentResp>> list(@ModelAttribute AgentSearchParam param) {
return ApiResponse.ok(agentService.list(param)); return ApiResponse.ok(agentService.list(param));
} }
/** 설계사 단건 상세 조회. READ 권한 필요. */
@GetMapping("/{agentId}") @GetMapping("/{agentId}")
@RequirePermission(menu = "ORG_AGENT", perm = "READ") @RequirePermission(menu = "ORG_AGENT", perm = "READ")
public ApiResponse<AgentResp> detail(@PathVariable Long agentId) { public ApiResponse<AgentResp> detail(@PathVariable Long agentId) {
return ApiResponse.ok(agentService.detail(agentId)); return ApiResponse.ok(agentService.detail(agentId));
} }
/** 신규 설계사 등록(입사). 등록 시 입사 이력이 함께 생성된다. CREATE 권한 필요. */
@PostMapping @PostMapping
@RequirePermission(menu = "ORG_AGENT", perm = "CREATE") @RequirePermission(menu = "ORG_AGENT", perm = "CREATE")
@DataChangeLog(menu = "ORG_AGENT", table = "agent") @DataChangeLog(menu = "ORG_AGENT", table = "agent")
@@ -44,6 +56,7 @@ public class AgentController {
return ApiResponse.ok(agentService.create(req)); return ApiResponse.ok(agentService.create(req));
} }
/** 설계사 정보 수정. 조직/직급이 바뀌면 전배/승진 이력이 자동 기록된다. UPDATE 권한 필요. */
@PutMapping("/{agentId}") @PutMapping("/{agentId}")
@RequirePermission(menu = "ORG_AGENT", perm = "UPDATE") @RequirePermission(menu = "ORG_AGENT", perm = "UPDATE")
@DataChangeLog(menu = "ORG_AGENT", table = "agent") @DataChangeLog(menu = "ORG_AGENT", table = "agent")
@@ -52,6 +65,7 @@ public class AgentController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 설계사 상태 변경(예: ACTIVE 재직 → 퇴사/휴직 등). body의 "status" 값을 코드로 검증한다. UPDATE 권한 필요. */
@PutMapping("/{agentId}/status") @PutMapping("/{agentId}/status")
@RequirePermission(menu = "ORG_AGENT", perm = "UPDATE") @RequirePermission(menu = "ORG_AGENT", perm = "UPDATE")
@DataChangeLog(menu = "ORG_AGENT", table = "agent") @DataChangeLog(menu = "ORG_AGENT", table = "agent")
@@ -60,12 +74,14 @@ public class AgentController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 설계사 조직/직급 변경 이력(입사·전배·승진) 조회. READ 권한 필요. */
@GetMapping("/{agentId}/history") @GetMapping("/{agentId}/history")
@RequirePermission(menu = "ORG_AGENT", perm = "READ") @RequirePermission(menu = "ORG_AGENT", perm = "READ")
public ApiResponse<List<AgentOrgHistoryResp>> history(@PathVariable Long agentId) { public ApiResponse<List<AgentOrgHistoryResp>> history(@PathVariable Long agentId) {
return ApiResponse.ok(agentService.history(agentId)); return ApiResponse.ok(agentService.history(agentId));
} }
/** 설계사 목록 엑셀 다운로드. 대용량 대비 커서 스트리밍으로 출력한다. EXPORT 권한 필요. */
@GetMapping("/export") @GetMapping("/export")
@RequirePermission(menu = "ORG_AGENT", perm = "EXPORT") @RequirePermission(menu = "ORG_AGENT", perm = "EXPORT")
public void export(@ModelAttribute AgentSearchParam param, HttpServletResponse response) { public void export(@ModelAttribute AgentSearchParam param, HttpServletResponse response) {
@@ -14,6 +14,14 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
/**
* 조직(본부/지점 ) 관리 API.
*
* <p>조직은 부모-자식 관계의 계층(트리) 구조를 가진다. 설계사는 말단 조직에 소속되며,
* 수수료 정산·실적 집계는 조직 계층을 따라 상위로 롤업된다.</p>
*
* <p>메뉴 ORG_TREE 권한으로 보호되며, 삭제는 하위 조직/소속 설계사가 없을 때만 허용된다(아래 서비스 참고).</p>
*/
@Tag(name = "조직 관리") @Tag(name = "조직 관리")
@RestController @RestController
@RequestMapping("/api/orgs") @RequestMapping("/api/orgs")
@@ -22,12 +30,14 @@ public class OrganizationController {
private final OrganizationService service; private final OrganizationService service;
/** 조직 전체를 트리(계층) 구조로 조회. READ 권한 필요. */
@GetMapping("/tree") @GetMapping("/tree")
@RequirePermission(menu = "ORG_TREE", perm = "READ") @RequirePermission(menu = "ORG_TREE", perm = "READ")
public ApiResponse<List<OrganizationResp>> tree() { public ApiResponse<List<OrganizationResp>> tree() {
return ApiResponse.ok(service.getTree()); return ApiResponse.ok(service.getTree());
} }
/** 조직 목록을 평면(flat) 리스트로 조회(검색어/조직유형/활성여부 필터). READ 권한 필요. */
@GetMapping @GetMapping
@RequirePermission(menu = "ORG_TREE", perm = "READ") @RequirePermission(menu = "ORG_TREE", perm = "READ")
public ApiResponse<List<OrganizationResp>> list(@RequestParam(required = false) String keyword, public ApiResponse<List<OrganizationResp>> list(@RequestParam(required = false) String keyword,
@@ -36,12 +46,14 @@ public class OrganizationController {
return ApiResponse.ok(service.list(keyword, orgType, isActive)); return ApiResponse.ok(service.list(keyword, orgType, isActive));
} }
/** 조직 단건 상세 조회. READ 권한 필요. */
@GetMapping("/{orgId}") @GetMapping("/{orgId}")
@RequirePermission(menu = "ORG_TREE", perm = "READ") @RequirePermission(menu = "ORG_TREE", perm = "READ")
public ApiResponse<OrganizationVO> detail(@PathVariable Long orgId) { public ApiResponse<OrganizationVO> detail(@PathVariable Long orgId) {
return ApiResponse.ok(service.get(orgId)); return ApiResponse.ok(service.get(orgId));
} }
/** 신규 조직 등록. CREATE 권한 필요. */
@PostMapping @PostMapping
@RequirePermission(menu = "ORG_TREE", perm = "CREATE") @RequirePermission(menu = "ORG_TREE", perm = "CREATE")
@DataChangeLog(menu = "ORG_TREE", table = "organization") @DataChangeLog(menu = "ORG_TREE", table = "organization")
@@ -49,6 +61,7 @@ public class OrganizationController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 조직 정보 수정. UPDATE 권한 필요. */
@PutMapping("/{orgId}") @PutMapping("/{orgId}")
@RequirePermission(menu = "ORG_TREE", perm = "UPDATE") @RequirePermission(menu = "ORG_TREE", perm = "UPDATE")
@DataChangeLog(menu = "ORG_TREE", table = "organization") @DataChangeLog(menu = "ORG_TREE", table = "organization")
@@ -57,6 +70,7 @@ public class OrganizationController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 조직 삭제. 하위 조직 또는 소속 설계사가 있으면 삭제 불가(서비스에서 검증). DELETE 권한 필요. */
@DeleteMapping("/{orgId}") @DeleteMapping("/{orgId}")
@RequirePermission(menu = "ORG_TREE", perm = "DELETE") @RequirePermission(menu = "ORG_TREE", perm = "DELETE")
@DataChangeLog(menu = "ORG_TREE", table = "organization") @DataChangeLog(menu = "ORG_TREE", table = "organization")
@@ -11,6 +11,14 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
/**
* 보험사(원수사) 관리 REST 컨트롤러.
* 우리 GA가 상품을 위탁판매하는 보험회사(: 삼성생명, KB손해보험 ) 마스터를 관리한다.
* 모든 상품/요율/수수료 계산의 출발점이 되는 기준 데이터이다.
*
* - @RequirePermission: 메뉴/권한(READ·CREATE·UPDATE) 체크. 권한 없으면 호출 거부.
* - @DataChangeLog: 데이터 변경 감사 로그(누가/언제/무엇을 바꿨는지) 자동 기록.
*/
@Tag(name = "보험사 관리") @Tag(name = "보험사 관리")
@RestController @RestController
@RequestMapping("/api/companies") @RequestMapping("/api/companies")
@@ -19,18 +27,21 @@ public class CompanyController {
private final InsuranceCompanyService companyService; private final InsuranceCompanyService companyService;
/** 보험사 목록 조회. activeOnly=true 면 사용중(활성) 보험사만 반환. */
@GetMapping @GetMapping
@RequirePermission(menu = "COMPANY", perm = "READ") @RequirePermission(menu = "COMPANY", perm = "READ")
public ApiResponse<List<InsuranceCompanyVO>> list(@RequestParam(required = false, defaultValue = "false") boolean activeOnly) { public ApiResponse<List<InsuranceCompanyVO>> list(@RequestParam(required = false, defaultValue = "false") boolean activeOnly) {
return ApiResponse.ok(companyService.list(activeOnly)); return ApiResponse.ok(companyService.list(activeOnly));
} }
/** 보험사 단건 상세 조회 (URL 경로의 companyId 기준). */
@GetMapping("/{companyId}") @GetMapping("/{companyId}")
@RequirePermission(menu = "COMPANY", perm = "READ") @RequirePermission(menu = "COMPANY", perm = "READ")
public ApiResponse<InsuranceCompanyVO> detail(@PathVariable Long companyId) { public ApiResponse<InsuranceCompanyVO> detail(@PathVariable Long companyId) {
return ApiResponse.ok(companyService.detail(companyId)); return ApiResponse.ok(companyService.detail(companyId));
} }
/** 보험사 신규 등록. 생성된 PK(companyId)를 반환. */
@PostMapping @PostMapping
@RequirePermission(menu = "COMPANY", perm = "CREATE") @RequirePermission(menu = "COMPANY", perm = "CREATE")
@DataChangeLog(menu = "COMPANY", table = "insurance_company") @DataChangeLog(menu = "COMPANY", table = "insurance_company")
@@ -38,6 +49,7 @@ public class CompanyController {
return ApiResponse.ok(companyService.create(vo)); return ApiResponse.ok(companyService.create(vo));
} }
/** 보험사 정보 수정 (경로 companyId 대상). */
@PutMapping("/{companyId}") @PutMapping("/{companyId}")
@RequirePermission(menu = "COMPANY", perm = "UPDATE") @RequirePermission(menu = "COMPANY", perm = "UPDATE")
@DataChangeLog(menu = "COMPANY", table = "insurance_company") @DataChangeLog(menu = "COMPANY", table = "insurance_company")
@@ -15,6 +15,11 @@ import org.springframework.web.bind.annotation.*;
import java.util.Map; import java.util.Map;
/**
* 보험계약 관리 REST 컨트롤러.
* 계약(contract) "어떤 설계사가 어떤 고객에게 어떤 상품을 팔았는가" 나타내는 핵심 거래 데이터로,
* 이후 수수료 계산·분급(installment)·차등환수(chargeback) 기준이 된다.
*/
@Tag(name = "계약 관리") @Tag(name = "계약 관리")
@RestController @RestController
@RequestMapping("/api/contracts") @RequestMapping("/api/contracts")
@@ -23,18 +28,21 @@ public class ContractController {
private final ContractService service; private final ContractService service;
/** 계약 목록 조회. @ModelAttribute 로 검색조건(증권번호·기간 등)을 받아 페이징 결과를 반환. */
@GetMapping @GetMapping
@RequirePermission(menu = "CONTRACT_LIST", perm = "READ") @RequirePermission(menu = "CONTRACT_LIST", perm = "READ")
public ApiResponse<PageResponse<ContractResp>> list(@ModelAttribute ContractSearchParam param) { public ApiResponse<PageResponse<ContractResp>> list(@ModelAttribute ContractSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 계약 단건 상세 조회. */
@GetMapping("/{contractId}") @GetMapping("/{contractId}")
@RequirePermission(menu = "CONTRACT_LIST", perm = "READ") @RequirePermission(menu = "CONTRACT_LIST", perm = "READ")
public ApiResponse<ContractResp> detail(@PathVariable Long contractId) { public ApiResponse<ContractResp> detail(@PathVariable Long contractId) {
return ApiResponse.ok(service.detail(contractId)); return ApiResponse.ok(service.detail(contractId));
} }
/** 계약 신규 등록. @Valid 로 필수값 검증 후 생성된 PK(contractId) 반환. */
@PostMapping @PostMapping
@RequirePermission(menu = "CONTRACT_LIST", perm = "CREATE") @RequirePermission(menu = "CONTRACT_LIST", perm = "CREATE")
@DataChangeLog(menu = "CONTRACT_LIST", table = "contract") @DataChangeLog(menu = "CONTRACT_LIST", table = "contract")
@@ -42,6 +50,7 @@ public class ContractController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 계약 정보 수정. */
@PutMapping("/{contractId}") @PutMapping("/{contractId}")
@RequirePermission(menu = "CONTRACT_LIST", perm = "UPDATE") @RequirePermission(menu = "CONTRACT_LIST", perm = "UPDATE")
@DataChangeLog(menu = "CONTRACT_LIST", table = "contract") @DataChangeLog(menu = "CONTRACT_LIST", table = "contract")
@@ -50,6 +59,7 @@ public class ContractController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 계약 상태 변경(예: 정상 ACTIVE → 해지 CANCELLED). body 의 "status" 값만 사용. 해지 시 차등환수 계산 대상이 됨. */
@PutMapping("/{contractId}/status") @PutMapping("/{contractId}/status")
@RequirePermission(menu = "CONTRACT_LIST", perm = "UPDATE") @RequirePermission(menu = "CONTRACT_LIST", perm = "UPDATE")
@DataChangeLog(menu = "CONTRACT_LIST", table = "contract") @DataChangeLog(menu = "CONTRACT_LIST", table = "contract")
@@ -11,6 +11,12 @@ import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 보험상품 관리 REST 컨트롤러.
* 상품(product) 보험사가 판매하는 개별 상품으로, 상품에는
* company_rate(보험사가 GA에 주는 요율)·payout_rate(GA가 설계사에게 지급하는 요율)
* 수수료 계산의 핵심 요율 정보가 붙는다.
*/
@Tag(name = "상품 관리") @Tag(name = "상품 관리")
@RestController @RestController
@RequestMapping("/api/products") @RequestMapping("/api/products")
@@ -19,6 +25,7 @@ public class ProductController {
private final ProductService productService; private final ProductService productService;
/** 상품 목록 조회. 보험사/보험종류/키워드/활성여부로 필터링하며 페이징 처리(pageNum/pageSize)된다. */
@GetMapping @GetMapping
@RequirePermission(menu = "PRODUCT", perm = "READ") @RequirePermission(menu = "PRODUCT", perm = "READ")
public ApiResponse<PageResponse<ProductResp>> list(@RequestParam(defaultValue = "1") int pageNum, public ApiResponse<PageResponse<ProductResp>> list(@RequestParam(defaultValue = "1") int pageNum,
@@ -30,12 +37,14 @@ public class ProductController {
return ApiResponse.ok(productService.list(pageNum, pageSize, companyId, insuranceType, keyword, isActive)); return ApiResponse.ok(productService.list(pageNum, pageSize, companyId, insuranceType, keyword, isActive));
} }
/** 상품 단건 상세 조회. */
@GetMapping("/{productId}") @GetMapping("/{productId}")
@RequirePermission(menu = "PRODUCT", perm = "READ") @RequirePermission(menu = "PRODUCT", perm = "READ")
public ApiResponse<ProductResp> detail(@PathVariable Long productId) { public ApiResponse<ProductResp> detail(@PathVariable Long productId) {
return ApiResponse.ok(productService.detail(productId)); return ApiResponse.ok(productService.detail(productId));
} }
/** 상품 신규 등록. 생성된 PK(productId) 반환. */
@PostMapping @PostMapping
@RequirePermission(menu = "PRODUCT", perm = "CREATE") @RequirePermission(menu = "PRODUCT", perm = "CREATE")
@DataChangeLog(menu = "PRODUCT", table = "product") @DataChangeLog(menu = "PRODUCT", table = "product")
@@ -43,6 +52,7 @@ public class ProductController {
return ApiResponse.ok(productService.create(vo)); return ApiResponse.ok(productService.create(vo));
} }
/** 상품 정보(요율 등) 수정. */
@PutMapping("/{productId}") @PutMapping("/{productId}")
@RequirePermission(menu = "PRODUCT", perm = "UPDATE") @RequirePermission(menu = "PRODUCT", perm = "UPDATE")
@DataChangeLog(menu = "PRODUCT", table = "product") @DataChangeLog(menu = "PRODUCT", table = "product")
@@ -51,6 +61,7 @@ public class ProductController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 상품 삭제. */
@DeleteMapping("/{productId}") @DeleteMapping("/{productId}")
@RequirePermission(menu = "PRODUCT", perm = "DELETE") @RequirePermission(menu = "PRODUCT", perm = "DELETE")
@DataChangeLog(menu = "PRODUCT", table = "product") @DataChangeLog(menu = "PRODUCT", table = "product")
@@ -12,6 +12,19 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
/**
* [데이터 수신 매핑/원본 관리 API]
*
* 신입 개발자 안내:
* - 보험사마다 보내주는 수수료 데이터의 컬럼명/코드값이 제각각이다. 이를 우리 표준으로 바꾸기 위한 설정이 "매핑"이다.
* - 구성 요소:
* company_profile : 보험사별 수신 설정(파일 형식, 헤더 위치 )
* company_field_mapping : 보험사 컬럼 우리 DB 필드 매핑
* code_mapping : 보험사 코드값 우리 표준 코드값 매핑
* raw_commission_data : 수신한 원본 데이터(파싱 상태 포함)
* parse_error_log : 파싱 실패 건과 처리(resolve) 상태
* - 업로드 템플릿(upload) "엑셀 수동 적재"라면, 여기 매핑은 "보험사별 자동 수신/파싱 규칙" 가깝다.
*/
@Tag(name = "데이터 수신") @Tag(name = "데이터 수신")
@RestController @RestController
@RequestMapping("/api/receive") @RequestMapping("/api/receive")
@@ -82,6 +95,7 @@ public class ReceiveController {
} }
// 원본 데이터 + 에러 // 원본 데이터 + 에러
// raw: 수신한 원본 목록(보험사/정산월/파싱상태로 필터). errors: 파싱 실패 로그. resolve: 실패 건을 처리완료로 표시.
@GetMapping("/raw") @GetMapping("/raw")
@RequirePermission(menu = "RECEIVE_DATA", perm = "READ") @RequirePermission(menu = "RECEIVE_DATA", perm = "READ")
public ApiResponse<List<RawCommissionDataVO>> rawList(@RequestParam(required = false) String companyCode, public ApiResponse<List<RawCommissionDataVO>> rawList(@RequestParam(required = false) String companyCode,
@@ -4,6 +4,11 @@ import jakarta.validation.constraints.NotBlank;
import lombok.Getter; import lombok.Getter;
import lombok.Setter; import lombok.Setter;
/**
* 파싱 에러 처리(resolve) 요청 본문.
* status: 처리 결과 상태(: 해결됨/보류 ) 필수.
* note : 처리 사유/메모 선택.
*/
@Getter @Getter
@Setter @Setter
public class ResolveErrorReq { public class ResolveErrorReq {
@@ -7,12 +7,18 @@ import lombok.Data;
import java.math.BigDecimal; import java.math.BigDecimal;
import java.time.LocalDate; import java.time.LocalDate;
/**
* 계약 단위 규제 한도(: 1200%) 위반 여부 체크 요청 DTO.
* "이 계약에 수수료를 additionalAmount 만큼 더 지급해도 규제 한도를 넘지 않는가?" 묻는다.
*/
@Data @Data
public class ContractLimitCheckReq { public class ContractLimitCheckReq {
/** 한도 체크 대상 계약 ID. */
@NotNull @NotNull
private Long contractId; private Long contractId;
/** 추가로 지급하려는 수수료 금액(양수만 허용). 이 금액을 더했을 때 한도 초과 여부를 검사한다. */
@NotNull @NotNull
@Positive @Positive
private BigDecimal additionalAmount; private BigDecimal additionalAmount;
@@ -17,6 +17,13 @@ import org.springframework.web.bind.annotation.*;
import java.time.LocalDate; import java.time.LocalDate;
/**
* 규제 한도 관리 REST 컨트롤러.
* 금융당국 규제(대표적으로 보험모집 수수료의 '1200%': 초년도 수수료를 월납보험료의 12배 이내로 제한)
* 한도마스터(regulatory_limit) 테이블로 관리하고, 계약별 위반 여부를 점검한다.
* - limitService : 한도 마스터 CRUD + 활성/비활성 토글
* - limitChecker : 실제 계약에 적용해 한도 초과 여부 계산(별도 상세 주석 파일)
*/
@Tag(name = "규제 한도 관리") @Tag(name = "규제 한도 관리")
@RestController @RestController
@RequestMapping("/api/regulatory-limits") @RequestMapping("/api/regulatory-limits")
@@ -26,18 +33,21 @@ public class RegulatoryLimitController {
private final RegulatoryLimitService limitService; private final RegulatoryLimitService limitService;
private final RegulatoryLimitChecker limitChecker; private final RegulatoryLimitChecker limitChecker;
/** 한도 마스터 목록 페이징 조회. */
@GetMapping @GetMapping
@RequirePermission(menu = "REGULATORY_LIMIT", perm = "READ") @RequirePermission(menu = "REGULATORY_LIMIT", perm = "READ")
public ApiResponse<PageResponse<RegulatoryLimitResp>> list(RegulatoryLimitSearchParam param) { public ApiResponse<PageResponse<RegulatoryLimitResp>> list(RegulatoryLimitSearchParam param) {
return ApiResponse.ok(limitService.list(param)); return ApiResponse.ok(limitService.list(param));
} }
/** 한도 마스터 단건 상세 조회. */
@GetMapping("/{limitId}") @GetMapping("/{limitId}")
@RequirePermission(menu = "REGULATORY_LIMIT", perm = "READ") @RequirePermission(menu = "REGULATORY_LIMIT", perm = "READ")
public ApiResponse<RegulatoryLimitResp> detail(@PathVariable Long limitId) { public ApiResponse<RegulatoryLimitResp> detail(@PathVariable Long limitId) {
return ApiResponse.ok(limitService.detail(limitId)); return ApiResponse.ok(limitService.detail(limitId));
} }
/** 한도 마스터 신규 등록. */
@PostMapping @PostMapping
@RequirePermission(menu = "REGULATORY_LIMIT", perm = "CREATE") @RequirePermission(menu = "REGULATORY_LIMIT", perm = "CREATE")
@DataChangeLog(menu = "REGULATORY_LIMIT", table = "regulatory_limit") @DataChangeLog(menu = "REGULATORY_LIMIT", table = "regulatory_limit")
@@ -46,6 +56,7 @@ public class RegulatoryLimitController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 한도 마스터 수정. */
@PutMapping("/{limitId}") @PutMapping("/{limitId}")
@RequirePermission(menu = "REGULATORY_LIMIT", perm = "UPDATE") @RequirePermission(menu = "REGULATORY_LIMIT", perm = "UPDATE")
@DataChangeLog(menu = "REGULATORY_LIMIT", table = "regulatory_limit") @DataChangeLog(menu = "REGULATORY_LIMIT", table = "regulatory_limit")
@@ -55,6 +66,7 @@ public class RegulatoryLimitController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 한도 마스터 비활성화(삭제 대신 사용 중지 처리). 비활성 한도는 위반 체크에서 제외된다. */
@PutMapping("/{limitId}/deactivate") @PutMapping("/{limitId}/deactivate")
@RequirePermission(menu = "REGULATORY_LIMIT", perm = "UPDATE") @RequirePermission(menu = "REGULATORY_LIMIT", perm = "UPDATE")
@DataChangeLog(menu = "REGULATORY_LIMIT", table = "regulatory_limit") @DataChangeLog(menu = "REGULATORY_LIMIT", table = "regulatory_limit")
@@ -63,6 +75,7 @@ public class RegulatoryLimitController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 한도 마스터 재활성화. 같은 유형의 활성 한도가 이미 있으면 중복 오류. */
@PutMapping("/{limitId}/activate") @PutMapping("/{limitId}/activate")
@RequirePermission(menu = "REGULATORY_LIMIT", perm = "UPDATE") @RequirePermission(menu = "REGULATORY_LIMIT", perm = "UPDATE")
@DataChangeLog(menu = "REGULATORY_LIMIT", table = "regulatory_limit") @DataChangeLog(menu = "REGULATORY_LIMIT", table = "regulatory_limit")
@@ -71,6 +84,11 @@ public class RegulatoryLimitController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/**
* 특정 계약에 수수료를 지급했을 규제 한도 위반 여부를 점검한다.
* limitType FIRST_YEAR_RATIO 초년도( 1년) 기준, (TOTAL_RATIO) 계약 전체 누적 기준으로 검사.
* baseDate 없으면 오늘 날짜를 기준일로 사용한다.
*/
@PostMapping("/check-contract") @PostMapping("/check-contract")
@RequirePermission(menu = "REGULATORY_LIMIT", perm = "READ") @RequirePermission(menu = "REGULATORY_LIMIT", perm = "READ")
public ApiResponse<ViolationResult> checkContract(@Valid @RequestBody ContractLimitCheckReq req) { public ApiResponse<ViolationResult> checkContract(@Valid @RequestBody ContractLimitCheckReq req) {
@@ -7,6 +7,7 @@ import com.ga.common.model.ApiResponse;
import com.ga.core.vo.report.ChargebackRiskRow; import com.ga.core.vo.report.ChargebackRiskRow;
import com.ga.core.vo.report.OrgReportRow; import com.ga.core.vo.report.OrgReportRow;
import com.ga.core.vo.report.PerfReportRow; import com.ga.core.vo.report.PerfReportRow;
import com.ga.core.vo.report.SimplifiedPaymentRow;
import io.swagger.v3.oas.annotations.tags.Tag; import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.servlet.http.HttpServletResponse; import jakarta.servlet.http.HttpServletResponse;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
@@ -19,6 +20,16 @@ import java.util.List;
/** /**
* 리포트 실적 / 조직별 / 환수위험. 읽기전용 집계 (신규 테이블 없음). * 리포트 실적 / 조직별 / 환수위험. 읽기전용 집계 (신규 테이블 없음).
* 화면의 조회 + 엑셀 export 엔드포인트 제공. * 화면의 조회 + 엑셀 export 엔드포인트 제공.
*
* [신입 개발자 안내]
* - 모든 리포트는 기존 정산/지급 데이터를 SQL 모아 보여주는 "읽기 전용 집계"(저장 테이블을 새로 만들지 않음).
* - 리포트마다 화면 조회용(JSON 목록) 엑셀 다운로드용(/export, Cursor 스트리밍) 개가 쌍이다.
* - year/settleMonth 파라미터가 없으면 defaultYear/defaultMonth "올해/이번 달" 기본 적용한다.
* - 리포트 종류:
* performance : 설계사/연도별 실적
* org : 조직(지점) 집계
* chargeback-risk : 환수(이미 수수료를 도로 회수) 위험 목록
* simplified-payment : 사업소득 간이지급명세서(국세청 제출용 월별 자료)
*/ */
@Tag(name = "리포트") @Tag(name = "리포트")
@RestController @RestController
@@ -81,4 +92,19 @@ public class ReportController {
excelService.exportLargeExcel("환수위험리포트", ChargebackRiskRow.class, excelService.exportLargeExcel("환수위험리포트", ChargebackRiskRow.class,
() -> service.chargebackRiskCursor(), response); () -> service.chargebackRiskCursor(), response);
} }
// 사업소득 간이지급명세서 (월별)
@GetMapping("/simplified-payment")
@RequirePermission(menu = "REPORT_SIMPLIFIED_PAYMENT", perm = "READ")
public ApiResponse<List<SimplifiedPaymentRow>> simplifiedPayment(@RequestParam(required = false) String settleMonth) {
return ApiResponse.ok(service.simplifiedPayment(defaultMonth(settleMonth)));
}
@GetMapping("/simplified-payment/export")
@RequirePermission(menu = "REPORT_SIMPLIFIED_PAYMENT", perm = "READ")
public void simplifiedPaymentExport(@RequestParam(required = false) String settleMonth, HttpServletResponse response) {
String m = defaultMonth(settleMonth);
excelService.exportLargeExcel("간이지급명세서_" + m, SimplifiedPaymentRow.class,
() -> service.simplifiedPaymentCursor(m), response);
}
} }
@@ -11,6 +11,16 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
/**
* 수수료 규정() 관리 REST 컨트롤러.
* 수수료 계산에 쓰이는 각종 기준표를 CRUD 한다. 다섯 가지 그룹으로 구성된다.
* - commission_rate : 상품별 보험사 지급요율(company_rate) 기준표
* - payout_rule : 설계사 등급(grade) 지급요율(payout_rate) 규칙
* - override_rule : 상위 관리자에게 주는 오버라이드(육성) 수당 규칙
* - chargeback_rule : 조기해지 환수율(차등환수) 규칙
* - exception_type_code : 예외 처리 유형 코드
* 기준표들을 잘못 등록하면 직원 수수료 계산이 틀어지므로 권한·감사로그가 엄격히 걸려 있다.
*/
@Tag(name = "수수료 규정") @Tag(name = "수수료 규정")
@RestController @RestController
@RequestMapping("/api/rules") @RequestMapping("/api/rules")
@@ -19,7 +29,7 @@ public class RuleController {
private final RuleService ruleService; private final RuleService ruleService;
// ========== commission_rate ========== // ========== commission_rate : 상품별 보험사 지급요율(company_rate) 기준표 CRUD ==========
@GetMapping("/commission-rates") @GetMapping("/commission-rates")
@RequirePermission(menu = "RULE_COMMISSION", perm = "READ") @RequirePermission(menu = "RULE_COMMISSION", perm = "READ")
public ApiResponse<List<CommissionRateVO>> listCommissionRates(@RequestParam(required = false) Long productId, public ApiResponse<List<CommissionRateVO>> listCommissionRates(@RequestParam(required = false) Long productId,
@@ -50,7 +60,7 @@ public class RuleController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
// ========== payout_rule ========== // ========== payout_rule : 설계사 등급(grade) 지급요율(payout_rate) 규칙 CRUD ==========
@GetMapping("/payout") @GetMapping("/payout")
@RequirePermission(menu = "RULE_PAYOUT", perm = "READ") @RequirePermission(menu = "RULE_PAYOUT", perm = "READ")
public ApiResponse<List<PayoutRuleVO>> listPayoutRules(@RequestParam(required = false) Long gradeId, public ApiResponse<List<PayoutRuleVO>> listPayoutRules(@RequestParam(required = false) Long gradeId,
@@ -81,7 +91,7 @@ public class RuleController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
// ========== override_rule ========== // ========== override_rule : 상위 관리자 오버라이드(육성) 수당 규칙 CRUD ==========
@GetMapping("/override") @GetMapping("/override")
@RequirePermission(menu = "RULE_OVERRIDE", perm = "READ") @RequirePermission(menu = "RULE_OVERRIDE", perm = "READ")
public ApiResponse<List<OverrideRuleVO>> listOverrideRules() { public ApiResponse<List<OverrideRuleVO>> listOverrideRules() {
@@ -111,7 +121,7 @@ public class RuleController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
// ========== chargeback_rule ========== // ========== chargeback_rule : 조기해지 환수율(차등환수) 규칙 CRUD ==========
@GetMapping("/chargeback") @GetMapping("/chargeback")
@RequirePermission(menu = "RULE_CHARGEBACK", perm = "READ") @RequirePermission(menu = "RULE_CHARGEBACK", perm = "READ")
public ApiResponse<List<ChargebackRuleVO>> listChargebackRules(@RequestParam(required = false) String companyCode) { public ApiResponse<List<ChargebackRuleVO>> listChargebackRules(@RequestParam(required = false) String companyCode) {
@@ -141,7 +151,7 @@ public class RuleController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
// ========== exception_type_code ========== // ========== exception_type_code : 예외 처리 유형 코드 관리(코드값 기반) ==========
@GetMapping("/exception-codes") @GetMapping("/exception-codes")
@RequirePermission(menu = "RULE_EXCEPTION", perm = "READ") @RequirePermission(menu = "RULE_EXCEPTION", perm = "READ")
public ApiResponse<List<ExceptionTypeCodeVO>> listExceptionCodes() { public ApiResponse<List<ExceptionTypeCodeVO>> listExceptionCodes() {
@@ -13,6 +13,14 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 보험사 회신(carrier_reconciliation_out) 관리 컨트롤러.
*
* <p>GA가 보험사로 보낸 정산 자료에 대해 "어떤 파일을 언제 회신/전송했는지" 이력을 관리하는 화면입니다.
* 건은 "보험사 1곳 × 정산월 1개" 유일하며, 전송 실패(FAIL) 건은 retry 다시 READY 돌려 배치가 재전송합니다.
*
* <p>상태: READY(전송대기) (배치 처리) 성공/FAIL. 권한(menu=RECON_OUT): 조회 READ, 등록 CREATE, 재전송 UPDATE.
*/
@Tag(name = "보험사 회신 관리") @Tag(name = "보험사 회신 관리")
@RestController @RestController
@RequestMapping("/api/carrier-reconciliation") @RequestMapping("/api/carrier-reconciliation")
@@ -21,18 +29,21 @@ public class CarrierReconciliationOutController {
private final CarrierReconciliationOutService service; private final CarrierReconciliationOutService service;
/** 보험사 회신 이력 목록 조회(검색 + 페이징). */
@GetMapping @GetMapping
@RequirePermission(menu = "RECON_OUT", perm = "READ") @RequirePermission(menu = "RECON_OUT", perm = "READ")
public ApiResponse<PageResponse<CarrierReconciliationOutResp>> list(@ModelAttribute CarrierReconciliationOutSearchParam param) { public ApiResponse<PageResponse<CarrierReconciliationOutResp>> list(@ModelAttribute CarrierReconciliationOutSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 회신 이력 단건 상세 조회. */
@GetMapping("/{reconOutId}") @GetMapping("/{reconOutId}")
@RequirePermission(menu = "RECON_OUT", perm = "READ") @RequirePermission(menu = "RECON_OUT", perm = "READ")
public ApiResponse<CarrierReconciliationOutResp> detail(@PathVariable Long reconOutId) { public ApiResponse<CarrierReconciliationOutResp> detail(@PathVariable Long reconOutId) {
return ApiResponse.ok(service.detail(reconOutId)); return ApiResponse.ok(service.detail(reconOutId));
} }
/** 회신 이력 신규 등록(READY 상태로 시작). 같은 보험사+정산월 중복 등록은 거부됩니다. */
@PostMapping @PostMapping
@RequirePermission(menu = "RECON_OUT", perm = "CREATE") @RequirePermission(menu = "RECON_OUT", perm = "CREATE")
@DataChangeLog(menu = "RECON_OUT", table = "carrier_reconciliation_out") @DataChangeLog(menu = "RECON_OUT", table = "carrier_reconciliation_out")
@@ -40,6 +51,7 @@ public class CarrierReconciliationOutController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 전송 실패(FAIL) 건 재전송. 상태를 READY 로 되돌려 배치가 다시 처리하도록 합니다. */
@PostMapping("/{reconOutId}/retry") @PostMapping("/{reconOutId}/retry")
@RequirePermission(menu = "RECON_OUT", perm = "UPDATE") @RequirePermission(menu = "RECON_OUT", perm = "UPDATE")
@DataChangeLog(menu = "RECON_OUT", table = "carrier_reconciliation_out") @DataChangeLog(menu = "RECON_OUT", table = "carrier_reconciliation_out")
@@ -0,0 +1,68 @@
package com.ga.api.controller.settle;
import com.ga.api.service.settle.ChargebackService;
import com.ga.api.service.settle.ChargebackUploadService;
import com.ga.common.annotation.DataChangeLog;
import com.ga.common.annotation.RequirePermission;
import com.ga.common.model.ApiResponse;
import com.ga.common.model.PageResponse;
import com.ga.core.vo.settle.ChargebackResp;
import com.ga.core.vo.settle.ChargebackSearchParam;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.validation.constraints.Pattern;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
/**
* 환수(chargeback) 자료 관리 컨트롤러.
*
* <p>"환수" 이미 설계사에게 지급한 수수료를 도로 거둬들이는 것입니다. 계약이 일찍 해지/실효되면
* 보험사가 GA에게 수수료를 돌려달라 하고, GA는 그만큼을 설계사 정산에서 회수합니다.
*
* <p> 업무는 보험사가 보내준 환수 엑셀(증권번호·환수금액·실효월·환수율) 업로드(upload)
* chargeback 테이블에 적재하는 것입니다. 존재하지 않는 증권번호나 잘못된 금액은 에러행으로 돌려주고,
* 같은 계약+정산월 중복은 건너뜁니다(스킵).
*
* <p>권한(menu=CHARGEBACK_DATA): 조회 READ, 엑셀 EXPORT, 업로드 CREATE.
*/
@Tag(name = "환수자료 관리")
@Validated
@RestController
@RequestMapping("/api/chargebacks")
@RequiredArgsConstructor
public class ChargebackController {
private final ChargebackService chargebackService;
private final ChargebackUploadService chargebackUploadService;
@Operation(summary = "환수자료 목록 조회")
@GetMapping
@RequirePermission(menu = "CHARGEBACK_DATA", perm = "READ")
public ApiResponse<PageResponse<ChargebackResp>> list(@ModelAttribute ChargebackSearchParam param) {
return ApiResponse.ok(chargebackService.list(param));
}
@Operation(summary = "환수자료 엑셀 다운로드")
@GetMapping("/export")
@RequirePermission(menu = "CHARGEBACK_DATA", perm = "EXPORT")
public void export(@ModelAttribute ChargebackSearchParam param, HttpServletResponse response) {
chargebackService.export(param, response);
}
@Operation(summary = "보험사 환수자료 업로드",
description = "정산월(YYYYMM) + 엑셀 파일(증권번호/환수금액/실효월/환수율). " +
"미존재 증권번호·cbAmount 오류는 에러행으로 반환. 동일 계약+정산월 중복은 스킵.")
@PostMapping("/upload")
@RequirePermission(menu = "CHARGEBACK_DATA", perm = "CREATE")
@DataChangeLog(menu = "CHARGEBACK_DATA", table = "chargeback")
public ApiResponse<ChargebackUploadService.UploadResult> upload(
@Pattern(regexp = "\\d{6}", message = "settleMonth는 YYYYMM 형식이어야 합니다")
@RequestParam String settleMonth,
@RequestParam("file") MultipartFile file) {
return ApiResponse.ok(chargebackUploadService.upload(settleMonth, file));
}
}
@@ -16,6 +16,18 @@ import org.springframework.web.bind.annotation.*;
import java.math.BigDecimal; import java.math.BigDecimal;
import java.util.Map; import java.util.Map;
/**
* 수수료 이의신청(commission_dispute) 관리 컨트롤러.
*
* <p>설계사가 "내 수수료 정산 금액이 이상하다" 문제를 제기하면 이의신청 건이 만들어집니다.
* 담당자는 검토를 시작(startReview)하고, 타당하면 승인(approve)하며 보정 금액을 정정(correction) 연결하거나,
* 타당하지 않으면 기각(reject)합니다.
*
* <p>상태 흐름(DisputeStatus): OPEN(접수) IN_REVIEW(검토중) APPROVED(승인)/REJECTED(기각).
* 승인/기각은 IN_REVIEW 상태에서만 가능합니다.
*
* <p>권한(menu=DISPUTE): 조회 READ, 접수 CREATE, 검토시작 UPDATE, 승인/기각 APPROVE.
*/
@Tag(name = "수수료 이의신청 관리") @Tag(name = "수수료 이의신청 관리")
@RestController @RestController
@RequestMapping("/api/disputes") @RequestMapping("/api/disputes")
@@ -24,18 +36,21 @@ public class CommissionDisputeController {
private final CommissionDisputeService service; private final CommissionDisputeService service;
/** 이의신청 목록 조회(검색 + 페이징). */
@GetMapping @GetMapping
@RequirePermission(menu = "DISPUTE", perm = "READ") @RequirePermission(menu = "DISPUTE", perm = "READ")
public ApiResponse<PageResponse<CommissionDisputeResp>> list(@ModelAttribute CommissionDisputeSearchParam param) { public ApiResponse<PageResponse<CommissionDisputeResp>> list(@ModelAttribute CommissionDisputeSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 이의신청 단건 상세 조회. */
@GetMapping("/{disputeId}") @GetMapping("/{disputeId}")
@RequirePermission(menu = "DISPUTE", perm = "READ") @RequirePermission(menu = "DISPUTE", perm = "READ")
public ApiResponse<CommissionDisputeResp> detail(@PathVariable Long disputeId) { public ApiResponse<CommissionDisputeResp> detail(@PathVariable Long disputeId) {
return ApiResponse.ok(service.detail(disputeId)); return ApiResponse.ok(service.detail(disputeId));
} }
/** 이의신청 접수(OPEN 상태로 생성). */
@PostMapping @PostMapping
@RequirePermission(menu = "DISPUTE", perm = "CREATE") @RequirePermission(menu = "DISPUTE", perm = "CREATE")
@DataChangeLog(menu = "DISPUTE", table = "commission_dispute") @DataChangeLog(menu = "DISPUTE", table = "commission_dispute")
@@ -43,6 +58,7 @@ public class CommissionDisputeController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 검토 시작(OPEN → IN_REVIEW). */
@PostMapping("/{disputeId}/review") @PostMapping("/{disputeId}/review")
@RequirePermission(menu = "DISPUTE", perm = "UPDATE") @RequirePermission(menu = "DISPUTE", perm = "UPDATE")
@DataChangeLog(menu = "DISPUTE", table = "commission_dispute") @DataChangeLog(menu = "DISPUTE", table = "commission_dispute")
@@ -51,6 +67,10 @@ public class CommissionDisputeController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/**
* 이의신청 승인(IN_REVIEW APPROVED).
* body resolution(처리내용), adjustmentAmount(보정금액, 선택), correctionId(연결된 정산정정ID, 선택) 받습니다.
*/
@PostMapping("/{disputeId}/approve") @PostMapping("/{disputeId}/approve")
@RequirePermission(menu = "DISPUTE", perm = "APPROVE") @RequirePermission(menu = "DISPUTE", perm = "APPROVE")
@DataChangeLog(menu = "DISPUTE", table = "commission_dispute") @DataChangeLog(menu = "DISPUTE", table = "commission_dispute")
@@ -64,6 +84,7 @@ public class CommissionDisputeController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 이의신청 기각(IN_REVIEW → REJECTED). body 의 resolution 에 기각 사유를 담습니다. */
@PostMapping("/{disputeId}/reject") @PostMapping("/{disputeId}/reject")
@RequirePermission(menu = "DISPUTE", perm = "APPROVE") @RequirePermission(menu = "DISPUTE", perm = "APPROVE")
@DataChangeLog(menu = "DISPUTE", table = "commission_dispute") @DataChangeLog(menu = "DISPUTE", table = "commission_dispute")
@@ -15,6 +15,17 @@ import org.springframework.web.bind.annotation.*;
import java.util.Map; import java.util.Map;
/**
* 시책 지급(incentive_payment) 관리 컨트롤러.
*
* <p>"시책" 보험사/GA가 특정 기간·상품에 거는 추가 인센티브(판매 장려금)입니다.
* 시책 프로그램(incentive_program) 조건을 충족한 설계사에게 지급할 금액을 건별로 만들어 확정/취소합니다.
*
* <p>상태 흐름(IncentivePayStatus): CALCULATED(산출) CONFIRMED(확정) PAID(지급완료), 또는 CANCELLED(취소).
* 확정은 CALCULATED 상태에서만, 취소는 PAID 아닐 때만 가능합니다. 생성·확정 정산월 마감 여부를 확인합니다.
*
* <p>권한(menu=INCENTIVE_PAY): 조회 READ, 생성 CREATE, 확정 APPROVE, 취소 UPDATE.
*/
@Tag(name = "시책 지급 관리") @Tag(name = "시책 지급 관리")
@RestController @RestController
@RequestMapping("/api/incentive-payments") @RequestMapping("/api/incentive-payments")
@@ -23,18 +34,21 @@ public class IncentivePaymentController {
private final IncentivePaymentService service; private final IncentivePaymentService service;
/** 시책 지급 목록 조회(검색 + 페이징). */
@GetMapping @GetMapping
@RequirePermission(menu = "INCENTIVE_PAY", perm = "READ") @RequirePermission(menu = "INCENTIVE_PAY", perm = "READ")
public ApiResponse<PageResponse<IncentivePaymentResp>> list(@ModelAttribute IncentivePaymentSearchParam param) { public ApiResponse<PageResponse<IncentivePaymentResp>> list(@ModelAttribute IncentivePaymentSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 시책 지급 단건 상세 조회. */
@GetMapping("/{incentivePayId}") @GetMapping("/{incentivePayId}")
@RequirePermission(menu = "INCENTIVE_PAY", perm = "READ") @RequirePermission(menu = "INCENTIVE_PAY", perm = "READ")
public ApiResponse<IncentivePaymentResp> detail(@PathVariable Long incentivePayId) { public ApiResponse<IncentivePaymentResp> detail(@PathVariable Long incentivePayId) {
return ApiResponse.ok(service.detail(incentivePayId)); return ApiResponse.ok(service.detail(incentivePayId));
} }
/** 시책 지급 생성(CALCULATED 상태). 해당 정산월이 마감되어 있으면 거부됩니다. */
@PostMapping @PostMapping
@RequirePermission(menu = "INCENTIVE_PAY", perm = "CREATE") @RequirePermission(menu = "INCENTIVE_PAY", perm = "CREATE")
@DataChangeLog(menu = "INCENTIVE_PAY", table = "incentive_payment") @DataChangeLog(menu = "INCENTIVE_PAY", table = "incentive_payment")
@@ -42,6 +56,7 @@ public class IncentivePaymentController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 시책 지급 확정(CALCULATED → CONFIRMED). 마감 가드 적용. APPROVE 권한 필요. */
@PostMapping("/{incentivePayId}/confirm") @PostMapping("/{incentivePayId}/confirm")
@RequirePermission(menu = "INCENTIVE_PAY", perm = "APPROVE") @RequirePermission(menu = "INCENTIVE_PAY", perm = "APPROVE")
@DataChangeLog(menu = "INCENTIVE_PAY", table = "incentive_payment") @DataChangeLog(menu = "INCENTIVE_PAY", table = "incentive_payment")
@@ -50,6 +65,7 @@ public class IncentivePaymentController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 시책 지급 취소(→ CANCELLED). body 의 cancelReason 에 취소 사유를 담습니다. 지급완료건은 취소 불가. */
@PostMapping("/{incentivePayId}/cancel") @PostMapping("/{incentivePayId}/cancel")
@RequirePermission(menu = "INCENTIVE_PAY", perm = "UPDATE") @RequirePermission(menu = "INCENTIVE_PAY", perm = "UPDATE")
@DataChangeLog(menu = "INCENTIVE_PAY", table = "incentive_payment") @DataChangeLog(menu = "INCENTIVE_PAY", table = "incentive_payment")
@@ -15,6 +15,16 @@ import org.springframework.web.bind.annotation.*;
import java.util.Map; import java.util.Map;
/**
* 시책 프로그램(incentive_program) 관리 컨트롤러.
*
* <p>시책 "프로그램" 인센티브 지급의 규칙 정의입니다. 대상(등급/조직/상품군), 기간(시작월~종료월),
* 지급 방식(정률 payRate 또는 정액 payAmountFixed), 예산(budgetAmount) 등을 설정합니다.
* 실제 지급(incentive_payment) 프로그램 조건에 따라 산출됩니다.
*
* <p>활성/비활성(isActive) toggleActive 전환합니다. 비활성 프로그램은 신규 지급 대상에서 제외됩니다.
* 권한(menu=INCENTIVE_PROG): 조회 READ, 생성 CREATE, 수정/활성토글 UPDATE.
*/
@Tag(name = "시책 프로그램 관리") @Tag(name = "시책 프로그램 관리")
@RestController @RestController
@RequestMapping("/api/incentive-programs") @RequestMapping("/api/incentive-programs")
@@ -23,18 +33,21 @@ public class IncentiveProgramController {
private final IncentiveProgramService service; private final IncentiveProgramService service;
/** 시책 프로그램 목록 조회(검색 + 페이징). */
@GetMapping @GetMapping
@RequirePermission(menu = "INCENTIVE_PROG", perm = "READ") @RequirePermission(menu = "INCENTIVE_PROG", perm = "READ")
public ApiResponse<PageResponse<IncentiveProgramResp>> list(@ModelAttribute IncentiveProgramSearchParam param) { public ApiResponse<PageResponse<IncentiveProgramResp>> list(@ModelAttribute IncentiveProgramSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 시책 프로그램 단건 상세 조회. */
@GetMapping("/{programId}") @GetMapping("/{programId}")
@RequirePermission(menu = "INCENTIVE_PROG", perm = "READ") @RequirePermission(menu = "INCENTIVE_PROG", perm = "READ")
public ApiResponse<IncentiveProgramResp> detail(@PathVariable Long programId) { public ApiResponse<IncentiveProgramResp> detail(@PathVariable Long programId) {
return ApiResponse.ok(service.detail(programId)); return ApiResponse.ok(service.detail(programId));
} }
/** 시책 프로그램 신규 등록(기본 활성 상태로 생성). */
@PostMapping @PostMapping
@RequirePermission(menu = "INCENTIVE_PROG", perm = "CREATE") @RequirePermission(menu = "INCENTIVE_PROG", perm = "CREATE")
@DataChangeLog(menu = "INCENTIVE_PROG", table = "incentive_program") @DataChangeLog(menu = "INCENTIVE_PROG", table = "incentive_program")
@@ -42,6 +55,7 @@ public class IncentiveProgramController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 시책 프로그램 수정(전체 필드 갱신). */
@PutMapping("/{programId}") @PutMapping("/{programId}")
@RequirePermission(menu = "INCENTIVE_PROG", perm = "UPDATE") @RequirePermission(menu = "INCENTIVE_PROG", perm = "UPDATE")
@DataChangeLog(menu = "INCENTIVE_PROG", table = "incentive_program") @DataChangeLog(menu = "INCENTIVE_PROG", table = "incentive_program")
@@ -50,6 +64,7 @@ public class IncentiveProgramController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 활성/비활성 토글. body 의 isActive(true/false)로 사용 여부를 전환합니다. */
@PutMapping("/{programId}/active") @PutMapping("/{programId}/active")
@RequirePermission(menu = "INCENTIVE_PROG", perm = "UPDATE") @RequirePermission(menu = "INCENTIVE_PROG", perm = "UPDATE")
@DataChangeLog(menu = "INCENTIVE_PROG", table = "incentive_program") @DataChangeLog(menu = "INCENTIVE_PROG", table = "incentive_program")
@@ -0,0 +1,96 @@
package com.ga.api.controller.settle;
import com.ga.api.service.settle.PaymentBatchService;
import com.ga.common.annotation.DataChangeLog;
import com.ga.common.annotation.RequirePermission;
import com.ga.common.model.ApiResponse;
import com.ga.common.model.PageResponse;
import com.ga.core.vo.settle.PaymentBatchItemUpdateReq;
import com.ga.core.vo.settle.PaymentBatchResp;
import com.ga.core.vo.settle.PaymentBatchSaveReq;
import com.ga.core.vo.settle.PaymentBatchSearchParam;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;
/**
* 지급대상 배치(payment_batch) 관리 컨트롤러.
*
* <p>"배치" 정산월에 실제로 돈을 보낼 대상 설계사들을 묶음으로 모은 작업 단위입니다.
* 담당자는 배치를 만들어(create) 대상 명단을 확인하고, 빼야 사람은 제외(updateItem) ,
* 최종 확정(finalize)하여 이후 이체 처리로 넘깁니다.
*
* <p>상태 흐름(PaymentBatchStatus): DRAFT(작성중) FINALIZED(확정) / CANCELLED(취소).
* 수정(updateItem) DRAFT 상태에서만 가능합니다.
*
* <p>권한(menu=PAYMENT_TARGET): 생성 CREATE, 조회/엑셀 READ, 항목수정 UPDATE, 확정 EXECUTE.
*/
@Tag(name = "지급대상 배치 관리")
@RestController
@RequestMapping("/api/payment-batches")
@RequiredArgsConstructor
public class PaymentBatchController {
private final PaymentBatchService service;
@PostMapping
@RequirePermission(menu = "PAYMENT_TARGET", perm = "CREATE")
@DataChangeLog(menu = "PAYMENT_TARGET", table = "payment_batch")
@Operation(summary = "배치 생성", description = "정산월의 지급대상(payable_amount>0) 건으로 DRAFT 배치를 구성합니다")
public ApiResponse<Long> create(@Valid @RequestBody PaymentBatchSaveReq req) {
return ApiResponse.ok(service.create(req));
}
@GetMapping
@RequirePermission(menu = "PAYMENT_TARGET", perm = "READ")
@Operation(summary = "배치 목록 조회")
public ApiResponse<PageResponse<PaymentBatchResp>> list(@ModelAttribute PaymentBatchSearchParam param) {
return ApiResponse.ok(service.list(param));
}
@GetMapping("/{id}")
@RequirePermission(menu = "PAYMENT_TARGET", perm = "READ")
@Operation(summary = "배치 상세 조회", description = "배치 헤더 + items 포함")
public ApiResponse<PaymentBatchResp> detail(@PathVariable Long id) {
return ApiResponse.ok(service.detail(id));
}
@PutMapping("/{id}/items/{itemId}")
@RequirePermission(menu = "PAYMENT_TARGET", perm = "UPDATE")
@DataChangeLog(menu = "PAYMENT_TARGET", table = "payment_batch_item")
@Operation(summary = "지급대상건 포함/제외 수정", description = "DRAFT 배치만 수정 가능합니다")
public ApiResponse<Void> updateItem(@PathVariable Long id,
@PathVariable Long itemId,
@Valid @RequestBody PaymentBatchItemUpdateReq req) {
service.updateItem(id, itemId, req);
return ApiResponse.ok();
}
@PutMapping("/{id}/finalize")
@RequirePermission(menu = "PAYMENT_TARGET", perm = "EXECUTE")
@DataChangeLog(menu = "PAYMENT_TARGET", table = "payment_batch")
@Operation(summary = "배치 확정", description = "DRAFT → FINALIZED. 포함건이 없으면 확정 불가")
public ApiResponse<Void> finalize(@PathVariable Long id) {
service.finalize(id);
return ApiResponse.ok();
}
@PutMapping("/{id}/cancel")
@RequirePermission(menu = "PAYMENT_TARGET", perm = "UPDATE")
@DataChangeLog(menu = "PAYMENT_TARGET", table = "payment_batch")
@Operation(summary = "배치 취소")
public ApiResponse<Void> cancel(@PathVariable Long id) {
service.cancel(id);
return ApiResponse.ok();
}
@GetMapping("/{id}/export")
@RequirePermission(menu = "PAYMENT_TARGET", perm = "READ")
@Operation(summary = "배치 items 엑셀 다운로드")
public void export(@PathVariable Long id, HttpServletResponse response) {
service.export(id, response);
}
}
@@ -16,6 +16,19 @@ import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated; import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 지급(payment) 관리 컨트롤러.
*
* <p>정산 마스터가 "이번 달 줄 금액" 확정하면, 실제 계좌로 보낼 건이 payment(지급) 레코드가 됩니다.
* 컨트롤러는 지급 목록 조회, 상태 변경, 세금 계산, 차감 적용, 은행 이체파일 생성을 담당합니다.
*
* <p>지급 건의 금액 계산 순서(도메인):
* payAmount(지급원금) 세금(소득세·지방세·부가세) 차감 각종 공제(차감) 차감 netAmount(실지급액).
* netAmount 최종적으로 설계사 통장에 들어가는 금액입니다.
*
* <p>@Validated + @Pattern 으로 settleMonth YYYYMM(숫자 6자리) 형식만 허용합니다.
* 권한(menu=PAYMENT): 조회 READ, 상태/세금/차감 변경 UPDATE, 이체파일 생성 EXPORT.
*/
@Tag(name = "지급 관리") @Tag(name = "지급 관리")
@Validated @Validated
@RestController @RestController
@@ -25,12 +38,14 @@ public class PaymentController {
private final PaymentService paymentService; private final PaymentService paymentService;
/** 지급 건 목록 조회(검색 + 페이징). */
@GetMapping @GetMapping
@RequirePermission(menu = "PAYMENT", perm = "READ") @RequirePermission(menu = "PAYMENT", perm = "READ")
public ApiResponse<PageResponse<PaymentResp>> list(@ModelAttribute SettleSearchParam param) { public ApiResponse<PageResponse<PaymentResp>> list(@ModelAttribute SettleSearchParam param) {
return ApiResponse.ok(paymentService.list(param)); return ApiResponse.ok(paymentService.list(param));
} }
/** 지급 상태 수동 변경(예: 실패 처리). 실패 시 req.failReason 에 사유를 담아 기록합니다. */
@PutMapping("/{paymentId}/status") @PutMapping("/{paymentId}/status")
@RequirePermission(menu = "PAYMENT", perm = "UPDATE") @RequirePermission(menu = "PAYMENT", perm = "UPDATE")
@DataChangeLog(menu = "PAYMENT", table = "payment") @DataChangeLog(menu = "PAYMENT", table = "payment")
@@ -4,6 +4,10 @@ import jakarta.validation.constraints.NotBlank;
import lombok.Getter; import lombok.Getter;
import lombok.Setter; import lombok.Setter;
/**
* 지급 상태 변경 요청 DTO.
* status: 변경할 상태값(필수). failReason: 실패 처리 사유(선택).
*/
@Getter @Getter
@Setter @Setter
public class PaymentStatusUpdateReq { public class PaymentStatusUpdateReq {
@@ -15,6 +15,15 @@ import org.springframework.web.bind.annotation.*;
import java.util.Map; import java.util.Map;
/**
* 정산 마감(period_close) 관리 컨트롤러.
*
* <p>"마감" 특정 정산월의 정산 데이터를 잠그는 작업입니다. 마감된 월에는 정정·시책지급 금액을 바꾸는
* 작업이 막혀(마감 가드), 이미 확정된 숫자가 사후에 흔들리는 것을 방지합니다.
*
* <p>마감(close) 정정이 필요하면 재오픈(reopen)으로 잠금을 있으며, 재오픈 사유를 함께 기록합니다.
* 권한(menu=PERIOD_CLOSE): 조회 READ, 마감 CREATE, 재오픈 UPDATE.
*/
@Tag(name = "정산 마감 관리") @Tag(name = "정산 마감 관리")
@RestController @RestController
@RequestMapping("/api/period-close") @RequestMapping("/api/period-close")
@@ -23,18 +32,21 @@ public class PeriodCloseController {
private final PeriodCloseService service; private final PeriodCloseService service;
/** 마감 이력 목록 조회(검색 + 페이징). */
@GetMapping @GetMapping
@RequirePermission(menu = "PERIOD_CLOSE", perm = "READ") @RequirePermission(menu = "PERIOD_CLOSE", perm = "READ")
public ApiResponse<PageResponse<PeriodCloseResp>> list(@ModelAttribute PeriodCloseSearchParam param) { public ApiResponse<PageResponse<PeriodCloseResp>> list(@ModelAttribute PeriodCloseSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 마감 이력 단건 상세 조회. */
@GetMapping("/{closeId}") @GetMapping("/{closeId}")
@RequirePermission(menu = "PERIOD_CLOSE", perm = "READ") @RequirePermission(menu = "PERIOD_CLOSE", perm = "READ")
public ApiResponse<PeriodCloseResp> detail(@PathVariable Long closeId) { public ApiResponse<PeriodCloseResp> detail(@PathVariable Long closeId) {
return ApiResponse.ok(service.detail(closeId)); return ApiResponse.ok(service.detail(closeId));
} }
/** 정산월 마감 실행. 이미 마감된 월이면 거부됩니다. */
@PostMapping @PostMapping
@RequirePermission(menu = "PERIOD_CLOSE", perm = "CREATE") @RequirePermission(menu = "PERIOD_CLOSE", perm = "CREATE")
@DataChangeLog(menu = "PERIOD_CLOSE", table = "period_close") @DataChangeLog(menu = "PERIOD_CLOSE", table = "period_close")
@@ -43,6 +55,7 @@ public class PeriodCloseController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 마감 재오픈(잠금 해제). body 의 reopenReason 에 재오픈 사유를 담습니다. */
@PostMapping("/{closeId}/reopen") @PostMapping("/{closeId}/reopen")
@RequirePermission(menu = "PERIOD_CLOSE", perm = "UPDATE") @RequirePermission(menu = "PERIOD_CLOSE", perm = "UPDATE")
@DataChangeLog(menu = "PERIOD_CLOSE", table = "period_close") @DataChangeLog(menu = "PERIOD_CLOSE", table = "period_close")
@@ -14,6 +14,18 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
/**
* 정산 마스터(settle_master) 관리 컨트롤러.
*
* <p>정산 마스터는 "설계사 1명 × 정산월 1개" 단위로 달에 수수료 합계를 모아둔 (원장)입니다.
* 매달 배치가 각종 원장을 집계해 settle_master 행을 만들고, 담당자가 화면에서 확인/승인합니다.
*
* <p>상태 흐름(SettleStatus): CALCULATED(산출완료) CONFIRMED(확정) PAID(지급완료).
* 중간에 문제가 있으면 HOLD(보류) 묶었다가 release 다시 CALCULATED 있습니다.
*
* <p>권한(menu=SETTLE_LIST): 조회는 READ, 확정/보류/해제 같은 상태변경은 APPROVE 권한이 필요합니다.
* 상태변경 엔드포인트에는 @DataChangeLog 붙어 누가 무엇을 바꿨는지 변경이력이 자동 기록됩니다.
*/
@Tag(name = "정산 관리") @Tag(name = "정산 관리")
@RestController @RestController
@RequestMapping("/api/settle") @RequestMapping("/api/settle")
@@ -22,12 +34,14 @@ public class SettleController {
private final SettleService service; private final SettleService service;
/** 정산 마스터 목록 조회(검색조건 + 페이징). 요청: SettleSearchParam, 응답: 페이지 형태의 정산 요약 목록. */
@GetMapping @GetMapping
@RequirePermission(menu = "SETTLE_LIST", perm = "READ") @RequirePermission(menu = "SETTLE_LIST", perm = "READ")
public ApiResponse<PageResponse<SettleMasterResp>> list(@ModelAttribute SettleSearchParam param) { public ApiResponse<PageResponse<SettleMasterResp>> list(@ModelAttribute SettleSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 정산 마스터 단건 상세 조회. 키는 "설계사ID + 정산월(YYYYMM)" 조합입니다. */
@GetMapping("/{agentId}/months/{settleMonth}") @GetMapping("/{agentId}/months/{settleMonth}")
@RequirePermission(menu = "SETTLE_LIST", perm = "READ") @RequirePermission(menu = "SETTLE_LIST", perm = "READ")
public ApiResponse<SettleMasterResp> detail(@PathVariable Long agentId, public ApiResponse<SettleMasterResp> detail(@PathVariable Long agentId,
@@ -35,18 +49,21 @@ public class SettleController {
return ApiResponse.ok(service.detail(agentId, settleMonth)); return ApiResponse.ok(service.detail(agentId, settleMonth));
} }
/** 특정 정산월 전체 합계 요약(총 인원, 총 지급액 등 대시보드용 집계). */
@GetMapping("/summary") @GetMapping("/summary")
@RequirePermission(menu = "SETTLE_LIST", perm = "READ") @RequirePermission(menu = "SETTLE_LIST", perm = "READ")
public ApiResponse<Map<String, Object>> summary(@RequestParam String settleMonth) { public ApiResponse<Map<String, Object>> summary(@RequestParam String settleMonth) {
return ApiResponse.ok(service.summary(settleMonth)); return ApiResponse.ok(service.summary(settleMonth));
} }
/** 특정 정산월의 조직(지점)별 합계 요약. summary 를 조직 단위로 쪼갠 목록입니다. */
@GetMapping("/org-summary") @GetMapping("/org-summary")
@RequirePermission(menu = "SETTLE_LIST", perm = "READ") @RequirePermission(menu = "SETTLE_LIST", perm = "READ")
public ApiResponse<List<Map<String, Object>>> orgSummary(@RequestParam String settleMonth) { public ApiResponse<List<Map<String, Object>>> orgSummary(@RequestParam String settleMonth) {
return ApiResponse.ok(service.orgSummary(settleMonth)); return ApiResponse.ok(service.orgSummary(settleMonth));
} }
/** 정산 확정(CONFIRMED). 확정 후에는 금액이 잠겨 지급 단계로 넘어갑니다. APPROVE 권한 필요. */
@PutMapping("/{settleId}/confirm") @PutMapping("/{settleId}/confirm")
@RequirePermission(menu = "SETTLE_LIST", perm = "APPROVE") @RequirePermission(menu = "SETTLE_LIST", perm = "APPROVE")
@DataChangeLog(menu = "SETTLE_LIST", table = "settle_master") @DataChangeLog(menu = "SETTLE_LIST", table = "settle_master")
@@ -55,6 +72,7 @@ public class SettleController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 정산 보류(HOLD). body 의 reason(사유)·reasonCode(사유코드)를 함께 기록합니다. 지급완료건은 보류 불가. */
@PutMapping("/{settleId}/hold") @PutMapping("/{settleId}/hold")
@RequirePermission(menu = "SETTLE_LIST", perm = "APPROVE") @RequirePermission(menu = "SETTLE_LIST", perm = "APPROVE")
@DataChangeLog(menu = "SETTLE_LIST", table = "settle_master") @DataChangeLog(menu = "SETTLE_LIST", table = "settle_master")
@@ -63,6 +81,7 @@ public class SettleController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 보류 해제(release). HOLD 상태를 다시 CALCULATED 로 되돌려 정상 흐름에 복귀시킵니다. */
@PutMapping("/{settleId}/release") @PutMapping("/{settleId}/release")
@RequirePermission(menu = "SETTLE_LIST", perm = "APPROVE") @RequirePermission(menu = "SETTLE_LIST", perm = "APPROVE")
@DataChangeLog(menu = "SETTLE_LIST", table = "settle_master") @DataChangeLog(menu = "SETTLE_LIST", table = "settle_master")
@@ -16,6 +16,18 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
/**
* 정산 정정(settle_correction) 관리 컨트롤러.
*
* <p>이미 산출된 정산 금액을 사후에 바로잡는 화면입니다. 원래 정산(originalSettleId) 기준으로
* 변경 (beforeAmount)·(afterAmount) 금액과 차액(diffAmount), 사유를 기록합니다.
*
* <p>상태 흐름(CorrectionStatus): DRAFT(작성) APPROVED(승인) APPLIED(반영완료), 또는 취소.
* 승인은 DRAFT 상태에서만, 취소는 이미 반영(APPLIED)되지 않은 건만 가능합니다.
* 생성 해당 정산월이 마감되어 있으면 거부됩니다(마감 가드).
*
* <p>권한(menu=SETTLE_CORRECTION): 조회 READ, 생성 CREATE, 승인 APPROVE, 취소 UPDATE.
*/
@Tag(name = "정산 정정 관리") @Tag(name = "정산 정정 관리")
@RestController @RestController
@RequestMapping("/api/settle-corrections") @RequestMapping("/api/settle-corrections")
@@ -24,24 +36,28 @@ public class SettleCorrectionController {
private final SettleCorrectionService service; private final SettleCorrectionService service;
/** 정정 목록 조회(검색 + 페이징). */
@GetMapping @GetMapping
@RequirePermission(menu = "SETTLE_CORRECTION", perm = "READ") @RequirePermission(menu = "SETTLE_CORRECTION", perm = "READ")
public ApiResponse<PageResponse<SettleCorrectionResp>> list(@ModelAttribute SettleCorrectionSearchParam param) { public ApiResponse<PageResponse<SettleCorrectionResp>> list(@ModelAttribute SettleCorrectionSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 정정 단건 상세 조회. */
@GetMapping("/{correctionId}") @GetMapping("/{correctionId}")
@RequirePermission(menu = "SETTLE_CORRECTION", perm = "READ") @RequirePermission(menu = "SETTLE_CORRECTION", perm = "READ")
public ApiResponse<SettleCorrectionResp> detail(@PathVariable Long correctionId) { public ApiResponse<SettleCorrectionResp> detail(@PathVariable Long correctionId) {
return ApiResponse.ok(service.detail(correctionId)); return ApiResponse.ok(service.detail(correctionId));
} }
/** 특정 원본 정산(originalSettleId)에 달린 정정 이력 전체 조회. */
@GetMapping("/by-settle/{originalSettleId}") @GetMapping("/by-settle/{originalSettleId}")
@RequirePermission(menu = "SETTLE_CORRECTION", perm = "READ") @RequirePermission(menu = "SETTLE_CORRECTION", perm = "READ")
public ApiResponse<List<SettleCorrectionResp>> listByOriginalSettle(@PathVariable Long originalSettleId) { public ApiResponse<List<SettleCorrectionResp>> listByOriginalSettle(@PathVariable Long originalSettleId) {
return ApiResponse.ok(service.listByOriginalSettle(originalSettleId)); return ApiResponse.ok(service.listByOriginalSettle(originalSettleId));
} }
/** 정정 생성(DRAFT 상태). 차액(diffAmount)은 후-전 금액으로 자동 계산됩니다. 마감 가드 적용. */
@PostMapping @PostMapping
@RequirePermission(menu = "SETTLE_CORRECTION", perm = "CREATE") @RequirePermission(menu = "SETTLE_CORRECTION", perm = "CREATE")
@DataChangeLog(menu = "SETTLE_CORRECTION", table = "settle_correction") @DataChangeLog(menu = "SETTLE_CORRECTION", table = "settle_correction")
@@ -49,6 +65,7 @@ public class SettleCorrectionController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 정정 승인(DRAFT → APPROVED). APPROVE 권한 필요. */
@PostMapping("/{correctionId}/approve") @PostMapping("/{correctionId}/approve")
@RequirePermission(menu = "SETTLE_CORRECTION", perm = "APPROVE") @RequirePermission(menu = "SETTLE_CORRECTION", perm = "APPROVE")
@DataChangeLog(menu = "SETTLE_CORRECTION", table = "settle_correction") @DataChangeLog(menu = "SETTLE_CORRECTION", table = "settle_correction")
@@ -57,6 +74,7 @@ public class SettleCorrectionController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 정정 취소. body 의 cancelReason 에 사유를 담습니다. 이미 반영(APPLIED)된 정정은 취소 불가. */
@PostMapping("/{correctionId}/cancel") @PostMapping("/{correctionId}/cancel")
@RequirePermission(menu = "SETTLE_CORRECTION", perm = "UPDATE") @RequirePermission(menu = "SETTLE_CORRECTION", perm = "UPDATE")
@DataChangeLog(menu = "SETTLE_CORRECTION", table = "settle_correction") @DataChangeLog(menu = "SETTLE_CORRECTION", table = "settle_correction")
@@ -15,6 +15,15 @@ import org.springframework.web.bind.annotation.*;
import java.util.Map; import java.util.Map;
/**
* 세금계산서(tax_invoice) 관리 컨트롤러.
*
* <p>수수료 지급/거래에 대한 세금계산서 발행 이력을 관리합니다. 공급가액(supplyAmount) + 세액(taxAmount) =
* 합계(totalAmount) 구성되며, 거래 상대방(상호·사업자번호·대표·주소) 정보를 함께 보관합니다.
*
* <p>발행번호(invoiceNo) 유일해야 하며 중복 등록이 거부됩니다. 잘못 발행한 계산서는 취소(cancel) 처리합니다.
* 권한(menu=TAX_INVOICE): 조회 READ, 발행 CREATE, 취소 UPDATE.
*/
@Tag(name = "세금계산서 관리") @Tag(name = "세금계산서 관리")
@RestController @RestController
@RequestMapping("/api/tax-invoices") @RequestMapping("/api/tax-invoices")
@@ -23,18 +32,21 @@ public class TaxInvoiceController {
private final TaxInvoiceService service; private final TaxInvoiceService service;
/** 세금계산서 목록 조회(검색 + 페이징). */
@GetMapping @GetMapping
@RequirePermission(menu = "TAX_INVOICE", perm = "READ") @RequirePermission(menu = "TAX_INVOICE", perm = "READ")
public ApiResponse<PageResponse<TaxInvoiceResp>> list(@ModelAttribute TaxInvoiceSearchParam param) { public ApiResponse<PageResponse<TaxInvoiceResp>> list(@ModelAttribute TaxInvoiceSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 세금계산서 단건 상세 조회. */
@GetMapping("/{invoiceId}") @GetMapping("/{invoiceId}")
@RequirePermission(menu = "TAX_INVOICE", perm = "READ") @RequirePermission(menu = "TAX_INVOICE", perm = "READ")
public ApiResponse<TaxInvoiceResp> detail(@PathVariable Long invoiceId) { public ApiResponse<TaxInvoiceResp> detail(@PathVariable Long invoiceId) {
return ApiResponse.ok(service.detail(invoiceId)); return ApiResponse.ok(service.detail(invoiceId));
} }
/** 세금계산서 발행(등록). 발행번호 중복은 거부됩니다. 합계금액은 공급가액+세액으로 자동 계산됩니다. */
@PostMapping @PostMapping
@RequirePermission(menu = "TAX_INVOICE", perm = "CREATE") @RequirePermission(menu = "TAX_INVOICE", perm = "CREATE")
@DataChangeLog(menu = "TAX_INVOICE", table = "tax_invoice") @DataChangeLog(menu = "TAX_INVOICE", table = "tax_invoice")
@@ -42,6 +54,7 @@ public class TaxInvoiceController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 세금계산서 취소. body 의 cancelReason 에 취소 사유를 담습니다(취소일은 서버 기준 오늘). */
@PostMapping("/{invoiceId}/cancel") @PostMapping("/{invoiceId}/cancel")
@RequirePermission(menu = "TAX_INVOICE", perm = "UPDATE") @RequirePermission(menu = "TAX_INVOICE", perm = "UPDATE")
@DataChangeLog(menu = "TAX_INVOICE", table = "tax_invoice") @DataChangeLog(menu = "TAX_INVOICE", table = "tax_invoice")
@@ -13,6 +13,17 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 해촉 정산(termination_settlement) 관리 컨트롤러.
*
* <p>"해촉" 설계사 위촉계약이 끝나는 것입니다. 그만둘 미지급 수수료(모집/분할/시책) 정산해 주고,
* 향후 발생할 환수 예상액 등은 차감하여 최종 지급액(finalPayAmount) 산출하는 일회성 정산입니다.
*
* <p>상태 흐름(TermSettleStatus): CALCULATING(산출중) CONFIRMED(확정), 또는 CANCELLED(취소).
* 수정·확정은 CALCULATING 상태에서만 가능합니다. 설계사에 진행 중인 해촉 정산이 이미 있으면 중복 생성이 거부됩니다.
*
* <p>권한(menu=TERM_SETTLE): 조회 READ, 생성/process CREATE, 수정 UPDATE, 확정 APPROVE.
*/
@Tag(name = "해촉 정산 관리") @Tag(name = "해촉 정산 관리")
@RestController @RestController
@RequestMapping("/api/termination-settlements") @RequestMapping("/api/termination-settlements")
@@ -21,18 +32,21 @@ public class TerminationSettlementController {
private final TerminationSettlementService service; private final TerminationSettlementService service;
/** 해촉 정산 목록 조회(검색 + 페이징). */
@GetMapping @GetMapping
@RequirePermission(menu = "TERM_SETTLE", perm = "READ") @RequirePermission(menu = "TERM_SETTLE", perm = "READ")
public ApiResponse<PageResponse<TerminationSettlementResp>> list(@ModelAttribute TerminationSettlementSearchParam param) { public ApiResponse<PageResponse<TerminationSettlementResp>> list(@ModelAttribute TerminationSettlementSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 해촉 정산 단건 상세 조회. */
@GetMapping("/{termSettleId}") @GetMapping("/{termSettleId}")
@RequirePermission(menu = "TERM_SETTLE", perm = "READ") @RequirePermission(menu = "TERM_SETTLE", perm = "READ")
public ApiResponse<TerminationSettlementResp> detail(@PathVariable Long termSettleId) { public ApiResponse<TerminationSettlementResp> detail(@PathVariable Long termSettleId) {
return ApiResponse.ok(service.detail(termSettleId)); return ApiResponse.ok(service.detail(termSettleId));
} }
/** 해촉 정산 생성(CALCULATING 상태). 진행 중인 해촉 정산이 있으면 거부됩니다. */
@PostMapping @PostMapping
@RequirePermission(menu = "TERM_SETTLE", perm = "CREATE") @RequirePermission(menu = "TERM_SETTLE", perm = "CREATE")
@DataChangeLog(menu = "TERM_SETTLE", table = "termination_settlement") @DataChangeLog(menu = "TERM_SETTLE", table = "termination_settlement")
@@ -40,6 +54,7 @@ public class TerminationSettlementController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 해촉 정산 금액 수정. 산출 중(CALCULATING) 상태에서만 가능합니다. */
@PutMapping("/{termSettleId}") @PutMapping("/{termSettleId}")
@RequirePermission(menu = "TERM_SETTLE", perm = "UPDATE") @RequirePermission(menu = "TERM_SETTLE", perm = "UPDATE")
@DataChangeLog(menu = "TERM_SETTLE", table = "termination_settlement") @DataChangeLog(menu = "TERM_SETTLE", table = "termination_settlement")
@@ -48,6 +63,7 @@ public class TerminationSettlementController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 해촉 발생 시 자동 처리 진입점. 내부적으로 create 와 동일하게 CALCULATING 레코드를 만듭니다. */
@PostMapping("/process") @PostMapping("/process")
@RequirePermission(menu = "TERM_SETTLE", perm = "CREATE") @RequirePermission(menu = "TERM_SETTLE", perm = "CREATE")
@DataChangeLog(menu = "TERM_SETTLE", table = "termination_settlement") @DataChangeLog(menu = "TERM_SETTLE", table = "termination_settlement")
@@ -55,6 +71,7 @@ public class TerminationSettlementController {
return ApiResponse.ok(service.process(req)); return ApiResponse.ok(service.process(req));
} }
/** 해촉 정산 확정(CALCULATING → CONFIRMED). APPROVE 권한 필요. */
@PostMapping("/{termSettleId}/confirm") @PostMapping("/{termSettleId}/confirm")
@RequirePermission(menu = "TERM_SETTLE", perm = "APPROVE") @RequirePermission(menu = "TERM_SETTLE", perm = "APPROVE")
@DataChangeLog(menu = "TERM_SETTLE", table = "termination_settlement") @DataChangeLog(menu = "TERM_SETTLE", table = "termination_settlement")
@@ -21,6 +21,15 @@ import java.io.IOException;
import java.net.URLEncoder; import java.net.URLEncoder;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
/**
* [수수료 명세서 API]
*
* 신입 개발자 안내:
* - 설계사에게 "이번 달 얼마를 어떻게 지급했는지" 정리한 문서가 수수료 명세서다.
* - 데이터 출처: 지급(payment) 내역을 설계사+정산월 단위로 합산(StatementAggregator)하여
* 총지급액/원천세/지방소득세/부가세/공제/실수령액을 산출하고, 엑셀 파일로 만들어 보관한다.
* - 발급: 단건(generate) 또는 월별 일괄(generateForMonth). 다운로드 상태가 DOWNLOADED 바뀐다.
*/
@Tag(name = "수수료 명세서") @Tag(name = "수수료 명세서")
@Validated @Validated
@RestController @RestController
@@ -30,12 +39,14 @@ public class CommissionStatementController {
private final CommissionStatementService statementService; private final CommissionStatementService statementService;
// 명세서 목록 (검색/페이징)
@GetMapping @GetMapping
@RequirePermission(menu = "STATEMENT", perm = "READ") @RequirePermission(menu = "STATEMENT", perm = "READ")
public ApiResponse<PageResponse<CommissionStatementResp>> list(@ModelAttribute CommissionStatementSearchParam param) { public ApiResponse<PageResponse<CommissionStatementResp>> list(@ModelAttribute CommissionStatementSearchParam param) {
return ApiResponse.ok(statementService.list(param)); return ApiResponse.ok(statementService.list(param));
} }
// 명세서 1건 상세
@GetMapping("/{statementId}") @GetMapping("/{statementId}")
@RequirePermission(menu = "STATEMENT", perm = "READ") @RequirePermission(menu = "STATEMENT", perm = "READ")
public ApiResponse<CommissionStatementResp> detail(@PathVariable Long statementId) { public ApiResponse<CommissionStatementResp> detail(@PathVariable Long statementId) {
@@ -61,6 +72,7 @@ public class CommissionStatementController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
// 발급된 명세서 엑셀 파일을 내려준다. 한글 파일명은 RFC5987(filename*=UTF-8'') 인코딩해 깨짐을 방지.
@Operation(summary = "명세서 다운로드") @Operation(summary = "명세서 다운로드")
@GetMapping("/{statementId}/download") @GetMapping("/{statementId}/download")
@RequirePermission(menu = "STATEMENT", perm = "READ") @RequirePermission(menu = "STATEMENT", perm = "READ")
@@ -13,6 +13,15 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 계약 승계 관리 API.
*
* <p>승계란 계약의 담당(귀속) 설계사를 전임(fromAgent)에서 후임(toAgent)으로 넘기는 것을 말한다.
* 퇴사·조직이동 등으로 담당자가 바뀌면, 승계일(successionDate) 이후의 유지수수료는 후임 설계사에게 귀속된다.
* 정산 배치가 승계 정보를 참고해 원장의 agent를 이관한다.</p>
*
* <p>메뉴 CONTRACT_SUCCESSION 권한으로 보호된다.</p>
*/
@Tag(name = "계약 승계") @Tag(name = "계약 승계")
@RestController @RestController
@RequestMapping("/api/contract-successions") @RequestMapping("/api/contract-successions")
@@ -21,6 +30,7 @@ public class ContractSuccessionController {
private final ContractSuccessionService service; private final ContractSuccessionService service;
/** 승계 내역 목록 조회(페이징). READ 권한 필요. */
@GetMapping @GetMapping
@RequirePermission(menu = "CONTRACT_SUCCESSION", perm = "READ") @RequirePermission(menu = "CONTRACT_SUCCESSION", perm = "READ")
public ApiResponse<PageResponse<ContractSuccessionResp>> list( public ApiResponse<PageResponse<ContractSuccessionResp>> list(
@@ -28,12 +38,14 @@ public class ContractSuccessionController {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 승계 단건 상세 조회. READ 권한 필요. */
@GetMapping("/{successionId}") @GetMapping("/{successionId}")
@RequirePermission(menu = "CONTRACT_SUCCESSION", perm = "READ") @RequirePermission(menu = "CONTRACT_SUCCESSION", perm = "READ")
public ApiResponse<ContractSuccessionResp> detail(@PathVariable Long successionId) { public ApiResponse<ContractSuccessionResp> detail(@PathVariable Long successionId) {
return ApiResponse.ok(service.detail(successionId)); return ApiResponse.ok(service.detail(successionId));
} }
/** 승계 등록(담당 설계사 이관 예약). 전임/후임이 같으면 거부된다. CREATE 권한 필요. */
@PostMapping @PostMapping
@RequirePermission(menu = "CONTRACT_SUCCESSION", perm = "CREATE") @RequirePermission(menu = "CONTRACT_SUCCESSION", perm = "CREATE")
@DataChangeLog(menu = "CONTRACT_SUCCESSION", table = "contract_succession") @DataChangeLog(menu = "CONTRACT_SUCCESSION", table = "contract_succession")
@@ -41,6 +53,7 @@ public class ContractSuccessionController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 승계 취소(status=CANCELED). 취소 후 정산월부터 유지수수료는 다시 직전 귀속 설계사에게 돌아간다. UPDATE 권한 필요. */
@PostMapping("/{successionId}/cancel") @PostMapping("/{successionId}/cancel")
@RequirePermission(menu = "CONTRACT_SUCCESSION", perm = "UPDATE") @RequirePermission(menu = "CONTRACT_SUCCESSION", perm = "UPDATE")
@DataChangeLog(menu = "CONTRACT_SUCCESSION", table = "contract_succession") @DataChangeLog(menu = "CONTRACT_SUCCESSION", table = "contract_succession")
@@ -49,6 +62,7 @@ public class ContractSuccessionController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 승계 레코드 물리 삭제. DELETE 권한 필요. */
@DeleteMapping("/{successionId}") @DeleteMapping("/{successionId}")
@RequirePermission(menu = "CONTRACT_SUCCESSION", perm = "DELETE") @RequirePermission(menu = "CONTRACT_SUCCESSION", perm = "DELETE")
@DataChangeLog(menu = "CONTRACT_SUCCESSION", table = "contract_succession") @DataChangeLog(menu = "CONTRACT_SUCCESSION", table = "contract_succession")
@@ -12,6 +12,13 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
/**
* 역할(Role) 권한 관리 API.
*
* <p>역할은 메뉴별 권한(menuId + permCode) 묶음이다. 사용자에게 역할을 부여해
* 접근 권한을 통제한다(RBAC). 역할별 권한 매핑은 savePermissions에서 전체 교체 방식으로 저장된다.
* 메뉴 SYSTEM_ROLE 권한으로 보호된다.</p>
*/
@Tag(name = "역할 관리") @Tag(name = "역할 관리")
@RestController @RestController
@RequestMapping("/api/system/roles") @RequestMapping("/api/system/roles")
@@ -20,24 +27,28 @@ public class RoleController {
private final RoleService roleService; private final RoleService roleService;
/** 역할 전체 목록 조회. READ 권한 필요. */
@GetMapping @GetMapping
@RequirePermission(menu = "SYSTEM_ROLE", perm = "READ") @RequirePermission(menu = "SYSTEM_ROLE", perm = "READ")
public ApiResponse<List<RoleVO>> list() { public ApiResponse<List<RoleVO>> list() {
return ApiResponse.ok(roleService.list()); return ApiResponse.ok(roleService.list());
} }
/** 역할 단건 상세 조회. READ 권한 필요. */
@GetMapping("/{roleId}") @GetMapping("/{roleId}")
@RequirePermission(menu = "SYSTEM_ROLE", perm = "READ") @RequirePermission(menu = "SYSTEM_ROLE", perm = "READ")
public ApiResponse<RoleVO> detail(@PathVariable Long roleId) { public ApiResponse<RoleVO> detail(@PathVariable Long roleId) {
return ApiResponse.ok(roleService.detail(roleId)); return ApiResponse.ok(roleService.detail(roleId));
} }
/** 역할에 부여된 메뉴별 권한 목록 조회. READ 권한 필요. */
@GetMapping("/{roleId}/permissions") @GetMapping("/{roleId}/permissions")
@RequirePermission(menu = "SYSTEM_ROLE", perm = "READ") @RequirePermission(menu = "SYSTEM_ROLE", perm = "READ")
public ApiResponse<List<Map<String, Object>>> permissions(@PathVariable Long roleId) { public ApiResponse<List<Map<String, Object>>> permissions(@PathVariable Long roleId) {
return ApiResponse.ok(roleService.permissions(roleId)); return ApiResponse.ok(roleService.permissions(roleId));
} }
/** 역할 신규 등록. CREATE 권한 필요. */
@PostMapping @PostMapping
@RequirePermission(menu = "SYSTEM_ROLE", perm = "CREATE") @RequirePermission(menu = "SYSTEM_ROLE", perm = "CREATE")
@DataChangeLog(menu = "SYSTEM_ROLE", table = "role") @DataChangeLog(menu = "SYSTEM_ROLE", table = "role")
@@ -45,6 +56,7 @@ public class RoleController {
return ApiResponse.ok(roleService.create(vo)); return ApiResponse.ok(roleService.create(vo));
} }
/** 역할 정보 수정. UPDATE 권한 필요. */
@PutMapping("/{roleId}") @PutMapping("/{roleId}")
@RequirePermission(menu = "SYSTEM_ROLE", perm = "UPDATE") @RequirePermission(menu = "SYSTEM_ROLE", perm = "UPDATE")
@DataChangeLog(menu = "SYSTEM_ROLE", table = "role") @DataChangeLog(menu = "SYSTEM_ROLE", table = "role")
@@ -53,6 +65,7 @@ public class RoleController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 역할 삭제. DELETE 권한 필요. */
@DeleteMapping("/{roleId}") @DeleteMapping("/{roleId}")
@RequirePermission(menu = "SYSTEM_ROLE", perm = "DELETE") @RequirePermission(menu = "SYSTEM_ROLE", perm = "DELETE")
@DataChangeLog(menu = "SYSTEM_ROLE", table = "role") @DataChangeLog(menu = "SYSTEM_ROLE", table = "role")
@@ -61,6 +74,7 @@ public class RoleController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 역할의 권한 매핑 일괄 저장(기존 전체 삭제 후 재삽입). UPDATE 권한 필요. */
@PutMapping("/{roleId}/permissions") @PutMapping("/{roleId}/permissions")
@RequirePermission(menu = "SYSTEM_ROLE", perm = "UPDATE") @RequirePermission(menu = "SYSTEM_ROLE", perm = "UPDATE")
@DataChangeLog(menu = "SYSTEM_ROLE", table = "role_permission") @DataChangeLog(menu = "SYSTEM_ROLE", table = "role_permission")
@@ -13,6 +13,13 @@ import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
/**
* 시스템 사용자(로그인 계정) 관리 API.
*
* <p>사용자 계정의 생성·수정·비밀번호 초기화·잠금 해제·전화번호 정정을 제공한다.
* 사용자는 역할(role) 통해 권한을 부여받는다(roleIds). 로그인 ID는 중복 불가다.
* 메뉴 SYSTEM_USER 권한으로 보호된다.</p>
*/
@Tag(name = "사용자 관리") @Tag(name = "사용자 관리")
@RestController @RestController
@RequestMapping("/api/system/users") @RequestMapping("/api/system/users")
@@ -21,18 +28,21 @@ public class UserController {
private final UserService service; private final UserService service;
/** 사용자 목록 조회(페이징). READ 권한 필요. */
@GetMapping @GetMapping
@RequirePermission(menu = "SYSTEM_USER", perm = "READ") @RequirePermission(menu = "SYSTEM_USER", perm = "READ")
public ApiResponse<PageResponse<UserResp>> list(@ModelAttribute UserSearchParam param) { public ApiResponse<PageResponse<UserResp>> list(@ModelAttribute UserSearchParam param) {
return ApiResponse.ok(service.list(param)); return ApiResponse.ok(service.list(param));
} }
/** 사용자 단건 상세 조회(역할 코드 포함). READ 권한 필요. */
@GetMapping("/{userId}") @GetMapping("/{userId}")
@RequirePermission(menu = "SYSTEM_USER", perm = "READ") @RequirePermission(menu = "SYSTEM_USER", perm = "READ")
public ApiResponse<UserResp> detail(@PathVariable Long userId) { public ApiResponse<UserResp> detail(@PathVariable Long userId) {
return ApiResponse.ok(service.detail(userId)); return ApiResponse.ok(service.detail(userId));
} }
/** 사용자 신규 등록. 비밀번호 미지정 시 임시 비밀번호로 생성하고 역할을 부여한다. CREATE 권한 필요. */
@PostMapping @PostMapping
@RequirePermission(menu = "SYSTEM_USER", perm = "CREATE") @RequirePermission(menu = "SYSTEM_USER", perm = "CREATE")
@DataChangeLog(menu = "SYSTEM_USER", table = "users") @DataChangeLog(menu = "SYSTEM_USER", table = "users")
@@ -40,6 +50,7 @@ public class UserController {
return ApiResponse.ok(service.create(req)); return ApiResponse.ok(service.create(req));
} }
/** 사용자 정보 수정. roleIds가 오면 역할을 전체 교체한다. UPDATE 권한 필요. */
@PutMapping("/{userId}") @PutMapping("/{userId}")
@RequirePermission(menu = "SYSTEM_USER", perm = "UPDATE") @RequirePermission(menu = "SYSTEM_USER", perm = "UPDATE")
@DataChangeLog(menu = "SYSTEM_USER", table = "users") @DataChangeLog(menu = "SYSTEM_USER", table = "users")
@@ -48,6 +59,7 @@ public class UserController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 비밀번호 초기화(임시 비밀번호 발급). UPDATE 권한 필요. */
@PutMapping("/{userId}/reset-password") @PutMapping("/{userId}/reset-password")
@RequirePermission(menu = "SYSTEM_USER", perm = "UPDATE") @RequirePermission(menu = "SYSTEM_USER", perm = "UPDATE")
public ApiResponse<Void> resetPassword(@PathVariable Long userId) { public ApiResponse<Void> resetPassword(@PathVariable Long userId) {
@@ -55,6 +67,7 @@ public class UserController {
return ApiResponse.ok(); return ApiResponse.ok();
} }
/** 계정 잠금 해제(로그인 실패 횟수 초기화 + ACTIVE 복귀). UPDATE 권한 필요. */
@PutMapping("/{userId}/unlock") @PutMapping("/{userId}/unlock")
@RequirePermission(menu = "SYSTEM_USER", perm = "UPDATE") @RequirePermission(menu = "SYSTEM_USER", perm = "UPDATE")
public ApiResponse<Void> unlock(@PathVariable Long userId) { public ApiResponse<Void> unlock(@PathVariable Long userId) {
@@ -17,6 +17,14 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
/**
* [부가세 분기신고 API]
*
* 신입 개발자 안내:
* - 부가세(VAT) 분기 단위(1~4분기) 신고한다. 과세사업자인 설계사의 지급분에 붙은 부가세를 분기별로 모은다.
* - 흐름: regenerate(분기 재집계 vat_report UPSERT) 목록/상세 확인 complete(신고 제출 완료 표시).
* - settleQuarter 형식은 보통 "YYYYQ"(: 2026년 1분기)처럼 분기를 식별하는 값이다.
*/
@Tag(name = "부가세 분기신고") @Tag(name = "부가세 분기신고")
@RestController @RestController
@RequestMapping("/api/vat-reports") @RequestMapping("/api/vat-reports")
@@ -48,6 +56,7 @@ public class VatReportController {
return ApiResponse.ok(service.regenerate(req)); return ApiResponse.ok(service.regenerate(req));
} }
// 선택한 신고건들의 상태를 "신고 완료(FILED)" 변경 (실제 국세청 제출은 외부 절차, 여기선 상태만 갱신)
@PutMapping("/complete") @PutMapping("/complete")
@Operation(summary = "부가세 분기신고 제출 완료 처리") @Operation(summary = "부가세 분기신고 제출 완료 처리")
@RequirePermission(menu = "VAT_REPORT", perm = "EXECUTE") @RequirePermission(menu = "VAT_REPORT", perm = "EXECUTE")
@@ -17,6 +17,14 @@ import org.springframework.web.bind.annotation.*;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
/**
* [원천세 분기신고 API]
*
* 신입 개발자 안내:
* - 원천세(원천징수세) 설계사에게 지급할 회사가 미리 떼어 국세청에 대신 납부하는 세금이다.
* 사업소득은 3.3%(소득세 3% + 지방소득세 0.3%), 기타소득은 8.8%(소득세 8% + 지방소득세 0.8%) 일반적이다.
* - 분기별로 떼어둔 원천세를 모아 신고한다. 흐름: regenerate(분기 재집계) 목록/상세 complete(제출 완료 표시).
*/
@Tag(name = "원천세 분기신고") @Tag(name = "원천세 분기신고")
@RestController @RestController
@RequestMapping("/api/withholding-tax-reports") @RequestMapping("/api/withholding-tax-reports")
@@ -48,6 +56,7 @@ public class WithholdingTaxReportController {
return ApiResponse.ok(service.regenerate(req)); return ApiResponse.ok(service.regenerate(req));
} }
// 선택한 신고건들의 상태를 "신고 완료(FILED)" 변경 (상태 갱신만, 실제 제출은 외부 절차)
@PutMapping("/complete") @PutMapping("/complete")
@Operation(summary = "원천세 분기신고 제출 완료 처리") @Operation(summary = "원천세 분기신고 제출 완료 처리")
@RequirePermission(menu = "WITHHOLDING_TAX", perm = "EXECUTE") @RequirePermission(menu = "WITHHOLDING_TAX", perm = "EXECUTE")

Some files were not shown because too many files have changed in this diff Show More