{ "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": "8a9e36c5-5b3b-4471-b848-b95f3a306e9d", "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\":\"5ee9af7f-f27d-3562-ad9d-51d0b27fde97\",\"name\":\"ut-6ab3c7cfe723b\",\"display_name\":\"Incidunt soluta cum illum numquam non.\",\"permissions_count\":null},{\"id\":\"4c8b12bb-98b3-3439-983d-003d821a4d91\",\"name\":\"totam-6ab3c7cfeb667\",\"display_name\":\"Consequatur cupiditate totam totam in minus.\",\"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\":[\"1787ac69-ab5b-311c-bcd5-d3fbe652d3e6\"]}" }, "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\":[\"a5c93c2e-6be4-3ba7-aaf6-82ef7f887aa1\"]}" }, "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\":\"f03c2ad0-a21d-3c01-a55f-660f7f955d23\",\"name\":\"molestiae-6ab3c7d007826\",\"display_name\":\"Dicta quia suscipit vitae sapiente.\",\"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\":\"sapiente\",\"display_name\":\"Qui dolorem et et ex.\"},{\"id\":null,\"name\":\"dolor\",\"display_name\":\"Doloribus occaecati sapiente quos dolor.\"}]}", "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\":\"soluta\",\"display_name\":\"Nostrum ducimus nam quidem quas consequuntur quis beatae.\"},{\"id\":null,\"name\":\"aut\",\"display_name\":\"Quam eius est consectetur dolor eum consequatur.\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/acl\/permissions", "query": [], "raw": "{{baseUrl}}\/api\/acl\/permissions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"display_name\":\"Example Name\"}" }, "description": "Create a new permission." }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/acl\/permissions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/acl\/permissions\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the permission." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"display_name\":\"Example Name\"}" }, "description": "Update a permission." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Show", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/acl\/permissions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/acl\/permissions\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the permission." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a permission." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"name\":\"ut\",\"display_name\":\"Beatae earum voluptatibus recusandae voluptatem voluptatibus fuga blanditiis.\"}}", "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\":\"be99abeb-d62a-36fe-b9ee-5a51334472dd\",\"code\":null,\"type\":\"sa\\u00edda\",\"payment_method\":\"cheque\",\"amount\":9089.52,\"due_date\":\"2026-10-15T03: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 architecto odit aliquid iure corporis aut.\",\"is_recurring\":null,\"recurrence_config\":null,\"parent_id\":null,\"recurrence_order\":1,\"total_recurrences\":null,\"children_count\":0,\"remaining_recurrences\":null,\"has_children\":false,\"field1\":\"unde\",\"field2\":85,\"field3\":false,\"notes\":\"Aspernatur nostrum non dicta consequatur.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"b2b0151f-38e5-31e6-a337-0cbfeaa6e089\",\"code\":null,\"type\":\"sa\\u00edda\",\"payment_method\":\"boleto\",\"amount\":3110.53,\"due_date\":\"2026-10-12T03: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\":\"Eaque pariatur ratione iure ipsa amet id est est et et.\",\"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\":\"eaque\",\"field2\":57,\"field3\":false,\"notes\":\"Non sint odio sit.\",\"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": "quo", "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]=quo" }, "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": "doloremque", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "consequatur", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "eum", "description": "The uuid of an existing record in the works table.", "disabled": false }, { "key": "statuses[0]", "value": "a protestar", "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-09-23T09%3A36%3A32", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "protest_date_end", "value": "2026-09-23T09%3A36%3A32", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "has_protest", "value": "1", "description": "", "disabled": false }, { "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]=doloremque&suppliers[0]=consequatur&works[0]=eum&statuses[0]=a protestar&payment_method=cheque&date_start=2023-01-01&date_end=2023-12-31&protest_date_start=2026-09-23T09%3A36%3A32&protest_date_end=2026-09-23T09%3A36%3A32&has_protest=1&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\":\"65cafbf0-4789-3ae9-bccd-fb078200ab70\",\"code\":null,\"type\":\"sa\\u00edda\",\"payment_method\":\"cheque\",\"amount\":1879.75,\"due_date\":\"2026-10-14T03: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\":\"Facilis ipsum quis mollitia nihil eos occaecati ex modi expedita magni vel iure.\",\"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\":\"consequatur\",\"field2\":58,\"field3\":false,\"notes\":\"Ipsa qui consequatur nemo praesentium.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"44333011-6731-3e85-a333-21b2898355f1\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"boleto\",\"amount\":7326.11,\"due_date\":\"2026-10-11T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"protest_date\":null,\"paid_amount\":null,\"interest_amount\":null,\"penalty_amount\":null,\"notary_fee_amount\":null,\"description\":\"Consequatur porro accusamus qui vel non sed quos perferendis.\",\"is_recurring\":null,\"recurrence_config\":null,\"parent_id\":null,\"recurrence_order\":1,\"total_recurrences\":null,\"children_count\":0,\"remaining_recurrences\":null,\"has_children\":false,\"field1\":\"quisquam\",\"field2\":26,\"field3\":true,\"notes\":\"Qui deserunt ut fugiat et ut dolorem quod.\",\"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": "dolores", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "repellendus", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "id", "description": "The uuid of an existing record in the works 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-09-23T09%3A36%3A32", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "protest_date_end", "value": "2026-09-23T09%3A36%3A32", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "has_protest", "value": "1", "description": "", "disabled": false }, { "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]=dolores&suppliers[0]=repellendus&works[0]=id&statuses[0]=cancelado&payment_method=cheque&date_start=2023-01-01&date_end=2023-12-31&protest_date_start=2026-09-23T09%3A36%3A32&protest_date_end=2026-09-23T09%3A36%3A32&has_protest=1&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\":\"b7734f92-199e-3d78-ba29-8b76edf43eb7\",\"code\":null,\"type\":\"sa\\u00edda\",\"payment_method\":\"cheque\",\"amount\":4510.59,\"due_date\":\"2026-10-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\":\"Laboriosam dolore quaerat quibusdam saepe in dolorum commodi aliquid.\",\"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\":\"quas\",\"field2\":99,\"field3\":false,\"notes\":\"Eos voluptatibus et eaque exercitationem.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"9de65840-14c8-30fe-8e83-f82704483847\",\"code\":null,\"type\":\"sa\\u00edda\",\"payment_method\":\"boleto\",\"amount\":2981.13,\"due_date\":\"2026-10-22T03: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\":\"Labore omnis voluptatibus culpa harum quos qui in quis inventore vero.\",\"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\":\"ut\",\"field2\":99,\"field3\":false,\"notes\":\"Quaerat voluptas earum inventore qui pariatur.\",\"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\":\"6a8e007d-90f6-38e1-901b-2ac789f2a500\",\"customer_id\":\"65c01407-d7ac-3836-8290-305cc17cdf57\",\"work_id\":\"14913ec5-ebc5-3f28-94bd-39f501d3adee\",\"status\":\"Example Status\",\"protest_date\":\"2024-01-01\",\"bank_account_id\":\"0c17cb06-16d0-3e20-ac1f-c58c1991f86b\",\"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\":\"voluptatem\",\"installment_ids\":[\"dolor\"],\"payment_method\":\"cartao\",\"work_id\":\"architecto\"}" }, "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": "minima", "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": "voluptatem", "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\":\"389ae9c2-5f98-3de8-912b-1c5868173a5a\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"cheque\",\"amount\":1711.4,\"due_date\":\"2026-09-30T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"protest_date\":null,\"paid_amount\":null,\"interest_amount\":null,\"penalty_amount\":null,\"notary_fee_amount\":null,\"description\":\"Dolorem omnis assumenda et necessitatibus distinctio minus accusamus sapiente voluptate est aut.\",\"is_recurring\":null,\"recurrence_config\":null,\"parent_id\":null,\"recurrence_order\":1,\"total_recurrences\":null,\"children_count\":0,\"remaining_recurrences\":null,\"has_children\":false,\"field1\":\"sint\",\"field2\":35,\"field3\":false,\"notes\":\"Ad sapiente quibusdam atque ea perspiciatis.\",\"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": "saepe", "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\":\"026cb615-0704-3554-a6c7-056dfa6d0b54\",\"customer_id\":\"63af8081-4f0a-31e5-b5da-b2f4e5a42a96\",\"work_id\":\"57acc5eb-d90b-3308-a29c-b5f87927aede\",\"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\":\"7c84b07e-5ce0-3a49-9d10-fb93e40e2571\",\"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": "et", "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\":\"reichert.bo@example.com\",\"password\":\"password\"}" }, "description": "Login with email and password", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"token\":\"string\"}", "name": "" } ] }, { "name": "Me", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/user", "query": [], "raw": "{{baseUrl}}\/api\/auth\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the current user" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"3f72bfd9-2425-3bef-ab7d-f55e868d4414\",\"name\":\"Emie Littel Sr.\",\"username\":\"kiehn.oswaldo\",\"email\":\"celestine28@example.org\",\"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\":\"roslyn.considine\",\"password\":\"password123\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"c2f8da96-9882-3241-93bc-043dd6b594b1\"],\"roles\":[\"0cbbe412-965a-384f-908d-6ac661b013a5\"]}" }, "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\":\"qhhsyntnzpqnld\",\"value\":[]}" }, "description": "Set or update a user preference" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Preference saved successfully\"}", "name": "" } ] }, { "name": "Delete user preference", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/preferences\/:key", "query": [], "raw": "{{baseUrl}}\/api\/auth\/preferences\/:key", "variable": [ { "id": "key", "key": "key", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a specific user preference" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Preference deleted successfully\"}", "name": "" } ] }, { "name": "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": "reiciendis", "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": "5", "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": "3", "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\":\"9bd6e781-570c-3e4e-b842-b9fbca50ca02\",\"agency\":\"7144\",\"account\":\"4248441-1\",\"type\":\"caixa\",\"balance\":9960.6,\"holder_type\":\"pf\",\"alias\":\"aliquam\",\"limit\":3798.2,\"available_balance\":13758.8,\"used_limit\":0,\"available_limit\":3798.2,\"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\":\"0b2ee3d4-24ed-387d-be4c-4a0823c56605\",\"agency\":\"1221\",\"account\":\"6769627-5\",\"type\":\"poupan\\u00e7a\",\"balance\":3068.86,\"holder_type\":\"pj\",\"alias\":\"omnis\",\"limit\":80.8,\"available_balance\":3149.6600000000003,\"used_limit\":0,\"available_limit\":80.8,\"is_default\":null,\"default_payment_method\":null,\"bank\":{\"id\":null,\"name\":null,\"code\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"d4295ba6-3828-342c-ab8d-99f12668d7d5\",\"agency\":\"0605\",\"account\":\"7124665-9\",\"type\":\"corrente\",\"balance\":2957.36,\"holder_type\":\"pf\",\"alias\":\"voluptatem\",\"limit\":5215.82,\"available_balance\":8173.18,\"used_limit\":0,\"available_limit\":5215.82,\"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\":\"9052349-3\",\"bank_id\":\"388ae55b-8868-312d-95b7-dad948247925\",\"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": "20", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"agency\":\"Example Agency\",\"account\":\"7485772-9\",\"bank_id\":\"d667c5c7-4e78-303e-802d-a9becafef31e\",\"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": "5", "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\":\"9ad28b96-4f08-3768-a715-3d8edc0b91c6\",\"agency\":\"9023\",\"account\":\"9702209-2\",\"type\":\"corrente\",\"balance\":2654.13,\"holder_type\":\"pj\",\"alias\":\"et\",\"limit\":936.48,\"available_balance\":3590.61,\"used_limit\":0,\"available_limit\":936.48,\"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": "11", "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": "5", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"sort_by\":\"consequatur\",\"sort_desc\":true,\"page\":36,\"per_page\":13,\"q\":\"egitrpynkncy\",\"type\":\"tarifa\",\"date_start\":\"2026-09-23T09:36:32\",\"date_end\":\"2112-01-14\"}" }, "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": "3", "description": "" }, { "id": "bankStatement", "key": "bankStatement", "value": "molestiae", "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\":\"82f99776-e706-35da-89c7-e024e550be39\",\"name\":\"Vale e Marin\",\"code\":\"333\"},{\"id\":\"f68767ed-a170-3b02-b734-5c63ce2ba85a\",\"name\":\"Vale e Bezerra e Filhos\",\"code\":\"838\"}],\"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\":\"9b0e853c-a398-3290-b2e0-6ad1956ef854\",\"name\":\"Ramos Comercial Ltda.\",\"code\":\"34\"}}", "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": "Nemo+et+maxime+et+dolore+aut+ducimus+illum.", "description": "Description .", "disabled": false }, { "key": "categories[0]", "value": "ratione", "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": "autem", "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": "autem", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "qui", "description": "The uuid of an existing record in the works table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/cash-flows\/summary?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Salary&cash_session=uuid&type=entrada&description=Nemo+et+maxime+et+dolore+aut+ducimus+illum.&categories[0]=ratione&date_start=2021-01-01&date_end=2021-01-31&bank_accounts[0]=autem&customers[0]=et&suppliers[0]=autem&works[0]=qui" }, "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": "Doloremque+ipsam+quas+molestiae+aliquam+autem+repellat+inventore+non.", "description": "Description .", "disabled": false }, { "key": "categories[0]", "value": "deserunt", "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": "sit", "description": "The uuid of an existing record in the bank_accounts table.", "disabled": false }, { "key": "customers[0]", "value": "suscipit", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "eos", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "hic", "description": "The uuid of an existing record in the works table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/cash-flows?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Salary&cash_session=uuid&type=entrada&description=Doloremque+ipsam+quas+molestiae+aliquam+autem+repellat+inventore+non.&categories[0]=deserunt&date_start=2021-01-01&date_end=2021-01-31&bank_accounts[0]=sit&customers[0]=suscipit&suppliers[0]=eos&works[0]=hic" }, "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\":\"9f414796-603a-37d1-825b-b8e7b28b8068\",\"code\":\"FC-80034277\",\"type\":\"ajuste\",\"amount\":2426.61,\"description\":\"Autem iusto accusantium minima quidem.\",\"transaction_date\":\"2015-02-24T03:00:00.000000Z\",\"transaction_category\":{\"id\":null,\"name\":null,\"type\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"17b12e05-9e2a-33ba-ae0d-d318670e0036\",\"code\":\"FC-76582499\",\"type\":\"transfer\\u00eancia\",\"amount\":-73.9,\"description\":\"Et aut maiores enim dolores dignissimos.\",\"transaction_date\":\"1999-02-15T02: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\":\"dec922c1-2499-31e1-bcdd-7ad5de82ada1\",\"transaction_category_id\":\"424a88dc-057f-3edd-ad60-f12ec27869bb\",\"bank_account_id\":\"e0cede81-2a89-3549-8246-3a5b131b9696\",\"customer_id\":\"ecb7f91d-ded6-3c94-a772-920b8aa8a020\",\"supplier_id\":\"b0f16a09-e63d-3652-9444-0613efae0ff0\",\"work_id\":\"1b20dca2-1f3c-37e3-b071-1a7a544077c8\",\"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": "5", "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\":\"36e36816-322f-36fb-8bc7-8d9fb6c1aa15\",\"code\":\"FC-51321843\",\"type\":\"pagamento\",\"amount\":-4247.24,\"description\":\"Rem atque et corrupti consectetur.\",\"transaction_date\":\"1977-06-02T03:00:00.000000Z\",\"transaction_category\":{\"id\":null,\"name\":null,\"type\":null},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Update cash flow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-flows\/:cashFlow", "query": [], "raw": "{{baseUrl}}\/api\/cash-flows\/:cashFlow", "variable": [ { "id": "cashFlow", "key": "cashFlow", "value": "16", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"Example Type\",\"cash_session_id\":\"e5475903-6db1-3cc1-8391-805bcd7099bf\",\"transaction_category_id\":\"9b37c6b2-1e79-30a5-9c34-c85ef96e22d8\",\"bank_account_id\":\"17a3a88b-22f5-30ac-8f84-d4630cbd27ce\",\"customer_id\":\"6d4fb8e0-c415-3bdc-bb18-a0edd703606a\",\"supplier_id\":\"843241c8-c6a3-3d75-b18e-9e183a9b9ce0\",\"work_id\":\"f967869d-2660-333c-9b6c-b24de839e469\",\"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": "7", "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\":\"0fc32493-3538-313e-b14a-ea9c1fed1dc4\",\"code\":null,\"opened_by\":null,\"opened_at\":\"2000-12-26T08:23:07.000000Z\",\"closed_by\":null,\"closed_at\":\"2007-02-25T14:52:58.000000Z\",\"opening_balance\":334.79,\"closing_balance\":6282.1,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Fechado\",\"hasSnapshot\":false,\"created_at\":\"1981-12-07T12:37:20.000000Z\",\"updated_at\":\"1983-04-29T03:52:07.000000Z\"},{\"id\":\"82618c36-71ce-33f0-adb4-de1083eccd71\",\"code\":null,\"opened_by\":null,\"opened_at\":\"1992-04-07T09:40:31.000000Z\",\"closed_by\":null,\"closed_at\":\"2018-12-27T13:10:19.000000Z\",\"opening_balance\":2270.41,\"closing_balance\":3666.73,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Fechado\",\"hasSnapshot\":false,\"created_at\":\"1993-11-03T16:12:20.000000Z\",\"updated_at\":\"2013-02-08T21:57:09.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\":\"54bd5f00-268a-3858-9ab0-4820ea49c4ef\",\"code\":null,\"opened_by\":null,\"opened_at\":\"1973-07-22T07:21:53.000000Z\",\"closed_by\":null,\"closed_at\":\"2005-05-15T06:31:50.000000Z\",\"opening_balance\":9359.97,\"closing_balance\":3387.33,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Fechado\",\"hasSnapshot\":false,\"created_at\":\"1998-06-03T02:29:59.000000Z\",\"updated_at\":\"1984-09-22T14:48:12.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": "573458c5-59fb-3144-a65e-f4dc19752218", "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": "3da9ea96-5527-310a-a8f3-ce553a3a1706", "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": "b485da10-5e1f-37f2-afbb-00e8ce10c676", "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\":\"48342f7d-20ce-3026-ad2c-b094111b062f\",\"code\":null,\"opened_by\":null,\"opened_at\":\"2025-07-18T20:47:33.000000Z\",\"closed_by\":null,\"closed_at\":\"1970-05-28T18:03:36.000000Z\",\"opening_balance\":6484.68,\"closing_balance\":6631.82,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Fechado\",\"hasSnapshot\":false,\"created_at\":\"1984-03-12T19:46:36.000000Z\",\"updated_at\":\"1979-12-27T16:41:17.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": "27884682-efe5-3ef3-937b-09ef29a1d8b1", "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\":\"a064d3d2-5257-3574-a9e3-d9dd6af8f2d7\",\"name\":\"minima quibusdam\",\"slug\":null,\"abbreviation\":null,\"tutorials_count\":0},{\"id\":\"f3e0855d-4b7c-3c3f-93bf-cc860c13609c\",\"name\":\"ipsum ducimus\",\"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": "0d0b2983-5dc9-37a7-b729-a5acceb0eca5", "description": "Filtra os m\u00f3dulos pelos tutoriais de um setor, ou \"__geral__\" para o material sem setor marcado. O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the sectors table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/tutorials\/modules?sector_id=0d0b2983-5dc9-37a7-b729-a5acceb0eca5" }, "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\":\"59d3a3a2-5c90-3985-8c49-4a12d197169e\",\"name\":\"Aut nemo\",\"slug\":\"aut-nemo-155730\",\"description\":\"Aperiam magnam odit debitis omnis unde.\",\"sort_order\":0,\"is_active\":true,\"created_at\":null,\"updated_at\":null},{\"id\":\"8b488254-add4-3e4d-bbfd-b4a15b4a8a3c\",\"name\":\"Reprehenderit fuga\",\"slug\":\"reprehenderit-fuga-917718\",\"description\":\"Officiis rerum maiores modi neque sed.\",\"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", "value": "91f8fdf6-5c9d-3392-ac67-6a3dce0320ab", "description": "Filtra pelo UUID do m\u00f3dulo. 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": "beff7622-39ad-335c-8873-595490adbbcf", "description": "Filtra pelo UUID do setor, ou \"__geral__\" para o material sem setor marcado. O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the sectors table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/tutorials?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=ordem+de+servi%C3%A7o&module_id=91f8fdf6-5c9d-3392-ac67-6a3dce0320ab§or_id=beff7622-39ad-335c-8873-595490adbbcf" }, "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\":\"e4eeaa71-a5fb-35e3-8188-36e28ab36556\",\"title\":\"Ipsam in aut facere\",\"description\":\"Ad non voluptatum nulla accusantium.\",\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a2d092d2-8627-446b-886d-b5b3fa18eb85\",\"name\":\"Omnis odio\",\"slug\":\"omnis-odio-554674\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"7a5cf592-698e-3bcd-9542-44f8118bcb2b\",\"title\":\"Nemo blanditiis qui suscipit\",\"description\":\"Magnam nesciunt qui voluptatem adipisci.\",\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a2d092d2-8833-4e00-8fc0-d9e4abb5249d\",\"name\":\"Sint est\",\"slug\":\"sint-est-257464\"},\"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\":\"86b5c9e6-6009-3943-ac88-582d73e2acc5\",\"title\":\"Qui quod enim adipisci\",\"description\":\"Consequatur autem possimus assumenda.\",\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a2d092d2-8cc4-4a5e-b4d3-669f571f99f1\",\"name\":\"Inventore maxime\",\"slug\":\"inventore-maxime-377406\"},\"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\":\"0b53e2f8-7c31-30e8-8632-3f53c265f6fb\"}" }, "description": "List all work contracts" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"eb2c5e71-0b9a-303a-93a2-6661b5ed0440\",\"number\":\"885\\\/2026\",\"started_at\":\"2026-09-23\",\"deadline_at\":\"2027-09-23\",\"work\":{\"id\":\"a2d092c5-9c10-4aa0-83e2-db5b9a7fb025\",\"name\":\"Dr. Th\\u00e9o Jean Carmona\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"e83900df-e3a1-3a0a-95fc-253ff6d07820\",\"number\":\"128\\\/2026\",\"started_at\":\"2026-09-23\",\"deadline_at\":\"2027-09-23\",\"work\":{\"id\":\"a2d092c5-a546-4b5d-9149-17f9b18d60ce\",\"name\":\"Sr. Guilherme Rico Correia\"},\"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\":\"cce4e3aa-49f2-3e5f-99b9-60107ab00a7c\",\"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": "5", "description": "The ID of the contract." }, { "id": "contract", "key": "contract", "value": "praesentium", "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\":\"372e3597-11de-3e92-968f-bc9b446dfbdf\",\"number\":\"875\\\/2026\",\"started_at\":\"2026-09-23\",\"deadline_at\":\"2027-09-23\",\"work\":{\"id\":\"a2d092c5-b071-4835-962a-dc2911816e6a\",\"name\":\"Srta. Nat\\u00e1lia Quintana Pontes\"},\"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": "14", "description": "The ID of the contract." }, { "id": "contract", "key": "contract", "value": "aut", "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": "veritatis", "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": "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\":\"5093f8bf-2b95-3074-b6d2-d05ae2cd3123\",\"name\":\"F\\u00e1tima Vasques\",\"email\":\"carlos.delatorre@example.net\",\"phone\":\"(74) 96087-4182\",\"document\":\"703.528.706-05\",\"type\":\"pf\",\"responsible\":\"Samanta Cordeiro Estrada 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\":\"b1df8a6f-fbc7-3a7f-8bc6-1aeec4635750\",\"name\":\"Juliane Saraiva Neto\",\"email\":\"nramires@example.com\",\"phone\":\"(81) 3213-6783\",\"document\":\"462.254.838-02\",\"type\":\"pj\",\"responsible\":\"Eduardo Alves Reis Filho\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents_count\":0}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customers", "query": [], "raw": "{{baseUrl}}\/api\/customers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"email\":\"user@example.com\",\"phone\":\"(11) 99999-9999\",\"document\":\"Example Document\",\"type\":\"Example Type\",\"responsible\":\"Example Responsible\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"address\":{\"0\":\"example1\",\"1\":\"example2\",\"street\":\"Example Address street\",\"number\":\"Example Address number\",\"complement\":\"Example Address complement\",\"neighborhood\":\"Example Address neighborhood\",\"city\":\"Example Address city\",\"state\":\"Example Address state\",\"zip_code\":\"Example Address zip code\"}}" }, "description": "Create a new customer" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Get customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": "15", "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\":\"de706600-0b2f-3839-8c60-439dd1d59767\",\"name\":\"Srta. Carolina Antonella Dominato Jr.\",\"email\":\"odelgado@example.net\",\"phone\":\"(94) 3681-7032\",\"document\":\"931.246.194-04\",\"type\":\"pf\",\"responsible\":\"Priscila Quintana Bezerra Sobrinho\",\"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": "6", "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\":\"f7265748-a611-3638-a5f1-4afd0262a8cc\",\"contract_id\":\"3d9395d3-de43-3a82-91aa-1bc021528029\",\"status_id\":\"9416f9d0-89b6-3889-999f-dbdfc420b9ee\",\"filled_by\":\"0b0887d6-0255-34a7-b341-885aae6e4b20\",\"responsible_id\":\"0d8e2c6a-1fb2-36ed-9a99-e40896a6eeb1\",\"date_from\":\"2024-01-01\",\"date_to\":\"2024-01-01\"}" }, "description": "List all daily work reports (RDO)" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"45304d8f-ed90-3f95-a7c0-bd4b9ad08a10\",\"code\":\"RDO-23-09-26\",\"report_number\":1,\"date\":\"2026-09-23\",\"status\":{\"id\":\"a2d092c5-f420-4661-9426-c607fba8910b\",\"slug\":null,\"name\":null,\"abbreviation\":\"hic\",\"color\":\"#8acfe8\",\"text_color\":\"#f21501\"},\"work\":{\"id\":\"a2d092c5-e904-4567-84da-11129ece55b5\",\"name\":\"Ester Clarice Assun\\u00e7\\u00e3o\",\"started_at\":\"2020-02-21 01:54:41\"},\"filled_by\":{\"id\":\"a2d092c5-f052-45e9-94a2-f6e8f43f7f30\",\"name\":\"Ashley Koss\"},\"contract_number\":\"323\\\/2026\",\"deadline_at\":\"2027-09-23\",\"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\":\"63bae095-f96f-3e4e-a3d0-175e8e1490fc\",\"code\":\"RDO-23-09-26\",\"report_number\":1,\"date\":\"2026-09-23\",\"status\":{\"id\":\"a2d092c5-fd93-4207-897f-86dd1a74a73f\",\"slug\":null,\"name\":null,\"abbreviation\":\"nisi\",\"color\":\"#bbfa86\",\"text_color\":\"#af8f6a\"},\"work\":{\"id\":\"a2d092c5-f80f-4c3e-8538-27e2205ee1aa\",\"name\":\"Em\\u00edlia Pedrosa Galhardo\",\"started_at\":\"2009-06-26 20:31:02\"},\"filled_by\":{\"id\":\"a2d092c5-fc10-4e90-b314-fd45a430c353\",\"name\":\"Ms. Nyah Dicki DDS\"},\"contract_number\":\"172\\\/2026\",\"deadline_at\":\"2027-09-23\",\"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": "sit", "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\":\"7518600d-e0b7-3827-8a2f-4ae305e2efda\",\"code\":\"RDO-23-09-26\",\"report_number\":1,\"date\":\"2026-09-23\",\"status\":{\"id\":\"a2d092c6-0f47-4077-9b5e-a6e1aed2a657\",\"slug\":null,\"name\":null,\"abbreviation\":\"esse\",\"color\":\"#ccd227\",\"text_color\":\"#94d1d4\"},\"work\":{\"id\":\"a2d092c6-09db-45af-ac8e-26da6cf9bf2b\",\"name\":\"Paulo Grego Quintana\",\"started_at\":\"1982-03-04 23:48:20\"},\"filled_by\":{\"id\":\"a2d092c6-0dbe-4313-8846-c76ccfbae549\",\"name\":\"Dayna Greenholt Jr.\"},\"contract_number\":\"064\\\/2026\",\"deadline_at\":\"2027-09-23\",\"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\":\"f5b40f93-6f10-3a88-87e4-e69f0d670668\"}" }, "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": "possimus", "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\":\"7e7fe59e-5fcc-4804-9e4d-9fbfac5d17c3\",\"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": "nemo", "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": "pariatur", "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": "ullam", "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": "consequatur", "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": "exercitationem", "description": "Daily Log UUID" }, { "id": "id", "key": "id", "value": "aut", "description": "The ID of the photo." }, { "id": "photo", "key": "photo", "value": "veniam", "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": "enim", "description": "Daily Log UUID" }, { "id": "photo", "key": "photo", "value": "alias", "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": "quaerat", "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\":\"039066e3-2f2a-3c6d-b6f2-5e9c7beb98f4\",\"name\":\"In\",\"code\":\"LKG\",\"description\":\"Necessitatibus velit vel quia sed quasi in.\",\"active\":true},{\"id\":\"24cc5480-2899-3346-89ad-a83e9b89515e\",\"name\":\"Dolor\",\"code\":\"TRE\",\"description\":\"Perferendis cum omnis sit sit.\",\"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": "voluptas", "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\":\"44a18547-13f6-3920-861c-e80aa3ecc4af\",\"name\":\"Pariatur\",\"code\":\"ZDH\",\"description\":\"Ullam sit repellat ut consequatur error aut doloremque ut.\",\"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": "itaque", "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": "repellat", "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\":\"6c19832e-59de-3509-b0a4-6828f3e3423b\",\"name\":\"P\\u00e9rola da Silva Fidalgo\",\"description\":\"Aut ratione adipisci est ipsum id dignissimos. Laborum ex sequi quam rem velit quis. Impedit magnam earum laboriosam corporis.\",\"module\":\"document\"},{\"id\":\"7f25a5b8-f0b1-333d-99fe-b63d95099137\",\"name\":\"Noel Walter Vega Neto\",\"description\":\"Nam qui commodi reprehenderit corporis voluptatum. Ratione facere eum ea et tenetur sit. Modi inventore eos porro excepturi et. Quasi id occaecati cupiditate molestiae provident quas.\",\"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": "aut", "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\":\"bb468a36-8d74-3a2d-a438-524a203b5f08\",\"name\":\"Dr. Felipe Marinho Galindo Filho\",\"description\":\"Quis tenetur consequatur id nesciunt. Provident sunt aut dolore beatae. Ea delectus ipsa sit fugit.\",\"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": "ratione", "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": "aliquid", "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": "necessitatibus", "description": "The uuid of an existing record in the document_categories table.", "disabled": false }, { "key": "documentable_type", "value": "deleniti", "description": "Type of the related documentable entity. The type of an existing record in the documentables table.", "disabled": false }, { "key": "customers[0]", "value": "in", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "alias", "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]=necessitatibus&documentable_type=deleniti&customers[0]=in&suppliers[0]=alias" }, "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\":\"f56149ac-f28d-3fd0-a47f-b69cbd8e047e\",\"name\":\"Sr. Ivan Jer\\u00f4nimo Serrano\",\"file\":{\"id\":null,\"url\":null,\"extension\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"6f3f8241-d31d-3786-9409-84cb54a2b5a3\",\"name\":\"Srta. Flor Soares Jr.\",\"file\":{\"id\":null,\"url\":null,\"extension\":null},\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Get document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/documents\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the document." }, { "id": "document", "key": "document", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Document ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a document" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"23769cee-0431-3499-8ac4-669860e51922\",\"name\":\"Rosana Fidalgo Neto\",\"file\":{\"id\":null,\"url\":null,\"extension\":null},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents", "query": [], "raw": "{{baseUrl}}\/api\/documents" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"category_id\":\"8e7b2a85-a568-3a3e-9a92-942e6c7ca3ea\",\"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": "20", "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\":\"33681457-df1f-3ae2-8909-69aea77049e0\",\"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\":\"labore\",\"renewal_status\":\"completed\",\"urgency\":\"expires_7_days\",\"employee_id\":\"sint\",\"epi_type_id\":\"in\"}" }, "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": "quis", "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": "ut", "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": "incidunt", "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\":\"maiores\",\"stock_id\":\"quo\"}" }, "description": "List all EPI types" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"977c8652-cc52-3ef7-b39e-86a50f42a83a\",\"name\":\"aliquid rerum\",\"default_validity_days\":259,\"requires_signature\":false,\"numero_ca\":\"31481\",\"product\":null,\"available_quantity\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"17df819a-64cb-34d7-ab03-5302a9144b3e\",\"name\":\"exercitationem exercitationem\",\"default_validity_days\":222,\"requires_signature\":true,\"numero_ca\":\"35182\",\"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\":\"eum\",\"stock_id\":\"dolor\"}" }, "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": "libero", "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\":\"d59a9784-90ba-3d60-bc26-c221e95d5e1b\",\"name\":\"inventore atque\",\"default_validity_days\":260,\"requires_signature\":false,\"numero_ca\":\"12055\",\"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\":\"608924d3-a9c4-38f1-8a4e-6fce04f2b84e\",\"product_family_id\":\"511426cc-9223-3705-8a48-2bcba775ddba\"}" }, "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\":\"1a4e7c5d-5185-3751-b078-4ad440d0b7e3\",\"action\":\"Example Items * action\",\"product_id\":\"848f3e1a-152c-3a73-a3a0-e074dca8e877\",\"product_family_id\":\"7cb9f7e9-e496-385a-a167-dfdc4e0d9477\"},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": "omnis", "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\":\"47492f32-b8fd-34de-8074-4c2f1ea6dd40\",\"product_family_id\":\"a3b997da-d15d-3c6c-a286-345b53aeef79\"}" }, "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": "necessitatibus", "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": "dignissimos", "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\":\"27886550-7113-44e6-a323-d6292580ebe6\",\"name\":\"fuga\",\"description\":\"Aspernatur temporibus doloribus tenetur sapiente sed dolores sed.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"aa536ead-47b3-4b70-88fa-fbb512c85449\",\"name\":\"est\",\"description\":\"Rerum distinctio ut distinctio quia ut odio quis.\",\"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": "incidunt", "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\":\"40396db3-d17e-419e-b34a-e07d80199292\",\"name\":\"doloremque\",\"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": "nisi", "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": "eum", "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\":69,\"per_page\":4,\"q\":\"dolores\",\"employee_id\":\"sequi\",\"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": "qui", "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]=qui&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\":\"87656e6a-86e3-4bcf-a887-6f5929e5ab20\",\"name\":\"Paola Carla Paz Neto\",\"cpf\":\"068.241.827-00\",\"rg\":null,\"ctps\":null,\"phone\":null,\"birthdate\":null,\"email\":\"marcelo96@example.net\",\"pis_pasep\":null,\"admission_date\":\"2009-02-14\",\"daily_salary\":\"91.45\",\"monthly_salary\":null,\"nationality\":null,\"place_of_birth\":\"Paulo do Leste\",\"status\":\"active\",\"status_label\":\"Ativo\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":\"a2d092c6-addd-4410-b826-60a156bcfad0\",\"name\":\"impedit\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"8354f179-e4b5-4acc-826b-28fe84a3c080\",\"name\":\"Sr. Ronaldo Diogo Saraiva Jr.\",\"cpf\":\"845.884.780-75\",\"rg\":null,\"ctps\":null,\"phone\":\"(69) 99049-4142\",\"birthdate\":null,\"email\":null,\"pis_pasep\":null,\"admission_date\":\"1981-12-16\",\"daily_salary\":\"69.55\",\"monthly_salary\":\"9530.28\",\"nationality\":null,\"place_of_birth\":\"Queir\\u00f3s do Leste\",\"status\":\"active\",\"status_label\":\"Ativo\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":\"a2d092c6-b266-4e83-ade6-2f735ad7a795\",\"name\":\"nisi\"},\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":\"\\\/?page=68\",\"next\":null},\"meta\":{\"current_page\":69,\"from\":681,\"last_page\":1,\"links\":[{\"url\":\"\\\/?page=68\",\"label\":\"« Anterior\",\"page\":68,\"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\":682,\"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": "consequuntur", "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]=consequuntur&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": "3", "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\":\"879a7a61-bdf2-4d5e-a549-f4e7010de0cf\",\"name\":\"Raphael Campos Filho\",\"cpf\":\"564.840.361-85\",\"rg\":\"645847717\",\"ctps\":\"536981911\",\"phone\":\"(46) 4012-8653\",\"birthdate\":null,\"email\":\"vieira.gabrielle@example.net\",\"pis_pasep\":\"51209321095\",\"admission_date\":\"2009-02-25\",\"daily_salary\":null,\"monthly_salary\":null,\"nationality\":\"Nova Guin\\u00e9\",\"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\":\"a2d092c6-c5d7-45a7-abd0-9eccbe2387e0\",\"name\":\"nesciunt\"},\"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\":\"8355134e-749b-4bef-83da-6ad7ee7dbcd0\",\"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\":\"646303f2-0c7f-4ebd-841c-b9677d29d890\",\"name\":\"Emanuelly Ferminiano Filho\",\"cpf\":\"771.518.819-45\",\"rg\":null,\"ctps\":null,\"phone\":null,\"birthdate\":null,\"email\":\"suelen49@example.com\",\"pis_pasep\":\"89491124744\",\"admission_date\":\"2014-08-24\",\"daily_salary\":\"71.23\",\"monthly_salary\":null,\"nationality\":null,\"place_of_birth\":\"Solano do Leste\",\"status\":\"active\",\"status_label\":\"Ativo\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":\"a2d092c6-cfa6-4ba9-b501-e6174c4a5e98\",\"name\":\"quaerat\"},\"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": "14", "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\":\"242faba4-0bf8-48bf-b20f-5404700d6dda\",\"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-09-23\",\"dismissal_reason\":\"resignation\"}" }, "description": "Register the dismissal of an active employee" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"7efe67a8-6175-4c17-83ed-7c726ca8c110\",\"name\":\"Noa \\u00c1vila\",\"cpf\":\"205.117.363-73\",\"rg\":\"848154376\",\"ctps\":\"128918669\",\"phone\":null,\"birthdate\":\"2026-06-24\",\"email\":\"abarros@example.org\",\"pis_pasep\":null,\"admission_date\":\"2011-04-18\",\"daily_salary\":\"133.26\",\"monthly_salary\":\"8986.53\",\"nationality\":null,\"place_of_birth\":\"Porto Filipe do Norte\",\"status\":\"active\",\"status_label\":\"Ativo\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":\"a2d092c6-dfec-4275-9190-8876dce1b13f\",\"name\":\"quidem\"},\"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-09-23\"}" }, "description": "Rehire an inactive employee with a new admission date" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"657c6acf-afee-41ec-95c6-04c96c311ada\",\"name\":\"Juliana Prado Valentin Sobrinho\",\"cpf\":\"089.163.385-77\",\"rg\":null,\"ctps\":\"608641871\",\"phone\":\"(45) 2328-8016\",\"birthdate\":\"1985-01-07\",\"email\":\"alicia55@example.net\",\"pis_pasep\":null,\"admission_date\":\"2010-06-08\",\"daily_salary\":\"287.73\",\"monthly_salary\":null,\"nationality\":\"Chile\",\"place_of_birth\":\"Martinho do Leste\",\"status\":\"active\",\"status_label\":\"Ativo\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":\"a2d092c6-e803-47fd-86b6-32e6dcd095ae\",\"name\":\"et\"},\"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": "3", "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": "12", "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\":\"voluptas\",\"agency\":\"ykjbauwkqexvgnmlxnsiusugo\",\"account\":\"oebtzbe\",\"account_type\":\"corrente\",\"pix_key\":\"sdloujbzlyzdzfncpudjdbc\",\"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": "16", "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\":\"consequatur\",\"agency\":\"lpwjdwcsxzacfqxh\",\"account\":\"tajugajsqbgsbmwnpdvp\",\"account_type\":\"corrente\",\"pix_key\":\"e\",\"favorite\":false}" }, "description": "Update a bank account for an employee" }, "response": [] }, { "name": "Delete employee bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee\/bank-account\/:id", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee\/bank-account\/:id", "variable": [ { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee UUID" }, { "id": "id", "key": "id", "value": "019556e7-2e9f-777c-a177-30bbf0646c33", "description": "Bank account UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a bank account from an employee" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "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": "fugit", "description": "Employee UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"q\":\"quia\",\"status\":\"expiring\",\"epi_type_id\":\"qui\"}" }, "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": "rem", "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": "17", "description": "The ID of the employee." }, { "id": "id", "key": "id", "value": "dolor", "description": "EPI delivery UUID" }, { "id": "employee", "key": "employee", "value": "qui", "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": "16", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "inventore", "description": "Employee UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"epi_type_id\":\"04ad3619-d876-3ee7-8be1-c3f1e5728c1d\",\"delivery_date\":\"2024-01-01\",\"quantity\":1,\"condition\":\"Example Condition\",\"delivered_by_employee_id\":\"d6f68773-6cec-448f-a03a-5842d98037f0\",\"stock_id\":\"18149321-23af-30cd-b55e-2f54507e0928\",\"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": "dolore", "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\":\"8f36bac8-7998-4437-8ebb-adf32d1d0cfe\",\"stock_id\":\"7c87b8ad-3c96-3946-8f8b-e626a6d9ca65\",\"confirm_insufficient_stock\":true,\"items\":[{\"epi_type_id\":\"f665774b-0f59-3b43-bda0-7e07fe3ed91a\",\"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": "ut", "description": "Employee UUID" }, { "id": "id", "key": "id", "value": "hic", "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": "5", "description": "The ID of the employee." }, { "id": "id", "key": "id", "value": "et", "description": "EPI delivery UUID" }, { "id": "employee", "key": "employee", "value": "perspiciatis", "description": "Employee UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"epi_type_id\":\"d4b1b727-e1ab-34f9-91fe-b32a9c4b1f25\",\"delivery_date\":\"2024-01-01\",\"quantity\":1,\"condition\":\"Example Condition\",\"delivered_by_employee_id\":\"16a1ad87-9522-4cfc-ae93-73cb18f2a1b3\",\"stock_id\":\"135851c4-be1d-3e54-87e8-47e7a1ea1f41\",\"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": "assumenda", "description": "Employee UUID" }, { "id": "id", "key": "id", "value": "aliquid", "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": "3", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "est", "description": "Employee UUID" } ] }, "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\":12,\"per_page\":14,\"q\":\"facilis\",\"employee_id\":\"corporis\",\"has_term\":false}" }, "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": "atque", "description": "Employee UUID" }, { "id": "kitUuid", "key": "kitUuid", "value": "4f44596d-a935-34b5-8ab6-35a6f62dcb88", "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": "voluptatibus", "description": "Employee UUID" }, { "id": "kitUuid", "key": "kitUuid", "value": "759c4351-900a-3123-9ecc-dcac62f4fb7c", "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": "8bba2f93-c5a6-3d17-851c-01fd03815048", "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": "5fbf5f83-2170-3dc2-bcba-3579f61495e6", "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": "378200c8-e0f3-3e44-ae45-51ab3817a4f1", "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\":\"dolores\",\"document_type\":\"nfe\",\"supplier_id\":\"laborum\",\"work_id\":\"eum\",\"start_date\":\"2026-09-23T09:36:35\",\"end_date\":\"2110-05-05\",\"per_page\":18}" }, "description": "Lista notas fiscais com filtros por busca, fornecedor, obra e per\u00edodo." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"2c93098f-7866-3f21-927a-324cad5bbc50\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"04638366620555786251637862222849201300485959\",\"nfe_number\":\"080046\",\"nfe_series\":\"00\",\"issue_date\":\"2011-03-17T03:00:00.000000Z\",\"total_value\":\"9395.33\",\"emit\":{\"cnpj\":\"25596553337627\",\"name\":\"Kerluke-Bosco\"},\"dest\":{\"document\":\"14261629090538\",\"name\":\"Pfannerstill PLC\"},\"supplier\":{\"id\":\"a2d092c8-8470-4ea4-8149-0f023d33c18e\",\"name\":\"Sra. Graziela Lara Sandoval\",\"document\":\"04.136.520\\\/0001-87\"},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null},{\"id\":\"84335b01-aa7e-398c-819c-3371acc6d45b\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"72949639969769657642309749892133587912792594\",\"nfe_number\":\"675541\",\"nfe_series\":\"28\",\"issue_date\":\"2015-08-13T03:00:00.000000Z\",\"total_value\":\"3596.29\",\"emit\":{\"cnpj\":\"42616730581182\",\"name\":\"Dickinson-Doyle\"},\"dest\":{\"document\":\"12185619061849\",\"name\":\"Parisian LLC\"},\"supplier\":{\"id\":\"a2d092c8-89c9-47f2-870a-d3c8407109f1\",\"name\":\"Dr. Daniel Toledo Filho\",\"document\":\"88.075.850\\\/0001-08\"},\"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\":\"quasi\",\"original_filename\":\".xml$\\\/i\",\"work_ids\":[\"dolor\"]}" }, "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\":\"3d19562d-3e61-3f67-9169-0375e2fc654d\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"18076026846351374667357315827247880976889266\",\"nfe_number\":\"698422\",\"nfe_series\":\"31\",\"issue_date\":\"1985-04-02T03:00:00.000000Z\",\"total_value\":\"191.41\",\"emit\":{\"cnpj\":\"84713885452432\",\"name\":\"Hermiston, Spencer and Bergnaum\"},\"dest\":{\"document\":\"47034820017567\",\"name\":\"Mraz Ltd\"},\"supplier\":{\"id\":\"a2d092c8-9b0c-4dd7-81b2-fb905ac9718c\",\"name\":\"Dr. Fabiano Gusm\\u00e3o Neto\",\"document\":\"26.285.389\\\/0001-52\"},\"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": "natus", "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\":\"c41965b4-7a16-3dc8-9a0a-70cf01e23b1c\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"07607354157555169385590387921478529626089472\",\"nfe_number\":\"461778\",\"nfe_series\":\"77\",\"issue_date\":\"2026-05-09T03:00:00.000000Z\",\"total_value\":\"3234.93\",\"emit\":{\"cnpj\":\"71273871757633\",\"name\":\"Paucek-Kilback\"},\"dest\":{\"document\":\"84336125079152\",\"name\":\"Schumm-Ratke\"},\"supplier\":{\"id\":\"a2d092c8-a424-428b-beb2-f9e57963dc50\",\"name\":\"Ellen Cristina Marin\",\"document\":\"60.605.832\\\/0001-63\"},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null}}", "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": "enim", "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": "deserunt", "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\":\"quisquam\",\"name\":\"rerum\",\"extension\":\"et\"}}" }, "description": "Anexa um arquivo (ex.: PDF da NF) j\u00e1 enviado ao S3 \u00e0 nota fiscal." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"fd10065e-4880-3f7b-bb4e-e4d551e1e404\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"34370383351674465593973302114245722789633064\",\"nfe_number\":\"332101\",\"nfe_series\":\"78\",\"issue_date\":\"1982-04-28T03:00:00.000000Z\",\"total_value\":\"3931.48\",\"emit\":{\"cnpj\":\"00422249754979\",\"name\":\"Stiedemann Inc\"},\"dest\":{\"document\":\"95350817827502\",\"name\":\"Bednar Group\"},\"supplier\":{\"id\":\"a2d092c8-b19d-46cb-9ea6-3d8478bdcf7d\",\"name\":\"Dr. Miranda Galindo Salgado Sobrinho\",\"document\":\"14.945.822\\\/0001-50\"},\"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": "corporis", "description": "UUID da nota fiscal" }, { "id": "file", "key": "file", "value": "est", "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\":\"a4cc5917-e696-3e1b-a03e-d463a087df17\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"34966518755256429647652023386613639741018863\",\"nfe_number\":\"106070\",\"nfe_series\":\"65\",\"issue_date\":\"2007-09-03T03:00:00.000000Z\",\"total_value\":\"7520.96\",\"emit\":{\"cnpj\":\"04601418874413\",\"name\":\"Gerhold Ltd\"},\"dest\":{\"document\":\"84449296436645\",\"name\":\"Walsh-Deckow\"},\"supplier\":{\"id\":\"a2d092c8-baa0-4afc-8ec9-960ba652875c\",\"name\":\"Dr. Eunice Vieira Vieira Filho\",\"document\":\"56.863.326\\\/0001-05\"},\"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": "nihil", "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\":[\"nam\"]}" }, "description": "Sincroniza o v\u00ednculo documental da nota fiscal com N obras." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"bf8da4c2-ce16-3e15-8f8d-cdcf77a5ed13\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"53748647990406368380157897991422238917076393\",\"nfe_number\":\"770392\",\"nfe_series\":\"45\",\"issue_date\":\"1977-12-13T03:00:00.000000Z\",\"total_value\":\"417.58\",\"emit\":{\"cnpj\":\"57434474950865\",\"name\":\"Pollich Ltd\"},\"dest\":{\"document\":\"08334009377836\",\"name\":\"Friesen-Keebler\"},\"supplier\":{\"id\":\"a2d092c8-c368-47b0-8d3a-f7212b738755\",\"name\":\"Dr. Eunice Valdez Sobrinho\",\"document\":\"01.247.473\\\/0001-50\"},\"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": "quod", "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\":\"840fa3b5-e506-3ede-85c6-7580cfddfd5a\",\"document_type\":\"nfe\",\"document_type_label\":\"NF-e\",\"service_description\":null,\"nfe_access_key\":\"21834293979215000928117602958267063287770411\",\"nfe_number\":\"293234\",\"nfe_series\":\"97\",\"issue_date\":\"2025-07-13T03:00:00.000000Z\",\"total_value\":\"2859.59\",\"emit\":{\"cnpj\":\"24061442130483\",\"name\":\"Gulgowski, DuBuque and Champlin\"},\"dest\":{\"document\":\"05221824426984\",\"name\":\"Reichel Inc\"},\"supplier\":{\"id\":\"a2d092c8-cd9b-445b-a644-8dfc1217eb40\",\"name\":\"Dr. Sueli Gisela Mendon\\u00e7a Sobrinho\",\"document\":\"42.504.889\\\/0001-94\"},\"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\":\"d4f6a3fd-9b64-3f61-9ed3-07de21f0464a\"}" }, "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": "dignissimos", "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 \"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": "blanditiis", "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": "neque", "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": "est", "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": "amet", "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\":\"aut\",\"sort_desc\":false,\"page\":14,\"per_page\":5}" }, "description": "List all states paginated" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"name\":\"nihil eveniet\",\"abbreviation\":\"ON\"},{\"id\":null,\"name\":\"saepe dolorum\",\"abbreviation\":\"DJ\"}],\"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\":\"Andersonstad\"},{\"id\":null,\"name\":\"Ashleyhaven\"}]}", "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": "dolores", "description": "", "disabled": false }, { "key": "document", "value": "est", "description": "", "disabled": false }, { "key": "work_id", "value": "a01edd80-bf3e-40f7-8613-ccb4be5831b3", "description": "Filter by work UUID. O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the works table.", "disabled": false }, { "key": "bank_account_id", "value": "a01edd80-bf3e-40f7-8613-ccb4be5831b3", "description": "Filter by bank account UUID. O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the bank_accounts table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/payment-receipts?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Jo%C3%A3o+Silva&employee_id=a01edd80-bf3e-40f7-8613-ccb4be5831b3&receiver_type=employee&start_date=2025-01-01&end_date=2025-12-31&min_amount=100&max_amount=1000&payment_method=PIX&city=S%C3%A3o+Paulo&search=dolores&document=est&work_id=a01edd80-bf3e-40f7-8613-ccb4be5831b3&bank_account_id=a01edd80-bf3e-40f7-8613-ccb4be5831b3" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all payment receipts with filters" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"44536f68-982b-3574-a7ca-ecdc52dcd6e3\",\"receipt_number\":\"REC-2562\",\"receiver_type\":\"employee\",\"receiver\":{\"id\":null,\"name\":\"Andrew Will\",\"document\":\"107.811.644-43\"},\"payment\":{\"amount\":9883.18,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"pix\",\"description\":\"Excepturi quisquam optio incidunt quis aliquam quo ut sapiente.\"},\"issuer\":{\"name\":\"Pagac-Dare\",\"document\":\"91.785.425\\\/2179-49\"},\"issue\":{\"date\":\"2026-09-04\",\"city\":\"Port Penelope\",\"state\":\"CE\"},\"created_by\":{\"id\":\"a2d092c9-01b4-41ce-a804-ea4acd819c5f\",\"name\":\"Alice Hahn\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"fb81971a-1195-3649-a264-e9cf8d529312\",\"receipt_number\":\"REC-7975\",\"receiver_type\":\"employee\",\"receiver\":{\"id\":null,\"name\":\"Prof. Adriel Durgan IV\",\"document\":\"723.827.768-91\"},\"payment\":{\"amount\":8196.17,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"cash\",\"description\":\"Voluptatibus explicabo vero deserunt cum reprehenderit repellat officia.\"},\"issuer\":{\"name\":\"Simonis, Lynch and Schaefer\",\"document\":\"64.499.584\\\/9866-28\"},\"issue\":{\"date\":\"2026-08-31\",\"city\":\"Penelopeburgh\",\"state\":\"MG\"},\"created_by\":{\"id\":\"a2d092c9-051a-4d1c-a6f8-e260359f2a41\",\"name\":\"Prof. Dedric Stokes PhD\"},\"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": "nulla", "description": "", "disabled": false }, { "key": "document", "value": "et", "description": "", "disabled": false }, { "key": "work_id", "value": "a01edd80-bf3e-40f7-8613-ccb4be5831b3", "description": "Filter by work UUID. O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the works table.", "disabled": false }, { "key": "bank_account_id", "value": "a01edd80-bf3e-40f7-8613-ccb4be5831b3", "description": "Filter by bank account UUID. O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the bank_accounts table.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/payment-receipts\/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=nulla&document=et&work_id=a01edd80-bf3e-40f7-8613-ccb4be5831b3&bank_account_id=a01edd80-bf3e-40f7-8613-ccb4be5831b3" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "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\":\"pix\",\"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\":\"0e54d123-0485-3411-b2e6-3f2608004626\",\"receipt_number\":\"REC-5405\",\"receiver_type\":\"employee\",\"receiver\":{\"id\":null,\"name\":\"Dr. Herman Weber\",\"document\":\"373.550.751-11\"},\"payment\":{\"amount\":9372.22,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"bank_transfer\",\"description\":\"Ullam voluptatem consequatur illum doloribus corporis accusamus esse.\"},\"issuer\":{\"name\":\"Hahn, Ondricka and Bailey\",\"document\":\"69.870.471\\\/7941-76\"},\"issue\":{\"date\":\"2026-09-01\",\"city\":\"West Alichester\",\"state\":\"BA\"},\"created_by\":{\"id\":\"a2d092c9-215e-4f21-9568-1c16ae279de1\",\"name\":\"Mrs. Alexandrine Johns\"},\"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\":\"99687392-d5ce-4e78-83db-2c058f284ed9\",\"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\":\"0f251921-d3ad-3f1b-973d-ee5d77175647\",\"bank_account_id\":\"f58f3889-e66e-3744-bca7-f2d5990cd9cd\"}" }, "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\":\"e558d584-9aad-4717-b254-4a250624adc7\",\"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\":\"78db6409-4771-3f6e-a456-d47079873920\",\"bank_account_id\":\"27a656d2-2e7c-3b48-a6da-cd3a8c516e12\"}" }, "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\":\"c58cc5d6-2d23-3f39-922b-2ef02552968b\",\"receipt_number\":\"REC-3561\",\"receiver_type\":\"custom\",\"receiver\":{\"id\":null,\"name\":\"Evalyn Prosacco Jr.\",\"document\":\"407.404.724-09\"},\"payment\":{\"amount\":8851.16,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"check\",\"description\":\"Totam veritatis cumque fuga quia quaerat dolor.\"},\"issuer\":{\"name\":\"Kerluke-Reinger\",\"document\":\"10.884.954\\\/0570-40\"},\"issue\":{\"date\":\"2026-09-02\",\"city\":\"Maurineport\",\"state\":\"RS\"},\"created_by\":{\"id\":\"a2d092c9-42e1-4856-a8a7-4ab7dfc7df51\",\"name\":\"Kaylah Mosciski\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"dc49fdf8-e4e4-33e6-a61f-be976379ee24\",\"receipt_number\":\"REC-8986\",\"receiver_type\":\"custom\",\"receiver\":{\"id\":null,\"name\":\"Jazmyn Kiehn PhD\",\"document\":\"559.161.997-32\"},\"payment\":{\"amount\":2796.94,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"check\",\"description\":\"Voluptas neque earum tempore facere facilis.\"},\"issuer\":{\"name\":\"Sauer-Grady\",\"document\":\"57.156.969\\\/2225-38\"},\"issue\":{\"date\":\"2026-08-29\",\"city\":\"East Maurice\",\"state\":\"SC\"},\"created_by\":{\"id\":\"a2d092c9-4508-4273-bf35-5bbcee393fea\",\"name\":\"Augustine Gutmann\"},\"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\":\"f184d7d1-d2fb-3486-ac80-9cfdf2c53164\",\"name\":\"consequuntur\",\"display_name\":\"Quo et aliquid dolorem odio.\"},{\"id\":\"ffafa2da-74c5-3c59-a348-e3fc3dc3f5d5\",\"name\":\"harum\",\"display_name\":\"Rem amet et et est.\"}],\"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\":\"0394d163-4ed1-3022-8a3e-a52cd480ca8c\",\"name\":\"nulla-unde-cupiditate\",\"display_name\":\"unde architecto impedit\",\"created_at\":null,\"updated_at\":null},{\"id\":\"92817cb0-70aa-36b9-817b-2efd7075e269\",\"name\":\"non-aut\",\"display_name\":\"corrupti id sed\",\"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\":\"3300ee0f-3c17-395c-9292-6c23deb32e00\",\"name\":\"qui-necessitatibus\",\"display_name\":\"qui dolorem beatae\",\"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\":[\"326e0f4d-cbe1-3d0b-96c0-2ead5123e0ea\"]}" }, "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\":\"2347690e-3a92-381c-82fe-5bb5967659dc\",\"name\":\"et-voluptatum\",\"display_name\":\"incidunt nesciunt soluta\",\"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\":[\"eddb0574-1e04-355e-ad34-9a251b077e90\"]}" }, "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\":\"b0c87fd5-953c-3a01-baa0-6a4306fdb5a7\",\"name\":\"nobis-tempora-perferendis\",\"display_name\":\"quae labore illo\",\"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\":\"38eb12da-b350-3ab1-8c2c-9f15400332e7\",\"name\":\"Heitor Padr\\u00e3o Neto\",\"created_at\":null,\"updated_at\":null},{\"id\":\"1a5a4150-0cd9-3708-b982-ad6b0f1ebcfc\",\"name\":\"Dr. Daiane Karine Quintana\",\"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": "et", "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\":\"89fe69c8-6ab2-3220-9c03-bafbe5c45ef0\",\"name\":\"Srta. Tainara Galhardo Ferraz Sobrinho\",\"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": "porro", "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": "aut", "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\":\"f568109a-8143-399f-8463-0b6b135b2d60\",\"name\":\"Sr. Nelson Dante de Arruda\",\"is_epi\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"0a70f620-791b-358f-b929-d08f04f7aa3d\",\"name\":\"Srta. Heloise Ayla Fernandes\",\"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": "nobis", "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\":\"087eac34-a0ef-390e-9f38-5e8758cb6406\",\"name\":\"Betina Pacheco 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": "aut", "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": "vel", "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\":\"97bf8b83-68eb-3534-af52-eb28c086a299\",\"user_id\":\"6d9850d8-7914-354b-a629-8af8a5abeb51\",\"responsible_id\":\"53478844-d7b9-3b0e-8b80-b9441ab04c41\",\"per_page\":1,\"sort\":\"Example Sort\",\"sort_desc\":true}" }, "description": "List all product quantity lists" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"945edc19-0454-32f6-89f7-dc017db967ef\",\"name\":\"Voluptas qui minus est.\",\"description\":null,\"work\":{\"id\":\"a2d092c9-dd4d-494e-bcfb-df7c7be6cf17\",\"name\":\"Marta Bezerra\"},\"user\":{\"id\":\"a2d092c9-e1a0-407a-905e-e8ebd47f9978\",\"name\":\"Danyka Hickle\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"96c0e40f-0ae1-3a1a-ab50-b678cc50b4ec\",\"name\":\"Velit ea quasi error.\",\"description\":\"Consequatur corrupti natus aut nostrum. Alias recusandae eveniet minus. Dolores deleniti nihil dolorem quae sunt. Ad fugit est consequatur modi saepe.\",\"work\":{\"id\":\"a2d092c9-e623-4e94-9393-f84090692b04\",\"name\":\"Antonieta Lozano\"},\"user\":{\"id\":\"a2d092c9-e902-41f4-b845-37d6c92d8dd6\",\"name\":\"Jamal Hansen V\"},\"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": "nemo", "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\":\"283b4750-62d4-31fa-a02c-6996214b59da\",\"name\":\"Officiis consectetur.\",\"description\":\"Deleniti rem nesciunt blanditiis voluptas nostrum nemo. Cum occaecati consequatur totam expedita repellendus. Voluptate qui deleniti reiciendis quo et perspiciatis. Aut quasi veniam molestiae ut necessitatibus omnis.\",\"work\":{\"id\":\"a2d092c9-f1e7-4921-a695-f91ebc31b97a\",\"name\":\"Fabiano Rezende Rios\"},\"user\":{\"id\":\"a2d092c9-f534-42fb-8366-2ab33c015e74\",\"name\":\"Desmond Wunsch Sr.\"},\"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": "cum", "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\":\"8e4d010a-2ae2-33d1-94a3-32cea1c39be0\",\"product\":{\"id\":\"a2d092ca-15c1-4cd0-8a20-9b76d46add14\",\"name\":\"Fl\\u00e1vio Serra\",\"code\":\"PRD-341013\",\"unit\":{\"id\":\"a2d092ca-1339-43e6-b6d9-eb2838f3b64a\",\"name\":\"Sr. Thiago Andr\\u00e9 Roque\",\"abbreviation\":\"Ingrid Laiane de Souza\"}},\"quantity\":152.8613,\"observation\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"78562933-bf84-34f6-aae8-10fabf9450d8\",\"product\":{\"id\":\"a2d092ca-2885-4788-8714-4ad6d418f612\",\"name\":\"Kamila Maiara Feliciano Neto\",\"code\":\"PRD-203166\",\"unit\":{\"id\":\"a2d092ca-26d3-40c5-a358-cd1d264281c1\",\"name\":\"Alessandro \\u00c1vila Vieira\",\"abbreviation\":\"Dr. Analu God\\u00f3i\"}},\"quantity\":355.5236,\"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\":\"31088112-7654-328d-b5c3-8f2e057d7deb\",\"items\":[{\"product_id\":\"21256181-6f4b-36de-8b14-f4d5f26fc489\",\"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": "qui", "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\":\"ee52bee7-bf1d-3f43-9d88-718fd5e194b9\",\"product_id\":\"7202bb56-62d9-38de-8249-5c3d379f66c7\",\"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": "nulla", "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": "ratione", "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\":\"61684f25-c7e5-39a4-b06c-a962c82d997f\",\"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": "fugiat", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "beatae", "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": "nihil", "description": "Product Quantity List UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[\"c0582b5c-3972-38c1-8417-0014d8d4b974\"]}" }, "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": "voluptatem", "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\":\"af03c64a-1587-38d1-9b16-aac9449b615f\",\"product_id\":\"c1bc086d-8e1c-3d6b-ba4d-df2c8be95c26\",\"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": "repellendus", "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\":\"26bc3af5-e117-363e-9408-37a5be022320\",\"quantity\":1,\"source_stock_id\":\"cb9bad58-acf2-3a37-bbdd-34cd99d17c93\",\"reason\":\"Example Reason\",\"origins\":[{\"supplier_product_id\":\"7078b2ad-050a-3514-9398-f3ba523aa601\",\"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": "et", "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\":\"23cf8548-c359-3333-8454-b6ec3b0a9cf0\",\"quantity\":30.7904,\"fulfilled_at\":\"2026-09-14T07:22:39.000000Z\",\"created_at\":null},{\"id\":\"c978aaf1-2b86-36be-9d52-6ecaa9000095\",\"quantity\":28.7409,\"fulfilled_at\":\"2026-09-11T04:14:46.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": "voluptatibus", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "magnam", "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\":\"1501e5a2-5efb-33c8-9bbe-7a3bcaa35a2d\",\"product\":{\"id\":\"a2d092cf-296b-40bd-bb16-8e948b341b85\",\"name\":\"Dr. Mariah Gon\\u00e7alves Carrara\",\"code\":\"PRD-821055\",\"unit\":{\"id\":\"a2d092cf-27ae-42ee-9a2d-c50de7e23e88\",\"name\":\"Fabiano Denis Abreu Filho\",\"abbreviation\":\"Bernardo Mascarenhas Caldeira Jr.\"}},\"quantity\":777.327,\"quantity_fulfilled\":0,\"quantity_pending\":777.327,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Quia ut quia recusandae quo odio.\",\"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": "rem", "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\":\"acda36b5-f31f-3679-9f81-e273a392a46e\",\"product\":{\"id\":\"a2d092cf-40d4-49c9-a088-cbce2dde0a88\",\"name\":\"Michele Ornela Rezende\",\"code\":\"PRD-363671\",\"unit\":{\"id\":\"a2d092cf-3f83-431f-b33b-95ec48c9c380\",\"name\":\"James Delgado\",\"abbreviation\":\"Dr. Lorenzo Mauro Leal\"}},\"quantity\":852.548,\"quantity_fulfilled\":0,\"quantity_pending\":852.548,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"f461e7dd-fa34-3c68-9e2d-3388c139223a\",\"product\":{\"id\":\"a2d092cf-52d7-41f2-8cf5-0fb3b2ec2660\",\"name\":\"Sra. Nayara Catarina Matos Sobrinho\",\"code\":\"PRD-058197\",\"unit\":{\"id\":\"a2d092cf-519e-4365-8784-d49599e6b70a\",\"name\":\"Jorge Escobar\",\"abbreviation\":\"Agatha Ferminiano Grego Sobrinho\"}},\"quantity\":961.1007,\"quantity_fulfilled\":0,\"quantity_pending\":961.1007,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Quia perferendis mollitia earum qui et voluptatem.\",\"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": "rerum", "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\":\"570901e4-7ce2-37cc-8233-a4adb88118dd\",\"product\":{\"id\":\"a2d092cf-6913-4b75-b1fd-9c6f5645b1a8\",\"name\":\"Dr. F\\u00e1bio God\\u00f3i\",\"code\":\"PRD-538715\",\"unit\":{\"id\":\"a2d092cf-67ab-4b8f-9fd6-d79e1d640a27\",\"name\":\"Isaac Rezende Domingues Filho\",\"abbreviation\":\"Srta. Talita Queir\\u00f3s Jr.\"}},\"quantity\":66.5781,\"quantity_fulfilled\":0,\"quantity_pending\":66.5781,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Minima voluptatum aut dolore pariatur velit laboriosam.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"5595ce84-989d-3ad4-bbcd-12699eb029c1\",\"product\":{\"id\":\"a2d092cf-7a1c-45be-bc42-a5d83966dcc3\",\"name\":\"Dr. Mar\\u00edlia Rocha Jr.\",\"code\":\"PRD-629666\",\"unit\":{\"id\":\"a2d092cf-78e7-44cc-880c-2999c10b8b5b\",\"name\":\"Diana Toledo\",\"abbreviation\":\"Srta. Fabiana de Arruda Sobrinho\"}},\"quantity\":879.2465,\"quantity_fulfilled\":0,\"quantity_pending\":879.2465,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Explicabo ut sequi et voluptatibus ut.\",\"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\":\"d02c2b99-aed4-3a1c-9264-89b8517bfaf9\",\"work_location_id\":\"990ff336-93e7-3eea-a9a1-74470d565b54\",\"user_id\":\"7f41ce9d-0b5e-3a13-a8c5-e42448b2b9ba\",\"status_id\":\"646687e3-956e-3196-b0e0-3c68c4af629e\",\"priority\":\"Example Priority\",\"needed_at_from\":\"Example Needed at from\",\"needed_at_to\":\"Example Needed at to\",\"responsible_id\":\"7663e6ae-73ac-38d4-90f8-33c77d1a6bba\"}" }, "description": "List all product requests" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"afd0fd8c-411f-3c9e-9ca3-055a50478bb8\",\"code\":null,\"name\":\"Reprehenderit dolorem sint aliquam.\",\"description\":null,\"work\":{\"id\":\"a2d092cc-2270-4ddd-a09d-cb6bb594b72c\",\"name\":\"Fernando Mascarenhas Pedrosa Filho\"},\"user\":{\"id\":\"a2d092cc-25a5-4bec-b9da-b478d6cde642\",\"name\":\"Lesley Morar IV\"},\"status\":{\"id\":\"a2d092cc-27bf-4b31-b2cf-44f5fdf2c1c2\",\"slug\":null,\"name\":null,\"description\":\"Srta. Ariane Oliveira Jr.\",\"abbreviation\":\"officia\",\"color\":\"#15347e\",\"text_color\":\"#98101b\"},\"priority\":\"medium\",\"priority_label\":\"M\\u00e9dia\",\"needed_at\":\"2026-10-14\",\"approved_at\":null,\"rejection_reason\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"3e5a990f-4f97-3e59-b5f8-0c841b20f932\",\"code\":null,\"name\":\"Delectus omnis occaecati vel.\",\"description\":null,\"work\":{\"id\":\"a2d092cc-2c69-454c-a825-fbf98f7621f6\",\"name\":\"Sra. Laiane Agustina Maia Jr.\"},\"user\":{\"id\":\"a2d092cc-2f40-48ab-9d58-1f8d0f5d7c01\",\"name\":\"Mckenna Tillman\"},\"status\":{\"id\":\"a2d092cc-30f8-4d1f-b0aa-72b32ba28151\",\"slug\":null,\"name\":null,\"description\":\"Sr. Cezar Casanova Filho\",\"abbreviation\":\"non\",\"color\":\"#78b63d\",\"text_color\":\"#ee6bf1\"},\"priority\":\"urgent\",\"priority_label\":\"Urgente\",\"needed_at\":\"2026-09-26\",\"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": "vero", "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\":\"e253c7fb-dd0d-3504-a1d6-5513ed0311c0\",\"code\":null,\"name\":\"Velit nulla vel suscipit dolor.\",\"description\":null,\"work\":{\"id\":\"a2d092cc-3a06-4dd3-9ad3-d9bfb8cfeda8\",\"name\":\"Sr. George Teles\"},\"user\":{\"id\":\"a2d092cc-3d25-441c-a723-f4072a714161\",\"name\":\"Rose Streich V\"},\"status\":{\"id\":\"a2d092cc-3ef9-44ef-b2c9-95ba5aee2baa\",\"slug\":null,\"name\":null,\"description\":\"Paulo Feliciano Matias\",\"abbreviation\":\"dolores\",\"color\":\"#4a9b96\",\"text_color\":\"#3b2536\"},\"priority\":\"urgent\",\"priority_label\":\"Urgente\",\"needed_at\":\"2026-10-20\",\"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": "laboriosam", "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\":\"14ff89f6-4287-3cbf-b06f-2ea9e9ca1d29\",\"product\":{\"id\":\"a2d092cc-5ba9-4841-a73c-53786e9a1a24\",\"name\":\"Valentina de Freitas Verdugo Filho\",\"code\":\"PRD-651499\",\"unit\":{\"id\":\"a2d092cc-5a68-42ac-bfab-e3c42d436cbb\",\"name\":\"Dr. Ketlin Medina Dominato Filho\",\"abbreviation\":\"Nicolas Alcantara Carrara\"}},\"quantity\":892.1107,\"quantity_fulfilled\":0,\"quantity_pending\":892.1107,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"5f9a074d-97b3-343e-bf4e-fa4c31ebedb7\",\"product\":{\"id\":\"a2d092cc-705a-4bb0-9991-5066b743bb50\",\"name\":\"Gabrielle Graziela Neves\",\"code\":\"PRD-675553\",\"unit\":{\"id\":\"a2d092cc-6d6c-4ea9-886c-bf6bb5df28ed\",\"name\":\"M\\u00e1ximo Barros Jr.\",\"abbreviation\":\"Dr. Sergio Adriel Ramires Sobrinho\"}},\"quantity\":834.8442,\"quantity_fulfilled\":0,\"quantity_pending\":834.8442,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Est dolores eum possimus officia nihil repellat.\",\"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\":\"9c5f8345-3b72-3761-8ed4-c297373625ef\",\"work_location_id\":\"d6b9e842-7ce5-3eb0-a821-da3e211e367a\",\"status_id\":\"ca29a13e-30b8-391a-8fdf-ec6f40f307d4\",\"priority\":\"Example Priority\",\"needed_at\":\"Example Needed at\",\"items\":[{\"product_id\":\"d66ab071-069a-3749-866f-78b6064124b0\",\"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": "dolor", "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\":\"b13aba9a-647b-3db9-ab6e-16f2acfd9f6f\",\"work_location_id\":\"9178eabe-977d-3e89-b76a-ce4148a0d2f7\",\"status_id\":\"59e337af-58c3-34d7-9f81-15d0527e1df3\",\"priority\":\"Example Priority\",\"needed_at\":\"Example Needed at\",\"items\":[{\"id\":\"d7c91dfc-3c15-3bcb-aba5-2069308868f8\",\"product_id\":\"49b18c7e-e79d-3948-963e-ad9120d9364a\",\"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": "veniam", "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": "et", "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": "commodi", "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": "at", "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\":\"dacba0ac-da38-39c3-b0fa-eee42631767e\",\"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": "facere", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "error", "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\":\"0aa5a0b7-9ab3-30ce-a67d-03704cf372f3\"}" }, "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": "voluptate", "description": "Product Request UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[\"fd27195a-5b50-3708-8c05-a31b2409c807\"]}" }, "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": "in", "description": "Product Request UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"id\":\"7c50bf3f-d60d-3491-a6b6-d74c6a849a32\",\"product_id\":\"f979bdc3-7017-3af3-81c5-fd3fb144077c\",\"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\":\"e26548da-e6d8-3efb-a0b1-b38f516e572d\",\"name\":\"Murilo Gusm\\u00e3o Galhardo Jr.\",\"code\":\"PRD-909227\",\"stock\":27935744,\"product_family\":{\"id\":\"a2d092c9-6c99-4300-87a6-89850e512c93\",\"name\":\"Ta\\u00eds Pereira Neto\"},\"product_brand\":{\"id\":\"a2d092c9-6e52-43e0-8427-4baa651bcb70\",\"name\":\"Dr. Maur\\u00edcio Matheus da Rosa Filho\"},\"unit\":{\"id\":\"a2d092c9-7027-42ff-8a81-2934e0b2d135\",\"name\":\"Graziela Carvalho\",\"abbreviation\":\"Sra. Cec\\u00edlia Suellen Pacheco Filho\"},\"image\":{\"id\":null,\"url\":null},\"epi_type\":null,\"description\":\"Magnam quae qui aliquid officiis laboriosam.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"69bc64c1-920a-36d8-9faf-8bb047015e45\",\"name\":\"Dr. Tha\\u00eds Rosana Queir\\u00f3s\",\"code\":\"PRD-882880\",\"stock\":18,\"product_family\":{\"id\":\"a2d092c9-742b-4a34-8f3d-b0de214b48a1\",\"name\":\"Michael Gael Quintana Sobrinho\"},\"product_brand\":{\"id\":\"a2d092c9-759e-454e-9439-35d346e57389\",\"name\":\"Leonardo Cl\\u00e1udio de Oliveira Jr.\"},\"unit\":{\"id\":\"a2d092c9-7722-44d8-b483-29ac0ed662f9\",\"name\":\"Sra. Rebeca Azevedo Jr.\",\"abbreviation\":\"Juliane Luiza Queir\\u00f3s\"},\"image\":{\"id\":null,\"url\":null},\"epi_type\":null,\"description\":\"Non temporibus ipsum porro.\",\"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": "nesciunt", "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\":\"b9f83569-5c27-30ca-9998-fb4c3f3e9e61\",\"name\":\"Srta. Stephany das Dores Filho\",\"code\":\"PRD-473827\",\"stock\":9874,\"product_family\":{\"id\":\"a2d092c9-8728-4de1-bd78-e4cbb51903ae\",\"name\":\"Dayane Pena Pena Neto\"},\"product_brand\":{\"id\":\"a2d092c9-8917-4431-9ab3-611290481efe\",\"name\":\"Samuel Eric Roque\"},\"unit\":{\"id\":\"a2d092c9-8b05-489b-924d-b58bbcd74f1b\",\"name\":\"Isabelly Santacruz Neto\",\"abbreviation\":\"Lara Aguiar\"},\"image\":{\"id\":null,\"url\":null},\"epi_type\":null,\"description\":\"Deserunt ut eos repellat recusandae.\",\"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": "veritatis", "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\":\"1d2fd657-c87d-3bf7-9eaa-42c1ed11ba35\",\"product_brand_id\":\"2dc0ea48-845b-315c-8fea-e4bc5977a458\",\"unit_id\":\"de8d50be-2ff5-3725-81e5-bfbf6d8502dc\",\"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": "officia", "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\":\"c40d3860-dbd1-3739-9de1-116dad1e6148\",\"product_brand_id\":\"e0c17139-8fea-34bd-b9f9-a60157f41e59\",\"unit_id\":\"946beda7-37a5-3658-840a-82f79a9eec01\",\"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": "fugit", "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": "aca1fd24-aa35-3c18-87e7-6cbf35a70a20", "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\":\"3aeda288-c354-30b6-a4cb-14431ed36ff5\",\"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": "d2bd8319-33f1-3ec0-b1f0-910f5da96266", "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": "dd970e86-7aa1-3e43-b8ee-62e3ffd50249", "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": "f6daa585-8671-33bd-8014-1b8a4a6f13f5", "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": "8f364613-feb6-395c-9a2c-f5e0d1fff6bd", "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": "a4cb2b80-d324-3751-9974-be8d9b4b9824", "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": "4b1d2b2c-6fe7-3b93-839b-69ceb226e2a1", "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": "6449dd32-386f-38bd-8b25-df1cdfa6993f", "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": "b37ada67-7b4c-363e-818b-65d453327c09", "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": "790a0a48-ddf7-3b82-87a5-89294ace96f2", "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=4b1d2b2c-6fe7-3b93-839b-69ceb226e2a1&work_id=6449dd32-386f-38bd-8b25-df1cdfa6993f&status_id=b37ada67-7b4c-363e-818b-65d453327c09&responsible_id=790a0a48-ddf7-3b82-87a5-89294ace96f2" }, "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\":\"14248d40-5aa0-3151-a35d-41b0dbd057e1\",\"name\":\"Ut recusandae ut\",\"description\":\"Nobis cupiditate architecto nam veritatis provident id non.\",\"current_version\":1,\"file\":{\"path\":\"projects\\\/63999263-f2cf-372a-be03-79db021a5d35.pdf\",\"size\":\"2102002\",\"extension\":\"pdf\"},\"discipline\":{\"id\":\"a2d092cf-8b21-4a3d-b760-6f38a0dc1075\",\"name\":\"Ut\",\"code\":\"AND\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"ce418db5-91fd-3302-8dcd-28841011d891\",\"name\":\"Rerum iure est\",\"description\":\"Veniam enim cum repudiandae est id.\",\"current_version\":1,\"file\":{\"path\":\"projects\\\/b2b79bfe-41b9-3fa8-bbc9-c2860270258b.pdf\",\"size\":\"1735949\",\"extension\":\"pdf\"},\"discipline\":{\"id\":\"a2d092cf-8eb0-47cb-9e51-632e53ad9039\",\"name\":\"Aliquid\",\"code\":\"VMA\"},\"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": "12", "description": "The ID of the project." }, { "id": "project", "key": "project", "value": "vero", "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\":\"92110d66-c342-3e99-bd48-e8df826bfeca\",\"name\":\"Quas voluptatem veniam\",\"description\":\"Dicta est quidem in cupiditate rerum optio dolor.\",\"current_version\":1,\"file\":{\"path\":\"projects\\\/0699582d-0a45-3e12-869e-bc883d3ef7f1.pdf\",\"size\":\"4061509\",\"extension\":\"pdf\"},\"discipline\":{\"id\":\"a2d092cf-97c8-4b73-b15d-3e479eeb614a\",\"name\":\"Eaque\",\"code\":\"FUO\"},\"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\":\"ec40f95d-0a77-3ce9-bb95-03d52508dfc4\",\"work_id\":\"c5024f3a-50b0-31ad-accd-18f6dd9eee03\",\"responsible_user_id\":\"763ed673-926a-370d-916c-8660c154b862\",\"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": "6", "description": "The ID of the project." }, { "id": "project", "key": "project", "value": "molestias", "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\":\"059467a7-b690-334d-a8da-243b56727264\",\"work_id\":\"40ea0800-ac62-3b0d-ba38-8fc6dd78378e\",\"responsible_user_id\":\"ca56b0a3-0b64-347e-9111-c086f99c4e9e\",\"status_id\":\"39132652-ba8d-3b97-bd72-7b9e62c63d76\"}" }, "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": "animi", "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": "", "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\":\"dolor\"}" }, "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\":\"incidunt\",\"kit_uuid\":\"107a9b0c-af6d-3aab-b930-5418bec5344f\"}" }, "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\":\"quia\"}" }, "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": "Export Cash Flow to Excel", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/cash-flow\/excel", "query": [ { "key": "q", "value": "voluptas", "description": "", "disabled": false }, { "key": "type", "value": "entrada", "description": "Tipo de lan\u00e7amento.", "disabled": false }, { "key": "description", "value": "Delectus+repellendus+dolor+nihil+laborum+quis+quae+voluptates.", "description": "", "disabled": false }, { "key": "categories[0]", "value": "abd35571-4317-3791-b699-8c57d9b6d2b5", "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": "73fd097b-9e15-3b17-a7cb-9593df992f40", "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": "fdcee41c-3865-30c0-9772-00c5a7ecf4a4", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "customers[0]", "value": "c9c9f6e3-7332-3615-8287-c7d13ca492e6", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "suppliers[0]", "value": "65407993-e7e8-3dcd-8bd3-6c1c11702ea3", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "cash_session", "value": "b9071b42-19b3-3e8c-89f3-e712da002fd1", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "works[0]", "value": "ab321ddc-10fc-3853-91f0-91054cb7f2ca", "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=voluptas&type=entrada&description=Delectus+repellendus+dolor+nihil+laborum+quis+quae+voluptates.&categories[0]=abd35571-4317-3791-b699-8c57d9b6d2b5&exclude_categories[0]=73fd097b-9e15-3b17-a7cb-9593df992f40&date_start=2026-01-01&date_end=2026-12-31&bank_accounts[0]=fdcee41c-3865-30c0-9772-00c5a7ecf4a4&customers[0]=c9c9f6e3-7332-3615-8287-c7d13ca492e6&suppliers[0]=65407993-e7e8-3dcd-8bd3-6c1c11702ea3&cash_session=b9071b42-19b3-3e8c-89f3-e712da002fd1&works[0]=ab321ddc-10fc-3853-91f0-91054cb7f2ca&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": "aliquam", "description": "", "disabled": false }, { "key": "type", "value": "entrada", "description": "Tipo de lan\u00e7amento.", "disabled": false }, { "key": "description", "value": "Earum+molestiae+eveniet+quod+est.", "description": "", "disabled": false }, { "key": "categories[0]", "value": "afaf0b29-1039-3269-9174-176f0848739e", "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": "77697f11-5eb1-39e1-b499-9d740002f154", "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": "830c78cc-1121-35c2-b475-34991cfd27b0", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "customers[0]", "value": "ee9eb383-bc56-3010-a081-4762734b3761", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "suppliers[0]", "value": "2df2a6b7-66cd-3d92-88b0-02cb2de318cc", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "cash_session", "value": "39e287a8-1dfe-33b1-a79b-6053156e8389", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "works[0]", "value": "ead6e5e1-0524-33a9-83d7-66d24761ad7d", "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=aliquam&type=entrada&description=Earum+molestiae+eveniet+quod+est.&categories[0]=afaf0b29-1039-3269-9174-176f0848739e&exclude_categories[0]=77697f11-5eb1-39e1-b499-9d740002f154&date_start=2026-01-01&date_end=2026-12-31&bank_accounts[0]=830c78cc-1121-35c2-b475-34991cfd27b0&customers[0]=ee9eb383-bc56-3010-a081-4762734b3761&suppliers[0]=2df2a6b7-66cd-3d92-88b0-02cb2de318cc&cash_session=39e287a8-1dfe-33b1-a79b-6053156e8389&works[0]=ead6e5e1-0524-33a9-83d7-66d24761ad7d&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\":\"53bda803-4ff4-3f7e-90ae-c206873b3e29\",\"name\":\"libero dolor\",\"slug\":null,\"description\":null,\"abbreviation\":\"nku\",\"created_at\":null,\"updated_at\":null},{\"id\":\"c03bdc2d-40ce-315e-a5fe-1367790d4f2c\",\"name\":\"non at\",\"slug\":null,\"description\":null,\"abbreviation\":\"dbt\",\"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": "6", "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\":\"d182dcd7-ef91-33ed-ae37-f1d8f701dd57\",\"name\":\"cupiditate voluptatem\",\"slug\":null,\"description\":null,\"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": "14", "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": "13", "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\":\"33f03d23-2775-3818-9404-f77825c90172\",\"name\":\"Mr. Willard Douglas II\",\"username\":\"csteuber\",\"email\":\"frami.eli@example.com\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"9b1b232e-4192-3872-b3da-b1f65787751e\",\"name\":\"Mr. Jaycee Murazik\",\"username\":\"nikolaus.marie\",\"email\":\"ppouros@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 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\":[\"2d305ff8-4e9d-3263-b9eb-8a4e25948cbb\"]}" }, "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\":[\"7242e9f5-3b12-336e-a11b-6e6df3bf20ee\"]}" }, "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\":[\"a03463e3-73af-3ed2-b119-a9839e7a03fe\"]}" }, "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\":\"laboriosam cupiditate\",\"slug\":\"enim-dolorem-consequatur-similique-recusandae-tempore\"},{\"name\":\"molestiae vitae\",\"slug\":\"velit-asperiores-alias-aut-qui-eum-ut-qui\"}]}", "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\":\"56ce5661-d7dc-351f-b743-ea78f4016b46\",\"slug\":null,\"name\":null,\"description\":\"Gael de Aguiar\",\"abbreviation\":\"laudantium\",\"color\":\"#329b30\",\"text_color\":\"#6bf5a6\",\"module\":{\"name\":\"Solicita\\u00e7\\u00e3o de Produtos\",\"slug\":\"product_request\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"ad705c8e-675e-3f75-9266-8f2a5d536683\",\"slug\":null,\"name\":null,\"description\":\"Srta. Noemi Duarte God\\u00f3i Jr.\",\"abbreviation\":\"dolore\",\"color\":\"#739ef8\",\"text_color\":\"#5e47f6\",\"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\":\"0fa35de4-fbb6-3913-aa25-ccc88f9f2431\",\"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\":\"345c4f71-5d2a-3df0-9209-aa35b379093b\",\"slug\":null,\"name\":null,\"description\":\"Sandra Rivera Martines Jr.\",\"abbreviation\":\"soluta\",\"color\":\"#ae8da7\",\"text_color\":\"#e45762\",\"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\":\"0121123b-c93a-3830-a817-e69316077b66\",\"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\":\"a3128cce-51c0-391f-ad2e-f82db91e5853\",\"quantity\":337.5403,\"min_quantity\":null,\"max_quantity\":null,\"below_minimum\":false,\"above_maximum\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"094ea16c-d36e-306a-a146-9c884910a48b\",\"quantity\":771.1087,\"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\":\"71a32dfb-a347-3fb3-875c-d69a2b79b1ea\",\"name\":\"Estoque Beltr\\u00e3o-Burgos\",\"module\":\"work\",\"is_active\":true,\"is_main\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"79ccad25-b2a2-34ea-b3fe-3e68132fb8f2\",\"name\":\"Estoque Padilha e Cordeiro e Associados\",\"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\":\"86e38500-541a-3541-beda-57fcf4db7df1\",\"name\":\"Estoque Tamoio-Serrano\",\"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\":\"06069441-2f50-3ff8-866f-e3aced9f25fb\",\"name\":\"Estoque Bonilha-Ramos\",\"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\":\"4ab7ffa0-fd53-310a-af4b-9979dd5b949a\",\"name\":\"Estoque Escobar 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\":\"522b2932-6b5b-3b55-8a9b-88f236834fb6\",\"name\":\"Estoque Saito S.A.\",\"module\":\"work\",\"is_active\":true,\"is_main\":false,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Delete stock", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stocks\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the stock." }, { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes a stock (soft delete)" }, "response": [] }, { "name": "List stock items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:stock\/items", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Number of items per page. O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Cement", "description": "Search by product name. O campo value n\u00e3o pode ser superior a 255 caracteres.", "disabled": false }, { "key": "below_minimum", "value": "1", "description": "Filter items below minimum quantity.", "disabled": false }, { "key": "above_maximum", "value": "", "description": "Filter items above maximum quantity.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/stocks\/:stock\/items?sort_by=created_at&sort_desc=1&page=1&per_page=10&q=Cement&below_minimum=1&above_maximum=", "variable": [ { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of items\/products in a stock" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"1eaa357f-f839-3e93-930f-0e9dc0e4cf82\",\"quantity\":957.3054,\"min_quantity\":null,\"max_quantity\":null,\"below_minimum\":false,\"above_maximum\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"ee3d70e5-7603-3e11-abcc-2e8ee5edc90f\",\"quantity\":578.3346,\"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": "dolorum", "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\":\"06117300-719e-3b9a-9641-46acdfc3ac62\",\"quantity\":610.3307,\"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\":\"0ed7e899-d014-3781-9f74-748005c719c3\",\"code\":\"MOV-835799\",\"type\":\"vencido\",\"type_name\":\"EXPIRED\",\"is_entry\":false,\"is_exit\":true,\"quantity\":25.0371,\"previous_quantity\":52.1502,\"new_quantity\":27.1131,\"reason\":null,\"movement_date\":\"2026-09-19T06:16:42.000000Z\",\"created_at\":null},{\"id\":\"8d92ff8c-5b3e-31e0-a434-13731d400c39\",\"code\":\"MOV-743389\",\"type\":\"sa\\u00edda transfer\\u00eancia\",\"type_name\":\"TRANSFER_OUT\",\"is_entry\":false,\"is_exit\":true,\"quantity\":58.7713,\"previous_quantity\":79.2094,\"new_quantity\":20.4381,\"reason\":null,\"movement_date\":\"2026-08-26T16:44:09.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\":\"c4d72ec7-186c-31d4-a498-5c52feb859d2\",\"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\":\"70ebbb01-dbed-31e9-a3d1-37c84aff845c\",\"code\":\"MOV-399486\",\"type\":\"compra\",\"type_name\":\"PURCHASE\",\"is_entry\":true,\"is_exit\":false,\"quantity\":55.3783,\"previous_quantity\":529.9587,\"new_quantity\":585.337,\"reason\":null,\"movement_date\":\"2026-08-28T08:21:10.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\":\"ee41c45f-2dc4-3a6d-8af5-f499c8ba9b05\",\"destination_stock_id\":\"4f7fffb2-3d86-3327-8b44-8661f6b638d4\",\"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\":\"d1b19267-c3f3-3043-98e1-43b642fd9087\",\"code\":\"MOV-161091\",\"type\":\"ajuste entrada\",\"type_name\":\"ADJUSTMENT_IN\",\"is_entry\":true,\"is_exit\":false,\"quantity\":51.0205,\"previous_quantity\":582.6054,\"new_quantity\":633.6259,\"reason\":null,\"movement_date\":\"2026-09-22T02:00:21.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\":\"0bb8fb93-984a-3d5a-85ba-540b9ab86f1f\",\"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\":\"2c30bbf2-cf89-3107-9b3c-2c11dcd99423\",\"code\":\"MOV-972221\",\"type\":\"aloca\\u00e7\\u00e3o\",\"type_name\":\"ALLOCATION\",\"is_entry\":true,\"is_exit\":false,\"quantity\":77.3446,\"previous_quantity\":529.5263,\"new_quantity\":606.8709,\"reason\":\"Enim et nemo quibusdam voluptatibus nihil dolorem.\",\"movement_date\":\"2026-09-05T23:22:55.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\":\"4f526700-f614-3b53-be2a-0c72c0e98bbb\",\"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\":\"dd38ff88-f56f-398d-9e04-3f34d4ac3941\",\"code\":\"MOV-346199\",\"type\":\"venda\",\"type_name\":\"SALE\",\"is_entry\":false,\"is_exit\":true,\"quantity\":98.7009,\"previous_quantity\":475.1323,\"new_quantity\":376.4314,\"reason\":null,\"movement_date\":\"2026-09-10T09:58:34.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\":\"9cde4315-f0eb-3a54-8d8b-ccc5920ebb02\",\"code\":\"MOV-868888\",\"type\":\"venda\",\"type_name\":\"SALE\",\"is_entry\":false,\"is_exit\":true,\"quantity\":43.0371,\"previous_quantity\":122.6035,\"new_quantity\":79.5664,\"reason\":\"Et eaque consequatur voluptatem et.\",\"movement_date\":\"2026-09-09T03:55:45.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\":\"9cd4cb41-9385-3fcf-b2db-f75030dd619b\",\"name\":\"Sra. Melissa Estrada Cruz\",\"email\":\"ferminiano.raissa@example.com\",\"phone\":\"(99) 99277-7953\",\"document\":\"10.457.868\\\/0001-79\",\"type\":\"pf\",\"responsible\":\"Dr. Renan \\u00cdcaro Vega Jr.\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null}},{\"id\":\"03eb181d-e509-3e79-be4f-603d10ddbd82\",\"name\":\"Luan Quintana Aranda\",\"email\":\"iasmin08@example.net\",\"phone\":\"(81) 95427-7336\",\"document\":\"26.376.083\\\/0001-01\",\"type\":\"pf\",\"responsible\":\"Sra. Naiara Rezende\",\"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\":\"66c65c6c-b0bd-3cb5-a206-9f4df1a71212\",\"name\":\"Norma Elo\\u00e1 Aranda Sobrinho\",\"email\":\"ldesouza@example.org\",\"phone\":\"(61) 2584-8529\",\"document\":\"08.450.880\\\/0001-00\",\"type\":\"pf\",\"responsible\":\"Dr. Mateus Furtado\",\"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\":\"8786f2f5-f4cb-3a2e-929f-4ba643e30c34\",\"name\":\"Dr. Thales Ortiz\",\"description\":\"Aut suscipit rerum earum nihil. Tenetur vel in autem. Ducimus aliquid recusandae aut laudantium. Odio consequatur maiores rerum eligendi veritatis perspiciatis illo dolorem.\",\"type\":\"dep\\u00f3sito\"},{\"id\":\"81b1165a-793f-3fcb-9c71-ff829221cbab\",\"name\":\"Willian Fernandes Jr.\",\"description\":\"Accusantium beatae dolore et ipsum consequuntur. Quia modi beatae quam velit. Similique aliquid labore deleniti praesentium qui cupiditate et.\",\"type\":\"entrada\"}],\"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": "velit", "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\":\"3cb6ed2c-306e-31a7-9767-31a605192cc5\",\"name\":\"Maria Delgado\",\"description\":\"Facere dignissimos animi accusamus numquam aut perspiciatis esse. Et maxime quia sed itaque. Voluptates in tenetur dicta minima explicabo. Quos ut ut ut.\",\"type\":\"sa\\u00edda\"}}", "name": "" } ] }, { "name": "Create transaction category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction-categories", "query": [], "raw": "{{baseUrl}}\/api\/transaction-categories" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"description\":\"Example Description\",\"type\":\"Example Type\"}" }, "description": "Create a new transaction category" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update transaction category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction-categories\/:transactionCategory", "query": [], "raw": "{{baseUrl}}\/api\/transaction-categories\/:transactionCategory", "variable": [ { "id": "transactionCategory", "key": "transactionCategory", "value": "tempora", "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": "mollitia", "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\":\"cf264d3e-52da-300c-83b9-f5ae410cddaf\",\"name\":\"Ullam repellat\",\"slug\":\"ullam-repellat-812892\",\"description\":\"Facilis et ut et ducimus aut sed quam.\",\"sort_order\":0,\"is_active\":true,\"created_at\":null,\"updated_at\":null},{\"id\":\"e9efa9c5-b0a8-3a4e-9e49-5696b3b13bfe\",\"name\":\"Voluptatem consequuntur\",\"slug\":\"voluptatem-consequuntur-482477\",\"description\":\"Iure dolor quia quidem ratione nobis.\",\"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\",\"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\":\"dd752d9a-7f57-36bc-a1c8-8759005c09d7\",\"name\":\"Praesentium amet\",\"slug\":\"praesentium-amet-500595\",\"description\":\"Velit deserunt eligendi qui earum assumenda molestias.\",\"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\":\"b744ed58-c05d-37c7-9b37-a93284e9685f\",\"name\":\"Excepturi odit\",\"slug\":\"excepturi-odit-448570\",\"description\":\"Et nisi nobis earum qui aut ratione quae.\",\"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\",\"sort_order\":1,\"is_active\":true}" }, "description": "Atualiza um m\u00f3dulo do cat\u00e1logo" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"a114e5e3-f78f-313f-9216-e81404ec9a9a\",\"name\":\"Modi nesciunt\",\"slug\":\"modi-nesciunt-718478\",\"description\":\"Amet eos ipsam fugiat aperiam.\",\"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", "value": "b82107a0-fa59-323f-b34e-4b5481003f78", "description": "Filtra pelo UUID do m\u00f3dulo. 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": "539de693-92f0-3800-b63e-f2da5b16ac4b", "description": "Filtra pelo UUID do setor vinculado. O campo value deve ser um UUID v\u00e1lido. The uuid of an existing record in the sectors table.", "disabled": false }, { "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=b82107a0-fa59-323f-b34e-4b5481003f78§or_id=539de693-92f0-3800-b63e-f2da5b16ac4b&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\":\"f9d14e03-3690-3510-b6ed-82196ce5be6b\",\"title\":\"Minima fuga voluptatum fugit\",\"description\":\"Et exercitationem illo eius culpa.\",\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a2d092d2-1af2-4324-8aee-c0ef3d6e9b18\",\"name\":\"Et iure\",\"slug\":\"et-iure-365854\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"b06e83d4-96d9-36c3-9c46-2969f4205f7c\",\"title\":\"Deserunt quod nostrum voluptas\",\"description\":\"Dolores sunt nulla recusandae sapiente officiis eveniet sapiente.\",\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a2d092d2-1edb-4996-b58a-da5cd81c2a94\",\"name\":\"Tempora nostrum\",\"slug\":\"tempora-nostrum-655623\"},\"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\":\"eb0f0111-0c14-39d4-bee7-6c081386a531\",\"title\":\"Example Title\",\"description\":\"Example Description\",\"cover_path\":\"Example Cover path\",\"sort_order\":1,\"sectors\":[\"f6443961-be69-3125-8ee8-28e34a6312da\"],\"permissions\":[\"79f669aa-e8b5-3342-a81e-78facc3e597e\"]}" }, "description": "Cria um tutorial. Nasce como rascunho e s\u00f3 aparece na central depois de publicado." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"6e366148-04a0-3301-a462-e5967eb64698\",\"title\":\"Repudiandae sit voluptas et\",\"description\":\"Quasi sed quos non sunt.\",\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a2d092d2-28a5-4c9a-a42f-51f5cf0edbd7\",\"name\":\"Nesciunt quia\",\"slug\":\"nesciunt-quia-894500\"},\"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\":\"82dfd614-a8c2-3427-b758-cf135977add6\",\"title\":\"Quis facilis nobis reprehenderit\",\"description\":\"Id libero aperiam minus itaque.\",\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a2d092d2-37e7-4fc3-aa4d-c72317df388b\",\"name\":\"Quo architecto\",\"slug\":\"quo-architecto-893459\"},\"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\":\"5219812f-516f-3374-92ce-9cb2fa7fd582\",\"title\":\"Example Title\",\"description\":\"Example Description\",\"cover_path\":\"Example Cover path\",\"sort_order\":1,\"sectors\":[\"3c24ba10-5134-3198-8a25-99e772cf1a3e\"],\"permissions\":[\"9c20aab7-a7bd-3b1f-aac9-8e00f9c54b83\"]}" }, "description": "Atualiza o tutorial e os v\u00ednculos de setor e permiss\u00e3o" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"02c15f20-fec7-3a25-a06d-56f4954d46e0\",\"title\":\"Ut ullam cum ducimus\",\"description\":\"Sunt debitis ullam odit voluptas magni impedit ea ipsam.\",\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a2d092d2-4015-4312-a945-dcb5e8a8c9f5\",\"name\":\"Velit vero\",\"slug\":\"velit-vero-999489\"},\"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\":\"1b3ba34d-070a-32e0-8eb4-13d1d958302f\",\"title\":\"Dolor omnis laboriosam sit\",\"description\":\"Fugiat voluptas maxime occaecati similique incidunt maxime omnis.\",\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a2d092d2-4814-4e21-a02b-5f2682e87efa\",\"name\":\"Aut fugiat\",\"slug\":\"aut-fugiat-670460\"},\"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\":\"5663b95f-683f-3ee6-be94-032ad3824aec\",\"title\":\"Doloribus vel alias omnis\",\"description\":\"Odit sit ullam hic libero voluptates.\",\"status\":\"draft\",\"published_at\":null,\"sort_order\":0,\"module\":{\"id\":\"a2d092d2-4d62-4ab8-a6cd-26d4f689afd8\",\"name\":\"Est ex\",\"slug\":\"est-ex-866275\"},\"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\":\"a236781b-981c-31ec-88f2-6a149836a423\",\"type\":\"pdf\",\"title\":\"Repudiandae alias velit\",\"mime_type\":\"application\\\/pdf\",\"size_bytes\":42921,\"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\":[\"3a948fbc-f9b0-3aa0-a40e-640154af0709\"]}" }, "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\":\"f588cd35-2476-3af6-8e89-aab85ca100b3\",\"type\":\"pdf\",\"title\":\"Laudantium amet ea\",\"mime_type\":\"application\\\/pdf\",\"size_bytes\":3167476,\"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\":\"1b63e13d-1ef6-3e15-be71-e215a7dd1495\",\"name\":\"Sr. Danilo Balestero Guerra Filho\",\"abbreviation\":\"Ziraldo Valente Sobrinho\",\"description\":\"Sint minus excepturi autem.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"36bbd26f-5bbb-3bc9-a8a6-74ac606c34b1\",\"name\":\"Luan Everton Rico\",\"abbreviation\":\"Paulina Sabrina Verdugo\",\"description\":\"Quasi itaque ut nemo quis.\",\"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": "provident", "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\":\"eb43448f-e9bb-37b8-9850-c25aa998a1f1\",\"name\":\"Sr. Benjamin Medina Jr.\",\"abbreviation\":\"Eva Lu\\u00edsa Serra Filho\",\"description\":\"Illum sit dolore quia iusto.\",\"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": "et", "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": "expedita", "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\":\"2f83ce8d-6237-3d84-b54e-5c67e563f8af\",\"name\":\"Rhianna Turcotte\",\"username\":\"tristin97\",\"email\":\"greichel@example.org\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"37d2fe17-e21e-3bfd-b235-f99e365759e1\",\"name\":\"Dr. Gerald Beahan\",\"username\":\"aurelia63\",\"email\":\"patrick.ziemann@example.org\",\"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\":\"6db362aa-c5b0-3b8a-891c-702237f024fe\",\"name\":\"Janessa Deckow II\",\"username\":\"murray.josiane\",\"email\":\"dicki.juvenal@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\":\"carroll53\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"b9552a96-9393-3f66-b35a-e834a9025d1c\"],\"roles\":[\"21b3a026-4dba-3c69-a029-54bdf686f124\"]}" }, "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\":\"mbruen\",\"password\":\"password123\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"cab32564-5c72-302d-a6f3-447b8c1d092c\"],\"roles\":[\"5e154cb9-0242-378c-9084-50215f14fddd\"]}" }, "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\":[\"1a3884de-4274-3876-b28a-03ed401d6952\"]}" }, "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\":\"ex\",\"display_name\":\"Quam et quod voluptatum saepe perspiciatis ipsa.\"},{\"id\":null,\"name\":\"aut\",\"display_name\":\"Quisquam et laudantium quibusdam quia voluptatem animi quis.\"}]}", "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\":\"5e28db9a-9945-3e53-8bcd-862b8d605132\",\"description\":\"Dr. P\\u00e2mela Ang\\u00e9lica Padilha Sobrinho\",\"work\":{\"id\":null,\"name\":null},\"documents\":[],\"created_at\":null,\"updated_at\":null},{\"id\":\"1393c1b8-7825-3b57-bd67-4689b7f10267\",\"description\":\"Josu\\u00e9 Quintana\",\"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\":\"35f02360-4b78-369f-98a8-9fa21e4f8545\"}" }, "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\":\"d1d5a11e-9d8c-3425-b499-df26181181ee\",\"description\":\"Marcelo Artur Amaral\",\"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\":\"75d46aed-1b1a-30a0-ba6e-69bbc416064a\"}" }, "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\":\"bdd82986-d004-34f8-96b4-7089bc416b3b\",\"name\":\"Srta. Milene Lutero Rocha Sobrinho\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents\":[],\"locations\":[],\"product_quantity_lists_count\":0,\"product_quantity_list_items_count\":0,\"product_requests_count\":0,\"product_request_items_count\":0,\"documents_count\":0,\"locations_documents_count\":0,\"total_documents_count\":0,\"daily_logs_count\":0,\"projects_count\":0,\"started_at\":{\"date\":\"2022-07-27 21:05:17.000000\",\"timezone_type\":3,\"timezone\":\"America\\\/Sao_Paulo\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"77af096d-0051-3ee0-a143-fe6563f5e2ad\",\"name\":\"Lia Aline Vega\",\"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\":\"2010-05-04 22:29:19.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\":\"e80c8569-a468-31f6-9c45-8f8c2c6723f8\",\"status_id\":\"30321051-4532-3c81-81b2-8d42027bb3d5\",\"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\":\"3e3239c4-8f6d-348b-97c3-4b23b401587a\",\"name\":\"Viviane Prado Sobrinho\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents\":[],\"locations\":[],\"product_quantity_lists_count\":0,\"product_quantity_list_items_count\":0,\"product_requests_count\":0,\"product_request_items_count\":0,\"documents_count\":0,\"locations_documents_count\":0,\"total_documents_count\":0,\"daily_logs_count\":0,\"projects_count\":0,\"started_at\":{\"date\":\"2014-08-18 03:41:10.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\":\"e24d0a72-adc9-3f94-a548-ea3a9fb4d72e\",\"status_id\":\"8b1fd7f8-590f-39ca-ad3c-e440905499b8\",\"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\":\"85906287-f7d2-34b9-b0b0-4bce3bc169ad\",\"name\":\"Dr. Kristy Leuschke\",\"username\":\"heath.wiegand\",\"email\":\"lgerhold@example.org\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"f14c0ecc-1151-31f0-8221-5261e4967be3\",\"name\":\"Mrs. Madisyn Zulauf\",\"username\":\"qstoltenberg\",\"email\":\"uheathcote@example.org\",\"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\":[\"c3160ce3-956f-3754-81e0-806150c2588e\"]}" }, "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\":[\"c948e506-f6b6-3505-8acb-9991ff7544e1\"]}" }, "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\":[\"6cff2914-f7c3-33f8-8eb0-a1ebf87b8853\"]}" }, "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" } ] } }