TOTVS Varejo Franquias e Redes

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Erik Lopes Vitelli

Gravado em

comparado com

Nova versão 2

changes.mady.by.user Erik Lopes Vitelli

Gravado em

Chave

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

...

Deck of Cards
idcredito_consulta_get
Card
labelDefinição das propriedades

Campo

Tipo

Descrição

IdInquilinoStringIdentintificador do inquilino
idRetaguardaLojaDataInicioStringIdentificador da loja na retaguarda
clienteObjetoObjeto de cliente 
DatetimeData de início
DataFimDatetimeData Fim
CpfCnpjcliente.cpfCnpjStringCPF Cpf ou CNPJ do clienteCnpj
Seriecliente.nomeStringNome do clienteSerie
Cupomcliente.enderecoStringEndereço do clienteCupom
IdRetaguardaProdutocliente.municipioStringMunicípio Identificador do clienteProduto na retaguarda
IdRetaguardaLojacliente.ufStringUnidade Federativa do clienteIdentificador da loja na retaguarda
TipoitensLista de ObjetosStringLista de Itens
itens[].idRetaguardaCupomItemStringIdentificador do Item do cupom na retaguarda
Tipos
PaginaIntPágina
ItensPaginaitens[].quantidadeIntQuantidade de itens da página
Card
labelBody

{
    "idInquilino": "string",
    "idRetaguardaLojadataInicio": "string2024-06-13T18:13:32.029Z",
    "cliente": {dataFim": "2024-06-13T18:13:32.029Z",
        "cpfCnpj": "string",
        "nomeserie": "string",
        "enderecocupom": "string",
        "municipioidRetaguardaProduto": "string",
        "ufidRetaguardaLoja": "string"
    },
    "itenstipo": [
        {"string"
        ],
    "idRetaguardaCupomItempagina": "string"0,
            "quantidadeitensPagina": 0
        }
    ]
}

Retornos

Deck of Cards
idcredito_consulta_get
Card
label200 - OK
boolValorCreditoValor do créditoIdRetaguardaNota na retaguardaIdRetaguardaCreditoIntInt

Campo

Tipo

Descrição

SuccessBooleanoIndica se a requisição foi feita com sucesso
MessageStringMensagem de retorno de erros
DataLista de ObjetosLista com os créditos retornados
Data[].IdRetaguardaLojaStringIdentificador da loja na retaguarda
Data[].DataHoraStringData e hora da nota
Data[].CpfCnpjStringCPF ou CNPJ do cliente
Data[].ValorTotalDecimalValor total da nota
Data[].TipoStringTipo da nota
Data[].QtdItensDecimalQuantidade de itens da nota
Data[].ItensLista de ObjetosItens da nota
Data[].Itens[].DescricaoStringDescrição do item 
Data[].Itens[].
ValorUnitario
Double
DecimalValor unitário do item
Data[].Itens[].QtdVendidaDecimalQuantidade vendida
Data[].Itens[].QtdDisponivelDecimalQuantidade disponível
Data[].Itens[].IdRetaguardaCupomItemStringIdentificador do cupom na retaguarda
Data[].
Itens[].IdRetaguardaProdutoStringIdentificador do produto na retaguarda
Data[].SerieStringSéria da nota
Data[].IdRetaguardaCupomStringIdentificador do crédito cupom na retaguarda
Data[].CupomStringCupom
Data[].SituacaoStringSituação
ErrorsLista de objetosLista de erros
TotalTimeInteiroTempo da requisição
NumberOfRecordsInteiroNúmero de registros


{
    "success": falsetrue,
    "message": "String",
    "data": [
        {
            "idRetaguardaLoja": "String",
            "dataHora": "13/06/2024 15:19:39",
            "cpfCnpj": "String",
            "valorTotal": 0.0,
            "tipo": "String",
            "qtdItens": 0.0,
            "itens": [
                {
                    "descricao": "String",
                    "valorUnitario": 0.0,
              "valorCredito      "qtdVendida": 0.0,
                    "qtdDisponivel": 0.0,
                    "idRetaguardaCupomItem": "String",
                    "idRetaguardaProduto": "String"
                }
            ],
            "idRetaguardaNota"serie": "String",
            "idRetaguardaCupom": "String",
            "cupom": "String",
            "idRetaguardaCreditosituacao": "String"
        }
    ],
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Card
label400 - Bad Request

Campo

Tipo

Descrição

Obeservação

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
DataObjetoObjeto de retonro
ErrorsLista de objetosLista de errosSomente é retornado na V3
TotalTimeIntTempo total da requisição
NumberOfRecordsIntNúmero de registros


{
    "success": false,
    "message": "string",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}