Árvore de páginas

Versões comparadas

Chave

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

...

Os parâmetros para a requisição estão abaixo

Campo

Tipo

Descrição

Observações

IdInquilinostringIdentificador do InquilinoObrigatório
IdRetaguardaLojastringIdentificador da loja na retaguarda

Obrigatório

Retornos

Deck of Cards
idcredito_consulta_get
Card
label200 - OK

Campo

Tipo

Descrição

CampoTipoIndica se a requisição foi feita com sucesso
SuccessBooleanoMensagem de retorno de erros
MessageStringLista com os créditos retornados
DataLista de ObjetosLista de objetos de retorno
Data.LoteStringNúmero do lote
Data.LoteOrigemStringNúmero do lote origem
Data.StatusInteiroStatus do lote
Data.IdOrigemStringIdentificador da origem
Data.ErrosIdentificadosLista de ObjetosLista de erros 
Data.ErrosIdentificados.TipoLoteInteiroTipo do lote
Data.ErrosIdentificados.IdRetaguardaStringIdentificador do lote na retaguarda
Data.ErrosIdentificados.ErroStringIdentificador do erro
Data.ErrosIdentificados.TipoLojaLoteInteiroIdentificador do tipo loja lote
Data.ErrosIdentificados.PaginaInteiroNúmero da página
Data.ErrosIdentificados.HasnextBooleanoIndica se há mais páginas
Data.IdRetaguardaLojaStringIdentificador da loja na retaguarda
Data.IdInquilinoStringIdentificador do inquilino
Data.DataAtualizacaoDatetimeData de atualização
Data.DataCadastroDatetimeData de cadastro
Data.IdStringIdentificador do loja lote
ErrorsObjetoLista de erros
TotalTimeInteiroTempo total da requisição
NumberOfRecordsInteiroNúmero de registros


{
    "success": true,
    "message": "string",
    "data": [
        {
            "lote": "string",
            "loteOrigem": "string",
            "status": 0,
            "idOrigem": "string",
            "errosIdentificados": [
                {
                    "tipoLote": 0,
                    "idRetaguarda": "string",
                    "erro": "string",
                    "tipoLojaLote": 0,
                    "pagina": 0,
                    "hasnext": true
                }
            ],
            "idRetaguardaLoja": "string",
            "idInquilino": "string",
            "dataAtualizacao": "2024-06-20T15:40:31.700Z",
            "dataCadastro": "2024-06-20T15:40:31.700Z",
            "id": "string"
        }
    ],
    "errors": {},
    "totalTime": 0,
    "numberOfRecords": 0
}

Card
label400 - Bad Request

Campo

Tipo

Descrição

Observação

Success

bool

Indica se a requisição foi feita com sucesso


DataObjetoObjeto de retorno
ErrorsLista de objetosLista de errosSomente é retornado na V3
MessagestringMensagem de retorno de erros
NumberOfRecordsIntNúmero de registros
TotalTimeIntTempo total da requisição


{
    "success": false,
    "message": "string",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}