diff --git a/reference/admin.yaml b/reference/admin.yaml
index 8617255cb..280a873f7 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.
example: true
restricted_spender_user_ids:
type: array
@@ -169,9 +185,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
@@ -185,8 +203,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
@@ -216,9 +235,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'
@@ -280,10 +302,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`._
@@ -291,10 +318,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
@@ -304,16 +335,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
@@ -323,10 +361,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
@@ -442,10 +485,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"}`_
@@ -458,8 +506,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._
@@ -495,8 +544,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
@@ -513,8 +564,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:
@@ -535,7 +587,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:
@@ -554,8 +608,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
@@ -569,10 +624,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.
category_in_only_id:
type: object
required:
@@ -638,8 +698,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
@@ -650,8 +711,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
@@ -686,8 +748,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
@@ -725,8 +789,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
@@ -739,13 +805,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
@@ -761,8 +831,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
@@ -861,8 +933,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
@@ -902,8 +975,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
@@ -1016,8 +1090,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
@@ -1055,8 +1130,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
@@ -1084,8 +1160,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
@@ -1201,8 +1278,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
@@ -1340,8 +1419,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'
@@ -1376,8 +1456,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'
@@ -1419,8 +1500,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.
null_field:
type: string
nullable: true
@@ -1428,15 +1511,19 @@ components:
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'
joined_at:
anyOf:
- $ref: '#/components/schemas/null_field'
- $ref: '#/components/schemas/timestamptz_utc'
nullable: true
- description: |
- Date and time when the user joined the organization. Date-time will be in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >
+ Date and time when the user joined the organization. Date-time will be
+ in [ISO8601
+ format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
level_out_embed:
type: object
additionalProperties: false
@@ -1452,8 +1539,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
@@ -1541,12 +1629,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:
@@ -1592,9 +1686,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
@@ -1637,8 +1734,9 @@ components:
$ref: '#/components/schemas/code'
has_accepted_invite:
type: boolean
- description: |
- This boolean field represents whether the employee has accepted the current org's invite by verifying his/her email or not.
+ description: >
+ This boolean field represents whether the employee has accepted the
+ current org's invite by verifying his/her email or not.
example: true
bank_ifsc:
type: string
@@ -1651,8 +1749,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
@@ -1756,8 +1856,9 @@ components:
end_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
- 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
@@ -1788,8 +1889,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
@@ -1816,9 +1919,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:
@@ -1881,15 +1987,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
@@ -1958,8 +2066,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
@@ -2038,8 +2147,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
potential_duplicate_expenses:
type: array
@@ -2049,14 +2159,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'
delegatee:
type: object
@@ -2076,8 +2189,9 @@ components:
end_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
- 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
invitation_in:
type: object
@@ -2090,8 +2204,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:
@@ -2104,9 +2220,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:
@@ -2139,8 +2258,9 @@ components:
- approver1@example.com
- approver2@example.com
- null
- description: |
- List of emails of employees that are approvers for this employee. Use null in case of no approver or to remove the approver.
+ description: >
+ List of emails of employees that are approvers for this employee.
+ Use null in case of no approver or to remove the approver.
project_names:
type: array
nullable: false
@@ -2149,9 +2269,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
@@ -2159,8 +2283,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
@@ -2188,8 +2313,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
@@ -2204,8 +2330,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
@@ -2225,8 +2352,9 @@ components:
$ref: '#/components/schemas/email'
example:
- delegatee@example.com
- description: |
- This key is in the process of being deprecated. It is recommended to use `delegatees` key instead.
+ description: >
+ This key is in the process of being deprecated. It is recommended to
+ use `delegatees` key instead.
deprecated: true
delegatees:
type: array
@@ -2239,8 +2367,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:
@@ -2349,8 +2479,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
@@ -2378,8 +2509,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
@@ -2408,8 +2540,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
@@ -2451,8 +2584,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
@@ -2606,7 +2740,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:
@@ -2628,7 +2764,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:
@@ -2740,8 +2878,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:
@@ -2770,27 +2909,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
@@ -2996,8 +3139,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:
@@ -3024,8 +3169,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
@@ -3043,8 +3189,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
@@ -3067,9 +3214,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:
@@ -3123,8 +3273,9 @@ components:
Mobile number of the employee
joined_at:
$ref: '#/components/schemas/joined_at'
- description: |
- NOTE: The data of this field is not realtime. It will get updated later even if `employee_id` is already up-to-date.
+ description: >
+ NOTE: The data of this field is not realtime. It will get updated later
+ even if `employee_id` is already up-to-date.
card_number:
type: string
description: |
@@ -3245,22 +3396,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
@@ -3283,15 +3440,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
@@ -3390,8 +3550,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'
@@ -3445,24 +3606,29 @@ components:
example: 5
policy_checks:
type: object
- description: |
+ description: >
Policy checks details.
- NOTE: The data of this field is not realtime. It will get updated later even if rest of fields are already up-to-date.
+
+ NOTE: The data of this field is not realtime. It will get updated later
+ even if rest of fields are already up-to-date.
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
@@ -3514,8 +3680,9 @@ components:
commute_details:
type: object
nullable: true
- description: |
- Commute details of the employee. This is used to deduct daily commute from the employee's mileage expenses.
+ description: >
+ Commute details of the employee. This is used to deduct daily commute
+ from the employee's mileage expenses.
properties:
id:
allOf:
@@ -3653,32 +3820,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:
@@ -3802,17 +3983,21 @@ components:
per_diem_num_days:
type: number
nullable: true
- description: |
- Specific to per diem related expenses, number of days for which per diem claim is made.
+ description: >
+ Specific to per diem related expenses, number of days for 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
@@ -3827,9 +4012,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
@@ -3843,8 +4032,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:
@@ -3899,18 +4090,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:
@@ -3947,17 +4142,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'
@@ -3975,12 +4175,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
@@ -3994,15 +4198,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
@@ -4023,18 +4229,22 @@ components:
$ref: '#/components/schemas/tax_group'
approver_comments:
type: array
- description: |
+ description: >
Comments added by approvers.
- NOTE: The data of this field is not realtime. It will get updated later even if rest of fields are already up-to-date.
+
+ NOTE: The data of this field is not realtime. It will get updated
+ later even if rest of fields are already up-to-date.
items:
type: string
example:
- This is a comment by approver
verifier_comments:
type: array
- description: |
+ description: >
Comments added by verifiers.
- NOTE: The data of this field is not realtime. It will get updated later even if rest of fields are already up-to-date.
+
+ NOTE: The data of this field is not realtime. It will get updated
+ later even if rest of fields are already up-to-date.
items:
type: string
example:
@@ -4109,8 +4319,9 @@ components:
commute_details_id:
type: integer
nullable: true
- description: |
- Commute details id of the expense. This id is provided by Fyle to identify a commute details.
+ description: >
+ Commute details id of the expense. This id is provided by Fyle to
+ identify a commute details.
example: 1234
commute_details:
$ref: '#/components/schemas/commute_details'
@@ -4143,9 +4354,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
@@ -4156,9 +4369,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
@@ -4234,10 +4450,15 @@ components:
assignee_user_email:
allOf:
- $ref: '#/components/schemas/email'
- description: |
- An immutable field that represents the email address of the employee.
- Must be compliant with RFC
+ description: >
+ An immutable field that represents the email address of the
+ employee.
+
+ Must be compliant with RFC
+
822.
+
- **Note:**
- The expense will be assigned/re-assigned to this particular `employee`.
- This field is required while creating an expense.
@@ -4314,10 +4535,14 @@ components:
items:
allOf:
- $ref: '#/components/schemas/fk_string'
- description: |
+ description: >
List of file ids to attach to the expense.
- To add new files to the expense, send the list of file ids to be attached.
- To remove files from the expense, send the list of all file ids except which you want to remove.
+
+ To add new files to the expense, send the list of file ids to be
+ attached.
+
+ To remove files from the expense, send the list of all file ids
+ except which you want to remove.
hotel_is_breakfast_provided:
type: boolean
nullable: true
@@ -4326,8 +4551,10 @@ components:
mileage_rate_id:
allOf:
- $ref: '#/components/schemas/fk_integer'
- description: |
- Specific to mileage expense. This represents the Mileage's rate id given by Fyle
+ description: >
+ Specific to mileage expense. This represents the Mileage's rate id
+ given by Fyle
+
during creation of mileage rate for which this expense is created.
nullable: true
example: 9080
@@ -4335,11 +4562,20 @@ components:
type: boolean
nullable: true
description: Flag stating whether this was a round trip or not.
+ mileage_calculated_distance:
+ type: number
+ nullable: true
+ description: Distance computed by Fyle in mileage expenses.
+ mileage_calculated_amount:
+ type: number
+ nullable: true
+ description: Amount computed by Fyle in mileage expenses.
commute_details_id:
type: integer
nullable: true
- description: |
- Commute details id of the expense. This id is provided by Fyle to identify a commute details.
+ description: >
+ Commute details id of the expense. This id is provided by Fyle to
+ identify a commute details.
example: 1234
commute_deduction:
type: string
@@ -4403,10 +4639,15 @@ components:
example: https://app.example.com/expense/txwownwrng
sub_feature:
type: string
- description: |
- This field can be used to setup a collection of filters. For example, if you have multiple filters
- for a single page, this can be used as an identifier to fetch all the filters for that page.
- **Note: Only combination of alphabets, numbers and _(underscore) is allowed**
+ description: >
+ This field can be used to setup a collection of filters. For example, if
+ you have multiple filters
+
+ for a single page, this can be used as an identifier to fetch all the
+ filters for that page.
+
+ **Note: Only combination of alphabets, numbers and _(underscore) is
+ allowed**
nullable: true
example: flagged_expenses
expense_filters_out:
@@ -4463,8 +4704,9 @@ components:
query_params:
nullable: false
type: string
- description: |
- Query param string similar to expenses GET call. Use group_by_state=eq.true to get state-wise grouping of stats.
+ description: >
+ Query param string similar to expenses GET call. Use
+ group_by_state=eq.true to get state-wise grouping of stats.
example: id=in.('tx1263', 'tx1569')&group_by_state=eq.true
expenses_stats_out:
oneOf:
@@ -4540,8 +4782,9 @@ components:
total_amount: 0
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
@@ -4565,8 +4808,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
@@ -4589,8 +4835,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
@@ -4608,8 +4855,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:
@@ -4758,9 +5006,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:
@@ -4821,10 +5072,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:
@@ -4861,8 +5116,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:
@@ -4895,10 +5151,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:
@@ -4908,8 +5168,9 @@ components:
advance_requests_stats_in:
properties:
query_params:
- description: |
- Query param string similar to advance_requests GET call. Use group_by_state=eq.true to get state-wise grouping of stats.
+ description: >
+ Query param string similar to advance_requests GET call. Use
+ group_by_state=eq.true to get state-wise grouping of stats.
nullable: false
example: id=in.('adr1263','adr1569')&group_by_state=eq.true
advance_requests_stats_out:
@@ -5026,8 +5287,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
advance_out:
type: object
@@ -5097,10 +5359,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:
@@ -5122,13 +5388,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:
@@ -5191,10 +5460,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:
@@ -5211,8 +5484,10 @@ components:
properties:
query_params:
type: string
- description: |
- This field contains the query param string similar to the query params passed in advances GET call for displaying advances in the list view.
+ description: >
+ This field contains the query param string similar to the query
+ params passed in advances GET call for displaying advances in the
+ list view.
nullable: false
example: id=in.('adv1263', 'adv1569')
advances_stats_out:
@@ -5220,15 +5495,19 @@ components:
properties:
count:
type: integer
- description: |
- This field represents the total number of advances that match the criteria specified in the query_params within the body of the request.
+ description: >
+ This field represents the total number of advances that match the
+ criteria specified in the query_params within the body of the
+ request.
nullable: false
example: 1
total_amount:
allOf:
- $ref: '#/components/schemas/amount'
- description: |
- This field indicates the sum of amount of advances that match the criteria specified in the query_params within the body of the request.
+ description: >
+ This field indicates the sum of amount of advances that match the
+ criteria specified in the query_params within the body of the
+ request.
example: 100
advance_wallet_out:
type: object
@@ -5322,10 +5601,15 @@ components:
source:
type: string
nullable: true
- description: |
- The name of the client app from which this advance refund was created.
+ description: >
+ The name of the client app from which this advance refund 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
card_number:
@@ -5378,10 +5662,15 @@ components:
source:
type: string
nullable: true
- description: |
- The name of the client app from which this advance refund was created.
+ description: >
+ The name of the client app from which this advance refund 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
card_number:
@@ -5396,8 +5685,10 @@ components:
properties:
query_params:
type: string
- description: |
- This field contains the query param string similar to the query params passed in advance_refunds GET call for displaying advance_refunds in the list view.
+ description: >
+ This field contains the query param string similar to the query
+ params passed in advance_refunds GET call for displaying
+ advance_refunds in the list view.
nullable: false
example: id=in.('adr1263', 'adr1569')
advance_refunds_stats_out:
@@ -5405,15 +5696,19 @@ components:
properties:
count:
type: integer
- description: |
- This field represents the total number of advance_refunds that match the criteria specified in the query_params within the body of the refund.
+ description: >
+ This field represents the total number of advance_refunds that match
+ the criteria specified in the query_params within the body of the
+ refund.
nullable: false
example: 1
total_amount:
allOf:
- $ref: '#/components/schemas/amount'
- description: |
- This field indicates the sum of amount of advance_refunds that match the criteria specified in the query_params within the body of the refund.
+ description: >
+ This field indicates the sum of amount of advance_refunds that match
+ the criteria specified in the query_params within the body of the
+ refund.
example: 100
reminder_type:
type: string
@@ -5510,8 +5805,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'
@@ -5519,20 +5815,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'
@@ -5559,8 +5864,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'
@@ -5590,9 +5896,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:
@@ -5673,7 +5982,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
@@ -5840,8 +6152,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
@@ -5854,8 +6167,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
@@ -5998,8 +6312,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
@@ -6190,8 +6506,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'
@@ -6241,19 +6558,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
@@ -6262,18 +6582,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:
@@ -6297,8 +6620,9 @@ 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:
@@ -6310,8 +6634,9 @@ components:
properties:
query_params:
type: string
- description: |
- Query param string similar to reports GET call. Use group_by_state=eq.true to get state-wise grouping of stats.
+ description: >
+ Query param string similar to reports GET call. Use
+ group_by_state=eq.true to get state-wise grouping of stats.
nullable: false
example: id=in.('rp123','rep1234')&group_by_state=eq.true
reports_stats_out:
@@ -6355,31 +6680,43 @@ components:
failed_amount:
type: number
nullable: true
- description: Sum of reimbursable amount for ACH-failed reports, applicable only in PAYMENT_PROCESSING state.
+ description: >-
+ Sum of reimbursable amount for ACH-failed reports, applicable
+ only in PAYMENT_PROCESSING state.
example: 200
failed_count:
type: integer
nullable: true
- description: Count of ACH-failed reports, applicable only in PAYMENT_PROCESSING state.
+ description: >-
+ Count of ACH-failed reports, applicable only in
+ PAYMENT_PROCESSING state.
example: 1
processing_amount:
type: number
nullable: true
- description: Sum of reimbursable amount for processing reports, applicable only in PAYMENT_PROCESSING state.
+ description: >-
+ Sum of reimbursable amount for processing reports, applicable
+ only in PAYMENT_PROCESSING state.
example: 1500
processing_count:
type: integer
nullable: true
- description: Count of processing reports, applicable only in PAYMENT_PROCESSING state.
+ description: >-
+ Count of processing reports, applicable only in
+ PAYMENT_PROCESSING state.
example: 3
reimbursable_amount:
type: number
nullable: false
- description: Sum of reimbursable amounts for matching reports in this state.
+ description: >-
+ Sum of reimbursable amounts for matching reports in this
+ state.
example: 500
- type: object
title: Overall stats
- description: Overall stats without state grouping (response for older mobile app versions).
+ description: >-
+ Overall stats without state grouping (response for older mobile app
+ versions).
required:
- count
- total_amount
@@ -6411,7 +6748,9 @@ components:
failed_amount:
type: number
nullable: true
- description: Sum of reimbursable amounts for reports in processing state with ACH failures.
+ description: >-
+ Sum of reimbursable amounts for reports in processing state with
+ ACH failures.
example: 101
failed_count:
type: integer
@@ -6581,8 +6920,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.
reports_export_config:
type: object
additionalProperties: true
@@ -6598,21 +6940,24 @@ components:
example: csv
include_receipts:
type: boolean
- description: |
- Whether to include receipts in the export file or not. Only required for PDF exports.
+ description: >
+ Whether to include receipts in the export file or not. Only required
+ for PDF exports.
example: true
is_header_visible:
type: boolean
- description: |
- Whether to show the header in the export file. Only required for CSV and XLSX exports.
+ description: >
+ Whether to show the header in the export file. Only required for CSV
+ and XLSX exports.
example: true
separate_line_items_entry:
type: object
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
@@ -6630,8 +6975,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. Only required for CSV and XLSX exports.
+ description: >
+ Configure how to show the double rows for each line item in the
+ export file, if enabled. Only required for CSV and XLSX exports.
columns:
type: array
items:
@@ -6647,8 +6993,9 @@ components:
- $ref: '#/components/schemas/reports_export_config_column_formula'
description: |
Formula to transform the data in the column.
- description: |
- Configure the columns to show in the export file. Only required for CSV and XLSX exports.
+ description: >
+ Configure the columns to show in the export file. Only required for
+ CSV and XLSX exports.
reports_exports_out:
type: object
additionalProperties: false
@@ -6756,14 +7103,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:
@@ -6835,8 +7185,9 @@ components:
- READY_FOR_VERIFICATION
virtual_card_id:
type: string
- description: |
- The unique id of the virtual card, if the card is created from virtual card.
+ description: >
+ The unique id of the virtual card, if the card is created from
+ virtual card.
nullable: true
example: viasdfasdfddd
virtual_card_state:
@@ -6928,14 +7279,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:
@@ -6959,8 +7313,9 @@ components:
query_params:
nullable: false
type: string
- description: |
- This field contains the query param string, which can be used to fetch data for assigned and unassigned cards.
+ description: >
+ This field contains the query param string, which can be used to
+ fetch data for assigned and unassigned cards.
example: user_id=eq.null
corporate_card_stats_out:
type: object
@@ -6974,8 +7329,9 @@ components:
transactions_count:
type: integer
nullable: false
- description: |
- This field indicates the total count of transactions, present for the cards.
+ description: >
+ This field indicates the total count of transactions, present for
+ the cards.
example: 1000
corporate_card_assign_in:
type: object
@@ -7015,8 +7371,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
example: null
corporate_card_unassign_out:
@@ -7063,14 +7420,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:
@@ -7138,8 +7498,9 @@ components:
nullable: true
virtual_card_id:
type: string
- description: |
- The unique id of the virtual card, if the card is created from virtual card.
+ description: >
+ The unique id of the virtual card, if the card is created from
+ virtual card.
nullable: true
example: viasdfasdfddd
virtual_card_state:
@@ -7220,7 +7581,9 @@ components:
- user_id
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:
@@ -7311,8 +7674,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'
@@ -7352,14 +7716,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:
@@ -7375,8 +7743,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'
@@ -7468,8 +7837,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:
@@ -7501,8 +7871,9 @@ components:
enum:
- POSTED
- PENDING
- description: |
- Holds the status of the Corporate Card Transaction, whether posted or still pending.
+ description: >
+ Holds the status of the Corporate Card Transaction, whether posted
+ or still pending.
description:
type: string
nullable: true
@@ -7512,8 +7883,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
@@ -7537,17 +7909,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:
@@ -7576,8 +7953,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'
@@ -7604,8 +7982,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:
@@ -7635,8 +8014,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'
@@ -7717,22 +8097,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:
@@ -7795,8 +8181,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
@@ -7814,23 +8201,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:
@@ -7861,8 +8254,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'
@@ -7891,8 +8285,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:
@@ -7922,8 +8317,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'
@@ -7969,9 +8365,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:
@@ -7984,14 +8383,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
@@ -8008,14 +8409,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
@@ -8080,8 +8483,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
@@ -8129,8 +8533,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
@@ -8148,23 +8553,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:
@@ -8193,8 +8604,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'
@@ -8223,8 +8635,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:
@@ -8254,8 +8667,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'
@@ -8305,8 +8719,9 @@ components:
example: btxnwownwrng
user_id:
type: string
- description: |
- The unique id of an user to whom the card transaction should be reassigned.
+ description: >
+ The unique id of an user to whom the card transaction should be
+ reassigned.
example: usge49ielgel
required:
- id
@@ -8368,8 +8783,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
@@ -8387,23 +8803,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:
@@ -8433,8 +8855,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'
@@ -8450,8 +8873,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:
@@ -8469,8 +8893,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:
@@ -8578,8 +9003,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
@@ -8597,23 +9023,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:
@@ -8642,8 +9074,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'
@@ -8671,8 +9104,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:
@@ -8702,8 +9136,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.
metadata:
$ref: '#/components/schemas/corporate_card_transaction_metadata'
required:
@@ -8785,8 +9220,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
@@ -8804,23 +9240,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:
@@ -8849,8 +9291,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'
@@ -8878,8 +9321,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:
@@ -8909,8 +9353,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'
@@ -8993,8 +9438,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
@@ -9018,23 +9464,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:
@@ -9063,8 +9515,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'
@@ -9092,8 +9545,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:
@@ -9123,8 +9577,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'
@@ -9204,8 +9659,9 @@ components:
enum:
- POSTED
- PENDING
- description: |
- Holds the status of the Corporate Card Transaction, whether posted or still pending.
+ description: >
+ Holds the status of the Corporate Card Transaction, whether posted
+ or still pending.
description:
type: string
nullable: true
@@ -9215,8 +9671,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
@@ -9240,23 +9697,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:
@@ -9285,8 +9748,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'
@@ -9314,8 +9778,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:
@@ -9345,8 +9810,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'
@@ -9446,8 +9912,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
@@ -9471,23 +9938,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:
@@ -9516,8 +9989,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'
@@ -9546,8 +10020,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:
@@ -9577,8 +10052,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'
@@ -9674,8 +10150,9 @@ components:
enum:
- POSTED
- PENDING
- description: |
- Holds the status of the Corporate Card Transaction, whether posted or still pending.
+ description: >
+ Holds the status of the Corporate Card Transaction, whether posted
+ or still pending.
description:
type: string
nullable: true
@@ -9685,8 +10162,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
@@ -9710,23 +10188,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:
@@ -9755,8 +10239,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'
@@ -9772,8 +10257,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'
@@ -9790,8 +10276,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:
@@ -9877,8 +10364,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.
corporate_card_transactions_export_config:
type: object
additionalProperties: true
@@ -9893,16 +10383,18 @@ components:
example: csv
is_header_visible:
type: boolean
- description: |
- Whether to show the header in the export file. Only required for CSV and XLSX exports.
+ description: >
+ Whether to show the header in the export file. Only required for CSV
+ and XLSX exports.
example: true
separate_line_items_entry:
type: object
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
@@ -9920,8 +10412,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. Only required for CSV and XLSX exports.
+ description: >
+ Configure how to show the double rows for each line item in the
+ export file, if enabled. Only required for CSV and XLSX exports.
columns:
type: array
items:
@@ -9934,11 +10427,13 @@ components:
example: Spent Date
formula:
allOf:
- - $ref: '#/components/schemas/corporate_card_transactions_export_config_column_formula'
+ - $ref: >-
+ #/components/schemas/corporate_card_transactions_export_config_column_formula
description: |
Formula to transform the data in the column.
- description: |
- Configure the columns to show in the export file. Only required for CSV and XLSX exports.
+ description: >
+ Configure the columns to show in the export file. Only required for
+ CSV and XLSX exports.
corporate_card_transactions_exports_in:
type: object
additionalProperties: false
@@ -9968,22 +10463,25 @@ components:
type: string
format: date-time
nullable: true
- description: |
- Signifies when this was processed in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >
+ Signifies when this was processed in [ISO8601
+ format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
example: '2020-06-11T13:14:55.201598+00:00'
completed_at:
type: string
format: date-time
nullable: true
- description: |
- Signifies when this was completed in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >
+ Signifies when this was completed in [ISO8601
+ format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
example: '2020-06-11T13:14:55.201598+00:00'
failed_at:
type: string
format: date-time
nullable: true
- description: |
- Signifies when this was failed in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >
+ Signifies when this was failed in [ISO8601
+ format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
example: '2020-06-11T13:14:55.201598+00:00'
corporate_card_transactions_exports_out:
type: object
@@ -10092,14 +10590,16 @@ components:
valid_from_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
- description: |
- Specifies the valid from date of the card, ie from when the card would be active.
+ description: >
+ Specifies the valid from date of the card, ie from when the card
+ would be active.
example: '2022-02-01'
valid_till_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
- description: |
- Specifies the valid till date of the card, ie till when the card would be active.
+ description: >
+ Specifies the valid till date of the card, ie till when the card
+ would be active.
example: '2022-02-01'
creator_user_id:
type: string
@@ -10108,13 +10608,15 @@ components:
example: useradfasd
virtual_card_user_id:
type: string
- description: |
- This id refers to the virtual card user to whom the virtual card is assigned.
+ description: >
+ This id refers to the virtual card user to whom the virtual card is
+ assigned.
example: vcg2Bl78jstf
nick_name:
type: string
- description: |
- Represents user defined nick name associated with the virtual card for easier recognition.
+ description: >
+ Represents user defined nick name associated with the virtual card
+ for easier recognition.
example: john
required:
- id
@@ -10292,8 +10794,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
@@ -10306,8 +10809,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
@@ -10481,8 +10985,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:
@@ -10719,13 +11225,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
@@ -10737,13 +11253,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
@@ -10859,8 +11377,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'
@@ -11305,7 +11824,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'
@@ -11316,8 +11837,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
@@ -11407,24 +11929,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
@@ -11438,15 +11964,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
@@ -11462,9 +11990,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
@@ -11479,9 +12012,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
@@ -11496,22 +12034,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
@@ -11543,26 +12088,31 @@ 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_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:
@@ -11575,21 +12125,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:
@@ -11598,8 +12152,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:
@@ -11616,8 +12171,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
@@ -11661,9 +12217,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'
@@ -11701,70 +12259,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 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 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:
@@ -11773,8 +12351,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'
@@ -11789,9 +12369,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:
@@ -11803,238 +12386,368 @@ components:
example: Receipt is mandatory for expense above $50
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.
- **Note: If this field is set to false i.e. receipts are mandatory, only following conditions & actions are allowed =>**
+ description: >
+ If this is set to false, then for all such expenses that doesn't
+ have receipt, this policy rule will be violated.
+
+ **Note: If this field is set to false i.e. receipts are mandatory,
+ only following conditions & actions are allowed =>**
+
- expense_category_ids
+
- expense_category_ids_op
+
- expense_project_ids
+
- expense_project_ids_op
+
- expense_cost_center_ids
+
- expense_cost_center_ids_op
+
- expense_limit_type (only `INIDIVIDUAL` type is allowed)
+
- expense_currency
+
- expense_amount_max
+
- expense_payment_modes
+
- expense_payment_modes_op
+
- expense_without_ccc_match_allowed
+
- employee_department_ids
+
- employee_department_ids_op
+
- employee_locations
+
- employee_user_ids
+
- employee_user_ids_op
+
- employee_titles
+
- employee_titles_op
+
- action_flag
+
- action_show_warning
+
- action_make_unreportable
+
- description
default: true
example: true
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_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:
@@ -12042,8 +12755,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:
@@ -12052,20 +12768,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:
@@ -12074,37 +12799,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:
@@ -12113,26 +12855,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:
@@ -12141,13 +12891,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:
@@ -12156,73 +12909,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 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 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:
@@ -12230,9 +13004,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
@@ -12253,17 +13032,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
@@ -12300,10 +13084,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
@@ -12325,8 +13114,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
@@ -12337,22 +13127,37 @@ 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
- missing approvers. For example, Department approver, Project head, etc.
+ 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 approver, Project head,
+ etc.
example:
- flag the expense
- cap the amount
@@ -12389,8 +13194,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
@@ -12402,23 +13208,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
@@ -12433,8 +13243,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
@@ -12476,8 +13287,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
@@ -12517,20 +13329,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
@@ -12564,8 +13380,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
@@ -12624,14 +13441,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
@@ -12640,8 +13461,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:
@@ -12656,25 +13478,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:
@@ -12728,14 +13554,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
@@ -12744,8 +13574,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:
@@ -12760,25 +13591,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:
@@ -12837,8 +13672,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:
@@ -12870,8 +13706,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:
@@ -12881,9 +13718,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
@@ -12915,22 +13755,25 @@ 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
statement_card_number:
type: string
- description: |
- Card number from statement can be passed to get transactions only from specific card
+ description: >
+ Card number from statement can be passed to get transactions only
+ from specific card
example: xxx5-4543
required:
- id
@@ -13015,8 +13858,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'
@@ -13077,8 +13921,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:
@@ -13110,8 +13955,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:
@@ -13121,9 +13967,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
@@ -13155,16 +14004,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
card_mapping:
@@ -13177,18 +14028,21 @@ 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
rtf_card_network:
type: string
- description: |
- Card network of the statement if the statement has atleast one card enrolled in RTF.
+ description: >
+ Card network of the statement if the statement has atleast one card
+ enrolled in RTF.
example: VISA
nullable: true
missing_corporate_card_details:
@@ -13340,8 +14194,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
@@ -13350,13 +14205,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
@@ -13396,8 +14254,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:
@@ -13429,8 +14288,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:
@@ -13440,9 +14300,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
@@ -13474,8 +14337,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:
@@ -13512,8 +14376,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
@@ -13553,8 +14418,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'
@@ -13686,16 +14552,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:
@@ -13707,9 +14579,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
@@ -13802,18 +14676,21 @@ components:
properties:
missing_amount:
type: boolean
- description: |
- If this is set to true, then you need to send amount field with expense object.
+ description: >
+ If this is set to true, then you need to send amount 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
@@ -13846,16 +14723,20 @@ components:
example:
- txwoirwlwwg
- txwlgwkgw42
- description: |
- List of expense IDs that needs to be dismissed as a duplicate from the target expense
+ description: >
+ List of expense IDs that needs to be dismissed as a duplicate from
+ the target expense
expenses_duplicate_sets_stats_in:
properties:
query_params:
nullable: false
type: string
- description: |
- This field contains the query param string similar to the query params passed in GET call. Currently we don't
- process this field, this is added for future use cases. Currently empty string value should be passed.
+ description: >
+ This field contains the query param string similar to the query
+ params passed in GET call. Currently we don't
+
+ process this field, this is added for future use cases. Currently
+ empty string value should be passed.
example: ''
expenses_duplicate_sets_stats_out:
type: object
@@ -13863,8 +14744,10 @@ components:
count:
type: integer
nullable: false
- description: |
- This field represents the total number of expense duplicate sets that match the criteria specified in the query_params within the body of the request.
+ description: >
+ This field represents the total number of expense duplicate sets
+ that match the criteria specified in the query_params within the
+ body of the request.
example: 45
any_type:
anyOf:
@@ -14113,8 +14996,9 @@ components:
admin_amount:
type: number
nullable: false
- description: |
- The expense amount which is added or modified by admin or approver.
+ description: >
+ The expense amount which is added or modified by admin or
+ approver.
example: 1900
admin_split_expense_in:
type: object
@@ -14137,12 +15021,21 @@ components:
The expense amount which is added or modified by admin or approver.
example: 1900
splits:
- description: |
- This array contains the number of split expenses admin wants to create for the expense.
- The `admin_amount` provided for the original expense should be equal to the sum of
- `admin_amount` provided for each split. Each attribute in the splits array will take precedence
- to the original expense object. If any attribute is not provided in the split object, then
- null or default value will be taken for that attribute in the resultant split.
+ description: >
+ This array contains the number of split expenses admin wants to
+ create for the expense.
+
+ The `admin_amount` provided for the original expense should be equal
+ to the sum of
+
+ `admin_amount` provided for each split. Each attribute in the splits
+ array will take precedence
+
+ to the original expense object. If any attribute is not provided in
+ the split object, then
+
+ null or default value will be taken for that attribute in the
+ resultant split.
allOf:
- $ref: '#/components/schemas/admin_expense_split_object'
expense_check_policies_individual_desired_states:
@@ -14153,8 +15046,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
@@ -14172,21 +15066,36 @@ components:
- VIOLATED_ACTION_SUCCESS
- VIOLATED_ACTION_FAILURE
- UNVIOLATED
- description: |
- This represents the status of policy computation for the input expense object against the policy represented by `expense_policy_rule_id`.
- If the state is `UNVIOLATED`, it means that the expense is not violating this policy. If the state is `VIOLATION_ACTION_SUCCESS`,
- it means that the expense is violating this policy and action stated in the object will be applied to the expense when it is saved.
- However, if the state is `VIOLATION_ACTION_FAILURE`, it means that this policy is violated for the expense but since some approver was
- missing or not set up properly, it will fail to take action on the expense when it is saved.
+ description: >
+ This represents the status of policy computation for the input
+ expense object against the policy represented by
+ `expense_policy_rule_id`.
+
+ If the state is `UNVIOLATED`, it means that the expense is not
+ violating this policy. If the state is `VIOLATION_ACTION_SUCCESS`,
+
+ it means that the expense is violating this policy and action stated
+ in the object will be applied to the expense when it is saved.
+
+ However, if the state is `VIOLATION_ACTION_FAILURE`, it means that
+ this policy is violated for the expense but since some approver was
+
+ missing or not set up properly, it will fail to take action on the
+ expense when it is saved.
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
- missing approvers. For example, Department approver, Project head, etc.
+ 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 approver, Project head,
+ etc.
example:
- flag the expense
- cap the amount
@@ -14206,8 +15115,9 @@ components:
properties:
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
@@ -14219,23 +15129,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
@@ -14250,8 +15164,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
@@ -14262,7 +15177,8 @@ components:
individual_desired_states:
type: array
items:
- $ref: '#/components/schemas/expense_check_policies_individual_desired_states'
+ $ref: >-
+ #/components/schemas/expense_check_policies_individual_desired_states
final_desired_state:
$ref: '#/components/schemas/expense_check_policies_final_desired_state'
parameters:
@@ -14276,8 +15192,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
@@ -14286,16 +15203,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
@@ -14341,9 +15260,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
@@ -14363,7 +15286,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
@@ -14374,13 +15299,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
@@ -14388,8 +15317,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
@@ -14459,8 +15390,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.
@@ -14477,14 +15409,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
@@ -14538,11 +15473,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.
- name: Feature Configs
description: |
These APIs gives you access to manage feature configs.
@@ -14553,8 +15490,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
@@ -14698,8 +15638,9 @@ paths:
tags:
- Projects
summary: Deletes projects
- description: |
- Deletes unused projects. If any of the project in input is used in other resources then validation error is raised.
+ description: >
+ Deletes unused projects. If any of the project in input is used in other
+ resources then validation error is raised.
operationId: projects_delete_bulk_post
requestBody:
required: true
@@ -14732,8 +15673,10 @@ paths:
message:
type: string
nullable: true
- example: |
- Can not delete project(s) used in other resources like expense, expense policy, expense rules, budgets, dependent fields.
+ example: >
+ Can not delete project(s) used in other resources like
+ expense, expense policy, expense rules, budgets, dependent
+ fields.
data:
type: object
example: null
@@ -14757,8 +15700,10 @@ paths:
tags:
- Projects
summary: Create delete summary for projects
- description: |
- Delete summary tells that how many projects could be deleted from given projects, it also
+ description: >
+ Delete summary tells that how many projects could be deleted from given
+ projects, it also
+
returns projects that could be deleted.
operationId: projects_delete_summary_bulk_post
requestBody:
@@ -14800,8 +15745,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
@@ -14952,8 +15900,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
@@ -15097,8 +16048,10 @@ paths:
tags:
- Categories
summary: Deletes categories
- description: |
- Deletes unused categories. If any of the category in input is used in other resources or it is a mileage/per diem
+ description: >
+ Deletes unused categories. If any of the category in input is used in
+ other resources or it is a mileage/per diem
+
category then validation error is raised.
operationId: categories_delete_bulk_post
requestBody:
@@ -15132,8 +16085,10 @@ paths:
message:
type: string
nullable: true
- example: |
- Can not delete per diem and mileage categorie(s) or categorie(s) used in other resources like expense, expense policy, expense rules, budgets.
+ example: >
+ Can not delete per diem and mileage categorie(s) or
+ categorie(s) used in other resources like expense, expense
+ policy, expense rules, budgets.
data:
type: object
example: null
@@ -15157,8 +16112,10 @@ paths:
tags:
- Categories
summary: Create delete summary for categories
- description: |
- Delete summary tells that how many categories could be deleted from given categories, it also
+ description: >
+ Delete summary tells that how many categories could be deleted from
+ given categories, it also
+
returns categories that could be deleted.
operationId: categories_delete_summary_bulk_post
requestBody:
@@ -15200,8 +16157,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
@@ -15235,8 +16193,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
@@ -15323,13 +16284,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
@@ -15450,13 +16415,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
@@ -15495,7 +16464,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:
@@ -15514,8 +16484,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
@@ -15531,7 +16504,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:
@@ -15548,8 +16522,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
@@ -15559,7 +16534,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:
@@ -15571,7 +16547,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:
@@ -15602,8 +16579,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
@@ -15619,7 +16599,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:
@@ -15635,9 +16616,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
@@ -15647,7 +16631,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:
@@ -15659,7 +16644,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:
@@ -15690,8 +16676,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
@@ -15778,8 +16767,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
@@ -15912,8 +16904,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
@@ -16003,8 +16998,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
@@ -16092,8 +17090,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
@@ -16181,8 +17182,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:
@@ -16220,8 +17224,11 @@ paths:
- Employees
summary: List employees and potential duplicate expenses
operationId: employees_and_potential_duplicate_expenses_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
@@ -16238,7 +17245,8 @@ paths:
data:
type: array
items:
- $ref: '#/components/schemas/employee_out_potential_duplicate_expenses'
+ $ref: >-
+ #/components/schemas/employee_out_potential_duplicate_expenses
'400':
description: Bad request
content:
@@ -16257,8 +17265,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'
@@ -16280,8 +17289,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:
@@ -16300,8 +17310,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'
@@ -16323,8 +17334,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:
@@ -16343,8 +17355,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'
@@ -16366,8 +17379,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:
@@ -16628,9 +17642,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
@@ -16932,9 +17950,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:
@@ -17240,8 +18261,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':
@@ -17331,8 +18355,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':
@@ -17477,10 +18504,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':
@@ -17911,8 +18943,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':
@@ -18063,8 +19098,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
@@ -18269,8 +19307,11 @@ paths:
- Advances
summary: List advance wallets
operationId: advance_wallets_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
@@ -18364,8 +19405,11 @@ paths:
tags:
- Advances
summary: List advance refunds
- 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_refunds_list
responses:
'200':
@@ -18571,8 +19615,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
@@ -18716,8 +19763,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:
@@ -18816,12 +19866,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':
@@ -19819,8 +20873,9 @@ paths:
tags:
- Reports
summary: Round off report amount
- description: |
- Round off report amount. This API first rounds of expenses and then rounds off the total amount of the report.
+ description: >
+ Round off report amount. This API first rounds of expenses and then
+ rounds off the total amount of the report.
operationId: report_round_off_amount
requestBody:
required: true
@@ -19866,8 +20921,11 @@ paths:
tags:
- Reports
summary: Get Reports Export
- description: |
- Get reports export request details. 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: >
+ Get reports export request details. 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: reports_exports_get
responses:
'200':
@@ -19947,8 +21005,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/q'
@@ -20097,8 +21158,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':
@@ -20118,8 +21180,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:
@@ -20137,8 +21200,10 @@ paths:
tags:
- Corporate Cards
summary: List corporate card masked card numbers
- description: |
- This API just returns all the masked card numbers (last 4 digits) associated with the corporate cards in the org, based on the query parameters.
+ description: >
+ This API just returns all the masked card numbers (last 4 digits)
+ associated with the corporate cards in the org, based on the query
+ parameters.
operationId: corporate_cards_masked_card_numbers_list
parameters:
- $ref: '#/components/parameters/q_integer'
@@ -20161,8 +21226,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:
@@ -20450,8 +21516,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'
@@ -20670,7 +21739,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
@@ -20681,7 +21751,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:
@@ -20770,8 +21841,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
@@ -20793,7 +21865,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:
@@ -20831,7 +21904,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:
@@ -20860,7 +21934,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:
@@ -20872,7 +21947,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:
@@ -21022,7 +22098,8 @@ paths:
data:
type: array
items:
- $ref: '#/components/schemas/corporate_card_transaction_reassign_in'
+ $ref: >-
+ #/components/schemas/corporate_card_transaction_reassign_in
required:
- data
responses:
@@ -21086,7 +22163,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:
@@ -21139,7 +22217,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:
@@ -21246,7 +22325,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:
@@ -21406,7 +22486,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:
@@ -21512,7 +22593,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:
@@ -21565,7 +22647,8 @@ paths:
type: object
properties:
data:
- $ref: '#/components/schemas/corporate_card_transactions_exports_out'
+ $ref: >-
+ #/components/schemas/corporate_card_transactions_exports_out
'400':
description: Bad request
content:
@@ -21589,8 +22672,11 @@ paths:
tags:
- Virtual Cards
summary: List virtual 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: virtual_cards_list
parameters:
- $ref: '#/components/parameters/created_at'
@@ -21853,8 +22939,11 @@ paths:
- Subscriptions
summary: List Admin Subscriptions
operationId: subscriptions_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
@@ -21895,8 +22984,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
@@ -21981,8 +23073,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
@@ -22078,8 +23173,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
@@ -22162,8 +23260,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
@@ -22192,9 +23293,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'
@@ -22254,9 +23361,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'
@@ -22312,9 +23423,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'
@@ -22370,9 +23485,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'
@@ -22428,9 +23547,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'
@@ -22455,7 +23578,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:
@@ -22486,9 +23610,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'
@@ -22544,9 +23672,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'
@@ -22571,7 +23704,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:
@@ -22601,8 +23735,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':
@@ -22687,8 +23824,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
@@ -22887,8 +24027,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
@@ -22963,8 +24106,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
@@ -22999,14 +24145,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
@@ -23057,14 +24214,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"
@@ -23234,12 +24398,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
@@ -23292,8 +24462,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'
@@ -23334,8 +24507,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
@@ -23387,8 +24561,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'
@@ -23429,8 +24606,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
@@ -23490,8 +24670,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
@@ -23543,8 +24724,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
@@ -23651,8 +24834,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
@@ -23662,7 +24846,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:
@@ -23696,8 +24881,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'
@@ -23713,7 +24899,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:
@@ -23731,8 +24918,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
@@ -23777,8 +24965,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':
@@ -23873,8 +25062,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
@@ -23965,10 +25157,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
@@ -24074,8 +25270,9 @@ paths:
- Expenses
summary: List expense duplicate sets
operationId: expense_duplicate_sets
- description: |
- This API provides the sets of the duplicate expenses for a particular employee.
+ description: >
+ This API provides the sets of the duplicate expenses for a particular
+ employee.
parameters:
- in: query
name: expense_id
@@ -24113,8 +25310,9 @@ paths:
- Expenses
summary: Expense duplicate sets stats
operationId: expense_duplicate_sets_stats
- description: |
- This API returns count of expenses duplicate set present in org across all employees.
+ description: >
+ This API returns count of expenses duplicate set present in org across
+ all employees.
requestBody:
required: true
content:
@@ -24168,8 +25366,11 @@ paths:
- Feature Configs
summary: List feature configs.
operationId: feature_configs_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
@@ -24311,10 +25512,14 @@ paths:
tags:
- Expenses
summary: Check mandatory fields before splitting an expense
- description: |
+ description: >
Before splitting an 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 split object 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 split object
+ documented below.
operationId: expenses_split_check_mandatory_post
requestBody:
required: true
@@ -24366,10 +25571,16 @@ paths:
tags:
- Expenses
summary: Check for policy violations before splitting an expense
- description: |
- Before splitting an [expense object](https://docs.fylehq.com/docs/fyle-platform-docs/7a3407a5ef184-split-an-expense)
- into Fyle, based on the business requirements, you might want to check the resulting
- expenses against the policy rules set up by your organization. You can easily do that by passing the same split expense object
+ description: >
+ Before splitting an [expense
+ object](https://docs.fylehq.com/docs/fyle-platform-docs/7a3407a5ef184-split-an-expense)
+
+ into Fyle, based on the business requirements, you might want to check
+ the resulting
+
+ expenses against the policy rules set up by your organization. You can
+ easily do that by passing the same split expense object
+
to this API.
operationId: expenses_split_check_policies_post
requestBody:
diff --git a/reference/approver.yaml b/reference/approver.yaml
index 16a965aa9..7725d1cfb 100644
--- a/reference/approver.yaml
+++ b/reference/approver.yaml
@@ -2,8 +2,9 @@ openapi: 3.0.3
info:
version: '1.0'
title: Approver APIs
- description: |
- These APIs are generally used by applications that want to enable approval of reports.
+ description: >
+ These APIs are generally used by applications that want to enable approval
+ of reports.
contact:
name: Platform Beta
email: support@fylehq.com
@@ -38,8 +39,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
@@ -48,8 +51,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:
@@ -57,19 +61,25 @@ 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.
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_string:
@@ -87,22 +97,26 @@ 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'
email:
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
@@ -116,13 +130,15 @@ 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
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})
amount:
@@ -151,8 +167,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
user_id:
@@ -164,8 +182,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
@@ -176,14 +195,16 @@ components:
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
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
department_out_embed:
type: object
@@ -205,8 +226,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.
level_out_embed:
type: object
additionalProperties: false
@@ -222,8 +245,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
@@ -231,20 +255,24 @@ components:
- band
has_accepted_invite:
type: boolean
- description: |
- This boolean field represents whether the employee has accepted the current org's invite by verifying his/her email or not.
+ description: >
+ This boolean field represents whether the employee has accepted the
+ current org's invite by verifying his/her email or not.
example: true
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.
example: true
phone_number:
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}$/
null_field:
type: string
@@ -253,15 +281,19 @@ components:
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'
joined_at:
anyOf:
- $ref: '#/components/schemas/null_field'
- $ref: '#/components/schemas/timestamptz_utc'
nullable: true
- description: |
- Date and time when the user joined the organization. Date-time will be in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >
+ Date and time when the user joined the organization. Date-time will be
+ in [ISO8601
+ format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
employee_out_embed_for_report:
type: object
additionalProperties: false
@@ -277,9 +309,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:
@@ -352,8 +387,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
report_comments_out_embed:
type: object
@@ -472,8 +508,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
@@ -486,8 +523,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
@@ -616,8 +654,9 @@ 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` state.
+ description: >
+ Indicates purpose of the reports. It can only be updated for an
+ existing report when the report is in `APPROVER_PENDING` state.
example: '#1: Jun 2020'
add_approver_in:
type: object
@@ -696,8 +735,9 @@ components:
example: Amount is incorrect
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
reports_export_config_column_formula:
type: object
@@ -721,8 +761,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.
reports_export_config:
type: object
additionalProperties: true
@@ -738,21 +781,24 @@ components:
example: csv
include_receipts:
type: boolean
- description: |
- Whether to include receipts in the export file or not. Only required for PDF exports.
+ description: >
+ Whether to include receipts in the export file or not. Only required
+ for PDF exports.
example: true
is_header_visible:
type: boolean
- description: |
- Whether to show the header in the export file. Only required for CSV and XLSX exports.
+ description: >
+ Whether to show the header in the export file. Only required for CSV
+ and XLSX exports.
example: true
separate_line_items_entry:
type: object
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
@@ -770,8 +816,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. Only required for CSV and XLSX exports.
+ description: >
+ Configure how to show the double rows for each line item in the
+ export file, if enabled. Only required for CSV and XLSX exports.
columns:
type: array
items:
@@ -787,8 +834,9 @@ components:
- $ref: '#/components/schemas/reports_export_config_column_formula'
description: |
Formula to transform the data in the column.
- description: |
- Configure the columns to show in the export file. Only required for CSV and XLSX exports.
+ description: >
+ Configure the columns to show in the export file. Only required for
+ CSV and XLSX exports.
reports_exports_out:
type: object
additionalProperties: false
@@ -863,14 +911,16 @@ components:
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
@@ -927,8 +977,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.
project_out_embed:
type: object
nullable: true
@@ -952,9 +1004,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.
fk_string:
type: string
nullable: true
@@ -1094,12 +1149,18 @@ components:
$ref: '#/components/schemas/expense_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:
@@ -1211,8 +1272,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:
@@ -1239,8 +1302,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
@@ -1295,9 +1359,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:
@@ -1351,8 +1418,9 @@ components:
Mobile number of the employee
joined_at:
$ref: '#/components/schemas/joined_at'
- description: |
- NOTE: The data of this field is not realtime. It will get updated later even if `employee_id` is already up-to-date.
+ description: >
+ NOTE: The data of this field is not realtime. It will get updated later
+ even if `employee_id` is already up-to-date.
card_number:
type: string
description: |
@@ -1368,14 +1436,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'
spent_at:
allOf:
@@ -1486,22 +1557,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
@@ -1524,15 +1601,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
@@ -1631,8 +1711,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'
@@ -1686,24 +1767,29 @@ components:
example: 5
policy_checks:
type: object
- description: |
+ description: >
Policy checks details.
- NOTE: The data of this field is not realtime. It will get updated later even if rest of fields are already up-to-date.
+
+ NOTE: The data of this field is not realtime. It will get updated later
+ even if rest of fields are already up-to-date.
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
@@ -1755,8 +1841,9 @@ components:
commute_details:
type: object
nullable: true
- description: |
- Commute details of the employee. This is used to deduct daily commute from the employee's mileage expenses.
+ description: >
+ Commute details of the employee. This is used to deduct daily commute
+ from the employee's mileage expenses.
properties:
id:
allOf:
@@ -1894,32 +1981,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:
@@ -2043,17 +2144,21 @@ components:
per_diem_num_days:
type: number
nullable: true
- description: |
- Specific to per diem related expenses, number of days for which per diem claim is made.
+ description: >
+ Specific to per diem related expenses, number of days for 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
@@ -2068,9 +2173,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
@@ -2084,8 +2193,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:
@@ -2140,18 +2251,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:
@@ -2188,17 +2303,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'
@@ -2216,12 +2336,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
@@ -2235,15 +2359,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
@@ -2264,18 +2390,22 @@ components:
$ref: '#/components/schemas/tax_group'
approver_comments:
type: array
- description: |
+ description: >
Comments added by approvers.
- NOTE: The data of this field is not realtime. It will get updated later even if rest of fields are already up-to-date.
+
+ NOTE: The data of this field is not realtime. It will get updated
+ later even if rest of fields are already up-to-date.
items:
type: string
example:
- This is a comment by approver
verifier_comments:
type: array
- description: |
+ description: >
Comments added by verifiers.
- NOTE: The data of this field is not realtime. It will get updated later even if rest of fields are already up-to-date.
+
+ NOTE: The data of this field is not realtime. It will get updated
+ later even if rest of fields are already up-to-date.
items:
type: string
example:
@@ -2350,8 +2480,9 @@ components:
commute_details_id:
type: integer
nullable: true
- description: |
- Commute details id of the expense. This id is provided by Fyle to identify a commute details.
+ description: >
+ Commute details id of the expense. This id is provided by Fyle to
+ identify a commute details.
example: 1234
commute_details:
$ref: '#/components/schemas/commute_details'
@@ -2384,9 +2515,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
@@ -2397,9 +2530,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
@@ -2544,8 +2680,10 @@ components:
mileage_rate_id:
allOf:
- $ref: '#/components/schemas/fk_integer'
- description: |
- Specific to mileage expense. This represents the Mileage's rate id given by Fyle
+ description: >
+ Specific to mileage expense. This represents the Mileage's rate id
+ given by Fyle
+
during creation of mileage rate for which this expense is created.
nullable: true
example: 9080
@@ -2553,11 +2691,20 @@ components:
type: boolean
nullable: true
description: Flag stating whether this was a round trip or not.
+ mileage_calculated_distance:
+ type: number
+ nullable: true
+ description: Distance computed by Fyle in mileage expenses.
+ mileage_calculated_amount:
+ type: number
+ nullable: true
+ description: Amount computed by Fyle in mileage expenses.
commute_details_id:
type: integer
nullable: true
- description: |
- Commute details id of the expense. This id is provided by Fyle to identify a commute details.
+ description: >
+ Commute details id of the expense. This id is provided by Fyle to
+ identify a commute details.
example: 1234
commute_deduction:
type: string
@@ -2630,10 +2777,15 @@ components:
example: code.eq.'E0101'
sub_feature:
type: string
- description: |
- This field can be used to setup a collection of filters. For example, if you have multiple filters
- for a single page, this can be used as an identifier to fetch all the filters for that page.
- **Note: Only combination of alphabets, numbers and _(underscore) is allowed**
+ description: >
+ This field can be used to setup a collection of filters. For example, if
+ you have multiple filters
+
+ for a single page, this can be used as an identifier to fetch all the
+ filters for that page.
+
+ **Note: Only combination of alphabets, numbers and _(underscore) is
+ allowed**
nullable: true
example: flagged_expenses
report_filters_out:
@@ -2689,8 +2841,9 @@ components:
properties:
query_params:
type: string
- description: |
- Query param string similar to reports GET call. Use group_by_state=eq.true to get state-wise grouping of stats.
+ description: >
+ Query param string similar to reports GET call. Use
+ group_by_state=eq.true to get state-wise grouping of stats.
nullable: false
example: id=in.('rp123','rep1234')&group_by_state=eq.true
reports_stats_out:
@@ -2734,31 +2887,43 @@ components:
failed_amount:
type: number
nullable: true
- description: Sum of reimbursable amount for ACH-failed reports, applicable only in PAYMENT_PROCESSING state.
+ description: >-
+ Sum of reimbursable amount for ACH-failed reports, applicable
+ only in PAYMENT_PROCESSING state.
example: 200
failed_count:
type: integer
nullable: true
- description: Count of ACH-failed reports, applicable only in PAYMENT_PROCESSING state.
+ description: >-
+ Count of ACH-failed reports, applicable only in
+ PAYMENT_PROCESSING state.
example: 1
processing_amount:
type: number
nullable: true
- description: Sum of reimbursable amount for processing reports, applicable only in PAYMENT_PROCESSING state.
+ description: >-
+ Sum of reimbursable amount for processing reports, applicable
+ only in PAYMENT_PROCESSING state.
example: 1500
processing_count:
type: integer
nullable: true
- description: Count of processing reports, applicable only in PAYMENT_PROCESSING state.
+ description: >-
+ Count of processing reports, applicable only in
+ PAYMENT_PROCESSING state.
example: 3
reimbursable_amount:
type: number
nullable: false
- description: Sum of reimbursable amounts for matching reports in this state.
+ description: >-
+ Sum of reimbursable amounts for matching reports in this
+ state.
example: 500
- type: object
title: Overall stats
- description: Overall stats without state grouping (response for older mobile app versions).
+ description: >-
+ Overall stats without state grouping (response for older mobile app
+ versions).
required:
- count
- total_amount
@@ -2790,7 +2955,9 @@ components:
failed_amount:
type: number
nullable: true
- description: Sum of reimbursable amounts for reports in processing state with ACH failures.
+ description: >-
+ Sum of reimbursable amounts for reports in processing state with
+ ACH failures.
example: 101
failed_count:
type: integer
@@ -3087,9 +3254,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'
@@ -3142,8 +3312,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
@@ -3160,8 +3332,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'
approver_cost_center_out:
@@ -3268,17 +3441,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
@@ -3315,10 +3493,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
@@ -3340,8 +3523,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
@@ -3352,22 +3536,37 @@ 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
- missing approvers. For example, Department approver, Project head, etc.
+ 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 approver, Project head,
+ etc.
example:
- flag the expense
- cap the amount
@@ -3404,8 +3603,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
@@ -3417,23 +3617,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
@@ -3448,8 +3652,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
@@ -3480,16 +3685,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:
@@ -3501,9 +3712,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
@@ -3596,18 +3809,21 @@ components:
properties:
missing_amount:
type: boolean
- description: |
- If this is set to true, then you need to send amount field with expense object.
+ description: >
+ If this is set to true, then you need to send amount 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
@@ -3640,8 +3856,9 @@ components:
example:
- txwoirwlwwg
- txwlgwkgw42
- description: |
- List of expense IDs that needs to be dismissed as a duplicate from the target expense
+ description: >
+ List of expense IDs that needs to be dismissed as a duplicate from
+ the target expense
expense_duplicate_sets_out:
type: object
additionalProperties: false
@@ -3661,8 +3878,9 @@ components:
query_params:
nullable: false
type: string
- description: |
- Query param string similar to expenses GET call. Use group_by_state=eq.true to get state-wise grouping of stats.
+ description: >
+ Query param string similar to expenses GET call. Use
+ group_by_state=eq.true to get state-wise grouping of stats.
example: id=in.('tx1263', 'tx1569')&group_by_state=eq.true
expenses_stats_out:
oneOf:
@@ -3807,8 +4025,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
@@ -3831,8 +4052,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
@@ -3850,8 +4072,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:
@@ -4071,8 +4294,9 @@ components:
admin_amount:
type: number
nullable: false
- description: |
- The expense amount which is added or modified by admin or approver.
+ description: >
+ The expense amount which is added or modified by admin or
+ approver.
example: 1900
admin_split_expense_in:
type: object
@@ -4095,12 +4319,21 @@ components:
The expense amount which is added or modified by admin or approver.
example: 1900
splits:
- description: |
- This array contains the number of split expenses admin wants to create for the expense.
- The `admin_amount` provided for the original expense should be equal to the sum of
- `admin_amount` provided for each split. Each attribute in the splits array will take precedence
- to the original expense object. If any attribute is not provided in the split object, then
- null or default value will be taken for that attribute in the resultant split.
+ description: >
+ This array contains the number of split expenses admin wants to
+ create for the expense.
+
+ The `admin_amount` provided for the original expense should be equal
+ to the sum of
+
+ `admin_amount` provided for each split. Each attribute in the splits
+ array will take precedence
+
+ to the original expense object. If any attribute is not provided in
+ the split object, then
+
+ null or default value will be taken for that attribute in the
+ resultant split.
allOf:
- $ref: '#/components/schemas/admin_expense_split_object'
expense_check_policies_individual_desired_states:
@@ -4111,8 +4344,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
@@ -4130,21 +4364,36 @@ components:
- VIOLATED_ACTION_SUCCESS
- VIOLATED_ACTION_FAILURE
- UNVIOLATED
- description: |
- This represents the status of policy computation for the input expense object against the policy represented by `expense_policy_rule_id`.
- If the state is `UNVIOLATED`, it means that the expense is not violating this policy. If the state is `VIOLATION_ACTION_SUCCESS`,
- it means that the expense is violating this policy and action stated in the object will be applied to the expense when it is saved.
- However, if the state is `VIOLATION_ACTION_FAILURE`, it means that this policy is violated for the expense but since some approver was
- missing or not set up properly, it will fail to take action on the expense when it is saved.
+ description: >
+ This represents the status of policy computation for the input
+ expense object against the policy represented by
+ `expense_policy_rule_id`.
+
+ If the state is `UNVIOLATED`, it means that the expense is not
+ violating this policy. If the state is `VIOLATION_ACTION_SUCCESS`,
+
+ it means that the expense is violating this policy and action stated
+ in the object will be applied to the expense when it is saved.
+
+ However, if the state is `VIOLATION_ACTION_FAILURE`, it means that
+ this policy is violated for the expense but since some approver was
+
+ missing or not set up properly, it will fail to take action on the
+ expense when it is saved.
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
- missing approvers. For example, Department approver, Project head, etc.
+ 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 approver, Project head,
+ etc.
example:
- flag the expense
- cap the amount
@@ -4164,8 +4413,9 @@ components:
properties:
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
@@ -4177,23 +4427,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
@@ -4208,8 +4462,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
@@ -4220,7 +4475,8 @@ components:
individual_desired_states:
type: array
items:
- $ref: '#/components/schemas/expense_check_policies_individual_desired_states'
+ $ref: >-
+ #/components/schemas/expense_check_policies_individual_desired_states
final_desired_state:
$ref: '#/components/schemas/expense_check_policies_final_desired_state'
file_in:
@@ -4241,8 +4497,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
@@ -4289,8 +4546,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
@@ -4343,8 +4601,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
@@ -4387,8 +4646,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)
responses:
'200':
description: OK
@@ -4689,8 +4951,11 @@ paths:
tags:
- Reports
summary: Get Reports Export
- description: |
- Get reports export request details. 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: >
+ Get reports export request details. 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: reports_exports_get
responses:
'200':
@@ -4770,10 +5035,14 @@ paths:
tags:
- Expenses
summary: List expenses
- description: |
+ description: >
This API gets expenses assigned to you to approve.
- 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':
@@ -4807,8 +5076,10 @@ paths:
tags:
- Expenses
summary: Update an expense
- description: |
- Approver can update an expense already reported by an employee. Please note that the expense in `APPROVER_PENDING` or `APPROVED` state for the approver to be able to update it.
+ description: >
+ Approver can update an expense already reported by an employee. Please
+ note that the expense in `APPROVER_PENDING` or `APPROVED` state for the
+ approver to be able to update it.
operationId: expenses_post
requestBody:
required: true
@@ -4924,7 +5195,8 @@ 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:
$ref: '#/components/schemas/reason'
responses:
@@ -4961,8 +5233,9 @@ paths:
tags:
- Reports
summary: Create Report saved filters
- description: |
- Save report filters for personal use or share them among other approvers.
+ description: >
+ Save report filters for personal use or share them among other
+ approvers.
operationId: report_filters_post
requestBody:
required: true
@@ -5255,8 +5528,9 @@ paths:
tags:
- Reports
summary: Round off report amount
- description: |
- Round off report amount. This API first rounds of expenses and then rounds off the total amount of the report.
+ description: >
+ Round off report amount. This API first rounds of expenses and then
+ rounds off the total amount of the report.
operationId: report_round_off_amount
requestBody:
required: true
@@ -5368,8 +5642,11 @@ paths:
- Subscriptions
summary: List Approver Subscriptions
operationId: subscriptions_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
@@ -5410,8 +5687,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
@@ -5446,8 +5726,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
@@ -5482,8 +5765,11 @@ paths:
- Cost Centers
summary: List cost centers
operationId: cost_centers_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
@@ -5518,8 +5804,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
@@ -5554,8 +5843,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
@@ -5595,12 +5887,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
@@ -5653,10 +5951,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
@@ -5762,8 +6064,9 @@ paths:
- Expenses
summary: List expense duplicate sets
operationId: expense_duplicate_sets
- description: |
- This API provides the sets of the duplicate expenses for a particular employee.
+ description: >
+ This API provides the sets of the duplicate expenses for a particular
+ employee.
parameters:
- in: query
name: expense_id
@@ -6038,8 +6341,9 @@ paths:
tags:
- Expenses
summary: Split an expense
- description: |
- Approver can split an expense reported by spender which is not yet paid out.
+ description: >
+ Approver can split an expense reported by spender which is not yet paid
+ out.
operationId: expenses_split_post
requestBody:
required: true
@@ -6091,10 +6395,15 @@ paths:
tags:
- Expenses
summary: Check for policy violations before splitting an expense
- description: |
+ description: >
Before splitting an expense object
- into Fyle, based on the business requirements, you might want to check the resulting
- expenses against the policy rules set up by your organization. You can easily do that by passing the same split expense object
+
+ into Fyle, based on the business requirements, you might want to check
+ the resulting
+
+ expenses against the policy rules set up by your organization. You can
+ easily do that by passing the same split expense object
+
to this API.
operationId: expenses_split_check_policies_post
requestBody:
@@ -6147,10 +6456,14 @@ paths:
tags:
- Expenses
summary: Check mandatory fields before splitting an expense
- description: |
+ description: >
Before splitting an 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 split object 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 split object
+ documented below.
operationId: expenses_split_check_mandatory_post
requestBody:
required: true
@@ -6274,9 +6587,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:
diff --git a/reference/spender.yaml b/reference/spender.yaml
index 4f4fdf8a0..70f43c12d 100644
--- a/reference/spender.yaml
+++ b/reference/spender.yaml
@@ -6,8 +6,9 @@ info:
contact:
name: Platform Beta
email: support@fylehq.com
- description: |
- These APIs are used by applications that operate on the Spender's behalf. Very commonly, it is to enable creation of expenses and reports.
+ description: >
+ These APIs are used by applications that operate on the Spender's behalf.
+ Very commonly, it is to enable creation of expenses and reports.
servers:
- url: https://us1.fylehq.com/platform/v1
description: US Region Server
@@ -39,8 +40,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
@@ -49,8 +52,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:
@@ -58,19 +62,25 @@ 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.
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:
@@ -87,21 +97,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
@@ -112,8 +125,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.
example: true
project_out:
type: object
@@ -143,9 +157,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'
@@ -213,8 +230,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
@@ -231,8 +250,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.
category_ids:
type: array
description: |
@@ -262,8 +282,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
@@ -274,8 +295,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
@@ -310,8 +332,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
@@ -395,8 +419,9 @@ components:
example: uswjwgnwwgo
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})
org_out_embed:
@@ -413,7 +438,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'
@@ -427,9 +454,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
@@ -443,8 +472,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
role:
type: string
@@ -528,8 +558,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
department_head_user_ids:
type: array
@@ -584,8 +615,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
@@ -596,19 +629,23 @@ components:
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'
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
@@ -660,8 +697,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.
project_out_embed:
type: object
nullable: true
@@ -685,9 +724,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.
fk_string:
type: string
nullable: true
@@ -830,12 +872,18 @@ components:
$ref: '#/components/schemas/expense_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"}`
- 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.
+ NOTE: Key name is converted to snake case and spaces are replaced with
+ underscores.
nullable: false
additionalProperties: true
properties:
@@ -970,8 +1018,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:
@@ -998,8 +1048,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
@@ -1017,15 +1068,18 @@ 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
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
@@ -1052,8 +1106,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.
level_out_embed:
type: object
additionalProperties: false
@@ -1069,8 +1125,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
@@ -1102,23 +1159,28 @@ components:
- v2
has_accepted_invite:
type: boolean
- description: |
- This boolean field represents whether the employee has accepted the current org's invite by verifying his/her email or not.
+ description: >
+ This boolean field represents whether the employee has accepted the
+ current org's invite by verifying his/her email or not.
example: true
phone_number:
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}$/
joined_at:
anyOf:
- $ref: '#/components/schemas/null_field'
- $ref: '#/components/schemas/timestamptz_utc'
nullable: true
- description: |
- Date and time when the user joined the organization. Date-time will be in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >
+ Date and time when the user joined the organization. Date-time will be
+ in [ISO8601
+ format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
employee_out_embed_for_expense:
type: object
additionalProperties: false
@@ -1135,9 +1197,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:
@@ -1191,8 +1256,9 @@ components:
Mobile number of the employee
joined_at:
$ref: '#/components/schemas/joined_at'
- description: |
- NOTE: The data of this field is not realtime. It will get updated later even if `employee_id` is already up-to-date.
+ description: >
+ NOTE: The data of this field is not realtime. It will get updated later
+ even if `employee_id` is already up-to-date.
card_number:
type: string
description: |
@@ -1208,14 +1274,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'
spent_at:
allOf:
@@ -1326,22 +1395,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
@@ -1364,15 +1439,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
@@ -1471,8 +1549,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'
@@ -1526,24 +1605,29 @@ components:
example: 5
policy_checks:
type: object
- description: |
+ description: >
Policy checks details.
- NOTE: The data of this field is not realtime. It will get updated later even if rest of fields are already up-to-date.
+
+ NOTE: The data of this field is not realtime. It will get updated later
+ even if rest of fields are already up-to-date.
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
@@ -1595,8 +1679,9 @@ components:
commute_details:
type: object
nullable: true
- description: |
- Commute details of the employee. This is used to deduct daily commute from the employee's mileage expenses.
+ description: >
+ Commute details of the employee. This is used to deduct daily commute
+ from the employee's mileage expenses.
properties:
id:
allOf:
@@ -1734,32 +1819,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:
@@ -1883,17 +1982,21 @@ components:
per_diem_num_days:
type: number
nullable: true
- description: |
- Specific to per diem related expenses, number of days for which per diem claim is made.
+ description: >
+ Specific to per diem related expenses, number of days for 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
@@ -1908,9 +2011,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
@@ -1924,8 +2031,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:
@@ -1980,18 +2089,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:
@@ -2028,17 +2141,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'
@@ -2056,12 +2174,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
@@ -2075,15 +2197,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
@@ -2104,18 +2228,22 @@ components:
$ref: '#/components/schemas/tax_group'
approver_comments:
type: array
- description: |
+ description: >
Comments added by approvers.
- NOTE: The data of this field is not realtime. It will get updated later even if rest of fields are already up-to-date.
+
+ NOTE: The data of this field is not realtime. It will get updated
+ later even if rest of fields are already up-to-date.
items:
type: string
example:
- This is a comment by approver
verifier_comments:
type: array
- description: |
+ description: >
Comments added by verifiers.
- NOTE: The data of this field is not realtime. It will get updated later even if rest of fields are already up-to-date.
+
+ NOTE: The data of this field is not realtime. It will get updated
+ later even if rest of fields are already up-to-date.
items:
type: string
example:
@@ -2190,8 +2318,9 @@ components:
commute_details_id:
type: integer
nullable: true
- description: |
- Commute details id of the expense. This id is provided by Fyle to identify a commute details.
+ description: >
+ Commute details id of the expense. This id is provided by Fyle to
+ identify a commute details.
example: 1234
commute_details:
$ref: '#/components/schemas/commute_details'
@@ -2229,9 +2358,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
@@ -2242,9 +2373,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
@@ -2315,9 +2449,11 @@ components:
claim_amount:
allOf:
- $ref: '#/components/schemas/claim_amount'
- description: |
+ description: >
The expense amount as claimed by user.
- For Per Diem Expenses this amount should be equal to per diem rate rounded to two decimal places multiplied by number of days.
+
+ For Per Diem Expenses this amount should be equal to per diem rate
+ rounded to two decimal places multiplied by number of days.
purpose:
type: string
example: Team lunch
@@ -2379,25 +2515,35 @@ components:
- $ref: '#/components/schemas/fk_integer'
nullable: true
example: 583
- description: |
- Specific to per diem expense. This represents the per diem's rate id given by Fyle
- during creation of per diem rate for which this expense is created.
+ description: >
+ Specific to per diem expense. This represents the per diem's rate id
+ given by Fyle
+
+ during creation of per diem rate for which this expense is created.
+
+
This field is required for creating Per Diem Expenses.
per_diem_num_days:
type: number
nullable: true
example: 2
- description: |
- Specific to per diem related expenses, number of days for which per diem claim is made.
+ description: >
+ Specific to per diem related expenses, number of days for which per
+ diem claim is made.
+
This field is required for creating Per Diem Expenses.
report_id:
allOf:
- $ref: '#/components/schemas/fk_string'
nullable: true
- description: |
+ description: >
Unique id given by Fyle to identify an Expense Report.
- Sending this field will add the expense to the report. If the expense is already attached to a report,
- the expense will be removed from the old report and added to the new report if it is not yet approved.
+
+ Sending this field will add the expense to the report. If the
+ expense is already attached to a report,
+
+ the expense will be removed from the old report and added to the new
+ report if it is not yet approved.
example: rpvgnwlgw34
invoice_number:
type: string
@@ -2411,10 +2557,14 @@ components:
items:
allOf:
- $ref: '#/components/schemas/fk_string'
- description: |
+ description: >
List of file ids to attach to the expense.
- To add new files to the expense, send the list of file ids to be attached.
- To remove files from the expense, send the list of all file ids except which you want to remove.
+
+ To add new files to the expense, send the list of file ids to be
+ attached.
+
+ To remove files from the expense, send the list of all file ids
+ except which you want to remove.
hotel_is_breakfast_provided:
type: boolean
nullable: true
@@ -2423,8 +2573,10 @@ components:
mileage_rate_id:
allOf:
- $ref: '#/components/schemas/fk_integer'
- description: |
- Specific to mileage expense. This represents the Mileage's rate id given by Fyle
+ description: >
+ Specific to mileage expense. This represents the Mileage's rate id
+ given by Fyle
+
during creation of mileage rate for which this expense is created.
nullable: true
example: 9080
@@ -2432,11 +2584,20 @@ components:
type: boolean
nullable: true
description: Flag stating whether this was a round trip or not.
+ mileage_calculated_distance:
+ type: number
+ nullable: true
+ description: Distance computed by Fyle in mileage expenses.
+ mileage_calculated_amount:
+ type: number
+ nullable: true
+ description: Amount computed by Fyle in mileage expenses.
commute_details_id:
type: integer
nullable: true
- description: |
- Commute details id of the expense. This id is provided by Fyle to identify a commute details.
+ description: >
+ Commute details id of the expense. This id is provided by Fyle to
+ identify a commute details.
example: 1234
commute_deduction:
type: string
@@ -2648,9 +2809,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:
@@ -2723,8 +2887,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
report_comments_out_embed:
type: object
@@ -2843,8 +3008,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
@@ -2857,8 +3023,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
@@ -3173,8 +3340,10 @@ components:
$ref: '#/components/schemas/report_source'
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` , `APPROVER_INQUIRY` or `DRAFT` state.
+ description: >
+ Indicates purpose of the reports. It can only be updated for an
+ existing report when the report is in `APPROVER_PENDING` ,
+ `APPROVER_INQUIRY` or `DRAFT` state.
example: '#1: Jun 2020'
report_delete_in:
type: object
@@ -3252,8 +3421,9 @@ components:
properties:
query_params:
type: string
- description: |
- Query param string similar to reports GET call. Use group_by_state=eq.true to get state-wise grouping of stats.
+ description: >
+ Query param string similar to reports GET call. Use
+ group_by_state=eq.true to get state-wise grouping of stats.
nullable: false
example: id=in.('rp123','rep1234')&group_by_state=eq.true
reports_stats_out:
@@ -3297,31 +3467,43 @@ components:
failed_amount:
type: number
nullable: true
- description: Sum of reimbursable amount for ACH-failed reports, applicable only in PAYMENT_PROCESSING state.
+ description: >-
+ Sum of reimbursable amount for ACH-failed reports, applicable
+ only in PAYMENT_PROCESSING state.
example: 200
failed_count:
type: integer
nullable: true
- description: Count of ACH-failed reports, applicable only in PAYMENT_PROCESSING state.
+ description: >-
+ Count of ACH-failed reports, applicable only in
+ PAYMENT_PROCESSING state.
example: 1
processing_amount:
type: number
nullable: true
- description: Sum of reimbursable amount for processing reports, applicable only in PAYMENT_PROCESSING state.
+ description: >-
+ Sum of reimbursable amount for processing reports, applicable
+ only in PAYMENT_PROCESSING state.
example: 1500
processing_count:
type: integer
nullable: true
- description: Count of processing reports, applicable only in PAYMENT_PROCESSING state.
+ description: >-
+ Count of processing reports, applicable only in
+ PAYMENT_PROCESSING state.
example: 3
reimbursable_amount:
type: number
nullable: false
- description: Sum of reimbursable amounts for matching reports in this state.
+ description: >-
+ Sum of reimbursable amounts for matching reports in this
+ state.
example: 500
- type: object
title: Overall stats
- description: Overall stats without state grouping (response for older mobile app versions).
+ description: >-
+ Overall stats without state grouping (response for older mobile app
+ versions).
required:
- count
- total_amount
@@ -3353,7 +3535,9 @@ components:
failed_amount:
type: number
nullable: true
- description: Sum of reimbursable amounts for reports in processing state with ACH failures.
+ description: >-
+ Sum of reimbursable amounts for reports in processing state with
+ ACH failures.
example: 101
failed_count:
type: integer
@@ -3440,10 +3624,15 @@ components:
example: code.eq.'E0101'
sub_feature:
type: string
- description: |
- This field can be used to setup a collection of filters. For example, if you have multiple filters
- for a single page, this can be used as an identifier to fetch all the filters for that page.
- **Note: Only combination of alphabets, numbers and _(underscore) is allowed**
+ description: >
+ This field can be used to setup a collection of filters. For example, if
+ you have multiple filters
+
+ for a single page, this can be used as an identifier to fetch all the
+ filters for that page.
+
+ **Note: Only combination of alphabets, numbers and _(underscore) is
+ allowed**
nullable: true
example: flagged_expenses
report_filters_out:
@@ -3610,8 +3799,9 @@ components:
example: true
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
reports_export_config_column_formula:
type: object
@@ -3635,8 +3825,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.
reports_export_config:
type: object
additionalProperties: true
@@ -3652,21 +3845,24 @@ components:
example: csv
include_receipts:
type: boolean
- description: |
- Whether to include receipts in the export file or not. Only required for PDF exports.
+ description: >
+ Whether to include receipts in the export file or not. Only required
+ for PDF exports.
example: true
is_header_visible:
type: boolean
- description: |
- Whether to show the header in the export file. Only required for CSV and XLSX exports.
+ description: >
+ Whether to show the header in the export file. Only required for CSV
+ and XLSX exports.
example: true
separate_line_items_entry:
type: object
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
@@ -3684,8 +3880,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. Only required for CSV and XLSX exports.
+ description: >
+ Configure how to show the double rows for each line item in the
+ export file, if enabled. Only required for CSV and XLSX exports.
columns:
type: array
items:
@@ -3701,8 +3898,9 @@ components:
- $ref: '#/components/schemas/reports_export_config_column_formula'
description: |
Formula to transform the data in the column.
- description: |
- Configure the columns to show in the export file. Only required for CSV and XLSX exports.
+ description: >
+ Configure the columns to show in the export file. Only required for
+ CSV and XLSX exports.
reports_exports_out:
type: object
additionalProperties: false
@@ -3834,9 +4032,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:
@@ -3897,10 +4098,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:
@@ -3937,8 +4142,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:
@@ -3971,10 +4177,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:
@@ -3984,8 +4194,9 @@ components:
advance_requests_stats_in:
properties:
query_params:
- description: |
- Query param string similar to advance_requests GET call. Use group_by_state=eq.true to get state-wise grouping of stats.
+ description: >
+ Query param string similar to advance_requests GET call. Use
+ group_by_state=eq.true to get state-wise grouping of stats.
nullable: false
example: id=in.('adr1263','adr1569')&group_by_state=eq.true
advance_requests_stats_out:
@@ -4156,10 +4367,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:
@@ -4181,13 +4396,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:
@@ -4200,8 +4418,10 @@ components:
properties:
query_params:
type: string
- description: |
- This field contains the query param string similar to the query params passed in advances GET call for displaying advances in the list view.
+ description: >
+ This field contains the query param string similar to the query
+ params passed in advances GET call for displaying advances in the
+ list view.
nullable: false
example: id=in.('adv1263', 'adv1569')
advances_stats_out:
@@ -4209,15 +4429,19 @@ components:
properties:
count:
type: integer
- description: |
- This field represents the total number of advances that match the criteria specified in the query_params within the body of the request.
+ description: >
+ This field represents the total number of advances that match the
+ criteria specified in the query_params within the body of the
+ request.
nullable: false
example: 1
total_amount:
allOf:
- $ref: '#/components/schemas/amount'
- description: |
- This field indicates the sum of amount of advances that match the criteria specified in the query_params within the body of the request.
+ description: >
+ This field indicates the sum of amount of advances that match the
+ criteria specified in the query_params within the body of the
+ request.
example: 100
advance_wallet_out:
type: object
@@ -4275,14 +4499,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:
@@ -4354,8 +4581,9 @@ components:
- READY_FOR_VERIFICATION
virtual_card_id:
type: string
- description: |
- The unique id of the virtual card, if the card is created from virtual card.
+ description: >
+ The unique id of the virtual card, if the card is created from
+ virtual card.
nullable: true
example: viasdfasdfddd
virtual_card_state:
@@ -4421,7 +4649,9 @@ components:
- unassigned_transactions_count
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:
@@ -4512,8 +4742,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'
@@ -4553,14 +4784,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:
@@ -4576,8 +4811,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'
@@ -4669,8 +4905,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:
@@ -4702,8 +4939,9 @@ components:
enum:
- POSTED
- PENDING
- description: |
- Holds the status of the Corporate Card Transaction, whether posted or still pending.
+ description: >
+ Holds the status of the Corporate Card Transaction, whether posted
+ or still pending.
description:
type: string
nullable: true
@@ -4713,8 +4951,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
@@ -4738,17 +4977,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:
@@ -4777,8 +5021,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'
@@ -4805,8 +5050,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:
@@ -4836,8 +5082,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'
@@ -4889,8 +5136,10 @@ components:
example: created_at=gt.2024-01-01
corporate_card_transactions_expenses_stats_out:
type: array
- description: |
- Array containing stats objects grouped by corporate card numbers and expense state. Returns an empty array if no
+ description: >
+ Array containing stats objects grouped by corporate card numbers and
+ expense state. Returns an empty array if no
+
transactions are found matching the criteria.
items:
type: object
@@ -4999,8 +5248,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
@@ -5018,23 +5268,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:
@@ -5063,8 +5319,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'
@@ -5092,8 +5349,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:
@@ -5123,8 +5381,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.
metadata:
$ref: '#/components/schemas/corporate_card_transaction_metadata'
required:
@@ -5206,8 +5465,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
@@ -5225,23 +5485,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:
@@ -5270,8 +5536,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'
@@ -5299,8 +5566,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:
@@ -5330,8 +5598,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'
@@ -5414,8 +5683,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
@@ -5439,23 +5709,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:
@@ -5484,8 +5760,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'
@@ -5513,8 +5790,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:
@@ -5544,8 +5822,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'
@@ -5625,8 +5904,9 @@ components:
enum:
- POSTED
- PENDING
- description: |
- Holds the status of the Corporate Card Transaction, whether posted or still pending.
+ description: >
+ Holds the status of the Corporate Card Transaction, whether posted
+ or still pending.
description:
type: string
nullable: true
@@ -5636,8 +5916,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
@@ -5661,23 +5942,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:
@@ -5706,8 +5993,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'
@@ -5735,8 +6023,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:
@@ -5766,8 +6055,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'
@@ -5867,8 +6157,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
@@ -5892,23 +6183,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:
@@ -5937,8 +6234,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'
@@ -5967,8 +6265,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:
@@ -5998,8 +6297,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'
@@ -6095,8 +6395,9 @@ components:
enum:
- POSTED
- PENDING
- description: |
- Holds the status of the Corporate Card Transaction, whether posted or still pending.
+ description: >
+ Holds the status of the Corporate Card Transaction, whether posted
+ or still pending.
description:
type: string
nullable: true
@@ -6106,8 +6407,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
@@ -6131,23 +6433,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:
@@ -6176,8 +6484,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'
@@ -6193,8 +6502,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'
@@ -6211,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:
@@ -6321,8 +6632,9 @@ components:
end_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
- 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
spender_employee_out:
type: object
@@ -6407,8 +6719,9 @@ components:
type: object
nullable: false
additionalProperties: false
- description: |
- Commute details of the employee. This is used to deduct daily commute from the employee's mileage expenses.
+ description: >
+ Commute details of the employee. This is used to deduct daily commute
+ from the employee's mileage expenses.
properties:
home_location:
allOf:
@@ -6503,8 +6816,9 @@ components:
end_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
- 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
spender_delegatees_post_out:
type: object
@@ -6647,14 +6961,16 @@ components:
valid_from_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
- description: |
- Specifies the valid from date of the card, ie from when the card would be active.
+ description: >
+ Specifies the valid from date of the card, ie from when the card
+ would be active.
example: '2022-02-01'
valid_till_at:
allOf:
- $ref: '#/components/schemas/timestamptz_utc'
- description: |
- Specifies the valid till date of the card, ie till when the card would be active.
+ description: >
+ Specifies the valid till date of the card, ie till when the card
+ would be active.
example: '2022-02-01'
creator_user_id:
type: string
@@ -6663,13 +6979,15 @@ components:
example: useradfasd
virtual_card_user_id:
type: string
- description: |
- This id refers to the virtual card user to whom the virtual card is assigned.
+ description: >
+ This id refers to the virtual card user to whom the virtual card is
+ assigned.
example: vcg2Bl78jstf
nick_name:
type: string
- description: |
- Represents user defined nick name associated with the virtual card for easier recognition.
+ description: >
+ Represents user defined nick name associated with the virtual card
+ for easier recognition.
example: john
required:
- id
@@ -6777,8 +7095,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
@@ -6809,8 +7128,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
@@ -6966,24 +7286,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
@@ -6997,15 +7321,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
@@ -7021,9 +7347,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
@@ -7038,9 +7369,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
@@ -7055,22 +7391,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
@@ -7102,26 +7445,31 @@ 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_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:
@@ -7134,21 +7482,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:
@@ -7157,8 +7509,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:
@@ -7175,8 +7528,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
@@ -7220,9 +7574,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'
@@ -7260,70 +7616,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 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 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:
@@ -7332,8 +7708,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'
@@ -7346,17 +7724,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
@@ -7393,10 +7776,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
@@ -7418,8 +7806,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
@@ -7430,22 +7819,37 @@ 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
- missing approvers. For example, Department approver, Project head, etc.
+ 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 approver, Project head,
+ etc.
example:
- flag the expense
- cap the amount
@@ -7482,8 +7886,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
@@ -7495,23 +7900,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
@@ -7526,8 +7935,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
@@ -7553,16 +7963,23 @@ 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 against the policy rules before saving the expense._
+
+ _Note: This field is required when you are updating an already
+ created expense and want to check it again against the policy rules
+ before saving the expense._
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 against the policy rules before saving the expense._
+ 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 against the policy rules before saving the
+ expense._
source:
$ref: '#/components/schemas/source'
merchant:
@@ -7572,14 +7989,18 @@ components:
foreign_amount:
allOf:
- $ref: '#/components/schemas/foreign_amount'
- description: |
- Amount value of the expense, in original currency i.e the currency in which the expense was initially created.
+ description: >
+ Amount value of the expense, in original currency i.e the currency
+ in which the expense was initially created.
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 against the policy rules before saving the expense._
+
+ _Note: This field is mandatory when you are creating an expense and
+ want to check it against the policy rules before saving the
+ expense._
example: 1984.18
purpose:
type: string
@@ -7589,32 +8010,40 @@ components:
cost_center_id:
allOf:
- $ref: '#/components/schemas/fk_integer'
- description: |
- This represents the cost_center's id given by Fyle during creation of cost center
+ description: >
+ This represents the cost_center's id given by Fyle during creation
+ of cost center
+
for which this expense is created.
nullable: true
example: 1049
category_id:
allOf:
- $ref: '#/components/schemas/fk_integer'
- description: |
- This represents the category's id given by Fyle during creation of category
+ description: >
+ This represents the category's id given by Fyle during creation of
+ category
+
for which this expense is created.
nullable: true
example: 49058
project_id:
allOf:
- $ref: '#/components/schemas/fk_integer'
- description: |
- This represents the project's id given by Fyle during creation of project
+ description: >
+ This represents the project's id given by Fyle during creation of
+ project
+
for which this expense is created.
nullable: true
example: 92895
source_account_id:
allOf:
- $ref: '#/components/schemas/fk_string'
- description: |
- This represents the source account's id given by Fyle during creation of account type
+ description: >
+ This represents the source account's id given by Fyle during
+ creation of account type
+
of user for which this expense is created.
example: acwbl222wlg
advance_wallet_id:
@@ -7632,8 +8061,10 @@ components:
tax_group_id:
allOf:
- $ref: '#/components/schemas/fk_string'
- description: |
- This represents the tax's group id given by Fyle during creation of tax group
+ description: >
+ This represents the tax's group id given by Fyle during creation of
+ tax group
+
for which this expense is created.
nullable: true
is_billable:
@@ -7647,13 +8078,15 @@ components:
started_at:
allOf:
- $ref: '#/components/schemas/timestamptz_pst'
- description: |
- Specific to per diem related expenses. Start date from which per diem claim is made.
+ description: >
+ Specific to per diem related expenses. Start date from which per
+ diem claim is made.
ended_at:
allOf:
- $ref: '#/components/schemas/timestamptz_pst'
- description: |
- Specific to per diem related expenses. End date until which per diem claim is made.
+ description: >
+ Specific to per diem related expenses. End date until which per diem
+ claim is made.
travel_classes:
$ref: '#/components/schemas/travel_classes'
locations:
@@ -7674,24 +8107,29 @@ components:
mileage_rate_id:
allOf:
- $ref: '#/components/schemas/fk_integer'
- description: |
- Specific to mileage expense. This represents the Mileage's rate id given by Fyle
+ description: >
+ Specific to mileage expense. This represents the Mileage's rate id
+ given by Fyle
+
during creation of mileage rate for which this expense is created.
nullable: true
example: 9080
per_diem_rate_id:
allOf:
- $ref: '#/components/schemas/fk_integer'
- description: |
- Specific to per diem expense. This represents the per diem's rate id given by Fyle
+ description: >
+ Specific to per diem expense. This represents the per diem's rate id
+ given by Fyle
+
during creation of per diem rate for which this expense is created.
nullable: true
example: 583
per_diem_num_days:
type: number
nullable: true
- description: |
- Specific to per diem related expenses. Number of days for which per diem claim is made.
+ description: >
+ Specific to per diem related expenses. Number of days for which per
+ diem claim is made.
example: 2
invoice_number:
type: string
@@ -7703,11 +8141,15 @@ components:
mileage_calculated_distance:
type: number
nullable: true
- description: Specific to mileage expense. Distance computed by Fyle for mileage expenses.
+ description: >-
+ Specific to mileage expense. Distance computed by Fyle for mileage
+ expenses.
mileage_calculated_amount:
type: number
nullable: true
- description: Specific to mileage expense. Amount computed by Fyle for mileage expenses.
+ description: >-
+ Specific to mileage expense. Amount computed by Fyle for mileage
+ expenses.
expense_check_policies_individual_desired_states:
type: object
properties:
@@ -7716,8 +8158,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
@@ -7735,21 +8178,36 @@ components:
- VIOLATED_ACTION_SUCCESS
- VIOLATED_ACTION_FAILURE
- UNVIOLATED
- description: |
- This represents the status of policy computation for the input expense object against the policy represented by `expense_policy_rule_id`.
- If the state is `UNVIOLATED`, it means that the expense is not violating this policy. If the state is `VIOLATION_ACTION_SUCCESS`,
- it means that the expense is violating this policy and action stated in the object will be applied to the expense when it is saved.
- However, if the state is `VIOLATION_ACTION_FAILURE`, it means that this policy is violated for the expense but since some approver was
- missing or not set up properly, it will fail to take action on the expense when it is saved.
+ description: >
+ This represents the status of policy computation for the input
+ expense object against the policy represented by
+ `expense_policy_rule_id`.
+
+ If the state is `UNVIOLATED`, it means that the expense is not
+ violating this policy. If the state is `VIOLATION_ACTION_SUCCESS`,
+
+ it means that the expense is violating this policy and action stated
+ in the object will be applied to the expense when it is saved.
+
+ However, if the state is `VIOLATION_ACTION_FAILURE`, it means that
+ this policy is violated for the expense but since some approver was
+
+ missing or not set up properly, it will fail to take action on the
+ expense when it is saved.
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
- missing approvers. For example, Department approver, Project head, etc.
+ 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 approver, Project head,
+ etc.
example:
- flag the expense
- cap the amount
@@ -7769,8 +8227,9 @@ components:
properties:
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
@@ -7782,23 +8241,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
@@ -7813,8 +8276,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
@@ -7825,7 +8289,8 @@ components:
individual_desired_states:
type: array
items:
- $ref: '#/components/schemas/expense_check_policies_individual_desired_states'
+ $ref: >-
+ #/components/schemas/expense_check_policies_individual_desired_states
final_desired_state:
$ref: '#/components/schemas/expense_check_policies_final_desired_state'
spender_automate_report_submission_next_at_out:
@@ -7837,7 +8302,10 @@ components:
type: string
format: date-time
nullable: true
- description: Signifies the time when the next automate report submission will run for the organization. Date-time in [ISO8601 format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14).
+ description: >-
+ Signifies the time when the next automate report submission will run
+ for the organization. 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'
spender_expense_check_mandatory_fields_in:
type: object
@@ -7846,16 +8314,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:
@@ -7867,9 +8341,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
@@ -7950,18 +8426,21 @@ components:
properties:
missing_amount:
type: boolean
- description: |
- If this is set to true, then you need to send amount field with expense object.
+ description: >
+ If this is set to true, then you need to send amount 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
@@ -7994,8 +8473,9 @@ components:
example:
- txwoirwlwwg
- txwlgwkgw42
- description: |
- List of expense IDs that needs to be dismissed as a duplicate from the target expense
+ description: >
+ List of expense IDs that needs to be dismissed as a duplicate from
+ the target expense
expense_duplicate_sets_out:
type: object
additionalProperties: false
@@ -8015,8 +8495,9 @@ components:
query_params:
nullable: false
type: string
- description: |
- Query param string similar to expenses GET call. Use group_by_state=eq.true to get state-wise grouping of stats.
+ description: >
+ Query param string similar to expenses GET call. Use
+ group_by_state=eq.true to get state-wise grouping of stats.
example: id=in.('tx1263', 'tx1569')&group_by_state=eq.true
expenses_stats_out:
oneOf:
@@ -8161,8 +8642,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
@@ -8185,8 +8669,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
@@ -8204,8 +8689,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:
@@ -8449,22 +8935,35 @@ components:
The expense amount which is added or modified by spender.
example: 1900
splits:
- description: |
- This array contains the number of split expenses spender wants to create for the expense.
- The `claim_amount` provided for the original expense should be equal to the sum of
- `claim_amount` provided for each split. Each attribute in the splits array will take precedence
- to the original expense object. If any attribute is not provided in the split object, then
- null or default value will be taken for that attribute in the resultant split.
+ description: >
+ This array contains the number of split expenses spender wants to
+ create for the expense.
+
+ The `claim_amount` provided for the original expense should be equal
+ to the sum of
+
+ `claim_amount` provided for each split. Each attribute in the splits
+ array will take precedence
+
+ to the original expense object. If any attribute is not provided in
+ the split object, then
+
+ null or default value will be taken for that attribute in the
+ resultant split.
allOf:
- $ref: '#/components/schemas/spender_expense_split_object'
report_id:
allOf:
- $ref: '#/components/schemas/fk_string'
nullable: true
- description: |
+ description: >
Unique id given by Fyle to identify an Expense Report.
- Sending this field will add the expense to the report. If the expense is already attached to a report,
- the expense will be removed from the old report and added to the new report if it is not yet approved.
+
+ Sending this field will add the expense to the report. If the
+ expense is already attached to a report,
+
+ the expense will be removed from the old report and added to the new
+ report if it is not yet approved.
example: rpvgnwlgw34
any_type:
anyOf:
@@ -8583,8 +9082,9 @@ components:
configName:
type: string
maxLength: 255
- description: |
- Name of the configuration for the action that would be performed while opening the Yodlee Fastlink application
+ description: >
+ Name of the configuration for the action that would be performed
+ while opening the Yodlee Fastlink application
example: Aggregation
flow:
type: string
@@ -8636,8 +9136,10 @@ components:
nullable: false
default: false
example: false
- description: |
- Determines whether the user has changed the credentials and need to reconfirm the credentials when user tried to fetch the card transactions.
+ description: >
+ Determines whether the user has changed the credentials and need to
+ reconfirm the credentials when user tried to fetch the card
+ transactions.
yodlee_is_mfa_required:
type: boolean
nullable: false
@@ -8700,8 +9202,10 @@ components:
nullable: false
default: false
example: false
- description: |
- Determines whether the user has changed the credentials and need to reconfirm the credentials when user tried to fetch the card transactions.
+ description: >
+ Determines whether the user has changed the credentials and need to
+ reconfirm the credentials when user tried to fetch the card
+ transactions.
yodlee_is_mfa_required:
type: boolean
nullable: false
@@ -8839,9 +9343,13 @@ components:
query_params:
nullable: false
type: string
- description: |
- - This field contains the query param string similar to the query params passed in personal card transactions GET call for displaying transactions in the list view.
- - Supported query params: personal_card_id, state, spent_at, created_at, updated_at, foreign_amount, amount, id
+ description: >
+ - This field contains the query param string similar to the query
+ params passed in personal card transactions GET call for displaying
+ transactions in the list view.
+
+ - Supported query params: personal_card_id, state, spent_at,
+ created_at, updated_at, foreign_amount, amount, id
example: personal_card_id=eq.bacctW9DfNhwOt&state=eq.HIDDEN
personal_card_transactions_stats_out:
type: object
@@ -8855,14 +9363,16 @@ components:
debit_amount:
allOf:
- $ref: '#/components/schemas/amount'
- description: |
- This field indicates the sum of amount of the debit type personal card transactions.
+ description: >
+ This field indicates the sum of amount of the debit type personal
+ card transactions.
example: 1239
credit_amount:
allOf:
- $ref: '#/components/schemas/amount'
- description: |
- This field indicates the sum of amount of the credit type personal card transactions.
+ description: >
+ This field indicates the sum of amount of the credit type personal
+ card transactions.
example: 101
parameters:
q:
@@ -8875,16 +9385,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
@@ -8899,8 +9411,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
@@ -8950,8 +9463,9 @@ tags:
description: |
These APIs gives you access to manage your organisation's Employees
- name: Merchants
- description: |
- This API gives you access to merchants, primarily to help with autocomplete.
+ description: >
+ This API gives you access to merchants, primarily to help with
+ autocomplete.
- name: Mileage Rates
description: |
These APIs gives access to your organisation's Mileage Rates
@@ -8987,8 +9501,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
@@ -9023,8 +9540,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
@@ -9065,8 +9585,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
@@ -9101,8 +9624,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
@@ -9137,13 +9663,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
@@ -9211,8 +9741,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
@@ -9275,8 +9808,11 @@ paths:
- Accounts
summary: List accounts
operationId: accounts_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
@@ -9312,8 +9848,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
@@ -9349,8 +9888,11 @@ paths:
- Expenses
summary: List expenses
operationId: expenses_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:
@@ -9367,11 +9909,17 @@ paths:
type: integer
example: 10000
offset:
- description: |
- offset is used to skip that many number of objects before counting.
+ 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 1000 to return first 1000 objects.
- The second request will have offset as 1000 and limit as 1000 to return next 1000 objects.
+
+ The first request will have offset as 0 and limit as 1000
+ to return first 1000 objects.
+
+ The second request will have offset as 1000 and limit as
+ 1000 to return next 1000 objects.
type: integer
example: 10
data:
@@ -9394,8 +9942,10 @@ paths:
tags:
- Expenses
summary: Create or update expense
- description: |
- Create or update an expense.
To create/edit per diem expenses, please send category id of per diem category, along with some required additional fields mentioned below
+ description: >
+ Create or update an expense.
To create/edit per diem expenses,
+ please send category id of per diem category, along with some required
+ additional fields mentioned below
operationId: expenses_post
requestBody:
required: true
@@ -9711,8 +10261,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
@@ -9848,8 +10401,11 @@ paths:
- Subscriptions
summary: List Spender Subscriptions
operationId: subscriptions_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
@@ -9944,8 +10500,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
@@ -10184,7 +10743,8 @@ 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:
$ref: '#/components/schemas/reason'
responses:
@@ -10659,8 +11219,11 @@ paths:
tags:
- Reports
summary: Get Reports Export
- description: |
- Get reports export request details. 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: >
+ Get reports export request details. 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: reports_exports_get
responses:
'200':
@@ -10741,8 +11304,11 @@ paths:
- Advances
summary: List advance requests
operationId: advance_requests_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
@@ -10892,8 +11458,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
@@ -10989,8 +11558,11 @@ paths:
- Advances
summary: List advance wallets
operationId: advance_wallets_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
@@ -11031,8 +11603,11 @@ paths:
- Corporate Cards
summary: List of corporate cards assigned to user
operationId: corporate_cards_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
@@ -11067,8 +11642,11 @@ paths:
- Corporate Card Transactions
summary: List corporate card transactions
operationId: corporate_card_transactions_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
@@ -11102,8 +11680,9 @@ paths:
tags:
- Corporate Card Transactions
summary: Get corporate card transactions expenses stats
- description: |
- Get stats of corporate card transaction expenses grouped by card number and expense state.
+ description: >
+ Get stats of corporate card transaction expenses grouped by card number
+ and expense state.
operationId: corporate_card_transactions_expenses_stats
requestBody:
required: true
@@ -11116,7 +11695,8 @@ paths:
- data
properties:
data:
- $ref: '#/components/schemas/corporate_card_transactions_expenses_stats_in'
+ $ref: >-
+ #/components/schemas/corporate_card_transactions_expenses_stats_in
responses:
'200':
description: OK
@@ -11127,7 +11707,8 @@ paths:
additionalProperties: false
properties:
data:
- $ref: '#/components/schemas/corporate_card_transactions_expenses_stats_out'
+ $ref: >-
+ #/components/schemas/corporate_card_transactions_expenses_stats_out
'400':
description: Bad request
content:
@@ -11180,7 +11761,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:
@@ -11233,7 +11815,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:
@@ -11339,7 +11922,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:
@@ -11445,7 +12029,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:
@@ -11476,8 +12061,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)
responses:
'200':
description: OK
@@ -11512,8 +12100,9 @@ paths:
tags:
- Employees
summary: Update Commute Details
- description: |
- Update spender's commute details to use commute deduction feature in mileage expenses.
+ description: >
+ Update spender's commute details to use commute deduction feature in
+ mileage expenses.
operationId: employee_commute_details_post
requestBody:
required: true
@@ -11567,8 +12156,9 @@ paths:
tags:
- Employees
summary: Delete Commute Details
- description: |
- Delete spender's commute details. Spender will not be able to use commute deduction feature in mileage expenses.
+ description: >
+ Delete spender's commute details. Spender will not be able to use
+ commute deduction feature in mileage expenses.
operationId: employee_commute_details_delete_post
requestBody:
required: true
@@ -11587,7 +12177,9 @@ paths:
id:
allOf:
- $ref: '#/components/schemas/id_integer'
- description: Current commute details id of the spender. This id is provided by Fyle to identify an object.
+ description: >-
+ Current commute details id of the spender. This id is
+ provided by Fyle to identify an object.
responses:
'200':
description: OK
@@ -11682,8 +12274,9 @@ paths:
- Employees
summary: Employee's Delegators
operationId: employees_delegators_list
- description: |
- Get a list of delegators for the employee. Delegators are employees who have delegated their account access to the employee.
+ description: >
+ Get a list of delegators for the employee. Delegators are employees who
+ have delegated their account access to the employee.
responses:
'200':
description: OK
@@ -11738,7 +12331,9 @@ paths:
id:
allOf:
- $ref: '#/components/schemas/id_integer'
- description: Delegation id of spender and delegatee. This id is provided by Fyle to identify an object.
+ description: >-
+ Delegation id of spender and delegatee. This id is
+ provided by Fyle to identify an object.
responses:
'200':
description: OK
@@ -11781,8 +12376,11 @@ paths:
tags:
- Virtual Cards
summary: List virtual 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: virtual_cards_list
parameters:
- $ref: '#/components/parameters/created_at'
@@ -11932,8 +12530,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
@@ -12094,9 +12695,12 @@ paths:
tags:
- Files
summary: 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.
operationId: files_generate_urls_post
requestBody:
required: true
@@ -12145,9 +12749,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:
@@ -12323,7 +12930,9 @@ paths:
properties:
expense_id:
type: string
- description: ID of the expense to which this html file needs to be attached
+ description: >-
+ ID of the expense to which this html file needs to be
+ attached
example: txdtyereJtR6
html_content:
type: string
@@ -12378,14 +12987,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"
@@ -12445,12 +13061,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
@@ -12503,12 +13125,21 @@ paths:
tags:
- Expenses
summary: Check expense for policy violation
- description: |
- Before creating or updating an [expense object](https://docs.fylehq.com/docs/fyle-platform-docs/b5ec89140e06b-create-or-update-expense)
- into Fyle, based on the business requirements, you might want to check that
- expense against the policy rules set up by your organization. You can easily do that by passing the same expense object
- that you want to create/update to this API, along with some extra optional fields documented below.
- Note that, however based on whether you are creating or updating an expense, some fields may be mandatory as mentioned explicitly by _Note_.
+ description: >
+ Before creating or updating an [expense
+ object](https://docs.fylehq.com/docs/fyle-platform-docs/b5ec89140e06b-create-or-update-expense)
+
+ into Fyle, based on the business requirements, you might want to check
+ that
+
+ expense against the policy rules set up by your organization. You can
+ easily do that by passing the same expense object
+
+ that you want to create/update to this API, along with some extra
+ optional fields documented below.
+
+ Note that, however based on whether you are creating or updating an
+ expense, some fields may be mandatory as mentioned explicitly by _Note_.
operationId: check_policies_post
requestBody:
required: true
@@ -12582,7 +13213,8 @@ paths:
- data
properties:
data:
- $ref: '#/components/schemas/spender_automate_report_submission_next_at_out'
+ $ref: >-
+ #/components/schemas/spender_automate_report_submission_next_at_out
'400':
description: Bad request
content:
@@ -12606,10 +13238,15 @@ paths:
tags:
- Expenses
summary: Check expense for missing mandatory fields
- description: |
- Before creating or updating an [expense object](https://docs.fylehq.com/docs/fyle-platform-docs/b5ec89140e06b-create-or-update-expense)
- 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.
+ description: >
+ Before creating or updating an [expense
+ object](https://docs.fylehq.com/docs/fyle-platform-docs/b5ec89140e06b-create-or-update-expense)
+
+ 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
@@ -12622,7 +13259,8 @@ paths:
- data
properties:
data:
- $ref: '#/components/schemas/spender_expense_check_mandatory_fields_in'
+ $ref: >-
+ #/components/schemas/spender_expense_check_mandatory_fields_in
responses:
'200':
description: OK
@@ -12715,8 +13353,9 @@ paths:
- Expenses
summary: List expense duplicate sets
operationId: expense_duplicate_sets
- description: |
- This API provides the sets of the duplicate expenses for a particular employee.
+ description: >
+ This API provides the sets of the duplicate expenses for a particular
+ employee.
parameters:
- in: query
name: expense_id
@@ -12991,8 +13630,9 @@ paths:
tags:
- Expenses
summary: Split an expense
- description: |
- Spender can split an existing expense or create splits for a new expense object.
+ description: >
+ Spender can split an existing expense or create splits for a new expense
+ object.
operationId: expenses_split_post
requestBody:
required: true
@@ -13044,10 +13684,15 @@ paths:
tags:
- Expenses
summary: Check for policy violations before splitting an expense
- description: |
+ description: >
Before splitting an expense object
- into Fyle, based on the business requirements, you might want to check the resulting
- expenses against the policy rules set up by your organization. You can easily do that by passing the same split expense object
+
+ into Fyle, based on the business requirements, you might want to check
+ the resulting
+
+ expenses against the policy rules set up by your organization. You can
+ easily do that by passing the same split expense object
+
to this API.
operationId: expenses_split_check_policies_post
requestBody:
@@ -13100,10 +13745,14 @@ paths:
tags:
- Expenses
summary: Check mandatory fields before splitting an expense
- description: |
+ description: >
Before splitting an 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 split object 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 split object
+ documented below.
operationId: expenses_split_check_mandatory_post
requestBody:
required: true
@@ -13156,8 +13805,11 @@ paths:
- Feature Configs
summary: List feature configs.
operationId: feature_configs_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
@@ -13341,7 +13993,9 @@ paths:
id:
allOf:
- $ref: '#/components/schemas/id_string'
- description: Personal card id of the spender. This id is provided by Fyle to identify an object.
+ description: >-
+ Personal card id of the spender. This id is provided by
+ Fyle to identify an object.
responses:
'200':
description: OK
@@ -13424,8 +14078,9 @@ paths:
- Personal Cards
summary: Personal card MFA
operationId: personal_cards_mfa
- description: |
- Get MFA details for opening the MFA dialog before fetching the personal card transactions
+ description: >
+ Get MFA details for opening the MFA dialog before fetching the personal
+ card transactions
requestBody:
required: true
content:
@@ -13488,7 +14143,9 @@ paths:
personal_card_id:
allOf:
- $ref: '#/components/schemas/id_string'
- description: Personal card id of the spender. This id is provided by Fyle to identify an object.
+ description: >-
+ Personal card id of the spender. This id is provided by
+ Fyle to identify an object.
responses:
'200':
description: OK
@@ -13512,21 +14169,31 @@ paths:
parameters:
- in: query
name: personal_card_id
- description: |
- The id of the personal cards for which the transactions need to be fetched.
+ description: >
+ The id of the personal cards for which the transactions need to be
+ fetched.
+
Supported operators are `eq` .
+
id=eq."id"
- > If no id is passed then all the personal card transactions of the user will be returned.
+
+ > If no id is passed then all the personal card transactions of the
+ user will be returned.
schema:
type: string
example: eq."btxnxzApu30fvX"
- in: query
name: state
- description: |
- Whether to fetch only INITIALIZED state personal card transactions.
+ description: >
+ Whether to fetch only INITIALIZED state personal card
+ transactions.
+
Supported operators are `eq`.
+
state=eq."id"
- > If no state is passed then all the personal card transactions of the user will be returned.
+
+ > If no state is passed then all the personal card transactions of
+ the user will be returned.
schema:
type: string
example: eq."INITIALIZED"
@@ -13587,12 +14254,16 @@ paths:
id:
allOf:
- $ref: '#/components/schemas/id_string'
- description: Personal card id of the spender. This id is provided by Fyle to identify an object.
+ description: >-
+ Personal card id of the spender. This id is provided by
+ Fyle to identify an object.
example: btxnAnsad23ms
expense_split_group_id:
allOf:
- $ref: '#/components/schemas/id_string'
- description: Personal card id of the spender. This id is provided by Fyle to identify an object.
+ description: >-
+ Personal card id of the spender. This id is provided by
+ Fyle to identify an object.
example: txaisd2asdJ
responses:
'200':
@@ -13692,18 +14363,23 @@ paths:
- Personal Card Transactions
summary: Personal Card Transactions Expense Suggestions
operationId: personal_card_transactions_expense_suggestions
- description: |
- This API provides the sets of the duplicate expenses for a particular employee.
+ description: >
+ This API provides the sets of the duplicate expenses for a particular
+ employee.
parameters:
- in: query
name: amount
- description: Amount for finding similar expense to match a personal card transaction.
+ description: >-
+ Amount for finding similar expense to match a personal card
+ transaction.
schema:
type: number
example: 80.23
- in: query
name: spent_at
- description: Date for finding similar expense to match a personal card transaction.
+ description: >-
+ Date for finding similar expense to match a personal card
+ transaction.
schema:
type: string
example: '2024-05-14'
diff --git a/src/components/schemas/expense.yaml b/src/components/schemas/expense.yaml
index 2660fcd0d..904272081 100644
--- a/src/components/schemas/expense.yaml
+++ b/src/components/schemas/expense.yaml
@@ -878,6 +878,14 @@ spender_expense_in:
type: boolean
nullable: true
description: Flag stating whether this was a round trip or not.
+ mileage_calculated_distance:
+ type: number
+ nullable: true
+ description: Distance computed by Fyle in mileage expenses.
+ mileage_calculated_amount:
+ type: number
+ nullable: true
+ description: Amount computed by Fyle in mileage expenses.
commute_details_id:
type: integer
nullable: true
@@ -1038,6 +1046,14 @@ admin_expense_in:
type: boolean
nullable: true
description: Flag stating whether this was a round trip or not.
+ mileage_calculated_distance:
+ type: number
+ nullable: true
+ description: Distance computed by Fyle in mileage expenses.
+ mileage_calculated_amount:
+ type: number
+ nullable: true
+ description: Amount computed by Fyle in mileage expenses.
commute_details_id:
type: integer
nullable: true
@@ -1169,6 +1185,14 @@ approver_expense_in:
type: boolean
nullable: true
description: Flag stating whether this was a round trip or not.
+ mileage_calculated_distance:
+ type: number
+ nullable: true
+ description: Distance computed by Fyle in mileage expenses.
+ mileage_calculated_amount:
+ type: number
+ nullable: true
+ description: Amount computed by Fyle in mileage expenses.
commute_details_id:
type: integer
nullable: true