정산 등록
- 인쇄
- PDF
정산 등록
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
설명
건별 정산 데이터를 등록한다.
(인원 수 외 정산 데이터 입력이 필요한 경우 사용)
요청 헤더 공통
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | * 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 * API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 |
| x-ncp-iam-access-key | * 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID |
| x-ncp-apigw-signature-v2 | * 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명 * HMAC 암호화 알고리즘은 HmacSHA256 사용 |
정산 등록 API
건별 정산 데이터를 등록한다.
요청 URL
GET
https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/{company
Id}/metering
요청 Path 파라미터
| 파라미터 | 타입 | 크기 | 필수 여부 | 설명 |
|---|---|---|---|---|
| partnerId | String | 15 | Y | WORKPLACE에서 제공한 파트너 ID |
| companyId | String | 36 | Y | 조회할 고객사의 연동키(CompanyId) Developers > 기본 설정 > 연동키 |
요청 Body 파라미터
| 파라미터 | 타입 | 크기 | 필수 여부 | 설명 |
|---|---|---|---|---|
| companyId | String | 36 | Y | 고객사 company ID |
| empId | String | 36 | Y | 사원ID |
| productCode | Map | Y | 상품코드 | |
| productName | String | 100 | Y | 상품명 |
| productAmt | int | Y | 상품금액 | |
| billYmd | String | 100 | Y | 정산날짜(YYYYMMDD) |
| applyYmdt | boolean | Y | 신청날짜(YYYYMMDDHH24MISS | |
| svcOrderKey | String | 10 | Y | 업무지원 서비스 고유키 |
요청 예시
POST https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/adc835a8-244c-46b4-8410-7421816d4808/metering
POST /partner/apigw/v2/partner/{partnerId}/company/adc835a8-244c-46b4-8410-7421816d4808/metering
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
"companyId" : "187d83ad-4038-45b6-8e7c-59eca16fdc46",
"empId" : "7764286e-5d40-43e7-bff0-4a947e1437e1",
"productCode" : "AAA01",
"productName" : "상품명",
"productAmt" : "3500",
"billYmd" : "20220221",
"applyYmdt" : "20220219013125",
"svcOrderKey" : "5a5d9d7gg57x8x63de"
}
응답 예시
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34
응답
HTTP 상태 코드로 리턴되고, Body 정보로 전달한다.
| HTTP 상태 코드 | 응답 메시지 | 설명 |
|---|---|---|
| 200 | OK | 일반적인 요청 성공 |
| 201 | Created | 리소스 생성 성공에 대한 응답 코드 |
| 400 | Bad Request | 일반적인 요청 실패에 사용 |
| 500 | Internal Server Error | - 일반적인 서버 오류에 대한 응답 코드 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용된다면, 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용됨 |
응답 예시
{
"status": 400,
"code": -4020,
"errors": [],
"message": "parentDeptExternalKey is null"
}이 문서가 도움이 되었습니까?