# QX API

- [Introdução](https://developers.useqx.com/introduction.md): O que a API do QX faz e como começar.
- [Guia rápido](https://developers.useqx.com/quickstart.md): Crie um contato e uma coleta, envie uma fatura e leia os campos da fatura.
- [Autenticação](https://developers.useqx.com/authentication.md): Como a chave de API identifica a organização, e os limites de cada chave.
- [Erros](https://developers.useqx.com/errors.md): O formato dos erros e os códigos da API.
- [Paginação](https://developers.useqx.com/pagination.md): Como percorrer uma lista página por página.
- [Idempotência](https://developers.useqx.com/idempotency.md): Como repetir uma escrita sem gravar o recurso duas vezes.
- [Listar as coletas](https://developers.useqx.com/api-reference/coletas/listar-as-coletas.md): Lista as coletas da organização da chave, da coleta mais nova à mais antiga. A lista não traz a coleta arquivada. `GET /collections/{id}` mostra a coleta arquivada, com `discarded` igual a `true`. Cada filtro reduz a lista, e os filtros valem juntos.
- [Criar uma coleta](https://developers.useqx.com/api-reference/coletas/criar-uma-coleta.md): Cria uma coleta com um pacote. Com um contato, a coleta nasce com os slots dos requisitos do pacote. Sem contato, a API cria a coleta para um destinatário e manda o convite ao e-mail dele. Os slots nascem depois que o destinatário se identifica no portal. A criação conta no limite de escritas pagas…
- [Ler uma coleta](https://developers.useqx.com/api-reference/coletas/ler-uma-coleta.md): Lê uma coleta da organização da chave, com os documentos da coleta. A chamada acha também a coleta arquivada.
- [Listar os contatos](https://developers.useqx.com/api-reference/contatos/listar-os-contatos.md): Lista as pessoas e as empresas da organização da chave, do contato mais novo ao mais antigo. A lista não traz o contato arquivado nem o sócio que a consulta do CNPJ criou. Cada filtro reduz a lista, e os filtros valem juntos.
- [Criar um contato](https://developers.useqx.com/api-reference/contatos/criar-um-contato.md): Cria uma pessoa pelo CPF ou uma empresa pelo CNPJ. O QX consulta o CPF ou o CNPJ depois da criação, e o `lookup_status` mostra o andamento da consulta. A criação conta no limite de escritas pagas da chave.
- [Ler um contato](https://developers.useqx.com/api-reference/contatos/ler-um-contato.md): Lê uma pessoa ou uma empresa da organização da chave. A chamada acha também o contato arquivado e o sócio que a consulta do CNPJ criou.
- [Listar os documentos de um contato](https://developers.useqx.com/api-reference/documentos/listar-os-documentos-de-um-contato.md): Lista os documentos de um contato, do documento mais novo ao mais antigo. A lista traz os documentos das coletas e os documentos da Triagem. O slot vazio de uma coleta entra na lista com `status` igual a `pending`. A lista não traz o documento descartado. `GET /documents/{id}` mostra o documento des…
- [Enviar um documento](https://developers.useqx.com/api-reference/documentos/enviar-um-documento.md): Envia o arquivo de um documento, com o contato e o tipo do documento. Uma chamada leva um arquivo, e o arquivo vira um documento. Sem `collection_id`, o documento entra na Triagem, como o documento que chega por e-mail. A leitura começa, e o encaixe procura uma coleta para o documento quando a leitu…
- [Ler um documento](https://developers.useqx.com/api-reference/documentos/ler-um-documento.md): Lê um documento da organização da chave, com os campos que a leitura extraiu. A chamada acha também o documento descartado.
- [Gravar campos ou preencher um slot](https://developers.useqx.com/api-reference/documentos/gravar-campos-ou-preencher-um-slot.md): Faz uma de duas mudanças num documento. Com `fields`, em JSON, a chamada grava as respostas dos campos, e o valor gravado vence o valor que a leitura extraiu. O documento da Triagem volta ao encaixe, e a coleta do documento roda as validações de novo. Com `file`, em `multipart/form-data`, a chamada…
- [Listar os pacotes](https://developers.useqx.com/api-reference/pacotes/listar-os-pacotes.md): Lista os pacotes da organização da chave, do mais novo ao mais antigo. A lista traz os pacotes ativos e os inativos. Cada pacote traz os requisitos na ordem do pacote.

## OpenAPI Specs

- [openapi](/openapi.yaml)