Documentação da API

POST /list_purchase_orders

Resumo

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

Descrição

Utilize este endpoint para obter uma lista de pedidos de compra de uma unidade específica, podendo filtrar por projeto, contato, 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	Não	Data inicial (YYYY-MM-DD) para filtrar por estimated_payment_date.	2025-11-01
date_to	string	Não	Data final (YYYY-MM-DD) para filtrar por estimated_payment_date.	2025-11-30
id_token_contact	string	Não	Token do contato associado ao pedido.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
category_id_token	string	Não	Token da categoria associada ao pedido.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
id_token_project	string	Não	Token do projeto associado ao pedido.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
search	string	Não	Pesquisa pedidos de compra.	``
access_key	string	Não	Chave de acesso do pedido.	``
code	string	Não	Código interno do pedido.	PV-202511-98sTqMKu0Mc

---

Exemplo de Requisição

curl -X POST 'https://portal.fipli.pro/api/v1/list_purchase_orders'   -H 'Content-Type: application/json'   -d '{
    "access_token": "<access_token>",
    "unit_token": "<unit_token>",
    "date_from": "<date_from>",
    "date_to": "<date_to>"
  }'

---

Resposta

200 OK

{
  "success": true,
  "data": [
    {
      "purchase_orders": "<purchase_orders>",
      "id": "<id>",
      "issueDate": "<issueDate>",
      "accessKey": "<accessKey>",
      "supplierName": "<supplierName>",
      "supplierCnpj": "<supplierCnpj>",
      "totalValue": "<totalValue>",
      "active": "<active>",
      "createdDate": "<createdDate>",
      "itemsTotal": "<itemsTotal>",
      "itemsTaxTotal": "<itemsTaxTotal>",
      "itemsCount": "<itemsCount>",
      "contactId": "<contactId>",
      "categoryId": "<categoryId>",
      "projectId": "<projectId>",
      "freightValue": "<freightValue>",
      "totalTax": "<totalTax>",
      "xmlFileName": "<xmlFileName>",
      "unitToken": "<unitToken>",
      "filesName": "<filesName>",
      "pdfsName": "<pdfsName>",
      "items": "<items>"
    }
  ]
}

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.