Pular para o conteúdo principal

Documentação da API

POST /get_sales_order_by_id​

Resumo​

Retorna os detalhes de um único pedido de venda pelo token.

Requisição​

Body da Requisição​

ParâmetroTipoObrigatórioDescriçãoExemplo
access_tokenstringSimToken de autenticação do usuário.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_tokenstringSimToken da unidade do pedido.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
id_tokenstringSimToken do pedido de venda.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Exemplo de Requisição​

curl -X POST 'https://portal.fipli.pro/api/v1/get_sales_order_by_id'   -H 'Content-Type: application/json'   -d '{
    "access_token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "unit_token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "id_token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
  }'

Resposta​

200 OK​

{
  "success": true,
  "data": {
    "id_token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "active": true,
    "freight_mode": 9,
    "freight_total": "0.00",
    "local_destino": null,
    "products_qty": 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": null,
    "description": null,
    "value": "150.00",
    "id_token_category": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "category": "Via API",
    "estimated_payment_date": "2025-10-01T03:00:00.000Z",
    "quantity": "1.00",
    "cod_orders": "PV-202510-bg54BuPCeyw",
    "nf": false,
    "revenue": false,
    "charge": false,
    "cancel_nf": false,
    "cancel_charge": false,

    "date_nf": "01/10/2025",
    "date_revenue": null,
    "date_charge": null,
    "date_cancel_nf": "09/10/2025",
    "date_cancel_charge": null,

    "service_assoc_id": "18",
    "service_cod": "1520",
    "service_location": "São José dos Campos - SP",

    "tax_service_gross_amount": "150.00",
    "tax_service_deduction_amount": "777.00",
    "tax_service_uncond_discount_amount": "40.00",
    "tax_service_cond_discount_amount": "50.00",
    "tax_iss_rate_percent": "2.0000",
    "tax_service_base_amount": "0.00",
    "tax_iss_amount": "0.00",

    "ret_pis_rate_percent": "0.6500",
    "ret_inss_rate_percent": "0.5100",
    "ret_csll_rate_percent": "1.0000",
    "ret_cofins_rate_percent": "3.0000",
    "ret_ir_rate_percent": "1.5000",
    "ret_other_rate_percent": "0.0000",

    "ret_pis_amount": "0.00",
    "ret_inss_amount": "0.00",
    "ret_csll_amount": "0.00",
    "ret_cofins_amount": "0.00",
    "ret_ir_amount": "0.00",
    "ret_other_amount": "0.00",
    "ret_total_amount": "0.00",

    "net_receivable_amount": "150.00",

    "payment_key": "BOLETO",
    "pix_key": null,

    "charge_status": null,
    "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": "Principal Beta",
    "project_name": null,
    "contact_name": "BETA FIPLI",
    "customer_city_ibge": "3549904",
    "nick_name_bank_account": null
  }
}

Erros​

400 - Missing id parameter​

{
  "success": false,
  "error": "Missing id parameter"
}

403 - Invalid data​

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

500 - Erro interno​

{
  "success": false,
  "error": "Erro desconhecido"
}