Skip to content

Commit

Permalink
fix transactions doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@ktakenaka
ktakenaka committed Apr 26, 2019
1 parent ebf51d7 commit fc6dabc
Showing 1 changed file with 45 additions and 16 deletions.
61 changes: 45 additions & 16 deletions transactions_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,26 +35,55 @@ X-MFOAuthToken: "Bearer 0d171c8d5e6b023fa13ebd2209453f95e566ba4cb16a1bd1c3becdf0
```

## 応答の本文

### パラメーター

| 名称 | 内容 |
| ---- | --- |
| `transactions[i][transaction][hashed_id]` | 入出金記録の `hashed_id` |
| `transactions[i][transaction][content]` | ユーザーが書き込める入出金の内容を表す文字列 |
| `transactions[i][transaction][is_target]` | `true`: 計算対象, `false`: 計算対象外 |
| `transactions[i][transaction][is_income]` | `true`: 収入, `false`: 支出 |
| `transactions[i][transaction][is_transfer]` | `true`: 振替, `false`: 振替でない |
| `transactions[i][transaction][currency]` | 通貨; デフォルト: `JPY` (日本円) |
| `transactions[i][transaction][amount]` | 金額; 正: 入金, 負: 出金 |
| `transactions[i][transaction][jpyrate]` | 日本円に対する為替レート |
| `transactions[i][transaction][large_category_id]` | 大項目の `id` |
| `transactions[i][transaction][middle_category_id]` | 中項目の `id` |
| `transactions[i][transaction][hashed_partner_act_id]` | 振替を構成する反対側の入出金記録の `hashed_id` |
| `transactions[i][transaction][hashed_account_id]` | 入出金元の口座の `hashed_id` |
| `transactions[i][transaction][hashed_sub_account_id]` | 入出金元のサブアカウントの `hashed_id` |
| `transactions[i][transaction][updated_at]` | 入出金が記帳された日時; ISO 8601 拡張形式 |
| `transactions[i][transaction][created_at]` | マネーフォワードが情報を取得した日時; ISO 8601 拡張形式 |
| `total_count` | 全レコード数 |
| `transactions[i][transaction][amount]` | 金額; 正: 入金, 負: 出金 |
| `transactions[i][transaction][content]` | ユーザーが書き込める入出金の内容を表す文字列 |
| `transactions[i][transaction][created_at]` | マネーフォワードが情報を取得した日時; ISO 8601 拡張形式 |
| `transactions[i][transaction][currency]` | 通貨; デフォルト: `JPY` (日本円) |
| `transactions[i][transaction][is_target]` | `true`: 計算対象, `false`: 計算対象外 |
| `transactions[i][transaction][is_income]` | `true`: 収入, `false`: 支出 |
| `transactions[i][transaction][is_transfer]` | `true`: 振替, `false`: 振替でない |
| `transactions[i][transaction][jpyrate]` | 日本円に対する為替レート |
| `transactions[i][transaction][large_category_id]` | 大項目の`id` |
| `transactions[i][transaction][memo]` | ユーザー入力のメモ |
| `transactions[i][transaction][middle_category_id]` | 中項目の`id` |
| `transactions[i][transaction][updated_at]` | 入出金が記帳された日時; ISO 8601 拡張形式 |
| `transactions[i][transaction][hashed_id]` | 入出金記録の`hashed_id` |
| `transactions[i][transaction][hashed_partner_act_id]` | 振替を構成する反対側の入出金記録の`hashed_id` |
| `transactions[i][transaction][hashed_account_id]` | 入出金元の口座の`hashed_id` |
| `transactions[i][transaction][hashed_sub_account_id]` | 入出金元のサブアカウントの`hashed_id` |
| `transactions[i][transaction][account][account_uid_hidden]` | 口座のidの一部を隠したもの (最大3文字が表示される) |
| `transactions[i][transaction][account][created_at]` | accountを登録した日時 |
| `transactions[i][transaction][account][disp_name]` | ユーザーが設定した口座の識別名 (未設定なら null) |
| `transactions[i][transaction][account][last_aggregated_at]` | 該当accountのサービスが、MoneyForwardと最後にデータ連携を実施した日時 |
| `transactions[i][transaction][account][last_succeeded_at]` | 該当accountのサービスが、MoneyForwardと最後にデータ連携処理が成功した日時 |
| `transactions[i][transaction][account][memo]` | ユーザーが設定したメモ |
| `transactions[i][transaction][account][message]` | 金融機関からユーザーへの通知 |
| `transactions[i][transaction][account][msg_flag]` | `true`: message を表示する, false (デフォルト): message を表示しない |
| `transactions[i][transaction][account][msg_time]` | 現在は未使用
| `transactions[i][transaction][account][next_aggregate_at]` | 該当accountのサービスが、MoneyForwardとデータ連携する次回の予定日 |
| `transactions[i][transaction][account][service_category_id]` | 金融機関分類のid |
| `transactions[i][transaction][account][service_id]` | 金融機関の`id` |
| `transactions[i][transaction][account][status]` | 金融機関からの情報の取得状況; 0: 取得済み, 1: 取得中、2: 取得エラー, 3: 取得停止中 |
| `transactions[i][transaction][sub_account][created_at]` | sub_accountを登録した日時 |
| `transactions[i][transaction][sub_account][disp_name]` | 手入力で作成した口座（財布内の所持金など）につけた名称 |
| `transactions[i][transaction][sub_account][service_category_id]` | 金融機関分類のid |
| `transactions[i][transaction][sub_account][sub_name]` | 支店名 |
| `transactions[i][transaction][sub_account][sub_number]` | 口座番号 |
| `transactions[i][transaction][sub_account][sub_type]` | 口座の種別（普通、定期、カードなど）など弊社側のシステムで自動で割り当てられた値 |
| `transactions[i][transaction][large_category][disp_order]` | マネーフォワードサービスで表示される時の表示順 |
| `transactions[i][transaction][large_category][id]` | 大項目の`id` |
| `transactions[i][transaction][large_category][income]` | `true`: 収入, `false`: 支出 ※（サンプルデータには、-1が格納されているため、要確認） |
| `transactions[i][transaction][large_category][name]` | 大項目の名称 |
| `transactions[i][transaction][middle_category][disp_order]` | マネーフォワードサービスで表示される時の表示順 |
| `transactions[i][transaction][middle_category][id]` | 中項目の`id` |
| `transactions[i][transaction][middle_category][large_category_id]` | 紐付く大項目の`id` |
| `transactions[i][transaction][middle_category][name]` | 中項目の名称 |


### 例

Expand Down

0 comments on commit fc6dabc

Please sign in to comment.