精算の登録
    • PDF

    精算の登録

    • PDF

    Article Summary

    説明

    件別の精算データを登録します。(人数以外に精算データの入力が必要な場合に使用)

    リクエストヘッダ共通

    HeaderDescription
    x-ncp-apigw-timestamp* 1970年1月1日00::00::00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの
    * API Gatewayサーバとの時間差が5分以上の場合は、無効なリクエストとみなす
    x-ncp-iam-access-key* NAVERクラウドプラットフォームポータル{target=「_blank」}または 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パラメータ

    パラメータタイプ容量要否説明
    partnerIdString15YWORKPLACEから提供されたパートナー ID
    companyIdString36Y照会する顧客会社の連携キー(CompanyId) Developers > Default settings > Integration key

    リクエスト Bodyパラメータ

    パラメータタイプ容量要否説明
    companyIdString36Y顧客会社 company ID
    empIdString36Y社員 ID
    productCodeMapY商品コード
    productNameString100Y商品名
    productAmtintY商品価格
    billYmdString100Y精算日時(YYYYMMDD)
    applyYmdtbooleanY申請日時(YYYYMMDDHH24MISS)
    svcOrderKeyString10Y業務支援サービスの固有キー

    リクエスト例

    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ステータスコードレスポンスメッセージ説明
    200OK一般的なリクエスト成功
    201Createdリソース作成成功に対するレスポンスコード
    400Bad Request一般的なリクエスト失敗に使用
    500Internal Server Error- 一般的なサーバエラーに対するレスポンスコード
    4XX番台のエラーコードが、クライアント側のエラーを表示するために使用され、
    5XX番台のエラーコードは、サーバ側のエラーを表示するために使用される

    レスポンス例

    {
        "status": 400,
        "code": -4020,
        "errors": [],
        "message": "parentDeptExternalKey is null"
    }
    

    この記事は役に立ちましたか?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.