FYLE-2hwr6bb #151
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| post: | ||
| tags: | ||
| - Statements | ||
| summary: Upload a statement | ||
| description: | | ||
| Upload a statement to Fyle for reconciliation. | ||
|
There was a problem hiding this comment. upload a corporate card statement(csv or excel) |
||
| operationId: statements_post | ||
|
There was a problem hiding this comment. try to understand what and where this is used There was a problem hiding this comment. Got it, this is a unique string used to identify an operation. |
||
| requestBody: | ||
| required: true | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: object | ||
| properties: | ||
| data: | ||
| $ref: '../../components/schemas/statements.yaml#/statements_in' | ||
| required: | ||
| - data | ||
| responses: | ||
| '200': | ||
| description: OK | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: object | ||
| properties: | ||
| data: | ||
| $ref: '../../components/schemas/statements.yaml#/statements_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' | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| statements_in: | ||
| type: object | ||
| properties: | ||
| file_id: | ||
| allOf: | ||
| - $ref: './fields.yaml#/id_string' | ||
| example: fidftadfdsdf | ||
| required: | ||
| - file_id | ||
|
|
||
| statements_out: | ||
| type: object | ||
| additionalProperties: False | ||
| properties: | ||
| id: | ||
| allOf: | ||
| - $ref: './fields.yaml#/id_string' | ||
| example: stmtwownwrng | ||
| org_id: | ||
| $ref: './fields.yaml#/org_id' | ||
| created_at: | ||
| $ref: './fields.yaml#/created_at' | ||
| updated_at: | ||
| $ref: './fields.yaml#/updated_at' | ||
| file_name: | ||
| type: string | ||
| description: | | ||
| Specifies the name of file uploaded by the user. | ||
| example: amex.csv | ||
| file_size: | ||
| type: string | ||
| description: | | ||
| Specifies the size of file uploaded by the user. | ||
| example: 21KB | ||
|
There was a problem hiding this comment. Will have to mention what is the default size, is it bytes (or) MB (or) KB. Also, it is a number so it cannot be 21KB, it just has to be 21. Is this expected or do we need to take this as text @Kulsekar4 ? There was a problem hiding this comment. Number is only expected here sir, will remove the KB |
||
| no_of_debit: | ||
| type: integer | ||
| description: | | ||
| Number of debit transactions in the document uploaded by the user. | ||
|
There was a problem hiding this comment. Can we use |
||
| example: 3 | ||
| no_of_credit: | ||
| type: integer | ||
| description: | | ||
| Number of credit transactions in the document uploaded by the user. | ||
| example: 3 | ||
| no_of_transactions: | ||
| type: integer | ||
| description: | | ||
| Number of transactions in the document uploaded by the user. | ||
| example: 3 | ||
|
There was a problem hiding this comment. example: 6 Because above examples of credit and debit are 3 each |
||
| statement_columns: | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: > | ||
| This specifies headers of the statement uploaded by the user. | ||
| example: | ||
| - account_number | ||
| - amount | ||
| statement_mapping_id: | ||
| type: string | ||
| description: | | ||
| Refers to the mapping used in statement. | ||
| example: stmpdfddfd | ||
| start_date: | ||
| $ref: './fields.yaml#/timestamptz_utc' | ||
| description: | | ||
| Start date of the statement period | ||
| end_date: | ||
| $ref: './fields.yaml#/timestamptz_utc' | ||
| description: | | ||
| End date of the statement period | ||
| has_statement_duplicate: | ||
|
|
||
| type: boolean | ||
| description: | | ||
| Determines whether the statement is duplicate or not. | ||
|
There was a problem hiding this comment. Determines whether the statement is completely duplicate or not. |
||
| duplicate_statement_ids: | ||
| type: array | ||
| items: | ||
| $ref: './fields.yaml#/id_string' | ||
| example: | ||
| - stmtge49ielgel | ||
modernwarfareuplink marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| has_statement_line_items_duplicate: | ||
|
There was a problem hiding this comment. rename to has_duplicate_statement_line_items |
||
| type: boolean | ||
| description: | | ||
| Determines whether the transaction inside the statement is duplicate or not. | ||
|
There was a problem hiding this comment. instead of |
||
| duplicate_statement_line_items: | ||
| type: array | ||
| items: | ||
| type: object | ||
| properties: | ||
| ids: | ||
| type: array | ||
| items: | ||
| $ref: './fields.yaml#/id_string' | ||
| example: | ||
| - stlige49ielgel | ||
| description: | ||
| Ids of the current statement line items which are duplicates | ||
| duplicate_line_item_statement_id: | ||
| type: string | ||
| description: | | ||
| Id of the existing duplicate statement | ||
| example: | ||
| - stmpge49ielgel | ||
|
|
||
|
|
||
| required: | ||
modernwarfareuplink marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - id | ||
| - org_id | ||
| - created_at | ||
| - updated_at | ||
| - file_name | ||
| - file_size | ||
| - no_of_debit | ||
| - no_of_credit | ||
| - no_of_transactions | ||
| - statement_mapping_id | ||
| - statement_columns | ||
| - start_date | ||
| - end_date | ||
| - has_statement_duplicate | ||
| - duplicate_statement_ids | ||
| - has_statement_line_items_duplicate | ||
| - duplicate_statement_line_items | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary :
Have added not null constraint for -> also have added in doc and script @modernwarfareuplink sir
file_name
file_size
no_of_debit
no_of_credit
no_of_transactions