Árvore de páginas

Versões comparadas

Chave

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

...

Deck of Cards
idcredito_consulta_get
Card
labelDefinição das propriedades

Campo

Tipo

Descrição

IdInquilinoStringIdentintificador Identificador do inquilino
idRetaguardaLojaStringIdentificador da loja na retaguarda
clienteObjetoObjeto de cliente 
cliente.cpfCnpjStringCPF ou CNPJ do cliente
cliente.nomeStringNome do cliente
cliente.enderecoStringEndereço do cliente
cliente.municipioStringMunicípio do cliente
cliente.ufStringUnidade Federativa do cliente
itensLista de ObjetosLista de Itens
itens[].idRetaguardaCupomItemStringIdentificador do Item do cupom na retaguarda
itens[].quantidadeIntQuantidade
Card
labelBody

{
    "idInquilino": "string",
    "idRetaguardaLoja": "string",
    "cliente": {
        "cpfCnpj": "string",
        "nome": "string",
        "endereco": "string",
        "municipio": "string",
        "uf": "string"
    },
    "itens": [
        {
            "idRetaguardaCupomItem": "string",
            "quantidade": 0
        }
    ]
}

...

Deck of Cards
idcredito_consulta_get
Card
label200 - OK

Campo

Tipo

Descrição

SuccessboolIndica se a requisição foi feita com sucesso
MessageStringMensagem de retorno de erros
DataLista de ObjetosLista com os créditos retornados
Data[].ValorCreditoDoubleValor do crédito
Data[].IdRetaguardaNotaStringIdentificador da nota na retaguarda
Data[].IdRetaguardaCreditoStringIdentificador do crédito na retaguarda
ErrorsLista de objetosLista de erros
TotalTimeIntTempo da requisição
NumberOfRecordsIntNúmero de registros

{
    "success": false,
    "message": "String",
    "data": [
        {
            "valorCredito": 0.0,
            "idRetaguardaNota": "String",
            "idRetaguardaCredito": "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
}