Merge branch 'main' of https://github.com/fylein/fyle-platform-docs i…

…nto Fyle-85ztqhzv9

src/admin/openapi.yaml

@@ -192,12 +192,16 @@ paths:
     $ref: paths/[email protected]
   /admin/expenses/assign:
     $ref: paths/admin@[email protected]
+  /admin/expenses/accounting_export_summary/bulk:
+    $ref: paths/admin@expenses@[email protected]
   /admin/expenses/filters:
     $ref: paths/admin@[email protected]
   /admin/expenses/filters/delete:
     $ref: paths/admin@expenses@[email protected]
   /admin/expenses/stats:
     $ref: paths/admin@[email protected]
+  /admin/expenses/exports:
+    $ref: paths/admin@[email protected]
   /admin/advance_requests:
     $ref: paths/admin@advance_requests.yaml
   /admin/advances:
@@ -210,6 +214,10 @@ paths:
     $ref: paths/[email protected]
   /admin/reports/eject_expenses:
     $ref: 'paths/admin@reports@eject_expenses.yaml'
+  /admin/reports/filters:
+    $ref: 'paths/admin@reports@save_filters.yaml'
+  /admin/reports/filters/delete:
+    $ref: 'paths/admin@reports@delete_filter.yaml'
   /admin/reports/comments:
     $ref: 'paths/admin@[email protected]'
   /admin/reports/add_approvers:
@@ -224,6 +232,8 @@ paths:
     $ref: paths/admin@reports@[email protected]
   /admin/reports/stats:
     $ref: paths/admin@[email protected]
+  /admin/reports/create_and_submit:
+    $ref: paths/admin@reports@create_and_submit.yaml
   /admin/corporate_cards:
     $ref: paths/admin@corporate_cards.yaml
   /admin/corporate_cards/bulk:
@@ -358,3 +368,5 @@ paths:
     $ref: paths/admin@expense_rules.yaml
   /admin/expense_rules/delete:
     $ref: paths/admin@[email protected]
+  /admin/expenses/check_mandatory_fields:
+    $ref: paths/admin@expenses@check_mandatory_fields.yaml

src/admin/paths/admin@advances.yaml

@@ -42,9 +42,9 @@ get:
 post:
   tags:
     - Advances
-  summary: Create or update an advances
+  summary: Create advances
   description: |
-    Create or update an advances.
+    Create advances.
   operationId: advances_post
   requestBody:
     required: true

src/admin/paths/admin@categories.yaml

@@ -21,7 +21,7 @@ get:
               data:
                 type: array
                 items:
-                  $ref: ../../components/schemas/category.yaml#/category_out
+                  $ref: ../../components/schemas/category.yaml#/admin_approver_category_out
     '400':
       description: Bad request
       content:
@@ -63,7 +63,7 @@ post:
             additionalProperties: False
             properties:
               data:
-                $ref: ../../components/schemas/category.yaml#/category_out
+                $ref: ../../components/schemas/category.yaml#/admin_approver_category_out
     '400':
       description: Bad request
       content:

src/admin/paths/admin@expenses@accounting_export_summary@bulk.yaml

@@ -0,0 +1,54 @@
+post:
+  operationId: expenses_accounting_export_summary_bulk_post
+  tags:
+    - Expenses
+  summary: Create or update accounting export summary in bulk
+  description: |
+    Create or update accounting export summary in bulk
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          type: object
+          required:
+            - data
+          additionalProperties: False
+          properties:
+            data:
+              type: array
+              items:
+                $ref: ../../components/schemas/expense.yaml#/accounting_export_summary_in
+  responses:
+    '200':
+      description: OK
+    '400':
+      description: Bad request
+      content:
+        application/json:
+          schema:
+            oneOf:
+              - $ref: ../../components/schemas/bulk_error.yaml
+              - type: object
+                properties:
+                  error:
+                    type: string
+                    nullable: true
+                  message:
+                    type: string
+                    nullable: true
+                  data:
+                    type: object
+                    nullable: true
+    '401':
+      description: Unauthorized request
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/schemas/401.yaml
+    '403':
+      description: Forbidden
+      content:
+        application/json:
+          schema:
+            $ref: ../../components/schemas/403.yaml

src/admin/paths/admin@expenses@check_mandatory_fields.yaml

@@ -0,0 +1,52 @@
+post:
+  tags:
+    - Expenses
+  summary: Check expense for missing mandatory fields
+  description: |
+    Before updating employee's expense object
+    into Fyle, based on the business requirements, you might want to check if you have added all the mandatory fields set up by your organization.
+    You can easily do that by passing the same expense object with some extra optional fields documented below.
+  operationId: check_mandatory_fields_post
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          type: object
+          additionalProperties: False
+          required:
+            - data
+          properties:
+            data:
+              $ref: '../../components/schemas/expense.yaml#/expense_check_mandatory_fields_in'
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            additionalProperties: False
+            required: 
+              - data
+            properties:
+              data:
+                $ref: ../../components/schemas/expense.yaml#/expense_check_mandatory_fields_out
+    '401':
+      description: Unauthorised request
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/401.yaml'
+    '400':
+      description: Unauthorised request
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/400.yaml'
+    '404':
+      description: Not Found
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/404.yaml'

src/admin/paths/admin@expenses@exports.yaml

@@ -0,0 +1,46 @@
+post:
+  tags:
+    - Expenses
+  summary: Create Expenses Export
+  description: |
+    Create Expenses Export Request.
+  operationId: expenses_exports_post
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            data:
+              $ref: '../../components/schemas/expenses_exports.yaml#/expenses_exports_in'
+          required:
+            - data
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              data:
+                $ref: '../../components/schemas/expenses_exports.yaml#/expenses_exports_out'
+    '400':
+      description: Bad request
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/400.yaml'
+    '401':
+      description: Unauthorized request
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/401.yaml'
+    '403':
+      description: Forbidden
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/403.yaml'

src/admin/paths/admin@reports@create_and_submit.yaml

@@ -0,0 +1,39 @@
+post:
+  tags:
+    - Reports
+  summary: Create and submit reports for employees 
+  description: Create and submit reports for employees 
+  operationId: report_create_and_submit
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          type: object
+          additionalProperties: False
+          required:
+            - data
+          properties:
+            data:
+              $ref: '../../components/schemas/report.yaml#/report_create_and_submit_expenses'
+  responses:
+    '200':
+      description: OK
+    '401':
+      description: Unauthorised request
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/401.yaml'
+    '400':
+      description: Unauthorised request
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/400.yaml'
+    '404':
+      description: Not Found
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/404.yaml'

src/admin/paths/admin@reports@delete_filter.yaml

@@ -0,0 +1,52 @@
+post:
+  tags:
+    - Reports
+  summary: Delete Report saved filter
+  description: |
+    Delete Report saved filter having the provided id.
+  operationId: report_filters_post_action_delete
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            data:
+              $ref: '../../components/schemas/report_filters.yaml#/report_filters_delete_in'
+          required:
+            - data
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              data:
+                $ref: '../../components/schemas/report_filters.yaml#/report_filters_out'
+    '400':
+      description: Bad request
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/400.yaml'
+    '401':
+      description: Unauthorized request
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/401.yaml'
+    '403':
+      description: Forbidden
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/403.yaml'
+    '404':
+      description: Not Found
+      content:
+        application/json:
+          schema:
+            $ref: '../../components/schemas/404.yaml'