API's Conta Azul Pro (v2)

API para gerenciamento de dados do ERP Conta Azul Pro

Download OpenAPI description

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

Serviço

Operations

Obter lista de serviços

Request

Query

paginainteger

Default 1

tamanho_paginainteger

Default 10

busca_textualstring

Busca textual por nome, código ou descrição do serviço

curl -i -X GET \
  'https://developers.contaazul.com/_mock/openapi/v1/servico?busca_textual=string&pagina=1&tamanho_pagina=10' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Resposta bem-sucedida

Bodyapplication/json

itens_totaisinteger

Example: 100

itensArray of objects

Response

application/json

{
  "itens_totais": 100,
  "itens": [
    { … }
  ]
}

Criação de serviço

Request

Criação um serviço

Bodyapplication/jsonrequired

idstring(uuid)

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

id_servicointeger

Example: 1

nomestring

Example: "Serviço de Consultoria"

codigostring

Example: "CONSULT01"

descricaostringrequired

Example: "Serviço de consultoria empresarial"

preconumber(double)

Example: 1500

custonumber(double)

Example: 1000

statusstring

Example: "DISABLED"

tipo_servicostring

Example: "PROVIDED"

curl -i -X POST \
  https://developers.contaazul.com/_mock/openapi/v1/servico \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "id_servico": 1,
    "nome": "Serviço de Consultoria",
    "codigo": "CONSULT01",
    "descricao": "Serviço de consultoria empresarial",
    "preco": 1500,
    "custo": 1000,
    "status": "DISABLED",
    "tipo_servico": "PROVIDED"
  }'

Responses

Serviço criado com sucesso

Bodyapplication/json

idstring(uuid)

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

id_servicointeger

Example: 1

nomestring

Example: "Serviço de Consultoria"

codigostring

Example: "CONSULT01"

descricaostringrequired

Example: "Serviço de consultoria empresarial"

preconumber(double)

Example: 1500

custonumber(double)

Example: 1000

statusstring

Example: "DISABLED"

tipo_servicostring

Example: "PROVIDED"

Response

application/json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "id_servico": 1,
  "nome": "Serviço de Consultoria",
  "codigo": "CONSULT01",
  "descricao": "Serviço de consultoria empresarial",
  "preco": 1500,
  "custo": 1000,
  "status": "DISABLED",
  "tipo_servico": "PROVIDED"
}

Obter serviço por UUID

Request

Busca os dados de um serviço pelo seu UUID

Path

uuidstringrequired

O UUID do serviço a ser recuperado

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

Responses

Serviço encontrado com sucesso

Bodyapplication/json

idstring(uuid)

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

id_servicointeger

Example: 1

nomestring

Example: "Serviço de Consultoria"

codigostring

Example: "CONSULT01"

descricaostringrequired

Example: "Serviço de consultoria empresarial"

preconumber(double)

Example: 1500

custonumber(double)

Example: 1000

statusstring

Example: "DISABLED"

tipo_servicostring

Example: "PROVIDED"

Response

application/json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "id_servico": 1,
  "nome": "Serviço de Consultoria",
  "codigo": "CONSULT01",
  "descricao": "Serviço de consultoria empresarial",
  "preco": 1500,
  "custo": 1000,
  "status": "DISABLED",
  "tipo_servico": "PROVIDED"
}

Exclusão em lote de serviços

Request

Exclui serviços em lote dado uma lista de UUIDs

Bodyapplication/jsonrequiredArray [

integer

]

curl -i -X DELETE \
  https://developers.contaazul.com/_mock/openapi/v1/servico/exclusao-lote \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    0
  ]'

Responses

Serviços excluídos com sucesso