Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Exemplo:

{
    "dataInicio""2019010120220101",
    "dataFim""20220914",
    "cupom""2019013039",
    "pagina"1
}


Parâmetros de entrada (Request):

ParâmetroTipoObrigatórioObjetivo
dataInicioDataSIM, quando não informado o cupomFiltrar data da venda
dataFimDataSIM, quando não informado o cupomFiltrar data da venda
cpfCnpjStringNPesquisar com base no CPF informado no Cupom ou com base no código do cliente identificado na venda que possui o CPF informado na pesquisa
serieStringNSerie 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)
IdRetaguardaLojaCupom
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

Enum

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.
page
paginaIntNQuando possuir paginação, informar a página.
pagesize
itensPaginaIntN
Qtde
Quantidade de itens que serão retornados por página.


Retorno:

{
    "data": [
        {
            "descricao"idRetaguardaLoja""D PR 02 ",
            "dataHora""                              2022031116:56",
            "idRetaguardaLojacpfCnpj""D MG 01 26664794000181",
            "dataHoravalorTotal"503,
            "tipo"2019011109:27 "SATCE",
            "qtdItens"3,
            "itens": [
                {
                    "descricao""PROD1 LOJA - 10% - ICMS - TEN ",
                    "valorUnitario"300,
                    "qtdVendida"1,
                    "qtdDisponivel"1,
                    "idRetaguardaCupomItem""D PR 02 000039   0  01",
                    "idRetaguardaProduto""LJTEST01       "
                },
                {
                    "descricao""D MG 01 15       LOJ01",
            "situacao"PROD2 LOJA - 12% - ICMS       ",
                    "valorUnitario"200,
                    "qtdVendida"1,
                    "disponível            qtdDisponivel"1,
                                "cpdCnpjidRetaguardaCupomItem""26865525140   D PR 02 000039   0  02",
                                "valorTotalidRetaguardaProduto"10,
            "tipo"LJTEST02       "
                },
                {
                    "descricao""CF   PROD3 LOJA - 17% - ICMS - ALT ",
                                "valorUnitario"103,
                                "qtdVendida"1,
                                "qtdItensqtdDisponivel"1,
                    "idRetaguardaCupomItem""D PR 02 000039   0  03",
                                "serieidRetaguardaProduto""LOJ"LJTEST03       "
                }
            ],
            "qtdDisponivelserie"1"0  ",
            "idRetaguardaCupom""D MG 01 15       LOJD PR 02 000039   0  ",
            "cupom""15       000039   ",
            "idRetaguardaProdutosituacao""LOTE           DISPONÍVEL            "
        }
    ],
    "messagesuccess"""true,
    "successhasNext"truefalse,
    "hasNextmessage"""
}

Nota

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.

Incremente a tag "pagina",  para solicitar os demais registros.

04. DEMAIS INFORMAÇÕES

Envia Condição de PagamentoNão há

05. ASSUNTOS RELACIONADOS

...