Contratos

API's Conta Azul Pro (v2)

API para gerenciamento de dados do ERP Conta Azul Pro

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://developers.contaazul.com/_mock/openapi/
Servidor de produção
https://api-public.contaazul.com/

Autenticação

Operations

Baixa

Operations

Cobranças

Operations

Contratos

Operations

Cria um novo contrato

Request

Cria um novo contrato com base nos dados fornecidos.

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

observacoes_pagamentostring

Observações complementares da nota fiscal

Example: "Pagamento à vista"
termosobjectrequired
termos.​tipo_frequenciastringrequired
Enum"MENSAL""ANUAL"
termos.​tipo_expiracaostringrequired
Enum"DATA""NUNCA"
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 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
condicao_pagamentoobjectrequired
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"
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 objectsrequired
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://developers.contaazul.com/_mock/openapi/v1/contratos \
  -H 'Authorization: YOUR_API_KEY_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": "string",
    "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",
      "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

Contrato criado com sucesso

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"
}

Centro de Custo

Operations

Eventos financeiros

Operations

Categorias

Operations

Conta Financeira

Operations

Produto

Operations

Cadastro de Pessoas

Operations

Protocolo

Operations

Venda

Operations

Serviço

Operations