GET api/NotaFiscal/Campos

Retorna os campos da NF

Request Information

URI Parameters

None.

Body Parameters

Dados para a consulta

Name	Description	Type	Additional information
idcadastro	Código do cadastro do cliente	integer	None.
titulo	Número do título	integer	None.
token	Token de acesso	string	None.

Request Formats

application/json, text/json

Sample:

{
  "idcadastro": 1,
  "titulo": 2,
  "token": "sample string 3"
}

application/xml, text/xml

Sample:

<NotaFiscalModel.NF21Dados xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api_pgp">
  <idcadastro>1</idcadastro>
  <titulo>2</titulo>
  <token>sample string 3</token>
</NotaFiscalModel.NF21Dados>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NF21Campos

Name	Description	Type	Additional information
empresa_nome	Nome da empresa emitente da nota fiscal SCM	string	None.
empresa_cnpj	Cnpj do emitente	string	None.
empresa_ie	Inscrição estadual do emitente	string	None.
empresa_endereco	Endereço do emitente	string	None.
empresa_cidade	Cidade/UF do emitente	string	None.
empresa_telefone	Telefone do emitente	string	None.
empresa_url_logo	URL do logo do emitente	string	None.
cliente_codigo	Código do cadastro do cliente	integer	None.
cliente_nome	Nome do cliente	string	None.
cliente_pessoa	PF - Pessoa Física, PJ - Pessoa Jurídica	string	None.
cliente_cpf	CPF ou CNPJ do cliente	string	None.
cliente_endereco	Endereço do cliente (será o endereço da cobrança, se houver)	string	None.
cliente_bairro	Bairro do cliente	string	None.
cliente_cep	CEP do cliente	string	None.
cliente_cidade	Cidade do cliente	string	None.
cobranca_titulo	Número do título de cobrança	integer	None.
cobranca_nosso_numero	Nosso número do boleto bancário	string	None.
cobranca_data_emissao	Data de emissão do título	string	None.
cobranca_data_vencimento	Data de vencimento do título	string	None.
cobranca_valor	Valor do título	string	None.
cobranca_codigo_barras	Código de barras do título	string	None.
nf_numero	Número da nota fiscal SCM (modelo 21)	string	None.
nf_serie	Série da nota fiscal	string	None.
nf_status	ATIVA ou CANCELADA	string	None.
nf_data_emissao	Data de emissão da nota fiscal	string	None.
nf_referencia	Mês/Ano de referência da nota fiscal	string	None.
nf_cfop	CFOP	string	None.
nf_descricao	Descrição do serviço	string	None.
nf_aliq_icms	Alíquota do ICMS	string	None.
nf_valor_nota	Valor de referência para o cálculo do ICMS	string	None.
nf_valor_icms	Valor (R$) do ICMS	string	None.
nf_chave	Código da chave	string	None.
nf_info_complementar	Informações complementares da nota fiscal	string	None.
sva	Dados do SVA (apenas pessoa física)	Collection of SvaInfo	None.
sva_valor_total	Valor todos dos serviços adicionados (se houver)	string	None.

Response Formats

application/json, text/json

Sample:

{
  "empresa_nome": "sample string 1",
  "empresa_cnpj": "sample string 2",
  "empresa_ie": "sample string 3",
  "empresa_endereco": "sample string 4",
  "empresa_cidade": "sample string 5",
  "empresa_telefone": "sample string 6",
  "empresa_url_logo": "sample string 7",
  "cliente_codigo": 8,
  "cliente_nome": "sample string 9",
  "cliente_pessoa": "sample string 10",
  "cliente_cpf": "sample string 11",
  "cliente_endereco": "sample string 12",
  "cliente_bairro": "sample string 13",
  "cliente_cep": "sample string 14",
  "cliente_cidade": "sample string 15",
  "cobranca_titulo": 16,
  "cobranca_nosso_numero": "sample string 17",
  "cobranca_data_emissao": "sample string 18",
  "cobranca_data_vencimento": "sample string 19",
  "cobranca_valor": "sample string 20",
  "cobranca_codigo_barras": "sample string 21",
  "nf_numero": "sample string 22",
  "nf_serie": "sample string 23",
  "nf_status": "sample string 24",
  "nf_data_emissao": "sample string 25",
  "nf_referencia": "sample string 26",
  "nf_cfop": "sample string 27",
  "nf_descricao": "sample string 28",
  "nf_aliq_icms": "sample string 29",
  "nf_valor_nota": "sample string 30",
  "nf_valor_icms": "sample string 31",
  "nf_chave": "sample string 32",
  "nf_info_complementar": "sample string 33",
  "sva": [
    {
      "descricao": "sample string 1",
      "valor": "sample string 2"
    },
    {
      "descricao": "sample string 1",
      "valor": "sample string 2"
    }
  ],
  "sva_valor_total": "sample string 34"
}

application/xml, text/xml

Sample:

<NotaFiscalModel.NF21Campos xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api_pgp">
  <cliente_bairro>sample string 13</cliente_bairro>
  <cliente_cep>sample string 14</cliente_cep>
  <cliente_cidade>sample string 15</cliente_cidade>
  <cliente_codigo>8</cliente_codigo>
  <cliente_cpf>sample string 11</cliente_cpf>
  <cliente_endereco>sample string 12</cliente_endereco>
  <cliente_nome>sample string 9</cliente_nome>
  <cliente_pessoa>sample string 10</cliente_pessoa>
  <cobranca_codigo_barras>sample string 21</cobranca_codigo_barras>
  <cobranca_data_emissao>sample string 18</cobranca_data_emissao>
  <cobranca_data_vencimento>sample string 19</cobranca_data_vencimento>
  <cobranca_nosso_numero>sample string 17</cobranca_nosso_numero>
  <cobranca_titulo>16</cobranca_titulo>
  <cobranca_valor>sample string 20</cobranca_valor>
  <empresa_cidade>sample string 5</empresa_cidade>
  <empresa_cnpj>sample string 2</empresa_cnpj>
  <empresa_endereco>sample string 4</empresa_endereco>
  <empresa_ie>sample string 3</empresa_ie>
  <empresa_nome>sample string 1</empresa_nome>
  <empresa_telefone>sample string 6</empresa_telefone>
  <empresa_url_logo>sample string 7</empresa_url_logo>
  <nf_aliq_icms>sample string 29</nf_aliq_icms>
  <nf_cfop>sample string 27</nf_cfop>
  <nf_chave>sample string 32</nf_chave>
  <nf_data_emissao>sample string 25</nf_data_emissao>
  <nf_descricao>sample string 28</nf_descricao>
  <nf_info_complementar>sample string 33</nf_info_complementar>
  <nf_numero>sample string 22</nf_numero>
  <nf_referencia>sample string 26</nf_referencia>
  <nf_serie>sample string 23</nf_serie>
  <nf_status>sample string 24</nf_status>
  <nf_valor_icms>sample string 31</nf_valor_icms>
  <nf_valor_nota>sample string 30</nf_valor_nota>
  <sva>
    <NotaFiscalModel.SvaInfo>
      <descricao>sample string 1</descricao>
      <valor>sample string 2</valor>
    </NotaFiscalModel.SvaInfo>
    <NotaFiscalModel.SvaInfo>
      <descricao>sample string 1</descricao>
      <valor>sample string 2</valor>
    </NotaFiscalModel.SvaInfo>
  </sva>
  <sva_valor_total>sample string 34</sva_valor_total>
</NotaFiscalModel.NF21Campos>