# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Send Text

Neste endpoint é possível enviar mensagem de texto p/ um numero.


# Requisição POST

# URL https://app.apiintegra.com/api/whatsapp/sendMessage

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/whatsapp/sendMessage
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
  "session":"weverson",
  "phone": "5569992279526",
  "message": "Olá"
}

return JSON


{
	"message": "Mensagem enviada com sucesso.",
	"data": {
		"status": "success",
		"response": [
			{
				"id": "true_556992279526@c.us_3EB0EF62B62F0D615EF3D4_out",
				"viewed": false,
				"body": "asdasdasd",
				"type": "chat",
				"subtype": null,
				"t": 1723120630,
				"from": "556992279526@c.us",
				"to": "556992279526@c.us",
				"ack": 3,
				"isNewMsg": true,
				"star": false,
				"kicNotified": false,
				"isFromTemplate": false,
				"pollInvalidated": false,
				"isSentCagPollCreation": false,
				"latestEditMsgKey": null,
				"latestEditSenderTimestampMs": null,
				"mentionedJidList": [],
				"groupMentions": [],
				"isEventCanceled": false,
				"eventInvalidated": false,
				"urlText": null,
				"urlNumber": null,
				"isVcardOverMmsDocument": false,
				"isForwarded": false,
				"hasReaction": false,
				"disappearingModeInitiator": "chat",
				"disappearingModeTrigger": "chat_settings",
				"productHeaderImageRejected": false,
				"lastPlaybackProgress": 0,
				"isDynamicReplyButtonsMsg": false,
				"isCarouselCard": false,
				"parentMsgId": null,
				"isMdHistoryMsg": false,
				"stickerSentTs": 0,
				"isAvatar": false,
				"lastUpdateFromServerTs": 0,
				"invokedBotWid": null,
				"bizBotType": null,
				"botResponseTargetId": null,
				"botPluginType": null,
				"botPluginReferenceIndex": null,
				"botPluginSearchProvider": null,
				"botPluginSearchUrl": null,
				"botPluginSearchQuery": null,
				"botPluginMaybeParent": false,
				"botReelPluginThumbnailCdnUrl": null,
				"botMsgBodyType": null,
				"requiresDirectConnection": false,
				"bizContentPlaceholderType": null,
				"hostedBizEncStateMismatch": false,
				"senderOrRecipientAccountTypeHosted": false,
				"placeholderCreatedWhenAccountIsHosted": false,
				"chatId": "556992279526@c.us",
				"fromMe": true,
				"sender": {
					"id": "556992279526@c.us",
					"pushname": "Weverson Gomes",
					"type": "in",
					"isBusiness": false,
					"isEnterprise": false,
					"isSmb": false,
					"textStatusLastUpdateTime": -1,
					"syncToAddressbook": false,
					"formattedName": "You",
					"isMe": true,
					"isMyContact": false,
					"isPSA": false,
					"isUser": true,
					"isWAContact": true,
					"profilePicThumbObj": null,
					"msgs": null
				},
				"timestamp": 1723120630,
				"content": "asdasdasd",
				"isGroupMsg": false,
				"mediaData": []
			}
		],
		"mapper": "return",
		"session": "weverson"
	}
}

# Send Imagem

Neste endpoint é possível enviar arquivo de imagem p/ um numero.

em "filename" é obrigatório colocar o nome do arquivo e sua extensão (png,jpg e etc).

Caso queira enviar uma legenda p/ a imagem, basta preencher "message", porém não é obrigatório. 


# Requisição POST

# URL https://app.apiintegra.com/api/whatsapp/sendImage

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/whatsapp/sendImage
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
  "session":"weverson",
  "phone": "5569992279526",
  "base64": "base64",
  "filename": "nome da imagem.png",
  "message": null
}

return JSON


{
	"message": "Mensagem enviada com sucesso.",
	"data": {
		"status": "success",
		"response": [
			{
				"ack": 3,
				"id": "true_556992279526@c.us_3EB0E4FD5F17CB1630B398_out",
				"sendMsgResult": {
					"messageSendResult": "OK"
				}
			}
		],
		"mapper": "return",
		"session": "weverson"
	}
}

# Send File

Neste endpoint é possível enviar arquivos de variados formatos p/ um numero.

em "filename" é obrigatório informar o nome do arquivo e sua extensão (pdf, xlsx e etc)

caso queira enviar uma legenda, basta preencher "message", porém não é obrigatório.


# Requisição POST

# URL https://app.apiintegra.com/api/whatsapp/sendFile

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/whatsapp/sendFile
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
  "session":"weverson",
  "phone": "5569992279526",
  "base64": "",
  "filename": "file.pdf",
  "message": "envio de documento pdf"
}

return JSON


{
	"message": "Mensagem enviada com sucesso.",
	"data": {
		"status": "success",
		"response": [
			{
				"ack": 3,
				"id": "true_556992279526@c.us_3EB00BB83AAA963B3C4B67_out",
				"sendMsgResult": {
					"messageSendResult": "OK"
				}
			}
		],
		"mapper": "return",
		"session": "weverson"
	}
}

# Send Vídeo

Neste endpoint é possível enviar um arquivo de vídeo p/ um numero.


em "filename" é obrigatório colocar o nome do arquivo e sua extensão (mp4,avi e etc).
Caso queira enviar uma legenda p/ a imagem, basta preencher "message", porém não é obrigatório. 


# Requisição POST

# URL https://app.apiintegra.com/api/whatsapp/sendVideo

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/whatsapp/sendVideo
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
  "session":"weverson",
  "phone": "5569992279526",
  "base64": "base64",
  "filename": "nome do vídeo.mp4",
  "message": null
}

return JSON


{
	"message": "Mensagem enviada com sucesso.",
	"data": {
		"status": "success",
		"response": [
			{
				"ack": 3,
				"id": "true_556992279526@c.us_3EB06EECCAEBE8EC4481D8_out",
				"sendMsgResult": {
					"messageSendResult": "OK"
				}
			}
		],
		"mapper": "return",
		"session": "weverson"
	}
}

# Send Link

Neste endpoint é possível enviar um URL LINK p/ um numero.


# Requisição POST

# URL https://app.apiintegra.com/api/whatsapp/sendLink

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/whatsapp/sendLink
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
  "session":"weverson",
  "phone": "5569992279526",
  "url": "https://docs.apiintegra.com/doc-page#section-1"
}

return JSON


{
	"message": "Mensagem enviada com sucesso.",
	"data": {
		"status": "success",
		"response": [
			{
				"id": "true_556992279526@c.us_3EB0BA540B22734E33ECDA_out",
				"ack": 3,
				"from": "556992279526@c.us",
				"to": "556992279526@c.us",
				"sendMsgResult": []
			}
		],
		"mapper": "return",
		"session": "weverson"
	}
}

# Send Audio

Neste endpoint é possível enviar um Audio p/ um numero.

"filename" é obrigatório informar junto com sua extensão.


# Requisição POST

# URL https://app.apiintegra.com/api/whatsapp/sendAudio

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/whatsapp/sendAudio
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
  "session":"weverson",
  "phone": "5569992279526",
  "base64": "base64",
  "filename": "nome do audio.mp3",
}

return JSON


{
	"message": "Mensagem enviada com sucesso.",
	"data": {
		"status": "success",
		"response": [
			{
				"ack": 3,
				"id": "true_556992279526@c.us_3EB061C7B30319FBB9D0B2_out",
				"sendMsgResult": {
					"messageSendResult": "OK"
				}
			}
		],
		"mapper": "return",
		"session": "weverson"
	}
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Sms Send

Neste endpoint é possível enviar mensagens de texto via SMS


# Requisição POST

# URL https://app.apiintegra.com/api/sms/send

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/sms/send
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
	"number": "5569992279526",
	"message": "12"
}

return JSON


{
	"return": true,
	"message": "success"
}

# Sms Auth

Neste endpoint é possível enviar uma autenticação de 2 fatores com código gerado automaticamente.


# Requisição POST

# URL https://app.apiintegra.com/api/sms/auth

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/sms/auth
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
	"number": "5569992279526",
	"message": "seu sódigo é..."
}

return JSON


{
	"return": true,
	"message": "success",
	"auth": 756488
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Consultar NFe

Neste endpoint é possível consultar e baixar xml/pdf do documento fiscal.


# Requisição GET

# URL https://app.apiintegra.com/api/chnfe/{chave da nota}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/chnfe/{chave da nota}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": {
		"chaveAcesso": "11240114263090000460550220000000241059558900",
		"numero": "24",
		"versaoXml": "4.00",
		"modelo": "55",
		"serie": "22",
		"dataEmissao": "09\/01\/2024",
		"dataEntSaida": "09\/01\/2024",
		"valorTotal": "31029.95",
		"emiCpfCnpj": "XXXXXXXXXXXXXX",
		"emiNome": "PEREIRA MATERIAIS PARA CONSTRUCAO LT",
		"emiInscEstadual": "00000005327431",
		"emiUf": "RO",
		"destCpfCnpj": "XXXXXXXXXXXXXX",
		"destNome": "MATERIAIS PARA CONSTRUCAO EIRELI-EPP (MATRIZ)",
		"destInscEstadual": "00000003408094",
		"destUf": "RO",
		"natOperacao": "RETORNO MERC DEPOSITADA DEP FECHADO",
		"tipoOperacao": "1 - Saída",
		"digest": "xWUnzQzu7kHi5J7hoMy6H+vfkjY=",
		"danfe": "url documento pdf",
		"xml": "url documento xml"
	}
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Buscar Endereço via CEP

Neste endpoint é possível consultar endereço completo de um CEP.


# Requisição GET

# URL https://app.apiintegra.com/api/cep/{cep}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/cep/{cep}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": {
		"cep": "76906384",
		"address_type": "Rua",
		"address_name": "Ana Ferrari",
		"address": "Rua Ana Ferrari",
		"state": "RO",
		"district": "Araçá",
		"lat": "-10.87564",
		"lng": "-61.9435",
		"city": "Ji-Paraná",
		"city_ibge": "1100122",
		"ddd": "69"
	}
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Listar Instituições Finânceiras

Busque por todas Instituições Finânceiras


# Requisição GET

# URL https://app.apiintegra.com/api/bank/

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/bank/
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": [
		{
			"ispb": "00000000",
			"name": "BCO DO BRASIL S.A.",
			"code": 1,
			"fullName": "Banco do Brasil S.A."
		},
		{
			"ispb": "00000208",
			"name": "BRB - BCO DE BRASILIA S.A.",
			"code": 70,
			"fullName": "BRB - BANCO DE BRASILIA S.A."
		},
	]
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Consultar CNPJ

Consulte os dados cadastrais de um CNPJ


# Requisição GET

# URL https://app.apiintegra.com/api/cnpj/{cnpj}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/cnpj/{cnpj}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": {
		"uf": "RO",
		"cep": "76900864",
		"qsa": [
			{
				"pais": null,
				"nome_socio": "EDMAR GOMES FERREIRA",
				"codigo_pais": null,
				"faixa_etaria": "Entre 51 a 60 anos",
				"cnpj_cpf_do_socio": "***372702**",
				"qualificacao_socio": "Sócio-Administrador",
				"codigo_faixa_etaria": 6,
				"data_entrada_sociedade": "1989-03-03",
				"identificador_de_socio": 2,
				"cpf_representante_legal": "***000000**",
				"nome_representante_legal": "",
				"codigo_qualificacao_socio": 49,
				"qualificacao_representante_legal": "Não informada",
				"codigo_qualificacao_representante_legal": 0
			},
			{
				"pais": null,
				"nome_socio": "ELIANE SOARES DOS SANTOS FERREIRA",
				"codigo_pais": null,
				"faixa_etaria": "Entre 51 a 60 anos",
				"cnpj_cpf_do_socio": "***756461**",
				"qualificacao_socio": "Sócio",
				"codigo_faixa_etaria": 6,
				"data_entrada_sociedade": "1989-03-03",
				"identificador_de_socio": 2,
				"cpf_representante_legal": "***000000**",
				"nome_representante_legal": "",
				"codigo_qualificacao_socio": 22,
				"qualificacao_representante_legal": "Não informada",
				"codigo_qualificacao_representante_legal": 0
			}
		],
		"cnpj": "34452136000154",
		"pais": null,
		"email": null,
		"porte": "EMPRESA DE PEQUENO PORTE",
		"bairro": "DOIS DE ABRIL",
		"numero": "2828",
		"ddd_fax": "",
		"municipio": "JI-PARANA",
		"logradouro": "MARECHAL RONDON",
		"cnae_fiscal": 4681805,
		"codigo_pais": null,
		"complemento": "",
		"codigo_porte": 3,
		"razao_social": "ELLUS DISTRIBUIDORA DE PECAS E LUBRIFICANTES LTDA",
		"nome_fantasia": "",
		"capital_social": 200000,
		"ddd_telefone_1": "6934215437",
		"ddd_telefone_2": "",
		"opcao_pelo_mei": false,
		"descricao_porte": "",
		"codigo_municipio": 5,
		"cnaes_secundarios": [
			{
				"codigo": 4530701,
				"descricao": "Comércio por atacado de peças e acessórios novos para veículos automotores"
			},
			{
				"codigo": 4530703,
				"descricao": "Comércio a varejo de peças e acessórios novos para veículos automotores"
			},
			{
				"codigo": 4639701,
				"descricao": "Comércio atacadista de produtos alimentícios em geral"
			},
			{
				"codigo": 4642701,
				"descricao": "Comércio atacadista de artigos do vestuário e acessórios, exceto profissionais e de segurança"
			},
			{
				"codigo": 4643501,
				"descricao": "Comércio atacadista de calçados"
			},
			{
				"codigo": 4649404,
				"descricao": "Comércio atacadista de móveis e artigos de colchoaria"
			},
			{
				"codigo": 4672900,
				"descricao": "Comércio atacadista de ferragens e ferramentas"
			},
			{
				"codigo": 4673700,
				"descricao": "Comércio atacadista de material elétrico"
			},
			{
				"codigo": 4679699,
				"descricao": "Comércio atacadista de materiais de construção em geral"
			},
			{
				"codigo": 4711302,
				"descricao": "Comércio varejista de mercadorias em geral, com predominância de produtos alimentícios - supermercados"
			},
			{
				"codigo": 4729699,
				"descricao": "Comércio varejista de produtos alimentícios em geral ou especializado em produtos alimentícios não especificados anteriormente"
			},
			{
				"codigo": 4732600,
				"descricao": "Comércio varejista de lubrificantes"
			},
			{
				"codigo": 4742300,
				"descricao": "Comércio varejista de material elétrico"
			},
			{
				"codigo": 4744001,
				"descricao": "Comércio varejista de ferragens e ferramentas"
			},
			{
				"codigo": 4744099,
				"descricao": "Comércio varejista de materiais de construção em geral"
			},
			{
				"codigo": 4753900,
				"descricao": "Comércio varejista especializado de eletrodomésticos e equipamentos de áudio e vídeo"
			},
			{
				"codigo": 4754701,
				"descricao": "Comércio varejista de móveis"
			},
			{
				"codigo": 4781400,
				"descricao": "Comércio varejista de artigos do vestuário e acessórios"
			},
			{
				"codigo": 4782201,
				"descricao": "Comércio varejista de calçados"
			}
		],
		"natureza_juridica": "Sociedade Empresária Limitada",
		"situacao_especial": "",
		"opcao_pelo_simples": false,
		"situacao_cadastral": 2,
		"data_opcao_pelo_mei": null,
		"data_exclusao_do_mei": null,
		"cnae_fiscal_descricao": "Comércio atacadista de lubrificantes",
		"codigo_municipio_ibge": 1100122,
		"data_inicio_atividade": "1989-03-03",
		"data_situacao_especial": null,
		"data_opcao_pelo_simples": "2012-01-01",
		"data_situacao_cadastral": "2004-03-12",
		"nome_cidade_no_exterior": "",
		"codigo_natureza_juridica": 2062,
		"data_exclusao_do_simples": "2016-12-31",
		"motivo_situacao_cadastral": 0,
		"ente_federativo_responsavel": "",
		"identificador_matriz_filial": 1,
		"qualificacao_do_responsavel": 49,
		"descricao_situacao_cadastral": "ATIVA",
		"descricao_tipo_de_logradouro": "AVENIDA",
		"descricao_motivo_situacao_cadastral": "SEM MOTIVO",
		"descricao_identificador_matriz_filial": "MATRIZ"
	}
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Obter Coordenadas Lat/Lng

Consulte as coordenadas lat/lng de um determinado endereço.


# Requisição POST

# URL https://app.apiintegra.com/api/address_latlong

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/address_latlong
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
	"address": "rua são vicente 662, são paulo capital"
}

return JSON


{
	"address": "rua são vicente 662, são paulo capital",
	"lat": -23.5404486,
	"lng": -46.6570454
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Envio de arquivos

Neste endpoint é possível enviar arquivos p/ o servidor Integra WebDoc previamente instalado e configurado em uma maquina local.

Os dados são enviados, onde o arquivo deve ser convertido em base64.

namenome do arquivo a ser salvo na maquina local
base64arquivo convertido em base64
pathdiretório da maquina local (é importante considerar os limites de direitos do computador local)
typetipo de formato do arquivo (pdf, rtf, .txt etc)
devicecódigo p/ identificar o dispositivo na qual será impresso. Este código deve ser o mesmo configurado no servidor de arquivos na maquina local.



# Requisição POST

# URL https://app.apiintegra.com/api/document

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/document
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
	"name":"preco",
	"base64": "",
	"path": "C:\\Users\\COMPUTADOR\\Documents",
	"type": "rtf",
	"device": "1"
}

return JSON


{
	"return": true,
	"message": "Document job saved successfully",
	"data": {
		"base64": "",
		"path": "C:\\Users\\COMPUTADOR\\Documents",
		"device": "1",
		"type": "rtf",
		"name": "preco",
		"updated_at": "2024-07-17T21:25:50.000000Z",
		"created_at": "2024-07-17T21:25:50.000000Z",
		"id": 53
	}
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Buscar NCM

Neste endpoint é possível listar todos NCM disponíveis.


# Requisição GET

# URL https://app.apiintegra.com/api/ncm

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/ncm
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": [
		{
			"codigo": "01",
			"descricao": "Animais vivos.",
			"data_inicio": "2022-04-01",
			"data_fim": "9999-12-31",
			"tipo_ato": "Res Camex",
			"numero_ato": "272",
			"ano_ato": "2021"
		},
		{
			"codigo": "01.01",
			"descricao": "Cavalos, asininos e muares, vivos.",
			"data_inicio": "2022-04-01",
			"data_fim": "9999-12-31",
			"tipo_ato": "Res Camex",
			"numero_ato": "272",
			"ano_ato": "2021"
		},
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Buscar Coordenadas IP

Neste endpoint é possível buscar as coordenadas lat/lng de um determinado IP publico.


# Requisição GET

# URL https://app.apiintegra.com/api/ipgeolocalizacao/{ip}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/ipgeolocalizacao/{ip}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": {
		"status": "success",
		"country": "Brazil",
		"countryCode": "BR",
		"region": "RO",
		"regionName": "Rondônia",
		"city": "Cacoal",
		"zip": "78975",
		"lat": -11.4904,
		"lon": -61.4317,
		"timezone": "America\/Porto_Velho",
		"isp": "Speed Travel Comunicação Multimídia Ltda - ME",
		"org": "Speed Travel Comunicação Multimídia Ltda - ME",
		"as": "AS52956 Speed Travel Comunicação Multimídia Ltda - ME",
		"query": "177.22.111.254"
	}
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Rastrear Entrega

Neste endpoint é possível buscar os status/rastreio de uma determinada encomenda.


# Requisição GET

# URL https://app.apiintegra.com/api/rastreio/{codigo_rastreio}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/rastreio/{codigo_rastreio}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": [
		{
			"local": "LOCAL: UNIDADE DE DISTRIBUIÇÃO - CASCAVEL \/ PR",
			"data": "2024-02-22 16:12",
			"status": "Objeto entregue ao destinatário"
		},
		{
			"local": "LOCAL: UNIDADE DE DISTRIBUIÇÃO - CASCAVEL \/ PR",
			"data": "2024-02-22 09:47",
			"status": "Objeto saiu para entrega ao destinatário"
		},
		{
			"local": "DESTINO: UNIDADE DE DISTRIBUIÇÃO - CASCAVEL \/ PR",
			"data": "2024-02-21 21:20",
			"status": "Objeto encaminhado"
		},
		{
			"local": "DESTINO: UNIDADE DE TRATAMENTO - CASCAVEL \/ PR",
			"data": "2024-02-20 21:49",
			"status": "Objeto encaminhado"
		},
		{
			"local": "DESTINO: UNIDADE DE TRATAMENTO - SAO PAULO \/ SP",
			"data": "2024-02-20 17:38",
			"status": "Objeto encaminhado"
		},
		{
			"local": "LOCAL: AGÊNCIA DOS CORREIOS - SAO PAULO \/ SP",
			"data": "2024-02-20 16:18",
			"status": "Objeto postado"
		}
	]
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Buscar Placa

Neste endpoint é possível buscar informações de um determinado veiculo pela placa.


# Requisição GET

# URL https://app.apiintegra.com/api/placa/{placa}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/placa/{placa}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": {
		"fipeTablePriceDetail": {
			"marca": "YAMAHA",
			"modelo": "FZ25 FAZER",
			"importado": "Não",
			"ano": "2018",
			"ano_modelo": "2019",
			"cor": "Branca",
			"cilindrada": "249 cc",
			"combustivel": "Gasolina",
			"chassi": "*****0020873",
			"motor": "*****E020874",
			"passageiros": "2",
			"uf": "AM",
			"municipio": "MANAUS",
			"segmento": "Moto",
			"especie_veiculo": "Passageiro"
		},
		"placaIpva": {
			"ac": 156.38,
			"ap": 234.57,
			"ba": 155.76,
			"ce": 467.28,
			"df": 392.25,
			"es": 157.13,
			"go": 470.7,
			"ma": 311,
			"mg": 314.4,
			"ms": 313.8,
			"pa": 156,
			"pb": 389.4,
			"pe": 311.52,
			"rj": 314.26,
			"rn": 467.28,
			"rr": 312.76,
			"rs": 325.2,
			"sc": 162.59,
			"sp": 303.18,
			"to": 390.95
		}
	}
}

# Buscar Marcas

Neste endpoint é possível buscar Marcas de Veículos.

Parâmetros:

Tipo de veículo (valor 1 para carro, 2 para moto e 3 para caminhão).


# Requisição GET

# URL https://app.apiintegra.com/api/fipe/marca/{tipo}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/fipe/marca/{tipo}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": [
		{
			"id": 1,
			"brand": "Acura"
		},
		{
			"id": 2,
			"brand": "Agrale"
		},
      
}

# Buscar Modelo/Marca

Neste endoint é possível buscar os Modelos de Veículos de acordo com a marca passada como parâmetro. 
o parâmetro {marca} é o valor do campo "id" do endpoint: /api/marca/{tipo}


# Requisição GET

# URL https://app.apiintegra.com/api/fipe/modelo/{marca}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/fipe/modelo/{marca}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": [
		{
			"fipe_code": "005329-5",
			"model": "AMAROK CD2.0 16V\/S CD2.0 16V TDI 4x2 Die",
			"years": "2011 a 2013"
		},
		{
			"fipe_code": "005330-9",
			"model": "AMAROK CD2.0 16V\/S CD2.0 16V TDI 4x4 Die",
			"years": "2011 a 2018"
		},
}

# Buscar Modelo/Ano/Preço

Neste endpoint é possível buscar o Preço, Ano e Modelo do veiculo.
o Parâmetro {fipe_code} é o retorno do endpoint /api/fipe/modelo/{marca}


# Requisição GET

# URL https://app.apiintegra.com/api/fipe/ano-preco/{fipe_code}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/fipe/ano-preco/{fipe_code}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": [
		{
			"fipe_code": "005329-5",
			"model": "AMAROK CD2.0 16V\/S CD2.0 16V TDI 4x2 Die",
			"years": "2011 a 2013"
		},
}

# Buscar Histórico Fipe

Neste endpoint é possível buscar o histórico de preço de um veículo.


Os parâmetros {fipe_code}/{year_id} são dos endpoints:
/api/fipe/modelo/
api/fipe/ano-preco/


# Requisição GET

# URL https://app.apiintegra.com/api/fipe/ano-preco-historico/{fipe_code}/{year_id}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/fipe/ano-preco-historico/{fipe_code}/{year_id}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": {
		"brand": "VW - VolksWagen",
		"model": "CROSSFOX 1.6 Mi Total Flex 8V 5p",
		"model_year": "2006",
		"fuel": "Gasolina",
		"history": [
			{
				"month": "2024-07",
				"price": 26929
			},
			{
				"month": "2024-06",
				"price": 26948
			},
          
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Status Sefaz

Neste endpoint é possível consultar os Status dos servidores Sefaz. As informações são divididas por UF.


# Requisição GET

# URL https://app.apiintegra.com/api/sefaz

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/sefaz
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": {
		"data": [
			{
				"autorizador": "AM",
				"autorizacao4": "active",
				"retornoautorizacao4": "active",
				"inutilizacao4": "active",
				"consultaprotocolo4": "active",
				"statusservico4": "active",
				"tempomedio": "-",
				"consultacadastro4": "",
				"recepcaoevento4": "active"
			},
			{
				"autorizador": "BA",
				"autorizacao4": "active",
				"retornoautorizacao4": "active",
				"inutilizacao4": "active",
				"consultaprotocolo4": "active",
				"statusservico4": "active",
				"tempomedio": "-",
				"consultacadastro4": "active",
				"recepcaoevento4": "active"
			},
			{
				"autorizador": "GO",
				"autorizacao4": "active",
				"retornoautorizacao4": "active",
				"inutilizacao4": "active",
				"consultaprotocolo4": "active",
				"statusservico4": "active",
				"tempomedio": "-",
				"consultacadastro4": "active",
				"recepcaoevento4": "active"
			},
			{
				"autorizador": "MG",
				"autorizacao4": "active",
				"retornoautorizacao4": "active",
				"inutilizacao4": "active",
				"consultaprotocolo4": "active",
				"statusservico4": "active",
				"tempomedio": "-",
				"consultacadastro4": "active",
				"recepcaoevento4": "active"
			},
			{
				"autorizador": "MS",
				"autorizacao4": "active",
				"retornoautorizacao4": "active",
				"inutilizacao4": "active",
				"consultaprotocolo4": "active",
				"statusservico4": "active",
				"tempomedio": "-",
				"consultacadastro4": "active",
				"recepcaoevento4": "active"
			},
			{
				"autorizador": "MT",
				"autorizacao4": "active",
				"retornoautorizacao4": "active",
				"inutilizacao4": "active",
				"consultaprotocolo4": "active",
				"statusservico4": "active",
				"tempomedio": "-",
				"consultacadastro4": "active",
				"recepcaoevento4": "active"
			},
			{
				"autorizador": "PE",
				"autorizacao4": "active",
				"retornoautorizacao4": "active",
				"inutilizacao4": "active",
				"consultaprotocolo4": "active",
				"statusservico4": "active",
				"tempomedio": "-",
				"consultacadastro4": "active",
				"recepcaoevento4": "active"
			},
			{
				"autorizador": "PR",
				"autorizacao4": "active",
				"retornoautorizacao4": "active",
				"inutilizacao4": "active",
				"consultaprotocolo4": "active",
				"statusservico4": "active",
				"tempomedio": "-",
				"consultacadastro4": "active",
				"recepcaoevento4": "active"
			},
			{
				"autorizador": "RS",
				"autorizacao4": "active",
				"retornoautorizacao4": "active",
				"inutilizacao4": "active",
				"consultaprotocolo4": "active",
				"statusservico4": "active",
				"tempomedio": "-",
				"consultacadastro4": "active",
				"recepcaoevento4": "active"
			},
			{
				"autorizador": "SP",
				"autorizacao4": "active",
				"retornoautorizacao4": "active",
				"inutilizacao4": "active",
				"consultaprotocolo4": "active",
				"statusservico4": "active",
				"tempomedio": "-",
				"consultacadastro4": "active",
				"recepcaoevento4": "active"
			},
			{
				"autorizador": "SVAN",
				"autorizacao4": "active",
				"retornoautorizacao4": "active",
				"inutilizacao4": "active",
				"consultaprotocolo4": "active",
				"statusservico4": "active",
				"tempomedio": "-",
				"consultacadastro4": "",
				"recepcaoevento4": "active"
			},
			{
				"autorizador": "SVRS",
				"autorizacao4": "active",
				"retornoautorizacao4": "active",
				"inutilizacao4": "active",
				"consultaprotocolo4": "active",
				"statusservico4": "active",
				"tempomedio": "-",
				"consultacadastro4": "active",
				"recepcaoevento4": "active"
			},
			{
				"autorizador": "SVC-AN",
				"autorizacao4": "active",
				"retornoautorizacao4": "active",
				"inutilizacao4": "active",
				"consultaprotocolo4": "active",
				"statusservico4": "active",
				"tempomedio": "-",
				"consultacadastro4": "",
				"recepcaoevento4": "active"
			},
			{
				"autorizador": "SVC-RS",
				"autorizacao4": "active",
				"retornoautorizacao4": "active",
				"inutilizacao4": "",
				"consultaprotocolo4": "active",
				"statusservico4": "active",
				"tempomedio": "-",
				"consultacadastro4": "",
				"recepcaoevento4": "active"
			}
		]
	}
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Câmbio Atualizado

Neste endpoint é possível buscar a taxa de Câmbio atualizadas.


# Requisição GET

# URL https://app.apiintegra.com/api/cambio

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/cambio
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": {
		"USD": 1,
		"AED": 3.67,
		"AFN": 70.89,
		"ALL": 92.07,
		"AMD": 387.93,
		"ANG": 1.79,
		"AOA": 883.5,
		"ARS": 923.5,
		"AUD": 1.49,
		"AWG": 1.79,
		"AZN": 1.7,
		"BAM": 1.8,
		"BBD": 2,
		"BDT": 117.54,
		"BGN": 1.79,
		"BHD": 0.376,
		"BIF": 2874.1,
		"BMD": 1,
		"BND": 1.34,
		"BOB": 6.92,
		"BRL": 5.43,
		"BSD": 1,
		"BTN": 83.58,
		"BWP": 13.51,
		"BYN": 3.27,
		"BZD": 2,
		"CAD": 1.37,
		"CDF": 2830.89,
		"CHF": 0.894,
		"CLP": 909.4,
		"CNY": 7.28,
		"COP": 3959.27,
		"CRC": 522.53,
		"CUP": 24,
		"CVE": 101.2,
		"CZK": 23.25,
		"DJF": 177.72,
		"DKK": 6.85,
		"DOP": 59.15,
		"DZD": 134.37,
		"EGP": 48.03,
		"ERN": 15,
		"ETB": 57.87,
		"EUR": 0.918,
		"FJD": 2.23,
		"FKP": 0.771,
		"FOK": 6.85,
		"GBP": 0.771,
		"GEL": 2.7,
		"GGP": 0.771,
		"GHS": 15.49,
		"GIP": 0.771,
		"GMD": 64.87,
		"GNF": 8665.77,
		"GTQ": 7.75,
		"GYD": 209.24,
		"HKD": 7.81,
		"HNL": 24.75,
		"HRK": 6.92,
		"HTG": 131.87,
		"HUF": 359.72,
		"IDR": 16160.97,
		"ILS": 3.62,
		"IMP": 0.771,
		"INR": 83.58,
		"IQD": 1312.01,
		"IRR": 42084.41,
		"ISK": 137.01,
		"JEP": 0.771,
		"JMD": 156.47,
		"JOD": 0.709,
		"JPY": 158.4,
		"KES": 129.6,
		"KGS": 85.65,
		"KHR": 4130.83,
		"KID": 1.49,
		"KMF": 451.53,
		"KRW": 1383.14,
		"KWD": 0.306,
		"KYD": 0.833,
		"KZT": 474.65,
		"LAK": 21948.37,
		"LBP": 89500,
		"LKR": 302.89,
		"LRD": 195.09,
		"LSL": 18.07,
		"LYD": 4.83,
		"MAD": 9.83,
		"MDL": 17.69,
		"MGA": 4495.74,
		"MKD": 56.39,
		"MMK": 2095.75,
		"MNT": 3379.94,
		"MOP": 8.04,
		"MRU": 39.76,
		"MUR": 46.59,
		"MVR": 15.43,
		"MWK": 1744.85,
		"MXN": 17.68,
		"MYR": 4.68,
		"MZN": 63.91,
		"NAD": 18.07,
		"NGN": 1583.98,
		"NIO": 36.83,
		"NOK": 10.8,
		"NPR": 133.72,
		"NZD": 1.65,
		"OMR": 0.384,
		"PAB": 1,
		"PEN": 3.72,
		"PGK": 3.86,
		"PHP": 58.4,
		"PKR": 278.56,
		"PLN": 3.93,
		"PYG": 7486.3,
		"QAR": 3.64,
		"RON": 4.56,
		"RSD": 107.46,
		"RUB": 88.29,
		"RWF": 1313.25,
		"SAR": 3.75,
		"SBD": 8.5,
		"SCR": 13.84,
		"SDG": 449.15,
		"SEK": 10.6,
		"SGD": 1.34,
		"SHP": 0.771,
		"SLE": 23.5,
		"SLL": 23504.72,
		"SOS": 571.41,
		"SRD": 29.8,
		"SSP": 2193.74,
		"STN": 22.49,
		"SYP": 12862.15,
		"SZL": 18.07,
		"THB": 36.05,
		"TJS": 10.67,
		"TMT": 3.5,
		"TND": 3.11,
		"TOP": 2.33,
		"TRY": 33.06,
		"TTD": 6.73,
		"TVD": 1.49,
		"TWD": 32.58,
		"TZS": 2663.33,
		"UAH": 41.27,
		"UGX": 3690.31,
		"UYU": 40.11,
		"UZS": 12669.51,
		"VES": 36.51,
		"VND": 25393.81,
		"VUV": 118.6,
		"WST": 2.73,
		"XAF": 602.04,
		"XCD": 2.7,
		"XDR": 0.754,
		"XOF": 602.04,
		"XPF": 109.52,
		"YER": 250.15,
		"ZAR": 18.07,
		"ZMW": 25.91,
		"ZWL": 13.76
	}
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Enviar Doc p/ Impressão

Neste endpoint é possível enviar documentos PDF p/ impressão no servidor de Impressão previamente configurado na maquina local.

O arquivo deve ser enviado em base64.


base64arquivo deve ser convertido p/ base64. São aceitos somente arquivos PDF. Nenhum outro formato será possível a impressão.
printernome da impressora local p/ impressão. A impressora deve estar previamente instalada e configurada na maquina local. O servidor de impressão busca a impressora pelo nome.
devicecódigo do dispositivo a receber a impressão. Este código deve ser o mesmo previamente configurado no servidor de impressão na maquina local.



# Requisição POST

# URL https://app.apiintegra.com/api/printer

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/printer
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
	"base64": "base64",
	"printer": "PREVENDA",
	"device": "1"
}

return JSON


{
	"return": true,
	"message": "Print job saved successfully",
	"data": {
		"base64": "",
		"printer": "PREVENDA",
		"device": "1",
		"updated_at": "2024-07-17T21:25:46.000000Z",
		"created_at": "2024-07-17T21:25:46.000000Z",
		"id": 57
	}
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Tributos x Esferas

Neste endpoint é possível buscar tipos de impostos por esfera:


federalmunicipalestadual



# Requisição GET

# URL https://app.apiintegra.com/api/tributo_esfera/{esfera}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/tributo_esfera/{esfera}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": [
		{
			"Nome": "CIDE",
			"Esfera": "Federal",
			"Parametro": "cide",
			"Tributos": null
		},
		{
			"Nome": "COFINS",
			"Esfera": "Federal",
			"Parametro": "cofins",
			"Tributos": null
		},
      ]
}

# Consultar Imposto x UF x Município

Neste endpoint é possível buscar o total de impostos por UF/Município.


# Requisição POST

# URL https://app.apiintegra.com/api/imposto

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/imposto
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
	"uf":"sp",
	"mun":"sao-paulo",
	"dataINI":"01/01/2024",
	"dataFIN":"19/07/2024"
}

return JSON


{
	"return": true,
	"data": {
		"Valor": 42649692.26807616,
		"Incremento": 2.442213050179113,
		"Data": "2024-07-19T15:07:33.8970000",
		"Midnight": "2024-07-19T00:00:00.0000000"
	}
}

# Arrecadação x Tributo

Neste endpoint é possível buscar o total arrecadado pela esfera x tributo:

Esferas:

estadualmunicipalfederal

Tributos Federais:

cidecofinscpmfcsllfgtsfundafieii
iofipiiritroutrospis-pasepprevidenciataxas

Tributos Estaduais:

icmsipvairitcmdoutrosprevidenciataxas

Tributos Municipais:

iptuissitbioutrostaxas



# Requisição POST

# URL https://app.apiintegra.com/api/arrecadacao_tributo

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/arrecadacao_tributo
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
	"esfera":"estadual",
	"tributo":"icms",
	"dataINI":"01/01/2024",
	"dataFIN":"19/07/2024"
}

return JSON


{
	"return": true,
	"data": {
		"Valor": 399234899303.6417,
		"Incremento": 22861.048446441226,
		"Data": "2024-07-19T15:08:35.2930000",
		"Midnight": "2024-07-19T00:00:00.0000000"
	}
}

# Tabela IBPT

Neste endpoint é possível listar/buscar informações da tabela IBPT.
Caso deseje buscar um índice especifico, pode passar o código como parâmetro.


# Requisição GET

# URL https://app.apiintegra.com/api/ibpt/{codigo}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/ibpt/{codigo}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": [
		{
			"codigo": 1012100,
			"ex": null,
			"tipo": 0,
			"descricao": "Cavalos reprodutores,de raca pura",
			"nacionalfederal": 13.45,
			"importadosfederal": 15.45,
			"estadual": 18,
			"municipal": 0,
			"vigenciainicio": "20\/05\/2024",
			"vigenciafim": "30\/06\/2024",
			"chave": "691A69",
			"versao": "24.1.E"
		}
	]
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Buscar Municípios

Neste endpoint é possível buscar todas cidades das UF informadas


# Requisição GET

# URL https://app.apiintegra.com/api/cidades/{uf}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/cidades/{uf}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": [
		{
			"Id": 0,
			"Cidade": null,
			"Nome": "ADAMANTINA",
			"Parametro": "adamantina",
			"UF": "SP",
			"Municipios": null
		},
		{
			"Id": 0,
			"Cidade": null,
			"Nome": "ADOLFO",
			"Parametro": "adolfo",
			"UF": "SP",
			"Municipios": null
		},
      ]
}

# Estatísticas UF

Neste endpoint é possível buscas dados adicionais de cada estado.

Código de cada Estado:

Acre:12Alagoas:27Amapá:16Amazonas:13Bahia:29Ceará:23Distrito Federal:53Espírito Santo:32Goiás:52
Maranhão:21Mato Grosso:51Minas Gerais:31Pará:15Paraíba:25Paraná:41Pernambuco:26Piauí:22Rio de Janeiro:33
Rio Grande do Norte:24Rio Grande do Sul:43Rondônia:11Roraima:14Santa Catarina:42Sergipe:28São Paulo:35Tocantis:17Mato Grosso do Sul:50



# Requisição GET

# URL https://app.apiintegra.com/api/estatistica_uf/{idEstado}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/estatistica_uf/{idEstado}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": {
		"QuantidadeEmpresas": 130928,
		"QuantidadeEmpresasMEI": 38009,
		"QuantidadeEmpresas_Brasil": 18438645,
		"QuantidadeEmpresasMEI_Brasil": 5622691,
		"EmpresasRelativoEstadoBrasil": 0.71007386931,
		"EmpresasMEIRelativoEstadoBrasil": 0.675993043188,
		"Populacao": 1748531,
		"Populacao_Brasil": 202758031,
		"PopulacaoRelativoEstadoBrasil": 0.862373239361
	}
}

# Introdução

Para realizar o consumo de qualquer recurso da API, é necessário que realize a autenticação, utilizando X-Token Authentication ou Bearer token Authentication. Nela irá enviar um Header, com key: X-Token ou Bearer e value: {TOKEN}.

Na documentação primeiro é mostrado a URL para enviar a requisição, abaixo sempre terá um código mostrando o body com o padrão que tem que ser enviado/recebido, se houver sucesso nessa requisição retorna um response com status 200. Segue o exemplo abaixo de outros HTTPs Requests/Responses.

# Allowed HTTPs Requests

POST      - Criar um registro
PUT        - Atualizar um registro (parcial/total)
DELETE   - Deletar um registro
GET        - Buscar um ou mais registros


# Header Responses

200 - Sucesso
201 - Criado
204 - Sem conteúdo
401 - Sem autorização
403 - Acesso negado
404 - Not found
500 - Internal server Error: {message}

Exemplo: 


{
    "status": 500,
    "message": "Internal Server Error: Nao foi possivel conectar ao Servidor Cliente"
}

{
    "status": 404,
    "message": "Route Not found"
}

OBS: Nem todos EndPoint´s utilizam todos HTTPs Requests. Alguns utilizam apenas GET, POST Etc...

# Enviar NFE/NFCe

Neste endpoint é possivel gerar, validar e enviar um NFe e NFCe.

1. Campo cnpj

  • Descrição: CNPJ da empresa emissora da nota fiscal.
  • Tipo: String
  • Exemplo: "03274481000111"
  • Observações: O CNPJ deve ter 14 dígitos, sem separadores como pontos, barras ou hífens.

2. Campo tpAmb

  • Descrição: Tipo de ambiente para a emissão da NF-e.
  • Tipo: Integer
  • Exemplo: 2
  • Observações: Os valores possíveis são:
    • 1 - Produção
    • 2 - Homologação (ambiente de testes)

3. Objeto emitente

  • Descrição: Dados do emitente (empresa que emite a nota fiscal).
  • Campos:
    • razaosocial: Nome completo da empresa.
      • Tipo: String
      • Exemplo: "Empresa Teste LTDA"
    • fantasia: Nome fantasia da empresa.
      • Tipo: String
      • Exemplo: "Empresa Teste"
    • ie: Inscrição Estadual da empresa.
      • Tipo: String
      • Exemplo: "131886983"
    • crt: Código de Regime Tributário.
      • Tipo: String
      • Exemplo: "3"
      • Observações: Os valores possíveis são:
        • 1 - Simples Nacional
        • 2 - Simples Nacional - Excesso de sublimite de receita bruta
        • 3 - Regime Normal
    • cnpj: CNPJ da empresa.
      • Tipo: String
      • Exemplo: "03274481000111"
    • logradouro: Nome da rua ou avenida.
      • Tipo: String
      • Exemplo: "R PRESIDENTE TANCREDO NEVES"
    • numero: Número do endereço.
      • Tipo: String
      • Exemplo: "3517"
    • bairro: Bairro do endereço.
      • Tipo: String
      • Exemplo: "CENTRO"
    • codigo_municipio: Código do município segundo o IBGE.
      • Tipo: String
      • Exemplo: "5105622"
    • municipio: Nome do município.
      • Tipo: String
      • Exemplo: "MIRASSOL D'OESTE"
    • uf: Sigla da Unidade Federativa (estado).
      • Tipo: String
      • Exemplo: "MT"
    • cep: Código Postal (CEP).
      • Tipo: String
      • Exemplo: "78280000"

4. Objeto destinatario

  • Descrição: Dados do destinatário (cliente ou empresa que recebe a mercadoria).
  • Campos:
    • indIEDest: Indicador da IE do destinatário.
      • Tipo: String
      • Exemplo: "1"
      • Observações: Os valores possíveis são:
        • 1 - Contribuinte ICMS
        • 2 - Contribuinte isento de inscrição
        • 9 - Não contribuinte
    • nome: Nome do destinatário.
      • Tipo: String
      • Exemplo: "Cliente Teste"
    • ie: Inscrição Estadual do destinatário.
      • Tipo: String
      • Exemplo: "131886983"
    • cnpj: CNPJ do destinatário.
      • Tipo: String
      • Exemplo: "03274481000111"
    • logradouro: Nome da rua ou avenida.
      • Tipo: String
      • Exemplo: "Av. Exemplo"
    • numero: Número do endereço.
      • Tipo: String
      • Exemplo: "100"
    • bairro: Bairro do endereço.
      • Tipo: String
      • Exemplo: "Bairro Exemplo"
    • codigo_municipio: Código do município segundo o IBGE.
      • Tipo: String
      • Exemplo: "5105622"
    • municipio: Nome do município.
      • Tipo: String
      • Exemplo: "MIRASSOL D'OESTE"
    • uf: Sigla da Unidade Federativa (estado).
      • Tipo: String
      • Exemplo: "MT"
    • cep: Código Postal (CEP).
      • Tipo: String
      • Exemplo: "76907878"

5. Array produtos

  • Descrição: Lista de produtos incluídos na nota fiscal.
  • Campos:

    • codigo: Código do produto.

      • Tipo: String
      • Exemplo: "001"

    • descricao: Descrição do produto.

      • Tipo: String
      • Exemplo: "Produto 1"

    • ncm: Código NCM (Nomenclatura Comum do Mercosul) do produto.

      • Tipo: String
      • Exemplo: "84099115"

    • cfop: Código Fiscal de Operações e Prestações.

      • Tipo: String
      • Exemplo: "5102"

    • unidade: Unidade de medida do produto.

      • Tipo: String
      • Exemplo: "UN"

    • quantidade: Quantidade do produto.

      • Tipo: String
      • Exemplo: "10"

    • valor_unitario: Valor unitário do produto.

      • Tipo: String
      • Exemplo: "10.00"

    • valor_total: Valor total do produto.

      • Tipo: String
      • Exemplo: "100.00"

    • cean: Código EAN do produto.

      • Tipo: String
      • Exemplo: "SEM GTIN"

    • indtot: Indica se o valor do item (produto) compõe o valor total da NF-e.

      • Tipo: String
      • Exemplo: "1"
      • Observações: 1 para sim, 0 para não.

    • Objeto imposto:

      • vTotTrib: Valor total dos tributos.
        • Tipo: String
        • Exemplo: "0.00"
      • Objeto icms:
        • orig: Origem da mercadoria.
          • Tipo: String
          • Exemplo: "0"
          • Observações: 0 para Nacional, 1 para Estrangeira - importação direta, etc.
        • CST: Código da Situação Tributária do ICMS.
          • Tipo: String
          • Exemplo: "00"
        • modBC: Modalidade de determinação da base de cálculo do ICMS.
          • Tipo: String
          • Exemplo: "3"
        • vBC: Valor da base de cálculo do ICMS.
          • Tipo: String
          • Exemplo: "0.00"
        • pICMS: Alíquota do ICMS.
          • Tipo: String
          • Exemplo: "0.00"
        • vICMS: Valor do ICMS.
          • Tipo: String
          • Exemplo: "0.00"
      • Objeto ipi:
        • cEnq: Código de enquadramento legal do IPI.
          • Tipo: String
          • Exemplo: "999"
        • CST: Código da Situação Tributária do IPI.
          • Tipo: String
          • Exemplo: "50"
        • vBC: Valor da base de cálculo do IPI.
          • Tipo: String
          • Exemplo: "0.00"
        • pIPI: Alíquota do IPI.
          • Tipo: String
          • Exemplo: "0.00"
        • vIPI: Valor do IPI.
          • Tipo: String
          • Exemplo: "0.00"
      • Objeto pis:
        • CST: Código da Situação Tributária do PIS.
          • Tipo: String
          • Exemplo: "01"
        • vBC: Valor da base de cálculo do PIS.
          • Tipo: String
          • Exemplo: "0.00"
        • pPIS: Alíquota do PIS.
          • Tipo: String
          • Exemplo: "0.00"
        • vPIS: Valor do PIS.
          • Tipo: String
          • Exemplo: "0.00"
      • Objeto cofins:
        • CST: Código da Situação Tributária do COFINS.
          • Tipo: String
          • Exemplo: "01"
        • vBC: Valor da base de cálculo do COFINS.
          • Tipo: String
          • Exemplo: "0.00"
        • pCOFINS: Alíquota do COFINS.
          • Tipo: String
          • Exemplo: "0.00"
        • vCOFINS: Valor do COFINS.
          • Tipo: String
          • Exemplo: "0.00"

6. Objeto totais

  • Descrição: Valores totais da nota fiscal.
  • Campos:
    • vBC: Valor da base de cálculo do ICMS.
      • Tipo: String
      • Exemplo: "0.00"
    • vICMS: Valor do ICMS.
      • Tipo: String
      • Exemplo: "0.00"
    • vICMSDeson: Valor do ICMS desonerado.
      • Tipo: String
      • Exemplo: "0.00"
    • vFCP: Valor do Fundo de Combate à Pobreza.
      • Tipo: String
      • Exemplo: "0.00"
    • vBCST: Valor da base de cálculo do ICMS ST (Substituição Tributária).
      • Tipo: String
      • Exemplo: "0.00"
    • vST: Valor do ICMS ST.
      • Tipo: String
      • Exemplo: "0.00"
    • vFCPST: Valor do FCP sobre o ICMS ST.
      • Tipo: String
      • Exemplo: "0.00"
    • vFCPSTRet: Valor do FCP retido por ST.
      • Tipo: String
      • Exemplo: "0.00"
    • vProd: Valor total dos produtos.
      • Tipo: String
      • Exemplo: "200.00"
    • vFrete: Valor do frete.
      • Tipo: String
      • Exemplo: "0.00"
    • vSeg: Valor do seguro.
      • Tipo: String
      • Exemplo: "0.00"
    • vDesc: Valor do desconto.
      • Tipo: String
      • Exemplo: "0.00"
    • vII: Valor do Imposto de Importação.
      • Tipo: String
      • Exemplo: "0.00"
    • vIPI: Valor do IPI.
      • Tipo: String
      • Exemplo: "0.00"
    • vIPIDevol: Valor do IPI devolvido.
      • Tipo: String
      • Exemplo: "0.00"
    • vPIS: Valor do PIS.
      • Tipo: String
      • Exemplo: "0.00"
    • vCOFINS: Valor do COFINS.
      • Tipo: String
      • Exemplo: "0.00"
    • vOutro: Valor de outras despesas acessórias.
      • Tipo: String
      • Exemplo: "0.00"
    • vNF: Valor total da NF-e.
      • Tipo: String
      • Exemplo: "200.00"
    • vTotTrib: Valor total dos tributos.
      • Tipo: String
      • Exemplo: "0.00"

7. Objeto ide

  • Descrição: Informações de identificação da NF-e.
  • Campos:
    • natOp: Natureza da operação.
      • Tipo: String
      • Exemplo: "VENDA DE MERCADORIA"
    • mod: Modelo do documento fiscal.
      • Tipo: String
      • Exemplo: "55"
      • Observações: 55 para NF-e e 65 para NFC-e.
    • serie: Série do documento fiscal.
      • Tipo: String
      • Exemplo: "1"
    • nNF: Número da nota fiscal.
      • Tipo: String
      • Exemplo: "25"
    • tpNF: Tipo de operação.
      • Tipo: String
      • Exemplo: "1"
      • Observações: 0 para entrada, 1 para saída.
    • idDest: Identificador de destino da operação.
      • Tipo: String
      • Exemplo: "1"
      • Observações: 1 para operação interna, 2 para interestadual, 3 para exterior.
    • indFinal: Indicador de operação com consumidor final.
      • Tipo: String
      • Exemplo: "1"
      • Observações: 0 para não, 1 para sim.
    • indPres: Indicador de presença do comprador.
      • Tipo: String
      • Exemplo: "1"
      • Observações: 0 para não aplicável, 1 para operação presencial, etc.
    • finNFe: Finalidade da emissão da NF-e.
      • Tipo: String
      • Exemplo: "1"
      • Observações: 1 para nota normal, 2 para complementar, 3 para ajuste, 4 para devolução.
    • tPag: Forma de pagamento.
      • Tipo: String
      • Exemplo: "01"
      • Observações: 01 para dinheiro, 02 para cheque, 03 para cartão de crédito, etc.
    • chaveNFe: Chave de acesso da NF-e (pode ser gerada automaticamente).
      • Tipo: String
      • Exemplo: ""
    • NFref: Referência a outras NF-e (pode ser vazio se não houver).
      • Tipo: String
      • Exemplo: ""
    • tpImp: Tipo de impressão do DANFE.
      • Tipo: String
      • Exemplo: "0"
      • Observações: 0 para retrato, 1 para paisagem, etc.
    • modFrete: Modalidade do frete.
      • Tipo: String
      • Exemplo: "0"
      • Observações: 0 para sem frete, 1 para por conta do remetente, etc.
    • indPag: Indicador de pagamento.
      • Tipo: String
      • Exemplo: "0"
      • Observações: 0 para pagamento à vista, 1 para à prazo, 2 para outros.
    • tpEmis: Tipo de emissão da NF-e.
      • Tipo: String
      • Exemplo: "1"
      • Observações: 1 para emissão normal, 2 para contingência em formulário de segurança, etc.


# Requisição GET

# URL https://app.apiintegra.com/api/sendNFe

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/sendNFe
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
  "cnpj": "03274481000111",
  "tpAmb": 2,
  "emitente": {
    "razaosocial": "Empresa Teste LTDA",
    "fantasia": "Empresa Teste",
    "ie": "131886983",
    "crt": "3",
    "cnpj": "03274481000111",
    "logradouro": "R PRESIDENTE TANCREDO NEVES",
    "numero": "3517",
    "bairro": "CENTRO",
    "codigo_municipio": "5105622",
    "municipio": "MIRASSOL D'OESTE",
    "uf": "MT",
    "cep": "78280000"
  },
  "destinatario": {
		"indIEDest": "1",
    "nome": "Cliente Teste",
    "ie": "131886983",
    "cnpj": "03274481000111",
    "logradouro": "Av. Exemplo",
    "numero": "100",
    "bairro": "Bairro Exemplo",
    "codigo_municipio": "5105622",
    "municipio": "MIRASSOL D'OESTE",
    "uf": "MT",
    "cep": "76907878"
  },
  "produtos": [
    {
      "codigo": "001",
      "descricao": "Produto 1",
      "ncm": "84099115",
      "cfop": "5102",
      "unidade": "UN",
      "quantidade": "10",
      "valor_unitario": "10.00",
      "valor_total": "100.00",
			"cean": "SEM GTIN",
			"indtot": "1",
      "imposto": {
        "vTotTrib": "0.00",
        "icms": {
          "orig": "0",
          "CST": "00",
          "modBC": "3",
          "vBC": "0.00",
          "pICMS": "0.00",
          "vICMS": "0.00"
        },
        "ipi": {
          "cEnq": "999",
          "CST": "50",
          "vBC": "0.00",
          "pIPI": "0.00",
          "vIPI": "0.00"
        },
        "pis": {
          "CST": "01",
          "vBC": "0.00",
          "pPIS": "0.00",
          "vPIS": "0.00"
        },
        "cofins": {
          "CST": "01",
          "vBC": "0.00",
          "pCOFINS": "0.00",
          "vCOFINS": "0.00"
        }
      }
    },
    {
      "codigo": "002",
      "descricao": "Produto 2",
      "ncm": "84099115",
      "cfop": "5102",
      "unidade": "UN",
      "quantidade": "5",
      "valor_unitario": "20.00",
      "valor_total": "100.00",
			"cean": "SEM GTIN",
			"indtot": "1",
      "imposto": {
        "vTotTrib": "0.00",
        "icms": {
          "orig": "0",
          "CST": "00",
          "modBC": "3",
          "vBC": "0.00",
          "pICMS": "0.00",
          "vICMS": "0.00"
        },
        "ipi": {
          "cEnq": "999",
          "CST": "50",
          "vBC": "0.00",
          "pIPI": "0.00",
          "vIPI": "0.00"
        },
        "pis": {
          "CST": "01",
          "vBC": "0.00",
          "pPIS": "0.00",
          "vPIS": "0.00"
        },
        "cofins": {
          "CST": "01",
          "vBC": "0.00",
          "pCOFINS": "0.00",
          "vCOFINS": "0.00"
        }
      }
    }
  ],
  "totais": {
    "vBC": "0.00",
    "vICMS": "0.00",
    "vICMSDeson": "0.00",
    "vFCP": "0.00",
    "vBCST": "0.00",
    "vST": "0.00",
    "vFCPST": "0.00",
    "vFCPSTRet": "0.00",
    "vProd": "200.00",
    "vFrete": "0.00",
    "vSeg": "0.00",
    "vDesc": "0.00",
    "vII": "0.00",
    "vIPI": "0.00",
    "vIPIDevol": "0.00",
    "vPIS": "0.00",
    "vCOFINS": "0.00",
    "vOutro": "0.00",
    "vTotTrib": "0.00",
    "vNF": "200.00"
  },
  "ide": {
    "natOp": "VENDA DE MERCADORIA",
    "mod": "55",
    "serie": "1",
    "nNF": "25",
    "tpNF": "1",
    "idDest": "1",
    "indFinal": "1",
    "indPres": "1",
		"finNFe":"1",
		"tPag":"01",
		"chaveNFe":"",
		"NFref":"",
		"tpImp":"0",
		"modFrete":"0",
		"indPag":"0",
		"tpEmis":"1"
  }
}

return JSON


{
	"sendNFe": {
		"attributes": {
			"versao": "4.00"
		},
		"tpAmb": "2",
		"verAplic": "MT_A2RL-4.00",
		"nRec": "510000038319786",
		"cStat": "105",
		"xMotivo": "Lote em processamento",
		"cUF": "51",
		"dhRecbto": "2024-08-23T10:53:55-04:00"
	},
	"chaveNFe": "51240803274481000111550010000000261191468816",
	"xml": "base64"
}

# Cancelar NFe

Neste endpoint é possível Cancelar uma NFe validada.

1. Campo cnpj

  • Descrição: CNPJ da empresa emitente da NF-e.
  • Tipo: String
  • Exemplo: "03274481000111"
  • Observações: Deve ter 14 dígitos, sem separadores como pontos, barras ou hífens.

2. Campo chaveNFe

  • Descrição: Chave de acesso da NF-e que será cancelada.
  • Tipo: String
  • Exemplo: "51240803274481000111550010000000241200050853"
  • Observações: A chave de acesso é um identificador único de 44 dígitos que representa a NF-e. Ela é composta pelo código da UF, ano e mês de emissão, CNPJ do emitente, modelo, série, número da NF-e, código numérico e dígito verificador.

3. Campo nProt

  • Descrição: Número do Protocolo de Autorização da NF-e.
  • Tipo: String
  • Exemplo: "151240000320847"
  • Observações: Esse é o número do protocolo que foi recebido quando a NF-e foi autorizada. Ele é necessário para realizar o cancelamento.

4. Campo xJust

  • Descrição: Justificativa para o cancelamento da NF-e.
  • Tipo: String
  • Exemplo: "Cancelamento solicitado pelo cliente"
  • Observações: A justificativa deve ter no mínimo 15 e no máximo 255 caracteres, e deve ser clara o suficiente para justificar o cancelamento.

5. Campo tpAmb

  • Descrição: Tipo de ambiente no qual a NF-e está sendo cancelada.
  • Tipo: Integer
  • Exemplo: 2
  • Observações: Os valores possíveis são:
    • 1 - Produção
    • 2 - Homologação (ambiente de testes)


# Requisição POST

# URL https://app.apiintegra.com/api/cancelarNFe

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/cancelarNFe
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
  "cnpj": "03274481000111",
  "chaveNFe": "51240803274481000111550010000000241200050853",
  "nProt": "151240000320847",
  "xJust": "Cancelamento solicitado pelo cliente",
  "tpAmb": 2
}

return JSON


{
	"attributes": {
		"versao": "1.00"
	},
	"idLote": "202408230850487",
	"tpAmb": "2",
	"verAplic": "MT_A2RL-4.00",
	"cOrgao": "51",
	"cStat": "128",
	"xMotivo": "Lote de Evento Processado",
	"retEvento": {
		"attributes": {
			"versao": "1.00"
		},
		"infEvento": {
			"tpAmb": "2",
			"verAplic": "MT_A2RL-4.00",
			"cOrgao": "51",
			"cStat": "573",
			"xMotivo": "Rejeicao: Duplicidade de Evento",
			"chNFe": "51240803274481000111550010000000241200050853",
			"tpEvento": "110111",
			"nSeqEvento": "1",
			"dhRegEvento": "2024-08-23T08:49:41-04:00"
		}
	}
}

# Inutilizar NFe

Neste endpoint é possível Inutilizar uma numeração NFe.

1. Campo cnpj

  • Descrição: CNPJ da empresa emitente das NF-e que serão inutilizadas.
  • Tipo: String
  • Exemplo: "03274481000111"
  • Observações: Deve ter 14 dígitos, sem separadores como pontos, barras ou hífens.

2. Campo serie

  • Descrição: Série das NF-e que serão inutilizadas.
  • Tipo: Integer
  • Exemplo: 1
  • Observações: A série é um identificador numérico para organizar as notas fiscais emitidas. Normalmente, varia de 1 a 999.

3. Campo nNFIni

  • Descrição: Número inicial da faixa de numeração das NF-e que serão inutilizadas.
  • Tipo: Integer
  • Exemplo: 7
  • Observações: Este é o número da primeira NF-e dentro da faixa de numeração que será inutilizada. A inutilização é feita para informar à SEFAZ que determinadas numerações não serão mais utilizadas, evitando assim buracos na sequência.

4. Campo nNFFin

  • Descrição: Número final da faixa de numeração das NF-e que serão inutilizadas.
  • Tipo: Integer
  • Exemplo: 7
  • Observações: Este é o número da última NF-e dentro da faixa de numeração que será inutilizada. Se apenas uma nota fiscal será inutilizada, nNFIni e nNFFin terão o mesmo valor.

5. Campo xJust

  • Descrição: Justificativa para a inutilização da faixa de numeração das NF-e.
  • Tipo: String
  • Exemplo: "Falha no sistema que gerou numeração incorreta"
  • Observações: A justificativa deve ter no mínimo 15 e no máximo 255 caracteres, e deve explicar claramente o motivo pelo qual a numeração está sendo inutilizada.

6. Campo tpAmb

  • Descrição: Tipo de ambiente no qual a inutilização será realizada.
  • Tipo: Integer
  • Exemplo: 2
  • Observações: Os valores possíveis são:
    • 1 - Produção
    • 2 - Homologação (ambiente de testes)


# Requisição POST

# URL https://app.apiintegra.com/api/inutilizarNFe

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/inutilizarNFe
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
  "cnpj": "03274481000111",
  "serie": 1,
  "nNFIni": 7,
  "nNFFin": 7,
  "xJust": "Falha no sistema que gerou numeração incorreta",
  "tpAmb": 2
}

return JSON


{
	"attributes": {
		"versao": "4.00"
	},
	"infInut": {
		"tpAmb": "2",
		"verAplic": "MT_A2RL-4.00",
		"cStat": "241",
		"xMotivo": "Rejeicao: Um numero da faixa ja foi utilizado",
		"cUF": "51",
		"dhRecbto": "2024-08-22T09:20:36-04:00"
	}
}

# Carta de Correção NFe

Neste endpoint é possível enviar uma Carta de correção p/ uma determinada NFe.


1. Campo cnpj

  • Descrição: CNPJ da empresa emitente da NF-e que será corrigida.
  • Tipo: String
  • Exemplo: "03274481000111"
  • Observações: Deve ter 14 dígitos, sem separadores como pontos, barras ou hífens.

2. Campo chaveNFe

  • Descrição: Chave de acesso da NF-e que será corrigida.
  • Tipo: String
  • Exemplo: "51240803274481000111550010000000061466264679"
  • Observações: A chave de acesso é composta por 44 dígitos, que identificam unicamente uma NF-e. Ela é gerada automaticamente durante a emissão da NF-e e contém informações como o CNPJ do emitente, o ano e o mês de emissão, a série e o número da nota, entre outros.

3. Campo correcao

  • Descrição: Texto descritivo da correção que está sendo feita na NF-e.
  • Tipo: String
  • Exemplo: "teste carta de correcao"
  • Observações: O texto deve ser claro e objetivo, detalhando a correção que está sendo realizada. Existem restrições quanto ao que pode ser corrigido por meio de uma CC-e. Por exemplo, não é permitido corrigir valores totais, a descrição dos produtos, ou qualquer informação que altere a operação original.

4. Campo tpAmb

  • Descrição: Tipo de ambiente no qual a Carta de Correção será emitida.
  • Tipo: Integer
  • Exemplo: 2
  • Observações: Os valores possíveis são:
    • 1 - Produção
    • 2 - Homologação (ambiente de testes)


# Requisição POST

# URL https://app.apiintegra.com/api/correcaoNFe

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/correcaoNFe
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
  "cnpj": "03274481000111",
  "chaveNFe": "51240803274481000111550010000000061466264679",
  "correcao": "teste carta de correcao",
  "tpAmb": 2
}

return JSON


{
	"attributes": {
		"versao": "1.00"
	},
	"idLote": "202408220936358",
	"tpAmb": "2",
	"verAplic": "MT_A2RL-4.00",
	"cOrgao": "51",
	"cStat": "128",
	"xMotivo": "Lote de Evento Processado",
	"retEvento": {
		"attributes": {
			"versao": "1.00"
		},
		"infEvento": {
			"tpAmb": "2",
			"verAplic": "MT_A2RL-4.00",
			"cOrgao": "51",
			"cStat": "135",
			"xMotivo": "Evento registrado e vinculado a NF-e",
			"chNFe": "51240803274481000111550010000000061466264679",
			"tpEvento": "110110",
			"nSeqEvento": "1",
			"dhRegEvento": "2024-08-22T09:35:29-04:00",
			"nProt": "151240000320270"
		}
	}
}

# Confirmar Operação NFe

Neste endpoint é possível enviar Evento Confirmação da Operação de uma NFe.

1. Campo cnpj

  • Descrição: CNPJ da empresa emitente da NF-e que será consultada.
  • Tipo: String
  • Exemplo: "03274481000111"
  • Observações: Deve ter 14 dígitos, sem separadores como pontos, barras ou hífens.

2. Campo tpAmb

  • Descrição: Tipo de ambiente no qual a consulta será realizada.
  • Tipo: Integer
  • Exemplo: 2
  • Observações: Os valores possíveis são:
    • 1 - Produção
    • 2 - Homologação (ambiente de testes)

3. Campo chaveNFe

  • Descrição: Chave de acesso da NF-e que será consultada.
  • Tipo: String
  • Exemplo: "51240803274481000111550010000000071176996712"
  • Observações: A chave de acesso é composta por 44 dígitos, que identificam unicamente uma NF-e. Ela é gerada automaticamente durante a emissão da NF-e e contém informações como o CNPJ do emitente, o ano e o mês de emissão, a série e o número da nota, entre outros.


# Requisição POST

# URL https://app.apiintegra.com/api/mdfeConfirmarOperacao

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/mdfeConfirmarOperacao
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
  "cnpj": "03274481000111",
  "tpAmb": 2,
  "chaveNFe": "51240803274481000111550010000000071176996712"
}

return JSON


{
	"attributes": {
		"versao": "1.00"
	},
	"idLote": "202408221106355",
	"tpAmb": "2",
	"verAplic": "AN_1.8.4",
	"cOrgao": "91",
	"cStat": "128",
	"xMotivo": "Lote de evento processado",
	"retEvento": {
		"attributes": {
			"versao": "1.00"
		},
		"infEvento": {
			"tpAmb": "2",
			"verAplic": "AN_1.8.4",
			"cOrgao": "91",
			"cStat": "573",
			"xMotivo": "Rejeicao: Duplicidade de evento",
			"chNFe": "51240803274481000111550010000000071176996712",
			"tpEvento": "210200",
			"xEvento": "Confirmacao da Operacao",
			"nSeqEvento": "1",
			"dhRegEvento": "2024-08-22T12:06:35-03:00"
		}
	}
}

# Desconhecer Operação NFe

Neste endpoint é possível enviar Evento Desconhecer Operação NFe.

1. Campo cnpj

  • Descrição: CNPJ da empresa emitente da NF-e que será consultada.
  • Tipo: String
  • Exemplo: "03274481000111"
  • Observações: Deve ter 14 dígitos, sem separadores como pontos, barras ou hífens.

2. Campo tpAmb

  • Descrição: Tipo de ambiente no qual a consulta será realizada.
  • Tipo: Integer
  • Exemplo: 2
  • Observações: Os valores possíveis são:
    • 1 - Produção
    • 2 - Homologação (ambiente de testes)

3. Campo chaveNFe

  • Descrição: Chave de acesso da NF-e que será consultada.
  • Tipo: String
  • Exemplo: "51240803274481000111550010000000071176996712"
  • Observações: A chave de acesso é composta por 44 dígitos, que identificam unicamente uma NF-e. Ela é gerada automaticamente durante a emissão da NF-e e contém informações como o CNPJ do emitente, o ano e o mês de emissão, a série e o número da nota, entre outros.


# Requisição POST

# URL https://app.apiintegra.com/api/mdfeDesconhecer

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/mdfeDesconhecer
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
  "cnpj": "03274481000111",
  "tpAmb": 2,
  "chaveNFe": "51240803274481000111550010000000071176996712"
}

return JSON


{
	"attributes": {
		"versao": "1.00"
	},
	"idLote": "202408221109566",
	"tpAmb": "2",
	"verAplic": "AN_1.8.4",
	"cOrgao": "91",
	"cStat": "128",
	"xMotivo": "Lote de evento processado",
	"retEvento": {
		"attributes": {
			"versao": "1.00"
		},
		"infEvento": {
			"tpAmb": "2",
			"verAplic": "AN_1.8.4",
			"cOrgao": "91",
			"cStat": "573",
			"xMotivo": "Rejeicao: Duplicidade de evento",
			"chNFe": "51240803274481000111550010000000071176996712",
			"tpEvento": "210220",
			"xEvento": "Desconhecimento da Operacao",
			"nSeqEvento": "1",
			"dhRegEvento": "2024-08-22T12:09:56-03:00"
		}
	}
}

# Operação Não Realizada NFe

Neste endpoint é possível enviar Evento Operação Não Realizada NFe.

1. Campo cnpj

  • Descrição: CNPJ da empresa emitente da NF-e que será consultada.
  • Tipo: String
  • Exemplo: "03274481000111"
  • Observações: Deve ter 14 dígitos, sem separadores como pontos, barras ou hífens.

2. Campo tpAmb

  • Descrição: Tipo de ambiente no qual a consulta será realizada.
  • Tipo: Integer
  • Exemplo: 2
  • Observações: Os valores possíveis são:
    • 1 - Produção
    • 2 - Homologação (ambiente de testes)

3. Campo chaveNFe

  • Descrição: Chave de acesso da NF-e que será consultada.
  • Tipo: String
  • Exemplo: "51240803274481000111550010000000071176996712"
  • Observações: A chave de acesso é composta por 44 dígitos, que identificam unicamente uma NF-e. Ela é gerada automaticamente durante a emissão da NF-e e contém informações como o CNPJ do emitente, o ano e o mês de emissão, a série e o número da nota, entre outros.


# Requisição POST

# URL https://app.apiintegra.com/api/mdfeNaoRealizado

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/mdfeNaoRealizado
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
  "cnpj": "03274481000111",
  "tpAmb": 2,
  "chaveNFe": "51240803274481000111550010000000071176996712"
}

return JSON


{
	"attributes": {
		"versao": "1.00"
	},
	"idLote": "202408221109566",
	"tpAmb": "2",
	"verAplic": "AN_1.8.4",
	"cOrgao": "91",
	"cStat": "128",
	"xMotivo": "Lote de evento processado",
	"retEvento": {
		"attributes": {
			"versao": "1.00"
		},
		"infEvento": {
			"tpAmb": "2",
			"verAplic": "AN_1.8.4",
			"cOrgao": "91",
			"cStat": "573",
			"xMotivo": "Rejeicao: Duplicidade de evento",
			"chNFe": "51240803274481000111550010000000071176996712",
			"tpEvento": "210220",
			"xEvento": "Desconhecimento da Operacao",
			"nSeqEvento": "1",
			"dhRegEvento": "2024-08-22T12:09:56-03:00"
		}
	}
}

# Ciência da Operação NFe

Neste endpoint é possível enviar Evento Ciência da Operação NFe.

1. Campo cnpj

  • Descrição: CNPJ da empresa emitente da NF-e que será consultada.
  • Tipo: String
  • Exemplo: "03274481000111"
  • Observações: Deve ter 14 dígitos, sem separadores como pontos, barras ou hífens.

2. Campo tpAmb

  • Descrição: Tipo de ambiente no qual a consulta será realizada.
  • Tipo: Integer
  • Exemplo: 2
  • Observações: Os valores possíveis são:
    • 1 - Produção
    • 2 - Homologação (ambiente de testes)

3. Campo chaveNFe

  • Descrição: Chave de acesso da NF-e que será consultada.
  • Tipo: String
  • Exemplo: "51240803274481000111550010000000071176996712"
  • Observações: A chave de acesso é composta por 44 dígitos, que identificam unicamente uma NF-e. Ela é gerada automaticamente durante a emissão da NF-e e contém informações como o CNPJ do emitente, o ano e o mês de emissão, a série e o número da nota, entre outros.


# Requisição POST

# URL https://app.apiintegra.com/api/mdfeCienciaOperacao

# Parâmetros Header

curl -X POST \
https://app.apiintegra.com/api/mdfeCienciaOperacao
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON


{
  "cnpj": "03274481000111",
  "tpAmb": 2,
  "chaveNFe": "51240803274481000111550010000000071176996712"
}

return JSON


{
	"attributes": {
		"versao": "1.00"
	},
	"idLote": "202408221109566",
	"tpAmb": "2",
	"verAplic": "AN_1.8.4",
	"cOrgao": "91",
	"cStat": "128",
	"xMotivo": "Lote de evento processado",
	"retEvento": {
		"attributes": {
			"versao": "1.00"
		},
		"infEvento": {
			"tpAmb": "2",
			"verAplic": "AN_1.8.4",
			"cOrgao": "91",
			"cStat": "573",
			"xMotivo": "Rejeicao: Duplicidade de evento",
			"chNFe": "51240803274481000111550010000000071176996712",
			"tpEvento": "210220",
			"xEvento": "Desconhecimento da Operacao",
			"nSeqEvento": "1",
			"dhRegEvento": "2024-08-22T12:09:56-03:00"
		}
	}
}

# Buscar Recibo NFe

Neste endpoint é possível consutar o Status de uma NFe utilizando o Protocolo de Recibo.


# Requisição GET

# URL https://app.apiintegra.com/api/reciboNFe/{cnpj}/{protocolo_recibo}/{tbAmb}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/reciboNFe/{cnpj}/{protocolo_recibo}/{tbAmb}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"attributes": {
		"versao": "4.00"
	},
	"tpAmb": "2",
	"verAplic": "MT_A2RL-4.00",
	"nRec": "510000038319499",
	"cStat": "105",
	"xMotivo": "Lote em processamento",
	"cUF": "51",
	"dhRecbto": "2024-08-23T08:13:45-04:00"
}

# Listar NFe´s

Neste endpoint é possível listar as NFe´s salvas no banco de dados através da consulta de NFe Monitor.


# Requisição GET

# URL https://app.apiintegra.com/api/chnfe/list/{cnpj}/{data}

# Parâmetros Header

curl -X GET \
https://app.apiintegra.com/api/chnfe/list/{cnpj}/{data}
-H 'X-Token or Bearer: {TOKEN}' \
-H 'Content-Type: application/json'


body JSON

return JSON


{
	"return": true,
	"data": [
		{
			"id": 1,
			"user_id": 1,
			"chave_acesso": "51240803274481000111550010003663351745899765",
			"cnpj_emitente": "03274481000111",
			"cnpj_destinatario": null,
			"data_emissao": "2024-08-13 18:29:00",
			"xml": "base64",
			"event": "procEventoNFe",
			"created_at": "2024-08-14 12:04:46",
			"updated_at": "2024-08-14 12:04:46"
		},
		{
			"id": 76,
			"user_id": 1,
			"chave_acesso": "51240803274481000383550110000019951758173724",
			"cnpj_emitente": "03274481000383",
			"cnpj_destinatario": "03274481000111",
			"data_emissao": "2024-08-13 13:57:42",
			"xml": "base64",
			"event": "nfeProc",
			"created_at": "2024-08-14 14:40:10",
			"updated_at": "2024-08-14 14:40:10"
		}		
	]
}