diff --git a/reference/admin.yaml b/reference/admin.yaml
index a9a04c196..2bcac93fa 100644
--- a/reference/admin.yaml
+++ b/reference/admin.yaml
@@ -2,8 +2,9 @@ openapi: 3.0.3
info:
version: '1.0'
title: Admin APIs
- description: |
- These APIs are generally used to integrate Fyle with accounting or HRMS systems.
+ description: >
+ These APIs are generally used to integrate Fyle with accounting or HRMS
+ systems.
contact:
name: Platform Beta
email: support@fylehq.com
@@ -28,8 +29,9 @@ components:
properties:
message:
type: string
- description: |
- Request has been accepted and is being processed, Please try again in sometime.
+ description: >
+ Request has been accepted and is being processed, Please try again
+ in sometime.
'400':
type: object
properties:
@@ -45,8 +47,10 @@ components:
enum:
- invalid token
type: string
- description: |
- This error means that the input access token is either not issued by Fyle or has expired.
+ description: >
+ This error means that the input access token is either not issued by
+ Fyle or has expired.
+
You need to generate a new access token.
'403':
type: object
@@ -55,8 +59,9 @@ components:
enum:
- Forbidden
type: string
- description: |
- This error means current user does not have enough permissions to perform this operation.
+ description: >
+ This error means current user does not have enough permissions to
+ perform this operation.
'404':
type: object
properties:
@@ -64,26 +69,33 @@ components:
enum:
- Resource not found
type: string
- description: |
- This error means the requested resource was not found or the requester doesn't have sufficient access.
+ description: >
+ This error means the requested resource was not found or the
+ requester doesn't have sufficient access.
'500':
type: object
properties:
message:
type: string
- description: |
- API server hit an internal error and could not process request. This is likely a bug.
+ description: >
+ API server hit an internal error and could not process request. This
+ is likely a bug.
count:
type: integer
description: |
The total number of objects that can be requested.
example: 10000
offset:
- description: |
+ description: >
offset is used to skip that many number of objects before counting.
+
For example, if there are 2000 objects,
- The first request will have offset as 0 and limit as 200 to return first 200 objects.
- The second request will have offset as 200 and limit as 200 to return next 200 objects.
+
+ The first request will have offset as 0 and limit as 200 to return first
+ 200 objects.
+
+ The second request will have offset as 200 and limit as 200 to return
+ next 200 objects.
type: integer
example: 10
id_integer:
@@ -100,21 +112,24 @@ components:
created_at:
type: string
format: date-time
- description: |
- Signifies when this object was created in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >
+ Signifies when this object was created in [ISO8601
+ format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
example: '2020-06-01T13:14:54.804+00:00'
updated_at:
type: string
format: date-time
- description: |
- Signifies when this object was updated in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >
+ Signifies when this object was updated in [ISO8601
+ format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
example: '2020-06-11T13:14:55.201598+00:00'
code:
type: string
nullable: true
maxLength: 255
- description: |
- This represents a code that is typically used for syncing with other systems.
+ description: >
+ This represents a code that is typically used for syncing with other
+ systems.
example: C1234
description:
type: string
@@ -125,8 +140,9 @@ components:
example: Win the trophy
is_enabled:
type: boolean
- description: |
- This indicates if the resource is enabled for use within the organisation.
+ description: >
+ This indicates if the resource is enabled for use within the
+ organisation.
default: true
example: true
restricted_spender_user_ids:
@@ -170,9 +186,11 @@ components:
type: string
maxLength: 127
example: john.doe@example.com
- description: |
+ description: >
An immutable field that represents the email address of the employee.
- Must be compliant with RFC 822.
+
+ Must be compliant with RFC
+ 822.
user_out_embed:
type: object
additionalProperties: false
@@ -186,8 +204,9 @@ components:
full_name:
type: string
maxLength: 255
- description: |
- Represents the full name of the Employee. Must be at least 3 characters.
+ description: >
+ Represents the full name of the Employee. Must be at least 3
+ characters.
example: John Doe
admin_approver_project_out:
type: object
@@ -217,9 +236,12 @@ components:
display_name:
type: string
maxLength: 513
- description: |
- This is a combination of name and sub_project separated by a / and spaces.
- In case if no sub_project is present it is same as name of the project.
+ description: >
+ This is a combination of name and sub_project separated by a / and
+ spaces.
+
+ In case if no sub_project is present it is same as name of the
+ project.
example: Fast and Furious / Formula One
description:
$ref: '#/components/schemas/description'
@@ -281,10 +303,15 @@ components:
example:
- uswoirwlwwg
- uswlgwkgw42
- description: |
+ description: >
- List of IDs of users who can access this object.
- - `null` value indicates that all users in the org can access this object.
- - `[]` value indicates that no users in the org can access this object.
+
+ - `null` value indicates that all users in the org can access this
+ object.
+
+ - `[]` value indicates that no users in the org can access this
+ object.
+
- **Note:**
- **_When the `restrict employee to their own projects` feature is disabled, only `null` value is accepted._**
- _If the `restrict employee to their own projects` feature is **disabled**, then the default value while creating project is `null`._
@@ -292,10 +319,14 @@ components:
approver_user_ids:
allOf:
- $ref: '#/components/schemas/approver_user_ids'
- description: |
+ description: >
- List of IDs of users who are approvers of the project.
- - Either `approver_user_ids` or `approver_emails` can be used but not both.
- - The default value for approver_user_ids is `[]` and it is applicable only when creating the project.
+
+ - Either `approver_user_ids` or `approver_emails` can be used but
+ not both.
+
+ - The default value for approver_user_ids is `[]` and it is
+ applicable only when creating the project.
approver_emails:
type: array
maxItems: 2
@@ -305,16 +336,23 @@ components:
maxLength: 127
nullable: true
example: john.doe@example.com
- description: |
- An immutable field that represents the email address of the employee.
- Must be compliant with RFC 822.
+ description: >
+ An immutable field that represents the email address of the
+ employee.
+
+ Must be compliant with RFC 822.
example:
- approver1@example.com
- approver2@example.com
- description: |
+ description: >
- List of emails of employees that are approvers for the project.
- - Either `approver_user_ids` or `approver_emails` can be used but not both.
- - The default value for approver_emails is `[]` and it is applicable only when creating the project.
+
+ - Either `approver_user_ids` or `approver_emails` can be used but
+ not both.
+
+ - The default value for approver_emails is `[]` and it is applicable
+ only when creating the project.
category_ids:
type: array
nullable: true
@@ -324,10 +362,15 @@ components:
- 87291
- 78322
- 492
- description: |
+ description: >
- List of IDs of categories which can be used with the project.
- - `null` value indicates that all categories in the org are applicable for the project.
- - `[]` value indicates that no category in the org is applicable for the project.
+
+ - `null` value indicates that all categories in the org are
+ applicable for the project.
+
+ - `[]` value indicates that no category in the org is applicable for
+ the project.
+
- The default value of `category_ids` is `null`
bulk_error:
type: object
@@ -416,10 +459,15 @@ components:
example:
- uswoirwlwwg
- uswlgwkgw42
- description: |
+ description: >
- List of IDs of users who can access this object.
- - `null` value indicates that all users in the org can access this object.
- - `[]` value indicates that no users in the org can access this object.
+
+ - `null` value indicates that all users in the org can access this
+ object.
+
+ - `[]` value indicates that no users in the org can access this
+ object.
+
- **Note:**
- _Either `restricted_spender_user_ids` or `restricted_spender_user_group` key can be used to set restrictions. Both the keys can't be used together._
- _While creating cost_centers, if both `restricted_spender_user_ids` and `restricted_spender_user_group` keys are not set, restrictions defaults to `"restricted_spender_user_group": {"with_no_cost_center_restrictions": "true"}`_
@@ -432,8 +480,9 @@ components:
properties:
with_no_cost_center_restrictions:
type: boolean
- description: |
- - If you want the cost_center to be visible to all the users in the org with no cost center restrictions,
+ description: >
+ - If you want the cost_center to be visible to all the users in
+ the org with no cost center restrictions,
you can set this key to True.
**Note:**
- _Either `restricted_spender_user_ids` or `restricted_spender_user_group` key can be used to set restrictions. Both the keys can't be used together._
@@ -469,8 +518,10 @@ components:
type: string
maxLength: 255
example: Engine / Turbo charged
- description: |
- This is a combination of name and sub_category separated by a / and spaces. In case if no sub_category is present it is same as name of the category.
+ description: >
+ This is a combination of name and sub_category separated by a / and
+ spaces. In case if no sub_category is present it is same as name of
+ the category.
system_category:
nullable: true
type: string
@@ -487,8 +538,9 @@ components:
example:
- 2222
- 1221
- description: |
- List of project ids for which this category can be used. If project_ids is null, then this category can be used for any project.
+ description: >
+ List of project ids for which this category can be used. If
+ project_ids is null, then this category can be used for any project.
restricted_spender_user_ids:
$ref: '#/components/schemas/restricted_spender_user_ids'
category_in:
@@ -509,7 +561,9 @@ components:
type: string
maxLength: 255
example: Turbo charged
- description: Represents the sub category of the category. Note that the name and sub category cannot be same.
+ description: >-
+ Represents the sub category of the category. Note that the name and
+ sub category cannot be same.
is_enabled:
$ref: '#/components/schemas/is_enabled'
system_category:
@@ -528,8 +582,9 @@ components:
example:
- 2222
- 1221
- description: |
- List of project ids for which this category can be used. If project_ids is null, then this category can be used for any project
+ description: >
+ List of project ids for which this category can be used. If
+ project_ids is null, then this category can be used for any project
restricted_spender_user_ids:
type: array
nullable: true
@@ -543,10 +598,15 @@ components:
example:
- uswoirwlwwg
- uswlgwkgw42
- description: |
- - List of IDs of users who can access this category. Default value is `[]`.
- - `null` value indicates that all users in the org can access this category.
- - `[]` value indicates that no users in the org can access this category.
+ description: >
+ - List of IDs of users who can access this category. Default value
+ is `[]`.
+
+ - `null` value indicates that all users in the org can access this
+ category.
+
+ - `[]` value indicates that no users in the org can access this
+ category.
system_category_out:
type: object
additionalProperties: false
@@ -585,8 +645,9 @@ components:
example: Vendor description
column_name:
type: string
- description: |
- This specifies the name of column to which this expense field mapped to.
+ description: >
+ This specifies the name of column to which this expense field mapped
+ to.
example: Purpose
type:
type: string
@@ -597,8 +658,9 @@ components:
type: array
items:
type: string
- description: |
- This specifies the option values of the expense field in case on SELECT or MULTI_SELECT type.
+ description: >
+ This specifies the option values of the expense field in case on
+ SELECT or MULTI_SELECT type.
example:
- Chai
- Coffee
@@ -633,8 +695,10 @@ components:
parent_field_id:
type: integer
nullable: true
- description: |
- This specifies the `id` of the parent expense field and denotes that the expense field is a dependent custom field. NOTE: `type` must be `DEPENDENT_SELECT`.
+ description: >
+ This specifies the `id` of the parent expense field and denotes that
+ the expense field is a dependent custom field. NOTE: `type` must be
+ `DEPENDENT_SELECT`.
example: 1234
expense_field_in:
type: object
@@ -670,8 +734,9 @@ components:
- flight_return_travel_class
- train_travel_class
- bus_travel_class
- description: |
- This specifies the name of column to which this expense field mapped to.
+ description: >
+ This specifies the name of column to which this expense field mapped
+ to.
example: purpose
type:
type: string
@@ -693,8 +758,10 @@ components:
items:
type: string
nullable: true
- description: |
- This specifies the option values of the expense field in case on SELECT or MULTI_SELECT type. Sets to empty array by default if null is passed.
+ description: >
+ This specifies the option values of the expense field in case on
+ SELECT or MULTI_SELECT type. Sets to empty array by default if null
+ is passed.
example:
- Chai
- Coffee
@@ -707,13 +774,17 @@ components:
placeholder:
type: string
nullable: true
- description: |
- This specifies the placeholder of the expense field. Sets to empty string by default if null is passed.
+ description: >
+ This specifies the placeholder of the expense field. Sets to empty
+ string by default if null is passed.
example: Enter vendor
category_ids:
type: array
nullable: true
- description: List of category ids for which this expense field is applicable. If null is passed, the default value is all category ids of the org as array.
+ description: >-
+ List of category ids for which this expense field is applicable. If
+ null is passed, the default value is all category ids of the org as
+ array.
items:
type: integer
example: 16570
@@ -734,8 +805,10 @@ components:
parent_field_id:
type: integer
nullable: true
- description: |
- This specifies the `id` of the parent expense field and denotes that the expense field is a dependent custom field. NOTE: `type` must be `DEPENDENT_SELECT`.
+ description: >
+ This specifies the `id` of the parent expense field and denotes that
+ the expense field is a dependent custom field. NOTE: `type` must be
+ `DEPENDENT_SELECT`.
example: 1234
dependent_expense_field_values_out:
type: object
@@ -834,8 +907,9 @@ components:
expense_field_values:
type: array
nullable: false
- description: |
- This specifies the text values of the dependent expense field upto 20 items.
+ description: >
+ This specifies the text values of the dependent expense field upto
+ 20 items.
items:
type: string
nullable: false
@@ -875,8 +949,9 @@ components:
error_file_id:
type: string
nullable: true
- description: |
- File `id` of the error excel file generated after processing the uploaded file.
+ description: >
+ File `id` of the error excel file generated after processing the
+ uploaded file.
example: fiit3pX9gzzQ
state:
type: string
@@ -989,8 +1064,9 @@ components:
type: array
items:
type: string
- description: |
- This specifies the option values of the employee field in case on SELECT or MULTI_SELECT type.
+ description: >
+ This specifies the option values of the employee field in case on
+ SELECT or MULTI_SELECT type.
example:
- Mr
- Mrs
@@ -1028,8 +1104,9 @@ components:
type: array
items:
type: string
- description: |
- This specifies the option values of the employee field in case on SELECT or MULTI_SELECT type.
+ description: >
+ This specifies the option values of the employee field in case on
+ SELECT or MULTI_SELECT type.
example:
- Mr
- Ms
@@ -1057,8 +1134,9 @@ components:
name:
type: string
maxLength: 255
- description: |
- This represents the name of the resource. This should be unique in an organization
+ description: >
+ This represents the name of the resource. This should be unique in an
+ organization
example: foo123
per_diem_rate_out:
type: object
@@ -1174,8 +1252,10 @@ components:
display_name:
type: string
example: Sales / Outbound Sales
- description: |
- This is a combination of name and sub_department separated by a / and spaces. In case if no sub_department is present it is same as name of the department.
+ description: >
+ This is a combination of name and sub_department separated by a /
+ and spaces. In case if no sub_department is present it is same as
+ name of the department.
doc_url:
type: string
nullable: true
@@ -1313,8 +1393,9 @@ components:
band:
type: string
nullable: true
- description: |
- Band in which this level belongs to, you can group multiple levels into a single band.
+ description: >
+ Band in which this level belongs to, you can group multiple levels
+ into a single band.
example: Associate
code:
$ref: '#/components/schemas/code'
@@ -1349,8 +1430,9 @@ components:
band:
type: string
nullable: true
- description: |
- Band in which this level belongs to, you can group multiple levels into a single band.
+ description: >
+ Band in which this level belongs to, you can group multiple levels
+ into a single band.
example: Associate
code:
$ref: '#/components/schemas/code'
@@ -1392,13 +1474,17 @@ components:
display_name:
type: string
example: Sales / Outbound Sales
- description: |
- This is a combination of name and sub_department separated by a / and spaces. In case if no sub_department is present it is same as name of the department.
+ description: >
+ This is a combination of name and sub_department separated by a /
+ and spaces. In case if no sub_department is present it is same as
+ name of the department.
timestamptz_utc:
type: string
format: date-time
nullable: true
- description: Date-time in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >-
+ Date-time in [ISO8601
+ format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
example: '2020-06-01T13:14:54.804+00:00'
level_out_embed:
type: object
@@ -1415,8 +1501,9 @@ components:
band:
type: string
nullable: true
- description: |
- Band in which this level belongs to, you can group multiple levels into a single band.
+ description: >
+ Band in which this level belongs to, you can group multiple levels
+ into a single band.
example: Associate
required:
- id
@@ -1504,12 +1591,18 @@ components:
$ref: '#/components/schemas/custom_field'
flattened_custom_field:
type: object
- description: |
- Custom fields in object format with keys as the name of the custom field and value as the value of the custom field. This is done to make it easier to query the custom fields.
+ description: >
+ Custom fields in object format with keys as the name of the custom field
+ and value as the value of the custom field. This is done to make it
+ easier to query the custom fields.
- Example: `[{"name": "Custom Field 1", "value": "Value 1"}]` is flattened to `{"custom_field_1": "Value 1"}`
- NOTE: Key name is converted to snake case and spaces are replaced with underscores.
+ Example: `[{"name": "Custom Field 1", "value": "Value 1"}]` is flattened
+ to `{"custom_field_1": "Value 1"}`
+
+
+ NOTE: Key name is converted to snake case and spaces are replaced with
+ underscores.
nullable: false
additionalProperties: true
properties:
@@ -1555,9 +1648,12 @@ components:
display_name:
type: string
example: Fast and Furious / Formula One
- description: |
- This is a combination of name and sub_project separated by a / and spaces.
- In case if no sub_project is present it is same as name of the project.
+ description: >
+ This is a combination of name and sub_project separated by a / and
+ spaces.
+
+ In case if no sub_project is present it is same as name of the
+ project.
cost_center_out_embed:
type: object
nullable: true
@@ -1609,8 +1705,10 @@ components:
type: string
example: '+12131234567'
maxLength: 16
- description: |
- phone number is represented by +CC MMMMMM... where CC is the country code, and is one to three digits, and MMMMMM... is the area code (where applicable) and subscriber number Max 12 digits
+ description: >
+ phone number is represented by +CC MMMMMM... where CC is the country
+ code, and is one to three digits, and MMMMMM... is the area code (where
+ applicable) and subscriber number Max 12 digits
pattern: /^(\+\d{1,3}[- ]?)?\d{10}$/
locale:
type: object
@@ -1686,8 +1784,9 @@ components:
type: string
format: date-time
example: '2020-07-11T13:14:55.201598+00:00'
- description: |
- Date and time till which the delegation is active. If null, delegation is active indefinitely.
+ description: >
+ Date and time till which the delegation is active. If null,
+ delegation is active indefinitely.
nullable: true
category_out_embed:
type: object
@@ -1718,8 +1817,10 @@ components:
display_name:
type: string
example: Engine / Turbo charged
- description: |
- This is a combination of name and sub_category separated by a / and spaces. In case if no sub_category is present it is same as name of the category.
+ description: >
+ This is a combination of name and sub_category separated by a / and
+ spaces. In case if no sub_category is present it is same as name of
+ the category.
employee_out:
type: object
additionalProperties: false
@@ -1746,9 +1847,12 @@ components:
maxLength: 255
nullable: true
example: E84122
- description: |
- This field refers to any string that the client programs can use to refer to an employee's unique id.
- This could be any field such as an UUID from an Active Directory server or employee id in a HRMS system.
+ description: >
+ This field refers to any string that the client programs can use to
+ refer to an employee's unique id.
+
+ This could be any field such as an UUID from an Active Directory
+ server or employee id in a HRMS system.
department_id:
$ref: '#/components/schemas/fk_string'
department:
@@ -1808,15 +1912,17 @@ components:
example:
- 2222
- 1221
- description: |
- List of cost center ids that this employee is allowed to access. [] (empty array) means access to all cost centers.
+ description: >
+ List of cost center ids that this employee is allowed to access. []
+ (empty array) means access to all cost centers.
cost_centers:
type: array
nullable: false
items:
$ref: '#/components/schemas/cost_center_out_embed'
- description: |
- List of cost_ enters that this employee is allowed to access. [] (empty array) means access to all cost centers.
+ description: >
+ List of cost_ enters that this employee is allowed to access. []
+ (empty array) means access to all cost centers.
per_diem_rate_ids:
type: array
nullable: false
@@ -1871,8 +1977,9 @@ components:
List of users who are approvers for this employee.
has_accepted_invite:
type: boolean
- description: |
- This boolean field represents whether the employee has accepted the current org's invite by veryfying his/her email or not.
+ description: >
+ This boolean field represents whether the employee has accepted the
+ current org's invite by veryfying his/her email or not.
default: true
example: true
branch_account:
@@ -1889,8 +1996,9 @@ components:
items:
$ref: '#/components/schemas/bank_ifsc'
example: null
- description: |
- IFSC code of the bank account of the Employee. Must be a 11 digit alphanumeric code.
+ description: >
+ IFSC code of the bank account of the Employee. Must be a 11 digit
+ alphanumeric code.
mobile:
type: string
nullable: true
@@ -1948,14 +2056,17 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
- This represents the name of the resource. This should be unique in an organization
+ description: >
+ This represents the name of the resource. This should be unique in an
+ organization
example: foo123
timestamptz_pst:
type: string
format: date-time
nullable: true
- description: Date-time in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >-
+ Date-time in [ISO8601
+ format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
example: '2020-06-01T01:18:19.292-08:00'
invitation_in:
type: object
@@ -1968,8 +2079,10 @@ components:
user_full_name:
type: string
maxLength: 255
- description: |
- Represents the full name of the Employee. Must be at least 3 characters.
+ description: >
+ Represents the full name of the Employee. Must be at least 3
+ characters.
+
Is required when creating a new employee
example: John Doe
business_unit:
@@ -1982,9 +2095,12 @@ components:
maxLength: 255
nullable: true
example: E84122
- description: |
- This field refers to any string that the client programs can use to refer to an employee's unique id.
- This could be any field such as an UUID from an Active Directory server or employee id in a HRMS system.
+ description: >
+ This field refers to any string that the client programs can use to
+ refer to an employee's unique id.
+
+ This could be any field such as an UUID from an Active Directory
+ server or employee id in a HRMS system.
department_name:
$ref: '#/components/schemas/name_nullable'
sub_department:
@@ -2026,9 +2142,13 @@ components:
example:
- Project / Sub Project
- Only Project
- description: |
- List of project names that this employee is allowed to access. If null, then there are no restrictions.
- Individual list item should be in the format of `project_name / sub_project`. If there is no sub project, then simply pass `project_name`.
+ description: >
+ List of project names that this employee is allowed to access. If
+ null, then there are no restrictions.
+
+ Individual list item should be in the format of `project_name /
+ sub_project`. If there is no sub project, then simply pass
+ `project_name`.
cost_center_names:
type: array
nullable: false
@@ -2036,8 +2156,9 @@ components:
$ref: '#/components/schemas/name'
example:
- Sales
- description: |
- List of cost center names that this employee is allowed to access. [] (empty array) means access to all cost centers.
+ description: >
+ List of cost center names that this employee is allowed to access.
+ [] (empty array) means access to all cost centers.
per_diem_rate_names:
type: array
nullable: false
@@ -2065,8 +2186,9 @@ components:
example:
- two_wheeler
- four_wheeler_1
- description: |
- List of mileage rate's vehicle types that this employee is allowed to access. If null, then there are no restrictions
+ description: >
+ List of mileage rate's vehicle types that this employee is allowed
+ to access. If null, then there are no restrictions
branch_account:
type: string
nullable: true
@@ -2081,8 +2203,9 @@ components:
items:
$ref: '#/components/schemas/bank_ifsc'
example: null
- description: |
- IFSC code of the bank account of the Employee. Must be a 11 digit alphanumeric code.
+ description: >
+ IFSC code of the bank account of the Employee. Must be a 11 digit
+ alphanumeric code.
mobile:
type: string
nullable: true
@@ -2107,8 +2230,10 @@ components:
employee_id:
type: string
maxLength: 255
- description: |
- This id provided by Fyle to uniquely identify an employee within an organization.
+ description: >
+ This id provided by Fyle to uniquely identify an employee within an
+ organization.
+
This id is always prefixed with `ou`.
example: outGt9ju6qP
reinvitation_in:
@@ -2129,8 +2254,9 @@ components:
is_shared:
type: boolean
nullable: true
- description: |
- This indicates if the filter should be shared with other admins in the org.
+ description: >
+ This indicates if the filter should be shared with other admins in the
+ org.
default: false
example: true
query_string:
@@ -2217,8 +2343,9 @@ components:
error_file_id:
type: string
nullable: true
- description: |
- File `id` of the error excel file generated after processing the uploaded file.
+ description: >
+ File `id` of the error excel file generated after processing the
+ uploaded file.
example: fi1yut1owo3
employees_upload_in:
type: object
@@ -2246,8 +2373,9 @@ components:
file_id:
type: string
nullable: true
- description: |
- File `id` of the excel file generated after processing the download request.
+ description: >
+ File `id` of the excel file generated after processing the download
+ request.
example: fi3ou3hg3l
state:
type: string
@@ -2276,8 +2404,9 @@ components:
enum:
- INTEGRATION
- RECEIPT
- description: |
- Indicates whether this file original size or encrypted or its thumbnail image.
+ description: >
+ Indicates whether this file original size or encrypted or its
+ thumbnail image.
example: RECEIPT
password:
type: string
@@ -2318,8 +2447,9 @@ components:
enum:
- INTEGRATION
- RECEIPT
- description: |
- Indicates whether this file original size or encrypted or its thumbnail image.
+ description: >
+ Indicates whether this file original size or encrypted or its
+ thumbnail image.
example: RECEIPT
content_type:
type: string
@@ -2466,7 +2596,9 @@ components:
type: string
description: |
A human readable identifier for the automate report submission
- example: Expense Reports will be submitted automatically for approval on the Last Day, 7th and 24th of every month.
+ example: >-
+ Expense Reports will be submitted automatically for approval on the
+ Last Day, 7th and 24th of every month.
schedule_config:
$ref: '#/components/schemas/schedule_config'
org_id:
@@ -2488,7 +2620,9 @@ components:
type: string
description: |
A human readable identifier for the automate report submission
- example: Expense Reports will be submitted automatically for approval on the Last Day, 7th and 24th of every month.
+ example: >-
+ Expense Reports will be submitted automatically for approval on the
+ Last Day, 7th and 24th of every month.
schedule_config:
$ref: '#/components/schemas/schedule_config'
delete_automate_report_submission_in:
@@ -2600,8 +2734,9 @@ components:
type: string
nullable: true
maxLength: 255
- description: |
- Optional metadata about the Export operation. For example, newly created Accounting Entry numbers in Quickbooks.
+ description: >
+ Optional metadata about the Export operation. For example, newly
+ created Accounting Entry numbers in Quickbooks.
accounting_export_id:
$ref: '#/components/schemas/fk_string'
org_id:
@@ -2630,27 +2765,31 @@ components:
type: string
nullable: true
maxLength: 255
- description: |
- Optional metadata about the Export operation. For example, newly created Accounting Entry numbers in Quickbooks.
+ description: >
+ Optional metadata about the Export operation. For example, newly
+ created Accounting Entry numbers in Quickbooks.
accounting_export_id:
$ref: '#/components/schemas/fk_string'
currency:
type: string
- description: |
- The three-letter currency code following ISO standard ISO 4217.
+ description: >
+ The three-letter currency code following ISO standard ISO 4217.
example: USD
pattern: ([A-Z]{3})
foreign_currency:
type: string
nullable: true
- description: |
- The three-letter currency code following ISO standard ISO 4217.
+ description: >
+ The three-letter currency code following ISO standard ISO 4217.
example: GBP
foreign_amount:
type: number
nullable: true
- description: |
- Amount value of the object, in original currency i.e the currency in which the object was initially created.
+ description: >
+ Amount value of the object, in original currency i.e the currency in
+ which the object was initially created.
example: 3768
fk_integer:
type: integer
@@ -2806,8 +2945,10 @@ components:
reimbursement_seq_num:
type: string
nullable: true
- description: |
- A unique, organization wide identifier for a particular reimbursement.
+ description: >
+ A unique, organization wide identifier for a particular
+ reimbursement.
+
This id is always prefixed with `P/`.
example: P/2020/11/29
approvals:
@@ -2834,8 +2975,9 @@ components:
enum:
- INTEGRATION
- RECEIPT
- description: |
- Indicates whether this file original size or encrypted or its thumbnail image.
+ description: >
+ Indicates whether this file original size or encrypted or its
+ thumbnail image.
example: RECEIPT
content_type:
type: string
@@ -2843,8 +2985,9 @@ components:
org_name:
type: string
maxLength: 255
- description: |
- This represents the name of the organization. This should be unique for all organizations
+ description: >
+ This represents the name of the organization. This should be unique for
+ all organizations
example: foo123
department_id:
type: string
@@ -2867,9 +3010,12 @@ components:
maxLength: 255
nullable: true
example: E84122
- description: |
- This field refers to any string that the client programs can use to refer to an employee's unique id.
- This could be any field such as an UUID from an Active Directory server or employee id in a HRMS system.
+ description: >
+ This field refers to any string that the client programs can use to
+ refer to an employee's unique id.
+
+ This could be any field such as an UUID from an Active Directory
+ server or employee id in a HRMS system.
org_id:
$ref: '#/components/schemas/org_id'
org_name:
@@ -2903,14 +3049,16 @@ components:
$ref: '#/components/schemas/flattened_custom_field'
has_accepted_invite:
type: boolean
- description: |
- This boolean field represents whether the employee has accepted the current org's invite by veryfying his/her email or not.
+ description: >
+ This boolean field represents whether the employee has accepted the
+ current org's invite by veryfying his/her email or not.
default: true
example: true
is_enabled:
$ref: '#/components/schemas/is_enabled'
- description: |
- NOTE: The data of this field is not realtime. It will get updated later even if `matched_corporate_card_transaction_ids` is already up-to-date.
+ description: >
+ NOTE: The data of this field is not realtime. It will get updated later
+ even if `matched_corporate_card_transaction_ids` is already up-to-date.
card_number:
type: string
description: |
@@ -3000,22 +3148,28 @@ components:
nullable: true
allOf:
- $ref: '#/components/schemas/merchant'
- description: |
- String denoting the name of the vendor to which the card transaction was made.
- Note: This is not same as the merchant added in Fyle but just a string
+ description: >
+ String denoting the name of the vendor to which the card transaction
+ was made.
+
+ Note: This is not same as the merchant added in Fyle but just a
+ string
category:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: Travel
matched_by:
type: string
nullable: true
- description: |
- String denoting the email of the user who matched the card transaction to an expense.
+ description: >
+ String denoting the email of the user who matched the card
+ transaction to an expense.
example: john.ooe@fyle.in
missing_mandatory_fields:
type: object
@@ -3038,15 +3192,18 @@ components:
amount:
type: boolean
nullable: false
- description: |
- This field shows whether the amount field is present in the expense or not
+ description: >
+ This field shows whether the amount field is present in the expense
+ or not
currency:
type: boolean
nullable: false
- description: |
- This field shows whether the currency field is present in the expense or not
- description: |
- This object contains all the fields which are mandatory bu tare missing in the expense.
+ description: >
+ This field shows whether the currency field is present in the
+ expense or not
+ description: >
+ This object contains all the fields which are mandatory bu tare missing
+ in the expense.
activity_details:
type: object
nullable: true
@@ -3104,8 +3261,9 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
- String denoting the name of the merchant to which the Expense was made.
+ description: >
+ String denoting the name of the merchant to which the Expense was
+ made.
example: Amazon
is_billable:
$ref: '#/components/schemas/is_billable'
@@ -3157,18 +3315,21 @@ components:
properties:
is_amount_limit_applied:
type: boolean
- description: |
- A true value here means, that as per policy calculation this expense amount is capped based on the policy calculation.
+ description: >
+ A true value here means, that as per policy calculation this expense
+ amount is capped based on the policy calculation.
example: true
are_approvers_added:
type: boolean
- description: |
- A true value here means, approvers are added to the expense based on the policy calculation.
+ description: >
+ A true value here means, approvers are added to the expense based on
+ the policy calculation.
example: true
is_flagged_ever:
type: boolean
- description: |
- A true value here means, that as per policy calculation this expense is flagged.
+ description: >
+ A true value here means, that as per policy calculation this expense
+ is flagged.
example: true
violations:
type: array
@@ -3290,32 +3451,46 @@ components:
This date cannot be in future.
source:
type: string
- description: |
+ description: >
The name of the client app which is creating the expense.
+
if its a thrid party app, it prefixed with TPA_.
- Ex - If you pass SLACK_APP, it will be saved as TPA_SLACK_APP. If not
+
+ Ex - If you pass SLACK_APP, it will be saved as TPA_SLACK_APP. If
+ not
+
passed, source is saved as TPA.
example: SLACK_APP
merchant:
type: string
maxLength: 255
nullable: true
- description: |
- String denoting the name of the merchant to which the Expense was made.
+ description: >
+ String denoting the name of the merchant to which the Expense was
+ made.
example: Uber
currency:
$ref: '#/components/schemas/currency'
amount:
type: number
nullable: true
- description: |
+ description: >
The amount for which the expense was/will-be fyled.
- The amount will be in the currency that the organization's home currency.
- Note that, this field is calculated from admin_amount, policy_amount, claim_amount.
+ The amount will be in the currency that the organization's home
+ currency.
+
+
+ Note that, this field is calculated from admin_amount,
+ policy_amount, claim_amount.
+
+
+ if admin_amount is present then this value will be same
+ admin_amount.
+
+ if policy_amount is present then this value will be same
+ policy_amount.
- if admin_amount is present then this value will be same admin_amount.
- if policy_amount is present then this value will be same policy_amount.
else this should be same as claim_amount.
example: 1500
claim_amount:
@@ -3431,17 +3606,21 @@ components:
per_diem_num_days:
type: integer
nullable: true
- description: |
- Specific to per diem related expenses, number of days ofr which per diem claim is made.
+ description: >
+ Specific to per diem related expenses, number of days ofr which per
+ diem claim is made.
example: 2
started_at:
$ref: '#/components/schemas/timestamptz_utc'
ended_at:
$ref: '#/components/schemas/timestamptz_utc'
travel_classes:
- description: |
- This field is applicable only for `Flight`, `Train`, `Bus`, `Taxi` category.
- index 0 holds onward journey class, index 1 holds return journey travel class.
+ description: >
+ This field is applicable only for `Flight`, `Train`, `Bus`, `Taxi`
+ category.
+
+ index 0 holds onward journey class, index 1 holds return journey
+ travel class.
type: array
minItems: 0
maxItems: 2
@@ -3456,9 +3635,13 @@ components:
description: |
This field is applicable for only `Hotel` category.
locations:
- description: |
+ description: >
This field will be present for travel related categories.
- For travel between Place A to Place B, this array will contain two items, From location at array index 0 and To location at array index 1.
+
+ For travel between Place A to Place B, this array will contain two
+ items, From location at array index 0 and To location at array index
+ 1.
+
For travel between Place A to Place c and stopping at Place B, this
type: array
minItems: 0
@@ -3472,8 +3655,10 @@ components:
code:
type: string
nullable: true
- description: |
- Id given by external systems like Gmail. To identify whether that entity
+ description: >
+ Id given by external systems like Gmail. To identify whether that
+ entity
+
has been already added to Fyle or not.
example: wgjwgo3ihwljnlsww
state:
@@ -3528,18 +3713,22 @@ components:
is_receipt_mandatory:
type: boolean
nullable: true
- description: |
- Determines whether a receipt is missing for this expense when it is required.
+ description: >
+ Determines whether a receipt is missing for this expense when it is
+ required.
is_exported:
type: boolean
nullable: true
- description: |
- Determines whether this expense has been exported to external accounting system or not.
+ description: >
+ Determines whether this expense has been exported to external
+ accounting system or not.
last_exported_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
nullable: true
- description: signifies when this expense was exported to an external accounting system.
+ description: >-
+ signifies when this expense was exported to an external accounting
+ system.
file_ids:
type: array
items:
@@ -3570,17 +3759,22 @@ components:
type: array
items:
$ref: '#/components/schemas/id_string'
- description: |
- Holds the corporate card transaction ids which are matched to this expense
+ description: >
+ Holds the corporate card transaction ids which are matched to this
+ expense
example:
- btxnwownwrng
matched_corporate_card_transactions:
type: array
items:
$ref: '#/components/schemas/matched_corporate_card_transaction_out_embed'
- description: |
- Holds the corporate card transactions which are matched to this expense.
- NOTE: The data of this field is not realtime. It will get updated later even if `matched_corporate_card_transaction_ids` is already up-to-date.
+ description: >
+ Holds the corporate card transactions which are matched to this
+ expense.
+
+ NOTE: The data of this field is not realtime. It will get updated
+ later even if `matched_corporate_card_transaction_ids` is already
+ up-to-date.
last_settled_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
@@ -3598,12 +3792,16 @@ components:
is_manually_flagged:
type: boolean
nullable: true
- description: This fields marks whether a given expense is manually flagged or not.
+ description: >-
+ This fields marks whether a given expense is manually flagged or
+ not.
example: true
is_policy_flagged:
type: boolean
nullable: true
- description: This fields marks whether a given expense is flagged by policy or not.
+ description: >-
+ This fields marks whether a given expense is flagged by policy or
+ not.
example: true
split_group_id:
type: string
@@ -3617,15 +3815,17 @@ components:
is_physical_bill_submitted:
type: boolean
nullable: true
- description: |
- This fields marks if physical has been collected for the given expense.
+ description: >
+ This fields marks if physical has been collected for the given
+ expense.
example: true
physical_bill_submitted_at:
type: string
format: date-time
example: '2020-06-11T13:14:55.201598+00:00'
- description: |
- Signifies if and when the physical bill for this report was submitted.
+ description: >
+ Signifies if and when the physical bill for this report was
+ submitted.
nullable: true
expense_rule_id:
type: string
@@ -3799,8 +3999,10 @@ components:
query_params:
nullable: false
type: string
- description: |
- This field contains the query param string similar to the query params passed in expenses GET call for displaying expenses in the list view.
+ description: >
+ This field contains the query param string similar to the query
+ params passed in expenses GET call for displaying expenses in the
+ list view.
example: id=in.('tx1263', 'tx1569')
expenses_stats_out:
type: object
@@ -3808,19 +4010,24 @@ components:
count:
type: integer
nullable: false
- description: |
- This field represents the total number of expenses that match the criteria specified in the query_params within the body of the request.
+ description: >
+ This field represents the total number of expenses that match the
+ criteria specified in the query_params within the body of the
+ request.
example: 1
total_amount:
allOf:
- $ref: '#/components/schemas/amount'
- description: |
- This field indicates the sum of amount of expenses that match the criteria specified in the query_params within the body of the request.
+ description: >
+ This field indicates the sum of amount of expenses that match the
+ criteria specified in the query_params within the body of the
+ request.
example: 100
query_params:
type: string
- description: |
- This field contains the query param string similar to the query params passed in GET call for displaying data in the list view.
+ description: >
+ This field contains the query param string similar to the query params
+ passed in GET call for displaying data in the list view.
example: state=eq.PAID
expenses_export_config_column_formula:
type: object
@@ -3844,8 +4051,11 @@ components:
- yyyy-MM-dd'T'HH:mm:ss
- dd-MM-yyyy
- error in date formatting
- description: |
- Export column formula is a expression that is used to transform the data. Refer https://help.fylehq.com/en/articles/4422306-advanced-export-formulas for more details.
+ description: >
+ Export column formula is a expression that is used to transform the
+ data. Refer
+ https://help.fylehq.com/en/articles/4422306-advanced-export-formulas for
+ more details.
expenses_export_config:
type: object
additionalProperties: true
@@ -3868,8 +4078,9 @@ components:
properties:
enabled:
type: boolean
- description: |
- Whether to show the double rows for each line item in the export file.
+ description: >
+ Whether to show the double rows for each line item in the export
+ file.
example: false
debit_entries_only:
type: array
@@ -3887,8 +4098,9 @@ components:
Configure which columns to show for credit entries.
example:
- credit_amount
- description: |
- Configure how to show the double rows for each line item in the export file, if enabled.
+ description: >
+ Configure how to show the double rows for each line item in the
+ export file, if enabled.
columns:
type: array
items:
@@ -4035,9 +4247,12 @@ components:
maxLength: 255
nullable: true
example: E84122
- description: |
- This field refers to any string that the client programs can use to refer to an employee's unique id.
- This could be any field such as an UUID from an Active Directory server or employee id in a HRMS system.
+ description: >
+ This field refers to any string that the client programs can use to
+ refer to an employee's unique id.
+
+ This could be any field such as an UUID from an Active Directory
+ server or employee id in a HRMS system.
org_id:
$ref: '#/components/schemas/org_id'
department_id:
@@ -4104,10 +4319,14 @@ components:
source:
type: string
nullable: true
- description: |
+ description: >
The name of the client app from which this advance was created.
+
if its a thrid party app, it prefixed with TPA_.
- Ex - If you pass SLACK_APP, it will be saved as TPA_SLACK_APP. If not
+
+ Ex - If you pass SLACK_APP, it will be saved as TPA_SLACK_APP. If
+ not
+
passed, source is saved as TPA.
example: WEBAPP
state:
@@ -4149,8 +4368,9 @@ components:
is_exported:
type: boolean
nullable: true
- description: |
- Determines whether this advance request has been exported to external accounting system or not.
+ description: >
+ Determines whether this advance request has been exported to
+ external accounting system or not.
employee_id:
$ref: '#/components/schemas/employee_id'
employee:
@@ -4183,10 +4403,14 @@ components:
source:
type: string
nullable: true
- description: |
+ description: >
The name of the client app from which this advance was created.
+
if its a thrid party app, it prefixed with TPA_.
- Ex - If you pass SLACK_APP, it will be saved as TPA_SLACK_APP. If not
+
+ Ex - If you pass SLACK_APP, it will be saved as TPA_SLACK_APP. If
+ not
+
passed, source is saved as TPA.
example: WEBAPP
project_id:
@@ -4252,10 +4476,14 @@ components:
source:
type: string
nullable: true
- description: |
+ description: >
The name of the client app from which this advance was created.
+
if its a thrid party app, it prefixed with TPA_.
- Ex - If you pass SLACK_APP, it will be saved as TPA_SLACK_APP. If not
+
+ Ex - If you pass SLACK_APP, it will be saved as TPA_SLACK_APP. If
+ not
+
passed, source is saved as TPA.
example: WEBAPP
project_id:
@@ -4282,13 +4510,16 @@ components:
is_exported:
type: boolean
nullable: true
- description: |
- Determines whether this advance has been exported to external accounting system or not.
+ description: >
+ Determines whether this advance has been exported to external
+ accounting system or not.
last_exported_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
nullable: true
- description: signifies when this advance was exported to an external accounting system.
+ description: >-
+ signifies when this advance was exported to an external accounting
+ system.
custom_fields:
$ref: '#/components/schemas/custom_fields'
employee_id:
@@ -4343,10 +4574,14 @@ components:
source:
type: string
nullable: true
- description: |
+ description: >
The name of the client app from which this advance was created.
+
if its a thrid party app, it prefixed with TPA_.
- Ex - If you pass SLACK_APP, it will be saved as TPA_SLACK_APP. If not
+
+ Ex - If you pass SLACK_APP, it will be saved as TPA_SLACK_APP. If
+ not
+
passed, source is saved as TPA.
example: WEBAPP
project_id:
@@ -4454,8 +4689,9 @@ components:
$ref: '#/components/schemas/reminder_type'
message:
type: string
- description: |
- The custom message which the admin wants to send alongside the reminder
+ description: >
+ The custom message which the admin wants to send alongside the
+ reminder
example: Please fyle your expenses before 25th of this month
schedule_config:
$ref: '#/components/schemas/reminder_schedule_config'
@@ -4463,20 +4699,29 @@ components:
type: string
format: date-time
nullable: true
- description: Signifies the time when this reminder was sent. In case of scheduled reminders, signifies when the last reminder was sent. Date-time in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >-
+ Signifies the time when this reminder was sent. In case of scheduled
+ reminders, signifies when the last reminder was sent. Date-time in
+ [ISO8601
+ format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
example: '2021-06-01T13:14:54.804+00:00'
next_reminder_at:
type: string
format: date-time
nullable: true
- description: Only valid for scheduled reminders. Signifies the time when the next reminder will be sent according to the schedule_config. Date-time in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >-
+ Only valid for scheduled reminders. Signifies the time when the next
+ reminder will be sent according to the schedule_config. Date-time in
+ [ISO8601
+ format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
example: '2021-06-01T13:14:54.804+00:00'
add_to_calendar:
type: boolean
nullable: false
default: false
- description: |
- Determines whether this reminder will be added as an event in the google calendar of receiver.
+ description: >
+ Determines whether this reminder will be added as an event in the
+ google calendar of receiver.
example: true
receiver_user_ids:
$ref: '#/components/schemas/reminder_receiver_user_ids'
@@ -4503,8 +4748,9 @@ components:
type: boolean
nullable: false
default: false
- description: |
- Determines whether this reminder will be added as an event in the google calendar of receiver.
+ description: >
+ Determines whether this reminder will be added as an event in the
+ google calendar of receiver.
example: true
receiver_user_ids:
$ref: '#/components/schemas/reminder_receiver_user_ids'
@@ -4534,9 +4780,12 @@ components:
maxLength: 255
nullable: true
example: E84122
- description: |
- This field refers to any string that the client programs can use to refer to an employee's unique id.
- This could be any field such as an UUID from an Active Directory server or employee id in a HRMS system.
+ description: >
+ This field refers to any string that the client programs can use to
+ refer to an employee's unique id.
+
+ This could be any field such as an UUID from an Active Directory
+ server or employee id in a HRMS system.
org_id:
$ref: '#/components/schemas/org_id'
department_id:
@@ -4596,7 +4845,10 @@ components:
type: string
description: |
Description of current status of the payment.
- example: Kindly ask the employee to add a valid bank account in their Settings. You'll then be able to see the bank icon next to the payment number, after which you can retry the payment.
+ example: >-
+ Kindly ask the employee to add a valid bank account in their
+ Settings. You'll then be able to see the bank icon next to the
+ payment number, after which you can retry the payment.
nullable: true
initiated_at:
nullable: true
@@ -4733,8 +4985,9 @@ components:
type: string
format: date-time
example: '2020-06-11T13:14:55.201598+00:00'
- description: |
- Signifies if and when the physical bill for this report was submitted.
+ description: >
+ Signifies if and when the physical bill for this report was
+ submitted.
nullable: true
is_manually_flagged:
type: boolean
@@ -4747,8 +5000,9 @@ components:
is_exported:
type: boolean
nullable: true
- description: |
- Determines whether this expense has been exported to external accounting system or not.
+ description: >
+ Determines whether this expense has been exported to external
+ accounting system or not.
last_paid_at:
type: string
format: date-time
@@ -4873,8 +5127,10 @@ components:
$ref: '#/components/schemas/id_string'
purpose:
type: string
- description: |
- Indicates purpose of the reports. It can only be updated for an existing report when the report is in `APPROVER_PENDING` or `APPROVED` state.
+ description: >
+ Indicates purpose of the reports. It can only be updated for an
+ existing report when the report is in `APPROVER_PENDING` or
+ `APPROVED` state.
example: '#1: Jun 2020'
report_action_with_expenses_ids_to_eject:
type: object
@@ -4954,8 +5210,9 @@ components:
full_name:
type: string
maxLength: 255
- description: |
- Represents the full name of the Employee. Must be at least 3 characters.
+ description: >
+ Represents the full name of the Employee. Must be at least 3
+ characters.
example: John Doe
admin_report_comments_out:
type: object
@@ -5046,8 +5303,9 @@ components:
paid_notify_at:
type: string
format: date-time
- description: |
- This field indicates when should user receive notification regarding reimbursement
+ description: >
+ This field indicates when should user receive notification regarding
+ reimbursement
example: '2022-12-02T17:58:21.406Z'
code:
$ref: '#/components/schemas/code'
@@ -5097,19 +5355,22 @@ components:
example: 100
missing_bank_details_count:
type: integer
- description: |
- This field indicates the count of reports with missing users bank account details.
+ description: >
+ This field indicates the count of reports with missing users bank
+ account details.
example: 2
missing_bank_details_amount:
allOf:
- $ref: '#/components/schemas/amount'
- description: |
- This field indicates the total amount of reports with missing users bank account details.
+ description: >
+ This field indicates the total amount of reports with missing users
+ bank account details.
example: 101
missing_bank_details_employee_count:
type: integer
- description: |
- This field indicates the count of employees with missing users bank account details.
+ description: >
+ This field indicates the count of employees with missing users bank
+ account details.
example: 2
missing_bank_details_employee_ids:
type: array
@@ -5118,18 +5379,21 @@ components:
- $ref: '#/components/schemas/id_string'
example:
- ouN7x27CwrwC
- description: |
- This field contains list of employee_ids whose bank accounts are missing.
+ description: >
+ This field contains list of employee_ids whose bank accounts are
+ missing.
payment_initiated_amount:
allOf:
- $ref: '#/components/schemas/amount'
- description: |
- This field indicates the total amount of reports that are in payment_processing and ach_initiated state.
+ description: >
+ This field indicates the total amount of reports that are in
+ payment_processing and ach_initiated state.
example: 101
payment_initiated_count:
type: integer
- description: |
- This field indicates the count of reports that are in payment_processing and ach_initiated state.
+ description: >
+ This field indicates the count of reports that are in
+ payment_processing and ach_initiated state.
example: 2
reimbursable_amount:
allOf:
@@ -5153,15 +5417,25 @@ components:
- $ref: '#/components/schemas/id_string'
example:
- re123453
- description: |
- This field contains list of report_ids that can directly be closed(with reimbursable amount as 0).
+ description: >
+ This field contains list of report_ids that can directly be
+ closed(with reimbursable amount as 0).
+ report_accounting_export_summary_in:
+ type: object
+ required:
+ - id
+ properties:
+ id:
+ $ref: '#/components/schemas/id_string'
reports_stats_in:
properties:
query_params:
nullable: false
type: string
- description: |
- This field contains the query param string similar to the query params passed in reports GET call for displaying reports in the list view.
+ description: >
+ This field contains the query param string similar to the query
+ params passed in reports GET call for displaying reports in the list
+ view.
example: state=eq.PAYMENT_PROCESSING&report_id=in.('rp123', 'rep1234')
reports_stats_out:
type: object
@@ -5181,8 +5455,9 @@ components:
processing_amount:
allOf:
- $ref: '#/components/schemas/amount'
- description: |
- This field indicates the sum of reimbursable amount of reports in Processing state.
+ description: >
+ This field indicates the sum of reimbursable amount of reports in
+ Processing state.
example: 101
processing_count:
type: integer
@@ -5194,14 +5469,16 @@ components:
anyOf:
- $ref: '#/components/schemas/amount'
- $ref: '#/components/schemas/null_field'
- description: |
- This field indicates the sum of reimbursable amount of reports in Processing state for which ACH has failed
+ description: >
+ This field indicates the sum of reimbursable amount of reports in
+ Processing state for which ACH has failed
example: 101
failed_count:
type: integer
nullable: true
- description: |
- This field indicates the count of reports in processing state for which ACH has failed.
+ description: >
+ This field indicates the count of reports in processing state for
+ which ACH has failed.
example: 1
report_create_and_submit_expenses:
type: object
@@ -5251,14 +5528,17 @@ components:
data_feed_source:
type: string
nullable: true
- description: |
- signifies the source of how card is added and how further card transactions could be synced
+ description: >
+ signifies the source of how card is added and how further card
+ transactions could be synced
example: BANK FEED - CDF
code:
type: string
nullable: true
- description: |
- Id given by external systems like Gmail. To identify whether that entity
+ description: >
+ Id given by external systems like Gmail. To identify whether that
+ entity
+
has been already added to Fyle or not.
example: wgjwgo3ihwljnlsww
last_synced_at:
@@ -5372,14 +5652,17 @@ components:
data_feed_source:
type: string
nullable: true
- description: |
- signifies the source of how card is added and how further card transactions could be synced
+ description: >
+ signifies the source of how card is added and how further card
+ transactions could be synced
example: BANK FEED - CDF
code:
type: string
nullable: true
- description: |
- Id given by external systems like Gmail. To identify whether that entity
+ description: >
+ Id given by external systems like Gmail. To identify whether that
+ entity
+
has been already added to Fyle or not.
example: wgjwgo3ihwljnlsww
last_synced_at:
@@ -5457,14 +5740,17 @@ components:
data_feed_source:
type: string
nullable: true
- description: |
- signifies the source of how card is added and how further card transactions could be synced
+ description: >
+ signifies the source of how card is added and how further card
+ transactions could be synced
example: BANK FEED - CDF
code:
type: string
nullable: true
- description: |
- Id given by external systems like Gmail. To identify whether that entity
+ description: >
+ Id given by external systems like Gmail. To identify whether that
+ entity
+
has been already added to Fyle or not.
example: wgjwgo3ihwljnlsww
last_synced_at:
@@ -5548,7 +5834,9 @@ components:
- last_verified_at
string_detail:
type: string
- description: Additional string details of the card transaction. Can hold details upto 256 characters in length.
+ description: >-
+ Additional string details of the card transaction. Can hold details upto
+ 256 characters in length.
nullable: true
example: sample string
corporate_card_out_embed:
@@ -5625,8 +5913,9 @@ components:
type: string
nullable: true
maxLength: 255
- description: |
- String denoting the name of the merchant to which the Expense was made.
+ description: >
+ String denoting the name of the merchant to which the Expense was
+ made.
example: Uber
foreign_currency:
$ref: '#/components/schemas/foreign_currency'
@@ -5666,14 +5955,18 @@ components:
example: Travel
double_precision_detail:
type: number
- description: Additional floating point numeric details of the card transaction. Same as double precision.
+ description: >-
+ Additional floating point numeric details of the card transaction. Same
+ as double precision.
nullable: true
example: 468.2923
timestamp_detail:
type: string
format: date-time
- description: |
- Additional details of the card transaction. RFC 3339, section 5.6 compliant timestamp.
+ description: >
+ Additional details of the card transaction. RFC 3339, section
+ 5.6 compliant timestamp.
example: '2020-07-03T18:19:31.193Z'
nullable: true
integer_detail:
@@ -5689,8 +5982,9 @@ components:
corporate_card_transaction_metadata:
type: object
nullable: true
- description: |
- Additional data that can optionally be stored. Some example details are added for reference.
+ description: >
+ Additional data that can optionally be stored. Some example details are
+ added for reference.
properties:
merchant_category_code:
$ref: '#/components/schemas/string_detail'
@@ -5782,8 +6076,9 @@ components:
example: null
mcc:
type: string
- description: |
- This refers to the merchant category code for which this card transaction is made.
+ description: >
+ This refers to the merchant category code for which this card
+ transaction is made.
$ref: '#/components/schemas/string_detail'
example: '5102'
user:
@@ -5819,8 +6114,9 @@ components:
statement_id:
type: string
nullable: true
- description: |
- If the transaction is created by statement uploaded then this key refers to the source statement.
+ description: >
+ If the transaction is created by statement uploaded then this key
+ refers to the source statement.
example: stmtdasfdsaf3
can_delete:
type: boolean
@@ -5838,17 +6134,22 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
- String denoting the name of the vendor to which the card transaction was made.
- Note: This is not same as the merchant added in Fyle but just a string
+ description: >
+ String denoting the name of the vendor to which the card transaction
+ was made.
+
+ Note: This is not same as the merchant added in Fyle but just a
+ string
example: Uber
category:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: Travel
corporate_card_id:
allOf:
@@ -5860,9 +6161,11 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: set7oisw24gju
assignor_user_id:
type: string
@@ -5885,8 +6188,9 @@ components:
is_marked_personal:
type: boolean
example: false
- description: |
- Determines whether this card transaction is marked as personal transaction made on the corporate card.
+ description: >
+ Determines whether this card transaction is marked as personal
+ transaction made on the corporate card.
last_marked_personal_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
@@ -5913,8 +6217,9 @@ components:
type: array
items:
$ref: '#/components/schemas/id_string'
- description: |
- Holds the expense ids which are automatically suggested to be matched by the system
+ description: >
+ Holds the expense ids which are automatically suggested to be
+ matched by the system
example:
- txwownwrng
last_auto_matched_at:
@@ -5944,8 +6249,9 @@ components:
is_exported:
type: boolean
nullable: true
- description: |
- Determines whether this CCC transaction has been exported to external accounting system or not.
+ description: >
+ Determines whether this CCC transaction has been exported to
+ external accounting system or not.
example: false
metadata:
$ref: '#/components/schemas/corporate_card_transaction_metadata'
@@ -6027,22 +6333,28 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
- String denoting the name of the vendor to which the card transaction was made.
- Note: This is not same as the merchant added in Fyle but just a string
+ description: >
+ String denoting the name of the vendor to which the card transaction
+ was made.
+
+ Note: This is not same as the merchant added in Fyle but just a
+ string
example: Uber
category:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: Travel
mcc:
type: string
- description: |
- This refers to the merchant category code for which this card transaction is made.
+ description: >
+ This refers to the merchant category code for which this card
+ transaction is made.
$ref: '#/components/schemas/string_detail'
example: '5102'
corporate_card_id:
@@ -6105,8 +6417,9 @@ components:
statement_id:
type: string
nullable: true
- description: |
- If the transaction is created by statement uploaded then this key refers to the source statement.
+ description: >
+ If the transaction is created by statement uploaded then this key
+ refers to the source statement.
example: stmtdasfdsaf3
can_delete:
type: boolean
@@ -6124,23 +6437,29 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
- String denoting the name of the vendor to which the card transaction was made.
- Note: This is not same as the merchant added in Fyle but just a string
+ description: >
+ String denoting the name of the vendor to which the card transaction
+ was made.
+
+ Note: This is not same as the merchant added in Fyle but just a
+ string
example: Uber
mcc:
type: string
- description: |
- This refers to the merchant category code for which this card transaction is made.
+ description: >
+ This refers to the merchant category code for which this card
+ transaction is made.
$ref: '#/components/schemas/string_detail'
example: '5102'
category:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: Travel
corporate_card_id:
allOf:
@@ -6171,8 +6490,9 @@ components:
is_marked_personal:
type: boolean
example: false
- description: |
- Determines whether this card transaction is marked as personal transaction made on the corporate card.
+ description: >
+ Determines whether this card transaction is marked as personal
+ transaction made on the corporate card.
last_marked_personal_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
@@ -6201,8 +6521,9 @@ components:
type: array
items:
$ref: '#/components/schemas/id_string'
- description: |
- Holds the expense ids which are automatically suggested to be matched by the system
+ description: >
+ Holds the expense ids which are automatically suggested to be
+ matched by the system
example: []
last_auto_matched_at:
allOf:
@@ -6233,15 +6554,18 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: null
is_exported:
type: boolean
nullable: true
- description: |
- Determines whether this CCC transaction has been exported to external accounting system or not.
+ description: >
+ Determines whether this CCC transaction has been exported to
+ external accounting system or not.
example: false
metadata:
$ref: '#/components/schemas/corporate_card_transaction_metadata'
@@ -6288,9 +6612,12 @@ components:
query_params:
nullable: false
type: string
- description: |
- This field contains the query param string similar to the query params passed in corporate card transactions GET call for displaying transactions in the list view.
- example: amount=gt.0&amount=lt.1000&created_at=gt.2021-01-01T00:00:00.000Z&created_at=lt.2021-12-31T23:59:59.999Z
+ description: >
+ This field contains the query param string similar to the query
+ params passed in corporate card transactions GET call for displaying
+ transactions in the list view.
+ example: >-
+ amount=gt.0&amount=lt.1000&created_at=gt.2021-01-01T00:00:00.000Z&created_at=lt.2021-12-31T23:59:59.999Z
corporate_card_transactions_stats_out:
type: object
properties:
@@ -6303,14 +6630,16 @@ components:
debit_amount:
allOf:
- $ref: '#/components/schemas/amount'
- description: |
- This field indicates the sum of amount of the debit type corporate card transactions.
+ description: >
+ This field indicates the sum of amount of the debit type corporate
+ card transactions.
example: 1239
credit_amount:
allOf:
- $ref: '#/components/schemas/amount'
- description: |
- This field indicates the sum of amount of the credit type corporate card transactions.
+ description: >
+ This field indicates the sum of amount of the credit type corporate
+ card transactions.
example: 101
corporate_card_transactions_delete_summary_in:
type: object
@@ -6327,14 +6656,16 @@ components:
delete_count:
type: integer
nullable: false
- description: |
- This field indicates the count of corporate card transactions that can be deleted.
+ description: >
+ This field indicates the count of corporate card transactions that
+ can be deleted.
example: 1
delete_amount:
allOf:
- $ref: '#/components/schemas/amount'
- description: |
- This field indicates the sum of amount of the corporate card transactions that can be deleted.
+ description: >
+ This field indicates the sum of amount of the corporate card
+ transactions that can be deleted.
example: 101
corporate_card_transactions_delete_in:
type: object
@@ -6399,8 +6730,9 @@ components:
example: btxnwownwrng
user_id:
type: string
- description: |
- The unique id of an user to whom the card transaction should be assigned.
+ description: >
+ The unique id of an user to whom the card transaction should be
+ assigned.
example: usge49ielgel
required:
- id
@@ -6448,8 +6780,9 @@ components:
statement_id:
type: string
nullable: true
- description: |
- If the transaction is created by statement uploaded then this key refers to the source statement.
+ description: >
+ If the transaction is created by statement uploaded then this key
+ refers to the source statement.
example: stmtdasfdsaf3
can_delete:
type: boolean
@@ -6467,23 +6800,29 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
- String denoting the name of the vendor to which the card transaction was made.
- Note: This is not same as the merchant added in Fyle but just a string
+ description: >
+ String denoting the name of the vendor to which the card transaction
+ was made.
+
+ Note: This is not same as the merchant added in Fyle but just a
+ string
example: Uber
mcc:
type: string
- description: |
- This refers to the merchant category code for which this card transaction is made.
+ description: >
+ This refers to the merchant category code for which this card
+ transaction is made.
$ref: '#/components/schemas/string_detail'
example: '5102'
category:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: Travel
corporate_card_id:
allOf:
@@ -6512,8 +6851,9 @@ components:
is_marked_personal:
type: boolean
example: false
- description: |
- Determines whether this card transaction is marked as personal transaction made on the corporate card.
+ description: >
+ Determines whether this card transaction is marked as personal
+ transaction made on the corporate card.
last_marked_personal_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
@@ -6542,8 +6882,9 @@ components:
type: array
items:
$ref: '#/components/schemas/id_string'
- description: |
- Holds the expense ids which are automatically suggested to be matched by the system
+ description: >
+ Holds the expense ids which are automatically suggested to be
+ matched by the system
example: []
last_auto_matched_at:
allOf:
@@ -6574,15 +6915,18 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: null
is_exported:
type: boolean
nullable: true
- description: |
- Determines whether this CCC transaction has been exported to external accounting system or not.
+ description: >
+ Determines whether this CCC transaction has been exported to
+ external accounting system or not.
example: false
metadata:
$ref: '#/components/schemas/corporate_card_transaction_metadata'
@@ -6681,8 +7025,9 @@ components:
statement_id:
type: string
nullable: true
- description: |
- If the transaction is created by statement uploaded then this key refers to the source statement.
+ description: >
+ If the transaction is created by statement uploaded then this key
+ refers to the source statement.
example: stmtdasfdsaf3
can_delete:
type: boolean
@@ -6700,23 +7045,29 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
- String denoting the name of the vendor to which the card transaction was made.
- Note: This is not same as the merchant added in Fyle but just a string
+ description: >
+ String denoting the name of the vendor to which the card transaction
+ was made.
+
+ Note: This is not same as the merchant added in Fyle but just a
+ string
example: Uber
mcc:
type: string
- description: |
- This refers to the merchant category code for which this card transaction is made.
+ description: >
+ This refers to the merchant category code for which this card
+ transaction is made.
$ref: '#/components/schemas/string_detail'
example: '5102'
category:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: Travel
corporate_card_id:
allOf:
@@ -6746,8 +7097,9 @@ components:
is_marked_personal:
type: boolean
example: false
- description: |
- Determines whether this card transaction is marked as personal transaction made on the corporate card.
+ description: >
+ Determines whether this card transaction is marked as personal
+ transaction made on the corporate card.
last_marked_personal_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
@@ -6763,8 +7115,9 @@ components:
is_exported:
type: boolean
nullable: true
- description: |
- Determines whether this CCC transaction has been exported to external accounting system or not.
+ description: >
+ Determines whether this CCC transaction has been exported to
+ external accounting system or not.
example: false
last_dismissed_at:
allOf:
@@ -6782,8 +7135,9 @@ components:
type: array
items:
$ref: '#/components/schemas/id_string'
- description: |
- Holds the expense ids which are automatically suggested to be matched by the system
+ description: >
+ Holds the expense ids which are automatically suggested to be
+ matched by the system
example: []
last_auto_matched_at:
allOf:
@@ -6814,9 +7168,11 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: null
metadata:
$ref: '#/components/schemas/corporate_card_transaction_metadata'
@@ -6900,8 +7256,9 @@ components:
statement_id:
type: string
nullable: true
- description: |
- If the transaction is created by statement uploaded then this key refers to the source statement.
+ description: >
+ If the transaction is created by statement uploaded then this key
+ refers to the source statement.
example: stmtdasfdsaf3
can_delete:
type: boolean
@@ -6919,23 +7276,29 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
- String denoting the name of the vendor to which the card transaction was made.
- Note: This is not same as the merchant added in Fyle but just a string
+ description: >
+ String denoting the name of the vendor to which the card transaction
+ was made.
+
+ Note: This is not same as the merchant added in Fyle but just a
+ string
example: Uber
mcc:
type: string
- description: |
- This refers to the merchant category code for which this card transaction is made.
+ description: >
+ This refers to the merchant category code for which this card
+ transaction is made.
$ref: '#/components/schemas/string_detail'
example: '5102'
category:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: Travel
corporate_card_id:
allOf:
@@ -6964,8 +7327,9 @@ components:
is_marked_personal:
type: boolean
example: true
- description: |
- Determines whether this card transaction is marked as personal transaction made on the corporate card.
+ description: >
+ Determines whether this card transaction is marked as personal
+ transaction made on the corporate card.
last_marked_personal_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
@@ -6993,8 +7357,9 @@ components:
type: array
items:
$ref: '#/components/schemas/id_string'
- description: |
- Holds the expense ids which are automatically suggested to be matched by the system
+ description: >
+ Holds the expense ids which are automatically suggested to be
+ matched by the system
example: []
last_auto_matched_at:
allOf:
@@ -7025,15 +7390,18 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: null
is_exported:
type: boolean
nullable: true
- description: |
- Determines whether this CCC transaction has been exported to external accounting system or not.
+ description: >
+ Determines whether this CCC transaction has been exported to
+ external accounting system or not.
metadata:
$ref: '#/components/schemas/corporate_card_transaction_metadata'
required:
@@ -7116,8 +7484,9 @@ components:
statement_id:
type: string
nullable: true
- description: |
- If the transaction is created by statement uploaded then this key refers to the source statement.
+ description: >
+ If the transaction is created by statement uploaded then this key
+ refers to the source statement.
example: stmtdasfdsaf3
can_delete:
type: boolean
@@ -7135,23 +7504,29 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
- String denoting the name of the vendor to which the card transaction was made.
- Note: This is not same as the merchant added in Fyle but just a string
+ description: >
+ String denoting the name of the vendor to which the card transaction
+ was made.
+
+ Note: This is not same as the merchant added in Fyle but just a
+ string
example: Uber
mcc:
type: string
- description: |
- This refers to the merchant category code for which this card transaction is made.
+ description: >
+ This refers to the merchant category code for which this card
+ transaction is made.
$ref: '#/components/schemas/string_detail'
example: '5102'
category:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: Travel
corporate_card_id:
allOf:
@@ -7180,8 +7555,9 @@ components:
is_marked_personal:
type: boolean
example: false
- description: |
- Determines whether this card transaction is marked as personal transaction made on the corporate card.
+ description: >
+ Determines whether this card transaction is marked as personal
+ transaction made on the corporate card.
last_marked_personal_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
@@ -7209,8 +7585,9 @@ components:
type: array
items:
$ref: '#/components/schemas/id_string'
- description: |
- Holds the expense ids which are automatically suggested to be matched by the system
+ description: >
+ Holds the expense ids which are automatically suggested to be
+ matched by the system
example: []
last_auto_matched_at:
allOf:
@@ -7241,15 +7618,18 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: null
is_exported:
type: boolean
nullable: true
- description: |
- Determines whether this CCC transaction has been exported to external accounting system or not.
+ description: >
+ Determines whether this CCC transaction has been exported to
+ external accounting system or not.
example: false
metadata:
$ref: '#/components/schemas/corporate_card_transaction_metadata'
@@ -7333,8 +7713,9 @@ components:
statement_id:
type: string
nullable: true
- description: |
- If the transaction is created by statement uploaded then this key refers to the source statement.
+ description: >
+ If the transaction is created by statement uploaded then this key
+ refers to the source statement.
example: stmtdasfdsaf3
can_delete:
type: boolean
@@ -7352,23 +7733,29 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
- String denoting the name of the vendor to which the card transaction was made.
- Note: This is not same as the merchant added in Fyle but just a string
+ description: >
+ String denoting the name of the vendor to which the card transaction
+ was made.
+
+ Note: This is not same as the merchant added in Fyle but just a
+ string
example: Uber
mcc:
type: string
- description: |
- This refers to the merchant category code for which this card transaction is made.
+ description: >
+ This refers to the merchant category code for which this card
+ transaction is made.
$ref: '#/components/schemas/string_detail'
example: '5102'
category:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: Travel
corporate_card_id:
allOf:
@@ -7397,8 +7784,9 @@ components:
is_marked_personal:
type: boolean
example: false
- description: |
- Determines whether this card transaction is marked as personal transaction made on the corporate card.
+ description: >
+ Determines whether this card transaction is marked as personal
+ transaction made on the corporate card.
last_marked_personal_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
@@ -7426,8 +7814,9 @@ components:
type: array
items:
$ref: '#/components/schemas/id_string'
- description: |
- Holds the expense ids which are automatically suggested to be matched by the system
+ description: >
+ Holds the expense ids which are automatically suggested to be
+ matched by the system
example: []
last_auto_matched_at:
allOf:
@@ -7458,15 +7847,18 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: null
is_exported:
type: boolean
nullable: true
- description: |
- Determines whether this CCC transaction has been exported to external accounting system or not.
+ description: >
+ Determines whether this CCC transaction has been exported to
+ external accounting system or not.
example: false
metadata:
$ref: '#/components/schemas/corporate_card_transaction_metadata'
@@ -7551,8 +7943,9 @@ components:
statement_id:
type: string
nullable: true
- description: |
- If the transaction is created by statement uploaded then this key refers to the source statement.
+ description: >
+ If the transaction is created by statement uploaded then this key
+ refers to the source statement.
example: stmtdasfdsaf3
can_delete:
type: boolean
@@ -7570,23 +7963,29 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
- String denoting the name of the vendor to which the card transaction was made.
- Note: This is not same as the merchant added in Fyle but just a string
+ description: >
+ String denoting the name of the vendor to which the card transaction
+ was made.
+
+ Note: This is not same as the merchant added in Fyle but just a
+ string
example: Uber
mcc:
type: string
- description: |
- This refers to the merchant category code for which this card transaction is made.
+ description: >
+ This refers to the merchant category code for which this card
+ transaction is made.
$ref: '#/components/schemas/string_detail'
example: '5102'
category:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: Travel
corporate_card_id:
allOf:
@@ -7615,8 +8014,9 @@ components:
is_marked_personal:
type: boolean
example: false
- description: |
- Determines whether this card transaction is marked as personal transaction made on the corporate card.
+ description: >
+ Determines whether this card transaction is marked as personal
+ transaction made on the corporate card.
last_marked_personal_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
@@ -7644,8 +8044,9 @@ components:
type: array
items:
$ref: '#/components/schemas/id_string'
- description: |
- Holds the expense ids which are automatically suggested to be matched by the system
+ description: >
+ Holds the expense ids which are automatically suggested to be
+ matched by the system
example: []
last_auto_matched_at:
allOf:
@@ -7676,15 +8077,18 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: null
is_exported:
type: boolean
nullable: true
- description: |
- Determines whether this CCC transaction has been exported to external accounting system or not.
+ description: >
+ Determines whether this CCC transaction has been exported to
+ external accounting system or not.
example: false
metadata:
$ref: '#/components/schemas/corporate_card_transaction_metadata'
@@ -7785,8 +8189,9 @@ components:
statement_id:
type: string
nullable: true
- description: |
- If the transaction is created by statement uploaded then this key refers to the source statement.
+ description: >
+ If the transaction is created by statement uploaded then this key
+ refers to the source statement.
example: stmtdasfdsaf3
can_delete:
type: boolean
@@ -7804,23 +8209,29 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
- String denoting the name of the vendor to which the card transaction was made.
- Note: This is not same as the merchant added in Fyle but just a string
+ description: >
+ String denoting the name of the vendor to which the card transaction
+ was made.
+
+ Note: This is not same as the merchant added in Fyle but just a
+ string
example: Uber
mcc:
type: string
- description: |
- This refers to the merchant category code for which this card transaction is made.
+ description: >
+ This refers to the merchant category code for which this card
+ transaction is made.
$ref: '#/components/schemas/string_detail'
example: '5102'
category:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: Travel
corporate_card_id:
allOf:
@@ -7849,8 +8260,9 @@ components:
is_marked_personal:
type: boolean
example: false
- description: |
- Determines whether this card transaction is marked as personal transaction made on the corporate card.
+ description: >
+ Determines whether this card transaction is marked as personal
+ transaction made on the corporate card.
last_marked_personal_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
@@ -7879,8 +8291,9 @@ components:
type: array
items:
$ref: '#/components/schemas/id_string'
- description: |
- Holds the expense ids which are automatically suggested to be matched by the system
+ description: >
+ Holds the expense ids which are automatically suggested to be
+ matched by the system
example: []
last_auto_matched_at:
allOf:
@@ -7911,15 +8324,18 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: null
is_exported:
type: boolean
nullable: true
- description: |
- Determines whether this CCC transaction has been exported to external accounting system or not.
+ description: >
+ Determines whether this CCC transaction has been exported to
+ external accounting system or not.
example: false
metadata:
$ref: '#/components/schemas/corporate_card_transaction_metadata'
@@ -8020,8 +8436,9 @@ components:
statement_id:
type: string
nullable: true
- description: |
- If the transaction is created by statement uploaded then this key refers to the source statement.
+ description: >
+ If the transaction is created by statement uploaded then this key
+ refers to the source statement.
example: stmtdasfdsaf3
can_delete:
type: boolean
@@ -8039,23 +8456,29 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
- String denoting the name of the vendor to which the card transaction was made.
- Note: This is not same as the merchant added in Fyle but just a string
+ description: >
+ String denoting the name of the vendor to which the card transaction
+ was made.
+
+ Note: This is not same as the merchant added in Fyle but just a
+ string
example: Uber
mcc:
type: string
- description: |
- This refers to the merchant category code for which this card transaction is made.
+ description: >
+ This refers to the merchant category code for which this card
+ transaction is made.
$ref: '#/components/schemas/string_detail'
example: '5102'
category:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: Travel
corporate_card_id:
allOf:
@@ -8084,8 +8507,9 @@ components:
is_marked_personal:
type: boolean
example: false
- description: |
- Determines whether this card transaction is marked as personal transaction made on the corporate card.
+ description: >
+ Determines whether this card transaction is marked as personal
+ transaction made on the corporate card.
last_marked_personal_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
@@ -8101,8 +8525,9 @@ components:
is_exported:
type: boolean
nullable: true
- description: |
- Determines whether this CCC transaction has been exported to external accounting system or not.
+ description: >
+ Determines whether this CCC transaction has been exported to
+ external accounting system or not.
last_dismissed_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
@@ -8119,8 +8544,9 @@ components:
type: array
items:
$ref: '#/components/schemas/id_string'
- description: |
- Holds the expense ids which are automatically suggested to be matched by the system
+ description: >
+ Holds the expense ids which are automatically suggested to be
+ matched by the system
example: []
last_auto_matched_at:
allOf:
@@ -8150,9 +8576,11 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
+ description: >
String denoting the category of the card transaction
- Note: This is not same as the category added in Fyle but just a string
+
+ Note: This is not same as the category added in Fyle but just a
+ string
example: null
metadata:
$ref: '#/components/schemas/corporate_card_transaction_metadata'
@@ -8283,8 +8711,10 @@ components:
$ref: '#/components/schemas/updated_at'
reimbursement_number:
type: string
- description: |
- A unique, organization wide identifier for a particular reimbursement.
+ description: >
+ A unique, organization wide identifier for a particular
+ reimbursement.
+
This id is always prefixed with `P/`.
example: P/2020/11/29
creator_user_id:
@@ -8525,13 +8955,23 @@ components:
time_interval_marker:
type: string
nullable: false
- description: |
- Representation of a point in time for which the sum of amount of expenses is calculated.
+ description: >
+ Representation of a point in time for which the sum of amount of
+ expenses is calculated.
+
Value depends of value of time_interval_granularity as follows :
- - for time_interval_granularity of `day`, value will be in date format YYYY-MM-DD. Example : 2021-01-01
- - for time_interval_granularity of `month`, value will be in date format YYYY-MM. Example : 2021-01
- - for time_interval_granularity of `quarter`, value will be in date format YYYY-QQ. Example : 2021-Q1
- - for time_interval_granularity of `year`, value will be in date format YYYY. Example : 2021
+
+ - for time_interval_granularity of `day`, value will be in date format
+ YYYY-MM-DD. Example : 2021-01-01
+
+ - for time_interval_granularity of `month`, value will be in date format
+ YYYY-MM. Example : 2021-01
+
+ - for time_interval_granularity of `quarter`, value will be in date
+ format YYYY-QQ. Example : 2021-Q1
+
+ - for time_interval_granularity of `year`, value will be in date format
+ YYYY. Example : 2021
example: 2022-02
spend_overview_summary_data_out:
type: object
@@ -8543,13 +8983,15 @@ components:
$ref: '#/components/schemas/time_interval_marker'
spend_overview_percentage:
type: number
- description: |
- Percentage of spend which falls under this object/resource after filtering criteria is applied.
+ description: >
+ Percentage of spend which falls under this object/resource after
+ filtering criteria is applied.
example: 10.34
spend_overview_change_percentage:
type: number
- description: |
- Change in percentage of spend compared to spend in same time period one time interval ago, after filtering criteria is applied.
+ description: >
+ Change in percentage of spend compared to spend in same time period one
+ time interval ago, after filtering criteria is applied.
example: -4.95
spend_overview_by_merchant_data_out:
type: object
@@ -8664,8 +9106,9 @@ components:
type: string
nullable: true
maxLength: 15
- description: |
- This id provided by Fyle to identify a user. This can be null if the corporate card is not assigned to any user.
+ description: >
+ This id provided by Fyle to identify a user. This can be null if the
+ corporate card is not assigned to any user.
example: sdfd2391
amount:
$ref: '#/components/schemas/amount'
@@ -9070,7 +9513,9 @@ components:
domain:
type: string
maxLength: 255
- description: This field specifies the domain with which the organisation is registered.
+ description: >-
+ This field specifies the domain with which the organisation is
+ registered.
example: example.com
currency:
$ref: '#/components/schemas/currency'
@@ -9081,8 +9526,9 @@ components:
is_verified:
type: boolean
nullable: false
- description: |
- Determines whether this organization has been verified by a verifier.
+ description: >
+ Determines whether this organization has been verified by a
+ verifier.
expense_policy_limit_type:
nullable: true
type: string
@@ -9176,24 +9622,28 @@ components:
anyOf:
- $ref: '#/components/schemas/currency'
- $ref: '#/components/schemas/null_field'
- description: |
+ description: >
The three-letter currency code following ISO standard ISO 4217.
+
+ href='https://www.iso.org/iso-4217-currency-codes.html'>ISO
+ 4217.
expense_amount_max:
nullable: true
anyOf:
- $ref: '#/components/schemas/amount'
- $ref: '#/components/schemas/null_field'
- description: |
- If an expense's amount exceeds this value, this policy rule will be violated for that expense.
+ description: >
+ If an expense's amount exceeds this value, this policy rule will be
+ violated for that expense.
example: 10000
expense_amount_min:
nullable: true
anyOf:
- $ref: '#/components/schemas/amount'
- $ref: '#/components/schemas/null_field'
- description: |
- If an expense's amount falls behind this value, this policy rule will be violated for that expense.
+ description: >
+ If an expense's amount falls behind this value, this policy rule
+ will be violated for that expense.
example: 500
expense_fiscal_start_month:
nullable: true
@@ -9207,15 +9657,17 @@ components:
nullable: true
allOf:
- $ref: '#/components/schemas/distance'
- description: |
- If an expense's distance exceeds this value, this policy rule will be violated for that expense.
+ description: >
+ If an expense's distance exceeds this value, this policy rule will
+ be violated for that expense.
example: 10000
expense_distance_min:
nullable: true
allOf:
- $ref: '#/components/schemas/distance'
- description: |
- If an expense's distance falls behind this value, this policy rule will be violated for that expense.
+ description: >
+ If an expense's distance falls behind this value, this policy rule
+ will be violated for that expense.
example: 500
expense_category_ids:
nullable: true
@@ -9231,9 +9683,14 @@ components:
nullable: true
allOf:
- $ref: '#/components/schemas/contains_operator'
- description: |
- - If it is set to IN, this policy rule will be applicable to all the expenses that belong to any of the categories listed in the field `expense_category_ids`.
- - If it is set to NOT_IN, this policy rule will be applicable to all the expenses that do not belong to any of the categories listed in the field `expense_category_ids`.
+ description: >
+ - If it is set to IN, this policy rule will be applicable to all the
+ expenses that belong to any of the categories listed in the field
+ `expense_category_ids`.
+
+ - If it is set to NOT_IN, this policy rule will be applicable to all
+ the expenses that do not belong to any of the categories listed in
+ the field `expense_category_ids`.
expense_project_ids:
nullable: true
type: array
@@ -9248,9 +9705,14 @@ components:
nullable: true
allOf:
- $ref: '#/components/schemas/contains_operator'
- description: |
- - If it is set to IN, this policy rule will be applicable to all the expenses that belong to any of the projects listed in the field `expense_project_ids`.
- - If it is set to NOT_IN, this policy rule will be applicable to all the expenses that do not belong to any of the projects listed in the field `expense_project_ids`.
+ description: >
+ - If it is set to IN, this policy rule will be applicable to all the
+ expenses that belong to any of the projects listed in the field
+ `expense_project_ids`.
+
+ - If it is set to NOT_IN, this policy rule will be applicable to all
+ the expenses that do not belong to any of the projects listed in the
+ field `expense_project_ids`.
expense_cost_center_ids:
nullable: true
type: array
@@ -9265,22 +9727,29 @@ components:
nullable: true
allOf:
- $ref: '#/components/schemas/contains_operator'
- description: |
- - If it is set to IN, this policy rule will be applicable to all the expenses that belong to any of the cost centers listed in the field `expense_cost_center_ids`.
- - If it is set to NOT_IN, this policy rule will be applicable to all the expenses that do not belong to any of the cost centers listed in the field `expense_cost_center_ids`.
+ description: >
+ - If it is set to IN, this policy rule will be applicable to all the
+ expenses that belong to any of the cost centers listed in the field
+ `expense_cost_center_ids`.
+
+ - If it is set to NOT_IN, this policy rule will be applicable to all
+ the expenses that do not belong to any of the cost centers listed in
+ the field `expense_cost_center_ids`.
expense_allowed_exchange_rate_difference_percentage:
nullable: true
type: number
- description: |
- Allowed percentage difference for exchange rates beyond which this policy rule will be violated.
+ description: >
+ Allowed percentage difference for exchange rates beyond which this
+ policy rule will be violated.
example: 10
minimum: 0
maximum: 100
expense_allowed_distance_difference_percentage:
nullable: true
type: number
- description: |
- Allowed distance percentage difference beyond which this policy rule will be violated.
+ description: >
+ Allowed distance percentage difference beyond which this policy rule
+ will be violated.
example: 8
minimum: 0
maximum: 100
@@ -9312,32 +9781,38 @@ components:
nullable: true
type: number
example: 12
- description: |
- This value decides how delayed an expense creation can be. If the expense is created after this many days of spend date, this policy rule will be violated.
+ description: >
+ This value decides how delayed an expense creation can be. If the
+ expense is created after this many days of spend date, this policy
+ rule will be violated.
expense_on_holiday_allowed:
type: boolean
- description: |
- If this is set to false, then for all such expenses that are created on holidays, this policy rule will be violated.
+ description: >
+ If this is set to false, then for all such expenses that are created
+ on holidays, this policy rule will be violated.
default: true
example: true
expense_without_receipt_allowed:
type: boolean
- description: |
- If this is set to false, then for all such expenses that doesn't have receipt, this policy rule will be violated.
+ description: >
+ If this is set to false, then for all such expenses that doesn't
+ have receipt, this policy rule will be violated.
default: true
example: true
expense_spent_at_max:
nullable: true
allOf:
- $ref: '#/components/schemas/timestamptz_pst'
- description: |
- If an expense's spend date exceeds this value, this policy rule will be violated for that expense.
+ description: >
+ If an expense's spend date exceeds this value, this policy rule will
+ be violated for that expense.
expense_spent_at_min:
nullable: true
allOf:
- $ref: '#/components/schemas/timestamptz_pst'
- description: |
- If an expense's spend date falls behind this value, this policy rule will be violated for that expense.
+ description: >
+ If an expense's spend date falls behind this value, this policy rule
+ will be violated for that expense.
expense_payment_modes:
nullable: true
allOf:
@@ -9350,21 +9825,25 @@ components:
- $ref: '#/components/schemas/contains_operator'
expense_without_ccc_match_allowed:
type: boolean
- description: |
- If this is set to false, then for all such expenses that are not matched to corporate credit card transaction, this policy rule will be violated.
+ description: >
+ If this is set to false, then for all such expenses that are not
+ matched to corporate credit card transaction, this policy rule will
+ be violated.
default: true
example: true
expense_include_foreign_currency:
type: boolean
- description: |
- If this is set to true, then for all such expenses that are created in foreign currency, this policy rule will be applicable.
+ description: >
+ If this is set to true, then for all such expenses that are created
+ in foreign currency, this policy rule will be applicable.
default: false
example: true
expense_flight_travel_class:
nullable: true
type: array
- description: |
- This field is applicable only for Flight category.
List of travel classes considered by this policy rule.
+ description: >
+ This field is applicable only for Flight category.
List of
+ travel classes considered by this policy rule.
items:
type: string
example:
@@ -9373,8 +9852,9 @@ components:
expense_train_travel_class:
nullable: true
type: array
- description: |
- This field is applicable only for Train category.
List of travel classes considered by this policy rule.
+ description: >
+ This field is applicable only for Train category.
List of
+ travel classes considered by this policy rule.
items:
type: string
example:
@@ -9391,8 +9871,9 @@ components:
nullable: true
type: number
example: 1200
- description: |
- If an expense's annual distance exceeds this value, this policy rule will be violated for that expense.
+ description: >
+ If an expense's annual distance exceeds this value, this policy rule
+ will be violated for that expense.
employee_level_ids:
nullable: true
type: array
@@ -9436,9 +9917,11 @@ components:
- $ref: '#/components/schemas/contains_operator'
employee_locations:
nullable: true
- description: |
+ description: >
Location of employees considered by this policy rule.
- If this is set, then for all such employees whose location is in `employee_locations`, this policy rule will be applicable.
+
+ If this is set, then for all such employees whose location is in
+ `employee_locations`, this policy rule will be applicable.
type: array
items:
$ref: '#/components/schemas/location'
@@ -9476,70 +9959,90 @@ components:
- $ref: '#/components/schemas/contains_operator'
action_flag:
type: boolean
- description: |
- If it is set to true, then the expense(s) violating this policy rule, will be flagged.
+ description: >
+ If it is set to true, then the expense(s) violating this policy
+ rule, will be flagged.
default: false
example: true
action_show_warning:
type: boolean
- description: |
- If it is set to true, then a warning is shown to the employee, whenever he attempts to create an expense that violates this policy rule.
+ description: >
+ If it is set to true, then a warning is shown to the employee,
+ whenever he attempts to create an expense that violates this policy
+ rule.
default: false
example: true
action_make_unreportable:
type: boolean
- description: |
- If it is set to true, then the expense(s) violating this policy rule, will be made unreportable.
- (Expense will be created but employee will not be able to add it to report).
+ description: >
+ If it is set to true, then the expense(s) violating this policy
+ rule, will be made unreportable.
+
+ (Expense will be created but employee will not be able to add it to
+ report).
default: false
example: true
action_remove_employee_approver1:
type: boolean
- description: |
- If this is set to true, then the employee's first approver will be removed from the report that contains expense(s) violating this policy rule.
+ description: >
+ If this is set to true, then the employee's first approver will be
+ removed from the report that contains expense(s) violating this
+ policy rule.
default: false
example: true
action_add_employee_approver2:
type: boolean
- description: |
- If this is set to true, then the employee's second approver will be added to the report that contains expense(s) violating this policy rule.
+ description: >
+ If this is set to true, then the employee's second approver will be
+ added to the report that contains expense(s) violating this policy
+ rule.
default: false
example: true
action_add_employee_approver3:
type: boolean
- description: |
- If this is set to true, then the employee's third approver will be added to the report that contains expense(s) violating this policy rule.
+ description: >
+ If this is set to true, then the employee's third approver will be
+ added to the report that contains expense(s) violating this policy
+ rule.
default: false
example: true
action_add_project_approver1:
type: boolean
- description: |
- If this is set to true, then the project's first approver will be added to the report that contains expense(s) violating this policy rule.
+ description: >
+ If this is set to true, then the project's first approver will be
+ added to the report that contains expense(s) violating this policy
+ rule.
default: false
example: true
action_add_project_approver2:
type: boolean
- description: |
- If this is set to true, then the project's second approver will be added to the report that contains expense(s) violating this policy rule.
+ description: >
+ If this is set to true, then the project's second approver will be
+ added to the report that contains expense(s) violating this policy
+ rule.
default: false
example: true
action_add_department_head_approver:
type: boolean
- description: |
- If this is set to true, then the employee's department head approver will be added to the report that contains expense(s) violating this policy rule.
+ description: >
+ If this is set to true, then the employee's department head approver
+ will be added to the report that contains expense(s) violating this
+ policy rule.
default: false
example: true
action_cap_amount:
type: boolean
- description: |
- If it is set to true, then expense's amount will be capped to `expense_amount_max` when the expense(s) violates this policy rule.
+ description: >
+ If it is set to true, then expense's amount will be capped to
+ `expense_amount_max` when the expense(s) violates this policy rule.
default: false
example: true
action_add_approver_user_ids:
nullable: true
type: array
- description: |
- List of approver user ids that will be added to the report that contains expense(s) violating this policy rule.
+ description: >
+ List of approver user ids that will be added to the report that
+ contains expense(s) violating this policy rule.
items:
type: string
example:
@@ -9548,8 +10051,10 @@ components:
action_override_distance_slab_rate:
nullable: true
type: number
- description: |
- When annual mileage distance limit exceeds `expense_annual_distance_max` for `expense_vehicle_type`, this rate will be applied afterwards.
+ description: >
+ When annual mileage distance limit exceeds
+ `expense_annual_distance_max` for `expense_vehicle_type`, this rate
+ will be applied afterwards.
example: 20
creator_user_id:
$ref: '#/components/schemas/user_id'
@@ -9564,9 +10069,12 @@ components:
id:
allOf:
- $ref: '#/components/schemas/id_string'
- description: |
+ description: >
This represents the id of the expense policy rule.
- _Note: When creating the policy rule, this field shouldn't be set._
+
+ _Note: When creating the policy rule, this field shouldn't be
+ set._
+
_When updating, this field should be set._
example: tpr12345xyz
description:
@@ -9579,219 +10087,325 @@ components:
expense_limit_type:
oneOf:
- $ref: '#/components/schemas/expense_policy_limit_type'
- description: |
+ description: >
Value signifying the limit type of the expense policy.
- `INDIVIDUAL`: Amount limit will be checked against each expense.
- `DAILY`: Amount limit will be checked against the total of all expenses in a day.
- `NIGHTLY`: Amount limit will be checked against the hotel cost per night.
- `WEEKLY`: Amount limit will be checked against the total of all expenses in a week.
- `MONTHLY`: Amount limit will be checked against the total of all expenses in a month.
- `QUARTERLY`: Amount limit will be checked against the total of all expenses in a financial quarter.
- `HALF_YEARLY`: Amount limit will be checked against the total of all expenses in a financial half-year.
- `YEARLY`: Amount limit will be checked against the total of all expenses in a financial year.
- `LIFETIME`: Amount limit will be checked against the total amount of all expenses throughout employee duration in the organisation.
- **Note: If this field is set(to any value), then the following fields are mandatory in the request body:**
+
+ `INDIVIDUAL`: Amount limit will be checked against each expense.
+
+
+ `DAILY`: Amount limit will be checked against the total of all
+ expenses in a day.
+
+ `NIGHTLY`: Amount limit will be checked against the hotel cost per
+ night.
+
+ `WEEKLY`: Amount limit will be checked against the total of all
+ expenses in a week.
+
+ `MONTHLY`: Amount limit will be checked against the total of all
+ expenses in a month.
+
+ `QUARTERLY`: Amount limit will be checked against the total of all
+ expenses in a financial quarter.
+
+ `HALF_YEARLY`: Amount limit will be checked against the total of all
+ expenses in a financial half-year.
+
+ `YEARLY`: Amount limit will be checked against the total of all
+ expenses in a financial year.
+
+ `LIFETIME`: Amount limit will be checked against the total amount of
+ all expenses throughout employee duration in the organisation.
+
+
+ **Note: If this field is set(to any value), then the following
+ fields are mandatory in the request body:**
+
- `expense_currency`
+
- Either `expense_amount_max` or `expense_amount_min`
- **Note: If this field is set to QUARTERLY, HALF_YEARLY or YEARLY, then the following additional fields are mandatory in the request body:**
+
+ **Note: If this field is set to QUARTERLY, HALF_YEARLY or YEARLY,
+ then the following additional fields are mandatory in the request
+ body:**
+
- `expense_fiscal_start_month`
expense_currency:
allOf:
- $ref: '#/components/schemas/currency'
- description: |
+ description: >
The three-letter currency code following ISO standard ISO 4217.
- _Note: `expense_amount_max` or `expense_amount_min` is mandatory if the field `expense_currency` is present in the request body._
+
+ href='https://www.iso.org/iso-4217-currency-codes.html'>ISO
+ 4217.
+
+ _Note: `expense_amount_max` or `expense_amount_min` is mandatory if
+ the field `expense_currency` is present in the request body._
expense_amount_max:
anyOf:
- $ref: '#/components/schemas/amount'
- description: |
- If an expense's amount exceeds this value, this policy rule will be violated for that expense.
- _Note: `expense_currency` and `expense_limit_type` is mandatory if the field `expense_amount_max` is present in the request body._
+ description: >
+ If an expense's amount exceeds this value, this policy rule will be
+ violated for that expense.
+
+ _Note: `expense_currency` and `expense_limit_type` is mandatory if
+ the field `expense_amount_max` is present in the request body._
example: 10000
expense_amount_min:
anyOf:
- $ref: '#/components/schemas/amount'
- description: |
- If an expense's amount falls behind this value, this policy rule will be violated for that expense..
- _Note: `expense_currency` and `expense_limit_type` is mandatory if the field `expense_amount_min` is present in the request body._
+ description: >
+ If an expense's amount falls behind this value, this policy rule
+ will be violated for that expense..
+
+ _Note: `expense_currency` and `expense_limit_type` is mandatory if
+ the field `expense_amount_min` is present in the request body._
example: 500
expense_fiscal_start_month:
type: number
- description: |
+ description: >
Month number of start of fiscal year.
- _Note: This fields is required when `expense_limit_type` is QUARTERLY, HALF_YEARLY or YEARLY._
+
+ _Note: This fields is required when `expense_limit_type` is
+ QUARTERLY, HALF_YEARLY or YEARLY._
example: 4
minimum: 1
maximum: 12
expense_distance_max:
allOf:
- $ref: '#/components/schemas/distance'
- description: |
- If an expense's distance exceeds this value, this policy rule will be violated for that expense.
- _Note: `expense_category_ids` with mileage category is mandatory if the field `expense_distance_max` is present in the request body._
+ description: >
+ If an expense's distance exceeds this value, this policy rule will
+ be violated for that expense.
+
+ _Note: `expense_category_ids` with mileage category is mandatory if
+ the field `expense_distance_max` is present in the request body._
example: 10000
expense_distance_min:
allOf:
- $ref: '#/components/schemas/distance'
- description: |
- If an expense's distance falls behind this value, this policy rule will be violated for that expense.
- _Note: `expense_category_ids` with mileage category is mandatory if the field `expense_distance_min` is present in the request body._
+ description: >
+ If an expense's distance falls behind this value, this policy rule
+ will be violated for that expense.
+
+ _Note: `expense_category_ids` with mileage category is mandatory if
+ the field `expense_distance_min` is present in the request body._
example: 500
expense_category_ids:
type: array
items:
$ref: '#/components/schemas/id_integer'
- description: |
+ description: >
List of category ids considered by this policy rule.
- _Note: You need to use field `expense_category_ids_op` along with this field._
+
+ _Note: You need to use field `expense_category_ids_op` along with
+ this field._
example:
- 2222
- 1221
expense_category_ids_op:
allOf:
- $ref: '#/components/schemas/contains_operator'
- description: |
- - If it is set to IN, this policy rule will be applicable to all the expenses that belong to any of the categories listed in the field `expense_category_ids`.
- - If it is set to NOT_IN, this policy rule will be applicable to all the expenses that do not belong to any of the categories listed in the field `expense_category_ids`.
+ description: >
+ - If it is set to IN, this policy rule will be applicable to all the
+ expenses that belong to any of the categories listed in the field
+ `expense_category_ids`.
+
+ - If it is set to NOT_IN, this policy rule will be applicable to all
+ the expenses that do not belong to any of the categories listed in
+ the field `expense_category_ids`.
expense_project_ids:
type: array
items:
$ref: '#/components/schemas/id_integer'
- description: |
+ description: >
List of project ids considered by this policy rule.
- _Note: You need to use field `expense_project_ids_op` along with this field._
+
+ _Note: You need to use field `expense_project_ids_op` along with
+ this field._
example:
- 1234
- 5678
expense_project_ids_op:
allOf:
- $ref: '#/components/schemas/contains_operator'
- description: |
- - If it is set to IN, this policy rule will be applicable to all the expenses that belong to any of the projects listed in the field `expense_project_ids`.
- - If it is set to NOT_IN, this policy rule will be applicable to all the expenses that do not belong to any of the projects listed in the field `expense_project_ids`.
+ description: >
+ - If it is set to IN, this policy rule will be applicable to all the
+ expenses that belong to any of the projects listed in the field
+ `expense_project_ids`.
+
+ - If it is set to NOT_IN, this policy rule will be applicable to all
+ the expenses that do not belong to any of the projects listed in the
+ field `expense_project_ids`.
expense_cost_center_ids:
type: array
items:
$ref: '#/components/schemas/id_integer'
- description: |
+ description: >
List of cost centers ids considered by this policy rule.
- _Note: You need to use field `expense_cost_center_ids_op` along with this field._
+
+ _Note: You need to use field `expense_cost_center_ids_op` along with
+ this field._
example:
- 1987
- 3456
expense_cost_center_ids_op:
allOf:
- $ref: '#/components/schemas/contains_operator'
- description: |
- - If it is set to IN, this policy rule will be applicable to all the expenses that belong to any of the cost centers listed in the field `expense_cost_center_ids`.
- - If it is set to NOT_IN, this policy rule will be applicable to all the expenses that do not belong to any of the cost centers listed in the field `expense_cost_center_ids`.
+ description: >
+ - If it is set to IN, this policy rule will be applicable to all the
+ expenses that belong to any of the cost centers listed in the field
+ `expense_cost_center_ids`.
+
+ - If it is set to NOT_IN, this policy rule will be applicable to all
+ the expenses that do not belong to any of the cost centers listed in
+ the field `expense_cost_center_ids`.
expense_allowed_exchange_rate_difference_percentage:
type: number
- description: |
- Allowed percentage difference for exchange rates beyond which this policy rule will be violated.
+ description: >
+ Allowed percentage difference for exchange rates beyond which this
+ policy rule will be violated.
example: 10
minimum: 0
maximum: 100
expense_allowed_distance_difference_percentage:
type: number
- description: |
- Allowed distance percentage difference beyond which this policy rule will be violated.
- _Note: `expense_category_ids` with mileage category is mandatory if the field `expense_allowed_distance_difference_percentage` is present in the request body._
+ description: >
+ Allowed distance percentage difference beyond which this policy rule
+ will be violated.
+
+ _Note: `expense_category_ids` with mileage category is mandatory if
+ the field `expense_allowed_distance_difference_percentage` is
+ present in the request body._
example: 8
minimum: 0
maximum: 100
expense_custom_fields:
allOf:
- $ref: '#/components/schemas/custom_fields'
- description: |
+ description: >
Custom fields (if any)
+
_Example -> "No. of days": 5_
- _Note: You need to use field `expense_custom_fields_op` along with this field._
+
+ _Note: You need to use field `expense_custom_fields_op` along with
+ this field._
expense_custom_fields_op:
type: object
- description: |
+ description: >
Operator for the expense_custom_fields.
+
_Format -> field_name: operator_
+
_Example -> "No. of days": "GREATER_THAN_EQUAL_TO"_
+
Supported values based on field type:
+
`Boolean`: `IS`, `NOT_IS`
+
`Date`: `LESS_THAN_EQUAL_TO`, `GREATER_THAN_EQUAL_TO`
+
`Location`: `IN`, `NOT_IN`
+
`Number`: `LESS_THAN_EQUAL_TO`, `GREATER_THAN_EQUAL_TO`
+
`String`: `CONTAINS`, `EQUALS`
+
`Select`: `IN`, `NOT_IN`
- _Note: This field is mandatory if the field `expense_custom_fields` is present in the request body._
+
+ _Note: This field is mandatory if the field `expense_custom_fields`
+ is present in the request body._
properties:
field_name:
type: string
expense_locations:
- description: |
+ description: >
Location of expense considered by this policy rule.
- If this is set, then for all such expenses that have a location - like expenses of category Flight, Train, Bus, Hotel, etc. - this policy rule will be applicable.
- _Note: You need to use field `expense_locations_op` along with this field._
+
+ If this is set, then for all such expenses that have a location -
+ like expenses of category Flight, Train, Bus, Hotel, etc. - this
+ policy rule will be applicable.
+
+ _Note: You need to use field `expense_locations_op` along with this
+ field._
type: array
items:
$ref: '#/components/schemas/location'
expense_locations_op:
allOf:
- $ref: '#/components/schemas/contains_operator'
- description: |
- _Note: This field is mandatory if the field `expense_locations` is present in the request body._
+ description: >
+ _Note: This field is mandatory if the field `expense_locations` is
+ present in the request body._
expense_creation_delay_days_max:
type: number
example: 12
- description: |
- This value decides how delayed an expense creation can be. If the expense is created after this many days of spend date, this policy rule will be violated.
+ description: >
+ This value decides how delayed an expense creation can be. If the
+ expense is created after this many days of spend date, this policy
+ rule will be violated.
expense_on_holiday_allowed:
type: boolean
- description: |
- If this is set to false, then for all such expenses that are created on holidays, this policy rule will be violated.
+ description: >
+ If this is set to false, then for all such expenses that are created
+ on holidays, this policy rule will be violated.
default: true
example: true
expense_without_receipt_allowed:
type: boolean
- description: |
- If this is set to false, then for all such expenses that doesn't have receipt, this policy rule will be violated.
+ description: >
+ If this is set to false, then for all such expenses that doesn't
+ have receipt, this policy rule will be violated.
default: true
example: true
expense_spent_at_max:
allOf:
- $ref: '#/components/schemas/timestamptz_pst'
- description: |
- If an expense's spend date exceeds this value, this policy rule will be violated for that expense.
+ description: >
+ If an expense's spend date exceeds this value, this policy rule will
+ be violated for that expense.
expense_spent_at_min:
allOf:
- $ref: '#/components/schemas/timestamptz_pst'
- description: |
- If an expense's spend date falls behind this value, this policy rule will be violated for that expense
+ description: >
+ If an expense's spend date falls behind this value, this policy rule
+ will be violated for that expense
expense_payment_modes:
allOf:
- $ref: '#/components/schemas/policy_payment_modes'
- description: |
+ description: >
Payment mode for expense to be considered by the policy rule.
- _Note: You need to use field `expense_payment_modes_op` along with this field._
+
+ _Note: You need to use field `expense_payment_modes_op` along with
+ this field._
expense_payment_modes_op:
allOf:
- $ref: '#/components/schemas/contains_operator'
- description: |
- _Note: This field is mandatory if the field `expense_payment_modes` is present in the request body._
+ description: >
+ _Note: This field is mandatory if the field `expense_payment_modes`
+ is present in the request body._
expense_without_ccc_match_allowed:
type: boolean
- description: |
- If this is set to false, then for all such expenses that are not matched to corporate credit card transaction, this policy rule will be violated.
+ description: >
+ If this is set to false, then for all such expenses that are not
+ matched to corporate credit card transaction, this policy rule will
+ be violated.
default: true
example: true
expense_include_foreign_currency:
type: boolean
- description: |
- If this is set to true, then for all such expenses that are created in foreign currency, this policy rule will be applicable.
+ description: >
+ If this is set to true, then for all such expenses that are created
+ in foreign currency, this policy rule will be applicable.
default: false
example: true
expense_flight_travel_class:
type: array
- description: |
- This field is applicable only for Train category.
List of travel classes considered by this policy rule. _Note: `expense_category_ids` with train category is mandatory if the field `expense_train_travel_class` is present in the request body._
+ description: >
+ This field is applicable only for Train category.
List of
+ travel classes considered by this policy rule. _Note:
+ `expense_category_ids` with train category is mandatory if the field
+ `expense_train_travel_class` is present in the request body._
items:
type: string
example:
@@ -9799,8 +10413,11 @@ components:
- ECONOMY
expense_train_travel_class:
type: array
- description: |
- This field is applicable only for Train category.
List of travel classes considered by this policy rule. _Note: `expense_category_ids` with train category is mandatory if the field `expense_train_travel_class` is present in the request body._
+ description: >
+ This field is applicable only for Train category.
List of
+ travel classes considered by this policy rule. _Note:
+ `expense_category_ids` with train category is mandatory if the field
+ `expense_train_travel_class` is present in the request body._
items:
type: string
example:
@@ -9809,20 +10426,29 @@ components:
expense_vehicle_type:
allOf:
- $ref: '#/components/schemas/vehicle_type'
- description: |
+ description: >
Vehicle type considered by this policy rule.
- _Note: `expense_annual_distance_max` and `action_override_distance_slab_rate` is mandatory if the field `expense_vehicle_type` is present in the request body._
+
+ _Note: `expense_annual_distance_max` and
+ `action_override_distance_slab_rate` is mandatory if the field
+ `expense_vehicle_type` is present in the request body._
expense_annual_distance_max:
type: number
example: 1200
- description: |
- If an expense's annual distance exceeds this value, this policy rule will be violated for that expense.
- _Note: `expense_vehicle_type` and `action_override_distance_slab_rate` is mandatory if the field `expense_annual_distance_max` is present in the request body._
+ description: >
+ If an expense's annual distance exceeds this value, this policy rule
+ will be violated for that expense.
+
+ _Note: `expense_vehicle_type` and
+ `action_override_distance_slab_rate` is mandatory if the field
+ `expense_annual_distance_max` is present in the request body._
employee_level_ids:
type: array
- description: |
+ description: >
Employee level ids considered by this policy rule.
- _Note: You need to use field `employee_level_ids_op` along with this field._
+
+ _Note: You need to use field `employee_level_ids_op` along with this
+ field._
items:
type: string
example:
@@ -9831,37 +10457,54 @@ components:
employee_level_ids_op:
allOf:
- $ref: '#/components/schemas/contains_operator'
- description: |
- Note: This field is mandatory if the field `employee_level_ids` is present in the request payload/body.
+ description: >
+ Note: This field is mandatory if the field `employee_level_ids` is
+ present in the request payload/body.
employee_custom_fields:
allOf:
- $ref: '#/components/schemas/custom_fields'
- description: |
+ description: >
Custom fields (if any)
+
_Example -> "Employee Age": 30_
- _Note: You need to use field `employee_custom_fields_op` along with this field._
+
+ _Note: You need to use field `employee_custom_fields_op` along with
+ this field._
employee_custom_fields_op:
type: object
- description: |
+ description: >
Operator for the employee_custom_fields.
+
_Format -> field_name: operator_
+
_Example -> "Employee Age": "GREATER_THAN_EQUAL_TO"_
+
Supported values based on field type:
+
`Boolean`: `IS`, `NOT_IS`
+
`Date`: `LESS_THAN_EQUAL_TO`, `GREATER_THAN_EQUAL_TO`
+
`Location`: `IN`, `NOT_IN`
+
`Number`: `LESS_THAN_EQUAL_TO`, `GREATER_THAN_EQUAL_TO`
+
`String`: `CONTAINS`, `EQUALS`
+
`Select`: `IN`, `NOT_IN`
- _Note: This field is mandatory if the field `employee_custom_fields` is present in the request body._
+
+ _Note: This field is mandatory if the field `employee_custom_fields`
+ is present in the request body._
properties:
field_name:
type: string
employee_department_ids:
type: array
- description: |
+ description: >
Employee department ids considered by this policy rule.
- _Note: You need to use field `employee_department_ids_op` along with this field._
+
+ _Note: You need to use field `employee_department_ids_op` along with
+ this field._
items:
type: string
example:
@@ -9870,26 +10513,34 @@ components:
employee_department_ids_op:
allOf:
- $ref: '#/components/schemas/contains_operator'
- description: |
- _Note: This field is mandatory if the field `employee_department_ids` is present in the request body._
+ description: >
+ _Note: This field is mandatory if the field
+ `employee_department_ids` is present in the request body._
employee_locations:
- description: |
+ description: >
Location of employees considered by this policy rule.
- If this is set, then for all such employees whose location is in `employee_locations`, this policy rule will be applicable.
- _Note: You need to use field `employee_locations_op` along with this field._
+
+ If this is set, then for all such employees whose location is in
+ `employee_locations`, this policy rule will be applicable.
+
+ _Note: You need to use field `employee_locations_op` along with this
+ field._
type: array
items:
$ref: '#/components/schemas/location'
employee_locations_op:
allOf:
- $ref: '#/components/schemas/contains_operator'
- description: |
- _Note: This field is mandatory if the field `employee_locations` is present in the request body._
+ description: >
+ _Note: This field is mandatory if the field `employee_locations` is
+ present in the request body._
employee_user_ids:
type: array
- description: |
+ description: >
Employee user ids considered by this policy rule.
- _Note: You need to use field `employee_user_ids_op` along with this field._
+
+ _Note: You need to use field `employee_user_ids_op` along with this
+ field._
items:
type: string
example:
@@ -9898,13 +10549,16 @@ components:
employee_user_ids_op:
allOf:
- $ref: '#/components/schemas/contains_operator'
- description: |
- _Note: This field is mandatory if the field `employee_user_ids` is present in the request body._
+ description: >
+ _Note: This field is mandatory if the field `employee_user_ids` is
+ present in the request body._
employee_titles:
type: array
- description: |
+ description: >
Employee titles considered by this policy rule.
- _Note: You need to use field `employee_titles_op` along with this field._
+
+ _Note: You need to use field `employee_titles_op` along with this
+ field._
items:
type: string
example:
@@ -9913,73 +10567,94 @@ components:
employee_titles_op:
allOf:
- $ref: '#/components/schemas/contains_operator'
- description: |
- _Note: This field is mandatory if the field `employee_titles` is present in the request body._
+ description: >
+ _Note: This field is mandatory if the field `employee_titles` is
+ present in the request body._
action_flag:
type: boolean
- description: |
- If it is set to true, then the expense(s) violating this policy rule, will be flagged.
+ description: >
+ If it is set to true, then the expense(s) violating this policy
+ rule, will be flagged.
default: false
example: true
action_show_warning:
type: boolean
- description: |
- If it is set to true, then a warning is shown to the employee, whenever he attempts to create an expense that violates this policy rule.
+ description: >
+ If it is set to true, then a warning is shown to the employee,
+ whenever he attempts to create an expense that violates this policy
+ rule.
default: false
example: true
action_make_unreportable:
type: boolean
- description: |
- If it is set to true, then the expense(s) violating this policy rule, will be made unreportable.
- (Expense will be created but employee will not be able to add it to report).
+ description: >
+ If it is set to true, then the expense(s) violating this policy
+ rule, will be made unreportable.
+
+ (Expense will be created but employee will not be able to add it to
+ report).
default: false
example: true
action_remove_employee_approver1:
type: boolean
- description: |
- If this is set to true, then the employee's first approver will be removed from the report that contains expense(s) violating this policy rule.
+ description: >
+ If this is set to true, then the employee's first approver will be
+ removed from the report that contains expense(s) violating this
+ policy rule.
default: false
example: true
action_add_employee_approver2:
type: boolean
- description: |
- If this is set to true, then the employee's second approver will be added to the report that contains expense(s) violating this policy rule.
+ description: >
+ If this is set to true, then the employee's second approver will be
+ added to the report that contains expense(s) violating this policy
+ rule.
default: false
example: true
action_add_employee_approver3:
type: boolean
- description: |
- If this is set to true, then the employee's third approver will be added to the report that contains expense(s) violating this policy rule.
+ description: >
+ If this is set to true, then the employee's third approver will be
+ added to the report that contains expense(s) violating this policy
+ rule.
default: false
example: true
action_add_project_approver1:
type: boolean
- description: |
- If this is set to true, then the project's first approver will be added to the report that contains expense(s) violating this policy rule.
+ description: >
+ If this is set to true, then the project's first approver will be
+ added to the report that contains expense(s) violating this policy
+ rule.
default: false
example: true
action_add_project_approver2:
type: boolean
- description: |
- If this is set to true, then the project's second approver will be added to the report that contains expense(s) violating this policy rule.
+ description: >
+ If this is set to true, then the project's second approver will be
+ added to the report that contains expense(s) violating this policy
+ rule.
default: false
example: true
action_add_department_head_approver:
type: boolean
- description: |
- If this is set to true, then the employee's department head approver will be added to the report that contains expense(s) violating this policy rule.
+ description: >
+ If this is set to true, then the employee's department head approver
+ will be added to the report that contains expense(s) violating this
+ policy rule.
default: false
example: true
action_cap_amount:
type: boolean
- description: |
- If it is set to true, then expense's amount will be capped to `expense_amount_max` when the expense(s) violates this policy rule.
+ description: >
+ If it is set to true, then expense's amount will be capped to
+ `expense_amount_max` when the expense(s) violates this policy rule.
default: false
example: true
action_add_approver_user_ids:
type: array
- description: |
- List of approver user ids that will be added to the report that contains expense(s) violating this policy rule.
+ description: >
+ List of approver user ids that will be added to the report that
+ contains expense(s) violating this policy rule.
items:
type: string
example:
@@ -9987,9 +10662,14 @@ components:
- usabcds4
action_override_distance_slab_rate:
type: number
- description: |
- When annual mileage distance limit exceeds `expense_annual_distance_max` for `expense_vehicle_type`, this rate will be applied afterwards.
- _Note: `expense_vehicle_type` and `expense_annual_distance_max` is mandatory if the field `action_override_distance_slab_rate` is present in the request body._
+ description: >
+ When annual mileage distance limit exceeds
+ `expense_annual_distance_max` for `expense_vehicle_type`, this rate
+ will be applied afterwards.
+
+ _Note: `expense_vehicle_type` and `expense_annual_distance_max` is
+ mandatory if the field `action_override_distance_slab_rate` is
+ present in the request body._
example: 20
expense_policy_state_change_in:
type: object
@@ -10010,17 +10690,22 @@ components:
id:
type: string
example: tpr1234abcd
- description: This represents the id of the expense policy rule that is violated for this expense.
+ description: >-
+ This represents the id of the expense policy rule that is violated
+ for this expense.
description:
anyOf:
- $ref: '#/components/schemas/description'
- description: |
- This represents the description of the expense policy rule that is violated for this expense.
+ description: >
+ This represents the description of the expense policy rule that is
+ violated for this expense.
example: Receipt is mandatory for expense above $50
action_show_warning:
type: boolean
- description: |
- A true value here means that policy calculation suggests showing a warning when the user attempts to create an expense that violates this expense policy rule.
+ description: >
+ A true value here means that policy calculation suggests showing a
+ warning when the user attempts to create an expense that violates
+ this expense policy rule.
example: true
expense_policy_expenses_query_object_params:
type: object
@@ -10057,10 +10742,15 @@ components:
example: eq.ouNSnadfaLA
expense_policy_expenses_query_object:
type: object
- description: |
- An expense may be violating an expense policy rule due to a group of other expenses.
- These query params can be used to fetch those expenses because of which this expense is causing a violation.
- Below params should be ANDed to get the correct list of violating expenses.
+ description: >
+ An expense may be violating an expense policy rule due to a group of
+ other expenses.
+
+ These query params can be used to fetch those expenses because of which
+ this expense is causing a violation.
+
+ Below params should be ANDed to get the correct list of violating
+ expenses.
properties:
limit_start_date:
type: string
@@ -10082,8 +10772,9 @@ components:
type: array
items:
type: string
- description: |
- List of approver ids that the policy calculation suggests adding to report that contains this expense.
+ description: >
+ List of approver ids that the policy calculation suggests adding to
+ report that contains this expense.
example:
- usBdsdfscl
- usLSsdfwqt
@@ -10094,21 +10785,35 @@ components:
- VIOLATED_ACTION_SUCCESS
- VIOLATED_ACTION_FAILURE
- UNVIOLATED
- description: |
- This represent the status of policy computation for an expense against the policy. If the state is
- `UNVIOLATED`, it means that the expense is not violating the policy. If the state is `VIOLATION_ACTION_SUCCESS`,
- it means that expense is violating the policy and action stated in the object will be applied to
- expense. However, if the state is `VIOLATION_ACTION_FAILURE`, it means that the policy is violated for the
- expense but since some approver was missing or not setup properly, it will fail to take action
+ description: >
+ This represent the status of policy computation for an expense
+ against the policy. If the state is
+
+ `UNVIOLATED`, it means that the expense is not violating the policy.
+ If the state is `VIOLATION_ACTION_SUCCESS`,
+
+ it means that expense is violating the policy and action stated in
+ the object will be applied to
+
+ expense. However, if the state is `VIOLATION_ACTION_FAILURE`, it
+ means that the policy is violated for the
+
+ expense but since some approver was missing or not setup properly,
+ it will fail to take action
+
on the expense
example: SUCCESS
run_result:
type: array
items:
type: string
- description: |
- List of human-readable action summaries that the policy calculation suggests for this expense. Note that, in
- case some approver was not setup properly for the given violation, this array will contain description of
+ description: >
+ List of human-readable action summaries that the policy calculation
+ suggests for this expense. Note that, in
+
+ case some approver was not setup properly for the given violation,
+ this array will contain description of
+
missing approvers. For example, Department head, Project head, etc.
example:
- flag the expense
@@ -10146,8 +10851,9 @@ components:
example: txabsdfSYqd
flag:
type: boolean
- description: |
- A true value here means, that as per policy calculation this expense should be flagged.
+ description: >
+ A true value here means, that as per policy calculation this expense
+ should be flagged.
example: true
amount:
nullable: true
@@ -10159,23 +10865,27 @@ components:
example: 500
is_receipt_mandatory:
type: boolean
- description: |
- A true value here means, that as per policy calculation this expense requires receipt.
+ description: >
+ A true value here means, that as per policy calculation this expense
+ requires receipt.
example: true
add_approver_user_ids:
nullable: true
type: array
items:
type: string
- description: |
- List of approver ids that the policy calculation suggests adding to report that contains this expense.
+ description: >
+ List of approver ids that the policy calculation suggests adding to
+ report that contains this expense.
example:
- usBdsdfscl
- usLSsdfwqt
remove_employee_approver1:
type: boolean
- description: |
- A true value here means, that as per policy calculation, the employee's first approver should be removed from the report that contains this expense.
+ description: >
+ A true value here means, that as per policy calculation, the
+ employee's first approver should be removed from the report that
+ contains this expense.
example: true
run_status:
nullable: false
@@ -10190,8 +10900,9 @@ components:
type: array
items:
type: string
- description: |
- List of human-readable action summaries that the policy calculation suggests for this expense.
+ description: >
+ List of human-readable action summaries that the policy calculation
+ suggests for this expense.
example:
- flag the expense
- cap the amount
@@ -10233,8 +10944,9 @@ components:
example: amex.csv
file_size:
type: number
- description: |
- Specifies the size of file uploaded by the user. (The size is represented in bytes)
+ description: >
+ Specifies the size of file uploaded by the user. (The size is
+ represented in bytes)
example: 21
no_of_debit:
type: integer
@@ -10274,20 +10986,24 @@ components:
nullable: true
has_duplicate_statements:
type: boolean
- description: |
- This specifies if the statement is complete duplicate of already uploaded statement or not.
+ description: >
+ This specifies if the statement is complete duplicate of already
+ uploaded statement or not.
nullable: true
duplicate_statement_ids:
type: array
- description: Holds the list of statement_ids which are complete duplicate of the current statement
+ description: >-
+ Holds the list of statement_ids which are complete duplicate of the
+ current statement
items:
$ref: '#/components/schemas/id_string'
example:
- stmtge49ielgel
has_duplicate_statement_line_items:
type: boolean
- description: |
- Indicates whether there are any line items in this statement are duplicates.
+ description: >
+ Indicates whether there are any line items in this statement are
+ duplicates.
nullable: true
duplicate_statement_line_items:
type: array
@@ -10321,8 +11037,9 @@ components:
nullable: true
is_processed:
type: boolean
- description: |
- Indicates whether the corporate card transactions are created out of the statement.
+ description: >
+ Indicates whether the corporate card transactions are created out of
+ the statement.
statement_mappings_id:
type: string
example: stmpdfddfd
@@ -10381,14 +11098,18 @@ components:
example: American Express
is_debit_positive:
type: boolean
- description: |
- Specifies the representation of the the amount in the statement, if true then the amount represented by
- positive sign are debits, and if false then the amount represented by negative sign are debits.
+ description: >
+ Specifies the representation of the the amount in the statement, if
+ true then the amount represented by
+
+ positive sign are debits, and if false then the amount represented
+ by negative sign are debits.
example: true
transaction_date_column:
type: string
- description: |
- Specifies the header name of the transaction date column in the statement.
+ description: >
+ Specifies the header name of the transaction date column in the
+ statement.
example: spent date
merchant_column:
type: string
@@ -10397,8 +11118,9 @@ components:
example: merchant
transaction_id_column:
type: string
- description: |
- Specifies the header name of the transaction id / unique id column in the statement.
+ description: >
+ Specifies the header name of the transaction id / unique id column
+ in the statement.
nullable: true
example: reference number
amount_column:
@@ -10413,25 +11135,29 @@ components:
example: amex_mapping
card_number_column:
type: string
- description: |
- Specifies the header name of the card number column in the statement.
+ description: >
+ Specifies the header name of the card number column in the
+ statement.
example: account number
foreign_amount_column:
type: string
- description: |
- Specifies the header name of the foreign amount column in the statement.
+ description: >
+ Specifies the header name of the foreign amount column in the
+ statement.
nullable: true
example: foreign amount
foreign_currency_column:
type: string
- description: |
- Specifies the header name of the foreign currency column in the statement.
+ description: >
+ Specifies the header name of the foreign currency column in the
+ statement.
nullable: true
example: foreign currency
description_column:
type: string
- description: |
- Specifies the header name of the description column in the statement.
+ description: >
+ Specifies the header name of the description column in the
+ statement.
nullable: true
example: description
post_date_column:
@@ -10485,14 +11211,18 @@ components:
example: American Express
is_debit_positive:
type: boolean
- description: |
- Specifies the representation of the the amount in the statement, if true then the amount represented by
- positive sign are debits, and if false then the amount represented by negative sign are debits.
+ description: >
+ Specifies the representation of the the amount in the statement, if
+ true then the amount represented by
+
+ positive sign are debits, and if false then the amount represented
+ by negative sign are debits.
example: true
transaction_date_column:
type: string
- description: |
- Specifies the header name of the transaction date column in the statement.
+ description: >
+ Specifies the header name of the transaction date column in the
+ statement.
example: spent date
merchant_column:
type: string
@@ -10501,8 +11231,9 @@ components:
example: merchant
transaction_id_column:
type: string
- description: |
- Specifies the header name of the transaction id / unique id column in the statement.
+ description: >
+ Specifies the header name of the transaction id / unique id column
+ in the statement.
nullable: true
example: reference number
amount_column:
@@ -10517,25 +11248,29 @@ components:
example: amex_mapping
card_number_column:
type: string
- description: |
- Specifies the header name of the card number column in the statement.
+ description: >
+ Specifies the header name of the card number column in the
+ statement.
example: account number
foreign_amount_column:
type: string
- description: |
- Specifies the header name of the foreign amount column in the statement.
+ description: >
+ Specifies the header name of the foreign amount column in the
+ statement.
nullable: true
example: foreign amount
foreign_currency_column:
type: string
- description: |
- Specifies the header name of the foreign currency column in the statement.
+ description: >
+ Specifies the header name of the foreign currency column in the
+ statement.
nullable: true
example: foreign currency
description_column:
type: string
- description: |
- Specifies the header name of the description column in the statement.
+ description: >
+ Specifies the header name of the description column in the
+ statement.
nullable: true
example: description
post_date_column:
@@ -10594,8 +11329,9 @@ components:
example: txn date
transaction_id_column:
type: string
- description: |
- Specifies the mapping of transaction id / unique id on the statement.
+ description: >
+ Specifies the mapping of transaction id / unique id on the
+ statement.
example: reference number
nullable: true
amount_column:
@@ -10627,8 +11363,9 @@ components:
nullable: true
post_date_column:
type: string
- description: |
- Specifies the header name of the post date column in the statement.
+ description: >
+ Specifies the header name of the post date column in the
+ statement.
example: post date
nullable: true
bank_name:
@@ -10638,9 +11375,12 @@ components:
example: American Express
is_debit_positive:
type: boolean
- description: |
- Specifies the representation of the the amount in the statement, if true then the amount represented by |
- positive sign are debits, and if false then the amount represented by negative sign are debits.
+ description: >
+ Specifies the representation of the the amount in the statement,
+ if true then the amount represented by |
+
+ positive sign are debits, and if false then the amount
+ represented by negative sign are debits.
example: true
name:
type: string
@@ -10672,16 +11412,18 @@ components:
type: array
items:
type: string
- description: |
- This specifies list of statement line items to be ignored in the statement.
+ description: >
+ This specifies list of statement line items to be ignored in the
+ statement.
example:
- stlisfdfadssd
rtf_missing_line_item_ids:
type: array
items:
type: string
- description: |
- This specifies list of statement line items which are to be created as RTF missing transactions.
+ description: >
+ This specifies list of statement line items which are to be created
+ as RTF missing transactions.
example:
- stlisfdfadssd
required:
@@ -10767,8 +11509,9 @@ components:
example: USD
transaction_type:
type: string
- description: |
- Specifies the transaction type of the transactions on the statement (credit / debit).
+ description: >
+ Specifies the transaction type of the transactions on the
+ statement (credit / debit).
example: debit
post_date:
$ref: '#/components/schemas/timestamptz_utc'
@@ -10796,13 +11539,15 @@ components:
properties:
missing_transactions_count:
type: integer
- description: |
- Number of transactions in the statement that are from cards that dont exist on Fyle/are not RTF enrolled.
+ description: >
+ Number of transactions in the statement that are from cards that
+ dont exist on Fyle/are not RTF enrolled.
example: 76
is_rtf_statement:
type: boolean
- description: |
- Indicates whether the statement has atleast one card enrolled in RTF.
+ description: >
+ Indicates whether the statement has atleast one card enrolled in
+ RTF.
example: true
missing_corporate_card_details:
type: array
@@ -10916,8 +11661,9 @@ components:
example: USD
transaction_type:
type: string
- description: |
- Specifies the transaction type of the transactions on the statement (credit / debit).
+ description: >
+ Specifies the transaction type of the transactions on the
+ statement (credit / debit).
example: debit
unique_id:
type: string
@@ -10926,13 +11672,16 @@ components:
example: ed0b2aa913c
rtf_confidence:
type: string
- description: |
- RTF Confidence percentage - `rtf_count` to the `total_count`, indicates what % of statement transactions are already existing in Fyle via RTF.
+ description: >
+ RTF Confidence percentage - `rtf_count` to the `total_count`,
+ indicates what % of statement transactions are already existing in
+ Fyle via RTF.
example: 99.22
rtf_count:
type: integer
- description: |
- Number of transactions in the statement that are already existing in Fyle via RTF.
+ description: >
+ Number of transactions in the statement that are already existing in
+ Fyle via RTF.
example: 76
total_count:
type: integer
@@ -10972,8 +11721,9 @@ components:
example: txn date
transaction_id_column:
type: string
- description: |
- Specifies the mapping of transaction id / unique id on the statement.
+ description: >
+ Specifies the mapping of transaction id / unique id on the
+ statement.
example: reference number
nullable: true
amount_column:
@@ -11005,8 +11755,9 @@ components:
nullable: true
post_date_column:
type: string
- description: |
- Specifies the header name of the post date column in the statement.
+ description: >
+ Specifies the header name of the post date column in the
+ statement.
example: post date
nullable: true
bank_name:
@@ -11016,9 +11767,12 @@ components:
example: American Express
is_debit_positive:
type: boolean
- description: |
- Specifies the representation of the the amount in the statement, if true then the amount represented by |
- positive sign are debits, and if false then the amount represented by negative sign are debits.
+ description: >
+ Specifies the representation of the the amount in the statement,
+ if true then the amount represented by |
+
+ positive sign are debits, and if false then the amount
+ represented by negative sign are debits.
example: true
name:
type: string
@@ -11050,8 +11804,9 @@ components:
type: array
items:
type: string
- description: |
- This specifies list of statement line items to be ignored in the statement.
+ description: >
+ This specifies list of statement line items to be ignored in the
+ statement.
example:
- stlisfdfadssd
reconciliation_method:
@@ -11086,8 +11841,9 @@ components:
Timestamp of the last uploaded statement.
rtf_confidence:
type: string
- description: |
- RTF Confidence percentage indicates what % of the transactions in last uploaded statement are already existing in Fyle via RTF.
+ description: >
+ RTF Confidence percentage indicates what % of the transactions in
+ last uploaded statement are already existing in Fyle via RTF.
example: 99.22
expense_rule_if_out:
type: object
@@ -11127,8 +11883,9 @@ components:
type: string
maxLength: 255
nullable: true
- description: |
- String denoting the name of the merchant to which the Expense was made.
+ description: >
+ String denoting the name of the merchant to which the Expense was
+ made.
example: Amazon
is_billable:
$ref: '#/components/schemas/is_billable'
@@ -11270,9 +12027,11 @@ components:
- MILES
example: MILES
travel_classes:
- description: |
+ description: >
This field is applicable only for `Flight`, `Train`, `Bus` category.
- Index 0 holds onward journey travel class, index 1 holds return journey travel class.
+
+ Index 0 holds onward journey travel class, index 1 holds return journey
+ travel class.
type: array
minItems: 0
maxItems: 2
@@ -11283,9 +12042,12 @@ components:
- ECONOMY
- BUSINESS
locations:
- description: |
+ description: >
This field will be present for travel related categories.
- For travel between Place A to Place B, this array will contain two items. From location at array index i and To location at array index i+1.
+
+ For travel between Place A to Place B, this array will contain two
+ items. From location at array index i and To location at array index
+ i+1.
type: array
nullable: true
minItems: 0
@@ -11299,16 +12061,22 @@ components:
id:
allOf:
- $ref: '#/components/schemas/id_string'
- description: |
+ description: >
This represents the id of the expense.
- _Note: This field is required when you are updating an already created expense and want to check it again for missing mandatory fields._
+
+ _Note: This field is required when you are updating an already
+ created expense and want to check it again for missing mandatory
+ fields._
example: tx0agOdICdbV
spent_at:
allOf:
- $ref: '#/components/schemas/spent_at'
- description: |
- It signifies when this expense was made. This date cannot be in future.
- _Note: This field is mandatory when you are creating an expense and want to check it again for missing mandatory fields._
+ description: >
+ It signifies when this expense was made. This date cannot be in
+ future.
+
+ _Note: This field is mandatory when you are creating an expense and
+ want to check it again for missing mandatory fields._
source:
$ref: '#/components/schemas/source'
merchant:
@@ -11320,9 +12088,11 @@ components:
claim_amount:
allOf:
- $ref: '#/components/schemas/claim_amount'
- description: |
+ description: >
The expense amount as claimed by user.
- _Note: This field is mandatory when you are creating an expense and want to check it again for missing mandatory fields._
+
+ _Note: This field is mandatory when you are creating an expense and
+ want to check it again for missing mandatory fields._
example: 1984.18
purpose:
type: string
@@ -11400,18 +12170,21 @@ components:
properties:
missing_amount:
type: boolean
- description: |
- If this is set to true, then you need to send currency field with expense object.
+ description: >
+ If this is set to true, then you need to send currency field with
+ expense object.
example: false
missing_currency:
type: boolean
- description: |
- If this is set to true, then you need to send currency field with expense object.
+ description: >
+ If this is set to true, then you need to send currency field with
+ expense object.
example: false
missing_receipt:
type: boolean
- description: |
- If this is set to true, then you need to attach receipt to the expense.
+ description: >
+ If this is set to true, then you need to attach receipt to the
+ expense.
example: false
missing_expense_field_ids:
type: array
@@ -11438,8 +12211,9 @@ components:
limit:
in: query
name: limit
- description: |
- A limit on the number of objects to be returned. Allowed values are from 1 to 200.
+ description: >
+ A limit on the number of objects to be returned. Allowed values are from
+ 1 to 200.
schema:
type: integer
example: 20
@@ -11448,16 +12222,18 @@ components:
created_at:
in: query
name: created_at
- description: |
- Date string in yyyy-MM-ddTHH:mm:ss.SSSZ format along with operator in RHS dot pattern.
Supported operators are `gte`,`lte`,`gt`,`lt`.
+ description: >
+ Date string in yyyy-MM-ddTHH:mm:ss.SSSZ format along with operator in
+ RHS dot pattern.
Supported operators are `gte`,`lte`,`gt`,`lt`.
schema:
type: string
example: gte.2020-06-01T00:00:00.000-08:00
updated_at:
in: query
name: updated_at
- description: |
- Date string in yyyy-MM-ddTHH:mm:ss.SSSZ format along with operator in RHS dot pattern.
Supported operators are `gte`,`lte`,`gt`,`lt`.
+ description: >
+ Date string in yyyy-MM-ddTHH:mm:ss.SSSZ format along with operator in
+ RHS dot pattern.
Supported operators are `gte`,`lte`,`gt`,`lt`.
schema:
type: string
example: gte.2020-06-01T00:00:00.000-08:00
@@ -11496,9 +12272,13 @@ components:
time_interval_preset:
in: query
name: time_interval_preset
- description: |
- Preset time durations which can be used to filter expenses by spend date.
- Default value is used if it is not specified and time_interval_start and time_interval_end params are also not specified.
+ description: >
+ Preset time durations which can be used to filter expenses by spend
+ date.
+
+ Default value is used if it is not specified and time_interval_start and
+ time_interval_end params are also not specified.
+
Supported operator is `eq`.
schema:
type: string
@@ -11518,7 +12298,9 @@ components:
Supported operator is `eq`.
schema:
type: string
- description: Date-time in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >-
+ Date-time in [ISO8601
+ format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
example: '2020-06-01T13:14:54.804+00:00'
time_interval_end:
in: query
@@ -11529,13 +12311,17 @@ components:
Supported operator is `eq`.
schema:
type: string
- description: Date-time in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >-
+ Date-time in [ISO8601
+ format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
example: '2021-06-01T13:14:54.804+00:00'
is_card_spend:
in: query
name: is_card_spend
- description: |
- For filtering out only those expenses where source account is corporate card account
+ description: >
+ For filtering out only those expenses where source account is corporate
+ card account
+
Supported operators are `eq`.
schema:
type: string
@@ -11543,8 +12329,10 @@ components:
is_reimbursable:
in: query
name: is_reimbursable
- description: |
- For filtering out only those expenses which are reimbursable to the employee.
+ description: >
+ For filtering out only those expenses which are reimbursable to the
+ employee.
+
Supported operators are `eq`.
schema:
type: string
@@ -11614,8 +12402,9 @@ components:
- eq.ouwruogwnngg
tags:
- name: Accounting Exports
- description: |
- This API allows you to record export of Fyle resources to an external accounting exports
+ description: >
+ This API allows you to record export of Fyle resources to an external
+ accounting exports
- name: Accounts
description: |
This APIs gives access to your Employees's accounts data.
@@ -11632,14 +12421,17 @@ tags:
description: |
These APIs gives you access to manage your organisation's Categories
- name: Corporate Cards
- description: |
- This API gives you access to manage your organisation's Corporate Cards data.
+ description: >
+ This API gives you access to manage your organisation's Corporate Cards
+ data.
- name: Corporate Card Transactions
- description: |
- This API gives you access to manage your organisation's Corporate Card Transaction data.
+ description: >
+ This API gives you access to manage your organisation's Corporate Card
+ Transaction data.
- name: Cost Centers
- description: |
- These APIs gives you access to manage your organisation's Cost Centers data.
+ description: >
+ These APIs gives you access to manage your organisation's Cost Centers
+ data.
- name: Departments
description: |
These APIs gives you access to manage your organisation's Departments
@@ -11693,11 +12485,13 @@ tags:
description: |
These APIs gives you access to manage organisations.
- name: Statements
- description: |
- These APIs gives you access to add / view a bank statement for reconciliation.
+ description: >
+ These APIs gives you access to add / view a bank statement for
+ reconciliation.
- name: Statement mappings
- description: |
- These APIs gives you access to manage statement mappings which is used for statement uploads.
+ description: >
+ These APIs gives you access to manage statement mappings which is used for
+ statement uploads.
paths:
/admin/projects:
get:
@@ -11705,8 +12499,11 @@ paths:
- Projects
summary: List projects
operationId: projects_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -11851,8 +12648,11 @@ paths:
tags:
- Cost Centers
summary: List cost centers
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -12003,8 +12803,11 @@ paths:
- Categories
summary: List categories
operationId: categories_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -12149,8 +12952,9 @@ paths:
- Categories
summary: List system categories
operationId: system_categories_list
- description: |
- This APIs gives you the list of system categories. Note that this API does not support any query params like order, limit, offset or name.
+ description: >
+ This APIs gives you the list of system categories. Note that this API
+ does not support any query params like order, limit, offset or name.
responses:
'200':
description: OK
@@ -12184,8 +12988,11 @@ paths:
- Expenses
summary: List expense fields
operationId: expense_fields_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -12272,13 +13079,17 @@ paths:
- Expenses
summary: List dependent expense field values
operationId: dependent_expense_field_values_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
parameters:
- in: query
name: limit
- description: |
- A limit on the number of objects to be returned. Allowed values are from 1 to 200.
+ description: >
+ A limit on the number of objects to be returned. Allowed values are
+ from 1 to 200.
schema:
type: integer
example: 10
@@ -12399,13 +13210,17 @@ paths:
- Expenses
summary: List dependent expense field values preview
operationId: dependent_expense_field_values_preview_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
parameters:
- in: query
name: limit
- description: |
- A limit on the number of objects to be returned. Allowed values are from 1 to 10.
+ description: >
+ A limit on the number of objects to be returned. Allowed values are
+ from 1 to 10.
schema:
type: integer
example: 10
@@ -12444,7 +13259,8 @@ paths:
data:
type: array
items:
- $ref: '#/components/schemas/dependent_expense_field_values_preview_out'
+ $ref: >-
+ #/components/schemas/dependent_expense_field_values_preview_out
'400':
description: Bad request
content:
@@ -12463,8 +13279,11 @@ paths:
- Expenses
summary: List dependent expense field values upload requests
operationId: dependent_expense_field_values_uploads_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -12480,7 +13299,8 @@ paths:
data:
type: array
items:
- $ref: '#/components/schemas/dependent_expense_field_values_upload_out'
+ $ref: >-
+ #/components/schemas/dependent_expense_field_values_upload_out
'400':
description: Bad request
content:
@@ -12497,8 +13317,9 @@ paths:
tags:
- Expenses
summary: Create an upload excel file request for dependent expense field values
- description: |
- Create a request to upload excel file containing dependent expense field values mappings
+ description: >
+ Create a request to upload excel file containing dependent expense field
+ values mappings
operationId: dependent_expense_field_values_uploads_post
requestBody:
required: true
@@ -12508,7 +13329,8 @@ paths:
type: object
properties:
data:
- $ref: '#/components/schemas/dependent_expense_field_values_upload_in'
+ $ref: >-
+ #/components/schemas/dependent_expense_field_values_upload_in
required:
- data
responses:
@@ -12520,7 +13342,8 @@ paths:
type: object
properties:
data:
- $ref: '#/components/schemas/dependent_expense_field_values_upload_out'
+ $ref: >-
+ #/components/schemas/dependent_expense_field_values_upload_out
'400':
description: Bad request
content:
@@ -12551,8 +13374,11 @@ paths:
- Expenses
summary: List dependent expense field values download requests
operationId: dependent_expense_field_values_downloads_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -12568,7 +13394,8 @@ paths:
data:
type: array
items:
- $ref: '#/components/schemas/dependent_expense_field_values_download_out'
+ $ref: >-
+ #/components/schemas/dependent_expense_field_values_download_out
'400':
description: Bad request
content:
@@ -12584,9 +13411,12 @@ paths:
post:
tags:
- Expenses
- summary: Create a request to download an excel file for dependent expense field values
- description: |
- Create a request to download an excel file containing dependent expense field values mappings
+ summary: >-
+ Create a request to download an excel file for dependent expense field
+ values
+ description: >
+ Create a request to download an excel file containing dependent expense
+ field values mappings
operationId: dependent_expense_field_values_downloads_post
requestBody:
required: true
@@ -12596,7 +13426,8 @@ paths:
type: object
properties:
data:
- $ref: '#/components/schemas/dependent_expense_field_values_download_in'
+ $ref: >-
+ #/components/schemas/dependent_expense_field_values_download_in
required:
- data
responses:
@@ -12608,7 +13439,8 @@ paths:
type: object
properties:
data:
- $ref: '#/components/schemas/dependent_expense_field_values_download_out'
+ $ref: >-
+ #/components/schemas/dependent_expense_field_values_download_out
'400':
description: Bad request
content:
@@ -12639,8 +13471,11 @@ paths:
- Employees
summary: List employee fields
operationId: employee_fields_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -12727,8 +13562,11 @@ paths:
- Per Diem Rates
summary: List per diem rates
operationId: per_diem_rates_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -12818,8 +13656,11 @@ paths:
- Departments
summary: List departments
operationId: departments_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -12909,8 +13750,11 @@ paths:
- Mileage Rates
summary: List mileage rates
operationId: mileage_rates_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -12998,8 +13842,11 @@ paths:
- Levels
summary: List Levels
operationId: levels_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -13087,8 +13934,11 @@ paths:
- Employees
summary: List employees
operationId: employees_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
parameters:
- $ref: '#/components/parameters/q'
responses:
@@ -13126,8 +13976,9 @@ paths:
- Employees
summary: List employees business units
operationId: employees_business_units_list
- description: |
- This API returns the list of business units of employees based on the query parameters.
+ description: >
+ This API returns the list of business units of employees based on the
+ query parameters.
parameters:
- $ref: '#/components/parameters/q'
- $ref: '#/components/parameters/limit'
@@ -13149,8 +14000,9 @@ paths:
example:
- Marketing
- Management
- description: |
- List of business units of the employees based on the query parameters.
+ description: >
+ List of business units of the employees based on the
+ query parameters.
'400':
description: Bad request
content:
@@ -13169,8 +14021,9 @@ paths:
- Employees
summary: List employees titles
operationId: employees_titles_list
- description: |
- This API returns the list of titles of employees based on the query parameters.
+ description: >
+ This API returns the list of titles of employees based on the query
+ parameters.
parameters:
- $ref: '#/components/parameters/q'
- $ref: '#/components/parameters/limit'
@@ -13192,8 +14045,9 @@ paths:
example:
- Branch Manager
- Branch Head
- description: |
- List of titles of the employees based on the query parameters.
+ description: >
+ List of titles of the employees based on the query
+ parameters.
'400':
description: Bad request
content:
@@ -13212,8 +14066,9 @@ paths:
- Employees
summary: List employees locations
operationId: employees_locations_list
- description: |
- This API returns the list of locations of employees based on the query parameters.
+ description: >
+ This API returns the list of locations of employees based on the query
+ parameters.
parameters:
- $ref: '#/components/parameters/q'
- $ref: '#/components/parameters/limit'
@@ -13235,8 +14090,9 @@ paths:
example:
- India
- Indonesia
- description: |
- List of locations of the employees based on the query parameters.
+ description: >
+ List of locations of the employees based on the query
+ parameters.
'400':
description: Bad request
content:
@@ -13497,9 +14353,13 @@ paths:
- Employees
summary: List Employees upload requests
operationId: employees_upload_list
- description: |
+ description: >
You can check the status of the Employees upload requests.
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -13730,9 +14590,12 @@ paths:
tags:
- Files
summary: Bulk generate download and upload URLs
- description: |
- Once a file is created, its contents may need to be uploaded (or downloaded). To upload (or download) contents, you'll
- need to generate a temporary signed URL. This API accomplishes that. The signed URL is valid for 5 mins.
+ description: >
+ Once a file is created, its contents may need to be uploaded (or
+ downloaded). To upload (or download) contents, you'll
+
+ need to generate a temporary signed URL. This API accomplishes that. The
+ signed URL is valid for 5 mins.
requestBody:
required: true
content:
@@ -13944,8 +14807,11 @@ paths:
tags:
- Accounting Exports
summary: List accounting exports
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
operationId: accounting_exports_list
responses:
'200':
@@ -14035,8 +14901,11 @@ paths:
tags:
- Accounting Exports
summary: List accounting exports lineitems
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
operationId: accounting_export_lineitems_list
responses:
'200':
@@ -14181,10 +15050,15 @@ paths:
tags:
- Expenses
summary: List expenses
- description: |
- This API gets you expenses submitted by any employee in the current organization.
+ description: >
+ This API gets you expenses submitted by any employee in the current
+ organization.
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
operationId: expenses_list
responses:
'200':
@@ -14561,8 +15435,11 @@ paths:
tags:
- Advances
summary: List advance requests
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
operationId: advance_requests_list
responses:
'200':
@@ -14658,8 +15535,11 @@ paths:
- Advances
summary: List advances
operationId: advances_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -14754,8 +15634,11 @@ paths:
- Reminders
summary: List Reminders
operationId: reminders_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -14899,8 +15782,11 @@ paths:
- Reports
summary: List reports
operationId: reports_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
parameters:
- $ref: '#/components/parameters/q'
responses:
@@ -14999,12 +15885,16 @@ paths:
- data
properties:
data:
- $ref: '#/components/schemas/report_action_with_expenses_ids_to_eject'
+ $ref: >-
+ #/components/schemas/report_action_with_expenses_ids_to_eject
reason:
type: string
- description: |
+ description: >
Reason for ejecting the expense \
- Note: When ejecting own expense, reason is not required. However, if another spender's expense are ejected reason is mandatory.
+
+ Note: When ejecting own expense, reason is not required.
+ However, if another spender's expense are ejected reason is
+ mandatory.
example: All bills are in order
responses:
'200':
@@ -15176,8 +16066,11 @@ paths:
tags:
- Reports
summary: List report comments
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
operationId: report_comments_list
responses:
'200':
@@ -15568,6 +16461,75 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/404'
+ /admin/reports/accounting_export/bulk:
+ post:
+ tags:
+ - Reports
+ summary: Update accounting export summary and initiate export
+ description: |
+ Update accounting export summary and initiate export
+ operationId: reports_accounting_export_summary_bulk_post
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ additionalProperties: false
+ required:
+ - data
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/report_accounting_export_summary_in'
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: object
+ additionalProperties: false
+ properties:
+ data:
+ $ref: '#/components/schemas/admin_report_out'
+ '400':
+ description: Bad request
+ content:
+ application/json:
+ schema:
+ oneOf:
+ - $ref: '#/components/schemas/bulk_error'
+ - 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'
+ '403':
+ description: Forbidden
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/403'
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/404'
/admin/reports/stats:
post:
tags:
@@ -15668,8 +16630,11 @@ paths:
tags:
- Corporate Cards
summary: List corporate cards
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
operationId: corporate_cards_list
parameters:
- $ref: '#/components/parameters/created_at'
@@ -15817,8 +16782,9 @@ paths:
tags:
- Corporate Cards
summary: List corporate card bank names
- description: |
- This API just returns all the bank names associated with the corporate cards in the org
+ description: >
+ This API just returns all the bank names associated with the corporate
+ cards in the org
operationId: corporate_cards_bank_names_list
responses:
'200':
@@ -15838,8 +16804,9 @@ paths:
example:
- Amex
- Bank of America
- description: |
- Holds the bank names of all the corporate cards present in the org
+ description: >
+ Holds the bank names of all the corporate cards
+ present in the org
'400':
description: Bad request
content:
@@ -15857,8 +16824,9 @@ paths:
tags:
- Corporate Cards
summary: List corporate card masked card numbers
- description: |
- This API just returns all the maksed card numbers (last 4 digits) associated with the corporate cards in the org
+ description: >
+ This API just returns all the maksed card numbers (last 4 digits)
+ associated with the corporate cards in the org
operationId: corporate_cards_masked_card_numbers_list
responses:
'200':
@@ -15878,8 +16846,9 @@ paths:
example:
- 1234
- 5678
- description: |
- Holds the masked card numbers (last 4 digits) of all the corporate cards present in the org
+ description: >
+ Holds the masked card numbers (last 4 digits) of all
+ the corporate cards present in the org
'400':
description: Bad request
content:
@@ -16005,8 +16974,11 @@ paths:
tags:
- Corporate Card Transactions
summary: List corporate card transactions
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
operationId: corporate_card_transactions_list
parameters:
- $ref: '#/components/parameters/created_at'
@@ -16225,7 +17197,8 @@ paths:
data:
type: array
items:
- $ref: '#/components/schemas/corporate_card_transactions_delete_summary_in'
+ $ref: >-
+ #/components/schemas/corporate_card_transactions_delete_summary_in
responses:
'200':
description: OK
@@ -16236,7 +17209,8 @@ paths:
additionalProperties: false
properties:
data:
- $ref: '#/components/schemas/corporate_card_transactions_delete_summary_out'
+ $ref: >-
+ #/components/schemas/corporate_card_transactions_delete_summary_out
'400':
description: Bad request
content:
@@ -16325,8 +17299,9 @@ paths:
tags:
- Corporate Card Transactions
summary: Corporate card transactions saved filters
- description: |
- Save Corporate Card Transaction filters for personal use or share with other admins.
+ description: >
+ Save Corporate Card Transaction filters for personal use or share with
+ other admins.
operationId: corporate_card_transaction_filters_post
requestBody:
required: true
@@ -16348,7 +17323,8 @@ paths:
type: object
properties:
data:
- $ref: '#/components/schemas/corporate_card_transaction_filters_out'
+ $ref: >-
+ #/components/schemas/corporate_card_transaction_filters_out
'400':
description: Bad request
content:
@@ -16386,7 +17362,8 @@ paths:
data:
type: array
items:
- $ref: '#/components/schemas/corporate_card_transaction_filters_out'
+ $ref: >-
+ #/components/schemas/corporate_card_transaction_filters_out
'400':
description: Bad request
content:
@@ -16415,7 +17392,8 @@ paths:
type: object
properties:
data:
- $ref: '#/components/schemas/corporate_card_transaction_filters_delete_in'
+ $ref: >-
+ #/components/schemas/corporate_card_transaction_filters_delete_in
required:
- data
responses:
@@ -16427,7 +17405,8 @@ paths:
type: object
properties:
data:
- $ref: '#/components/schemas/corporate_card_transaction_filters_out'
+ $ref: >-
+ #/components/schemas/corporate_card_transaction_filters_out
'400':
description: Bad request
content:
@@ -16533,7 +17512,8 @@ paths:
type: object
properties:
data:
- $ref: '#/components/schemas/corporate_card_transaction_unassign_out'
+ $ref: >-
+ #/components/schemas/corporate_card_transaction_unassign_out
'400':
description: Bad request
content:
@@ -16586,7 +17566,8 @@ paths:
type: object
properties:
data:
- $ref: '#/components/schemas/corporate_card_transaction_mark_personal_out'
+ $ref: >-
+ #/components/schemas/corporate_card_transaction_mark_personal_out
'400':
description: Bad request
content:
@@ -16639,7 +17620,8 @@ paths:
type: object
properties:
data:
- $ref: '#/components/schemas/corporate_card_transaction_unmark_personal_out'
+ $ref: >-
+ #/components/schemas/corporate_card_transaction_unmark_personal_out
'400':
description: Bad request
content:
@@ -16745,7 +17727,8 @@ paths:
type: object
properties:
data:
- $ref: '#/components/schemas/corporate_card_transaction_undo_ignore_out'
+ $ref: >-
+ #/components/schemas/corporate_card_transaction_undo_ignore_out
'400':
description: Bad request
content:
@@ -16851,7 +17834,8 @@ paths:
type: object
properties:
data:
- $ref: '#/components/schemas/corporate_card_transaction_unmatch_out'
+ $ref: >-
+ #/components/schemas/corporate_card_transaction_unmatch_out
'400':
description: Bad request
content:
@@ -16882,8 +17866,11 @@ paths:
- Settlements
summary: List settlements
operationId: settlements_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -16925,8 +17912,11 @@ paths:
- Reimbursements
summary: List reimbursements
operationId: reimbursements_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -17011,8 +18001,11 @@ paths:
- Settlements
summary: List employee accounts summaries
operationId: employee_account_summaries_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -17108,8 +18101,11 @@ paths:
- Schedules
summary: List Schedule
operationId: schedules_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -17192,8 +18188,11 @@ paths:
- Scheduled Callbacks
summary: List Scheduled Callback
operationId: scheduled_callbacks_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -17222,9 +18221,15 @@ paths:
- Spend Overview
summary: Spend Overview Summary
operationId: spend_overview_summary
- description: |
- API to return spend overview summary data. Data returned by this API can be used to plot a time series graph depicting amount of spend over a period of time.
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ API to return spend overview summary data. Data returned by this API can
+ be used to plot a time series graph depicting amount of spend over a
+ period of time.
+
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
parameters:
- $ref: '#/components/parameters/time_interval_granularity'
- $ref: '#/components/parameters/time_interval_preset'
@@ -17284,9 +18289,13 @@ paths:
- Spend Overview
summary: Spend Overview By Merchant
operationId: spend_overview_by_merchant
- description: |
+ description: >
API to return spend overview data grouped by merchant.
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
parameters:
- $ref: '#/components/parameters/time_interval_preset'
- $ref: '#/components/parameters/time_interval_start'
@@ -17342,9 +18351,13 @@ paths:
- Spend Overview
summary: Spend Overview By Project
operationId: spend_overview_by_project
- description: |
+ description: >
API to return spend overview data grouped by project.
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
parameters:
- $ref: '#/components/parameters/time_interval_preset'
- $ref: '#/components/parameters/time_interval_start'
@@ -17400,9 +18413,13 @@ paths:
- Spend Overview
summary: Spend Overview By Category
operationId: spend_overview_by_category
- description: |
+ description: >
API to return spend overview data grouped by category.
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
parameters:
- $ref: '#/components/parameters/time_interval_preset'
- $ref: '#/components/parameters/time_interval_start'
@@ -17458,9 +18475,13 @@ paths:
- Spend Overview
summary: Spend Overview By Department
operationId: spend_overview_by_department
- description: |
+ description: >
API to return spend overview data grouped by department.
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
parameters:
- $ref: '#/components/parameters/time_interval_preset'
- $ref: '#/components/parameters/time_interval_start'
@@ -17485,7 +18506,8 @@ paths:
data:
type: array
items:
- $ref: '#/components/schemas/spend_overview_by_department_data_out'
+ $ref: >-
+ #/components/schemas/spend_overview_by_department_data_out
'202':
description: Request Accepted
content:
@@ -17516,9 +18538,13 @@ paths:
- Spend Overview
summary: Spend Overview By User
operationId: spend_overview_by_user
- description: |
+ description: >
API to return spend overview data grouped by user of an org.
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
parameters:
- $ref: '#/components/parameters/time_interval_preset'
- $ref: '#/components/parameters/time_interval_start'
@@ -17574,9 +18600,14 @@ paths:
- Spend Overview
summary: Spend Overview By Corporate Card
operationId: spend_overview_by_corporate_card
- description: |
- API to return spend overview data grouped by corporate cards being used in an org.
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ API to return spend overview data grouped by corporate cards being used
+ in an org.
+
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
parameters:
- $ref: '#/components/parameters/time_interval_preset'
- $ref: '#/components/parameters/time_interval_start'
@@ -17601,7 +18632,8 @@ paths:
data:
type: array
items:
- $ref: '#/components/schemas/spend_overview_by_corporate_card_data_out'
+ $ref: >-
+ #/components/schemas/spend_overview_by_corporate_card_data_out
'202':
description: Request Accepted
content:
@@ -17631,8 +18663,11 @@ paths:
tags:
- Accounts
summary: List accounts
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
operationId: accounts_list
responses:
'200':
@@ -17717,8 +18752,11 @@ paths:
- Tax Groups
summary: List tax groups
operationId: tax_groups_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -17917,8 +18955,11 @@ paths:
- Budgets
summary: List Budgets
operationId: budgets_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -17993,8 +19034,11 @@ paths:
- Organisations
summary: List Organisations
operationId: orgs_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -18029,14 +19073,25 @@ paths:
tags:
- Expense Policies
summary: Create or Update Expense Policy Rules
- description: |
+ description: >
Create or Update Expense Policy Rules
- **Apart from the required fields mentioned below, the request body should contain the following:**
- - You should choose at least one condition from **expense_*** or **employee_***.
+
+ **Apart from the required fields mentioned below, the request body
+ should contain the following:**
+
+ - You should choose at least one condition from **expense_*** or
+ **employee_***.
+
- You should choose at least one action from **action_***.
- _When multiple conditions are provided, then there will AND operation in between them and the policy rule
- will only be applicable on expenses if all of the conditions match.
- Similarly, for actions, if multiple actions are provided then all of the actions will be applied when conditions satisfy._
+
+ _When multiple conditions are provided, then there will AND operation in
+ between them and the policy rule
+
+ will only be applicable on expenses if all of the conditions match.
+
+
+ Similarly, for actions, if multiple actions are provided then all of the
+ actions will be applied when conditions satisfy._
operationId: expense_policy_rules_post
requestBody:
required: true
@@ -18087,14 +19142,21 @@ paths:
parameters:
- in: query
name: id
- description: |
+ description: >
The id of the expense policy rule.
+
Supported operators are `eq`, `in`, `neq`, `not_in`.
+
id=eq."id"
+
id=in.("id1","id2","id3")
+
id=neq."id"
+
id=not_in.("id1","id2","id3")
- > If no id is passed then all the expense policy rules of the org will be returned.
+
+ > If no id is passed then all the expense policy rules of the org
+ will be returned.
schema:
type: string
example: eq."tprmdNPsd"
@@ -18264,12 +19326,18 @@ paths:
parameters:
- in: query
name: expense_id
- description: |
- The id of the expense for which you are querying the policy states.
+ description: >
+ The id of the expense for which you are querying the policy
+ states.
+
Supported operators are `eq`, `in`, `neq`, `not_in`.
+
expense_id=eq."id"
+
expense_id=in.("id1","id2","id3")
+
expense_id=neq."id"
+
expense_id=not_in.("id1","id2","id3")
schema:
type: string
@@ -18322,8 +19390,11 @@ paths:
tags:
- Statements
summary: List Statements
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
operationId: statements_list
parameters:
- $ref: '#/components/parameters/created_at'
@@ -18364,8 +19435,9 @@ paths:
tags:
- Statements
summary: Upload a statement
- description: |
- Upload a corporate card statement(csv or excel) to Fyle for reconciliation.
+ description: >
+ Upload a corporate card statement(csv or excel) to Fyle for
+ reconciliation.
operationId: statements_post
requestBody:
required: true
@@ -18417,8 +19489,11 @@ paths:
tags:
- Statement mappings
summary: List of statement mappings
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
operationId: statement_mappings_list
parameters:
- $ref: '#/components/parameters/created_at'
@@ -18459,8 +19534,11 @@ paths:
tags:
- Statements
summary: Statement mapping suggestion
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
operationId: statement_mappings_suggest
requestBody:
required: true
@@ -18520,8 +19598,9 @@ paths:
tags:
- Statements
summary: Preview of the uploaded statement
- description: |
- This API helps in converting the statement with the mapping chosed and helps the user to preview it, this doesn't save the statement
+ description: >
+ This API helps in converting the statement with the mapping chosed and
+ helps the user to preview it, this doesn't save the statement
operationId: statements_preview
requestBody:
required: true
@@ -18573,8 +19652,10 @@ paths:
tags:
- Statements
summary: RTF Card Stats of a Statement
- description: |
- This API helps in getting all the card stats of a statement during RTF missing transactions upload. Stats include information such as if Card exists in Fyle, RTF enrollment of card etc.
+ description: >
+ This API helps in getting all the card stats of a statement during RTF
+ missing transactions upload. Stats include information such as if Card
+ exists in Fyle, RTF enrollment of card etc.
operationId: card_stats
requestBody:
required: true
@@ -18626,8 +19707,9 @@ paths:
tags:
- Statements
summary: Process RTF Missing Transactions Reconciliation
- description: |
- This API is used to start processing RTF missing transactions reconciliation of a statement.
+ description: >
+ This API is used to start processing RTF missing transactions
+ reconciliation of a statement.
operationId: post_missing_transactions
requestBody:
required: true
@@ -18637,7 +19719,8 @@ paths:
type: object
properties:
data:
- $ref: '#/components/schemas/rtf_missing_transaction_from_statement_in'
+ $ref: >-
+ #/components/schemas/rtf_missing_transaction_from_statement_in
required:
- data
responses:
@@ -18671,8 +19754,9 @@ paths:
tags:
- Statements
summary: Get RTF Missing Transactions Reconciliation Data
- description: |
- This API is used to get the data for RTF missing transactions reconciliation of a statement.
+ description: >
+ This API is used to get the data for RTF missing transactions
+ reconciliation of a statement.
operationId: get_missing_transactions
parameters:
- $ref: '#/components/parameters/id'
@@ -18688,7 +19772,8 @@ paths:
data:
type: object
items:
- $ref: '#/components/schemas/rtf_missing_transaction_from_statement_out'
+ $ref: >-
+ #/components/schemas/rtf_missing_transaction_from_statement_out
'400':
description: Bad Request
content:
@@ -18706,8 +19791,9 @@ paths:
tags:
- Statements
summary: Create corporate card transactions out of the uploaded statement
- description: |
- This API helps in converting the statement with the mapping chosed and create card transactions out of the statement.
+ description: >
+ This API helps in converting the statement with the mapping chosed and
+ create card transactions out of the statement.
operationId: statements_create_card_transactions
requestBody:
required: true
@@ -18752,8 +19838,9 @@ paths:
tags:
- Statements
summary: Get RTF Stats of the last uploaded statement
- description: |
- This API is used to get the RTF stats of the last uploaded statement for an organization.
+ description: >
+ This API is used to get the RTF stats of the last uploaded statement for
+ an organization.
operationId: get_rtf_stats
responses:
'200':
@@ -18848,8 +19935,11 @@ paths:
- Expense Rules
summary: List expense rules
operationId: expense_rules_list
- description: |
- This API supports very rich filtering on all response fields and pagination via query parameters. To understand how to use these parameters, please see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
+ description: >
+ This API supports very rich filtering on all response fields and
+ pagination via query parameters. To understand how to use these
+ parameters, please see the [Guide to Data
+ APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
responses:
'200':
description: OK
@@ -18940,10 +20030,14 @@ paths:
tags:
- Expenses
summary: Check expense for missing mandatory fields
- description: |
+ 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.
+
+ 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
diff --git a/src/admin/openapi.yaml b/src/admin/openapi.yaml
index 1908b3e94..fdfa6ac98 100644
--- a/src/admin/openapi.yaml
+++ b/src/admin/openapi.yaml
@@ -230,6 +230,8 @@ paths:
$ref: paths/admin@reports@process_manual@bulk.yaml
/admin/reports/process_summary/bulk:
$ref: paths/admin@reports@process_summary@bulk.yaml
+ /admin/reports/accounting_export/bulk:
+ $ref: paths/admin@reports@accounting_export@bulk.yaml
/admin/reports/stats:
$ref: paths/admin@reports@stats.yaml
/admin/reports/create_and_submit:
diff --git a/src/admin/paths/admin@reports@accounting_export@bulk.yaml b/src/admin/paths/admin@reports@accounting_export@bulk.yaml
new file mode 100644
index 000000000..662531b66
--- /dev/null
+++ b/src/admin/paths/admin@reports@accounting_export@bulk.yaml
@@ -0,0 +1,68 @@
+post:
+ tags:
+ - Reports
+ summary: Update accounting export summary and initiate export
+ description: |
+ Update accounting export summary and initiate export
+ operationId: reports_accounting_export_summary_bulk_post
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: object
+ additionalProperties: False
+ required:
+ - data
+ properties:
+ data:
+ type: array
+ items:
+ $ref: ../../components/schemas/report.yaml#/accounting_export_summary_in
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: object
+ additionalProperties: False
+ properties:
+ data:
+ $ref: '../../components/schemas/report.yaml#/admin_report_out'
+ '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
+ '404':
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ $ref: '../../components/schemas/404.yaml'
\ No newline at end of file
diff --git a/src/components/schemas/report.yaml b/src/components/schemas/report.yaml
index fe91a2f8d..cee5f7530 100644
--- a/src/components/schemas/report.yaml
+++ b/src/components/schemas/report.yaml
@@ -985,4 +985,10 @@ report_create_and_submit_expenses:
- $ref: './fields.yaml#/id_string'
example: [ 'txelntgwgwll', 'txavbdabass' ]
+accounting_export_summary_in:
+ type: object
+ required: [ id ]
+ properties:
+ id:
+ $ref: './fields.yaml#/id_string'