Árvore de páginas

Versões comparadas

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/ProcessoOnlineNotaSaida
  • Método: POST
  • Autenticação: Bearer token
  • Permissão: Client

Body da requisição

Deck of Cards
idcredito_consulta_get
Card
labelDefinição das propriedades

Campo

Tipo

Descrição

Obrigatório

IdInquilinoStringIdentintificador Identificador do inquilino
DataInicioDatetimeData de início
DataFimDatetimeData Fim
CpfCnpjStringCpf ou Cnpj
SerieStringSerie
CupomStringCupom
IdRetaguardaProdutoStringIdentificador do Produto na retaguarda
IdRetaguardaLojaStringIdentificador da loja na retaguarda
TipoLista de StringTipos
PaginaIntPágina
ItensPaginaIntQuantidade de itens da página
Card
labelBody

{
    "idInquilino": "string",
    "dataInicio": "2024-06-13T18:13:32.029Z",
    "dataFim": "2024-06-13T18:13:32.029Z",
    "cpfCnpj": "string",
    "serie": "string",
    "cupom": "string",
    "idRetaguardaProduto": "string",
    "idRetaguardaLoja": "string",
    "tipo": [
        "string"
    ],
    "pagina": 0,
    "itensPagina": 0
}

Retornos

Deck of Cards
idcredito_consulta_get
Card
label200 - OK

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[].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 cupom na retaguarda
Data[].CupomStringCupom
Data[].SituacaoStringSituação
ErrorsLista de objetosLista de erros
TotalTimeInteiroTempo da requisição
NumberOfRecordsInteiroNúmero de registros


{
    "success": true,
    "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,
                    "qtdVendida": 0.0,
                    "qtdDisponivel": 0.0,
                    "idRetaguardaCupomItem": "String",
                    "idRetaguardaProduto": "String"
                }
            ],
            "serie": "String",
            "idRetaguardaCupom": "String",
            "cupom": "String",
            "situacao": "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
}