NFSe

Documentação do Rio de Janeiro

Documentação de São Paulo

A emissão de um nova Nota Fiscal de Serviço Eletrônica é feita através de um única chamada a API. Todos os dados da NFSe, são dividos pelo seus respectivos modelos. Confira o padrão dos modelos abaixo:

Modelos

Nota fiscal de serviço eletrônica

O modelo abaixo relaciona o emissor, tomador e outras informações necessárias para a nota ser emitida.

Parâmetro Descrição Padrão Obrigatório Tipo de Dado Tamanho Máximo
emitter_id Identificação do emitente cadastrado no Emites. (ID)   Sim Numérico  
taker Tomador do serviço. Ver valores permitidos   Não* Vide categoria tomador  
taker_id Identificação do tomador cadastrado no Emites (ID)   Não** Numérico  
rps_situation Situação da NFSe. Ver valores permitidos 1 Não Numérico  
serie Série do RPS   Sim Caracteres 5
number Número do RPS   Não Númerico 10
rps_type Tipo do RPS. Ver valores permitidos 1 Não Numérico 1
emission_date Data de emissão do documento. Ver formatação   Sim Data/Hora  
operation_nature Natureza da Operação. Ver valores permitidos 1 Sim Numérico  
other_informations Campo livre para informações adicionais   Não Caracteres 255
competence Data da competência do serviço. Ver formatação   Não Data  
special_regime Regime especial de tributação. Ver valores permitidos 1 Não Numérico 1
status Status da NFSe na prefeitura. Por exemplo, o status processing quer dizer que a NFSe está sendo processada   Não*** Caracteres  
description Descrição do status da NFSe. Versão humanizada do campo status   Não*** Caracteres  
send_nfse_taker Envia a NFSe para o tomador assim que a mesma for aceita false Não Booleano  
allow_incomplete Flag para permitir o cadastro incompleto da NFSe. No cadastro incompleto, somente o emitente é obrigatório. false Não Booleano  
is_complete Caso os dados da NFSe não estejam completos o usuário poderá completar o cadastro posteriormente. A NFSe não será emitida. true Não Booleano  

*taker_id: Não obrigatório caso seja passado o taker.

**taker: Não obrigatório caso seja passado o taker_id.

***Campos de apenas leitura, não podem ser editados.

Valores da nota fiscal de serviço eletrônica

O modelo abaixo relaciona todas as informações de valores da nota fiscal, por exemplo: o valor do serviço, o valor líquido da nota, descrição do serviço prestado, entre outros valores necessários para a NFSe.

Parâmetro Descrição Padrão Obrigatório Tipo de Dado Tamanho Máximo
service_amount Valor do Serviço em R$   Sim Numérico 16,2
calculation_base Base de cálculo do serviço   Sim Numérico 16,2
deduction_amount Valor das deduções para Redução da Base de Cálculo em R$   Sim Numérico 16,2
retained_iss ISS Retido. Sim (true) ou Não (false) false Não Booleano  
iss_percentage Valor da aliquota do ISS em %   Sim Numérico 6,2
iss_amount Valor do ISS em R$   Sim Numérico 16,2
pis_amount Valor da retenção do PIS em R$   Sim Numérico 16,2
cofins_amount Valor da retenção do COFINS em R$   Sim Numérico 16,2
inss_amount Valor da retenção do INSS em R$   Sim Numérico 16,2
ir_amount Valor da retenção do IR em R$   Sim Numérico 16,2
csll_amount Valor da retenção do CSLL em R$   Sim Numérico 16,2
discount_conditioning_amount Valor de desconto concedido sobre uma determinada condição   Sim Numérico 16,2
service_item_code Código do serviço conforme prefeitura onde o serviço é prestado   Sim Caracteres 5
city_tax_code Código do serviço prestado do próprio município. Muda conforme prefeitura   Não Caracteres 20
cnae_code Classificação Nacional de Atividades Econômicas. Mais informações   Não Numérico  
description Discriminação dos serviços prestados   Sim Caracteres  
city_code Código da cidade conforme IBGE. Pesquisar código da cidade   Sim Numérico  
nfse_liquid_amount Valor líquido do serviço prestado   Não Numérico 16,2
other_retentions_amount Outras retenções na Fonte   Não Numérico 16,2
retained_iss_amount Valor do ISS em R$   Não Numérico 16,2
unconditioned_discount_amount Desconto incondicional é aquele concedido independentemente de qualquer condição   Não Numérico 16,2
highlight_retentions Flag para destacar as retenções na discriminação do serviço. Veja abaixo os valores permitidos   Não Caracteres 255

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

Substituição da nota fiscal de serviço eletrônica

Esse modelo de substituição só deve ser informado quando a nota deseja substituir uma NFSe já emitida, como em algum caso de código do serviço errado, valor de imposto incorreto, entre outros motivos possíveis.

Parâmetro Descrição Obrigatório Tipo de Dado Tamanho Máximo
number Número do RPS que será substituído. Sim Numérico 15,0
serie Série do RPS que será substituído. Sim Caracteres 5
rps_type Tipo do RPS que será substituído. Sim Númerico 1

Criação

A criação da NFSe acontece pelo envio dos dados através de uma única chamada na API. Os dados são aninhados, e todos os modelos são obrigatórios, exceto o modelo de substituição quando for uma NFSe nova.

POST /api/v1/nfse

Corpo de exemplo da requisição:

{
    "emitter_id": 1,
    "rps_type": 1,
    "serie": "a",
    "emission_date": "2014-03-18T08:34:56Z",
    "operation_nature": 1,
    "rps_situation": 1,
    "service_values": {
        "service_amount": 99.9,
        "deduction_amount": 0,
        "retained_iss": falsealse,
        "calculation_base": 99.9,
        "iss_percentage": 5.00,
        "iss_amount": 4.99,
        "pis_amount": 0,
        "cofins_amount": 0,
        "inss_amount": 0,
        "ir_amount": 0,
        "csll_amount": 0,
        "discount_conditioning_amount": 0,
        "service_item_code": "0105",
        "city_tax_code": "010501",
        "description": "Servicos de informatica",
        "city_code": 3304557,
        "nfse_liquid_amount": 109.9
    },
    "taker": {
        "cpf": "44423739577",
        "city_inscription": "92708711",
        "social_reason": "Razão Social do Tomador",
        "address": {
            "street": "Feijó Júnior",
            "number": "535",
            "neighborhood": "São Pelegrino",
            "neighborhood_type": "COM",
            "city_code": 4305108,
            "state": "RS",
            "zip_code": 95110550,
            "city": "Caxias do Sul"
        },
        "contact": {
            "phone": "32272144",
            "ddd": 54
        }
    }
}

Cadastro incompleto

Você cadastrar uma NFSe parcialmente. Isso é útil quando o seu sistema não possui todos os dados necessários para o cadastro completo. Dessa maneira será necessário continuar o cadastro manualmente. Para o cadastro parcial, passe a chave allow_incomplete como ´true´:

POST /api/v1/nfse

Corpo de exemplo da requisição:

{
    "emitter_id": 1,
    "allow_incomplete": true
}

Corpo de exemplo da resposta:

{
    "_links": [
        {
            "href":"https:sandbox.emites.com.br/api/v1/nfse/1",
            "method":"GET",
            "rel":"self"
        }, {
            "href":"https:sandbox.emites.com.br/api/v1/nfse/1",
            "method":"DELETE",
            "rel":"destroy"
        }, {
            "href":"https:sandbox.emites.com.br/api/v1/nfse/1/status",
            "method":"GET",
            "rel":"status"
        }, {
            "href":"https:sandbox.emites.com.br/api/v1/nfse/1/cancel",
            "method":"POST",
            "rel":"cancel"
        }, {
            "href":"https:sandbox.emites.com.br/api/v1/nfse/1/mirror",
            "method":"GET",
            "rel":"mirror"
        }, {
            "href":"https:sandbox.emites.com.br/api/v1/nfse/1/xml",
            "method":"GET",
            "rel":"xml"
        }, {
            "href":"https:sandbox.emites.com.br/api/v1/nfse/1/pdf",
            "method":"GET",
            "rel":"pdf"
        }, {
            "href":"https:sandbox.emites.com.br/api/v1/nfse/1/history",
            "method":"GET",
            "rel":"history"
        }, {
            "href":"https:sandbox.emites.com.br/nfse/show/1",
            "method":"GET",
            "rel":"html"
        }, {
            "href":"https:sandbox.emites.com.br/api/v1/nfse/1",
            "method":"PUT",
            "rel":"update"
        }, {
            "href":"https:sandbox.emites.com.br/api/v1/nfse/1",
            "method":"PATCH",
            "rel":"partial_update"
        }
    ],
    "nfse_errors": [],
    "service_values": {
        "deduction_amount": "0.0",
        "discount_conditioning_amount": "0.0",
        "city_tax_code": null,
        "calculation_base": null,
        "service_amount": null,
        "pis_amount": null,
        "other_retentions": "0.0",
        "inss_amount": null,
        "retained_iss": false,
        "iss_percentage": null,
        "csll_amount": null,
        "service_item_code": null,
        "retained_iss_amount": null,
        "nfse_liquid_amount": null,
        "unconditioned_discount": "0.0",
        "cofins_amount": null,
        "ir_amount": null,
        "iss_amount": null,
        "cnae_code": null,
        "city_code": null,
        "description": null
    },
    "substitute_rps": null,
    "environment": "sandbox",
    "taker": null,
    "emitter_id": 1,
    "batch_id": null,
    "mirror_url": null,
    "xml_url": null,
    "pdf_url": null,
    "id": 1,
    "is_complete": false,
    "status": "created",
    "description": "Aguardando o envio para a Sefaz.",
    "nfse_key": null,
    "nfse_number": null,
    "protocol": null,
    "send_nfse_taker": false,
    "is_api": true,
    "user_id": null,
    "number": 1,
    "serie": null,
    "rps_type": 1,
    "emission_date": null,
    "operation_nature": 1,
    "rps_situation": 1,
    "other_informations": null,
    "competence": null,
    "special_regime": null,
    "emitter_national_simple_optant": true,
    "emitter_cultural_promoter": false
}

Utilizando Tomador previamente cadastrado

Caso você já tenha um Tomador cadastrado, você pode usá-lo da seguinte maneira:

{
    "emitter_id": 1,
    "taker_id": 1,
    "rps_type": 1,
    "serie": "a",
    "emission_date": "2014-03-18T08:34:56Z",
    "operation_nature": 1,
    "rps_situation": 1,
    "service_values": {
        "service_amount": 99.9,
        "deduction_amount": 0,
        "retained_iss": false,
        "calculation_base": 99.9,
        "iss_percentage": 5.00,
        "iss_amount": 4.99,
        "pis_amount": 0,
        "cofins_amount": 0,
        "inss_amount": 0,
        "ir_amount": 0,
        "csll_amount": 0,
        "discount_conditioning_amount": 0,
        "service_item_code": "0105",
        "city_tax_code": "010501",
        "description": "Servicos de informatica",
        "city_code": 3304557,
        "nfse_liquid_amount": 109.9
    }
}

Cabeçalho da resposta:

Status Code: 202
Location: https://sandbox.emites.com.br/api/v1/nfse/1
Date: Tue, 04 Feb 2014 17:55:19 GMT
Vary: Accept, Cookie
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json

Corpo de exemplo da resposta:

{
    "_links": [{
        "href": "https://app.emites.com.br/api/v1/nfse/1",
        "method": "GET",
        "rel": "self"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1",
        "method": "DELETE",
        "rel": "destroy"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/status",
        "method": "GET",
        "rel": "status"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/cancel",
        "method": "POST",
        "rel": "cancel"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/xml",
        "method": "GET",
        "rel": "xml"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/pdf",
        "method": "GET",
        "rel": "pdf"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/history",
        "method": "GET",
        "rel": "history"
    }, {
        "href": "https://app.emites.com.br/nfse/show/1"
        "method": "GET"
        "rel": "html"
    }],
    "taker": {
        "address": {
            "id": 1,
            "street": "Feijó Junior",
            "number": "535",
            "complement": "Sala 102",
            "neighborhood": "Sao Pelegrino",
            "city_code": 4305108,
            "state": "RS",
            "zip_code": 95110550,
            "street_type": "RUA",
            "neighborhood_type": "COM",
            "city": "Caxias do Sul",
            "reference_point": null,
            "country": "Brasil",
            "country_code": "01058",
            "country_abbreviation": "BR"
        },
        "contact": {
            "id": 1,
            "ddd": 54,
            "phone": "32272144",
            "email": null,
            "ddd_comercial_phone": null,
            "comercial_phone": null,
            "ddd_fax": null,
            "fax_phone": null
        },
        "id": 1,
        "cpf": 44423739577,
        "cnpj": null,
        "city_inscription": 92708711,
        "social_reason": "Razão Social do Tomador",
        "fancy_name": null,
        "state_inscription": null,
        "substitute_state_inscription": null,
        "special_situation": 0,
        "foreign_taker": false
    },
    "xml": null,
    "service_values": {
        "id": 1,
        "service_amount": "99.9",
        "deduction_amount": "0",
        "retained_iss": false,
        "calculation_base": "99.9",
        "iss_percentage": "5.00",
        "iss_amount": "4.99",
        "pis_amount": "0",
        "cofins_amount": "0",
        "inss_amount": "0",
        "ir_amount": "0",
        "csll_amount": "0",
        "discount_conditioning_amount": "0",
        "service_item_code": "0105",
        "cnae_code": null,
        "description": "Servicos de informatica",
        "city_code": 3304557,
        "nfse_liquid_amount": "109.9",
        "city_tax_code": "010501",
        "other_retentions_amount": "0.00",
        "retained_iss_amount": "0.00",
        "unconditioned_discount_amount": "0.00"
    },
    "substitute_rps": null,
    "errors": [],
    "id": 1,
    "emitter_id": 1,
    "status": "processing",
    "description": "Aguardando processamento pela Sefaz",
    "nfse_key": null,
    "nfse_number": null,
    "nfse_xml": null,
    "number": 370851823,
    "serie": "a",
    "rps_type": 1,
    "emission_date": "2014-03-18T08:34:56Z",
    "operation_nature": 1,
    "rps_situation": 1,
    "other_informations": null,
    "competence": null,
    "special_regime": null,
    "is_complete": true
}

Utilizando modelo de Valores e Serviços

Se você já possui um modelo de valores e serviços, pode-se utilizando facilmente no cadastro de uma nova NFSe. Caso o modelo esteja completo, ou seja, todos os campos necessários para a emissão da NFSe estão preenchidos, basta passar o ´id´ do modelo dentro do objeto ´service_values´, como o exemplo abaixo:

POST /api/v1/nfse

Corpo da requisição:

{
    "emitter_id": 1,
    "taker_id": 1,
    "rps_type": 1,
    "serie": "a",
    "emission_date": "2014-03-18T08:34:56Z",
    "operation_nature": 1,
    "rps_situation": 1,
    "service_values": {
        "id": 1
    }
}

Caso o modelo não esteja completo, você deve passar os campos que faltam junto ao ´id´ do modelo, como o examplo abaixo:

{
    "emitter_id": 1,
    "taker_id": 1,
    "rps_type": 1,
    "serie": "a",
    "emission_date": "2014-03-18T08:34:56Z",
    "operation_nature": 1,
    "rps_situation": 1,
    "service_values": {
        "id": 1,
        "service_amount": 99.90,
        "iss_percentage": 5.00
    }
}

Cabeçalho da resposta:

Status Code: 202
Location: https://sandbox.emites.com.br/api/v1/nfse/1
Date: Tue, 04 Feb 2014 17:55:19 GMT
Vary: Accept, Cookie
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json

Corpo de exemplo da resposta:

{
    "_links": [{
        "href": "https://app.emites.com.br/api/v1/nfse/1",
        "method": "GET",
        "rel": "self"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1",
        "method": "DELETE",
        "rel": "destroy"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/status",
        "method": "GET",
        "rel": "status"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/cancel",
        "method": "POST",
        "rel": "cancel"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/xml",
        "method": "GET",
        "rel": "xml"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/pdf",
        "method": "GET",
        "rel": "pdf"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/history",
        "method": "GET",
        "rel": "history"
    }, {
        "href": "https://app.emites.com.br/nfse/show/1"
        "method": "GET"
        "rel": "html"
    }],
    "taker": {
        "address": {
            "id": 1,
            "street": "Feijó Junior",
            "number": "535",
            "complement": "Sala 102",
            "neighborhood": "Sao Pelegrino",
            "city_code": 4305108,
            "state": "RS",
            "zip_code": 95110550,
            "street_type": "RUA",
            "neighborhood_type": "COM",
            "city": "Caxias do Sul",
            "reference_point": null,
            "country": "Brasil",
            "country_code": "01058",
            "country_abbreviation": "BR"
        },
        "contact": {
            "id": 1,
            "ddd": 54,
            "phone": "32272144",
            "email": null,
            "ddd_comercial_phone": null,
            "comercial_phone": null,
            "ddd_fax": null,
            "fax_phone": null
        },
        "id": 1,
        "cpf": 44423739577,
        "cnpj": null,
        "city_inscription": 92708711,
        "social_reason": "Razão Social do Tomador",
        "fancy_name": null,
        "state_inscription": null,
        "substitute_state_inscription": null,
        "special_situation": 0,
        "foreign_taker": false
    },
    "xml": null,
    "service_values": {
        "id": 1,
        "service_amount": "99.90",
        "deduction_amount": "0",
        "retained_iss": false,
        "calculation_base": "99.90",
        "iss_percentage": "5.00",
        "iss_amount": "4.99",
        "pis_amount": "0",
        "cofins_amount": "0",
        "inss_amount": "0",
        "ir_amount": "0",
        "csll_amount": "0",
        "discount_conditioning_amount": "0",
        "service_item_code": "0105",
        "cnae_code": null,
        "description": "Servicos de informatica",
        "city_code": 3304557,
        "nfse_liquid_amount": "109.9",
        "city_tax_code": "010501",
        "other_retentions_amount": "0.00",
        "retained_iss_amount": "0.00",
        "unconditioned_discount_amount": "0.00"
    },
    "substitute_rps": null,
    "errors": [],
    "id": 1,
    "emitter_id": 1,
    "status": "processing",
    "description": "Aguardando processamento pela Sefaz",
    "nfse_key": null,
    "nfse_number": null,
    "nfse_xml": null,
    "number": 370851823,
    "serie": "a",
    "rps_type": 1,
    "emission_date": "2014-03-18T08:34:56Z",
    "operation_nature": 1,
    "rps_situation": 1,
    "other_informations": null,
    "competence": null,
    "special_regime": null,
    "is_complete": true
}

Enviando uma NFSe sem tomador

Você pode enviar uma NFSe sem os dados do tomador, apenas omitindo a chave taker, conforme o exemplo abaixo:

POST /api/v1/nfse

Corpo da requisição:

{
    "emitter_id": 1,
    "rps_type": 1,
    "serie": "a",
    "emission_date": "2014-03-18T08:34:56Z",
    "operation_nature": 1,
    "rps_situation": 1,
    "service_values": {
        "service_amount": 99.9,
        "deduction_amount": 0,
        "retained_iss": 0,
        "calculation_base": 99.9,
        "iss_percentage": 5.00,
        "iss_amount": 4.99,
        "pis_amount": 0,
        "cofins_amount": 0,
        "inss_amount": 0,
        "ir_amount": 0,
        "csll_amount": 0,
        "discount_conditioning_amount": 0,
        "service_item_code": "0105",
        "city_tax_code": "010501",
        "description": "Servicos de informatica",
        "city_code": 3304557,
        "nfse_liquid_amount": 109.9
    }
}

Cabeçalho da resposta:

Status Code: 202
Location: https://sandbox.emites.com.br/api/v1/nfse/1
Date: Tue, 04 Feb 2014 17:55:19 GMT
Vary: Accept, Cookie
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json

Corpo de exemplo da resposta:

{
    "_links": [{
        "href": "https://app.emites.com.br/api/v1/nfse/1",
        "method": "GET",
        "rel": "self"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1",
        "method": "DELETE",
        "rel": "destroy"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/status",
        "method": "GET",
        "rel": "status"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/cancel",
        "method": "POST",
        "rel": "cancel"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/xml",
        "method": "GET",
        "rel": "xml"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/pdf",
        "method": "GET",
        "rel": "pdf"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/history",
        "method": "GET",
            "rel": "history"
    }, {
        "href": "https://app.emites.com.br/nfse/show/1"
        "method": "GET"
        "rel": "html"
    }],
    "taker": null,
    "xml": null,
    "service_values": {
        "id": 1,
        "service_amount": "99.90",
        "deduction_amount": "0",
        "retained_iss": false,
        "calculation_base": "99.90",
        "iss_percentage": "5.00",
        "iss_amount": "4.99",
        "pis_amount": "0",
        "cofins_amount": "0",
        "inss_amount": "0",
        "ir_amount": "0",
        "csll_amount": "0",
        "discount_conditioning_amount": "0",
        "service_item_code": "0105",
        "cnae_code": null,
        "description": "Servicos de informatica",
        "city_code": 3304557,
        "nfse_liquid_amount": "109.9",
        "city_tax_code": "010501",
        "other_retentions_amount": "0.00",
        "retained_iss_amount": "0.00",
        "unconditioned_discount_amount": "0.00"
    },
    "substitute_rps": null,
    "errors": [],
    "id": 1,
    "emitter_id": 1,
    "status": "processing",
    "description": "Aguardando processamento pela Sefaz",
    "nfse_key": null,
    "nfse_number": null,
    "nfse_xml": null,
    "number": 370851823,
    "serie": "a",
    "rps_type": 1,
    "emission_date": "2014-03-18T08:34:56Z",
    "operation_nature": 1,
    "rps_situation": 1,
    "other_informations": null,
    "competence": null,
    "special_regime": null,
    "is_complete": true
}

Criar uma NFSe associada a um lote existente

Quando um lote for previamente criado, você pode associa-lo a uma NFSe adicionado o campo ‘batch_id’ com o ID do lote no corpo da requisição, como o exemplo abaixo:

{
    "batch_id": 1,
    "emitter_id": 1,
    "rps_type": 1,
    "serie": "a",
    "emission_date": "2014-03-18T08:34:56Z",
    "operation_nature": 1,
    "rps_situation": 1,
    "service_values": {
        "service_amount": 99.9,
        "deduction_amount": 0,
        "retained_iss": 0,
        "calculation_base": 99.9,
        "iss_percentage": 5.00,
        "iss_amount": 4.99,
        "pis_amount": 0,
        "cofins_amount": 0,
        "inss_amount": 0,
        "ir_amount": 0,
        "csll_amount": 0,
        "discount_conditioning_amount": 0,
        "service_item_code": "0105",
        "city_tax_code": "010501",
        "description": "Servicos de informatica",
        "city_code": 3304557,
        "nfse_liquid_amount": 109.9
    },
    "taker": {
        "cpf": "44423739577",
        "city_inscription": "92708711",
        "social_reason": "Razão Social do Tomador",
        "address": {
            "street": "Feijó Júnior",
            "number": "535",
            "neighborhood": "São Pelegrino",
            "neighborhood_type": "COM",
            "city_code": 4305108,
            "state": "RS",
            "zip_code": 95110550,
            "city": "Caxias do Sul"
        },
        "contact": {
            "phone": "32272144",
            "ddd": 54
        }
    }
}

Criar uma NFSe associada a um novo lote

Para criar um lote associado com uma nova NFSe, você deve passar o nome do lote no campo ‘batch_name’, como o exemplo abaixo. Caso já exista um lote com esse nome e o mesmo não tenha sido processado, ou seja o status é igual a ´created´, a nova NFSe será associado ao lote existente.

{
    "batch_name": "batch-name",
    "emitter_id": 1,
    "rps_type": 1,
    "serie": "a",
    "emission_date": "2014-03-18T08:34:56Z",
    "operation_nature": 1,
    "rps_situation": 1,
    "service_values": {
        "service_amount": 99.9,
        "deduction_amount": 0,
        "retained_iss": 0,
        "calculation_base": 99.9,
        "iss_percentage": 5.00,
        "iss_amount": 4.99,
        "pis_amount": 0,
        "cofins_amount": 0,
        "inss_amount": 0,
        "ir_amount": 0,
        "csll_amount": 0,
        "discount_conditioning_amount": 0,
        "service_item_code": "0105",
        "city_tax_code": "010501",
        "description": "Servicos de informatica",
        "city_code": 3304557,
        "nfse_liquid_amount": 109.9
    },
    "taker": {
        "cpf": "44423739577",
        "city_inscription": "92708711",
        "social_reason": "Razão Social do Tomador",
        "address": {
            "street": "Feijó Júnior",
            "number": "535",
            "neighborhood": "São Pelegrino",
            "neighborhood_type": "COM",
            "city_code": 4305108,
            "state": "RS",
            "zip_code": 95110550,
            "city": "Caxias do Sul"
        },
        "contact": {
            "phone": "32272144",
            "ddd": 54
        }
    }
}

Listagem

Lista todas as notas emitidas, rejeitadas ou canceladas:

GET /api/v1/nfse

Corpo de exemplo da resposta:

{
    "count": 1,
    "next": null,
    "previous": null,
    "collection": [{
        "_links": [{
            "href": "https://app.emites.com.br/api/v1/nfse/1",
            "method": "GET",
            "rel": "self"
        }, {
            "href": "https://app.emites.com.br/api/v1/nfse/1",
            "method": "DELETE",
            "rel": "destroy"
        }, {
            "href": "https://app.emites.com.br/api/v1/nfse/1/status",
            "method": "GET",
            "rel": "status"
        }, {
            "href": "https://app.emites.com.br/api/v1/nfse/1/cancel",
            "method": "POST",
            "rel": "cancel"
        }, {
            "href": "https://app.emites.com.br/api/v1/nfse/1/xml",
            "method": "GET",
            "rel": "xml"
        }, {
            "href": "https://app.emites.com.br/api/v1/nfse/1/pdf",
            "method": "GET",
            "rel": "pdf"
        }, {
            "href": "https://app.emites.com.br/api/v1/nfse/1/history",
            "method": "GET",
            "rel": "history"
        }, {
            "href": "https://app.emites.com.br/nfse/show/1"
            "method": "GET"
            "rel": "html"
        }],
        "taker": {
            "address": {
                "id": 1,
                "street": "Rua Feijo Junior",
                "number": "535",
                "complement": "Sala 102",
                "neighborhood": "Sao Pelegrino",
                "city_code": 4305108,
                "state": "RJ",
                "zip_code": 95034160,
                "street_type": "RUA",
                "neighborhood_type": "COM",
                "city": "Rio de Janeiro",
                "reference_point": null,
                "country": "Brasil",
                "country_code": "1058",
                "country_abbreviation": "BR"
            },
            "contact": {
                "id": 1,
                "phone": "32215850",
                "email": "vital@vitalconsultoria.com.br",
                "ddd": 54,
                "ddd_comercial_phone": null,
                "comercial_phone": null,
                "ddd_fax": null,
                "fax_phone": null
            },
            "id": 1,
            "cpf": null,
            "cnpj": "06276574000173",
            "city_inscription": null,
            "social_reason": "VITAL Consultoria e Assessoria em Gestão Empresarial LTDA",
            "fancy_name": "Vital",
            "state_inscription": "ISENTO",
            "substitute_state_inscription": null,
            "special_situation": 0,
            "foreign_taker": false
        },
        "xml": null,
        "service_values": {
            "id": 1,
            "service_amount": "99.90",
            "deduction_amount": "0.00",
            "retained_iss": false,
            "calculation_base": "99.90",
            "iss_percentage": "5.00",
            "iss_amount": "4.99",
            "pis_amount": "0.00",
            "cofins_amount": "0.00",
            "inss_amount": "0.00",
            "ir_amount": "0.00",
            "csll_amount": "0.00",
            "discount_conditioning_amount": "0.00",
            "service_item_code": "0105",
            "cnae_code": null,
            "description": "Servicos de informatica",
            "city_code": 3304557,
            "nfse_liquid_amount": "109.90",
            "city_tax_code": "010501",
            "other_retentions_amount": "0.00",
            "retained_iss_amount": "0.00",
            "unconditioned_discount_amount": "0.00"
        },
        "substitute_rps": null,
        "errors": [],
        "id": 1,
        "emitter_id": 1,
        "status": "processing",
        "description": "Aguardando processamento pela Sefaz",
        "nfse_key": null,
        "nfse_number": null,
        "nfse_xml": "",
        "number": 370851823,
        "serie": "a",
        "rps_type": 1,
        "emission_date": "2014-03-18T08:34:56Z",
        "operation_nature": 1,
        "rps_situation": 1,
        "other_informations": null,
        "competence": null,
        "special_regime": null,
        "is_complete": true
    }]
}

Filtros

Para filtrar uma listagem de NFSes:

GET /api/v1/nfse?status=processed
Parâmetro Exemplo
status /api/v1/nfse?status=created
emitter_id /api/v1/nfse?emitter_id=1
nfse_key /api/v1/nfse?nfse_key=12345
emission_date_lte* /api/v1/nfse?emission_date_lte=2014-05-20
emission_date_gte** /api/v1/nfse?emission_date_gte=2014-05-10
number /api/v1/nfse?number=123
nfse_number /api/v1/nfse?nfse_number=123
amount_lte* /api/v1/nfse?amount_lte=99.90
amount_gte** /api/v1/nfse?amount_gte=99.90
taker_social_reason /api/v1/nfse?taker_social_reason=Razao+Social
taker_cpf /api/v1/nfse?taker_cpf=12345678900
taker_cnpj /api/v1/nfse?taker_cnpj=12345678901234
is_complete /api/v1/nfse?is_complete=False
serie /api/v1/nfse?serie=teste

*Registros menor igual.

**Registros maior ou igual.

Você pode agrupar filtros, como no exemplo abaixo:

GET /api/v1/nfse?emission_date_gte=2014-05-10&emission_date_lte=2014-05-20&status=created

Todos os parâmetros devem ser URL Enconded

Cabeçalho de exemplo da resposta:

Status Code: 200
Date: Tue, 20 May 2014 12:43:23 GMT
Vary: Accept, Cookie
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
{
    "count": 1,
    "next": null,
    "previous": null,
    "collection": [{
        "_links": [{
            "href": "https://app.emites.com.br/api/v1/nfse/1",
            "method": "GET",
            "rel": "self"
        }, {
            "href": "https://app.emites.com.br/api/v1/nfse/1",
            "method": "DELETE",
            "rel": "destroy"
        }, {
            "href": "https://app.emites.com.br/api/v1/nfse/1/status",
            "method": "GET",
            "rel": "status"
        }, {
            "href": "https://app.emites.com.br/api/v1/nfse/1/cancel",
            "method": "POST",
            "rel": "cancel"
        }, {
            "href": "https://app.emites.com.br/api/v1/nfse/1/xml",
            "method": "GET",
            "rel": "xml"
        }, {
            "href": "https://app.emites.com.br/api/v1/nfse/1/pdf",
            "method": "GET",
            "rel": "pdf"
        }, {
            "href": "https://app.emites.com.br/api/v1/nfse/1/history",
            "method": "GET",
            "rel": "history"
        }, {
            "href": "https://app.emites.com.br/nfse/show/1"
            "method": "GET"
            "rel": "html"
        }],
        "taker": {
            "address": {
                "id": 1,
                "street": "Rua Feijo Junior",
                "number": "535",
                "complement": "Sala 102",
                "neighborhood": "Sao Pelegrino",
                "city_code": 4305108,
                "state": "RJ",
                "zip_code": 95034160,
                "street_type": "RUA",
                "neighborhood_type": "COM",
                "city": "Rio de Janeiro",
                "reference_point": null,
                "country": "Brasil",
                "country_code": "1058",
                "country_abbreviation": "BR"
            },
            "contact": {
                "id": 1,
                "phone": "32215850",
                "email": "vital@vitalconsultoria.com.br",
                "ddd": 54,
                "ddd_comercial_phone": null,
                "comercial_phone": null,
                "ddd_fax": null,
                "fax_phone": null
            },
            "id": 1,
            "cpf": null,
            "cnpj": "06276574000173",
            "city_inscription": null,
            "social_reason": "VITAL Consultoria e Assessoria em Gestão Empresarial LTDA",
            "fancy_name": "Vital",
            "state_inscription": "ISENTO",
            "substitute_state_inscription": null,
            "special_situation": 0,
            "foreign_taker": false
        },
        "xml": null,
        "service_values": {
            "id": 1,
            "service_amount": "99.90",
            "deduction_amount": "0.00",
            "retained_iss": false,
            "calculation_base": "99.90",
            "iss_percentage": "5.00",
            "iss_amount": "4.99",
            "pis_amount": "0.00",
            "cofins_amount": "0.00",
            "inss_amount": "0.00",
            "ir_amount": "0.00",
            "csll_amount": "0.00",
            "discount_conditioning_amount": "0.00",
            "service_item_code": "0105",
            "cnae_code": null,
            "description": "Servicos de informatica",
            "city_code": 3304557,
            "nfse_liquid_amount": "109.90",
            "city_tax_code": "010501",
            "other_retentions_amount": "0.00",
            "retained_iss_amount": "0.00",
            "unconditioned_discount_amount": "0.00"
        },
        "substitute_rps": null,
        "errors": [],
        "id": 1,
        "emitter_id": 1,
        "status": "processed",
        "description": "Aguardando processamento pela Sefaz",
        "nfse_key": null,
        "nfse_number": null,
        "nfse_xml": "",
        "number": 370851823,
        "serie": "a",
        "rps_type": 1,
        "emission_date": "2014-03-18T08:34:56Z",
        "operation_nature": 1,
        "rps_situation": 1,
        "other_informations": null,
        "competence": null,
        "special_regime": null,
        "is_complete": true
    }]
}

Detalhes

Para acessar os detalhes de uma NFSe:

GET /api/v1/nfse/1

Cabeçalho da resposta:

Status Code: 200
Date: Tue, 04 Feb 2014 18:23:21 GMT
Allow: GET, HEAD, OPTIONS
Vary: Accept-Encoding, Accept, Cookie
Content-Type: application/json

Corpo de exemplo da resposta:

{
    "_links": [{
        "href": "https://app.emites.com.br/api/v1/nfse/1",
        "method": "GET",
        "rel": "self"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1",
        "method": "DELETE",
        "rel": "destroy"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/status",
        "method": "GET",
        "rel": "status"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/cancel",
        "method": "POST",
        "rel": "cancel"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/xml",
        "method": "GET",
        "rel": "xml"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/pdf",
        "method": "GET",
        "rel": "pdf"
    }, {
        "href": "https://app.emites.com.br/api/v1/nfse/1/history",
        "method": "GET",
        "rel": "history"
    }, {
        "href": "https://app.emites.com.br/nfse/show/1"
        "method": "GET"
        "rel": "html"
    }],
    "taker": {
        "address": {
            "id": 1,
            "street": "Rua Feijo Junior",
            "number": "535",
            "complement": "Sala 102",
            "neighborhood": "Sao Pelegrino",
            "city_code": 4305108,
            "state": "RJ",
            "zip_code": 95034160,
            "street_type": "RUA",
            "neighborhood_type": "COM",
            "city": "Rio de Janeiro",
            "reference_point": null,
            "country": "Brasil",
            "country_code": "1058",
            "country_abbreviation": "BR"
        },
        "contact": {
            "id": 1,
            "phone": "32215850",
            "email": "vital@vitalconsultoria.com.br",
            "ddd": 54,
            "ddd_comercial_phone": null,
            "comercial_phone": null,
            "ddd_fax": null,
            "fax_phone": null
        },
        "id": 1,
        "cpf": null,
        "cnpj": "06276574000173",
        "city_inscription": null,
        "social_reason": "VITAL Consultoria e Assessoria em Gestão Empresarial LTDA",
        "fancy_name": "Vital",
        "state_inscription": "ISENTO",
        "substitute_state_inscription": null,
        "special_situation": 0,
        "foreign_taker": false
    },
    "xml": null,
    "service_values": {
        "id": 1,
        "service_amount": "99.90",
        "deduction_amount": "0.00",
        "retained_iss": false,
        "calculation_base": "99.90",
        "iss_percentage": "5.00",
        "iss_amount": "4.99",
        "pis_amount": "0.00",
        "cofins_amount": "0.00",
        "inss_amount": "0.00",
        "ir_amount": "0.00",
        "csll_amount": "0.00",
        "discount_conditioning_amount": "0.00",
        "service_item_code": "0105",
        "cnae_code": null,
        "description": "Servicos de informatica",
        "city_code": 3304557,
        "nfse_liquid_amount": "109.90",
        "city_tax_code": "010501",
        "other_retentions_amount": "0.00",
        "retained_iss_amount": "0.00",
        "unconditioned_discount_amount": "0.00"
    },
    "substitute_rps": null,
    "errors": [],
    "id": 1,
    "emitter_id": 1,
    "status": "processing",
    "description": "Aguardando processamento pela Sefaz",
    "nfse_key": null,
    "nfse_number": null,
    "nfse_xml": "",
    "number": 370851823,
    "serie": "a",
    "rps_type": 1,
    "emission_date": "2014-03-18T08:34:56Z",
    "operation_nature": 1,
    "rps_situation": 1,
    "other_informations": null,
    "competence": null,
    "special_regime": null,
    "is_complete": true
}

Atualização parcial e completa

Quando a NFSe está incompleta, você pode atualizar ela, caso ela já esteja completa ela será emitida automáticamente:

Para atualizar uma NFSe:

PATCH /api/v1/nfse/1

Ou:

PUT /api/v1/nfse/1
{
    "batch_name": "batch-name",
    "emitter_id": 1,
    "rps_type": 1,
    "serie": "a",
    "emission_date": "2014-03-18T08:34:56Z",
    "operation_nature": 1,
    "rps_situation": 1,
    "service_values": {
        "service_amount": 99.9,
        "deduction_amount": 0,
        "retained_iss": 0,
        "calculation_base": 99.9,
        "iss_percentage": 5.00,
        "iss_amount": 4.99,
        "pis_amount": 0,
        "cofins_amount": 0,
        "inss_amount": 0,
        "ir_amount": 0,
        "csll_amount": 0,
        "discount_conditioning_amount": 0,
        "service_item_code": "0105",
        "city_tax_code": "010501",
        "description": "Servicos de informatica",
        "city_code": 3304557,
        "nfse_liquid_amount": 109.9
    },
    "taker": {
        "cpf": "44423739577",
        "city_inscription": "92708711",
        "social_reason": "Razão Social do Tomador",
        "address": {
            "street": "Feijó Júnior",
            "number": "535",
            "neighborhood": "São Pelegrino",
            "neighborhood_type": "COM",
            "city_code": 4305108,
            "state": "RS",
            "zip_code": 95110550,
            "city": "Caxias do Sul"
        },
        "contact": {
            "phone": "32272144",
            "ddd": 54
        }
    }
}

Cabeçalho da resposta:

Status Code: 200
Date: Tue, 04 Feb 2014 18:23:21 GMT
Allow: GET, HEAD, OPTIONS
Vary: Accept-Encoding, Accept, Cookie
Content-Type: application/json

Corpo de exemplo da resposta:

{
    "_links": [{
        "href": "https://app.emites.com.br/api/v2/nfse/1",
        "method": "GET",
        "rel": "self"
    }, {
        "href": "https://app.emites.com.br/api/v2/nfse/1",
        "method": "DELETE",
        "rel": "destroy"
    }, {
        "href": "https://app.emites.com.br/api/v2/nfse/1/status",
        "method": "GET",
        "rel": "status"
    }, {
        "href": "https://app.emites.com.br/api/v2/nfse/1/cancel",
        "method": "POST",
        "rel": "cancel"
    }, {
        "href": "https://app.emites.com.br/api/v2/nfse/1/mirror",
        "method": "GET",
        "rel": "mirror"
    }, {
        "href": "https://app.emites.com.br/api/v2/nfse/1/xml",
        "method": "GET",
        "rel": "xml"
    }, {
        "href": "https://app.emites.com.br/api/v2/nfse/1/pdf",
        "method": "GET",
        "rel": "pdf"
    }, {
        "href": "https://app.emites.com.br/api/v2/nfse/1/history",
        "method": "GET",
        "rel": "history"
    }, {
        "href": "https://app.emites.com.br/nfse/show/1"
        "method": "GET"
        "rel": "html"
    }],
    "taker": {
        "address": {
            "id": 1,
            "street": "Rua Feijo Junior",
            "number": "535",
            "complement": "Sala 102",
            "neighborhood": "Sao Pelegrino",
            "city_code": 4305108,
            "state": "RJ",
            "zip_code": 95034160,
            "street_type": "RUA",
            "neighborhood_type": "COM",
            "city": "Rio de Janeiro",
            "reference_point": null,
            "country": "Brasil",
            "country_code": "1058",
            "country_abbreviation": "BR"
        },
        "contact": {
            "id": 1,
            "phone": "32215850",
            "email": "vital@vitalconsultoria.com.br",
            "ddd": 54,
            "ddd_comercial_phone": null,
            "comercial_phone": null,
            "ddd_fax": null,
            "fax_phone": null
        },
        "id": 1,
        "cpf": null,
        "cnpj": "06276574000173",
        "city_inscription": null,
        "social_reason": "VITAL Consultoria e Assessoria em Gestão Empresarial LTDA",
        "fancy_name": "Vital",
        "state_inscription": "ISENTO",
        "substitute_state_inscription": null,
        "special_situation": 0,
        "foreign_taker": false
    },
    "mirror": null,
    "xml": null,
    "service_values": {
        "id": 1,
        "service_amount": "99.90",
        "deduction_amount": "0.00",
        "retained_iss": false,
        "calculation_base": "99.90",
        "iss_percentage": "5.00",
        "iss_amount": "4.99",
        "pis_amount": "0.00",
        "cofins_amount": "0.00",
        "inss_amount": "0.00",
        "ir_amount": "0.00",
        "csll_amount": "0.00",
        "discount_conditioning_amount": "0.00",
        "service_item_code": "0105",
        "cnae_code": null,
        "description": "Servicos de informatica",
        "city_code": 3304557,
        "nfse_liquid_amount": "109.90",
        "city_tax_code": "010501",
        "other_retentions_amount": "0.00",
        "retained_iss_amount": "0.00",
        "unconditioned_discount_amount": "0.00"
    },
    "substitute_rps": null,
    "errors": [],
    "id": 1,
    "emitter_id": 1,
    "status": "processing",
    "description": "Aguardando processamento pela Sefaz",
    "nfse_key": null,
    "nfse_number": null,
    "nfse_mirror": "",
    "nfse_xml": "",
    "number": 370851823,
    "serie": "a",
    "rps_type": 1,
    "emission_date": "2014-03-18T08:34:56Z",
    "operation_nature": 1,
    "rps_situation": 1,
    "other_informations": null,
    "competence": null,
    "special_regime": null,
    "is_complete": true
}

Remoção

O Emites permite a remoção de NFSe desde que o documento ainda não tenha sido processado. É o caso por exemplo de quando uma NFSe é criada e associada a um lote, ou quando a NFSe foi cadastrada parcialmente. Nesse exemplo, a nota fica com o status ´created´ e pode ser removida.

Para remover um NFSe:

DELETE /api/v1/nfse/1

Cabeçalho da resposta:

Status Code: 204
Date: Tue, 04 Feb 2014 18:25:25 GMT
Content-Type: application/json

Na remoção da NFSe o corpo da resposta retorna vázio.

Status

Uma NFSe pode ter qualquer um dos status abaixo durante o processo de emissão/cancelamento:

Status Descrição
created NFSe criada
scheduled Agendado o processamento da NFSe
processing Processando NFSe junto a Sefaz
accepted Processado pela Sefaz
rejected Rejeitado pela Sefaz
cancelling Cancelando junto a Sefaz
cancelled Cancelado pela Sefaz

Confira o diagrama de mudança de status abaixo:

../_images/status.png

Para consultar o status de uma NFSe:

GET /api/v1/nfse/1/status

Cabeçalho da resposta:

Status Code: 200
Date: Tue, 04 Feb 2014 18:25:25 GMT
Content-Type: application/json

Corpo de exemplo da resposta:

{
    "id": 1,
    "status": "processing",
    "description": "Aguardando processamento pela Sefaz",
    "nfse_key": null,
    "nfse_number": null,
    "number": 370851823,
    "xml": null,
    "errors": []
}

Cancelamento

Para cancelar uma NFSe:

POST /api/v1/nfse/1/cancel

Cabeçalho da resposta:

Status Code: 202
Date: Tue, 04 Feb 2014 18:25:25 GMT
Content-Type: application/json

Corpo de exemplo da resposta:

{
    "id": 1,
    "status": "cancelling",
    "description": "Cancelamento aguardando pela Sefaz",
    "nfse_key": null,
    "nfse_number": null,
    "number": 370851823,
    "xml": null,
    "errors": []
}

Histórico

O histórico é o registro de toda e qualquer interação feita através da API de NFSe. No registro é salvo os dados do usuário que realizou a ação bem como os seus dados.

Para consultar o histórico de interações de todas as NFSe de uma conta:

GET /api/v1/nfse/history

Cabeçalho da resposta:

Status Code: 200
Date: Tue, 25 Mar 2014 17:27:30 GMT
Content-Type: application/json

Corpo de exemplo da resposta:

{
    "count": 2,
    "next": null,
    "previous": null,
    "collection": [{
        "rps": {
            "id": 6,
            "number": 1950875687
        },
        "emitter": {
            "id": 3,
            "social_reason": "Myfinance Consultoria e Informática Ltda"
        },
        "account": {
            "id": 1,
            "name": "Pull4up-NFSE"
        },
        "id": 5,
        "token_description": "Token inicial",
        "from_status": "scheduled",
        "to_status": "processing",
        "date": "2014-03-25T17:07:08Z"
    }, {
        "rps": {
            "id": 6,
            "number": 1950875687
        },
        "emitter": {
            "id": 3,
            "social_reason": "Myfinance Consultoria e Informática Ltda"
        },
        "account": {
            "id": 1,
            "name": "Pull4up-NFSE"
        },
        "id": 4,
        "token_description": "Token inicial",
        "from_status": "created",
        "to_status": "scheduled",
        "date": "2014-03-25T16:59:51Z"
    }]
}

Para consultar o histórico de interações de uma NFSe:

GET /api/v1/nfse/1/history

Cabeçalho da resposta:

Status Code: 200
Date: Tue, 25 Mar 2014 17:27:30 GMT
Content-Type: application/json

Corpo de exemplo da resposta:

{
    "count": 2,
    "next": null,
    "previous": null,
    "collection": [{
        "rps": {
            "id": 1,
            "number": 1493875102
        },
        "emitter": {
            "id": 1,
            "social_reason": "Foo Bar"
        },
        "account": {
            "id": 1,
            "name": "Pull4up-NFSE"
        },
        "id": 1,
        "token_description": "Token inicial",
        "from_status": "scheduled",
        "to_status": "processing",
        "date": "2014-04-01T12:49:40Z"
        }, {
        "rps": {
            "id": 2,
            "number": 1493875102
        },
        "emitter": {
            "id": 1, "social_reason": "Foo Bar"
        },
        "account": {
            "id": 1,
            "name": "Pull4up-NFSE"
        },
        "id": 2,
        "token_description": "Token inicial",
        "from_status": "created",
        "to_status": "scheduled",
        "date": "2014-04-01T12:44:58Z"
    }]
}

XML

Para consultar a url do xml da NFSe:

GET /api/v1/nfse/1/xml

Não possui retorno no corpo do json, apenas uma url de redirect para o xml.

PDF

Para consultar a url do pdf da NFSe:

GET /api/v1/nfse/1/pdf

Não possui retorno no corpo do json, apenas uma url de redirect para o pdf.

*As URLs disponibilizadas são válidas por apenas 15 minutos, sendo assim não armazene o retorno e sempre que for necessário realize um novo GET.