{ "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": "ce5c6e89-10a0-4404-908c-953327d4d76e", "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\":\"41a6c147-dbfe-388b-bdc3-df2819c78a1b\",\"name\":\"delectus-6aedfa3c8f813\",\"display_name\":\"Laudantium et non ullam.\",\"permissions_count\":null},{\"id\":\"a838ef73-4be4-35f1-baea-8a02bc939059\",\"name\":\"voluptatum-6aedfa3c938ef\",\"display_name\":\"Aut est et et ut enim architecto odio iure.\",\"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\":[\"09477fa9-9141-301a-b05a-5bdad15d2d08\"]}" }, "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\":[\"7aa218e9-e0eb-34bb-bbba-4db7926cf300\"]}" }, "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\":\"0b1ae0c7-5533-3fec-bfe9-1d85af51b1d2\",\"name\":\"facere-6aedfa3ca0835\",\"display_name\":\"Ipsam rem aut dolor magni velit exercitationem laboriosam.\",\"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\":\"eum\",\"display_name\":\"Perspiciatis ut alias et reiciendis labore.\"},{\"id\":null,\"name\":\"est\",\"display_name\":\"Architecto pariatur aut odit velit exercitationem.\"}]}", "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\":\"est\",\"display_name\":\"Temporibus reprehenderit molestiae et tempore voluptatibus.\"},{\"id\":null,\"name\":\"voluptas\",\"display_name\":\"Ut qui magnam beatae dolores fugit dolorum earum ut.\"}],\"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\":\"maiores\",\"display_name\":\"Id voluptatibus minus ullam quae aut rerum.\"}}", "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\":\"df399040-1489-3a8d-adbc-0d97a04468cb\",\"code\":null,\"type\":\"sa\\u00edda\",\"payment_method\":\"boleto\",\"amount\":5042.57,\"due_date\":\"2026-12-04T03: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\":\"Sit eveniet et labore aspernatur et fuga ducimus commodi magni praesentium.\",\"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\":\"sit\",\"field2\":8,\"field3\":false,\"notes\":\"Aut aspernatur dolore id sed voluptates.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"e781b60c-92e2-39e8-930a-bdfca10c0812\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"cheque\",\"amount\":8125.51,\"due_date\":\"2026-12-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 est et eligendi vitae aspernatur facere similique.\",\"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\":\"neque\",\"field2\":44,\"field3\":true,\"notes\":\"Harum suscipit sapiente voluptas impedit.\",\"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": "aut", "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]=aut" }, "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": "esse", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "non", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "quo", "description": "The uuid of an existing record in the works table.", "disabled": false }, { "key": "cost_centers[0]", "value": "reiciendis", "description": "The uuid of an existing record in the cost_centers table.", "disabled": false }, { "key": "statuses[0]", "value": "cancelado", "description": "", "disabled": false }, { "key": "payment_method", "value": "cheque", "description": "Payment method.", "disabled": false }, { "key": "date_start", "value": "2023-01-01", "description": "Start date. O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "date_end", "value": "2023-12-31", "description": "End date. O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "protest_date_start", "value": "2026-11-06T13%3A03%3A08", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "protest_date_end", "value": "2026-11-06T13%3A03%3A08", "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]=esse&suppliers[0]=non&works[0]=quo&cost_centers[0]=reiciendis&statuses[0]=cancelado&payment_method=cheque&date_start=2023-01-01&date_end=2023-12-31&protest_date_start=2026-11-06T13%3A03%3A08&protest_date_end=2026-11-06T13%3A03%3A08&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\":\"c31e5ac3-915a-3981-a2e2-2c41823b2a91\",\"code\":null,\"type\":\"sa\\u00edda\",\"payment_method\":\"cheque\",\"amount\":982.09,\"due_date\":\"2026-11-23T03: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\":\"Velit molestiae id eius id quibusdam sint voluptatem quia nulla.\",\"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\":\"fugiat\",\"field2\":87,\"field3\":false,\"notes\":\"Eius quo est est sapiente sequi ut mollitia.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"c6f2d6d9-9e9f-3a59-bb84-c8b6653332f2\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"cheque\",\"amount\":6870.53,\"due_date\":\"2026-11-27T03: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 sit repellendus hic officia omnis amet dolorum et ut tenetur temporibus.\",\"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\":\"deleniti\",\"field2\":73,\"field3\":true,\"notes\":\"Dolor perferendis molestias sed quis assumenda.\",\"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": "officia", "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": "rem", "description": "The uuid of an existing record in the works table.", "disabled": false }, { "key": "cost_centers[0]", "value": "consequatur", "description": "The uuid of an existing record in the cost_centers table.", "disabled": false }, { "key": "statuses[0]", "value": "pago", "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-11-06T13%3A03%3A08", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "protest_date_end", "value": "2026-11-06T13%3A03%3A08", "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]=officia&suppliers[0]=est&works[0]=rem&cost_centers[0]=consequatur&statuses[0]=pago&payment_method=cheque&date_start=2023-01-01&date_end=2023-12-31&protest_date_start=2026-11-06T13%3A03%3A08&protest_date_end=2026-11-06T13%3A03%3A08&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\":\"da773aa2-daff-32e7-a1c6-6234e7dbc2fc\",\"code\":null,\"type\":\"sa\\u00edda\",\"payment_method\":\"cheque\",\"amount\":8539.14,\"due_date\":\"2026-12-03T03: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\":\"Magni ullam ipsum velit cupiditate dignissimos sequi consectetur.\",\"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\":\"quos\",\"field2\":78,\"field3\":true,\"notes\":\"Voluptas velit officia expedita.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"ea160bca-de70-3796-8ba9-432be3a1bc48\",\"code\":null,\"type\":\"sa\\u00edda\",\"payment_method\":\"boleto\",\"amount\":9607.61,\"due_date\":\"2026-11-20T03: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\":\"Cupiditate distinctio velit dolorem culpa et qui quos similique.\",\"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\":\"eos\",\"field2\":33,\"field3\":false,\"notes\":\"Dignissimos iure alias quod eligendi nam.\",\"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\":\"e3bd2ba9-5c44-389e-a2f9-d2d5aa0f5edf\",\"customer_id\":\"c3d7ed09-7427-3500-90ab-da18fb1ba376\",\"work_id\":\"50af7513-b55f-3381-b8eb-d91c7141a602\",\"cost_center_id\":\"db1ea72e-33e9-3709-8732-9215d6bf1343\",\"status\":\"Example Status\",\"protest_date\":\"2024-01-01\",\"bank_account_id\":\"1e101d1b-c4fa-3349-8899-1a50eee58544\",\"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\":\"explicabo\",\"installment_ids\":[\"ullam\"],\"payment_method\":\"cheque\",\"work_id\":\"totam\",\"cost_center_id\":\"earum\"}" }, "description": "Gera contas a pagar para as parcelas selecionadas de uma nota fiscal. A obra \u00e9 opcional: quando omitida, s\u00f3 \u00e9 herdada se a NF tiver exatamente uma obra vinculada." }, "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": "velit", "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": "sunt", "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\":\"de7014d8-17a3-3111-ba39-f7aded1f6b20\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"boleto\",\"amount\":8044.74,\"due_date\":\"2026-11-21T03: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\":\"Est itaque fugit mollitia voluptas reprehenderit sint adipisci voluptas aspernatur.\",\"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\":\"ex\",\"field2\":11,\"field3\":true,\"notes\":\"Id minus id at sed et quo.\",\"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": "totam", "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\":\"ba84e2a2-d687-3da0-89d8-c484332af22c\",\"customer_id\":\"e962fa44-001f-3b46-9067-39451079b821\",\"work_id\":\"ee6c92f1-14d5-3716-9310-be700aa1698c\",\"cost_center_id\":\"be52003e-6688-3378-8506-ab95987981c2\",\"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\":\"beb1cab7-2fe3-3eba-96ac-3c2951277e83\",\"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": "quidem", "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\":\"yadira.donnelly@example.org\",\"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\":\"b6d55999-2df7-3c96-8d7e-8378437196bd\",\"name\":\"Sidney Grimes Jr.\",\"username\":\"emerson.balistreri\",\"email\":\"willy69@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\",\"certification\":\"Example Certification\",\"crea\":\"Example Crea\",\"email\":\"user@example.com\",\"username\":\"heidi91\",\"password\":\"password123\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"cb6a82b5-55bf-3859-8557-b760d1910b7a\"],\"roles\":[\"da1e364e-febc-3df7-9c84-4c76c949dd12\"]}" }, "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\":\"cxivssmedaimfrwrhl\",\"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": "occaecati", "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": "eius", "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": "1", "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": "12", "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\":\"ca9662b4-3af7-3a37-9b61-8670c6d70a8d\",\"agency\":\"5664\",\"account\":\"8966064-1\",\"type\":\"corrente\",\"balance\":4768.62,\"holder_type\":\"pf\",\"alias\":\"et\",\"limit\":2724.98,\"available_balance\":7493.6,\"used_limit\":0,\"available_limit\":2724.98,\"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\":\"04f0a697-ec08-3524-b4f0-560a93fae321\",\"agency\":\"4840\",\"account\":\"3920333-8\",\"type\":\"poupan\\u00e7a\",\"balance\":39.33,\"holder_type\":\"pj\",\"alias\":\"sint\",\"limit\":8726.74,\"available_balance\":8766.07,\"used_limit\":0,\"available_limit\":8726.74,\"is_default\":null,\"default_payment_method\":null,\"bank\":{\"id\":null,\"name\":null,\"code\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"e36e4575-e626-3c74-8441-c5029416de68\",\"agency\":\"1305\",\"account\":\"2968714-7\",\"type\":\"corrente\",\"balance\":2787.68,\"holder_type\":\"pj\",\"alias\":\"consequatur\",\"limit\":5086.15,\"available_balance\":7873.83,\"used_limit\":0,\"available_limit\":5086.15,\"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\":\"9456642-5\",\"bank_id\":\"51afef1d-5691-38d2-8cc0-9f8c4485664b\",\"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": "3", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"agency\":\"Example Agency\",\"account\":\"3168706-6\",\"bank_id\":\"77f9c59e-b176-3b8c-a64f-f68f8e17a2fc\",\"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": "9", "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\":\"e4e980d4-fbc5-3b22-8edf-8344aa6d0d97\",\"agency\":\"1365\",\"account\":\"9318664-9\",\"type\":\"corrente\",\"balance\":1998.26,\"holder_type\":\"pj\",\"alias\":\"reprehenderit\",\"limit\":6383.5,\"available_balance\":8381.76,\"used_limit\":0,\"available_limit\":6383.5,\"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": "12", "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": "1", "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": "14", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"sort_by\":\"est\",\"sort_desc\":false,\"page\":62,\"per_page\":2,\"q\":\"edvrlgbjbctra\",\"type\":\"sa\u00edda\",\"date_start\":\"2026-11-06T13:03:09\",\"date_end\":\"2065-04-24\"}" }, "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": "19", "description": "" }, { "id": "bankStatement", "key": "bankStatement", "value": "rem", "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\":\"89c55070-7183-3f26-8481-cffcc9a06591\",\"name\":\"Gomes e Cola\\u00e7o Ltda.\",\"code\":\"411\"},{\"id\":\"ee247d4c-18f2-3673-a5e5-a7aa20343fc2\",\"name\":\"Rios-Furtado\",\"code\":\"863\"}],\"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\":\"35d01543-f0a4-3be6-b022-631a772d413b\",\"name\":\"Arag\\u00e3o e Arruda e Filhos\",\"code\":\"737\"}}", "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": "Nam+ratione+perferendis+sed+sunt+laborum+et.", "description": "Description .", "disabled": false }, { "key": "categories[0]", "value": "molestias", "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": "perferendis", "description": "The uuid of an existing record in the bank_accounts table.", "disabled": false }, { "key": "customers[0]", "value": "ea", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "totam", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "inventore", "description": "The uuid of an existing record in the works table.", "disabled": false }, { "key": "cost_centers[0]", "value": "numquam", "description": "The uuid of an existing record in the cost_centers 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=Nam+ratione+perferendis+sed+sunt+laborum+et.&categories[0]=molestias&date_start=2021-01-01&date_end=2021-01-31&bank_accounts[0]=perferendis&customers[0]=ea&suppliers[0]=totam&works[0]=inventore&cost_centers[0]=numquam" }, "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": "Quaerat+voluptatum+veritatis+qui+molestias+aspernatur+mollitia+molestiae+enim.", "description": "Description .", "disabled": false }, { "key": "categories[0]", "value": "omnis", "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": "aut", "description": "The uuid of an existing record in the bank_accounts table.", "disabled": false }, { "key": "customers[0]", "value": "et", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "ipsa", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "voluptatem", "description": "The uuid of an existing record in the works table.", "disabled": false }, { "key": "cost_centers[0]", "value": "atque", "description": "The uuid of an existing record in the cost_centers 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=Quaerat+voluptatum+veritatis+qui+molestias+aspernatur+mollitia+molestiae+enim.&categories[0]=omnis&date_start=2021-01-01&date_end=2021-01-31&bank_accounts[0]=aut&customers[0]=et&suppliers[0]=ipsa&works[0]=voluptatem&cost_centers[0]=atque" }, "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\":\"ee2d3e59-5b8e-3414-8afd-5bf2a45171f6\",\"code\":\"FC-51892312\",\"type\":\"saque\",\"amount\":-2968.41,\"description\":\"Vero odit ratione ut voluptatem.\",\"transaction_date\":\"2021-02-02T03:00:00.000000Z\",\"transaction_category\":{\"id\":null,\"name\":null,\"type\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"8a20d714-3c99-37af-9d35-cb708248cb5f\",\"code\":\"FC-06421289\",\"type\":\"sa\\u00edda\",\"amount\":-1479.82,\"description\":\"Consequatur voluptates iusto expedita aliquam.\",\"transaction_date\":\"1983-02-15T03: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\":\"9fda7a3d-83d8-3a1f-a81c-6b512ab33643\",\"transaction_category_id\":\"3f1783d2-cb2e-3d6b-9b56-1454ecf7428b\",\"bank_account_id\":\"19bd60a8-6b24-3523-8041-e6929f5ad9c3\",\"customer_id\":\"f649ce8b-0050-3059-af49-38a31b8d508e\",\"supplier_id\":\"5e0b9454-cd5a-32e4-8325-28f34c3c9570\",\"work_id\":\"f365b3cf-260d-3d46-b8a2-253bb55cc885\",\"cost_center_id\":\"127ca393-c3ad-3e01-bffc-46d35d00ad56\",\"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": "3", "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\":\"d0dd9751-7711-3dc0-b0a4-226483ef6758\",\"code\":\"FC-50556747\",\"type\":\"pagamento\",\"amount\":-3344.85,\"description\":\"Nemo aut aut dolorem.\",\"transaction_date\":\"1976-10-12T03: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": "5", "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\":\"9c92e749-88c8-3041-9a28-cd65d04fb13d\",\"transaction_category_id\":\"79245e79-bca5-3ece-a696-62a09a388771\",\"bank_account_id\":\"3edc0755-df89-3670-b92a-48766a3aca09\",\"customer_id\":\"9df8846a-3531-38f5-bbdc-6fbe1fc14f16\",\"supplier_id\":\"7cf37e4d-61f0-37f8-8ae4-f2df9b9c96a6\",\"work_id\":\"5f3ad9c2-2071-37fa-b2ad-57806ce1312c\",\"cost_center_id\":\"7ca085f9-8479-3f19-9d20-903948943aae\",\"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": "14", "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\":\"d9878a6a-f1ff-3229-91fa-01b704734a6a\",\"code\":null,\"opened_by\":null,\"opened_at\":\"2010-07-04T17:37:30.000000Z\",\"closed_by\":null,\"closed_at\":\"1999-03-26T06:09:10.000000Z\",\"opening_balance\":7687.1,\"closing_balance\":7941.58,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Aberto\",\"hasSnapshot\":false,\"created_at\":\"2009-03-03T02:20:11.000000Z\",\"updated_at\":\"1974-05-15T15:40:43.000000Z\"},{\"id\":\"a7b34977-1f7a-38a0-be99-a8c5f2354be5\",\"code\":null,\"opened_by\":null,\"opened_at\":\"2005-05-10T00:11:48.000000Z\",\"closed_by\":null,\"closed_at\":\"1991-01-05T03:26:07.000000Z\",\"opening_balance\":6465.63,\"closing_balance\":5935.37,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Fechado\",\"hasSnapshot\":false,\"created_at\":\"1977-06-16T21:33:08.000000Z\",\"updated_at\":\"1976-06-15T15:46:02.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\":\"16c0beed-a080-3a61-9139-0689a21fa84a\",\"code\":null,\"opened_by\":null,\"opened_at\":\"1987-09-27T09:04:16.000000Z\",\"closed_by\":null,\"closed_at\":\"1981-12-16T03:22:53.000000Z\",\"opening_balance\":8386.96,\"closing_balance\":2526.43,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Aberto\",\"hasSnapshot\":false,\"created_at\":\"2020-12-30T10:24:23.000000Z\",\"updated_at\":\"2014-03-03T10:45:36.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": "f0408cf7-6437-3f22-b20c-c0c14362edde", "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": "Cash session account snapshot", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-sessions\/:uuid\/account-snapshot", "query": [], "raw": "{{baseUrl}}\/api\/cash-sessions\/:uuid\/account-snapshot", "variable": [ { "id": "uuid", "key": "uuid", "value": "4971d795-b828-33da-a7b3-d0461c7a762f", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List the account balance snapshot captured when the cash session was closed" }, "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": "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": "44ffcdf9-f7b7-3649-bf2a-07a4b75ccf70", "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\":\"043aeaf4-bc15-3943-b432-44c3ef263800\",\"code\":null,\"opened_by\":null,\"opened_at\":\"2018-02-05T17:59:00.000000Z\",\"closed_by\":null,\"closed_at\":\"2010-11-02T08:00:55.000000Z\",\"opening_balance\":3699.16,\"closing_balance\":3264.13,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Aberto\",\"hasSnapshot\":false,\"created_at\":\"1995-10-27T14:50:13.000000Z\",\"updated_at\":\"2011-09-18T16:51:43.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": "5c7a831b-672e-339b-9e61-e2cd4d34227e", "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": "Central de Tutoriais", "description": "Consulta dos tutoriais liberados para quem est\u00e1 autenticado", "item": [ { "name": "Setores da central", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tutorials\/sectors", "query": [], "raw": "{{baseUrl}}\/api\/tutorials\/sectors" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Setores da pessoa que tenham ao menos um tutorial vis\u00edvel, com a contagem" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"eeb5a27f-7d34-37e5-9b4d-729c0902c5b6\",\"name\":\"voluptate aperiam\",\"slug\":null,\"abbreviation\":null,\"tutorials_count\":0},{\"id\":\"1d6e85a3-80aa-3145-adfd-5382e40755ff\",\"name\":\"maiores qui\",\"slug\":null,\"abbreviation\":null,\"tutorials_count\":0}]}", "name": "" } ] }, { "name": "M\u00f3dulos da central", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tutorials\/modules", "query": [ { "key": "sector_id[]", "value": "", "description": "", "disabled": true } ], "raw": "{{baseUrl}}\/api\/tutorials\/modules?sector_id[]=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "M\u00f3dulos ativos com tutoriais vis\u00edveis para a pessoa; aceita filtro de setor" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"6eb4e111-a9a5-3857-9dff-59c1f50da98c\",\"name\":\"Unde nihil\",\"slug\":\"unde-nihil-158238\",\"description\":\"Dicta autem sit in velit nihil qui vel asperiores.\",\"icon\":null,\"color\":null,\"sort_order\":0,\"is_active\":true,\"created_at\":null,\"updated_at\":null},{\"id\":\"07446c04-75dc-36c4-8839-edeaa897bca0\",\"name\":\"Saepe est\",\"slug\":\"saepe-est-297535\",\"description\":\"Quia consequatur sequi nisi deleniti eaque perferendis omnis.\",\"icon\":null,\"color\":null,\"sort_order\":0,\"is_active\":true,\"created_at\":null,\"updated_at\":null}]}", "name": "" } ] }, { "name": "Listar tutoriais", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tutorials", "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": "ordem+de+servi%C3%A7o", "description": "Busca por t\u00edtulo ou descri\u00e7\u00e3o.", "disabled": false }, { "key": "module_id[0]", "value": "df0654f9-79cc-3ddb-afe1-d96e0b83af3a", "description": "O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the tutorial_modules table.", "disabled": false }, { "key": "sector_id[]", "value": "", "description": "", "disabled": true } ], "raw": "{{baseUrl}}\/api\/tutorials?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=ordem+de+servi%C3%A7o&module_id[0]=df0654f9-79cc-3ddb-afe1-d96e0b83af3a§or_id[]=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lista paginada dos tutoriais vis\u00edveis, com filtros de m\u00f3dulo, setor e busca por texto" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"143229c2-7b91-38a1-8238-005afe5e624e\",\"title\":\"Unde in quaerat magnam\",\"description\":\"Voluptate similique optio eos provident sit quia.\",\"cover_url\":null,\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a3296004-fb42-4fd2-bc6a-a9ccb83c3de8\",\"name\":\"Quod incidunt\",\"slug\":\"quod-incidunt-684191\",\"icon\":null,\"color\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"727498bb-56a1-33ed-be86-203d90ae04c3\",\"title\":\"Nemo dolorem et voluptatem\",\"description\":\"Nemo voluptates ut et ea.\",\"cover_url\":null,\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a3296004-fd60-47b9-aa03-1f7a77ed1068\",\"name\":\"Cumque repudiandae\",\"slug\":\"cumque-repudiandae-775793\",\"icon\":null,\"color\":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": "Detalhe do tutorial", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tutorials\/:id", "query": [], "raw": "{{baseUrl}}\/api\/tutorials\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the tutorial." }, { "id": "tutorial", "key": "tutorial", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "UUID do tutorial" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Tutorial com os itens em ordem. Fora da visibilidade, responde 404." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"9733414e-32bd-33a0-a9dd-87bc8a244f5c\",\"title\":\"Sit nisi eos omnis\",\"description\":\"Sint dolores impedit quasi.\",\"cover_url\":null,\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a3296005-041c-44bc-86ad-829822016d3f\",\"name\":\"Est recusandae\",\"slug\":\"est-recusandae-566158\",\"icon\":null,\"color\":null},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "URL do item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tutorial-items\/:tutorialItem\/url", "query": [], "raw": "{{baseUrl}}\/api\/tutorial-items\/:tutorialItem\/url", "variable": [ { "id": "tutorialItem", "key": "tutorialItem", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "UUID do item" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Devolve a URL assinada de curta validade para o arquivo no S3, ou o link externo do item. O caminho bruto do S3 nunca \u00e9 exposto." }, "response": [ { "header": [], "code": 200, "body": "{\"type\":\"string\",\"title\":\"string\",\"url\":\"string\",\"expires_in\":\"integer\",\"mime_type\":\"string\",\"size_bytes\":\"integer\"}", "name": "" } ] } ] }, { "name": "Contracts", "description": "Endpoints for managing work contracts", "item": [ { "name": "List contracts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contracts", "query": [], "raw": "{{baseUrl}}\/api\/contracts" }, "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,\"work_id\":\"0a0f9d9c-3d84-3e28-bfd0-c40162116b46\"}" }, "description": "List all work contracts" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"56e93eb7-b29c-34be-9456-74c7736ea58b\",\"number\":\"134\\\/2026\",\"started_at\":\"2026-11-06\",\"deadline_at\":\"2027-11-06\",\"work\":{\"id\":\"a3295ff6-ad2e-4105-894f-704d9cd4179e\",\"name\":\"Dr. Malu Gabriela Deverso\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"da9370f5-5f42-3b35-8914-6ecabf59e32c\",\"number\":\"309\\\/2026\",\"started_at\":\"2026-11-06\",\"deadline_at\":\"2027-11-06\",\"work\":{\"id\":\"a3295ff6-b64f-4df4-aede-426f3ed0b8e5\",\"name\":\"Srta. Mari Vasques Corona Jr.\"},\"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 contract", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contracts", "query": [], "raw": "{{baseUrl}}\/api\/contracts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"work_id\":\"13b97750-7e58-322f-bb46-fceff44b7c66\",\"number\":\"Example Number\",\"started_at\":\"Example Started at\",\"deadline_at\":\"Example Deadline at\"}" }, "description": "Create a new contract for a work" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Show contract", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contracts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/contracts\/:id", "variable": [ { "id": "id", "key": "id", "value": "9", "description": "The ID of the contract." }, { "id": "contract", "key": "contract", "value": "nihil", "description": "Contract UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a work contract" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"ba58d8ed-84fe-3444-b32d-624f678f3d29\",\"number\":\"722\\\/2026\",\"started_at\":\"2026-11-06\",\"deadline_at\":\"2027-11-06\",\"work\":{\"id\":\"a3295ff6-c41f-401c-b992-272fe4eea64a\",\"name\":\"Sr. Luciano Robson Delvalle\"},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Update contract", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contracts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/contracts\/:id", "variable": [ { "id": "id", "key": "id", "value": "18", "description": "The ID of the contract." }, { "id": "contract", "key": "contract", "value": "dolorem", "description": "Contract UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"number\":\"Example Number\",\"started_at\":\"Example Started at\",\"deadline_at\":\"Example Deadline at\"}" }, "description": "Update a work contract" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Delete contract", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contracts\/:contract", "query": [], "raw": "{{baseUrl}}\/api\/contracts\/:contract", "variable": [ { "id": "contract", "key": "contract", "value": "ducimus", "description": "Contract UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a work contract" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Cost Centers", "description": "Endpoints for cost centers", "item": [ { "name": "Suggest next code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cost-centers\/next-code", "query": [ { "key": "parent_id", "value": "ipsam", "description": "UUID do centro de custo pai. Omitido, sugere no primeiro n\u00edvel.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/cost-centers\/next-code?parent_id=ipsam" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"parent_id\":\"molestiae\"}" }, "description": "Pr\u00f3ximo c\u00f3digo livre sob o pai informado. O c\u00f3digo \u00e9 sugest\u00e3o e pode ser alterado antes de salvar." }, "response": [ { "header": [], "code": 200, "body": "{\"code\":\"001.002\"}", "name": "" } ] }, { "name": "Cost center requirement", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cost-centers\/requirement-config", "query": [], "raw": "{{baseUrl}}\/api\/cost-centers\/requirement-config" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Data a partir da qual o centro de custo \u00e9 obrigat\u00f3rio em lan\u00e7amentos novos. A tela usa isso para marcar o campo como obrigat\u00f3rio sem precisar tentar salvar." }, "response": [ { "header": [], "code": 200, "body": "{\"required_from\":\"2026-11-03\",\"required_now\":true}", "name": "" } ] }, { "name": "Update cost center requirement", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cost-centers\/requirement-config", "query": [], "raw": "{{baseUrl}}\/api\/cost-centers\/requirement-config" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"required_from\":\"2026-11-03\"}" }, "description": "Ajusta a data de corte. Enviar nulo desliga a obrigatoriedade." }, "response": [ { "header": [], "code": 200, "body": "{\"required_from\":\"2026-11-03\",\"required_now\":true}", "name": "" } ] }, { "name": "Stock cost center", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cost-centers\/stock-config", "query": [], "raw": "{{baseUrl}}\/api\/cost-centers\/stock-config" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Centro de custo que recebe a compra de material. A conta a pagar gerada por NF-e de produto nasce nele, porque o custo do material chega \u00e0 obra pela movimenta\u00e7\u00e3o de estoque." }, "response": [ { "header": [], "code": 200, "body": "{\"cost_center\":{\"id\":\"uuid\",\"code\":\"003.001\",\"name\":\"Estoque central\"}}", "name": "" } ] }, { "name": "Update stock cost center", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cost-centers\/stock-config", "query": [], "raw": "{{baseUrl}}\/api\/cost-centers\/stock-config" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"cost_center_id\":\"omnis\"}" }, "description": "Aponta a configura\u00e7\u00e3o para outro centro. Nulo desliga: a conta da nota passa a nascer sem centro, para ser classificada na confer\u00eancia." }, "response": [ { "header": [], "code": 200, "body": "{\"cost_center\":{\"id\":\"uuid\",\"code\":\"003.001\",\"name\":\"Estoque central\"}}", "name": "" } ] }, { "name": "List cost centers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cost-centers", "query": [ { "key": "q", "value": "vila", "description": "Busca por parte do nome ou do c\u00f3digo.", "disabled": false }, { "key": "active", "value": "1", "description": "Filtra por situa\u00e7\u00e3o. Omitido, traz ativos e inativos.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/cost-centers?q=vila&active=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lista plana ordenada por c\u00f3digo, sem pagina\u00e7\u00e3o. Cada item traz n\u00edvel e caminho completo, para o cliente montar a \u00e1rvore em mem\u00f3ria." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"0163de52-0f47-39a2-8f0c-cbc10af93972\",\"code\":\"306\",\"name\":\"aut odit\",\"level\":1,\"path\":null,\"is_active\":true,\"selectable\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"cf91e2fe-a8fa-3708-8372-34801b2a0071\",\"code\":\"493\",\"name\":\"itaque sint\",\"level\":1,\"path\":null,\"is_active\":true,\"selectable\":false,\"created_at\":null,\"updated_at\":null}]}", "name": "" } ] }, { "name": "Show cost center", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cost-centers\/:costCenter", "query": [], "raw": "{{baseUrl}}\/api\/cost-centers\/:costCenter", "variable": [ { "id": "costCenter", "key": "costCenter", "value": "sit", "description": "Cost center UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Detalhe de um centro de custo" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"300209f5-0942-3145-84a5-17120f4b3da6\",\"code\":\"370\",\"name\":\"eos molestiae\",\"level\":1,\"path\":null,\"is_active\":true,\"selectable\":false,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create cost center", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cost-centers", "query": [], "raw": "{{baseUrl}}\/api\/cost-centers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"Example Code\",\"name\":\"Example Name\",\"parent_id\":\"6927a136-b3e0-3b9b-914f-69130594bf3a\",\"work_id\":\"3a015543-8199-30ef-bad2-7cf8f0397d76\",\"is_active\":true}" }, "description": "Cadastra um centro de custo" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update cost center", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cost-centers\/:costCenter", "query": [], "raw": "{{baseUrl}}\/api\/cost-centers\/:costCenter", "variable": [ { "id": "costCenter", "key": "costCenter", "value": "tempore", "description": "Cost center UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"Example Code\",\"name\":\"Example Name\",\"parent_id\":\"63013f2a-f14a-34cd-bfaf-b35f0b7fde9f\",\"work_id\":\"90195977-7fef-35cb-973e-170e0c26e38d\",\"is_active\":true}" }, "description": "Atualiza um centro de custo, inclusive a situa\u00e7\u00e3o (inativar e reativar)" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete cost center", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cost-centers\/:costCenter", "query": [], "raw": "{{baseUrl}}\/api\/cost-centers\/:costCenter", "variable": [ { "id": "costCenter", "key": "costCenter", "value": "voluptatem", "description": "Cost center UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Exclui um centro de custo. S\u00f3 \u00e9 permitido quando ele n\u00e3o tem centros abaixo nem lan\u00e7amentos." }, "response": [ { "header": [], "code": 204, "body": null, "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\":\"56938128-bb94-30cc-bb69-c65280ae9830\",\"name\":\"Matias Leon Lutero\",\"email\":\"montenegro.danilo@example.net\",\"phone\":\"(47) 3159-4164\",\"document\":\"431.304.278-48\",\"type\":\"pf\",\"responsible\":\"Srta. Kamila Meireles Ferraz Jr.\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents_count\":0},{\"id\":\"2a07d594-2ada-323c-9b5e-eed382edd578\",\"name\":\"Ellen Cervantes\",\"email\":\"gbranco@example.net\",\"phone\":\"(11) 2507-4761\",\"document\":\"438.680.406-41\",\"type\":\"pf\",\"responsible\":\"N\\u00e1dia Violeta Louren\\u00e7o\",\"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": "4", "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\":\"0b5cbd76-2a8c-3501-b8c0-566fe9b69297\",\"name\":\"Bernardo Edilson Ferreira Neto\",\"email\":\"claudio.benites@example.com\",\"phone\":\"(42) 3386-3004\",\"document\":\"955.120.995-82\",\"type\":\"pj\",\"responsible\":\"Dr. N\\u00e1dia M\\u00f4nica de Freitas Jr.\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents_count\":0}}", "name": "" } ] }, { "name": "Update customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "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": "Daily Logs (RDO)", "description": "Endpoints for managing daily work reports (RDO)", "item": [ { "name": "List daily logs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/daily-logs", "query": [], "raw": "{{baseUrl}}\/api\/daily-logs" }, "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\":\"4b36afdb-aea8-3546-8750-46396cb0d43f\",\"contract_id\":\"7f32d83f-9dc9-3c54-a87e-c413a2d204b5\",\"status_id\":\"a207375b-bf72-3b0f-8cdb-3d8cc627bfcd\",\"filled_by\":\"5b279b15-eafe-3b9e-8ec3-ff68ae947f52\",\"responsible_id\":\"a4da5c32-3367-3059-a8e9-927f3ea3090a\",\"date_from\":\"2024-01-01\",\"date_to\":\"2024-01-01\"}" }, "description": "List all daily work reports (RDO)" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"caf2975c-c06b-36c9-b475-89d63cc0abb7\",\"code\":\"RDO-06-11-26\",\"report_number\":1,\"date\":\"2026-11-06\",\"status\":{\"id\":\"a3295ff7-40db-4a97-a47c-0b67a884be92\",\"slug\":null,\"name\":null,\"abbreviation\":\"voluptates\",\"color\":\"#f6f1a5\",\"text_color\":\"#2b7257\"},\"work\":{\"id\":\"a3295ff7-37e3-4a76-ad0a-56541acdedb2\",\"name\":\"Sr. Marco Amaral Pedrosa\",\"started_at\":\"1981-06-02 21:39:33\"},\"filled_by\":{\"id\":\"a3295ff7-3d63-4beb-ab85-2816c12692cd\",\"name\":\"Saul Watsica\"},\"contract_number\":\"940\\\/2026\",\"deadline_at\":\"2027-11-06\",\"technical_responsible\":{\"name\":null,\"certification\":null,\"crea\":null},\"activities\":[],\"occurrences\":null,\"next_day_forecast\":null,\"finalized_at\":null,\"has_signed_document\":false,\"content_hash\":null,\"gov_br_validation_url\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"519ca545-6c30-3c7c-a116-a335c5aa3400\",\"code\":\"RDO-06-11-26\",\"report_number\":1,\"date\":\"2026-11-06\",\"status\":{\"id\":\"a3295ff7-4b0c-406a-b731-4cf9d7db0a76\",\"slug\":null,\"name\":null,\"abbreviation\":\"nulla\",\"color\":\"#db669d\",\"text_color\":\"#b33a09\"},\"work\":{\"id\":\"a3295ff7-44e8-48e8-9374-7fcef62adacd\",\"name\":\"Ester Perez Sobrinho\",\"started_at\":\"1995-06-05 06:18:07\"},\"filled_by\":{\"id\":\"a3295ff7-4941-4c30-9d6b-57223d7bd9ff\",\"name\":\"Prof. Alphonso Spinka DVM\"},\"contract_number\":\"409\\\/2026\",\"deadline_at\":\"2027-11-06\",\"technical_responsible\":{\"name\":null,\"certification\":null,\"crea\":null},\"activities\":[],\"occurrences\":null,\"next_day_forecast\":null,\"finalized_at\":null,\"has_signed_document\":false,\"content_hash\":null,\"gov_br_validation_url\":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": "Pending RDO days", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/daily-logs\/pending-days", "query": [], "raw": "{{baseUrl}}\/api\/daily-logs\/pending-days" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contract_id\":\"Example Contract id\",\"date_from\":\"2024-01-01\",\"date_to\":\"2024-01-01\"}" }, "description": "List the days in a period that have no RDO for a given work" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[\"2026-07-01\",\"2026-07-02\"]}", "name": "" } ] }, { "name": "Show daily log", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/daily-logs\/:dailyLog", "query": [], "raw": "{{baseUrl}}\/api\/daily-logs\/:dailyLog", "variable": [ { "id": "dailyLog", "key": "dailyLog", "value": "quidem", "description": "Daily Log UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a daily work report (RDO)" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"63f19bd4-1a78-3e33-9ae7-9fb57b17e9dd\",\"code\":\"RDO-06-11-26\",\"report_number\":1,\"date\":\"2026-11-06\",\"status\":{\"id\":\"a3295ff7-6552-4095-8de3-d9988f320e83\",\"slug\":null,\"name\":null,\"abbreviation\":\"voluptatem\",\"color\":\"#23439f\",\"text_color\":\"#c3fa65\"},\"work\":{\"id\":\"a3295ff7-587f-4d9a-abf4-a05bcb05a374\",\"name\":\"Davi Maur\\u00edcio Maldonado Jr.\",\"started_at\":\"2021-07-21 02:58:25\"},\"filled_by\":{\"id\":\"a3295ff7-6363-4bf8-b5f5-8eb3218718d0\",\"name\":\"Prof. Eulalia Gaylord IV\"},\"contract_number\":\"895\\\/2026\",\"deadline_at\":\"2027-11-06\",\"technical_responsible\":{\"name\":null,\"certification\":null,\"crea\":null},\"activities\":[],\"occurrences\":null,\"next_day_forecast\":null,\"finalized_at\":null,\"has_signed_document\":false,\"content_hash\":null,\"gov_br_validation_url\":null,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create daily log", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/daily-logs", "query": [], "raw": "{{baseUrl}}\/api\/daily-logs" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contract_id\":\"Example Contract id\",\"date\":\"2024-01-01\",\"status_id\":\"e81d2732-4b20-3ff9-82bf-9bec25b3ca4c\"}" }, "description": "Open a new daily work report (RDO) for a work" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Update daily log", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/daily-logs\/:dailyLog", "query": [], "raw": "{{baseUrl}}\/api\/daily-logs\/:dailyLog", "variable": [ { "id": "dailyLog", "key": "dailyLog", "value": "hic", "description": "Daily Log UUID" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"activities\":\"Example Activities\",\"occurrences\":\"Example Occurrences\",\"next_day_forecast\":\"Example Next day forecast\",\"weather\":[{\"shift\":\"Example Weather * shift\",\"weather\":\"Example Weather * weather\"},null],\"teams\":[{\"employee_role_id\":\"f5749054-223c-4687-8ef7-2a6e2aa696f3\",\"quantity\":1},null]}" }, "description": "Update a draft RDO: weather, team, activities, occurrences and next-day forecast" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Finalize daily log", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/daily-logs\/:dailyLog\/finalize", "query": [], "raw": "{{baseUrl}}\/api\/daily-logs\/:dailyLog\/finalize", "variable": [ { "id": "dailyLog", "key": "dailyLog", "value": "omnis", "description": "Daily Log UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Validate, stamp and lock a draft RDO (Rascunho \u2192 Finalizado)" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Attach gov.br signed document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/daily-logs\/:dailyLog\/signed-document", "query": [], "raw": "{{baseUrl}}\/api\/daily-logs\/:dailyLog\/signed-document", "variable": [ { "id": "dailyLog", "key": "dailyLog", "value": "temporibus", "description": "Daily Log UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"path\":\"Example Path\",\"name\":\"Example Name\",\"size\":\"Example Size\",\"extension\":\"Example Extension\",\"gov_br_validation_url\":\"https:\\\/\\\/example.com\"}" }, "description": "Attach the gov.br-signed PDF and validation link to a finalized RDO" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Reopen daily log", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/daily-logs\/:dailyLog\/reopen", "query": [], "raw": "{{baseUrl}}\/api\/daily-logs\/:dailyLog\/reopen", "variable": [ { "id": "dailyLog", "key": "dailyLog", "value": "sint", "description": "Daily Log UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Send a finalized RDO back to draft (Finalizado \u2192 Rascunho). Refused when a gov.br-signed document is attached" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Attach photos", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/daily-logs\/:dailyLog\/photos", "query": [], "raw": "{{baseUrl}}\/api\/daily-logs\/:dailyLog\/photos", "variable": [ { "id": "dailyLog", "key": "dailyLog", "value": "quaerat", "description": "Daily Log UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"photos\":[{\"path\":\"Example Photos * path\",\"name\":\"Example Name\",\"size\":\"Example Photos * size\",\"extension\":\"Example Photos * extension\",\"caption\":\"Example Photos * caption\"},null]}" }, "description": "Attach photographs (already uploaded to storage) to a draft RDO" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Update photo caption", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/daily-logs\/:dailyLog\/photos\/:id", "query": [], "raw": "{{baseUrl}}\/api\/daily-logs\/:dailyLog\/photos\/:id", "variable": [ { "id": "dailyLog", "key": "dailyLog", "value": "dicta", "description": "Daily Log UUID" }, { "id": "id", "key": "id", "value": "ex", "description": "The ID of the photo." }, { "id": "photo", "key": "photo", "value": "qui", "description": "Photo (File) UUID" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"caption\":\"Example Caption\"}" }, "description": "Update the caption of a photo in a draft RDO" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] }, { "name": "Delete photo", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/daily-logs\/:dailyLog\/photos\/:photo", "query": [], "raw": "{{baseUrl}}\/api\/daily-logs\/:dailyLog\/photos\/:photo", "variable": [ { "id": "dailyLog", "key": "dailyLog", "value": "deleniti", "description": "Daily Log UUID" }, { "id": "photo", "key": "photo", "value": "itaque", "description": "Photo (File) UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a photo from a draft RDO" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Delete daily log", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/daily-logs\/:dailyLog", "query": [], "raw": "{{baseUrl}}\/api\/daily-logs\/:dailyLog", "variable": [ { "id": "dailyLog", "key": "dailyLog", "value": "vel", "description": "Daily Log UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a draft daily work report (RDO)" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Disciplines", "description": "Endpoints for engineering disciplines", "item": [ { "name": "List disciplines", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/disciplines", "query": [ { "key": "q", "value": "El%C3%A9trico", "description": "Search query.", "disabled": false }, { "key": "active", "value": "1", "description": "Filter by active status.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/disciplines?q=El%C3%A9trico&active=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all disciplines" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"4ba9bafb-631c-359c-9e5f-7fd2d960801b\",\"name\":\"Culpa\",\"code\":\"PJN\",\"description\":\"Optio quas voluptas labore qui in cumque soluta.\",\"active\":true},{\"id\":\"2454f261-dd60-3eda-aba6-dc8e1919d380\",\"name\":\"Id\",\"code\":\"FBP\",\"description\":\"Accusantium ut voluptas qui nihil ipsam.\",\"active\":true}],\"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 discipline", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/disciplines\/:id", "query": [], "raw": "{{baseUrl}}\/api\/disciplines\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the discipline." }, { "id": "discipline", "key": "discipline", "value": "dolorum", "description": "Discipline UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a discipline" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"1179d834-fbcd-39c9-a6f2-f024fa8ffc96\",\"name\":\"Porro\",\"code\":\"BPA\",\"description\":\"Est nulla eaque ea eum assumenda.\",\"active\":true}}", "name": "" } ] }, { "name": "Create discipline", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/disciplines", "query": [], "raw": "{{baseUrl}}\/api\/disciplines" }, "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\":\"Example Description\",\"active\":true}" }, "description": "Create a new discipline" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update discipline", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/disciplines\/:id", "query": [], "raw": "{{baseUrl}}\/api\/disciplines\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the discipline." }, { "id": "discipline", "key": "discipline", "value": "dicta", "description": "Discipline UUID" } ] }, "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\":\"Example Description\",\"active\":true}" }, "description": "Update a discipline" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete discipline", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/disciplines\/:discipline", "query": [], "raw": "{{baseUrl}}\/api\/disciplines\/:discipline", "variable": [ { "id": "discipline", "key": "discipline", "value": "omnis", "description": "Discipline UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a discipline" }, "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\":\"453222a4-ae10-324a-b61a-25b0c7ecb3e6\",\"name\":\"Sr. Fabiano Adriel de Arruda Filho\",\"description\":\"Vel corrupti et nihil voluptas ipsum. Sit itaque excepturi ut aut consectetur quibusdam. Quia id ut est vel voluptatibus rerum et. Velit id autem consequatur perspiciatis id.\",\"module\":\"document\"},{\"id\":\"bbe7e4b7-98e2-373f-bcaf-02a69989f5da\",\"name\":\"Emanuelly Michelle Assun\\u00e7\\u00e3o\",\"description\":\"Ut quasi nam culpa voluptatem eos dolores repellendus. Minus odio nulla qui error. Voluptas repudiandae voluptas rerum laborum pariatur perspiciatis ad iure. Est est veniam esse culpa qui aut ut.\",\"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": "enim", "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\":\"8be74317-6cd5-3e37-a793-ea74f327b424\",\"name\":\"Dr. Diana Cervantes Jr.\",\"description\":\"Ad et est ut fuga voluptatem libero delectus. Et sit repudiandae ab nihil quidem quia quis. Dicta at neque quis aut aut odit ea.\",\"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": "commodi", "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": "modi", "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": "sed", "description": "The uuid of an existing record in the document_categories table.", "disabled": false }, { "key": "documentable_type", "value": "culpa", "description": "Type of the related documentable entity. The type of an existing record in the documentables table.", "disabled": false }, { "key": "customers[0]", "value": "aut", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "ratione", "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]=sed&documentable_type=culpa&customers[0]=aut&suppliers[0]=ratione" }, "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\":\"2cf68f69-bbbf-3672-91ab-03f52059e83a\",\"name\":\"Teobaldo Isaac Campos Neto\",\"file\":{\"id\":null,\"url\":null,\"extension\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"33987e3b-9f65-3525-ab74-03e584a4408b\",\"name\":\"Eric das Dores Valente\",\"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": "10", "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\":\"d5e39173-6f56-3a1a-887f-649d7dfe92e1\",\"name\":\"Cristian Emiliano Rico\",\"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\":\"395f8e06-1b17-39be-a66e-24de5efb7075\",\"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": "6", "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\":\"4e088904-8d7d-3505-96ef-8f50df227850\",\"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": "EPI Renewals", "description": "Endpoints for EPI pending renewals", "item": [ { "name": "List EPI renewals", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-renewals", "query": [], "raw": "{{baseUrl}}\/api\/epi-renewals" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"q\":\"eos\",\"renewal_status\":\"pending\",\"urgency\":\"expires_30_days\",\"employee_id\":\"non\",\"epi_type_id\":\"possimus\"}" }, "description": "List pending\/ignored (default) or completed EPI renewals. Ignored items remain in the default listing with renewal_status=ignored" }, "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": "EPI renewals summary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-renewals\/summary", "query": [], "raw": "{{baseUrl}}\/api\/epi-renewals\/summary" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Counts of renewals by urgency (pending and ignored; ignore only silences 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": "Renew EPI delivery", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-renewals\/:id\/renew", "query": [], "raw": "{{baseUrl}}\/api\/epi-renewals\/:id\/renew", "variable": [ { "id": "id", "key": "id", "value": "minus", "description": "EPI delivery UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"quantity\":1,\"condition\":\"new\",\"confirm_insufficient_stock\":false}" }, "description": "Renew an EPI delivery with a new delivery date" }, "response": [] }, { "name": "Ignore EPI renewal", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-renewals\/:id\/ignore", "query": [], "raw": "{{baseUrl}}\/api\/epi-renewals\/:id\/ignore", "variable": [ { "id": "id", "key": "id", "value": "alias", "description": "EPI delivery UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ignore_reason\":\"Colaborador afastado temporariamente\"}" }, "description": "Ignore expiry alerts for an EPI delivery" }, "response": [] }, { "name": "Unignore EPI renewal", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-renewals\/:id\/ignore", "query": [], "raw": "{{baseUrl}}\/api\/epi-renewals\/:id\/ignore", "variable": [ { "id": "id", "key": "id", "value": "officia", "description": "EPI delivery UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Resume expiry alerts for an EPI delivery" }, "response": [ { "header": [], "code": 200, "body": null, "name": "" } ] } ] }, { "name": "EPI Types", "description": "Endpoints for EPI types catalog", "item": [ { "name": "List EPI types", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-types", "query": [], "raw": "{{baseUrl}}\/api\/epi-types" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"q\":\"error\",\"stock_id\":\"architecto\"}" }, "description": "List all EPI types" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"7e7963f3-7ce3-3cc0-9c73-2b07098ea5b6\",\"name\":\"aliquid et\",\"default_validity_days\":557,\"requires_signature\":false,\"numero_ca\":\"38017\",\"product\":null,\"available_quantity\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"5e98ff64-8fbd-37ff-b23c-3d1bfe7f46f2\",\"name\":\"qui sit\",\"default_validity_days\":68,\"requires_signature\":false,\"numero_ca\":\"15674\",\"product\":null,\"available_quantity\":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": "List catalog products that could become EPI", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-types\/candidates", "query": [], "raw": "{{baseUrl}}\/api\/epi-types\/candidates" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"q\":\"maiores\",\"stock_id\":\"et\"}" }, "description": "Products sitting in a family flagged as EPI that do not have EPI attributes yet. Being here does not make a product an EPI: it becomes one when someone gives it a validity, through the create endpoint with action link_existing." }, "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": "Show EPI type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-types\/:epiType", "query": [], "raw": "{{baseUrl}}\/api\/epi-types\/:epiType", "variable": [ { "id": "epiType", "key": "epiType", "value": "quam", "description": "EPI type UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show an EPI type" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"29256266-2dd2-370d-9fda-9c08c4f7df3a\",\"name\":\"autem id\",\"default_validity_days\":216,\"requires_signature\":false,\"numero_ca\":\"40150\",\"product\":null,\"available_quantity\":null,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create EPI type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-types", "query": [], "raw": "{{baseUrl}}\/api\/epi-types" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"default_validity_days\":1,\"requires_signature\":true,\"numero_ca\":\"Example Numero ca\",\"action\":\"Example Action\",\"product_id\":\"0d3ccbfd-4635-35e7-a9e5-921e9e2d84c5\",\"product_family_id\":\"b24c5c56-ae3e-37ec-83f9-fc95ccc971be\"}" }, "description": "Create a new EPI type" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Link EPI types to catalog products in bulk", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-types\/link-products", "query": [], "raw": "{{baseUrl}}\/api\/epi-types\/link-products" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"epi_type_id\":\"eb254c05-38a6-3eb4-a3bb-16fe124faa80\",\"action\":\"Example Items * action\",\"product_id\":\"bb5ef129-349c-33a8-b041-a4f52cd2d877\",\"product_family_id\":\"d6d493c3-012f-30cd-b8ae-2a226a4b82e9\"},null]}" }, "description": "Link several EPI types to catalog products at once, creating the product where it does not exist yet. All or nothing: one refusal rolls back the whole batch." }, "response": [] }, { "name": "Link an EPI type to a catalog product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-types\/:epiType\/product", "query": [], "raw": "{{baseUrl}}\/api\/epi-types\/:epiType\/product", "variable": [ { "id": "epiType", "key": "epiType", "value": "cumque", "description": "EPI type UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"action\":\"Example Action\",\"product_id\":\"f40c2139-5d53-3dc8-a6c6-c3864b26d7f7\",\"product_family_id\":\"c15f1dcc-0942-34f7-9377-678a3eda0964\"}" }, "description": "Link one EPI type to an existing product, or create the product from the EPI type name." }, "response": [] }, { "name": "Update EPI type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-types\/:epiType", "query": [], "raw": "{{baseUrl}}\/api\/epi-types\/:epiType", "variable": [ { "id": "epiType", "key": "epiType", "value": "quia", "description": "EPI type UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"default_validity_days\":1,\"requires_signature\":true,\"numero_ca\":\"Example Numero ca\"}" }, "description": "Update an EPI type" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete EPI type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-types\/:epiType", "query": [], "raw": "{{baseUrl}}\/api\/epi-types\/:epiType", "variable": [ { "id": "epiType", "key": "epiType", "value": "laudantium", "description": "EPI type UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an EPI type" }, "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\":\"55b35ae7-5ea3-424f-8b9d-49f0f9d3b6b9\",\"name\":\"delectus\",\"description\":\"Qui autem aut nihil itaque laboriosam nulla autem.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"b09d0096-b763-4495-8455-49707456a18e\",\"name\":\"autem\",\"description\":null,\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Show employee role", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employee-roles\/:employeeRole", "query": [], "raw": "{{baseUrl}}\/api\/employee-roles\/:employeeRole", "variable": [ { "id": "employeeRole", "key": "employeeRole", "value": "odit", "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\":\"f964e01a-5e4a-46bf-9009-6b120f437473\",\"name\":\"dicta\",\"description\":null,\"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": "molestias", "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": "sapiente", "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 EPI terms", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-terms", "query": [], "raw": "{{baseUrl}}\/api\/epi-terms" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"sort_by\":\"delivery_date\",\"sort_desc\":false,\"page\":87,\"per_page\":10,\"q\":\"minima\",\"employee_id\":\"sapiente\",\"has_term\":false}" }, "description": "List initial EPI kit terms globally" }, "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": "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 }, { "key": "status", "value": "active", "description": "Filtrar por situa\u00e7\u00e3o (active, inactive ou all). Sem o par\u00e2metro, lista apenas ativos.", "disabled": false }, { "key": "employee_roles[0]", "value": "consequatur", "description": "The uuid of an existing record in the employee_roles table.", "disabled": false }, { "key": "admission_date_from", "value": "2026-01-01", "description": "Data inicial do per\u00edodo de admiss\u00e3o. O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "admission_date_to", "value": "2026-12-31", "description": "Data final do per\u00edodo de admiss\u00e3o. O campo value deve ser uma data v\u00e1lida. O campo value deve ser uma data posterior ou igual a admission_date_from.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/employees?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Jo%C3%A3o+Silva&status=active&employee_roles[0]=consequatur&admission_date_from=2026-01-01&admission_date_to=2026-12-31" }, "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\":\"e21a79c3-bf03-4228-b522-ff9595b58f85\",\"name\":\"M\\u00e1ximo Ortiz Jr.\",\"cpf\":\"323.792.263-85\",\"rg\":null,\"ctps\":null,\"phone\":\"(43) 97072-0925\",\"birthdate\":\"1989-08-26\",\"email\":null,\"pis_pasep\":null,\"admission_date\":\"2004-10-24\",\"daily_salary\":\"152.41\",\"monthly_salary\":null,\"nationality\":\"Tun\\u00edsia\",\"place_of_birth\":null,\"status\":\"active\",\"status_label\":\"Ativo\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":\"a3295ff7-feb3-4c24-b22e-f7ed89e473c8\",\"name\":\"qui\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"b47b4cb8-0da5-4134-9a89-d9a6a9788c83\",\"name\":\"Juan Carrara Filho\",\"cpf\":\"845.842.034-42\",\"rg\":null,\"ctps\":null,\"phone\":\"(11) 2774-6180\",\"birthdate\":null,\"email\":\"carla56@example.com\",\"pis_pasep\":\"07798237010\",\"admission_date\":\"1988-11-11\",\"daily_salary\":null,\"monthly_salary\":\"5667.82\",\"nationality\":null,\"place_of_birth\":null,\"status\":\"active\",\"status_label\":\"Ativo\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":\"a3295ff8-01d0-44b0-ac80-e0f78ca87224\",\"name\":\"nesciunt\"},\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":\"\\\/?page=86\",\"next\":null},\"meta\":{\"current_page\":87,\"from\":861,\"last_page\":1,\"links\":[{\"url\":\"\\\/?page=86\",\"label\":\"« Anterior\",\"page\":86,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":false},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":862,\"total\":2}}", "name": "" } ] }, { "name": "Export employees to Excel", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/excel", "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 }, { "key": "status", "value": "active", "description": "Filtrar por situa\u00e7\u00e3o (active, inactive ou all). Sem o par\u00e2metro, lista apenas ativos.", "disabled": false }, { "key": "employee_roles[0]", "value": "voluptas", "description": "The uuid of an existing record in the employee_roles table.", "disabled": false }, { "key": "admission_date_from", "value": "2026-01-01", "description": "Data inicial do per\u00edodo de admiss\u00e3o. O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "admission_date_to", "value": "2026-12-31", "description": "Data final do per\u00edodo de admiss\u00e3o. O campo value deve ser uma data v\u00e1lida. O campo value deve ser uma data posterior ou igual a admission_date_from.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/employees\/excel?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Jo%C3%A3o+Silva&status=active&employee_roles[0]=voluptas&admission_date_from=2026-01-01&admission_date_to=2026-12-31" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Dispatches async Excel generation using the same filters as the listing. Frontend is notified via Pusher when ready." }, "response": [ { "header": [], "code": 202, "body": "{\"message\":\"string\",\"channel\":\"string\",\"event\":\"string\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Show employee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:id", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:id", "variable": [ { "id": "id", "key": "id", "value": "18", "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\":\"b475adef-1c10-4aa9-965c-cc68831af602\",\"name\":\"Dr. Agostinho Luciano Camacho\",\"cpf\":\"844.851.508-94\",\"rg\":\"940160858\",\"ctps\":null,\"phone\":\"(54) 98684-4339\",\"birthdate\":null,\"email\":\"carolina82@example.com\",\"pis_pasep\":null,\"admission_date\":\"2010-06-01\",\"daily_salary\":null,\"monthly_salary\":\"7985.23\",\"nationality\":\"Cro\\u00e1cia\",\"place_of_birth\":null,\"status\":\"active\",\"status_label\":\"Ativo\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":\"a3295ff8-0e1d-4134-b385-9f634ee9dfe1\",\"name\":\"quod\"},\"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\":\"3896eb9c-79be-4f17-ae20-4c54b577c330\",\"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": "{\"data\":{\"id\":\"363e5e81-4685-4f01-a8f9-74b81f974e64\",\"name\":\"Sr. Luan Gil Filho\",\"cpf\":\"015.802.953-21\",\"rg\":null,\"ctps\":null,\"phone\":\"(18) 99417-4973\",\"birthdate\":\"2000-06-30\",\"email\":\"lorenzo.pontes@example.com\",\"pis_pasep\":null,\"admission_date\":\"1993-05-04\",\"daily_salary\":\"143.83\",\"monthly_salary\":\"7348.58\",\"nationality\":null,\"place_of_birth\":null,\"status\":\"active\",\"status_label\":\"Ativo\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":\"a3295ff8-175c-43b8-be07-550134046fac\",\"name\":\"aut\"},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Update employee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:id", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:id", "variable": [ { "id": "id", "key": "id", "value": "10", "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\":\"f745f207-c0a7-4ecb-9bd1-225a0aa67b6a\",\"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": "Dismiss employee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee\/dismiss", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee\/dismiss", "variable": [ { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee ID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"dismissal_date\":\"2026-11-06\",\"dismissal_reason\":\"resignation\"}" }, "description": "Register the dismissal of an active employee" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"618431ab-b306-4d3e-85b5-a3dff0a0502f\",\"name\":\"Michelle Clarice Gon\\u00e7alves\",\"cpf\":\"155.696.868-14\",\"rg\":\"339206686\",\"ctps\":null,\"phone\":\"(28) 4526-4708\",\"birthdate\":\"1984-03-18\",\"email\":\"daniel57@example.org\",\"pis_pasep\":\"64556637148\",\"admission_date\":\"1998-11-01\",\"daily_salary\":null,\"monthly_salary\":\"5480.19\",\"nationality\":null,\"place_of_birth\":null,\"status\":\"active\",\"status_label\":\"Ativo\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":\"a3295ff8-2610-4224-8c68-97cae160c8e5\",\"name\":\"ut\"},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Rehire employee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee\/rehire", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee\/rehire", "variable": [ { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee ID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"admission_date\":\"2026-11-06\"}" }, "description": "Rehire an inactive employee with a new admission date" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"d5e26f3f-def7-4dfb-abec-d36b8ded8f77\",\"name\":\"Eric Azevedo Aguiar\",\"cpf\":\"114.998.391-10\",\"rg\":\"009453181\",\"ctps\":null,\"phone\":\"(83) 2696-0084\",\"birthdate\":\"2026-03-14\",\"email\":null,\"pis_pasep\":\"54134947525\",\"admission_date\":\"2016-06-30\",\"daily_salary\":\"65.29\",\"monthly_salary\":null,\"nationality\":\"Cro\\u00e1cia\",\"place_of_birth\":null,\"status\":\"active\",\"status_label\":\"Ativo\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":\"a3295ff8-2c61-465c-aa75-406d184cbb78\",\"name\":\"perspiciatis\"},\"created_at\":null,\"updated_at\":null}}", "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": "1", "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": "16", "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\":\"rem\",\"agency\":\"gubo\",\"account\":\"q\",\"account_type\":\"corrente\",\"pix_key\":\"mfluyriurccjzdwja\",\"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": "17", "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\":\"enim\",\"agency\":\"zodllleexsrlr\",\"account\":\"rvfwto\",\"account_type\":\"poupan\u00e7a\",\"pix_key\":\"fzhdpaqfivbsnjqpvke\",\"favorite\":true}" }, "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": "List employee EPI deliveries", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee_id\/epi-deliveries", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee_id\/epi-deliveries", "variable": [ { "id": "employee_id", "key": "employee_id", "value": "5", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "facere", "description": "Employee UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"q\":\"temporibus\",\"status\":\"expiring\",\"epi_type_id\":\"id\"}" }, "description": "List EPI deliveries 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": "Pending EPI renewals count", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee\/epi-deliveries\/pending-renewals-count", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee\/epi-deliveries\/pending-renewals-count", "variable": [ { "id": "employee", "key": "employee", "value": "omnis", "description": "Employee UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Count of pending EPI renewals 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": "Show employee EPI delivery", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee_id\/epi-deliveries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee_id\/epi-deliveries\/:id", "variable": [ { "id": "employee_id", "key": "employee_id", "value": "11", "description": "The ID of the employee." }, { "id": "id", "key": "id", "value": "voluptas", "description": "EPI delivery UUID" }, { "id": "employee", "key": "employee", "value": "odit", "description": "Employee UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show an EPI delivery 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 EPI delivery", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee_id\/epi-deliveries", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee_id\/epi-deliveries", "variable": [ { "id": "employee_id", "key": "employee_id", "value": "8", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "in", "description": "Employee UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"epi_type_id\":\"2567b47a-8f67-314e-92d7-60df8ca8f4b2\",\"delivery_date\":\"2024-01-01\",\"quantity\":1,\"condition\":\"Example Condition\",\"delivered_by_employee_id\":\"5a5c14cd-1d6e-47f7-b978-727bab24bbee\",\"stock_id\":\"3230b8ca-5c1f-3720-bd49-2f8b5280194a\",\"confirm_insufficient_stock\":true}" }, "description": "Register an EPI delivery for an employee" }, "response": [ { "header": [], "code": 201, "body": null, "name": "" } ] }, { "name": "Create employee initial EPI kit", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee\/epi-deliveries\/kit", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee\/epi-deliveries\/kit", "variable": [ { "id": "employee", "key": "employee", "value": "natus", "description": "Employee UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"delivery_date\":\"2024-01-01\",\"is_kit_initial\":true,\"show_epi_receipt_text\":true,\"delivered_by_employee_id\":\"bbd4ca6b-5f8c-4a9c-b6ad-5e70a502a083\",\"stock_id\":\"6927c6a7-b95c-3d9e-a9d7-fedfcb34ebba\",\"confirm_insufficient_stock\":true,\"items\":[{\"epi_type_id\":\"074e7ae6-78c7-31d1-92b7-ddc2c57c6e27\",\"quantity\":1,\"condition\":\"Example Items * condition\"},null]}" }, "description": "Register multiple EPI deliveries as initial kit" }, "response": [ { "header": [], "code": 201, "body": null, "name": "" } ] }, { "name": "Promote EPI delivery to kit", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee\/epi-deliveries\/:id\/promote-to-kit", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee\/epi-deliveries\/:id\/promote-to-kit", "variable": [ { "id": "employee", "key": "employee", "value": "est", "description": "Employee UUID" }, { "id": "id", "key": "id", "value": "eligendi", "description": "EPI delivery UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Turn a standalone EPI delivery into a single-item kit so it can generate the acknowledgement term. Idempotent: a delivery already belonging to a kit is returned unchanged." }, "response": [] }, { "name": "Update employee EPI delivery", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee_id\/epi-deliveries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee_id\/epi-deliveries\/:id", "variable": [ { "id": "employee_id", "key": "employee_id", "value": "16", "description": "The ID of the employee." }, { "id": "id", "key": "id", "value": "et", "description": "EPI delivery UUID" }, { "id": "employee", "key": "employee", "value": "modi", "description": "Employee UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"epi_type_id\":\"7264860a-5116-3d7f-990d-72fa807cb1cf\",\"delivery_date\":\"2024-01-01\",\"quantity\":1,\"condition\":\"Example Condition\",\"delivered_by_employee_id\":\"fa3d581b-c38d-47d5-9e27-02d7f59fe248\",\"stock_id\":\"1e7794cf-08ba-3212-a466-b49cbbf23070\",\"confirm_insufficient_stock\":true}" }, "description": "Update an EPI delivery for an employee" }, "response": [] }, { "name": "Delete employee EPI delivery", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee\/epi-deliveries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee\/epi-deliveries\/:id", "variable": [ { "id": "employee", "key": "employee", "value": "aut", "description": "Employee UUID" }, { "id": "id", "key": "id", "value": "quia", "description": "EPI delivery UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an EPI delivery from an employee" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "List employee EPI terms", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee_id\/epi-terms", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee_id\/epi-terms", "variable": [ { "id": "employee_id", "key": "employee_id", "value": "13", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "voluptas", "description": "Employee UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"sort_by\":\"created_at\",\"sort_desc\":false,\"page\":47,\"per_page\":7,\"q\":\"eaque\",\"employee_id\":\"illum\",\"has_term\":true}" }, "description": "List initial EPI kit terms 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": "Upload signed EPI term", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee\/epi-terms\/:kitUuid\/upload", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee\/epi-terms\/:kitUuid\/upload", "variable": [ { "id": "employee", "key": "employee", "value": "quaerat", "description": "Employee UUID" }, { "id": "kitUuid", "key": "kitUuid", "value": "41209750-fb34-38d0-8ece-4b29de60703c", "description": "Kit UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"file\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example File path\",\"name\":\"Example Name\",\"extension\":\"Example File extension\",\"size\":\"Example File size\",\"mime_type\":\"Example File mime type\"}}" }, "description": "Upload signed Termo de Ci\u00eancia for an initial kit" }, "response": [ { "header": [], "code": 201, "body": null, "name": "" } ] }, { "name": "Download signed EPI term", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee\/epi-terms\/:kitUuid\/document", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee\/epi-terms\/:kitUuid\/document", "variable": [ { "id": "employee", "key": "employee", "value": "impedit", "description": "Employee UUID" }, { "id": "kitUuid", "key": "kitUuid", "value": "a0d570d8-84b4-38e0-9354-cddd77b3ed29", "description": "Kit UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get temporary download URL for signed term" }, "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": "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": "f29366c9-3745-3467-8f0d-b7a14da90660", "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": "dab52a22-5b65-30c4-841a-88106cf1014e", "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": "205dd305-fbeb-3a6d-b852-95533632d867", "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\":\"corporis\",\"document_type\":\"nfe\",\"supplier_id\":\"exercitationem\",\"work_id\":\"iusto\",\"products_status\":\"imported\",\"financial_status\":\"partial\",\"start_date\":\"2026-11-06T13:03:12\",\"end_date\":\"2093-01-12\",\"per_page\":2,\"cost_centers\":[\"magni\"]}" }, "description": "Lista notas fiscais com filtros por busca, fornecedor, obra e per\u00edodo." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"9b9666ba-0f64-3aa1-acfa-dac6c1ceabae\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"57346366959219299865659780501736487438170114\",\"nfe_number\":\"505213\",\"nfe_series\":\"44\",\"issue_date\":\"1974-01-02T03:00:00.000000Z\",\"total_value\":\"7560.09\",\"emit\":{\"cnpj\":\"09659616498440\",\"name\":\"Gibson, Kozey and Runolfsdottir\"},\"dest\":{\"document\":\"42710274160507\",\"name\":\"Hyatt-Senger\"},\"supplier\":{\"id\":\"a3295ffa-4140-4049-bd34-ec714575ac5c\",\"name\":\"Dr. Luis Nero Bonilha Neto\",\"document\":\"62.226.435\\\/0001-06\"},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null},{\"id\":\"de525b46-7eee-3164-85b2-fd0f74dff1e5\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"91672342579726519026148026762199222333768146\",\"nfe_number\":\"828122\",\"nfe_series\":\"40\",\"issue_date\":\"1981-07-23T03:00:00.000000Z\",\"total_value\":\"1748.78\",\"emit\":{\"cnpj\":\"25605107232023\",\"name\":\"Renner Ltd\"},\"dest\":{\"document\":\"47865344272827\",\"name\":\"Hermann Ltd\"},\"supplier\":{\"id\":\"a3295ffa-4b22-48c3-a5c9-70fd75e395df\",\"name\":\"Willian Brito Queir\\u00f3s Sobrinho\",\"document\":\"89.547.100\\\/0001-46\"},\"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\":\"qui\",\"original_filename\":\".xml$\\\/i\",\"work_ids\":[\"consequatur\"]}" }, "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\":\"d8a61ba3-bfed-308b-b8c7-6364ff79e34a\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"72118191611829069103468322121241950635230136\",\"nfe_number\":\"363397\",\"nfe_series\":\"76\",\"issue_date\":\"2013-10-08T03:00:00.000000Z\",\"total_value\":\"479.20\",\"emit\":{\"cnpj\":\"58768067191855\",\"name\":\"Langosh-Lakin\"},\"dest\":{\"document\":\"46418936201386\",\"name\":\"O'Keefe PLC\"},\"supplier\":{\"id\":\"a3295ffa-5e5c-4f5e-aa05-4edec85c8dc5\",\"name\":\"Srta. Josefina Corona Lira\",\"document\":\"30.520.863\\\/0001-50\"},\"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": "maiores", "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\":\"5f296db5-1214-31e8-b063-aa477968c966\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"63573033282060467482259308540818556475134602\",\"nfe_number\":\"894742\",\"nfe_series\":\"63\",\"issue_date\":\"1991-02-18T03:00:00.000000Z\",\"total_value\":\"7485.56\",\"emit\":{\"cnpj\":\"14336184247539\",\"name\":\"Sipes Inc\"},\"dest\":{\"document\":\"55665382584516\",\"name\":\"Feest LLC\"},\"supplier\":{\"id\":\"a3295ffa-717c-49e6-a0a3-ce753b486b36\",\"name\":\"Dr. Thales Quintana\",\"document\":\"57.763.545\\\/0001-77\"},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null}}", "name": "" } ] }, { "name": "Fiscal document by cost center", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/fiscal-documents\/:fiscalDocument\/cost-centers", "query": [], "raw": "{{baseUrl}}\/api\/fiscal-documents\/:fiscalDocument\/cost-centers", "variable": [ { "id": "fiscalDocument", "key": "fiscalDocument", "value": "ipsum", "description": "UUID da nota fiscal" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Distribui a nota por centro de custo. NF-e de produto sai do estoque: o que a vincula\u00e7\u00e3o dos itens lan\u00e7ou em cada estoque de obra (quantidade \u00d7 pre\u00e7o do lote, o mesmo c\u00e1lculo do custo apropriado do painel), o que foi para o estoque principal e o que ainda n\u00e3o foi integrado. NFS-e sai das parcelas, pelo centro da conta gerada. As linhas somam o total da nota; a diferen\u00e7a vai para other_values, que pode ser negativo quando h\u00e1 desconto. Linhas zeradas s\u00e3o omitidas." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"total\":\"5074.19\",\"source\":\"stock\",\"rows\":[{\"kind\":\"cost_center\",\"cost_center\":{\"id\":\"uuid\",\"code\":\"002.001\",\"name\":\"Residencial Vila Nova\"},\"amount\":\"2100.00\",\"share\":41.39},{\"kind\":\"work_without_cost_center\",\"work\":{\"id\":\"uuid\",\"name\":\"Reforma Centro\"},\"amount\":\"474.19\",\"share\":9.35},{\"kind\":\"main_stock\",\"cost_center\":{\"id\":\"uuid\",\"code\":\"003.001\",\"name\":\"Estoque central\"},\"amount\":\"1500.00\",\"share\":29.56},{\"kind\":\"not_integrated\",\"amount\":\"900.00\",\"share\":17.74},{\"kind\":\"other_values\",\"amount\":\"100.00\",\"share\":1.97}]}}", "name": "" } ] }, { "name": "Delete fiscal document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/fiscal-documents\/:fiscalDocument", "query": [], "raw": "{{baseUrl}}\/api\/fiscal-documents\/:fiscalDocument", "variable": [ { "id": "fiscalDocument", "key": "fiscalDocument", "value": "minus", "description": "UUID da nota fiscal" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Exclui definitivamente uma nota fiscal. N\u00e3o permitido quando a nota j\u00e1 gerou parcelas no financeiro ou j\u00e1 teve produtos importados." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Nota fiscal exclu\u00edda." } ] }, { "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": "et", "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\":\"quae\",\"name\":\"ullam\",\"extension\":\"aut\"}}" }, "description": "Anexa um arquivo (ex.: PDF da NF) j\u00e1 enviado ao S3 \u00e0 nota fiscal." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"a87d6787-68ff-3219-96d0-e2b050145926\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"99921916690155451162886394139840105648881274\",\"nfe_number\":\"416382\",\"nfe_series\":\"03\",\"issue_date\":\"1976-07-06T03:00:00.000000Z\",\"total_value\":\"8684.42\",\"emit\":{\"cnpj\":\"55302163574486\",\"name\":\"Robel, Donnelly and Ebert\"},\"dest\":{\"document\":\"36416039269769\",\"name\":\"Torp Group\"},\"supplier\":{\"id\":\"a3295ffa-9513-4fd5-b4f8-5b23646b73cb\",\"name\":\"Dr. Marcos Renato Carmona\",\"document\":\"11.320.016\\\/0001-06\"},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null}}", "name": "" } ] }, { "name": "Detach file", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/fiscal-documents\/:fiscalDocument\/files\/:file", "query": [], "raw": "{{baseUrl}}\/api\/fiscal-documents\/:fiscalDocument\/files\/:file", "variable": [ { "id": "fiscalDocument", "key": "fiscalDocument", "value": "consequatur", "description": "UUID da nota fiscal" }, { "id": "file", "key": "file", "value": "magnam", "description": "UUID do arquivo anexado" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove definitivamente um anexo da nota fiscal, inclusive o objeto no S3. O XML original da NFe n\u00e3o pode ser removido." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"efcd0d99-970e-3efa-a289-23b111c6e402\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"96602636946465048270208530062591312471050083\",\"nfe_number\":\"355005\",\"nfe_series\":\"41\",\"issue_date\":\"1971-08-14T03:00:00.000000Z\",\"total_value\":\"9924.08\",\"emit\":{\"cnpj\":\"17013285603447\",\"name\":\"Rutherford LLC\"},\"dest\":{\"document\":\"58823113202138\",\"name\":\"Kertzmann, Johnson and Vandervort\"},\"supplier\":{\"id\":\"a3295ffa-a5fb-464e-949d-7f54226cbc2f\",\"name\":\"Dr. Gustavo Carvalho Jr.\",\"document\":\"63.657.673\\\/0001-39\"},\"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": "et", "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\":[\"at\"]}" }, "description": "Sincroniza o v\u00ednculo documental da nota fiscal com N obras." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"df0710cd-2bdd-3b87-8090-bf05f7c5a32b\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"36492282433658096388601148392212878120732250\",\"nfe_number\":\"779225\",\"nfe_series\":\"24\",\"issue_date\":\"2008-11-05T02:00:00.000000Z\",\"total_value\":\"1022.69\",\"emit\":{\"cnpj\":\"67440952846444\",\"name\":\"Gerlach Ltd\"},\"dest\":{\"document\":\"85041902037964\",\"name\":\"Sporer, Murray and Gutkowski\"},\"supplier\":{\"id\":\"a3295ffa-b8bc-4d3b-9ca1-6220c4920539\",\"name\":\"Sr. Giovane Maicon Cervantes Neto\",\"document\":\"10.605.945\\\/0001-90\"},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null}}", "name": "" } ] }, { "name": "Create installment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/fiscal-documents\/:fiscalDocument\/installments", "query": [], "raw": "{{baseUrl}}\/api\/fiscal-documents\/:fiscalDocument\/installments", "variable": [ { "id": "fiscalDocument", "key": "fiscalDocument", "value": "corrupti", "description": "UUID da nota fiscal" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"due_date\":\"2024-01-01\",\"amount\":1,\"number\":\"Example Number\"}" }, "description": "Lan\u00e7a uma cobran\u00e7a avulsa na nota fiscal, para o boleto que o fornecedor cobra al\u00e9m das duplicatas do XML. Nasce pendente e sem conta no financeiro; a gera\u00e7\u00e3o continua sendo pelo import-nfe." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"84abad8e-0def-3651-ab01-db4521d91381\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"50095668849183015167179041654037945482319862\",\"nfe_number\":\"763901\",\"nfe_series\":\"76\",\"issue_date\":\"2004-01-27T02:00:00.000000Z\",\"total_value\":\"3609.42\",\"emit\":{\"cnpj\":\"43600608156911\",\"name\":\"Hermann, O'Connell and Swift\"},\"dest\":{\"document\":\"84717747139869\",\"name\":\"Lindgren, Senger and Halvorson\"},\"supplier\":{\"id\":\"a3295ffa-cae2-4a26-8070-1ebd6895b107\",\"name\":\"Yasmin Marques Neto\",\"document\":\"63.506.978\\\/0001-40\"},\"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\":\"46883037-937c-3d34-a70c-10ac409054ef\"}" }, "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": "autem", "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 \"auto_linked_count\": 4,\n \"stock_launched_count\": 7,\n \"pending_stock_launch_count\": 3,\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 \"fiscal_document\": {\n \"id\": \"fiscal-document-uuid\",\n \"nfe_number\": \"123456\",\n \"works\": [\n {\"id\": \"work-uuid\", \"name\": \"Hospital Bom Jesus\", \"cost_center\": {\"id\": \"cost-center-uuid\", \"code\": \"002.001\", \"name\": \"Hospital Bom Jesus\"}},\n {\"id\": \"work-uuid-2\", \"name\": \"Reforma Centro\", \"cost_center\": null}\n ]\n },\n \"channel\": \"import-progress.9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\"\n }", "name": "Import details retrieved successfully" } ] }, { "name": "Delete Import", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports\/:importId", "query": [], "raw": "{{baseUrl}}\/api\/imports\/:importId", "variable": [ { "id": "importId", "key": "importId", "value": "atque", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an NFe import along with its supplier products and pending link mappings. Only allowed when no imported product has been linked to a system product and the import is not being processed." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Import deleted successfully" }, { "header": [], "code": 422, "body": "{\"error\": \"N\u00e3o \u00e9 poss\u00edvel excluir uma importa\u00e7\u00e3o com produtos j\u00e1 vinculados.\"}", "name": "Import has linked products or is still processing" } ] }, { "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": "quia", "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 \"has_stock_movement\": false\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": "List Import Stock Distributions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports\/:importId\/distributions", "query": [], "raw": "{{baseUrl}}\/api\/imports\/:importId\/distributions", "variable": [ { "id": "importId", "key": "importId", "value": "dolores", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return, per imported product, how the purchased quantity was distributed across stocks (works and main). Aggregated from stock movements generated by the import." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"product\": { \"id\": \"product-uuid\", \"name\": \"Cano PVC XPTO\" },\n \"total\": 50,\n \"by_stock\": [\n { \"stock\": { \"id\": \"stock-uuid-a\", \"name\": \"Obra A\", \"is_main\": false }, \"quantity\": 10 },\n { \"stock\": { \"id\": \"stock-uuid-b\", \"name\": \"Obra B\", \"is_main\": false }, \"quantity\": 30 },\n { \"stock\": { \"id\": \"main-uuid\", \"name\": \"Principal\", \"is_main\": true }, \"quantity\": 10 }\n ]\n }\n ]\n }", "name": "Distribution breakdown per product" } ] }, { "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": "dignissimos", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mappings\":[{\"distributions\":[{\"stock_id\":\"Example Mappings * distributions * stock id\",\"quantity\":1}]}]}" }, "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\":\"vero\",\"sort_desc\":false,\"page\":21,\"per_page\":23}" }, "description": "List all states paginated" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"name\":\"qui veniam\",\"abbreviation\":\"XK\"},{\"id\":null,\"name\":\"cupiditate ut\",\"abbreviation\":\"HS\"}],\"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\":\"Dibberttown\"},{\"id\":null,\"name\":\"Wallaceville\"}]}", "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": "ad", "description": "", "disabled": false }, { "key": "document", "value": "incidunt", "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": "cost_center_id", "value": "0cde452a-a564-3a1d-b326-738f9e51f654", "description": "O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the cost_centers 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=ad&document=incidunt&work_id=a01edd80-bf3e-40f7-8613-ccb4be5831b3&cost_center_id=0cde452a-a564-3a1d-b326-738f9e51f654&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\":\"dbcfdcd5-8567-3b77-93bf-8cf447c7ec8b\",\"receipt_number\":\"REC-0806\",\"receiver_type\":\"custom\",\"receiver\":{\"id\":null,\"name\":\"Miss Sydni O'Reilly\",\"document\":\"167.192.963-53\"},\"payment\":{\"amount\":3179.3,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"pix\",\"description\":\"Velit a et facere qui consectetur nesciunt.\"},\"issuer\":{\"name\":\"Hermiston and Sons\",\"document\":\"42.084.544\\\/4876-02\"},\"issue\":{\"date\":\"2026-11-03\",\"city\":\"Creolahaven\",\"state\":\"RJ\"},\"created_by\":{\"id\":\"a3295ffb-315e-47d4-b216-79a68daf9b31\",\"name\":\"Prof. Karson Kulas\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"71f7d359-76ef-33fd-bfe0-6409c64c97b5\",\"receipt_number\":\"REC-5704\",\"receiver_type\":\"employee\",\"receiver\":{\"id\":null,\"name\":\"Samson Feest\",\"document\":\"313.312.512-98\"},\"payment\":{\"amount\":7885.98,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"check\",\"description\":\"Eveniet fuga fugiat dignissimos non aliquid esse quo sit.\"},\"issuer\":{\"name\":\"Upton and Sons\",\"document\":\"40.975.184\\\/7122-96\"},\"issue\":{\"date\":\"2026-10-17\",\"city\":\"Batzport\",\"state\":\"SP\"},\"created_by\":{\"id\":\"a3295ffb-3a1a-43e7-ba3a-f79411bfe616\",\"name\":\"Dr. Buford Kessler Sr.\"},\"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": "Export payment receipts to Excel", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-receipts\/excel", "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": "corporis", "description": "", "disabled": false }, { "key": "document", "value": "eaque", "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": "cost_center_id", "value": "2c10ac21-a902-33fd-868f-c1cf93dcfb74", "description": "O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the cost_centers 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\/excel?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=corporis&document=eaque&work_id=a01edd80-bf3e-40f7-8613-ccb4be5831b3&cost_center_id=2c10ac21-a902-33fd-868f-c1cf93dcfb74&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": "Dispatches async Excel generation using the same filters as the listing. Frontend is notified via Pusher when ready." }, "response": [ { "header": [], "code": 202, "body": "{\"message\":\"string\",\"channel\":\"string\",\"event\":\"string\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"string\"}", "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\":\"check\",\"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\":\"2e7ab2fd-3c9e-3916-8cbf-5b7ff756031e\",\"receipt_number\":\"REC-4697\",\"receiver_type\":\"custom\",\"receiver\":{\"id\":null,\"name\":\"Jaunita Torp\",\"document\":\"528.915.967-85\"},\"payment\":{\"amount\":8853.8,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"bank_transfer\",\"description\":\"Dolores voluptates temporibus architecto dolores minima eius.\"},\"issuer\":{\"name\":\"Lockman, McClure and Prohaska\",\"document\":\"31.936.280\\\/3093-93\"},\"issue\":{\"date\":\"2026-10-23\",\"city\":\"Keiraberg\",\"state\":\"SC\"},\"created_by\":{\"id\":\"a3295ffb-5ff4-40a6-9717-43a17f501ab3\",\"name\":\"Casandra Franecki\"},\"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\":\"9007ace7-817d-448f-b632-da5133aa2360\",\"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\":\"7e135069-639e-3e6d-831e-16c331425a04\",\"cost_center_id\":\"551baef9-77d0-3965-a90c-fc37cd971b82\",\"bank_account_id\":\"3908d31a-dc1e-30b2-8166-36efab3de5fe\"}" }, "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\":\"db1b29ef-0618-4f87-84c1-71b568acd464\",\"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\":\"80212a3c-5535-3ab6-9a79-28139997228a\",\"cost_center_id\":\"30819968-945f-3a4d-bd45-459cdc84d285\",\"bank_account_id\":\"b8e0adb8-0542-3fd6-b040-2420d9794ba3\"}" }, "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": "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": "List all payment receipts for a specific employee" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"5a634ead-f262-3748-bf6f-38afcf475f99\",\"receipt_number\":\"REC-5913\",\"receiver_type\":\"custom\",\"receiver\":{\"id\":null,\"name\":\"Rick Will\",\"document\":\"603.882.945-06\"},\"payment\":{\"amount\":9235.18,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"cash\",\"description\":\"Eos voluptas aut aperiam.\"},\"issuer\":{\"name\":\"Hammes-Aufderhar\",\"document\":\"86.605.287\\\/8940-68\"},\"issue\":{\"date\":\"2026-10-19\",\"city\":\"Rennerside\",\"state\":\"SC\"},\"created_by\":{\"id\":\"a3295ffb-979b-44e0-b5a1-e958b4ba2d4d\",\"name\":\"Dell Grimes\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"a345b796-7d4d-3b05-b80b-797240326a04\",\"receipt_number\":\"REC-2833\",\"receiver_type\":\"employee\",\"receiver\":{\"id\":null,\"name\":\"Dr. Telly Stark Jr.\",\"document\":\"147.506.999-91\"},\"payment\":{\"amount\":3755.27,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"bank_transfer\",\"description\":\"Nulla ullam et praesentium dolorem inventore voluptatum mollitia.\"},\"issuer\":{\"name\":\"Rodriguez, Dach and Trantow\",\"document\":\"74.438.262\\\/4375-73\"},\"issue\":{\"date\":\"2026-10-19\",\"city\":\"Davonteburgh\",\"state\":\"PE\"},\"created_by\":{\"id\":\"a3295ffb-9a14-42f2-97fd-bcf85f1c23d5\",\"name\":\"Tracey Heaney\"},\"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 ungrouped permissions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/permission-groups\/ungrouped-permissions", "query": [ { "key": "q", "value": "Permission+name", "description": "Search query.", "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 } ], "raw": "{{baseUrl}}\/api\/permission-groups\/ungrouped-permissions?q=Permission+name&page=1&per_page=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all permissions that do not belong to any permission group." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"836e690e-5cf6-3f5b-a477-d304c16fc682\",\"name\":\"non\",\"display_name\":\"Soluta accusantium neque est consequatur.\"},{\"id\":\"4ab72aec-dc40-3813-aee1-143da6e03d49\",\"name\":\"voluptas\",\"display_name\":\"Excepturi voluptatum eligendi dolor sunt ad pariatur.\"}],\"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 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\":\"10802bf3-fce2-3906-86bc-66fa32904256\",\"name\":\"qui-asperiores-et\",\"display_name\":\"repudiandae nam maiores\",\"created_at\":null,\"updated_at\":null},{\"id\":\"1ae6a27c-848f-3b06-bb0d-a5b5041f45cd\",\"name\":\"cumque-nam-sint\",\"display_name\":\"sed eum ipsam\",\"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\":\"e754e2ea-76e7-3906-8d3b-2423182fda43\",\"name\":\"explicabo-id-vero\",\"display_name\":\"recusandae velit non\",\"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": "Attach permissions to group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/permission-groups\/:permissionGroup\/permissions", "query": [], "raw": "{{baseUrl}}\/api\/permission-groups\/:permissionGroup\/permissions", "variable": [ { "id": "permissionGroup", "key": "permissionGroup", "value": "1", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"permissions\":[\"b99efcd7-fbdd-39d1-9209-691eadce7438\"]}" }, "description": "Attach one or more permissions to a permission group. Permissions already in another group are moved to this group." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"c786111d-7d8d-322d-b2b7-046edfc85670\",\"name\":\"occaecati-eveniet-cupiditate\",\"display_name\":\"labore natus id\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Detach permissions from group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/permission-groups\/:permissionGroup\/permissions", "query": [], "raw": "{{baseUrl}}\/api\/permission-groups\/:permissionGroup\/permissions", "variable": [ { "id": "permissionGroup", "key": "permissionGroup", "value": "1", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"permissions\":[\"1cb29fd2-c263-32bb-ad66-d907526d326e\"]}" }, "description": "Detach one or more permissions from a permission group. Fails if any permission does not belong to the group." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"0a321d5e-2612-3c6a-8b0b-5f19ce7a7766\",\"name\":\"dignissimos-aut-qui\",\"display_name\":\"natus praesentium incidunt\",\"created_at\":null,\"updated_at\":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\":\"7e1e0713-d184-3003-8cff-46a651b6edc8\",\"name\":\"Stephanie Daniela Deverso Jr.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"b067e867-f96b-3f3a-8cb2-17a7b1da59be\",\"name\":\"Sr. M\\u00e1rio Manuel Carrara Jr.\",\"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": "excepturi", "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\":\"aa01d287-adca-3921-9ce6-5684160625be\",\"name\":\"Alma Beltr\\u00e3o Faro 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": "excepturi", "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": "voluptas", "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": "is_epi", "value": "", "description": "", "disabled": true }, { "key": "q", "value": "Structure", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/api\/product-families?is_epi=&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\":\"73f31a9d-fe56-301c-9e62-4889ea52ca41\",\"name\":\"George Ricardo Gusm\\u00e3o Neto\",\"is_epi\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"967c0d32-7c5b-3b63-9ffc-08784aff7d46\",\"name\":\"Dr. Amanda Catarina Serna\",\"is_epi\":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": "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": "tempore", "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\":\"37a0e428-589a-3f52-82b2-ef389135f9d4\",\"name\":\"Sra. Franciele Paloma Mendes Filho\",\"is_epi\":false,\"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\",\"is_epi\":true}" }, "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": "quasi", "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\",\"is_epi\":true}" }, "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": "sunt", "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\":\"81bc507f-211b-35cc-899e-71d7530ad055\",\"user_id\":\"27858add-9e1b-384b-b6f5-3a06505c1b79\",\"responsible_id\":\"1bc2968d-c43b-3bd5-8b34-977748b56dc7\",\"per_page\":1,\"sort\":\"Example Sort\",\"sort_desc\":true}" }, "description": "List all product quantity lists" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"e1532b3a-8785-3f96-bbbb-5abf033270ab\",\"name\":\"Ullam unde et aliquam.\",\"description\":null,\"work\":{\"id\":\"a3295ffc-3344-4eb5-9534-8e9e9667b22e\",\"name\":\"Mauro Ferreira de Oliveira Sobrinho\"},\"user\":{\"id\":\"a3295ffc-35f0-4962-8fc0-541b76dce414\",\"name\":\"Ms. Heloise Emard DVM\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"17e55f38-9cb8-3cba-980f-889b47b7a760\",\"name\":\"Qui consectetur et.\",\"description\":null,\"work\":{\"id\":\"a3295ffc-3949-4dd6-bb6d-557af6915c28\",\"name\":\"Mari Noemi Abreu Neto\"},\"user\":{\"id\":\"a3295ffc-3c00-410d-8814-3f4eb68e72e1\",\"name\":\"Lela Reynolds\"},\"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": "et", "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\":\"6e18b351-3395-3d87-8d3f-a59ab94c0bd3\",\"name\":\"Similique suscipit consequatur numquam.\",\"description\":\"Officiis delectus et veniam reiciendis. Eos culpa aliquid doloribus reiciendis.\",\"work\":{\"id\":\"a3295ffc-43b0-4b63-a7d3-9c8a9c138564\",\"name\":\"Leandro Josu\\u00e9 Benez\"},\"user\":{\"id\":\"a3295ffc-46ad-4099-adfc-ddacd19a943a\",\"name\":\"Kassandra Considine III\"},\"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": "id", "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\":\"8629f2fe-814d-3b26-8202-110375f3ce15\",\"product\":{\"id\":\"a3295ffc-5c96-4171-b033-b0ed0db9c1ad\",\"name\":\"Mauro Verdara Rico Jr.\",\"code\":\"PRD-431993\",\"unit\":{\"id\":\"a3295ffc-5a83-4f07-a2e3-195d3d90bb3d\",\"name\":\"Betina Sanches Perez\",\"abbreviation\":\"Sra. Dayane Valentin Neto\"}},\"quantity\":539.2014,\"observation\":\"Aliquid quam rerum facilis aspernatur omnis sint.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"431783c2-a084-33e8-aa2e-6494a125486f\",\"product\":{\"id\":\"a3295ffc-6c48-4f2a-90e0-13d8bd511447\",\"name\":\"Sr. Fl\\u00e1vio Aguiar Madeira Sobrinho\",\"code\":\"PRD-773697\",\"unit\":{\"id\":\"a3295ffc-6b0c-4732-a3de-f7ffa0f25f32\",\"name\":\"Fl\\u00e1vio Lira Aguiar Sobrinho\",\"abbreviation\":\"Dr. Erik Simon Padilha\"}},\"quantity\":409.7053,\"observation\":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 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\":\"0a7231ca-2e5d-3403-af35-ccf7e7c097b3\",\"items\":[{\"product_id\":\"0236b20f-5498-33bd-b88f-f975dae5e3c4\",\"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": "culpa", "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\":\"72aa2c36-43ee-3824-a334-0a6709f50e62\",\"product_id\":\"a6b733e3-1f32-3cfe-9162-eaff7d8e6a8d\",\"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": "inventore", "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": "officia", "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\":\"7f292008-6863-3624-ab52-7c2001d4eeb4\",\"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": "unde", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "sed", "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": "voluptas", "description": "Product Quantity List UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[\"8ff07637-e911-3c86-8e98-dabc44c8965f\"]}" }, "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": "ea", "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\":\"01540724-9f3e-3086-b8d5-0047e4046223\",\"product_id\":\"cf02bbb5-65ca-3ffa-9ed0-8ad99321898b\",\"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": "alias", "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\":\"9583bc3a-e0fb-3c1b-a646-eb8ac04a441e\",\"quantity\":1,\"source_stock_id\":\"f65bbb61-9849-3a4f-9319-f1f0dc60e0ed\",\"reason\":\"Example Reason\",\"origins\":[{\"supplier_product_id\":\"6d4ac084-f6c5-367b-9023-d6a9a6a9ad36\",\"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": "fugiat", "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\":\"414668be-857e-3e49-bfc1-2dde650196c0\",\"quantity\":53.5578,\"fulfilled_at\":\"2026-10-23T12:18:04.000000Z\",\"created_at\":null},{\"id\":\"3fde187e-41ae-3117-bfd8-2679cb861327\",\"quantity\":96.8006,\"fulfilled_at\":\"2026-10-28T20:09:11.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": "perspiciatis", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "earum", "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\":\"cc1721a8-625f-3b0f-8f27-daa8e96974b0\",\"product\":{\"id\":\"a3296001-531a-4a31-b000-314d90e7d699\",\"name\":\"Beatriz God\\u00f3i\",\"code\":\"PRD-487381\",\"unit\":{\"id\":\"a3296001-51e2-444a-bf93-bf5208df6127\",\"name\":\"Vit\\u00f3ria Noa Espinoza\",\"abbreviation\":\"Guilherme Aaron Molina Jr.\"}},\"quantity\":45.5158,\"quantity_fulfilled\":0,\"quantity_pending\":45.5158,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Perspiciatis rerum nemo cum molestiae.\",\"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": "suscipit", "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\":\"e632cc92-2732-3790-8404-59ad3d2613d5\",\"product\":{\"id\":\"a3296001-67e2-4a64-86cd-9316f0f5197d\",\"name\":\"Jer\\u00f4nimo C\\u00e9sar Carvalho Sobrinho\",\"code\":\"PRD-258776\",\"unit\":{\"id\":\"a3296001-66ac-4b68-beaa-cbeb7336669b\",\"name\":\"Srta. Stephanie Gomes Neto\",\"abbreviation\":\"Sr. Artur Urias Jr.\"}},\"quantity\":674.5476,\"quantity_fulfilled\":0,\"quantity_pending\":674.5476,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"f6000afc-3629-3e91-b358-8d8d4b1695d9\",\"product\":{\"id\":\"a3296001-7db7-436c-bca4-0cb09387fe2f\",\"name\":\"Sr. David Joaquin Amaral\",\"code\":\"PRD-572578\",\"unit\":{\"id\":\"a3296001-7cac-4936-b084-618033b395aa\",\"name\":\"Dr. Gabriel Franco Queir\\u00f3s\",\"abbreviation\":\"Marisa Serra\"}},\"quantity\":684.8509,\"quantity_fulfilled\":0,\"quantity_pending\":684.8509,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":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": "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": "quam", "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\":\"757f674b-ac75-3189-9cd6-b980b2bbecf2\",\"product\":{\"id\":\"a3296001-91cb-4b5f-8a83-8b11534c751c\",\"name\":\"Aaron Marques Barros\",\"code\":\"PRD-609435\",\"unit\":{\"id\":\"a3296001-90bc-4b70-a81f-e5d46d676eae\",\"name\":\"Dr. Isadora Roque\",\"abbreviation\":\"Marta Sarah Verdugo Sobrinho\"}},\"quantity\":729.685,\"quantity_fulfilled\":0,\"quantity_pending\":729.685,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"05b9f4ce-2247-358d-b2b4-cdb2d5d02c15\",\"product\":{\"id\":\"a3296001-a30b-46e2-89fb-79db2ee627c5\",\"name\":\"Gael Cordeiro\",\"code\":\"PRD-200785\",\"unit\":{\"id\":\"a3296001-a1d8-4575-83c5-e60bf94a3ed4\",\"name\":\"Srta. Anita Rosa Sobrinho\",\"abbreviation\":\"Sra. Manuela Oliveira Filho\"}},\"quantity\":547.5845,\"quantity_fulfilled\":0,\"quantity_pending\":547.5845,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Ipsam aut iusto non ut officia itaque quam.\",\"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\":\"f73fd794-51d0-3dfe-b41b-1d4113651a83\",\"work_location_id\":\"47ea20da-a2e9-37d8-9012-4113dd1738c8\",\"user_id\":\"789b581b-5151-3a51-8131-6240f2847381\",\"status_id\":\"c0018b70-0736-365f-8ecf-d99fa442c09b\",\"priority\":\"Example Priority\",\"needed_at_from\":\"Example Needed at from\",\"needed_at_to\":\"Example Needed at to\",\"responsible_id\":\"93933037-5e8e-35f4-a088-17ab6af7567a\"}" }, "description": "List all product requests" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"41be78ab-e1e2-359e-ae9a-d0de03ca7e66\",\"code\":null,\"name\":\"Omnis molestiae.\",\"description\":null,\"work\":{\"id\":\"a3295ffe-2039-4626-9874-06ce2d852834\",\"name\":\"Dr. Sophie Alessandra Lutero\"},\"user\":{\"id\":\"a3295ffe-232b-4e89-b150-e30133e97529\",\"name\":\"Kristopher Dach\"},\"status\":{\"id\":\"a3295ffe-2500-44ea-b09b-2ca56b275543\",\"slug\":null,\"name\":null,\"description\":\"D\\u00e9bora Delgado\",\"abbreviation\":\"omnis\",\"color\":\"#11e1d8\",\"text_color\":\"#b69466\"},\"priority\":\"medium\",\"priority_label\":\"M\\u00e9dia\",\"needed_at\":\"2026-11-19\",\"approved_at\":null,\"rejection_reason\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"9191cc6b-18a3-34b8-b19a-13e91d8f33de\",\"code\":null,\"name\":\"Nihil eos quia debitis.\",\"description\":null,\"work\":{\"id\":\"a3295ffe-2992-4d75-95da-99b1c6b1a7a3\",\"name\":\"Aaron Queir\\u00f3s\"},\"user\":{\"id\":\"a3295ffe-2ca3-43f4-80cb-ab0319d4affb\",\"name\":\"Amya Carroll\"},\"status\":{\"id\":\"a3295ffe-2eb0-4c98-858e-cb762249202e\",\"slug\":null,\"name\":null,\"description\":\"Sr. Sim\\u00e3o Azevedo Batista\",\"abbreviation\":\"quia\",\"color\":\"#2710eb\",\"text_color\":\"#6b9d89\"},\"priority\":\"urgent\",\"priority_label\":\"Urgente\",\"needed_at\":null,\"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": "quia", "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\":\"3aca14ab-99dc-30e4-8a35-29228fcd3d63\",\"code\":null,\"name\":\"Id nulla eaque et.\",\"description\":null,\"work\":{\"id\":\"a3295ffe-38cf-447d-acdc-c0f50763ec06\",\"name\":\"Srta. Mariah Vanessa Maia\"},\"user\":{\"id\":\"a3295ffe-3bec-47c2-b2cb-d6b02c099a4c\",\"name\":\"Bert Gusikowski\"},\"status\":{\"id\":\"a3295ffe-3dfd-4849-b349-fee312e361aa\",\"slug\":null,\"name\":null,\"description\":\"Srta. Anita \\u00c1vila Serna\",\"abbreviation\":\"explicabo\",\"color\":\"#a53c4c\",\"text_color\":\"#49f568\"},\"priority\":\"high\",\"priority_label\":\"Alta\",\"needed_at\":\"2026-12-03\",\"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": "similique", "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\":\"f25b01d0-a985-366c-8da4-8e485b8aafe3\",\"product\":{\"id\":\"a3295ffe-615c-467c-a108-6c7a291d9420\",\"name\":\"Vin\\u00edcius Serna\",\"code\":\"PRD-742173\",\"unit\":{\"id\":\"a3295ffe-5ff2-415b-9bad-c5f1f6402ab8\",\"name\":\"Sra. Priscila Valente\",\"abbreviation\":\"Matheus Pedrosa Jr.\"}},\"quantity\":225.992,\"quantity_fulfilled\":0,\"quantity_pending\":225.992,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"8090862a-9e6c-32aa-adcb-e6a2a20aaefb\",\"product\":{\"id\":\"a3295ffe-7a62-4bf7-9f65-df8d37d585a6\",\"name\":\"Miranda Padr\\u00e3o Jr.\",\"code\":\"PRD-215756\",\"unit\":{\"id\":\"a3295ffe-791a-4ec9-93b1-6353f91a006a\",\"name\":\"Rayane Michelle Prado\",\"abbreviation\":\"Dayane Maiara Pacheco\"}},\"quantity\":71.9137,\"quantity_fulfilled\":0,\"quantity_pending\":71.9137,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Ut rem veritatis et architecto at.\",\"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\":\"9695dc8e-511c-3e99-b317-8c6eaf488889\",\"work_location_id\":\"a0064262-a0e3-39c4-8667-313fb748107e\",\"status_id\":\"8ec79828-c98c-37e6-b950-58c47cbe53a2\",\"priority\":\"Example Priority\",\"needed_at\":\"Example Needed at\",\"items\":[{\"product_id\":\"6fb41ce7-f4df-345f-8a11-795554782546\",\"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": "quis", "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\":\"d06976f9-8dd9-3d82-95ea-88c966d4b981\",\"work_location_id\":\"891f559e-48b5-3ba2-897f-de1db31db81c\",\"status_id\":\"59f7b17f-9eee-3d35-9c42-df1f70c89215\",\"priority\":\"Example Priority\",\"needed_at\":\"Example Needed at\",\"items\":[{\"id\":\"261bf617-9659-3dd9-9329-a913e692cbdd\",\"product_id\":\"e9e77d7c-679f-314a-ad10-929f8dfddcef\",\"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": "quo", "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": "aperiam", "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": "et", "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": "ea", "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\":\"7f7b640d-e1a2-391e-bda5-cf6f6ed46c55\",\"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": "mollitia", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "et", "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\":\"3a37e85b-9ebf-3505-a1f2-9e82605ca4a2\"}" }, "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": "fuga", "description": "Product Request UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[\"36b9b998-9d93-3d69-97e9-13d115213a9e\"]}" }, "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": "ut", "description": "Product Request UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"id\":\"974b23b9-75b1-3e66-b8e8-44e06c38b4a4\",\"product_id\":\"95faeb55-ae2f-3a7c-8f7c-7b5ea7ce16fc\",\"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 }, { "key": "is_epi", "value": "1", "description": "Filter by products whose family is flagged as EPI.", "disabled": false }, { "key": "has_epi_type", "value": "", "description": "Filter by products that already are an EPI type. Pass 0 to list only products still available to become one.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/products?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Brick&code=PROD-00003&is_epi=1&has_epi_type=" }, "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\":\"c106737c-737a-3d07-9b1b-0b6ec5ad7691\",\"name\":\"Dr. Marcos Marques Neto\",\"code\":\"PRD-237867\",\"stock\":495,\"product_family\":{\"id\":\"a3295ffb-cc51-4561-8370-cc2f97dce8ff\",\"name\":\"Antonieta Andr\\u00e9ia Campos\"},\"product_brand\":{\"id\":\"a3295ffb-ce2e-4d26-9b40-859b838c980e\",\"name\":\"Emanuelly Gil Ortega Jr.\"},\"unit\":{\"id\":\"a3295ffb-cff1-417d-b3aa-3c6d63fcc959\",\"name\":\"Ester Fernanda Dominato\",\"abbreviation\":\"Sr. Raphael Soares Neto\"},\"image\":{\"id\":null,\"url\":null},\"epi_type\":null,\"description\":\"Ipsam libero commodi dolores et quae.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"1c7137e5-548b-37c8-806a-eadd38ef4be8\",\"name\":\"Isabella Gabrielle Marin Neto\",\"code\":\"PRD-599156\",\"stock\":77,\"product_family\":{\"id\":\"a3295ffb-d35b-45c3-95ce-1b88455e8fe3\",\"name\":\"Dr. Abgail Fabiana de Freitas\"},\"product_brand\":{\"id\":\"a3295ffb-d4de-4604-b5ab-8bfc1c9a2658\",\"name\":\"Elizabeth das Neves Teles Filho\"},\"unit\":{\"id\":\"a3295ffb-d684-42d6-aab8-26414b4b842a\",\"name\":\"Dr. Josu\\u00e9 Sanches Salazar\",\"abbreviation\":\"Srta. Priscila Salazar Grego Neto\"},\"image\":{\"id\":null,\"url\":null},\"epi_type\":null,\"description\":\"Ab eos voluptas molestias voluptatibus magnam et in ducimus.\",\"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": "aut", "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\":\"7680cd48-72a0-357a-a469-cb8818ea5b5b\",\"name\":\"Anderson Solano\",\"code\":\"PRD-443935\",\"stock\":8006961,\"product_family\":{\"id\":\"a3295ffb-df05-4b97-8bde-98d47fd5f982\",\"name\":\"Sra. Michelle Corona Serna\"},\"product_brand\":{\"id\":\"a3295ffb-e0b8-46bc-ac69-8da807343558\",\"name\":\"Dr. Emerson Benites Sobrinho\"},\"unit\":{\"id\":\"a3295ffb-e256-43e1-ab8d-c8c22732adab\",\"name\":\"Luciana Mascarenhas Marin Sobrinho\",\"abbreviation\":\"Miguel Gil Torres\"},\"image\":{\"id\":null,\"url\":null},\"epi_type\":null,\"description\":\"Animi architecto ipsa ipsa fugit modi.\",\"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": "soluta", "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\":\"bdd9edcb-9c8c-37c9-8872-a20726513cd0\",\"product_brand_id\":\"33d3c17b-faee-32dd-936c-a231f354a259\",\"unit_id\":\"f4d15468-c876-39c5-8bc2-e9264fa255c8\",\"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": "vel", "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\":\"28cf361a-1c74-3cb9-ab03-82c08ad5a61a\",\"product_brand_id\":\"7c05a439-f445-3f0e-a371-e220207a5665\",\"unit_id\":\"5b296445-d764-3443-9224-bee464705ecc\",\"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": "similique", "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": "Project Versions", "description": "Endpoints for project revisions", "item": [ { "name": "Create revision", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:projectUuid\/versions", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:projectUuid\/versions", "variable": [ { "id": "projectUuid", "key": "projectUuid", "value": "762cf6f7-2c38-37a0-8c16-4bfb3b33db7b", "description": "Project UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"notes\":\"Example Notes\",\"responsible_user_id\":\"cb867a04-a200-3dfe-ab41-85c461b248ab\",\"file\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example File path\",\"name\":\"Example Name\",\"size\":\"Example File size\",\"extension\":\"Example File extension\"}}" }, "description": "Create a new revision and update the project current file" }, "response": [ { "header": [], "code": 201, "body": null, "name": "" } ] }, { "name": "List revisions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:projectUuid\/versions", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:projectUuid\/versions", "variable": [ { "id": "projectUuid", "key": "projectUuid", "value": "d0017d80-1a9d-3415-8f84-dd0a5d2ed1ec", "description": "Project UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all revisions of a project" }, "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": "Show revision", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project-versions\/:versionUuid", "query": [], "raw": "{{baseUrl}}\/api\/project-versions\/:versionUuid", "variable": [ { "id": "versionUuid", "key": "versionUuid", "value": "6acf0ad0-bd23-3725-ae25-656074ddafaf", "description": "Revision UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a specific revision" }, "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": "Download revision", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project-versions\/:versionUuid\/download", "query": [], "raw": "{{baseUrl}}\/api\/project-versions\/:versionUuid\/download", "variable": [ { "id": "versionUuid", "key": "versionUuid", "value": "26426e2d-b800-37c7-9d31-5e9b214bbddd", "description": "Revision UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Generate a signed URL to download a revision" }, "response": [ { "header": [], "code": 200, "body": "{\"url\":\"string\",\"filename\":\"string\",\"size\":\"string\",\"version_number\":\"integer\"}", "name": "" } ] }, { "name": "Restore revision", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project-versions\/:versionUuid\/restore", "query": [], "raw": "{{baseUrl}}\/api\/project-versions\/:versionUuid\/restore", "variable": [ { "id": "versionUuid", "key": "versionUuid", "value": "7fd6fef6-e200-3970-8c94-4c417e0db12c", "description": "Revision UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Restore a revision as the current file" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete revision", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/project-versions\/:versionUuid", "query": [], "raw": "{{baseUrl}}\/api\/project-versions\/:versionUuid", "variable": [ { "id": "versionUuid", "key": "versionUuid", "value": "16087596-3509-30b5-b15f-9a37af506291", "description": "Revision UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Soft delete a revision" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Projects", "description": "Endpoints for engineering projects", "item": [ { "name": "List projects", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects", "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": "El%C3%A9trico", "description": "Search query.", "disabled": false }, { "key": "discipline_id", "value": "02843c85-e1e8-364d-92a7-04d1a8d1cae1", "description": "Filter by discipline UUID. O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the disciplines table.", "disabled": false }, { "key": "work_id", "value": "58cea06a-4284-38b1-8eab-cc1dbc6cc0cf", "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": "status_id", "value": "e418afa2-5c74-3104-b994-a2c1114c22f3", "description": "Filter by status UUID. O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the statuses table.", "disabled": false }, { "key": "responsible_id", "value": "0b5dbcc9-30e2-3a92-959f-1fc65f0111b6", "description": "Filter by responsible user UUID. O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the users table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/projects?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=El%C3%A9trico&discipline_id=02843c85-e1e8-364d-92a7-04d1a8d1cae1&work_id=58cea06a-4284-38b1-8eab-cc1dbc6cc0cf&status_id=e418afa2-5c74-3104-b994-a2c1114c22f3&responsible_id=0b5dbcc9-30e2-3a92-959f-1fc65f0111b6" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all projects" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"ebdf5172-06d1-3261-904f-46753f7bb3ed\",\"name\":\"Reiciendis occaecati nam\",\"description\":\"Error doloremque nihil sit minus.\",\"current_version\":1,\"file\":{\"path\":\"projects\\\/2baa1786-2127-33fd-a3e6-953a8596259e.pdf\",\"size\":\"1783563\",\"extension\":\"pdf\"},\"discipline\":{\"id\":\"a3296001-ada5-47d8-adb6-39957a2722f1\",\"name\":\"Quasi\",\"code\":\"ZZW\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"fcdeaf6c-4a1b-3d54-9aa8-846d5bc44dbf\",\"name\":\"Odio consequatur qui\",\"description\":\"Iste sit excepturi aut reiciendis vitae in molestias.\",\"current_version\":1,\"file\":{\"path\":\"projects\\\/e03e398c-441d-304c-83d2-1457184ee155.pdf\",\"size\":\"1609415\",\"extension\":\"pdf\"},\"discipline\":{\"id\":\"a3296001-b091-4d83-9472-a84fceeab0c1\",\"name\":\"Nemo\",\"code\":\"UDS\"},\"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 project", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:id", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the project." }, { "id": "project", "key": "project", "value": "a", "description": "Project UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a project" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"52066aeb-2141-332e-ad3f-4b17ad607d95\",\"name\":\"Et unde est\",\"description\":\"Ut voluptas nihil occaecati eos quo.\",\"current_version\":1,\"file\":{\"path\":\"projects\\\/72878fe6-590a-3b22-9cff-672fc549b18f.pdf\",\"size\":\"2535118\",\"extension\":\"pdf\"},\"discipline\":{\"id\":\"a3296001-b850-4512-93b5-6449bcf6cab2\",\"name\":\"Adipisci\",\"code\":\"YLR\"},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create project", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects", "query": [], "raw": "{{baseUrl}}\/api\/projects" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"description\":\"Example Description\",\"discipline_id\":\"3adb07d1-d004-3ac5-8923-600f23f21bb9\",\"work_id\":\"0c3118f2-7e22-3197-b2cc-2f4c1a12f88d\",\"responsible_user_id\":\"8ed321f1-2574-312d-add9-1277fe9c3857\",\"notes\":\"Example Notes\",\"file\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example File path\",\"name\":\"Example Name\",\"size\":\"Example File size\",\"extension\":\"Example File extension\"}}" }, "description": "Create a new project and its first revision (R00)" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update project", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:id", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the project." }, { "id": "project", "key": "project", "value": "a", "description": "Project 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\",\"discipline_id\":\"be154304-d135-3ae1-ba71-a7129e07c7d7\",\"work_id\":\"6bb5508d-dac6-3c30-b8fc-b871c3aab3ac\",\"responsible_user_id\":\"398b4420-1724-3f8f-8328-c4286f227a87\",\"status_id\":\"8afbf8af-8ac4-33ac-9f2b-75a23823d00a\"}" }, "description": "Update a project (metadata only)" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete project", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:project", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:project", "variable": [ { "id": "project", "key": "project", "value": "voluptas", "description": "Project UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a project and its revisions" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Reports", "description": "Endpoints for reports", "item": [ { "name": "Generate RDO PDF", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/daily-log", "query": [], "raw": "{{baseUrl}}\/api\/reports\/daily-log" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"daily_log\":\"quaerat\"}" }, "description": "Dispatches async PDF 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": "Generate EPI term PDF", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/epi-term", "query": [], "raw": "{{baseUrl}}\/api\/reports\/epi-term" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"employee\":\"earum\",\"kit_uuid\":\"60aa4ce2-81d7-3324-bfba-6828bd50f5cb\"}" }, "description": "Dispatches async PDF 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": "Generate employee sheet PDF", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/employee-sheet", "query": [], "raw": "{{baseUrl}}\/api\/reports\/employee-sheet" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"employee\":\"est\"}" }, "description": "Dispatches async PDF generation of the employee record. 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": "Cost center panel", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/cost-center", "query": [ { "key": "date_start", "value": "2026-11-01", "description": "In\u00edcio do per\u00edodo. Must be a valid date in the format Y-m-d.", "disabled": false }, { "key": "date_end", "value": "2026-11-30", "description": "Fim do per\u00edodo. Must be a valid date in the format Y-m-d. O campo value deve ser uma data posterior ou igual a date_start.", "disabled": false }, { "key": "works[0]", "value": "f6b58205-c4eb-36b2-92c0-2e839d1be4a8", "description": "O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the works table.", "disabled": false }, { "key": "cost_centers[0]", "value": "a838fb3c-5ac6-3d46-9353-57d3df136708", "description": "O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the cost_centers table.", "disabled": false }, { "key": "format", "value": "xlsx", "description": "S\u00f3 na exporta\u00e7\u00e3o: xlsx (padr\u00e3o) ou csv.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/cost-center?date_start=2026-11-01&date_end=2026-11-30&works[0]=f6b58205-c4eb-36b2-92c0-2e839d1be4a8&cost_centers[0]=a838fb3c-5ac6-3d46-9353-57d3df136708&format=xlsx" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Totais por centro de custo no per\u00edodo, somados pela \u00e1rvore. Devolve dois blocos declarados e separados: desembolso (fecha com o caixa e o banco) e custo apropriado por obra. Os dois n\u00e3o se somam \u2014 material comprado num m\u00eas e entregue em outro aparece em cada bloco no seu momento." }, "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": "Cost center entries", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/cost-center\/entries", "query": [ { "key": "search", "value": "vero", "description": "Texto livre em descri\u00e7\u00e3o, c\u00f3digo, obra e fornecedor\/recebedor, sem distinguir caixa nem acento. O total da pagina\u00e7\u00e3o reflete a busca.", "disabled": false }, { "key": "sort_by", "value": "date", "description": "date ou amount. Padr\u00e3o: date.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Ordem decrescente. Padr\u00e3o: 1.", "disabled": false }, { "key": "per_page", "value": "12", "description": "Itens por p\u00e1gina, at\u00e9 100. Padr\u00e3o: 10.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/cost-center\/entries?search=vero&sort_by=date&sort_desc=1&per_page=12" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"date_start\":\"2026-11-06\",\"date_end\":\"2087-03-12\",\"block\":\"work_cost\",\"cost_center_id\":\"f9bee4f1-4167-3593-a1d9-2ec06642c373\",\"without_cost_center\":false,\"type\":\"other\",\"per_page\":22,\"search\":\"xdigiephlexuqndd\",\"sort_by\":\"amount\",\"sort_desc\":true}" }, "description": "Lan\u00e7amentos que formam um total do painel, paginados e em ordem de data. O centro informado inclui a sub\u00e1rvore, ent\u00e3o clicar no total de um grupo lista o que veio dos filhos tamb\u00e9m." }, "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 cost center panel", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/cost-center\/excel", "query": [ { "key": "date_start", "value": "2026-11-01", "description": "In\u00edcio do per\u00edodo. Must be a valid date in the format Y-m-d.", "disabled": false }, { "key": "date_end", "value": "2026-11-30", "description": "Fim do per\u00edodo. Must be a valid date in the format Y-m-d. O campo value deve ser uma data posterior ou igual a date_start.", "disabled": false }, { "key": "works[0]", "value": "2448bb79-e735-3794-a9fe-5e695b6d6496", "description": "O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the works table.", "disabled": false }, { "key": "cost_centers[0]", "value": "9f5850c2-3c4e-33dc-8fba-ed18f03a885f", "description": "O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the cost_centers table.", "disabled": false }, { "key": "format", "value": "xlsx", "description": "S\u00f3 na exporta\u00e7\u00e3o: xlsx (padr\u00e3o) ou csv.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/cost-center\/excel?date_start=2026-11-01&date_end=2026-11-30&works[0]=2448bb79-e735-3794-a9fe-5e695b6d6496&cost_centers[0]=9f5850c2-3c4e-33dc-8fba-ed18f03a885f&format=xlsx" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Gera a planilha do painel com os filtros atuais. XLSX sai com tr\u00eas abas (um total por bloco, mais os lan\u00e7amentos); CSV sai com as mesmas tr\u00eas coisas em se\u00e7\u00f5es. O arquivo \u00e9 gerado em fila e chega por notifica\u00e7\u00e3o." }, "response": [ { "header": [], "code": 202, "body": "{\"message\":\"Relat\\u00f3rio sendo gerado. Voc\\u00ea ser\\u00e1 notificado quando estiver pronto.\",\"channel\":\"reports.{uuid}\",\"event\":\"excel-report.completed\"}", "name": "" } ] }, { "name": "Export Cash Flow to Excel", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/cash-flow\/excel", "query": [ { "key": "q", "value": "dolorem", "description": "", "disabled": false }, { "key": "type", "value": "entrada", "description": "Tipo de lan\u00e7amento.", "disabled": false }, { "key": "description", "value": "Ipsum+est+dignissimos+rerum+voluptatem+quo+blanditiis+inventore.", "description": "", "disabled": false }, { "key": "categories[0]", "value": "76ba4a57-340f-3837-b741-11e894ac55c3", "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": "c7898385-c2bd-399d-b96e-9981a81dd365", "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": "f1a80770-b251-3795-8043-1481d5b6c47f", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "customers[0]", "value": "1a4f8530-7744-3a3e-9938-a553e12571a2", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "suppliers[0]", "value": "f3470f50-b682-35f8-a125-01e4f2540243", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "cash_session", "value": "9d1c3cf9-bcab-3712-836c-2336b6ff976a", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "works[0]", "value": "e334f56a-4b90-3c89-bb59-01f8755f062e", "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=dolorem&type=entrada&description=Ipsum+est+dignissimos+rerum+voluptatem+quo+blanditiis+inventore.&categories[0]=76ba4a57-340f-3837-b741-11e894ac55c3&exclude_categories[0]=c7898385-c2bd-399d-b96e-9981a81dd365&date_start=2026-01-01&date_end=2026-12-31&bank_accounts[0]=f1a80770-b251-3795-8043-1481d5b6c47f&customers[0]=1a4f8530-7744-3a3e-9938-a553e12571a2&suppliers[0]=f3470f50-b682-35f8-a125-01e4f2540243&cash_session=9d1c3cf9-bcab-3712-836c-2336b6ff976a&works[0]=e334f56a-4b90-3c89-bb59-01f8755f062e&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": "quibusdam", "description": "", "disabled": false }, { "key": "type", "value": "entrada", "description": "Tipo de lan\u00e7amento.", "disabled": false }, { "key": "description", "value": "Sit+totam+sed+sit+ratione+repudiandae.", "description": "", "disabled": false }, { "key": "categories[0]", "value": "b90512f0-7e45-39ed-8718-8a8056bb08c9", "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": "f4fee5fa-7f31-301e-a4fc-e520bac4f7bb", "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": "ba63188a-7e9b-3e7b-bd98-b381b1675c73", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "customers[0]", "value": "09bc2e1b-0b6f-3185-bac6-30260d8b4dad", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "suppliers[0]", "value": "7d53f013-5ab1-3303-bcfc-a6e24a510814", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "cash_session", "value": "7a4b5252-b461-3c2f-b781-a4db27e33013", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "works[0]", "value": "7f2504fd-6dfc-3a06-9f8b-73a68ab37d40", "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=quibusdam&type=entrada&description=Sit+totam+sed+sit+ratione+repudiandae.&categories[0]=b90512f0-7e45-39ed-8718-8a8056bb08c9&exclude_categories[0]=f4fee5fa-7f31-301e-a4fc-e520bac4f7bb&date_start=2026-01-01&date_end=2026-12-31&bank_accounts[0]=ba63188a-7e9b-3e7b-bd98-b381b1675c73&customers[0]=09bc2e1b-0b6f-3185-bac6-30260d8b4dad&suppliers[0]=7d53f013-5ab1-3303-bcfc-a6e24a510814&cash_session=7a4b5252-b461-3c2f-b781-a4db27e33013&works[0]=7f2504fd-6dfc-3a06-9f8b-73a68ab37d40&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\":\"777c4645-75a9-3fdc-992c-c72501a27723\",\"name\":\"ut enim\",\"slug\":null,\"description\":null,\"abbreviation\":\"jya\",\"created_at\":null,\"updated_at\":null},{\"id\":\"405d7011-c7e4-3ef2-aa8c-c99131a95a7d\",\"name\":\"asperiores occaecati\",\"slug\":null,\"description\":null,\"abbreviation\":null,\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create sector", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors", "query": [], "raw": "{{baseUrl}}\/api\/sectors" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"slug\":\"Example Slug\",\"description\":\"Example Description\",\"abbreviation\":\"Example Abbreviation\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"url\":\"https:\\\/\\\/example.com\",\"name\":\"Example Name\",\"size\":\"Example Image size\",\"extension\":\"Example Image extension\"}}" }, "description": "Create a new sector" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Get sector", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors\/:id", "query": [], "raw": "{{baseUrl}}\/api\/sectors\/:id", "variable": [ { "id": "id", "key": "id", "value": "18", "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\":\"3d650da8-a949-3042-8c3b-deeb7ae48be3\",\"name\":\"natus provident\",\"slug\":null,\"description\":\"Incidunt tempora nemo velit voluptatem voluptas et et aut. Architecto sit aut ipsum sed est iusto magnam earum. Ut earum temporibus consequatur quibusdam sint. Quis dolores quod eum ut provident et.\",\"abbreviation\":null,\"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": "20", "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\":\"b3743eb8-1ac9-3441-b238-60625851a9fc\",\"name\":\"Hiram Hegmann\",\"username\":\"trystan.ankunding\",\"email\":\"fstamm@example.org\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"b1007f23-e8c2-3695-af50-78bfc77a260f\",\"name\":\"Celia D'Amore\",\"username\":\"lbradtke\",\"email\":\"priscilla05@example.net\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"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\":[\"ccb81782-0fca-3b82-bb8f-4b7976ed58da\"]}" }, "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\":[\"359b1a7c-f8e7-3fd6-9ab3-6676155b1fd1\"]}" }, "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\":[\"37afe25e-ea66-39ff-b37b-4a78d2bd42c4\"]}" }, "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\":\"et libero\",\"slug\":\"corrupti-est-est-assumenda-animi-voluptatem-sit-qui\"},{\"name\":\"est ea\",\"slug\":\"aliquid-sed-eveniet-officiis-et-odio-nihil-a\"}]}", "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\":\"24869b0e-14c4-3ae6-bcf8-215d7907c3e9\",\"slug\":null,\"name\":null,\"description\":\"Nicolas de Freitas\",\"abbreviation\":\"consequuntur\",\"color\":\"#d50a56\",\"text_color\":\"#9fc5bc\",\"created_at\":null,\"updated_at\":null},{\"id\":\"8bb01fbb-3ae7-3e52-b2aa-e50d390b430a\",\"slug\":null,\"name\":null,\"description\":\"Sr. Jos\\u00e9 Torres Bonilha\",\"abbreviation\":\"ipsam\",\"color\":\"#960c72\",\"text_color\":\"#da68b4\",\"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\":\"09031b1f-7987-33f2-938a-00b7c998b8f8\",\"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\":\"ce1c5b29-3870-367a-b14b-ddaf2ab9c767\",\"slug\":null,\"name\":null,\"description\":\"Dr. Martinho Lozano Pena\",\"abbreviation\":\"omnis\",\"color\":\"#992f61\",\"text_color\":\"#0b09f2\",\"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\":\"8df45d5b-988c-3a81-8aa1-aa01719574b0\",\"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\":\"771c8015-e3b4-33d2-94f6-825c13f0c96d\",\"quantity\":309.3971,\"min_quantity\":null,\"max_quantity\":null,\"below_minimum\":false,\"above_maximum\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"ee6bf7c9-8b94-3a20-9ce2-fa273d5e3e49\",\"quantity\":179.731,\"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\":\"4f7ea0b1-06f1-381f-b2b2-545c7471578e\",\"name\":\"Estoque Faro e Filhos\",\"module\":\"work\",\"is_active\":true,\"is_main\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"99140fd3-09e3-3c51-9969-6057ce36ebaa\",\"name\":\"Estoque Benites Ltda.\",\"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\":\"9b36878e-77da-31e8-b2fc-c592fa710b75\",\"name\":\"Estoque Valdez-Delatorre\",\"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\":\"200e7051-9a8c-34bf-a741-703e3bbfc194\",\"name\":\"Estoque Deverso Ltda.\",\"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\":\"6ff8fe92-038c-33fb-b120-c7b7116922e6\",\"name\":\"Estoque God\\u00f3i Comercial Ltda.\",\"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\":\"5f5144c0-950f-3fc9-ab1e-8f4648cfeb84\",\"name\":\"Estoque Correia Comercial Ltda.\",\"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\":\"3e3b892c-04d2-3195-a797-66140eaf08b1\",\"quantity\":798.4635,\"min_quantity\":null,\"max_quantity\":null,\"below_minimum\":false,\"above_maximum\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"c7efb4b9-138d-3b7a-87ec-3993068f27ae\",\"quantity\":984.5773,\"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": "ad", "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\":\"11b1dedc-6486-3aae-9b00-5fef217ce6d3\",\"quantity\":382.4545,\"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 \"total_value\": 18750.4,\n \"current_value\": 9000,\n \"consumed_value\": 9750.4,\n \"unvalued_quantity\": 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\":\"838fc981-c98f-3651-a445-03dc525f1dfb\",\"code\":\"MOV-579883\",\"type\":\"compra\",\"type_name\":\"PURCHASE\",\"is_entry\":true,\"is_exit\":false,\"quantity\":37.9901,\"previous_quantity\":573.8547,\"new_quantity\":611.8448,\"reason\":null,\"movement_date\":\"2026-10-08T05:39:26.000000Z\",\"created_at\":null},{\"id\":\"6faa20fe-744b-34ab-a65c-64789e240f65\",\"code\":\"MOV-112379\",\"type\":\"ajuste entrada\",\"type_name\":\"ADJUSTMENT_IN\",\"is_entry\":true,\"is_exit\":false,\"quantity\":25.578,\"previous_quantity\":374.6659,\"new_quantity\":400.2439,\"reason\":\"Officiis hic quia et nam ea sint velit quaerat.\",\"movement_date\":\"2026-10-24T08:34:04.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\":\"7c89992b-8853-3356-aad9-e0a9cb22ecf7\",\"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\":\"aa888bcf-0cc5-320f-ae75-f7e50f14827b\",\"code\":\"MOV-139176\",\"type\":\"compra\",\"type_name\":\"PURCHASE\",\"is_entry\":true,\"is_exit\":false,\"quantity\":86.4539,\"previous_quantity\":390.8058,\"new_quantity\":477.2597,\"reason\":null,\"movement_date\":\"2026-11-05T17:06:22.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\":\"3cd92a8a-d6ea-391b-9bab-54a7adf896b8\",\"destination_stock_id\":\"17b65c54-837e-3207-98d0-9f632df3231f\",\"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\":\"4aa6ceee-9e5d-34b5-9344-60f9131a252b\",\"code\":\"MOV-196934\",\"type\":\"consumo\",\"type_name\":\"CONSUMPTION\",\"is_entry\":false,\"is_exit\":true,\"quantity\":10.157,\"previous_quantity\":234.1904,\"new_quantity\":224.0334,\"reason\":\"Sunt aut aut qui.\",\"movement_date\":\"2026-10-29T06:00:52.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\":\"7693797f-b9f9-3aec-9970-1d086aa6b51c\",\"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\":\"d9a6683a-1b6d-3855-af39-ef746669293d\",\"code\":\"MOV-868004\",\"type\":\"entrada transfer\\u00eancia\",\"type_name\":\"TRANSFER_IN\",\"is_entry\":true,\"is_exit\":false,\"quantity\":66.2108,\"previous_quantity\":10.3738,\"new_quantity\":76.5846,\"reason\":null,\"movement_date\":\"2026-11-01T04:01:40.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\":\"61204d8a-1e46-3bc1-be5b-92be424b5a55\",\"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\":\"bd380288-27a8-3d6e-8872-6a02969447cd\",\"code\":\"MOV-404099\",\"type\":\"vencido\",\"type_name\":\"EXPIRED\",\"is_entry\":false,\"is_exit\":true,\"quantity\":3.0073,\"previous_quantity\":242.8694,\"new_quantity\":239.8621,\"reason\":\"Eos ad qui sint.\",\"movement_date\":\"2026-10-21T14:41:11.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\":\"bc910eae-cffa-368d-9768-87394dedf28b\",\"code\":\"MOV-109275\",\"type\":\"ajuste entrada\",\"type_name\":\"ADJUSTMENT_IN\",\"is_entry\":true,\"is_exit\":false,\"quantity\":44.5977,\"previous_quantity\":150.2536,\"new_quantity\":194.8513,\"reason\":null,\"movement_date\":\"2026-11-01T13:06:02.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\":\"e07b2990-cf80-331b-aafa-f352404e238d\",\"name\":\"Dr. Ketlin Santacruz\",\"email\":\"paloma.gomes@example.com\",\"phone\":\"(71) 2255-5111\",\"document\":\"15.444.382\\\/0001-10\",\"type\":\"pj\",\"responsible\":\"Dr. Raissa Louren\\u00e7o D'\\u00e1vila\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null}},{\"id\":\"7c2f9fee-5708-3692-b90c-6203cad20735\",\"name\":\"Sabrina Juliane Santana Sobrinho\",\"email\":\"santiago.filipe@example.org\",\"phone\":\"(87) 90357-3018\",\"document\":\"35.469.275\\\/0001-53\",\"type\":\"pj\",\"responsible\":\"Bruna Prado Santos Sobrinho\",\"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\":\"68d04f89-8839-39db-9b87-571a43392dd3\",\"name\":\"Stephany Toledo Sales\",\"email\":\"hcordeiro@example.net\",\"phone\":\"(44) 2567-7732\",\"document\":\"35.524.489\\\/0001-85\",\"type\":\"pj\",\"responsible\":\"Dr. Josu\\u00e9 Ferraz da Rosa\",\"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\":\"86aff075-444a-392e-bdcd-423142f69a81\",\"name\":\"Srta. Ver\\u00f4nica Aranda Filho\",\"description\":\"Eaque eveniet eligendi nesciunt omnis itaque. Dolor consequatur dolorem temporibus officiis exercitationem.\",\"type\":\"saque\"},{\"id\":\"321b3da4-e4a1-3cca-86f3-236626ab4d94\",\"name\":\"Cl\\u00e1udio Marinho Burgos Sobrinho\",\"description\":\"Dolor officiis quam molestias aliquid tenetur dolores pariatur. Veniam quam eaque rerum repellendus. Voluptas dignissimos deserunt est magnam asperiores.\",\"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": "voluptate", "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\":\"80af7ca8-61b7-35d2-959b-5e281a85f63e\",\"name\":\"Sra. Flor Teles\",\"description\":\"Dolorem nam quo provident. Magnam eos et ratione eum cupiditate. Illum ut ad et eligendi. Nam itaque accusamus non velit tenetur.\",\"type\":\"juros\"}}", "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": "adipisci", "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": "omnis", "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": "Tutoriais (administra\u00e7\u00e3o)", "description": "Cadastro do cat\u00e1logo de m\u00f3dulos da Central de Tutoriais", "item": [ { "name": "Listar m\u00f3dulos", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorial-modules", "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": "Financeiro", "description": "Busca por nome ou descri\u00e7\u00e3o.", "disabled": false }, { "key": "is_active", "value": "1", "description": "Filtra por m\u00f3dulos ativos ou inativos.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/admin\/tutorial-modules?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Financeiro&is_active=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lista o cat\u00e1logo de m\u00f3dulos de tutorial" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"bd2884d9-6bd6-3852-8977-ba63f5b3d738\",\"name\":\"Vero doloremque\",\"slug\":\"vero-doloremque-642821\",\"description\":\"Exercitationem aut ut id dolores.\",\"icon\":null,\"color\":null,\"sort_order\":0,\"is_active\":true,\"created_at\":null,\"updated_at\":null},{\"id\":\"7d32176b-9f08-3e65-bc51-9bc5259a5c7d\",\"name\":\"Ducimus eos\",\"slug\":\"ducimus-eos-777784\",\"description\":\"Voluptas quis cum adipisci nam perferendis qui.\",\"icon\":null,\"color\":null,\"sort_order\":0,\"is_active\":true,\"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": "Cadastrar m\u00f3dulo", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorial-modules", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorial-modules" }, "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\",\"icon\":\"Example Icon\",\"color\":\"Example Color\",\"sort_order\":1,\"is_active\":true}" }, "description": "Cria um m\u00f3dulo no cat\u00e1logo. O slug \u00e9 derivado do nome quando n\u00e3o informado." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"173d1d64-4c1d-36fe-af83-7dc2e35ef198\",\"name\":\"Tempora ut\",\"slug\":\"tempora-ut-218482\",\"description\":\"Quos veritatis quia voluptates alias perspiciatis.\",\"icon\":null,\"color\":null,\"sort_order\":0,\"is_active\":true,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Visualizar m\u00f3dulo", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorial-modules\/:tutorialModule", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorial-modules\/:tutorialModule", "variable": [ { "id": "tutorialModule", "key": "tutorialModule", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "UUID do m\u00f3dulo" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Detalhe de um m\u00f3dulo do cat\u00e1logo" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"cf276522-b822-3a0f-bdf6-2c2495fc4b8b\",\"name\":\"Voluptates ut\",\"slug\":\"voluptates-ut-213947\",\"description\":\"Necessitatibus enim recusandae blanditiis omnis laboriosam voluptatem sit.\",\"icon\":null,\"color\":null,\"sort_order\":0,\"is_active\":true,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Atualizar m\u00f3dulo", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorial-modules\/:tutorialModule", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorial-modules\/:tutorialModule", "variable": [ { "id": "tutorialModule", "key": "tutorialModule", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "UUID do m\u00f3dulo" } ] }, "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\",\"icon\":\"Example Icon\",\"color\":\"Example Color\",\"sort_order\":1,\"is_active\":true}" }, "description": "Atualiza um m\u00f3dulo do cat\u00e1logo" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"daee5fb3-e6aa-34cc-ac9a-f8fecf92aa6f\",\"name\":\"Officia labore\",\"slug\":\"officia-labore-472777\",\"description\":\"Placeat quia non quos blanditiis.\",\"icon\":null,\"color\":null,\"sort_order\":0,\"is_active\":true,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Remover m\u00f3dulo", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorial-modules\/:tutorialModule", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorial-modules\/:tutorialModule", "variable": [ { "id": "tutorialModule", "key": "tutorialModule", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "UUID do m\u00f3dulo" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove o m\u00f3dulo e, junto, os tutoriais que pertenciam a ele" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Listar tutoriais", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorials", "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": "ordem+de+servi%C3%A7o", "description": "Busca por t\u00edtulo ou descri\u00e7\u00e3o.", "disabled": false }, { "key": "module_id[0]", "value": "63e511d9-21d9-3a84-8742-fb13c4741d50", "description": "O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the tutorial_modules table.", "disabled": false }, { "key": "sector_id[]", "value": "", "description": "", "disabled": true }, { "key": "status", "value": "published", "description": "Filtra por status (draft ou published).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/admin\/tutorials?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=ordem+de+servi%C3%A7o&module_id[0]=63e511d9-21d9-3a84-8742-fb13c4741d50§or_id[]=&status=published" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lista os tutoriais em qualquer status, para quem administra" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"b259d7f4-093c-3631-bf85-81b885f4df90\",\"title\":\"Ipsa quo aut at\",\"description\":\"Provident itaque tempora eaque et.\",\"cover_url\":null,\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a3296004-85c0-40a1-88b1-4e000e4b7d48\",\"name\":\"Enim quaerat\",\"slug\":\"enim-quaerat-142284\",\"icon\":null,\"color\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"c9cd92c0-7fd9-397e-b695-daa17779afa6\",\"title\":\"Inventore eum voluptatem cupiditate\",\"description\":\"Officiis consequatur soluta voluptatum quae nobis eos inventore.\",\"cover_url\":null,\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a3296004-8907-4691-87c9-a3335bafabeb\",\"name\":\"Architecto sit\",\"slug\":\"architecto-sit-755851\",\"icon\":null,\"color\":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": "Cadastrar tutorial", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorials", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorials" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module_id\":\"68927f6c-9d06-3cf8-b096-aae1d26c36c1\",\"title\":\"Example Title\",\"description\":\"Example Description\",\"cover_path\":\"Example Cover path\",\"sort_order\":1,\"sectors\":[\"65ce4ae8-f084-3278-8cea-ef5d17eca32d\"],\"permissions\":[\"286f8488-38a1-31c4-b942-03a3ef2b7fe4\"]}" }, "description": "Cria um tutorial. Nasce como rascunho e s\u00f3 aparece na central depois de publicado." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"8d1913e9-214f-3c1a-ad51-c65781c18abe\",\"title\":\"Alias beatae officia minima\",\"description\":\"Quia sed harum quod esse.\",\"cover_url\":null,\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a3296004-93b1-4c9e-a907-f5f076386a02\",\"name\":\"Sed ex\",\"slug\":\"sed-ex-315598\",\"icon\":null,\"color\":null},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Gerar URL de upload", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorials\/upload-url", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorials\/upload-url" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"kind\":\"Example Kind\",\"filename\":\"Example Name\",\"extension\":\"Example Extension\",\"size_bytes\":1}" }, "description": "Devolve uma URL assinada de curta validade para o cliente enviar o arquivo direto ao S3. O arquivo s\u00f3 \u00e9 conferido depois, ao criar o item ou salvar a capa." }, "response": [ { "header": [], "code": 200, "body": "{\"url\":\"string\",\"headers\":\"array\",\"path\":\"string\",\"expires_in\":\"integer\"}", "name": "" } ] }, { "name": "Visualizar tutorial", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorials\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorials\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the tutorial." }, { "id": "tutorial", "key": "tutorial", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "UUID do tutorial" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Detalhe do tutorial com v\u00ednculos e itens" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"e4665f00-9aba-3a5b-8384-60893d7836a2\",\"title\":\"Occaecati molestias dolor minus\",\"description\":\"Quidem a nihil nostrum quis.\",\"cover_url\":null,\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a3296004-a03c-4eb4-921a-bc253f3e9499\",\"name\":\"Repudiandae et\",\"slug\":\"repudiandae-et-46682\",\"icon\":null,\"color\":null},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Atualizar tutorial", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorials\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorials\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the tutorial." }, { "id": "tutorial", "key": "tutorial", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "UUID do tutorial" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module_id\":\"f735e997-1014-3a1a-8de7-7631ae228255\",\"title\":\"Example Title\",\"description\":\"Example Description\",\"cover_path\":\"Example Cover path\",\"sort_order\":1,\"sectors\":[\"9e4e8227-0f65-36ae-82e0-ea791834b0e8\"],\"permissions\":[\"e315efbc-b095-3736-be4b-4080eb810d7a\"]}" }, "description": "Atualiza o tutorial e os v\u00ednculos de setor e permiss\u00e3o" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"f0497049-1a10-3318-933a-3fb971738e66\",\"title\":\"Eius et quo aut\",\"description\":\"Perferendis commodi tempora magnam rerum.\",\"cover_url\":null,\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a3296004-aaa1-461f-8592-a98f27ff2f8d\",\"name\":\"Qui sed\",\"slug\":\"qui-sed-726873\",\"icon\":null,\"color\":null},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Remover tutorial", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorials\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorials\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the tutorial." }, { "id": "tutorial", "key": "tutorial", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "UUID do tutorial" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove o tutorial, os itens e os arquivos correspondentes no S3" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Publicar tutorial", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorials\/:tutorial\/publish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorials\/:tutorial\/publish", "variable": [ { "id": "tutorial", "key": "tutorial", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "UUID do tutorial" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Publica o tutorial e carimba a data de publica\u00e7\u00e3o" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"4b875982-94f1-32c3-b123-980814619e83\",\"title\":\"Magni repellendus mollitia sit\",\"description\":\"Architecto vel animi id aliquam.\",\"cover_url\":null,\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a3296004-b335-4ed9-9931-310582d1381c\",\"name\":\"Laboriosam nesciunt\",\"slug\":\"laboriosam-nesciunt-463811\",\"icon\":null,\"color\":null},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Despublicar tutorial", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorials\/:tutorial\/unpublish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorials\/:tutorial\/unpublish", "variable": [ { "id": "tutorial", "key": "tutorial", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "UUID do tutorial" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Devolve o tutorial ao rascunho e limpa a data de publica\u00e7\u00e3o" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"5e8bfaa3-c410-390c-b841-d7d35d214d2f\",\"title\":\"Vitae repudiandae dolor nam\",\"description\":\"Voluptatem asperiores ut facere illo in enim dolore.\",\"cover_url\":null,\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a3296004-b8a9-4612-828a-1544057858cb\",\"name\":\"Perferendis labore\",\"slug\":\"perferendis-labore-406526\",\"icon\":null,\"color\":null},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Adicionar item ao tutorial", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorials\/:tutorial_id\/items", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorials\/:tutorial_id\/items", "variable": [ { "id": "tutorial_id", "key": "tutorial_id", "value": "1", "description": "The ID of the tutorial." }, { "id": "tutorial", "key": "tutorial", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "UUID do tutorial" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"Example Type\",\"title\":\"Example Title\",\"file_path\":\"Example File path\",\"external_url\":\"https:\\\/\\\/example.com\",\"duration_seconds\":1,\"sort_order\":1}" }, "description": "Cria o item a partir de um arquivo j\u00e1 enviado ao S3 (pdf ou video) ou de um link do YouTube\/Vimeo. O arquivo \u00e9 conferido aqui: exist\u00eancia, tamanho real e assinatura do conte\u00fado." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"5307ded9-e723-3604-836c-2e4bd7909f37\",\"type\":\"pdf\",\"title\":\"Sint ipsa tempora\",\"mime_type\":\"application\\\/pdf\",\"size_bytes\":1428861,\"duration_seconds\":null,\"sort_order\":0,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Reordenar itens", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorials\/:tutorial\/items\/reorder", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorials\/:tutorial\/items\/reorder", "variable": [ { "id": "tutorial", "key": "tutorial", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "UUID do tutorial" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[\"a24f3e13-aff3-3096-a51c-0d8f774e81d7\"]}" }, "description": "Grava a ordem dos itens conforme a sequ\u00eancia de UUIDs enviada" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Itens reordenados com sucesso\"}", "name": "" } ] }, { "name": "Atualizar item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorial-items\/:tutorialItem", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorial-items\/:tutorialItem", "variable": [ { "id": "tutorialItem", "key": "tutorialItem", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "UUID do item" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Example Title\",\"file_path\":\"Example File path\",\"external_url\":\"https:\\\/\\\/example.com\",\"duration_seconds\":1,\"sort_order\":1}" }, "description": "Atualiza o item. O tipo n\u00e3o muda depois de criado." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"0c93cee4-1dbb-3f5b-b3a4-1118316360a3\",\"type\":\"pdf\",\"title\":\"Et aut dolor\",\"mime_type\":\"application\\\/pdf\",\"size_bytes\":1427481,\"duration_seconds\":null,\"sort_order\":0,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Remover item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tutorial-items\/:tutorialItem", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tutorial-items\/:tutorialItem", "variable": [ { "id": "tutorialItem", "key": "tutorialItem", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "UUID do item" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove o item e apaga o arquivo correspondente no S3" }, "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\":\"24f20448-dacd-3dc8-8cc0-69bf28024ea5\",\"name\":\"Santiago Anderson Cervantes\",\"abbreviation\":\"Catarina Mary de Oliveira\",\"description\":\"Quia iure quia vel.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"a15dfc00-8261-3488-9f94-9db8508fdf84\",\"name\":\"Srta. Mirella Salas Barreto Filho\",\"abbreviation\":\"Sr. Luiz Saito Carrara Neto\",\"description\":\"Quos est sit vitae est vitae.\",\"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": "aliquid", "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\":\"86534254-025c-39a6-8dee-f4b8e700faf4\",\"name\":\"M\\u00f4nica God\\u00f3i\",\"abbreviation\":\"Marcelo Flores Marinho\",\"description\":\"Illo qui numquam rerum atque.\",\"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": "molestias", "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": "aliquid", "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\":\"c702d822-14ea-3b01-8846-e6d0f273c059\",\"name\":\"Freida Steuber\",\"username\":\"bell36\",\"email\":\"christa86@example.com\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"6d4cf3d0-b2e8-33a5-b3e0-4e638a1c43c1\",\"name\":\"Lesly Kiehn\",\"username\":\"matilda32\",\"email\":\"mosciski.tressa@example.com\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"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\":\"c11981bb-164b-3f42-980a-0a52ec94e497\",\"name\":\"Brady Bernhard\",\"username\":\"flakin\",\"email\":\"stracke.sally@example.org\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"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\",\"certification\":\"Example Certification\",\"crea\":\"Example Crea\",\"email\":\"user@example.com\",\"username\":\"grover.rohan\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"6e0e70b0-e568-3433-8116-61ba873844d8\"],\"roles\":[\"689c7c5c-8a97-3e1d-9cc4-1cf3323a8c08\"]}" }, "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\",\"certification\":\"Example Certification\",\"crea\":\"Example Crea\",\"email\":\"user@example.com\",\"username\":\"jmosciski\",\"password\":\"password123\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"eccb1387-7cae-309d-9c37-fcddf92f2b8e\"],\"roles\":[\"a20c2f16-e2b7-36c8-9917-7dd9442dc181\"]}" }, "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\":[\"cbac120b-225b-3f9d-87dc-52d1f45305d6\"]}" }, "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\":\"ad\",\"display_name\":\"Doloribus eligendi et ad cum consequatur.\"},{\"id\":null,\"name\":\"laboriosam\",\"display_name\":\"Enim sunt et quae provident culpa.\"}]}", "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\":\"0996bad9-ed9f-3530-8895-26f8e82a2df2\",\"description\":\"Sr. Alexandre da Cruz\",\"work\":{\"id\":null,\"name\":null},\"documents\":[],\"created_at\":null,\"updated_at\":null},{\"id\":\"83f7ebf2-c956-325a-a812-f8477144681d\",\"description\":\"Cristian Santiago Filho\",\"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\":\"c2956f09-ad3f-3832-a3d7-95497b42de42\"}" }, "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\":\"28e3bdc5-cc4c-38e3-a2d5-e833d0ac3a55\",\"description\":\"Matheus Saito Sobrinho\",\"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\":\"acffd96a-2634-38fd-b495-0cc2063cceb5\"}" }, "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\":\"1f7c5d5a-8e1b-3fce-a97f-c8c7e04a90c9\",\"name\":\"T\\u00e9o Heitor Duarte Jr.\",\"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,\"daily_logs_count\":0,\"projects_count\":0,\"started_at\":{\"date\":\"1981-04-10 09:11:33.000000\",\"timezone_type\":3,\"timezone\":\"America\\\/Sao_Paulo\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"6a56c7d4-4d3c-3ca5-9f09-0da492468639\",\"name\":\"Srta. Dayana Maia Neto\",\"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,\"daily_logs_count\":0,\"projects_count\":0,\"started_at\":{\"date\":\"2025-06-11 19:32:21.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\":\"26670cca-25d8-323d-a1f6-42fbde27e357\",\"status_id\":\"95579e39-83a2-32bf-8b28-c9a065501dc3\",\"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\":\"aa309841-bbae-30a6-b69d-10867b1c2c37\",\"name\":\"Giovana Azevedo Jr.\",\"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,\"daily_logs_count\":0,\"projects_count\":0,\"started_at\":{\"date\":\"1998-06-27 13:06:40.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\":\"1258a364-7da7-30b9-bc36-f9fe5528c63e\",\"status_id\":\"e574ab7f-72cd-3144-b348-d81a347b792f\",\"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\":\"4f50409a-a376-38ef-8e0f-66857a004e1c\",\"name\":\"Sandrine Nienow\",\"username\":\"prosacco.kasandra\",\"email\":\"desiree.effertz@example.com\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"8015d7d5-63f1-3a62-9f58-de7fc3099565\",\"name\":\"Prof. Irwin Lakin Sr.\",\"username\":\"missouri46\",\"email\":\"owill@example.com\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"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\":[\"c4494fb6-61bc-3ef6-8b35-f1361ef1d9d2\"]}" }, "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\":[\"7777ff91-891b-3235-aec6-8ee2313dcba4\"]}" }, "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\":[\"491d0f94-3c6e-392f-95db-98c265a94917\"]}" }, "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" } ] } }