{ "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": "73f1e4a2-e1ec-4c1f-9b98-f08346df2e06", "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\":\"7090755d-292b-308c-b0bb-2ed6ef124ae3\",\"name\":\"dolor-69f50b45ca2c5\",\"display_name\":\"Aut saepe et est in in atque ipsam.\",\"permissions_count\":null},{\"id\":\"1e655450-7e7b-3ac1-9628-8a36776be803\",\"name\":\"rerum-69f50b45cf977\",\"display_name\":\"Aliquam sint officia eos omnis.\",\"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\":[\"3ffe6b75-ac92-33b4-9712-51a5b01ed410\"]}" }, "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\":[\"cb3d96ca-5116-3b76-8e9e-69454ad78dba\"]}" }, "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\":\"6a7b5d24-4f7a-305b-a450-d06e684f8cb5\",\"name\":\"minima-69f50b45dfca2\",\"display_name\":\"Molestiae quam ipsa eos est distinctio.\",\"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\":\"delectus\",\"display_name\":\"Id placeat eveniet sunt numquam sit aut.\"},{\"id\":null,\"name\":\"amet\",\"display_name\":\"Aliquam harum est nesciunt velit porro id dolorem.\"}]}", "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\":\"asperiores\",\"display_name\":\"Qui est id aliquid blanditiis cumque.\"},{\"id\":null,\"name\":\"perferendis\",\"display_name\":\"Iure et dolor error aspernatur nisi voluptatem assumenda.\"}],\"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\":\"molestiae\",\"display_name\":\"Laboriosam suscipit vel error voluptas.\"}}", "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\":\"7aff2ba3-adb8-3cc1-9a05-40f30ca086e6\",\"type\":\"entrada\",\"payment_method\":\"cheque\",\"amount\":2550.04,\"due_date\":\"2026-05-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\":\"Ex consequatur consectetur expedita rem sit quaerat.\",\"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\":\"aut\",\"field2\":87,\"field3\":false,\"notes\":\"Aut error laborum a.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"de554ad9-efe6-3bcb-b2cc-6d63fb43347b\",\"type\":\"entrada\",\"payment_method\":\"boleto\",\"amount\":4865.69,\"due_date\":\"2026-05-29T03: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\":\"Aperiam quas velit et a doloribus assumenda accusamus blanditiis qui sint expedita quisquam non.\",\"is_recurring\":null,\"recurrence_config\":null,\"parent_id\":null,\"recurrence_order\":1,\"total_recurrences\":null,\"children_count\":0,\"remaining_recurrences\":null,\"has_children\":false,\"field1\":\"deleniti\",\"field2\":95,\"field3\":false,\"notes\":\"Ullam ut aperiam commodi sint sunt libero.\",\"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": "enim", "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]=enim" }, "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": "type", "value": "entrada", "description": "Type.", "disabled": false }, { "key": "customers[0]", "value": "dicta", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "consectetur", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "et", "description": "The uuid of an existing record in the works table.", "disabled": false }, { "key": "statuses[0]", "value": "vencido", "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-05-01T17%3A21%3A26", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "protest_date_end", "value": "2026-05-01T17%3A21%3A26", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "has_protest", "value": "", "description": "", "disabled": true }, { "key": "has_children", "value": "1", "description": "Filter accounts that have recurring children.", "disabled": false }, { "key": "is_recurring", "value": "1", "description": "Filter by recurring status (true: only recurring, false: only non-recurring, null: all).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/accounts-payable-receivable\/protests?sort_by=created_at&sort_desc=1&page=1&per_page=10&q=Salary&type=entrada&customers[0]=dicta&suppliers[0]=consectetur&works[0]=et&statuses[0]=vencido&payment_method=cheque&date_start=2023-01-01&date_end=2023-12-31&protest_date_start=2026-05-01T17%3A21%3A26&protest_date_end=2026-05-01T17%3A21%3A26&has_protest=&has_children=1&is_recurring=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List accounts with protest date that are not paid\/canceled" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"1c148233-5f04-322d-a917-ab29b2cf0538\",\"type\":\"entrada\",\"payment_method\":\"cheque\",\"amount\":8880.62,\"due_date\":\"2026-05-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\":\"Quod vel neque quo maxime architecto id.\",\"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\":\"quia\",\"field2\":19,\"field3\":false,\"notes\":\"Provident dolorem qui rerum voluptatem et.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"9f93dc08-6c8d-35d9-8198-9569b2c7efe3\",\"type\":\"sa\\u00edda\",\"payment_method\":\"boleto\",\"amount\":4272.54,\"due_date\":\"2026-05-27T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"protest_date\":null,\"paid_amount\":null,\"interest_amount\":null,\"penalty_amount\":null,\"notary_fee_amount\":null,\"description\":\"Impedit dolorem qui quia quae temporibus nesciunt dignissimos et eaque porro et in aut.\",\"is_recurring\":null,\"recurrence_config\":null,\"parent_id\":null,\"recurrence_order\":1,\"total_recurrences\":null,\"children_count\":0,\"remaining_recurrences\":null,\"has_children\":false,\"field1\":\"nostrum\",\"field2\":57,\"field3\":true,\"notes\":\"Praesentium quod et et sit.\",\"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": "type", "value": "entrada", "description": "Type.", "disabled": false }, { "key": "customers[0]", "value": "ut", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "culpa", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "praesentium", "description": "The uuid of an existing record in the works table.", "disabled": false }, { "key": "statuses[0]", "value": "pago_sem_lancamento", "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-05-01T17%3A21%3A26", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "protest_date_end", "value": "2026-05-01T17%3A21%3A26", "description": "O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "has_protest", "value": "", "description": "", "disabled": true }, { "key": "has_children", "value": "1", "description": "Filter accounts that have recurring children.", "disabled": false }, { "key": "is_recurring", "value": "1", "description": "Filter by recurring status (true: only recurring, false: only non-recurring, null: all).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/accounts-payable-receivable?sort_by=created_at&sort_desc=1&page=1&per_page=10&q=Salary&type=entrada&customers[0]=ut&suppliers[0]=culpa&works[0]=praesentium&statuses[0]=pago_sem_lancamento&payment_method=cheque&date_start=2023-01-01&date_end=2023-12-31&protest_date_start=2026-05-01T17%3A21%3A26&protest_date_end=2026-05-01T17%3A21%3A26&has_protest=&has_children=1&is_recurring=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all accounts payable receivable" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"3405e563-5062-399a-9bb8-82df066bff54\",\"type\":\"entrada\",\"payment_method\":\"cheque\",\"amount\":7553.4,\"due_date\":\"2026-05-16T03: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\":\"Dolores rerum corrupti ipsam voluptates illum incidunt quos distinctio optio in dolor dolorum.\",\"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\":54,\"field3\":true,\"notes\":\"Molestias voluptatum aut deleniti rerum.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"dcb80851-70ff-33bd-bf99-7cf2dd4e7683\",\"type\":\"entrada\",\"payment_method\":\"cheque\",\"amount\":4152.79,\"due_date\":\"2026-06-01T03: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\":\"Quis eos sunt quo maiores id quae voluptatem hic.\",\"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\":\"voluptatem\",\"field2\":89,\"field3\":false,\"notes\":\"Laudantium veritatis iste amet asperiores.\",\"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\":\"387a6ef8-1268-3fd6-80ce-7d1b7f5b6262\",\"customer_id\":\"a527bb83-6f8f-3d6e-a954-196133ea5128\",\"work_id\":\"7c6a9cc2-4c5a-343b-b7c5-a2f86f21f264\",\"status\":\"Example Status\",\"protest_date\":\"2024-01-01\",\"bank_account_id\":\"7ff2522b-dbd8-31d0-93f9-394e0632abc7\",\"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": "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": "magni", "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": "velit", "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\":\"6ea72336-2d52-3848-92c1-675b5766e35c\",\"type\":\"entrada\",\"payment_method\":\"cheque\",\"amount\":4293.72,\"due_date\":\"2026-05-14T03:00:00.000000Z\",\"status\":null,\"payment_date\":null,\"protest_date\":null,\"paid_amount\":null,\"interest_amount\":null,\"penalty_amount\":null,\"notary_fee_amount\":null,\"description\":\"Hic asperiores occaecati ut neque dignissimos a odio reiciendis unde praesentium velit ut fuga.\",\"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\":\"repudiandae\",\"field2\":2,\"field3\":false,\"notes\":\"Eligendi aut similique quam voluptas enim est.\",\"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": "voluptas", "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\":\"9b33e575-53d2-334b-9a56-7ebcdcb31b26\",\"customer_id\":\"f3289121-4d80-323f-a487-93a2ed54691a\",\"work_id\":\"c6836dcc-829c-3960-9480-0c17be68d383\",\"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\":\"60072803-e60f-3729-a787-6d91eeda1f78\",\"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": "aperiam", "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\":\"ggrimes@example.org\",\"password\":\"password\"}" }, "description": "Login with email and password", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"token\":\"string\"}", "name": "" } ] }, { "name": "Me", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/user", "query": [], "raw": "{{baseUrl}}\/api\/auth\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the current user" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"394896cf-ac57-34e6-99a2-10a95f79a446\",\"name\":\"Ms. Colleen Leannon\",\"username\":\"carroll.adolfo\",\"email\":\"carlie01@example.com\",\"ability\":[{\"action\":\"read\",\"subject\":\"Auth\"},{\"action\":\"listar\",\"subject\":\"padr\\u00e3o\"}],\"roles\":[],\"preferences\":[],\"sectors\":[],\"image\":{\"id\":null,\"url\":null}}}", "name": "" } ] }, { "name": "Update Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/user", "query": [], "raw": "{{baseUrl}}\/api\/auth\/user" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"email\":\"user@example.com\",\"username\":\"mosciski.alec\",\"password\":\"password123\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"5462dc82-1ce2-39f5-af16-ad2c6f0b2516\"],\"roles\":[\"54f14d1c-10e2-31e3-9d27-4acd3c72070b\"]}" }, "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\":\"uskxheryxletuyaneevnbs\",\"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": "sapiente", "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 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": "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\":\"c24f3b5b-4de8-3046-b712-0a5d89bb9c58\",\"agency\":\"9622\",\"account\":\"8859347-6\",\"type\":\"poupan\\u00e7a\",\"balance\":678.37,\"holder_type\":\"pf\",\"alias\":\"eos\",\"limit\":4356.69,\"available_balance\":5035.0599999999995,\"used_limit\":0,\"available_limit\":4356.69,\"is_default\":null,\"bank\":{\"id\":null,\"name\":null,\"code\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"6ffcdd31-1e6e-3482-b0a2-57b76a00fb4e\",\"agency\":\"9524\",\"account\":\"1992318-2\",\"type\":\"poupan\\u00e7a\",\"balance\":711.83,\"holder_type\":\"pf\",\"alias\":\"aliquam\",\"limit\":9226.32,\"available_balance\":9938.15,\"used_limit\":0,\"available_limit\":9226.32,\"is_default\":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\":\"5513330-6\",\"bank_id\":\"66c73303-4d54-3760-b943-73c8a9212c55\",\"type\":\"Example Type\",\"holder_type\":\"Example Holder type\",\"alias\":\"Example Alias\",\"balance\":1,\"limit\":1,\"is_default\":true}" }, "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": "2", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"agency\":\"Example Agency\",\"account\":\"6438613-0\",\"bank_id\":\"543402d4-0c87-3f0f-a9fe-fafa9e3f5e3e\",\"type\":\"Example Type\",\"holder_type\":\"Example Holder type\",\"alias\":\"Example Alias\",\"balance\":1,\"limit\":1,\"is_default\":true}" }, "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": "8", "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\":\"a600b8e6-d71b-33cd-be18-bb49a98875c9\",\"agency\":\"9560\",\"account\":\"7045696-0\",\"type\":\"corrente\",\"balance\":8269.46,\"holder_type\":\"pj\",\"alias\":\"ut\",\"limit\":6292.26,\"available_balance\":14561.72,\"used_limit\":0,\"available_limit\":6292.26,\"is_default\":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": "15", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a bank account" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] } ] }, { "name": "Banks", "description": "Endpoints for banks", "item": [ { "name": "List banks", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/banks", "query": [ { "key": "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\":\"9dbf15d9-b37c-3af5-b083-e1fd41c8812b\",\"name\":\"das Dores e Associados\",\"code\":\"638\"},{\"id\":\"61ffd6f7-6ea6-379b-82a1-52e5e34d51f9\",\"name\":\"Vale e Rosa e Filhos\",\"code\":\"267\"}],\"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\":\"ec128c31-4138-39ab-9d19-6b2ffb9ff8a7\",\"name\":\"Lutero e das Neves e Filhos\",\"code\":\"230\"}}", "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": "Delectus+provident+possimus+occaecati+ab+quae+harum+quis+architecto.", "description": "Description .", "disabled": false }, { "key": "categories[0]", "value": "quisquam", "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": "velit", "description": "The uuid of an existing record in the bank_accounts table.", "disabled": false }, { "key": "customers[0]", "value": "repellat", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "id", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "aliquid", "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=Delectus+provident+possimus+occaecati+ab+quae+harum+quis+architecto.&categories[0]=quisquam&date_start=2021-01-01&date_end=2021-01-31&bank_accounts[0]=velit&customers[0]=repellat&suppliers[0]=id&works[0]=aliquid" }, "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": "Voluptas+voluptatem+molestiae+architecto.", "description": "Description .", "disabled": false }, { "key": "categories[0]", "value": "cumque", "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": "dolores", "description": "The uuid of an existing record in the bank_accounts table.", "disabled": false }, { "key": "customers[0]", "value": "cupiditate", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "optio", "description": "The uuid of an existing record in the suppliers table.", "disabled": false }, { "key": "works[0]", "value": "esse", "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=Voluptas+voluptatem+molestiae+architecto.&categories[0]=cumque&date_start=2021-01-01&date_end=2021-01-31&bank_accounts[0]=dolores&customers[0]=cupiditate&suppliers[0]=optio&works[0]=esse" }, "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\":\"7b6af2d7-33cd-37d5-a50c-0a2b6acb4525\",\"code\":\"FC-31181055\",\"type\":\"dep\\u00f3sito\",\"amount\":5828.5,\"description\":\"Reiciendis voluptatem in quis fugit est.\",\"transaction_date\":\"2009-05-26T03:00:00.000000Z\",\"transaction_category\":{\"id\":null,\"name\":null,\"type\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"d7ae4e54-3cd2-3996-a451-bbeea44a7d3c\",\"code\":\"FC-74117039\",\"type\":\"tarifa\",\"amount\":-7771.63,\"description\":\"Ducimus voluptatem ex quasi ut.\",\"transaction_date\":\"1978-11-12T03: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\":\"a2754fd0-a566-3e2d-b5eb-f7c6287ca868\",\"transaction_category_id\":\"358c74e1-695e-3e86-afa1-8a0f3d129a41\",\"bank_account_id\":\"3eeee45b-67b7-39ab-9fe3-20b3eccc22b2\",\"customer_id\":\"ebde35b5-df42-3ca5-95cf-61f7e34e3838\",\"supplier_id\":\"c78f29ea-c82e-3ce3-8f17-67633b5432da\",\"work_id\":\"fc6531e8-8d31-36e7-aec3-047530fb4cd1\",\"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": "10", "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\":\"2d53cf55-436d-3ba7-8b34-98e1abe738b7\",\"code\":\"FC-58122864\",\"type\":\"dep\\u00f3sito\",\"amount\":6955.02,\"description\":\"Incidunt asperiores unde sequi omnis velit inventore aperiam.\",\"transaction_date\":\"1986-03-26T03: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": "13", "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\":\"2b93516c-ce4a-3d4a-80f8-3962dcb6d961\",\"transaction_category_id\":\"168e3048-e4a2-3919-bc0f-ea8058067d2e\",\"bank_account_id\":\"37cc931f-dd83-34d8-9168-225abc34bb99\",\"customer_id\":\"5f70ba57-5aa3-30ef-9e95-ecd990d8f916\",\"supplier_id\":\"aadef0d7-29e8-342d-bbdd-42899f3effec\",\"work_id\":\"0e9fa4a9-258d-3df3-ad4b-7fcdd0b9c0d2\",\"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": "3", "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\":\"b74c9b85-cdce-313b-ae9b-3fd800d1504a\",\"code\":null,\"opened_by\":null,\"opened_at\":\"2015-10-02T07:51:42.000000Z\",\"closed_by\":null,\"closed_at\":\"1998-09-10T07:03:08.000000Z\",\"opening_balance\":8619.96,\"closing_balance\":2680.28,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Aberto\",\"created_at\":\"1973-06-19T05:22:55.000000Z\",\"updated_at\":\"2021-06-09T21:50:38.000000Z\"},{\"id\":\"e70f25ca-65d6-31c4-9709-fba21059870c\",\"code\":null,\"opened_by\":null,\"opened_at\":\"2024-01-30T21:18:56.000000Z\",\"closed_by\":null,\"closed_at\":\"2008-09-14T16:04:26.000000Z\",\"opening_balance\":5930.83,\"closing_balance\":3858.39,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Aberto\",\"created_at\":\"2000-01-24T03:41:45.000000Z\",\"updated_at\":\"1980-07-19T10:10:38.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\":\"2122272f-f397-3340-b326-0f73824e8314\",\"code\":null,\"opened_by\":null,\"opened_at\":\"2007-08-05T10:08:21.000000Z\",\"closed_by\":null,\"closed_at\":\"2001-04-27T20:43:33.000000Z\",\"opening_balance\":3745.3,\"closing_balance\":5789.32,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Aberto\",\"created_at\":\"1989-02-06T13:49:02.000000Z\",\"updated_at\":\"2007-08-25T16:53:32.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": "5843c834-66a7-3904-9150-56c7fee0cc69", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Close a cash session" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Show cash session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cash-sessions\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/cash-sessions\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "6b859196-afda-3939-951b-cb4da589e427", "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\":\"a9920e4d-6dfe-3bdd-a125-b386cd621b41\",\"code\":null,\"opened_by\":null,\"opened_at\":\"2015-07-30T06:04:55.000000Z\",\"closed_by\":null,\"closed_at\":\"2013-10-09T17:07:29.000000Z\",\"opening_balance\":8850.56,\"closing_balance\":7069.37,\"total_income\":0,\"total_expense\":0,\"total_balance\":0,\"status\":\"Aberto\",\"created_at\":\"2011-07-26T01:25:48.000000Z\",\"updated_at\":\"1978-09-11T02:30:55.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": "46f9c374-9bfb-3e62-b78f-632b70174417", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a cash session" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] } ] }, { "name": "Customers", "description": "Endpoints for customers", "item": [ { "name": "List customers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customers", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Customer+name", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/customers?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Customer+name" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all customers" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"e040150a-79b6-3cad-97ea-7c88c962ba06\",\"name\":\"Hugo M\\u00e1rio da Rosa Sobrinho\",\"email\":\"diogo97@example.com\",\"phone\":\"(27) 93932-7063\",\"document\":\"198.349.253-10\",\"type\":\"pj\",\"responsible\":\"Sr. Jorge Solano de Souza Filho\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents_count\":0},{\"id\":\"de5c49c1-0c24-36ce-8f42-3ea3367377d5\",\"name\":\"Iasmin Bezerra Barros Sobrinho\",\"email\":\"fabricio71@example.org\",\"phone\":\"(34) 90381-3107\",\"document\":\"983.519.782-21\",\"type\":\"pj\",\"responsible\":\"Aparecida L\\u00e9ia Caldeira Filho\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents_count\":0}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customers", "query": [], "raw": "{{baseUrl}}\/api\/customers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"email\":\"user@example.com\",\"phone\":\"(11) 99999-9999\",\"document\":\"Example Document\",\"type\":\"Example Type\",\"responsible\":\"Example Responsible\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"address\":{\"0\":\"example1\",\"1\":\"example2\",\"street\":\"Example Address street\",\"number\":\"Example Address number\",\"complement\":\"Example Address complement\",\"neighborhood\":\"Example Address neighborhood\",\"city\":\"Example Address city\",\"state\":\"Example Address state\",\"zip_code\":\"Example Address zip code\"}}" }, "description": "Create a new customer" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Get customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the customer." }, { "id": "customer", "key": "customer", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Customer ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a customer" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"8ca9062c-795c-3f99-9c88-8e8153290ceb\",\"name\":\"Sr. F\\u00e1bio Ferreira\",\"email\":\"carolina.lourenco@example.net\",\"phone\":\"(81) 97870-9619\",\"document\":\"704.573.031-40\",\"type\":\"pf\",\"responsible\":\"Srta. Betina Gabrielle Ferminiano\",\"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": "16", "description": "The ID of the customer." }, { "id": "customer", "key": "customer", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Customer ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"email\":\"user@example.com\",\"phone\":\"(11) 99999-9999\",\"document\":\"Example Document\",\"type\":\"Example Type\",\"responsible\":\"Example Responsible\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"address\":{\"0\":\"example1\",\"1\":\"example2\",\"street\":\"Example Address street\",\"number\":\"Example Address number\",\"complement\":\"Example Address complement\",\"neighborhood\":\"Example Address neighborhood\",\"city\":\"Example Address city\",\"state\":\"Example Address state\",\"zip_code\":\"Example Address zip code\"}}" }, "description": "Update a customer" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/customers\/:customer", "query": [], "raw": "{{baseUrl}}\/api\/customers\/:customer", "variable": [ { "id": "customer", "key": "customer", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Customer ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a customer" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Document Categories", "description": "Endpoints for document categories", "item": [ { "name": "List document categories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/document-categories", "query": [ { "key": "q", "value": "Contracts", "description": "Search query.", "disabled": false }, { "key": "module", "value": "employee", "description": "Filter by module.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/document-categories?q=Contracts&module=employee" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all document categories" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"745ba4ac-9ac8-3863-9655-4c445b5078a9\",\"name\":\"Isadora Giovanna Zamana Sobrinho\",\"description\":\"Nulla in et molestiae ut. Ea harum excepturi odio voluptas quis. Debitis fuga rerum nulla ab impedit.\",\"module\":\"document\"},{\"id\":\"a66a7a44-c777-32bc-9003-7bbddab463af\",\"name\":\"Dr. Caio Rog\\u00e9rio Alcantara Jr.\",\"description\":\"Iste necessitatibus corporis iste tempore. Consequatur beatae quos ea consequuntur fugiat beatae quidem. Laudantium nulla sed non sunt voluptas.\",\"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": "eligendi", "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\":\"bf6663b9-76d3-378b-9e40-e2490be66f64\",\"name\":\"Sra. Elisa Luciana Ferminiano\",\"description\":\"Aut et harum iusto quia. Similique quas eaque officiis deleniti sequi itaque. Nesciunt quo debitis recusandae praesentium libero dolor eos.\",\"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": "beatae", "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": "explicabo", "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": "voluptatibus", "description": "The uuid of an existing record in the document_categories table.", "disabled": false }, { "key": "documentable_type", "value": "ratione", "description": "Type of the related documentable entity. The type of an existing record in the documentables table.", "disabled": false }, { "key": "customers[0]", "value": "ducimus", "description": "The uuid of an existing record in the customers table.", "disabled": false }, { "key": "suppliers[0]", "value": "quas", "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]=voluptatibus&documentable_type=ratione&customers[0]=ducimus&suppliers[0]=quas" }, "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\":\"00cf771c-059e-339c-bdb0-edb217e3ddda\",\"name\":\"Renato Martines\",\"file\":{\"id\":null,\"url\":null,\"extension\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"54bed1b8-9cec-34f3-9a1c-23e60c8c2488\",\"name\":\"Srta. Val\\u00e9ria Emilly Rico Neto\",\"file\":{\"id\":null,\"url\":null,\"extension\":null},\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Get document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/documents\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "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\":\"79c08168-0799-328b-92a9-bd8c46b2b0cc\",\"name\":\"Leo Daniel Fernandes Filho\",\"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\":\"17391be7-f325-351e-ac67-b316fe4f726d\",\"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": "8", "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\":\"4791ee29-8b81-3239-bc45-81fbab41637e\",\"file\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example File path\",\"name\":\"Example Name\",\"extension\":\"Example File extension\",\"size\":\"Example File size\"},\"documentable_type\":\"Example Documentable type\",\"documentable_id\":\"Example Documentable id\"}" }, "description": "Update a document" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Delete document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/documents\/:document", "query": [], "raw": "{{baseUrl}}\/api\/documents\/:document", "variable": [ { "id": "document", "key": "document", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Document ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a document" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Employee Roles", "description": "Endpoints for employee roles", "item": [ { "name": "List employee roles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employee-roles", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Manager", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/employee-roles?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Manager" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all employee roles" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"db83c6ef-3b65-4d59-8a19-974827e51b78\",\"name\":\"quia\",\"description\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"262c4dc2-317f-4d5d-89cf-2134d2076520\",\"name\":\"in\",\"description\":\"Quisquam sapiente est eos dolorem maiores totam vitae distinctio.\",\"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": "sed", "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\":\"5993de98-5f1b-4393-8a8e-251ace2f9310\",\"name\":\"omnis\",\"description\":null,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Create employee role", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employee-roles", "query": [], "raw": "{{baseUrl}}\/api\/employee-roles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"description\":\"Example Description\"}" }, "description": "Create a new employee role" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update employee role", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employee-roles\/:employeeRole", "query": [], "raw": "{{baseUrl}}\/api\/employee-roles\/:employeeRole", "variable": [ { "id": "employeeRole", "key": "employeeRole", "value": "ad", "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": "ad", "description": "Employee Role UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an employee role" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Employees", "description": "Endpoints for employees", "item": [ { "name": "List employees", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max: 100). O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "q", "value": "Jo%C3%A3o+Silva", "description": "Search query.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/employees?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Jo%C3%A3o+Silva" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all employees" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"7e65c24d-0e99-4b07-be12-ad5254a31694\",\"name\":\"Andres Vale\",\"cpf\":\"559.270.347-80\",\"rg\":\"566728498\",\"ctps\":\"451692333\",\"phone\":\"(75) 4253-5385\",\"birthdate\":null,\"email\":\"vrosa@example.com\",\"pis_pasep\":null,\"admission_date\":\"2004-01-16T02:00:00.000000Z\",\"daily_salary\":null,\"monthly_salary\":\"6695.19\",\"nationality\":\"Lib\\u00e9ria\",\"place_of_birth\":null,\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":null,\"name\":null},\"created_at\":null,\"updated_at\":null},{\"id\":\"20dd9402-dc9a-4035-8ef9-87580c88958a\",\"name\":\"Guilherme Miguel Oliveira\",\"cpf\":\"084.205.645-64\",\"rg\":\"419985438\",\"ctps\":null,\"phone\":null,\"birthdate\":\"2024-07-17T03:00:00.000000Z\",\"email\":null,\"pis_pasep\":\"74891712594\",\"admission_date\":\"2011-07-12T03:00:00.000000Z\",\"daily_salary\":\"329.38\",\"monthly_salary\":\"3086.45\",\"nationality\":null,\"place_of_birth\":\"Rivera do Norte\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":null,\"name\":null},\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Show employee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:id", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:id", "variable": [ { "id": "id", "key": "id", "value": "19", "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\":\"593494c0-b0cc-4905-b569-f29755bb802a\",\"name\":\"Sr. Evandro Sales\",\"cpf\":\"887.395.368-34\",\"rg\":\"284743997\",\"ctps\":\"313982789\",\"phone\":\"(91) 4849-8929\",\"birthdate\":\"2010-01-22T02:00:00.000000Z\",\"email\":\"mario88@example.com\",\"pis_pasep\":\"12522313074\",\"admission_date\":\"1990-05-22T03:00:00.000000Z\",\"daily_salary\":\"381.00\",\"monthly_salary\":null,\"nationality\":\"Seychelles\",\"place_of_birth\":\"Queir\\u00f3s do Sul\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"employee_role\":{\"id\":null,\"name\":null},\"created_at\":null,\"updated_at\":null}}", "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\":\"9e4902b2-5075-42b7-a4d3-1bb9ed932e59\",\"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": "5", "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\":\"1aea82fb-db76-4270-93d2-2ab0a0431b2e\",\"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": "4", "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": "6", "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\":\"praesentium\",\"agency\":\"mauhsn\",\"account\":\"fzgbyednmt\",\"account_type\":\"poupan\u00e7a\",\"pix_key\":\"xqnmenlhbgrorvhpxyvvnjcs\",\"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": "12", "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\":\"modi\",\"agency\":\"rsivno\",\"account\":\"csitla\",\"account_type\":\"poupan\u00e7a\",\"pix_key\":\"vfhvfwdu\",\"favorite\":true}" }, "description": "Update a bank account for an employee" }, "response": [] }, { "name": "Delete employee bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/employees\/:employee\/bank-account\/:id", "query": [], "raw": "{{baseUrl}}\/api\/employees\/:employee\/bank-account\/:id", "variable": [ { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee UUID" }, { "id": "id", "key": "id", "value": "019556e7-2e9f-777c-a177-30bbf0646c33", "description": "Bank account UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a bank account from an employee" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "GET api\/reports\/cash-flow", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/cash-flow", "query": [], "raw": "{{baseUrl}}\/api\/reports\/cash-flow" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/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": "0a42ebb3-7a32-36a9-8dc7-d2940ec5273b", "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": "66e850c1-3644-3b9b-9d36-b00c4e471fea", "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": "2bd43f62-7904-3d39-8968-95fab2039ca9", "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": "Import", "description": "Endpoints for managing NFe imports and product processing.", "item": [ { "name": "NFe Imports", "description": "Import and process Brazilian electronic invoice (NFe) files.", "item": [ { "name": "Create NFe Import", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports\/nfe\/products", "query": [], "raw": "{{baseUrl}}\/api\/imports\/nfe\/products" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"s3_file_path\":\"imports\\\/nfe_12345.xml\",\"original_filename\":\"nota_fiscal_001.xml\",\"import_type\":\"nfe\"}" }, "description": "Upload and process a Brazilian NFe (Nota Fiscal Eletr\u00f4nica) XML file. The file should be uploaded to S3 first, then this endpoint processes it asynchronously." }, "response": [ { "header": [], "code": 201, "body": "{\n \"import_id\": \"9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\",\n \"status\": \"pending\",\n \"channel\": \"import-progress.9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\"\n }", "name": "Import created successfully" }, { "header": [], "code": 404, "body": "{\"error\": \"Arquivo n\u00e3o encontrado no S3\"}", "name": "File not found in S3" }, { "header": [], "code": 422, "body": "{\"error\": \"Arquivo XML inv\u00e1lido ou n\u00e3o \u00e9 uma NFe\"}", "name": "Invalid XML or not a valid NFe" } ] }, { "name": "List User Imports", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports", "query": [ { "key": "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 for the authenticated user with filtering and pagination options." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": \"9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\",\n \"status\": \"completed\",\n \"import_type\": \"nfe\",\n \"original_filename\": \"nota_fiscal_001.xml\",\n \"nfe_number\": \"123456\",\n \"nfe_date\": \"2023-12-01\",\n \"total_products\": 15,\n \"processed_products\": 15,\n \"progress_percentage\": 100.00,\n \"imported_at\": \"2023-12-01T10:30:00.000Z\",\n \"supplier\": {\n \"name\": \"Fornecedor Ltda\",\n \"document\": \"12345678000199\"\n }\n }\n ]\n }", "name": "Imports retrieved successfully" } ] }, { "name": "Get Import Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports\/:importId", "query": [], "raw": "{{baseUrl}}\/api\/imports\/:importId", "variable": [ { "id": "importId", "key": "importId", "value": "placeat", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve detailed information about a specific NFe import, including progress and supplier data." }, "response": [ { "header": [], "code": 200, "body": "{\n \"import_id\": \"9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\",\n \"status\": \"completed\",\n \"import_type\": \"nfe\",\n \"original_filename\": \"nota_fiscal_001.xml\",\n \"nfe_number\": \"123456\",\n \"nfe_date\": \"2023-12-01\",\n \"total_products\": 15,\n \"processed_products\": 10,\n \"progress_percentage\": 66.67,\n \"imported_by\": \"Jo\u00e3o Silva\",\n \"imported_at\": \"2023-12-01T10:30:00.000Z\",\n \"supplier\": {\n \"id\": \"supplier-uuid\",\n \"name\": \"Fornecedor Ltda\",\n \"document\": \"12345678000199\"\n },\n \"channel\": \"import-progress.9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\"\n }", "name": "Import details retrieved successfully" } ] }, { "name": "Get Import Products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports\/:importId\/products", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of products per page. O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "status", "value": "pending", "description": "Filter products by processing status (pending, processed).", "disabled": false }, { "key": "q", "value": "Produto+ABC", "description": "Search products by name \/ code \/ EAN. O campo value n\u00e3o pode ser superior a 255 caracteres.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/imports\/:importId\/products?sort_by=created_at&sort_desc=1&page=1&per_page=15&status=pending&q=Produto+ABC", "variable": [ { "id": "importId", "key": "importId", "value": "quo", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all products from a specific NFe import with filtering and pagination options." }, "response": [ { "header": [], "code": 200, "body": "{\n \"import\": {\n \"id\": \"9d2f8e4a-1b3c-4d5e-6f7a-8b9c0d1e2f3a\",\n \"total_products\": 15,\n \"processed_products\": 10,\n \"progress_percentage\": 66.67\n },\n \"products\": {\n \"data\": [\n {\n \"id\": \"product-uuid\",\n \"supplier_product_code\": \"ABC123\",\n \"ean_code\": \"7891234567890\",\n \"name\": \"Nome do Produto\",\n \"unit\": \"UN\",\n \"quantity\": 10,\n \"unit_price\": 15.50,\n \"total_price\": 155.00,\n \"is_processed\": false,\n \"system_product\": null,\n \"linked_at\": null,\n \"linked_by\": null\n }\n ]\n },\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 15,\n \"last_page\": 1\n }\n }", "name": "Products retrieved successfully" } ] }, { "name": "Link Products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/imports\/:importId\/products\/link", "query": [], "raw": "{{baseUrl}}\/api\/imports\/:importId\/products\/link", "variable": [ { "id": "importId", "key": "importId", "value": "consequatur", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mappings\":[\"ab\"]}" }, "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": "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": "quae", "description": "", "disabled": false }, { "key": "document", "value": "id", "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=quae&document=id&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\":\"ffef6b85-d2af-3e13-b43a-70e1b7021eb0\",\"receipt_number\":\"REC-4862\",\"receiver_type\":\"custom\",\"receiver\":{\"id\":null,\"name\":\"Kiarra Collier\",\"document\":\"704.093.867-65\"},\"payment\":{\"amount\":452.67,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"pix\",\"description\":\"Et similique ut debitis deleniti est.\"},\"issuer\":{\"name\":\"Hoppe, Cummerata and Fisher\",\"document\":\"12.192.290\\\/2656-94\"},\"issue\":{\"date\":\"2026-04-12\",\"city\":\"South Dana\",\"state\":\"PR\"},\"created_by\":{\"id\":\"a1ad8856-200c-45df-abd3-c8605f47de7d\",\"name\":\"Ms. Libby Jaskolski Sr.\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"ee1fe31c-16ed-35f9-a220-a05717d417f7\",\"receipt_number\":\"REC-5928\",\"receiver_type\":\"custom\",\"receiver\":{\"id\":null,\"name\":\"Dr. Alfonzo Lebsack\",\"document\":\"652.691.795-62\"},\"payment\":{\"amount\":7484.01,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"cash\",\"description\":\"Velit aut enim delectus dicta harum omnis accusantium aut.\"},\"issuer\":{\"name\":\"Herzog, Dibbert and Runolfsdottir\",\"document\":\"69.047.638\\\/0123-47\"},\"issue\":{\"date\":\"2026-04-13\",\"city\":\"Lake Joanbury\",\"state\":\"MG\"},\"created_by\":{\"id\":\"a1ad8856-269f-43f9-b85a-fb48bd57d455\",\"name\":\"Ms. Viva Kling\"},\"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 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\":\"0bf048ae-95fe-3d5b-9bfc-be5a6498ad9f\",\"receipt_number\":\"REC-4177\",\"receiver_type\":\"custom\",\"receiver\":{\"id\":null,\"name\":\"Kelley Lang\",\"document\":\"015.012.187-95\"},\"payment\":{\"amount\":6284.59,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"bank_transfer\",\"description\":\"Est distinctio magni dolore facere quis et.\"},\"issuer\":{\"name\":\"Bogan, Von and Luettgen\",\"document\":\"75.243.234\\\/0330-95\"},\"issue\":{\"date\":\"2026-04-22\",\"city\":\"Ratkemouth\",\"state\":\"PE\"},\"created_by\":{\"id\":\"a1ad8856-2d9e-494d-81ba-32ced1e85c24\",\"name\":\"Aletha Wilkinson\"},\"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\":\"fdcd8f57-8667-48d8-8ff0-8b84b9c88981\",\"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\":\"2cca4f88-6a4a-3b3e-a7fe-15f855547155\",\"bank_account_id\":\"f81d40f5-1c3c-317f-9684-4f346475540c\"}" }, "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\":\"6415568f-522c-4660-addf-d183d88f307b\",\"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\":\"23e853fa-25d5-3674-9c14-e8b68063116a\",\"bank_account_id\":\"3cd849dc-66ef-3ca8-ae76-37c635cb7286\"}" }, "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": "3", "description": "The ID of the employee." }, { "id": "employee", "key": "employee", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Employee ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all payment receipts for a specific employee" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"493ac34b-a032-316d-88c2-0fcfa1e9dd13\",\"receipt_number\":\"REC-8693\",\"receiver_type\":\"custom\",\"receiver\":{\"id\":null,\"name\":\"Ursula Mayer\",\"document\":\"035.489.018-80\"},\"payment\":{\"amount\":5128.61,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"cash\",\"description\":\"Est sit voluptas mollitia magnam ea minima vel.\"},\"issuer\":{\"name\":\"Koelpin-O'Keefe\",\"document\":\"55.311.990\\\/0778-71\"},\"issue\":{\"date\":\"2026-04-08\",\"city\":\"Funkburgh\",\"state\":\"MG\"},\"created_by\":{\"id\":\"a1ad8856-47a3-40ce-89db-9adae6404848\",\"name\":\"Ms. Amanda Herzog\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"116cb206-65f9-3add-9e11-de004b7762c2\",\"receipt_number\":\"REC-5348\",\"receiver_type\":\"employee\",\"receiver\":{\"id\":null,\"name\":\"Prof. Rolando Howell IV\",\"document\":\"165.751.219-77\"},\"payment\":{\"amount\":1700.88,\"amount_in_words\":\"Valor por extenso de teste\",\"method\":\"pix\",\"description\":\"Qui sed et illum voluptatem et sunt.\"},\"issuer\":{\"name\":\"VonRueden Group\",\"document\":\"34.672.067\\\/3746-04\"},\"issue\":{\"date\":\"2026-04-18\",\"city\":\"West Kadinburgh\",\"state\":\"PE\"},\"created_by\":{\"id\":\"a1ad8856-4a69-4c57-86ec-6bea545f1a66\",\"name\":\"Prof. Lexus Boyle\"},\"created_at\":null,\"updated_at\":null}],\"pagination\":{\"total\":2,\"count\":2,\"per_page\":10,\"current_page\":1,\"total_pages\":1,\"has_more_pages\":false},\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] } ] }, { "name": "Permission Groups", "description": "Endpoints for permission groups", "item": [ { "name": "List permission groups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/permission-groups", "query": [], "raw": "{{baseUrl}}\/api\/permission-groups" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all permission groups" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"238d1ced-09dd-3eee-b0d1-71b0047562d5\",\"name\":\"est-minima\",\"display_name\":\"architecto vel autem\",\"created_at\":null,\"updated_at\":null},{\"id\":\"a70e4658-1b57-346d-8dad-42508c356328\",\"name\":\"eos-qui\",\"display_name\":\"sint voluptatem aspernatur\",\"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\":\"e8ed831c-63f9-3c94-94e6-985de0411a99\",\"name\":\"sed-sit-et\",\"display_name\":\"praesentium qui nihil\",\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Delete permission group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/permission-groups\/:permissionGroup", "query": [], "raw": "{{baseUrl}}\/api\/permission-groups\/:permissionGroup", "variable": [ { "id": "permissionGroup", "key": "permissionGroup", "value": "1", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a permission group" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Product Brands", "description": "Endpoints for product brands", "item": [ { "name": "List product brands", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/product-brands", "query": [ { "key": "q", "value": "Structure", "description": "", "disabled": false } ], "raw": "{{baseUrl}}\/api\/product-brands?q=Structure" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all product brands" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"3dcfc590-6477-37e2-8045-f3439aaf71f0\",\"name\":\"Elizabeth de Souza\",\"created_at\":null,\"updated_at\":null},{\"id\":\"b364f4c7-c66a-3d69-9b3e-afc60f15ef27\",\"name\":\"Fl\\u00e1vio Sep\\u00falveda Campos\",\"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": "ea", "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\":\"0a5ed127-3b2f-3852-9f6a-18f260e33678\",\"name\":\"Srta. Let\\u00edcia Naiara Garcia Neto\",\"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": "aliquid", "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": "facere", "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\":\"d06b6450-9b80-3dff-9ac2-54ff11586aec\",\"name\":\"James Robson Padilha\",\"created_at\":null,\"updated_at\":null},{\"id\":\"e785f71d-61ef-30d7-af93-17289cfb15df\",\"name\":\"Sr. In\\u00e1cio Maximiano Esteves\",\"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": "voluptas", "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\":\"7740cd29-e9d7-3c3c-8665-51e189eb9c62\",\"name\":\"Sr. Maicon Espinoza 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": "placeat", "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": "ullam", "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\":\"1178af1a-92ac-3761-ad8b-8e14147d7610\",\"user_id\":\"61d6537d-dbca-3c0f-8f72-a5c73ffb251c\",\"responsible_id\":\"ffd8c92a-dbc3-378e-b6ab-ef16d290821a\",\"per_page\":1,\"sort\":\"Example Sort\",\"sort_desc\":true}" }, "description": "List all product quantity lists" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"20fc635d-9d65-3bcc-abd0-ae4eec248efa\",\"name\":\"Ut rerum non aut.\",\"description\":null,\"work\":{\"id\":\"a1ad8856-db1f-49dc-93cb-06a0249d803e\",\"name\":\"Dr. F\\u00e1tima Fernanda Faria\"},\"user\":{\"id\":\"a1ad8856-decf-4021-9846-29ff2f6dcc34\",\"name\":\"Aniyah Fadel\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"a7a88239-498c-346b-9c09-dbc87ab64fab\",\"name\":\"Accusantium et.\",\"description\":null,\"work\":{\"id\":\"a1ad8856-e228-41d8-ab1b-1d26e674fdb2\",\"name\":\"Sr. Edilson Cort\\u00eas\"},\"user\":{\"id\":\"a1ad8856-e4d8-4622-ba7a-de992fc5c21f\",\"name\":\"Elissa Moen\"},\"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": "impedit", "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\":\"526d8d1e-fdcc-3259-8098-9dada80f9204\",\"name\":\"Iusto molestias tenetur magnam dolor.\",\"description\":null,\"work\":{\"id\":\"a1ad8856-ec37-49d9-af17-4359982512fa\",\"name\":\"Rebeca Ortiz \\u00c1vila Filho\"},\"user\":{\"id\":\"a1ad8856-ef59-42c5-a66b-7bf439b3b43d\",\"name\":\"Prof. Timothy Hoppe DVM\"},\"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": "porro", "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\":\"58d46546-1334-38f1-a7d5-699126847d1a\",\"product\":{\"id\":\"a1ad8857-0644-401d-960c-539feac3ba33\",\"name\":\"Louise Louren\\u00e7o Grego\",\"code\":\"PRD-673150\",\"unit\":{\"id\":\"a1ad8857-0435-4bf1-bcc1-04a808ebfcd9\",\"name\":\"Dr. Aurora Ingrid Louren\\u00e7o Sobrinho\",\"abbreviation\":\"Sr. Maicon Sim\\u00e3o Correia\"}},\"quantity\":480.5684,\"observation\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"5b4dee8e-374e-349c-bd29-4497556653a2\",\"product\":{\"id\":\"a1ad8857-1627-4882-bb6b-230e52bbfd09\",\"name\":\"Sr. Matias Galindo\",\"code\":\"PRD-186951\",\"unit\":{\"id\":\"a1ad8857-14bd-4ebc-8f34-1c90f407fe35\",\"name\":\"Dr. Cezar Delgado Gon\\u00e7alves\",\"abbreviation\":\"Sra. Mirella Marinho Vieira\"}},\"quantity\":55.3758,\"observation\":\"Aut sed explicabo aut.\",\"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\":\"29f04303-9f54-3dd3-bf0d-8eaf607f3d83\",\"items\":[{\"product_id\":\"bd7250f4-4e53-35f4-8d79-747f8d017132\",\"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": "totam", "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\":\"3eb4c3dc-380f-321f-8267-fd928827d1db\",\"product_id\":\"f76ba25d-fc95-3713-a62b-b045892d9c48\",\"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": "doloribus", "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": "assumenda", "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\":\"6a089807-cd9b-374d-aa12-7ddfb80acb29\",\"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": "praesentium", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "alias", "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": "et", "description": "Product Quantity List UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[\"ac8b7f69-9396-3b09-8602-dbfdf7f12d17\"]}" }, "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": "nulla", "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\":\"22369358-61c4-32c8-b04e-111853283431\",\"product_id\":\"2cb45810-3951-39ce-b2ae-aa2126c9ecd2\",\"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": "dolorem", "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\":\"3f6d2ba7-8758-3ae1-9c91-09e9398a64e8\",\"quantity\":1,\"source_stock_id\":\"41d442fd-dcfb-3718-ac7b-7258b712c736\",\"reason\":\"Example Reason\",\"origins\":[{\"supplier_product_id\":\"9fa15d69-6c5d-3405-8e6c-da7873603765\",\"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": "quam", "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\":\"838191be-480f-377b-93c2-1e45ee231a6e\",\"quantity\":3.2194,\"fulfilled_at\":\"2026-04-03T13:51:21.000000Z\",\"created_at\":null},{\"id\":\"65317052-8264-3d2c-813f-34d82600e846\",\"quantity\":12.7977,\"fulfilled_at\":\"2026-04-26T20:26:03.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": "quam", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "pariatur", "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\":\"fc7da31e-f586-3618-9a02-4d8c4ea82e95\",\"product\":{\"id\":\"a1ad885a-d996-4dbb-99fc-6e11a58689a3\",\"name\":\"Danielle de Arruda Delgado Sobrinho\",\"code\":\"PRD-271399\",\"unit\":{\"id\":\"a1ad885a-d813-466a-ad88-361208634f2e\",\"name\":\"Dr. Filipe Luciano Pacheco Filho\",\"abbreviation\":\"Sra. Mariah Delvalle Salas\"}},\"quantity\":785.5152,\"quantity_fulfilled\":0,\"quantity_pending\":785.5152,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Error sit libero laudantium voluptas architecto dolore qui.\",\"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": "quam", "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\":\"5a5a19d4-1fcd-3a06-857c-b7c62ff7d039\",\"product\":{\"id\":\"a1ad885a-f470-4efa-8602-b0b51dbae746\",\"name\":\"Wellington Rosa Matias\",\"code\":\"PRD-652043\",\"unit\":{\"id\":\"a1ad885a-f30b-49a2-97b0-0e346e8d4897\",\"name\":\"Sra. Sophia Corona Madeira\",\"abbreviation\":\"Sra. Heloise Luna Grego\"}},\"quantity\":615.9482,\"quantity_fulfilled\":0,\"quantity_pending\":615.9482,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Maxime ea modi eos dolor id.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"b670b24b-56b2-3b8f-ac4e-573cfbc2e2cb\",\"product\":{\"id\":\"a1ad885b-06dd-4c19-b3f3-2060e80a8a3c\",\"name\":\"Mateus Padilha Tamoio Filho\",\"code\":\"PRD-413221\",\"unit\":{\"id\":\"a1ad885b-056e-4d4e-a278-6cea3c01ccff\",\"name\":\"Dr. Sara Lorena Estrada Filho\",\"abbreviation\":\"Carla Mirella Valente\"}},\"quantity\":56.8181,\"quantity_fulfilled\":0,\"quantity_pending\":56.8181,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Consectetur vitae consequuntur aut quasi.\",\"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": "expedita", "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\":\"182d4ce9-8326-34f7-ae4f-77e160ded62d\",\"product\":{\"id\":\"a1ad885b-1eeb-46a5-8018-a5a04669afe0\",\"name\":\"Richard Valentin Neto\",\"code\":\"PRD-134066\",\"unit\":{\"id\":\"a1ad885b-1d6f-4eea-8b59-d2fda2efae58\",\"name\":\"Naomi Benez Santacruz Jr.\",\"abbreviation\":\"Srta. Cec\\u00edlia Bezerra Filho\"}},\"quantity\":217.2117,\"quantity_fulfilled\":0,\"quantity_pending\":217.2117,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"c106e760-ff31-3e7e-aa6b-4d803d91e6f8\",\"product\":{\"id\":\"a1ad885b-4090-425c-902f-0f87d3e91232\",\"name\":\"Jasmin Santos Amaral\",\"code\":\"PRD-739243\",\"unit\":{\"id\":\"a1ad885b-3e5c-452e-9075-cc3a60bcb696\",\"name\":\"Dr. Laiane Deverso\",\"abbreviation\":\"F\\u00e1tima Caldeira Burgos Sobrinho\"}},\"quantity\":336.1281,\"quantity_fulfilled\":0,\"quantity_pending\":336.1281,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":null,\"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\":\"43773d6a-3721-32b5-80d9-738e66d10df8\",\"work_location_id\":\"2f8b58cf-51c6-3336-bdf6-a004900a7966\",\"user_id\":\"7329a95a-c5ae-3205-8dd6-50cbabc4a708\",\"status_id\":\"c0e83d91-16af-3e35-a403-7c4fa5cb3869\",\"priority\":\"Example Priority\",\"needed_at_from\":\"Example Needed at from\",\"needed_at_to\":\"Example Needed at to\",\"responsible_id\":\"5dcc1f31-a287-302a-a7da-7109017522a3\"}" }, "description": "List all product requests" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"ba40db12-049b-3b50-8573-41bc4e87a5db\",\"code\":null,\"name\":\"Inventore voluptatem iste eos.\",\"description\":\"Minima deleniti soluta omnis cum sit dolor voluptas nostrum. Est omnis sapiente perferendis unde. Distinctio atque id suscipit dolorem recusandae.\",\"work\":{\"id\":\"a1ad8858-393b-44af-87f3-3b2335292490\",\"name\":\"Maicon Marin\"},\"user\":{\"id\":\"a1ad8858-3c96-474c-b544-45b26af03578\",\"name\":\"Mrs. Clarissa Padberg Sr.\"},\"status\":{\"id\":\"a1ad8858-3fcf-4db4-8cac-55d9d80727a3\",\"slug\":null,\"name\":null,\"description\":\"M\\u00e1rcio Rios\",\"abbreviation\":\"sit\",\"color\":\"#f1af35\",\"text_color\":\"#817426\"},\"priority\":\"urgent\",\"priority_label\":\"Urgente\",\"needed_at\":\"2026-05-18\",\"approved_at\":null,\"rejection_reason\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"71325ec6-c3f4-3d99-9e26-4616eacd29cd\",\"code\":null,\"name\":\"Facere et velit.\",\"description\":null,\"work\":{\"id\":\"a1ad8858-4489-41c8-818e-6333700b2d36\",\"name\":\"Denise Fernandes\"},\"user\":{\"id\":\"a1ad8858-474d-4b29-a5b5-24b9494ae0f6\",\"name\":\"Ricardo Marquardt\"},\"status\":{\"id\":\"a1ad8858-491e-4647-a20d-50a3d6f80963\",\"slug\":null,\"name\":null,\"description\":\"Cynthia Carvalho Branco\",\"abbreviation\":\"non\",\"color\":\"#700432\",\"text_color\":\"#c67883\"},\"priority\":\"low\",\"priority_label\":\"Baixa\",\"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": "rerum", "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\":\"45cfdca7-f2f6-3538-8511-8f14dd5f1666\",\"code\":null,\"name\":\"Sed provident ad.\",\"description\":\"Maxime qui quod est blanditiis. Ratione nam consequatur et cupiditate quidem minus. Quia beatae et qui ad praesentium doloribus delectus. Doloribus neque et rerum est aliquam. Ad est reprehenderit est reprehenderit quia quibusdam repellendus tenetur.\",\"work\":{\"id\":\"a1ad8858-53f4-42d1-a767-a6ac493a337d\",\"name\":\"Mait\\u00ea Esteves Faro Filho\"},\"user\":{\"id\":\"a1ad8858-5803-4079-8e1e-541deb7bc00b\",\"name\":\"Jacinto Cormier\"},\"status\":{\"id\":\"a1ad8858-5a4c-49ac-814e-0efd13eb3cff\",\"slug\":null,\"name\":null,\"description\":\"Simone Karine Barros\",\"abbreviation\":\"molestias\",\"color\":\"#45fb2a\",\"text_color\":\"#e65a1f\"},\"priority\":\"high\",\"priority_label\":\"Alta\",\"needed_at\":\"2026-05-28\",\"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": "a", "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\":\"385b3cba-5a58-3dd3-a40a-712de2d2f5e1\",\"product\":{\"id\":\"a1ad8858-8ec3-4b1b-a16a-5d44f9d5a23a\",\"name\":\"Sr. Alessandro Padilha Neto\",\"code\":\"PRD-186880\",\"unit\":{\"id\":\"a1ad8858-8b75-49fb-81d3-1680289dce3e\",\"name\":\"Renato da Rosa\",\"abbreviation\":\"Sra. Eunice de Souza Medina Filho\"}},\"quantity\":182.4585,\"quantity_fulfilled\":0,\"quantity_pending\":182.4585,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Minima soluta sint consequuntur odio recusandae ab dolorem.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"f55ca70f-48e5-3d44-9b32-f063279b6830\",\"product\":{\"id\":\"a1ad8858-ab3f-4e6c-ba7d-1f71a2183cb2\",\"name\":\"Sandro Sim\\u00e3o Sales Filho\",\"code\":\"PRD-448158\",\"unit\":{\"id\":\"a1ad8858-a811-4729-84fd-aeb910611f5d\",\"name\":\"Dr. Thomas Adriano Lutero Sobrinho\",\"abbreviation\":\"Sr. Ot\\u00e1vio Franco Pereira\"}},\"quantity\":607.641,\"quantity_fulfilled\":0,\"quantity_pending\":607.641,\"is_fulfilled\":false,\"is_partially_fulfilled\":false,\"observation\":\"Accusamus maiores et culpa delectus.\",\"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\":\"b576debd-1ad6-310c-94c6-3e761a2f4c23\",\"work_location_id\":\"6e53563a-3e34-3161-81bb-ecb4dac68833\",\"status_id\":\"e682b664-0e99-3bb3-8649-c94866cfd222\",\"priority\":\"Example Priority\",\"needed_at\":\"Example Needed at\",\"items\":[{\"product_id\":\"119fc890-41de-3cd6-a0ef-3b476611b7be\",\"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": "rerum", "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\":\"36943dc9-8116-3580-ae6c-a67a432d56a9\",\"work_location_id\":\"b8b5f44d-2dcd-3002-aaf3-5d4e4dcd0ebb\",\"status_id\":\"771f597d-60bd-3699-a737-3afbf087f384\",\"priority\":\"Example Priority\",\"needed_at\":\"Example Needed at\",\"items\":[{\"id\":\"43d96488-2757-314a-b27c-1eb6c69d528a\",\"product_id\":\"2863a5fb-d28e-30b0-be60-39af2562b51b\",\"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": "quis", "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": "quia", "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": "distinctio", "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": "magni", "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\":\"4ac7663d-f63e-3da7-a485-a45b5462a98c\",\"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": "dolorum", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "nihil", "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\":\"a7a83d4f-3ffa-3696-8114-519e5ef03187\"}" }, "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": "ipsa", "description": "Product Request UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[\"f28e0ccc-5573-3ca5-b207-c343757257ee\"]}" }, "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": "distinctio", "description": "Product Request UUID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"id\":\"96e0e9c3-f7d3-354c-a3a4-8241050bf7b6\",\"product_id\":\"8e8b3ec5-1e6d-3744-a8ad-0af0a0e42cc1\",\"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 } ], "raw": "{{baseUrl}}\/api\/products?sort_by=created_at&sort_desc=1&page=1&per_page=15&q=Brick" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all products" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"a6acccce-8fa0-3eaa-b029-4c847eb7b16f\",\"name\":\"Dr. Violeta Rivera Filho\",\"code\":\"PRD-319204\",\"stock\":78,\"product_family\":{\"id\":\"a1ad8856-6e15-4b43-9312-a4da4779a8d0\",\"name\":\"Franciele Urias Cervantes Filho\"},\"product_brand\":{\"id\":\"a1ad8856-7089-4fd2-87ee-16dad9f58a8c\",\"name\":\"Diogo Emiliano Gil Filho\"},\"unit\":{\"id\":\"a1ad8856-72e5-42e9-b911-8bbf7ff72e12\",\"name\":\"Sra. Noemi Beltr\\u00e3o Jr.\",\"abbreviation\":\"Sr. Breno Amaral Queir\\u00f3s\"},\"image\":{\"id\":null,\"url\":null},\"description\":\"Qui ullam at reiciendis.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"3cc1a1ad-2524-3f48-bf07-1106202c47d3\",\"name\":\"Reinaldo Pacheco Padr\\u00e3o\",\"code\":\"PRD-680724\",\"stock\":394,\"product_family\":{\"id\":\"a1ad8856-7699-4020-a79c-ba4fec163519\",\"name\":\"Noel\\u00ed Lovato Cruz Jr.\"},\"product_brand\":{\"id\":\"a1ad8856-783d-4b4e-a921-852ca987a033\",\"name\":\"Sra. Heloise de Freitas Jr.\"},\"unit\":{\"id\":\"a1ad8856-79d0-42d3-bc06-b3ad872f7ff3\",\"name\":\"Melissa Mendes\",\"abbreviation\":\"Thiago Galindo\"},\"image\":{\"id\":null,\"url\":null},\"description\":\"Laborum cupiditate facilis rem.\",\"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": "perferendis", "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\":\"15d500d5-61b6-3d3f-b729-2b864bcaa21c\",\"name\":\"Dr. Crist\\u00f3v\\u00e3o Gusm\\u00e3o\",\"code\":\"PRD-163648\",\"stock\":95352,\"product_family\":{\"id\":\"a1ad8856-82a1-4cec-9026-98d5dd2eb3e7\",\"name\":\"Noa \\u00c1vila Saraiva Sobrinho\"},\"product_brand\":{\"id\":\"a1ad8856-84ad-496a-98c9-0015f21026af\",\"name\":\"Sr. Igor Arag\\u00e3o Vieira Sobrinho\"},\"unit\":{\"id\":\"a1ad8856-8694-4169-95c4-e70b13a441f7\",\"name\":\"Erik Hor\\u00e1cio Delvalle Neto\",\"abbreviation\":\"Sra. Heloise Burgos Soto Neto\"},\"image\":{\"id\":null,\"url\":null},\"description\":\"Eos ad iure ducimus error.\",\"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": "molestiae", "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\":\"73c63dec-4f7e-32e8-8056-249cbd7f68a5\",\"product_brand_id\":\"7f814061-0af3-31c8-b17e-13796e2ca655\",\"unit_id\":\"a1028ecf-5a87-3eda-aa7d-1f5111522909\",\"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": "eaque", "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\":\"ae878219-86a2-3c3d-b634-50ab6814e2e3\",\"product_brand_id\":\"aa280314-7e6e-3b98-bbc5-7fc3f587428e\",\"unit_id\":\"466bf120-6caf-3a74-adf5-9a0b28414a4b\",\"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": "quo", "description": "Product UUID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a product" }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Reports", "description": "", "item": [ { "name": "Export 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\":\"0660c21b-4a34-34a5-9e57-7f134a9dec35\",\"name\":\"veniam quasi\",\"slug\":null,\"description\":\"Quis iste qui deleniti ex aspernatur. Error hic et aut expedita ducimus. Velit non aut ipsam deserunt.\",\"abbreviation\":null,\"created_at\":null,\"updated_at\":null},{\"id\":\"a5a70af0-bd24-3fb6-8bcd-e050f4cc8d01\",\"name\":\"officia distinctio\",\"slug\":null,\"description\":null,\"abbreviation\":\"hew\",\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create sector", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors", "query": [], "raw": "{{baseUrl}}\/api\/sectors" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"slug\":\"Example Slug\",\"description\":\"Example Description\",\"abbreviation\":\"Example Abbreviation\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"url\":\"https:\\\/\\\/example.com\",\"name\":\"Example Name\",\"size\":\"Example Image size\",\"extension\":\"Example Image extension\"}}" }, "description": "Create a new sector" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Get sector", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors\/:id", "query": [], "raw": "{{baseUrl}}\/api\/sectors\/:id", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the sector." }, { "id": "sector", "key": "sector", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Sector ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a sector" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"5a595368-ee6b-38da-b8d9-2116956165bb\",\"name\":\"aut et\",\"slug\":null,\"description\":null,\"abbreviation\":\"yyl\",\"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": "9", "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": "12", "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\":\"ceb274d4-457d-3897-a0b4-6c3a1a88f81d\",\"name\":\"Jaquan Volkman Jr.\",\"username\":\"herman.lisa\",\"email\":\"verdman@example.net\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"0e82d6fc-b136-3bd2-9c63-01e291e7bdd7\",\"name\":\"Gracie Dickinson\",\"username\":\"graham.mariano\",\"email\":\"lennie.metz@example.com\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Attach users to sector", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/sectors\/:sector\/users\/attach", "query": [], "raw": "{{baseUrl}}\/api\/sectors\/:sector\/users\/attach", "variable": [ { "id": "sector", "key": "sector", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Sector UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"users\":[\"e0e1e512-5ded-3c79-8d2b-6dcff6f45a83\"]}" }, "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\":[\"c13ccccf-c26c-33c4-b0d3-714ee269e5c9\"]}" }, "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\":[\"f5f6ecc1-fc1f-361f-86d3-5fa4cf1e0b88\"]}" }, "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\":\"tempore maiores\",\"slug\":\"ipsa-repellat-voluptas-id-velit-neque-dolor-repellat\"},{\"name\":\"mollitia dicta\",\"slug\":\"et-ut-vel-et-voluptatem\"}]}", "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\":\"d30b7ab9-b417-3a47-8334-00f3064ab56a\",\"slug\":null,\"name\":null,\"description\":\"Dr. Bianca Vieira Vila Neto\",\"abbreviation\":\"a\",\"color\":\"#299c91\",\"text_color\":\"#aab97b\",\"created_at\":null,\"updated_at\":null},{\"id\":\"d71542ce-c7ce-3387-b697-7048a7d90de1\",\"slug\":null,\"name\":null,\"description\":\"Dr. Emanuel Ronaldo Verdugo\",\"abbreviation\":\"iste\",\"color\":\"#64223f\",\"text_color\":\"#9e1ecc\",\"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\":\"0bd46c28-72c1-32e3-b3e2-294010208d8c\",\"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\":\"158006a7-d03e-3b12-bef3-f9d2b5efb183\",\"slug\":null,\"name\":null,\"description\":\"Fernanda Louise Grego\",\"abbreviation\":\"maxime\",\"color\":\"#a23008\",\"text_color\":\"#b660e8\",\"module\":{\"name\":\"Obras\",\"slug\":\"work\"},\"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\":\"2b343d57-35a8-38bd-ba43-3f10baecd5d3\",\"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\":\"11e300c0-5275-35ab-98d6-519f8390a287\",\"quantity\":596.1352,\"min_quantity\":null,\"max_quantity\":null,\"below_minimum\":false,\"above_maximum\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"5bd2e13c-5e68-3a16-bda0-b1b4830beb5f\",\"quantity\":197.5238,\"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\":\"1a1070ba-7590-377c-873b-3d5999cad0f7\",\"name\":\"Estoque Sanches-Campos\",\"module\":\"work\",\"is_active\":true,\"is_main\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"6f41da6e-b9e2-3ed0-8369-337054019780\",\"name\":\"Estoque Meireles e Cruz e Associados\",\"module\":\"work\",\"is_active\":true,\"is_main\":false,\"created_at\":null,\"updated_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create stock", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks", "query": [], "raw": "{{baseUrl}}\/api\/stocks" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"module\":\"Example Module\",\"id\":\"Example Id\",\"is_active\":true}" }, "description": "Creates a new stock linked to a module" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"a9cd3307-d986-3082-9b6c-7ad85612fd87\",\"name\":\"Estoque Gusm\\u00e3o e Gil\",\"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\":\"e8bf484c-0c40-32b0-b0f2-8f0211e5761e\",\"name\":\"Estoque Abreu e Benites e Filhos\",\"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\":\"8f09ef65-83dd-32bd-9ea7-21f34ef6e005\",\"name\":\"Estoque Saito e Guerra e Associados\",\"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\":\"d4da4811-7adc-3c07-9ee9-5117f6964b85\",\"name\":\"Estoque Carvalho e Rezende\",\"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\":\"8c5e2826-e64e-3b41-95ad-de631f034d55\",\"quantity\":244.8438,\"min_quantity\":null,\"max_quantity\":null,\"below_minimum\":false,\"above_maximum\":false,\"created_at\":null,\"updated_at\":null},{\"id\":\"9e6a4678-0b88-34bc-bb58-9552fa3a8795\",\"quantity\":717.7811,\"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": "illo", "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\":\"0b885fe4-2051-371c-826f-c17382a03ffe\",\"quantity\":98.3381,\"min_quantity\":null,\"max_quantity\":null,\"below_minimum\":false,\"above_maximum\":false,\"created_at\":null,\"updated_at\":null}}", "name": "" } ] }, { "name": "Stock summary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:stock\/summary", "query": [], "raw": "{{baseUrl}}\/api\/stocks\/:stock\/summary", "variable": [ { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a summary with totals and alerts for the stock" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"total_products\": 15,\n \"total_quantity\": 1250.5,\n \"items_below_minimum\": 3,\n \"items_above_maximum\": 1\n }\n}", "name": "" } ] } ] }, { "name": "Stock Movements", "description": "Endpoints for stock movement management", "item": [ { "name": "List movements", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stocks\/:stock_id\/movements", "query": [ { "key": "sort_by", "value": "created_at", "description": "Field to sort by.", "disabled": false }, { "key": "sort_desc", "value": "1", "description": "Sort order (true for descending, false for ascending).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. O campo value deve ser pelo menos 1.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Number of items per page. O campo value deve ser pelo menos 1. O campo value n\u00e3o pode ser superior a 100.", "disabled": false }, { "key": "type", "value": "entry", "description": "Filter by movement type (entry, consumption, transfer_in, transfer_out, adjustment_up, adjustment_down). O campo value n\u00e3o pode ser superior a 50 caracteres.", "disabled": false }, { "key": "product_id", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Filter by product UUID. O campo value deve ser um UUID v\u00e1lido.", "disabled": false }, { "key": "date_start", "value": "2024-01-01", "description": "Filter movements from this date (YYYY-MM-DD). O campo value deve ser uma data v\u00e1lida.", "disabled": false }, { "key": "date_end", "value": "2024-12-31", "description": "Filter movements until this date (YYYY-MM-DD). O campo value deve ser uma data v\u00e1lida. O campo value deve ser uma data posterior ou igual a date_start.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/stocks\/:stock_id\/movements?sort_by=created_at&sort_desc=1&page=1&per_page=10&type=entry&product_id=019556e7-2e9f-777c-a177-30bbf0646c32&date_start=2024-01-01&date_end=2024-12-31", "variable": [ { "id": "stock_id", "key": "stock_id", "value": "1", "description": "The ID of the stock." }, { "id": "stock", "key": "stock", "value": "019556e7-2e9f-777c-a177-30bbf0646c32", "description": "Stock UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of movements for a stock" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"1d55f3d8-7d1b-3527-b716-c62c2c716363\",\"code\":\"MOV-951875\",\"type\":\"consumo\",\"type_name\":\"CONSUMPTION\",\"is_entry\":false,\"is_exit\":true,\"quantity\":39.6569,\"previous_quantity\":188.4759,\"new_quantity\":148.819,\"reason\":\"Ut quasi et officia temporibus incidunt reprehenderit eligendi.\",\"movement_date\":\"2026-04-10T05:22:39.000000Z\",\"created_at\":null},{\"id\":\"22dae1de-dde2-375d-93c3-7aaea93db3d7\",\"code\":\"MOV-923453\",\"type\":\"produ\\u00e7\\u00e3o\",\"type_name\":\"PRODUCTION\",\"is_entry\":true,\"is_exit\":false,\"quantity\":32.3117,\"previous_quantity\":286.5256,\"new_quantity\":318.8373,\"reason\":\"Tempore asperiores sint alias vel.\",\"movement_date\":\"2026-04-09T21:44:01.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\":\"4b5030d0-95d0-3e87-9550-076656542d41\",\"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\":\"74024754-b57b-33aa-9883-f29956639683\",\"code\":\"MOV-975083\",\"type\":\"consumo\",\"type_name\":\"CONSUMPTION\",\"is_entry\":false,\"is_exit\":true,\"quantity\":34.4175,\"previous_quantity\":779.5335,\"new_quantity\":745.116,\"reason\":\"Molestias hic et minus laudantium omnis et aut quis.\",\"movement_date\":\"2026-04-11T23:04:41.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\":\"75a77714-012c-31ac-a0b1-7b76c3cc30a9\",\"destination_stock_id\":\"40a5a8b3-dc0c-3cfe-8923-52752a28b335\",\"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\":\"5c08bb2f-263a-35e2-b648-c0d88f6bf204\",\"code\":\"MOV-106175\",\"type\":\"sa\\u00edda transfer\\u00eancia\",\"type_name\":\"TRANSFER_OUT\",\"is_entry\":false,\"is_exit\":true,\"quantity\":60.0413,\"previous_quantity\":911.7241,\"new_quantity\":851.6828,\"reason\":null,\"movement_date\":\"2026-04-03T15:05:04.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\":\"ba3cb548-b164-3568-8d54-64ddd2f9a5e2\",\"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\":\"d819163b-41b7-3bf6-8551-57ab2608acad\",\"code\":\"MOV-261267\",\"type\":\"compra\",\"type_name\":\"PURCHASE\",\"is_entry\":true,\"is_exit\":false,\"quantity\":66.234,\"previous_quantity\":767.1041,\"new_quantity\":833.3381,\"reason\":null,\"movement_date\":\"2026-04-18T16:41:07.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\":\"fd49d22d-5f10-3ad9-a88f-d530224b1899\",\"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\":\"1af1f794-9943-3410-8c94-4b3b51605d4a\",\"code\":\"MOV-847657\",\"type\":\"sa\\u00edda transfer\\u00eancia\",\"type_name\":\"TRANSFER_OUT\",\"is_entry\":false,\"is_exit\":true,\"quantity\":47.0421,\"previous_quantity\":13.3993,\"new_quantity\":0,\"reason\":null,\"movement_date\":\"2026-04-30T20:14:59.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\":\"00a074b5-fce1-33bb-89c9-dd85a294e26d\",\"code\":\"MOV-968894\",\"type\":\"ajuste entrada\",\"type_name\":\"ADJUSTMENT_IN\",\"is_entry\":true,\"is_exit\":false,\"quantity\":57.2394,\"previous_quantity\":239.0026,\"new_quantity\":296.242,\"reason\":null,\"movement_date\":\"2026-04-10T20:02:12.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\":\"e0025951-2c4f-3dbc-acb8-ebfb60974f82\",\"name\":\"Mois\\u00e9s M\\u00e1rio Gon\\u00e7alves\",\"email\":\"luciano08@example.org\",\"phone\":\"(93) 3398-8343\",\"document\":\"48.756.084\\\/0001-14\",\"type\":\"pf\",\"responsible\":\"Dr. Fl\\u00e1vio Denis Ferminiano\",\"image\":{\"id\":null,\"url\":null},\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null}},{\"id\":\"3b0ae98d-3b9c-387a-b79f-9c93f5525237\",\"name\":\"Sr. Camilo William Bezerra\",\"email\":\"salas.lorenzo@example.net\",\"phone\":\"(46) 98546-8387\",\"document\":\"01.513.134\\\/0001-79\",\"type\":\"pj\",\"responsible\":\"Dr. Camila Domingues Rezende 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\":\"e6e5e129-0aee-3e11-9c18-8fa775514379\",\"name\":\"Beatriz Hosana Neves Jr.\",\"email\":\"adriel.valdez@example.org\",\"phone\":\"(87) 93913-1869\",\"document\":\"92.054.075\\\/0001-73\",\"type\":\"pf\",\"responsible\":\"Dr. Em\\u00edlia Sep\\u00falveda Esteves\",\"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\":\"ee5f0b9b-0a1a-302f-a89d-4dd7b089320a\",\"name\":\"Dr. Bruno Rios Jr.\",\"description\":\"Dolor voluptas facere ipsam eum impedit illo. Odio ratione veritatis in voluptate quos velit et. Reiciendis vitae harum vero.\",\"type\":\"entrada\"},{\"id\":\"a181028f-4512-3bbc-9237-6dcfe0638746\",\"name\":\"Eduardo Ramos da Rosa Filho\",\"description\":\"Nulla et sint ea sint omnis odit. Odit vel officiis et nostrum vel earum. Dolor libero neque quia aut hic aspernatur.\",\"type\":\"sa\\u00edda\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Show transaction category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction-categories\/:transactionCategory", "query": [], "raw": "{{baseUrl}}\/api\/transaction-categories\/:transactionCategory", "variable": [ { "id": "transactionCategory", "key": "transactionCategory", "value": "porro", "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\":\"528fa194-3f6b-38a0-b566-3a760391ccfa\",\"name\":\"Dr. Andres Galindo\",\"description\":\"Dignissimos fuga debitis fuga soluta perferendis. Nemo distinctio officia dolores rem quisquam rem. Dolores ipsa ullam dolor dolore incidunt sunt.\",\"type\":\"dep\\u00f3sito\"}}", "name": "" } ] }, { "name": "Create transaction category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction-categories", "query": [], "raw": "{{baseUrl}}\/api\/transaction-categories" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"description\":\"Example Description\",\"type\":\"Example Type\"}" }, "description": "Create a new transaction category" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update transaction category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/transaction-categories\/:transactionCategory", "query": [], "raw": "{{baseUrl}}\/api\/transaction-categories\/:transactionCategory", "variable": [ { "id": "transactionCategory", "key": "transactionCategory", "value": "est", "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": "saepe", "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\":\"85282f33-beb8-35a0-b3f1-bd4ece6fed32\",\"name\":\"Sr. Gilberto Fonseca Vieira Neto\",\"abbreviation\":\"Srta. Madalena da Cruz Jr.\",\"description\":\"Quia nostrum quas quis.\",\"created_at\":null,\"updated_at\":null},{\"id\":\"e44d6ae8-2b39-38bc-bb98-c0f1ef9c23b7\",\"name\":\"Catarina Garcia Sobrinho\",\"abbreviation\":\"Dr. Adriele Vale Neto\",\"description\":\"At error libero fuga 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 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": "nostrum", "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\":\"8ced0277-ab48-3157-864b-c2d91e200dd1\",\"name\":\"George God\\u00f3i Jr.\",\"abbreviation\":\"Sr. Eduardo Mascarenhas Rangel\",\"description\":\"Sint est dolorem unde.\",\"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": "consectetur", "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": "facilis", "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\":\"147faeb5-030b-3da5-9173-920d0b572573\",\"name\":\"Mr. Diamond Hahn\",\"username\":\"rolfson.bernadette\",\"email\":\"mathias.lebsack@example.com\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"fc49b918-3009-32a2-a6e1-8dc13bd4ee2a\",\"name\":\"Damon O'Hara\",\"username\":\"kiara.mcdermott\",\"email\":\"dcrooks@example.net\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Get user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a user" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"a522757f-5a36-3a42-87e8-1a6073f112b7\",\"name\":\"Carmine Funk PhD\",\"username\":\"ray68\",\"email\":\"edythe59@example.com\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]}}", "name": "" } ] }, { "name": "Create user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users", "query": [], "raw": "{{baseUrl}}\/api\/users" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"email\":\"user@example.com\",\"username\":\"rosella78\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"791fee41-e57f-30c1-8923-c2caddf663da\"],\"roles\":[\"682eae25-091b-369d-b9de-4020a5251c66\"]}" }, "description": "Create a new user" }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"string\"}", "name": "" } ] }, { "name": "Update user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the user." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Example Name\",\"email\":\"user@example.com\",\"username\":\"holly69\",\"password\":\"password123\",\"image\":{\"0\":\"example1\",\"1\":\"example2\",\"path\":\"Example Image path\",\"name\":\"Example Name\",\"extension\":\"Example Image extension\",\"size\":\"Example Image size\"},\"sectors\":[\"33b5b111-72de-37b5-8032-e29a51cd0600\"],\"roles\":[\"c6973b75-652d-31d0-97a7-4e4596580281\"]}" }, "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\":[\"085263c7-ccd3-3d18-b5e5-bc24d1d63aff\"]}" }, "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\":\"ea\",\"display_name\":\"Repudiandae delectus eligendi molestiae doloremque veniam pariatur eius.\"},{\"id\":null,\"name\":\"ea\",\"display_name\":\"Tenetur ut maiores similique molestiae ut cum doloribus.\"}]}", "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\":\"2ac780d0-2bf5-35b9-b57d-556994b65375\",\"description\":\"Milene J\\u00e9ssica Salgado Sobrinho\",\"work\":{\"id\":null,\"name\":null},\"documents\":[],\"created_at\":null,\"updated_at\":null},{\"id\":\"34ac8951-b859-304d-ae36-850899d99217\",\"description\":\"B\\u00e1rbara Vieira Rosa\",\"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\":\"3fba244e-9a8a-3ebd-9bbd-1e5ca930b99e\"}" }, "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\":\"469499bb-71ea-363a-8b3c-08a6d810890e\",\"description\":\"Maximiano David Quintana Filho\",\"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\":\"38bebbcb-825c-33d5-a29e-bfd2693c4f2e\"}" }, "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\":\"58a323d0-96f0-31de-a2ee-5178b531794f\",\"name\":\"Aline Zamana Sobrinho\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents\":[],\"locations\":[],\"product_quantity_lists_count\":0,\"product_quantity_list_items_count\":0,\"product_requests_count\":0,\"product_request_items_count\":0,\"documents_count\":0,\"locations_documents_count\":0,\"total_documents_count\":0,\"started_at\":{\"date\":\"2013-05-21 19:43:51.000000\",\"timezone_type\":3,\"timezone\":\"America\\\/Sao_Paulo\"},\"created_at\":null,\"updated_at\":null},{\"id\":\"ad959906-7a80-35a7-9a0e-ad28b7140712\",\"name\":\"Sr. Dante Augusto Salazar\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents\":[],\"locations\":[],\"product_quantity_lists_count\":0,\"product_quantity_list_items_count\":0,\"product_requests_count\":0,\"product_request_items_count\":0,\"documents_count\":0,\"locations_documents_count\":0,\"total_documents_count\":0,\"started_at\":{\"date\":\"2007-07-20 11:00:15.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\":\"3b63a6c9-c5f4-3f88-aeac-b2f8dc5be291\",\"status_id\":\"843e3566-4892-3a7c-8f76-908671237236\",\"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\":\"302e0ffb-ef7c-33bb-958f-a0e44962db1f\",\"name\":\"Kauan Faria Jr.\",\"address\":{\"street\":null,\"number\":null,\"complement\":null,\"neighborhood\":null,\"city\":null,\"state\":null,\"zip_code\":null},\"documents\":[],\"locations\":[],\"product_quantity_lists_count\":0,\"product_quantity_list_items_count\":0,\"product_requests_count\":0,\"product_request_items_count\":0,\"documents_count\":0,\"locations_documents_count\":0,\"total_documents_count\":0,\"started_at\":{\"date\":\"2014-10-06 09:52:14.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\":\"7c0e26cc-cf99-3244-ba94-c898e8759a28\",\"status_id\":\"be9f38c5-efc4-35d4-ac29-a8b1c874da3e\",\"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\":\"ddf5185f-33a8-3ae0-b883-d6be44290735\",\"name\":\"Tillman Hermiston\",\"username\":\"annalise76\",\"email\":\"kristian81@example.net\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]},{\"id\":\"4f5e19c8-fb2b-3286-9c7e-54110edad785\",\"name\":\"Emelia Bechtelar\",\"username\":\"daisha93\",\"email\":\"nkeeling@example.com\",\"image\":{\"id\":null,\"url\":null},\"sectors\":[],\"roles\":[]}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Anterior\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Pr\\u00f3ximo »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Attach 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\":[\"851979b6-92a5-3028-8010-5871fef5e6e3\"]}" }, "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\":[\"7230f8ed-f33c-3573-bf54-9dc867a519be\"]}" }, "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\":[\"ad435df1-0d98-39ab-80a1-a546d39b52af\"]}" }, "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" } ] } }