Settlement
- Print
- PDF
Settlement
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Description
Adds settlement data by case (Used when settlement data input other than the number of personnel is required)
Request headers (Common)
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | * It indicates the time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC * Request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes |
| x-ncp-iam-access-key | * Access key ID issued from the NAVER Cloud Platform portal or a sub-account |
| x-ncp-apigw-signature-v2 | * Signature of the body in the above example encrypted with secret key mapped to access key ID * HMAC encryption algorithm is HMAC-SHA256 |
Settlement add API
Adds settlement data by case
Request URL
GET
https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/{company
Id}/metering
Request path parameters
| Parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| partnerId | String | 15 | Y | Partner ID provided via WORKPLACE |
| companyId | String | 36 | Y | Integration key (CompanyId) of the customer to query Developers > Default settings > Integration key |
Request body parameters
| Parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| companyId | String | 36 | Y | Customer company ID |
| empId | String | 36 | Y | Employee ID |
| productCode | Map | Y | Product code | |
| productName | String | 100 | Y | Product name |
| productAmt | int | Y | Product amount | |
| billYmd | String | 100 | Y | Settlement date (YYYYMMDD) |
| applyYmdt | boolean | Y | Application date (YYYYMMDDHH24MISS) | |
| svcOrderKey | String | 10 | Y | Unique business support service key |
Request examples
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" : "Product name",
"productAmt" : "3500",
"billYmd" : "20220221",
"applyYmdt" : "20220219013125",
"svcOrderKey" : "5a5d9d7gg57x8x63de"
}
Response examples
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
Responses
Returned as HTTP status codes in the response body
| HTTP status code | Response message | Description |
|---|---|---|
| 200 | OK | Normal successful request |
| 201 | Created | Successful resource creation |
| 400 | Bad Request | Request failure |
| 500 | Internal Server Error | - Common server error Error codes in the 400 range indicate client-side errors Error codes in the 500 range indicate server-side errors |
Response examples
{
"status": 400,
"code": -4020,
"errors": [],
"message": "parentDeptExternalKey is null"
}
Was this article helpful?