Pular para o conteúdo principal

Listar contratos

POST /list_contracts​

Resumo​

Este endpoint retorna os contratos com base nos parâmetros fornecidos pelo usuário.

Descrição​

Utilize este endpoint para obter uma lista de contratos filtradas conforme os parâmetros passados na requisição.​

Requisição​

Body da Requisição​

O corpo da requisição deve ser um objeto JSON e é obrigatório. A seguir estão os parâmetros aceitos:

ParâmetroTipoDescriçãoExemplo
access_tokenstringToken de acesso (obrigatório).aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_tokenstringToken da unidade (obrigatório).aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
id_token_contactstringid do contato (opcional).aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Requisição de exemplo​

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

Respostas​

200 OK​

Em caso de sucesso, a resposta terá o seguinte formato:

{
  "success": true,
  "data": [
    {
      "id": "<id>",
      "contract_name": "<contract_name>",
      "validity_start": "<validity_start>",
      "validity_end": "<validity_end>",
      "is_recurring": "<is_recurring>",
      "recurrence_type": "<recurrence_type>",
      "effective_payment_value": "245.50",
      "id_sales_orders": "<id_sales_orders>",
      "created_date": "<created_date>",
      "active": "<active>",
      "description": "<description>",
      "files_data": [
        {
          "size": 99999,
          "filename": "<filename>",
          "mimetype": "<mimetype>",
          "year_inserted": "<year_inserted>",
          "month_inserted": "<month_inserted>",
          "original_filename": "<original_filename>"
        }
      ],
      "id_unit": "<id_unit>",
      "id_contact": "<id_contact>"
    }
  ]
}

effective_payment_value representa o valor do pedido de venda de referência (valor unitário multiplicado pela quantidade), em reais. A seleção considera apenas pedidos ativos vinculados ao contrato, prioriza pedidos internos e, entre os demais critérios de ordenação, datas futuras antes de datas passadas. O campo retorna null quando não há pedido de venda ativo associado; não representa a soma de todas as cobranças durante a vigência do contrato.

4xx e 5xx Erros​

Em caso de erro, success sera igual a false, seguido por uma menssagem de erro, por exemplo:

{ 
  "success": false, 
  "error": "Missing parameters",
  "data": []
}