Documentação da API

POST /insert_sales_order

Resumo

Este endpoint permite criar um novo pedido de venda (sales order) em uma unidade específica.

---

Descrição

Utilize este endpoint para registrar um pedido de venda no sistema, podendo associá-lo a um projeto, contato, produto/serviço, categoria, conta bancária, bem como informar dados fiscais e de cobrança (boletos, PIX, etc.).

---

Requisição

Body da Requisição

O corpo deve ser um objeto JSON com os principais campos abaixo (os demais são opcionais e dependem da sua modelagem interna):

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 o pedido será criado.	e6988e9e-b0c1-410c-ae08-aed7c64ac71f
id_stock_item	string	Não	Token do produto/serviço principal do pedido.	a1b2c3d4-5678-4b3c-9de0-000011112222
description	string	Não	Descrição do pedido.	Venda de serviço de consultoria
value	number	Sim	Valor bruto do pedido.	3500.00
id_token_category	string	Não	Token da categoria financeira associada.	cat-1234-5678-90ab-cdef12345678
estimated_payment_date	string(date)	Não	Data estimada de pagamento (YYYY-MM-DD).	2024-10-15
id_project	string	Não	Token do projeto vinculado ao pedido.	baf65ec0-8335-42c1-8899-6de18e2b9bc6
id_contact	string	Não	Token do contato (cliente) vinculado ao pedido.	3aeb0f0c-2b94-4ec7-bc3d-e1d7f6e8ac11
quantity	number	Não	Quantidade principal negociada (se aplicável).	1
generate_cora	boolean	Não	Indica se deve gerar cobrança via Cora.	true
generate_c6	boolean	Não	Indica se deve gerar cobrança via C6 Bank.	false
generate_with_asaas	boolean	Não	Indica se deve gerar cobrança via Asaas.	true
generateNFWebhook	boolean	Não	Se true, configura o pedido para emissão automática de NF via webhook de pagamento.	true
payment_type	string	Não	Tipo de pagamento (ex.: boleto, pix, cartao, etc.).	boleto
id_bank_account	string	Não	Token da conta bancária de recebimento vinculada.	bank-1234-5678-90ab-cdef12345678

Além desses campos, é possível enviar campos fiscais como base de cálculo, alíquotas e valores de ISS, PIS, COFINS, INSS, IR, CSLL e outras retenções, conforme sua modelagem interna.

---

Exemplo de Requisição

curl -X POST 'https://portal.fipli.pro/api/v1/insert_sales_order' -H 'Content-Type: application/json' -d '{
  "access_token": "b31643fc-a45f-448c-99ee-736a547f6989",
  "unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f",
  "id_stock_item": "a1b2c3d4-5678-4b3c-9de0-000011112222",
  "description": "Venda de serviço de consultoria",
  "value": 3500.00,
  "id_project": "baf65ec0-8335-42c1-8899-6de18e2b9bc6",
  "id_contact": "3aeb0f0c-2b94-4ec7-bc3d-e1d7f6e8ac11",
  "payment_type": "boleto",
  "generate_with_asaas": true,
  "generateNFWebhook": true
}'

---

Resposta

{
  "success": true,
  "message": "Sales order inserted successfully",
  "data": {
    "token": "d3e9f2b7-54ce-4d96-b729-51e4af6b9c10",
    "code_orders": "PV-2024-0001"
  }
}

Erros Comuns

Status	Mensagem	Descrição
403	"Invalid data"	Autenticação inválida (access_token/unit_token).
500	"Erro ao inserir pedido"	Erro interno ao criar o pedido.