INFORMAÇÕES TÉCNICAS

Especificação API's de integração com Motor Fiscal

MOTOR FISCAL -> ZAPIER | Integração via Webhook

NFSE - Webhook

GATILHO

Recebimento de uma Nota Fiscal de Serviço Eletrônica (NFSE) pelo Motor Fiscal, através de integração direta com a Prefeitura ou Processamento via OCR.

BODY - REQUEST
{
    "tipo": "recebida",
    "statusNFe": "Normal",
    "codMun": "3203130",
    "customValues": [],
    "COFINS": 7073.33,
    "CSLL": 2357.78,
    "INSS": 25935.54,
    "IR": 2357.78,
    "ISS": 11788.88,
    "ISSRetido": "true",
    "PIS": 1532.55,
    "UFPrestador": "ES",
    "aliqServico": "5",
    "cepPrestador": "29680-000",
    "cidadePrestador": "João Neiva",
    "cnpjCpfPrestador": "36557131000165",
    "cnpjCpfTomador": "34562939000131",
    "codServico": "7.10",
    "codVerificacao": "3140C8B381981FASDG12445A74741A07E9D1",
    "deducoes": 0,
    "descServico": "Limpeza, manutenção e conservação de vias e logradouros públicos, imóveis, chaminés, piscinas, parques, jardins e congeneres ",
    "discriminacao": "Prestacao de servicos de limpeza no posto de Vitoria/ES de acordo com o contrato 19.08.2012. Referente aos servicos prestados em Novembro de 2023. No Pedido 132461",
    "dtEmissaoNfe": "2023-12-19T12:00:00.000Z",
    "dtEmissaoRPS": "2023-12-19T12:00:00.000Z",
    "emailPrestador": "teste@compila.com.br",
    "enderecoPrestador": "AV.PAULISTA, 2006 ",
    "inscPrestador": "451.441",
    "inscTomador": "",
    "inscriEsPrestador": "",
    "lei": {
        "codigo": "7.10",
        "descricao": "Limpeza, manutenção e conservação de vias e logradouros públicos, imóveis, chaminés, piscinas, parques, jardins e congeneres "
    },
    "nome_municipio": "João Neiva",
    "numLote": "",
    "numRPS": "3413",
    "numeroNfe": "28426",
    "simples_nacional": { 
        "descricao": "Optante - Microempreendedor Individual (MEI)"
    },
    "outrasRetencoes": 0,
    "prefeitura": "João Neiva",
    "razaoPrestador": "COMPILA PROCESSAMENTO DE DADOS LTDA ",
    "razaoTomador": "Posto do Sudeste do Brasil S.A.",
    "serie": "",
    "serieRPS": "NF",
    "telefonePrestador": "",
    "tribNfe": "U0",
    "vlrCredito": 0,
    "vlrServico": 235777.6
}
BODY - ESPECIFICAÇÃO
ELEMENTO TP DESCRICAO
tipo S Opções: rebida / emitada
statusNFe S Opções: Normal / Cancelada / Substituida
codMun S Codigo Municipio padrao IBGE
customValues S Campos customizados criados pelo usuário dentro da plataforma Motor Fiscal
COFINS N Valor COFINS
CSLL N Valor CSLL
INSS N Valor INSS
IR N Valor IR
ISS N Valor ISS
ISSRetido S "true" / "false"
PIS N Valor PIS
UFPrestador S Sigla UF
aliqServico N Alíquota de Serviço (ISS)
cepPrestador S Cep Prestador 
cidadePrestador S Cidade Prestador
cnpjCpfPrestador S CNPJ ou CPF do Prestador
cnpjCpfTomador S CNPJ ou CPF do Tomador
codServico S Código do Serviço 
codVerificacao S Código de Verificação, Código de Autenticidade 
deducoes S Valor das deduções
descServico S Descrição dos serviços
discriminacao S Discriminação dos Serviços
dtEmissaoNfe S Data Emissão Nota Fiscal
dtEmissaoRPS S Data Emissão Recibo Provisório de Serviço (RPS)
emailPrestador S Email Prestador
enderecoPrestador S Endereço Prestador
inscPrestador S Inscrição Municipal Prestador
inscTomador S Inscrição Municipal Tomador
inscriEsPrestador S Inscrição Estadual Prestador
lei -> codigo S Código do Serviço mediante a lei 116
lei -> descricao S Descrição do Serviço mediante a lei 116
nome_municipio S Nome Município Prestador
numLote S Numero do Lote
numRPS S Numero da Recibo Provisório de Serviço (RPS)
numeroNfe S Numero da Nota Fiscal
simples_nacional -> 
descricao
 S
Descrição se prestador é Optante pelo Simples ? 
Exemplo: "Optante - Microempreendedor Individual (MEI)"
outrasRetencoes N Valor outras deduções
prefeitura S Prefeitura
razaoPrestador S Razão Social Prestador
razaoTomador S Razão Social Tomador
serie S Serie da Nota Fiscal
serieRPS S Serie da Recibo Provisório de Serviço (RPS)
telefonePrestador S Telefone Prestador
tribNfe S
Tipos Descrição
T Tributado em São Paulo.
F Tributado Fora de São Paulo.
A Tributado em São Paulo, porém Isento.
B Tributado Fora de São Paulo, porém Isento.
D Tributado em São Paulo com isenção parcia.
M Tributado em São Paulo, porém com indicação de imunidade subjetiva.
N Tributado Fora de São Paulo, porém com indicação de imunidade subjetiva.
R Tributado em São Paulo, porém com indicação de imunidade objetiva.
S Tributado fora de São Paulo, porém com indicação de imunidade objetiva.
X Tributado em São Paulo, porém Exigibilidade Suspensa.
V Tributado Fora de São Paulo, porém Exigibilidade Suspensa.
P Exportação de Serviços.
U0 Upload, sem informação de tributação.
vlrCredito N Valor do Crédito
vlrServico N Valor total do serviço


MOTOR FISCAL -> ZAPIER | Integration by Webhook

NFSE - Webhook

TRIGGER

Reception of Eletronic Service Invoice (NFSE) by Motor Fiscal, through direct integration with Municipality or OCR processing.

BODY - REQUEST
{
    "tipo": "received",
    "statusNFe": "Normal",
    "codMun": "3203130",
    "customValues": [],
    "COFINS": 7073.33,
    "CSLL": 2357.78,
    "INSS": 25935.54,
    "IR": 2357.78,
    "ISS": 11788.88,
    "ISSRetido": "true",
    "PIS": 1532.55,
    "UFPrestador": "ES",
    "aliqServico": "5",
    "cepPrestador": "29680-000",
    "cidadePrestador": "João Neiva",
    "cnpjCpfPrestador": "36557131000165",
    "cnpjCpfTomador": "34562939000131",
    "codServico": "7.10",
    "codVerificacao": "3140C8B381981FASDG12445A74741A07E9D1",
    "deducoes": 0,
    "descServico": "Cleaning, maintenance and conservation of public roads and places, properties, chimneys, swimming pools, parks, gardens and similar",
    "discriminacao": "Provision of cleaning services at the Vitória/ES station in accordance with contract 19.08.2012. Referring to services provided in November 2023. In Order 132461",
    "dtEmissaoNfe": "2023-12-19T12:00:00.000Z",
    "dtEmissaoRPS": "2023-12-19T12:00:00.000Z",
    "emailPrestador": "teste@compila.com.br",
    "enderecoPrestador": "AV.PAULISTA, 2006 ",
    "inscPrestador": "451.441",
    "inscTomador": "",
    "inscriEsPrestador": "",
    "lei": {
        "codigo": "7.10",
        "descricao": "Cleaning, maintenance and conservation of public roads and places, properties, chimneys, swimming pools, parks, gardens and similar"
    },
    "nome_municipio": "João Neiva",
    "numLote": "",
    "numRPS": "3413",
    "numeroNfe": "28426",
    "simples_nacional": { 
        "descricao": "Opting - Individual Microentrepreneur (MEI)"
    },
    "outrasRetencoes": 0,
    "prefeitura": "João Neiva",
    "razaoPrestador": "COMPILA PROCESSAMENTO DE DADOS LTDA ",
    "razaoTomador": "Posto do Sudeste do Brasil S.A.",
    "serie": "",
    "serieRPS": "NF",
    "telefonePrestador": "",
    "tribNfe": "U0",
    "vlrCredito": 0,
    "vlrServico": 235777.6
}
BODY - ESPECIFICAÇÃO
ELEMENT ID TYPE DESCRIPTION
tipo type string Options: received/outgoing
statusNFe Status NFSE  string Options: Normal / Canceled / Replaced
codMun City Code string City code - IBGE standard
customValues Custom Values string Custom fields created by user inside the Motor Fiscal plataform
COFINS Label Number COFINS value
CSLL Label Number CSLL value
INSS Label Number INSS value
IR Label Number IR value
ISS Label Number ISS value
ISSRetido Label string "true" / "false"
PIS Label Number PIS value
UFPrestador Service Provider State string UF value
aliqServico Percent Tax Service  Number Service aliquot (ISS)
cepPrestador

Service Provider

Zip code

 string Zip code of Service Provider
cidadePrestador Service Provider City  string Service Provider City
cnpjCpfPrestador CNPJ of Service Provider  string CNPJ or CPF of Service Provider 
cnpjCpfTomador CNPJ of Service Taker string CNPJ or CPF of Service Taker
codServico Service Code string Service code
codVerificacao Verification code of invoice string Verification code, Autenticity code
deducoes dedutions Number Dedutions values
descServico Service description string Service description
discriminacao Detailed Service description string Detailed Service description
dtEmissaoNfe Emission date of NFSE Datetime Invoice date of issue
dtEmissaoRPS Emission date of RPS  Datetime Provisional Service Receipt (RPS) date of issue
emailPrestador email of Service Provider string Service Provider Email 
enderecoPrestador Adress of Service Provider string Service Provider adress
inscPrestador Service Provider Municipal inscription  string Service Provider Municipal inscription 
inscTomador Service Taker Municipal inscription  string Service Taker Municipal inscription 
inscriEsPrestador Service Provider State inscription  string Service Provider State inscription 
lei -> codigo law -> code string Service code through law 116
lei -> descricao law -> description string Service description through law 116
nome_municipio name_city string Service provider City name
numLote Batch number string Batch number
numRPS Number of RPS string Provisional Service Receipt (RPS) Number
numeroNfe Nfe number string Invoice number
simples_nacional -> 
descricao
simples_nacional -> description
 string
Is service provider opting for Simples?
Example: "Opting - Individual Microentrepreneur (MEI)"
outrasRetencoes Other retentions Number Other retentions values
prefeitura municipality string municipality
razaoPrestador Service Provider Company name string Service Provider Company name
razaoTomador Service Taker Company name string Service Taker Company name
serie series string Invoice series
serieRPS RPS series string Provisional Service Receipt (RPS) Series
telefonePrestador Service Provider phone string Service Provider phone
tribNfe Nfe tax string
Tipos Descrição
T Taxed in São Paulo.
F Taxed out of São Paulo.
A Taxed in São Paulo, but with total exemption.
B Taxed out of São Paulo, but with total exemption.
D Taxed in São Paulo with partial exemption.
M Taxed in São Paulo, but with subjective immunity indication.
N Taxed out of São Paulo, but with subjective immunity indication.
R

Taxed in São Paulo, but with objective immunity indication.
S

Taxed out of São Paulo, but with objective immunity indication.
X

Taxed in São Paulo, but suspended collection.
V Taxed out of São Paulo, but suspended collection.
P Export of services
U0 Upload, without tax information.
vlrCredito Credited tax value  Number Credited tax value 
vlrServico Total service value Number Total service value


Single Sign On - SSO - Motor Fiscal

O Motor Fiscal Docs suporta autenticação por Microsoft Entra ID (antigo Azure Active Directory) como alternativa ao login por usuário e senha. A autenticação é feita via protocolo SAML com suporte a Single Sign-On (SSO), permitindo que usuários utilizem suas credenciais corporativas Microsoft para acesso à aplicação.

 

entra.png

 

As telas abaixo mostram as mensagens exibidas caso o usuario não tenha privilégios de administrador, e caso tenha os privilégios.

 

 

SSO.png