Árvore de páginas

Versões comparadas

Chave

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

...

Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok
Expandir
titleExemplo do retorno 200

{
    "success": true,
    "message": "String",
    "data": [
        {
            "tipo": 0,
            "status": 0,
            "conteudo": "String",
            "numeroLoja": "String",
            "numeroCaixa": "String",
            "dataHora": "datetime",
            "tipoMovimento": "String",
            "observacao": "String",
            "id": "String",
            "idInquilino": "String",
            "idRetaguarda": "String",
            "dataAtualizacao": "datetime",
            "dataCadastro": "datetime",
            "idProprietario": "String",
            "loteOrigem": "String",
            "lote": "String"
        }
    ],
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Expandir
titleDefinições do retorno 200

Campo

Tipo

Descrição

successBooleanoIndica se a criação do compartilhamento foi feita com sucesso
messageStringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
dataLista de ObjetosLista de caixa
data.tipoInteiroTipo do caixa
data.statusInteiroStatus do caixa
data.conteudoStringConteúdo do caixa em base64*
data.numeroLojaStringNúmero da loja
data.numeroCaixaStringNúmero do caixa
data.dataHoraData/Horadata do caixa
data.tipoMovimentoStringTipo de movimente
data.observacaoStringObservação
data.idStringIdentificador do caixa no POSH
data.idInquilinoStringIdentificador do inquilino
data.idRetaguardaStringIdentificador da Caixa na retaguarda
data.dataAtualizacaoData/HoraUltima atualização do caixa
data.dataCadastroData/HoraData de cadastro do caixa
data.idProprietarioStringIdentificador do proprietário
data.loteOrigemStringIdentificador do lote
data.loteStringIdentificador do lote
errorsNuloListas com os erros encontrados no processo
totalTimeInteiroTempo da requisição
numberOfRecordsInteiroNúmero de linhas afetadas
Expandir
title* Conteúdo do Caixa
  • Body de Envio (Base64 decodificado)

{
    "Id": 0,
    "TipoMovimento": 0,
    "Loja": {
        "Cnpj": "string",
        "NumeroLoja": "string",
        "IdRetaguarda": "string",
        "CodigoIdentificacaoLoja": "string"
    },
    "Operador": {
        "Nome": "string",
        "Login": "string",
        "IdRetaguarda": "string",
        "Id": 0,
        "DataCadastro": "string",
        "DataAtualizacao": "string"
    },
    "Valor": 0.0,
    "DataHora": "2020-03-16T17:23:07.400026",
    "NumeroCaixa": 0,
    "IdMotivo": "string",
    "DescricaoMotivo": "string",
    "IdPagamento": null,
    "DescricaoPagamento": null,
    "IdOperacaoPdv": "string",
    "IdCaixaoperacao": 0,
    "IdManipulacao": 0
}

  • Campos

Campo

Tipo

Descrição

IdInteiroCódigo Id da Movimentação do Caixa
TipoMovimentoInteiro

Tipo do Movimento Caixa:

  • 0 - AberturaCaixa
  • 1 - FechamentoCaixa
  • 2 - Sangria
  • 3 - Suprimento 
LojaObjetoObjeto do Cliente
Loja.CnpjStringCNPJ da Loja
Loja.NumeroLojaStringNúmero da Loja
Loja.IdRetaguardaStringCódigo Retaguarda da Loja
Loja.CodigoIdentificacaoLojaStringCódigo de Identificação da Loja
OperadorObjetoObjeto do Operador do Caixa (Usuário)
Operador.NomeStringNome do Operador de Caixa
Operador.LoginStringLogin do Operador
Operador.IdRetaguardaStringCódigo Retaguarda do Operador
Operador.IdInteiroCódigo Id do Operador
Operador.DataCadastroData/HoraData de Cadastro do Operador
Operador.DataAtualizacaoData/HoraData de Atualização do Operador
ValorDecimalValor do Caixa
DataHoraData/HoraData e Hora da Movimentação do Caixa
NumeroCaixaInteiroNúmero 
IdMotivoStringCódigo do Id do Motivo Movimentação do Caixa
DescricaoMotivoStringDescrição do Motivo Movimentação do Caixa
IdPagamentoStringCódigo Id da Forma de Pagamento
DescricaoPagamentoStringDescrição da Forma de Pagamento
IdOperacaoPdvStringCódigo Id da Operação de Caixa no PDV
IdCaixaoperacaoInteiroCódigo Id da Operação de Caixa
IdManipulacaoInteiroCódigo Id da Manipulação de Caixa
Expandir
title400 - Bad Request

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos

...