Á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 da nota de

...

entrada


  • Endpoint: /api/pdvsyncserver/retaguarda/v2/processoonlinecreditoprocessoonlinenotaentrada
  • 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

IdInquilinoString
Identintificador
Identificador do inquilinoSim
idRetaguardaLojaStringIdentificador da loja na retaguardaSim
clienteObjetoObjeto de cliente Validado no Retaguarda
cliente.cpfCnpjStringCPF ou CNPJ do clienteValidado no Retaguarda
cliente.nomeStringNome do clienteValidado no Retaguarda
cliente.enderecoStringEndereço do clienteValidado no Retaguarda
cliente.municipioStringMunicípio do clienteValidado no Retaguarda
cliente.ufStringUnidade Federativa do clienteValidado no Retaguarda
itensLista de ObjetosLista de ItensValidado no Retaguarda
itens[].idRetaguardaCupomItemStringIdentificador do Item do cupom na retaguardaValidado no Retaguarda
itens[].quantidadeIntQuantidadeValidado no Retaguarda
Card
labelBody

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

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[].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
}