Alterdata Software

Introdução ¶

Documentações dos Produtos

Esta é uma plataforma que permite os clientes da Alterdata acessarem as documentações dos seus produtos.

Documentações aqui presentes:

NF-Stock:

MS-Importação;
Ms-Exportação;

MS-Importação ¶

A API MS-Importação é um serviço da Alterdata que permite realizar a importação de documentos fiscais (NFe, NFCe, NFSe, CTe e SAT). Para enviar seu documento informe o tamanho e a extensão do seu arquivo. O sistema retornará uma url que será utilizada no envio do mesmo.

A autenticação na nossa API é realizada por meio de token de acesso. Um token de acesso é uma chave única que você precisa incluir no cabeçalho de autenticação da solicitação a fim de provar que está autorizado a acessar os recursos protegidos.Mantenha seu token de acesso em segurança. Não compartilhe seu token com terceiros e não o armazene em locais de fácil acesso.

Tipo de Documentos Fiscais Compatíveis: NFe, NFCe, NFSe, CTe e SAT;
Eventos: ProcNFE ou ProcEvento;
Tipo de Extensões Suportadas: .xml .zip .txt;
Tamanho de Arquivo Permitido: Máximo: 30mb

Importante: O tamanho do arquivo deverá ser informado em bytes. Exemplo: se o seu arquivo tiver 6mb, o informe como “6000000”.

Obter o token de acesso ¶

Passo 1: Obtenha o token no site do NF-Stock

O token de acesso é gerado no site do NF-Stock. Após se autenticar, acesse as ‘Opções da Conta’ e clique na aba ‘Integração’. Copie esse token para usá-lo no próximo passo.

Passo 2: Enviar as informações prévias do arquivo ¶

Obter o URL Upload
POST`/storage`

Através deste endpoint, faça o envio das informações do arquivo. Para fazer isso, utilize uma das seguintes URL’s: URL da ‘Example URI’ (ambiente de teste) ou para a URL de produção: https://ms-importacao-service-nfstock.alterdatasoftware.com.br/storage

Campos obrigatórios

size - Informe o tamanho em bytes do arquivo (até 6mb)

extension - Informe a extensão do arquivo: “.zip” ou “.xml”

Example URI

POST https://www.alterdata.com.br/storage

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer INSIRA_AQUI_SEU_TOKEN

Body

{
  "size": 2999999,
  "extension": ".xml"
}

Response 200

HideShow

Esta resposta devolverá o atributo “url”, que é o endpoint para o envio do documento no passo 2, com tempo de expiração de 1 minuto.

Body

{
  "mensagem": "Url gerada com sucesso.",
  "url": "https://ms-importacao.s3.amazonaws.com/Identificador?AWSAccessKeyId=&Expires=&Signature=",
  "id": "Identificador"
}

Passo 3: Enviar o arquivo ¶

Upload do arquivo
PUT`/{Identificador}{?AWSAccessKeyId,Expires,Signature}`

Através deste endpoint, faça o envio do arquivo para a url da Amazon. O corpo da solicitação precisa ser do tipo Binary File, para que você possa selecionar e enviar o arquivo desejado. Para fazer isso, utilize a url obtida na Response 200 do passo 1.

Example URI

PUT https://www.alterdata.com.br/Identificador?AWSAccessKeyId=&Expires=&Signature=

URI Parameters

HideShow

Identificador: guide (required)
AWSAccessKeyId: string (required)
Expires: number (required)
Signature: string (required)

Request

HideShow

Body

Binary file

Response 200

Passo 4: Consulte o status da importação ¶

Consultar status
GET`/storage/arquivo/{IdObtidoDoPost}`

Através deste endpoint, consulte o status atual da importação do arquivo enviado. Utilize o id obtido na resposta do Passo 2 para compor a URL. Para fazer isso, utilize uma das seguintes URLs: URL da ‘Example URI’ (ambiente de teste) ou para a URL de produção: https://ms-importacao-service-nfstock.alterdatasoftware.com.br/storage/arquivo/{IdObtidoDoPost}

Possíveis valores de status

Uploaded - O arquivo foi enviado e processado com sucesso.

Com Erro - Ocorreu um erro no processamento. Verifique o campo “log” para detalhes.

Example URI

GET https://www.alterdata.com.br/storage/arquivo/IdObtidoDoPost

URI Parameters

HideShow

IdObtidoDoPost: string (required)
O identificador retornado no campo “id” da Response do Passo 2.

Request

HideShow

Headers

Authorization: Bearer INSIRA_AQUI_SEU_TOKEN

Response 200

HideShow

Exemplo de retorno com sucesso:

Headers

Content-Type: application/json

Body

{
  "tamanho": 9138,
  "extensao": ".xml",
  "status": "Uploaded",
  "dataCriacao": "2026-08-18T12:11:47.6978768-03:00",
  "log": "",
  "dataUploaded": "2026-08-18T12:12:13"
}

Response 200

HideShow

Exemplo de retorno com erro:

Headers

Content-Type: application/json

Body

{
  "tamanho": 5086,
  "extensao": ".xml",
  "status": "Com Erro",
  "dataCriacao": "2026-08-18T12:25:09.3312127-03:00",
  "log": "Erro  - Erro de Schema: O elemento 'NFe' in namespace 'http://www.portalfiscal.inf.br/nfe' tem conteúdo incompleto. Lista de possíveis elementos esperados: 'infNFeSupl' in namespace 'http://www.portalfiscal.inf.br/nfe' bem como 'Signature'\n",
  "dataInicioImportacao": "2026-08-18T12:25:35",
  "dataFimImportacao": "2026-08-18T12:25:35",
  "dataUploaded": "2026-08-18T12:25:30"
}

MS-Exportação ¶

A API MS-Exportação é um serviço da Alterdata para realizar a exportação de documentos fiscais (NFe, NFCe, NFSe, CTe e CFe). Isso permite a entrega de documentos com mais agilidade.

A autenticação na nossa API é realizada por meio de token de acesso. Um token de acesso é uma chave única que você precisa incluir no cabeçalho de autenticação da solicitação a fim de provar que está autorizado a acessar os recursos protegidos. Mantenha seu token de acesso em segurança. Não compartilhe seu token com terceiros e não o armazene em locais de fácil acesso.

Obter o token de acesso

Obtenha o token no site do NF-Stock

O token de acesso é gerado no site do NF-Stock. Após se autenticar, acesse as ‘Opções da Conta’ e clique na aba ‘Integração’. Copie esse token para usá-lo nos próximos passos.

Regra do código CRM

O parâmetro codigoCrm deve conter exatamente 6 dígitos. Caso o número possua menos de 6 dígitos, ele deve ser preenchido com zeros à esquerda.

Exemplo: CRM 123 deve ser informado como 000123.

Buscar documentos novos a partir do NSU informado ¶

Buscar documentos novos
GET`/api/v1/{codigoCrm}/{cpfCnpj}/documentos/{nsu}/novos{?Tamanho,Pagina,Xml}`

Através deste endpoint, preenchendo os parâmetros da URL corretamente, você obtém novos documentos a partir do NSU informado.

Campos obrigatórios

codigoCrm - Código CRM para filtrar os documentos

cpfCnpj - CPF/CNPJ para filtrar os documentos

nsu - NSU (Número Sequencial Único) para buscar documentos

Example URI

GET https://www.alterdata.com.br/api/v1/codigoCrm/cpfCnpj/documentos/nsu/novos?Tamanho=&Pagina=&Xml=

URI Parameters

HideShow

codigoCrm: string (required)
Filtrar por código CRM (6 dígitos, preenchido com zeros à esquerda)
cpfCnpj: string (required)
Filtrar por CPF/CNPJ
nsu: int64 (required)
Filtrar por NSU
Tamanho: int64 (optional)
Tamanho da página
Pagina: int64 (optional)
Página que deseja
Xml: boolean (optional)
Se deseja o XML do documento

Request

HideShow

Headers

Authorization: Bearer INSIRA_AQUI_SEU_TOKEN

Response 200

HideShow

Body

{
  "total": 0,
  "paginas": 0,
  "tamanho": 0,
  "pagina": 0,
  "documentos": [
    {
      "nsu": 0,
      "data_emissao": "2025-10-22T14:01:01.521Z",
      "data_importacao": "2025-10-22T14:01:01.521Z",
      "chave": "string",
      "modelo": "string",
      "status": "string",
      "tipo": "string",
      "url_download": "string",
      "xml": "string",
      "url_finalidade": "string",
      "layout_nacional": true,
      "municipio_prestacao": 0
    }
  ]
}

Buscar documento pelo NSU informado ¶

Buscar documento específico
GET`/api/v1/{codigoCrm}/{cpfCnpj}/documentos/{nsu}{?Xml}`

Através deste endpoint, preenchendo os parâmetros da URL corretamente, você obtém o documento referente ao NSU informado.

Campos obrigatórios

codigoCrm - Código CRM para filtrar os documentos

cpfCnpj - CPF/CNPJ para filtrar os documentos

nsu - NSU (Número Sequencial Único) do documento

Example URI

GET https://www.alterdata.com.br/api/v1/codigoCrm/cpfCnpj/documentos/nsu?Xml=

URI Parameters

HideShow

codigoCrm: string (required)
Filtrar por código CRM (6 dígitos, preenchido com zeros à esquerda)
cpfCnpj: string (required)
Filtrar por CPF/CNPJ
nsu: int64 (required)
Filtrar por NSU
Xml: boolean (optional)
Se deseja o XML do documento

Request

HideShow

Headers

Authorization: Bearer INSIRA_AQUI_SEU_TOKEN

Response 200

HideShow

Body

{
  "nsu": 0,
  "data_emissao": "2025-10-22T14:05:07.510Z",
  "data_importacao": "2025-10-22T14:05:07.510Z",
  "chave": "string",
  "modelo": "string",
  "status": "string",
  "tipo": "string",
  "url_download": "string",
  "xml": "string",
  "url_finalidade": "string",
  "layout_nacional": true,
  "municipio_prestacao": 0
}

Buscar documento pela chave de acesso ¶

Buscar documento específico
GET`/api/v1/{codigoCrm}/{cpfCnpj}/documentos/{chave}/chave{?Xml}`

Através deste endpoint, preenchendo os parâmetros da URL corretamente, você obtém o documento referente à chave informada.

Campos obrigatórios

codigoCrm - Código CRM para filtrar os documentos

cpfCnpj - CPF/CNPJ para filtrar os documentos

chave - Chave de acesso do documento

Example URI

GET https://www.alterdata.com.br/api/v1/codigoCrm/cpfCnpj/documentos/chave/chave?Xml=

URI Parameters

HideShow

codigoCrm: string (required)
Filtrar por código CRM (6 dígitos, preenchido com zeros à esquerda)
cpfCnpj: string (required)
Filtrar por CPF/CNPJ
chave: string (required)
Filtrar por Chave de acesso
Xml: boolean (optional)
Se deseja o XML do documento

Request

HideShow

Headers

Authorization: Bearer INSIRA_AQUI_SEU_TOKEN

Response 200

HideShow

Body

{
  "nsu": 0,
  "data_emissao": "2025-10-22T14:05:07.510Z",
  "data_importacao": "2025-10-22T14:05:07.510Z",
  "chave": "string",
  "modelo": "string",
  "status": "string",
  "tipo": "string",
  "url_download": "string",
  "xml": "string",
  "url_finalidade": "string",
  "layout_nacional": true,
  "municipio_prestacao": 0
}

Buscar documentos com ou sem finalidade pelo NSU informado ¶

Buscar documentos com finalidade
GET`/api/v1/{codigoCrm}/{cpfCnpj}/documentos/{nsu}/finalidade{?Tamanho,Pagina,Finalidade}`

Através deste endpoint, preenchendo os parâmetros da URL corretamente, você obtém documentos com ou sem finalidade referentes ao NSU informado.

Campos obrigatórios

codigoCrm - Código CRM para filtrar os documentos

cpfCnpj - CPF/CNPJ para filtrar os documentos

nsu - NSU (Número Sequencial Único) para buscar documentos

Example URI

GET https://www.alterdata.com.br/api/v1/codigoCrm/cpfCnpj/documentos/nsu/finalidade?Tamanho=&Pagina=&Finalidade=

URI Parameters

HideShow

codigoCrm: string (required)
Filtrar por código CRM (6 dígitos, preenchido com zeros à esquerda)
cpfCnpj: string (required)
Filtrar por CPF/CNPJ
nsu: int64 (required)
Filtrar por NSU
Tamanho: int64 (optional)
Tamanho da página
Pagina: int64 (optional)
Página que deseja
Finalidade: boolean (optional)
Se deseja a finalidade do documento

Request

HideShow

Headers

Authorization: Bearer INSIRA_AQUI_SEU_TOKEN

Response 200

HideShow

Body

{
  "total": 0,
  "paginas": 0,
  "tamanho": 0,
  "pagina": 0,
  "documentos": [
    {
      "nsu": 0,
      "data_emissao": "2025-10-22T14:06:03.313Z",
      "data_importacao": "2025-10-22T14:06:03.313Z",
      "chave": "string",
      "modelo": "string",
      "status": "string",
      "tipo": "string",
      "url_download": "string",
      "xml": "string",
      "url_finalidade": "string",
      "layout_nacional": true,
      "municipio_prestacao": 0
    }
  ]
}

Filtrar NFCe ¶

Filtrar documentos NFCe
GET`/api/v1/{codigoCrm}/{cpfCnpj}/nfce{?Tipo,DataInicial,DataFinal,Status,Tamanho,Pagina}`

Através deste endpoint, preenchendo os parâmetros da URL corretamente, você obtém documentos NFCe filtrados pela data inicial informada.

Campos obrigatórios

codigoCrm - Código CRM para filtrar os documentos

cpfCnpj - CPF/CNPJ para filtrar os documentos

DataInicial - Data de início para filtrar os documentos NFCe

Example URI

GET https://www.alterdata.com.br/api/v1/codigoCrm/cpfCnpj/nfce?Tipo=&DataInicial=&DataFinal=&Status=&Tamanho=&Pagina=

URI Parameters

HideShow

codigoCrm: string (required)
Filtrar por código CRM (6 dígitos, preenchido com zeros à esquerda)
cpfCnpj: string (required)
Filtrar por CPF/CNPJ
Tipo: string (optional)
Se é emitida, recebida ou todas
DataInicial: string (required)
Data de início da busca
DataFinal: string (optional)
Data final da busca
Status: string (optional)
Se é autorizada, cancelada ou todas
Tamanho: int64 (optional)
Tamanho da página
Pagina: int64 (optional)
Página que deseja

Request

HideShow

Headers

Authorization: Bearer INSIRA_AQUI_SEU_TOKEN

Response 200

HideShow

Body

<!-- include(nfce-response-get.json)

Filtrar NFe ¶

Filtrar documentos NFe
GET`/api/v1/{codigoCrm}/{cpfCnpj}/nfe{?Tipo,DataInicial,DataFinal,Status,Tamanho,Pagina}`

Através deste endpoint, preenchendo os parâmetros da URL corretamente, você obtém documentos NFe filtrados pela data inicial informada.

Campos obrigatórios

codigoCrm - Código CRM para filtrar os documentos

cpfCnpj - CPF/CNPJ para filtrar os documentos

DataInicial - Data de início para filtrar os documentos NFe

Example URI

GET https://www.alterdata.com.br/api/v1/codigoCrm/cpfCnpj/nfe?Tipo=&DataInicial=&DataFinal=&Status=&Tamanho=&Pagina=

URI Parameters

HideShow

codigoCrm: string (required)
Filtrar por código CRM (6 dígitos, preenchido com zeros à esquerda)
cpfCnpj: string (required)
Filtrar por CPF/CNPJ
Tipo: string (optional)
Se é emitida, recebida ou todas
DataInicial: string (required)
Data de início da busca
DataFinal: string (optional)
Data final da busca
Status: string (optional)
Se é autorizada, cancelada, carta de correção, faltante, denegada, inutilizada ou todas
Tamanho: int64 (optional)
Tamanho da página
Pagina: int64 (optional)
Página que deseja

Request

HideShow

Headers

Authorization: Bearer INSIRA_AQUI_SEU_TOKEN

Response 200

HideShow

Body

include(nfe-response-get.json) -->

Dúvidas? ¶

Fale com a gente

Para verificar questões relacionadas a API, entre em contato com nosso atendimento exclusivo no e-mail: api_nfstock@alterdata.com.br

Introdução ¶

Documentações dos Produtos ¶

MS-Importação ¶

Obter o token de acesso ¶

Passo 1: Obtenha o token no site do NF-Stock ¶

Passo 2: Enviar as informações prévias do arquivo ¶

Obter o URL UploadPOST/storage

Campos obrigatórios ¶

Example URI

Headers

Body

Body

Passo 3: Enviar o arquivo ¶

Upload do arquivoPUT/{Identificador}{?AWSAccessKeyId,Expires,Signature}

Example URI

Body

Passo 4: Consulte o status da importação ¶

Consultar statusGET/storage/arquivo/{IdObtidoDoPost}

Possíveis valores de status ¶

Example URI

Headers

Headers

Body

Headers

Body

MS-Exportação ¶

Obter o token de acesso ¶

Obtenha o token no site do NF-Stock ¶

Regra do código CRM ¶

Buscar documentos novos a partir do NSU informado ¶

Buscar documentos novosGET/api/v1/{codigoCrm}/{cpfCnpj}/documentos/{nsu}/novos{?Tamanho,Pagina,Xml}

Campos obrigatórios ¶

Example URI

Headers

Body

Buscar documento pelo NSU informado ¶

Buscar documento específicoGET/api/v1/{codigoCrm}/{cpfCnpj}/documentos/{nsu}{?Xml}

Campos obrigatórios ¶

Example URI

Headers

Body

Buscar documento pela chave de acesso ¶

Buscar documento específicoGET/api/v1/{codigoCrm}/{cpfCnpj}/documentos/{chave}/chave{?Xml}

Campos obrigatórios ¶

Example URI

Headers

Body

Buscar documentos com ou sem finalidade pelo NSU informado ¶

Buscar documentos com finalidadeGET/api/v1/{codigoCrm}/{cpfCnpj}/documentos/{nsu}/finalidade{?Tamanho,Pagina,Finalidade}

Campos obrigatórios ¶

Example URI

Headers

Body

Filtrar NFCe ¶

Filtrar documentos NFCeGET/api/v1/{codigoCrm}/{cpfCnpj}/nfce{?Tipo,DataInicial,DataFinal,Status,Tamanho,Pagina}

Campos obrigatórios ¶

Example URI

Headers

Body

Filtrar NFe ¶

Filtrar documentos NFeGET/api/v1/{codigoCrm}/{cpfCnpj}/nfe{?Tipo,DataInicial,DataFinal,Status,Tamanho,Pagina}

Campos obrigatórios ¶

Example URI

Headers

Body

Dúvidas? ¶

Fale com a gente ¶

Documentações dos Produtos

Passo 1: Obtenha o token no site do NF-Stock

Obter o URL Upload
POST`/storage`

Campos obrigatórios

Upload do arquivo
PUT`/{Identificador}{?AWSAccessKeyId,Expires,Signature}`

Consultar status
GET`/storage/arquivo/{IdObtidoDoPost}`

Possíveis valores de status

Obter o token de acesso

Obtenha o token no site do NF-Stock

Regra do código CRM

Buscar documentos novos
GET`/api/v1/{codigoCrm}/{cpfCnpj}/documentos/{nsu}/novos{?Tamanho,Pagina,Xml}`

Campos obrigatórios

Buscar documento específico
GET`/api/v1/{codigoCrm}/{cpfCnpj}/documentos/{nsu}{?Xml}`

Campos obrigatórios

Buscar documento específico
GET`/api/v1/{codigoCrm}/{cpfCnpj}/documentos/{chave}/chave{?Xml}`

Campos obrigatórios

Buscar documentos com finalidade
GET`/api/v1/{codigoCrm}/{cpfCnpj}/documentos/{nsu}/finalidade{?Tamanho,Pagina,Finalidade}`

Campos obrigatórios

Filtrar documentos NFCe
GET`/api/v1/{codigoCrm}/{cpfCnpj}/nfce{?Tipo,DataInicial,DataFinal,Status,Tamanho,Pagina}`

Campos obrigatórios

Filtrar documentos NFe
GET`/api/v1/{codigoCrm}/{cpfCnpj}/nfe{?Tipo,DataInicial,DataFinal,Status,Tamanho,Pagina}`

Campos obrigatórios

Fale com a gente