Histórico da Página

01. DADOS GERAIS

Linha de Produto:	TOTVS Varejo Lojas
Segmento:	Varejo
Módulo:	SigaLoja (Controle de Loja)
Função:	RmiEnvPdvSyncObj
Ticket:	Não há.
Story:	DVARLOJ1-82488260

02. SITUAÇÃO/REQUISITO

Disponibilizar alguma maneira de consultar as notas fiscais de saída, onde seja possível visualizar os itens que já foram devolvidosforma de efetuar devolução de documentos de Saída.

03. SOLUÇÃO

Foi disponibilizada API no seguinte caminho: http://{urlRest}/api/retail/v1/notasaidanotaentrada/listadevolucao

A API utiliza o método POST, caso queria informar parâmetros para filtro os mesmos devem ser passados no corpo.

Exemplo:

{
    "dataInicio": "20220101",
    "dataFim": "20220914",
    "cupom": "39",
    "pagina": 1
}

Com esta API será possível efetuar a devolução de Documentos de Saída, gerando o Documento de Entrada com o tipo Devolução e na Nota de Credito para o Consumidor NCC.

Parâmetros de entrada (Request):

Parâmetro

Tipo

Obrigatório

Objetivo

dataInicio

idRetaguardaLoja

String

DataSIM, quando não informado o cupomFiltrar data da vendadataFimDataSIM, quando não informado o cupomFiltrar data da venda

S	Filial onde será gerado o documento de entrada de Devolução.
cliente	Objeto	S	Para agrupar os dados do cliente.
cpfCnpj	String

NPesquisar com base no CPF informado no Cupom ou com base no código do cliente identificado na venda que possui o CPF informado na pesquisaserieStringNSerie documento fiscal, algo interno do Protheus(F2_SERIE), exemplo: SAT não possui série de documento, possui serial apenas de equipamento. cupomStringNNúmero do documento fiscal (não precisa informar a série, se informar apenas o cupom, deverá retornar todos os cupons com o mesmo número, não importa a série). Não devemos obrigar informar zeros a esquerda se o Protheus gravar com zeros, devemos abstrair essa regra.IdRetaguardaProdutoStringNId do Produto (mesmo formato que enviamos o produto na integração)IdRetaguardaLojaStringNId da Loja que emitiu o cupom, será utilizado para pesquisar o documento da SF2 (esse campo será utilizado para identificar o cupom quando for gerar o Crédito/Nota de Entrada)tipo

Array

String

NPermitir filtrar somente alguns tipos de cupons, exemplo: O PDV OMNISHOP não emite NF-e, ou seja, se passar no filtro que deseja somente NFC-e e SAT, não iremos devolver vendas NF-e gravadas no ERP.paginaIntNQuando possuir paginação, informar a página.itensPaginaIntNQuantidade de itens que serão retornados por página.

Retorno:

S	Definição do cliente para quem será gerado o crédito NCC (deve estar dentro do objeto cliente).
Itens	Array	S	Array que conterá os itens que serão devolvidos.
IdRetaguardaCupomItem	String	S	Conteúdo retornado na API de consulta de documentos de saída, utilizado para identificar o item do Documento de Saída na tabela SD2. Estará dentro do array itens.
quantidade	Float	S	Quantidade que será devolvida. Estará dentro do array itens.

Exemplo:

{
    "{
    "data": [
        {
            "idRetaguardaLoja": "D PR 02 ",
                "dataHoracliente": "2022031116:56",
            {
        "cpfCnpj": "2666479400018126865525140   ",
            "valorTotal": 503,
            "tipo": "SATCE",
            "qtdItens": 3,

    },
    "itens": [
                        {
                                "descricaoidRetaguardaCupomItem": "PROD1 LOJA - 10% - ICMS - TEN D PR 02 000087   0  01",
                                "valorUnitarioquantidade": 300,
                    "qtdVendida": 1,
                    "qtdDisponivel": 1,
                    1
        },
        {
            "idRetaguardaCupomItem": "D PR 02 000039   0  01D PR 02 000088   0  01",
                                "idRetaguardaProdutoquantidade": "LJTEST01       "1
                },
                {
                    "descricao": "PROD2 LOJA - 12% - ICMS       ",
                    "valorUnitario": 200,
                    "qtdVendida": 1,
                    "qtdDisponivel": 1,
                    "idRetaguardaCupomItem": "D PR 02 000039   0  02",
                    "idRetaguardaProduto": "LJTEST02       "
                },
                {
                    "descricao": "PROD3 LOJA - 17% - ICMS - ALT ",
                    "valorUnitario": 3,
                    "qtdVendida": 1,
                    "qtdDisponivel": 1,
                    "idRetaguardaCupomItem": "D PR 02 000039   0  03",
                    "idRetaguardaProduto": "LJTEST03       "
                }
            ],
            "serie": "0  ",
            "idRetaguardaCupom": "D PR 02 000039   0  ",
            "cupom": "000039   ",
            "situacao": "DISPONÍVEL            "
        }
    ],
    "success": true,
    "hasNext": false,
    "message": ""
}

...

Para o controle de paginação, utilize a tag "hasNext", caso o seu retorno seja true, significa que existe mais registros para serem retornados a partir do filtro informado.

}
]
}

Valores de retorno (Response):

Campo	Tipo	Objetivo
valorCredito	Float	Valor gerado na NCC, tabela SE1
IdRetaguardaCredito	String	Chave do registro gerado na tabela SE1
IdRetaguardaNota	String	Chave do registro gerado na tabela SF1

Exemplo:

{
"data": [
{
"valorCredito": 130.49,
"idRetaguardaNota": "D PR 02 022051 UNI",
"idRetaguardaCredito": "D PR 02 022051 UNI1 NCC"
}
],
"message": "",
"success": true,
"hasNext": false
}

...

04. DEMAIS INFORMAÇÕES

Não há

05. ASSUNTOS RELACIONADOS

...

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

03. SOLUÇÃO

04. DEMAIS INFORMAÇÕES

05. ASSUNTOS RELACIONADOS