{ "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": "c6792746-de1b-490e-85a6-a74dd5eb1676", "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\":\"4798773c-b44f-3cc9-9543-670005461011\",\"name\":\"ipsum-6a723f63e0394\",\"display_name\":\"Qui delectus sint voluptatibus omnis fugiat.\",\"permissions_count\":null},{\"id\":\"08020f46-91cf-32a8-b6ff-a3d50a82b7b7\",\"name\":\"voluptas-6a723f63e3bf2\",\"display_name\":\"Rerum ut quisquam sapiente et accusamus unde quas.\",\"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\":[\"3ada3ecf-409f-30c3-b208-7a88f4be4724\"]}" }, "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\":[\"d34162fb-0b0c-372e-ae38-5ac47946f1a9\"]}" }, "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\":\"07750ebd-c711-3e75-9327-780cc69fdf69\",\"name\":\"sint-6a723f63ef0cd\",\"display_name\":\"Nostrum soluta id sed occaecati voluptatum voluptatem ratione cum.\",\"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\":\"modi\",\"display_name\":\"Facilis vel deleniti voluptas qui omnis.\"},{\"id\":null,\"name\":\"amet\",\"display_name\":\"Et sit totam iusto blanditiis.\"}]}", "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\":\"ex\",\"display_name\":\"Sint atque voluptatem quis blanditiis.\"},{\"id\":null,\"name\":\"ipsum\",\"display_name\":\"Omnis qui eius aut quia voluptatum perferendis.\"}],\"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\":\"corporis\",\"display_name\":\"Incidunt error laboriosam qui vitae dolores.\"}}", "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\":\"491447ac-ea5b-3988-a7f3-1377fb5f48f0\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"boleto\",\"amount\":6059.32,\"due_date\":\"2026-08-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\":\"Qui maiores officiis aut in et dolores nam consequatur blanditiis reiciendis sed quia.\",\"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\":\"qui\",\"field2\":71,\"field3\":true,\"notes\":\"Consequatur quia aspernatur et hic quam ut.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"0a8638c0-7459-3700-b526-e96f0216ecbb\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"cheque\",\"amount\":9475.44,\"due_date\":\"2026-08-13T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"protest_date\":null,\"paid_amount\":null,\"interest_amount\":null,\"penalty_amount\":null,\"notary_fee_amount\":null,\"description\":\"Quisquam dolores voluptas et incidunt esse est aut vel eos esse quibusdam sit.\",\"is_recurring\":null,\"recurrence_config\":null,\"parent_id\":null,\"recurrence_order\":1,\"total_recurrences\":null,\"children_count\":0,\"remaining_recurrences\":null,\"has_children\":false,\"field1\":\"quas\",\"field2\":37,\"field3\":true,\"notes\":\"Atque rerum modi qui eum.\",\"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": "odio", "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]=odio" }, "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": "maiores", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "itaque", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "exercitationem", "description": "The uuid of an existing record in the works table.", "disabled": false }, { "key": "statuses[0]", "value": "a vencer", "description": "", "disabled": false }, { "key": "payment_method", "value": "cheque", "description": "Payment method.", "disabled": false }, { "key": "date_start", "value": "2023-01-01", "description": "Start date. O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "date_end", "value": "2023-12-31", "description": "End date. O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "protest_date_start", "value": "2026-08-04T16%3A37%3A08", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "protest_date_end", "value": "2026-08-04T16%3A37%3A08", "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]=maiores&suppliers[0]=itaque&works[0]=exercitationem&statuses[0]=a vencer&payment_method=cheque&date_start=2023-01-01&date_end=2023-12-31&protest_date_start=2026-08-04T16%3A37%3A08&protest_date_end=2026-08-04T16%3A37%3A08&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\":\"5e64316e-474a-391f-901b-cc78212f2c9d\",\"code\":null,\"type\":\"sa\\u00edda\",\"payment_method\":\"boleto\",\"amount\":3528.81,\"due_date\":\"2026-08-20T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"protest_date\":null,\"paid_amount\":null,\"interest_amount\":null,\"penalty_amount\":null,\"notary_fee_amount\":null,\"description\":\"Qui modi ea ut provident quia fugit sapiente minus ut iste eius quae.\",\"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\":\"suscipit\",\"field2\":75,\"field3\":false,\"notes\":\"Et fugiat tenetur fugit omnis.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"50d8c26e-4ea1-399e-af3d-710a4decbcde\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"cheque\",\"amount\":2698.18,\"due_date\":\"2026-08-28T03: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\":\"Repellat blanditiis sequi et dicta possimus est aut quasi aperiam atque nulla sequi ex.\",\"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\":\"exercitationem\",\"field2\":95,\"field3\":true,\"notes\":\"Odio et doloribus odit qui.\",\"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": "suscipit", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "qui", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "ut", "description": "The uuid of an existing record in the works table.", "disabled": false }, { "key": "statuses[0]", "value": "a vencer", "description": "", "disabled": false }, { "key": "payment_method", "value": "cheque", "description": "Payment method.", "disabled": false }, { "key": "date_start", "value": "2023-01-01", "description": "Start date. O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "date_end", "value": "2023-12-31", "description": "End date. O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "protest_date_start", "value": "2026-08-04T16%3A37%3A08", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "protest_date_end", "value": "2026-08-04T16%3A37%3A08", "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]=suscipit&suppliers[0]=qui&works[0]=ut&statuses[0]=a vencer&payment_method=cheque&date_start=2023-01-01&date_end=2023-12-31&protest_date_start=2026-08-04T16%3A37%3A08&protest_date_end=2026-08-04T16%3A37%3A08&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\":\"f7b94f07-1526-3427-ad3e-62eea59785a1\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"cheque\",\"amount\":4306.4,\"due_date\":\"2026-08-23T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"protest_date\":null,\"paid_amount\":null,\"interest_amount\":null,\"penalty_amount\":null,\"notary_fee_amount\":null,\"description\":\"Unde deserunt nostrum dolores eius et nihil est itaque aut eveniet.\",\"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\":\"expedita\",\"field2\":39,\"field3\":true,\"notes\":\"Quos quia repellendus repellat.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"9787968c-518e-32d8-bb54-b5a601ba63e0\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"boleto\",\"amount\":5030.95,\"due_date\":\"2026-08-26T03: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\":\"Error dolores labore doloremque eum a et ullam at quaerat sed sit.\",\"is_recurring\":null,\"recurrence_config\":null,\"parent_id\":null,\"recurrence_order\":1,\"total_recurrences\":null,\"children_count\":0,\"remaining_recurrences\":null,\"has_children\":false,\"field1\":\"temporibus\",\"field2\":74,\"field3\":true,\"notes\":\"Nesciunt qui illo quia et pariatur ipsum nobis.\",\"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\":\"51464b5f-18bb-364d-8345-047729bd5702\",\"customer_id\":\"b915e833-aa36-36f5-b106-78833477454e\",\"work_id\":\"98b08130-6722-3780-ad27-cb98cc63b703\",\"status\":\"Example Status\",\"protest_date\":\"2024-01-01\",\"bank_account_id\":\"d0a04ee9-3990-3233-95af-9b0ed9df8c55\",\"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\":\"earum\",\"installment_ids\":[\"tempore\"],\"payment_method\":\"cheque\",\"work_id\":\"iste\"}" }, "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": "est", "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": "est", "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\":\"e3ffb713-f130-37b0-941e-21cbcc50933d\",\"code\":null,\"type\":\"entrada\",\"payment_method\":\"cheque\",\"amount\":3252.7,\"due_date\":\"2026-08-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\":\"Aspernatur animi rerum deserunt aut vel sequi consectetur ipsam.\",\"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\":\"saepe\",\"field2\":52,\"field3\":false,\"notes\":\"Error sed cupiditate qui eveniet.\",\"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": "rerum", "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\":\"0fad8a50-3b49-3b6e-bae0-e26e51e68698\",\"customer_id\":\"fff994fa-7a52-31c9-8bb8-4de814fa95fe\",\"work_id\":\"393f481e-8c5d-391a-b339-fc018ffc2006\",\"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\":\"7b4d784f-adb7-3e4b-a3cc-718dea8d2564\",\"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": "atque", "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\":\"esperanza.wolf@example.net\",\"password\":\"password\"}" }, "description": "Login with email and password", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"token\":\"string\"}", "name": "" } ] }, { "name": "Me", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/user", "query": [], "raw": "{{baseUrl}}\/api\/auth\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the current user" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"94177f3a-e02d-3283-bcb9-69ede3c7b5e3\",\"name\":\"Hellen Hansen\",\"username\":\"tziemann\",\"email\":\"kennedi.reynolds@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\":\"joesph.mcdermott\",\"password\":\"password123\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"7b70d32e-25c1-3d1f-894c-16cf441643da\"],\"roles\":[\"1cf8af83-d1d5-393d-b9a8-fb40b1e9d2e6\"]}" }, "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\":\"pfdrbbckcwrmlf\",\"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": "porro", "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": "aut", "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": "11", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"amount\":1,\"description\":\"Example Description\",\"transaction_date\":\"2024-01-01\",\"transaction_category_id\":\"Example Transaction category id\"}" }, "description": "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": "10", "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\":\"ab78bc14-d0dd-35c7-94c9-920cb024da3f\",\"agency\":\"6539\",\"account\":\"5991581-5\",\"type\":\"corrente\",\"balance\":7981.19,\"holder_type\":\"pf\",\"alias\":\"fuga\",\"limit\":5032.66,\"available_balance\":13013.849999999999,\"used_limit\":0,\"available_limit\":5032.66,\"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\":\"99fa6e8e-6682-3e13-9d96-2e775ed00494\",\"agency\":\"7870\",\"account\":\"8958340-3\",\"type\":\"caixa\",\"balance\":9318.82,\"holder_type\":\"pf\",\"alias\":\"ipsa\",\"limit\":3461.82,\"available_balance\":12780.64,\"used_limit\":0,\"available_limit\":3461.82,\"is_default\":null,\"default_payment_method\":null,\"bank\":{\"id\":null,\"name\":null,\"code\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"267a0d34-0965-3255-b0b7-371a120eefc2\",\"agency\":\"0637\",\"account\":\"4250445-8\",\"type\":\"corrente\",\"balance\":4623.3,\"holder_type\":\"pf\",\"alias\":\"sint\",\"limit\":9610.01,\"available_balance\":14233.310000000001,\"used_limit\":0,\"available_limit\":9610.01,\"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\":\"2585739-0\",\"bank_id\":\"09968807-d981-31e7-8e09-fcfa381ed118\",\"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\":\"9584158-8\",\"bank_id\":\"3500a3f3-41f4-34f5-8d32-35a691a9a0be\",\"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": "11", "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\":\"214040c7-0878-37ea-a5ad-7d5023c7164b\",\"agency\":\"9132\",\"account\":\"7428767-5\",\"type\":\"poupan\\u00e7a\",\"balance\":861.89,\"holder_type\":\"pf\",\"alias\":\"dolores\",\"limit\":8262.28,\"available_balance\":9124.17,\"used_limit\":0,\"available_limit\":8262.28,\"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": "9", "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": "5", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"date_start\":\"2024-01-01\",\"date_end\":\"2024-01-01\"}" }, "description": "Get aggregated summary for the period" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"opening_balance\":\"number\",\"closing_balance\":\"number\",\"total_credit\":\"number\",\"total_debit\":\"number\",\"count\":\"integer\",\"date_start\":\"string\",\"date_end\":\"string\"}}", "name": "" } ] }, { "name": "List bank statements", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/bank-accounts\/:bankAccount\/statements", "query": [], "raw": "{{baseUrl}}\/api\/bank-accounts\/:bankAccount\/statements", "variable": [ { "id": "bankAccount", "key": "bankAccount", "value": "20", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"sort_by\":\"ipsa\",\"sort_desc\":true,\"page\":78,\"per_page\":25,\"q\":\"rwhnm\",\"type\":\"dep\u00f3sito\",\"date_start\":\"2026-08-04T16:37:08\",\"date_end\":\"2100-12-30\"}" }, "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": "1", "description": "" }, { "id": "bankStatement", "key": "bankStatement", "value": "dolore", "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\":\"7af3e89d-c020-3450-8160-8f10a53cfe00\",\"name\":\"Queir\\u00f3s-Domingues\",\"code\":\"673\"},{\"id\":\"ef81f769-2345-38d4-99e8-7a3cfafe476e\",\"name\":\"Queir\\u00f3s S.A.\",\"code\":\"911\"}],\"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\":\"1231a068-90a6-3190-9628-a0f2517b40f8\",\"name\":\"Uchoa e Jimenes Ltda.\",\"code\":\"581\"}}", "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": "Numquam+velit+ut+delectus+iure.", "description": "Description .", "disabled": false }, { "key": "categories[0]", "value": "quibusdam", "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": "sed", "description": "The uuid of an existing record in the bank_accounts table.", "disabled": false }, { "key": "customers[0]", "value": "eligendi", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "accusantium", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "illo", "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=Numquam+velit+ut+delectus+iure.&categories[0]=quibusdam&date_start=2021-01-01&date_end=2021-01-31&bank_accounts[0]=sed&customers[0]=eligendi&suppliers[0]=accusantium&works[0]=illo" }, "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": "In+ad+illum+beatae+assumenda+quos+quam+laudantium.", "description": "Description .", "disabled": false }, { "key": "categories[0]", "value": "laborum", "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": "voluptatibus", "description": "The uuid of an existing record in the bank_accounts table.", "disabled": false }, { "key": "customers[0]", "value": "deleniti", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "odio", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "reiciendis", "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=In+ad+illum+beatae+assumenda+quos+quam+laudantium.&categories[0]=laborum&date_start=2021-01-01&date_end=2021-01-31&bank_accounts[0]=voluptatibus&customers[0]=deleniti&suppliers[0]=odio&works[0]=reiciendis" }, "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\":\"d3df90a3-dd2f-3755-aad2-8f9bde5b841c\",\"code\":\"FC-46689259\",\"type\":\"sa\\u00edda\",\"amount\":-6497.22,\"description\":\"Facere minima aut quia ut qui dolorem.\",\"transaction_date\":\"2021-09-10T03:00:00.000000Z\",\"transaction_category\":{\"id\":null,\"name\":null,\"type\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"96b23704-16df-3f79-8d2f-cb6be69b8786\",\"code\":\"FC-12909739\",\"type\":\"transfer\\u00eancia\",\"amount\":-4521.07,\"description\":\"In et voluptatem sit error facilis nostrum.\",\"transaction_date\":\"2007-10-02T03: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\":\"dff1c295-47bd-31a6-b035-c43ebea7f0ea\",\"transaction_category_id\":\"c0a0f41c-c37a-34fa-8804-4df45e912188\",\"bank_account_id\":\"4c2d7cbc-18f2-3b2e-bd66-985669257382\",\"customer_id\":\"fd6b7bcf-cfa4-36e7-8724-7662a9a86e30\",\"supplier_id\":\"b7ac8249-952e-3e34-80f2-bf6d8c444f4f\",\"work_id\":\"18b93b4f-0cce-338a-a6bc-a9a1ef32fe7b\",\"amount\":1,\"description\":\"Example Description\",\"transaction_date\":\"2024-01-01\"}" }, "description": "Create a new cash flow" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Show cash flow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-flows\/:cashFlow", "query": [], "raw": "{{baseUrl}}\/api\/cash-flows\/:cashFlow", "variable": [ { "id": "cashFlow", "key": "cashFlow", "value": "16", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a cash flow" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"adb917ca-4900-3cb8-8747-c2121e16bfe1\",\"code\":\"FC-84269109\",\"type\":\"transfer\\u00eancia\",\"amount\":-4166.17,\"description\":\"Libero omnis occaecati veritatis quibusdam.\",\"transaction_date\":\"2014-07-05T03: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": "9", "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\":\"ec846751-1e12-35c8-8e1f-de148413bca1\",\"transaction_category_id\":\"f8e4f1d5-fe91-33ba-8329-fe8fee57163b\",\"bank_account_id\":\"9b43109d-cd3d-347b-b62c-7f4fc85accd9\",\"customer_id\":\"c05bc298-ad58-3ad4-846b-23e340e61fd5\",\"supplier_id\":\"575f2019-bcfe-3d3f-b697-6b3750ac7876\",\"work_id\":\"ab50d3cf-884b-3126-b99f-1b6265548e9d\",\"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": "18", "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\":\"5257c447-8ef4-3fdc-8a2b-84c5cac7edcb\",\"code\":null,\"opened_by\":null,\"opened_at\":\"2023-11-23T11:13:09.000000Z\",\"closed_by\":null,\"closed_at\":\"2012-08-15T00:10:33.000000Z\",\"opening_balance\":2520.79,\"closing_balance\":1761.87,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Fechado\",\"hasSnapshot\":false,\"created_at\":\"2017-05-08T08:32:08.000000Z\",\"updated_at\":\"1996-06-15T23:30:34.000000Z\"},{\"id\":\"2189161f-32d6-36a4-af10-ec76435a3a38\",\"code\":null,\"opened_by\":null,\"opened_at\":\"1972-07-19T06:02:04.000000Z\",\"closed_by\":null,\"closed_at\":\"2004-05-20T02:55:29.000000Z\",\"opening_balance\":1461.19,\"closing_balance\":8440.21,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Fechado\",\"hasSnapshot\":false,\"created_at\":\"1998-05-16T16:10:26.000000Z\",\"updated_at\":\"1997-06-23T19:23:27.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\":\"2b993a65-1fb6-3c31-8104-fc6397b777ab\",\"code\":null,\"opened_by\":null,\"opened_at\":\"2010-06-16T10:32:37.000000Z\",\"closed_by\":null,\"closed_at\":\"1985-07-24T01:19:33.000000Z\",\"opening_balance\":2168.71,\"closing_balance\":3166.19,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Aberto\",\"hasSnapshot\":false,\"created_at\":\"2025-10-23T08:02:31.000000Z\",\"updated_at\":\"1972-07-27T03:54:05.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": "5c92b1fb-8c92-357f-b669-3ddb571b7de7", "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": "3fbd8864-1dfb-3577-89ac-50d69885495a", "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": "9b524a1e-fc28-3198-8e46-d46b19721f4f", "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\":\"2d1bf7ad-1b02-3ffd-8937-da87d8d855ef\",\"code\":null,\"opened_by\":null,\"opened_at\":\"1991-10-09T14:47:41.000000Z\",\"closed_by\":null,\"closed_at\":\"1996-04-30T18:33:41.000000Z\",\"opening_balance\":1906.35,\"closing_balance\":1781.7,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Fechado\",\"hasSnapshot\":false,\"created_at\":\"1996-08-06T17:28:44.000000Z\",\"updated_at\":\"1994-11-25T12:20:54.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": "25b20775-6f09-3c89-b2c4-822fdec3a6c7", "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": "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\":\"83a2da2b-63c9-3006-80ba-77c3957a3e0c\"}" }, "description": "List all work contracts" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"b4bdb518-4dd1-3e60-a371-69312c2c4e34\",\"number\":\"092\\\/2026\",\"started_at\":\"2026-08-04\",\"deadline_at\":\"2027-08-04\",\"work\":{\"id\":\"a26c93fb-ab3b-42b7-8d9c-6a884cd9fa6b\",\"name\":\"Sofia Noel\\u00ed Zambrano\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"79c8dfb2-61e6-3175-a616-a74fe43c1c70\",\"number\":\"868\\\/2026\",\"started_at\":\"2026-08-04\",\"deadline_at\":\"2027-08-04\",\"work\":{\"id\":\"a26c93fb-b8eb-405c-8348-19d2af4626da\",\"name\":\"Dr. Andressa Jaqueline Soares Neto\"},\"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\":\"5f7e6924-fd60-34d3-836d-f8a9cd0a53c8\",\"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": "7", "description": "The ID of the contract." }, { "id": "contract", "key": "contract", "value": "vitae", "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\":\"0236136e-560b-3c50-90a6-89eee6d4d661\",\"number\":\"397\\\/2026\",\"started_at\":\"2026-08-04\",\"deadline_at\":\"2027-08-04\",\"work\":{\"id\":\"a26c93fb-c637-4281-b867-6ed87da7306c\",\"name\":\"Elo\\u00e1 Ariana Ramos\"},\"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": "7", "description": "The ID of the contract." }, { "id": "contract", "key": "contract", "value": "voluptatem", "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": "et", "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\":\"055f3ce3-d0e3-34cc-ade5-a07ebd883366\",\"name\":\"David Pereira Barreto\",\"email\":\"melinda04@example.org\",\"phone\":\"(18) 90141-8736\",\"document\":\"476.343.538-84\",\"type\":\"pj\",\"responsible\":\"Dr. Hort\\u00eancia Estrada Benez 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},{\"id\":\"2efda8f2-b99c-3da4-9767-2d34885b230c\",\"name\":\"Srta. Simone Verdara Neto\",\"email\":\"zneves@example.net\",\"phone\":\"(41) 90999-8062\",\"document\":\"920.866.658-14\",\"type\":\"pf\",\"responsible\":\"Sr. Lorenzo Ramos\",\"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": "13", "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\":\"0778bc51-1e79-3bd7-93c0-708d4b1a9707\",\"name\":\"Sophia Daniella Delatorre Filho\",\"email\":\"diogo.rezende@example.org\",\"phone\":\"(81) 3429-5457\",\"document\":\"205.703.010-50\",\"type\":\"pf\",\"responsible\":\"Sr. Agostinho Fabr\\u00edcio Fernandes\",\"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": "20", "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,\"work_id\":\"fadb3131-0a17-378b-b95c-985a630662da\",\"contract_id\":\"f3523054-be92-312d-a734-c954e2f52bd2\",\"status_id\":\"1170fc66-e63e-3048-939c-193a48efda4d\",\"filled_by\":\"dad38031-e0dd-305c-b150-3a142abbef46\",\"responsible_id\":\"5e07a060-e038-3523-88f9-d14c766a2097\",\"date_from\":\"2024-01-01\",\"date_to\":\"2024-01-01\"}" }, "description": "List all daily work reports (RDO)" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"9b1cbc60-a69c-3dd2-bd50-6974e9eaa8da\",\"code\":\"RDO-001\",\"report_number\":1,\"date\":\"2026-08-04\",\"status\":{\"id\":\"a26c93fc-189d-49fc-8889-cf8695654dfb\",\"slug\":null,\"name\":null,\"abbreviation\":\"et\",\"color\":\"#7d341c\",\"text_color\":\"#da3eee\"},\"work\":{\"id\":\"a26c93fc-0ea9-41da-bfd7-73d56b75a188\",\"name\":\"Vicente Oliveira Filho\",\"started_at\":\"1979-12-20 00:03:17\"},\"filled_by\":{\"id\":\"a26c93fc-14d5-4943-8498-b717a7ce32d0\",\"name\":\"Janice Murray\"},\"contract_number\":\"029\\\/2026\",\"deadline_at\":\"2027-08-04\",\"technical_responsible\":{\"name\":null,\"certification\":null,\"crea\":null},\"activities\":[],\"occurrences\":null,\"next_day_forecast\":null,\"finalized_at\":null,\"content_hash\":null,\"gov_br_validation_url\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"3ab3521d-6d5f-334c-9170-affbd69d901f\",\"code\":\"RDO-001\",\"report_number\":1,\"date\":\"2026-08-04\",\"status\":{\"id\":\"a26c93fc-2429-470a-960f-ea5fdab880d0\",\"slug\":null,\"name\":null,\"abbreviation\":\"ipsum\",\"color\":\"#c3cde8\",\"text_color\":\"#701f6e\"},\"work\":{\"id\":\"a26c93fc-1da7-4c18-8dfa-24f14cad3668\",\"name\":\"Isabelly Vieira Faro\",\"started_at\":\"2022-11-10 10:48:52\"},\"filled_by\":{\"id\":\"a26c93fc-2260-4f43-8ba8-06e97ed931c6\",\"name\":\"Dr. Collin Crooks PhD\"},\"contract_number\":\"718\\\/2026\",\"deadline_at\":\"2027-08-04\",\"technical_responsible\":{\"name\":null,\"certification\":null,\"crea\":null},\"activities\":[],\"occurrences\":null,\"next_day_forecast\":null,\"finalized_at\":null,\"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": "sunt", "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\":\"1475e7d6-8063-3fb9-8e5c-3fec5832c430\",\"code\":\"RDO-001\",\"report_number\":1,\"date\":\"2026-08-04\",\"status\":{\"id\":\"a26c93fc-376b-4f12-9a9b-9da4979788ca\",\"slug\":null,\"name\":null,\"abbreviation\":\"velit\",\"color\":\"#8d20a4\",\"text_color\":\"#239af6\"},\"work\":{\"id\":\"a26c93fc-3104-4687-8bc5-39c80892b963\",\"name\":\"Leo Zamana Neto\",\"started_at\":\"1991-03-23 09:03:05\"},\"filled_by\":{\"id\":\"a26c93fc-35af-4cc6-85b9-058d019098a0\",\"name\":\"Mr. Skye Corkery III\"},\"contract_number\":\"089\\\/2026\",\"deadline_at\":\"2027-08-04\",\"technical_responsible\":{\"name\":null,\"certification\":null,\"crea\":null},\"activities\":[],\"occurrences\":null,\"next_day_forecast\":null,\"finalized_at\":null,\"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\":\"f2d74da8-053a-3931-9d4b-6df9e363910f\"}" }, "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": "atque", "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\":\"f8461be5-4ad4-4918-a9fc-f492d28e4af0\",\"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": "occaecati", "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": "consequatur", "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": "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": "illo", "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": "necessitatibus", "description": "Daily Log UUID" }, { "id": "id", "key": "id", "value": "quo", "description": "The ID of the photo." }, { "id": "photo", "key": "photo", "value": "alias", "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": "numquam", "description": "Daily Log UUID" }, { "id": "photo", "key": "photo", "value": "ducimus", "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": "quam", "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\":\"35b895dd-a896-3794-8f9b-81eed86f892d\",\"name\":\"Perspiciatis\",\"code\":\"LHZ\",\"description\":\"Rerum harum assumenda et quia rerum sit qui.\",\"active\":true},{\"id\":\"191e4beb-1fc8-3c7d-8d3b-af2e1a56e748\",\"name\":\"Vel\",\"code\":\"TBJ\",\"description\":\"Ratione ipsa necessitatibus aut architecto iusto occaecati eligendi.\",\"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": "quo", "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\":\"c731042e-cda5-3d35-82d8-a2cf73dcf009\",\"name\":\"Vel\",\"code\":\"ZWA\",\"description\":\"Quia in sit beatae doloremque aut.\",\"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": "atque", "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": "dolorum", "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\":\"3ed73c49-92bf-336e-b980-ec8b392bfcb1\",\"name\":\"Dr. Aline Quintana\",\"description\":\"Hic eum eum fugit quibusdam. Sint soluta asperiores tenetur provident aut. Consequatur error est ipsa.\",\"module\":\"document\"},{\"id\":\"2e757f64-4030-3ff7-aa29-972741c94374\",\"name\":\"S\\u00e9rgio \\u00cdtalo Val\\u00eancia\",\"description\":\"Ut porro minima quae ab unde qui nobis asperiores. Animi incidunt deserunt suscipit dolores velit. Non consequatur deleniti voluptatibus sint neque consectetur itaque corporis.\",\"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": "id", "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\":\"a77e5fae-53dc-3608-97c4-e3bd8e856011\",\"name\":\"Diogo de Arruda Jr.\",\"description\":\"Eaque voluptates dolor rem quo nemo. Distinctio vel qui at. Suscipit voluptates aliquid dolore occaecati. Tenetur quam aut sed molestias error modi distinctio.\",\"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": "eos", "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": "reiciendis", "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": "inventore", "description": "The uuid of an existing record in the document_categories table.", "disabled": false }, { "key": "documentable_type", "value": "unde", "description": "Type of the related documentable entity. The type of an existing record in the documentables table.", "disabled": false }, { "key": "customers[0]", "value": "neque", "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 } ], "raw": "{{baseUrl}}\/api\/documents?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Document+name&categories[0]=inventore&documentable_type=unde&customers[0]=neque&suppliers[0]=autem" }, "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\":\"6dd2d17d-2b60-35f8-a62a-9df0fb1fcdf8\",\"name\":\"Sr. Joaquim Kauan Saito\",\"file\":{\"id\":null,\"url\":null,\"extension\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"2ad4bbbd-ec19-3347-b932-bcc8f1724972\",\"name\":\"Srta. Beatriz Zarago\\u00e7a\",\"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": "1", "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\":\"08e43db9-d74d-34ab-8b2c-84c9adea9abf\",\"name\":\"Larissa Kamila Carrara\",\"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\":\"83390706-450e-3580-88ba-8b25edb35b67\",\"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": "1", "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\":\"f989cdc9-ed79-33cf-adf5-1f6e7c7980df\",\"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\":\"omnis\",\"renewal_status\":\"ignored\",\"urgency\":\"expires_7_days\",\"employee_id\":\"fugit\",\"epi_type_id\":\"nesciunt\"}" }, "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": "eius", "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\",\"lot\":\"LOTE-001\"}" }, "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": "error", "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": "ut", "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\":\"et\"}" }, "description": "List all EPI types" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"651aabac-688c-38e5-87f0-e08db412aff1\",\"name\":\"repudiandae ea\",\"default_validity_days\":526,\"requires_signature\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"fdb1d867-abef-30c7-a50a-0fa635217e3f\",\"name\":\"error sed\",\"default_validity_days\":342,\"requires_signature\":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 EPI type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/epi-types\/:epiType", "query": [], "raw": "{{baseUrl}}\/api\/epi-types\/:epiType", "variable": [ { "id": "epiType", "key": "epiType", "value": "vitae", "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\":\"12f98b97-b524-3d2e-a4cc-556423c69c8d\",\"name\":\"reprehenderit voluptatum\",\"default_validity_days\":394,\"requires_signature\":false,\"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}" }, "description": "Create a new EPI type" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "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": "et", "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}" }, "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": "iure", "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\":\"9b5a7fc7-7745-4824-bfcd-b6da51378e83\",\"name\":\"in\",\"description\":\"Odio blanditiis et iusto maxime.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"fdce0b9a-b57a-4a22-9596-4ab234bdaa87\",\"name\":\"velit\",\"description\":\"Quod impedit est numquam sapiente nihil nulla.\",\"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": "culpa", "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\":\"bdaa5c97-0f85-4e9d-b9aa-204cac0c6c5d\",\"name\":\"vero\",\"description\":\"Fugiat similique quidem in delectus esse quia ut.\",\"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": "vel", "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": "laboriosam", "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\":true,\"page\":10,\"per_page\":22,\"q\":\"amet\",\"employee_id\":\"sunt\",\"has_term\":true}" }, "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 } ], "raw": "{{baseUrl}}\/api\/employees?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Jo%C3%A3o+Silva" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all employees" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"5cda545c-0c4e-445a-bda2-a658027fd380\",\"name\":\"Allan Bonilha\",\"cpf\":\"249.127.216-02\",\"rg\":null,\"ctps\":null,\"phone\":null,\"birthdate\":\"1972-07-10T03:00:00.000000Z\",\"email\":\"nadia.lozano@example.org\",\"pis_pasep\":null,\"admission_date\":\"2003-12-13T02:00:00.000000Z\",\"daily_salary\":null,\"monthly_salary\":\"5615.64\",\"nationality\":null,\"place_of_birth\":\"Victor do Norte\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":\"a26c93fc-e48b-4860-afaf-96e9e9c2bd96\",\"name\":\"et\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"c9f41254-cbfd-468e-aea6-709e75ec328a\",\"name\":\"Dr. B\\u00e1rbara Saito\",\"cpf\":\"550.815.124-60\",\"rg\":\"073865905\",\"ctps\":\"666564782\",\"phone\":null,\"birthdate\":\"1972-12-20T03:00:00.000000Z\",\"email\":\"jimenes.gian@example.com\",\"pis_pasep\":null,\"admission_date\":\"2024-08-07T03:00:00.000000Z\",\"daily_salary\":\"176.99\",\"monthly_salary\":null,\"nationality\":\"Su\\u00e9cia\",\"place_of_birth\":\"Santa Leandro\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":\"a26c93fc-eb8e-4d0f-a03b-7c63362b810c\",\"name\":\"similique\"},\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":\"\\\/?page=9\",\"next\":null},\"meta\":{\"current_page\":10,\"from\":91,\"last_page\":1,\"links\":[{\"url\":\"\\\/?page=9\",\"label\":\"« Anterior\",\"page\":9,\"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\":92,\"total\":2}}", "name": "" } ] }, { "name": "Show employee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:id", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show an employee" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"9cd4a490-5e10-4fe2-9419-ec7a5429343c\",\"name\":\"Clara Teles\",\"cpf\":\"214.643.087-16\",\"rg\":null,\"ctps\":\"488619712\",\"phone\":\"(69) 96995-7350\",\"birthdate\":\"2018-06-14T03:00:00.000000Z\",\"email\":null,\"pis_pasep\":null,\"admission_date\":null,\"daily_salary\":\"201.93\",\"monthly_salary\":\"8850.22\",\"nationality\":null,\"place_of_birth\":null,\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":\"a26c93fc-f2ac-454b-9b66-7a622f50006d\",\"name\":\"illum\"},\"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\":\"71853782-e11a-4849-a6aa-b586e07b19ad\",\"pis_pasep\":\"Example Pis pasep\",\"admission_date\":\"2024-01-01\",\"daily_salary\":1,\"monthly_salary\":1,\"nationality\":\"Example Nationality\",\"place_of_birth\":\"Example Place of birth\",\"address\":{\"0\":\"example1\",\"1\":\"example2\",\"street\":\"Example Address street\",\"number\":\"Example Address number\",\"complement\":\"Example Address complement\",\"neighborhood\":\"Example Address neighborhood\",\"city\":\"Example Address city\",\"state\":\"Example Address state\",\"zip_code\":\"Example Address zip code\"}}" }, "description": "Create a new employee" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update employee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:id", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:id", "variable": [ { "id": "id", "key": "id", "value": "4", "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\":\"7a77f419-5466-49fa-8fd2-1897bc633f17\",\"pis_pasep\":\"Example Pis pasep\",\"admission_date\":\"2024-01-01\",\"daily_salary\":1,\"monthly_salary\":1,\"nationality\":\"Example Nationality\",\"place_of_birth\":\"Example Place of birth\",\"address\":{\"0\":\"example1\",\"1\":\"example2\",\"street\":\"Example Address street\",\"number\":\"Example Address number\",\"complement\":\"Example Address complement\",\"neighborhood\":\"Example Address neighborhood\",\"city\":\"Example Address city\",\"state\":\"Example Address state\",\"zip_code\":\"Example Address zip code\"}}" }, "description": "Update an employee" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete employee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee", "variable": [ { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an employee" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "List employee bank accounts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee_id\/bank-account", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee_id\/bank-account", "variable": [ { "id": "employee_id", "key": "employee_id", "value": "2", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all bank accounts for an employee" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create employee bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee_id\/bank-account", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee_id\/bank-account", "variable": [ { "id": "employee_id", "key": "employee_id", "value": "8", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"bank_id\":\"qui\",\"agency\":\"qnhhzwjplbdjcwjnlnzxhzx\",\"account\":\"sqeysniow\",\"account_type\":\"corrente\",\"pix_key\":\"lkzofheahtwbgeo\",\"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": "6", "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\":\"iure\",\"agency\":\"ivcpbvskijaccam\",\"account\":\"jqvnibhfibdecnpmam\",\"account_type\":\"corrente\",\"pix_key\":\"cykemynmdyezexnumf\",\"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": "17", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "laboriosam", "description": "Employee UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"q\":\"soluta\",\"status\":\"valid\",\"epi_type_id\":\"sapiente\"}" }, "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": "fugit", "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": "10", "description": "The ID of the employee." }, { "id": "id", "key": "id", "value": "neque", "description": "EPI delivery UUID" }, { "id": "employee", "key": "employee", "value": "ut", "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": "18", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "veniam", "description": "Employee UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"epi_type_id\":\"04e7682b-1f0a-3d2f-88c7-bbc534a3f43c\",\"delivery_date\":\"2024-01-01\",\"quantity\":1,\"condition\":\"Example Condition\",\"lot\":\"Example Lot\"}" }, "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": "officiis", "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\",\"items\":[{\"epi_type_id\":\"f8a51412-fa88-3f14-a15d-485682ba4e2b\",\"quantity\":1,\"condition\":\"Example Items * condition\",\"lot\":\"Example Items * lot\"},null]}" }, "description": "Register multiple EPI deliveries as initial kit" }, "response": [ { "header": [], "code": 201, "body": null, "name": "" } ] }, { "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": "3", "description": "The ID of the employee." }, { "id": "id", "key": "id", "value": "dolorem", "description": "EPI delivery UUID" }, { "id": "employee", "key": "employee", "value": "consequatur", "description": "Employee UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"epi_type_id\":\"f67c4c9b-8c80-3366-a5d3-17174d3cde4a\",\"delivery_date\":\"2024-01-01\",\"quantity\":1,\"condition\":\"Example Condition\",\"lot\":\"Example Lot\"}" }, "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": "est", "description": "Employee UUID" }, { "id": "id", "key": "id", "value": "aut", "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": "15", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "tenetur", "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\":24,\"per_page\":4,\"q\":\"nostrum\",\"employee_id\":\"eos\",\"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": "iste", "description": "Employee UUID" }, { "id": "kitUuid", "key": "kitUuid", "value": "80e8ad4f-d11d-3c32-9b5e-1673d4f1ce85", "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": "nostrum", "description": "Employee UUID" }, { "id": "kitUuid", "key": "kitUuid", "value": "c23cf65b-5f67-3ce9-a6a5-1681848167d6", "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": "c57170af-54a1-324b-8178-293644457c77", "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": "bad0bced-a99f-3715-88e8-4ae4ec14c9f0", "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": "118e22bd-56f8-3c1a-9b74-0b42072406d6", "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\":\"explicabo\",\"supplier_id\":\"et\",\"work_id\":\"illum\",\"start_date\":\"2026-08-04T16:37:10\",\"end_date\":\"2124-08-22\",\"per_page\":19}" }, "description": "Lista notas fiscais com filtros por busca, fornecedor, obra e per\u00edodo." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"nfe_access_key\":null,\"nfe_number\":null,\"nfe_series\":null,\"issue_date\":null,\"total_value\":null,\"emit\":{\"cnpj\":null,\"name\":null},\"dest\":{\"document\":null,\"name\":null},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null},{\"id\":null,\"nfe_access_key\":null,\"nfe_number\":null,\"nfe_series\":null,\"issue_date\":null,\"total_value\":null,\"emit\":{\"cnpj\":null,\"name\":null},\"dest\":{\"document\":null,\"name\":null},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":15,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create fiscal document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/fiscal-documents", "query": [], "raw": "{{baseUrl}}\/api\/fiscal-documents" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"s3_file_path\":\"porro\",\"original_filename\":\".xml$\\\/i\",\"work_ids\":[\"praesentium\"]}" }, "description": "Registra uma NFe a partir do XML j\u00e1 enviado ao S3 e o vincula \u00e0s obras informadas." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":null,\"nfe_access_key\":null,\"nfe_number\":null,\"nfe_series\":null,\"issue_date\":null,\"total_value\":null,\"emit\":{\"cnpj\":null,\"name\":null},\"dest\":{\"document\":null,\"name\":null},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null}}", "name": "" } ] }, { "name": "Get fiscal document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/fiscal-documents\/:fiscalDocument", "query": [], "raw": "{{baseUrl}}\/api\/fiscal-documents\/:fiscalDocument", "variable": [ { "id": "fiscalDocument", "key": "fiscalDocument", "value": "alias", "description": "UUID da nota fiscal" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Detalha uma nota fiscal com arquivos e obras vinculadas." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"nfe_access_key\":null,\"nfe_number\":null,\"nfe_series\":null,\"issue_date\":null,\"total_value\":null,\"emit\":{\"cnpj\":null,\"name\":null},\"dest\":{\"document\":null,\"name\":null},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null}}", "name": "" } ] }, { "name": "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": "aut", "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": "eum", "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\":\"voluptatem\",\"name\":\"enim\",\"extension\":\"animi\"}}" }, "description": "Anexa um arquivo (ex.: PDF da NF) j\u00e1 enviado ao S3 \u00e0 nota fiscal." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"nfe_access_key\":null,\"nfe_number\":null,\"nfe_series\":null,\"issue_date\":null,\"total_value\":null,\"emit\":{\"cnpj\":null,\"name\":null},\"dest\":{\"document\":null,\"name\":null},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null}}", "name": "" } ] }, { "name": "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": "nostrum", "description": "UUID da nota fiscal" }, { "id": "file", "key": "file", "value": "vel", "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\":null,\"nfe_access_key\":null,\"nfe_number\":null,\"nfe_series\":null,\"issue_date\":null,\"total_value\":null,\"emit\":{\"cnpj\":null,\"name\":null},\"dest\":{\"document\":null,\"name\":null},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null}}", "name": "" } ] }, { "name": "Sync works", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/fiscal-documents\/:fiscalDocument\/works", "query": [], "raw": "{{baseUrl}}\/api\/fiscal-documents\/:fiscalDocument\/works", "variable": [ { "id": "fiscalDocument", "key": "fiscalDocument", "value": "fugiat", "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\":[\"similique\"]}" }, "description": "Sincroniza o v\u00ednculo documental da nota fiscal com N obras." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"nfe_access_key\":null,\"nfe_number\":null,\"nfe_series\":null,\"issue_date\":null,\"total_value\":null,\"emit\":{\"cnpj\":null,\"name\":null},\"dest\":{\"document\":null,\"name\":null},\"financial_status\":\"pending\",\"products_imported_at\":null,\"created_at\":null}}", "name": "" } ] } ] }, { "name": "Import", "description": "Endpoints for managing NFe imports and product processing.", "item": [ { "name": "NFe Imports", "description": "Import and process Brazilian electronic invoice (NFe) files.", "item": [ { "name": "Create NFe Import", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports\/nfe\/products", "query": [], "raw": "{{baseUrl}}\/api\/imports\/nfe\/products" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"s3_file_path\":\"imports\\\/nfe_12345.xml\",\"original_filename\":\"nota_fiscal_001.xml\",\"import_type\":\"nfe\",\"fiscal_document_id\":\"019556e7-2e9f-777c-a177-30bbf0646c32\"}" }, "description": "Upload and process a Brazilian NFe (Nota Fiscal Eletr\u00f4nica) XML file. The file should be uploaded to S3 first, then this endpoint processes it asynchronously." }, "response": [ { "header": [], "code": 201, "body": "{\n \"import_id\": \"9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\",\n \"status\": \"pending\",\n \"channel\": \"import-progress.9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\"\n }", "name": "Import created successfully" }, { "header": [], "code": 404, "body": "{\"error\": \"Arquivo n\u00e3o encontrado no S3\"}", "name": "File not found in S3" }, { "header": [], "code": 422, "body": "{\"error\": \"Arquivo XML inv\u00e1lido ou n\u00e3o \u00e9 uma NFe\"}", "name": "Invalid XML or not a valid NFe" } ] }, { "name": "List Imports", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of imports per page. O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "status", "value": "completed", "description": "Filter imports by status (pending, processing, completed, failed).", "disabled": false }, { "key": "import_type", "value": "nfe", "description": "Filter imports by type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/imports?sort_by=created_at&sort_desc=1&page=1&per_page=15&status=completed&import_type=nfe" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all NFe imports with filtering and pagination options." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\",\n \"status\": \"completed\",\n \"import_type\": \"nfe\",\n \"original_filename\": \"nota_fiscal_001.xml\",\n \"nfe_number\": \"123456\",\n \"nfe_date\": \"2023-12-01\",\n \"total_products\": 15,\n \"processed_products\": 15,\n \"progress_percentage\": 100.00,\n \"imported_at\": \"2023-12-01T10:30:00.000Z\",\n \"supplier\": {\n \"name\": \"Fornecedor Ltda\",\n \"document\": \"12345678000199\"\n }\n }\n ]\n }", "name": "Imports retrieved successfully" } ] }, { "name": "Get Import Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports\/:importId", "query": [], "raw": "{{baseUrl}}\/api\/imports\/:importId", "variable": [ { "id": "importId", "key": "importId", "value": "pariatur", "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": "quia", "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": "occaecati", "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": "et", "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": "facere", "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\":\"voluptatum\",\"sort_desc\":false,\"page\":89,\"per_page\":12}" }, "description": "List all states paginated" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"name\":\"nam laborum\",\"abbreviation\":\"KN\"},{\"id\":null,\"name\":\"accusamus laudantium\",\"abbreviation\":\"SE\"}],\"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\":\"Corwinborough\"},{\"id\":null,\"name\":\"North Sigmundchester\"}]}", "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": "modi", "description": "", "disabled": false }, { "key": "document", "value": "dolorem", "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=modi&document=dolorem&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\":\"ff115612-01aa-3b1b-a6cb-3379f4e68381\",\"receipt_number\":\"REC-8460\",\"receiver_type\":\"employee\",\"receiver\":{\"id\":null,\"name\":\"Gerard Kohler\",\"document\":\"773.406.599-33\"},\"payment\":{\"amount\":4821.02,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"check\",\"description\":\"Aut vel vel dolor et.\"},\"issuer\":{\"name\":\"D'Amore-Langworth\",\"document\":\"62.574.550\\\/3156-20\"},\"issue\":{\"date\":\"2026-07-29\",\"city\":\"South Justina\",\"state\":\"SC\"},\"created_by\":{\"id\":\"a26c93fd-fb1e-4c2e-942f-9fa86c5da2c2\",\"name\":\"Christy Frami\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"2261e0d3-bc6c-30c5-9006-d7c77ce04b0a\",\"receipt_number\":\"REC-0299\",\"receiver_type\":\"employee\",\"receiver\":{\"id\":null,\"name\":\"Turner Gleichner\",\"document\":\"615.077.424-97\"},\"payment\":{\"amount\":6002.21,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"bank_transfer\",\"description\":\"Cum atque nam explicabo minus atque nihil nihil.\"},\"issuer\":{\"name\":\"Koepp, Koelpin and Champlin\",\"document\":\"60.868.303\\\/2981-60\"},\"issue\":{\"date\":\"2026-08-01\",\"city\":\"Jermaineborough\",\"state\":\"RS\"},\"created_by\":{\"id\":\"a26c93fd-fe7b-4c53-931b-38cf323a9ae4\",\"name\":\"Ms. Opal Balistreri\"},\"created_at\":null,\"updated_at\":null}],\"pagination\":{\"total\":2,\"count\":2,\"per_page\":10,\"current_page\":1,\"total_pages\":1,\"has_more_pages\":false},\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Show receipt cash flow config", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-receipts\/cash-flow-config", "query": [], "raw": "{{baseUrl}}\/api\/payment-receipts\/cash-flow-config" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lista cada forma de pagamento e se ela gera lancamento automatico no fluxo de caixa" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update receipt cash flow config", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-receipts\/cash-flow-config", "query": [], "raw": "{{baseUrl}}\/api\/payment-receipts\/cash-flow-config" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"methods\":[{\"method\":\"bank_transfer\",\"eligible\":false}]}" }, "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\":\"d15fedc4-61cb-3117-8015-254de397cb62\",\"receipt_number\":\"REC-7442\",\"receiver_type\":\"custom\",\"receiver\":{\"id\":null,\"name\":\"Ettie Douglas PhD\",\"document\":\"048.869.898-38\"},\"payment\":{\"amount\":5985.98,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"cash\",\"description\":\"Labore quasi quo ad nisi eum repellendus voluptatem.\"},\"issuer\":{\"name\":\"Barrows and Sons\",\"document\":\"87.454.897\\\/6251-86\"},\"issue\":{\"date\":\"2026-07-19\",\"city\":\"Garrisonstad\",\"state\":\"PE\"},\"created_by\":{\"id\":\"a26c93fe-0df5-4762-8d14-077e87bde825\",\"name\":\"Jeanie Kulas\"},\"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\":\"aaf63b47-e513-487b-9c3d-c67609a112ea\",\"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\":\"0e9ccb98-65e7-3de8-9cc0-c77767120f70\",\"bank_account_id\":\"496aa1a5-da22-3d39-adda-8728edcf9f33\"}" }, "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\":\"a8053a0e-fe0f-48c6-b618-d75a227652cd\",\"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\":\"5e7415ae-2693-387b-b336-238b4b97a53d\",\"bank_account_id\":\"df0b9ccd-f472-3a42-ac20-c33418e16f9a\"}" }, "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": "4", "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\":\"9bc0674a-ee27-37aa-a516-8d4cb8104714\",\"receipt_number\":\"REC-3028\",\"receiver_type\":\"custom\",\"receiver\":{\"id\":null,\"name\":\"Kaelyn Thompson DDS\",\"document\":\"164.193.879-19\"},\"payment\":{\"amount\":5138.47,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"bank_transfer\",\"description\":\"Dolor cum at incidunt non optio enim rerum.\"},\"issuer\":{\"name\":\"Weber Group\",\"document\":\"35.162.275\\\/3740-26\"},\"issue\":{\"date\":\"2026-07-18\",\"city\":\"Port Leonel\",\"state\":\"SP\"},\"created_by\":{\"id\":\"a26c93fe-3db6-453a-a461-35e4f00e4d7e\",\"name\":\"Dennis Graham\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"6ccbdc7c-2f31-317c-b2e5-00a9c71d1101\",\"receipt_number\":\"REC-4314\",\"receiver_type\":\"employee\",\"receiver\":{\"id\":null,\"name\":\"Mr. Brett Lesch\",\"document\":\"832.315.808-30\"},\"payment\":{\"amount\":2699.73,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"check\",\"description\":\"Minima atque in perspiciatis cum autem sed exercitationem.\"},\"issuer\":{\"name\":\"Klein-Wiza\",\"document\":\"31.633.661\\\/5997-63\"},\"issue\":{\"date\":\"2026-07-08\",\"city\":\"West Sabina\",\"state\":\"PE\"},\"created_by\":{\"id\":\"a26c93fe-3fdc-4efc-a578-6128caf07e5d\",\"name\":\"Malvina Wolff\"},\"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\":\"d58c2125-03b3-3928-91e7-9d7066d86619\",\"name\":\"eius\",\"display_name\":\"Dignissimos culpa veritatis id.\"},{\"id\":\"6124b555-f024-3cf7-bb27-8b10eacba535\",\"name\":\"adipisci\",\"display_name\":\"Et sed fugit quidem voluptas nemo.\"}],\"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\":\"823be50a-20f1-3147-b602-13a7f685c198\",\"name\":\"est-consequatur\",\"display_name\":\"eveniet alias quia\",\"created_at\":null,\"updated_at\":null},{\"id\":\"09d42195-f358-3453-ac4a-933c68ed29b2\",\"name\":\"a-mollitia\",\"display_name\":\"nobis ab enim\",\"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\":\"f0789a10-eb9b-3cae-90a9-271b40ec51d7\",\"name\":\"saepe-ea-architecto\",\"display_name\":\"excepturi voluptas enim\",\"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\":[\"e59c3be4-0ab4-3b2e-a886-387d591098f4\"]}" }, "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\":\"11329154-3110-3c04-aaff-ebecdc04086d\",\"name\":\"provident-culpa-reiciendis\",\"display_name\":\"sit sed reiciendis\",\"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\":[\"74946861-0977-3553-a5d0-da9f0b75faf9\"]}" }, "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\":\"a05259e7-d755-3e84-9a26-0f531ccab0e5\",\"name\":\"occaecati-veritatis\",\"display_name\":\"porro expedita incidunt\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] } ] }, { "name": "Product Brands", "description": "Endpoints for product brands", "item": [ { "name": "List product brands", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-brands", "query": [ { "key": "q", "value": "Structure", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/api\/product-brands?q=Structure" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all product brands" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"b92bd9fb-76a5-3087-8d78-f57bfc19c4bf\",\"name\":\"Srta. Nayara Pontes\",\"created_at\":null,\"updated_at\":null},{\"id\":\"84da330b-7b1f-3a5f-9c7a-6dc8816d553c\",\"name\":\"Sr. Ricardo Faria Louren\\u00e7o Neto\",\"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\":\"286af350-717f-3835-b83a-27a5d8553161\",\"name\":\"Sr. Luan God\\u00f3i Alcantara Jr.\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create product brand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-brands", "query": [], "raw": "{{baseUrl}}\/api\/product-brands" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\"}" }, "description": "Create a new product brand" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update product brand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-brands\/:productBrand", "query": [], "raw": "{{baseUrl}}\/api\/product-brands\/:productBrand", "variable": [ { "id": "productBrand", "key": "productBrand", "value": "beatae", "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": "eum", "description": "Product brand UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a product brand" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Product Families", "description": "Endpoints for product families", "item": [ { "name": "List product families", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-families", "query": [ { "key": "q", "value": "Structure", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/api\/product-families?q=Structure" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all product families" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"fbe640b0-48c1-3b3a-b28c-fdb0d6f85e25\",\"name\":\"Rog\\u00e9rio Fabiano Maia\",\"created_at\":null,\"updated_at\":null},{\"id\":\"38e25a47-d33c-39f0-9f3c-0bc7c0f76879\",\"name\":\"Benedito Caio Romero Neto\",\"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": "dolor", "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\":\"20ffb86b-3878-3472-94e4-73376bf00497\",\"name\":\"Cec\\u00edlia Marinho Carrara Sobrinho\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create product family", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-families", "query": [], "raw": "{{baseUrl}}\/api\/product-families" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\"}" }, "description": "Create a new product family" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update product family", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-families\/:productFamily", "query": [], "raw": "{{baseUrl}}\/api\/product-families\/:productFamily", "variable": [ { "id": "productFamily", "key": "productFamily", "value": "corrupti", "description": "Product family UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\"}" }, "description": "Update a product family" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete product family", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-families\/:productFamily", "query": [], "raw": "{{baseUrl}}\/api\/product-families\/:productFamily", "variable": [ { "id": "productFamily", "key": "productFamily", "value": "sed", "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\":\"d63f1d10-444a-38e0-b1fd-53a7dfcd53d4\",\"user_id\":\"f0c86231-e795-398b-bb63-ef7300f33a04\",\"responsible_id\":\"a3702791-1c7e-3b3a-8510-3dc2cda45cee\",\"per_page\":1,\"sort\":\"Example Sort\",\"sort_desc\":true}" }, "description": "List all product quantity lists" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"8c860ac0-6d79-34d8-a00f-9228033b43b2\",\"name\":\"Dolores facilis explicabo doloribus.\",\"description\":\"Hic neque accusamus accusamus corporis sit voluptates dicta. Recusandae delectus placeat ducimus quia. Earum et quia consequatur quas commodi.\",\"work\":{\"id\":\"a26c93fe-c4d7-4bdb-b72d-324b5318682d\",\"name\":\"Regina Mel Rocha Neto\"},\"user\":{\"id\":\"a26c93fe-c791-4bbb-a7ab-43d15faa6a57\",\"name\":\"Vicky Lakin\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"fcee2273-62bd-3b97-9aa5-6411ba1cc99f\",\"name\":\"Officia nulla maiores.\",\"description\":null,\"work\":{\"id\":\"a26c93fe-cadc-4208-a90b-de01fcacc5b3\",\"name\":\"Dr. Luciano Carvalho Bittencourt\"},\"user\":{\"id\":\"a26c93fe-cd3b-41cf-b634-e7a9fb9ccd04\",\"name\":\"Lura Schimmel\"},\"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": "dicta", "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\":\"fcec759a-fb2c-3e90-821c-89e307b36074\",\"name\":\"Ratione suscipit et molestiae.\",\"description\":null,\"work\":{\"id\":\"a26c93fe-d3d3-4608-8f91-ad71c0624212\",\"name\":\"Nelson Jimenes Dominato Jr.\"},\"user\":{\"id\":\"a26c93fe-d675-47ce-92f6-0b0811a11d03\",\"name\":\"Dejah Reinger III\"},\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "List items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-quantity-lists\/:productQuantityList\/items", "query": [], "raw": "{{baseUrl}}\/api\/product-quantity-lists\/:productQuantityList\/items", "variable": [ { "id": "productQuantityList", "key": "productQuantityList", "value": "quia", "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\":\"3f674af7-e77b-38f1-91c0-6268085fc1c4\",\"product\":{\"id\":\"a26c93fe-e9f4-4a42-adde-6357bd20b457\",\"name\":\"Sra. Samanta Al\\u00edcia Tamoio Sobrinho\",\"code\":\"PRD-633167\",\"unit\":{\"id\":\"a26c93fe-e82c-44d3-ab6b-4652a7d56b29\",\"name\":\"Sr. Walter Ramos Marques\",\"abbreviation\":\"Dr. Paula da Cruz Lutero Jr.\"}},\"quantity\":749.8195,\"observation\":\"Voluptas ad odio modi quia est consequatur.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"63022974-de44-3779-b9bf-6a0c08ca25bf\",\"product\":{\"id\":\"a26c93fe-f821-4a2f-a8ff-d1adc3d09bd3\",\"name\":\"Dr. Louise Soto Filho\",\"code\":\"PRD-768970\",\"unit\":{\"id\":\"a26c93fe-f705-481b-b627-2f3f7cd7accb\",\"name\":\"Mar\\u00edlia B\\u00e1rbara Sales\",\"abbreviation\":\"Srta. Maria Tainara D'\\u00e1vila Filho\"}},\"quantity\":64.7939,\"observation\":\"Architecto occaecati ducimus odio incidunt.\",\"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\":\"00236b8e-9277-30fa-bcfd-d860986ac21a\",\"items\":[{\"product_id\":\"ca416a9a-e067-39e3-b55f-698d95fa93f4\",\"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": "consequuntur", "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\":\"da17f3a3-f9d0-31c2-84c4-cfcfed1180e0\",\"product_id\":\"c8dc2884-88ae-3e4b-b661-0c39df9ccc70\",\"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": "assumenda", "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": "sit", "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\":\"d4e3e974-bd26-3317-a7c7-d6e30aed5fb7\",\"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": "earum", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "perferendis", "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": "consequuntur", "description": "Product Quantity List UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[\"6d01c7b3-169b-3fee-b60f-6ea23e69f0d4\"]}" }, "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": "dolor", "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\":\"352fbe8a-4ab9-3189-be09-b2f0bbf42756\",\"product_id\":\"06b9fd47-1d6c-3f13-8c40-73b574477f0e\",\"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": "maxime", "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\":\"bba6d48a-33cc-3220-9aa3-6735bfca2574\",\"quantity\":1,\"source_stock_id\":\"100afad6-11b4-3e37-83b4-d2210521456a\",\"reason\":\"Example Reason\",\"origins\":[{\"supplier_product_id\":\"f070abee-1a3c-32b3-b2ee-a8ffbbfd3377\",\"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": "veritatis", "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\":\"d44e4fa4-396d-3b70-9c60-06a56f5a56cc\",\"quantity\":20.693,\"fulfilled_at\":\"2026-07-23T23:39:53.000000Z\",\"created_at\":null},{\"id\":\"27ac4f1f-ebf6-3389-8419-f87a6df2acdc\",\"quantity\":13.2128,\"fulfilled_at\":\"2026-07-30T18:35:25.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": "perferendis", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "labore", "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\":\"6e54e896-a564-364d-9b1b-85b4b6e3cb7d\",\"product\":{\"id\":\"a26c9403-4c97-4a20-8aca-dc42bbd5297a\",\"name\":\"Tainara Solano\",\"code\":\"PRD-476776\",\"unit\":{\"id\":\"a26c9403-4b62-41e0-86b3-d56ef55b53da\",\"name\":\"Sophie Emilly Salas\",\"abbreviation\":\"Dr. Adriele Laura Prado Filho\"}},\"quantity\":611.1282,\"quantity_fulfilled\":0,\"quantity_pending\":611.1282,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"At consequatur fuga harum temporibus vel architecto minus.\",\"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": "cumque", "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\":\"43490de4-e056-36cd-922e-73d1eaba57f1\",\"product\":{\"id\":\"a26c9403-6ab2-4463-b536-ecff00aa427a\",\"name\":\"Franco Igor Tamoio\",\"code\":\"PRD-435319\",\"unit\":{\"id\":\"a26c9403-6916-48ea-870d-cb6e0fe3fdc0\",\"name\":\"Olga Amanda Estrada Filho\",\"abbreviation\":\"Vit\\u00f3ria Ver\\u00f4nica Furtado Neto\"}},\"quantity\":106.6956,\"quantity_fulfilled\":0,\"quantity_pending\":106.6956,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"c3801caf-0dc6-3016-a3fb-3abdb1f87661\",\"product\":{\"id\":\"a26c9403-7c3c-41d5-916c-f3d26e3b9f17\",\"name\":\"Dr. Maur\\u00edcio Rios Neto\",\"code\":\"PRD-360724\",\"unit\":{\"id\":\"a26c9403-7af5-4c21-8741-f128a9612407\",\"name\":\"Dr. Rodolfo Rios Escobar Sobrinho\",\"abbreviation\":\"Alma Aline Pontes Filho\"}},\"quantity\":215.8843,\"quantity_fulfilled\":0,\"quantity_pending\":215.8843,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":null,\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "List pending items by product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/pending-by-product\/:product", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/pending-by-product\/:product", "variable": [ { "id": "product", "key": "product", "value": "sit", "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\":\"731c483c-ab95-37a6-bfe4-9ef0e1356b1e\",\"product\":{\"id\":\"a26c9403-9178-4a90-bee1-b6ff956d4d4b\",\"name\":\"Sra. Mayara Escobar\",\"code\":\"PRD-040284\",\"unit\":{\"id\":\"a26c9403-903e-4da3-a060-2eccbbc4bd28\",\"name\":\"Agostinho Cauan Arag\\u00e3o\",\"abbreviation\":\"Deivid Carvalho Marin Filho\"}},\"quantity\":557.7859,\"quantity_fulfilled\":0,\"quantity_pending\":557.7859,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"295cf26c-9c4c-309e-b068-4ac270011cef\",\"product\":{\"id\":\"a26c9403-a239-43b4-a409-c1a5d01546d1\",\"name\":\"Sra. Daniele Cordeiro Cervantes\",\"code\":\"PRD-265356\",\"unit\":{\"id\":\"a26c9403-a109-4d27-b28d-274edac6e1d3\",\"name\":\"Andr\\u00e9 Leo Galv\\u00e3o\",\"abbreviation\":\"Const\\u00e2ncia Tamoio Sobrinho\"}},\"quantity\":381.0916,\"quantity_fulfilled\":0,\"quantity_pending\":381.0916,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Ut quas vero et quia voluptas ipsa.\",\"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\":\"f1c9c9a1-ef69-354e-b133-25b776023bb3\",\"work_location_id\":\"f9ab523d-85f8-329a-b697-db14055bd238\",\"user_id\":\"87f9c0fb-8685-3f22-8fbf-506811c2b6e0\",\"status_id\":\"3691e0f7-028c-3efd-a512-7bdd68f44325\",\"priority\":\"Example Priority\",\"needed_at_from\":\"Example Needed at from\",\"needed_at_to\":\"Example Needed at to\",\"responsible_id\":\"c5cc5b2c-9e23-3a9b-a793-225583e786b3\"}" }, "description": "List all product requests" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"a3464b5f-6133-392c-85a6-4a36bbe1d508\",\"code\":null,\"name\":\"Necessitatibus nobis eligendi repellendus.\",\"description\":null,\"work\":{\"id\":\"a26c9400-7e77-41ed-b417-91110751ed6a\",\"name\":\"Fabiano Mendon\\u00e7a\"},\"user\":{\"id\":\"a26c9400-8161-42fc-9e33-7430c496725a\",\"name\":\"Albertha Roberts\"},\"status\":{\"id\":\"a26c9400-832f-47ab-8f54-188de6f3d7fa\",\"slug\":null,\"name\":null,\"description\":\"Dr. Marina Serna Sobrinho\",\"abbreviation\":\"labore\",\"color\":\"#384090\",\"text_color\":\"#d2cd59\"},\"priority\":\"low\",\"priority_label\":\"Baixa\",\"needed_at\":null,\"approved_at\":null,\"rejection_reason\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"51174f0f-f57a-319c-bdfc-ac036007e7b3\",\"code\":null,\"name\":\"Nihil libero nobis suscipit quasi.\",\"description\":\"Quo alias optio tempora beatae facere enim officia omnis. Iure quidem tempora et optio animi. Voluptatem dolores voluptates aut nihil et sit.\",\"work\":{\"id\":\"a26c9400-8751-421e-a242-00d6678bb135\",\"name\":\"Jennifer Lozano Jr.\"},\"user\":{\"id\":\"a26c9400-8a52-4c6b-8fc7-541568ab9c62\",\"name\":\"Daija Kilback\"},\"status\":{\"id\":\"a26c9400-8c1b-4568-a0c4-8b579784f3b1\",\"slug\":null,\"name\":null,\"description\":\"Cristian Rios\",\"abbreviation\":\"est\",\"color\":\"#e6abad\",\"text_color\":\"#0e4700\"},\"priority\":\"high\",\"priority_label\":\"Alta\",\"needed_at\":null,\"approved_at\":null,\"rejection_reason\":null,\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Show product request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-requests\/:productRequest", "query": [], "raw": "{{baseUrl}}\/api\/product-requests\/:productRequest", "variable": [ { "id": "productRequest", "key": "productRequest", "value": "tempora", "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\":\"47e572cd-50aa-3c28-bbab-9b542c2ac81b\",\"code\":null,\"name\":\"Minus explicabo.\",\"description\":\"Qui dolorem id libero vero tenetur dolor. Exercitationem placeat voluptates vel aut. Dolorum voluptatem laboriosam nemo in sunt quos.\",\"work\":{\"id\":\"a26c9400-9a1f-4bca-bdef-cf1086f7b433\",\"name\":\"Srta. N\\u00e1dia Em\\u00edlia Rosa Jr.\"},\"user\":{\"id\":\"a26c9400-9cb0-4510-8654-647b3ac55d0f\",\"name\":\"Prof. Delilah O'Conner Sr.\"},\"status\":{\"id\":\"a26c9400-9e61-44de-a172-ccb34786afb5\",\"slug\":null,\"name\":null,\"description\":\"Dr. Gael Beltr\\u00e3o Sobrinho\",\"abbreviation\":\"natus\",\"color\":\"#79bce3\",\"text_color\":\"#464fd1\"},\"priority\":\"high\",\"priority_label\":\"Alta\",\"needed_at\":null,\"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": "rerum", "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\":\"7ee759fe-db91-34d0-9b93-ae72b765232e\",\"product\":{\"id\":\"a26c9400-ba15-4c52-b194-9fbec404256b\",\"name\":\"Sr. Leonardo Tamoio Mendon\\u00e7a Filho\",\"code\":\"PRD-251518\",\"unit\":{\"id\":\"a26c9400-b8da-4ef1-a5db-aac3610b30b2\",\"name\":\"Mary Amaral Cort\\u00eas\",\"abbreviation\":\"Sandro Carrara\"}},\"quantity\":349.2003,\"quantity_fulfilled\":0,\"quantity_pending\":349.2003,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"eec19cf4-9dc0-33e8-bc38-32603553f8f6\",\"product\":{\"id\":\"a26c9400-cb8c-4ecc-a5ae-69b4a79ff419\",\"name\":\"Sra. Mait\\u00ea Silvana Medina Neto\",\"code\":\"PRD-059326\",\"unit\":{\"id\":\"a26c9400-caa5-4488-bd1b-1e375f5c4fa7\",\"name\":\"Sr. Teobaldo Galindo Marques Neto\",\"abbreviation\":\"D\\u00e9bora Aguiar Quintana Jr.\"}},\"quantity\":711.7946,\"quantity_fulfilled\":0,\"quantity_pending\":711.7946,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":null,\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "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\":\"86b6895b-0831-3109-a941-914afe1810f8\",\"work_location_id\":\"698207dc-0ec1-3efb-8de2-d40bf4662c5d\",\"status_id\":\"ddb79eaa-4876-3624-b09d-b2e62f440f08\",\"priority\":\"Example Priority\",\"needed_at\":\"Example Needed at\",\"items\":[{\"product_id\":\"f23d905b-bd69-3cee-85d2-eddb107c4172\",\"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": "consequatur", "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\":\"87076d3a-3366-31fa-9a76-a798ba44efbe\",\"work_location_id\":\"cf4b1fd4-233f-3cf2-a610-8f3ba0294b8c\",\"status_id\":\"51c44dd1-d7a0-3752-98c8-e39647d2c9e0\",\"priority\":\"Example Priority\",\"needed_at\":\"Example Needed at\",\"items\":[{\"id\":\"f65552a6-1aa3-3837-bfc4-7758b505fb94\",\"product_id\":\"1b756f1a-5099-39e6-8f3c-5a982be5e413\",\"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": "eum", "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": "asperiores", "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": "adipisci", "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": "nobis", "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\":\"d2510e8a-c809-392e-ab65-4b7cc14ab22c\",\"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": "aut", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "unde", "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\":\"fc6b338a-1606-3993-989e-2a3a064654b8\"}" }, "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": "aspernatur", "description": "Product Request UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[\"5519c8fe-b7c0-376f-920f-868f5e2a7b98\"]}" }, "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": "voluptas", "description": "Product Request UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"id\":\"38ec89f7-6488-3420-a892-4615f94f5b23\",\"product_id\":\"39378076-0f6c-3adc-95ea-d8b71e023c59\",\"quantity\":1,\"observation\":\"Example Items * observation\"},null]}" }, "description": "Replace all items in the request" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":\"object\"}", "name": "" } ] } ] }, { "name": "Products", "description": "Endpoints for products", "item": [ { "name": "List products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/products", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Brick", "description": "Search query.", "disabled": false }, { "key": "code", "value": "PROD-00003", "description": "Filter by product code.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/products?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Brick&code=PROD-00003" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all products" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"f837f195-fd17-363c-a1de-5e58cb580005\",\"name\":\"Sr. Juliano Henrique Rodrigues\",\"code\":\"PRD-211330\",\"stock\":6165,\"product_family\":{\"id\":\"a26c93fe-6863-4fd0-a427-4a8cf40c87b2\",\"name\":\"Guilherme Feliciano Beltr\\u00e3o\"},\"product_brand\":{\"id\":\"a26c93fe-6af0-4044-b1d8-9d03775aa7f0\",\"name\":\"Miguel Pereira\"},\"unit\":{\"id\":\"a26c93fe-6d2a-42f9-a2cd-73fb21a49dd6\",\"name\":\"Dr. Mateus Roque\",\"abbreviation\":\"Lorena Roque Jr.\"},\"image\":{\"id\":null,\"url\":null},\"description\":\"Excepturi officiis aspernatur velit cum sed aspernatur.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"59592599-a3c5-3bd9-a3b9-27189a568fcd\",\"name\":\"Alessandra Delvalle Solano\",\"code\":\"PRD-708662\",\"stock\":6285,\"product_family\":{\"id\":\"a26c93fe-7113-400b-9376-043bb23776f8\",\"name\":\"Bruna Caldeira Valente\"},\"product_brand\":{\"id\":\"a26c93fe-727e-4520-9579-d3fd44f6a5d7\",\"name\":\"Madalena Val\\u00eancia\"},\"unit\":{\"id\":\"a26c93fe-73ec-44a2-aef3-0fadcde18375\",\"name\":\"Elo\\u00e1 Brito Verdugo\",\"abbreviation\":\"Dr. Sarah Louren\\u00e7o \\u00c1vila\"},\"image\":{\"id\":null,\"url\":null},\"description\":\"Magni aperiam cum praesentium aut excepturi ut.\",\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "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": "nihil", "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\":\"16fe956b-39bd-38bd-ad35-f3281308cd2d\",\"name\":\"Th\\u00e9o Fonseca Vale\",\"code\":\"PRD-017647\",\"stock\":752816471,\"product_family\":{\"id\":\"a26c93fe-7b73-4af9-b355-25890fc05ca2\",\"name\":\"Dr. Vitor Mendes Filho\"},\"product_brand\":{\"id\":\"a26c93fe-7d03-410b-9519-19abc2f00cf7\",\"name\":\"Sr. C\\u00e9sar Padilha Pacheco Filho\"},\"unit\":{\"id\":\"a26c93fe-7e88-4afd-a6a8-a4d438626960\",\"name\":\"Leonardo Murilo Paes Jr.\",\"abbreviation\":\"La\\u00eds Serrano Lira Filho\"},\"image\":{\"id\":null,\"url\":null},\"description\":\"Quisquam aut voluptatibus excepturi repellat repellat voluptatem.\",\"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": "sint", "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\":\"2315c4ba-cfea-3c8b-a22d-5d4695f65840\",\"product_brand_id\":\"f02647b4-c5d4-3707-a7b4-a757ff2b8538\",\"unit_id\":\"29f5ef88-7c5e-3d4b-89d0-5a5780f71ea7\",\"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": "occaecati", "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\":\"35496a95-1e5b-3052-b3cd-7bbd64ae4bf1\",\"product_brand_id\":\"ea3f076f-654f-3dad-a595-2d878abf9eb7\",\"unit_id\":\"95c684d7-85b6-3900-a250-810252899b9d\",\"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": "exercitationem", "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": "47bd0377-2838-30af-ab26-9c0697ea4527", "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\":\"f7a528e7-5f84-3c93-a530-e77f4289a4bf\",\"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": "58c5b16c-1ccb-3f57-b0ba-6c8728a142fa", "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": "cbed6a49-1b4f-3b23-93fd-1d3c31dc3acd", "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": "dacf592e-b8ee-332a-b336-cc63ef33ab16", "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": "8b8957ff-4dcb-3002-9ad4-20a06c7eb046", "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": "ed29f19e-4432-3801-a63d-acd60c40ab6e", "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": "82189e1d-2eec-3272-aa46-df2da12e0d8c", "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": "daa5ec8b-c810-310f-a407-9a4fa93d06ba", "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": "3e2ee36a-7cce-3424-8f04-89e3efe6025d", "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": "c1d8a6d1-0967-3154-9f6d-4a6b0a4b7c14", "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=82189e1d-2eec-3272-aa46-df2da12e0d8c&work_id=daa5ec8b-c810-310f-a407-9a4fa93d06ba&status_id=3e2ee36a-7cce-3424-8f04-89e3efe6025d&responsible_id=c1d8a6d1-0967-3154-9f6d-4a6b0a4b7c14" }, "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\":\"3f69083b-7d39-378c-b2ea-da011e10269f\",\"name\":\"Deserunt eos aut\",\"description\":\"Reiciendis nam minima aliquid.\",\"current_version\":1,\"file\":{\"path\":\"projects\\\/58ba19ee-541e-3215-88b2-6477b5fce31b.pdf\",\"size\":\"1756687\",\"extension\":\"pdf\"},\"discipline\":{\"id\":\"a26c9403-a940-4cc4-8548-f736cf811579\",\"name\":\"Et\",\"code\":\"AWW\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"6acd825a-bebd-3694-a2df-80600005d3e5\",\"name\":\"Aliquam reiciendis necessitatibus\",\"description\":\"Aperiam doloribus delectus qui saepe maxime nostrum possimus.\",\"current_version\":1,\"file\":{\"path\":\"projects\\\/0388061b-1218-3983-a567-79159d28a9c9.pdf\",\"size\":\"916449\",\"extension\":\"pdf\"},\"discipline\":{\"id\":\"a26c9403-acff-45b8-92a0-0809ed213f2d\",\"name\":\"Accusamus\",\"code\":\"ZRH\"},\"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": "20", "description": "The ID of the project." }, { "id": "project", "key": "project", "value": "est", "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\":\"2d102e13-89b2-3142-be61-ed2f66c25ed5\",\"name\":\"Enim hic sit\",\"description\":\"Voluptate dolorum quasi est ut rerum debitis unde.\",\"current_version\":1,\"file\":{\"path\":\"projects\\\/8ad2725f-a6aa-3185-a183-1f0fdc8a99b3.pdf\",\"size\":\"1575151\",\"extension\":\"pdf\"},\"discipline\":{\"id\":\"a26c9403-b524-482e-825f-aa1944c56bff\",\"name\":\"Delectus\",\"code\":\"XAG\"},\"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\":\"097962c1-325b-3d72-91b3-fe47f30497cd\",\"work_id\":\"f7cc537f-c010-3ad4-acfa-12de2b208545\",\"responsible_user_id\":\"9b1d7ff9-80e7-36f3-ad99-ad85e84e1595\",\"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": "2", "description": "The ID of the project." }, { "id": "project", "key": "project", "value": "quod", "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\":\"2d9eb9fd-0ab8-330c-82d3-3f33d5710798\",\"work_id\":\"529c48d4-095f-3248-9d05-6251f428d0fc\",\"responsible_user_id\":\"c19f6955-5beb-397c-ad42-5775ab4bae29\",\"status_id\":\"d7ce3786-9885-3af8-a674-561c8035fdf5\"}" }, "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": "sequi", "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\":\"quia\"}" }, "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\":\"quia\",\"kit_uuid\":\"6cddc606-683c-3aea-b74f-36b69055ec89\"}" }, "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": "Export Cash Flow to Excel", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/cash-flow\/excel", "query": [ { "key": "q", "value": "sit", "description": "", "disabled": false }, { "key": "type", "value": "entrada", "description": "Tipo de lan\u00e7amento.", "disabled": false }, { "key": "description", "value": "Cumque+autem+et+ducimus+sapiente+sed+accusamus+quisquam.", "description": "", "disabled": false }, { "key": "categories[0]", "value": "728065ae-054e-3ef1-b56b-76ab5e1b5556", "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": "a9a74b50-baf0-3162-aea6-a59e3c41e9af", "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": "3a189b47-1605-3f2d-b626-2473bd8af93f", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "customers[0]", "value": "4e1609f5-063a-30b4-8edc-cc0d032c0f32", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "suppliers[0]", "value": "2ab3b7c6-0fa2-3aff-9d47-debf36a500f2", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "cash_session", "value": "50d922db-b32f-362f-b887-e1829495f6a3", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "works[0]", "value": "aff93d5e-deda-3ec1-ba97-1f1a92bc97ca", "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=sit&type=entrada&description=Cumque+autem+et+ducimus+sapiente+sed+accusamus+quisquam.&categories[0]=728065ae-054e-3ef1-b56b-76ab5e1b5556&exclude_categories[0]=a9a74b50-baf0-3162-aea6-a59e3c41e9af&date_start=2026-01-01&date_end=2026-12-31&bank_accounts[0]=3a189b47-1605-3f2d-b626-2473bd8af93f&customers[0]=4e1609f5-063a-30b4-8edc-cc0d032c0f32&suppliers[0]=2ab3b7c6-0fa2-3aff-9d47-debf36a500f2&cash_session=50d922db-b32f-362f-b887-e1829495f6a3&works[0]=aff93d5e-deda-3ec1-ba97-1f1a92bc97ca&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": "ipsam", "description": "", "disabled": false }, { "key": "type", "value": "entrada", "description": "Tipo de lan\u00e7amento.", "disabled": false }, { "key": "description", "value": "Omnis+odio+libero+blanditiis+molestias+incidunt+sed+reprehenderit+rerum.", "description": "", "disabled": false }, { "key": "categories[0]", "value": "fc8ce598-63ea-3281-9e3e-25dbbbbba1e3", "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": "45a7b051-222b-376d-bf06-19f7b994ba09", "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": "990de134-be9d-393c-ab29-6f0a868d048c", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "customers[0]", "value": "e4e59bdb-dbbe-35f6-ab29-30e5950fc6cc", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "suppliers[0]", "value": "04722383-67b0-34fd-97b9-19ed32e98342", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "cash_session", "value": "ffc3e52c-a45b-3bac-99c4-69acf534937a", "description": "O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "works[0]", "value": "44e5eb13-26fa-39d1-b075-900552d87ce1", "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=ipsam&type=entrada&description=Omnis+odio+libero+blanditiis+molestias+incidunt+sed+reprehenderit+rerum.&categories[0]=fc8ce598-63ea-3281-9e3e-25dbbbbba1e3&exclude_categories[0]=45a7b051-222b-376d-bf06-19f7b994ba09&date_start=2026-01-01&date_end=2026-12-31&bank_accounts[0]=990de134-be9d-393c-ab29-6f0a868d048c&customers[0]=e4e59bdb-dbbe-35f6-ab29-30e5950fc6cc&suppliers[0]=04722383-67b0-34fd-97b9-19ed32e98342&cash_session=ffc3e52c-a45b-3bac-99c4-69acf534937a&works[0]=44e5eb13-26fa-39d1-b075-900552d87ce1&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\":\"d9a98b9a-65b1-3e92-ac2c-5a5f1db1d499\",\"name\":\"quas laudantium\",\"slug\":null,\"description\":\"Cupiditate qui eius enim et qui quod quam et. In reiciendis quo eos numquam sunt unde est quaerat. Voluptas vel rem aliquid inventore vero. Ut ex ut voluptatibus voluptatem exercitationem vel.\",\"abbreviation\":\"vtb\",\"created_at\":null,\"updated_at\":null},{\"id\":\"b2257361-7b4d-3f91-806c-c3f98c6fd970\",\"name\":\"distinctio repudiandae\",\"slug\":null,\"description\":null,\"abbreviation\":\"mil\",\"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": "3", "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\":\"79d8605b-036f-30cc-b6ad-b2c6fcdf1ca7\",\"name\":\"iure qui\",\"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": "7", "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": "18", "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\":\"cbbd4042-1d0a-3797-84f7-723ce1cad390\",\"name\":\"Dr. Lauryn Kassulke\",\"username\":\"ztoy\",\"email\":\"hester.daniel@example.org\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"fd9979ec-654b-3908-841c-827c89ef67f0\",\"name\":\"Joyce Reichel\",\"username\":\"pwilkinson\",\"email\":\"tbernier@example.net\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Attach users to sector", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors\/:sector\/users\/attach", "query": [], "raw": "{{baseUrl}}\/api\/sectors\/:sector\/users\/attach", "variable": [ { "id": "sector", "key": "sector", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Sector UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"users\":[\"366d589d-c606-3b7c-950b-7d8ab59c53c2\"]}" }, "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\":[\"905b6872-f3b4-3f4e-b0d1-6f7e32dcae9d\"]}" }, "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\":[\"dc9f651a-7f1a-30cb-ad33-59bcd4a3425e\"]}" }, "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\":\"ex explicabo\",\"slug\":\"enim-inventore-voluptas-animi-aut-quae-voluptate-vitae\"},{\"name\":\"laborum sed\",\"slug\":\"eum-voluptas-recusandae-hic-atque-autem\"}]}", "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\":\"7948507e-1804-3d55-a37c-ee3b97eae6e4\",\"slug\":null,\"name\":null,\"description\":\"Dayana Galhardo Soares\",\"abbreviation\":\"quae\",\"color\":\"#6da692\",\"text_color\":\"#dd2e96\",\"created_at\":null,\"updated_at\":null},{\"id\":\"b87998a8-0fdb-3e4d-bafd-38a83974bdde\",\"slug\":null,\"name\":null,\"description\":\"Betina Verdara Mar\\u00e9s\",\"abbreviation\":\"ut\",\"color\":\"#0670d5\",\"text_color\":\"#63e55e\",\"module\":{\"name\":\"Obras\",\"slug\":\"work\"},\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/statuses", "query": [], "raw": "{{baseUrl}}\/api\/statuses" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"slug\":\"Example Slug\",\"name\":\"Example Name\",\"description\":\"Example Description\",\"abbreviation\":\"Example Abbreviation\",\"module\":\"Example Module\",\"sector_id\":\"47b1c751-df54-3ecf-ba25-f87aaf31debb\",\"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\":\"de805c14-ef87-3878-9ec5-65afabc34569\",\"slug\":null,\"name\":null,\"description\":\"Dr. Flor Arruda\",\"abbreviation\":\"ex\",\"color\":\"#141e89\",\"text_color\":\"#d51dc0\",\"module\":{\"name\":\"Solicita\\u00e7\\u00e3o de Produtos\",\"slug\":\"product_request\"},\"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\":\"d0955c09-2cf7-3cb9-9cd5-34a26cbfab8e\",\"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\":\"58f83f21-dcf3-31df-bb6f-c8e7228777a6\",\"quantity\":532.0627,\"min_quantity\":null,\"max_quantity\":null,\"below_minimum\":false,\"above_maximum\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"54bce805-be64-340d-b4a5-11fa068730f6\",\"quantity\":875.0796,\"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\":\"21753fea-9950-3818-918c-35ab3f994089\",\"name\":\"Estoque \\u00c1vila-Bonilha\",\"module\":\"work\",\"is_active\":true,\"is_main\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"8421417a-2cd0-3a19-b4e2-52d7ed80e7a2\",\"name\":\"Estoque de Souza e Rezende\",\"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\":\"1c90b30f-e508-37ff-907a-e001ddda0b5e\",\"name\":\"Estoque Galv\\u00e3o e de Arruda\",\"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\":\"9a0b5ee2-2113-3b4d-99b1-1243f9fc2da2\",\"name\":\"Estoque de Aguiar e Associados\",\"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\":\"bedf7b15-cdc7-30bc-8755-7dfc1d71cdf8\",\"name\":\"Estoque Rivera e Reis\",\"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\":\"ec28d10e-99ed-3cc7-9fbe-7a5a4515ca66\",\"name\":\"Estoque Torres Comercial Ltda.\",\"module\":\"work\",\"is_active\":true,\"is_main\":false,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Delete stock", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stocks\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the stock." }, { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes a stock (soft delete)" }, "response": [] }, { "name": "List stock items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:stock\/items", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Number of items per page. O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Cement", "description": "Search by product name. O campo value n\u00e3o pode ser superior a 255 caracteres.", "disabled": false }, { "key": "below_minimum", "value": "1", "description": "Filter items below minimum quantity.", "disabled": false }, { "key": "above_maximum", "value": "", "description": "Filter items above maximum quantity.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/stocks\/:stock\/items?sort_by=created_at&sort_desc=1&page=1&per_page=10&q=Cement&below_minimum=1&above_maximum=", "variable": [ { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of items\/products in a stock" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"d8aff686-0fe0-31e4-ad10-95d0419dcd26\",\"quantity\":41.8956,\"min_quantity\":null,\"max_quantity\":null,\"below_minimum\":false,\"above_maximum\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"daa51beb-94c0-3de0-9d03-e76c2a69b5ae\",\"quantity\":18.9765,\"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": "atque", "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\":\"c97c93ea-0569-3178-a912-b36f6a5752f9\",\"quantity\":603.1837,\"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\":\"8366dde0-28d3-33bd-8766-bd23576030c4\",\"code\":\"MOV-065851\",\"type\":\"compra\",\"type_name\":\"PURCHASE\",\"is_entry\":true,\"is_exit\":false,\"quantity\":85.252,\"previous_quantity\":830.505,\"new_quantity\":915.757,\"reason\":null,\"movement_date\":\"2026-08-01T18:45:52.000000Z\",\"created_at\":null},{\"id\":\"d545c7a4-4e0f-3266-8fe9-379e9ac54fe5\",\"code\":\"MOV-767502\",\"type\":\"vencido\",\"type_name\":\"EXPIRED\",\"is_entry\":false,\"is_exit\":true,\"quantity\":94.4874,\"previous_quantity\":479.2046,\"new_quantity\":384.7172,\"reason\":\"Voluptas atque laborum et.\",\"movement_date\":\"2026-07-08T14:50:54.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\":\"79c3e8e4-05dc-3d1d-bc94-5fd4a479a18a\",\"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\":\"1e153473-cefc-3f40-a0ac-facaf42000e3\",\"code\":\"MOV-526641\",\"type\":\"devolu\\u00e7\\u00e3o\",\"type_name\":\"RETURN\",\"is_entry\":true,\"is_exit\":false,\"quantity\":9.3293,\"previous_quantity\":763.7988,\"new_quantity\":773.1281,\"reason\":null,\"movement_date\":\"2026-07-30T07:51:07.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\":\"7b9297ba-3703-3d9a-8b98-13b1f5b0906e\",\"destination_stock_id\":\"005d531e-0163-35a1-be31-9fa69022aec3\",\"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\":\"8b813f4a-9c6c-3266-9de9-f06a6535f152\",\"code\":\"MOV-775790\",\"type\":\"entrada transfer\\u00eancia\",\"type_name\":\"TRANSFER_IN\",\"is_entry\":true,\"is_exit\":false,\"quantity\":60.9615,\"previous_quantity\":360.2432,\"new_quantity\":421.2047,\"reason\":null,\"movement_date\":\"2026-08-04T15:14:26.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\":\"88bfcc51-2eb2-327a-a7a5-7195e02c8a3a\",\"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\":\"e0e0b90a-1fa5-327a-881e-fdf360caf86a\",\"code\":\"MOV-655669\",\"type\":\"consumo\",\"type_name\":\"CONSUMPTION\",\"is_entry\":false,\"is_exit\":true,\"quantity\":21.756,\"previous_quantity\":489.412,\"new_quantity\":467.656,\"reason\":null,\"movement_date\":\"2026-08-04T08:07:02.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\":\"e44cb042-e8b6-353f-babb-8b33736956e4\",\"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\":\"17326699-77a2-383c-93dd-ac008ec00b40\",\"code\":\"MOV-840805\",\"type\":\"vencido\",\"type_name\":\"EXPIRED\",\"is_entry\":false,\"is_exit\":true,\"quantity\":76.343,\"previous_quantity\":839.6726,\"new_quantity\":763.3296,\"reason\":null,\"movement_date\":\"2026-07-28T17:21:08.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\":\"2322fe0f-bda9-3d26-b24d-4ce5df888167\",\"code\":\"MOV-380120\",\"type\":\"ajuste sa\\u00edda\",\"type_name\":\"ADJUSTMENT_OUT\",\"is_entry\":false,\"is_exit\":true,\"quantity\":87.0391,\"previous_quantity\":665.6095,\"new_quantity\":578.5704,\"reason\":\"Facilis harum debitis ab nostrum.\",\"movement_date\":\"2026-07-18T17:37:27.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\":\"1c2dead9-11f2-3281-aac3-70ae834a9879\",\"name\":\"Sra. Elisa Mirella Ramires\",\"email\":\"fassuncao@example.org\",\"phone\":\"(96) 99424-6178\",\"document\":\"04.035.957\\\/0001-24\",\"type\":\"pf\",\"responsible\":\"Sra. Ruth L\\u00e9ia Oliveira Neto\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null}},{\"id\":\"28c86dde-b743-35cb-bb8f-7694ba7d38cd\",\"name\":\"Maraisa Deverso Jr.\",\"email\":\"eric80@example.com\",\"phone\":\"(65) 96052-5731\",\"document\":\"80.204.456\\\/0001-02\",\"type\":\"pj\",\"responsible\":\"Dr. Walter Molina Lira Neto\",\"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\":\"2a6d1efc-a78d-35c0-925f-6a1a3ce65ef3\",\"name\":\"Everton Gian Mar\\u00e9s Filho\",\"email\":\"meireles.paulo@example.com\",\"phone\":\"(77) 98551-2489\",\"document\":\"57.597.442\\\/0001-84\",\"type\":\"pj\",\"responsible\":\"Dr. Gabrielly God\\u00f3i\",\"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\":\"3e440c82-5291-3a99-b3d1-e586aefa2a00\",\"name\":\"Sra. Franciele Montenegro Padr\\u00e3o\",\"description\":\"Sed ullam facere consequuntur et a illum et. Necessitatibus quis tenetur voluptatem ex qui in reprehenderit. Minus voluptas ad dolorem. Vel ad voluptatem quia dolores ea et.\",\"type\":\"ajuste\"},{\"id\":\"d2e88cbc-9884-365d-9dab-3e42ebbd3c8c\",\"name\":\"Sra. Priscila Mar\\u00e9s Mar\\u00e9s\",\"description\":\"Eveniet inventore delectus quasi ut laudantium consequatur et. Consequatur ea ut est ipsam omnis. Exercitationem veniam alias eligendi doloremque amet sunt earum aut. Sed et provident ut iure ut.\",\"type\":\"juros\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Show transaction category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction-categories\/:transactionCategory", "query": [], "raw": "{{baseUrl}}\/api\/transaction-categories\/:transactionCategory", "variable": [ { "id": "transactionCategory", "key": "transactionCategory", "value": "et", "description": "Transaction category UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Show a transaction category" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"7a0bdcd2-e706-3597-9031-1a693d497f67\",\"name\":\"Sra. Josefina Tess\\u00e1lia Estrada\",\"description\":\"Reprehenderit maxime maxime harum rem quo itaque consequatur. Corporis necessitatibus sit magnam quis. Facilis soluta rerum animi nam. Nesciunt porro tempore beatae ab voluptatibus rerum.\",\"type\":\"ajuste\"}}", "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": "incidunt", "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": "repudiandae", "description": "Transaction category UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a transaction category" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Units", "description": "Endpoints for units", "item": [ { "name": "List units", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/units", "query": [ { "key": "q", "value": "Structure", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/api\/units?q=Structure" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all units" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"3eb19250-7b22-39c4-8cbf-06249346c619\",\"name\":\"Sr. Mois\\u00e9s David Marinho Neto\",\"abbreviation\":\"Dr. Michael Estrada Neto\",\"description\":\"Ipsum aperiam et autem.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"b72e9d6d-c0d7-36a2-be48-b11995f595a9\",\"name\":\"Ana Franciele Carmona\",\"abbreviation\":\"Dr. Richard Delvalle Galv\\u00e3o\",\"description\":\"Dolores tenetur cum non odio.\",\"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": "quae", "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\":\"dbff83db-df9d-3998-9e04-c05e110163cc\",\"name\":\"Julieta Luna Urias\",\"abbreviation\":\"Bella Branco Valente\",\"description\":\"Natus officiis ipsam et quos.\",\"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": "beatae", "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": "in", "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\":\"e7bb8253-914f-3b09-8464-07b659aff213\",\"name\":\"Maya Kohler\",\"username\":\"gudrun21\",\"email\":\"kenna48@example.com\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"71162d40-eb34-3545-948c-44d1e34f16e7\",\"name\":\"Haylee Murray Jr.\",\"username\":\"zwyman\",\"email\":\"twila78@example.com\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Get user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a user" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"53e6df48-2b0f-3db1-8b4e-33392f196441\",\"name\":\"Stuart Bins PhD\",\"username\":\"fcartwright\",\"email\":\"adalberto.cormier@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\":\"hegmann.pablo\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"c51d0d31-b583-387e-b2fe-5faec223571d\"],\"roles\":[\"92670d44-0e54-34cc-815d-41de78e5a716\"]}" }, "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\":\"stokes.jaida\",\"password\":\"password123\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"7319d8c2-b8ed-3c84-a94f-a9b2c474e1c4\"],\"roles\":[\"058d9fa3-4d70-3508-a4cb-0c08a8d96ac1\"]}" }, "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\":[\"09d72f59-805b-3022-8ea4-876ec79f3e64\"]}" }, "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\":\"sit\",\"display_name\":\"Voluptatem qui ab dicta quis culpa.\"},{\"id\":null,\"name\":\"fugiat\",\"display_name\":\"Consequatur quos quas rerum sequi.\"}]}", "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\":\"431793b7-a704-3891-8dbb-5318e5f7b832\",\"description\":\"Hugo Mauro Ferreira\",\"work\":{\"id\":null,\"name\":null},\"documents\":[],\"created_at\":null,\"updated_at\":null},{\"id\":\"ac78099d-d41b-3a58-ab8c-24ebbde4a7de\",\"description\":\"Dr. Fl\\u00e1vio Pena\",\"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\":\"36611be6-eef8-3d84-a758-3bd9711f3921\"}" }, "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\":\"c083ba4e-c341-3fe1-9afd-0e155d028443\",\"description\":\"Melina Ferreira Aguiar\",\"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\":\"9ab9943b-481a-3d98-9ec6-95a5b5c0e806\"}" }, "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\":\"5a45b6b9-7a32-305d-9ec2-5cc93a12f66b\",\"name\":\"Lia Ramires\",\"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\":\"1972-03-11 15:45:10.000000\",\"timezone_type\":3,\"timezone\":\"America\\\/Sao_Paulo\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"ac594978-c5c4-3cfd-82e0-d030cffd2126\",\"name\":\"Jos\\u00e9 Evandro Beltr\\u00e3o\",\"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\":\"1989-06-06 17:15:16.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\":\"5c1dc12c-415a-3071-8742-6dc548ee6048\",\"status_id\":\"a62c280e-570f-31e7-8c14-439557101280\",\"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\":\"ae97a92a-ae7e-326a-98a4-19f25d276bbd\",\"name\":\"Kauan Corona Neto\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents\":[],\"locations\":[],\"product_quantity_lists_count\":0,\"product_quantity_list_items_count\":0,\"product_requests_count\":0,\"product_request_items_count\":0,\"documents_count\":0,\"locations_documents_count\":0,\"total_documents_count\":0,\"daily_logs_count\":0,\"projects_count\":0,\"started_at\":{\"date\":\"2019-06-05 22:23:15.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\":\"15afb0af-b23c-347c-a1e7-4894f5c2de3e\",\"status_id\":\"ad1fe9f2-3c11-3db7-ae66-ddf0126bca6e\",\"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\":\"7924b5a0-fba3-3b8f-bb2c-ce7ea204edfb\",\"name\":\"Dr. Narciso Lynch\",\"username\":\"brady28\",\"email\":\"mgreenholt@example.com\",\"certification\":null,\"crea\":null,\"last_login_at\":null,\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"13e8bfd8-c720-339f-b454-3d229acaff08\",\"name\":\"Christophe Dach\",\"username\":\"arnold.huel\",\"email\":\"qcollins@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\":[\"0f450af4-6450-3c71-a906-be266e8d19f0\"]}" }, "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\":[\"2c620457-d9f2-3e5e-989c-6233a3fb46de\"]}" }, "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\":[\"fc3b5cc4-10a4-38d1-bd3a-718b80f08e40\"]}" }, "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" } ] } }