Description (Company's Document List)
Show the documents related with that company. (GET)
End Point
https://api.yedpay.com/v1/companies/{{company_id}}/documents
Variable
# | Name | Type | Description |
---|---|---|---|
1 | company_id | String | Company's ID |
Request Header
# | Key | Value | Description |
---|---|---|---|
1 | Authorization | Bearer {{access_token}} | Login Token |
Body
# | Name | Type | Description |
---|
Response
# | Name | Type | Description |
---|---|---|---|
1 | success | Boolean | Request Document List Success or Fail |
2 | data | Array | Include all Document Information (document_iD, name etc..) |
3 | meta | Array | Include all Pagination's Information (total, count, total_pages, etc..) |
Success Response - data
# | Name | Type | Description |
---|---|---|---|
1 | id | String | Id of the File |
2 | user_id | String | Id of the User |
3 | type | String | Type of the File |
4 | name | String | Name of the File |
5 | description | String | Description of the File |
6 | mime | String | MIME Type of the File |
7 | size | Integer | Size of the File |
8 | shared | Boolean | Whether the File is Shared or Not (true/false) |
9 | br_number | String | Business Registration number (for type="br" or "store_br" only) |
10 | branch_number | Numeric String | Branch number of the BR (for type="br" or "store_br" only) |
11 | registered_company_name | String | Company name displayed in the BR (for "br" type file only) |
12 | type_of_business | Integer | Type of business registered via the BR (for "br" type file only) |
13 | expiry_date | String | Expiry Date of the BR (format: yyyy-MM-dd) (for type="br" or "store_br" only) |
14 | ci_number | String | Number of the CI (for last "ci" type file only) |
15 | company_name | String | Company name displayed in the CI (for last "ci" type file only) |
16 | date_of_establishment | String | CI's date of establishment (format: yyyy-MM-dd) (for last "ci" type file only) |
Example Success Response
{ "success": true, "data": [ { "id": "PWN67LK13G5ZQX540E", "user_id": "8YN319ZPJDJZX2DJ7P", "uploader_id": "MJ86QYO3LL2ZEP3RG5", "fileable_type": "App\Models\Company", "fileable_id": "3WJ2PMK6W1GK7Y6DN5", "type": "ci", "name": "xxxxxxxxxxxx", "description": "xxxxxxxxxxxxx", "mime": "xxxxxxx", "size": 484089, "shared": false, "updated_at": 2023-06-03 06:53:59, "ci_number": "71045312", "company_name": "xxxxxxxxxxxx", "date_of_establishment": "2023-06-03" }, { "id": "G2R98WZXRY9Z5EV3PN", "user_id": "7E52LGO210LK68YJDQ", "uploader_id": "MJ86QYO35J0KEP3RG5", "fileable_type": "App\Models\Company", "fileable_id": "3GWX1LKVL7MZER4NYP", "type": "br", "name": "xxxxxxxxxxxx", "description": "xxxxxxxxxxxxx", "mime": "xxxxxxx", "size": 464434, "shared": false, "updated_at": 2023-06-03 06:53:59, "registered_company_name": "xxxxxxxxx", "type_of_business": 2, "br_number": "83564986", "branch_number": "009", "expiry_date": "2023-06-03" } ], "meta": { "pagination": { "total": 2, "count": 2, "per_page": 40, "current_page": 1, "total_pages": 1, "links": [] } } }
Example Error Response
{ "success": false, "message": "Unauthenticated.", "status": 500 }
v1.61.15-20230523 © The Payment Cards Group Limited. All rights reserved.