Skip to content
API
/
/v1

Contratos (v1)

API para gerenciamento de contratos

Download OpenAPI description
contracts-apis-openapi.json
contracts-apis-openapi.yaml
Languages
Servers
Servidor de produção

https://api-v2.contaazul.com/

Mock server

https://developers.contaazul.com/_mock/docs/contracts-apis-openapi/

v1

Conjunto de recursos para acompanhar e administrar operações relacionadas a contratos - esses recursos incluem criar um novo contrato e retornar os contratos por filtro

Operations

Criar um novo contrato

Request

Cria um novo contrato com base nos dados fornecidos

Security
BearerAuth
Bodyapplication/jsonrequired
id_clientestring(uuid)required

id do cliente

Example: "123e4567-e89b-12d3-a456-426614174000"
data_emissaostring(date)

Data de emissão

Example: "2021-01-01"
id_categoriastring(uuid)

id da categoria

Example: "123e4567-e89b-12d3-a456-426614174000"
id_centro_custostring(uuid)

id do centro de custo

Example: "123e4567-e89b-12d3-a456-426614174000"
id_vendedorstring(uuid)

id do vendedor

Example: "123e4567-e89b-12d3-a456-426614174000"
observacoesstring

Observações do pagamento

Example: "Pagamento realizado em parcela única."
observacoes_pagamentostring

Observações complementares da nota fiscal

Example: "Pagamento à vista."
termosobject(Termo)required
termos.​tipo_frequenciastringrequired
Enum"MENSAL""ANUAL"
Example: "MENSAL"
termos.​tipo_expiracaostringrequired
Enum"DATA""NUNCA"
Example: "DATA"
termos.​data_iniciostring(date)required

Data de início

Example: "2021-01-01"
termos.​data_fimstring(date)required

Data de fim

Example: "2021-12-31"
termos.​intervalo_frequenciainteger

Intervalo de frequência deve ser sempre maior ou igual a 1

Example: 1
termos.​dia_emissao_vendainteger

Dia de emissão do contrato

Example: 1
termos.​numerointegerrequired

O número do contrato deve ser único

Example: 1
composicao_de_valorobject(ComposicaoDeValor)
condicao_pagamentoobject(CondicaoPagamento)required
condicao_pagamento.​tipo_pagamentostring

Tipo de pagamento

Enum"BOLETO_BANCARIO""CARTAO_CREDITO""CARTAO_DEBITO""CARTEIRA_DIGITAL""CASHBACK""CHEQUE""CREDITO_LOJA""CREDITO_VIRTUAL""DEPOSITO_BANCARIO""DINHEIRO"
Example: "BOLETO_BANCARIO"
condicao_pagamento.​id_conta_financeirastring(uuid)

id da conta financeira

Example: "123e4567-e89b-12d3-a456-426614174000"
condicao_pagamento.​dia_vencimentointegerrequired

Dia de vencimento

Example: 10
condicao_pagamento.​primeira_data_vencimentostring(date)required

Primeira data de vencimento

Example: "2021-01-10"
itensArray of objects(Item)required
itens[].​idstring(uuid)required

id do item

Example: "123e4567-e89b-12d3-a456-426614174000"
itens[].​quantidadeintegerrequired

Quantidade do produto

Example: 10
itens[].​descricaostring

Descrição do produto

Example: "Produto 1"
itens[].​valornumber(double)required

Valor unitário do item

Example: 100
itens[].​valor_custonumber(double)

Valor de custo do item

Example: 100
curl -i -X POST \
  https://api-v2.contaazul.com/v1/contratos \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id_cliente": "123e4567-e89b-12d3-a456-426614174000",
    "data_emissao": "2021-01-01",
    "id_categoria": "123e4567-e89b-12d3-a456-426614174000",
    "id_centro_custo": "123e4567-e89b-12d3-a456-426614174000",
    "id_vendedor": "123e4567-e89b-12d3-a456-426614174000",
    "observacoes": "Pagamento realizado em parcela única.",
    "observacoes_pagamento": "Pagamento à vista.",
    "termos": {
      "tipo_frequencia": "MENSAL",
      "tipo_expiracao": "DATA",
      "data_inicio": "2021-01-01",
      "data_fim": "2021-12-31",
      "intervalo_frequencia": 1,
      "dia_emissao_venda": 1,
      "numero": 1
    },
    "composicao_de_valor": {
      "frete": 10,
      "desconto": {
        "tipo": "PORCENTAGEM",
        "valor": 10
      }
    },
    "condicao_pagamento": {
      "tipo_pagamento": "BOLETO_BANCARIO",
      "id_conta_financeira": "123e4567-e89b-12d3-a456-426614174000",
      "dia_vencimento": 10,
      "primeira_data_vencimento": "2021-01-10"
    },
    "itens": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "quantidade": 10,
        "descricao": "Produto 1",
        "valor": 100,
        "valor_custo": 100
      }
    ]
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)

id do contrato

Example: "123e4567-e89b-12d3-a456-426614174000"
id_legadointeger(int64)

id legado

Example: 1234
id_vendastring(uuid)

id da venda

Example: "6bac0a7f-0422-48a9-86ea-0b1f0a6f9db9"
Response
application/json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "id_legado": 1234,
  "id_venda": "6bac0a7f-0422-48a9-86ea-0b1f0a6f9db9"
}

Retornar os contratos por filtro

Request

Retorna contratos com base nos filtros fornecidos

Security
BearerAuth
Query
paginanumber

Página

Default 1
Example: pagina=1
tamanho_paginanumber

Tamanho da página (máximo 50)

Default 10
Example: tamanho_pagina=10
campo_ordenado_ascendentestring

Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente. É possível ordenar por 'DATA_INICIO' ou 'DATA_FIM'

campo_ordenado_descendentestring

Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não deverá ser informado. É possível ordenar por 'DATA_INICIO' ou 'DATA_FIM'

busca_textualstring

Busca textual por nome

Example: busca_textual=Contrato 1
cliente_idstring(uuid)

id do cliente

data_iniciostring(date)required

Data inicio do intervalo de busca

Example: data_inicio=2026-08-15
data_fimstring(date)required

Data fim do intervalo de busca

Example: data_fim=2027-08-15
curl -i -X GET \
  'https://api-v2.contaazul.com/v1/contratos?pagina=1&tamanho_pagina=10&campo_ordenado_ascendente=string&campo_ordenado_descendente=string&busca_textual=Contrato+1&cliente_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&data_inicio=2026-08-15&data_fim=2027-08-15' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
itens_totaisinteger
Example: 6
itemsArray of objects(ListagemContratoItemResponse)
Response
application/json
{
  "itens_totais": 6,
  "items": [
    { … }
  ]
}