Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31,232 changes: 16,746 additions & 14,486 deletions reference/admin.yaml

Large diffs are not rendered by default.

20 changes: 20 additions & 0 deletions src/admin/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -511,6 +511,26 @@ paths:
$ref: paths/admin@reconciliation_entries.yaml
/admin/reconciliation_entries/transactions:
$ref: paths/admin@reconciliation_entries@transactions.yaml
/admin/reconciliation_entries/transactions/reconcile/bulk:
$ref: paths/admin@reconciliation_entries@transactions@reconcile@bulk.yaml
/admin/reconciliation_entries/transactions/match_and_reconcile/bulk:
$ref: paths/admin@reconciliation_entries@transactions@match_and_reconcile@bulk.yaml
/admin/reconciliation_entries/transactions/find_match:
$ref: paths/admin@reconciliation_entries@transactions@find_match.yaml
/admin/reconciliation_entries/transactions/ignore/bulk:
$ref: paths/admin@reconciliation_entries@transactions@ignore@bulk.yaml
/admin/reconciliation_entries/eligible_cards:
$ref: paths/admin@reconciliation_entries@eligible_cards.yaml
/admin/reconciliation_entries/eligible_cards/stats:
$ref: paths/admin@reconciliation_entries@eligible_cards@stats.yaml
/admin/reconciliation_entries/transactions/delete/bulk:
$ref: paths/admin@reconciliation_entries@transactions@delete@bulk.yaml
/admin/reconciliation_entries/transactions/unmatch/bulk:
$ref: paths/admin@reconciliation_entries@transactions@unmatch@bulk.yaml
/admin/reconciliation_entries/transactions/resolve_multi_matches:
$ref: paths/admin@reconciliation_entries@transactions@resolve_multi_matches.yaml
/admin/reconciliation_entries/close:
$ref: paths/admin@reconciliation_entries@close.yaml
/admin/expenses/delete/bulk:
$ref: paths/admin@expenses@delete@bulk.yaml
/admin/employee_settings:
Expand Down
65 changes: 65 additions & 0 deletions src/admin/paths/admin@reconciliation_entries@close.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
post:
tags:
- Reconciliation
summary: Close reconciliation entry
description: |
Mark a reconciliation entry as reconciled/closed.
operationId: reconciliation_entries_close
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- id
properties:
id:
type: string
description: Reconciliation entry id to close.
example: receabc12345
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
data:
type: object
description: Result of close operation. Empty object on success.
example: {}
'400':
description: Bad request
content:
application/json:
schema:
$ref: '../../components/schemas/400.yaml'
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: '../../components/schemas/401.yaml'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '../../components/schemas/403.yaml'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '../../components/schemas/404.yaml'

69 changes: 69 additions & 0 deletions src/admin/paths/admin@reconciliation_entries@eligible_cards.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
get:
tags:
- Reconciliation
summary: List eligible cards for a reconciliation entry
description: |
Returns the list of corporate cards that are eligible for a given reconciliation entry.
To understand filtering, ordering and pagination, see the [Guide to Data APIs](https://docs.fylehq.com/docs/fyle-platform-docs/ZG9jOjI3Mzk2NTM3-guide-to-data-ap-is#filtering)
operationId: reconciliation_entries_eligible_cards_list
parameters:
- in: query
name: reconciliation_entry_id
required: true
schema:
type: string
example: receabc12345
description: |
Reconciliation entry id for which eligible cards should be listed.
- in: query
name: status
required: false
schema:
type: string
example: RECONCILED
description: |
Optional status filter for eligible cards.
- $ref: '../../components/parameters/q.yaml'
- $ref: '../../components/parameters/order.yaml'
- $ref: '../../components/parameters/offset.yaml'
- $ref: '../../components/parameters/limit.yaml'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
count:
$ref: '../../components/schemas/count.yaml'
offset:
$ref: '../../components/schemas/offset.yaml'
data:
type: array
items:
$ref: '../../components/schemas/reconciliation_eligible_cards.yaml#/reconciliation_eligible_card_out'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '../../components/schemas/400.yaml'
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: '../../components/schemas/401.yaml'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '../../components/schemas/403.yaml'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '../../components/schemas/404.yaml'
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
post:
tags:
- Reconciliation
summary: Stats for eligible cards of a reconciliation entry
description: |
Returns aggregate stats for corporate cards eligible under a reconciliation entry.

Use this endpoint to get period window, transaction and expense totals, differences, and card-level aggregate counts such as matching issues and reconciliation status.
operationId: reconciliation_entries_eligible_cards_stats
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: False
required:
- data
properties:
data:
$ref: '../../components/schemas/reconciliation_eligible_cards.yaml#/reconciliation_eligible_cards_stats_in'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
additionalProperties: False
properties:
data:
$ref: '../../components/schemas/reconciliation_eligible_cards.yaml#/reconciliation_eligible_cards_stats_out'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '../../components/schemas/400.yaml'
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: '../../components/schemas/401.yaml'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '../../components/schemas/403.yaml'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '../../components/schemas/404.yaml'

Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
post:
tags:
- Reconciliation
summary: Bulk delete reconciliation transactions
description: |
Delete multiple reconciliation transactions in bulk.
operationId: reconciliation_transactions_delete_bulk
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- data
properties:
data:
type: array
description: List of reconciliation transaction identifiers to delete.
items:
type: object
additionalProperties: false
required:
- id
properties:
id:
type: string
description: Unique id of the reconciliation transaction to delete.
example: rectx8abc123
example:
- id: rectx8abc123
- id: rectx8xyz789
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
data:
type: object
description: Result of bulk delete. Empty object on success.
example: {}
'400':
description: Bad request
content:
application/json:
schema:
oneOf:
- $ref: '../../components/schemas/bulk_error.yaml'
- type: object
properties:
error:
type: string
nullable: true
message:
type: string
nullable: true
data:
type: object
nullable: true
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: '../../components/schemas/401.yaml'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '../../components/schemas/403.yaml'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '../../components/schemas/404.yaml'

Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
post:
tags:
- Reconciliation
summary: Find matches for a reconciliation transaction
description: |
Find potential matching expenses for a reconciliation transaction.
operationId: reconciliation_transactions_find_match
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- data
properties:
data:
type: object
additionalProperties: false
required:
- id
properties:
id:
type: string
description: Unique id of the reconciliation transaction for which to find matches.
example: rectx8abc123
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
data:
type: array
description: List of potential matches for the provided reconciliation transaction.
items:
$ref: '../../components/schemas/reconciliation_transactions.yaml#/reconciliation_transaction_out'
count:
$ref: '../../components/schemas/count.yaml'
offset:
$ref: '../../components/schemas/offset.yaml'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '../../components/schemas/400.yaml'
'401':
description: Unauthorized request
content:
application/json:
schema:
$ref: '../../components/schemas/401.yaml'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '../../components/schemas/403.yaml'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '../../components/schemas/404.yaml'

Loading