Meu Dinheiro · API
Contatos

Lista os contatos

GET
/contatos

Os clientes e fornecedores do workspace, com documento, e-mail, telefones e endereço. Inclui os inativos. tipo_contato=cliente traz também quem é cliente e fornecedor (ambos); o mesmo vale para fornecedor.

Autenticação

accessToken
headerAuthorizationBearer <token>

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

Parâmetros de consulta

limit?integer

Itens por página.

Faixa1 <= value <= 500
Padrão100
cursor?string

O next_cursor da página anterior. Omita na primeira página.

tipo_pessoa?string
Valores"fisica""juridica"
tipo_contato?string
Valores"cliente""fornecedor""ambos"
status?string

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

Valores"active""inactive"

Corpo da resposta

Uma página.

application/json
  1. response
data*array<>
next_cursor*|

Cursor da próxima página; nulo na última.

curl -X GET "https://example.com/contatos"
{  "data": [    {      "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"      }    }  ],  "next_cursor": "string"}

Altera um projeto (todos os campos) PUT

Troca todos os campos; `inicio`, `fim` e as metas aceitam nulo. Para alterar só alguns, use `PATCH`. Exige o papel **Editor** ou um papel com permissão de editar Projetos.

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}`.