Documentação da API

POST /insert_purchase_order_by_access_key

Resumo

Este endpoint insere um pedido de compra.

Descrição

Utilize este endpoint para inserir um pedido de compra em uma unidade específica.

---

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
access_key	string	Sim	Chave de acesso do pedido.	``
category_id_token	string	Não	ID da categoria.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
project_id_token	string	Não	ID do projeto.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
bank_account_id_token	string	Não	ID da conta bancária.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
payment_method_id_token	string	Não	ID do método de pagamento.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
installment	string	Não	Parcelamento.	001/001
description	string	Não	Descrição.	``
user_id_token	string	Não	ID do usuário.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

---

Exemplo de Requisição

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

---

Resposta

200 OK

{
    "success": true,
    "data": {
        "ok": true,
        "id_purchase_order": "<id_purchase_order>"
    }
}

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.