Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Informações
Este método é responsável pela criação de credito online


  • Endpoint: /api/pdvsyncserver/retaguarda/v2/processoonlinecredito
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Client

Body da requisição

Deck of Cards
idcredito_consulta_get
Card
labelDefinição das propriedades

Campo

Tipo

Descrição

Obrigatório

IdInquilinoStringIdentificador do inquilino
S
Sim
NumeroVendaStringNúmero de identificação da venda
S
Sim
SerieVendaStringSérie da venda
S
Sim
NumeroCaixaStringNumero do caixa
S
Sim
TipoOperacaoStringTipo de operação
S
Sim
MotivoStringMotivo
S
Sim
IdRetaguardaOperadorStringIdentificador do operador na retaguarda
S
Sim
OrigemPdvStringOrigem PDVNão
CreditosLista de objetosLista de créditos
S
Sim
Creditos.CpfCnpjStringCPF ou CNPJ do clienteNão
Creditos.IdRetaguardaCreditoStringIdentificador do crédito na retaguardaNão
Creditos.IdRetaguardaLojaConsultaStringIdentificador da loja de consulta na retaguardaNão
Creditos.IdRetaguardaLojaBaixaStringIdentificador da loja de baixa na retaguarda
S
Sim
Creditos.TipoLista de StringTipos de créditoNão
Creditos.ValorBaixaDecimalValor do créditoNão
Creditos.IdRetaguardaUsuarioStringIdentificador do usuário na retaguardaNão
Creditos
[]
.IdInquilinoStringIdentificador do inquilinoNão
Creditos.DataAtualizacaoDateTimeData de atualização do dadoNão
Creditos.DataCadastroDateTimeData de cadastro do dadoNão
Card
labelBody

{
    "idInquilino": "string",
    "numeroVenda": "string",
    "serieVenda": "string",
    "numeroCaixa": "string",
    "tipoOperacao": "string",
    "motivo": "string",
    "idRetaguardaoperador": "string",
    "origemPDV": "string",
    "creditos": [
        {
            "cpfCnpj": "string",
            "idRetaguardaCredito": "string",
            "idRetaguardaLojaConsulta": "string",
            "idRetaguardaLojaBaixa": "string",
            "tipo": [
                "string"
            ],
            "valorBaixa": 0,
            "idRetaguardaUsuario": "string",
            "idInquilino": "string",
            "dataAtualizacao": "2024-06-13T12:04:11.249Z",
            "dataCadastro": "2024-06-13T12:04:11.249Z"
        }
    ]
}

Retornos

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.SaldodoubleSaldo do crédito
Data.IdRetaguardaCreditostringIdentificador do crédito na retaguarda
ErrorsLista de objetosLista de erros
TotalTimeIntTempo da requisição
NumberOfRecordsIntNúmero de registros

{
    "success": true,
    "message": "",
    "data": [
        {
            "saldo": 0.0,
            "idRetaguardaCredito": "string"
        }
    ],
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Card
label400 - Bad Request

Campo

Tipo

Descrição

Observação

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
DataObjetoObjeto de retorno
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
}