Arquivos da empresa

Arquivos guardam documentos da empresa, como contrato social e certidões, cada um classificado por categoria. Correspondem à aba Arquivos, na tela Empresas. Os mesmos endpoints servem a fornecedores, com {type} igual a vendors; veja Arquivos do fornecedor.

Endpoints

Método	Caminho	Descrição
GET	/administrative/business/{customer_vendor_uuid}/files	Lista os arquivos da empresa
GET	/administrative/{type}/{customer_vendor_uuid}/files	Lista os arquivos (type = business ou customers)
POST	/administrative/{type}/{customer_vendor_uuid}/files	Anexa um arquivo
POST	/administrative/{type}/{customer_vendor_uuid}/files/{id}	Substitui o arquivo ou os dados de um registro existente
GET	/administrative/{type}/{customer_vendor_uuid}/files/{id}	Baixa o arquivo
DELETE	/administrative/{type}/{customer_vendor_uuid}/files/{id}	Apaga o registro e o arquivo guardado
GET	/administrative/business/file-types	Lista as categorias de arquivo

{type} aceita business ou customers, e o {customer_vendor_uuid} é o uuid da empresa. O {id} é o id numérico do arquivo.

As categorias de arquivo são cadastradas em Configurações e listadas pelo endpoint de categorias desta página.

Endpoints de arquivos

GET /administrative/business/{customer_vendor_uuid}/files

GET /administrative/{type}/{customer_vendor_uuid}/files

Lista os arquivos da empresa.

Parâmetros de URL

Parâmetro	Descrição
search	Busca pela categoria do arquivo
columnName e orderData	Ordenação: coluna e direção
per_page e page	Paginação

Resposta: 200, lista de arquivos com id, customer_vendor_id, file_type_id, file_type (nome da categoria), description, expiration_date, upload (dados do arquivo guardado) e os nomes de quem criou e alterou.

POST /administrative/{type}/{customer_vendor_uuid}/files

POST /administrative/{type}/{customer_vendor_uuid}/files/{id}

Anexa um arquivo à empresa. Envie em multipart/form-data. Com {id}, o arquivo do registro é substituído pelo novo, quando um arquivo for enviado, e os demais campos são atualizados.

Corpo

Campo	Obrigatório	Tipo	Descrição
file	Sim na criação. Não na alteração	Arquivo	PDF, JPG, JPEG ou PNG
file_type_id	Sim	Inteiro	Id da categoria de arquivo. Deve existir
description	Não	Texto	Descrição. Se ficar em branco, a tela usa o nome do arquivo
expiration_date	Não	Data (AAAA-MM-DD)	Data de vencimento. É apenas informativa

Resposta: 201 na criação, 200 na alteração, com o registro do arquivo.

GET /administrative/{type}/{customer_vendor_uuid}/files/{id}

Baixa o arquivo guardado. Se o registro ou o arquivo não existir, a resposta é 404 com {"success": false, "error": "File not found"}.

Resposta: 200, arquivo para download.

DELETE /administrative/{type}/{customer_vendor_uuid}/files/{id}

Apaga o registro e o arquivo guardado. A exclusão é lógica no registro.

Resposta: 200.

Categorias de arquivo

GET /administrative/business/file-types

Lista as categorias de arquivo cadastradas para o cliente, em ordem alfabética salvo se columnName e orderData forem informados.

Parâmetros de URL

Parâmetro	Descrição
search	Busca pelo nome da categoria
columnName e orderData	Ordenação: coluna e direção
per_page e page	Paginação

Resposta: 200, lista com id, uuid e file_type (nome da categoria).