Criar um novo contrato

Contratos

Request

Permite criar um novo contrato, definindo as informações necessárias para configuração da recorrência, como período, produtos/serviços vinculados e demais parâmetros do contrato.

Security

BearerAuth

Bodyapplication/jsonrequired

Dados para criar o contrato

composicao_de_valorobject(CriarComposicaoValorContrato)

Composição dos valores da venda, incluindo frete e desconto

condicao_pagamentoobject(CriarCondicaoPagamentoContrato)required

Condição de pagamento do contrato

id_categoriastring

ID da categoria

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

id_centro_custostring

ID do centro de custo

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

id_clientestringrequired

ID do cliente associado ao contrato

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

id_vendedorstring

ID do vendedor responsável pelo contrato

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

itensArray of objects, non-empty(CriarItemVendaContrato)required

Lista de itens do contrato

observacoesstring

Observações gerais sobre o contrato

Example:"Cliente solicitou entrega rápida"

observacoes_pagamentostring

Observações específicas para a emissão da nota fiscal

Example:"Pagamento realizado em 3 parcelas"

termosobject(CriarTermosContrato)required

Termos de recorrência da venda agendada

curl -i -X POST \
  https://api-v2.contaazul.com/v1/contratos \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "composicao_de_valor": {
      "desconto": {
        "tipo": "VALOR",
        "valor": 5
      },
      "frete": 15
    },
    "condicao_pagamento": {
      "dia_vencimento": 10,
      "id_conta_financeira": "123e4567-e89b-12d3-a456-426614174000",
      "primeira_data_vencimento": "2025-01-10",
      "tipo_pagamento": "BOLETO_BANCARIO"
    },
    "id_categoria": "123e4567-e89b-12d3-a456-426614174000",
    "id_centro_custo": "123e4567-e89b-12d3-a456-426614174000",
    "id_cliente": "123e4567-e89b-12d3-a456-426614174000",
    "id_vendedor": "123e4567-e89b-12d3-a456-426614174000",
    "itens": [
      {
        "descricao": "Produto A",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "quantidade": 2,
        "valor": 100.5,
        "valor_custo": 80
      }
    ],
    "observacoes": "Cliente solicitou entrega rápida",
    "observacoes_pagamento": "Pagamento realizado em 3 parcelas",
    "termos": {
      "data_fim": "2025-12-31",
      "data_inicio": "2025-01-01",
      "dia_emissao_venda": 5,
      "intervalo_frequencia": 1,
      "numero": 12,
      "tipo_expiracao": "DATA",
      "tipo_frequencia": "MENSAL"
    }
  }'

Responses

Created

Bodyapplication/json

idstring

ID do contrato

Example:"550e8400-e29b-41d4-a716-446655440000"

id_legadointeger

ID legado do contrato

Example:12345

id_vendastring

ID da venda gerada pelo contrato

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

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "id_legado": 12345,
  "id_venda": "123e4567-e89b-12d3-a456-426614174000"
}