...
Para acessar os dados a requisição é a seguinte
- Endpoints: Endpoint
- : /api/pdvsyncclient/v2/caixamensagens/{idInquilino}
- V3: /api/pdvsyncclient/v3/caixamensagens/{idInquilino}
- Método: GET
- Autenticação: Bearer token
- Permissão: Client
Para esse endpoint, alguns parâmetro podem ser enviados na requisição. Estes parâmetros são:
| ParametroParâmetro | Descrição | Tipo | Observação |
|---|
| listIdProprietario* | Lista de Proprietário para filtro | Lista de objetos | Opcional |
...
| Expandir |
|---|
| title | Definição dos campos de retorno |
|---|
|
| Expandir |
|---|
| | Expandir |
|---|
| title | Exemplo 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 |
|---|
| title | Definições do retorno 200 |
|---|
| Campo | Tipo | Descrição |
|---|
| success | Booleano | Indica se a criação do compartilhamento foi feita com sucesso | | message | String | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | data | Lista de Objetos | Lista de caixa | | data.tipo | Inteiro | Tipo do caixa | | data.status | Inteiro | Status do caixa | | data.conteudo | String | Conteúdo do caixa em base64* | | data.numeroLoja | String | Número da loja | | data.numeroCaixa | String | Número do caixa | | data.dataHora | Data/Hora | data do caixa | | data.tipoMovimento | String | Tipo de movimente | | data.observacao | String | Observação | | data.id | String | Identificador do caixa no POSH | | data.idInquilino | String | Identificador do inquilino | | data.idRetaguarda | String | Identificador da Caixa na retaguarda | | data.dataAtualizacao | Data/Hora | Ultima atualização do caixa | | data.dataCadastro | Data/Hora | Data de cadastro do caixa | | data.idProprietario | String | Identificador do proprietário | | data.loteOrigem | String | Identificador do lote | | data.lote | String | Identificador do lote | | errors | Nulo | Listas com os erros encontrados no processo | | totalTime | Inteiro | Tempo da requisição | | numberOfRecords | Inteiro | Número de linhas afetadas |
| Expandir |
|---|
| - 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
} Campo | Tipo | Descrição |
|---|
| Id | Inteiro | Código Id da Movimentação do Caixa | | TipoMovimento | Inteiro | Tipo do Movimento Caixa: - 0 - AberturaCaixa
- 1 - FechamentoCaixa
- 2 - Sangria
- 3 - Suprimento
| | Loja | Objeto | Objeto do Cliente | | Loja.Cnpj | String | CNPJ da Loja | | Loja.NumeroLoja | String | Número da Loja | | Loja.IdRetaguarda | String | Código Retaguarda da Loja | | Loja.CodigoIdentificacaoLoja | String | Código de Identificação da Loja | | Operador | Objeto | Objeto do Operador do Caixa (Usuário) | | Operador.Nome | String | Nome do Operador de Caixa | | Operador.Login | String | Login do Operador | | Operador.IdRetaguarda | String | Código Retaguarda do Operador | | Operador.Id | Inteiro | Código Id do Operador | | Operador.DataCadastro | Data/Hora | Data de Cadastro do Operador | | Operador.DataAtualizacao | Data/Hora | Data de Atualização do Operador | | Valor | Decimal | Valor do Caixa | | DataHora | Data/Hora | Data e Hora da Movimentação do Caixa | | NumeroCaixa | Inteiro | Número | | IdMotivo | String | Código do Id do Motivo Movimentação do Caixa | | DescricaoMotivo | String | Descrição do Motivo Movimentação do Caixa | | IdPagamento | String | Código Id da Forma de Pagamento | | DescricaoPagamento | String | Descrição da Forma de Pagamento | | IdOperacaoPdv | String | Código Id da Operação de Caixa no PDV | | IdCaixaoperacao | Inteiro | Código Id da Operação de Caixa | | IdManipulacao | Inteiro | Código Id da Manipulação de Caixa |
|
|
|
| Expandir |
|---|
| Campo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
...
