Project
プロジェクトのAPIリファレンスは以下の通りです。

Create project

プロジェクトの作成
Role actions
  • ModifyProject
Request
1
POST /project HTTP1.1
2
Authorization: Bearer {token}
3
Content-Type: application/json
4
5
{request body}
Copied!
以下に{request body}のリクエストペイロードの例を示します。
{request body}
1
{
2
"project_code":"project 1",
3
"project_label":"project 1 description",
4
"project_currency":"jpy"
5
}
Copied!
{request body} description
Field
Type
Required
Validation
Description
project_code
string
Yes
1 ~ 40
プロジェクトコード
project_label
string
Yes
1 ~ 40
プロジェクトラベル
project_currency
string
Yes
support:['jpy','usd']
表示通貨
Response
1
HTTP 200
2
3
{"status":"success"}
Copied!

Edit project

プロジェクトの更新
Role actions
  • ModifyProject
Request
1
POST /project/{project_id} HTTP1.1
2
Authorization: Bearer {token}
3
Content-Type: application/json
4
5
{request body}
Copied!
以下に{request body}のリクエストペイロードの例を示します。
1
{
2
"project_code":"project 1",
3
"project_label":"project 1 description",
4
"project_currency":"jpy"
5
}
Copied!
{request body} description
Field
Type
Required
Validation
Description
project_code
string
Yes
1 ~ 40
プロジェクトコード
project_label
string
Yes
1 ~ 40
プロジェクトラベル
project_currency
string
Yes
support:['jpy','usd']
表示通貨

Delete project

プロジェクトの削除
Role actions
  • ModifyProject
Request
1
DELETE /project/{project_id} HTTP1.1
2
Authorization: Bearer {token}
Copied!

Get project list

プロジェクト一覧の取得
Role actions
  • ReadProject
  • ModifyProject
Request
1
GET /project HTTP1.1
2
Authorization: Bearer {token}
Copied!
Response
1
HTTP 200
2
3
[
4
{
5
"project_id": "prj-ad413e7b2006f3746r790a",
6
"project_code": "プロジェクト1",
7
"project_label": "プロジェクト1のラベル",
8
"project_currency": "jpy"
9
},
10
{
11
"project_id": "prj-fdf13fvf7vb61h0llr6519",
12
"project_code": "プロジェクト2",
13
"project_label": "プロジェクト2のラベル",
14
"project_currency": "jpy"
15
},...
16
]
Copied!

Get project list per month

月のプロジェクトデータの取得
Role actions
  • ReadProject
  • ModifyProject
Request
1
GET /project/{month} HTTP1.1
2
Authorization: Bearer {token}
Copied!
リクエストパラーメータの{month}のフォーマット: yyyy-mm 例: 2020-01
Response
1
HTTP 200
2
3
[
4
{
5
"project_id": "prj-ad413e7b2006f3746r790a",
6
"project_code": "プロジェクト1",
7
"project_label": "プロジェクト1のラベル",
8
"project_currency": "jpy",
9
"amount": {
10
"aws": {
11
"profit": 0,
12
"profit_exchanged": 0,
13
"profit_exchanged_rate": 0,
14
"profit_rate": 0,
15
"sales": 0,
16
"sales_exchanged": 0,
17
"stock": 0,
18
"stock_exchanged": 0
19
},
20
"total": {
21
"profit": 0,
22
"profit_exchanged": 0,
23
"profit_exchanged_rate": 0,
24
"profit_rate": 0,
25
"sales": 0,
26
"sales_exchanged": 0,
27
"stock": 0,
28
"stock_exchanged": 0
29
}
30
}
31
},...
32
]
Copied!

Export project list per month

月のプロジェクトデータCSVの出力
Role actions
  • ReadProject
  • ModifyProject
Request
1
GET /project/{month}/csv HTTP1.1
2
Authorization: Bearer {token}
Copied!
リクエストパラーメータの{month}のフォーマット: yyyy-mm 例: 2020-01
Response
1
HTTP 200
2
3
{
4
"status":"success",
5
"data":"csv url"
6
}
Copied!
Last modified 1yr ago