Diárias / Despesas de Viagem


Método responsável por realizar uma carga avulsa (rápida) no cartão de um portador (CPF ou CNPJ) com conta física.


Request


  • ENDPOINT: CargaAvulsa/Carregar
  • VERBO: POST


Índice Chave Descrição Elem. Tipo Ocor. Tamanho Versão
1 CNPJAplicacao CNPJ da Aplicação Para autenticação E Caractere 1-1 14 1.0
2 DocumentoUsuarioAudit Documento do usuário que está realizando a operação E Caractere 1-1 14 1.0
3 NomeUsuarioAudit Nome do usuário que está realizando a operação E Caractere 1-1 60 1.0
4 Token Gerado a partir do CNPJ de autenticação para validar permissões de acesso E Caractere 1-1 100 1.0
5 CNPJEmpresa CNPJ da Empresa para Autenticação (mesmo CNPJAplicacao) E Caractere 1-1 14 1.0
6 NroControleIntegracao Código para identificação dos registros E Caractere 1-1 100 1.0
7 CPFUsuario CPF do usuário responsável pela(s) carga(s) avulsa, apenas números. Necessário cadastro no portal Extratta E Caractere 1-1 11 1.0
8 CNPJFilial CNPJ da filial que está realizando a carga avulsa, apenas números E Caractere 1-0 14 1.0
9 CargasAvulsas Objeto pai que contém uma lista de carga(s) avulsa(s) G 1-1 1.0
9.1 CPF CPF ou CNPJ do portador, apenas números E Caractere 1-1 14 1.0
9.2 Nome Nome do motorista E Caractere 1-1 100 1.0
9.3 Documento CPF ou CNPJ do portador, apenas números E Caractere 1-1 14 1.0
9.4 Valor Valor da carga E Decimal 1-1 18,2 1.0
9.5 Observacao Observação / Informações sobre a carga a ser realizada E Caractere 1-0 1.0


Modelo de Json - Request


{
  "CNPJAplicacao": "",
  "DocumentoUsuarioAudit": "",
  "NomeUsuarioAudit": "",
  "Token": "",
  "CNPJEmpresa": "",
  "NroControleIntegracao": "",
  "CPFUsuario": "",
  "CNPJFilial": "",
  "CargasAvulsas": [
    {
      "CPF": "",
      "Nome": "",
      "Documento": "",
      "Valor": 0.0,
      "Observacao": ""
    }
  ]
}


Response


Índice Chave Descrição Elem. Tipo Ocor. Tamanho Versão
1 Sucesso True: Caso não tenha acontecido nenhuma exceção ou validação no processo mesmo não trazendo dados no retorno.
False: Quaisquer validações ou exceção não tratada pelo sistema que impediu o processo de ser concluído
E Booleano 1-1 True/False 1.0
2 Mensagem Mensagem com as validações e exceções E Caractere 0-1 100 1.0
3 Objeto Elemento pai que contém as cargas G 1-1 1.0
3.1 NroControleIntegracao Código para identificação dos registros E Caractere 1-1 100 1.0
3.2 CargasAvulsas Objeto pai que contém uma lista de carga(s) avulsa(s) A 1-1 1.0
3.2.1 IdCargaAvulsa Código da carga avulsa, em caso de erro será retornado null E Inteiro 0-1 10 1.0
3.2.2 CPF CPF ou CNPJ do portador E Caractere 0-1 14 1.0
3.2.3 Valor Valor da carga E Decimal 0-1 18,2 1.0
3.2.4 StatusProcessamento Status do pagamento do cartão, podendo ser eles:
1 - Aberto;
2 - Baixado;
3 - Erro;
4 - Pendente.
E Inteiro 0-1 1 1.0
3.2.5 MensagemProcessamento Mensagem da processadora do cartão E Caractere 0-1 255 1.0
4 Faults Objeto pai que contém uma lista de erro(s) ou aviso(s) caso aconteça A 1-1 1.0
4.1 Type Tipo de erro ou aviso, podendo ser eles:
1 - Error;
2 - Alert.
E Inteiro 0-1 1 1.0
4.2 Code Codigo do erro E Caractere 0-1 10 1.0
4.3 Message Mensagem do erro E Caractere 0-1 100 1.0


Modelo de Json - Response


{
  "Sucesso": true,
  "Mensagem": "",
  "Objeto": {
    "NroControleIntegracao": "",
    "CargasAvulsas": [
      {
        "IdCargaAvulsa": 0,
        "CPF": "",
        "Valor": 0.0,
        "StatusProcessamento": 0,
        "MensagemProcessamento": ""
      }
    ]
  },
  "Faults": [
    {
        "Type": 0,
        "Code": "",
        "Message": ""
    }    
  ]
}