GET notas servico - Varejonline/api GitHub Wiki
URLs
GET https://integrador.varejonline.com.br/apps/api/notas-servico
GET https://integrador.varejonline.com.br/apps/api/notas-servico/:id
Parâmetros
- inicio: Entenda a Coleta Paginada
- quantidade: Entenda a Coleta Paginada
- alteradoApos: Entenda a Coleta de Alterações
- desde: Veja o Filtro de Datas
- ate: Veja o Filtro de Datas
- naoEscrituradas: Indica se devem ser retornadas notas não escrituradas na consulta (boolean)
- cfops: Retorna somente as notas que possuem ao menos um dos cfops informados (lista numérica separada por virgula)
Retorno
- id: id da nota (long)
- tipo: tipo da nota (string). Os valores possíveis são: ENTRADA e SAIDA
- modelo: Modelo da nota fiscal.
- numeroNotafiscal: número do documento da nota de serviço (long).
- data: data de emissão da nota (string)
- idTerceiroRemetente: id do terceiro remetente da nota (long)
- idTerceiroDestinatario: id do terceiro destinatário da nota (long)
- idEntidade: id da entidade da nota (long)
- status: status da nota (string). veja os valores de status de documentos fiscais
- valorTotal: valor total da nota (decimal)
- entradas: lista com os ids das entradas associadas à nota emitida.
- saidas: lista com os ids das saídas associadas à nota emitida.
- itens: lista de itens da nota
- idServico: id do servico prestado (long)
- cfop: código CFOP da operação (integer)
- quantidade: quantidade do serviço prestado (decimal)
- valorUnitario: valor unitário do serviço na nota (decimal)
- valorTotal: valor total do item (decimal)
- valorDesconto: valor do desconto do item (decimal)
- nbs: código NBS (Nomenclatura Brasileira de Serviços) do item (string)
- cofins: dados do COFINS aplicado ao item (segue a estrutura comum abaixo)
- pis: dados do PIS aplicado ao item (segue a estrutura comum abaixo)
- iss: dados do ISS aplicado ao item (segue a estrutura comum abaixo)
- ibsCbs: dados da Reforma Tributária (objeto complexo, retornado quando aplicável)
- baseCalculoIbsCbs: base de cálculo do IBS/CBS (decimal)
- percentualReducaoAliquota: percentual de redução da alíquota (decimal)
- valorTotalItem: valor total considerado no cálculo (decimal)
- cst: código de situação tributária da reforma (string)
- codigoClassificacaoTributaria: código de classificação tributária (string)
- cbs: dados da CBS
- aliquotaCbs: alíquota CBS (decimal)
- valorCbs: valor CBS (decimal)
- valorDiferimentoCbs: valor diferido CBS (decimal)
- aliquotaDiferimentoCbs: alíquota de diferimento CBS (decimal)
- aliquotaEfetivaCbs: alíquota efetiva CBS (decimal)
- valorTributadoCbsRegular: valor tributado CBS regular (decimal)
- aliquotaEfetivaCbsRegular: alíquota efetiva CBS regular (decimal)
- valorCbsRegular: valor CBS regular (decimal)
- ibsUf: dados do IBS estadual
- aliquotaIbsUf: alíquota IBS estadual (decimal)
- valorIbsUf: valor IBS estadual (decimal)
- valorTotalIbs: valor total IBS (decimal)
- valorIbsUfRegular: valor IBS estadual regular (decimal)
- valorDiferimentoIbsUf: valor diferido IBS estadual (decimal)
- aliquotaDiferimentoIbsUf: alíquota de diferimento IBS estadual (decimal)
- aliquotaEfetivaIbsUf: alíquota efetiva IBS estadual (decimal)
- aliquotaEfetivaIbsUfRegular: alíquota efetiva IBS estadual regular (decimal)
- ibsMunicipal: dados do IBS municipal
- aliquotaIbsMunicipio: alíquota IBS municipal (decimal)
- valorIbsMunicipio: valor IBS municipal (decimal)
- valorTributadoIbsMunicipioRegular: valor tributado IBS municipal regular (decimal)
- valorDiferimentoIbsMunicipio: valor diferido IBS municipal (decimal)
- aliquotaDiferimentoIbsMunicipio: alíquota de diferimento IBS municipal (decimal)
- aliquotaEfetivaIbsMunicipio: alíquota efetiva IBS municipal (decimal)
- aliquotaEfetivaIbsMunicipioRegular: alíquota efetiva IBS municipal regular (decimal)
- aliquotaEfetivaIbsUfRegular: alíquota efetiva IBS estadual regular no contexto municipal (decimal)
- retencoes: lista de retenções de tributos da nota
- nome: nome do tributo (string)
- valor: valor retido (decimal)
Estrutura comum para tributos:
- base: valor da base de cálculo do tributo (decimal)
- aliquota: valor da alíquota aplicada (decimal)
- valor: valor do tributo (decimal)
- cst: código de situação tributária (string)
Exemplo
GET https://integrador.varejonline.com.br/apps/api/notas-servico
{
"id": 1362,
"data": "19-02-2026",
"status": "EMITIDO",
"valorTotal": 180,
"tipo": "SAIDA",
"itens": [
{
"valorDesconto": 0,
"valorTotal": 20,
"iss": {
"base": 0.00,
"aliquota": 0,
"valor": 0,
"cst": "N"
},
"idServico": 6,
"valorUnitario": 10.0000,
"quantidade": 2,
"cofins": {
"base": 1.52,
"aliquota": 7.6,
"valor": 1.52,
"cst": "01"
},
"cfop": 5933,
"pis": {
"base": 0.33,
"aliquota": 1.65,
"valor": 0.33,
"cst": "01"
}
},
{
"valorDesconto": 0,
"valorTotal": 100,
"iss": {
"base": 0.00,
"aliquota": 0,
"valor": 0,
"cst": "N"
},
"nbs": "1.1405.12.00",
"idServico": 5,
"valorUnitario": 100.0000,
"quantidade": 1,
"cofins": {
"base": 7.60,
"aliquota": 7.6,
"valor": 7.6,
"cst": "01"
},
"cfop": 5933,
"pis": {
"base": 1.65,
"aliquota": 1.65,
"valor": 1.65,
"cst": "01"
},
"impostoReformaTributaria": {
"baseCalculoIbsCbs": 90.75,
"percentualReducaoAliquota": 0,
"cbs": {
"valorDiferimentoCbs": 0,
"aliquotaDiferimentoCbs": 0,
"aliquotaEfetivaCbs": 0,
"valorTributadoCbsRegular": 0,
"aliquotaEfetivaCbsRegular": 0,
"valorCbsRegular": 0,
"aliquotaCbs": 0.9,
"valorCbs": 0.9
},
"valorTotalItem": 0,
"cst": "TRIBUTACAO_INTEGRAL",
"ibsUf": {
"valorDiferimentoIbsUf": 0,
"aliquotaEfetivaIbsUf": 0,
"aliquotaEfetivaIbsUfRegular": 0,
"aliquotaDiferimentoIbsUf": 0,
"valorTotalIbs": 0.1,
"valorIbsUfRegular": 0,
"valorIbsUf": 0.1,
"aliquotaIbsUf": 0.1
},
"ibsMunicipal": {
"valorIbsMunicipio": 0,
"valorDiferimentoIbsMunicipio": 0,
"aliquotaEfetivaIbsUfRegular": 0,
"aliquotaIbsMunicipio": 0,
"aliquotaEfetivaIbsMunicipio": 0,
"valorTributadoIbsMunicipioRegular": 0,
"aliquotaDiferimentoIbsMunicipio": 0,
"aliquotaEfetivaIbsMunicipioRegular": 0
},
"codigoClassificacaoTributaria": "000001"
}
},
{
"valorDesconto": 0,
"valorTotal": 50,
"iss": {
"base": 0.00,
"aliquota": 0,
"valor": 0,
"cst": "N"
},
"nbs": "1.1405.11.00",
"idServico": 1,
"valorUnitario": 50.0000,
"quantidade": 1,
"cofins": {
"base": 3.80,
"aliquota": 7.6,
"valor": 3.8,
"cst": "01"
},
"cfop": 5933,
"pis": {
"base": 0.82,
"aliquota": 1.65,
"valor": 0.82,
"cst": "01"
},
"impostoReformaTributaria": {
"baseCalculoIbsCbs": 45.38,
"percentualReducaoAliquota": 0,
"cbs": {
"valorDiferimentoCbs": 0,
"aliquotaDiferimentoCbs": 0,
"aliquotaEfetivaCbs": 0,
"valorTributadoCbsRegular": 0,
"aliquotaEfetivaCbsRegular": 0,
"valorCbsRegular": 0,
"aliquotaCbs": 0.9,
"valorCbs": 0.45
},
"valorTotalItem": 0,
"cst": "TRIBUTACAO_INTEGRAL",
"ibsUf": {
"valorDiferimentoIbsUf": 0,
"aliquotaEfetivaIbsUf": 0,
"aliquotaEfetivaIbsUfRegular": 0,
"aliquotaDiferimentoIbsUf": 0,
"valorTotalIbs": 0.05,
"valorIbsUfRegular": 0,
"valorIbsUf": 0.05,
"aliquotaIbsUf": 0.1
},
"ibsMunicipal": {
"valorIbsMunicipio": 0,
"valorDiferimentoIbsMunicipio": 0,
"aliquotaEfetivaIbsUfRegular": 0,
"aliquotaIbsMunicipio": 0,
"aliquotaEfetivaIbsMunicipio": 0,
"valorTributadoIbsMunicipioRegular": 0,
"aliquotaDiferimentoIbsMunicipio": 0,
"aliquotaEfetivaIbsMunicipioRegular": 0
},
"codigoClassificacaoTributaria": "000001"
}
},
{
"valorDesconto": 0,
"valorTotal": 10,
"iss": {
"base": 0.00,
"aliquota": 0,
"valor": 0,
"cst": "N"
},
"nbs": "1.1803.29.00",
"idServico": 7,
"valorUnitario": 10.0000,
"quantidade": 1,
"cofins": {
"base": 0.76,
"aliquota": 7.6,
"valor": 0.76,
"cst": "01"
},
"cfop": 5933,
"pis": {
"base": 0.16,
"aliquota": 1.65,
"valor": 0.16,
"cst": "01"
},
"impostoReformaTributaria": {
"baseCalculoIbsCbs": 9.08,
"percentualReducaoAliquota": 0,
"cbs": {
"valorDiferimentoCbs": 0,
"aliquotaDiferimentoCbs": 0,
"aliquotaEfetivaCbs": 0,
"valorTributadoCbsRegular": 0,
"aliquotaEfetivaCbsRegular": 0,
"valorCbsRegular": 0,
"aliquotaCbs": 0.8,
"valorCbs": 0.08
},
"valorTotalItem": 0,
"cst": "ALIQUOTA_REDUZIDA_50",
"ibsUf": {
"valorDiferimentoIbsUf": 0,
"aliquotaEfetivaIbsUf": 0,
"aliquotaEfetivaIbsUfRegular": 0,
"aliquotaDiferimentoIbsUf": 0,
"valorTotalIbs": 0.02,
"valorIbsUfRegular": 0,
"valorIbsUf": 0.02,
"aliquotaIbsUf": 0.2
},
"ibsMunicipal": {
"valorIbsMunicipio": 0,
"valorDiferimentoIbsMunicipio": 0,
"aliquotaEfetivaIbsUfRegular": 0,
"aliquotaIbsMunicipio": 0,
"aliquotaEfetivaIbsMunicipio": 0,
"valorTributadoIbsMunicipioRegular": 0,
"aliquotaDiferimentoIbsMunicipio": 0,
"aliquotaEfetivaIbsMunicipioRegular": 0
},
"codigoClassificacaoTributaria": "200046"
}
}
],
"numeroNotaFiscal": 108,
"escriturada": "ESCRITURADA_INTERNO",
"modelo": "SERVICO",
"saidas": [
181
],
"idEntidade": 17,
"modeloDocumentoFiscal": "NFS",
"retencoes": [],
"entradas": [],
"idTerceiroRemetente": 273,
"idTerceiroDestinatario": 42
}