{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.bs-homolog.pensou.app.br" } ], "info": { "name": "BS Homolog API Documentation", "_postman_id": "51facaeb-d238-486b-8180-792f17d91a96", "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\":\"3b65a232-0f04-3136-afc3-b7ac38def540\",\"name\":\"aut-6a397079ad9a4\",\"display_name\":\"Ut dignissimos eum qui autem ut.\",\"permissions_count\":null},{\"id\":\"91cf45ae-3f2b-3e63-ba6a-be30f8d3b3ee\",\"name\":\"architecto-6a397079b6f97\",\"display_name\":\"Et ut quae omnis libero.\",\"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\":[\"7d834b81-aa6a-3a35-ad3c-77bdb2c00a4f\"]}" }, "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\":[\"1c9d235e-d733-32e2-bc24-15b3394251a0\"]}" }, "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\":\"d540922a-c097-381c-8ca2-0826c5a066fe\",\"name\":\"cumque-6a397079d28c9\",\"display_name\":\"Odio voluptatem eum alias perspiciatis.\",\"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\":\"sed\",\"display_name\":\"Dicta necessitatibus laboriosam magni nisi velit ut ut.\"},{\"id\":null,\"name\":\"et\",\"display_name\":\"In ut delectus quia saepe.\"}]}", "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\":\"doloremque\",\"display_name\":\"Sit doloribus ad eos itaque unde saepe non.\"},{\"id\":null,\"name\":\"nesciunt\",\"display_name\":\"Totam qui qui possimus qui vel voluptas quia minima.\"}],\"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\":\"ut\",\"display_name\":\"Dolores aut et doloribus voluptatem veritatis et deserunt laudantium.\"}}", "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\":\"00b5d7a2-c4ef-36af-a410-743aceae805f\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"boleto\",\"amount\":5700.82,\"due_date\":\"2026-07-02T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"protest_date\":null,\"paid_amount\":null,\"interest_amount\":null,\"penalty_amount\":null,\"notary_fee_amount\":null,\"description\":\"Consequatur beatae laborum iste quos ex minima corrupti a eaque quo sit.\",\"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\":\"earum\",\"field2\":38,\"field3\":true,\"notes\":\"Quo voluptatem amet aut consequatur.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"94b38aec-e6cb-3d03-8fb7-4f03fd92b5ce\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"boleto\",\"amount\":5710.8,\"due_date\":\"2026-07-02T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"protest_date\":null,\"paid_amount\":null,\"interest_amount\":null,\"penalty_amount\":null,\"notary_fee_amount\":null,\"description\":\"Occaecati ipsum consequuntur et quia qui atque hic in eligendi.\",\"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\":\"rerum\",\"field2\":76,\"field3\":false,\"notes\":\"Ducimus aliquam omnis labore veniam.\",\"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": "quia", "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]=quia" }, "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": "Get protest summary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/accounts-payable-receivable\/protests\/summary", "query": [], "raw": "{{baseUrl}}\/api\/accounts-payable-receivable\/protests\/summary" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get summary of accounts with protest status" }, "response": [ { "header": [], "code": 200, "body": "{\"to_protest_count\":\"integer\",\"protested_count\":\"integer\",\"protesting_today_count\":\"integer\",\"total_protest_amount\":\"float\"}", "name": "" } ] }, { "name": "List protested accounts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/accounts-payable-receivable\/protests", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Items per page. O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Salary", "description": "Search query.", "disabled": false }, { "key": "code", "value": "CPR-000123", "description": "Filter by account code.", "disabled": false }, { "key": "type", "value": "entrada", "description": "Type.", "disabled": false }, { "key": "customers[0]", "value": "odit", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "cupiditate", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "sint", "description": "The uuid of an existing record in the works table.", "disabled": false }, { "key": "statuses[0]", "value": "a vencer", "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": "protest_date_start", "value": "2026-06-22T14%3A27%3A22", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "protest_date_end", "value": "2026-06-22T14%3A27%3A22", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "has_protest", "value": "", "description": "", "disabled": true }, { "key": "has_children", "value": "1", "description": "Filter accounts that have recurring children.", "disabled": false }, { "key": "is_recurring", "value": "1", "description": "Filter by recurring status (true: only recurring, false: only non-recurring, null: all).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/accounts-payable-receivable\/protests?sort_by=created_at&sort_desc=1&page=1&per_page=10&q=Salary&code=CPR-000123&type=entrada&customers[0]=odit&suppliers[0]=cupiditate&works[0]=sint&statuses[0]=a vencer&payment_method=cheque&date_start=2023-01-01&date_end=2023-12-31&protest_date_start=2026-06-22T14%3A27%3A22&protest_date_end=2026-06-22T14%3A27%3A22&has_protest=&has_children=1&is_recurring=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List accounts with protest date that are not paid\/canceled" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"2177a342-c42e-3780-8f9d-a7cbc10ce1d4\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"boleto\",\"amount\":8329.74,\"due_date\":\"2026-07-13T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"protest_date\":null,\"paid_amount\":null,\"interest_amount\":null,\"penalty_amount\":null,\"notary_fee_amount\":null,\"description\":\"Sapiente odio voluptatum minima enim vero aut iusto 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\":\"et\",\"field2\":21,\"field3\":false,\"notes\":\"Consequatur et qui error voluptas sunt et.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"e8be35ff-c42e-3e0e-84c2-685b8d5f15ae\",\"code\":null,\"type\":\"sa\\u00edda\",\"payment_method\":\"cheque\",\"amount\":6995.93,\"due_date\":\"2026-06-30T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"protest_date\":null,\"paid_amount\":null,\"interest_amount\":null,\"penalty_amount\":null,\"notary_fee_amount\":null,\"description\":\"Commodi optio ut consequatur nemo dolor velit.\",\"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\":\"omnis\",\"field2\":43,\"field3\":false,\"notes\":\"Aliquid asperiores sint molestias ut.\",\"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": "List accounts payable receivable", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/accounts-payable-receivable", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Items per page. O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Salary", "description": "Search query.", "disabled": false }, { "key": "code", "value": "CPR-000123", "description": "Filter by account code.", "disabled": false }, { "key": "type", "value": "entrada", "description": "Type.", "disabled": false }, { "key": "customers[0]", "value": "dicta", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "aut", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "perspiciatis", "description": "The uuid of an existing record in the works table.", "disabled": false }, { "key": "statuses[0]", "value": "a vencer", "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": "protest_date_start", "value": "2026-06-22T14%3A27%3A22", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "protest_date_end", "value": "2026-06-22T14%3A27%3A22", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "has_protest", "value": "", "description": "", "disabled": true }, { "key": "has_children", "value": "1", "description": "Filter accounts that have recurring children.", "disabled": false }, { "key": "is_recurring", "value": "1", "description": "Filter by recurring status (true: only recurring, false: only non-recurring, null: all).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/accounts-payable-receivable?sort_by=created_at&sort_desc=1&page=1&per_page=10&q=Salary&code=CPR-000123&type=entrada&customers[0]=dicta&suppliers[0]=aut&works[0]=perspiciatis&statuses[0]=a vencer&payment_method=cheque&date_start=2023-01-01&date_end=2023-12-31&protest_date_start=2026-06-22T14%3A27%3A22&protest_date_end=2026-06-22T14%3A27%3A22&has_protest=&has_children=1&is_recurring=1" }, "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\":\"9f1228be-5beb-3336-95a7-5ac63bb7e6df\",\"code\":null,\"type\":\"sa\\u00edda\",\"payment_method\":\"boleto\",\"amount\":6769.27,\"due_date\":\"2026-07-06T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"protest_date\":null,\"paid_amount\":null,\"interest_amount\":null,\"penalty_amount\":null,\"notary_fee_amount\":null,\"description\":\"Aut recusandae omnis est aspernatur quo dolorem.\",\"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\":\"voluptatum\",\"field2\":70,\"field3\":true,\"notes\":\"Nihil et non in distinctio est quam et.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"23a8ea41-647e-3165-8b85-2c10584d9c2d\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"cheque\",\"amount\":3582.34,\"due_date\":\"2026-07-18T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"protest_date\":null,\"paid_amount\":null,\"interest_amount\":null,\"penalty_amount\":null,\"notary_fee_amount\":null,\"description\":\"Et iste quae vel rerum non non nemo perferendis.\",\"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\":\"sed\",\"field2\":52,\"field3\":false,\"notes\":\"At nemo aut qui dolore eius aut aliquid mollitia.\",\"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\":\"c217cfca-78ba-3b1a-878d-16479c11596a\",\"customer_id\":\"0ed7c60d-2df6-3975-96cf-05840ddc0c44\",\"work_id\":\"3235569c-b44a-3ce6-b12d-3291d5a5f0a2\",\"status\":\"Example Status\",\"protest_date\":\"2024-01-01\",\"bank_account_id\":\"030b4c20-bfba-3dee-ac1d-9b211730a6aa\",\"custom_fields\":[\"example1\",\"example2\"],\"is_recurring\":true,\"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": "Import NFe installments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/accounts-payable-receivable\/import-nfe", "query": [], "raw": "{{baseUrl}}\/api\/accounts-payable-receivable\/import-nfe" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"fiscal_document_id\":\"sit\",\"installment_ids\":[\"eius\"],\"payment_method\":\"cheque\"}" }, "description": "Gera contas a pagar para as parcelas selecionadas de uma nota fiscal." }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\",\"total\":\"integer\"}", "name": "" } ] }, { "name": "Get account history", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/accounts-payable-receivable\/:accountPayableReceivable\/history", "query": [], "raw": "{{baseUrl}}\/api\/accounts-payable-receivable\/:accountPayableReceivable\/history", "variable": [ { "id": "accountPayableReceivable", "key": "accountPayableReceivable", "value": "dolor", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the activity log history for an account payable receivable" }, "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 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": "harum", "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\":\"c89b66fe-4592-336f-bb6c-1d45199935ad\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"cheque\",\"amount\":5810.19,\"due_date\":\"2026-07-13T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"protest_date\":null,\"paid_amount\":null,\"interest_amount\":null,\"penalty_amount\":null,\"notary_fee_amount\":null,\"description\":\"Natus tempore autem necessitatibus sint quidem iusto et laudantium.\",\"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\":\"odit\",\"field2\":79,\"field3\":true,\"notes\":\"Dolores aut est nam aut enim dolorem eos odio.\",\"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": "soluta", "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\":\"730f8c3b-6abe-3bd3-958a-6a38139075a3\",\"customer_id\":\"7b0cf902-64bf-3734-b004-0287b4a5c6d8\",\"work_id\":\"cceba3e9-5c20-3687-b79d-60b4b6e1d345\",\"status\":\"Example Status\",\"payment_date\":\"2024-01-01\",\"protest_date\":\"2024-01-01\",\"paid_amount\":1,\"interest_amount\":1,\"penalty_amount\":1,\"notary_fee_amount\":1,\"bank_account_id\":\"e391ecfa-d5a6-3e87-8b4c-f3d9576b931b\",\"custom_fields\":[\"example1\",\"example2\"],\"is_recurring\":true,\"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": "pariatur", "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\":\"hallie68@example.com\",\"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\":\"fb4a1034-7ccf-39a9-aa92-9d1cbd7d1837\",\"name\":\"Madie Bailey\",\"username\":\"lois39\",\"email\":\"orpha.bernier@example.com\",\"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\":\"ritchie.rod\",\"password\":\"password123\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"954a106e-5db6-3a14-abfd-27c81118dca6\"],\"roles\":[\"886f4116-b584-3bb3-b248-ab8759c0e99b\"]}" }, "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\":\"ikudrmpnsivykqql\",\"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": "ipsa", "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": "Generate user token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/:user\/token", "query": [], "raw": "{{baseUrl}}\/api\/auth\/:user\/token", "variable": [ { "id": "user", "key": "user", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "User UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Generate a token for a specific user" }, "response": [ { "header": [], "code": 200, "body": "{\"token\":\"string\",\"userData\":{\"id\":\"uuid\",\"name\":\"string\",\"username\":\"string\",\"email\":\"string\",\"ability\":[\"array\"],\"roles\":[\"array\"],\"preferences\":[\"array\"],\"sectors\":[\"array\"],\"image\":{\"id\":\"uuid\",\"url\":\"string\"}}}", "name": "" } ] } ] }, { "name": "Bank Account Movements", "description": "Endpoints for bank account deposits, withdraws and transfers", "item": [ { "name": "Transfer between bank accounts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts\/transfers", "query": [], "raw": "{{baseUrl}}\/api\/bank-accounts\/transfers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"source_id\":\"Example Source id\",\"destination_id\":\"Example Destination id\",\"amount\":1,\"description\":\"Example Description\",\"transaction_date\":\"2024-01-01\",\"transaction_category_id\":\"Example Transaction category id\"}" }, "description": "Transfers funds from a source account to a destination account" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\",\"data\":\"object\"}", "name": "" } ] }, { "name": "Delete a bank transfer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts\/transfers\/:bankTransfer", "query": [], "raw": "{{baseUrl}}\/api\/bank-accounts\/transfers\/:bankTransfer", "variable": [ { "id": "bankTransfer", "key": "bankTransfer", "value": "qui", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Reverts a transfer by deleting both cash flows and the transfer record" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Deposit into bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts\/:bankAccount\/deposit", "query": [], "raw": "{{baseUrl}}\/api\/bank-accounts\/:bankAccount\/deposit", "variable": [ { "id": "bankAccount", "key": "bankAccount", "value": "17", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"amount\":1,\"description\":\"Example Description\",\"transaction_date\":\"2024-01-01\",\"transaction_category_id\":\"Example Transaction category id\"}" }, "description": "Adds funds to a bank account" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Withdraw from bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts\/:bankAccount\/withdraw", "query": [], "raw": "{{baseUrl}}\/api\/bank-accounts\/:bankAccount\/withdraw", "variable": [ { "id": "bankAccount", "key": "bankAccount", "value": "11", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"amount\":1,\"description\":\"Example Description\",\"transaction_date\":\"2024-01-01\",\"transaction_category_id\":\"Example Transaction category id\"}" }, "description": "Removes funds from a bank account" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "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\":{\"totalBalance\":\"number\",\"totalBalancePositive\":\"number\",\"totalBalanceNegative\":\"number\",\"totalLimit\":\"number\",\"totalAvailableBalance\":\"number\",\"totalUsedLimit\":\"number\",\"totalAvailableLimit\":\"number\",\"accounts\":{\"*\":{\"id\":\"string\",\"bank\":\"string\",\"balance\":\"number\",\"limit\":\"number\",\"available_balance\":\"number\",\"used_limit\":\"number\",\"available_limit\":\"number\"}}}}", "name": "" } ] }, { "name": "Get default bank account by payment method", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts\/default-by-payment-method", "query": [ { "key": "method", "value": "cash", "description": "Forma de pagamento (pix, bank_transfer, cash, check).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/bank-accounts\/default-by-payment-method?method=cash" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the bank account configured as default for the given payment method. Responds 404 when no default is configured." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"898fdca7-7d8b-3b2a-aa58-28c178f0e05e\",\"agency\":\"3649\",\"account\":\"2153344-4\",\"type\":\"corrente\",\"balance\":5086.99,\"holder_type\":\"pf\",\"alias\":\"rerum\",\"limit\":3429.69,\"available_balance\":8516.68,\"used_limit\":0,\"available_limit\":3429.69,\"is_default\":null,\"default_payment_method\":null,\"bank\":{\"id\":null,\"name\":null,\"code\":null},\"created_at\":null,\"updated_at\":null}}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "List bank accounts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "name", "description": "Search query.", "disabled": false }, { "key": "is_default", "value": "1", "description": "Filter by default account (1 or 0).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/bank-accounts?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=name&is_default=1" }, "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\":\"b7837884-419f-3401-a34f-a082adcc22ac\",\"agency\":\"8240\",\"account\":\"7073471-2\",\"type\":\"poupan\\u00e7a\",\"balance\":3683.88,\"holder_type\":\"pf\",\"alias\":\"est\",\"limit\":6410.31,\"available_balance\":10094.19,\"used_limit\":0,\"available_limit\":6410.31,\"is_default\":null,\"default_payment_method\":null,\"bank\":{\"id\":null,\"name\":null,\"code\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"2517c77f-bc29-362e-bb3c-b7422c1ebc88\",\"agency\":\"4815\",\"account\":\"7034613-0\",\"type\":\"poupan\\u00e7a\",\"balance\":9812.76,\"holder_type\":\"pj\",\"alias\":\"harum\",\"limit\":5538.41,\"available_balance\":15351.17,\"used_limit\":0,\"available_limit\":5538.41,\"is_default\":null,\"default_payment_method\":null,\"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\":\"8639268-9\",\"bank_id\":\"09bc7541-9c86-3be5-8261-3f1fae159ce5\",\"type\":\"Example Type\",\"holder_type\":\"Example Holder type\",\"alias\":\"Example Alias\",\"balance\":1,\"limit\":1,\"is_default\":true,\"default_payment_method\":\"Example Default payment method\"}" }, "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": "6", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"agency\":\"Example Agency\",\"account\":\"9937544-4\",\"bank_id\":\"6e39e48d-9eb2-3adc-86d9-39f6fc80a0c1\",\"type\":\"Example Type\",\"holder_type\":\"Example Holder type\",\"alias\":\"Example Alias\",\"balance\":1,\"limit\":1,\"is_default\":true,\"default_payment_method\":\"Example Default payment method\"}" }, "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": "10", "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\":\"5192609c-9f4b-31b4-bbe7-1e6d2a278938\",\"agency\":\"8338\",\"account\":\"8480814-5\",\"type\":\"corrente\",\"balance\":3680.61,\"holder_type\":\"pj\",\"alias\":\"fuga\",\"limit\":9819.41,\"available_balance\":13500.02,\"used_limit\":0,\"available_limit\":9819.41,\"is_default\":null,\"default_payment_method\":null,\"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": "2", "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": "Bank Statements", "description": "Endpoints for bank account statements (extrato banc\u00e1rio)", "item": [ { "name": "Bank statement summary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts\/:bankAccount\/statements\/summary", "query": [], "raw": "{{baseUrl}}\/api\/bank-accounts\/:bankAccount\/statements\/summary", "variable": [ { "id": "bankAccount", "key": "bankAccount", "value": "16", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"date_start\":\"2024-01-01\",\"date_end\":\"2024-01-01\"}" }, "description": "Get aggregated summary for the period" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"opening_balance\":\"number\",\"closing_balance\":\"number\",\"total_credit\":\"number\",\"total_debit\":\"number\",\"count\":\"integer\",\"date_start\":\"string\",\"date_end\":\"string\"}}", "name": "" } ] }, { "name": "List bank statements", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts\/:bankAccount\/statements", "query": [], "raw": "{{baseUrl}}\/api\/bank-accounts\/:bankAccount\/statements", "variable": [ { "id": "bankAccount", "key": "bankAccount", "value": "20", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"sort_by\":\"eaque\",\"sort_desc\":true,\"page\":25,\"per_page\":4,\"q\":\"vmszrwgdozxkidjepjunjdj\",\"type\":\"entrada\",\"date_start\":\"2026-06-22T14:27:23\",\"date_end\":\"2044-07-15\"}" }, "description": "List statements for a bank account. Default period: last 30 days." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"type\":null,\"amount\":null,\"balance_after\":null,\"description\":null,\"date\":null,\"statement_date\":null,\"created_at\":null,\"updated_at\":null},{\"id\":null,\"type\":null,\"amount\":null,\"balance_after\":null,\"description\":null,\"date\":null,\"statement_date\":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 bank statement", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts\/:bankAccount\/statements\/:bankStatement", "query": [], "raw": "{{baseUrl}}\/api\/bank-accounts\/:bankAccount\/statements\/:bankStatement", "variable": [ { "id": "bankAccount", "key": "bankAccount", "value": "7", "description": "" }, { "id": "bankStatement", "key": "bankStatement", "value": "dignissimos", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a specific statement entry" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"type\":null,\"amount\":null,\"balance_after\":null,\"description\":null,\"date\":null,\"statement_date\":null,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] } ] }, { "name": "Banks", "description": "Endpoints for banks", "item": [ { "name": "List banks", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/banks", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Permission+name", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/banks?sort_by=created_at&sort_desc=1&page=1&per_page=15&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\":\"55c255bd-1f74-31bc-b7c7-65f33158d642\",\"name\":\"Ferreira e Ferreira S.A.\",\"code\":\"534\"},{\"id\":\"758c4d52-814f-396d-af28-c85d34547771\",\"name\":\"Pereira e Pereira\",\"code\":\"302\"}],\"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\":\"5662929e-eb71-34b4-94a5-6129d7899e46\",\"name\":\"Cruz e Serra\",\"code\":\"320\"}}", "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": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "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": "Voluptatibus+explicabo+culpa+culpa+ad+ipsam+amet+nihil.", "description": "Description .", "disabled": false }, { "key": "categories[0]", "value": "sunt", "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": "enim", "description": "The uuid of an existing record in the bank_accounts table.", "disabled": false }, { "key": "customers[0]", "value": "quia", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "est", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "ex", "description": "The uuid of an existing record in the works table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/cash-flows\/summary?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Salary&cash_session=uuid&type=entrada&description=Voluptatibus+explicabo+culpa+culpa+ad+ipsam+amet+nihil.&categories[0]=sunt&date_start=2021-01-01&date_end=2021-01-31&bank_accounts[0]=enim&customers[0]=quia&suppliers[0]=est&works[0]=ex" }, "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": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "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": "Quae+ea+et+cupiditate+molestias.", "description": "Description .", "disabled": false }, { "key": "categories[0]", "value": "et", "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": "aliquid", "description": "The uuid of an existing record in the bank_accounts table.", "disabled": false }, { "key": "customers[0]", "value": "dolore", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "esse", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "exercitationem", "description": "The uuid of an existing record in the works table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/cash-flows?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Salary&cash_session=uuid&type=entrada&description=Quae+ea+et+cupiditate+molestias.&categories[0]=et&date_start=2021-01-01&date_end=2021-01-31&bank_accounts[0]=aliquid&customers[0]=dolore&suppliers[0]=esse&works[0]=exercitationem" }, "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\":\"6260a579-4b3a-30ae-a3b5-95fce66c8998\",\"code\":\"FC-20094711\",\"type\":\"transfer\\u00eancia\",\"amount\":-4704.43,\"description\":\"Vel voluptatem repudiandae illo ab rerum.\",\"transaction_date\":\"2014-02-03T02:00:00.000000Z\",\"transaction_category\":{\"id\":null,\"name\":null,\"type\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"bb97c45e-2100-399c-8bf3-f7ae09d69571\",\"code\":\"FC-63507609\",\"type\":\"transfer\\u00eancia\",\"amount\":-707.55,\"description\":\"Ipsam sit totam sed ut omnis dolore et architecto.\",\"transaction_date\":\"1974-11-04T03: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\":\"407b7c18-e10c-343a-bd52-dfc5ac261462\",\"transaction_category_id\":\"c6939ff3-56b7-3b2c-acf0-90358dfb5a4c\",\"bank_account_id\":\"bd5743e4-7b2b-32a0-ace8-69a6085fe538\",\"customer_id\":\"7c902a1f-40d6-3435-9521-fdcabf52729f\",\"supplier_id\":\"81984a1d-ff76-35d5-88d4-2574fd087039\",\"work_id\":\"2c8c7f1a-5a90-3834-bb6f-f78e79fa712f\",\"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": "12", "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\":\"cde0bc60-a9a3-3ecf-9b01-267aa501f0a4\",\"code\":\"FC-92235162\",\"type\":\"ajuste\",\"amount\":5362.9,\"description\":\"Quod dolorum animi eius nulla aut laborum sed.\",\"transaction_date\":\"2006-12-06T02: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": "3", "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\":\"3d0af9aa-0e61-3228-9347-c08b0c277de7\",\"transaction_category_id\":\"71f9a8d8-1f25-391f-9829-ee4df81d5b77\",\"bank_account_id\":\"a600873f-e6af-3caa-b6ba-2e9e145eb4cc\",\"customer_id\":\"0a48e05d-97b6-36ea-9df3-0149610e9709\",\"supplier_id\":\"5cd8f242-207f-3074-a3a3-2a3023d88d6b\",\"work_id\":\"75d15780-6b85-3da4-8bd3-3dfd1847aef3\",\"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": "11", "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\":\"d660b251-2e4f-3fdc-84dc-e83089d924a2\",\"code\":null,\"opened_by\":null,\"opened_at\":\"2010-03-01T11:17:35.000000Z\",\"closed_by\":null,\"closed_at\":\"2025-02-15T05:39:15.000000Z\",\"opening_balance\":2699.37,\"closing_balance\":6409.54,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Aberto\",\"created_at\":\"1975-07-15T10:53:14.000000Z\",\"updated_at\":\"1996-01-22T11:01:24.000000Z\"},{\"id\":\"02ffd136-f450-3434-ad0c-9fb685dadeae\",\"code\":null,\"opened_by\":null,\"opened_at\":\"1996-04-27T01:16:09.000000Z\",\"closed_by\":null,\"closed_at\":\"2012-09-03T05:34:06.000000Z\",\"opening_balance\":9118.66,\"closing_balance\":1052.65,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Fechado\",\"created_at\":\"2015-05-11T23:52:34.000000Z\",\"updated_at\":\"2017-08-20T11:28:36.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\":\"9bf4d492-3866-3b65-bdfe-9921e0be5008\",\"code\":null,\"opened_by\":null,\"opened_at\":\"2015-10-28T21:24:49.000000Z\",\"closed_by\":null,\"closed_at\":\"1982-05-26T16:59:35.000000Z\",\"opening_balance\":3655.8,\"closing_balance\":238.42,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Aberto\",\"created_at\":\"1985-12-25T13:04:27.000000Z\",\"updated_at\":\"2002-04-20T00:58:23.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": "fb04aaf5-f57f-38c3-844f-5040fb060a5f", "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": "317df7e8-b3fd-320a-9e52-520e427ac96b", "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\":\"39351998-a851-361a-b037-5ca6f535e586\",\"code\":null,\"opened_by\":null,\"opened_at\":\"2022-02-26T18:50:04.000000Z\",\"closed_by\":null,\"closed_at\":\"1976-11-30T01:56:50.000000Z\",\"opening_balance\":7148.24,\"closing_balance\":4955.16,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Fechado\",\"created_at\":\"1980-04-22T06:04:55.000000Z\",\"updated_at\":\"2009-06-15T11:59:32.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": "53b60e4c-a621-32ac-aaa6-cec2fb63c4e9", "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": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Customer+name", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/customers?sort_by=created_at&sort_desc=1&page=1&per_page=15&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\":\"32f0f3c1-fd25-3b8f-90ea-8414a994fc73\",\"name\":\"Dr. Matheus Carrara Pacheco\",\"email\":\"delvalle.ana@example.net\",\"phone\":\"(94) 91958-2490\",\"document\":\"165.966.926-04\",\"type\":\"pf\",\"responsible\":\"Emiliano Estrada Mendes 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},{\"id\":\"6d5db268-e995-3dc0-8fc5-ba46058dbf32\",\"name\":\"Ivana Gabi Serna Sobrinho\",\"email\":\"ohana.mendonca@example.com\",\"phone\":\"(92) 2509-0623\",\"document\":\"960.406.287-58\",\"type\":\"pj\",\"responsible\":\"Sra. Talita Flor Lira\",\"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\"}", "name": "" } ] }, { "name": "Get customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "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\":\"8f4afd11-8263-3fe5-9a85-a27bedafa10b\",\"name\":\"Isaac Pereira Neto\",\"email\":\"paola81@example.com\",\"phone\":\"(12) 97929-0145\",\"document\":\"563.398.617-25\",\"type\":\"pf\",\"responsible\":\"M\\u00f4nica Maia Neves\",\"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": "19", "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\":\"98c6068f-e186-34e1-83d9-00e49b011e42\",\"name\":\"Mar\\u00edlia Renata Serra Filho\",\"description\":\"Totam quos debitis repudiandae laudantium officiis consectetur. Exercitationem possimus corporis ipsa est.\",\"module\":\"document\"},{\"id\":\"3ce3108b-6574-3ecd-ac42-cfe611fa7475\",\"name\":\"Dr. Vicente Santiago Santacruz Sobrinho\",\"description\":\"Omnis quia et voluptas molestiae. Ducimus et deleniti ad eos maxime. Sint eaque in voluptas possimus.\",\"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": "sed", "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\":\"248ac93c-2716-3381-a3e9-c12e327df1a9\",\"name\":\"Dr. Lucas Pontes Guerra\",\"description\":\"Ut et et necessitatibus et. Quia repudiandae architecto voluptate qui sint consectetur voluptates.\",\"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": "ducimus", "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": "animi", "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": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Document+name", "description": "", "disabled": false }, { "key": "categories[0]", "value": "dolor", "description": "The uuid of an existing record in the document_categories table.", "disabled": false }, { "key": "documentable_type", "value": "cum", "description": "Type of the related documentable entity. The type of an existing record in the documentables table.", "disabled": false }, { "key": "customers[0]", "value": "fugiat", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "odio", "description": "The uuid of an existing record in the suppliers table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/documents?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Document+name&categories[0]=dolor&documentable_type=cum&customers[0]=fugiat&suppliers[0]=odio" }, "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\":\"38e3d331-5f07-327d-991d-86b819593743\",\"name\":\"Dirce Estrada Neto\",\"file\":{\"id\":null,\"url\":null,\"extension\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"78ab50c7-6e97-3cb3-8a7f-0fa99f230fe1\",\"name\":\"Arthur Rico Neto\",\"file\":{\"id\":null,\"url\":null,\"extension\":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": "17", "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\":\"4c394963-5b66-3a32-9dfb-3db74177ac6f\",\"name\":\"Lara Delvalle Padilha Neto\",\"file\":{\"id\":null,\"url\":null,\"extension\":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\":\"4f35e65c-7e6d-31e7-879d-fcbc584b124c\",\"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": "12", "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\":\"78a9a1ba-3ba6-3026-8c64-10e9d5ad9290\",\"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": "Employee Roles", "description": "Endpoints for employee roles", "item": [ { "name": "List employee roles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employee-roles", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Manager", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/employee-roles?sort_by=created_at&sort_desc=1&page=1&per_page=15&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\":\"fb87afbb-6a34-4d28-a65c-fa1286e43efb\",\"name\":\"ipsam\",\"description\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"2ad63a06-8896-4d4b-b255-35490ae8f12d\",\"name\":\"labore\",\"description\":\"Vel modi ex eum sunt.\",\"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": "omnis", "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\":\"3781f5ce-2078-4798-9caf-2a987bad7a2f\",\"name\":\"quaerat\",\"description\":\"Velit maiores error tenetur sunt voluptas fugit.\",\"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\":\"Example Name\",\"description\":\"Example Description\"}" }, "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": "aperiam", "description": "Employee Role 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\"}" }, "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": "qui", "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": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Jo%C3%A3o+Silva", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/employees?sort_by=created_at&sort_desc=1&page=1&per_page=15&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\":\"bea1e9d5-d23e-4ca0-b3ae-df715bba026d\",\"name\":\"Marisa Salazar Pena\",\"cpf\":\"914.556.737-59\",\"rg\":null,\"ctps\":\"179988584\",\"phone\":null,\"birthdate\":\"1990-07-25T03:00:00.000000Z\",\"email\":\"amaral.wilson@example.com\",\"pis_pasep\":\"75062369264\",\"admission_date\":\"2009-10-27T02:00:00.000000Z\",\"daily_salary\":null,\"monthly_salary\":null,\"nationality\":\"Paraguai\",\"place_of_birth\":\"S\\u00e3o Gael do Sul\",\"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\":\"31d0e49d-31d9-475d-8054-9a7c50e13c5c\",\"name\":\"Dr. Alexandre Cruz Camacho Filho\",\"cpf\":\"058.345.277-25\",\"rg\":null,\"ctps\":\"915731811\",\"phone\":\"(81) 3672-4362\",\"birthdate\":null,\"email\":\"pontes.suellen@example.net\",\"pis_pasep\":\"39581143900\",\"admission_date\":null,\"daily_salary\":\"78.10\",\"monthly_salary\":\"4447.92\",\"nationality\":\"Tonga\",\"place_of_birth\":\"Santa Robson do Sul\",\"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": "2", "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\":\"a36b4983-900a-4fc3-abec-f01b6d390102\",\"name\":\"Maria Delvalle\",\"cpf\":\"503.187.486-03\",\"rg\":null,\"ctps\":null,\"phone\":null,\"birthdate\":\"2006-04-15T03:00:00.000000Z\",\"email\":\"milene.fontes@example.net\",\"pis_pasep\":null,\"admission_date\":null,\"daily_salary\":\"215.49\",\"monthly_salary\":null,\"nationality\":\"M\\u00f4naco\",\"place_of_birth\":\"Vila Santiago d'Oeste\",\"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\":\"Example Name\",\"cpf\":\"Example Cpf\",\"rg\":\"Example Rg\",\"ctps\":\"Example Ctps\",\"phone\":\"(11) 99999-9999\",\"birthdate\":\"2024-01-01\",\"email\":\"user@example.com\",\"employee_role_id\":\"d364b0f0-adc1-4e93-affb-a91e7fdc2e70\",\"pis_pasep\":\"Example Pis pasep\",\"admission_date\":\"2024-01-01\",\"daily_salary\":1,\"monthly_salary\":1,\"nationality\":\"Example Nationality\",\"place_of_birth\":\"Example Place of birth\",\"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 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": "6", "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\":\"Example Name\",\"cpf\":\"Example Cpf\",\"rg\":\"Example Rg\",\"ctps\":\"Example Ctps\",\"phone\":\"(11) 99999-9999\",\"birthdate\":\"2024-01-01\",\"email\":\"user@example.com\",\"employee_role_id\":\"688144f6-2a0d-4aa5-afb7-c8f2627b940d\",\"pis_pasep\":\"Example Pis pasep\",\"admission_date\":\"2024-01-01\",\"daily_salary\":1,\"monthly_salary\":1,\"nationality\":\"Example Nationality\",\"place_of_birth\":\"Example Place of birth\",\"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 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": "List employee bank accounts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee_id\/bank-account", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee_id\/bank-account", "variable": [ { "id": "employee_id", "key": "employee_id", "value": "15", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all bank accounts for an employee" }, "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": "Create employee bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee_id\/bank-account", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee_id\/bank-account", "variable": [ { "id": "employee_id", "key": "employee_id", "value": "8", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"bank_id\":\"adipisci\",\"agency\":\"cxclfbawmdaqdlxxu\",\"account\":\"svwgy\",\"account_type\":\"corrente\",\"pix_key\":\"etngfmj\",\"favorite\":false}" }, "description": "Add a bank account to an employee" }, "response": [ { "header": [], "code": 201, "body": null, "name": "" } ] }, { "name": "Update employee bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee_id\/bank-account\/:id", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee_id\/bank-account\/:id", "variable": [ { "id": "employee_id", "key": "employee_id", "value": "20", "description": "The ID of the employee." }, { "id": "id", "key": "id", "value": "019556e7-2e9f-777c-a177-30bbf0646c33", "description": "Bank account UUID" }, { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"bank_id\":\"qui\",\"agency\":\"mkocptrhbprihwrqxffzc\",\"account\":\"fkqh\",\"account_type\":\"poupan\u00e7a\",\"pix_key\":\"vtxgbdtchkphzqvmtyftibugt\",\"favorite\":false}" }, "description": "Update a bank account for an employee" }, "response": [] }, { "name": "Delete employee bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee\/bank-account\/:id", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee\/bank-account\/:id", "variable": [ { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee UUID" }, { "id": "id", "key": "id", "value": "019556e7-2e9f-777c-a177-30bbf0646c33", "description": "Bank account UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a bank account from an employee" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "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": "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": "990c7356-761e-35be-900b-d85cb46e39eb", "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": "39509b95-80cc-331d-a10c-bffdc75a4683", "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": "11723af0-0093-36fc-a76b-44c63377987a", "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\":true}" }, "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\":true},null]}" }, "description": "Generate signed URLs for uploading multiple files" }, "response": [ { "header": [], "code": 200, "body": "[{\"url\":\"string\",\"path\":\"string\",\"headers\":\"array\"}]", "name": "" } ] } ] }, { "name": "Fiscal Documents", "description": "Endpoints para gerenciar notas fiscais (arquivos XML\/PDF e v\u00ednculo com obras).", "item": [ { "name": "List fiscal documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/fiscal-documents", "query": [], "raw": "{{baseUrl}}\/api\/fiscal-documents" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"q\":\"architecto\",\"supplier_id\":\"excepturi\",\"work_id\":\"cupiditate\",\"start_date\":\"2026-06-22T14:27:25\",\"end_date\":\"2095-01-09\",\"per_page\":21}" }, "description": "Lista notas fiscais com filtros por busca, fornecedor, obra e per\u00edodo." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"nfe_access_key\":null,\"nfe_number\":null,\"nfe_series\":null,\"issue_date\":null,\"total_value\":null,\"emit\":{\"cnpj\":null,\"name\":null},\"dest\":{\"document\":null,\"name\":null},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null},{\"id\":null,\"nfe_access_key\":null,\"nfe_number\":null,\"nfe_series\":null,\"issue_date\":null,\"total_value\":null,\"emit\":{\"cnpj\":null,\"name\":null},\"dest\":{\"document\":null,\"name\":null},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_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\":15,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create fiscal document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/fiscal-documents", "query": [], "raw": "{{baseUrl}}\/api\/fiscal-documents" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"s3_file_path\":\"voluptas\",\"original_filename\":\".xml$\\\/i\",\"work_ids\":[\"ducimus\"]}" }, "description": "Registra uma NFe a partir do XML j\u00e1 enviado ao S3 e o vincula \u00e0s obras informadas." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":null,\"nfe_access_key\":null,\"nfe_number\":null,\"nfe_series\":null,\"issue_date\":null,\"total_value\":null,\"emit\":{\"cnpj\":null,\"name\":null},\"dest\":{\"document\":null,\"name\":null},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null}}", "name": "" } ] }, { "name": "Get fiscal document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/fiscal-documents\/:fiscalDocument", "query": [], "raw": "{{baseUrl}}\/api\/fiscal-documents\/:fiscalDocument", "variable": [ { "id": "fiscalDocument", "key": "fiscalDocument", "value": "et", "description": "UUID da nota fiscal" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Detalha uma nota fiscal com arquivos e obras vinculadas." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"nfe_access_key\":null,\"nfe_number\":null,\"nfe_series\":null,\"issue_date\":null,\"total_value\":null,\"emit\":{\"cnpj\":null,\"name\":null},\"dest\":{\"document\":null,\"name\":null},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null}}", "name": "" } ] }, { "name": "Attach file", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/fiscal-documents\/:fiscalDocument\/files", "query": [], "raw": "{{baseUrl}}\/api\/fiscal-documents\/:fiscalDocument\/files", "variable": [ { "id": "fiscalDocument", "key": "fiscalDocument", "value": "perferendis", "description": "UUID da nota fiscal" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"file\":{\"path\":\"rerum\",\"name\":\"architecto\",\"extension\":\"a\"}}" }, "description": "Anexa um arquivo (ex.: PDF da NF) j\u00e1 enviado ao S3 \u00e0 nota fiscal." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"nfe_access_key\":null,\"nfe_number\":null,\"nfe_series\":null,\"issue_date\":null,\"total_value\":null,\"emit\":{\"cnpj\":null,\"name\":null},\"dest\":{\"document\":null,\"name\":null},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null}}", "name": "" } ] }, { "name": "Sync works", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/fiscal-documents\/:fiscalDocument\/works", "query": [], "raw": "{{baseUrl}}\/api\/fiscal-documents\/:fiscalDocument\/works", "variable": [ { "id": "fiscalDocument", "key": "fiscalDocument", "value": "sunt", "description": "UUID da nota fiscal" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"work_ids\":[\"quae\"]}" }, "description": "Sincroniza o v\u00ednculo documental da nota fiscal com N obras." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"nfe_access_key\":null,\"nfe_number\":null,\"nfe_series\":null,\"issue_date\":null,\"total_value\":null,\"emit\":{\"cnpj\":null,\"name\":null},\"dest\":{\"document\":null,\"name\":null},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null}}", "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\",\"fiscal_document_id\":\"019556e7-2e9f-777c-a177-30bbf0646c32\"}" }, "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 Imports", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "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 }, { "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 } ], "raw": "{{baseUrl}}\/api\/imports?sort_by=created_at&sort_desc=1&page=1&per_page=15&status=completed&import_type=nfe" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all NFe imports 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": "tempora", "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": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "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 }, { "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 } ], "raw": "{{baseUrl}}\/api\/imports\/:importId\/products?sort_by=created_at&sort_desc=1&page=1&per_page=15&status=pending&q=Produto+ABC", "variable": [ { "id": "importId", "key": "importId", "value": "sunt", "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": "iusto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mappings\":[\"sint\"]}" }, "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": "Locations", "description": "Endpoints for states and cities", "item": [ { "name": "List states", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/locations\/states", "query": [], "raw": "{{baseUrl}}\/api\/locations\/states" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"sort_by\":\"quibusdam\",\"sort_desc\":false,\"page\":73,\"per_page\":13}" }, "description": "List all states paginated" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"name\":\"nihil quidem\",\"abbreviation\":\"CE\"},{\"id\":null,\"name\":\"totam id\",\"abbreviation\":\"QC\"}],\"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\":30,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "List cities by state", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/locations\/states\/:state\/cities", "query": [], "raw": "{{baseUrl}}\/api\/locations\/states\/:state\/cities", "variable": [ { "id": "state", "key": "state", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "State UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all cities for a given state" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"name\":\"Feeneyview\"},{\"id\":null,\"name\":\"Parkerport\"}]}", "name": "" } ] } ] }, { "name": "Notifications", "description": "Endpoints for user notifications", "item": [ { "name": "List notifications", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). 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?sort_by=created_at&sort_desc=1&page=1&per_page=15&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\":[\"Example Notifications *\"]}" }, "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\":[\"Example Notifications *\"]}" }, "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": "Payment Receipts", "description": "Endpoints for payment receipts", "item": [ { "name": "List payment receipts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-receipts", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Jo%C3%A3o+Silva", "description": "Search query (searches in receiver name, document, and receipt number).", "disabled": false }, { "key": "employee_id", "value": "a01edd80-bf3e-40f7-8613-ccb4be5831b3", "description": "Filter by employee UUID. The uuid of an existing record in the employees table.", "disabled": false }, { "key": "receiver_type", "value": "employee", "description": "Filter by receiver type.", "disabled": false }, { "key": "start_date", "value": "2025-01-01", "description": "Filter by issue date (start). O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "end_date", "value": "2025-12-31", "description": "Filter by issue date (end). O campo value deve ser uma data v\u00e1lida. O campo value deve ser uma data posterior ou igual a start_date.", "disabled": false }, { "key": "min_amount", "value": "100", "description": "Filter by minimum amount. O campo value deve ser pelo menos 0.", "disabled": false }, { "key": "max_amount", "value": "1000", "description": "Filter by maximum amount. O campo value deve ser pelo menos 0.", "disabled": false }, { "key": "payment_method", "value": "PIX", "description": "Filter by payment method.", "disabled": false }, { "key": "city", "value": "S%C3%A3o+Paulo", "description": "Filter by city.", "disabled": false }, { "key": "search", "value": "quod", "description": "", "disabled": false }, { "key": "document", "value": "molestiae", "description": "", "disabled": false }, { "key": "work_id", "value": "a01edd80-bf3e-40f7-8613-ccb4be5831b3", "description": "Filter by work UUID. O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the works table.", "disabled": false }, { "key": "bank_account_id", "value": "a01edd80-bf3e-40f7-8613-ccb4be5831b3", "description": "Filter by bank account UUID. O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the bank_accounts table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/payment-receipts?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Jo%C3%A3o+Silva&employee_id=a01edd80-bf3e-40f7-8613-ccb4be5831b3&receiver_type=employee&start_date=2025-01-01&end_date=2025-12-31&min_amount=100&max_amount=1000&payment_method=PIX&city=S%C3%A3o+Paulo&search=quod&document=molestiae&work_id=a01edd80-bf3e-40f7-8613-ccb4be5831b3&bank_account_id=a01edd80-bf3e-40f7-8613-ccb4be5831b3" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all payment receipts with filters" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"778b5591-cfca-3118-b9d9-f3fda995436c\",\"receipt_number\":\"REC-1156\",\"receiver_type\":\"employee\",\"receiver\":{\"id\":null,\"name\":\"Justyn Paucek\",\"document\":\"430.308.268-49\"},\"payment\":{\"amount\":1481.5,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"pix\",\"description\":\"In mollitia laboriosam consequatur consequatur.\"},\"issuer\":{\"name\":\"Schowalter PLC\",\"document\":\"03.364.526\\\/3371-69\"},\"issue\":{\"date\":\"2026-06-01\",\"city\":\"Port Tinachester\",\"state\":\"SP\"},\"created_by\":{\"id\":\"a215e546-0453-4751-939f-05ee0842fd77\",\"name\":\"Kailey Greenfelder DVM\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"8dd3afae-c898-3688-b460-936eb6387f29\",\"receipt_number\":\"REC-7348\",\"receiver_type\":\"employee\",\"receiver\":{\"id\":null,\"name\":\"Zackery Weber\",\"document\":\"732.211.592-23\"},\"payment\":{\"amount\":4433.1,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"cash\",\"description\":\"Aut consectetur et provident.\"},\"issuer\":{\"name\":\"Heathcote, Mayer and Sawayn\",\"document\":\"86.878.704\\\/6381-93\"},\"issue\":{\"date\":\"2026-06-14\",\"city\":\"Lazaroshire\",\"state\":\"GO\"},\"created_by\":{\"id\":\"a215e546-0f21-4e38-ad6e-6eeaa5ad2037\",\"name\":\"Anastacio Willms\"},\"created_at\":null,\"updated_at\":null}],\"pagination\":{\"total\":2,\"count\":2,\"per_page\":10,\"current_page\":1,\"total_pages\":1,\"has_more_pages\":false},\"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 receipt cash flow config", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-receipts\/cash-flow-config", "query": [], "raw": "{{baseUrl}}\/api\/payment-receipts\/cash-flow-config" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lista cada forma de pagamento e se ela gera lancamento automatico no fluxo de caixa" }, "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": "Update receipt cash flow config", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-receipts\/cash-flow-config", "query": [], "raw": "{{baseUrl}}\/api\/payment-receipts\/cash-flow-config" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"methods\":[{\"method\":\"cash\",\"eligible\":true}]}" }, "description": "Define, por forma de pagamento, se o recibo gera lancamento automatico no fluxo de caixa" }, "response": [] }, { "name": "Show payment receipt", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-receipts\/:receipt", "query": [], "raw": "{{baseUrl}}\/api\/payment-receipts\/:receipt", "variable": [ { "id": "receipt", "key": "receipt", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Payment Receipt ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a payment receipt" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"0f7042e5-3cf0-37d4-bf80-fc2c61df9212\",\"receipt_number\":\"REC-4615\",\"receiver_type\":\"custom\",\"receiver\":{\"id\":null,\"name\":\"Dr. Tiffany Bernhard III\",\"document\":\"466.282.750-89\"},\"payment\":{\"amount\":6264.47,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"check\",\"description\":\"Quia nihil iusto eum commodi.\"},\"issuer\":{\"name\":\"Mann LLC\",\"document\":\"30.595.974\\\/4496-21\"},\"issue\":{\"date\":\"2026-06-07\",\"city\":\"Idellaberg\",\"state\":\"RJ\"},\"created_by\":{\"id\":\"a215e546-358e-4603-8cb0-7c6abf64c8d3\",\"name\":\"Presley Klocko\"},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create payment receipt", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-receipts", "query": [], "raw": "{{baseUrl}}\/api\/payment-receipts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"receiver_type\":\"Example Receiver type\",\"employee_id\":\"2eb7b046-ac54-4320-b190-079d260f71d5\",\"receiver_name\":\"Example Name\",\"receiver_document\":\"Example Receiver document\",\"amount\":1,\"amount_in_words\":\"Example Amount in words\",\"payment_method\":\"Example Payment method\",\"description\":\"Example Description\",\"issuer_name\":\"Example Name\",\"issuer_document\":\"Example Issuer document\",\"issue_date\":\"2024-01-01\",\"city\":\"Example City\",\"state\":\"Example State\",\"work_id\":\"09078179-cc30-3b27-9290-7c3058234bbf\",\"bank_account_id\":\"ddf80cfe-94a3-3671-96d9-fa72b69adbf6\"}" }, "description": "Create a new payment receipt" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update payment receipt", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-receipts\/:receipt", "query": [], "raw": "{{baseUrl}}\/api\/payment-receipts\/:receipt", "variable": [ { "id": "receipt", "key": "receipt", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Payment Receipt ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"receiver_type\":\"Example Receiver type\",\"employee_id\":\"a1e03feb-9365-4040-b669-fe915b824956\",\"receiver_name\":\"Example Name\",\"receiver_document\":\"Example Receiver document\",\"amount\":1,\"amount_in_words\":\"Example Amount in words\",\"payment_method\":\"Example Payment method\",\"description\":\"Example Description\",\"issuer_name\":\"Example Name\",\"issuer_document\":\"Example Issuer document\",\"issue_date\":\"2024-01-01\",\"city\":\"Example City\",\"state\":\"Example State\",\"work_id\":\"131c875d-0454-31a6-9851-c4f22f70c4db\",\"bank_account_id\":\"20cd0b19-a268-3237-9068-cacd643b423c\"}" }, "description": "Update a payment receipt" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete payment receipt", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-receipts\/:receipt", "query": [], "raw": "{{baseUrl}}\/api\/payment-receipts\/:receipt", "variable": [ { "id": "receipt", "key": "receipt", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Payment Receipt ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a payment receipt" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "List employee receipts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee_id\/receipts", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee_id\/receipts", "variable": [ { "id": "employee_id", "key": "employee_id", "value": "9", "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": "List all payment receipts for a specific employee" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"19f9e8dc-fefb-35d4-98a5-0b60589e9c65\",\"receipt_number\":\"REC-1955\",\"receiver_type\":\"custom\",\"receiver\":{\"id\":null,\"name\":\"Braxton Hoeger\",\"document\":\"876.148.615-64\"},\"payment\":{\"amount\":3574.18,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"bank_transfer\",\"description\":\"Eum exercitationem placeat exercitationem qui et quas.\"},\"issuer\":{\"name\":\"Runolfsson-Ruecker\",\"document\":\"75.089.833\\\/5608-08\"},\"issue\":{\"date\":\"2026-05-24\",\"city\":\"Myriamborough\",\"state\":\"SP\"},\"created_by\":{\"id\":\"a215e546-7600-4693-95b2-1a1dba218390\",\"name\":\"Hershel Ernser\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"3976eb5f-0728-3ed9-8a2d-01f13e2ede2a\",\"receipt_number\":\"REC-3775\",\"receiver_type\":\"custom\",\"receiver\":{\"id\":null,\"name\":\"Dr. Dock Beer\",\"document\":\"879.114.413-69\"},\"payment\":{\"amount\":7987.06,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"cash\",\"description\":\"Enim rerum temporibus repellendus explicabo nihil aliquid.\"},\"issuer\":{\"name\":\"Nikolaus-Schumm\",\"document\":\"28.115.156\\\/7239-57\"},\"issue\":{\"date\":\"2026-06-13\",\"city\":\"North Lysannetown\",\"state\":\"GO\"},\"created_by\":{\"id\":\"a215e546-7bca-45f5-b94b-605baa578103\",\"name\":\"Ms. Vada Herzog\"},\"created_at\":null,\"updated_at\":null}],\"pagination\":{\"total\":2,\"count\":2,\"per_page\":10,\"current_page\":1,\"total_pages\":1,\"has_more_pages\":false},\"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": "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\":\"0d6d1d01-ba17-3ffc-99fb-e35045806490\",\"name\":\"alias-ut-suscipit\",\"display_name\":\"animi sed praesentium\",\"created_at\":null,\"updated_at\":null},{\"id\":\"8a66b3cc-eb48-38b8-bb5c-68a8a6ecde6c\",\"name\":\"voluptatibus-repellat-harum\",\"display_name\":\"aut similique optio\",\"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\"}" }, "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\"}" }, "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\":\"0b61a178-54ff-3a44-8efe-7209be42e778\",\"name\":\"omnis-sequi\",\"display_name\":\"quisquam ea magnam\",\"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\":\"320c1d12-73b3-3b8a-9aad-3d8d9f6e59e9\",\"name\":\"Sr. Lucio Batista Lutero\",\"created_at\":null,\"updated_at\":null},{\"id\":\"3462d027-4563-308f-9bc1-230804fa921e\",\"name\":\"Camilo Rocha Vasques Filho\",\"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": "dolorem", "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\":\"f38c8216-af05-37d3-97d8-1be13d66b6e1\",\"name\":\"Joaquin Pacheco Jr.\",\"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\":\"Example Name\"}" }, "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": "sed", "description": "Product brand UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\"}" }, "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": "praesentium", "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\":\"44e8872a-0a96-3114-ae85-d36d61a8deb9\",\"name\":\"Adriel Abreu Neto\",\"created_at\":null,\"updated_at\":null},{\"id\":\"462049f1-c48e-30af-96f3-b7508283396a\",\"name\":\"Lara Mayara Guerra\",\"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": "quis", "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\":\"682a2061-2e3c-3c4e-8b05-af9fa6dcfff0\",\"name\":\"Srta. Luiza Garcia Mendon\\u00e7a Filho\",\"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\":\"Example Name\"}" }, "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": "similique", "description": "Product family UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\"}" }, "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": "quia", "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": "Product Quantity Lists", "description": "Endpoints for managing product quantity lists", "item": [ { "name": "List product quantity lists", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-quantity-lists", "query": [], "raw": "{{baseUrl}}\/api\/product-quantity-lists" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"q\":\"Example Q\",\"work_id\":\"968e7865-c302-3a94-abd7-29c11f7aef08\",\"user_id\":\"360bc352-3679-30c6-a3cc-c64a78c61c5a\",\"responsible_id\":\"9e7ec0fe-c0a5-3090-b927-8e9b84f1e566\",\"per_page\":1,\"sort\":\"Example Sort\",\"sort_desc\":true}" }, "description": "List all product quantity lists" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"f521e070-c6ac-37bf-8b70-bf570c9d173a\",\"name\":\"Perferendis occaecati sit.\",\"description\":\"Occaecati ut aut eum et a et id. Accusantium odio quae doloremque quisquam voluptas quas quod. Ut eos aut omnis molestiae maxime ut qui porro.\",\"work\":{\"id\":\"a215e547-9403-4cbf-b443-d1355f2af760\",\"name\":\"Dr. Gean Jorge das Neves\"},\"user\":{\"id\":\"a215e547-a097-4f44-b4c4-e3466daea06d\",\"name\":\"Gideon Wisozk\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"94aed025-24b6-38b9-a479-e03641808bf5\",\"name\":\"Voluptatem ut ducimus.\",\"description\":null,\"work\":{\"id\":\"a215e547-ac24-42db-a5a7-07b25e3b0844\",\"name\":\"Dr. Wellington Adriano Maia\"},\"user\":{\"id\":\"a215e547-b2b6-4316-9cc2-8f51a998626f\",\"name\":\"Maurine Runolfsson\"},\"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 quantity list", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-quantity-lists\/:productQuantityList", "query": [], "raw": "{{baseUrl}}\/api\/product-quantity-lists\/:productQuantityList", "variable": [ { "id": "productQuantityList", "key": "productQuantityList", "value": "iste", "description": "Product Quantity List UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a product quantity list" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"b0216801-ac2e-3973-a8f2-5effd7d2ac41\",\"name\":\"Accusamus et et quis.\",\"description\":\"Et reiciendis quo ipsum sunt facere nobis provident. Deleniti modi quia eum quo sed dolore quia. Temporibus nemo culpa saepe eum dolores. Omnis perferendis sapiente sed eaque.\",\"work\":{\"id\":\"a215e547-c4af-47b7-a98d-0814fca3c218\",\"name\":\"Erik Dias Urias\"},\"user\":{\"id\":\"a215e547-c954-4285-b3b3-34288510c13a\",\"name\":\"Modesta Trantow\"},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "List items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-quantity-lists\/:productQuantityList\/items", "query": [], "raw": "{{baseUrl}}\/api\/product-quantity-lists\/:productQuantityList\/items", "variable": [ { "id": "productQuantityList", "key": "productQuantityList", "value": "in", "description": "Product Quantity List UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"per_page\":1,\"q\":\"Example Q\"}" }, "description": "List all items from a product quantity list with pagination" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"8027613e-284f-344d-8484-ea63a275abc6\",\"product\":{\"id\":\"a215e547-faf2-4438-9f49-aa77f2267f8b\",\"name\":\"Sr. Diogo Espinoza Martines\",\"code\":\"PRD-307822\",\"unit\":{\"id\":\"a215e547-f52e-4258-aa07-f2585fc718c1\",\"name\":\"Dr. Marisa de Souza Louren\\u00e7o Sobrinho\",\"abbreviation\":\"Simon Salgado Rosa\"}},\"quantity\":585.3173,\"observation\":\"Non molestias vel voluptate qui.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"6151593a-b699-3225-9ca8-154f3fe897df\",\"product\":{\"id\":\"a215e548-216f-47ff-a19a-0c15e6863513\",\"name\":\"Srta. Carol Paulina Solano Sobrinho\",\"code\":\"PRD-897386\",\"unit\":{\"id\":\"a215e548-1b51-47f2-b212-248482e5882d\",\"name\":\"Mait\\u00ea Padilha Garcia Neto\",\"abbreviation\":\"Dr. Fernando Gil Cordeiro Sobrinho\"}},\"quantity\":630.3032,\"observation\":\"Eaque iste rerum eveniet voluptatum.\",\"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 product quantity list", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-quantity-lists", "query": [], "raw": "{{baseUrl}}\/api\/product-quantity-lists" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"description\":\"Example Description\",\"work_id\":\"66ede55b-68f3-3ce2-b9e9-e338d4230f6d\",\"items\":[{\"product_id\":\"448dc74b-429f-374a-98c9-85169e1d168e\",\"quantity\":1,\"observation\":\"Example Items * observation\"},null]}" }, "description": "Create a new product quantity list" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Update product quantity list", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-quantity-lists\/:productQuantityList", "query": [], "raw": "{{baseUrl}}\/api\/product-quantity-lists\/:productQuantityList", "variable": [ { "id": "productQuantityList", "key": "productQuantityList", "value": "ut", "description": "Product Quantity List 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\",\"items\":[{\"id\":\"13688684-c36a-3e21-a9da-031d0e63b5e0\",\"product_id\":\"9f61b1cb-e6d8-3073-ae5d-b8c22ddda1d4\",\"quantity\":1,\"observation\":\"Example Items * observation\"},null]}" }, "description": "Update a product quantity list. Can include items to replace all items in the list." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Delete product quantity list", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-quantity-lists\/:productQuantityList", "query": [], "raw": "{{baseUrl}}\/api\/product-quantity-lists\/:productQuantityList", "variable": [ { "id": "productQuantityList", "key": "productQuantityList", "value": "provident", "description": "Product Quantity List UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a product quantity list" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Add items to list", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-quantity-lists\/:productQuantityList\/items", "query": [], "raw": "{{baseUrl}}\/api\/product-quantity-lists\/:productQuantityList\/items", "variable": [ { "id": "productQuantityList", "key": "productQuantityList", "value": "ea", "description": "Product Quantity List UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"product_id\":\"3a0e90f3-4c7f-3f03-9c00-7bfb72cd2b96\",\"quantity\":1,\"observation\":\"Example Items * observation\"},null]}" }, "description": "Add one or more product items to the list" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":\"array\"}", "name": "" } ] }, { "name": "Update item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-quantity-lists\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/product-quantity-lists\/items\/:id", "variable": [ { "id": "id", "key": "id", "value": "et", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "qui", "description": "Product Quantity List Item UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"quantity\":1,\"observation\":\"Example Observation\"}" }, "description": "Update a product item in the list" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Remove items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-quantity-lists\/:productQuantityList\/items", "query": [], "raw": "{{baseUrl}}\/api\/product-quantity-lists\/:productQuantityList\/items", "variable": [ { "id": "productQuantityList", "key": "productQuantityList", "value": "molestiae", "description": "Product Quantity List UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[\"1e62964a-fcd7-3ec0-8f37-26f32c6593be\"]}" }, "description": "Remove one or more product items from the list" }, "response": [ { "header": [], "code": 200, "body": "{\"deleted\":\"integer\"}", "name": "" } ] }, { "name": "Sync items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-quantity-lists\/:productQuantityList\/sync-items", "query": [], "raw": "{{baseUrl}}\/api\/product-quantity-lists\/:productQuantityList\/sync-items", "variable": [ { "id": "productQuantityList", "key": "productQuantityList", "value": "aliquid", "description": "Product Quantity List UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"id\":\"1c7e090e-892e-3c59-a938-f35e58a10d6c\",\"product_id\":\"bb5f67df-30d4-3093-aac0-631e893d6853\",\"quantity\":1,\"observation\":\"Example Items * observation\"},null]}" }, "description": "Replace all items in the list" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] } ] }, { "name": "Product Request Fulfillment", "description": "Endpoints for fulfilling product request items", "item": [ { "name": "Fulfill item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/items\/:item\/fulfill", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/items\/:item\/fulfill", "variable": [ { "id": "item", "key": "item", "value": "rerum", "description": "Product Request Item UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"fulfillment_type\":\"Example Fulfillment type\",\"stock_id\":\"614aff45-52b0-3d9f-9e10-e7dbc33a971c\",\"quantity\":1,\"source_stock_id\":\"401a2ff1-0f50-3e46-9221-66a2bd106bf4\",\"reason\":\"Example Reason\",\"origins\":[{\"supplier_product_id\":\"bc4de31d-fcc0-366c-bf78-05cb790eb73c\",\"quantity\":1},null]}" }, "description": "Fulfill a product request item via transfer or allocation" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "List item fulfillments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/items\/:item\/fulfillments", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/items\/:item\/fulfillments", "variable": [ { "id": "item", "key": "item", "value": "non", "description": "Product Request Item UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"per_page\":1,\"page\":1}" }, "description": "List all fulfillments for a product request item" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"83e608c5-5cc2-3807-bb2d-046dc567b3c6\",\"quantity\":80.4271,\"fulfilled_at\":\"2026-06-06T04:51:46.000000Z\",\"created_at\":null},{\"id\":\"e9e49f87-17b3-3768-9651-5e4d17cc28af\",\"quantity\":29.4291,\"fulfilled_at\":\"2026-05-24T05:33:48.000000Z\",\"created_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 item with fulfillment details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/items\/:id", "variable": [ { "id": "id", "key": "id", "value": "aut", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "esse", "description": "Product Request Item UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a single product request item with its fulfillment details" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"4bf20e55-fc5b-3a89-b019-885e0f30169d\",\"product\":{\"id\":\"a215e54d-9f75-419b-92c3-bf6aa835eaa8\",\"name\":\"Richard Ferreira\",\"code\":\"PRD-761329\",\"unit\":{\"id\":\"a215e54d-9b85-4c0e-946b-a2c103c7a89c\",\"name\":\"Sr. \\u00cdcaro Alonso Batista Neto\",\"abbreviation\":\"Elias Rivera Jr.\"}},\"quantity\":175.6329,\"quantity_fulfilled\":0,\"quantity_pending\":175.6329,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":null,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "List pending items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/:productRequest\/pending-items", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/:productRequest\/pending-items", "variable": [ { "id": "productRequest", "key": "productRequest", "value": "quia", "description": "Product Request UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"per_page\":1,\"page\":1}" }, "description": "List all pending items from a product request" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"c60ad9c3-d6e0-36ce-8d9b-f983ebc7a434\",\"product\":{\"id\":\"a215e54d-d60b-498b-945f-291e1dde63fa\",\"name\":\"Srta. Ornela Ferreira Louren\\u00e7o\",\"code\":\"PRD-590904\",\"unit\":{\"id\":\"a215e54d-d302-49cf-bb71-5f7db3539d5a\",\"name\":\"Sr. Maur\\u00edcio Rezende Jr.\",\"abbreviation\":\"Ronaldo Marin Ortiz\"}},\"quantity\":293.3871,\"quantity_fulfilled\":0,\"quantity_pending\":293.3871,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Nostrum consectetur vel ad illum recusandae asperiores quibusdam.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"e8baa106-9cb4-33a2-b4d4-ca4b71a43c73\",\"product\":{\"id\":\"a215e54e-0f40-4f5d-aaad-6b798accba33\",\"name\":\"Laura Rico Neto\",\"code\":\"PRD-278585\",\"unit\":{\"id\":\"a215e54e-0c2e-4cec-bc5e-78726053b163\",\"name\":\"Srta. Luiza Jaqueline Marinho Filho\",\"abbreviation\":\"Wilson Sergio Dominato\"}},\"quantity\":636.3912,\"quantity_fulfilled\":0,\"quantity_pending\":636.3912,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Rerum deleniti sunt aliquam similique earum quibusdam rerum.\",\"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": "List pending items by product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/pending-by-product\/:product", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/pending-by-product\/:product", "variable": [ { "id": "product", "key": "product", "value": "facere", "description": "Product UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all pending product request items for a specific product" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"cab16c40-6495-3bf4-aa5e-428f42efd625\",\"product\":{\"id\":\"a215e54e-4223-42cf-86f4-3701eb7239a4\",\"name\":\"Louise Ferreira Jr.\",\"code\":\"PRD-519763\",\"unit\":{\"id\":\"a215e54e-3f81-4263-ab45-6c690081b3cb\",\"name\":\"Dr. Fabiano Leal Estrada Neto\",\"abbreviation\":\"Dr. Wagner Ortega Filho\"}},\"quantity\":942.8721,\"quantity_fulfilled\":0,\"quantity_pending\":942.8721,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"f3becb74-944c-3c80-b0f9-fd8a88abcb43\",\"product\":{\"id\":\"a215e54e-70fc-4dac-8951-29a0d615e599\",\"name\":\"Dr. Dener Natan de Freitas Sobrinho\",\"code\":\"PRD-261673\",\"unit\":{\"id\":\"a215e54e-6ccc-4968-9056-1ccb93fb4c3c\",\"name\":\"Srta. Raquel Luna Faria Neto\",\"abbreviation\":\"Leandro Guilherme Leon Sobrinho\"}},\"quantity\":804.1848,\"quantity_fulfilled\":0,\"quantity_pending\":804.1848,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Sequi voluptas rem non nemo sed veniam sunt.\",\"created_at\":null,\"updated_at\":null}]}", "name": "" } ] } ] }, { "name": "Product Requests", "description": "Endpoints for managing product requests for works", "item": [ { "name": "List product requests", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests", "query": [], "raw": "{{baseUrl}}\/api\/product-requests" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"sort_by\":\"Example Sort by\",\"sort_desc\":true,\"page\":1,\"per_page\":1,\"q\":\"Example Q\",\"work_id\":\"66353ded-3af7-3e79-be59-e315f3dfc522\",\"work_location_id\":\"9686769a-0929-3478-89e5-111fc629d4e8\",\"user_id\":\"f534df33-9f28-3a27-8caa-1ffc886beac7\",\"status_id\":\"7fbe0112-a49f-392c-ac37-c10e3bffae35\",\"priority\":\"Example Priority\",\"needed_at_from\":\"Example Needed at from\",\"needed_at_to\":\"Example Needed at to\",\"responsible_id\":\"4190633a-dc27-3ecc-94bf-2aa551538d5a\"}" }, "description": "List all product requests" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"23fdcb5f-509f-3d9f-a150-0adf446b6294\",\"code\":null,\"name\":\"Omnis dicta sit.\",\"description\":\"Voluptatem et recusandae et eaque. Rerum non voluptate autem voluptatem dolor dicta.\",\"work\":{\"id\":\"a215e549-dc12-4eee-9d8e-4fb05fe2086f\",\"name\":\"Dr. Marta Tamoio Neto\"},\"user\":{\"id\":\"a215e549-e474-4575-93ee-11a989f87e5d\",\"name\":\"Kristin Daniel\"},\"status\":{\"id\":\"a215e549-e967-418a-9ee6-6f61cfd78ce9\",\"slug\":null,\"name\":null,\"description\":\"Joaquin Campos Soto\",\"abbreviation\":\"adipisci\",\"color\":\"#275cbd\",\"text_color\":\"#1f002f\"},\"priority\":\"high\",\"priority_label\":\"Alta\",\"needed_at\":\"2026-06-22\",\"approved_at\":null,\"rejection_reason\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"f958a20c-892b-338f-9902-51db0b5be1eb\",\"code\":null,\"name\":\"Dolorem voluptas qui debitis.\",\"description\":null,\"work\":{\"id\":\"a215e549-f241-4eb9-924a-4f71cf5f9e85\",\"name\":\"Dr. Hort\\u00eancia Bonilha Rios Jr.\"},\"user\":{\"id\":\"a215e549-f816-4191-809c-7a33c5536b13\",\"name\":\"Candace Leannon\"},\"status\":{\"id\":\"a215e549-fb09-4970-8798-83591d74e975\",\"slug\":null,\"name\":null,\"description\":\"Dr. Antonella Noemi Leon Jr.\",\"abbreviation\":\"rerum\",\"color\":\"#9171d5\",\"text_color\":\"#6aa57b\"},\"priority\":\"medium\",\"priority_label\":\"M\\u00e9dia\",\"needed_at\":\"2026-06-28\",\"approved_at\":null,\"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": "Show product request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/:productRequest", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/:productRequest", "variable": [ { "id": "productRequest", "key": "productRequest", "value": "qui", "description": "Product Request UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a product request" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"918ae9bf-2587-3531-820a-0c93cca45919\",\"code\":null,\"name\":\"Id sint labore.\",\"description\":null,\"work\":{\"id\":\"a215e54a-0cf6-4c6d-a086-db25b3f7517d\",\"name\":\"Sra. Emilly Flores Sobrinho\"},\"user\":{\"id\":\"a215e54a-1177-4e98-bb1b-77d4ebaa5ba1\",\"name\":\"Cara Dickens\"},\"status\":{\"id\":\"a215e54a-1678-4d61-9023-e20a4db2c607\",\"slug\":null,\"name\":null,\"description\":\"Sr. William Ramos Fontes Filho\",\"abbreviation\":\"rerum\",\"color\":\"#91694b\",\"text_color\":\"#fa4942\"},\"priority\":\"low\",\"priority_label\":\"Baixa\",\"needed_at\":\"2026-07-15\",\"approved_at\":null,\"rejection_reason\":null,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "List items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/:productRequest\/items", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/:productRequest\/items", "variable": [ { "id": "productRequest", "key": "productRequest", "value": "totam", "description": "Product Request UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"q\":\"Example Q\",\"per_page\":1}" }, "description": "List all items from a product request with pagination" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"7953c20a-fdd8-396c-af81-195e5ad6fe3d\",\"product\":{\"id\":\"a215e54a-4e43-428e-b5dc-65c6203ca423\",\"name\":\"Dr. Edilson Brito Jr.\",\"code\":\"PRD-456526\",\"unit\":{\"id\":\"a215e54a-4cec-49ab-b39b-ed33fb59c224\",\"name\":\"Miguel Ferraz Quintana\",\"abbreviation\":\"Simone Esther Corona Neto\"}},\"quantity\":686.4892,\"quantity_fulfilled\":0,\"quantity_pending\":686.4892,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Ut ab sit ullam sequi.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"ffc1cb17-161e-38b7-b9e7-9419ccf63c1d\",\"product\":{\"id\":\"a215e54a-7e7c-4561-b413-159f8f780707\",\"name\":\"Dr. Bruno Maldonado Jr.\",\"code\":\"PRD-861418\",\"unit\":{\"id\":\"a215e54a-797e-410c-b6d0-a7f69d781c0c\",\"name\":\"Jean Rodrigues\",\"abbreviation\":\"Sra. T\\u00e1bata Ramos Sobrinho\"}},\"quantity\":322.4176,\"quantity_fulfilled\":0,\"quantity_pending\":322.4176,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Sunt quaerat qui ipsam numquam.\",\"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 product request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests", "query": [], "raw": "{{baseUrl}}\/api\/product-requests" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"description\":\"Example Description\",\"work_id\":\"2fc14170-87b3-35ba-92f8-c249aa2bd70a\",\"work_location_id\":\"67766c86-4019-3e99-a1bb-a814316e93f1\",\"status_id\":\"cdd083a3-0b57-3fdc-a9ad-1b0d607e91c3\",\"priority\":\"Example Priority\",\"needed_at\":\"Example Needed at\",\"items\":[{\"product_id\":\"9cd91d47-9f35-3b8d-b62b-1bd8bd05efad\",\"quantity\":1,\"observation\":\"Example Items * observation\"},null]}" }, "description": "Create a new product request" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Update product request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/:productRequest", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/:productRequest", "variable": [ { "id": "productRequest", "key": "productRequest", "value": "dolorem", "description": "Product Request 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\",\"work_id\":\"1087f17d-9ea7-3098-9841-82b6984fad03\",\"work_location_id\":\"e0735dcc-84b9-337b-b673-29cd5c780a50\",\"status_id\":\"20975846-02bb-306f-a357-955818f45716\",\"priority\":\"Example Priority\",\"needed_at\":\"Example Needed at\",\"items\":[{\"id\":\"f5fb8531-bdde-3fcf-a930-d82aef4e3ce0\",\"product_id\":\"e3bddaf6-a6c0-341f-94e5-04a8131141a9\",\"quantity\":1,\"observation\":\"Example Items * observation\"},null]}" }, "description": "Update a product request. Can include items to replace all items in the request." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Delete product request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/:productRequest", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/:productRequest", "variable": [ { "id": "productRequest", "key": "productRequest", "value": "voluptatem", "description": "Product Request UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a product request" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Approve product request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/:productRequest\/approve", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/:productRequest\/approve", "variable": [ { "id": "productRequest", "key": "productRequest", "value": "occaecati", "description": "Product Request UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Approve a product request" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Reject product request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/:productRequest\/reject", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/:productRequest\/reject", "variable": [ { "id": "productRequest", "key": "productRequest", "value": "qui", "description": "Product Request UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Example Reason\"}" }, "description": "Reject a product request with a reason" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Add items to request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/:productRequest\/items", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/:productRequest\/items", "variable": [ { "id": "productRequest", "key": "productRequest", "value": "adipisci", "description": "Product Request UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"product_id\":\"10ae57b8-569d-3b65-9146-41f80c1e0d5b\",\"quantity\":1,\"observation\":\"Example Items * observation\"},null]}" }, "description": "Add one or more product items to the request" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":\"array\"}", "name": "" } ] }, { "name": "Update item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/items\/:id", "variable": [ { "id": "id", "key": "id", "value": "sunt", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "quis", "description": "Product Request Item UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"quantity\":1,\"observation\":\"Example Observation\",\"status_id\":\"063a75a9-665f-36b3-95e9-5b5b2c87ba1e\"}" }, "description": "Update a product item in the request" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Remove items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/:productRequest\/items", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/:productRequest\/items", "variable": [ { "id": "productRequest", "key": "productRequest", "value": "qui", "description": "Product Request UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[\"60f60e8f-3cf6-3fb3-9d99-06d488c1abfb\"]}" }, "description": "Remove one or more product items from the request" }, "response": [ { "header": [], "code": 200, "body": "{\"deleted\":\"integer\"}", "name": "" } ] }, { "name": "Sync items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/:productRequest\/sync-items", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/:productRequest\/sync-items", "variable": [ { "id": "productRequest", "key": "productRequest", "value": "laborum", "description": "Product Request UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"id\":\"c345c7ae-0a96-3e57-973a-b37a5e71c9b4\",\"product_id\":\"34595e9b-aaba-3428-b3f9-b7538773bea1\",\"quantity\":1,\"observation\":\"Example Items * observation\"},null]}" }, "description": "Replace all items in the request" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] } ] }, { "name": "Products", "description": "Endpoints for products", "item": [ { "name": "List products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Brick", "description": "Search query.", "disabled": false }, { "key": "code", "value": "PROD-00003", "description": "Filter by product code.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/products?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Brick&code=PROD-00003" }, "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\":\"c7ad983d-5341-391f-b759-2e602a8a047c\",\"name\":\"Alana Madeira Balestero\",\"code\":\"PRD-403733\",\"stock\":416636,\"product_family\":{\"id\":\"a215e546-b524-4590-8c5c-41d97348345c\",\"name\":\"Joaquim Martines Rosa\"},\"product_brand\":{\"id\":\"a215e546-ba42-405c-b824-56928ed7d15a\",\"name\":\"Bianca Zambrano Sobrinho\"},\"unit\":{\"id\":\"a215e546-beb8-450a-915c-f0a9fd4f6b73\",\"name\":\"Evandro Ramires Jr.\",\"abbreviation\":\"Sra. Elisa Melina Pontes\"},\"image\":{\"id\":null,\"url\":null},\"description\":\"Ipsum aliquam vitae voluptatem impedit quo.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"47526c06-e40a-35be-b13a-019bf0c861e8\",\"name\":\"Joyce S\\u00f4nia Leon\",\"code\":\"PRD-115445\",\"stock\":46289949,\"product_family\":{\"id\":\"a215e546-c7a4-4206-a04c-4fb9d7db5a56\",\"name\":\"Cristian Ferraz Ferreira Jr.\"},\"product_brand\":{\"id\":\"a215e546-ca38-4a71-9207-3060ff01896f\",\"name\":\"Dr. Cezar Santana Sobrinho\"},\"unit\":{\"id\":\"a215e546-ce43-4f1c-991d-4049d7eb7f63\",\"name\":\"Ben\\u00edcio Gael Assun\\u00e7\\u00e3o Neto\",\"abbreviation\":\"Guilherme Padr\\u00e3o Neto\"},\"image\":{\"id\":null,\"url\":null},\"description\":\"Totam consequuntur ut accusantium occaecati.\",\"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": "1", "description": "The ID of the product." }, { "id": "product", "key": "product", "value": "vero", "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\":\"fe3b523e-daa3-36ca-a5dc-2a68ba2c2df0\",\"name\":\"Sra. Olga Balestero\",\"code\":\"PRD-797616\",\"stock\":40334,\"product_family\":{\"id\":\"a215e546-e116-4892-8dc3-81e18e0a3314\",\"name\":\"Martinho Feliciano Neto\"},\"product_brand\":{\"id\":\"a215e546-e581-44f4-b5d3-f3392e1f2da0\",\"name\":\"Suelen Em\\u00edlia Duarte\"},\"unit\":{\"id\":\"a215e546-ea08-4742-a232-1c197a11fef7\",\"name\":\"Luiz de Souza\",\"abbreviation\":\"Dr. Manoela Santacruz Neto\"},\"image\":{\"id\":null,\"url\":null},\"description\":\"Quia suscipit doloremque quo autem molestias.\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "List available origins", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products\/:product\/available-origins", "query": [], "raw": "{{baseUrl}}\/api\/products\/:product\/available-origins", "variable": [ { "id": "product", "key": "product", "value": "facere", "description": "Product UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List supplier_products (NF items) with available quantity for the given product, ordered FIFO by NF date." }, "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": "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\":\"Example Name\",\"product_family_id\":\"1c5e6b27-e390-3125-8ee8-5adff4cd1e02\",\"product_brand_id\":\"5e85f8d1-899c-34ea-980c-155feb31b8ca\",\"unit_id\":\"f90f0846-510b-33b4-8183-5188e67288d0\",\"description\":\"Example Description\",\"stock\":1}" }, "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": "1", "description": "The ID of the product." }, { "id": "product", "key": "product", "value": "sapiente", "description": "Product UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"product_family_id\":\"16c44814-d5e5-3330-ac80-b16492f73b14\",\"product_brand_id\":\"1544fca9-8341-381c-9d4a-644b80a837e5\",\"unit_id\":\"ce05fc8d-a54b-3040-9c76-38f54ce6d06a\",\"stock\":1,\"description\":\"Example Description\"}" }, "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": "dolorum", "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": "Reports", "description": "", "item": [ { "name": "Export Cash Flow to Excel", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/cash-flow\/excel", "query": [ { "key": "q", "value": "fugiat", "description": "", "disabled": false }, { "key": "type", "value": "entrada", "description": "Tipo de lan\u00e7amento.", "disabled": false }, { "key": "description", "value": "Dolor+ipsam+voluptatem+quia+aut+impedit.", "description": "", "disabled": false }, { "key": "categories[0]", "value": "6661a8ee-8090-31a0-bf3e-a3ab20b9635f", "description": "O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the transaction_categories table.", "disabled": false }, { "key": "exclude_categories[0]", "value": "2f4e709d-7c58-3eed-b5df-2ca3b4088400", "description": "O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the transaction_categories table.", "disabled": false }, { "key": "date_start", "value": "2026-01-01", "description": "In\u00edcio do per\u00edodo (data). O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "date_end", "value": "2026-12-31", "description": "Fim do per\u00edodo (data). O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "bank_accounts[0]", "value": "52ebf893-487c-353d-a490-6c80233cbd38", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "customers[0]", "value": "601fb8a9-9347-3167-a915-9b9f88dde6ff", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "suppliers[0]", "value": "dcb2960e-4a5e-3e9d-b4ed-780977e5ed1f", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "cash_session", "value": "756fb632-7087-39d7-ae78-b76222b54684", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "works[0]", "value": "1d753c31-ee97-3f9d-9c86-369e620568df", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "url", "value": "", "description": "", "disabled": true }, { "key": "base64", "value": "", "description": "", "disabled": true }, { "key": "aba_unica", "value": "", "description": "", "disabled": true } ], "raw": "{{baseUrl}}\/api\/reports\/cash-flow\/excel?q=fugiat&type=entrada&description=Dolor+ipsam+voluptatem+quia+aut+impedit.&categories[0]=6661a8ee-8090-31a0-bf3e-a3ab20b9635f&exclude_categories[0]=2f4e709d-7c58-3eed-b5df-2ca3b4088400&date_start=2026-01-01&date_end=2026-12-31&bank_accounts[0]=52ebf893-487c-353d-a490-6c80233cbd38&customers[0]=601fb8a9-9347-3167-a915-9b9f88dde6ff&suppliers[0]=dcb2960e-4a5e-3e9d-b4ed-780977e5ed1f&cash_session=756fb632-7087-39d7-ae78-b76222b54684&works[0]=1d753c31-ee97-3f9d-9c86-369e620568df&url=&base64=&aba_unica=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Dispatches async Excel generation. Frontend receives notification via Pusher when ready." }, "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\/cash-flow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/cash-flow", "query": [ { "key": "q", "value": "voluptatem", "description": "", "disabled": false }, { "key": "type", "value": "entrada", "description": "Tipo de lan\u00e7amento.", "disabled": false }, { "key": "description", "value": "Et+quam+aperiam+non+necessitatibus+iusto.", "description": "", "disabled": false }, { "key": "categories[0]", "value": "1cd8d871-26cd-3671-96e0-ce14108d273e", "description": "O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the transaction_categories table.", "disabled": false }, { "key": "exclude_categories[0]", "value": "ad8e4b37-0277-374f-a991-fab61946dcba", "description": "O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the transaction_categories table.", "disabled": false }, { "key": "date_start", "value": "2026-01-01", "description": "In\u00edcio do per\u00edodo (data). O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "date_end", "value": "2026-12-31", "description": "Fim do per\u00edodo (data). O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "bank_accounts[0]", "value": "ec0956db-f67a-32ef-b9c6-8a0e0478c732", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "customers[0]", "value": "766b1b55-1713-3b20-b44a-d5495e74550f", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "suppliers[0]", "value": "312e68a3-8fe1-3586-adb0-0a8b0a0fb83c", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "cash_session", "value": "687675a2-3672-31d0-8127-b3119f13c288", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "works[0]", "value": "a4f08ed8-91a4-3acb-93e0-7e02ad634871", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "url", "value": "", "description": "", "disabled": true }, { "key": "base64", "value": "", "description": "", "disabled": true }, { "key": "aba_unica", "value": "", "description": "", "disabled": true } ], "raw": "{{baseUrl}}\/api\/reports\/cash-flow?q=voluptatem&type=entrada&description=Et+quam+aperiam+non+necessitatibus+iusto.&categories[0]=1cd8d871-26cd-3671-96e0-ce14108d273e&exclude_categories[0]=ad8e4b37-0277-374f-a991-fab61946dcba&date_start=2026-01-01&date_end=2026-12-31&bank_accounts[0]=ec0956db-f67a-32ef-b9c6-8a0e0478c732&customers[0]=766b1b55-1713-3b20-b44a-d5495e74550f&suppliers[0]=312e68a3-8fe1-3586-adb0-0a8b0a0fb83c&cash_session=687675a2-3672-31d0-8127-b3119f13c288&works[0]=a4f08ed8-91a4-3acb-93e0-7e02ad634871&url=&base64=&aba_unica=" }, "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": "Export Accounts Payable\/Receivable to Excel", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/accounts-payable-receivable\/excel", "query": [], "raw": "{{baseUrl}}\/api\/reports\/accounts-payable-receivable\/excel" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Dispatches async Excel generation. Frontend receives notification via Pusher when ready." }, "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": "Sectors", "description": "Endpoints for sectors", "item": [ { "name": "List sectors", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Tecnologia", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/sectors?sort_by=created_at&sort_desc=1&page=1&per_page=15&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\":\"2dfc07cf-08e9-3c7a-8f55-f3973371eeae\",\"name\":\"atque sed\",\"slug\":null,\"description\":null,\"abbreviation\":\"mnc\",\"created_at\":null,\"updated_at\":null},{\"id\":\"2af2f87d-b692-3864-8c31-188b6693d484\",\"name\":\"maxime aut\",\"slug\":null,\"description\":\"Sint assumenda maiores sequi nisi cum. Provident aut ea assumenda veniam repudiandae dolore esse. Harum laborum eveniet ut voluptates amet doloremque.\",\"abbreviation\":\"kiz\",\"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": "17", "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\":\"98124060-1db2-3735-a17b-52e1e13382cf\",\"name\":\"fuga quidem\",\"slug\":null,\"description\":\"Debitis quia aut sed eaque non. Est necessitatibus sed alias asperiores rerum dolor ea doloribus. Sit cumque nihil quo omnis nemo. Iusto ut sed beatae est. Ipsa aut perferendis natus consequatur debitis.\",\"abbreviation\":\"vjj\",\"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": "2", "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": "5", "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\":\"c9abae8f-5c44-3dcc-8e20-299f8d246bc8\",\"name\":\"Dr. Evan Schinner Sr.\",\"username\":\"jillian23\",\"email\":\"bennett.trantow@example.com\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"9593def0-6ce2-3e21-9cd3-7190d91b048d\",\"name\":\"Prof. Rick Beier\",\"username\":\"jessie.schoen\",\"email\":\"bette.johnson@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\":[\"c763fada-109a-39ce-bda5-51e973619a3f\"]}" }, "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\":[\"6db7cda1-b4e3-38d8-83b9-a805df90e471\"]}" }, "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\":[\"5c1795b5-367f-349a-897a-16b32014d91a\"]}" }, "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\":\"quisquam ut\",\"slug\":\"ratione-et-inventore-quisquam\"},{\"name\":\"quaerat autem\",\"slug\":\"voluptatem-voluptatem-et-iure-distinctio\"}]}", "name": "" } ] } ] }, { "name": "Statuses", "description": "Endpoints for statuses", "item": [ { "name": "List statuses", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/statuses", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Em+andamento", "description": "Search query.", "disabled": false }, { "key": "module", "value": "work", "description": "Filter by module slug. The slug of an existing record in the status_modules table.", "disabled": false }, { "key": "sector_id", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Filter by sector UUID. The uuid of an existing record in the sectors table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/statuses?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Em+andamento&module=work§or_id=019556e7-2e9f-777c-a177-30bbf0646c32" }, "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\":\"8a531c7b-6edc-38e6-ae51-171786a5a254\",\"slug\":null,\"name\":null,\"description\":\"Deivid Garcia Quintana Neto\",\"abbreviation\":\"dolorum\",\"color\":\"#49bf0c\",\"text_color\":\"#49d415\",\"module\":{\"name\":\"Obras\",\"slug\":\"work\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"982f7501-da47-3f98-a53e-6c28c3e63e2c\",\"slug\":null,\"name\":null,\"description\":\"Lorenzo Gil Paes Neto\",\"abbreviation\":\"sunt\",\"color\":\"#440448\",\"text_color\":\"#fb6e37\",\"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": "{\"slug\":\"Example Slug\",\"name\":\"Example Name\",\"description\":\"Example Description\",\"abbreviation\":\"Example Abbreviation\",\"module\":\"Example Module\",\"sector_id\":\"4602fab1-8031-3b8b-b509-d1461849c946\",\"color\":\"Example Color\",\"text_color\":\"Example Text color\",\"order\":1,\"is_initial\":true,\"is_final\":true}" }, "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": "1", "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\":\"b9c31b56-e3e0-3f53-831d-8900a4a3e0fb\",\"slug\":null,\"name\":null,\"description\":\"\\u00cdcaro Santos Zambrano\",\"abbreviation\":\"consequatur\",\"color\":\"#5b4f83\",\"text_color\":\"#4af12e\",\"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": "1", "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": "{\"slug\":\"Example Slug\",\"name\":\"Example Name\",\"description\":\"Example Description\",\"abbreviation\":\"Example Abbreviation\",\"module\":\"Example Module\",\"sector_id\":\"53a2ec67-e256-3ee4-9001-e720afdeae99\",\"color\":\"Example Color\",\"text_color\":\"Example Text color\",\"order\":1,\"is_initial\":true,\"is_final\":true}" }, "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": "Stock", "description": "Endpoints for stock management", "item": [ { "name": "List stocks available for transfer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/available-for-transfer", "query": [ { "key": "product_id", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Product UUID to search for. O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the products table.", "disabled": false }, { "key": "exclude_work_id", "value": "019556e7-2e9f-777c-a177-30bbf0646c33", "description": "Work UUID to exclude from results (usually the requesting work). O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the works table.", "disabled": false }, { "key": "min_quantity", "value": "1", "description": "Minimum quantity available. O campo value deve ser pelo menos 0.0001.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/stocks\/available-for-transfer?product_id=019556e7-2e9f-777c-a177-30bbf0646c32&exclude_work_id=019556e7-2e9f-777c-a177-30bbf0646c33&min_quantity=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a list of stock items from other works that have the specified product available for transfer" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"77f8c46a-211b-3347-b577-135604e9c501\",\"quantity\":463.9722,\"min_quantity\":null,\"max_quantity\":null,\"below_minimum\":false,\"above_maximum\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"1a002909-6fe0-3931-a1a5-b3a233747bfa\",\"quantity\":730.43,\"min_quantity\":null,\"max_quantity\":null,\"below_minimum\":false,\"above_maximum\":false,\"created_at\":null,\"updated_at\":null}]}", "name": "" } ] }, { "name": "List stocks", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Number of items per page. O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Main+Stock", "description": "Search by stock name. O campo value n\u00e3o pode ser superior a 255 caracteres.", "disabled": false }, { "key": "module", "value": "work", "description": "Filter by module type (e.g., work, customer). O campo value n\u00e3o pode ser superior a 100 caracteres.", "disabled": false }, { "key": "is_active", "value": "1", "description": "Filter by active status.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/stocks?sort_by=created_at&sort_desc=1&page=1&per_page=10&q=Main+Stock&module=work&is_active=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of stocks" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"88f1d044-6b47-37b5-9c1c-802157f4bfbc\",\"name\":\"Estoque Batista-Vale\",\"module\":\"work\",\"is_active\":true,\"is_main\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"108764b5-7dfa-350f-885e-7fd3d0618327\",\"name\":\"Estoque Oliveira-Rodrigues\",\"module\":\"work\",\"is_active\":true,\"is_main\":false,\"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 stock", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks", "query": [], "raw": "{{baseUrl}}\/api\/stocks" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"module\":\"Example Module\",\"id\":\"Example Id\",\"is_active\":true}" }, "description": "Creates a new stock linked to a module" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"e3e396dd-1002-38e1-916d-fbff679e5e25\",\"name\":\"Estoque Verdugo-Padr\\u00e3o\",\"module\":\"work\",\"is_active\":true,\"is_main\":false,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Get main stock", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/main", "query": [], "raw": "{{baseUrl}}\/api\/stocks\/main" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the main stock" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"cd922f7f-d7cd-37ed-b4b0-65c84ca99359\",\"name\":\"Estoque Padr\\u00e3o e Leal\",\"module\":\"work\",\"is_active\":true,\"is_main\":false,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Show stock", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stocks\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the stock." }, { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns details of a specific stock" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"b263b354-44f8-3f8e-99f8-f78489d21ebf\",\"name\":\"Estoque Zarago\\u00e7a-Queir\\u00f3s\",\"module\":\"work\",\"is_active\":true,\"is_main\":false,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Update stock", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stocks\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the stock." }, { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"is_active\":true}" }, "description": "Updates an existing stock" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"ab181ef0-dd6c-3b0e-ae2c-7db8a449508f\",\"name\":\"Estoque de Aguiar S.A.\",\"module\":\"work\",\"is_active\":true,\"is_main\":false,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Delete stock", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stocks\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the stock." }, { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes a stock (soft delete)" }, "response": [] }, { "name": "List stock items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:stock\/items", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Number of items per page. O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Cement", "description": "Search by product name. O campo value n\u00e3o pode ser superior a 255 caracteres.", "disabled": false }, { "key": "below_minimum", "value": "1", "description": "Filter items below minimum quantity.", "disabled": false }, { "key": "above_maximum", "value": "", "description": "Filter items above maximum quantity.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/stocks\/:stock\/items?sort_by=created_at&sort_desc=1&page=1&per_page=10&q=Cement&below_minimum=1&above_maximum=", "variable": [ { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of items\/products in a stock" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"cdd6f797-7cfc-3eeb-9b67-b48e40c4ff32\",\"quantity\":661.8207,\"min_quantity\":null,\"max_quantity\":null,\"below_minimum\":false,\"above_maximum\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"a3c973ab-d239-396d-a100-9bbf164e1598\",\"quantity\":504.1162,\"min_quantity\":null,\"max_quantity\":null,\"below_minimum\":false,\"above_maximum\":false,\"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": "Update stock item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:stock_id\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stocks\/:stock_id\/items\/:id", "variable": [ { "id": "stock_id", "key": "stock_id", "value": "1", "description": "The ID of the stock." }, { "id": "id", "key": "id", "value": "non", "description": "The ID of the item." }, { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" }, { "id": "item", "key": "item", "value": "019556e7-3a1b-888d-b288-41ccf0757d43", "description": "Stock item UUID" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"min_quantity\":10,\"max_quantity\":100}" }, "description": "Updates min\/max quantity thresholds for a stock item" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"3eb42b1a-c369-35cb-979a-0336e1701284\",\"quantity\":7.1864,\"min_quantity\":null,\"max_quantity\":null,\"below_minimum\":false,\"above_maximum\":false,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Stock summary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:stock\/summary", "query": [], "raw": "{{baseUrl}}\/api\/stocks\/:stock\/summary", "variable": [ { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a summary with totals and alerts for the stock" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"total_products\": 15,\n \"total_quantity\": 1250.5,\n \"items_below_minimum\": 3,\n \"items_above_maximum\": 1\n }\n}", "name": "" } ] } ] }, { "name": "Stock Movements", "description": "Endpoints for stock movement management", "item": [ { "name": "List movements", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:stock_id\/movements", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Number of items per page. O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "type", "value": "entry", "description": "Filter by movement type (entry, consumption, transfer_in, transfer_out, adjustment_up, adjustment_down). O campo value n\u00e3o pode ser superior a 50 caracteres.", "disabled": false }, { "key": "product_id", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Filter by product UUID. O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "date_start", "value": "2024-01-01", "description": "Filter movements 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 movements 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 } ], "raw": "{{baseUrl}}\/api\/stocks\/:stock_id\/movements?sort_by=created_at&sort_desc=1&page=1&per_page=10&type=entry&product_id=019556e7-2e9f-777c-a177-30bbf0646c32&date_start=2024-01-01&date_end=2024-12-31", "variable": [ { "id": "stock_id", "key": "stock_id", "value": "1", "description": "The ID of the stock." }, { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of movements for a stock" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"9bb56ff3-64fc-32e6-b257-d178e9852e35\",\"code\":\"MOV-403407\",\"type\":\"aloca\\u00e7\\u00e3o\",\"type_name\":\"ALLOCATION\",\"is_entry\":true,\"is_exit\":false,\"quantity\":81.4369,\"previous_quantity\":522.3343,\"new_quantity\":603.7712,\"reason\":null,\"movement_date\":\"2026-06-08T12:47:37.000000Z\",\"created_at\":null},{\"id\":\"d38cfe57-018b-3895-b0f1-99680aa00b98\",\"code\":\"MOV-558602\",\"type\":\"perda\",\"type_name\":\"LOSS\",\"is_entry\":false,\"is_exit\":true,\"quantity\":14.3847,\"previous_quantity\":293.0464,\"new_quantity\":278.6617,\"reason\":null,\"movement_date\":\"2026-05-31T05:53:49.000000Z\",\"created_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 movement", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:stock_id\/movements", "query": [], "raw": "{{baseUrl}}\/api\/stocks\/:stock_id\/movements", "variable": [ { "id": "stock_id", "key": "stock_id", "value": "1", "description": "The ID of the stock." }, { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":\"b9f3851b-2068-399e-bda1-b5c952a478a8\",\"type\":\"Example Type\",\"quantity\":1,\"reason\":\"Example Reason\",\"reference_type\":\"Example Reference type\",\"reference_id\":1,\"movement_date\":\"2024-01-01\"}" }, "description": "Creates a new entry or exit movement in the stock" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"47551e74-5617-3678-8019-6703aef641ca\",\"code\":\"MOV-346716\",\"type\":\"vencido\",\"type_name\":\"EXPIRED\",\"is_entry\":false,\"is_exit\":true,\"quantity\":73.3946,\"previous_quantity\":136.5215,\"new_quantity\":63.1269,\"reason\":null,\"movement_date\":\"2026-06-19T13:28:33.000000Z\",\"created_at\":null}}", "name": "" } ] }, { "name": "Transfer between stocks", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:stock\/movements\/transfer", "query": [], "raw": "{{baseUrl}}\/api\/stocks\/:stock\/movements\/transfer", "variable": [ { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Source stock UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":\"31a8f3b8-3fbd-3b66-8be5-a1bc4ae2df4f\",\"destination_stock_id\":\"2543adb3-002c-302d-ac1e-b0421949c2c2\",\"quantity\":1,\"reason\":\"Example Reason\",\"movement_date\":\"2024-01-01\"}" }, "description": "Transfers products from one stock to another" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"a348c494-ee74-3287-8708-65d2c6d767f7\",\"code\":\"MOV-210363\",\"type\":\"aloca\\u00e7\\u00e3o\",\"type_name\":\"ALLOCATION\",\"is_entry\":true,\"is_exit\":false,\"quantity\":9.4237,\"previous_quantity\":509.1995,\"new_quantity\":518.6232,\"reason\":null,\"movement_date\":\"2026-06-18T11:29:36.000000Z\",\"created_at\":null}}", "name": "" } ] }, { "name": "Inventory adjustment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:stock\/movements\/inventory", "query": [], "raw": "{{baseUrl}}\/api\/stocks\/:stock\/movements\/inventory", "variable": [ { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":\"92fa6640-e08a-308b-8b0e-4be984cd09b4\",\"new_quantity\":1,\"reason\":\"Example Reason\",\"movement_date\":\"2024-01-01\"}" }, "description": "Performs inventory adjustment to correct stock quantity" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"7d1fe8d1-c710-3565-a851-08c05d5a5d9e\",\"code\":\"MOV-481927\",\"type\":\"produ\\u00e7\\u00e3o\",\"type_name\":\"PRODUCTION\",\"is_entry\":true,\"is_exit\":false,\"quantity\":12.9093,\"previous_quantity\":900.9483,\"new_quantity\":913.8576,\"reason\":null,\"movement_date\":\"2026-06-02T01:44:28.000000Z\",\"created_at\":null}}", "name": "" } ] }, { "name": "Purchase entry", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stock-movements\/purchase", "query": [], "raw": "{{baseUrl}}\/api\/stock-movements\/purchase" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":\"c94a8248-7add-365e-81ab-5f501e757dd2\",\"quantity\":1,\"reason\":\"Example Reason\",\"movement_date\":\"2024-01-01\"}" }, "description": "Registers a purchase entry directly into the main stock" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"99d1a9d5-007f-39f9-b784-66f3b610aaf5\",\"code\":\"MOV-348026\",\"type\":\"produ\\u00e7\\u00e3o\",\"type_name\":\"PRODUCTION\",\"is_entry\":true,\"is_exit\":false,\"quantity\":68.4759,\"previous_quantity\":384.9405,\"new_quantity\":453.4164,\"reason\":\"Adipisci commodi ut ad odit incidunt qui non dolor.\",\"movement_date\":\"2026-06-14T07:23:37.000000Z\",\"created_at\":null}}", "name": "" } ] }, { "name": "Show movement", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stock-movements\/:movement", "query": [], "raw": "{{baseUrl}}\/api\/stock-movements\/:movement", "variable": [ { "id": "movement", "key": "movement", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Movement UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns details of a specific movement" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"051bfc59-bd7a-3165-b8d3-53fb40986acf\",\"code\":\"MOV-828876\",\"type\":\"venda\",\"type_name\":\"SALE\",\"is_entry\":false,\"is_exit\":true,\"quantity\":54.0169,\"previous_quantity\":238.2312,\"new_quantity\":184.2143,\"reason\":\"Laudantium aut suscipit excepturi ab laboriosam facere sint libero.\",\"movement_date\":\"2026-06-16T18:19:42.000000Z\",\"created_at\":null}}", "name": "" } ] } ] }, { "name": "Suppliers", "description": "Endpoints for suppliers", "item": [ { "name": "List suppliers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/suppliers", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Supplier+name", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/suppliers?sort_by=created_at&sort_desc=1&page=1&per_page=15&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\":\"95b334d1-e8e7-3e3c-bcc9-e669031fff9f\",\"name\":\"Jean Santana Leon\",\"email\":\"mirella97@example.com\",\"phone\":\"(88) 92984-9991\",\"document\":\"18.248.190\\\/0001-26\",\"type\":\"pj\",\"responsible\":\"Alexa Queir\\u00f3s Filho\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null}},{\"id\":\"f6f83712-b243-3e4f-ae1d-6bd42ea09781\",\"name\":\"Benedito Barreto Branco Neto\",\"email\":\"veronica13@example.net\",\"phone\":\"(67) 90346-6465\",\"document\":\"07.100.590\\\/0001-73\",\"type\":\"pf\",\"responsible\":\"Bruno Gabriel Rezende Jr.\",\"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": "1", "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\":\"8771e3a9-89e9-36f5-b511-a58e07881b93\",\"name\":\"Ant\\u00f4nio Robson da Rosa Jr.\",\"email\":\"bonilha.tomas@example.com\",\"phone\":\"(84) 3749-9064\",\"document\":\"87.926.250\\\/0001-35\",\"type\":\"pf\",\"responsible\":\"Dr. Teobaldo Vasques Marinho Jr.\",\"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": "1", "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": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "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?sort_by=created_at&sort_desc=1&page=1&per_page=15&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\":\"d18f89c4-fee8-3515-8332-080e1e1cc3dc\",\"name\":\"Thalissa Elo\\u00e1 Esteves Filho\",\"description\":\"Est molestias non dolorum incidunt pariatur odio. Odit culpa qui ullam aut ad. Et nihil consequuntur quo ipsum reiciendis perferendis perferendis a.\",\"type\":\"ajuste sa\\u00edda\"},{\"id\":\"0aa304af-d204-346c-b4c0-c953fa1417a1\",\"name\":\"Tiago David Molina\",\"description\":\"Alias et optio qui deserunt harum ut. Ipsam labore veritatis dolorem rem atque itaque dolor. Enim velit cupiditate dolores voluptatibus. Ut veritatis saepe quia laboriosam.\",\"type\":\"ajuste\"}],\"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": "et", "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\":\"17caa26d-c07a-3228-b7cf-c3eae40ef5b6\",\"name\":\"Ot\\u00e1vio Evandro Meireles Filho\",\"description\":\"Placeat maxime animi repellendus consequatur. Ut dolor sequi repellendus dolores ut. Aut delectus voluptatem quaerat rerum quis aliquid odit.\",\"type\":\"dep\\u00f3sito\"}}", "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": "modi", "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": "iure", "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\":\"6d2eac40-fcda-39b7-bb69-217249897dea\",\"name\":\"Sr. Ivan Delgado Vieira\",\"abbreviation\":\"Sr. Emiliano Teobaldo Carrara Sobrinho\",\"description\":\"Eos enim maxime aut et qui.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"f7fbc6e1-2ecb-3a9b-885a-bef226e03b37\",\"name\":\"Sra. Mila Santacruz\",\"abbreviation\":\"Igor Rocha\",\"description\":\"Eos recusandae qui optio.\",\"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": "ducimus", "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\":\"7d072ee2-a179-3d75-b390-6b4f798dd478\",\"name\":\"Lorena Val\\u00eancia\",\"abbreviation\":\"Ivan Azevedo Cort\\u00eas\",\"description\":\"Et tempora inventore a.\",\"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\":\"Example Name\",\"abbreviation\":\"Example Abbreviation\",\"description\":\"Example Description\"}" }, "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": "minima", "description": "Unit UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"abbreviation\":\"Example Abbreviation\",\"description\":\"Example Description\"}" }, "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": "omnis", "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": "Users", "description": "Endpoints for users", "item": [ { "name": "List users", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "John+Doe", "description": "Search query by name or email.", "disabled": false }, { "key": "sector_id", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "Filter by sector UUID. The uuid of an existing record in the sectors table.", "disabled": false }, { "key": "role", "value": "ADMIN", "description": "Filter by role name. The name of an existing record in the roles table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/users?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=John+Doe§or_id=123e4567-e89b-12d3-a456-426614174000&role=ADMIN" }, "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\":\"a333e080-f820-3e17-8178-6263dcac720b\",\"name\":\"Samanta Franecki DDS\",\"username\":\"margret83\",\"email\":\"tony.johnson@example.com\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"64852878-4a01-335a-8641-7f22db2f274b\",\"name\":\"Frederick Hilpert\",\"username\":\"lind.harold\",\"email\":\"buckridge.lempi@example.net\",\"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": "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\":\"b83c66ce-405d-3d30-9a8e-5aec389182bd\",\"name\":\"Mr. Arne Hermiston DDS\",\"username\":\"wilkinson.caden\",\"email\":\"karley18@example.com\",\"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\":\"hagenes.alfredo\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"d7b5a78c-f1af-3588-acf0-20d51c46752a\"],\"roles\":[\"e3f167bb-2801-30e7-bc66-f628830d5384\"]}" }, "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\":\"waino.hermann\",\"password\":\"password123\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"f9390345-206a-3322-ae20-4823e58e5559\"],\"roles\":[\"576a425a-e3a2-37dd-b3c5-5364f9774dc2\"]}" }, "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\":[\"1d78a79b-802e-3e3c-a66e-0649f81fd569\"]}" }, "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\":\"veniam\",\"display_name\":\"Facere sed excepturi tempora facilis.\"},{\"id\":null,\"name\":\"velit\",\"display_name\":\"Eum repellat illum quis laborum ullam et unde iure.\"}]}", "name": "" } ] } ] }, { "name": "Work Locations", "description": "Endpoints for work locations", "item": [ { "name": "List work locations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/work-locations", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "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?sort_by=created_at&sort_desc=1&page=1&per_page=15&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\":\"33c1fc1f-d757-3d93-9063-d04ff35c483a\",\"description\":\"Sr. Filipe Rico\",\"work\":{\"id\":null,\"name\":null},\"documents\":[],\"created_at\":null,\"updated_at\":null},{\"id\":\"ddef6b02-740d-3505-b812-ae89db5bf16e\",\"description\":\"Wilson Erik Leon\",\"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\":\"Example Description\",\"work_id\":\"95eabe51-1321-3a36-8be7-179de48ab30b\"}" }, "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\":\"11f642c0-275a-3a10-a3c5-125cd26da3b2\",\"description\":\"Ingrid Pacheco Alves\",\"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\":\"Example Description\",\"work_id\":\"e8f0aff3-4978-3bed-9124-727721b2dcde\"}" }, "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": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Tecnologia", "description": "Search query.", "disabled": false }, { "key": "customer_id", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Filter by customer UUID. The uuid of an existing record in the customers table.", "disabled": false }, { "key": "status_id", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Filter by status UUID. The uuid of an existing record in the statuses table.", "disabled": false }, { "key": "responsible_id", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Filter by responsible user UUID. Only works if user has \"work view-all\" permission. The uuid of an existing record in the users table.", "disabled": false }, { "key": "no_responsible", "value": "1", "description": "Filter works without any responsible users.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/works?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Tecnologia&customer_id=019556e7-2e9f-777c-a177-30bbf0646c32&status_id=019556e7-2e9f-777c-a177-30bbf0646c32&responsible_id=019556e7-2e9f-777c-a177-30bbf0646c32&no_responsible=1" }, "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\":\"8d698a99-aa95-3250-aeb1-69a7fc5b8a01\",\"name\":\"Sr. Emerson Ferraz Leon Sobrinho\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents\":[],\"locations\":[],\"product_quantity_lists_count\":0,\"product_quantity_list_items_count\":0,\"product_requests_count\":0,\"product_request_items_count\":0,\"documents_count\":0,\"locations_documents_count\":0,\"total_documents_count\":0,\"started_at\":{\"date\":\"2019-09-26 18:12:48.000000\",\"timezone_type\":3,\"timezone\":\"America\\\/Sao_Paulo\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"8014caca-78e6-30ef-a15e-785f45274647\",\"name\":\"Graziela Daniella D'\\u00e1vila Filho\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents\":[],\"locations\":[],\"product_quantity_lists_count\":0,\"product_quantity_list_items_count\":0,\"product_requests_count\":0,\"product_request_items_count\":0,\"documents_count\":0,\"locations_documents_count\":0,\"total_documents_count\":0,\"started_at\":{\"date\":\"1975-04-21 01:28:56.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\":\"Example Name\",\"customer_id\":\"af1c73a9-0683-354f-a627-0da337b0def8\",\"status_id\":\"d5b898fe-38d4-3b10-a605-3132b641e5af\",\"started_at\":\"Example Started at\",\"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 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": "1", "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\":\"4787f6cc-9ac1-3dce-98d2-65ad8647a4bf\",\"name\":\"Sra. Aline Serrano Sobrinho\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents\":[],\"locations\":[],\"product_quantity_lists_count\":0,\"product_quantity_list_items_count\":0,\"product_requests_count\":0,\"product_request_items_count\":0,\"documents_count\":0,\"locations_documents_count\":0,\"total_documents_count\":0,\"started_at\":{\"date\":\"2024-04-07 05:08:19.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": "1", "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\":\"Example Name\",\"customer_id\":\"c429aef6-39ac-3be4-a387-8f656508cbfb\",\"status_id\":\"164fe287-dade-39ff-9849-9c86a6049a21\",\"started_at\":\"Example Started at\",\"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 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": "1", "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": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "John", "description": "Search by name or email.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/works\/:work\/responsibles?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=John", "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 users responsible for a work" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"f01bb388-9b90-3ba5-92bc-8c4a596b75e4\",\"name\":\"Eula O'Reilly\",\"username\":\"beatrice23\",\"email\":\"gfadel@example.net\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"6801a7c2-1472-33a4-bd1d-2d46a11db7b2\",\"name\":\"Madonna Kuphal\",\"username\":\"ywindler\",\"email\":\"aida.parker@example.net\",\"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 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": "{\"users\":[\"abc032ea-dbd7-3a86-ad7c-879bcfcfbe64\"]}" }, "description": "Attach users as responsibles to a work without removing existing ones" }, "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": "{\"users\":[\"196f9261-5423-38f2-abfc-4f09b58f2970\"]}" }, "description": "Remove specific users as responsibles from a work" }, "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": "{\"users\":[\"78aadc72-b4e4-380d-85fa-ddc47ec8bb3e\"]}" }, "description": "Replace all responsibles of a work with the provided list" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Responsibles synchronized successfully\"}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }