Consultas MultiEmbarcador
Consultas MultiEmbarcador
Os parâmetros de requisição são variáveis para cada método solicitado pela integradora (cada
método será descrito neste documento), porém, para todos é necessário informar no cabeçalho da
requisição o Token de Integração (ver exemplo do XML abaixo).
Obs: Solicitar a Multisoftware o Token para Integração e os endereços (URI) dos Web Services.
Padrão de Retornos.
Obs: quando o retorno for código 500, a integradora deve considerar que a solicitação já foi
processada pela Multisoftware e sendo assim a solicitação não precisa mais ser feita. Por exemplo: ao
confirmar a integração de uma carga, a Multisoftware processa a requisição e retorna sucesso, porém,
a integradora tem um problema com a conexão da internet e não recebe o retorno. Ao tentar enviar
novamente a confirmação de integração será retornado o código 500 para a Mensagem, sendo assim,
a integradora deve considerar que a confirmação de integração já foi processada e não é mais
necessário fazer o envio da mesma.
Retornos paginados.
A paginação é informada na tag Objeto do retorno padrão conforme os dados descritos abaixo.
Para exemplificar a paginação podemos usar a seguinte situação: é feita uma solicitação a um
método paginado informando que o inicio é 0 e o limite é 50. O retorno no campo Itens é de 50 registros
e no campo NumeroTotalDeRegistro o valor é 70. Neste caso é necessário fazer uma segunda
requisição ao método, informando que o inicio deve ser 50 e o limite 50 (não é obrigatório informar o
limite restante, ou seja, pode informar sempre o limite máximo estimado pela Multisoftware), na
segunda requisição o retorno do campo Itens serão os 20 registros restantes e no campo
NumeroTotalDeRegistro o valor é 70. Desta forma pode-se dizer que em duas requisições foi possível
obter todos os registros disponíveis no método.
Métodos disponíveis.
Método: SalvarVeiculo
Resposta:
Método: BuscarNFSsPorPeriodo
Resposta
Método: BuscarOutrosDocsPorPeriodo
Descrição: É onde são retornadas as informações de outros documentos emitidos por periodo.
Resposta:
Resposta:
Método: SolicitarEncerramentoMDFePorChaveCTe
Descrição: Através deste método é possível solicitar o encerramento do MDF-e que está vinculado a
Chave do CT-e informado.
Resposta:
Descrição: Através deste método é possível verificar a situação do do MDF-e que está vinculado a
Chave do CT-e informado.
Resposta:
Retorna a situação do MDF-e que está vinculado a chave do CT-e informado. Abaixo possíveis
situações:
Situação Descrição
EmDigitacao Indica que o MDF-e está em digitação.
Enviado Indica que o MDF-e foi enviado para autorização ao Sefaz
Pendente Indica que o MDF-e está pendente de envio para autorização ao Sefaz.
Autorizado Indica que o MDF-e está autorizado no Sefaz
EmEncerramento Indica que o MDF-e foi enviado para encerramento ao Sefaz.
Encerrado Indica que o MDF-e foi encerrado no Sefaz
EmCancelamento Indica que o MDF-e foi enviado para cancelamento ao Sefaz.
Cancelado Indica que o MDF-e está cancelado no Sefaz
Rejeicao Indica que ouve uma rejeição de autorização no Sefaz
Objetos
Objeto: RamoAtividade
Objeto: Pais
Objeto: Regiao
Objeto: Localidade
Objeto: Endereco
Objeto: Pessoa
Objeto: Motorista
Objeto: Empresa
Objeto: DadosBancarios
Campo Tipo Valores Obri. Descrição
Banco Banco Ver objeto banco Sim Informação do banco dos dados bancários
Agencia xs:string 1 – 10 caracteres Sim É a agência dos dados bancários
DigitoAgencia xs:string 1 – 10 caracteres Não É o dígito verificador da Agência dos dados
bancários.
NumeroConta xs:string 1 – 10 caracteres Sim É o número da conta dos dados bancários
TipoContaBanco TipoContaBanco Corrente Sim Informa se a conta é do tipo conta corrente
Poupança ou conta poupança.
Objeto: Veiculo
Objeto: CTe
Objeto: NFS
Objeto: ValorNFs
Campo Tipo Valores Obri. Descrição
ValorServicos xs:decimal Sim É o Valor total do Serviço Prestado.
ValorDeducoes xs:decimal Não É o Valor total das Deduções do Serviço
Prestado.
ValorPIS xs:decimal Não É o Valor total do PIS do Serviço
Prestado.
ValorCOFINS xs:decimal Não É o Valor do COFINS do Serviço
Prestado.
ValorINSS xs:decimal Sim É o Valor de INSS do Serviço Prestado.
ValorIR xs:decimal Sim É o Valor de IR Serviço Prestado.
ValorCSLL xs:decimal Sim É o Valor do CSLL Serviço Prestado.
ISSRetido xs:bool Não Indica se o ISS é retido
ValorISSRetido xs:bool Sim É o Valor do ISS Retido do Serviço
Prestado.
ValorOutrasRetencoes xs:decimal Sim É o Valor de outras retenções do
Serviço Prestado.
ValorDescontoIncondicionado xs:decimal Sim É o Valor de desconto incondicionado
do Serviço Prestado.
ValorDescontoCondicionado xs:decimal Sim É o Valor de desconto condicionado do
Serviço Prestado.
AliquotaISS xs:decimal Sim É o Valor alíquota do ISS do Serviço
Prestado.
BaseCalculoISS xs:decimal Sim É o Valor da base de calculo do ISS do
Serviço Prestado.
ValorISS xs:decimal Sim É o Valor do ISS do Serviço Prestado.
Objeto: NFSManualServicoPrestado
Campo Tipo Valores Obri. Descrição
Quantidade xs:int Sim É a quantidade do serviço prestado.
Descricao xs:string 1-250 caracteres Sim É a Descrição do Serviço prestado
ValorTotal xs:decimal Sim É o Valor total do Serviço Prestado.
Objeto: NaturezaNFSe
Campo Tipo Valores Obri. Descrição
Codigo xs:int Sim É a quantidade da Natureza da NFS-e.
Descricao xs:string 1-150 caracteres Sim É a Descrição da Natureza da NFS-e
Objeto: NFSe
Campo Tipo Valores Obri. Descrição
NaturezaNFSe NaturezaNFSe Ver objeto NaturezaNFSe Sim É a natureza da NFS-e.
Serie xs:int Sim É a Série da NFS-e.
Numero xs:int Sim É o Número da NFS-e.
NumeroRPS xs:int Sim É o Número do RPS da NFS-e.
SerieRPS xs:string 1-3 caracteres Sim É a série do RPS da NFS-e
CodigoVerificacao xs:string 1-100 caracteres Sim Contém o código de verificação da NFS-
e.
StatusNFSe StatusNFSe EmDigitacao;
Pendente;
Enviado;
Autorizado;
EmCancelamento;
Cancelado;
Rejeicao;
DataEmissao xs:string dd/MM/yyyy HH:mm:ss Sim É a data de emissão da NFS-e
XML xs:string Texto Não É o xml da NFS-e.
PDF xs:string Texto Não Contém a codificação do PDF da NFS-e
Gerada pela Multisotware.
MotivoCancelamento xs:string 1-400 caracteres Não Caso a NFS-e esteja cancelado, nesse
campo está informado o motivo do
cancelamento.
NumeroProtocolo xs:string 1-150 caracteres Sim Contém o número de protocolo para
consulta no Site da prefeitura da NFS-e.