# Lista de fornecedores

Retorna lista de fornecedores.

Endpoint: GET /api/v3/suppliers
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Query parameters:

  - `search` (string)
    Filtra pelas principais propriedades do fornecedor, incluindo name, company_name, cnpj e cpf.
    Example: "Connectplug"

  - `document_type` (string)
    Indica o tipo do documento.

- cpf: CPF Pessoa física.
- rg: RG Pessoa física.
- cnpj: CNPJ Pessoa jurídica.
- ie: Inscrição Estadual Pessoa jurídica.
- im: Inscrição Municipal Pessoa jurídica.
    Enum: "cpf", "rg", "cnpj", "ie", "im"

  - `document_value` (string)
    Filtro pelo Valor do documento.
    Example: "22423374000152"

  - `updated_from` (string)
    Filtra por dados que foram atualizadas a partir de uma data. (Formato: YYYY-MM-DDThh:mm:ss+hh:mm).

  - `deleted` (string)
    Filtro para indicar se deve retornar dados apagados ou não.
    Enum: "not_include", "include", "only"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.suppliers` (array)
    Representa a lista de fornecedores

  - `data.suppliers.id` (integer)
    Identificador único do Fornecedor.
    Example: 123

  - `data.suppliers.name` (string)
    Nome do fornecedor pessoa física ou Razão social.
    Example: "Nome do Fornecedor"

  - `data.suppliers.type` (string)
    Tipo do fornecedor.

- individual (Pessoa física)
- company (Pessoa jurídica)
    Enum: "individual", "company"

  - `data.suppliers.company_name` (string)
    Razão social da pessoa jurídica.
    Example: "MyCompany"

  - `data.suppliers.documents` (array)
    Lista de documentos do fornecedor.

  - `data.suppliers.documents.type` (string, required)
    Indica o tipo do documento.

- cpf: CPF Pessoa física
- rg: RG Pessoa física
- cnpj: CNPJ Pessoa jurídica
- ie: Inscrição Estadual Pessoa jurídica
- im: Inscrição Municipal Pessoa jurídica
    Enum: "cpf", "rg", "cnpj", "ie", "im"

  - `data.suppliers.documents.identify` (string, required)
    Identificação do documento.
    Example: "11144477735"

  - `data.suppliers.founding_date` (string)
    Data da fundação da empresa. Formato "YYYY-MM-DD"
    Example: "2016-01-15"

  - `data.suppliers.birthday` (string)
    Data de nascimento do fornecedor, caso ele não seja uma pessoa jurídica. Formato "YYYY-MM-DD"
    Example: "1990-12-25"

  - `data.suppliers.inscricao_suframa` (string)
    Número de identificação e controle gerado por ocasião do cadastramento e vinculado a cada pessoa jurídica ou física, devendo ser utilizada exclusivamente para a viabilização dos serviços prestados pela SUFRAMA
    Example: "123456789"

  - `data.suppliers.notes` (string)
    Observações relacionadas ao fornecedor
    Example: "Uma anotação sobre o fornecedor"

  - `data.suppliers.address` (object)
    Endereço do fornecedor

  - `data.suppliers.address.id` (number)
    id do endereço.
    Example: 220

  - `data.suppliers.address.nickname` (string)
    Apelido do endereço.
    Example: "Casa"

  - `data.suppliers.address.type` (string, required)
    Tipo do endereço.

- default endereço principal.
- shipping endereço de entrega.
- charge endereço de cobrança.
- other outro tipo de endereço.
    Enum: "default", "shipping", "charge", "other"

  - `data.suppliers.address.street` (string, required)
    Nome do logradouro (Rua, Avenida, praça, etc).
    Example: "Avenida Paulista"

  - `data.suppliers.address.number` (string)
    Número do logradouro.
    Example: "42 A"

  - `data.suppliers.address.city_id` (number)
    ID da cidade.

Obrigatório quando o campo ibge_code não for passado.
    Example: 1234

  - `data.suppliers.address.ibge_code` (string)
    Código do município segundo IBGE.

Exemplo: O código do município segundo IBGE é 3550308

Obrigatório quando o campo city_id não for passado.
    Example: "3550308"

  - `data.suppliers.address.state` (string)
    Sigla do estado do endereço.
    Example: "SP"

  - `data.suppliers.address.city` (string)
    Nome da cidade.
    Example: "São Paulo"

  - `data.suppliers.address.neighborhood` (string)
    Nome do Bairro.
    Example: "Bela Vista"

  - `data.suppliers.address.complement` (string)
    Complemento do endereço.
    Example: "Apto 2550"

  - `data.suppliers.address.zip_code` (string)
    CEP do endereço.
    Example: "01311000"

  - `data.suppliers.contacts` (object)
    Contato do fornecedor

  - `data.suppliers.contacts.type` (string, required)
    Indica o tipo do contato.

- mobile: Número de telefone celular
- phone: Número de telefone (fixo ou celular)
- email: E-mail de contato
    Enum: "mobile", "phone", "email"

  - `data.suppliers.contacts.value` (string, required)
    Dados do contato.
    Example: "joe@example.com"

  - `data.suppliers.contacts.id` (number)
    Id do contato na CPlug.
    Example: 271

  - `data.suppliers.companies` (array)
    Lista de empresas que permite visualizar

  - `data.suppliers.companies.id` (integer)
    Identificador único da empresa
    Example: 1234

  - `data.suppliers.companies.name` (string)
    Nome fantasia da empresa.
    Example: "CPlug"

  - `data.suppliers.companies.company_name` (string,null)
    Razão social da empresa.
    Example: "CPlug Tecnologia da Informação"

  - `data.suppliers.created_at` (string)
    Data da última criação.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.suppliers.updated_at` (string)
    Data da última atualização.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.suppliers.deleted` (boolean)
    Informa se o registro está excluído

  - `meta` (object)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields