Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
ServiceInvoice

Emissão de Nota Fiscal de Serviço.

post/nfse

Request body

requestIdstring required

Identificador único da requisição.

companyIdstring required

Identificador único da empresa.

rpsSerialstring nullable

Série RPS de Documento Fiscal.

rpsNumberinteger nullable

Número RPS de Documento Fiscal.

operationType'TRIBUTACAO_MUNICIPIO' | 'TRIBUTACAO_FORA_MUNICIPIO' | 'ISENTO' | 'IMUNE' | 'EXIGIBILIDADE_SUSPENSA_DECISAO_JUDICIAL' | 'EXIGIBILIDADE_SUSPENSA_PROC_ADM' required

Tipo de Operação.<p>Values:</p><ul><li><i>TRIBUTACAO_MUNICIPIO</i> - Tributação no Município.</li><li><i>TRIBUTACAO_FORA_MUNICIPIO</i> - Tributação fora do Município.</li><li><i>ISENTO</i> - Isenção.</li><li><i>IMUNE</i> - Imune.</li><li><i>EXIGIBILIDADE_SUSPENSA_DECISAO_JUDICIAL</i> - Exigibilidade Suspensa por Decisão Judicial.</li><li><i>EXIGIBILIDADE_SUSPENSA_PROC_ADM</i> - Exigibilidade Suspensa por Procedimento Administrativo.</li></ul>

competenceDatestring required

Data da competência.

Example request

{
  "requestId": "9b37e3f9-c59e-4b47-a93e-41f66e89df88",
  "companyId": "6514d4db5f9a3c2e8b1d7f5a",
  "rpsSerial": "1",
  "rpsNumber": 1,
  "operationType": "TRIBUTACAO_MUNICIPIO",
  "client": {
    "documentType": "CNPJ",
    "document": "51236721000136",
    "name": "Lucas",
    "cityRegistration": "111111111111",
    "stateRegistration": "2222222222",
    "email": "lucas@example.com",
    "phone": "119999999999",
    "address": {
      "street": "Rua Sem",
      "number": "123",
      "neighborhood": "Jardim Sem",
      "cityCode": "1200013",
      "city": "Acrelandia",
      "state": "AC",
      "country": "BR",
      "complement": "Perto do parque",
      "zipCode": "000000000"
    }
  },
  "service": {
    "cnae": "1111111111",
    "code": "8.01",
    "cityTaxCode": "IPTU",
    "cityTaxDescription": "Tarifado",
    "description": "Manutenção de computadores",
    "values": {
      "value": 1000
    },
    "address": {
      "street": "Rua Sem",
      "number": "123",
      "neighborhood": "Jardim Sem",
      "cityCode": "1200013",
      "city": "Acrelandia",
      "state": "AC",
      "complement": "Perto do parque",
      "zipCode": "000000000"
    }
  },
  "competenceDate": "2024-12-25"
}

Response

OK

serviceInvoiceIdstring

Identificador da Nota de Serviço.

requestIdstring nullable

Identificador de Requisição.

rpsSerialstring nullable

Série RPS de Documento Fiscal.

rpsNumberinteger

Número RPS de Documento Fiscal.

operationType'TRIBUTACAO_MUNICIPIO' | 'TRIBUTACAO_FORA_MUNICIPIO' | 'ISENTO' | 'IMUNE' | 'EXIGIBILIDADE_SUSPENSA_DECISAO_JUDICIAL' | 'EXIGIBILIDADE_SUSPENSA_PROC_ADM'

Tipo de Operação.<p>Values:</p><ul><li><i>TRIBUTACAO_MUNICIPIO</i> - Tributação no Município.</li><li><i>TRIBUTACAO_FORA_MUNICIPIO</i> - Tributação fora do Município.</li><li><i>ISENTO</i> - Isenção.</li><li><i>IMUNE</i> - Imune.</li><li><i>EXIGIBILIDADE_SUSPENSA_DECISAO_JUDICIAL</i> - Exigibilidade Suspensa por Decisão Judicial.</li><li><i>EXIGIBILIDADE_SUSPENSA_PROC_ADM</i> - Exigibilidade Suspensa por Procedimento Administrativo.</li></ul>

status'PROCESSING' | 'APPROVED' | 'REJECTED' | 'CANCELED'

Tipo de Status.<p>Values:</p><ul><li><i>PROCESSING</i> - Processando.</li><li><i>APPROVED</i> - Aprovado.</li><li><i>REJECTED</i> - Rejeitado.</li><li><i>CANCELED</i> - Cancelado.</li></ul>

linkXmlstring nullable

Link do XML.

linkPdfstring nullable

Link do PDF.

competenceDatestring date-time nullable

Data de Competência.

createdstring date-time

Data de Criação.

Example response

{
  "serviceInvoiceId": "6761cf89b9fcb2eb27f9d6af",
  "requestId": "d2e5b7c1-9a3f-4a6e-8f7b-1c9d3b2f6a4e",
  "rpsSerial": "1",
  "rpsNumber": 1,
  "operationType": "TRIBUTACAO_MUNICIPIO",
  "client": {
    "documentType": "CNPJ",
    "document": "51236721000136",
    "name": "Razão Social",
    "cityRegistration": "12345678912345",
    "stateRegistration": "12345678912345",
    "email": "email@google.com",
    "phone": "11912345678",
    "address": {
      "street": "Logradouro",
      "number": "1",
      "neighborhood": "Bairro",
      "cityCode": "3550308",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "complement": "Casa",
      "zipCode": "08190120"
    }
  },
  "service": {
    "cnae": "62091",
    "code": "1.07",
    "cityTaxCode": "3158",
    "cityTaxDescription": "SUPORTE TÉCNICO, MANUTENÇÃO E OUTROS SERVIÇOS EM TECNOLOGIA DA INFORMAÇÃO",
    "description": "Prestação de Serviço",
    "value": 1000,
    "issRetained": true,
    "issRate": 1,
    "baseValue": 1010,
    "issRetainedValue": 10,
    "netValue": 1000,
    "address": {
      "street": "Logradouro",
      "number": "1",
      "neighborhood": "Bairro",
      "cityCode": "3550308",
      "city": "São Paulo",
      "state": "SP",
      "complement": "Casa",
      "zipCode": "08190120"
    }
  },
  "status": "PROCESSING"
}