Meu Dinheiro · API
Contatos

Um contato

GET
/contatos/{id}

Contato de outro workspace, ou inexistente, responde 404.

Autenticação

accessToken
headerAuthorizationBearer <token>

Access token (mda_…) obtido em POST /auth/token. Vale 1 hora.

Parâmetros de caminho

id*integer

Corpo da resposta

O item.

application/json
  1. response
id*integer
nome*string
razao_social*string|null
tipo_pessoa*TipoPessoa
Valores"fisica""juridica"
tipo_contato*TipoContato
Valores"cliente""fornecedor""ambos"
status*StatusCadastro

inactive: desativado no app, segue nos lançamentos antigos.

Valores"active""inactive"
categoria*|

A categoria de contato (o agrupamento que a área define), não a de lançamento.

documento*|

CPF ou CNPJ, só letras e números (o CNPJ pode ter letras desde 2026).

email*string|null
telefones*array<string>

Até três, como foram digitados.

endereco*|

Nulo quando o contato não tem endereço nenhum.

curl -X GET "https://example.com/contatos/0"
{  "id": 9120,  "nome": "Mercado Bom Preço",  "razao_social": "Bom Preço Comércio de Alimentos Ltda",  "tipo_pessoa": "fisica",  "tipo_contato": "cliente",  "status": "active",  "categoria": {    "id": 0,    "nome": "Atacado"  },  "documento": "12ABC34501DE35",  "email": "string",  "telefones": [    "(11) 3333-4444"  ],  "endereco": {    "logradouro": "string",    "numero": "string",    "complemento": "string",    "bairro": "string",    "cidade": "string",    "uf": "string",    "cep": "string"  }}

Cria um contato POST

Cria um contato ativo. `nome`, `tipo_pessoa` e `tipo_contato` são obrigatórios; o `documento` é validado (CPF na pessoa física, CNPJ, inclusive alfanumérico, na jurídica) e gravado sem pontuação. RG, nascimento, inscrições, observação, campos personalizados e anexos ficam fora do contrato. Exige o papel **Editor** ou um papel com permissão de editar Contatos. A resposta tem o mesmo formato do `GET /contatos/{id}`.

Altera um contato (só os campos enviados) PATCH

Altera somente os campos enviados; os ausentes ficam como estão. Trocar `tipo_pessoa` confere o documento gravado contra o tipo novo. Exige o papel **Editor** ou um papel com permissão de editar Contatos.