Criar um prazo

curl --request POST \
  --url http://localhost:4005/v1/deadlines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "color": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "frequency": "<string>",
  "name": "<string>",
  "type": "<string>",
  "active": true,
  "description": "<string>",
  "monthsOfYear": [
    123
  ],
  "notifyDaysBefore": 123,
  "templateId": "<string>"
}
'

import requests

url = "http://localhost:4005/v1/deadlines"

payload = {
    "color": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "frequency": "<string>",
    "name": "<string>",
    "type": "<string>",
    "active": True,
    "description": "<string>",
    "monthsOfYear": [123],
    "notifyDaysBefore": 123,
    "templateId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    color: '<string>',
    dueDate: '2023-11-07T05:31:56Z',
    frequency: '<string>',
    name: '<string>',
    type: '<string>',
    active: true,
    description: '<string>',
    monthsOfYear: [123],
    notifyDaysBefore: 123,
    templateId: '<string>'
  })
};

fetch('http://localhost:4005/v1/deadlines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "4005",
  CURLOPT_URL => "http://localhost:4005/v1/deadlines",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'color' => '<string>',
    'dueDate' => '2023-11-07T05:31:56Z',
    'frequency' => '<string>',
    'name' => '<string>',
    'type' => '<string>',
    'active' => true,
    'description' => '<string>',
    'monthsOfYear' => [
        123
    ],
    'notifyDaysBefore' => 123,
    'templateId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:4005/v1/deadlines"

	payload := strings.NewReader("{\n  \"color\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:4005/v1/deadlines")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"color\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:4005/v1/deadlines")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"color\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "active": true,
  "color": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "deliveredAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "frequency": "<string>",
  "id": "<string>",
  "monthsOfYear": [
    123
  ],
  "name": "<string>",
  "notifyDaysBefore": 123,
  "status": "<string>",
  "templateId": "<string>",
  "templateName": "<string>",
  "type": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

POST

deadlines

Criar um prazo

curl --request POST \
  --url http://localhost:4005/v1/deadlines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "color": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "frequency": "<string>",
  "name": "<string>",
  "type": "<string>",
  "active": true,
  "description": "<string>",
  "monthsOfYear": [
    123
  ],
  "notifyDaysBefore": 123,
  "templateId": "<string>"
}
'

import requests

url = "http://localhost:4005/v1/deadlines"

payload = {
    "color": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "frequency": "<string>",
    "name": "<string>",
    "type": "<string>",
    "active": True,
    "description": "<string>",
    "monthsOfYear": [123],
    "notifyDaysBefore": 123,
    "templateId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    color: '<string>',
    dueDate: '2023-11-07T05:31:56Z',
    frequency: '<string>',
    name: '<string>',
    type: '<string>',
    active: true,
    description: '<string>',
    monthsOfYear: [123],
    notifyDaysBefore: 123,
    templateId: '<string>'
  })
};

fetch('http://localhost:4005/v1/deadlines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "4005",
  CURLOPT_URL => "http://localhost:4005/v1/deadlines",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'color' => '<string>',
    'dueDate' => '2023-11-07T05:31:56Z',
    'frequency' => '<string>',
    'name' => '<string>',
    'type' => '<string>',
    'active' => true,
    'description' => '<string>',
    'monthsOfYear' => [
        123
    ],
    'notifyDaysBefore' => 123,
    'templateId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:4005/v1/deadlines"

	payload := strings.NewReader("{\n  \"color\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:4005/v1/deadlines")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"color\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:4005/v1/deadlines")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"color\": \"<string>\",\n  \"dueDate\": \"2023-11-07T05:31:56Z\",\n  \"frequency\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"active\": true,\n  \"description\": \"<string>\",\n  \"monthsOfYear\": [\n    123\n  ],\n  \"notifyDaysBefore\": 123,\n  \"templateId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "active": true,
  "color": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "deliveredAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "frequency": "<string>",
  "id": "<string>",
  "monthsOfYear": [
    123
  ],
  "name": "<string>",
  "notifyDaysBefore": 123,
  "status": "<string>",
  "templateId": "<string>",
  "templateName": "<string>",
  "type": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Esses endpoints permitem o gerenciamento de prazos no Console. Você também pode chamá-los diretamente para integrar prazos aos seus próprios sistemas.

Autorizações

Authorization

string

header

obrigatório

Token bearer JWT emitido pelo provedor de identidade.

Corpo

application/json

Payload JSON da requisição.

color

string

obrigatório

Cor hexadecimal usada para identificar o prazo.

Exemplo:

"#FF5733"

dueDate

string<date-time>

obrigatório

Data e hora de vencimento do prazo.

Exemplo:

"2026-03-31T23:59:59Z"

frequency

string

obrigatório

Frequência de recorrência do prazo.

Exemplo:

"monthly"

name

string

obrigatório

Nome legível do prazo.

Exemplo:

"Monthly Regulatory Report"

type

string

obrigatório

Categoria do prazo.

Exemplo:

"regulatory"

active

boolean

Se o prazo está ativo.

Exemplo:

true

description

string

Descrição opcional do prazo.

Exemplo:

"Monthly regulatory compliance report"

monthsOfYear

integer<int64>[] | null

Meses em que ocorre um prazo semestral ou anual.

Exemplo:

[1, 6]

notifyDaysBefore

integer<int64>

Quantidade de dias antes da data de vencimento em que as notificações começam.

Exemplo:

5

templateId

string

Template usado para gerar o relatório do prazo.

Exemplo:

"00000000-0000-0000-0000-000000000001"

Resposta

Criado

active

boolean

Se o prazo está ativo.

Exemplo:

true

color

string

Cor hexadecimal usada para identificar o prazo.

Exemplo:

"#FF5733"

createdAt

string<date-time>

Data e hora em que o prazo foi criado.

Exemplo:

"2026-01-01T00:00:00Z"

deliveredAt

string<date-time>

Data e hora em que o prazo foi entregue.

Exemplo:

"2026-03-15T10:00:00Z"

description

string

Descrição opcional do prazo.

Exemplo:

"Monthly regulatory compliance report"

dueDate

string<date-time>

Data e hora de vencimento do prazo.

Exemplo:

"2026-03-31T23:59:59Z"

frequency

string

Frequência de recorrência do prazo.

Exemplo:

"monthly"

string

Identificador único do prazo.

Exemplo:

"00000000-0000-0000-0000-000000000000"

monthsOfYear

integer<int64>[] | null

Meses em que ocorre um prazo semestral ou anual.

Exemplo:

[1, 6]

name

string

Nome legível do prazo.

Exemplo:

"Monthly Regulatory Report"

notifyDaysBefore

integer<int64>

Quantidade de dias antes da data de vencimento em que as notificações começam.

Exemplo:

5

status

string

Status derivado atual do prazo.

Exemplo:

"pending"

templateId

string

Template usado para gerar o relatório.

Exemplo:

"00000000-0000-0000-0000-000000000000"

templateName

string

Nome legível do template associado.

Exemplo:

"Financial Template"

type

string

Categoria do prazo.

Exemplo:

"regulatory"

updatedAt

string<date-time>

Data e hora da última atualização do prazo.

Exemplo:

"2026-01-01T00:00:00Z"

Baixar um relatório

Listar prazos

⌘I

Primeiros passos

API de Templates

API do Construtor de Templates

API de Relatórios

API de Prazos

API de Fontes de Dados

API de Métricas

API de Streaming

Tratamento de erros

Criar um prazo

Autorizações

Corpo

Resposta