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ção | URL Exemplo |
|---|---|
| POST | {{url_base}}/PostUpdateInvoiceNoSalesReturnOrder |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostUpdateInvoiceNoSalesReturnOrder" |
Parâmetros de Entrada
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| SalesReturnOrderNo | String(25) | Sim | Código externo do pedido de devolução de venda |
| BranchNo | String(25) | Sim | Código externo da filial |
| InvoiceNo | String(25) | Não | Número da nota fiscal |
| BillingDateOrder | DataHora | Não | Data de faturamento |
| ErrorIfNotFound | Boolean | Não | Retorna erro caso o pedido informado não exista no banco de dados |
Retorno
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sim | Informaçõ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ódigo | Mensagem |
|---|---|
| UIR‑001 | O 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ção | URL Exemplo |
|---|---|
| POST | {{url_base}}/PostUpdateInvoiceToTransporterReturnOrder |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostUpdateInvoiceToTransporterReturnOrder" |
Parâmetros de Entrada
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| SalesReturnOrderNo | String(25) | Sim | Código externo do pedido de devolução de venda |
| BranchNo | String(25) | Sim | Código externo da filial |
| InvoiceNo | String(25) | Não | Número da nota fiscal |
| InvoiceSeriesNo | String(10) | Não | Número da série da nota fiscal |
| ItemList | UpdateInvoiceToTransporterReturnOrderItemList | Não | Lista de itens do Pedido de Devolução de Venda |
| ErrorIfNotFound | Boolean | Não | Retorna erro caso o pedido informado não exista no banco de dados |
Observação
- Se não informar os parâmetros
InvoiceNoeInvoiceSeriesNo, os campos serão salvos nulos. - Se informado o parâmetro
InvoiceNo, o parâmetroInvoiceSeriesNodeve 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âmetro Tipo Obrigatório Descrição ProductNo String(25) Sim Código externo do produto Qty Integer Não Quantidade de caixas Weight Float Não Peso 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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sim | Informaçõ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ódigo | Mensagem |
|---|---|
| UIT‑001 | O 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‑002 | O 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! |