Introduction

Base URL: http://plantilla.test

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

This API is not authenticated.

Endpoints

GET api/user

Example request:

curl --request GET \
    --get "http://plantilla.test/api/user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/user"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=()
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "http://plantilla.test/api/v1/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\",
    \"password\": \"architecto\",
    \"device_name\": \"architecto\"
}"

const url = new URL(
    "http://plantilla.test/api/v1/auth/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "gbailey@example.net",
    "password": "architecto",
    "device_name": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/auth/login

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

email string

validation.email. Example: gbailey@example.net

password string

Example: architecto

device_name string optional

Example: architecto

POST api/v1/auth/logout

Example request:

curl --request POST \
    "http://plantilla.test/api/v1/auth/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/auth/logout"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/auth/me

Example request:

curl --request GET \
    --get "http://plantilla.test/api/v1/auth/me" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/auth/me"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=()
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/profile

Example request:

curl --request GET \
    --get "http://plantilla.test/api/v1/profile" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/profile"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=()
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

PUT api/v1/profile/password

Example request:

curl --request PUT \
    "http://plantilla.test/api/v1/profile/password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"current_password\": \"architecto\",
    \"password\": \"architecto\"
}"

const url = new URL(
    "http://plantilla.test/api/v1/profile/password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "current_password": "architecto",
    "password": "architecto"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/v1/profile/password

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

current_password string

Example: architecto

password string

Example: architecto

DELETE api/v1/profile

Example request:

curl --request DELETE \
    "http://plantilla.test/api/v1/profile" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"architecto\"
}"

const url = new URL(
    "http://plantilla.test/api/v1/profile"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "password": "architecto"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/dashboard/kpi

Example request:

curl --request GET \
    --get "http://plantilla.test/api/v1/dashboard/kpi" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/dashboard/kpi"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=()
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/company

Example request:

curl --request GET \
    --get "http://plantilla.test/api/v1/company" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/company"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=()
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

PUT api/v1/company

Example request:

curl --request PUT \
    "http://plantilla.test/api/v1/company" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"business_name\": \"b\",
    \"rif\": \"ngzmiyvdljnikhwa\",
    \"trade_name\": \"y\",
    \"email\": \"gilbert32@example.com\",
    \"address\": \"architecto\",
    \"phone_primary\": \"ngzmiyvdljnikhwa\",
    \"phone_secondary\": \"ykcmyuwpwlvqwrsi\",
    \"city\": \"t\",
    \"state\": \"c\",
    \"zip_code\": \"pscqldzsnrwtujwv\",
    \"currency_symbol\": \"l\",
    \"currency_iso\": \"x\",
    \"exchange_rate\": 48,
    \"tax_rate\": 75,
    \"igtf_rate\": 50
}"

const url = new URL(
    "http://plantilla.test/api/v1/company"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "business_name": "b",
    "rif": "ngzmiyvdljnikhwa",
    "trade_name": "y",
    "email": "gilbert32@example.com",
    "address": "architecto",
    "phone_primary": "ngzmiyvdljnikhwa",
    "phone_secondary": "ykcmyuwpwlvqwrsi",
    "city": "t",
    "state": "c",
    "zip_code": "pscqldzsnrwtujwv",
    "currency_symbol": "l",
    "currency_iso": "x",
    "exchange_rate": 48,
    "tax_rate": 75,
    "igtf_rate": 50
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/v1/company

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

business_name string

validation.max. Example: b

rif string

validation.max. Example: ngzmiyvdljnikhwa

trade_name string optional

validation.max. Example: y

email string optional

validation.email validation.max. Example: gilbert32@example.com

address string optional

Example: architecto

phone_primary string optional

validation.max. Example: ngzmiyvdljnikhwa

phone_secondary string optional

validation.max. Example: ykcmyuwpwlvqwrsi

city string optional

validation.max. Example: t

state string optional

validation.max. Example: c

zip_code string optional

validation.max. Example: pscqldzsnrwtujwv

currency_symbol string optional

validation.max. Example: l

currency_iso string optional

validation.max. Example: x

exchange_rate number optional

validation.min. Example: 48

tax_rate number optional

validation.min. Example: 75

igtf_rate number optional

validation.min. Example: 50

GET api/v1/company/license

Example request:

curl --request GET \
    --get "http://plantilla.test/api/v1/company/license" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/company/license"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=()
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

PUT api/v1/company/license

Example request:

curl --request PUT \
    "http://plantilla.test/api/v1/company/license" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"license_key\": \"architecto\"
}"

const url = new URL(
    "http://plantilla.test/api/v1/company/license"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "license_key": "architecto"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/users/roles

Example request:

curl --request GET \
    --get "http://plantilla.test/api/v1/users/roles" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/users/roles"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=()
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/users

Example request:

curl --request GET \
    --get "http://plantilla.test/api/v1/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/users"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=()
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v1/users

Example request:

curl --request POST \
    "http://plantilla.test/api/v1/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"email\": \"zbailey@example.net\",
    \"password\": \"-0pBNvYgxw\"
}"

const url = new URL(
    "http://plantilla.test/api/v1/users"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "b",
    "email": "zbailey@example.net",
    "password": "-0pBNvYgxw"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/users

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

name string

validation.max. Example: b

email string

validation.email validation.max. Example: zbailey@example.net

password string

validation.min. Example: -0pBNvYgxw

roles string[] optional

The name of an existing record in the roles table.

GET api/v1/users/{id}

Example request:

curl --request GET \
    --get "http://plantilla.test/api/v1/users/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/users/1"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=()
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

DELETE api/v1/users/{id}

Example request:

curl --request DELETE \
    "http://plantilla.test/api/v1/users/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/users/1"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/roles/permissions

Example request:

curl --request GET \
    --get "http://plantilla.test/api/v1/roles/permissions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/roles/permissions"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=()
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/roles

Example request:

curl --request GET \
    --get "http://plantilla.test/api/v1/roles" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/roles"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=()
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v1/roles

Example request:

curl --request POST \
    "http://plantilla.test/api/v1/roles" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\"
}"

const url = new URL(
    "http://plantilla.test/api/v1/roles"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "b"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/roles

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

name string

validation.max. Example: b

permissions string[] optional

The name of an existing record in the permissions table.

GET api/v1/roles/{id}

Example request:

curl --request GET \
    --get "http://plantilla.test/api/v1/roles/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/roles/1"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=()
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

DELETE api/v1/roles/{id}

Example request:

curl --request DELETE \
    "http://plantilla.test/api/v1/roles/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/roles/1"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

GET api/v1/report-configs

Example request:

curl --request GET \
    --get "http://plantilla.test/api/v1/report-configs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/report-configs"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=()
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

POST api/v1/report-configs

Example request:

curl --request POST \
    "http://plantilla.test/api/v1/report-configs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"is_default\": false,
    \"header_logo\": \"n\",
    \"header_show_logo\": true,
    \"header_title\": \"g\",
    \"header_text_align\": \"center\",
    \"footer_show_phone\": false,
    \"footer_show_email\": false,
    \"footer_show_page_number\": true,
    \"footer_show_print_date\": false,
    \"footer_show_control_number\": false,
    \"footer_text\": \"z\",
    \"margin_top\": 17,
    \"margin_bottom\": 15,
    \"font_size\": 1,
    \"print_format\": \"A4\",
    \"control_number_prefix\": \"vdljnikhwaykcmyu\",
    \"control_number_reset\": \"monthly\"
}"

const url = new URL(
    "http://plantilla.test/api/v1/report-configs"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "b",
    "is_default": false,
    "header_logo": "n",
    "header_show_logo": true,
    "header_title": "g",
    "header_text_align": "center",
    "footer_show_phone": false,
    "footer_show_email": false,
    "footer_show_page_number": true,
    "footer_show_print_date": false,
    "footer_show_control_number": false,
    "footer_text": "z",
    "margin_top": 17,
    "margin_bottom": 15,
    "font_size": 1,
    "print_format": "A4",
    "control_number_prefix": "vdljnikhwaykcmyu",
    "control_number_reset": "monthly"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST api/v1/report-configs

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

name string

validation.max. Example: b

is_default boolean optional true false

Example: false

header_logo string optional

validation.max. Example: n

header_show_logo boolean optional true false

Example: true

header_title string optional

validation.max. Example: g

header_text_align string optional

Example: center

Must be one of:

left
center
right

footer_show_phone boolean optional true false

Example: false

footer_show_email boolean optional true false

Example: false

footer_show_page_number boolean optional true false

Example: true

footer_show_print_date boolean optional true false

Example: false

footer_show_control_number boolean optional true false

Example: false

footer_text string optional

validation.max. Example: z

margin_top number optional

validation.min validation.max. Example: 17

margin_bottom number optional

validation.min validation.max. Example: 15

font_size integer optional

validation.min validation.max. Example: 1

print_format string optional

Example: A4

Must be one of:

PDF
A4
Letter

control_number_prefix string optional

validation.max. Example: vdljnikhwaykcmyu

control_number_reset string optional

Example: monthly

Must be one of:

never
yearly
monthly

GET api/v1/report-configs/{id}

Example request:

curl --request GET \
    --get "http://plantilla.test/api/v1/report-configs/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/report-configs/16"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
x-content-type-options: nosniff
x-frame-options: DENY
x-xss-protection: 1; mode=block
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
permissions-policy: geolocation=(), microphone=(), camera=()
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

PUT api/v1/report-configs/{id}

Example request:

curl --request PUT \
    "http://plantilla.test/api/v1/report-configs/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"is_default\": true,
    \"header_logo\": \"n\",
    \"header_show_logo\": true,
    \"header_title\": \"g\",
    \"header_text_align\": \"right\",
    \"footer_show_phone\": true,
    \"footer_show_email\": true,
    \"footer_show_page_number\": false,
    \"footer_show_print_date\": false,
    \"footer_show_control_number\": true,
    \"footer_text\": \"z\",
    \"margin_top\": 17,
    \"margin_bottom\": 15,
    \"font_size\": 1,
    \"print_format\": \"A4\",
    \"control_number_prefix\": \"vdljnikhwaykcmyu\",
    \"control_number_reset\": \"never\"
}"

const url = new URL(
    "http://plantilla.test/api/v1/report-configs/16"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "b",
    "is_default": true,
    "header_logo": "n",
    "header_show_logo": true,
    "header_title": "g",
    "header_text_align": "right",
    "footer_show_phone": true,
    "footer_show_email": true,
    "footer_show_page_number": false,
    "footer_show_print_date": false,
    "footer_show_control_number": true,
    "footer_text": "z",
    "margin_top": 17,
    "margin_bottom": 15,
    "font_size": 1,
    "print_format": "A4",
    "control_number_prefix": "vdljnikhwaykcmyu",
    "control_number_reset": "never"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT api/v1/report-configs/{id}

PATCH api/v1/report-configs/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The ID of the report config. Example: 16

Body Parameters

name string

validation.max. Example: b

is_default boolean optional true false

Example: true

header_logo string optional

validation.max. Example: n

header_show_logo boolean optional true false

Example: true

header_title string optional

validation.max. Example: g

header_text_align string optional

Example: right

Must be one of:

left
center
right

footer_show_phone boolean optional true false

Example: true

footer_show_email boolean optional true false

Example: true

footer_show_page_number boolean optional true false

Example: false

footer_show_print_date boolean optional true false

Example: false

footer_show_control_number boolean optional true false

Example: true

footer_text string optional

validation.max. Example: z

margin_top number optional

validation.min validation.max. Example: 17

margin_bottom number optional

validation.min validation.max. Example: 15

font_size integer optional

validation.min validation.max. Example: 1

print_format string optional

Example: A4

Must be one of:

PDF
A4
Letter

control_number_prefix string optional

validation.max. Example: vdljnikhwaykcmyu

control_number_reset string optional

Example: never

Must be one of:

never
yearly
monthly

DELETE api/v1/report-configs/{id}

Example request:

curl --request DELETE \
    "http://plantilla.test/api/v1/report-configs/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://plantilla.test/api/v1/report-configs/16"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Introduction

Authenticating requests

Endpoints

GET api/user

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

POST api/v1/auth/login

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/v1/auth/logout

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/v1/auth/me

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/v1/profile

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

PUT api/v1/profile/password

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

DELETE api/v1/profile

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

GET api/v1/dashboard/kpi

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/v1/company

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

PUT api/v1/company

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

GET api/v1/company/license

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

PUT api/v1/company/license

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

GET api/v1/users/roles

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/v1/users

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

POST api/v1/users

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

GET api/v1/users/{id}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

DELETE api/v1/users/{id}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

GET api/v1/roles/permissions

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/v1/roles

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

POST api/v1/roles

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

GET api/v1/roles/{id}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

DELETE api/v1/roles/{id}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request