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 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.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_token	string	Sim	Token da unidade onde os pedidos serão buscados.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
date_from	string	Sim	Data inicial (YYYY-MM-DD) para filtrar por estimated_payment_date.	2025-11-01
date_to	string	Sim	Data final (YYYY-MM-DD) para filtrar por estimated_payment_date.	2025-11-30
id_token_project	string	Não	Token do projeto associado ao pedido.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
id_token_contact	string	Não	Token do contato associado ao pedido.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
id_token_stock_item	string	Não	Token do produto/serviço associado ao pedido.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
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.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
code_orders	string	Não	Código interno do pedido (campo cod_orders).	PV-202511-98sTqMKu0Mc

---

Exemplo de Requisição

curl -X POST 'https://portal.fipli.pro/api/v1/list_sales_orders'   -H 'Content-Type: application/json'   -d '{
    "access_token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "unit_token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "date_from": "2025-11-01",
    "date_to": "2025-11-30",
    "active": true
  }'

---

Resposta

200 OK

{
  "success": true,
  "data": [
    {
      "id_token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "created_date_hours": "26/11/2025 11:05",
      "active": true,
      "freight_mode": 9,
      "freight_total": "0.00",
      "notify_email_charge": null,
      "notify_email_nf": null,
      "notify_email_alert": null,
      "local_destino": 0,
      "products_qty": null,
      "tipo_documento": null,
      "finalidade_emissao": null,
      "presenca_comprador": null,
      "consumidor_final": null,
      "observation_sales": null,
      "id_unit": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "id_stock_item": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "id_project": null,
      "id_contact": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "id_bank_account": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "payment_type": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "description": "teste",
      "value": "10.00",
      "id_token_category": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "category": "Via API",
      "estimated_payment_date": "2025-11-26T03:00:00.000Z",
      "recurrence": false,
      "quantity": "1.00",
      "cod_orders": "PV-202511-98sTqMKu0Mc",
      "nf": false,
      "revenue": true,
      "charge": false,
      "cancel_nf": false,
      "cancel_charge": false,
      "date_nf": null,
      "date_revenue": "26/11/2025 11:07",
      "date_charge": null,
      "date_cancel_nf": "26/11/2025 11:16",
      "date_cancel_charge": "26/11/2025 11:16",
      "date_payment": "26/11/2025 11:16",
      "service_assoc_id": null,
      "service_cod": null,
      "service_location": null,
      "tax_service_gross_amount": null,
      "tax_service_deduction_amount": "0.00",
      "tax_service_uncond_discount_amount": "0.00",
      "tax_service_cond_discount_amount": "0.00",
      "tax_iss_rate_percent": null,
      "tax_service_base_amount": null,
      "tax_iss_amount": null,
      "ret_pis_rate_percent": null,
      "ret_inss_rate_percent": null,
      "ret_csll_rate_percent": null,
      "ret_cofins_rate_percent": null,
      "ret_ir_rate_percent": null,
      "ret_other_rate_percent": null,
      "ret_pis_amount": null,
      "ret_inss_amount": null,
      "ret_csll_amount": null,
      "ret_cofins_amount": null,
      "ret_ir_amount": null,
      "ret_other_amount": null,
      "ret_total_amount": null,
      "net_receivable_amount": null,
      "payment_key": "BOLETO",
      "pix_key": null,
      "charge_status": "CANCELLED",
      "nf_status_text": null,
      "nf_kind": "nfse",
      "products": null,
      "product_id_tokens": [],
      "unit_name": "Principal Beta",
      "unit_city_ibge": "3549904",
      "unit_im": "452154",
      "stock_item_name": "AOficial",
      "project_name": null,
      "contact_name": "BETA FIPLI",
      "customer_city_ibge": "3549904",
      "nick_name_bank_account": "Saldo"
    }
  ]
}

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).
400	"Parâmetros de data são obrigatórios."	date_from e date_to não informados.
500	"Erro desconhecido"	Erro interno ao listar os pedidos.