Financeiro

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

Cobranças

Operations

Contratos

Operations

Centro de Custo

Operations

Categorias

Operations

Conta Financeira

Operations

Financeiro

Operations

Criação de Baixa

Request

Criação de baixa dado uma parcela.

Path
parcela_idstring(uuid)required
Example: 35473eec-4e74-11ee-b500-9f61de8a8b8b
Bodyapplication/jsonrequired
data_pagamentostring(date)required

Data do pagamento.

Example: "2023-10-01"
composicao_valorobjectrequired
composicao_valor.​multanumber(double)

O valor da multa, deve ser maior ou igual a zero.

Example: 0
composicao_valor.​jurosnumber(double)

O valor dos juros, deve ser maior ou igual a zero.

Example: 0
composicao_valor.​valor_brutonumber(double)required

O valor bruto, deve ser informado e maior ou igual a zero.

Example: 1000
composicao_valor.​descontonumber(double)

O valor do desconto, deve ser maior ou igual a zero.

Example: 0
composicao_valor.​taxanumber(double)

O valor da taxa, deve ser maior ou igual a zero.

Example: 0
conta_financeirastring(uuid)required

Identificador único da conta financeira.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
metodo_pagamentostring

Método de pagamento.

Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
observacaostring

Observação.

Example: "Payment for invoice #1234"
nsustring

Número sequencial único.

Example: "1234567890"
curl -i -X POST \
  https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/parcelas/35473eec-4e74-11ee-b500-9f61de8a8b8b/baixa \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "data_pagamento": "2023-10-01",
    "composicao_valor": {
      "multa": 0,
      "juros": 0,
      "valor_bruto": 1000,
      "desconto": 0,
      "taxa": 0
    },
    "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "metodo_pagamento": "CARTAO_CREDITO",
    "observacao": "Payment for invoice #1234",
    "nsu": "1234567890"
  }'

Responses

Baixa criado

Bodyapplication/json
idstring(uuid)

Identificador único gerado automaticamente após a criação.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
versaointeger(int64)

Versão da baixa.

Example: 1
data_pagamentostring(date)

Data do pagamento.

Example: "2023-10-01"
composicao_valorobject
conta_financeirastring(uuid)

Identificador único da conta financeira.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
metodo_pagamentostring

Método de pagamento.

Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
observacaostring

Observação.

Example: "Payment for invoice #1234"
nsustring

Número sequencial único.

Example: "1234567890"
Response
application/json
{
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "versao": 1,
  "data_pagamento": "2023-10-01",
  "composicao_valor": {
    "multa": 0,
    "juros": 0,
    "valor_bruto": 1000,
    "desconto": 0,
    "taxa": 0
  },
  "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "metodo_pagamento": "CARTAO_CREDITO",
  "observacao": "Payment for invoice #1234",
  "nsu": "1234567890"
}

Lista de Baixas

Request

Listagem de baixas dado o UUID da parcela.

Path
parcela_idstring(uuid)required
Example: 35473eec-4e74-11ee-b500-9f61de8a8b8b
curl -i -X GET \
  https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/parcelas/35473eec-4e74-11ee-b500-9f61de8a8b8b/baixa \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Lista de baixas

Bodyapplication/jsonArray [
idstring(uuid)

Identificador único da baixa.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
versaointeger(int64)

Versão da baixa.

Example: 1
data_pagamentostring(date)

Data do pagamento.

Example: "2023-10-01"
valor_composicaoobject
conta_financeirastring(uuid)

Identificador único da conta financeira.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_reconciliacaostring(uuid)

Identificador único da reconciliação.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_parcelastring(uuid)

Identificador único da parcela.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_solicitacao_cobrancastring(uuid)

Identificador único da solicitação de cobrança.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
observacaostring

Observação.

Example: "Payment for invoice #1234"
metodo_pagamentostring

Método de pagamento.

Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
origemstring

Origem.

Enum"LANCAMENTO_FINANCEIRO""DAS""FOLHA""TRANSFERENCIA""SALDO_CONTA_BANCARIA""VENDA""COMPRA""VENDA_AGENDADA""COMPRA_AGENDADA""IMPORTACAO_DOCUMENTO"
Example: "SALDO_CONTA_BANCARIA"
id_recibo_digitalstring(uuid)

Identificador único do recibo digital.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
tipo_evento_financeirostring

Tipo de evento financeiro.

Enum"RECEITA""DESPESA"
Example: "RECEITA"
nsustring

Número sequencial único.

Example: "1234567890"
id_referenciastring

Identificador único da referência.

Example: "REF1234"
atualizado_emstring(date-time)

Data de atualização.

Example: "2023-10-01T12:00:00Z"
anexosArray of objects
]
Response
application/json
[
  {
    "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "versao": 1,
    "data_pagamento": "2023-10-01",
    "valor_composicao": { … },
    "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "id_reconciliacao": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "id_parcela": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "id_solicitacao_cobranca": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "observacao": "Payment for invoice #1234",
    "metodo_pagamento": "CARTAO_CREDITO",
    "origem": "SALDO_CONTA_BANCARIA",
    "id_recibo_digital": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "tipo_evento_financeiro": "RECEITA",
    "nsu": "1234567890",
    "id_referencia": "REF1234",
    "atualizado_em": "2023-10-01T12:00:00Z",
    "anexos": [ … ]
  }
]

Atualização de Baixa.

Request

Atualiza uma baixa.

Path
baixa_idstring(uuid)required
Example: 35473eec-4e74-11ee-b500-9f61de8a8b8b
Bodyapplication/jsonrequired
versaointeger(int64)required

Deve ser enviado a versão atual do registro. Este valor será incrementado após sucesso na atualização.

Example: 1
data_pagamentostring(date)

Data do pagamento.

Example: "2023-10-01"
composicao_valorobject
conta_financeirastring(uuid)

Identificador único da conta financeira.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
metodo_pagamentostring

Método de pagamento.

Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
observacaostring

Observação.

Example: "Payment for invoice #1234"
nsustring

Número sequencial único.

Example: "1234567890"
curl -i -X PATCH \
  https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/parcelas/baixa/35473eec-4e74-11ee-b500-9f61de8a8b8b \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "versao": 1,
    "data_pagamento": "2023-10-01",
    "composicao_valor": {
      "multa": 0,
      "juros": 0,
      "valor_bruto": 1000,
      "desconto": 0,
      "taxa": 0
    },
    "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "metodo_pagamento": "CARTAO_CREDITO",
    "observacao": "Payment for invoice #1234",
    "nsu": "1234567890"
  }'

Responses

Baixa atualizada

Bodyapplication/json
idstring(uuid)

Identificador único gerado automaticamente após a criação.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
versaointeger(int64)

Versão da baixa.

Example: 1
data_pagamentostring(date)

Data do pagamento.

Example: "2023-10-01"
composicao_valorobject
conta_financeirastring(uuid)

Identificador único da conta financeira.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
metodo_pagamentostring

Método de pagamento.

Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
observacaostring

Observação.

Example: "Payment for invoice #1234"
nsustring

Número sequencial único.

Example: "1234567890"
Response
application/json
{
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "versao": 1,
  "data_pagamento": "2023-10-01",
  "composicao_valor": {
    "multa": 0,
    "juros": 0,
    "valor_bruto": 1000,
    "desconto": 0,
    "taxa": 0
  },
  "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "metodo_pagamento": "CARTAO_CREDITO",
  "observacao": "Payment for invoice #1234",
  "nsu": "1234567890"
}

Remoção de Baixa

Request

Remove uma baixa pelo UUID.

Path
baixa_idstring(uuid)required
Example: 35473eec-4e74-11ee-b500-9f61de8a8b8b
curl -i -X DELETE \
  https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/parcelas/baixa/35473eec-4e74-11ee-b500-9f61de8a8b8b \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Baixa removida com sucesso!

Busca de Baixa

Request

Busca um baixa pelo UUID.

Path
baixa_idstring(uuid)required
Example: 35473eec-4e74-11ee-b500-9f61de8a8b8b
curl -i -X GET \
  https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/parcelas/baixa/35473eec-4e74-11ee-b500-9f61de8a8b8b \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Detalhes do baixa

Bodyapplication/json
idstring(uuid)

Identificador único da baixa.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
versaointeger(int64)

Versão da baixa.

Example: 1
data_pagamentostring(date)

Data do pagamento.

Example: "2023-10-01"
valor_composicaoobject
conta_financeirastring(uuid)

Identificador único da conta financeira.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_reconciliacaostring(uuid)

Identificador único da reconciliação.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_parcelastring(uuid)

Identificador único da parcela.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_solicitacao_cobrancastring(uuid)

Identificador único da solicitação de cobrança.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
observacaostring

Observação.

Example: "Payment for invoice #1234"
metodo_pagamentostring

Método de pagamento.

Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
origemstring

Origem.

Enum"LANCAMENTO_FINANCEIRO""DAS""FOLHA""TRANSFERENCIA""SALDO_CONTA_BANCARIA""VENDA""COMPRA""VENDA_AGENDADA""COMPRA_AGENDADA""IMPORTACAO_DOCUMENTO"
Example: "SALDO_CONTA_BANCARIA"
id_recibo_digitalstring(uuid)

Identificador único do recibo digital.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
tipo_evento_financeirostring

Tipo de evento financeiro.

Enum"RECEITA""DESPESA"
Example: "RECEITA"
nsustring

Número sequencial único.

Example: "1234567890"
id_referenciastring

Identificador único da referência.

Example: "REF1234"
atualizado_emstring(date-time)

Data de atualização.

Example: "2023-10-01T12:00:00Z"
anexosArray of objects
Response
application/json
{
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "versao": 1,
  "data_pagamento": "2023-10-01",
  "valor_composicao": {
    "multa": 0,
    "juros": 0,
    "valor_bruto": 1000,
    "desconto": 0,
    "taxa": 0
  },
  "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "id_reconciliacao": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "id_parcela": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "id_solicitacao_cobranca": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "observacao": "Payment for invoice #1234",
  "metodo_pagamento": "CARTAO_CREDITO",
  "origem": "SALDO_CONTA_BANCARIA",
  "id_recibo_digital": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "tipo_evento_financeiro": "RECEITA",
  "nsu": "1234567890",
  "id_referencia": "REF1234",
  "atualizado_em": "2023-10-01T12:00:00Z",
  "anexos": [
    { … }
  ]
}

Busca as parcelas de acordo com o id do evento

Request

Retorna as parcelas de acordo com o id do evento informado

Path
id_eventostringrequired

UUID ou ID legado do evento.

curl -i -X GET \
  'https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/{id_evento}/parcelas' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Lista de Parcelas

Bodyapplication/json
eventoobject
idstring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
versaointeger(int64)
referenciastring
indiceinteger(int32)
Example: 1
conciliadoboolean
Example: true
statusstring
Enum"PENDENTE""QUITADO""CANCELADO"
Example: "PENDENTE"
valor_pagonumber(double)
Example: 10
perdaobject
nao_pagonumber(double)
Example: 5
data_vencimentostring(date)
Example: "01/01/2030"
data_pagamento_previstostring(date)
Example: "01/01/2030"
descricaostring
Example: "bla bla bla"
notastring
Example: "bla bla bla"
conta_financeiraobject
id_conta_financeirastring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
valor_composicaoobject
metodo_pagamentostring
Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "DEPOSITO_BANCARIO"
nsustring
Example: null
baixa_agendadaboolean
Example: false
baixasArray of objects
anexosArray of objects
solicitacoes_cobrancasArray of objects
id_ultima_solicitacao_pagamentostring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_boleto_bancario_autorizadostring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
faturaobject
valor_total_liquidonumber(double)
Example: 10
id_ultimo_solicitacao_cobrancastring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
Response
application/json
{
  "evento": {
    "data_competencia": "01/01/2030",
    "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "condicao_pagamento": { … },
    "referencia": { … },
    "agendado": true,
    "tipo": "RECEITA"
  },
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "versao": 0,
  "referencia": "string",
  "indice": 1,
  "conciliado": true,
  "status": "PENDENTE",
  "valor_pago": 10,
  "perda": {
    "data": "2024-07-15",
    "valor": 1.99
  },
  "nao_pago": 5,
  "data_vencimento": "01/01/2030",
  "data_pagamento_previsto": "01/01/2030",
  "descricao": "bla bla bla",
  "nota": "bla bla bla",
  "conta_financeira": {
    "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "banco": "string",
    "codigo_banco": 0,
    "nome": "string",
    "ativo": true,
    "tipo": "APLICACAO",
    "conta_padrao": true,
    "possui_config_boleto_bancario": true,
    "agencia": "string",
    "numero": "string"
  },
  "id_conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "valor_composicao": {
    "multa": 10,
    "juros": 1,
    "valor_bruto": 20,
    "desconto": 0.1,
    "taxa": 0.03,
    "valor_liquido": 9
  },
  "metodo_pagamento": "DEPOSITO_BANCARIO",
  "nsu": null,
  "baixa_agendada": false,
  "baixas": [
    { … }
  ],
  "anexos": [
    { … }
  ],
  "solicitacoes_cobrancas": [
    { … }
  ],
  "id_ultima_solicitacao_pagamento": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "id_boleto_bancario_autorizado": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "fatura": {
    "numero": 123,
    "rps": 1,
    "tipo_fatura": "NFE"
  },
  "valor_total_liquido": 10,
  "id_ultimo_solicitacao_cobranca": "35473eec-4e74-11ee-b500-9f61de8a8b8b"
}

Cria evento financeiro de conta a receber

Request

Realização a criação do evento financeiro de conta a receber e retorna o protocolo da operação

Bodyapplication/jsonrequired

Dados do evento financeiro de contas a receber

data_competenciastring(date)required

Data da compentência do evento financeiro é obrigatório.

valornumber(decimal)required

Valor do evento financeiro é obrigatório.

observacaostringrequired

Observação do evento financeiro é obrigatório.

Example: "Observação do evento financeiro"
descricaostringrequired

Descrição do evento financeiro é obrigatório.

Example: "Descriação do evento financeiro"
contatostring(uuid)required

Identificador do contato é obrigatório.

conta_financeirastring(uuid)required

Identificador da Conta Financeira é obrigatório.

rateioArray of objects
condicao_pagamentoobjectrequired
condicao_pagamento.​parcelasArray of objectsrequired

Lista de parcelas da condição de pagamento

condicao_pagamento.​parcelas[].​descricaostringrequired

A descrição da parcela é obrigatória.

Example: "Descrição da parcela"
condicao_pagamento.​parcelas[].​data_vencimentostring(date)required

A data de vencimento da parcela é obrigatória.

condicao_pagamento.​parcelas[].​notastringrequired

Nota adicional sobre a parcela é obrigatória.

Example: "Nota adicional sobre a parcela"
condicao_pagamento.​parcelas[].​conta_financeirastring(uuid)required

Identificador da conta financeira associada à parcela é obrigatória.

condicao_pagamento.​parcelas[].​detalhe_valorobjectrequired
condicao_pagamento.​parcelas[].​detalhe_valor.​multanumber

Valor da multa.

Example: 100.25
condicao_pagamento.​parcelas[].​detalhe_valor.​jurosnumber

Valor dos juros.

Example: 1.5
condicao_pagamento.​parcelas[].​detalhe_valor.​valor_brutonumberrequired

Valor bruto da parcela é obrigatório.

Example: 275.99
condicao_pagamento.​parcelas[].​detalhe_valor.​valor_liquidonumber

Valor líquido da parcela.

Example: 250.33
condicao_pagamento.​parcelas[].​detalhe_valor.​descontonumber

Valor do desconto.

Example: 2.1
condicao_pagamento.​parcelas[].​detalhe_valor.​taxanumber

Valor da taxa.

Example: 4.4
curl -i -X POST \
  https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/contas-a-receber \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "data_competencia": "2019-08-24",
    "valor": 0,
    "observacao": "Observação do evento financeiro",
    "descricao": "Descriação do evento financeiro",
    "contato": "52787046-cab8-4c99-b1e6-be8fede40891",
    "conta_financeira": "90a65889-9f79-4357-ad37-e801b9d7516f",
    "rateio": [
      {
        "id_categoria": "28aae0b9-0a40-4479-baff-3cbc83721b20",
        "valor": 0,
        "rateio_centro_custo": [
          {
            "id_centro_custo": "51474982-bf91-4e21-81d5-2212e04a543c",
            "valor": 0
          }
        ]
      }
    ],
    "condicao_pagamento": {
      "parcelas": [
        {
          "descricao": "Descrição da parcela",
          "data_vencimento": "2019-08-24",
          "nota": "Nota adicional sobre a parcela",
          "conta_financeira": "90a65889-9f79-4357-ad37-e801b9d7516f",
          "detalhe_valor": {
            "multa": 100.25,
            "juros": 1.5,
            "valor_bruto": 275.99,
            "valor_liquido": 250.33,
            "desconto": 2.1,
            "taxa": 4.4
          }
        }
      ]
    }
  }'

Responses

Evento financeiro de conta a receber criado com sucesso

Bodyapplication/json
protocolIdstring(uuid)

Identificador do protocolo

statusstring

Status do protocolo

Enum"PENDING""SUCCESS""ERROR"
createdAtstring(date-time)

Data de criação do protocolo

Response
application/json
{
  "protocolId": "145fbbc7-5125-4cc4-be15-11cd04d84fa0",
  "status": "PENDING",
  "createdAt": "2019-08-24T14:15:22Z"
}

Procura de acordo com o filtro e retorna as contas a receber

Request

Procura e retorna as contas a receber que atendam às condições dos filtros aplicados

Query
paginanumberrequired
tamanho_paginanumberrequired
campo_ordenado_ascendentestring
campo_ordenado_descendentestring
Bodyapplication/jsonrequired

Filtros para busca de contas a receber

descricaostring

Descrição da conta.

Example: "Conta do ..."
data_vencimento_destringrequired

Data de vencimento inicial da busca (Um intervalo de data é obrigatório entre vencimento, criação ou alteração).

Example: "2024-05-01"
data_vencimento_atestringrequired

Data de vencimento final da busca (Um intervalo de data é obrigatório entre vencimento, criação ou alteração).

Example: "2024-05-31"
data_competencia_destring

Data de competência inicial da busca.

Example: "2024-05-31"
data_competencia_atestring

Data de competência final da busca.

Example: "2024-05-31"
data_pagamento_destring

Data de pagamento inicial da busca.

Example: "2024-05-31"
data_pagamento_atestring

Data de pagamento final da busca.

Example: "2024-05-31"
data_criacao_destring(date-time)

Data de criação inicial da busca (Um intervalo de data é obrigatório entre vencimento, criação ou alteração).

Example: "2024-10-22T14:30:00Z"
data_criacao_atestring(date-time)

Data de criação final da busca (Um intervalo de data é obrigatório entre vencimento, criação ou alteração).

Example: "2024-10-22T14:30:00Z"
data_alteracao_destring(date-time)

Data de alteração inicial da busca (Um intervalo de data é obrigatório entre vencimento, criação ou alteração).

Example: "2024-10-22T14:30:00Z"
data_alteracao_atestring(date-time)

Data de alteração final da busca (Um intervalo de data é obrigatório entre vencimento, criação ou alteração).

Example: "2024-10-22T14:30:00Z"
valor_denumber

Valor mínimo da busca.

Example: 14.5
valor_atenumber

Valor máximo da busca.

Example: 278.5
statusArray of strings

Status da conta.

ids_contas_financeirasArray of strings

UUIDs das contas financeiras.

ids_categoriasArray of strings

UUIDs das categorias.

ids_centros_de_custoArray of strings

UUIDs dos centros de custo.

metodos_pagamentoArray of strings

Métodos de pagamento.

referenciasArray of strings

Referências.

curl -i -X POST \
  'https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/contas-a-receber/buscar?campo_ordenado_ascendente=string&campo_ordenado_descendente=string&pagina=0&tamanho_pagina=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "descricao": "Conta do ...",
    "data_vencimento_de": "2024-05-01",
    "data_vencimento_ate": "2024-05-31",
    "data_competencia_de": "2024-05-31",
    "data_competencia_ate": "2024-05-31",
    "data_pagamento_de": "2024-05-31",
    "data_pagamento_ate": "2024-05-31",
    "data_criacao_de": "2024-10-22T14:30:00Z",
    "data_criacao_ate": "2024-10-22T14:30:00Z",
    "data_alteracao_de": "2024-10-22T14:30:00Z",
    "data_alteracao_ate": "2024-10-22T14:30:00Z",
    "valor_de": 14.5,
    "valor_ate": 278.5,
    "status": [
      "string"
    ],
    "ids_contas_financeiras": [
      "string"
    ],
    "ids_categorias": [
      "string"
    ],
    "ids_centros_de_custo": [
      "string"
    ],
    "metodos_pagamento": [
      "string"
    ],
    "referencias": [
      "string"
    ]
  }'

Responses

Lista de Contas a Receber

Bodyapplication/json
itens_totaisinteger
Example: 6
itensArray of objects
totaisobject
Response
application/json
{
  "itens_totais": 6,
  "itens": [
    { … }
  ],
  "totais": {
    "ativo": 6,
    "inativo": 0,
    "todos": 6
  }
}

Cria evento financeiro de conta a pagar

Request

Realização a criação do evento financeiro de conta a pagar e retorna o protocolo da operação

Bodyapplication/jsonrequired

Dados do evento financeiro de contas a pagar

data_competenciastring(date)required

Data da compentência do evento financeiro é obrigatório.

valornumber(decimal)required

Valor do evento financeiro é obrigatório.

observacaostringrequired

Observação do evento financeiro é obrigatório.

Example: "Observação do evento financeiro"
descricaostringrequired

Descrição do evento financeiro é obrigatório.

Example: "Descriação do evento financeiro"
contatostring(uuid)required

Identificador do contato é obrigatório.

conta_financeirastring(uuid)required

Identificador da Conta Financeira é obrigatório.

rateioArray of objects
condicao_pagamentoobjectrequired
condicao_pagamento.​parcelasArray of objectsrequired

Lista de parcelas da condição de pagamento

condicao_pagamento.​parcelas[].​descricaostringrequired

A descrição da parcela é obrigatória.

Example: "Descrição da parcela"
condicao_pagamento.​parcelas[].​data_vencimentostring(date)required

A data de vencimento da parcela é obrigatória.

condicao_pagamento.​parcelas[].​notastringrequired

Nota adicional sobre a parcela é obrigatória.

Example: "Nota adicional sobre a parcela"
condicao_pagamento.​parcelas[].​conta_financeirastring(uuid)required

Identificador da conta financeira associada à parcela é obrigatória.

condicao_pagamento.​parcelas[].​detalhe_valorobjectrequired
condicao_pagamento.​parcelas[].​detalhe_valor.​multanumber

Valor da multa.

Example: 100.25
condicao_pagamento.​parcelas[].​detalhe_valor.​jurosnumber

Valor dos juros.

Example: 1.5
condicao_pagamento.​parcelas[].​detalhe_valor.​valor_brutonumberrequired

Valor bruto da parcela é obrigatório.

Example: 275.99
condicao_pagamento.​parcelas[].​detalhe_valor.​valor_liquidonumber

Valor líquido da parcela.

Example: 250.33
condicao_pagamento.​parcelas[].​detalhe_valor.​descontonumber

Valor do desconto.

Example: 2.1
condicao_pagamento.​parcelas[].​detalhe_valor.​taxanumber

Valor da taxa.

Example: 4.4
curl -i -X POST \
  https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/contas-a-pagar \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "data_competencia": "2019-08-24",
    "valor": 0,
    "observacao": "Observação do evento financeiro",
    "descricao": "Descriação do evento financeiro",
    "contato": "52787046-cab8-4c99-b1e6-be8fede40891",
    "conta_financeira": "90a65889-9f79-4357-ad37-e801b9d7516f",
    "rateio": [
      {
        "id_categoria": "28aae0b9-0a40-4479-baff-3cbc83721b20",
        "valor": 0,
        "rateio_centro_custo": [
          {
            "id_centro_custo": "51474982-bf91-4e21-81d5-2212e04a543c",
            "valor": 0
          }
        ]
      }
    ],
    "condicao_pagamento": {
      "parcelas": [
        {
          "descricao": "Descrição da parcela",
          "data_vencimento": "2019-08-24",
          "nota": "Nota adicional sobre a parcela",
          "conta_financeira": "90a65889-9f79-4357-ad37-e801b9d7516f",
          "detalhe_valor": {
            "multa": 100.25,
            "juros": 1.5,
            "valor_bruto": 275.99,
            "valor_liquido": 250.33,
            "desconto": 2.1,
            "taxa": 4.4
          }
        }
      ]
    }
  }'

Responses

Evento financeiro de conta a pagar criado com sucesso

Bodyapplication/json
protocolIdstring(uuid)

Identificador do protocolo

statusstring

Status do protocolo

Enum"PENDING""SUCCESS""ERROR"
createdAtstring(date-time)

Data de criação do protocolo

Response
application/json
{
  "protocolId": "145fbbc7-5125-4cc4-be15-11cd04d84fa0",
  "status": "PENDING",
  "createdAt": "2019-08-24T14:15:22Z"
}

Procura de acordo com o filtro e retorna as contas a pagar

Request

Procura e retorna as contas a pagar que atendam às condições dos filtros aplicados

Query
paginanumberrequired
tamanho_paginanumberrequired
campo_ordenado_ascendentestring
campo_ordenado_descendentestring
Bodyapplication/jsonrequired

Filtros para busca de contas a receber

descricaostring

Descrição da conta.

Example: "Conta do ..."
data_vencimento_destringrequired

Data de vencimento inicial da busca (Um intervalo de data é obrigatório entre vencimento, criação ou alteração).

Example: "2024-05-01"
data_vencimento_atestringrequired

Data de vencimento final da busca (Um intervalo de data é obrigatório entre vencimento, criação ou alteração).

Example: "2024-05-31"
data_competencia_destring

Data de competência inicial da busca.

Example: "2024-05-31"
data_competencia_atestring

Data de competência final da busca.

Example: "2024-05-31"
data_pagamento_destring

Data de pagamento inicial da busca.

Example: "2024-05-31"
data_pagamento_atestring

Data de pagamento final da busca.

Example: "2024-05-31"
data_criacao_destring(date-time)

Data de criação inicial da busca (Um intervalo de data é obrigatório entre vencimento, criação ou alteração).

Example: "2024-10-22T14:30:00Z"
data_criacao_atestring(date-time)

Data de criação final da busca (Um intervalo de data é obrigatório entre vencimento, criação ou alteração).

Example: "2024-10-22T14:30:00Z"
data_alteracao_destring(date-time)

Data de alteração inicial da busca (Um intervalo de data é obrigatório entre vencimento, criação ou alteração).

Example: "2024-10-22T14:30:00Z"
data_alteracao_atestring(date-time)

Data de alteração final da busca (Um intervalo de data é obrigatório entre vencimento, criação ou alteração).

Example: "2024-10-22T14:30:00Z"
valor_denumber

Valor mínimo da busca.

Example: 14.5
valor_atenumber

Valor máximo da busca.

Example: 278.5
statusArray of strings

Status da conta.

ids_contas_financeirasArray of strings

UUIDs das contas financeiras.

ids_categoriasArray of strings

UUIDs das categorias.

ids_centros_de_custoArray of strings

UUIDs dos centros de custo.

metodos_pagamentoArray of strings

Métodos de pagamento.

referenciasArray of strings

Referências.

curl -i -X POST \
  'https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/contas-a-pagar/buscar?campo_ordenado_ascendente=string&campo_ordenado_descendente=string&pagina=0&tamanho_pagina=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "descricao": "Conta do ...",
    "data_vencimento_de": "2024-05-01",
    "data_vencimento_ate": "2024-05-31",
    "data_competencia_de": "2024-05-31",
    "data_competencia_ate": "2024-05-31",
    "data_pagamento_de": "2024-05-31",
    "data_pagamento_ate": "2024-05-31",
    "data_criacao_de": "2024-10-22T14:30:00Z",
    "data_criacao_ate": "2024-10-22T14:30:00Z",
    "data_alteracao_de": "2024-10-22T14:30:00Z",
    "data_alteracao_ate": "2024-10-22T14:30:00Z",
    "valor_de": 14.5,
    "valor_ate": 278.5,
    "status": [
      "string"
    ],
    "ids_contas_financeiras": [
      "string"
    ],
    "ids_categorias": [
      "string"
    ],
    "ids_centros_de_custo": [
      "string"
    ],
    "metodos_pagamento": [
      "string"
    ],
    "referencias": [
      "string"
    ]
  }'

Responses

Lista de Contas a Pagar

Bodyapplication/json
itens_totaisinteger
Example: 6
itensArray of objects
totaisobject
Response
application/json
{
  "itens_totais": 6,
  "itens": [
    { … }
  ],
  "totais": {
    "ativo": 6,
    "inativo": 0,
    "todos": 6
  }
}

Busca parcela por ID

Request

Retorna as informações de uma parcela específica pelo seu ID.

Path
idstring(uuid)required

Identificador único da parcela

Example: 9986f173-f531-4660-96ae-04b71c879264
curl -i -X GET \
  https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/parcelas/9986f173-f531-4660-96ae-04b71c879264 \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Informações da parcela retornadas com sucesso

Bodyapplication/json
eventoobject
idstring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
versaointeger(int64)
referenciastring
indiceinteger(int32)
Example: 1
conciliadoboolean
Example: true
statusstring
Enum"PENDENTE""QUITADO""CANCELADO"
Example: "PENDENTE"
valor_pagonumber(double)
Example: 10
perdaobject
nao_pagonumber(double)
Example: 5
data_vencimentostring(date)
Example: "01/01/2030"
data_pagamento_previstostring(date)
Example: "01/01/2030"
descricaostring
Example: "bla bla bla"
notastring
Example: "bla bla bla"
conta_financeiraobject
id_conta_financeirastring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
valor_composicaoobject
metodo_pagamentostring
Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "DEPOSITO_BANCARIO"
nsustring
Example: null
baixa_agendadaboolean
Example: false
baixasArray of objects
anexosArray of objects
solicitacoes_cobrancasArray of objects
id_ultima_solicitacao_pagamentostring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_boleto_bancario_autorizadostring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
faturaobject
valor_total_liquidonumber(double)
Example: 10
id_ultimo_solicitacao_cobrancastring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
Response
application/json
{
  "evento": {
    "data_competencia": "01/01/2030",
    "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "condicao_pagamento": { … },
    "referencia": { … },
    "agendado": true,
    "tipo": "RECEITA"
  },
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "versao": 0,
  "referencia": "string",
  "indice": 1,
  "conciliado": true,
  "status": "PENDENTE",
  "valor_pago": 10,
  "perda": {
    "data": "2024-07-15",
    "valor": 1.99
  },
  "nao_pago": 5,
  "data_vencimento": "01/01/2030",
  "data_pagamento_previsto": "01/01/2030",
  "descricao": "bla bla bla",
  "nota": "bla bla bla",
  "conta_financeira": {
    "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "banco": "string",
    "codigo_banco": 0,
    "nome": "string",
    "ativo": true,
    "tipo": "APLICACAO",
    "conta_padrao": true,
    "possui_config_boleto_bancario": true,
    "agencia": "string",
    "numero": "string"
  },
  "id_conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "valor_composicao": {
    "multa": 10,
    "juros": 1,
    "valor_bruto": 20,
    "desconto": 0.1,
    "taxa": 0.03,
    "valor_liquido": 9
  },
  "metodo_pagamento": "DEPOSITO_BANCARIO",
  "nsu": null,
  "baixa_agendada": false,
  "baixas": [
    { … }
  ],
  "anexos": [
    { … }
  ],
  "solicitacoes_cobrancas": [
    { … }
  ],
  "id_ultima_solicitacao_pagamento": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "id_boleto_bancario_autorizado": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "fatura": {
    "numero": 123,
    "rps": 1,
    "tipo_fatura": "NFE"
  },
  "valor_total_liquido": 10,
  "id_ultimo_solicitacao_cobranca": "35473eec-4e74-11ee-b500-9f61de8a8b8b"
}

Atualiza as informações de uma parcela

Request

Atualiza as informações de uma parcela do evento financeiro. - Sempre deverá ser enviado o campo VERSÃO com o valor atualizado do registro. - Não é necessário o envio do objeto inteiro, apenas os campos que serão atualizados.

Path
idstring(uuid)required
Example: 9986f173-f531-4660-96ae-04b71c879264
Bodyapplication/jsonrequired

Campos aceitos para atualização da parcela

notastring
Example: "Nota da parcela"
descricaostring
Example: "Descrição da parcela"
vencimentostring(date)
Example: "2024-07-15"
composicao_valorobject
versaointegerrequired

Sempre enviar o valor atual da versão.

Example: 1
data_pagamento_esperadostring(date)
Example: "2024-07-15"
metodo_pagamentostring
Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
perdaobject
nsustring
Example: 1029384756
pagamento_agendadoboolean
Example: false
id_conta_financeirastring(uuid)
Example: "e12a84ed-fb5c-4b8c-af56-4448b947337c"
curl -i -X PATCH \
  https://developers.contaazul.com/_mock/openapi/v1/financeiro/eventos-financeiros/parcelas/9986f173-f531-4660-96ae-04b71c879264 \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "nota": "Nota da parcela",
    "descricao": "Descrição da parcela",
    "vencimento": "2024-07-15",
    "composicao_valor": {
      "multa": 100.25,
      "juros": 1.5,
      "valor_bruto": 275.99,
      "valor_liquido": 250.33,
      "desconto": 2.1,
      "taxa": 4.4
    },
    "versao": 1,
    "data_pagamento_esperado": "2024-07-15",
    "metodo_pagamento": "CARTAO_CREDITO",
    "perda": {
      "data": "2024-07-15",
      "valor": 1.99
    },
    "nsu": 1029384756,
    "pagamento_agendado": false,
    "id_conta_financeira": "e12a84ed-fb5c-4b8c-af56-4448b947337c"
  }'

Responses

Operação realizada com sucesso

Bodyapplication/json
notastring
Example: "Nota da parcela"
descricaostring
Example: "Descrição da parcela"
vencimentostring(date)
Example: "2024-07-15"
composicao_valorobject
versaointeger

Nova versão da parcela após salva as alterações.

Example: 1
data_pagamento_esperadostring(date)
Example: "2024-07-15"
metodo_pagamentostring
Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
perdaobject
nsustring
Example: 1029384756
pagamento_agendadoboolean
Example: false
conta_financeiraobject
Response
application/json
{
  "nota": "Nota da parcela",
  "descricao": "Descrição da parcela",
  "vencimento": "2024-07-15",
  "composicao_valor": {
    "multa": 100.25,
    "juros": 1.5,
    "valor_bruto": 275.99,
    "valor_liquido": 250.33,
    "desconto": 2.1,
    "taxa": 4.4
  },
  "versao": 1,
  "data_pagamento_esperado": "2024-07-15",
  "metodo_pagamento": "CARTAO_CREDITO",
  "perda": {
    "data": "2024-07-15",
    "valor": 1.99
  },
  "nsu": 1029384756,
  "pagamento_agendado": false,
  "conta_financeira": {
    "id": "6bac0a7f-0422-48a9-86ea-0b1f0a6f9db9",
    "versao": 1,
    "nome": "Nome do banco",
    "agencia": 1,
    "numero": 123,
    "tipo": "OUTROS",
    "banco": "OUTROS"
  }
}

Produto

Operations

Cadastro de Pessoas

Operations

Protocolo

Operations

Venda

Operations

Serviço

Operations