Administração · Referência

Modelos de Contrato

Modelos (templates HTML) usados para gerar contratos de aluguel e venda, com histórico de versões. Somente leitura (texto jurídico).

Permissão: modelos_contratoAções: lerglobal (sem carteira)

GET/v1/modelos_contratoListar GET/v1/modelos_contrato/{id}Detalhar GET/v1/modelos_contrato/{id}/versoesRelação: Versões de modelo de contrato

O objeto modelos de contrato

Campo	Tipo	Descrição
`id`	inteiro	Identificador	ordenar
`type`	texto	type	filtro
`name`	texto	Nome	ordenar
`html`	texto	html
`updated_by`	inteiro	updated by
`updated_at`	data-hora	Atualizado em	ordenar
`created_at`	data-hora	Criado em

Exemplo do objeto200 OK

{
    "id": 1024,
    "type": "carro",
    "name": "Maria Fernanda Souza",
    "html": "texto",
    "updated_by": 1,
    "updated_at": "2026-10-08T14:30:00-03:00",
    "created_at": "2026-10-08T14:30:00-03:00"
}

GET Listar

Retorna os registros paginados, do mais recente para o mais antigo (padrão). Requer Ler.

Parâmetros de consulta

Parâmetro	Tipo	Descrição
`pagina`	inteiro	Página (padrão 1)
`por_pagina`	inteiro	1 a 200 (padrão 50)
`ordenar`	texto	Aceita: `id`, `name`, `updated_at` — prefixo `-` para decrescente
`campos`	texto	Lista de campos do objeto, separados por vírgula
`q`	texto	Busca em: `name`, `type`
`type`	texto	type — valor exato ou lista separada por vírgula
`criado_desde` / `criado_ate`	data	Período de criação
`atualizado_desde`	data-hora	Criados ou alterados desde (pela coluna de atualização)
`incluir`	texto	Só no detalhe. Relações: `versoes`

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/modelos_contrato?por_pagina=20" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/modelos_contrato?por_pagina=20');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/modelos_contrato?por_pagina=20', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/modelos_contrato?por_pagina=20",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": [
        {
            "id": 1024,
            "type": "carro",
            "name": "Maria Fernanda Souza",
            "html": "texto",
            "updated_by": 1,
            "updated_at": "2026-10-08T14:30:00-03:00",
            "created_at": "2026-10-08T14:30:00-03:00"
        }
    ],
    "meta": {
        "total": 1,
        "pagina": 1,
        "por_pagina": 20,
        "paginas": 1
    },
    "request_id": "req_0f1e2d3c4b5a69788796"
}

GET Detalhar

Retorna um registro pelo id. Requer Ler.

Use incluir para embutir relações (cada uma exige Ler no módulo relacionado).

Erro	Quando
`404 nao_encontrado`	Não existe ou está fora das carteiras da chave
`403 permissao_negada`	Sem Ler no módulo (ou numa relação pedida)

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/modelos_contrato/1024?incluir=versoes" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/modelos_contrato/1024?incluir=versoes');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/modelos_contrato/1024?incluir=versoes', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/modelos_contrato/1024?incluir=versoes",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "type": "carro",
        "name": "Maria Fernanda Souza",
        "html": "texto",
        "updated_by": 1,
        "updated_at": "2026-10-08T14:30:00-03:00",
        "created_at": "2026-10-08T14:30:00-03:00"
    },
    "request_id": "req_1d2c3b4a5f6e7d8c9b0a"
}

Relações

Nome	Módulo	Retorno	Rota
`versoes`	Versões de modelo de contrato	lista paginada	`/v1/modelos_contrato/{id}/versoes`

Recursos incluídos neste módulo

Estes recursos usam a mesma permissão de Modelos de Contrato:

Rota	Recurso	Descrição	Campos
`/v1/modelos_contrato_versoes`	Versões de modelo de contrato	Histórico de alterações dos modelos de contrato.	`id`, `template_id`, `html`, `changed_by`, `changed_at`