{"info":{"_postman_id":"d8efea80-34d0-433d-b1d8-a5254fedb48c","name":"Invoice API","description":"

API Rest for the control and registration of invoices, clients and users.

Develop with Laravel 10.48.10 (PHP ^8.1) and Postgre 14.12

Considerations

Check Users into database can be change.
\n
Admin email and password always is same.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6168326","collectionId":"d8efea80-34d0-433d-b1d8-a5254fedb48c","publishedId":"2sAYJ3DLjd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-12-19T18:28:56.000Z"},"item":[{"name":"Users","item":[{"name":"Login","event":[{"listen":"test","script":{"id":"10bc0698-671d-4607-a544-0d6f68426d17","exec":["let response = pm.response.json();","let token = response.token;","","pm.collectionVariables.set('auth_token', token);"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"cda1b52b-56eb-4bcc-9e23-80000938495f","exec":["const basicUser = {"," \"email\":\"augusto@test.com\","," \"password\":\"password\",","}","","const adminUser = {"," \"email\":\"admin@test.com\","," \"password\":\"S3P2XE/V7RLogin users.

Considerations

Check Users into database can be change.
Admin email and password always is same.

\n","urlObject":{"path":["login"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"539ce0f4-35bd-4733-9196-74fd634d83a7"},{"name":"Logout","id":"53831dce-66de-48ed-b4e9-1bb52108ecf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/logout","description":"

Request

This endpoint is used to log out the user and destroy the token. It is an HTTP GET request.

Response

The response for this request is a JSON schema. The schema includes the properties and data types of the response body.

\n","urlObject":{"path":["logout"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"53831dce-66de-48ed-b4e9-1bb52108ecf6"},{"name":"All Users","id":"dbeca2cc-3284-49ae-89d5-d2a8cb3698ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/users?perPage=10&email[eq]=qdeckow@example.com&isAdmin[eq]=0&lastAccess[eq]=2024-05-30 16:16:57&createdAt[eq]=2024-05-30 16:16:57&updatedAt[eq]=2024-05-30 16:16:57","description":"

This endpoint makes an HTTP GET request to retrieve a list of registered users based on specific filters such as perPage, email, isAdmin, lastAccess, createdAt, and updatedAt. The purpose of this request is to fetch user data based on the provided filter criteria (filters are optionals)

Expected Input

The expected input for this request includes query parameters:

perPage: The number of users to be displayed per page.
\n
emaill: The email address of the user to be retrieved.
\n
isAdmin: The admin status of the user (0 for non-admin, 1 for admin).
\n
lastAccess: The specific date and time of the last access by the user.
\n
createdAt: The date and time when the user account was created.
\n
updatedAt: The date and time when the user account was last updated.
\n

Expected Output

The response to this request is expected to be in JSON format with the following structure:

{\n    \"data\": [\n        {\n            \"name\": \"\",\n            \"email\": \"\",\n            \"isAdmin\": true,\n            \"lastAccess\": null,\n            \"createdAt\": \"\",\n            \"updatedAt\": \"\"\n        }\n    ],\n    \"links\": {\n        \"first\": \"\",\n        \"last\": \"\",\n        \"prev\": null,\n        \"next\": \"\"\n    },\n    \"meta\": {\n        \"current_page\": 0,\n        \"from\": 0,\n        \"last_page\": 0,\n        \"links\": [\n            {\n                \"url\": null,\n                \"label\": \"\",\n                \"active\": true\n            }\n        ],\n        \"path\": \"\",\n        \"per_page\": 0,\n        \"to\": 0,\n        \"total\": 0\n    }\n}\n\n

The \"data\" field contains an array of user objects with their respective attributes. The \"links\" field provides navigation links for pagination, and the \"meta\" field includes metadata about the current page, total users, and pagination links.

This endpoint is useful for retrieving user data based on specified filters and can be used to populate user lists or generate user reports.

\n","urlObject":{"path":["users"],"host":["http://127.0.0.1:8000/api/v1"],"query":[{"description":{"content":"

Users per page

\n","type":"text/plain"},"key":"perPage","value":"10"},{"description":{"content":"

Email filter. Can be use: 'eq'

\n","type":"text/plain"},"key":"email[eq]","value":"qdeckow@example.com"},{"description":{"content":"

Is admin (boolean) filter. Can be use: 'eq'

\n","type":"text/plain"},"key":"isAdmin[eq]","value":"0"},{"description":{"content":"

Last Access date filter. Can be use: 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'

\n","type":"text/plain"},"key":"lastAccess[eq]","value":"2024-05-30 16:16:57"},{"description":{"content":"

Created at date filter Can be use: 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'

\n","type":"text/plain"},"key":"createdAt[eq]","value":"2024-05-30 16:16:57"},{"description":{"content":"

Updated at date filter Can be use: 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'

\n","type":"text/plain"},"key":"updatedAt[eq]","value":"2024-05-30 16:16:57"}],"variable":[]}},"response":[{"id":"4b2bcf50-e6dc-4967-847b-bc79798d55ab","name":"All Users","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"http://127.0.0.1:8000/api/v1/users?perPage=10&email[eq]=qdeckow@example.com&isAdmin[eq]=0&lastAccess[eq]=2024-05-30 16:16:57&createdAt[eq]=2024-05-30 16:16:57&updatedAt[eq]=2024-05-30 16:16:57","host":["http://127.0.0.1:8000/api/v1"],"path":["users"],"query":[{"key":"perPage","value":"10","description":"Users per page"},{"key":"email[eq]","value":"qdeckow@example.com","description":"Email filter. Can be use: 'eq'"},{"key":"isAdmin[eq]","value":"0","description":"Is admin (boolean) filter. Can be use: 'eq'"},{"key":"lastAccess[eq]","value":"2024-05-30 16:16:57","description":"Last Access date filter. Can be use: 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'"},{"key":"createdAt[eq]","value":"2024-05-30 16:16:57","description":"Created at date filter Can be use: 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'"},{"key":"updatedAt[eq]","value":"2024-05-30 16:16:57","description":"Updated at date filter Can be use: 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sun, 02 Jun 2024 01:16:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"56"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"name\": \"Admin\",\n \"email\": \"admin@test.com\",\n \"isAdmin\": true,\n \"lastAccess\": null,\n \"createdAt\": \"2024-06-01T21:23:49.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:49.000000Z\"\n },\n {\n \"name\": \"Keira Kiehn\",\n \"email\": \"gunner.wilkinson@example.org\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Dr. Elwyn Homenick\",\n \"email\": \"ona.grady@example.com\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Peyton Rolfson DVM\",\n \"email\": \"itzel.mante@example.com\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Yasmeen Waelchi\",\n \"email\": \"keeling.samantha@example.net\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Serena Thiel\",\n \"email\": \"sauer.rosendo@example.net\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Ethel Mertz DDS\",\n \"email\": \"mina59@example.com\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Tiara Bins\",\n \"email\": \"ykuphal@example.net\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Penelope West\",\n \"email\": \"antwon.deckow@example.net\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Prof. Dewitt Morar\",\n \"email\": \"xrogahn@example.org\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"http://127.0.0.1:8000/api/v1/users?perPage=10&page=1\",\n \"last\": \"http://127.0.0.1:8000/api/v1/users?perPage=10&page=2\",\n \"prev\": null,\n \"next\": \"http://127.0.0.1:8000/api/v1/users?perPage=10&page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 2,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/users?perPage=10&page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/users?perPage=10&page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/users?perPage=10&page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"http://127.0.0.1:8000/api/v1/users\",\n \"per_page\": 10,\n \"to\": 10,\n \"total\": 11\n }\n}"},{"id":"c34c2e65-2f0e-43c9-9ea6-e535768fef05","name":"All Users","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"http://127.0.0.1:8000/api/v1/users?perPage=10","host":["http://127.0.0.1:8000/api/v1"],"path":["users"],"query":[{"key":"perPage","value":"10","description":"Users per page"},{"key":"email[eq]","value":"qdeckow@example.com","description":"Email filter. Can be use: 'eq'","disabled":true},{"key":"isAdmin[eq]","value":"0","description":"Is admin (boolean) filter. Can be use: 'eq'","disabled":true},{"key":"lastAccess[eq]","value":"2024-05-30 16:16:57","description":"Last Access date filter. Can be use: 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'","disabled":true},{"key":"createdAt[eq]","value":"2024-05-30 16:16:57","description":"Created at date filter Can be use: 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'","disabled":true},{"key":"updatedAt[eq]","value":"2024-05-30 16:16:57","description":"Updated at date filter Can be use: 'eq', 'ne', 'lt', 'lte', 'gt', 'gte'","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 03 Jun 2024 16:18:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"name\": \"Peyton Rolfson DVM\",\n \"email\": \"itzel.mante@example.com\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Yasmeen Waelchi\",\n \"email\": \"keeling.samantha@example.net\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Serena Thiel\",\n \"email\": \"sauer.rosendo@example.net\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Ethel Mertz DDS\",\n \"email\": \"mina59@example.com\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Tiara Bins\",\n \"email\": \"ykuphal@example.net\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Penelope West\",\n \"email\": \"antwon.deckow@example.net\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Prof. Dewitt Morar\",\n \"email\": \"xrogahn@example.org\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Johnson Connelly PhD\",\n \"email\": \"madalyn34@example.com\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-01T21:23:50.000000Z\"\n },\n {\n \"name\": \"Mrs. Chloe Cummerata\",\n \"email\": \"vweber@example.com\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-01 21:23:50\",\n \"createdAt\": \"2024-06-01T21:23:50.000000Z\",\n \"updatedAt\": \"2024-06-02T04:21:10.000000Z\"\n },\n {\n \"name\": \"Nuevo Nombre\",\n \"email\": \"augusto@test.com\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-06-02 02:09:02\",\n \"createdAt\": \"2024-06-02T02:09:02.000000Z\",\n \"updatedAt\": \"2024-06-02T04:27:32.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"http://127.0.0.1:8000/api/v1/users?perPage=10&page=1\",\n \"last\": \"http://127.0.0.1:8000/api/v1/users?perPage=10&page=2\",\n \"prev\": null,\n \"next\": \"http://127.0.0.1:8000/api/v1/users?perPage=10&page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 2,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/users?perPage=10&page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/users?perPage=10&page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/users?perPage=10&page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"http://127.0.0.1:8000/api/v1/users\",\n \"per_page\": 10,\n \"to\": 10,\n \"total\": 12\n }\n}"}],"_postman_id":"dbeca2cc-3284-49ae-89d5-d2a8cb3698ad"},{"name":"User","id":"34824b41-cb69-4383-92fb-c91c88252379","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Sarah Perez","type":"text"},{"key":"email","value":"julia@test.com","description":"

Email must be equal to email invitation

\n","type":"text"},{"key":"password","value":"password","type":"text"},{"key":"password_confirmation","value":"password","type":"text"},{"key":"token","value":"$2y$12$dzJdRVBlCP/26eUvc6qGP.sZV6n2byf2fK8lkt9IbYVXCi7G0kr06","description":"

Token invitation

\n","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/users","description":"

Request

This endpoint makes an HTTP POST request to create a new user. The request body is of type x-www-form-urlencoded and includes the following parameters:

name (text): User full name
\n
email (text): Email must be equal to email invitation
\n
password (text):
\n
password_confirmation (text):
\n
token (text): Token invitation
\n

Response

The response of this request is in the form of a JSON schema with the following structure:

{\n    \"data\": {\n        \"name\": \"\",\n        \"email\": \"\",\n        \"isAdmin\": true,\n        \"lastAccess\": \"\",\n        \"createdAt\": \"\",\n        \"updatedAt\": \"\"\n    }\n}\n\n

The data object contains the user information with the name, email, isAdmin status, lastAccess timestamp, createdAt timestamp, and updatedAt timestamp.

Example Response

{\n    \"data\": {\n        \"name\": \"\",\n        \"email\": \"\",\n        \"isAdmin\": \"\",\n        \"lastAccess\": \"\",\n        \"createdAt\": \"\",\n        \"updatedAt\": \"\"\n    }\n}\n\n

\n","urlObject":{"path":["users"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[{"id":"e71268d9-a7ae-4cea-a557-9901972b4eb4","name":"Create User","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Jesus Antonio","type":"text"},{"key":"email","value":"jesus@test.com","type":"text"},{"key":"password","value":"password","type":"text"},{"key":"isAdmin","value":"0","description":"boolean","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 30 May 2024 20:10:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"name\": \"Jesus Antonio\",\n \"email\": \"jesus@test.com\",\n \"isAdmin\": \"0\",\n \"lastAccess\": \"2024-05-30T20:10:25.865218Z\",\n \"createdAt\": \"2024-05-30T20:10:25.000000Z\",\n \"updatedAt\": \"2024-05-30T20:10:25.000000Z\"\n }\n}"},{"id":"bda303c0-8bd2-4a97-b5f0-ef203fd83451","name":"Error Invitation Expired","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Sarah Perez","type":"text"},{"key":"email","value":"sarah@test.com","description":"Email must be equal to email invitation","type":"text"},{"key":"password","value":"password","type":"text"},{"key":"password_confirmation","value":"password","type":"text"},{"key":"token","value":"$2y$12$h3S2/2YCAiTAMMk1CDF2kuBuLBDY2kPifRZvxXbomD8bZboP92CkK","description":"Token invitation","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/users"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sun, 02 Jun 2024 02:27:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"statusCode\": 500,\n \"error\": {\n \"code\": 11430,\n \"message\": \"Invitation expired\",\n \"details\": \"Invitation has expired, please request a new one\",\n \"timestamp\": \"2024-06-02T02:27:46.523375Z\",\n \"path\": \"api/v1/users\",\n \"suggestion\": \"Invitation has expired, contact admin user and request a new one\"\n },\n \"documentation_url\": \"https://google.com/docs/errors\"\n}"},{"id":"6906a272-4517-4804-a275-a201b3df446e","name":"Store error","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Sarah Perez","type":"text"},{"key":"email","value":"julia@test.com","description":"Email must be equal to email invitation","type":"text"},{"key":"password","value":"password","type":"text"},{"key":"password_confirmation","value":"password","type":"text"},{"key":"token","value":"$2y$12$dzJdRVBlCP/26eUvc6qGP.sZV6n2byf2fK8lkt9IbYVXCi7G0kr06","description":"Token invitation","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/users"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sun, 02 Jun 2024 02:53:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"statusCode\": 500,\n \"error\": {\n \"code\": 10100,\n \"message\": \"Store was not possible\",\n \"details\": \"Store was not possible, contact with admin.\",\n \"timestamp\": \"2024-06-02T02:53:00.824404Z\",\n \"path\": \"api/v1/users\",\n \"suggestion\": \"Please contact with admin or developer\"\n },\n \"documentation_url\": \"https://google.com/docs/errors\"\n}"}],"_postman_id":"34824b41-cb69-4383-92fb-c91c88252379"},{"name":"User By Id","id":"04f01555-d9b8-45f0-8677-7b07febbb697","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/users/5","description":"

Retrieve User by ID

This API endpoint makes an HTTP GET request to retrieve user information by their ID.

Response

The response for this request can be documented as a JSON schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"data\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"name\": { \"type\": \"string\" },\n        \"email\": { \"type\": \"string\" },\n        \"isAdmin\": { \"type\": \"boolean\" },\n        \"lastAccess\": { \"type\": \"string\" },\n        \"createdAt\": { \"type\": \"string\" },\n        \"updatedAt\": { \"type\": \"string\" }\n      }\n    }\n  }\n}\n

\n","urlObject":{"path":["users","5"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[{"id":"3335493d-5a4f-45fd-b272-5ef59bc53c47","name":"User By Id","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/users/5"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 30 May 2024 20:14:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"name\": \"Jordyn Reilly\",\n \"email\": \"marian.okon@example.org\",\n \"isAdmin\": false,\n \"lastAccess\": \"2024-05-30 16:16:57\",\n \"createdAt\": \"2024-05-30T16:16:57.000000Z\",\n \"updatedAt\": \"2024-05-30T16:16:57.000000Z\"\n }\n}"}],"_postman_id":"04f01555-d9b8-45f0-8677-7b07febbb697"},{"name":"User By id","id":"b1229a9d-0a0a-45b2-bd29-4d519c9fd839","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/users/10","description":"

Delete User by ID

Deletes a user with the specified ID.

Only for admin user.

\n","urlObject":{"path":["users","10"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"b1229a9d-0a0a-45b2-bd29-4d519c9fd839"},{"name":"User","id":"605ea55c-38a5-4bc7-907a-3e2037da2f9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Nuevo Nombre","type":"text"},{"key":"email","value":"augusto@test.com","type":"text"},{"key":"isAdmin","value":"0","type":"text"},{"key":"password","value":"password","type":"text"},{"key":"password_confirmation","value":"password","type":"text"},{"key":"currentPassword","value":"password1","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/users/12","description":"

Update User Profile

This endpoint update specific user.

Description

Update the user profile. Only accessible for the user themselves (not admin).

Request Body

name (text): Fullname user
email (text):
isAdmin (text): boolean
password (text):
password_confirmation (text):
currentPassword (text):

Response

The response for this request can be documented as a JSON schema.

\n","urlObject":{"path":["users","12"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"605ea55c-38a5-4bc7-907a-3e2037da2f9b"},{"name":"User","id":"2c350ead-0913-4d7c-b466-f24d20a76261","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Mrs. Chloe Cummerata","type":"text","disabled":true},{"key":"email","value":"vweber@example.com","type":"text","disabled":true},{"key":"isAdmin","value":"0","type":"text","disabled":true},{"key":"password","value":"password1","type":"text"},{"key":"password_confirmation","value":"password1","type":"text"},{"key":"currentPassword","value":"password","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/users/12","description":"

Update User Profile

This endpoint update a user profile by ID.

Body

password (text):
password_confirmation (text):
currentPassword (text):

Only for the user themselves (not admin).

Response

Status: 201

\n","urlObject":{"path":["users","12"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[{"id":"272d1cd9-2c81-40e3-ad80-cb197469f117","name":"Current Pasword Not Match","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Mrs. Chloe Cummerata","type":"text","disabled":true},{"key":"email","value":"vweber@example.com","type":"text","disabled":true},{"key":"isAdmin","value":"0","type":"text","disabled":true},{"key":"password","value":"password1","type":"text"},{"key":"password_confirmation","value":"password1","type":"text"},{"key":"currentPassword","value":"password","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/users/12"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sun, 02 Jun 2024 04:26:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"statusCode\": 401,\n \"error\": {\n \"code\": 10100,\n \"message\": \"Password not match\",\n \"details\": \"Your password does not match\",\n \"timestamp\": \"2024-06-02T04:26:39.833265Z\",\n \"path\": \"api/v1/users/{user}\",\n \"suggestion\": \"Please try again, check your password, it should match the one we have saved.\"\n },\n \"documentation_url\": \"https://google.com/docs/errors\"\n}"}],"_postman_id":"2c350ead-0913-4d7c-b466-f24d20a76261"},{"name":"Forgot Password","event":[{"listen":"test","script":{"id":"f39bf873-74c2-4334-b93e-b1558ea54835","exec":[""],"type":"text/javascript","packages":{}}}],"id":"ffe0e570-5492-488c-95e4-93b9ad907ae3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"ona.grady@example.com","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/forgot-password","description":"

Forgot Password Request

This endpoint is used to initiate the process of resetting the user's password.

Request Body

email (text): The email address of the user for whom the password reset is requested.

Response

The response for this request is a JSON object with the following schema:

{\n    \"status\": \"string\"\n}\n\n

The status field indicates the status of the password reset request.

\n","urlObject":{"path":["forgot-password"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[{"id":"1eee093e-f10b-431f-aec0-b3b2268a11b7","name":"Error email invalid","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"oa.grady@example.com","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/forgot-password"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 03 Jun 2024 15:38:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"statusCode\": 422,\n \"error\": {\n \"code\": 15100,\n \"message\": \"Email is invalid\",\n \"details\": \"Email you sent is not registered in our system.\",\n \"timestamp\": \"2024-06-03T15:38:55.409873Z\",\n \"path\": \"api/v1/forgot-password\",\n \"suggestion\": \"Email you sent is not registered in our system. Please confirm and try again.\"\n },\n \"documentation_url\": \"https://google.com/docs/errors\"\n}"}],"_postman_id":"ffe0e570-5492-488c-95e4-93b9ad907ae3"},{"name":"Reset Password","id":"2d1947d6-bab7-4874-926b-a46a89399205","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"ona.grady@example.com","type":"text"},{"key":"token","value":"3265792d863a17690b78e24dd507c6824f082327b92d0df3c04f0c667f20d1e9","type":"text"},{"key":"password","value":"123456","type":"text"},{"key":"password_confirmation","value":"123456","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/reset-password","description":"

Reset Password

The reset-password endpoint is used to reset the password for a user account.

Request Body

email (text): The email address of the user.
token (text): The token received for password reset.
password (text): The new password for the user account.
password_confirmation (text): Confirmation of the new password.

Response

The response for the reset-password request is a JSON object with the following schema:

{\n    \"type\": \"object\",\n    \"properties\": {\n        \"message\": {\n            \"type\": \"string\"\n        }\n    }\n}\n

\n","urlObject":{"path":["reset-password"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[{"id":"0409ab53-6ec9-4ac1-baa4-d9e73948d05b","name":"Error update password","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"ona.grady@example.com","type":"text"},{"key":"token","value":"4cc6395bcbea3a438f0e2b75eee5d27f5a1c643dea830558c96607526a45d486","type":"text"},{"key":"password","value":"123456","type":"text"},{"key":"password_confirmation","value":"123456","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/reset-password"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 03 Jun 2024 15:34:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"statusCode\": 500,\n \"error\": {\n \"code\": 10201,\n \"message\": \"Update was not possible\",\n \"details\": \"Update was not possible, contact with admin.\",\n \"timestamp\": \"2024-06-03T15:34:20.993430Z\",\n \"path\": \"api/v1/reset-password\",\n \"suggestion\": \"Please contact with admin or developer\"\n },\n \"documentation_url\": \"https://google.com/docs/errors\"\n}"}],"_postman_id":"2d1947d6-bab7-4874-926b-a46a89399205"}],"id":"b8c33a02-5074-489f-9840-0ddd9ab5b545","description":"

Users who use the application

\n","_postman_id":"b8c33a02-5074-489f-9840-0ddd9ab5b545"},{"name":"Invitations","item":[{"name":"Invitation By id","id":"1bdc2c5f-c4ee-49c8-a171-ed38d25dbe39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/invitations/14","description":"

GET Invitation by Id

This endpoint retrieves invitation details for a specific invitation ID.

(Only for admin user)

Request

No request body is required for this endpoint.

Response

The response will be a JSON object with the following schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"data\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"email\": {\n          \"type\": \"string\"\n        },\n        \"token\": {\n          \"type\": \"string\"\n        },\n        \"isAdmin\": {\n          \"type\": \"boolean\"\n        },\n        \"expiresAt\": {\n          \"type\": \"string\"\n        },\n        \"createdAt\": {\n          \"type\": \"string\"\n        }\n      }\n    }\n  }\n}\n\n

The response will contain the invitation details including the email, token, isAdmin status, expiration date, and creation date.

Example Response

{\n  \"data\": {\n    \"email\": \"\",\n    \"token\": \"\",\n    \"isAdmin\": true,\n    \"expiresAt\": \"\",\n    \"createdAt\": \"\"\n  }\n}\n\n

\n","urlObject":{"path":["invitations","14"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[{"id":"c2216da4-a9d2-4349-a6f2-d6f4771d4e7e","name":"Invitation by id","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/invitations/14"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sun, 02 Jun 2024 01:10:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"email\": \"jose@test.com\",\n \"token\": \"$2y$12$iKJ3GDowm9G2RT01u/5ub.44f3.qp8gMkhXGKfAs3L6vgHjYoZNV.\",\n \"isAdmin\": false,\n \"expiresAt\": \"2024-06-02 11:58:58\",\n \"createdAt\": \"2024-06-01T23:58:58.000000Z\"\n }\n}"}],"_postman_id":"1bdc2c5f-c4ee-49c8-a171-ed38d25dbe39"},{"name":"All invitations","id":"93c97cae-d415-4633-be6f-3181c100cc08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/invitations","description":"

Get Invitations

This endpoint retrieves a list of invitations.

(Only for admin user).

Request

No request body is required for this request.

Method: GET
URL: http://127.0.0.1:8000/api/v1/invitations

Response

The response will be in JSON format and will contain the following fields:

data (array): An array of invitation objects, each containing the following fields:
- email: The email associated with the invitation.
- token: The token associated with the invitation.
- isAdmin: A boolean indicating if the user is an admin.
- expiresAt: The expiration date of the invitation.
- createdAt: The creation date of the invitation.
\n
links (object): Contains pagination links for navigating through the list of invitations.
meta (object): Contains metadata about the pagination, such as the current page, total items, etc.

Example Response

{\n    \"data\": [\n        {\n            \"email\": \"\",\n            \"token\": \"\",\n            \"isAdmin\": true,\n            \"expiresAt\": \"\",\n            \"createdAt\": \"\"\n        }\n    ],\n    \"links\": {\n        \"first\": \"\",\n        \"last\": \"\",\n        \"prev\": null,\n        \"next\": \"\"\n    },\n    \"meta\": {\n        \"current_page\": 0,\n        \"from\": 0,\n        \"last_page\": 0,\n        \"links\": [\n            {\n                \"url\": null,\n                \"label\": \"\",\n                \"active\": true\n            }\n        ],\n        \"path\": \"\",\n        \"per_page\": 0,\n        \"to\": 0,\n        \"total\": 0\n    }\n}\n\n

\n","urlObject":{"path":["invitations"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[{"id":"bd939767-34f8-4ea8-8aa9-0681e1eaa6a5","name":"All invitations","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/invitations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sun, 02 Jun 2024 01:11:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"email\": \"jose@test.com\",\n \"token\": \"$2y$12$iKJ3GDowm9G2RT01u/5ub.44f3.qp8gMkhXGKfAs3L6vgHjYoZNV.\",\n \"isAdmin\": false,\n \"expiresAt\": \"2024-06-02 11:58:58\",\n \"createdAt\": \"2024-06-01T23:58:58.000000Z\"\n },\n {\n \"email\": \"augusto@test.com\",\n \"token\": \"$2y$12$eWmEDISEB8/UWqLbmNmpiO/AYn0fmWKuCipusC0UGijdGPlZikL5O\",\n \"isAdmin\": false,\n \"expiresAt\": \"2024-06-02 13:03:03\",\n \"createdAt\": \"2024-06-02T01:03:03.000000Z\"\n },\n {\n \"email\": \"damian@test.com\",\n \"token\": \"$2y$12$GKMRqh45MZfvvgi1tDUfZ.DDHDliHYVMRVawJ3pyFrOjQsDInqhYa\",\n \"isAdmin\": false,\n \"expiresAt\": \"2024-06-02 13:03:33\",\n \"createdAt\": \"2024-06-02T01:03:33.000000Z\"\n },\n {\n \"email\": \"sarah@test.com\",\n \"token\": \"$2y$12$h3S2/2YCAiTAMMk1CDF2kuBuLBDY2kPifRZvxXbomD8bZboP92CkK\",\n \"isAdmin\": false,\n \"expiresAt\": \"2024-06-02 13:04:49\",\n \"createdAt\": \"2024-06-02T01:04:49.000000Z\"\n },\n {\n \"email\": \"veronica@test.com\",\n \"token\": \"$2y$12$5WYn394dgTipvRwEyISH.eQCVNUfvKB8bV2ScV0sZR3/BzOhl8xiq\",\n \"isAdmin\": false,\n \"expiresAt\": \"2024-06-02 13:06:00\",\n \"createdAt\": \"2024-06-02T01:06:00.000000Z\"\n },\n {\n \"email\": \"julia@test.com\",\n \"token\": \"$2y$12$dzJdRVBlCP/26eUvc6qGP.sZV6n2byf2fK8lkt9IbYVXCi7G0kr06\",\n \"isAdmin\": false,\n \"expiresAt\": \"2024-06-02 13:06:24\",\n \"createdAt\": \"2024-06-02T01:06:24.000000Z\"\n },\n {\n \"email\": \"jesus@test.com\",\n \"token\": \"$2y$12$I2HS.Hs.kC3wY.lpyVO.0.nshGYE1f62bc6uBu/vn/oA/RIM15VF6\",\n \"isAdmin\": false,\n \"expiresAt\": \"2024-06-02 13:07:27\",\n \"createdAt\": \"2024-06-02T01:07:27.000000Z\"\n },\n {\n \"email\": \"joseus@test.com\",\n \"token\": \"$2y$12$EWdy1lHfRUjTRuUfQkMVwea3BaS3UhTNXfM.kenH3TZJrTauqf7Ne\",\n \"isAdmin\": false,\n \"expiresAt\": \"2024-06-02 13:08:02\",\n \"createdAt\": \"2024-06-02T01:08:02.000000Z\"\n },\n {\n \"email\": \"josequs@test.com\",\n \"token\": \"$2y$12$InGX4ySqtYTIHmmCDKtBIOPilW.ZokyROrspLlFCgV3dBh.jO76Ny\",\n \"isAdmin\": false,\n \"expiresAt\": \"2024-06-02 13:08:51\",\n \"createdAt\": \"2024-06-02T01:08:51.000000Z\"\n },\n {\n \"email\": \"josequs@test.coma\",\n \"token\": \"$2y$12$DHxiDhOL4FwFSPn0CKckd.blgSP4qQcxUX.NveUDAu4YkiaDgvZAK\",\n \"isAdmin\": false,\n \"expiresAt\": \"2024-06-02 13:09:26\",\n \"createdAt\": \"2024-06-02T01:09:26.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"http://127.0.0.1:8000/api/v1/invitations?page=1\",\n \"last\": \"http://127.0.0.1:8000/api/v1/invitations?page=2\",\n \"prev\": null,\n \"next\": \"http://127.0.0.1:8000/api/v1/invitations?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 2,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invitations?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invitations?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invitations?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"http://127.0.0.1:8000/api/v1/invitations\",\n \"per_page\": 10,\n \"to\": 10,\n \"total\": 11\n }\n}"}],"_postman_id":"93c97cae-d415-4633-be6f-3181c100cc08"},{"name":"Invitation","event":[{"listen":"test","script":{"id":"17730193-18c6-40b5-9b0f-55345a5fc4b5","exec":[""],"type":"text/javascript","packages":{}}}],"id":"aa8af8d1-dcfc-46e0-a74d-8e92ad297777","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"eduard22@test.com","type":"text"},{"key":"isAdmin","value":"0","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/invitations","description":"

POST /invitations

This endpoint is used to send invitations via HTTP POST request. This endpoint send email to complete registration (users).

(Only for admin user)

Request

The request should be made to http://127.0.0.1:8000/api/v1/invitations with a payload in x-www-form-urlencoded format. The payload should include the following parameter:

email (text): The email address of the recipient.

Response

Upon a successful request, the API returns a response with a status code of 201 and a JSON object in the following format:

{\n  \"data\": {\n    \"email\": \"\",\n    \"token\": \"\",\n    \"isActive\": null,\n    \"expiresAt\": \"\"\n  }\n}\n\n

The response JSON schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"data\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"email\": { \"type\": \"string\" },\n        \"token\": { \"type\": \"string\" },\n        \"isActive\": { \"type\": [\"boolean\", \"null\"] },\n        \"expiresAt\": { \"type\": \"string\" }\n      }\n    }\n  }\n}\n\n

\n","urlObject":{"path":["invitations"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[{"id":"917689eb-932f-4de1-b6c4-afc6678a7849","name":"Create Invitation","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"eduardo@test.com","type":"text"},{"key":"isAdmin","value":"0","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/invitations"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sun, 02 Jun 2024 04:31:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"email\": \"eduardo@test.com\",\n \"token\": \"$2y$12$/UvzhGunhHO3KMhXHYeNLeEXZUxFqMalFoW.Sj31ct./QvH/e.3xS\",\n \"isAdmin\": \"0\",\n \"expiresAt\": \"2024-06-02T16:31:52.137953Z\",\n \"createdAt\": \"2024-06-02T04:31:52.000000Z\"\n }\n}"},{"id":"88991505-5ad3-440b-a543-95f2efc07171","name":"Error Active Invitation","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"eduardo2@test.com","type":"text"},{"key":"isAdmin","value":"0","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/invitations"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sun, 02 Jun 2024 04:37:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"statusCode\": 500,\n \"error\": {\n \"code\": 13100,\n \"message\": \"Email has an active invitation.\",\n \"details\": \"Email has an active invitation.\",\n \"timestamp\": \"2024-06-02T04:37:36.206874Z\",\n \"path\": \"api/v1/invitations\",\n \"suggestion\": \"User already has an active invitation, check your email or wait for the invitation to expire to request a new one.\"\n },\n \"documentation_url\": \"https://google.com/docs/errors\"\n}"},{"id":"4beff6f1-42b4-46d0-8df7-38c96fb0f057","name":"Error Send Mail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"eduard22@test.com","type":"text"},{"key":"isAdmin","value":"0","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/invitations"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sun, 02 Jun 2024 04:38:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"statusCode\": 500,\n \"error\": {\n \"code\": 11500,\n \"message\": \"Send mail was not possible\",\n \"details\": \"Send mail was not possible, contact with admin.\",\n \"timestamp\": \"2024-06-02T04:38:05.773101Z\",\n \"path\": \"api/v1/invitations\",\n \"suggestion\": \"Send mail was not possible check connection and try again\"\n },\n \"documentation_url\": \"https://google.com/docs/errors\"\n}"},{"id":"54243246-9c9e-4209-9b2e-76aea606ebf5","name":"Create Invitation","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"eduard22@test.com","type":"text"},{"key":"isAdmin","value":"0","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/invitations"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sun, 02 Jun 2024 04:38:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"email\": \"eduard22@test.com\",\n \"token\": \"$2y$12$7pw8ofJT69OPFbENG8WJy.AkfZx3brdDFCbjLnBKEPwJ1nNNthfpS\",\n \"isAdmin\": \"0\",\n \"expiresAt\": \"2024-06-02T16:38:30.948758Z\",\n \"createdAt\": \"2024-06-02T04:38:30.000000Z\"\n }\n}"}],"_postman_id":"aa8af8d1-dcfc-46e0-a74d-8e92ad297777"}],"id":"dbcf5c84-341d-49e7-86eb-046ec47cde88","_postman_id":"dbcf5c84-341d-49e7-86eb-046ec47cde88","description":""},{"name":"Customers","item":[{"name":"All Customers","id":"563164eb-faa2-4fe6-ad6b-3a1770ee49a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/customers","description":"

GET /customers

Retrive a complete list of customers.

Request

No request body for this request.

Response

Status: 200
Content-Type: application/json

{\n  \"data\": [\n    {\n      \"id\": 0,\n      \"name\": \"\",\n      \"type\": \"\",\n      \"email\": \"\",\n      \"address\": \"\",\n      \"city\": \"\",\n      \"state\": \"\",\n      \"country\": \"\",\n      \"postalCode\": \"\"\n    }\n  ],\n  \"links\": {\n    \"first\": \"\",\n    \"last\": \"\",\n    \"prev\": null,\n    \"next\": \"\"\n  },\n  \"meta\": {\n    \"current_page\": 0,\n    \"from\": 0,\n    \"last_page\": 0,\n    \"links\": [\n      {\n        \"url\": null,\n        \"label\": \"\",\n        \"active\": true\n      }\n    ],\n    \"path\": \"\",\n    \"per_page\": 0,\n    \"to\": 0,\n    \"total\": 0\n  }\n}\n

\n","urlObject":{"path":["customers"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[{"id":"b4d6fe02-b540-4b32-8b64-fad4f72519fa","name":"All Customers","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 30 May 2024 20:29:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Camille Hodkiewicz V\",\n \"type\": \"I\",\n \"email\": \"yparisian@gmail.com\",\n \"address\": \"59181 Hugh Burg Suite 463\",\n \"city\": \"South Nestormouth\",\n \"state\": \"South Carolina\",\n \"country\": \"Jamaica\",\n \"postalCode\": \"50100-3504\"\n },\n {\n \"id\": 2,\n \"name\": \"Cortney Powlowski\",\n \"type\": \"I\",\n \"email\": \"howe.kendrick@hotmail.com\",\n \"address\": \"799 Trace Fork\",\n \"city\": \"Lake Vada\",\n \"state\": \"Virginia\",\n \"country\": \"Zimbabwe\",\n \"postalCode\": \"82568-0796\"\n },\n {\n \"id\": 3,\n \"name\": \"Fausto Douglas\",\n \"type\": \"I\",\n \"email\": \"agleichner@fritsch.com\",\n \"address\": \"955 Kulas Well\",\n \"city\": \"Marianeland\",\n \"state\": \"Colorado\",\n \"country\": \"Tunisia\",\n \"postalCode\": \"49698\"\n },\n {\n \"id\": 4,\n \"name\": \"Roob-Durgan\",\n \"type\": \"B\",\n \"email\": \"ryan.devin@renner.com\",\n \"address\": \"38733 Abbott Flats Apt. 081\",\n \"city\": \"South Marianamouth\",\n \"state\": \"Washington\",\n \"country\": \"Djibouti\",\n \"postalCode\": \"40929\"\n },\n {\n \"id\": 6,\n \"name\": \"Dudley Predovic\",\n \"type\": \"I\",\n \"email\": \"serenity68@parisian.com\",\n \"address\": \"1785 Madie Junctions\",\n \"city\": \"Imanibury\",\n \"state\": \"Nevada\",\n \"country\": \"Korea\",\n \"postalCode\": \"16630\"\n },\n {\n \"id\": 7,\n \"name\": \"Parisian, O'Hara and Kulas\",\n \"type\": \"B\",\n \"email\": \"sbecker@yahoo.com\",\n \"address\": \"881 Joshua Crescent\",\n \"city\": \"Kelliefort\",\n \"state\": \"Nevada\",\n \"country\": \"Serbia\",\n \"postalCode\": \"74424-2847\"\n },\n {\n \"id\": 8,\n \"name\": \"Armstrong-Barrows\",\n \"type\": \"B\",\n \"email\": \"trycia94@rowe.com\",\n \"address\": \"49311 Maxime Causeway\",\n \"city\": \"Sigridborough\",\n \"state\": \"Tennessee\",\n \"country\": \"Niger\",\n \"postalCode\": \"79880-6328\"\n },\n {\n \"id\": 9,\n \"name\": \"Predovic, Doyle and Turcotte\",\n \"type\": \"B\",\n \"email\": \"abagail45@rolfson.com\",\n \"address\": \"133 Francisca Lock\",\n \"city\": \"Lake Dorothyfort\",\n \"state\": \"South Carolina\",\n \"country\": \"Mayotte\",\n \"postalCode\": \"10678-7943\"\n },\n {\n \"id\": 10,\n \"name\": \"Rohan, Dietrich and Hermann\",\n \"type\": \"B\",\n \"email\": \"francisca.price@thiel.net\",\n \"address\": \"181 Schinner Parkways\",\n \"city\": \"Earnestton\",\n \"state\": \"Delaware\",\n \"country\": \"Malta\",\n \"postalCode\": \"90122\"\n },\n {\n \"id\": 11,\n \"name\": \"Medhurst, Balistreri and Zieme\",\n \"type\": \"B\",\n \"email\": \"blick.sally@sporer.org\",\n \"address\": \"2688 Cielo Court\",\n \"city\": \"Huelburgh\",\n \"state\": \"Indiana\",\n \"country\": \"Samoa\",\n \"postalCode\": \"90388-0882\"\n },\n {\n \"id\": 12,\n \"name\": \"Dr. Dashawn Schimmel\",\n \"type\": \"I\",\n \"email\": \"gilda.mccullough@kuphal.biz\",\n \"address\": \"50098 Morissette Cliff Apt. 287\",\n \"city\": \"Soniabury\",\n \"state\": \"Ohio\",\n \"country\": \"Nauru\",\n \"postalCode\": \"84736\"\n },\n {\n \"id\": 13,\n \"name\": \"Davis PLC\",\n \"type\": \"B\",\n \"email\": \"adell57@hotmail.com\",\n \"address\": \"326 Dickinson Junction Apt. 910\",\n \"city\": \"Moorefurt\",\n \"state\": \"Massachusetts\",\n \"country\": \"Bolivia\",\n \"postalCode\": \"28581\"\n },\n {\n \"id\": 14,\n \"name\": \"Dr. Lempi Pacocha\",\n \"type\": \"I\",\n \"email\": \"gutmann.otho@bogan.com\",\n \"address\": \"904 Hodkiewicz Port Suite 720\",\n \"city\": \"Port Mabel\",\n \"state\": \"Mississippi\",\n \"country\": \"Mayotte\",\n \"postalCode\": \"94851-0340\"\n },\n {\n \"id\": 15,\n \"name\": \"Cormier Group\",\n \"type\": \"B\",\n \"email\": \"keven.rohan@yahoo.com\",\n \"address\": \"5540 Ledner Manor Suite 281\",\n \"city\": \"New Brenda\",\n \"state\": \"Texas\",\n \"country\": \"Cook Islands\",\n \"postalCode\": \"29206-3736\"\n },\n {\n \"id\": 16,\n \"name\": \"Schiller, Pollich and Hagenes\",\n \"type\": \"B\",\n \"email\": \"gislason.joanie@pouros.net\",\n \"address\": \"338 Gleason Trace Apt. 239\",\n \"city\": \"Elysehaven\",\n \"state\": \"Utah\",\n \"country\": \"San Marino\",\n \"postalCode\": \"03792\"\n }\n ],\n \"links\": {\n \"first\": \"http://127.0.0.1:8000/api/v1/customers?page=1\",\n \"last\": \"http://127.0.0.1:8000/api/v1/customers?page=13\",\n \"prev\": null,\n \"next\": \"http://127.0.0.1:8000/api/v1/customers?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 13,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?page=4\",\n \"label\": \"4\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?page=5\",\n \"label\": \"5\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?page=6\",\n \"label\": \"6\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?page=7\",\n \"label\": \"7\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?page=8\",\n \"label\": \"8\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?page=9\",\n \"label\": \"9\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?page=10\",\n \"label\": \"10\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?page=11\",\n \"label\": \"11\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?page=12\",\n \"label\": \"12\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?page=13\",\n \"label\": \"13\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"http://127.0.0.1:8000/api/v1/customers\",\n \"per_page\": 15,\n \"to\": 15,\n \"total\": 182\n }\n}"}],"_postman_id":"563164eb-faa2-4fe6-ad6b-3a1770ee49a7"},{"name":"Customers By filter","id":"75415ecd-060a-4cc4-b5a6-43f44b6c6d1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/customers?state[eq]=Washington","description":"

Get all customers by filters, and can add invoices

\n","urlObject":{"path":["customers"],"host":["http://127.0.0.1:8000/api/v1"],"query":[{"disabled":true,"description":{"content":"

Name filter. Can be use: eq

\n","type":"text/plain"},"key":"name[eq]","value":"Roob-Durgan"},{"description":{"content":"

State filter. Can be use: eq

\n","type":"text/plain"},"key":"state[eq]","value":"Washington"},{"disabled":true,"description":{"content":"

Type filter. Can be use: eq

\n","type":"text/plain"},"key":"type[eq]","value":null},{"disabled":true,"description":{"content":"

Email filter. Can be use: eq

\n","type":"text/plain"},"key":"email[eq]","value":"ryan.devin@renner.com"},{"disabled":true,"description":{"content":"

Address filter. Can be use: eq

\n","type":"text/plain"},"key":"address[eq]","value":null},{"disabled":true,"description":{"content":"

City filter. Can be use: eq

\n","type":"text/plain"},"key":"city[eq]","value":null},{"disabled":true,"description":{"content":"

State filter. Can be use: eq

\n","type":"text/plain"},"key":"state[eq]","value":null},{"disabled":true,"description":{"content":"

Country filter. Can be use: eq

\n","type":"text/plain"},"key":"country[eq]","value":null},{"disabled":true,"description":{"content":"

Postal code filter. Can be use: eq, gt, lt

\n","type":"text/plain"},"key":"postalCode[eq]","value":null}],"variable":[]}},"response":[{"id":"da0027ce-fbf1-48ff-b85b-d0279da06948","name":"Customers By filter","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"http://127.0.0.1:8000/api/v1/customers?state[eq]=Washington","host":["http://127.0.0.1:8000/api/v1"],"path":["customers"],"query":[{"key":"name[eq]","value":"Roob-Durgan","description":"Name filter. Can be use: eq","type":"text","disabled":true},{"key":"state[eq]","value":"Washington","description":"State filter. Can be use: eq","type":"text"},{"key":"type[eq]","value":null,"description":"Type filter. Can be use: eq","type":"text","disabled":true},{"key":"email[eq]","value":"ryan.devin@renner.com","description":"Email filter. Can be use: eq","type":"text","disabled":true},{"key":"address[eq]","value":null,"description":"Address filter. Can be use: eq","type":"text","disabled":true},{"key":"city[eq]","value":null,"description":"City filter. Can be use: eq","type":"text","disabled":true},{"key":"state[eq]","value":null,"description":"State filter. Can be use: eq","type":"text","disabled":true},{"key":"country[eq]","value":null,"description":"Country filter. Can be use: eq","type":"text","disabled":true},{"key":"postalCode[eq]","value":null,"description":"Postal code filter. Can be use: eq, gt, lt","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 30 May 2024 20:36:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 4,\n \"name\": \"Roob-Durgan\",\n \"type\": \"B\",\n \"email\": \"ryan.devin@renner.com\",\n \"address\": \"38733 Abbott Flats Apt. 081\",\n \"city\": \"South Marianamouth\",\n \"state\": \"Washington\",\n \"country\": \"Djibouti\",\n \"postalCode\": \"40929\"\n },\n {\n \"id\": 31,\n \"name\": \"Princess Keebler\",\n \"type\": \"I\",\n \"email\": \"casper.leanne@yahoo.com\",\n \"address\": \"525 Sabina Passage\",\n \"city\": \"Stephaniaberg\",\n \"state\": \"Washington\",\n \"country\": \"Jamaica\",\n \"postalCode\": \"20297\"\n },\n {\n \"id\": 46,\n \"name\": \"Miss Daphnee Pfannerstill\",\n \"type\": \"I\",\n \"email\": \"mills.enos@gmail.com\",\n \"address\": \"4390 Novella Island\",\n \"city\": \"Rodriguezview\",\n \"state\": \"Washington\",\n \"country\": \"Armenia\",\n \"postalCode\": \"13418\"\n },\n {\n \"id\": 128,\n \"name\": \"Sauer, Franecki and Heathcote\",\n \"type\": \"B\",\n \"email\": \"brooklyn.schuppe@hotmail.com\",\n \"address\": \"99816 Mathias Meadows Suite 074\",\n \"city\": \"North Tryciaton\",\n \"state\": \"Washington\",\n \"country\": \"Australia\",\n \"postalCode\": \"98034-5984\"\n },\n {\n \"id\": 132,\n \"name\": \"Deborah Adams\",\n \"type\": \"I\",\n \"email\": \"kennedi.kessler@schulist.com\",\n \"address\": \"2825 O'Conner Inlet Apt. 981\",\n \"city\": \"Asaside\",\n \"state\": \"Washington\",\n \"country\": \"Serbia\",\n \"postalCode\": \"08952-5462\"\n }\n ],\n \"links\": {\n \"first\": \"http://127.0.0.1:8000/api/v1/customers?state%5Beq%5D=Washington&page=1\",\n \"last\": \"http://127.0.0.1:8000/api/v1/customers?state%5Beq%5D=Washington&page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/customers?state%5Beq%5D=Washington&page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"http://127.0.0.1:8000/api/v1/customers\",\n \"per_page\": 15,\n \"to\": 5,\n \"total\": 5\n }\n}"}],"_postman_id":"75415ecd-060a-4cc4-b5a6-43f44b6c6d1b"},{"name":"Customer By id","id":"3ff2b17b-eac2-48a4-b390-afcd88c22591","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/customers/5?includeInvoices=true","description":"

Retrieve Customer By Id with Invoices

Retrieves customer details by the provided ID and includes related invoices if the 'includeInvoices' parameter is set to true.

Request

Method: GET
URL: http://127.0.0.1:8000/api/v1/customers/5?includeInvoices=true

Response

The response is in JSON format and follows the schema below:

{\n  \"data\": {\n    \"id\": 0,\n    \"name\": \"\",\n    \"type\": \"\",\n    \"email\": \"\",\n    \"address\": \"\",\n    \"city\": \"\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"postalCode\": \"\",\n    \"invoices\": [\n      {\n        \"id\": 0,\n        \"customerId\": 0,\n        \"invoiceNumber\": 0,\n        \"uuid\": \"\",\n        \"amount\": \"\",\n        \"status\": \"\",\n        \"billedDated\": \"\",\n        \"paidDated\": \"\",\n        \"createdAt\": \"\",\n        \"updatedAt\": \"\"\n      }\n    ]\n  }\n}\n\n

The data object contains customer details such as ID, name, type, email, address, city, state, country, and postal code. If the 'includeInvoices' parameter is true, it also includes an array of invoices with their respective details like ID, customer ID, invoice number, UUID, amount, status, billed date, paid date, creation date, and update date.

Example Response

{\n  \"data\": {\n    \"id\": 0,\n    \"name\": \"\",\n    \"type\": \"\",\n    \"email\": \"\",\n    \"address\": \"\",\n    \"city\": \"\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"postalCode\": \"\",\n    \"invoices\": [\n      {\n        \"id\": 0,\n        \"customerId\": 0,\n        \"invoiceNumber\": 0,\n        \"uuid\": \"\",\n        \"amount\": \"\",\n        \"status\": \"\",\n        \"billedDated\": \"\",\n        \"paidDated\": \"\",\n        \"createdAt\": \"\",\n        \"updatedAt\": \"\"\n      }\n    ]\n  }\n}\n\n

{\n  \"data\": {\n    \"id\": 0,\n    \"name\": \"\",\n    \"type\": \"\",\n    \"email\": \"\",\n    \"address\": \"\",\n    \"city\": \"\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"postalCode\": \"\"\n  }\n}\n\n

\n","urlObject":{"path":["customers","5"],"host":["http://127.0.0.1:8000/api/v1"],"query":[{"description":{"content":"

(Optional) customer relationship invoices

\n","type":"text/plain"},"key":"includeInvoices","value":"true"}],"variable":[]}},"response":[{"id":"d2101408-612e-49d0-a55f-29718ce9c23a","name":"Customer By id with invoices","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"http://127.0.0.1:8000/api/v1/customers/5?includeInvoices=true","host":["http://127.0.0.1:8000/api/v1"],"path":["customers","5"],"query":[{"key":"includeInvoices","value":"true","description":"(Optional) customer relationship invoices"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 03 Jun 2024 16:26:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 5,\n \"name\": \"Miss Jody Gusikowski\",\n \"type\": \"I\",\n \"email\": \"nelda.dickinson@dickinson.com\",\n \"address\": \"6325 Brekke Valleys\",\n \"city\": \"West Kristin\",\n \"state\": \"Nebraska\",\n \"country\": \"Uzbekistan\",\n \"postalCode\": \"00806-9072\",\n \"invoices\": [\n {\n \"id\": 37,\n \"customerId\": 5,\n \"invoiceNumber\": 12160,\n \"uuid\": \"21ca97a7-a733-3c60-a27f-5981fe724dc2\",\n \"amount\": \"21\",\n \"status\": \"P\",\n \"billedDated\": \"2015-07-10 08:53:45\",\n \"paidDated\": \"2017-08-10 15:07:35\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 38,\n \"customerId\": 5,\n \"invoiceNumber\": 12161,\n \"uuid\": \"20b1f285-2d53-38b3-9621-f6ed5a7c7e01\",\n \"amount\": \"19.6\",\n \"status\": \"P\",\n \"billedDated\": \"2020-10-12 15:59:14\",\n \"paidDated\": \"2014-12-02 10:49:31\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 39,\n \"customerId\": 5,\n \"invoiceNumber\": 12162,\n \"uuid\": \"bf411f48-e488-3d4b-824f-10ffa01a52a2\",\n \"amount\": \"22.3\",\n \"status\": \"B\",\n \"billedDated\": \"2019-02-10 18:57:52\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 40,\n \"customerId\": 5,\n \"invoiceNumber\": 12163,\n \"uuid\": \"0418d305-ae10-3f38-8b5e-c25bc48efe99\",\n \"amount\": \"18.1\",\n \"status\": \"P\",\n \"billedDated\": \"2017-06-03 18:21:09\",\n \"paidDated\": \"2023-12-04 18:28:43\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 41,\n \"customerId\": 5,\n \"invoiceNumber\": 12164,\n \"uuid\": \"271bcb97-e3c8-333c-9fe2-c6e76fac738f\",\n \"amount\": \"11.7\",\n \"status\": \"P\",\n \"billedDated\": \"2017-06-05 18:33:20\",\n \"paidDated\": \"2023-03-18 02:27:23\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 42,\n \"customerId\": 5,\n \"invoiceNumber\": 12165,\n \"uuid\": \"6b678ba1-8ef2-336d-bfd2-d8e60d9ed28f\",\n \"amount\": \"20.2\",\n \"status\": \"V\",\n \"billedDated\": \"2017-07-28 23:56:26\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 43,\n \"customerId\": 5,\n \"invoiceNumber\": 12166,\n \"uuid\": \"88e71c3a-c317-3fca-8305-fd287f8da080\",\n \"amount\": \"12.6\",\n \"status\": \"B\",\n \"billedDated\": \"2021-01-30 00:18:45\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 44,\n \"customerId\": 5,\n \"invoiceNumber\": 12167,\n \"uuid\": \"1d1f83c7-5f19-36eb-b768-e993a2088442\",\n \"amount\": \"20.3\",\n \"status\": \"P\",\n \"billedDated\": \"2020-08-15 00:10:50\",\n \"paidDated\": \"2016-12-15 20:37:55\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 45,\n \"customerId\": 5,\n \"invoiceNumber\": 12168,\n \"uuid\": \"5425fec6-45dc-31d8-88ad-1979ca02af01\",\n \"amount\": \"13.9\",\n \"status\": \"B\",\n \"billedDated\": \"2018-05-01 01:18:34\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n }\n ]\n }\n}"},{"id":"64255aeb-00be-405c-bd4a-0f5345488be2","name":"Customer By id","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"http://127.0.0.1:8000/api/v1/customers/5","host":["http://127.0.0.1:8000/api/v1"],"path":["customers","5"],"query":[{"key":"includeInvoices","value":"true","description":"(Optional) customer relationship invoices","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 03 Jun 2024 16:27:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 5,\n \"name\": \"Miss Jody Gusikowski\",\n \"type\": \"I\",\n \"email\": \"nelda.dickinson@dickinson.com\",\n \"address\": \"6325 Brekke Valleys\",\n \"city\": \"West Kristin\",\n \"state\": \"Nebraska\",\n \"country\": \"Uzbekistan\",\n \"postalCode\": \"00806-9072\"\n }\n}"}],"_postman_id":"3ff2b17b-eac2-48a4-b390-afcd88c22591"},{"name":"Customer","id":"f5e7af20-e1ef-4d7e-8991-1b59acefe03c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Abraham Gonzalez","type":"text"},{"key":"type","value":"I","type":"text","description":"

Type can be: I or B

\n"},{"key":"email","value":"agonzalez@test.com","type":"text"},{"key":"address","value":"Urb. Nueva Casarapa","type":"text"},{"key":"city","value":"Caracas","type":"text"},{"key":"state","value":"Distrito capital","type":"text"},{"key":"country","value":"Venezuela","type":"text"},{"key":"postalCode","value":"1020","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/customers","description":"

Create a new customer

Request Body

name (text)
type (text, Type can be: I or B)
email (text)
address (text)
city (text)
state (text)
country (text)
postalCode (text)

Response

{\n    \"data\": {\n        \"id\": 0,\n        \"name\": \"\",\n        \"type\": \"\",\n        \"email\": \"\",\n        \"address\": \"\",\n        \"city\": \"\",\n        \"state\": \"\",\n        \"country\": \"\",\n        \"postalCode\": \"\"\n    }\n}\n

\n","urlObject":{"path":["customers"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[{"id":"397092ac-b29d-4be1-83f1-2b72deec227b","name":"Create Customer","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Abraham Gonzalez,","type":"text"},{"key":"type","value":"I","type":"text"},{"key":"email","value":"agonzalez@test.com","type":"text"},{"key":"address","value":"Urb. Nueva Casarapa","type":"text"},{"key":"city","value":"Caracas","type":"text"},{"key":"state","value":"Distrito capital","type":"text"},{"key":"country","value":"Venezuela","type":"text"},{"key":"postalCode","value":"1020","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/customers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 30 May 2024 20:39:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 183,\n \"name\": \"Abraham Gonzalez,\",\n \"type\": \"I\",\n \"email\": \"agonzalez@test.com\",\n \"address\": \"Urb. Nueva Casarapa\",\n \"city\": \"Caracas\",\n \"state\": \"Distrito capital\",\n \"country\": \"Venezuela\",\n \"postalCode\": \"1020\"\n }\n}"}],"_postman_id":"f5e7af20-e1ef-4d7e-8991-1b59acefe03c"},{"name":"Customer","id":"dc3c50f7-960c-4bac-94d6-fe51a8910f2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Abraham Perez","type":"text"},{"key":"type","value":"B","type":"text"},{"key":"email","value":"aperez@test.com","type":"text"},{"key":"address","value":"urb. nueva casarapa","type":"text"},{"key":"city","value":"Guarenas","type":"text"},{"key":"state","value":"Miranda","type":"text"},{"key":"country","value":"Venezuela","type":"text"},{"key":"postalCode","value":"1020","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/customers/183","description":"

Update Customer

Updates the customer information.

Request Body

name (text)
type (text)
email (text)
address (text)
city (text)
state (text)
country (text)
postalCode (text)

Response

Return HTTP status 201 , if customer was updated.

\n","urlObject":{"path":["customers","183"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"dc3c50f7-960c-4bac-94d6-fe51a8910f2c"},{"name":"Customer","id":"71283211-6400-4d35-ad2c-4acc41e637c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"Abraham Gonzalez","type":"text"},{"key":"type","value":"I","type":"text","disabled":true},{"key":"email","value":"agonzalez@test.com","type":"text","disabled":true},{"key":"address","value":"Urb. Nueva Casarapa","type":"text"},{"key":"city","value":"Caracas","type":"text","disabled":true},{"key":"state","value":"Distrito capital","type":"text","disabled":true},{"key":"country","value":"Venezuela","type":"text","disabled":true},{"key":"postalCode","value":"1020","type":"text","disabled":true}]},"url":"http://127.0.0.1:8000/api/v1/customers/2","description":"

Update a customer.

\n","urlObject":{"path":["customers","2"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"71283211-6400-4d35-ad2c-4acc41e637c8"},{"name":"Customer By Id","id":"3d05dc26-c458-42f7-8434-b5c8992c6403","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/customers/5","description":"

Delete customer by id.

\n","urlObject":{"path":["customers","5"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"3d05dc26-c458-42f7-8434-b5c8992c6403"}],"id":"154b4657-00fc-411c-8e7b-9e42a786c7b2","_postman_id":"154b4657-00fc-411c-8e7b-9e42a786c7b2","description":""},{"name":"Invoices","item":[{"name":"All invoices","id":"3abef32a-fd49-4763-b8ca-4ecb5e84463d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/invoices","description":"

Retrieve Invoices

Retrieves a list of invoices.

Response

The response for this request can be represented as a JSON schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"data\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"id\": { \"type\": \"integer\" },\n          \"customerId\": { \"type\": \"integer\" },\n          \"invoiceNumber\": { \"type\": \"integer\" },\n          \"uuid\": { \"type\": \"string\" },\n          \"amount\": { \"type\": \"string\" },\n          \"status\": { \"type\": \"string\" },\n          \"billedDated\": { \"type\": \"string\" },\n          \"paidDated\": { \"type\": \"string\" },\n          \"createdAt\": { \"type\": \"string\" },\n          \"updatedAt\": { \"type\": \"string\" }\n        }\n      }\n    },\n    \"links\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"first\": { \"type\": \"string\" },\n        \"last\": { \"type\": \"string\" },\n        \"prev\": { \"type\": [\"string\", \"null\"] },\n        \"next\": { \"type\": \"string\" }\n      }\n    },\n    \"meta\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"current_page\": { \"type\": \"integer\" },\n        \"from\": { \"type\": \"integer\" },\n        \"last_page\": { \"type\": \"integer\" },\n        \"links\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"url\": { \"type\": [\"string\", \"null\"] },\n              \"label\": { \"type\": \"string\" },\n              \"active\": { \"type\": \"boolean\" }\n            }\n          }\n        },\n        \"path\": { \"type\": \"string\" },\n        \"per_page\": { \"type\": \"integer\" },\n        \"to\": { \"type\": \"integer\" },\n        \"total\": { \"type\": \"integer\" }\n      }\n    }\n  }\n}\n\n

\n","urlObject":{"path":["invoices"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[{"id":"5b169b65-282b-404e-b444-a984690970e6","name":"All invoices","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/invoices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 03 Jun 2024 16:45:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"customerId\": 1,\n \"invoiceNumber\": 12124,\n \"uuid\": \"7798a662-d449-3378-88ee-4539746bd157\",\n \"amount\": \"17.9\",\n \"status\": \"P\",\n \"billedDated\": \"2014-12-30 11:21:57\",\n \"paidDated\": \"2022-10-17 14:49:39\",\n \"createdAt\": \"2024-06-03T16:24:59.000000Z\",\n \"updatedAt\": \"2024-06-03T16:24:59.000000Z\"\n },\n {\n \"id\": 2,\n \"customerId\": 1,\n \"invoiceNumber\": 12125,\n \"uuid\": \"e49943b6-7fb1-366e-be83-1b389b10f799\",\n \"amount\": \"23.2\",\n \"status\": \"B\",\n \"billedDated\": \"2016-05-31 14:20:14\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 3,\n \"customerId\": 1,\n \"invoiceNumber\": 12126,\n \"uuid\": \"53b9388a-945e-35b2-93e3-2041fa355466\",\n \"amount\": \"19.9\",\n \"status\": \"P\",\n \"billedDated\": \"2016-08-11 05:06:22\",\n \"paidDated\": \"2019-05-28 09:55:30\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 4,\n \"customerId\": 1,\n \"invoiceNumber\": 12127,\n \"uuid\": \"89c5455f-b2db-3736-9f4b-ca6976286b34\",\n \"amount\": \"21.6\",\n \"status\": \"B\",\n \"billedDated\": \"2021-02-05 10:12:59\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 5,\n \"customerId\": 1,\n \"invoiceNumber\": 12128,\n \"uuid\": \"9026f151-cdaf-37ff-9673-7d6ed8900935\",\n \"amount\": \"14.4\",\n \"status\": \"B\",\n \"billedDated\": \"2015-08-11 22:08:05\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 6,\n \"customerId\": 1,\n \"invoiceNumber\": 12129,\n \"uuid\": \"b9ab49ce-3298-3363-b571-3f3b421f8893\",\n \"amount\": \"16.6\",\n \"status\": \"P\",\n \"billedDated\": \"2017-01-26 06:56:27\",\n \"paidDated\": \"2019-10-12 16:05:46\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 7,\n \"customerId\": 1,\n \"invoiceNumber\": 12130,\n \"uuid\": \"c99fb13b-fd34-3d38-a321-1674f88c1aaa\",\n \"amount\": \"17\",\n \"status\": \"V\",\n \"billedDated\": \"2021-04-21 05:01:22\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 8,\n \"customerId\": 1,\n \"invoiceNumber\": 12131,\n \"uuid\": \"2f9ff047-1fb5-326c-9e60-49cbbf5f421e\",\n \"amount\": \"18.8\",\n \"status\": \"B\",\n \"billedDated\": \"2024-01-05 15:14:38\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 9,\n \"customerId\": 1,\n \"invoiceNumber\": 12132,\n \"uuid\": \"e3fe935d-8b64-3927-a870-81990a0532e5\",\n \"amount\": \"16.4\",\n \"status\": \"V\",\n \"billedDated\": \"2021-04-13 18:44:36\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 10,\n \"customerId\": 2,\n \"invoiceNumber\": 12133,\n \"uuid\": \"8ecee6ff-913c-3696-9d45-fa1d541a7f66\",\n \"amount\": \"21.3\",\n \"status\": \"V\",\n \"billedDated\": \"2020-10-10 01:09:08\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 11,\n \"customerId\": 2,\n \"invoiceNumber\": 12134,\n \"uuid\": \"8fd50cb2-2b89-3612-b7e4-3152b673cec3\",\n \"amount\": \"14.1\",\n \"status\": \"P\",\n \"billedDated\": \"2018-05-06 00:44:31\",\n \"paidDated\": \"2019-02-15 07:26:28\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 12,\n \"customerId\": 2,\n \"invoiceNumber\": 12135,\n \"uuid\": \"ecc44a3d-3ad9-3c49-a473-e6b8b98d3915\",\n \"amount\": \"15.3\",\n \"status\": \"V\",\n \"billedDated\": \"2014-11-14 04:14:13\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 13,\n \"customerId\": 2,\n \"invoiceNumber\": 12136,\n \"uuid\": \"73b24481-383e-3f46-a16b-df81aecf03b0\",\n \"amount\": \"23.1\",\n \"status\": \"P\",\n \"billedDated\": \"2019-03-09 04:21:51\",\n \"paidDated\": \"2019-09-08 14:29:03\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 14,\n \"customerId\": 2,\n \"invoiceNumber\": 12137,\n \"uuid\": \"601746e5-cde3-3deb-889e-b495541f8bf4\",\n \"amount\": \"19.5\",\n \"status\": \"P\",\n \"billedDated\": \"2021-01-30 06:32:56\",\n \"paidDated\": \"2021-05-18 04:55:48\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n },\n {\n \"id\": 15,\n \"customerId\": 2,\n \"invoiceNumber\": 12138,\n \"uuid\": \"bc600c39-a7b0-385d-b3ad-970e96e70043\",\n \"amount\": \"13.9\",\n \"status\": \"V\",\n \"billedDated\": \"2016-12-08 09:59:41\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"http://127.0.0.1:8000/api/v1/invoices?page=1\",\n \"last\": \"http://127.0.0.1:8000/api/v1/invoices?page=72\",\n \"prev\": null,\n \"next\": \"http://127.0.0.1:8000/api/v1/invoices?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 72,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?page=4\",\n \"label\": \"4\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?page=5\",\n \"label\": \"5\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?page=6\",\n \"label\": \"6\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?page=7\",\n \"label\": \"7\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?page=8\",\n \"label\": \"8\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?page=9\",\n \"label\": \"9\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?page=10\",\n \"label\": \"10\",\n \"active\": false\n },\n {\n \"url\": null,\n \"label\": \"...\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?page=71\",\n \"label\": \"71\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?page=72\",\n \"label\": \"72\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"http://127.0.0.1:8000/api/v1/invoices\",\n \"per_page\": 15,\n \"to\": 15,\n \"total\": 1075\n }\n}"}],"_postman_id":"3abef32a-fd49-4763-b8ca-4ecb5e84463d"},{"name":"Invoices By filters","id":"4f24cfc6-9c3e-4013-b79c-53bde256bde0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount[gt]=18","description":"

Request Description

This is an HTTP GET request to retrieve all invoices with the option to include customer details and filter by amount greater than a specified value.

Request Body

This request does not contain a request body.

Response

The response is in the form of a JSON schema:

{\n  \"data\": [\n    {\n      \"id\": 0,\n      \"customerId\": 0,\n      \"invoiceNumber\": 0,\n      \"uuid\": \"\",\n      \"amount\": \"\",\n      \"status\": \"\",\n      \"billedDated\": \"\",\n      \"paidDated\": null,\n      \"createdAt\": \"\",\n      \"updatedAt\": \"\",\n      \"customer\": {\n        \"id\": 0,\n        \"name\": \"\",\n        \"type\": \"\",\n        \"email\": \"\",\n        \"address\": \"\",\n        \"city\": \"\",\n        \"state\": \"\",\n        \"country\": \"\",\n        \"postalCode\": \"\"\n      }\n    }\n  ],\n  \"links\": {\n    \"first\": \"\",\n    \"last\": \"\",\n    \"prev\": null,\n    \"next\": \"\"\n  },\n  \"meta\": {\n    \"current_page\": 0,\n    \"from\": 0,\n    \"last_page\": 0,\n    \"links\": [\n      {\n        \"url\": null,\n        \"label\": \"\",\n        \"active\": true\n      }\n    ],\n    \"path\": \"\",\n    \"per_page\": 0,\n    \"to\": 0,\n    \"total\": 0\n  }\n}\n

The response includes an array of invoice objects with their details, such as ID, customer ID, invoice number, UUID, amount, status, billing and payment dates, creation and update timestamps, and customer information. Additionally, it contains links for pagination and metadata about the current page and total count.

\n","urlObject":{"path":["invoices"],"host":["http://127.0.0.1:8000/api/v1"],"query":[{"key":"includeCustomer","value":"true"},{"disabled":true,"description":{"content":"

Options: eq

\n","type":"text/plain"},"key":"customerId[eq]","value":"2"},{"disabled":true,"description":{"content":"

Options: eq

\n","type":"text/plain"},"key":"invoiceNumber[eq]","value":"1269"},{"disabled":true,"description":{"content":"

Options: eq

\n","type":"text/plain"},"key":"uuid[eq]","value":null},{"description":{"content":"

Options: eq, gt, lt, lte, gte

\n","type":"text/plain"},"key":"amount[gt]","value":"18"},{"disabled":true,"description":{"content":"

Options: eq, ne

\n","type":"text/plain"},"key":"status[eq]","value":null},{"disabled":true,"description":{"content":"

Options: eq eq, gt, lt, lte, gte

\n","type":"text/plain"},"key":"billedDated[gt]","value":null},{"disabled":true,"description":{"content":"

Options: eq eq, gt, lt, lte, gte

\n","type":"text/plain"},"key":"paidDated[gt]","value":null}],"variable":[]}},"response":[{"id":"2331ad74-64fe-4a30-9359-5e05cada8e04","name":"Invoices By filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount[gt]=18","host":["http://127.0.0.1:8000/api/v1"],"path":["invoices"],"query":[{"key":"includeCustomer","value":"true"},{"key":"customerId[eq]","value":"2","description":"Options: eq","type":"text","disabled":true},{"key":"invoiceNumber[eq]","value":"1269","description":"Options: eq","type":"text","disabled":true},{"key":"uuid[eq]","value":null,"description":"Options: eq","type":"text","disabled":true},{"key":"amount[gt]","value":"18","description":"Options: eq, gt, lt, lte, gte"},{"key":"status[eq]","value":null,"description":"Options: eq, ne","type":"text","disabled":true},{"key":"billedDated[gt]","value":null,"description":"Options: eq eq, gt, lt, lte, gte","type":"text","disabled":true},{"key":"paidDated[gt]","value":null,"description":"Options: eq eq, gt, lt, lte, gte","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 03 Jun 2024 16:46:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 2,\n \"customerId\": 1,\n \"invoiceNumber\": 12125,\n \"uuid\": \"e49943b6-7fb1-366e-be83-1b389b10f799\",\n \"amount\": \"23.2\",\n \"status\": \"B\",\n \"billedDated\": \"2016-05-31 14:20:14\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 1,\n \"name\": \"Jacquelyn Lynch\",\n \"type\": \"I\",\n \"email\": \"alana.graham@yahoo.com\",\n \"address\": \"5787 Spinka Rest Apt. 871\",\n \"city\": \"Maeganport\",\n \"state\": \"Texas\",\n \"country\": \"Syrian Arab Republic\",\n \"postalCode\": \"25046\"\n }\n },\n {\n \"id\": 3,\n \"customerId\": 1,\n \"invoiceNumber\": 12126,\n \"uuid\": \"53b9388a-945e-35b2-93e3-2041fa355466\",\n \"amount\": \"19.9\",\n \"status\": \"P\",\n \"billedDated\": \"2016-08-11 05:06:22\",\n \"paidDated\": \"2019-05-28 09:55:30\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 1,\n \"name\": \"Jacquelyn Lynch\",\n \"type\": \"I\",\n \"email\": \"alana.graham@yahoo.com\",\n \"address\": \"5787 Spinka Rest Apt. 871\",\n \"city\": \"Maeganport\",\n \"state\": \"Texas\",\n \"country\": \"Syrian Arab Republic\",\n \"postalCode\": \"25046\"\n }\n },\n {\n \"id\": 4,\n \"customerId\": 1,\n \"invoiceNumber\": 12127,\n \"uuid\": \"89c5455f-b2db-3736-9f4b-ca6976286b34\",\n \"amount\": \"21.6\",\n \"status\": \"B\",\n \"billedDated\": \"2021-02-05 10:12:59\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 1,\n \"name\": \"Jacquelyn Lynch\",\n \"type\": \"I\",\n \"email\": \"alana.graham@yahoo.com\",\n \"address\": \"5787 Spinka Rest Apt. 871\",\n \"city\": \"Maeganport\",\n \"state\": \"Texas\",\n \"country\": \"Syrian Arab Republic\",\n \"postalCode\": \"25046\"\n }\n },\n {\n \"id\": 8,\n \"customerId\": 1,\n \"invoiceNumber\": 12131,\n \"uuid\": \"2f9ff047-1fb5-326c-9e60-49cbbf5f421e\",\n \"amount\": \"18.8\",\n \"status\": \"B\",\n \"billedDated\": \"2024-01-05 15:14:38\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 1,\n \"name\": \"Jacquelyn Lynch\",\n \"type\": \"I\",\n \"email\": \"alana.graham@yahoo.com\",\n \"address\": \"5787 Spinka Rest Apt. 871\",\n \"city\": \"Maeganport\",\n \"state\": \"Texas\",\n \"country\": \"Syrian Arab Republic\",\n \"postalCode\": \"25046\"\n }\n },\n {\n \"id\": 10,\n \"customerId\": 2,\n \"invoiceNumber\": 12133,\n \"uuid\": \"8ecee6ff-913c-3696-9d45-fa1d541a7f66\",\n \"amount\": \"21.3\",\n \"status\": \"V\",\n \"billedDated\": \"2020-10-10 01:09:08\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 2,\n \"name\": \"Abraham Gonzalez\",\n \"type\": \"I\",\n \"email\": \"cturcotte@yahoo.com\",\n \"address\": \"Urb. Nueva Casarapa\",\n \"city\": \"Ulicesfurt\",\n \"state\": \"Washington\",\n \"country\": \"Congo\",\n \"postalCode\": \"32647\"\n }\n },\n {\n \"id\": 13,\n \"customerId\": 2,\n \"invoiceNumber\": 12136,\n \"uuid\": \"73b24481-383e-3f46-a16b-df81aecf03b0\",\n \"amount\": \"23.1\",\n \"status\": \"P\",\n \"billedDated\": \"2019-03-09 04:21:51\",\n \"paidDated\": \"2019-09-08 14:29:03\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 2,\n \"name\": \"Abraham Gonzalez\",\n \"type\": \"I\",\n \"email\": \"cturcotte@yahoo.com\",\n \"address\": \"Urb. Nueva Casarapa\",\n \"city\": \"Ulicesfurt\",\n \"state\": \"Washington\",\n \"country\": \"Congo\",\n \"postalCode\": \"32647\"\n }\n },\n {\n \"id\": 14,\n \"customerId\": 2,\n \"invoiceNumber\": 12137,\n \"uuid\": \"601746e5-cde3-3deb-889e-b495541f8bf4\",\n \"amount\": \"19.5\",\n \"status\": \"P\",\n \"billedDated\": \"2021-01-30 06:32:56\",\n \"paidDated\": \"2021-05-18 04:55:48\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 2,\n \"name\": \"Abraham Gonzalez\",\n \"type\": \"I\",\n \"email\": \"cturcotte@yahoo.com\",\n \"address\": \"Urb. Nueva Casarapa\",\n \"city\": \"Ulicesfurt\",\n \"state\": \"Washington\",\n \"country\": \"Congo\",\n \"postalCode\": \"32647\"\n }\n },\n {\n \"id\": 20,\n \"customerId\": 3,\n \"invoiceNumber\": 12143,\n \"uuid\": \"547a0983-bd7e-3bc8-a7b4-336009c4e0c2\",\n \"amount\": \"20.4\",\n \"status\": \"B\",\n \"billedDated\": \"2016-02-05 03:04:02\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 3,\n \"name\": \"Wuckert Group\",\n \"type\": \"B\",\n \"email\": \"finn.mcdermott@hotmail.com\",\n \"address\": \"51050 Aurelio Prairie\",\n \"city\": \"Lake Jonathan\",\n \"state\": \"West Virginia\",\n \"country\": \"Cocos (Keeling) Islands\",\n \"postalCode\": \"64833\"\n }\n },\n {\n \"id\": 27,\n \"customerId\": 3,\n \"invoiceNumber\": 12150,\n \"uuid\": \"09c0c3b7-dd4a-3684-b764-34cf397f64cd\",\n \"amount\": \"20.9\",\n \"status\": \"V\",\n \"billedDated\": \"2023-03-27 19:47:14\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 3,\n \"name\": \"Wuckert Group\",\n \"type\": \"B\",\n \"email\": \"finn.mcdermott@hotmail.com\",\n \"address\": \"51050 Aurelio Prairie\",\n \"city\": \"Lake Jonathan\",\n \"state\": \"West Virginia\",\n \"country\": \"Cocos (Keeling) Islands\",\n \"postalCode\": \"64833\"\n }\n },\n {\n \"id\": 31,\n \"customerId\": 4,\n \"invoiceNumber\": 12154,\n \"uuid\": \"3aa697e8-b77e-3dd6-b474-664ac6c57b28\",\n \"amount\": \"22.4\",\n \"status\": \"P\",\n \"billedDated\": \"2014-11-04 17:51:49\",\n \"paidDated\": \"2017-09-14 10:45:37\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 4,\n \"name\": \"Hosea Braun MD\",\n \"type\": \"I\",\n \"email\": \"hester09@schowalter.com\",\n \"address\": \"28141 Grimes Brooks\",\n \"city\": \"Legroschester\",\n \"state\": \"Colorado\",\n \"country\": \"Andorra\",\n \"postalCode\": \"02635\"\n }\n },\n {\n \"id\": 36,\n \"customerId\": 4,\n \"invoiceNumber\": 12159,\n \"uuid\": \"47b0ec36-270f-3134-bc6c-68145c92d9ae\",\n \"amount\": \"24.7\",\n \"status\": \"V\",\n \"billedDated\": \"2015-05-17 23:02:06\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 4,\n \"name\": \"Hosea Braun MD\",\n \"type\": \"I\",\n \"email\": \"hester09@schowalter.com\",\n \"address\": \"28141 Grimes Brooks\",\n \"city\": \"Legroschester\",\n \"state\": \"Colorado\",\n \"country\": \"Andorra\",\n \"postalCode\": \"02635\"\n }\n },\n {\n \"id\": 48,\n \"customerId\": 6,\n \"invoiceNumber\": 12171,\n \"uuid\": \"22bf28c8-7fdc-3429-9805-9ffc4c98a91c\",\n \"amount\": \"20.6\",\n \"status\": \"P\",\n \"billedDated\": \"2023-01-20 16:34:28\",\n \"paidDated\": \"2014-08-31 05:25:11\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 6,\n \"name\": \"Mr. Cedrick Trantow Jr.\",\n \"type\": \"I\",\n \"email\": \"quentin.carter@gmail.com\",\n \"address\": \"5051 Damaris Pass\",\n \"city\": \"Mayertborough\",\n \"state\": \"Michigan\",\n \"country\": \"Timor-Leste\",\n \"postalCode\": \"71510-4844\"\n }\n },\n {\n \"id\": 51,\n \"customerId\": 6,\n \"invoiceNumber\": 12174,\n \"uuid\": \"8c83fb00-3401-3a73-8068-e3827b2ee0d4\",\n \"amount\": \"18.9\",\n \"status\": \"V\",\n \"billedDated\": \"2018-03-25 15:15:12\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 6,\n \"name\": \"Mr. Cedrick Trantow Jr.\",\n \"type\": \"I\",\n \"email\": \"quentin.carter@gmail.com\",\n \"address\": \"5051 Damaris Pass\",\n \"city\": \"Mayertborough\",\n \"state\": \"Michigan\",\n \"country\": \"Timor-Leste\",\n \"postalCode\": \"71510-4844\"\n }\n },\n {\n \"id\": 53,\n \"customerId\": 6,\n \"invoiceNumber\": 12176,\n \"uuid\": \"8cb0bb4c-d0a8-38e4-a442-3a3b95b71056\",\n \"amount\": \"23.7\",\n \"status\": \"P\",\n \"billedDated\": \"2018-01-07 07:40:29\",\n \"paidDated\": \"2021-04-15 09:32:17\",\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 6,\n \"name\": \"Mr. Cedrick Trantow Jr.\",\n \"type\": \"I\",\n \"email\": \"quentin.carter@gmail.com\",\n \"address\": \"5051 Damaris Pass\",\n \"city\": \"Mayertborough\",\n \"state\": \"Michigan\",\n \"country\": \"Timor-Leste\",\n \"postalCode\": \"71510-4844\"\n }\n },\n {\n \"id\": 56,\n \"customerId\": 7,\n \"invoiceNumber\": 12179,\n \"uuid\": \"8f674a9d-94e5-313f-9104-98210d914345\",\n \"amount\": \"21.6\",\n \"status\": \"V\",\n \"billedDated\": \"2023-09-24 01:23:29\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:25:00.000000Z\",\n \"updatedAt\": \"2024-06-03T16:25:00.000000Z\",\n \"customer\": {\n \"id\": 7,\n \"name\": \"Eryn Reynolds\",\n \"type\": \"I\",\n \"email\": \"fabian.bogan@gmail.com\",\n \"address\": \"9780 Alexane Village Apt. 368\",\n \"city\": \"Beulahshire\",\n \"state\": \"Indiana\",\n \"country\": \"Iran\",\n \"postalCode\": \"34644\"\n }\n }\n ],\n \"links\": {\n \"first\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=1\",\n \"last\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=34\",\n \"prev\": null,\n \"next\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 34,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=4\",\n \"label\": \"4\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=5\",\n \"label\": \"5\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=6\",\n \"label\": \"6\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=7\",\n \"label\": \"7\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=8\",\n \"label\": \"8\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=9\",\n \"label\": \"9\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=10\",\n \"label\": \"10\",\n \"active\": false\n },\n {\n \"url\": null,\n \"label\": \"...\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=33\",\n \"label\": \"33\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=34\",\n \"label\": \"34\",\n \"active\": false\n },\n {\n \"url\": \"http://127.0.0.1:8000/api/v1/invoices?includeCustomer=true&amount%5Bgt%5D=18&page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"http://127.0.0.1:8000/api/v1/invoices\",\n \"per_page\": 15,\n \"to\": 15,\n \"total\": 498\n }\n}"}],"_postman_id":"4f24cfc6-9c3e-4013-b79c-53bde256bde0"},{"name":"Invoice By id","id":"c5af0029-7781-4340-a1c5-550b2fcae2a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/invoices/4?includeCustomer=true","description":"

Retrive invoice by id and can be added relationships with customer.

\n","urlObject":{"path":["invoices","4"],"host":["http://127.0.0.1:8000/api/v1"],"query":[{"description":{"content":"

(Optional) Invoice relationship with customer

\n","type":"text/plain"},"key":"includeCustomer","value":"true"}],"variable":[]}},"response":[],"_postman_id":"c5af0029-7781-4340-a1c5-550b2fcae2a5"},{"name":"Invoice","id":"154dcfcf-a0d4-46d5-90d5-01915e798fc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"customerId","value":"2","type":"text"},{"key":"amount","value":"201","type":"text"},{"key":"status","value":"V","type":"text"},{"key":"billedDated","value":"2024-05-27 20:03:01","type":"text"},{"key":"paidDated","value":"","type":"text","disabled":true}]},"url":"http://127.0.0.1:8000/api/v1/invoices","description":"

Create a new invoice

Creates a new invoice with the provided customer ID, amount, status, and billed date.

Request Body Parameters

customerId (text): The ID of the customer for whom the invoice is being created.
amount (text): The amount of the invoice.
status (text): The status of the invoice.
billedDated (text): The date on which the invoice is billed.

Response

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"data\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"id\": {\n          \"type\": \"integer\"\n        },\n        \"customerId\": {\n          \"type\": \"string\"\n        },\n        \"invoiceNumber\": {\n          \"type\": \"integer\"\n        },\n        \"uuid\": {\n          \"type\": \"string\"\n        },\n        \"amount\": {\n          \"type\": \"string\"\n        },\n        \"status\": {\n          \"type\": \"string\"\n        },\n        \"billedDated\": {\n          \"type\": \"string\"\n        },\n        \"paidDated\": {\n          \"type\": [\"string\", \"null\"]\n        },\n        \"createdAt\": {\n          \"type\": \"string\"\n        },\n        \"updatedAt\": {\n          \"type\": \"string\"\n        }\n      }\n    }\n  }\n}\n

\n","urlObject":{"path":["invoices"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[{"id":"d714beca-9c3e-4a22-9881-340401123ef6","name":"Create Invoice","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"customerId","value":"2","type":"text"},{"key":"amount","value":"201","type":"text"},{"key":"status","value":"V","type":"text"},{"key":"billedDated","value":"2024-05-27 20:03:01","type":"text"},{"key":"paidDated","value":"","type":"text","disabled":true}]},"url":"http://127.0.0.1:8000/api/v1/invoices"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 03 Jun 2024 16:47:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1085,\n \"customerId\": \"2\",\n \"invoiceNumber\": 13208,\n \"uuid\": \"1d3de9c9-125a-407a-8281-ec97886b39bf\",\n \"amount\": \"201\",\n \"status\": \"V\",\n \"billedDated\": \"2024-05-27 20:03:01\",\n \"paidDated\": null,\n \"createdAt\": \"2024-06-03T16:47:47.000000Z\",\n \"updatedAt\": \"2024-06-03T16:47:47.000000Z\"\n }\n}"},{"id":"f714a8df-59b3-49ec-a7b5-39a23a749532","name":"Error create invoice","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"customerId","value":"2","type":"text"},{"key":"amount","value":"201","type":"text"},{"key":"status","value":"V","type":"text"},{"key":"billedDated","value":"2024-05-27 20:03:01","type":"text"},{"key":"paidDated","value":"","type":"text","disabled":true}]},"url":"http://127.0.0.1:8000/api/v1/invoices"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 03 Jun 2024 17:05:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"statusCode\": 500,\n \"error\": {\n \"code\": 10104,\n \"message\": \"Store was not possible\",\n \"details\": \"SQLSTATE[23502]: Not null violation: 7 ERROR: null value in column \\\"customer_id\\\" of relation \\\"invoices\\\" violates not-null constraint\\nDETAIL: Failing row contains (1092, null, 13215, 7082c292-2614-405f-b336-7c092f07ac54, 201, V, 2024-05-27 20:03:01, null, 2024-06-03 17:05:14, 2024-06-03 17:05:14, null). (Connection: pgsql, SQL: insert into \\\"invoices\\\" (\\\"invoice_number\\\", \\\"uuid\\\", \\\"amount\\\", \\\"status\\\", \\\"billed_dated\\\", \\\"paid_dated\\\", \\\"updated_at\\\", \\\"created_at\\\") values (13215, 7082c292-2614-405f-b336-7c092f07ac54, 201, V, 2024-05-27 20:03:01, ?, 2024-06-03 17:05:14, 2024-06-03 17:05:14) returning \\\"id\\\")\",\n \"timestamp\": \"2024-06-03T17:05:14.529562Z\",\n \"path\": \"api/v1/invoices\",\n \"suggestion\": \"Please contact with admin or developer\"\n },\n \"documentation_url\": \"https://google.com/docs/errors\"\n}"}],"_postman_id":"154dcfcf-a0d4-46d5-90d5-01915e798fc4"},{"name":"Invoice","id":"e920a7be-8637-44bb-a7f0-13480bf8fbe4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"customerId","value":"2","type":"text"},{"key":"amount","value":"210.4","type":"text"},{"key":"status","value":"V","type":"text"},{"key":"billedDated","value":"2024-05-27 20:03:01","type":"text"},{"key":"paidDated","value":"","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/invoices/11","description":"

Update Invoice

This endpoint is used to update an existing invoice by sending an HTTP PUT request.

Request Body

customerId (text): The ID of the customer associated with the invoice.
amount (text): The amount of the invoice.
status (text): The status of the invoice.
billedDated (text): The date when the invoice was billed.
paidDated (text): The date when the invoice was paid.

Response

Status: 201
Content-Type: application/json
Body: []

\n","urlObject":{"path":["invoices","11"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[{"id":"b66829ea-17d3-41df-9664-bbc360907948","name":"Error update Invoice","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"customerId","value":"2","type":"text"},{"key":"amount","value":"210.4","type":"text"},{"key":"status","value":"V","type":"text"},{"key":"billedDated","value":"2024-05-27 20:03:01","type":"text"},{"key":"paidDated","value":"","type":"text"}]},"url":"http://127.0.0.1:8000/api/v1/invoices/10"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 03 Jun 2024 17:00:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"statusCode\": 500,\n \"error\": {\n \"code\": 10204,\n \"message\": \"Update was not possible\",\n \"details\": \"Update was not possible, contact with admin.\",\n \"timestamp\": \"2024-06-03T17:00:15.588592Z\",\n \"path\": \"api/v1/invoices/{invoice}\",\n \"suggestion\": \"Please check ID invoice and try again\"\n },\n \"documentation_url\": \"https://google.com/docs/errors\"\n}"}],"_postman_id":"e920a7be-8637-44bb-a7f0-13480bf8fbe4"},{"name":"Invoice","id":"6b496d84-bee4-49e2-a369-48240dcbf484","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"customerId","value":"2","type":"text","disabled":true},{"key":"amount","value":"210.4","type":"text","disabled":true},{"key":"status","value":"P","type":"text"},{"key":"billedDated","value":"2024-05-27 20:03:01","type":"text","disabled":true},{"key":"paidDated","value":"","type":"text","disabled":true}]},"url":"http://127.0.0.1:8000/api/v1/invoices/1093","description":"

Update an invoice.

\n","urlObject":{"path":["invoices","1093"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b496d84-bee4-49e2-a369-48240dcbf484"},{"name":"Bulk invoices","id":"5c439219-69ae-4bb0-89c3-31f6c2d292ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"customerId\": 182,\n \"amount\": \"1\",\n \"status\": \"V\",\n \"billedDated\": \"2024-05-20 19:30:11\",\n \"paidDated\": null\n },\n {\n \"customerId\":182,\n \"amount\": \"11\",\n \"status\": \"V\",\n \"billedDated\": \"2024-05-22 05:13:05\",\n \"paidDated\": null\n },\n {\n \"customerId\": 182,\n \"amount\": \"21.40\",\n \"status\": \"P\",\n \"billedDated\": \"2024-05-27 15:22:28\",\n \"paidDated\": \"2024-05-27 20:03:05\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/v1/invoices/bulk","description":"

Create a multiple invoices.

Only for admin user.

\n","urlObject":{"path":["invoices","bulk"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"5c439219-69ae-4bb0-89c3-31f6c2d292ef"},{"name":"Invoice By Id","id":"8f042401-738e-44e9-a50f-d1f45359940b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/invoices/8","description":"

Delete Invoice

Deletes the invoice with the specified ID.

Only for admin user.

Request

Method: DELETE

Response

Status: 200
Content-Type: application/json

\n","urlObject":{"path":["invoices","8"],"host":["http://127.0.0.1:8000/api/v1"],"query":[],"variable":[]}},"response":[{"id":"9e9871ef-11e5-4462-937f-0187db38bd03","name":"Error delete invoice","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"http://127.0.0.1:8000/api/v1/invoices/7"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"127.0.0.1:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.1.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 03 Jun 2024 17:08:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"57"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"statusCode\": 500,\n \"error\": {\n \"code\": 10104,\n \"message\": \"Store was not possible\",\n \"details\": \"Store was not possible, contact with admin.\",\n \"timestamp\": \"2024-06-03T17:08:11.489277Z\",\n \"path\": \"api/v1/invoices/{invoice}\",\n \"suggestion\": \"Please contact with admin or developer\"\n },\n \"documentation_url\": \"https://google.com/docs/errors\"\n}"}],"_postman_id":"8f042401-738e-44e9-a50f-d1f45359940b"}],"id":"6b197302-db42-4cd1-a090-f40e254fb152","_postman_id":"6b197302-db42-4cd1-a090-f40e254fb152","description":""}],"event":[{"listen":"prerequest","script":{"id":"ceda9f2d-1c94-4a31-9306-9c3bc5f85d3b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"75724b7d-824c-4fdd-8421-a32a99e21f6d","type":"text/javascript","exec":[""]}}],"variable":[{"key":"url","value":"http://127.0.0.1:8000/api/v1","type":"string"},{"key":"auth_token","value":"","type":"string"},{"key":"login_with_admin","value":"true","type":"string"},{"key":"body_user_login","value":"","type":"string"}]}