0% acharam este documento útil (0 voto)
234 visualizações14 páginas

Consultas MultiEmbarcador

O documento descreve os métodos disponíveis para integração com os web services da Multisoftware, incluindo parâmetros de requisição e resposta. Os métodos permitem buscar e salvar informações de veículos, NFs, CT-es, MDF-es e outros documentos por período.
Direitos autorais
© © All Rights Reserved
Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.
Formatos disponíveis
Baixe no formato PDF, TXT ou leia on-line no Scribd
0% acharam este documento útil (0 voto)
234 visualizações14 páginas

Consultas MultiEmbarcador

O documento descreve os métodos disponíveis para integração com os web services da Multisoftware, incluindo parâmetros de requisição e resposta. Os métodos permitem buscar e salvar informações de veículos, NFs, CT-es, MDF-es e outros documentos por período.
Direitos autorais
© © All Rights Reserved
Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.
Formatos disponíveis
Baixe no formato PDF, TXT ou leia on-line no Scribd
Você está na página 1/ 14

Toda a requisição aos Web Services da Multisoftware devem respeitar algumas regras para

integração. Os Web Services se baseiam no padrão WSDL (https://www.w3.org/TR/wsdl) e utilizam


o protocolo SOAP como forma de integração, ou seja, existe um contrato entre a integradora e os
métodos dos Web Services que devem ser respeitados.

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.

Os métodos disponibilizados para integração pela Multisoftware possuem um retorno


padronizado conforme tabela abaixo.

Campo Tipo Valores Descrição


CodigoMensagem xs:int 300 – Dados Inválidos; Tipo de falha na integração, considerar
400 – Falha Interna Web Service; apenas se o retorno falha na integração.
500 – Duplicidade na Requisição;
DataRetorno xs:string Dd/MM/yyyy HH:mm:ss Data de Retorno da integração.
Mensagem xs:string Texto Em caso de falha na integração uma
mensagem é retornada para informar o
motivo da falha.
Objeto Dinâmico Variável conforme o método solicitado Neste campo o conteúdo de retorno é
variável conforme cada métodos (ver
retorno nos métodos descritos neste
documento).
Status xs:boolean true; Em caso de true a solicitação foi
false; processada com sucesso. Em caso de
False ocorreu algum impedimento a
requisição não foi concluída (neste caso
observar campos de falha).

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.

Quando os métodos de integração podem retornar uma grande quantidade de informação a


Multisoftware adota o padrão de paginação no retorno, ou seja, para se obter todos os dados pode
ser necessário que a integradora faça mais de uma requisição ao mesmo método.

A paginação é informada na tag Objeto do retorno padrão conforme os dados descritos abaixo.

Campo Tipo Valores Descrição


NumeroTotalDeRegistro xs:int Contém a quantidade total de registros
para serem retornadas;
Itens xs:Array Variável conforme o método solicitado É um Array contendo os dados retornados
no método (ver retorno nos métodos
descritos neste documento).

Os métodos paginados serão descritos nesse documento quando houver a necessidade de


paginar o retorno. O conceito é o padrão para todos os métodos paginados, onde se tem um parâmetro
início e um limite. O início descreve qual em qual posição do array deseja obter os dados, e o limite
determina a quantidade de registros por vez (cada método possui um limite padrão que é informado
nesse documento).

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

Web Sevice: Empresa.svc

Descrição: salva os dados do veículo na Multisoftware.

Parâmetros para requisição:

Campo Tipo Valores Obri. Descrição


veiculoIntegracao Veiculo Ver objeto Veiculo Sim Contém as informações do veículo

Resposta:

Retorna um booleano indicando que a requisição foi processada.

Método: BuscarNFSsPorPeriodo

Web Sevice: NFS.svc

Descrição: É onde são retornadas as informações das NFSs da carga.

Parâmetros para requisição:

Campo Tipo Valores Obri. Descrição


dataInicial xs:string dd/MM/yyyy Sim Data inicial para busca dos documentos.
dataFinal xs:string dd/MM/yyyy Sim Data final para busca dos documentos.
tipoDocumentoRetorno TipoDocumentoRetorno Nenhum; Sim Recomenda-se informar apenas os documentos
PDF; que a integradora precisa.
XML;
Todos;
inicio xs:int Sim Início da paginação
limite xs:int Limite máximo de Sim Limite da paginação
50 registros por vez

Resposta

Retorna uma lista de objetos do tipo NFS.


Método: BuscarCTesPorPeriodo

Web Sevice: CTe.svc

Descrição: É onde são retornadas as informações dos CT-es da carga.

Parâmetros para requisição:

Campo Tipo Valores Obri. Descrição


dataInicial xs:string dd/MM/yyyy Sim Data inicial para busca dos documentos.
dataFinal xs:string dd/MM/yyyy Sim Data final para busca dos documentos.
tipoDocumentoRetorno TipoDocumentoRetorno Nenhum; Sim Recomenda-se informar apenas os documentos
PDF; que a integradora precisa.
XML;
Todos;
inicio xs:int Sim Início da paginação
limite xs:int Limite máximo de Sim Limite da paginação
50 registros por vez
Resposta:

Retorna um objeto do tipo CTe.

Método: BuscarOutrosDocsPorPeriodo

Web Sevice: CTe.svc

Descrição: É onde são retornadas as informações de outros documentos emitidos por periodo.

Parâmetros para requisição:

Campo Tipo Valores Obri. Descrição


dataInicial xs:string dd/MM/yyyy Sim Data inicial para busca dos documentos.
dataFinal xs:string dd/MM/yyyy Sim Data final para busca dos documentos.
tipoDocumentoRetorno TipoDocumentoRetorno Nenhum; Sim Recomenda-se informar apenas os documentos
PDF; que a integradora precisa.
XML;
Todos;
inicio xs:int Sim Início da paginação
limite xs:int Limite máximo de Sim Limite da paginação
50 registros por vez

Resposta:

Retorna um objeto do tipo CTe.


Método: BuscarMDFesPorPeriodo

Web Sevice: MDFe.svc

Descrição: É onde são retornadas as informações dos MDF-es.

Parâmetros para requisição:

Campo Tipo Valores Obri. Descrição


dataInicial xs:string dd/MM/yyyy Sim Data inicial para busca dos documentos.
dataFinal xs:string dd/MM/yyyy Sim Data final para busca dos documentos.
tipoDocumentoRetorno TipoDocumentoRetorno Nenhum; Sim Recomenda-se informar apenas os documentos
PDF; que a integradora precisa.
XML;
Todos;
inicio xs:int Sim Início da paginação
limite xs:int Limite máximo de Sim Limite da paginação
50 registros por vez

Resposta:

Retorna um objeto do tipo MDFe.

Método: SolicitarEncerramentoMDFePorChaveCTe

Web Sevice: MDFe.svc

Descrição: Através deste método é possível solicitar o encerramento do MDF-e que está vinculado a
Chave do CT-e informado.

Parâmetros para requisição:

Campo Tipo Valores Obri. Descrição


ChaveCTe xs:string 44 caracteres Sim É a chave do CT-e que se deseja encerrar o MDF-
e da viagem.

Resposta:

Retorna um booleano indicando que a requisição foi processada.


Método: ConsultaStatusMDFePorChaveCTe

Web Sevice: MDFe.svc

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.

Parâmetros para requisição:

Campo Tipo Valores Obri. Descrição


ChaveCTe xs:string 44 caracteres Sim É a chave do CT-e que se deseja encerrar o MDF-
e da viagem.

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

Campo Tipo Valores Descrição


Codigo xs:int Código em comum para troca de informação entre
a integradora e a Multisoftware.
Descricao xs:string 1 - 150 caracteres Contém a descrição do ramo de Atividade

Objeto: Pais

Campo Tipo Valores Obri. Descrição


CodigoPais xs:int Sim Código em comum para troca de informação entre a integradora
e a Multisoftware.
NomePais xs:string 1 - 80 Caracteres Sim Nome do País.
SiglaPais xs:string 3 Caracteres Não Sigla de abreviação do país.

Objeto: Regiao

Campo Tipo Valores Obri. Descrição


CodigoIntegracao xs:string 1 - 50 Caractees Sim Código em comum para troca de informação entre a
integradora e a Multisoftware.
Descricao xs:string 1 - 150 Caracteres Sim É a descrição da Região.
IBGELocalidadePolo xs:int Não Código IBGE da cidade polo da região

Objeto: Localidade

Campo Tipo Valores Obri. Descrição


CodigoIntegracao xs:string 1 - 50 Cararcteres Não Código em comum para troca de informação entre a
integradora e a Multisoftware.
Descricao xs:string 1 - 150 Caracteres Sim Nome da Localidade (Cidade)
IBGE xs:int Sim Código da Localidade
Pais Pais Ver objeto Pais. Não Obrigatório quando localidade for Exterior (IBGE 9999999)
Regiao Regiao Não Ver objeto Região

Objeto: Endereco

Campo Tipo Valores Obri. Descrição


Bairro xs:string 3 - 80 caracteres Sim É a descrição do bairro do endereço.
CEP xs:string 9 - 11 caracteres Sim É o CEP do Endereço.
Localidade Localidade Ver objeto Localidade. Sim É a localidade do Endereço.
CodigoIntegracao xs:string 1 - 50 caracteres Não Código em comum para troca de informação entre a
integradora e a Multisoftware.
Complemento xs:string 3 - 80 caracteres Não É o complemento do Endereço.
Logradouro xs:string 3 - 150 caracteres Sim É o logradouro do endereço
Numero xs:string 3 - 10 caracteres Sim É o número do endereço, para endereços sem números
informar S/N.
Telefone xs:string 9 - 14 caracteres Não É o telefone do endereço.

Objeto: Pessoa

Campo Tipo Valores Obri. Descrição


AtualizarEnderecoPessoa xs:boolean Não Informa se deseja atualizar o endereço da
Pessoa quando ela já estiver cadastrada
na Multisoftware.
CPFCNPJ xs:string 9 - 18 caracteres Sim CPF ou CNPJ da Pessoa.
ClienteExterior xs:boolean Não Identifica se o cliente é do Exterior.
CodigoAtividade xs:int Ver Codigo Objeto Sim É a atividade da pessoa.
RamoAtividade
CodigoIntegracao xs:string 1 - 50 Caracteres Não Código em comum para troca de
informação entre a integradora e a
Multisoftware.
Email xs:string 1 - 150 caracteres Não E-mail da pessoa.
Endereco Endereco Ver Objeto Endereco Sim É o endereço da Pessoa
IM xs:string 1 - 20 Não Inscrição Municipal da pessoa.
NomeFantasia xs:string 1 - 80 caracteres Não Nome fantasia da pessoa.
RGIE xs:string 7 - 20 caracteres Sim É a inscrição estadual ou o RG da pessoa.
RazaoSocial xs:string 1 – 80 caracteres Sim Razão Social ou Nome da pessoa.
TipoPessoa TipoPessoa Fisica; Sim Identifica se a pessoa é física ou jurídica.
Juridica;

Objeto: Motorista

Campo Tipo Valores Obri. Descrição


CPF xs:string 9 - 14 caracteres Sim É o CPF do motorista.
DataAdmissao xs:string dd/MM/yyyy Não É a data de admissão do motorista.
DataHabilitacao xs:string dd/MM/yyyy Não É a data de habilitação do motorista.
DataNascimento xs:string dd/MM/yyyy Não É a data de nascimento do motorista.
DataVencimentoHabilitacao xs:string dd/MM/yyyy Não É a data de vencimento da habilitação do
motorista.
Email xs:string 1 – 150 caracteres Não É o e-mail do motorista.
Endereco Endereco Ver objeto Endereco Não É o endereço do motorista.
Nome xs:string 1 - 80 caracteres Sim É o nome do motorista.
NumeroHabilitacao xs:string 6 - 20 Não É o número de habilitação do motorista.
RG xs:string 7 - 14 caracteres Não É o RG do motorista.
Objeto: Proprietario

Campo Tipo Valores Obri. Descrição


CIOT xs:string 12 Caracteres Não Número do CIOT Aberto
FornecedorValePedagio Pessoa Ver objeto Pessoa Não É o Fornecedor do Vale Pedágio
NumeroCompraValePedagio xs:string 1 – 20 Caracteres Não Número de compra do Vale Pedágio
ResponsavelValePedagio Pessoa Ver objeto Pessoa Não É o Responsável pelo Vale Pedágio
TipoTACVeiculo TipoTACVeiculo TACAgregado; Sim Tipo da TAC do veículo.
TACIndependente;
Outros;
TransportadorTerceiro Empresa Ver objeto empresa Sim É o transportador proprietário do
véiculo.
ValorValePedagio xs:decimal Não Valor do Vale Pedágio.

Objeto: Empresa

Campo Tipo Valores Obri. Descrição


CNPJ xs:string 14 - caracteres Sim CNPJ da Empresa.
Endereco Endereco Ver objeto Endereco Sim É o endereço da Empresa.
IE xs:string 7 - 20 caracteres Sim É a inscrição estadual da Empresa.
InscricaoMunicipal xs:string 1 - 20 caracteres Não Inscrição Municipal da empresa.
InscricaoST xs:string 10 - 20 Não Inscrição ST da empresa.
NomeFantasia xs:string 1 - 80 caracteres Sim Nome fantasia da empresa.
RNTRC xs:string 8 caracteres Sim É o registro ANTT da emprersa.
(Somente Números).
RazaoSocial xs:string 1 – 80 caracteres Sim É a razão social da empresa.
SimplesNacional xs:boolean Não Indica se a emprersa é da tributação
simples.
DadosBancarios DadosBancarios Ver objeto Não É os dados bancários da Empresa.
DadosBancarios

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

Campo Tipo Valores Obri. Descrição


AnoFabricacao xs:int Não Ano de fabricação do veículo.
AnoModelo xs:int Não Ano de modelo do veículo.
Ativo xs:boolean Sim Veículo ativo na Multisoftware.
CapacidadeKG xs:int Sim É a capacidade em KG do veículo.
CapacidadeM3 xs:int Não É a capacidade em metros cúbicos do
veículo.
DataAquisicao xs:string dd/MM/yyyy Não Data de aquisição do veículo.

ModeloVeicular ModeloVeicular Ver objeto Não É o modelo veicular de carga do veículo.


ModeloVeicular
Motoristas Array: Motoristas Ver objeto motorista Não São os motoristas que conduzem o veículo.
NumeroChassi xs:string 17 caracteres Não Número do chassi do véiculo.
NumeroFrota xs:string 1 – 30 caracteres Não Número da Frota do Veículo.
NumeroMotor xs:string 1 – 60 caracteres Nâo Númeo do motor do veículo.
Placa xs:string AAA9999 Sim É a placa do veículo.
Proprietario Proprietario Ver objeto Não É obrigatório quando o veículo for de
Proprietario terceiros.
RNTC xs:string 8 caracteres Não Registro ANTT do veículo. Obrigatório
quando o veículo for de terceios.
Reboques Array:Veiculo Ver objeto Veiculo Não Lista de reboques do veículo.
Renavam xs:string 9 - 11 caracteres Sim É o RENAVAM do veículo.
Tara xs:int Não É a tara veículo.
TipoCarroceria TipoCarroceria NaoAplicavel; Sim É o tipo da carroceria do veículo.
Aberta;
FechadaBau;
Graneleira;
PortaContainer;
Sider;
TipoPropriedadeVeiculo TipoPropriedadeVeiculo Proprio; Sim Tipo do proprietário do veículo.
Terceiros;
TipoRodado TipoRodado NaoAplicavel; Sim Tipo do Rodado do veículo.
Truck;
Toco;
CavaloMecanico;
VAN;
Utilitario;
Outros;
TipoVeiculo TipoVeiculo Tracao; Sim É o tipo do veículo.
Reboque;
UF xs:string 2 caracteres Sim É a UF de emplacamento do veículo.
XTexto xs:string 0 – 160 Não Valor será incluído na tag xTexto do CT-e
xCampo xs:string 0 – 20 Não Valor será incluído na tag xCampo do CT-e

Objeto: CTe

Campo Tipo Valores Obri. Descrição


CFOP xs:int Sim É a CFOP utilizada para emissão do CT-
e
Chave xs:string 44 caracteres Sim É a chave de acesso do CT-e
DataEmissao xs:string dd/MM/yyyy HH:mm:ss Sim É a data de emissão do CT-e
Destinatario Pessoa Ver objeto Pessoa Sim É o destinatário do CT-e
Expedidor Pessoa Ver objeto Pessoa Não É o expedidor do CT-e
LocalidadeFimPrestacao Localidade Ver objeto Localidade Sim É a localidade onde a prestação do
serviço é finalizada.
LocalidadeInicioPrestacao Localidade Ver objeto Localidade Sim É a localidade onde a prestação do
serviço é iniciada.
Lotacao xs:boolean Não Indica se o CT-e é lotação.
Modelo xs:string 2 caracteres Sim É o modelo do documento. CT-e sempre
57.
MotivoCancelamento xs:string 1-400 caracteres Não Caso o CT-e esteja cancelado, nesse
campo está informado o motivo do
cancelamento.
Motoristas Array: Motoristas Ver objeto motorista Não São os motoristas utilizados no Ct-e
Numero xs:int Sim Número do CT-e.
PDF xs:string Texto Não Contém a codificação do PDF da
DACTE Gerada pela Multisotware.
Protocolo xs:int Sim É o protocolo da Multisoftware para o
CT-e.
ProtocolosDePedidos ArrayOfint Não Contém os protocolos dos pedidos que
pertencem a esse CT-e.
Recebedor Pessoa Ver objeto Pessoa Não É o recebedor do CT-e
Remetente Pessoa Ver objeto Pessoa Sim É o remetente do CT-e
Serie xs:int Sim É a série do CT-e.
SituacaoCTeSefaz SituacaoCTeSefaz Autorizada; Sim É a situação do CT-e.
Cancelada;
Denegada;
Rejeitada;
Pendente;
Enviada;
Inutilizada;
EmDigitacao;
EmCancelamento;
EmInutilizacao;
TipoCTE TipoCTE Normal; Sim É o tipo do CT-e.
Complemento;
Anulacao;
Substituto;
TipoServico TipoServico Normal; Sim É o tipo de serviço realizado no CT-e.
SubContratacao;
Redespacho;
RedIntermediario;
TipoTomador TipoTomador Remetente; Sim É o tipo do tomador do CT-e.
Expedidor;
Recebedor;
Destinatario;
Outros;
Tomador Pessoa Ver objeto Pessoa Sim É o tomador do CT-e.
TransportadoraEmitente Empresa Ver objeto Empresa Sim É o emitente do CT-e.
ValorFrete FreteValor Ver objeto FreteValor Sim Contém as informações do Frete Do CT-
e.
ValorTotalMercadoria xs:decimal Sim É o valor total da mercadoria.
VersaoCTE xs:string 4 caracteres Sim É a versão do CT-e.
XML xs:string Texto Não É o xml da situação atual do CT-e.
XMLAutorizacao xs:string Texto Não É o xml de autorização do CT-e.
XMLCancelamento xs:string Texto Não É o xml de cancelamento do CT-e
Veiculo Veiculo Ver objeto Veículo Não É o veículo utilizado no CT-e.
Objeto: MDFe

Campo Tipo Valores Obri. Descrição


Chave xs:string 44 caracteres Sim É a chave de acesso do MDF-e
DataEmissao xs:string dd/MM/yyyy HH:mm:ss Sim É a data de emissão do MDF-e
Numero xs:int Sim Número do MDF-e.
PDF xs:string Texto Não Contém a codificação do PDF do MDFe
Gerada pela Multisotware.
Protocolo xs:int Sim É o protocolo da Multisoftware para o
MDFe
ProtocolosDeCTe List:int Lista Sim Lista dos protocolos dos CT-es
vinculados ao MDFe
Serie xs:int Sim Série do MDF-e.
Status
TransportadoraEmitente Empresa Ver objeto Empresa Sim É a transportadora Emitente da Nota de
Serviço Manual.
UFDestino xs:string 2 caracteres Sim Estado de Destino do MDF-e
UFOrigem xs:string 2 caracteres Sim Estado de Origem do MDF-e
XML xs:string Texto Não É o xml do MDF-e.

Objeto: NFS

Campo Tipo Valores Obri. Descrição


Protocolo xs:int Sim É o protocolo da Multisoftware para a
Nota Fiscal de Serviço.
TipoNotaFiscalServico TipoNotaFiscalServic Manual; Sim É o tipo da nota de Serviço.
o Eletronica;
NFSe NFSe Ver objeto NFSe Não Contém dos detalhes de uma nota de
serviço quando ela é eletrônica.
NFSManual NFSManual Ver objeto NFSManual Não Contém os detalhes de uma nota de
serviço quando ela é manual.
ProtocolosDePedidos ArrayOfint Não Contém os protocolos dos pedidos que
pertencem a esse NFS-e.
Tomador Pessoa Ver objeto Pessoa Sim É o tomador da NFS-e.
LocalidadePrestacaoServico Localidade Ver objeto Localidade Sim É a localidade onde o serviço foi
prestado.
TransportadoraEmitente Empresa Ver objeto Empresa Sim É a transportadora Emitente da Nota de
Serviço Manual.
ValoresNFS ValorNFs Ver Objeto ValorNFs Sim Contém os Valores da Nota de Serviço
Manual.
Motoristas Array: Motoristas Ver objeto motorista Não São os motoristas utilizados na Nota de
Serviço
Veiculo Veiculo Ver objeto Veículo Não É o veículo utilizado na Nota de Serviço.
Objeto: NFSManual
Campo Tipo Valores Obri. Descrição
Numero xs:int Sim Número da Nota de Serviço Manual
DataEmissao xs:string dd/MM/yyyy Sim É a data de emissão da Nota de Serviço
Manual
ServicosPrestados Array: Ver objeto Não Contém os serviços prestados na Nota
NFSManualServico NFSManualServicoPrest de serviço Manual.
Prestado ado
Imagem xs:string Texto Não Contém a imagem da nota de serviço
manual.

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.

Você também pode gostar

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy