FYLE-2hwr6bb #151
FYLE-2hwr6bb #151
Conversation
| summary: Upload a statement | ||
| description: | | ||
| Upload a statement to Fyle for reconciliation. | ||
| 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.
Addl info: Some code generators use this value to name the corresponding methods in code.
| 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.
| has_statement_line_items_duplicate: | ||
| type: boolean | ||
| description: | | ||
| Determines whether the transaction inside the statement is duplicate or not. |
There was a problem hiding this comment.
instead of Determines can use
indicates whether there are any line items in this statement are duplicates.
| type: number | ||
| 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
| file_id: | ||
| type: string | ||
| description: | | ||
| Id of the uploaded statement. |
There was a problem hiding this comment.
file id of the upload statement.
| 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 statement everywhere instead of using document pls ?
| 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
| has_statement_duplicate: | ||
| type: boolean | ||
| description: | | ||
| Determines whether the statement is completely duplicate or not. |
There was a problem hiding this comment.
Determines -> Indicates
| type: string | ||
| description: | | ||
| Id of the uploaded statement. | ||
| is_ccc_created: |
There was a problem hiding this comment.
This is not added in doc, pls to update it. Need to check with the naming.
We can avoid using abbreviations like ccc pls ?
Maybe something like are_corporate_card_transactions_created_from_statement ?
Pls to discuss with Gokul / Adi on the naming here
| - 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)
| description: | | ||
| End date of the statement period | ||
| nullable: true | ||
| has_statement_duplicate: |
| duplicate_statement_ids: | ||
| type: array | ||
| description: | ||
| Holds the list of statement_ids which are duplicate to the current statement |
There was a problem hiding this comment.
Holds the list of statement_ids which are complete duplicate of the current statement
| example: | ||
| - stmtge49ielgel | ||
| nullable: true | ||
| has_statement_line_items_duplicate: |
There was a problem hiding this comment.
rename to has_duplicate_statement_line_items
| unique_id: | ||
| type: string | ||
| description: | | ||
| Unique key that is used to identify the statement. |
There was a problem hiding this comment.
Unique hash value that is used to identify the statement.
| - Statements | ||
| summary: Upload a statement | ||
| description: | | ||
| upload a corporate card statement(csv or excel) to Fyle for reconciliation. |
There was a problem hiding this comment.
upload -> Upload
| has_duplicate_statements: | ||
| type: boolean | ||
| description: | | ||
| Indicates whether the statement is completely duplicate or not. |
There was a problem hiding this comment.
p2 | Pls check if you can rephrase this.
| description: | | ||
| File id of the uploaded statement. | ||
| example: fiit3pX9gzzP | ||
| is_corporate_card_transactions_created: |
There was a problem hiding this comment.
p2 | Pls check if we can change this from is_corporate_card_transactions_created to are_corporate_card_transactions_created as they are plural
There was a problem hiding this comment.
proceeding with is_corporate_card_transactions_created only sir, as the transactions indicates the plural form here
| - has_duplicate_statements | ||
| - has_duplicate_statement_line_items | ||
| - duplicate_statement_ids | ||
| - duplicate_statement_line_items |
There was a problem hiding this comment.
Pls add statement_mappings_id in the required
| @@ -6539,6 +6539,163 @@ components: | |||
| description: > | |||
| Determines whether this organization has been verified by a | |||
| verifier. | |||
| statements_in: | |||
There was a problem hiding this comment.
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
| example: stmtwownwrng | ||
| org_id: | ||
| $ref: './fields.yaml#/org_id' | ||
| user_id: |
| example: | ||
| - account_number | ||
| - amount | ||
| nullable: true |
| description: | | ||
| Unique hash value that is used to identify the statement. | ||
| example: 74175aadf22675aa59df28b96d351cfb | ||
| nullable: true |
There was a problem hiding this comment.
nullable: false
fill existing with dummy values if you have to cc: @modernwarfareuplink
Open api doc for /statements/upload
Design doc link : https://www.notion.so/fyleuniverse/Moving-statement-upload-api-s-to-platform-5e3d17095d2e46e888ed68cd0a526e6c#8ff21bd57f6048de8c57af642641c651
Other PR's related to this change:
Open api doc: FYLE-2hwr6bb
Core logic: FYLE-257mdht
DB Changes: FYLE-257mdhq
DB Changes: FYLE-257mdhq-sync-functions (sync functions)