Rio de Janeiro

Documentação do Rio de Janeiro

POST /api/v1/nfse

Exemplo completo com tomador Pessoa Jurídica:

{
    "emitter_id": 1,
    "service_values": {
        "rps_situation": 1,
        "rps_type": 1,
        "operation_nature": 1,
        "special_regime": 1,
        "serie": "A",
        "city_tax_code": "010501",
        "service_item_code": "0105",
        "description": "Descrição do serviço prestado",
        "service_amount": 100.00,
        "deduction_amount": 0.00,
        "iss_percentage": 5.00,
        "inss_percentage": 1.00,
        "ir_percentage": 1.00,
        "cofins_percentage": 1.00,
        "csll_percentage": 1.00,
        "pis_percentage": 1.00,
        "retained_iss": false,
        "retained_iss_percentage": 1.00,
        "tax_burden_percentage": 1.00,
        "tax_burden_amount": 1.00,
        "tax_burden_source": "IBPT",
        "highlight_retentions": ["ir_amount", "pis_amount", "cofins_amount", "csll_amount", "inss_amount", "retained_iss_amount"],
        "tax_burden_highlight": true

    },
    "taker": {
        "cnpj": "11023029000105",
        "social_reason": "Fulano de tal",
        "fancy_name": "Fulado",
        "city_inscription": "39476901",
        "state_inscription": "",
        "special_situation": "",
        "foreign_taker": false,
        "address": {
            "zip_code": "95095000",
            "state": "RS",
            "city": "Caxias do Sul",
            "neighborhood": "CENTRO",
            "street": "Pinheiro Machado",
            "neighborhood_type": "",
            "number": "123",
            "street_type": "RUA",
            "complement": "",
            "reference_point": ""
        },
        "contact": {
            "email": "fulado.tal@exemplo.com.br",
            "phone": "1234567890"
        }
    }
}

Exemplo completo com tomador Pessoa Física:

{
    "emitter_id": 1,
    "service_values": {
        "rps_situation": 1,
        "rps_type": 1,
        "operation_nature": 1,
        "special_regime": 1,
        "serie": "A",
        "city_tax_code": "010501",
        "service_item_code": "0105",
        "description": "Descrição do serviço prestado",
        "service_amount": 100.00,
        "deduction_amount": 0.00,
        "iss_percentage": 5.00,
        "inss_percentage": 1.00,
        "ir_percentage": 1.00,
        "cofins_percentage": 1.00,
        "csll_percentage": 1.00,
        "pis_percentage": 1.00,
        "retained_iss": false,
        "retained_iss_percentage": 1.00,
        "tax_burden_percentage": 1.00,
        "tax_burden_amount": 1.00,
        "tax_burden_source": "IBPT",
        "highlight_retentions": ["ir_amount", "pis_amount", "cofins_amount", "csll_amount", "inss_amount", "retained_iss_amount"],
        "tax_burden_highlight": true

    },
    "taker": {
        "cpf": "11185827641",
        "social_reason": "Fulano de tal",
        "address": {
            "zip_code": "95095000",
            "state": "RS",
            "city": "Caxias do Sul",
            "neighborhood": "CENTRO",
            "street": "Pinheiro Machado",
            "neighborhood_type": "",
            "number": "123",
            "street_type": "RUA",
            "complement": "",
            "reference_point": ""
        },
        "contact": {
            "email": "fulado.tal@exemplo.com.br",
            "phone": "1234567890"
        }
    }
}

Dados gerais da nota

Parâmetro	Descrição	Formato	Obrigatório
emitter_id	Identificação do emitente cadastrado no Emites.		Sim

Dados do service_values

Parâmetro	Descrição	Formato	Obrigatório
rps_situation	Situação da NFSe. *Ver valores permitidos.		Sim
rps_type	Tipo do RPS. *Ver valores permitidos.		Sim
operation_nature	Natureza da Operação. *Ver valores permitidos.		Sim
special_regime	Regime especial de tributação. *Ver valores permitidos.		Não
serie	Série do RPS.		Sim
city_tax_code	Código do serviço prestado do próprio município.		Sim
service_item_code	Código do serviço conforme prefeitura onde o serviço é prestado.		Sim
description	Discriminação dos serviços.		Sim
service_amount	Valor do Serviço em R$.	0.00	Sim
deduction_amount	Valor das deduções para Redução da Base de Cálculo em R$.	0.00	Não
iss_percentage	Valor do ISS em %.	0.00	Não
inss_percentage	Valor do INSS em %.	0.00	Não
ir_percentage	Valor do IR em %.	0.00	Não
cofins_percentage	Valor do COFINS em %.	0.00	Não
csll_percentage	Valor do CSLL em %.	0.00	Não
pis_percentage	Valor do PIS em %.	0.00	Não
retained_iss_percentage	Valor do ISS retirdo em %.	0.00	Não
tax_burden_percentage	Valor da Carga tributária em %.	0.00	Não
tax_burden_amount	Valor Aproximado da Carga Tributária em R$	0.00	Não
tax_burden_source	Fonte da Carga tributária		Não
highlight_retentions	Flag para destacar as retenções na discriminação do serviço.		Não
tax_burden_highlight	tax_burden_highlight a carga tributária aproximada na discriminação do serviço.		Não

Valores permitidos para rps_situation

Valor	Descrição
1	Normal
2	Cancelado

Valores permitidos para rps_type

Valor	Descrição
1	RPS
2	Nota
3	Cupom

Valores permitidos para operation_nature

Valor	Descrição
1	Tributação no município
2	Tributação fora do município
3	Isenção
4	Imune
5	Exigibilidade suspensa por decisão judicial
6	Exigibilidade suspensa por procedimento Administrativo

Valores permitidos para special_regime

Valor	Descrição
1	Microempresa Municipal
2	Estimativa
3	Sociedade Professional
4	Cooperativa
5	MEI - Microempresário Individual
6	ME EPP - Microempresário e Empresa de Pequeno Porte

Valores permitidos para highlight_retentions

Valor	Descrição
ir_amount	IR
pis_amount	PIS
cofins_amount	COFINS
csll_amount	CSLL
inss_amount	INSS
retained_iss_amount	ISS

Dados do taker

Parâmetro	Descrição	Formato	Obrigatório
cpf	CPF do tomador.		Sim*
cnpj	CNPJ do tomador.		Sim**
social_reason	Razão Social do Tomador.		Sim
fancy_name	Nome Fantasia do Tomador.		Não
city_inscription	Inscrição Municipal do Tomador.		Não
state_inscription	Inscrição Estadual do Tomador.		Não
special_situation	Situação Especial do Tomador. *Ver valores permitidos.		Não
foreign_taker	Tomador Estrangeiro.	true ou false	Não

*cpf: Não obrigatório caso seja passado o cnpj.

**cnpj: Não obrigatório caso seja passado o cpf.

Valores permitidos para special_situation

Valor	Descrição
0	Outros
1	SUS
2	Órgão do Poder Executivo
3	Bancos
4	Comércio/Industria
5	Poder Legislativo/Judiciário

Endereço do tomador:

Parâmetro	Descrição	Obrigatório
zip_code	CEP.	Não
state	Estado (Sigla).	Não
city	Nome da cidade.	Não
neighborhood	Bairro.	Não
street	Logradouro.	Não
neighborhood_type	Tipo do logradouro. *Ver valores permitidos.	Não
number	Número.	Não
street_type	Tipo do bairro. *Ver valores permitidos.	Não
complement	Complemento do endereço.	Não
reference_point	Ponto de referência.	Não

Valores permitidos para street_type

Valor	Descrição
RUA	Rua
ALM	Alameda
AVN	Avenida
BEC	Beco
BLV	Boulevard
CAM	Caminho
CAS	Cais
CMP	Campo
ESC	Escada
ETR	Estrada
FAV	Favela
FAZ	Fazendo
FLT	Floresta
ILH	Ilha
JRD	Jardim
LAD	Ladeira
LRG	Largo
LTM	Loteamento
LUG	Lugar
MRR	Morro
PQE	Parque
PAS	Passeio
PRA	Praia
PRC	Praça
REC	Recanto
ROD	Rodovia
SRV	Servidão
TRV	Travessa
VIA	Via
VIL	Vila

Valores permitidos para neighborhood_type

Valor	Descrição
IND	Industrial
COM	Comercial
RED	Residencial

Contato do tomador:

Parâmetro	Descrição	Obrigatório
email	Telefone do tomador, com o código DDD.	Não
phone	Email do tomador.	Não