{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.gestao-arquivos.pensou.app.br" } ], "info": { "name": "Gestao de Arquivos API Documentation", "_postman_id": "01052f0a-648d-4174-b00f-9bb7fe6b8857", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "ACL", "description": "Endpoints for managing roles and permissions.", "item": [ { "name": "Roles", "description": "Endpoints for managing roles.", "item": [ { "name": "List", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/acl\/roles", "query": [ { "key": "q", "value": "Role+name", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/acl\/roles?q=Role+name" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List roles." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"e9596f10-9ddb-3051-8b75-f9c115baafa1\",\"name\":\"et\",\"display_name\":\"Veritatis eum molestiae est modi optio porro.\",\"permissions_count\":null},{\"id\":\"a2264953-8407-3635-a3f5-1cfd6e312ee9\",\"name\":\"dolor\",\"display_name\":\"Laborum non provident sit suscipit doloribus aperiam sit.\",\"permissions_count\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/acl\/roles", "query": [], "raw": "{{baseUrl}}\/api\/acl\/roles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"display_name\":\"Example Name\",\"permissions\":[\"bfc53181-d647-36b2-9080-f9c2b76006f4\"]}" }, "description": "Create a new role." }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/acl\/roles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/acl\/roles\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the role." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"display_name\":\"Example Name\",\"permissions\":[\"bfc53181-d647-36b2-9080-f9c2b76006f4\"]}" }, "description": "Update a role." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Show", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/acl\/roles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/acl\/roles\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the role." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a role." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"quidem\",\"display_name\":\"Qui commodi incidunt iure odit.\",\"permissions_count\":null}}", "name": "" } ] }, { "name": "Role Permissions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/acl\/roles\/:role\/permissions", "query": [], "raw": "{{baseUrl}}\/api\/acl\/roles\/:role\/permissions", "variable": [ { "id": "role", "key": "role", "value": "1", "description": "The role." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List permissions associated with a role." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"name\":\"quidem\",\"display_name\":\"Qui commodi incidunt iure odit.\"},{\"id\":null,\"name\":\"modi\",\"display_name\":\"Nostrum omnis autem et consequatur aut.\"}]}", "name": "" } ] }, { "name": "Delete", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/acl\/roles\/:role", "query": [], "raw": "{{baseUrl}}\/api\/acl\/roles\/:role", "variable": [ { "id": "role", "key": "role", "value": "1", "description": "The role." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a role." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Permissions", "description": "Endpoints for managing permissions.", "item": [ { "name": "List", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/acl\/permissions", "query": [ { "key": "q", "value": "Permission+name", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/acl\/permissions?q=Permission+name" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List permissions." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"name\":\"quidem\",\"display_name\":\"Qui commodi incidunt iure odit.\"},{\"id\":null,\"name\":\"modi\",\"display_name\":\"Nostrum omnis autem et consequatur aut.\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/acl\/permissions", "query": [], "raw": "{{baseUrl}}\/api\/acl\/permissions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"display_name\":\"Example Name\"}" }, "description": "Create a new permission." }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/acl\/permissions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/acl\/permissions\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the permission." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"display_name\":\"Example Name\"}" }, "description": "Update a permission." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Show", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/acl\/permissions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/acl\/permissions\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the permission." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a permission." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"name\":\"quidem\",\"display_name\":\"Qui commodi incidunt iure odit.\"}}", "name": "" } ] }, { "name": "Delete", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/acl\/permissions\/:permission", "query": [], "raw": "{{baseUrl}}\/api\/acl\/permissions\/:permission", "variable": [ { "id": "permission", "key": "permission", "value": "1", "description": "The permission." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a permission." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] } ] }, { "name": "Accounts Payable Receivable", "description": "Endpoints for accounts payable receivable", "item": [ { "name": "List reminders for accounts payable receivable", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/accounts-payable-receivable\/reminders", "query": [], "raw": "{{baseUrl}}\/api\/accounts-payable-receivable\/reminders" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List reminders for accounts payable receivable that are about to expire soon" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"type\":\"sa\\u00edda\",\"payment_method\":\"cheque\",\"amount\":6092.26,\"due_date\":\"2026-01-24T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"description\":\"Iure odit et et modi ipsum nostrum omnis autem et consequatur aut dolores.\",\"is_recurring\":null,\"recurrence_config\":null,\"parent_id\":null,\"recurrence_order\":1,\"total_recurrences\":null,\"children_count\":0,\"remaining_recurrences\":null,\"has_children\":false,\"field1\":\"enim\",\"field2\":62,\"field3\":true,\"notes\":\"Veniam corporis dolorem mollitia.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"0733da06-3f67-3b0d-b923-684c336397e5\",\"type\":\"sa\\u00edda\",\"payment_method\":\"boleto\",\"amount\":8204.46,\"due_date\":\"2026-01-24T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"description\":\"Fugit qui repudiandae laboriosam est alias tenetur ratione nemo voluptate.\",\"is_recurring\":null,\"recurrence_config\":null,\"parent_id\":null,\"recurrence_order\":1,\"total_recurrences\":null,\"children_count\":0,\"remaining_recurrences\":null,\"has_children\":false,\"field1\":\"accusamus\",\"field2\":84,\"field3\":true,\"notes\":\"Modi rerum ex repellendus assumenda et tenetur.\",\"created_at\":null,\"updated_at\":null}]}", "name": "" } ] }, { "name": "Mark reminders as read", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/accounts-payable-receivable\/reminders\/mark-as-read", "query": [ { "key": "items[0]", "value": "architecto", "description": "The uuid of an existing record in the account_payable_receivables table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/accounts-payable-receivable\/reminders\/mark-as-read?items[0]=architecto" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Mark reminders for accounts payable receivable as read" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "List accounts payable receivable", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/accounts-payable-receivable", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Salary", "description": "Search query.", "disabled": false }, { "key": "type", "value": "entrada", "description": "Type.", "disabled": false }, { "key": "customers[0]", "value": "architecto", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "architecto", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "statuses[0]", "value": "cancelado", "description": "", "disabled": false }, { "key": "payment_method", "value": "cheque", "description": "Payment method.", "disabled": false }, { "key": "date_start", "value": "2023-01-01", "description": "Start date. O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "date_end", "value": "2023-12-31", "description": "End date. O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "has_children", "value": "", "description": "Filter accounts that have recurring children.", "disabled": true }, { "key": "is_recurring", "value": "", "description": "Filter by recurring status (true: only recurring, false: only non-recurring, null: all).", "disabled": true } ], "raw": "{{baseUrl}}\/api\/accounts-payable-receivable?sortBy=created_at&sortDesc=1&q=Salary&type=entrada&customers[0]=architecto&suppliers[0]=architecto&statuses[0]=cancelado&payment_method=cheque&date_start=2023-01-01&date_end=2023-12-31&has_children=&is_recurring=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all accounts payable receivable" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"a4855dc5-0acb-33c3-b921-f4291f719ca0\",\"type\":\"sa\\u00edda\",\"payment_method\":\"cheque\",\"amount\":5750.1,\"due_date\":\"2026-02-09T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"description\":\"Sunt nihil accusantium harum mollitia modi deserunt aut.\",\"is_recurring\":null,\"recurrence_config\":null,\"parent_id\":null,\"recurrence_order\":1,\"total_recurrences\":null,\"children_count\":0,\"remaining_recurrences\":null,\"has_children\":false,\"field1\":\"ab\",\"field2\":49,\"field3\":true,\"notes\":\"Iure odit et et modi ipsum nostrum omnis.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"59183559-65ff-3076-b8ca-d2d03d26a42a\",\"type\":\"entrada\",\"payment_method\":\"boleto\",\"amount\":8676.17,\"due_date\":\"2026-01-25T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"description\":\"Quis adipisci molestias fugit deleniti distinctio eum doloremque id aut libero.\",\"is_recurring\":null,\"recurrence_config\":null,\"parent_id\":null,\"recurrence_order\":1,\"total_recurrences\":null,\"children_count\":0,\"remaining_recurrences\":null,\"has_children\":false,\"field1\":\"aliquam\",\"field2\":75,\"field3\":true,\"notes\":\"Mollitia deleniti nemo odit quia officia.\",\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create accounts payable receivable", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/accounts-payable-receivable", "query": [], "raw": "{{baseUrl}}\/api\/accounts-payable-receivable" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"Example Type\",\"payment_method\":\"Example Payment method\",\"due_date\":\"2024-01-01\",\"amount\":1,\"description\":\"Example Description\",\"supplier_id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"customer_id\":\"c71cb930-01f3-381c-9172-e1c70e63388f\",\"status\":\"Example Status\",\"custom_fields\":[\"example1\",\"example2\"],\"is_recurring\":false,\"recurrence_config\":{\"0\":\"example1\",\"1\":\"example2\",\"frequency_type\":\"Example Recurrence config frequency type\",\"frequency_value\":1,\"end_date\":\"2024-01-01\",\"max_occurrences\":1,\"generation_days_ahead\":1}}" }, "description": "Create a new accounts payable receivable" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Get accounts payable receivable", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/accounts-payable-receivable\/:accountPayableReceivable", "query": [], "raw": "{{baseUrl}}\/api\/accounts-payable-receivable\/:accountPayableReceivable", "variable": [ { "id": "accountPayableReceivable", "key": "accountPayableReceivable", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get an accounts payable receivable" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"type\":\"sa\\u00edda\",\"payment_method\":\"cheque\",\"amount\":6092.26,\"due_date\":\"2026-01-24T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"description\":\"Iure odit et et modi ipsum nostrum omnis autem et consequatur aut dolores.\",\"is_recurring\":null,\"recurrence_config\":null,\"parent_id\":null,\"recurrence_order\":1,\"total_recurrences\":null,\"children_count\":0,\"remaining_recurrences\":null,\"has_children\":false,\"field1\":\"enim\",\"field2\":62,\"field3\":true,\"notes\":\"Veniam corporis dolorem mollitia.\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Update accounts payable receivable", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/accounts-payable-receivable\/:accountPayableReceivable", "query": [], "raw": "{{baseUrl}}\/api\/accounts-payable-receivable\/:accountPayableReceivable", "variable": [ { "id": "accountPayableReceivable", "key": "accountPayableReceivable", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"Example Type\",\"payment_method\":\"Example Payment method\",\"due_date\":\"2024-01-01\",\"amount\":1,\"description\":\"Example Description\",\"supplier_id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"customer_id\":\"c71cb930-01f3-381c-9172-e1c70e63388f\",\"status\":\"Example Status\",\"payment_date\":\"2024-01-01\",\"custom_fields\":[\"example1\",\"example2\"],\"is_recurring\":false,\"recurrence_config\":{\"0\":\"example1\",\"1\":\"example2\",\"frequency_type\":\"Example Recurrence config frequency type\",\"frequency_value\":1,\"end_date\":\"2024-01-01\",\"max_occurrences\":1,\"generation_days_ahead\":1}}" }, "description": "Update an accounts payable receivable" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete accounts payable receivable", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/accounts-payable-receivable\/:accountPayableReceivable", "query": [], "raw": "{{baseUrl}}\/api\/accounts-payable-receivable\/:accountPayableReceivable", "variable": [ { "id": "accountPayableReceivable", "key": "accountPayableReceivable", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an accounts payable receivable" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] } ] }, { "name": "Authentication", "description": "Endpoints for authentication", "item": [ { "name": "Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/login", "query": [], "raw": "{{baseUrl}}\/api\/auth\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\",\"password\":\"password\"}" }, "description": "Login with email and password", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"token\":\"string\"}", "name": "" } ] }, { "name": "Me", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/user", "query": [], "raw": "{{baseUrl}}\/api\/auth\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the current user" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Miss Pearl Hauck\",\"username\":\"pfritsch\",\"email\":\"leo34@example.net\",\"ability\":[{\"action\":\"read\",\"subject\":\"Auth\"},{\"action\":\"listar\",\"subject\":\"padr\\u00e3o\"}],\"roles\":[],\"preferences\":[],\"sectors\":[],\"image\":{\"id\":null,\"url\":null}}}", "name": "" } ] }, { "name": "Update Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/user", "query": [], "raw": "{{baseUrl}}\/api\/auth\/user" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"email\":\"user@example.com\",\"username\":\"christian51\",\"password\":\"password123\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"3457a2ff-ae91-3fa6-b7ef-d2a3b0cb075b\"],\"roles\":[\"3637ab3b-64aa-3e77-a6a7-c306cb6519a5\"]}" }, "description": "Update the current user profile" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/logout", "query": [], "raw": "{{baseUrl}}\/api\/auth\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Logout the current user" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Get user preferences", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/preferences", "query": [], "raw": "{{baseUrl}}\/api\/auth\/preferences" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get all user preferences" }, "response": [ { "header": [], "code": 200, "body": "{\"theme\":\"dark\",\"language\":\"pt-br\",\"notifications\":{\"email\":true,\"sms\":false}}", "name": "" } ] }, { "name": "Set user preference", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/preferences", "query": [], "raw": "{{baseUrl}}\/api\/auth\/preferences" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"key\":\"b\",\"value\":[]}" }, "description": "Set or update a user preference" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Preference saved successfully\"}", "name": "" } ] }, { "name": "Delete user preference", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/preferences\/:key", "query": [], "raw": "{{baseUrl}}\/api\/auth\/preferences\/:key", "variable": [ { "id": "key", "key": "key", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a specific user preference" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Preference deleted successfully\"}", "name": "" } ] } ] }, { "name": "Bank Accounts", "description": "Endpoints for bank accounts", "item": [ { "name": "Get bank account balance summary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts\/balance-summary", "query": [], "raw": "{{baseUrl}}\/api\/bank-accounts\/balance-summary" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the balance summary of all bank accounts" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"totalBalancePositive\":\"number\",\"totalBalanceNegative\":\"number\",\"totalLimit\":\"number\",\"sumLimitAndBalancePositive\":\"number\",\"accounts\":{\"*\":{\"id\":\"string\",\"bank\":\"string\",\"balance\":\"number\",\"limit\":\"number\"}}}}", "name": "" } ] }, { "name": "List bank accounts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "name", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/bank-accounts?sortBy=created_at&sortDesc=1&q=name" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all bank accounts" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"agency\":\"0949\",\"account\":\"2170043-2\",\"type\":\"poupan\\u00e7a\",\"balance\":4254.04,\"holder_type\":\"pf\",\"alias\":\"iure\",\"limit\":1223.92,\"bank\":{\"id\":null,\"name\":null,\"code\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"fa253524-dd6a-3fdb-a788-0cabcf134db7\",\"agency\":\"1627\",\"account\":\"5913505-2\",\"type\":\"corrente\",\"balance\":442.88,\"holder_type\":\"pf\",\"alias\":\"et\",\"limit\":4927.89,\"bank\":{\"id\":null,\"name\":null,\"code\":null},\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts", "query": [], "raw": "{{baseUrl}}\/api\/bank-accounts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"agency\":\"Example Agency\",\"account\":\"2170043-2\",\"bank_id\":\"fa253524-dd6a-3fdb-a788-0cabcf134db7\",\"type\":\"Example Type\",\"holder_type\":\"Example Holder type\",\"alias\":\"Example Alias\",\"balance\":1,\"limit\":1}" }, "description": "Create a new bank account" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts\/:bankAccount", "query": [], "raw": "{{baseUrl}}\/api\/bank-accounts\/:bankAccount", "variable": [ { "id": "bankAccount", "key": "bankAccount", "value": "16", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"agency\":\"Example Agency\",\"account\":\"2170043-2\",\"bank_id\":\"fa253524-dd6a-3fdb-a788-0cabcf134db7\",\"type\":\"Example Type\",\"holder_type\":\"Example Holder type\",\"alias\":\"Example Alias\",\"balance\":1,\"limit\":1}" }, "description": "Update a bank account" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Show bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts\/:bankAccount", "query": [], "raw": "{{baseUrl}}\/api\/bank-accounts\/:bankAccount", "variable": [ { "id": "bankAccount", "key": "bankAccount", "value": "16", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a bank account" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"agency\":\"0949\",\"account\":\"2170043-2\",\"type\":\"poupan\\u00e7a\",\"balance\":4254.04,\"holder_type\":\"pf\",\"alias\":\"iure\",\"limit\":1223.92,\"bank\":{\"id\":null,\"name\":null,\"code\":null},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Delete bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts\/:bankAccount", "query": [], "raw": "{{baseUrl}}\/api\/bank-accounts\/:bankAccount", "variable": [ { "id": "bankAccount", "key": "bankAccount", "value": "16", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a bank account" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] } ] }, { "name": "Banks", "description": "Endpoints for banks", "item": [ { "name": "List banks", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/banks", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Permission+name", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/banks?sortBy=created_at&sortDesc=1&q=Permission+name" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all banks" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Cort\\u00eas Comercial Ltda.\",\"code\":\"881\"},{\"id\":\"0a9446d3-4070-3757-8926-67a9d2adbc0e\",\"name\":\"Urias e Caldeira\",\"code\":\"744\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create bank", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/banks", "query": [], "raw": "{{baseUrl}}\/api\/banks" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"code\":\"Example Code\"}" }, "description": "Create a new bank" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update bank", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/banks\/:bank", "query": [], "raw": "{{baseUrl}}\/api\/banks\/:bank", "variable": [ { "id": "bank", "key": "bank", "value": "1", "description": "The bank." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"code\":\"Example Code\"}" }, "description": "Update a bank" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Show bank", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/banks\/:bank", "query": [], "raw": "{{baseUrl}}\/api\/banks\/:bank", "variable": [ { "id": "bank", "key": "bank", "value": "1", "description": "The bank." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a bank" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Cort\\u00eas Comercial Ltda.\",\"code\":\"881\"}}", "name": "" } ] }, { "name": "Delete bank", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/banks\/:bank", "query": [], "raw": "{{baseUrl}}\/api\/banks\/:bank", "variable": [ { "id": "bank", "key": "bank", "value": "1", "description": "The bank." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a bank" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "CEP", "description": "", "item": [ { "name": "Search CEP", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cep\/:cep", "query": [], "raw": "{{baseUrl}}\/api\/cep\/:cep", "variable": [ { "id": "cep", "key": "cep", "value": "01001000", "description": "CEP to search for" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search for address information by CEP (Brazilian postal code)" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"cep\":\"01001000\",\"street\":\"Pra\\u00e7a da S\\u00e9\",\"district\":\"S\\u00e9\",\"city\":\"S\\u00e3o Paulo\",\"state\":\"SP\",\"complement\":\"lado \\u00edmpar\",\"ibge\":\"3550308\",\"ddd\":\"11\",\"siafi\":\"7107\"}}", "name": "CEP found successfully" }, { "header": [], "code": 200, "body": "{\"data\":{\"cep\":\"99999999\",\"street\":null,\"district\":null,\"city\":null,\"state\":null,\"complement\":null,\"ibge\":null,\"ddd\":null,\"siafi\":null}}", "name": "CEP not found" } ] } ] }, { "name": "Cash Flow", "description": "Endpoints for cash flow", "item": [ { "name": "Get cash flow summary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-flows\/summary", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Salary", "description": "Search query.", "disabled": false }, { "key": "cash_session", "value": "uuid", "description": "Cash session. The uuid of an existing record in the cash_sessions table.", "disabled": false }, { "key": "type", "value": "entrada", "description": "Cash flow type.", "disabled": false }, { "key": "description", "value": "Eius+et+animi+quos+velit+et.", "description": "Description .", "disabled": false }, { "key": "categories[0]", "value": "architecto", "description": "The uuid of an existing record in the transaction_categories table.", "disabled": false }, { "key": "date_start", "value": "2021-01-01", "description": "Start date. O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "date_end", "value": "2021-01-31", "description": "End date. O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "bank_accounts[0]", "value": "architecto", "description": "The uuid of an existing record in the bank_accounts table.", "disabled": false }, { "key": "customers[0]", "value": "architecto", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "architecto", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "architecto", "description": "The uuid of an existing record in the works table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/cash-flows\/summary?sortBy=created_at&sortDesc=1&q=Salary&cash_session=uuid&type=entrada&description=Eius+et+animi+quos+velit+et.&categories[0]=architecto&date_start=2021-01-01&date_end=2021-01-31&bank_accounts[0]=architecto&customers[0]=architecto&suppliers[0]=architecto&works[0]=architecto" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get cash flow summary" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"total_income\":\"number\",\"total_expense\":\"number\",\"total_fee\":\"number\",\"total_balance\":\"number\"}}", "name": "" } ] }, { "name": "List cash flow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-flows", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Salary", "description": "Search query.", "disabled": false }, { "key": "cash_session", "value": "uuid", "description": "Cash session. The uuid of an existing record in the cash_sessions table.", "disabled": false }, { "key": "type", "value": "entrada", "description": "Cash flow type.", "disabled": false }, { "key": "description", "value": "Eius+et+animi+quos+velit+et.", "description": "Description .", "disabled": false }, { "key": "categories[0]", "value": "architecto", "description": "The uuid of an existing record in the transaction_categories table.", "disabled": false }, { "key": "date_start", "value": "2021-01-01", "description": "Start date. O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "date_end", "value": "2021-01-31", "description": "End date. O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "bank_accounts[0]", "value": "architecto", "description": "The uuid of an existing record in the bank_accounts table.", "disabled": false }, { "key": "customers[0]", "value": "architecto", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "architecto", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "architecto", "description": "The uuid of an existing record in the works table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/cash-flows?sortBy=created_at&sortDesc=1&q=Salary&cash_session=uuid&type=entrada&description=Eius+et+animi+quos+velit+et.&categories[0]=architecto&date_start=2021-01-01&date_end=2021-01-31&bank_accounts[0]=architecto&customers[0]=architecto&suppliers[0]=architecto&works[0]=architecto" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all cash flow" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"a4855dc5-0acb-33c3-b921-f4291f719ca0\",\"type\":\"tarifa\",\"amount\":-8754.55,\"description\":\"Et fugiat sunt nihil accusantium.\",\"transaction_date\":\"1990-07-03T03:00:00.000000Z\",\"transaction_category\":{\"id\":null,\"name\":null,\"type\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"cd1eb1ea-4697-3b9a-9dd0-988044a83af6\",\"type\":\"entrada\",\"amount\":6303.26,\"description\":\"Provident perspiciatis quo omnis nostrum aut adipisci quidem.\",\"transaction_date\":\"2015-01-19T02:00:00.000000Z\",\"transaction_category\":{\"id\":null,\"name\":null,\"type\":null},\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create cash flow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-flows", "query": [], "raw": "{{baseUrl}}\/api\/cash-flows" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"Example Type\",\"cash_session_id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"transaction_category_id\":\"fa253524-dd6a-3fdb-a788-0cabcf134db7\",\"bank_account_id\":\"45d1e1f4-e38d-3971-92c7-6d933b3b67fa\",\"customer_id\":\"8c352249-2535-3e45-8de4-d6620458a778\",\"supplier_id\":\"61733391-0acb-3d07-80fa-6a559e639b13\",\"work_id\":\"338aa13c-ee9b-3c59-9dad-eeca56f85ba2\",\"amount\":1,\"description\":\"Example Description\",\"transaction_date\":\"2024-01-01\"}" }, "description": "Create a new cash flow" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Show cash flow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-flows\/:cashFlow", "query": [], "raw": "{{baseUrl}}\/api\/cash-flows\/:cashFlow", "variable": [ { "id": "cashFlow", "key": "cashFlow", "value": "16", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a cash flow" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"type\":\"transfer\\u00eancia\",\"amount\":-6620.31,\"description\":\"Commodi incidunt iure odit.\",\"transaction_date\":\"1977-08-15T03:00:00.000000Z\",\"transaction_category\":{\"id\":null,\"name\":null,\"type\":null},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Update cash flow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-flows\/:cashFlow", "query": [], "raw": "{{baseUrl}}\/api\/cash-flows\/:cashFlow", "variable": [ { "id": "cashFlow", "key": "cashFlow", "value": "16", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"Example Type\",\"cash_session_id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"transaction_category_id\":\"fa253524-dd6a-3fdb-a788-0cabcf134db7\",\"bank_account_id\":\"45d1e1f4-e38d-3971-92c7-6d933b3b67fa\",\"customer_id\":\"8c352249-2535-3e45-8de4-d6620458a778\",\"supplier_id\":\"61733391-0acb-3d07-80fa-6a559e639b13\",\"work_id\":\"338aa13c-ee9b-3c59-9dad-eeca56f85ba2\",\"amount\":1,\"description\":\"Example Description\",\"transaction_date\":\"2024-01-01\"}" }, "description": "Update a cash flow" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete cash flow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-flows\/:cashFlow", "query": [], "raw": "{{baseUrl}}\/api\/cash-flows\/:cashFlow", "variable": [ { "id": "cashFlow", "key": "cashFlow", "value": "16", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a cash flow" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] } ] }, { "name": "Cash Session", "description": "Endpoints for cash session", "item": [ { "name": "List cash session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-sessions", "query": [], "raw": "{{baseUrl}}\/api\/cash-sessions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all cash session" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"opened_by\":null,\"opened_at\":\"2023-03-17T11:56:05.000000Z\",\"closed_by\":null,\"closed_at\":\"2020-05-23T06:21:42.000000Z\",\"opening_balance\":3669.26,\"closing_balance\":6620.31,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Fechado\",\"created_at\":\"1983-05-17T03:07:42.000000Z\",\"updated_at\":\"1990-05-07T06:45:25.000000Z\"},{\"id\":\"fa253524-dd6a-3fdb-a788-0cabcf134db7\",\"opened_by\":null,\"opened_at\":\"2019-02-24T11:41:44.000000Z\",\"closed_by\":null,\"closed_at\":\"2009-07-27T04:40:06.000000Z\",\"opening_balance\":8853.25,\"closing_balance\":275.37,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Fechado\",\"created_at\":\"2003-07-15T08:01:07.000000Z\",\"updated_at\":\"2019-08-30T13:55:51.000000Z\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Open cash session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-sessions\/open", "query": [], "raw": "{{baseUrl}}\/api\/cash-sessions\/open" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Open a new cash session" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"opened_by\":null,\"opened_at\":\"2023-03-17T11:56:05.000000Z\",\"closed_by\":null,\"closed_at\":\"2020-05-23T06:21:42.000000Z\",\"opening_balance\":3669.26,\"closing_balance\":6620.31,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Fechado\",\"created_at\":\"1983-05-17T03:07:42.000000Z\",\"updated_at\":\"1990-05-07T06:45:25.000000Z\"}}", "name": "" } ] }, { "name": "Close cash session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-sessions\/close\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/cash-sessions\/close\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Close a cash session" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Show cash session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-sessions\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/cash-sessions\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a cash session" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"opened_by\":null,\"opened_at\":\"2023-03-17T11:56:05.000000Z\",\"closed_by\":null,\"closed_at\":\"2020-05-23T06:21:42.000000Z\",\"opening_balance\":3669.26,\"closing_balance\":6620.31,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Fechado\",\"created_at\":\"1983-05-17T03:07:42.000000Z\",\"updated_at\":\"1990-05-07T06:45:25.000000Z\"}}", "name": "" } ] }, { "name": "Delete cash session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-sessions\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/cash-sessions\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a cash session" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] } ] }, { "name": "Customers", "description": "Endpoints for customers", "item": [ { "name": "List customers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customers", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Customer+name", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/customers?sortBy=created_at&sortDesc=1&q=Customer+name" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all customers" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"e3342fd7-0e43-33a4-9b4d-9acf41af3cee\",\"name\":\"Luzia Vasques Bezerra\",\"email\":\"yfaro@example.org\",\"phone\":\"(24) 93926-9781\",\"document\":\"776.069.637-03\",\"type\":\"pj\",\"responsible\":\"Sra. Micaela Bianca Maia Jr.\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents_count\":0},{\"id\":\"d8dfc377-41e0-31f7-8611-66bd3ebc9c7d\",\"name\":\"Dr. Roberto Fabiano Arruda\",\"email\":\"clarice60@example.net\",\"phone\":\"(86) 98353-1004\",\"document\":\"800.712.698-86\",\"type\":\"pf\",\"responsible\":\"Jorge Reis Estrada Filho\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents_count\":0}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customers", "query": [], "raw": "{{baseUrl}}\/api\/customers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"email\":\"user@example.com\",\"phone\":\"(11) 99999-9999\",\"document\":\"Example Document\",\"type\":\"Example Type\",\"responsible\":\"Example Responsible\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"address\":{\"0\":\"example1\",\"1\":\"example2\",\"street\":\"Example Address street\",\"number\":\"Example Address number\",\"complement\":\"Example Address complement\",\"neighborhood\":\"Example Address neighborhood\",\"city\":\"Example Address city\",\"state\":\"Example Address state\",\"zip_code\":\"Example Address zip code\"}}" }, "description": "Create a new customer" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\",\"id\":\"string\"}", "name": "" } ] }, { "name": "Get customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the customer." }, { "id": "customer", "key": "customer", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Customer ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a customer" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"email\":\"yohanna44@example.org\",\"phone\":\"(94) 94866-9606\",\"document\":\"790.915.066-01\",\"type\":\"pj\",\"responsible\":\"Sra. Katherine de Arruda\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents_count\":0}}", "name": "" } ] }, { "name": "Update customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the customer." }, { "id": "customer", "key": "customer", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Customer ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"email\":\"user@example.com\",\"phone\":\"(11) 99999-9999\",\"document\":\"Example Document\",\"type\":\"Example Type\",\"responsible\":\"Example Responsible\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"address\":{\"0\":\"example1\",\"1\":\"example2\",\"street\":\"Example Address street\",\"number\":\"Example Address number\",\"complement\":\"Example Address complement\",\"neighborhood\":\"Example Address neighborhood\",\"city\":\"Example Address city\",\"state\":\"Example Address state\",\"zip_code\":\"Example Address zip code\"}}" }, "description": "Update a customer" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customers\/:customer", "query": [], "raw": "{{baseUrl}}\/api\/customers\/:customer", "variable": [ { "id": "customer", "key": "customer", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Customer ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a customer" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Document Categories", "description": "Endpoints for document categories", "item": [ { "name": "List document categories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/document-categories", "query": [ { "key": "q", "value": "Contracts", "description": "Search query.", "disabled": false }, { "key": "module", "value": "employee", "description": "Filter by module.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/document-categories?q=Contracts&module=employee" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all document categories" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"description\":\"Et et modi ipsum nostrum. Autem et consequatur aut dolores enim non facere tempora.\",\"module\":\"document\"},{\"id\":\"690f4e21-70e0-3516-8ade-d6c679dacb9e\",\"name\":\"Juliano Cl\\u00e9ber Dias Filho\",\"description\":\"Fugit qui repudiandae laboriosam est alias. Ratione nemo voluptate accusamus ut et recusandae modi rerum. Repellendus assumenda et tenetur ab reiciendis.\",\"module\":\"document\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Show document category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/document-categories\/:documentCategory", "query": [], "raw": "{{baseUrl}}\/api\/document-categories\/:documentCategory", "variable": [ { "id": "documentCategory", "key": "documentCategory", "value": "architecto", "description": "Document category UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a document category" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"description\":\"Et et modi ipsum nostrum. Autem et consequatur aut dolores enim non facere tempora.\",\"module\":\"document\"}}", "name": "" } ] }, { "name": "Create document category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/document-categories", "query": [], "raw": "{{baseUrl}}\/api\/document-categories" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"description\":\"Example Description\",\"module\":\"Example Module\"}" }, "description": "Create a new document category" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update document category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/document-categories\/:documentCategory", "query": [], "raw": "{{baseUrl}}\/api\/document-categories\/:documentCategory", "variable": [ { "id": "documentCategory", "key": "documentCategory", "value": "architecto", "description": "Document category UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"description\":\"Example Description\",\"module\":\"Example Module\"}" }, "description": "Update a document category" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete document category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/document-categories\/:documentCategory", "query": [], "raw": "{{baseUrl}}\/api\/document-categories\/:documentCategory", "variable": [ { "id": "documentCategory", "key": "documentCategory", "value": "architecto", "description": "Document category UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a document category" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Documents", "description": "Endpoints for documents", "item": [ { "name": "List documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Document+name", "description": "", "disabled": false }, { "key": "categories[0]", "value": "architecto", "description": "The uuid of an existing record in the document_categories table.", "disabled": false }, { "key": "documentable_type", "value": "architecto", "description": "Type of the related documentable entity. The type of an existing record in the documentables table.", "disabled": false }, { "key": "customers[0]", "value": "architecto", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "architecto", "description": "The uuid of an existing record in the suppliers table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/documents?sortBy=created_at&sortDesc=1&q=Document+name&categories[0]=architecto&documentable_type=architecto&customers[0]=architecto&suppliers[0]=architecto" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all documents" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"a4855dc5-0acb-33c3-b921-f4291f719ca0\",\"name\":\"Sr. Emerson Torres Ferminiano\",\"file\":{\"id\":null,\"url\":null,\"extension\":null,\"current_version\":null,\"created_at\":null},\"share_token\":null,\"is_shared_active\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"5707ca55-f609-3528-be8b-1baeaee1567e\",\"name\":\"Srta. Rayane Galindo\",\"file\":{\"id\":null,\"url\":null,\"extension\":null,\"current_version\":null,\"created_at\":null},\"share_token\":null,\"is_shared_active\":null,\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Get document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/documents\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the document." }, { "id": "document", "key": "document", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Document ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a document" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"file\":{\"id\":null,\"url\":null,\"extension\":null,\"current_version\":null,\"created_at\":null},\"share_token\":null,\"is_shared_active\":null,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents", "query": [], "raw": "{{baseUrl}}\/api\/documents" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"category_id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"file\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example File path\",\"name\":\"Example Name\",\"extension\":\"Example File extension\",\"size\":\"Example File size\"},\"documentable_type\":\"Example Documentable type\",\"documentable_id\":\"Example Documentable id\"}" }, "description": "Create a new document" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/documents\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the document." }, { "id": "document", "key": "document", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Document ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"category_id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"file\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example File path\",\"name\":\"Example Name\",\"extension\":\"Example File extension\",\"size\":\"Example File size\"},\"documentable_type\":\"Example Documentable type\",\"documentable_id\":\"Example Documentable id\"}" }, "description": "Update a document" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents\/:document", "query": [], "raw": "{{baseUrl}}\/api\/documents\/:document", "variable": [ { "id": "document", "key": "document", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Document ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a document" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Generate share link", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents\/:document\/share", "query": [], "raw": "{{baseUrl}}\/api\/documents\/:document\/share", "variable": [ { "id": "document", "key": "document", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Document ID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Generate a unique share link for a document" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\",\"token\":\"string\"}", "name": "" } ] }, { "name": "Revoke share link", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents\/:document\/share", "query": [], "raw": "{{baseUrl}}\/api\/documents\/:document\/share", "variable": [ { "id": "document", "key": "document", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Document ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revoke the share link for a document" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] } ] }, { "name": "Employee Roles", "description": "Endpoints for employee roles", "item": [ { "name": "List employee roles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employee-roles", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Manager", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/employee-roles?sortBy=created_at&sortDesc=1&q=Manager" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all employee roles" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"2d7afb98-02af-4ffa-a730-622d9adea297\",\"name\":\"non\",\"description\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"312c7f66-47e8-48cc-bdaa-f9a5c08d4cc5\",\"name\":\"deleniti\",\"description\":null,\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Show employee role", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employee-roles\/:employeeRole", "query": [], "raw": "{{baseUrl}}\/api\/employee-roles\/:employeeRole", "variable": [ { "id": "employeeRole", "key": "employeeRole", "value": "architecto", "description": "Employee Role UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show an employee role" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"d64f288e-d007-42c4-aedd-827e96ab0701\",\"name\":\"aut\",\"description\":\"Nostrum qui commodi incidunt iure.\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create employee role", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employee-roles", "query": [], "raw": "{{baseUrl}}\/api\/employee-roles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"description\":\"Eius et animi quos velit et.\"}" }, "description": "Create a new employee role" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update employee role", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employee-roles\/:employeeRole", "query": [], "raw": "{{baseUrl}}\/api\/employee-roles\/:employeeRole", "variable": [ { "id": "employeeRole", "key": "employeeRole", "value": "architecto", "description": "Employee Role UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"description\":\"Eius et animi quos velit et.\"}" }, "description": "Update an employee role" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete employee role", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employee-roles\/:employeeRole", "query": [], "raw": "{{baseUrl}}\/api\/employee-roles\/:employeeRole", "variable": [ { "id": "employeeRole", "key": "employeeRole", "value": "architecto", "description": "Employee Role UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an employee role" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Employees", "description": "Endpoints for employees", "item": [ { "name": "List employees", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Jo%C3%A3o+Silva", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/employees?sortBy=created_at&sortDesc=1&q=Jo%C3%A3o+Silva" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all employees" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"9187f645-b401-4061-b3cf-f259496916df\",\"name\":\"Rodrigo Leon\",\"cpf\":\"421.700.432-81\",\"rg\":\"590214902\",\"ctps\":null,\"phone\":null,\"birthdate\":\"1982-06-09\",\"email\":\"valdez.jacomo@example.org\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":null,\"name\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"62167803-e751-4a50-9306-82cf6e2440c2\",\"name\":\"Elaine Kamila Serna Neto\",\"cpf\":\"323.759.947-24\",\"rg\":\"504415490\",\"ctps\":\"691282316\",\"phone\":\"(93) 3757-0170\",\"birthdate\":null,\"email\":null,\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":null,\"name\":null},\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Show employee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:id", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show an employee" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"170568d9-7d20-4e28-beea-69876bb90a21\",\"name\":\"Rodrigo Leon\",\"cpf\":\"421.700.432-81\",\"rg\":\"590214902\",\"ctps\":null,\"phone\":null,\"birthdate\":\"1982-06-09\",\"email\":\"valdez.jacomo@example.org\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":null,\"name\":null},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create employee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees", "query": [], "raw": "{{baseUrl}}\/api\/employees" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"cpf\":\"ngzmiyvdljnikh\",\"rg\":\"waykcmyuwpwlvqwr\",\"ctps\":\"sitcpscqldzsnrwt\",\"phone\":\"ujwvlxjklqppwqbe\",\"birthdate\":\"2026-01-12T19:22:33\",\"email\":\"kutch.cynthia@example.org\",\"employee_role_id\":\"architecto\"}" }, "description": "Create a new employee" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update employee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:id", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"cpf\":\"ngzmiyvdljnikh\",\"rg\":\"waykcmyuwpwlvqwr\",\"ctps\":\"sitcpscqldzsnrwt\",\"phone\":\"ujwvlxjklqppwqbe\",\"birthdate\":\"2026-01-12T19:22:34\",\"email\":\"kutch.cynthia@example.org\",\"employee_role_id\":\"architecto\"}" }, "description": "Update an employee" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete employee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee", "variable": [ { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an employee" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "GET api\/reports\/cash-flow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/cash-flow", "query": [], "raw": "{{baseUrl}}\/api\/reports\/cash-flow" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/reports\/accounts-payable-receivable", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/accounts-payable-receivable", "query": [], "raw": "{{baseUrl}}\/api\/reports\/accounts-payable-receivable" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/up", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/up", "query": [], "raw": "{{baseUrl}}\/api\/up" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"message\":\"API is running\"}", "name": "" } ] } ] }, { "name": "File Versions", "description": "Endpoints for file version management", "item": [ { "name": "Create version", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/files\/:fileUuid\/versions", "query": [], "raw": "{{baseUrl}}\/api\/files\/:fileUuid\/versions", "variable": [ { "id": "fileUuid", "key": "fileUuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "The UUID of the file to version" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"path\":\"Example Path\",\"size\":\"Example Size\",\"extension\":\"Example Extension\",\"responsible_user_id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\"}" }, "description": "Create a new version and update file with new data" }, "response": [ { "header": [], "code": 201, "body": null, "name": "" } ] }, { "name": "List versions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/files\/:fileUuid\/versions", "query": [], "raw": "{{baseUrl}}\/api\/files\/:fileUuid\/versions", "variable": [ { "id": "fileUuid", "key": "fileUuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "The UUID of the file" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all versions of a file" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"string\",\"version_number\":\"integer\",\"name\":\"string\",\"size\":\"string\",\"extension\":\"string\",\"created_by\":\"object\",\"created_at\":\"datetime\"}]}", "name": "" } ] }, { "name": "Get version", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/file-versions\/:versionUuid", "query": [], "raw": "{{baseUrl}}\/api\/file-versions\/:versionUuid", "variable": [ { "id": "versionUuid", "key": "versionUuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "The UUID of the version" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get details of a specific version" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"string\",\"version_number\":\"integer\",\"name\":\"string\",\"size\":\"string\",\"extension\":\"string\",\"created_by\":\"object\",\"created_at\":\"datetime\"}", "name": "" } ] }, { "name": "Restore version", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/file-versions\/:versionUuid\/restore", "query": [], "raw": "{{baseUrl}}\/api\/file-versions\/:versionUuid\/restore", "variable": [ { "id": "versionUuid", "key": "versionUuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "The UUID of the version to restore" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Restore a version as the current file" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Version restored successfully\"}", "name": "" } ] }, { "name": "Download version", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/file-versions\/:versionUuid\/download", "query": [], "raw": "{{baseUrl}}\/api\/file-versions\/:versionUuid\/download", "variable": [ { "id": "versionUuid", "key": "versionUuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "The UUID of the version to download" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Generate signed URL for downloading a specific version" }, "response": [ { "header": [], "code": 200, "body": "{\"url\":\"string\",\"filename\":\"string\",\"size\":\"string\",\"version_number\":\"integer\"}", "name": "" } ] }, { "name": "Delete version", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/file-versions\/:versionUuid", "query": [], "raw": "{{baseUrl}}\/api\/file-versions\/:versionUuid", "variable": [ { "id": "versionUuid", "key": "versionUuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "The UUID of the version to delete" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Soft delete a specific version" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Files", "description": "Endpoints for files", "item": [ { "name": "Delete file", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/files\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/files\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a file" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Get file info", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/files\/:uuid\/info", "query": [], "raw": "{{baseUrl}}\/api\/files\/:uuid\/info", "variable": [ { "id": "uuid", "key": "uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get file information" }, "response": [ { "header": [], "code": 200, "body": "{\"uuid\":\"string\",\"name\":\"string\",\"size\":\"integer\",\"type\":\"string\",\"extension\":\"string\",\"path\":\"string\"}", "name": "" } ] }, { "name": "Generate download URL", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/files\/:uuid\/download", "query": [], "raw": "{{baseUrl}}\/api\/files\/:uuid\/download", "variable": [ { "id": "uuid", "key": "uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "The UUID of the file to download" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Generate a signed URL for downloading a file" }, "response": [ { "header": [], "code": 200, "body": "{\"url\":\"string\",\"filename\":\"string\",\"size\":\"integer\",\"type\":\"string\"}", "name": "" } ] }, { "name": "Generate upload URL", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/files\/generate-upload-url", "query": [], "raw": "{{baseUrl}}\/api\/files\/generate-upload-url" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"path\":\"Example Path\",\"mimetype\":\"Example Mimetype\",\"public\":false}" }, "description": "Generate a signed URL for uploading a file" }, "response": [ { "header": [], "code": 200, "body": "{\"url\":\"string\",\"path\":\"string\",\"headers\":\"array\"}", "name": "" } ] }, { "name": "Generate bulk upload URL", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/files\/generate-bulk-upload-url", "query": [], "raw": "{{baseUrl}}\/api\/files\/generate-bulk-upload-url" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"files\":[{\"path\":\"Example Files * path\",\"mimetype\":\"Example Files * mimetype\",\"public\":false},null]}" }, "description": "Generate signed URLs for uploading multiple files" }, "response": [ { "header": [], "code": 200, "body": "[{\"url\":\"string\",\"path\":\"string\",\"headers\":\"array\"}]", "name": "" } ] } ] }, { "name": "Import", "description": "Endpoints for managing NFe imports and product processing.", "item": [ { "name": "NFe Imports", "description": "Import and process Brazilian electronic invoice (NFe) files.", "item": [ { "name": "Create NFe Import", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports\/nfe\/products", "query": [], "raw": "{{baseUrl}}\/api\/imports\/nfe\/products" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"s3_file_path\":\"imports\\\/nfe_12345.xml\",\"original_filename\":\"nota_fiscal_001.xml\",\"import_type\":\"nfe\"}" }, "description": "Upload and process a Brazilian NFe (Nota Fiscal Eletr\u00f4nica) XML file. The file should be uploaded to S3 first, then this endpoint processes it asynchronously." }, "response": [ { "header": [], "code": 201, "body": "{\n \"import_id\": \"9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\",\n \"status\": \"pending\",\n \"channel\": \"import-progress.9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\"\n }", "name": "Import created successfully" }, { "header": [], "code": 404, "body": "{\"error\": \"Arquivo n\u00e3o encontrado no S3\"}", "name": "File not found in S3" }, { "header": [], "code": 422, "body": "{\"error\": \"Arquivo XML inv\u00e1lido ou n\u00e3o \u00e9 uma NFe\"}", "name": "Invalid XML or not a valid NFe" } ] }, { "name": "List User Imports", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "status", "value": "completed", "description": "Filter imports by status (pending, processing, completed, failed).", "disabled": false }, { "key": "import_type", "value": "nfe", "description": "Filter imports by type.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of imports per page. O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/imports?sortBy=created_at&sortDesc=1&status=completed&import_type=nfe&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all NFe imports for the authenticated user with filtering and pagination options." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\",\n \"status\": \"completed\",\n \"import_type\": \"nfe\",\n \"original_filename\": \"nota_fiscal_001.xml\",\n \"nfe_number\": \"123456\",\n \"nfe_date\": \"2023-12-01\",\n \"total_products\": 15,\n \"processed_products\": 15,\n \"progress_percentage\": 100.00,\n \"imported_at\": \"2023-12-01T10:30:00.000Z\",\n \"supplier\": {\n \"name\": \"Fornecedor Ltda\",\n \"document\": \"12345678000199\"\n }\n }\n ]\n }", "name": "Imports retrieved successfully" } ] }, { "name": "Get Import Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports\/:importId", "query": [], "raw": "{{baseUrl}}\/api\/imports\/:importId", "variable": [ { "id": "importId", "key": "importId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve detailed information about a specific NFe import, including progress and supplier data." }, "response": [ { "header": [], "code": 200, "body": "{\n \"import_id\": \"9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\",\n \"status\": \"completed\",\n \"import_type\": \"nfe\",\n \"original_filename\": \"nota_fiscal_001.xml\",\n \"nfe_number\": \"123456\",\n \"nfe_date\": \"2023-12-01\",\n \"total_products\": 15,\n \"processed_products\": 10,\n \"progress_percentage\": 66.67,\n \"imported_by\": \"Jo\u00e3o Silva\",\n \"imported_at\": \"2023-12-01T10:30:00.000Z\",\n \"supplier\": {\n \"id\": \"supplier-uuid\",\n \"name\": \"Fornecedor Ltda\",\n \"document\": \"12345678000199\"\n },\n \"channel\": \"import-progress.9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\"\n }", "name": "Import details retrieved successfully" } ] }, { "name": "Get Import Products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports\/:importId\/products", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "status", "value": "pending", "description": "Filter products by processing status (pending, processed).", "disabled": false }, { "key": "q", "value": "Produto+ABC", "description": "Search products by name \/ code \/ EAN. O campo value n\u00e3o pode ser superior a 255 caracteres.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of products per page. O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/imports\/:importId\/products?sortBy=created_at&sortDesc=1&status=pending&q=Produto+ABC&per_page=15", "variable": [ { "id": "importId", "key": "importId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all products from a specific NFe import with filtering and pagination options." }, "response": [ { "header": [], "code": 200, "body": "{\n \"import\": {\n \"id\": \"9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\",\n \"total_products\": 15,\n \"processed_products\": 10,\n \"progress_percentage\": 66.67\n },\n \"products\": {\n \"data\": [\n {\n \"id\": \"product-uuid\",\n \"supplier_product_code\": \"ABC123\",\n \"ean_code\": \"7891234567890\",\n \"name\": \"Nome do Produto\",\n \"unit\": \"UN\",\n \"quantity\": 10,\n \"unit_price\": 15.50,\n \"total_price\": 155.00,\n \"is_processed\": false,\n \"system_product\": null,\n \"linked_at\": null,\n \"linked_by\": null\n }\n ]\n },\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 15,\n \"last_page\": 1\n }\n }", "name": "Products retrieved successfully" } ] }, { "name": "Link Products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports\/:importId\/products\/link", "query": [], "raw": "{{baseUrl}}\/api\/imports\/:importId\/products\/link", "variable": [ { "id": "importId", "key": "importId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mappings\":[\"architecto\"]}" }, "description": "Inicia, de forma ass\u00edncrona, a vincula\u00e7\u00e3o de produtos do fornecedor a produtos do sistema ou cria\u00e7\u00e3o de novos itens no estoque. Retorna 202 com o canal para acompanhar o progresso." }, "response": [ { "header": [], "code": 202, "body": "{\n \"message\": \"Vincula\u00e7\u00e3o de produtos iniciada com sucesso\",\n \"total_mappings\": 2,\n \"channel\": \"imports.{import-uuid}\"\n }", "name": "Linking accepted and started asynchronously" }, { "header": [], "code": 422, "body": "{\"error\": \"Erro ao vincular produtos: Product not found\"}", "name": "Error linking products" } ] } ] } ] }, { "name": "Integration Keys", "description": "Endpoints para gerenciar chaves de integra\u00e7\u00e3o", "item": [ { "name": "Listar chaves", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/integration-keys", "query": [], "raw": "{{baseUrl}}\/api\/integration-keys" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lista todas as chaves de integra\u00e7\u00e3o do usu\u00e1rio autenticado" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"a0d2301b-08aa-4ae2-a27c-8fdf802d8cc1\",\"name\":\"Integracao Voltec\",\"status\":\"active\",\"expires_at\":null,\"last_used_at\":\"2026-01-12T17:18:02-03:00\",\"last_used_ip\":\"179.190.116.68\",\"created_at\":\"2026-01-12T16:28:26-03:00\"},{\"id\":\"a0d2301b-08aa-4ae2-a27c-8fdf802d8cc1\",\"name\":\"Integracao Voltec\",\"status\":\"active\",\"expires_at\":null,\"last_used_at\":\"2026-01-12T17:18:02-03:00\",\"last_used_ip\":\"179.190.116.68\",\"created_at\":\"2026-01-12T16:28:26-03:00\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Criar chave", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/integration-keys", "query": [], "raw": "{{baseUrl}}\/api\/integration-keys" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"expires_at\":\"2052-02-06\"}" }, "description": "Cria uma nova chave de integra\u00e7\u00e3o" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"uuid\",\"name\":\"string\"},\"token\":\"eyJ...\",\"message\":\"Integration key created. Save the token - it will not be shown again.\"}", "name": "" } ] }, { "name": "Ver chave", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/integration-keys\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/integration-keys\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "1", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retorna os detalhes de uma chave de integra\u00e7\u00e3o" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"a0d2301b-08aa-4ae2-a27c-8fdf802d8cc1\",\"name\":\"Integracao Voltec\",\"status\":\"active\",\"expires_at\":null,\"last_used_at\":\"2026-01-12T17:18:02-03:00\",\"last_used_ip\":\"179.190.116.68\",\"created_at\":\"2026-01-12T16:28:26-03:00\"}}", "name": "" } ] }, { "name": "Atualizar chave", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/integration-keys\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/integration-keys\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "1", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"status\":\"inactive\"}" }, "description": "Atualiza o nome ou status de uma chave de integra\u00e7\u00e3o" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Integration key updated\"}", "name": "" } ] }, { "name": "Excluir chave", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/integration-keys\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/integration-keys\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "1", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Exclui uma chave de integra\u00e7\u00e3o" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Revogar chave", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/integration-keys\/:uuid\/revoke", "query": [], "raw": "{{baseUrl}}\/api\/integration-keys\/:uuid\/revoke", "variable": [ { "id": "uuid", "key": "uuid", "value": "1", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revoga uma chave de integra\u00e7\u00e3o, tornando-a inv\u00e1lida imediatamente" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Integration key revoked\"}", "name": "" } ] } ] }, { "name": "Notifications", "description": "Endpoints for user notifications", "item": [ { "name": "List notifications", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "per_page", "value": "1", "description": "O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "module", "value": "CashFlow", "description": "Filter by module name. O campo value n\u00e3o pode ser superior a 100 caracteres.", "disabled": false }, { "key": "type", "value": "success", "description": "Filter by type (ex.: info, success, warning, error). O campo value n\u00e3o pode ser superior a 100 caracteres.", "disabled": false }, { "key": "priority", "value": "10", "description": "Filter by priority number. O campo value deve ser pelo menos 0. O campo value n\u00e3o pode ser superior a 255.", "disabled": false }, { "key": "unread_only", "value": "1", "description": "Only unread notifications when true.", "disabled": false }, { "key": "read_status", "value": "unread", "description": "Filter by read status (all, read, unread).", "disabled": false }, { "key": "date_start", "value": "2024-01-01", "description": "Filter notifications created from this date (YYYY-MM-DD). O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "date_end", "value": "2024-12-31", "description": "Filter notifications created until this date (YYYY-MM-DD). O campo value deve ser uma data v\u00e1lida. O campo value deve ser uma data posterior ou igual a date_start.", "disabled": false }, { "key": "q", "value": "erro+faturamento", "description": "Search by title\/message. O campo value n\u00e3o pode ser superior a 255 caracteres.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/notifications?sortBy=created_at&sortDesc=1&per_page=1&module=CashFlow&type=success&priority=10&unread_only=1&read_status=unread&date_start=2024-01-01&date_end=2024-12-31&q=erro+faturamento" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List user notifications" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Mark notifications as read", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications\/mark-as-read", "query": [], "raw": "{{baseUrl}}\/api\/notifications\/mark-as-read" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"notifications\":[\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"]}" }, "description": "Mark one or many notifications as read" }, "response": [] }, { "name": "Mark notifications as unread", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications\/mark-as-unread", "query": [], "raw": "{{baseUrl}}\/api\/notifications\/mark-as-unread" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"notifications\":[\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"]}" }, "description": "Mark one or many notifications as unread" }, "response": [] }, { "name": "Mark all notifications as read", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications\/mark-all-as-read", "query": [], "raw": "{{baseUrl}}\/api\/notifications\/mark-all-as-read" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Mark all user notifications as read" }, "response": [] }, { "name": "Unread notifications count", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications\/unread-count", "query": [], "raw": "{{baseUrl}}\/api\/notifications\/unread-count" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Count of unread notifications for the user" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Permission Groups", "description": "Endpoints for permission groups", "item": [ { "name": "List permission groups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/permission-groups", "query": [], "raw": "{{baseUrl}}\/api\/permission-groups" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all permission groups" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"nostrum-qui\",\"display_name\":\"commodi incidunt iure\",\"active\":null,\"permissions_count\":0,\"created_at\":null,\"updated_at\":null},{\"id\":\"d9be5934-80e7-34a9-a136-841b5f0aea83\",\"name\":\"modi-ipsum\",\"display_name\":\"nostrum omnis autem\",\"active\":null,\"permissions_count\":0,\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create permission group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/permission-groups", "query": [], "raw": "{{baseUrl}}\/api\/permission-groups" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"display_name\":\"Example Name\",\"active\":false}" }, "description": "Create a new permission group" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update permission group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/permission-groups\/:permissionGroup", "query": [], "raw": "{{baseUrl}}\/api\/permission-groups\/:permissionGroup", "variable": [ { "id": "permissionGroup", "key": "permissionGroup", "value": "1", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"display_name\":\"Example Name\",\"active\":false}" }, "description": "Update a permission group" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Show permission group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/permission-groups\/:permissionGroup", "query": [], "raw": "{{baseUrl}}\/api\/permission-groups\/:permissionGroup", "variable": [ { "id": "permissionGroup", "key": "permissionGroup", "value": "1", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a permission group" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"nostrum-qui\",\"display_name\":\"commodi incidunt iure\",\"active\":null,\"permissions_count\":0,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Delete permission group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/permission-groups\/:permissionGroup", "query": [], "raw": "{{baseUrl}}\/api\/permission-groups\/:permissionGroup", "variable": [ { "id": "permissionGroup", "key": "permissionGroup", "value": "1", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a permission group" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Product Brands", "description": "Endpoints for product brands", "item": [ { "name": "List product brands", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-brands", "query": [ { "key": "q", "value": "Structure", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/api\/product-brands?q=Structure" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all product brands" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"created_at\":null,\"updated_at\":null},{\"id\":\"c68e0767-6220-31fb-a489-61093ff79529\",\"name\":\"Valentin Ramos Zamana\",\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Show product brand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-brands\/:productBrand", "query": [], "raw": "{{baseUrl}}\/api\/product-brands\/:productBrand", "variable": [ { "id": "productBrand", "key": "productBrand", "value": "architecto", "description": "Product brand UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a product brand" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create product brand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-brands", "query": [], "raw": "{{baseUrl}}\/api\/product-brands" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"architecto\"}" }, "description": "Create a new product brand" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update product brand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-brands\/:productBrand", "query": [], "raw": "{{baseUrl}}\/api\/product-brands\/:productBrand", "variable": [ { "id": "productBrand", "key": "productBrand", "value": "architecto", "description": "Product brand UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"architecto\"}" }, "description": "Update a product brand" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete product brand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-brands\/:productBrand", "query": [], "raw": "{{baseUrl}}\/api\/product-brands\/:productBrand", "variable": [ { "id": "productBrand", "key": "productBrand", "value": "architecto", "description": "Product brand UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a product brand" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Product Families", "description": "Endpoints for product families", "item": [ { "name": "List product families", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-families", "query": [ { "key": "q", "value": "Structure", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/api\/product-families?q=Structure" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all product families" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"fe8c33bd-b2e3-3135-9ddc-2be0ed5a1675\",\"name\":\"Dr. Denis Valentin Pereira\",\"created_at\":null,\"updated_at\":null},{\"id\":\"06d27cd5-aeb6-3542-bbe9-9c7ed118a07a\",\"name\":\"Srta. F\\u00e1tima Clara Gon\\u00e7alves\",\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Show product family", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-families\/:productFamily", "query": [], "raw": "{{baseUrl}}\/api\/product-families\/:productFamily", "variable": [ { "id": "productFamily", "key": "productFamily", "value": "architecto", "description": "Product family UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a product family" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create product family", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-families", "query": [], "raw": "{{baseUrl}}\/api\/product-families" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"architecto\"}" }, "description": "Create a new product family" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update product family", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-families\/:productFamily", "query": [], "raw": "{{baseUrl}}\/api\/product-families\/:productFamily", "variable": [ { "id": "productFamily", "key": "productFamily", "value": "architecto", "description": "Product family UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"architecto\"}" }, "description": "Update a product family" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete product family", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-families\/:productFamily", "query": [], "raw": "{{baseUrl}}\/api\/product-families\/:productFamily", "variable": [ { "id": "productFamily", "key": "productFamily", "value": "architecto", "description": "Product family UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a product family" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Products", "description": "Endpoints for products", "item": [ { "name": "List products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Brick", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/products?sortBy=created_at&sortDesc=1&q=Brick" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all products" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"code\":\"PRD-265058\",\"stock\":7365,\"product_family\":{\"id\":\"a0d26e61-5410-4a5c-a6ee-66d5b7b27847\",\"name\":\"Elaine Kamila Serna Neto\"},\"product_brand\":{\"id\":\"a0d26e61-60ae-4c5c-965a-98dcd52686a1\",\"name\":\"Liz Sueli Pacheco Neto\"},\"unit\":{\"id\":\"a0d26e61-64d4-4c93-b7a3-c65decf9e1dd\",\"name\":\"Mia Let\\u00edcia Velasques Jr.\",\"abbreviation\":\"Srta. Talita Zambrano\"},\"image\":{\"id\":null,\"url\":null},\"description\":\"Odit et et modi.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"241611a0-a07b-352b-9f83-f15a091959e3\",\"name\":\"Dr. Yasmin Duarte Queir\\u00f3s Filho\",\"code\":\"PRD-312753\",\"stock\":49,\"product_family\":{\"id\":\"a0d26e61-6b0b-497d-a0d2-715610a13269\",\"name\":\"Dr. S\\u00e9rgio Hernani Pontes\"},\"product_brand\":{\"id\":\"a0d26e61-6d85-485a-acbd-170cd55dcc37\",\"name\":\"Dr. Iasmin Leon Neto\"},\"unit\":{\"id\":\"a0d26e61-6fe1-4be6-a689-a7f3e955f244\",\"name\":\"Sr. Andr\\u00e9 Jimenes Prado Neto\",\"abbreviation\":\"Sr. Cristian Beltr\\u00e3o\"},\"image\":{\"id\":null,\"url\":null},\"description\":\"Aut molestiae sunt suscipit doloribus fugiat.\",\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Show product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products\/:id", "query": [], "raw": "{{baseUrl}}\/api\/products\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the product." }, { "id": "product", "key": "product", "value": "architecto", "description": "Product UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a product" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"code\":\"PRD-265058\",\"stock\":7365,\"product_family\":{\"id\":\"a0d26e61-7bc5-4487-bd6f-dcf05b78b4c1\",\"name\":\"Elaine Kamila Serna Neto\"},\"product_brand\":{\"id\":\"a0d26e61-7e6e-454a-89ed-8e18ad55791c\",\"name\":\"Liz Sueli Pacheco Neto\"},\"unit\":{\"id\":\"a0d26e61-80b7-44a3-bd00-343ff0602a77\",\"name\":\"Mia Let\\u00edcia Velasques Jr.\",\"abbreviation\":\"Srta. Talita Zambrano\"},\"image\":{\"id\":null,\"url\":null},\"description\":\"Odit et et modi.\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products", "query": [], "raw": "{{baseUrl}}\/api\/products" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"product_family_id\":\"architecto\",\"product_brand_id\":\"architecto\",\"unit_id\":\"architecto\",\"description\":\"Eius et animi quos velit et.\",\"stock\":60}" }, "description": "Create a new product" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update product ", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products\/:id", "query": [], "raw": "{{baseUrl}}\/api\/products\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the product." }, { "id": "product", "key": "product", "value": "architecto", "description": "Product UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"product_family_id\":\"architecto\",\"product_brand_id\":\"architecto\",\"unit_id\":\"architecto\",\"stock\":39,\"description\":\"Eius et animi quos velit et.\"}" }, "description": "Update a product " }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products\/:product", "query": [], "raw": "{{baseUrl}}\/api\/products\/:product", "variable": [ { "id": "product", "key": "product", "value": "architecto", "description": "Product UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a product" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Public Documents", "description": "Public endpoints for shared documents", "item": [ { "name": "Get shared document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/public\/documents\/:token", "query": [], "raw": "{{baseUrl}}\/api\/public\/documents\/:token", "variable": [ { "id": "token", "key": "token", "value": "abc123...", "description": "Share token" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a shared document by token", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"a4855dc5-0acb-33c3-b921-f4291f719ca0\",\"name\":\"Sr. Emerson Torres Ferminiano\",\"category\":null,\"created_at\":null}}", "name": "" } ] } ] }, { "name": "Public Single-Use Links", "description": "Public single-use endpoints for documentables", "item": [ { "name": "Get work location by single-use token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/public\/single-use\/work-locations\/:token", "query": [], "raw": "{{baseUrl}}\/api\/public\/single-use\/work-locations\/:token", "variable": [ { "id": "token", "key": "token", "value": "abc123...", "description": "Single-use token" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a work location by single-use token (consumed after first access)", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"a4855dc5-0acb-33c3-b921-f4291f719ca0\",\"description\":\"Sr. Emerson Torres Ferminiano\",\"created_at\":null}}", "name": "" } ] } ] }, { "name": "Responsible", "description": "Endpoints for responsible", "item": [ { "name": "List responsibles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/responsibles", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Responsible+name%2C+email%2C+phone+or+role", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/responsibles?sortBy=created_at&sortDesc=1&q=Responsible+name%2C+email%2C+phone+or+role" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all responsibles" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"email\":\"yohanna44@example.org\",\"phone\":\"(94) 94866-9606\",\"role\":\"consequatur\",\"created_at\":null,\"updated_at\":null},{\"id\":\"ac9e0973-adfe-32df-ade4-9b9752e8c6ad\",\"name\":\"Srta. Mait\\u00ea Simone Rangel\",\"email\":\"sandra09@example.com\",\"phone\":\"(98) 4569-6081\",\"role\":\"doloremque\",\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create responsible", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/responsibles", "query": [], "raw": "{{baseUrl}}\/api\/responsibles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"role\":\"Example Role\",\"email\":\"user@example.com\",\"phone\":\"(11) 99999-9999\",\"works\":[\"bfc53181-d647-36b2-9080-f9c2b76006f4\"]}" }, "description": "Create a new responsible" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Get responsible", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/responsibles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/responsibles\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the responsible." }, { "id": "responsible", "key": "responsible", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Responsible ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a responsible" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"email\":\"yohanna44@example.org\",\"phone\":\"(94) 94866-9606\",\"role\":\"consequatur\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Update responsible", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/responsibles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/responsibles\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the responsible." }, { "id": "responsible", "key": "responsible", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Responsible ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"role\":\"Example Role\",\"email\":\"user@example.com\",\"phone\":\"(11) 99999-9999\",\"works\":[\"bfc53181-d647-36b2-9080-f9c2b76006f4\"]}" }, "description": "Update a responsible" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete responsible", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/responsibles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/responsibles\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the responsible." }, { "id": "responsible", "key": "responsible", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Responsible ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a responsible" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Sectors", "description": "Endpoints for sectors", "item": [ { "name": "List sectors", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Tecnologia", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/sectors?sortBy=created_at&sortDesc=1&q=Tecnologia" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all sectors" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"quidem nostrum\",\"slug\":null,\"description\":null,\"abbreviation\":\"qwr\",\"created_at\":null,\"updated_at\":null},{\"id\":\"fa253524-dd6a-3fdb-a788-0cabcf134db7\",\"name\":\"modi ipsum\",\"slug\":null,\"description\":null,\"abbreviation\":null,\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create sector", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors", "query": [], "raw": "{{baseUrl}}\/api\/sectors" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"slug\":\"Example Slug\",\"description\":\"Example Description\",\"abbreviation\":\"Example Abbreviation\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"url\":\"https:\\\/\\\/example.com\",\"name\":\"Example Name\",\"size\":\"Example Image size\",\"extension\":\"Example Image extension\"}}" }, "description": "Create a new sector" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Get sector", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors\/:id", "query": [], "raw": "{{baseUrl}}\/api\/sectors\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the sector." }, { "id": "sector", "key": "sector", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Sector ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a sector" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"quidem nostrum\",\"slug\":null,\"description\":null,\"abbreviation\":\"qwr\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Update sector", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors\/:id", "query": [], "raw": "{{baseUrl}}\/api\/sectors\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the sector." }, { "id": "sector", "key": "sector", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Sector ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"slug\":\"Example Slug\",\"description\":\"Example Description\",\"abbreviation\":\"Example Abbreviation\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"url\":\"https:\\\/\\\/example.com\",\"name\":\"Example Name\",\"size\":\"Example Image size\",\"extension\":\"Example Image extension\"}}" }, "description": "Update a sector" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete sector", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors\/:id", "query": [], "raw": "{{baseUrl}}\/api\/sectors\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the sector." }, { "id": "sector", "key": "sector", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Sector ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a sector" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "List sector users", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors\/:sector\/users", "query": [], "raw": "{{baseUrl}}\/api\/sectors\/:sector\/users", "variable": [ { "id": "sector", "key": "sector", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Sector UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all users assigned to a sector" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Miss Pearl Hauck\",\"username\":\"pauline09\",\"email\":\"mitchell.matilda@example.org\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"f2726f3d-9044-3663-bede-2a0f37053879\",\"name\":\"Mrs. Abbey Gaylord MD\",\"username\":\"madisen51\",\"email\":\"qankunding@example.com\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Attach users to sector", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors\/:sector\/users\/attach", "query": [], "raw": "{{baseUrl}}\/api\/sectors\/:sector\/users\/attach", "variable": [ { "id": "sector", "key": "sector", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Sector UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"users\":[\"9e13baad-9e20-392f-94ab-6047f7ff6a83\"]}" }, "description": "Attach users to a sector without removing existing ones. Expects an array of user UUIDs in the \"users\" field." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Users attached successfully\"}", "name": "" } ] }, { "name": "Detach users from sector", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors\/:sector\/users\/detach", "query": [], "raw": "{{baseUrl}}\/api\/sectors\/:sector\/users\/detach", "variable": [ { "id": "sector", "key": "sector", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Sector UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"users\":[\"c7bf1d68-67aa-3fb7-979d-eaef8e3908bc\"]}" }, "description": "Remove specific users from a sector. Expects an array of user UUIDs in the \"users\" field." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Users detached successfully\"}", "name": "" } ] }, { "name": "Sync sector users", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors\/:sector\/users\/sync", "query": [], "raw": "{{baseUrl}}\/api\/sectors\/:sector\/users\/sync", "variable": [ { "id": "sector", "key": "sector", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Sector UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"users\":[\"ea57fb8f-9953-354e-9184-d01c4ec16bb0\"]}" }, "description": "Replace all sector users with the provided list. Expects an array of user UUIDs in the \"users\" field." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Users synchronized successfully\"}", "name": "" } ] } ] }, { "name": "Status Modules", "description": "Endpoints for modules that have status", "item": [ { "name": "List status modules", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/status-modules", "query": [], "raw": "{{baseUrl}}\/api\/status-modules" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all modules that have status functionality" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"name\":\"aut adipisci\",\"slug\":\"nostrum-qui-commodi-incidunt-iure\"},{\"name\":\"omnis autem\",\"slug\":\"consequatur-aut-dolores-enim-non-facere-tempora\"}]}", "name": "" } ] } ] }, { "name": "Statuses", "description": "Endpoints for statuses", "item": [ { "name": "List statuses", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/statuses", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Em+andamento", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/statuses?sortBy=created_at&sortDesc=1&q=Em+andamento" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all statuses" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"description\":\"Sr. George de Souza Delvalle\",\"abbreviation\":\"iure\",\"color\":\"#aa8e3f\",\"text_color\":\"#559641\",\"created_at\":null,\"updated_at\":null},{\"id\":\"665a39c0-48af-31f1-a546-aa4f41372488\",\"description\":\"Sra. J\\u00e9ssica Sep\\u00falveda Jr.\",\"abbreviation\":\"aut\",\"color\":\"#005d49\",\"text_color\":\"#8a9b1e\",\"module\":{\"name\":\"Obras\",\"slug\":\"work\"},\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/statuses", "query": [], "raw": "{{baseUrl}}\/api\/statuses" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"Eius et animi quos velit et.\",\"abbreviation\":\"v\",\"module\":\"architecto\",\"sector_id\":\"architecto\",\"color\":\"architecto\",\"text_color\":\"architecto\"}" }, "description": "Create a new status" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Get status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/statuses\/:id", "query": [], "raw": "{{baseUrl}}\/api\/statuses\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the status." }, { "id": "status", "key": "status", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Status ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a status" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"description\":\"Sr. George de Souza Delvalle\",\"abbreviation\":\"iure\",\"color\":\"#aa8e3f\",\"text_color\":\"#559641\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Update status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/statuses\/:id", "query": [], "raw": "{{baseUrl}}\/api\/statuses\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the status." }, { "id": "Status", "key": "Status", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Status ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"Eius et animi quos velit et.\",\"abbreviation\":\"v\",\"module\":\"architecto\",\"sector_id\":\"architecto\",\"color\":\"architecto\",\"text_color\":\"architecto\"}" }, "description": "Update a status" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/statuses\/:status", "query": [], "raw": "{{baseUrl}}\/api\/statuses\/:status", "variable": [ { "id": "status", "key": "status", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Status ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a status" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Suppliers", "description": "Endpoints for suppliers", "item": [ { "name": "List suppliers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/suppliers", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Supplier+name", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/suppliers?sortBy=created_at&sortDesc=1&q=Supplier+name" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all suppliers" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"email\":\"yohanna44@example.org\",\"phone\":\"(94) 94866-9606\",\"document\":\"90.915.066\\\/0001-02\",\"type\":\"pj\",\"responsible\":\"Sra. Katherine de Arruda\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null}},{\"id\":\"c71cb930-01f3-381c-9172-e1c70e63388f\",\"name\":\"Liz Sueli Pacheco Neto\",\"email\":\"jrosa@example.net\",\"phone\":\"(49) 3996-5127\",\"document\":\"69.737.788\\\/0001-10\",\"type\":\"pf\",\"responsible\":\"Sr. Rodrigo Gil\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null}}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create supplier", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/suppliers", "query": [], "raw": "{{baseUrl}}\/api\/suppliers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"email\":\"user@example.com\",\"phone\":\"(11) 99999-9999\",\"document\":\"Example Document\",\"type\":\"Example Type\",\"responsible\":\"Example Responsible\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"address\":{\"0\":\"example1\",\"1\":\"example2\",\"street\":\"Example Address street\",\"number\":\"Example Address number\",\"complement\":\"Example Address complement\",\"neighborhood\":\"Example Address neighborhood\",\"city\":\"Example Address city\",\"state\":\"Example Address state\",\"zip_code\":\"Example Address zip code\"}}" }, "description": "Create a new supplier" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Get supplier", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/suppliers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/suppliers\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the supplier." }, { "id": "supplier", "key": "supplier", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Supplier ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a supplier" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"email\":\"yohanna44@example.org\",\"phone\":\"(94) 94866-9606\",\"document\":\"90.915.066\\\/0001-02\",\"type\":\"pj\",\"responsible\":\"Sra. Katherine de Arruda\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null}}}", "name": "" } ] }, { "name": "Update supplier", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/suppliers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/suppliers\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the supplier." }, { "id": "supplier", "key": "supplier", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Supplier ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"email\":\"user@example.com\",\"phone\":\"(11) 99999-9999\",\"document\":\"Example Document\",\"type\":\"Example Type\",\"responsible\":\"Example Responsible\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"address\":{\"0\":\"example1\",\"1\":\"example2\",\"street\":\"Example Address street\",\"number\":\"Example Address number\",\"complement\":\"Example Address complement\",\"neighborhood\":\"Example Address neighborhood\",\"city\":\"Example Address city\",\"state\":\"Example Address state\",\"zip_code\":\"Example Address zip code\"}}" }, "description": "Update a supplier" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete supplier", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/suppliers\/:supplier", "query": [], "raw": "{{baseUrl}}\/api\/suppliers\/:supplier", "variable": [ { "id": "supplier", "key": "supplier", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Supplier ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a supplier" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "System Types", "description": "Endpoints for system types", "item": [ { "name": "System Types", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/system-types", "query": [], "raw": "{{baseUrl}}\/api\/system-types" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the system types" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"bankAccountTypes\":{\"key\":\"value\"},\"fileTypes\":{\"key\":\"value\"},\"legalEntityTypes\":{\"key\":\"value\"},\"transactionTypes\":{\"key\":\"value\"}}}", "name": "" } ] } ] }, { "name": "Transaction Categories", "description": "Endpoints for transaction categories", "item": [ { "name": "List transaction categories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction-categories", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Salary", "description": "Search query.", "disabled": false }, { "key": "type", "value": "entrada", "description": "Transaction type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/transaction-categories?sortBy=created_at&sortDesc=1&q=Salary&type=entrada" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all transaction categories" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"description\":\"Et et modi ipsum nostrum. Autem et consequatur aut dolores enim non facere tempora.\",\"type\":\"sa\\u00edda\"},{\"id\":\"8529678e-de6b-32f2-9f70-231a0d681563\",\"name\":\"Dr. Erik Dias Feliciano\",\"description\":\"Qui repudiandae laboriosam est alias. Ratione nemo voluptate accusamus ut et recusandae modi rerum. Repellendus assumenda et tenetur ab reiciendis.\",\"type\":\"sa\\u00edda\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Show transaction category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction-categories\/:transactionCategory", "query": [], "raw": "{{baseUrl}}\/api\/transaction-categories\/:transactionCategory", "variable": [ { "id": "transactionCategory", "key": "transactionCategory", "value": "architecto", "description": "Transaction category UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a transaction category" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"description\":\"Et et modi ipsum nostrum. Autem et consequatur aut dolores enim non facere tempora.\",\"type\":\"sa\\u00edda\"}}", "name": "" } ] }, { "name": "Create transaction category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction-categories", "query": [], "raw": "{{baseUrl}}\/api\/transaction-categories" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"description\":\"Example Description\",\"type\":\"Example Type\"}" }, "description": "Create a new transaction category" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update transaction category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction-categories\/:transactionCategory", "query": [], "raw": "{{baseUrl}}\/api\/transaction-categories\/:transactionCategory", "variable": [ { "id": "transactionCategory", "key": "transactionCategory", "value": "architecto", "description": "Transaction category UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"description\":\"Example Description\",\"type\":\"Example Type\"}" }, "description": "Update a transaction category" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete transaction category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction-categories\/:transactionCategory", "query": [], "raw": "{{baseUrl}}\/api\/transaction-categories\/:transactionCategory", "variable": [ { "id": "transactionCategory", "key": "transactionCategory", "value": "architecto", "description": "Transaction category UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a transaction category" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Units", "description": "Endpoints for units", "item": [ { "name": "List units", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/units", "query": [ { "key": "q", "value": "Structure", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/api\/units?q=Structure" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all units" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"abbreviation\":\"Edilson Caldeira Filho\",\"description\":\"Id aut libero aliquam veniam.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"2024410d-26cd-3763-b1f0-31011d306e58\",\"name\":\"Dr. Luciano Val\\u00eancia Delvalle\",\"abbreviation\":\"Erik Matheus Feliciano Filho\",\"description\":\"Et error neque recusandae et.\",\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Show unit", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/units\/:id", "query": [], "raw": "{{baseUrl}}\/api\/units\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the unit." }, { "id": "unit", "key": "unit", "value": "architecto", "description": "Unit UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a unit" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"abbreviation\":\"Edilson Caldeira Filho\",\"description\":\"Id aut libero aliquam veniam.\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create unit", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/units", "query": [], "raw": "{{baseUrl}}\/api\/units" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"architecto\",\"abbreviation\":\"architecto\",\"description\":\"Eius et animi quos velit et.\"}" }, "description": "Create a new unit" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update unit", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/units\/:id", "query": [], "raw": "{{baseUrl}}\/api\/units\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the unit." }, { "id": "unit", "key": "unit", "value": "architecto", "description": "Unit UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"architecto\",\"abbreviation\":\"architecto\",\"description\":\"Eius et animi quos velit et.\"}" }, "description": "Update a unit" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete unit", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/units\/:unit", "query": [], "raw": "{{baseUrl}}\/api\/units\/:unit", "variable": [ { "id": "unit", "key": "unit", "value": "architecto", "description": "Unit UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a unit" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "User Requests", "description": "Endpoints for user registration requests", "item": [ { "name": "Create user request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user-requests", "query": [], "raw": "{{baseUrl}}\/api\/user-requests" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"email\":\"zbailey@example.net\",\"document\":\"architecto\",\"customer_document\":\"architecto\",\"user_type\":\"filial\"}" }, "description": "Create a new user registration request (public endpoint)", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"Solicita\\u00e7\\u00e3o criada com sucesso\",\"data\":{\"uuid\":\"string\",\"name\":\"string\",\"email\":\"string\",\"status\":\"string\"}}", "name": "" } ] }, { "name": "Validate token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user-requests\/token\/:token", "query": [], "raw": "{{baseUrl}}\/api\/user-requests\/token\/:token", "variable": [ { "id": "token", "key": "token", "value": "abc123-def456-ghi789", "description": "Registration token" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Validate a registration token (public endpoint)", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"valid\":true,\"email\":\"user@example.com\",\"name\":\"User Name\"}", "name": "" } ] }, { "name": "Complete registration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user-requests\/password", "query": [], "raw": "{{baseUrl}}\/api\/user-requests\/password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"architecto\",\"password\":\"|]|{+-\"}" }, "description": "Complete user registration by setting password (public endpoint)", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"Cadastro conclu\\u00eddo com sucesso\",\"user\":{\"uuid\":\"string\",\"email\":\"string\",\"name\":\"string\"}}", "name": "" } ] }, { "name": "Renew token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user-requests\/renew-token", "query": [], "raw": "{{baseUrl}}\/api\/user-requests\/renew-token" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"old_token\":\"architecto\"}" }, "description": "Renew an expired registration token (public endpoint)", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Novo token enviado para seu email\",\"email\":\"user@example.com\"}", "name": "" } ] }, { "name": "List user requests", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user-requests", "query": [], "raw": "{{baseUrl}}\/api\/user-requests" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all user registration requests" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"uuid\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"email\":\"yohanna44@example.org\",\"document\":\"05913505212\",\"customer_document\":\"95107365\",\"user_type\":\"matriz\",\"status\":\"pending\",\"rejection_reason\":null,\"created_at\":null,\"updated_at\":null},{\"uuid\":\"d34becdc-c0c1-3b29-91d0-b8358c864cf4\",\"name\":\"Elaine Kamila Serna Neto\",\"email\":\"tdesouza@example.net\",\"document\":\"69128231651\",\"customer_document\":\"97647809\",\"user_type\":\"filial\",\"status\":\"pending\",\"rejection_reason\":null,\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Get user request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user-requests\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/user-requests\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "User Request UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a user registration request by UUID" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uuid\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"email\":\"yohanna44@example.org\",\"document\":\"05913505212\",\"customer_document\":\"95107365\",\"user_type\":\"matriz\",\"status\":\"pending\",\"rejection_reason\":null,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "List available CNPJs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user-requests\/:uuid\/cnpjs", "query": [], "raw": "{{baseUrl}}\/api\/user-requests\/:uuid\/cnpjs", "variable": [ { "id": "uuid", "key": "uuid", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "User Request UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List available CNPJs for a user request based on the customer document root" }, "response": [ { "header": [], "code": 200, "body": "{\"available_cnpjs\":[{\"cnpj\":\"string\",\"name\":\"string\"}],\"selected_cnpjs\":[\"string\"]}", "name": "" } ] }, { "name": "Select CNPJs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user-requests\/:uuid\/cnpjs", "query": [], "raw": "{{baseUrl}}\/api\/user-requests\/:uuid\/cnpjs", "variable": [ { "id": "uuid", "key": "uuid", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "User Request UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"cnpjs\":[\"architecto\"]}" }, "description": "Select CNPJs that the user will have access to" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"CNPJs selecionados com sucesso\"}", "name": "" } ] }, { "name": "Approve user request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user-requests\/:uuid\/approve", "query": [], "raw": "{{baseUrl}}\/api\/user-requests\/:uuid\/approve", "variable": [ { "id": "uuid", "key": "uuid", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "User Request UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Approve a pending user registration request" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Solicita\\u00e7\\u00e3o aprovada com sucesso\",\"data\":{\"uuid\":\"string\",\"status\":\"approved\"}}", "name": "" } ] }, { "name": "Reject user request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user-requests\/:uuid\/reject", "query": [], "raw": "{{baseUrl}}\/api\/user-requests\/:uuid\/reject", "variable": [ { "id": "uuid", "key": "uuid", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "User Request UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"b\"}" }, "description": "Reject a pending user registration request" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Solicita\\u00e7\\u00e3o rejeitada com sucesso\",\"data\":{\"uuid\":\"string\",\"status\":\"rejected\"}}", "name": "" } ] } ] }, { "name": "Users", "description": "Endpoints for users", "item": [ { "name": "List users", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users", "query": [ { "key": "q", "value": "User+name", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/users?q=User+name" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all users" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Miss Pearl Hauck\",\"username\":\"balistreri.josiane\",\"email\":\"wbatz@example.net\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"8529678e-de6b-32f2-9f70-231a0d681563\",\"name\":\"Gerhard Beier\",\"username\":\"doris.franecki\",\"email\":\"pagac.skylar@example.org\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "List technical users", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/technical", "query": [], "raw": "{{baseUrl}}\/api\/users\/technical" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all users from the technical sector" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Miss Pearl Hauck\",\"email\":\"oking@example.net\"},{\"id\":\"0733da06-3f67-3b0d-b923-684c336397e5\",\"name\":\"Vito Bradtke\",\"email\":\"skylar.kuvalis@example.net\"}]}", "name": "" } ] }, { "name": "Get user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a user" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Miss Pearl Hauck\",\"username\":\"libby.bradtke\",\"email\":\"torp.florence@example.org\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]}}", "name": "" } ] }, { "name": "Create user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users", "query": [], "raw": "{{baseUrl}}\/api\/users" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"email\":\"user@example.com\",\"username\":\"schmidt.elton\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"067d00f5-e958-3b01-bc80-7e5e367be869\"],\"roles\":[\"af49b819-28db-33bd-b66b-66e0bad1c5fa\"]}" }, "description": "Create a new user" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the user." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"email\":\"user@example.com\",\"username\":\"franecki.brennon\",\"password\":\"password123\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"4d08ad85-13a7-32e9-86de-fb3dca87190a\"],\"roles\":[\"143f14ee-91a0-3454-b6d3-a0238f33b92b\"]}" }, "description": "Update a user" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user", "variable": [ { "id": "user", "key": "user", "value": "1", "description": "The user." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a user" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Reset user password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user\/password-reset", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user\/password-reset", "variable": [ { "id": "user", "key": "user", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "User ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Reset a user password" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Password reset successfully to foobaar\"}", "name": "" } ] }, { "name": "Attach permissions to user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user\/permissions", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user\/permissions", "variable": [ { "id": "user", "key": "user", "value": "1", "description": "The user." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"permissions\":[\"bfc53181-d647-36b2-9080-f9c2b76006f4\"]}" }, "description": "Attach direct permissions to a user" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Permissions attached successfully\"}", "name": "" } ] }, { "name": "List user direct permissions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user\/permissions", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user\/permissions", "variable": [ { "id": "user", "key": "user", "value": "1", "description": "The user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List direct permissions associated with a user" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"name\":\"quidem\",\"display_name\":\"Qui commodi incidunt iure odit.\"},{\"id\":null,\"name\":\"modi\",\"display_name\":\"Nostrum omnis autem et consequatur aut.\"}]}", "name": "" } ] } ] }, { "name": "Work Locations", "description": "Endpoints for work locations", "item": [ { "name": "List work locations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/work-locations", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Tecnologia", "description": "Search query.", "disabled": false }, { "key": "work", "value": "uuid", "description": "Work. The uuid of an existing record in the works table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/work-locations?sortBy=created_at&sortDesc=1&q=Tecnologia&work=uuid" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all work locations" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"description\":\"Sr. George de Souza Delvalle\",\"work\":{\"id\":null,\"name\":null},\"documents\":[],\"created_at\":null,\"updated_at\":null},{\"id\":\"c68e0767-6220-31fb-a489-61093ff79529\",\"description\":\"Valentin Ramos Zamana\",\"work\":{\"id\":null,\"name\":null},\"documents\":[],\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create work location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/work-locations", "query": [], "raw": "{{baseUrl}}\/api\/work-locations" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"Eius et animi quos velit et.\",\"work_id\":\"architecto\"}" }, "description": "Create a new work location" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Get work location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/work-locations\/:workLocation", "query": [], "raw": "{{baseUrl}}\/api\/work-locations\/:workLocation", "variable": [ { "id": "workLocation", "key": "workLocation", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Work Location ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a work location" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"description\":\"Sr. George de Souza Delvalle\",\"work\":{\"id\":null,\"name\":null},\"documents\":[],\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Update work location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/work-locations\/:workLocation", "query": [], "raw": "{{baseUrl}}\/api\/work-locations\/:workLocation", "variable": [ { "id": "workLocation", "key": "workLocation", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Work ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"Eius et animi quos velit et.\"}" }, "description": "Update a work location" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete work location", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/work-locations\/:workLocation", "query": [], "raw": "{{baseUrl}}\/api\/work-locations\/:workLocation", "variable": [ { "id": "workLocation", "key": "workLocation", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Work ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a work location" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Works", "description": "Endpoints for works", "item": [ { "name": "List works", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/works", "query": [ { "key": "sortBy", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sortDesc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "q", "value": "Tecnologia", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/works?sortBy=created_at&sortDesc=1&q=Tecnologia" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all works" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents\":[],\"locations\":[],\"responsibles\":[],\"started_at\":{\"date\":\"1983-05-17 00:07:42.000000\",\"timezone_type\":3,\"timezone\":\"America\\\/Sao_Paulo\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"d9be5934-80e7-34a9-a136-841b5f0aea83\",\"name\":\"Wilson Zamana Valdez Sobrinho\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents\":[],\"locations\":[],\"responsibles\":[],\"started_at\":{\"date\":\"2009-07-27 01:40:06.000000\",\"timezone_type\":3,\"timezone\":\"America\\\/Sao_Paulo\"},\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create work", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/works", "query": [], "raw": "{{baseUrl}}\/api\/works" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"customer_id\":\"architecto\",\"status_id\":\"architecto\",\"started_at\":\"2026-01-12T19:22:35\",\"address\":{\"street\":\"architecto\",\"number\":\"architecto\",\"neighborhood\":\"architecto\",\"city\":\"architecto\",\"state\":\"architecto\",\"zip_code\":\"architecto\"}}" }, "description": "Create a new work" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Get work", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/works\/:id", "query": [], "raw": "{{baseUrl}}\/api\/works\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the work." }, { "id": "work", "key": "work", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Work ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a work" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents\":[],\"locations\":[],\"responsibles\":[],\"started_at\":{\"date\":\"1983-05-17 00:07:42.000000\",\"timezone_type\":3,\"timezone\":\"America\\\/Sao_Paulo\"},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Update work", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/works\/:id", "query": [], "raw": "{{baseUrl}}\/api\/works\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the work." }, { "id": "work", "key": "work", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Work ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"customer_id\":\"architecto\",\"status_id\":\"architecto\",\"started_at\":\"2026-01-12T19:22:35\"}" }, "description": "Update a work" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete work", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/works\/:id", "query": [], "raw": "{{baseUrl}}\/api\/works\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the work." }, { "id": "work", "key": "work", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Work ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a work" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "List work responsibles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/works\/:work\/responsibles", "query": [], "raw": "{{baseUrl}}\/api\/works\/:work\/responsibles", "variable": [ { "id": "work", "key": "work", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Work UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all responsibles assigned to a work" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bfc53181-d647-36b2-9080-f9c2b76006f4\",\"name\":\"Sr. George de Souza Delvalle\",\"email\":\"yohanna44@example.org\",\"phone\":\"(94) 94866-9606\",\"role\":\"consequatur\",\"created_at\":null,\"updated_at\":null},{\"id\":\"ac9e0973-adfe-32df-ade4-9b9752e8c6ad\",\"name\":\"Srta. Mait\\u00ea Simone Rangel\",\"email\":\"sandra09@example.com\",\"phone\":\"(98) 4569-6081\",\"role\":\"doloremque\",\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Attach responsibles to work", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/works\/:work\/responsibles\/attach", "query": [], "raw": "{{baseUrl}}\/api\/works\/:work\/responsibles\/attach", "variable": [ { "id": "work", "key": "work", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Work UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"responsibles\":[\"bfc53181-d647-36b2-9080-f9c2b76006f4\"]}" }, "description": "Attach responsibles to a work without removing existing ones. Expects an array of responsible UUIDs in the \"responsibles\" field." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Responsibles attached successfully\"}", "name": "" } ] }, { "name": "Detach responsibles from work", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/works\/:work\/responsibles\/detach", "query": [], "raw": "{{baseUrl}}\/api\/works\/:work\/responsibles\/detach", "variable": [ { "id": "work", "key": "work", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Work UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"responsibles\":[\"bfc53181-d647-36b2-9080-f9c2b76006f4\"]}" }, "description": "Remove specific responsibles from a work. Expects an array of responsible UUIDs in the \"responsibles\" field." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Responsibles detached successfully\"}", "name": "" } ] }, { "name": "Sync work responsibles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/works\/:work\/responsibles\/sync", "query": [], "raw": "{{baseUrl}}\/api\/works\/:work\/responsibles\/sync", "variable": [ { "id": "work", "key": "work", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Work UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"responsibles\":[\"bfc53181-d647-36b2-9080-f9c2b76006f4\"]}" }, "description": "Replace all work responsibles with the provided list. Expects an array of responsible UUIDs in the \"responsibles\" field." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Responsibles synchronized successfully\"}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }