TOTVS Varejo PDV Omni

Á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 Atual

changes.mady.by.user Erik Lopes Vitelli

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Informações
Este método é responsável pela criação da nota de

...

saída 


  • Endpoint: /api/pdvsyncserver/retaguarda/v2/processoonlinecreditoProcessoOnlineNotaSaida
  • Método: POST
  • Autenticação: Bearer token
  • Permissão: Client

Body da requisição

cliente.endereco
Deck of Cards
idcredito_consulta_get
cliente.cpfCnpj
Card
labelDefinição das propriedades

Campo

Tipo

Descrição

Obrigatório

IdInquilinoString
Identintificador
Identificador do inquilino
idRetaguardaLoja

DataInicio
StringIdentificador da loja na retaguarda
clienteObjetoObjeto de cliente 
DatetimeData de início
DataFimDatetimeData Fim
CpfCnpjString
CPF
Cpf ou
CNPJ do cliente
Cnpj
Serie
cliente.nome
String
Nome do cliente
Serie
CupomString
Endereço do clientecliente.municipio
Cupom
IdRetaguardaProdutoString
Município
Identificador do
cliente
Produto na retaguarda
IdRetaguardaLoja
cliente.uf
String
Unidade Federativa do cliente
Identificador da loja na retaguarda
Tipo
itens
Lista de
Objetos
String
Lista de Itensitens[].idRetaguardaCupomItemStringIdentificador do Item do cupom na retaguardaitens[].quantidade
Tipos
PaginaIntPágina
ItensPaginaIntQuantidade de itens da página
Card
labelBody

{
    "idInquilino": "string",
    "idRetaguardaLojadataInicio": "string2024-06-13T18:13:32.029Z",
    "clientedataFim": {
  "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
boolData[].IdRetaguardaCreditoIntInt

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.CpfCnpjString
Data[].ValorCreditoDoubleValor do crédito
Data[].IdRetaguardaNotaStringIdentificador da nota na retaguarda
CPF 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.ValorUnitarioDecimalValor 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,
            "valorCreditoitens": [
                {
                    "descricao": "String",
                    "valorUnitario": 0.0,
                    "qtdVendida": 0.0,
                    "qtdDisponivel": 0.0,
            "idRetaguardaNota        "idRetaguardaCupomItem": "String",
                    "idRetaguardaProduto": "String"
                }
            ],
            "serie": "String",
            "idRetaguardaCupom": "String",
            "cupom": "String",
            "idRetaguardaCreditosituacao": "String"
        }
    ],
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Card
label400 - Bad Request

Campo

Tipo

Descrição

ObeservaçãoObservação

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
DataObjetoObjeto de retonroretorno
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
}