Pular para o conteúdo principal

Atualizar Pedido de Devolução


Atualiza informações de faturamento

O endpoint PostUpdateInvoiceNoSalesReturnOrder atualiza nota fiscal e a data de faturamento em um pedido de devolução de venda no MIMS


Como atualizar nota fiscal e a data de faturamento no pedido de devolução

Request HTTP Post

Tipo da RequisiçãoURL Exemplo
POST{{url_base}}/PostUpdateInvoiceNoSalesReturnOrder
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostUpdateInvoiceNoSalesReturnOrder"

Parâmetros de Entrada

ParâmetroTipoObrigatórioDescrição
SalesReturnOrderNoString(25)SimCódigo externo do pedido de devolução de venda
BranchNoString(25)SimCódigo externo da filial
InvoiceNoString(25)NãoNúmero da nota fiscal
BillingDateOrderDataHoraNãoData de faturamento
ErrorIfNotFoundBooleanNãoRetorna erro caso o pedido informado não exista no banco de dados

Retorno

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformações padrão de resposta do WebService na execução do método

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostUpdateInvoiceNoSalesReturnOrder"' \
--header 'Content-Type: application/json' \
--data '{
"SalesReturnOrderNo": "249",
"BranchNo": "010",
"InvoiceNo": "0018",
"BillingDateOrder": "2025-07-17T01:00:00",
"ErrorIfNotFound": false
}'

Exemplo de Response

{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
}
}

🐞 Possíveis Erros

CódigoMensagem
UIR‑001O número da Nota Fiscal não pode ser atualizado para o pedido de devolução ([valor enviado na requisição]) do tipo Sobras. Processo abortado!


Atualiza nota fiscal e quantidades expedidas

O endpoint PostUpdateInvoiceToTransporterReturnOrder atualiza os dados da nota fiscal e ajusta as quantidades expedidas do ERP em um pedido de devolução de venda no sistema MIMS.


Como atualizar nota fiscal e quantidades expedidas no pedido de devolução

Request HTTP Post

Tipo da RequisiçãoURL Exemplo
POST{{url_base}}/PostUpdateInvoiceToTransporterReturnOrder
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostUpdateInvoiceToTransporterReturnOrder"

Parâmetros de Entrada

ParâmetroTipoObrigatórioDescrição
SalesReturnOrderNoString(25)SimCódigo externo do pedido de devolução de venda
BranchNoString(25)SimCódigo externo da filial
InvoiceNoString(25)NãoNúmero da nota fiscal
InvoiceSeriesNoString(10)NãoNúmero da série da nota fiscal
ItemListUpdateInvoiceToTransporterReturnOrderItemListNãoLista de itens do Pedido de Devolução de Venda
ErrorIfNotFoundBooleanNãoRetorna erro caso o pedido informado não exista no banco de dados
Observação
  • Se não informar os parâmetros InvoiceNo e InvoiceSeriesNo, os campos serão salvos nulos.
  • Se informado o parâmetro InvoiceNo, o parâmetro InvoiceSeriesNo deve ser informado também.

📝 Objeto UpdateInvoiceToTransporterReturnOrderItemList

O objeto UpdateInvoiceToTransporterReturnOrderItemList representa uma lista de itens do pedido de devolução, contendo informações sobre produtos, quantidades e pesos para atualização.

Parâmetros de Entrada

ParâmetroTipoObrigatórioDescrição
ProductNoString(25)SimCódigo externo do produto
QtyIntegerNãoQuantidade de caixas
WeightFloatNãoPeso das caixas
Observação
  • O parâmetro Qty é obrigatório se o parâmetro "Weight" não for informado.
  • O parâmetro Weight é obrigatório se o parâmetro "Qty" não for informado.

Retorno

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformações padrão de resposta do WebService na execução do método

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostUpdateInvoiceToTransporterReturnOrder"' \
--header 'Content-Type: application/json' \
--data '{
"SalesReturnOrderNo": "RET123",
"BranchNo": "BR001",
"InvoiceNo": "NF123456",
"InvoiceSeriesNo": "001",
"ItemList": [
{
"ProductNo": "PROD001",
"Qty": 5,
"Weight": 10.0
}
],
"ErrorIfNotFound": false
}'

Exemplo de Response

{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
}
}

🐞 Possíveis Erros

CódigoMensagem
UIT‑001O item "[descrição do parâmetro]" valor "[valor enviado na requisição]" no índice [[código do índice]] deverá ter Quantidade "Qty" ou Peso "Weight" informado!
UIT‑002O produto "[descrição do parâmetro]" fornecido ([valor enviado na requisição]) no índice [[código do índice]] não está vinculado ao pedido de devolução de venda informado!