API's Conta Azul Pro (v2)

API para gerenciamento de dados do ERP Conta Azul Pro

Download OpenAPI description

openapi.json

openapi.yaml

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

Centro de Custo

Operations

Eventos financeiros

Operations

Categorias

Operations

Conta Financeira

Operations

Produto

Operations

Cadastro de Pessoas

Operations

Protocolo

Operations

Venda

Operations

Obter venda por ID

Request

Path

idstringrequired

O legacy ID ou UUID da venda a ser obtida

curl -i -X GET \
  'https://developers.contaazul.com/_mock/openapi/v1/venda/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Venda obtida com sucesso

Bodyapplication/json

clienteobject

evento_financeiroobject

notificacaoobject

natureza_operacaoobject

vendaobject

Response

application/json

{
  "cliente": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "tipo_pessoa": "Física",
    "documento": "12345678901",
    "nome": "João da Silva"
  },
  "evento_financeiro": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "notificacao": {
    "id_referencia": "string",
    "enviado_para": "string",
    "enviado_em": "2019-08-24T14:15:22Z",
    "aberto_em": "2019-08-24T14:15:22Z",
    "status": "ENVIADO"
  },
  "natureza_operacao": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "tipo_operacao": "VENDA",
    "template_operacao": "VENDA_MERCADORIAS",
    "label": "Venda a Não Contribuinte",
    "mudanca_financeira": true,
    "mudanca_estoque": "ENTRADA_ESTOQUE"
  },
  "venda": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "status": "REVISAO_PENDENTE",
    "id_legado": 0,
    "tipo_negociacao": "VENDA",
    "numero": 0,
    "id_categoria": "28aae0b9-0a40-4479-baff-3cbc83721b20",
    "data_compromisso": "2023-12-31",
    "configuracao_de_desconto": { … },
    "composicao_valor": { … },
    "condicao_pagamento": { … },
    "total_itens": { … },
    "observacoes": "string",
    "id_cliente": "2887ff7c-e8dc-4cd4-bd04-a5554a71c2de",
    "versao": 0,
    "tipo_pendencia": { … },
    "situacao": { … },
    "id_natureza_operacao": "df1c7a86-2b48-437c-b768-057e089cdcd2",
    "id_centro_custo": "51474982-bf91-4e21-81d5-2212e04a543c"
  }
}

Edição de venda por ID

Request

Path

idstringrequired

O UUID da venda a ser editada

Bodyapplication/jsonrequired

id_clientestring(uuid)required

UUID do cliente

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

numerointegerrequired

Número da venda

Example: 1

data_vendastring(date)required

Data da venda

Example: "2023-12-31"

situacaostringrequired

Situação da venda

Enum"EM_ANDAMENTO""APROVADO""FATURADO""CANCELADO""PROPOSTA_EM_ANDAMENTO""PROPOSTA_APROVADA""PROPOSTA_RECUSADA""CONTRATO""VENDA"

observacoesstring

Observações sobre a venda

Example: "Cliente solicitou entrega rápida"

observacoes_pagamentostring

Observações sobre o pagamento

Example: "Pagamento realizado em 3 parcelas"

id_natureza_operacaostring(uuid)

ID da natureza da operação

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

versaointegerrequired

Versão da venda é obrigatório na edição.

Example: 1

itensobjectrequired

itens.descricaostring

Descrição do item da venda

Example: "Produto A"

itens.quantidadenumber(double)required

Quantidade do item da venda

Example: 2

itens.valornumber(double)required

Valor do item da venda

Example: 50

itens.idstring(uuid)required

ID do item da venda

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

itens.valor_custonumber(double)

Valor de custo do item da venda.

Example: 40

composicao_de_valorobject

condicao_pagamentoobjectrequired

condicao_pagamento.tipo_pagamentostring

Forma de pagamento

Enum"BOLETO_BANCARIO""CARTAO_CREDITO""CARTAO_DEBITO""CARTEIRA_DIGITAL""CASHBACK""CHEQUE""CREDITO_LOJA""CREDITO_VIRTUAL""DEPOSITO_BANCARIO""DINHEIRO"

Example: "CARTAO_CREDITO"

condicao_pagamento.id_conta_financeirastring(uuid)

ID da conta financeira

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

condicao_pagamento.opcao_condicao_pagamentostringrequired

Deve ser em um dos três formatos: - 1º: Ex: À vista. - 2º: Ex1: 30, 60, 90. Ex2: 15, 30, 45. - 3º: Ex1: 3x. Ex2: 12x

Example: "À vista"

condicao_pagamento.nsustring

NSU

Example: "1234567890"

condicao_pagamento.parcelasArray of objectsrequired

condicao_pagamento.parcelas[].data_vencimentostring(date)required

Data de vencimento

Example: "2023-12-31"

condicao_pagamento.parcelas[].valornumber(double)required

Valor da parcela

Example: 100

condicao_pagamento.parcelas[].descricaostring

Descrição da parcela

Example: "Parcela 1"

curl -i -X PUT \
  'https://developers.contaazul.com/_mock/openapi/v1/venda/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id_cliente": "550e8400-e29b-41d4-a716-446655440000",
    "numero": 1,
    "data_venda": "2023-12-31",
    "situacao": "EM_ANDAMENTO",
    "observacoes": "Cliente solicitou entrega rápida",
    "observacoes_pagamento": "Pagamento realizado em 3 parcelas",
    "id_natureza_operacao": "550e8400-e29b-41d4-a716-446655440000",
    "versao": 1,
    "itens": {
      "descricao": "Produto A",
      "quantidade": 2,
      "valor": 50,
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "valor_custo": 40
    },
    "composicao_de_valor": {
      "frete": 100,
      "desconto": {
        "tipo": "PORCENTAGEM",
        "valor": 5
      }
    },
    "condicao_pagamento": {
      "tipo_pagamento": "CARTAO_CREDITO",
      "id_conta_financeira": "550e8400-e29b-41d4-a716-446655440000",
      "opcao_condicao_pagamento": "À vista",
      "nsu": "1234567890",
      "parcelas": [
        {
          "data_vencimento": "2023-12-31",
          "valor": 100,
          "descricao": "Parcela 1"
        }
      ]
    }
  }'

Responses

Venda editada com sucesso

Bodyapplication/json

idstring(uuid)

UUID da venda editada

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

id_legadointeger

ID legado

Example: 123456

Response

application/json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "id_legado": 123456
}

Listar vendas por filtros

Request

Query

paginainteger

Default 1

tamanho_paginainteger

Default 10

campo_ordenado_ascendentestring

Se este campo for utilizado, o parâmetro campo_ordenado_descendente será desconsiderado. É possível ordenar por numero da venda, pelo nome do cliente, pelo total da venda ou pela data da venda.

campo_ordenado_descendentestring

Para utilizar este campo, é necessário não utilizar o campo_ordenado_ascendente. É possível ordenar por numero da venda, pelo nome do cliente, pelo total da venda ou pela data da venda.

Bodyapplication/jsonrequired

termo_buscastring

Termo para busca das vendas por nome, email do cliente ou número da venda.

periodoobject

ids_donosArray of strings(uuid)

IDs dos donos

ids_clientesArray of strings(uuid)

IDs dos clientes

ids_natureza_operacaoArray of strings(uuid)

IDs da natureza da operação. Possíveis valores IN_PROCESS, APPROVED, INVOICED, CANCELED, PROPOSAL, PROPOSAL_ACCEPTED, PROPOSAL_REFUSED, SCHEDULED, COMMITED

situacoesArray of strings

Situações

tiposArray of strings

Tipos de venda

origensArray of strings

Origens

numerosArray of integers

Números

ids_categoriasArray of strings(uuid)

IDs das categorias

ids_produtosArray of strings(uuid)

IDs dos produtos

pendenteboolean

Pendente

totaisstring

Tipo de total de venda. Possíveis valores WAITING_APPROVED, APPROVED, CANCELED e ALL

ids_legado_donosArray of integers

IDs legados dos donos

ids_legado_clientesArray of integers

IDs legados das categorias

ids_legado_produtosArray of integers

IDs legados dos produtos

ids_legado_categoriasArray of integers

IDs legados dos clientes

curl -i -X POST \
  'https://developers.contaazul.com/_mock/openapi/v1/venda/busca?campo_ordenado_ascendente=string&campo_ordenado_descendente=string&pagina=1&tamanho_pagina=10' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "termo_busca": "string",
    "periodo": {
      "data_inicio": "2019-08-24",
      "data_fim": "2019-08-24"
    },
    "ids_donos": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "ids_clientes": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "ids_natureza_operacao": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "situacoes": [
      "string"
    ],
    "tipos": [
      "string"
    ],
    "origens": [
      "string"
    ],
    "numeros": [
      0
    ],
    "ids_categorias": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "ids_produtos": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "pendente": true,
    "totais": "string",
    "ids_legado_donos": [
      0
    ],
    "ids_legado_clientes": [
      0
    ],
    "ids_legado_produtos": [
      0
    ],
    "ids_legado_categorias": [
      0
    ]
  }'

Responses

Lista de vendas obtida com sucesso

Bodyapplication/json

totaisobject

Valores das de vendas com status Aprovado, Cancelado, Esperando aprovação e Total

quantidadesobject

Quantidades de vendas com status Aprovado, Cancelado, Esperando aprovação e Total

total_itensinteger

Total de itens

itensArray of objects

Response

application/json

{
  "totais": {
    "total": 0.1,
    "aprovado": 0.1,
    "cancelado": 0.1,
    "esperando_aprovacao": 0.1
  },
  "quantidades": {
    "total": 0.1,
    "aprovado": 0.1,
    "cancelado": 0.1,
    "esperando_aprovacao": 0.1
  },
  "total_itens": 0,
  "itens": [
    { … }
  ]
}

Criar uma nova venda

Request

Bodyapplication/jsonrequired

id_clientestring(uuid)required

ID do cliente

numerointeger(int64)required

Número da venda

situacaostringrequired

Situação da venda

Enum"EM_ANDAMENTO""APROVADO""FATURADO"

data_vendastring(date)required

Data da venda

id_categoriastring(uuid)

ID da categoria

id_centro_custostring(uuid)

ID do centro de custo

observacoesstring

Observações sobre a venda

observacoes_pagamentostring

Observações sobre o pagamento

itensArray of objectsrequired

itens[].descricaostring

Descrição do item da venda

Example: "Produto A"

itens[].quantidadenumber(double)required

Quantidade do item da venda

Example: 2

itens[].valornumber(double)required

Valor do item da venda

Example: 50

itens[].idstring(uuid)required

ID do item da venda

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

itens[].valor_custonumber(double)

Valor de custo do item da venda.

Example: 40

composicao_de_valorobject

condicao_pagamentoobjectrequired

condicao_pagamento.tipo_pagamentostring

Forma de pagamento

Enum"BOLETO_BANCARIO""CARTAO_CREDITO""CARTAO_DEBITO""CARTEIRA_DIGITAL""CASHBACK""CHEQUE""CREDITO_LOJA""CREDITO_VIRTUAL""DEPOSITO_BANCARIO""DINHEIRO"

Example: "CARTAO_CREDITO"

condicao_pagamento.id_conta_financeirastring(uuid)

ID da conta financeira

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

condicao_pagamento.opcao_condicao_pagamentostringrequired

Deve ser em um dos três formatos: - 1º: Ex: À vista. - 2º: Ex1: 30, 60, 90. Ex2: 15, 30, 45. - 3º: Ex1: 3x. Ex2: 12x

Example: "À vista"

condicao_pagamento.nsustring

NSU

Example: "1234567890"

condicao_pagamento.parcelasArray of objectsrequired

condicao_pagamento.parcelas[].data_vencimentostring(date)required

Data de vencimento

Example: "2023-12-31"

condicao_pagamento.parcelas[].valornumber(double)required

Valor da parcela

Example: 100

condicao_pagamento.parcelas[].descricaostring

Descrição da parcela

Example: "Parcela 1"

curl -i -X POST \
  https://developers.contaazul.com/_mock/openapi/v1/venda \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id_cliente": "2887ff7c-e8dc-4cd4-bd04-a5554a71c2de",
    "numero": 0,
    "situacao": "EM_ANDAMENTO",
    "data_venda": "2019-08-24",
    "id_categoria": "28aae0b9-0a40-4479-baff-3cbc83721b20",
    "id_centro_custo": "51474982-bf91-4e21-81d5-2212e04a543c",
    "observacoes": "string",
    "observacoes_pagamento": "string",
    "itens": [
      {
        "descricao": "Produto A",
        "quantidade": 2,
        "valor": 50,
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "valor_custo": 40
      }
    ],
    "composicao_de_valor": {
      "frete": 100,
      "desconto": {
        "tipo": "PORCENTAGEM",
        "valor": 5
      }
    },
    "condicao_pagamento": {
      "tipo_pagamento": "CARTAO_CREDITO",
      "id_conta_financeira": "550e8400-e29b-41d4-a716-446655440000",
      "opcao_condicao_pagamento": "À vista",
      "nsu": "1234567890",
      "parcelas": [
        {
          "data_vencimento": "2023-12-31",
          "valor": 100,
          "descricao": "Parcela 1"
        }
      ]
    }
  }'

Responses

Venda criada com sucesso

Bodyapplication/json

idstring(uuid)

ID único da venda

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

id_legadointeger(int64)

ID legado necessário para a venda

Example: 123456

id_clientestring(uuid)

ID do cliente associado à venda

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

numerointeger(int64)

Número da venda

Example: 1001

origemstring

Origem da venda

Example: "Online"

id_categoriastring(uuid)

ID da categoria da venda

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

data_vendastring(date-time)

Data da venda

Example: "2023-10-01T12:00:00Z"

situacaoobject

pendenciaobject

valor_composicaoobject

condicao_pagamentoobject

observacoesstring

Observações sobre a venda

Example: "Cliente solicitou entrega rápida"

id_vendedorstring(uuid)

ID do vendedor responsável pela venda

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

versaointeger(int64)

Versão da venda

Example: 1

Response

application/json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "id_legado": 123456,
  "id_cliente": "123e4567-e89b-12d3-a456-426614174001",
  "numero": 1001,
  "origem": "Online",
  "id_categoria": "123e4567-e89b-12d3-a456-426614174002",
  "data_venda": "2023-10-01T12:00:00Z",
  "situacao": {
    "nome": "Situação Exemplo",
    "descricao": "Descrição da situação exemplo"
  },
  "pendencia": {
    "nome": "AGUARDANDO_CONFIRMACAO",
    "descricao": "Aguardando confirmação"
  },
  "valor_composicao": {
    "valor_bruto": 100,
    "desconto": { … },
    "frete": 10,
    "valor_liquido": 90
  },
  "condicao_pagamento": {
    "id_legado": 123456789,
    "tipo_pagamento": "CARTAO_CREDITO",
    "id_conta_financeira": "550e8400-e29b-41d4-a716-446655440000",
    "opcao_condicao_pagamento": "Parcelado",
    "parcelas": [ … ],
    "observacoes_pagamento": "Pagamento realizado em 3 parcelas",
    "nsu": "1234567890",
    "troco_total": 10.5
  },
  "observacoes": "Cliente solicitou entrega rápida",
  "id_vendedor": "123e4567-e89b-12d3-a456-426614174003",
  "versao": 1
}

Imprime o PDF de uma venda

Request

Gera e retorna um PDF da venda especificada pelo ID

Path

idstring or integerrequired

ID da venda a ser impressa, pode ser passado id Long ou uuid

One of:

string(uuid)

curl -i -X GET \
  'https://developers.contaazul.com/_mock/openapi/v1/venda/{id}/imprimir' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

PDF da venda gerado com sucesso

Bodyapplication/pdf

string(binary)

Exclusão de vendas em lote

Request

Exclui vendas em lote(maximo de 10 por vez) especificadas pelos UUIDs fornecidos

Bodyapplication/jsonrequired

idsArray of strings(uuid)[ 1 .. 10 ] itemsrequired

Lista de UUIDs das vendas a serem excluídas

Example: ["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"]

curl -i -X POST \
  https://developers.contaazul.com/_mock/openapi/v1/venda/exclusao-lote \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "ids": [
      "123e4567-e89b-12d3-a456-426614174000",
      "123e4567-e89b-12d3-a456-426614174001"
    ]
  }'

Responses

Vendas excluídas com sucesso

Bodyapplication/json

atualizadosinteger

Indica quantidade excluída

Example: 1

ignoradosinteger

Indica quantidade ignorada

Example: 1

Response

application/json

{
  "atualizados": 1,
  "ignorados": 1
}

Retorna os itens de uma venda paginados

Request

Retorna os itens de uma venda especificada pelo UUID, com suporte a paginação e ordenação

Path

id_vendastring(uuid)required

UUID da venda

Query

paginainteger

Número da página

Default 1

tamanho_paginainteger

Tamanho da página

Default 10

curl -i -X GET \
  'https://developers.contaazul.com/_mock/openapi/v1/venda/{id_venda}/itens?pagina=1&tamanho_pagina=10' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Itens da venda retornados com sucesso

Bodyapplication/json

itensArray of objects

itens_totaisinteger

totaisobject

Response

application/json

{
  "itens": [
    { … }
  ],
  "itens_totais": 0,
  "totais": {
    "quantidade_produtos": 1,
    "quantidade_servicos": 1,
    "quantidade_nao_conciliados": 1
  }
}

Serviço

Operations

API's Conta Azul Pro (v2)

Autenticação

Baixa

Cobranças

Contratos

Centro de Custo

Eventos financeiros

Categorias

Conta Financeira

Produto

Cadastro de Pessoas

Protocolo

Venda

Obter venda por ID

Request

Responses

Was this helpful?

Edição de venda por ID

RequestExpand all

Responses

Was this helpful?

Listar vendas por filtros

RequestExpand all

Responses

Was this helpful?

Criar uma nova venda

RequestExpand all

Responses

Was this helpful?

Imprime o PDF de uma venda

RequestExpand all

Responses

Was this helpful?

Exclusão de vendas em lote

Request

Responses

Was this helpful?

Retorna os itens de uma venda paginados

Request

Responses

Was this helpful?

Serviço

Request

Request

Request

Request