Árvore de páginas

Versões comparadas

Chave

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

...

ParametroDescriçãoTipoObservação
listIdProprietario*Lista de Proprietário para filtroLista de objetosOpcional

Obs.: Os campos em * devem ser enviados no Header do GET. 

Os parâmetros opcionais funcionam como um filtro de dados, caso estejam preenchidos ele trará somente os dados relacionados ao filtro.

inquilinoCódigo do InquilinoStringObrigatório
Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok
Expandir
titleExemplo do retorno 200

{
    "success": true,
    "message": "Stringstring",
    "data": [
        {
            "tipoid": 0,
            "statusidInquilino": 0,
            "conteudo": "String",
      "string",
      "numeroLojadataAtualizacao": "String",
            "numeroCaixa": "String",
            "dataHora": "datetime",
      2024-05-03T20:52:37.521Z",
      "tipoMovimentodataCadastro": "String",
            "observacao": "String",
            "id": "String2024-05-03T20:52:37.521Z",
            "idInquilinoidRetaguardaLoja": "Stringstring",
            "idRetaguardatipoDado": "String"1,
            "dataAtualizacaonumeroRegistros": "datetime"0,
            "dataCadastronumeroRegistrosConfirmados": "datetime"0,
            "idProprietariostatus": "String"0,
            "loteOrigemconteudo": "Stringstring",
            "loteobservacao": "Stringstring"
        }
    ],
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Expandir
titleDefinições do retorno 200
Tipo do caixaConteúdo do caixa em base64

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.tipoInteiroid

data.statusInteiroStatus do caixadata.conteudoStringidInquilino

data.dataAtualizacao

data.numeroLojaStringNúmero da lojadataCadastro

data.numeroCaixaStringNúmero do caixaidRetaguardaLoja

data.tipoDadodata.dataHoraData/Horadata do caixa

data.tipoMovimentoStringTipo de movimentenumeroRegistros

data.observacaonumeroRegistrosConfirmadosStringObservaçã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
status

data.conteudo

data.observacaonumberOfRecordsInteiroNúmero de linhas afetadas

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

...