@tocca-systems/twp-cli 0.14.1 → 0.15.1

package/command-model/invoice.json

@@ -0,0 +1,897 @@
+{
+  "domain": "invoice",
+  "operations": [
+    {
+      "name": "cancel",
+      "domain": "invoice",
+      "operationId": "invoice.cancel",
+      "method": "POST",
+      "path": "/v2/sales/invoices/{id}/cancel",
+      "summary": "請求を取消（無効）にする",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "cancel_reason": {
+              "type": "string",
+              "maxLength": 1000
+            }
+          },
+          "required": [
+            "cancel_reason"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "consolidate",
+      "domain": "invoice",
+      "operationId": "invoice.consolidate",
+      "method": "POST",
+      "path": "/v2/sales/invoices/consolidate",
+      "summary": "統合請求書作成（同一取引先の複数請求を1枚に統合）",
+      "pathParams": [],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "invoice_ids": {
+              "type": "array",
+              "items": {
+                "type": "integer"
+              },
+              "minItems": 2
+            },
+            "title": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 500
+            }
+          },
+          "required": [
+            "invoice_ids"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "create",
+      "domain": "invoice",
+      "operationId": "invoice.store",
+      "method": "POST",
+      "path": "/v2/sales/invoices",
+      "summary": "請求作成",
+      "pathParams": [],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "direct_create": {
+              "type": [
+                "boolean",
+                "null"
+              ]
+            },
+            "estimate_format_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "contract_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "estimate_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "invoice_no_rule_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "title": {
+              "type": "string",
+              "maxLength": 500
+            },
+            "company_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "project_id": {
+              "type": "string",
+              "maxLength": 36
+            },
+            "invoice_user_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 36
+            },
+            "business_place_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "seal_impression_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "payee_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "new",
+                "create_completed",
+                "in_progress",
+                "approved",
+                "rejected",
+                "submitted",
+                "manager_confirmation",
+                "invoice_issued",
+                "sent_to_client",
+                "archived",
+                "deleted",
+                null
+              ]
+            },
+            "invoice_date": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "delivery_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "inspection_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "due_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "terms": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "memo": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "internal_memo": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 5000
+            },
+            "manage_form_data": {
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string"
+              }
+            },
+            "details": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "item_name": {
+                    "type": "string",
+                    "maxLength": 500
+                  },
+                  "quantity": {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  "unit": {
+                    "type": "string",
+                    "enum": [
+                      "set",
+                      "item",
+                      "unit",
+                      "hour",
+                      "day",
+                      "month",
+                      "person",
+                      "person_month",
+                      "person_day"
+                    ]
+                  },
+                  "unit_price": {
+                    "type": "integer"
+                  },
+                  "tax_rate": {
+                    "type": "string",
+                    "enum": [
+                      "10",
+                      "8",
+                      "0"
+                    ]
+                  },
+                  "delivery_date": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "format": "date-time"
+                  }
+                },
+                "required": [
+                  "item_name",
+                  "quantity",
+                  "unit",
+                  "unit_price",
+                  "tax_rate"
+                ]
+              },
+              "minItems": 1
+            },
+            "recipients": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "customer_contact_id": {
+                    "type": "string",
+                    "maxLength": 64
+                  },
+                  "recipient_type": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "enum": [
+                      "to",
+                      "cc",
+                      null
+                    ]
+                  }
+                },
+                "required": [
+                  "customer_contact_id"
+                ]
+              },
+              "maxItems": 50
+            }
+          },
+          "required": [
+            "title",
+            "project_id",
+            "invoice_date",
+            "details"
+          ],
+          "title": "InvoiceStoreRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "create-payment-link",
+      "domain": "invoice",
+      "operationId": "invoice.createPaymentLink",
+      "method": "POST",
+      "path": "/v2/sales/invoices/{id}/create-payment-link",
+      "summary": "請求書の支払いリンク生成",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "integer",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "success_url": {
+              "type": "string"
+            },
+            "cancel_url": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "delete",
+      "domain": "invoice",
+      "operationId": "invoice.destroy",
+      "method": "DELETE",
+      "path": "/v2/sales/invoices/{id}",
+      "summary": "",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "destructive",
+      "aliases": []
+    },
+    {
+      "name": "export",
+      "domain": "invoice",
+      "operationId": "invoice.export",
+      "method": "GET",
+      "path": "/v2/sales/invoices/export",
+      "summary": "請求一覧CSV出力",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "sort_column",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "sort_direction",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": null,
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "export-mf-journal",
+      "domain": "invoice",
+      "operationId": "invoice.exportMfJournal",
+      "method": "GET",
+      "path": "/v2/sales/invoices/export-mf-journal",
+      "summary": "請求一覧CSV出力（MF会計仕訳形式・企業ごと集約）",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "debit_account",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "credit_account",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "invoice_date_from",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": null,
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "get",
+      "domain": "invoice",
+      "operationId": "invoice.show",
+      "method": "GET",
+      "path": "/v2/sales/invoices/{id}",
+      "summary": "請求詳細取得",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": null,
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "list",
+      "domain": "invoice",
+      "operationId": "invoice.index",
+      "method": "GET",
+      "path": "/v2/sales/invoices",
+      "summary": "請求一覧取得",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "sort_column",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "sort_direction",
+          "type": "string",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "consolidated_view",
+          "type": "boolean",
+          "required": false,
+          "source": "spec"
+        },
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": null,
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "send-email",
+      "domain": "invoice",
+      "operationId": "invoice.sendEmail",
+      "method": "POST",
+      "path": "/v2/sales/invoices/{id}/send-email",
+      "summary": "請求書メール送信",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "to": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "format": "email"
+              },
+              "minItems": 1
+            },
+            "cc": {
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": [
+                  "string",
+                  "null"
+                ],
+                "format": "email"
+              }
+            },
+            "message": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 2000
+            }
+          },
+          "required": [
+            "to"
+          ],
+          "title": "InvoiceSendEmailRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "uncancel",
+      "domain": "invoice",
+      "operationId": "invoice.uncancel",
+      "method": "DELETE",
+      "path": "/v2/sales/invoices/{id}/cancel",
+      "summary": "請求の取消（無効）を解除する",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "destructive",
+      "aliases": []
+    },
+    {
+      "name": "update",
+      "domain": "invoice",
+      "operationId": "invoice.update",
+      "method": "PUT",
+      "path": "/v2/sales/invoices/{id}",
+      "summary": "請求更新",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "title": {
+              "type": "string",
+              "maxLength": 500
+            },
+            "company_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "project_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 36
+            },
+            "invoice_user_id": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 36
+            },
+            "business_place_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "seal_impression_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "payee_id": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "status": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "enum": [
+                "new",
+                "create_completed",
+                "in_progress",
+                "approved",
+                "rejected",
+                "submitted",
+                "manager_confirmation",
+                "invoice_issued",
+                "sent_to_client",
+                "archived",
+                "deleted",
+                "lost",
+                null
+              ]
+            },
+            "invoice_date": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "delivery_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "inspection_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "due_date": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date-time"
+            },
+            "terms": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "memo": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "internal_memo": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 5000
+            },
+            "approval_comment": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 1000
+            },
+            "manage_form_data": {
+              "type": [
+                "array",
+                "null"
+              ],
+              "items": {
+                "type": "string"
+              }
+            },
+            "details": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "item_name": {
+                    "type": "string",
+                    "maxLength": 500
+                  },
+                  "quantity": {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  "unit": {
+                    "type": "string",
+                    "enum": [
+                      "set",
+                      "item",
+                      "unit",
+                      "hour",
+                      "day",
+                      "month",
+                      "person",
+                      "person_month",
+                      "person_day"
+                    ]
+                  },
+                  "unit_price": {
+                    "type": "integer"
+                  },
+                  "tax_rate": {
+                    "type": "string",
+                    "enum": [
+                      "10",
+                      "8",
+                      "0"
+                    ]
+                  },
+                  "delivery_date": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "format": "date-time"
+                  }
+                }
+              },
+              "minItems": 1
+            },
+            "recipients": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "customer_contact_id": {
+                    "type": "string",
+                    "maxLength": 64
+                  },
+                  "recipient_type": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "enum": [
+                      "to",
+                      "cc",
+                      null
+                    ]
+                  }
+                },
+                "required": [
+                  "customer_contact_id"
+                ]
+              },
+              "maxItems": 50
+            }
+          },
+          "title": "InvoiceUpdateRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "update-internal-memo",
+      "domain": "invoice",
+      "operationId": "invoice.updateInternalMemo",
+      "method": "PATCH",
+      "path": "/v2/sales/invoices/{id}/internal-memo",
+      "summary": "請求の社内共有メモを更新する",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "internal_memo": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 5000
+            }
+          },
+          "required": [
+            "internal_memo"
+          ]
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    }
+  ]
+}