View settlement
- Print
- PDF
View settlement
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Description
Searches settlement data.
Common request header
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | * This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. |
| x-ncp-iam-access-key | * Access key ID issued on the NAVER Cloud Platform portal or by Sub Account |
| x-ncp-apigw-signature-v2 | * A signature that encrypts the body of the example above with the secret key mapped to the access key ID * Uses HmacSHA256 for the HMAC encryption algorithm |
View settlement API
Registers settlement data by case.
Request URL
GET
https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/{companyId}/metering
Request path parameter
| Parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| partnerId | String | 15 | Y | Partner ID provided by WORKPLACE |
| companyId | String | 36 | Y | Integration key (CompanyId) of customer to be searchedDevelopers > Basic settings > Integration key |
Request body parameter
| Parameter | Type | Size | Requirement status | Description |
|---|---|---|---|---|
| meterYm | String | 6 | Y | Settlement date (YYYYMM) |
Request examples
GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/adc835a8-244c-46b4-8410-7421816d4808/metering
GET /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=
{
"meterYm" : "202205"
}
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
Response
It is returned as an HTTP status code and delivered as body information.
| HTTP status code | Response message | Description |
|---|---|---|
| 200 | OK | General successful request |
| 201 | Created | Response code for successful resource creation |
| 400 | Bad Request | Used for general request failure |
| 500 | Internal Server Error | - Response code for general server errors While 4XX error codes represent client-side errors, 5XX error codes represent server-side errors. |
Response examples
{
"status": 400,
"code": -4020,
"errors": [],
"message": "parentDeptExternalKey is null"
}
Was this article helpful?