Documentação da API

POST /list_sales_orders

Resumo

Este endpoint retorna pedidos de venda filtrados conforme os parâmetros enviados na requisição.

Descrição

Utilize este endpoint para obter uma lista de pedidos de venda (sales orders) de uma unidade específica, podendo filtrar por projeto, contato, produto, categoria, código do pedido e outros parâmetros.

---

Requisição

Body da Requisição

O corpo da requisição deve ser um objeto JSON. Os parâmetros abaixo são aceitos:

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
access_token	string	Sim	Token de autenticação do usuário.	b31643fc-a45f-448c-99ee-736a547f6989
unit_token	string	Sim	Token da unidade onde os pedidos serão buscados.	e6988e9e-b0c1-410c-ae08-aed7c64ac71f
date_from	string	Sim	Data inicial onde os pedidos serão buscados.	20025-11-01
date_to	string	Sim	Data final onde os pedidos serão buscados.	2025-11-30
id_project	string	Não	Token do projeto associado ao pedido (filtra pelos pedidos daquele projeto).	baf65ec0-8335-42c1-8899-6de18e2b9bc6
id_contact	string	Não	Token do contato associado ao pedido.	3aeb0f0c-2b94-4ec7-bc3d-e1d7f6e8ac11
id_stock_item	string	Não	Token do produto/serviço associado ao pedido.	a1b2c3d4-5678-4b3c-9de0-000011112222
active	boolean	Não	Se informado, filtra por pedidos ativos (true) ou inativos (false).	true
id_token_category	string	Não	Token da categoria associada ao pedido.	cat-1234-5678-90ab-cdef12345678
service_assoc_id	number	Não	ID associado ao serviço (quando houver relação com uma ordem/serviço externo).	123
cod_orders (cod_pv)	string	Não	Código interno do pedido de venda (campo cod_orders).	PV-2024-0001

---

Exemplo de Requisição

curl -X POST 'https://portal.fipli.pro/api/v1/list_sales_orders' -H 'Content-Type: application/json' -H 'userlogged: <jwt>' -d '{
  "access_token": "b31643fc-a45f-448c-99ee-736a547f6989",
  "unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f",
  "id_project": "baf65ec0-8335-42c1-8899-6de18e2b9bc6",
  "active": true
}'

---

Resposta

200 OK

{
  "success": true,
  "data": [
    {
      "token": "d3e9f2b7-54ce-4d96-b729-51e4af6b9c10",
      "cod_orders": "PV-2024-0001 - (cod_pv)" ,
      "description": "Venda de serviço de consultoria",
      "value": 3500.00,
      "quantity": 1,
      "created_date": "02/09/2024 12:07",
      "project_token": "baf65ec0-8335-42c1-8899-6de18e2b9bc6",
      "contact_token": "3aeb0f0c-2b94-4ec7-bc3d-e1d7f6e8ac11",
      "stock_item_token": "a1b2c3d4-5678-4b3c-9de0-000011112222",
      "id_token_category": "cat-1234-5678-90ab-cdef12345678",
      "active": true,
      "nf_status": "nao_emitida",
      "charge_status": "OPEN"
    }
  ]
}

4xx e 5xx Erros

{
  "success": false,
  "error": "Invalid data"
}

---

Erros Comuns

Status	Mensagem	Descrição
403	"Invalid data"	Falha na autenticação (access_token ou unit_token inválidos).
500	"Erro desconhecido"	Erro interno ao listar os pedidos.