Skip to main content

Upload de Nota Fiscal

Este é o recurso responsável pelo upload de nota fiscal. Após o envio da nota fiscal, o pedido referente a nota terá seu status alterado para Valor confirmado, pedido liberado para entrega caso o valor da nota seja o mesmo do pedido. Se a nota fiscal tiver uma atualização de valor o pedido terá seu status alterado para Valor alterado e liberado para entrega.
Para fazer o upload da nota fiscal, o pedido deve possuir o status Pedido aprovado, aguardando valor final do faturamento (Status 10).

Nota

Não é possível fazer o upload de nota fiscal para pedidos que tem como forma de pagamento Boleto Bancário.

Iniciando a sessão​

Altere o método da requisição para o tipo POST.

ordr1

Configurando a URL da requisição​

Nesse caso, devemos configurar a URL no endpoint /integrator/api/v1/orders/upload-invoice/{id_pedido}/

ordr2

Configurando a aba Authorization​

Na aba Authorization altere o Type para Bearer Token.

ordr3

Inserindo o token de autorização​

Insira seu token de autorização (obtido aqui).

ordr4

Inserindo o arquivo da Nota Fiscal que será feito o Upload​

Selecione o arquivo xml da Nota Fiscal na aba Body>form-data e clique em Send para fazer o upload.

CAMPOTIPOOBSERVAÇÃO
fileFileFormato XML

ordr5

ordr6

Retorno da requisição​

Após o envio da Nota Fiscal, será retornada uma mensagem com o valor total.

ordr7

Modelo de retorno de dados
{
    "total_value": 1500
}

Erros que podem ser retornados​

STATUSCONTEÚDODESCRIÇÃO
403{"error": true, "detail": "Total amount exceeds total!"}Valor total da nota fiscal excede o limite do pedido
403{"error": true, "detail": "Invalid Invoice!"}Nota fiscal não é válida
403{"error": true, "detail": "Only invoices in xml format are accepted!"}Formato da nota fiscal não é um XML
403{"error": true, "detail": "Customer document not found!"}Documento do cliente não foi encontrado
403{"error": true, "detail": "Invoice File already exists!"}Já existe uma nota fiscal cadastrada para o pedido
403{"error": true, "detail": "Error updating order!"}Erro ao atualizar pedido
403{"error": true, "detail": "Transition of status not allowed!"}Pedido não satisfaz o fluxo de status
403{"error": true, "detail": "The payment method used is not accepted!"}Meio de pagamento não é permitido
403{"error": true, "detail": "Invoice number already exists!"}Já existe uma nota fiscal cadastrada com esse número de série para o pedido
404{"error": true, "detail": "Order not exists!"}Pedido não existe