NAV
php

Introdução

Bem-vindo ao guia de referência da API do Notazz! É através desta API que você irá integrar seu sistema ao nosso.

A primeira coisa que você deve saber é o endpoint que usamos:

https://app.notazz.com/api

Para baixar o SDK PHP clique aqui.

Para baixar o SDK C# clique aqui.

Possíveis status da Nota Fiscal: Pendente, AguardandoAutorizacao, Autorizada, Rejeitada, EmProcessoDeCancelamento, Cancelada

Observação 1: a api faz um controle de requisições por minuto, sendo que a cada 1 minuto deverá ocorrer no máximo 100 requisições.

Observação 2: todos as requisições em json devem ser enviadas dentro da variável fields do tipo array como mostra no exemplo: POST(array("fields" => json))

Observação 3: A chave de API pode ser encontrada acessando a aplicação e indo até o menu Configurações > Empresas. Na coluna API KEY clique no botão Copiar.

NFS-e (Nota Fiscal de Serviço)

Através da rota /nfse e suas derivadas, você pode criar, consultar, atualizar e excluir uma nota fiscal de serviço

Criar

POST https://app.notazz.com/api

<?php
require("notazz-php.php");
    
$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "create_nfse",
    "DESTINATION_NAME" => "Jose Maria da Silva",
    "DESTINATION_TAXID" => "35281474588",
    "DESTINATION_IE" => "12345678",
    "DESTINATION_IM" => "12345678",
    "DESTINATION_TAXTYPE" => "F",
    "DESTINATION_STREET" => "Rua de teste",
    "DESTINATION_NUMBER" => "123",
    "DESTINATION_COMPLEMENT" => "Apt. 101",
    "DESTINATION_DISTRICT" => "Centro",
    "DESTINATION_CITY" => "Belo Horizonte",
    "DESTINATION_UF" => "MG",
    "DESTINATION_ZIPCODE" => "31320240",
    "DESTINATION_PHONE" => "31999998888",
    "DESTINATION_EMAIL" => "test@test.com",
    "DESTINATION_EMAIL_SEND" => array(
        "1" => array(
            "EMAIL" => "mail1@example.com" 
        ),
        "2" => array(
            "EMAIL" => "mail2@example.com" 
        ),
    ),
    "DOCUMENT_BASEVALUE" => "100.00",
    "DOCUMENT_DESCRIPTION" => "Prestação de Serviço em consultoria",
    "DOCUMENT_COMPETENCE" => "2017-01-01",
    "DOCUMENT_CNAE" => "8599604",
    "SERVICE_LIST_LC116" => "0802",
    "WITHHELD_ISS" => "0",
    "CITY_SERVICE_CODE" => "12345",
    "CITY_SERVICE_DESCRIPTION" => "Treinamento em Informática",
    "ALIQUOTAS" => array(
        "COFINS" => "0.00", 
        "CSLL" => "0.00", 
        "INSS" => "0.00", 
        "IR" => "0.00", 
        "PIS" => "0.00", 
        "ISS" => "2.00", 
    ),
    "EXTERNAL_ID" => "89678678",    
    "SALE_ID" => "127654"    
    "DOCUMENT_ISSUE_DATE" => 2018-12-17 15:44:27    
));
            
$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000",
  "id": "da140fd704eff1bf45652e07468053e1"
}

Ao criar uma nota fiscal, este será o objeto que você deverá enviar.

Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: create_nfse
DESTINATION_NAME
obrigatório
Nome completo do cliente
DESTINATION_TAXID
obrigatório
CPF ou CNPJ
DESTINATION_IE Inscrição Estadual
DESTINATION_IM Inscrição Municipal
DESTINATION_TAXTYPE
obrigatório
F = Física, J = Jurídica, E = Estrangeiro
DESTINATION_STREET
obrigatório
Logradouro
DESTINATION_NUMBER
obrigatório
Número
DESTINATION_COMPLEMENT Complemento
DESTINATION_DISTRICT
obrigatório
Bairro
DESTINATION_CITY
obrigatório
Cidade (não utilizar abreviações)
DESTINATION_UF
obrigatório
Estado
DESTINATION_ZIPCODE
obrigatório
CEP
DESTINATION_PHONE Telefone
DESTINATION_EMAIL E-mail
DESTINATION_EMAIL_SEND Esse parâmetro é um Array que irá conter os e-mails que será enviado após a nota ser autorizada ou cancelada.
OBS: Para cada e-mail que será enviado, passe os parâmetros abaixo alterando o índice em +1 para cada e-mail
DESTINATION_EMAIL_SEND[EMAIL] E-mail
DOCUMENT_BASEVALUE
obrigatório
Valor da nota fiscal
DOCUMENT_DESCRIPTION
obrigatório
Descrição da nota fiscal
DOCUMENT_COMPETENCE Competência. Utilizar padrão: YYYY-mm-dd
DOCUMENT_CNAE CNAE. Documentação: http://www.cnae.ibge.gov.br
SERVICE_LIST_LC116 Item da Lista de Serviço da LC 116.
WITHHELD_ISS ISS retido na fonte. 1 = Retido e 0 = Não retido.
CITY_SERVICE_CODE Código de serviço do município
CITY_SERVICE_DESCRIPTION Descrição do serviço do município
ALIQUOTAS[COFINS] Porcentagem (%) alíquota COFINS
ALIQUOTAS[CSLL] Porcentagem (%) alíquota CSLL
ALIQUOTAS[INSS] Porcentagem (%) alíquota INSS
ALIQUOTAS[IR] Porcentagem (%) alíquota IR
ALIQUOTAS[PIS] Porcentagem (%) alíquota PIS
ALIQUOTAS[ISS] Porcentagem (%) alíquota ISS
EXTERNAL_ID
ID do sistema para consultar a nota posteriormente
SALE_ID
ID da venda
DOCUMENT_ISSUE_DATE
Data de emissão automática da nota fiscal (por padrão é a data atual) formato YYYY-mm-dd HH:ii:ss

Atualizar

POST https://app.notazz.com/api

<?php
require("notazz-php.php");
            
$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "update_nfse",
    "DESTINATION_NAME" => "Jose Maria da Silva",
    "DESTINATION_TAXID" => "35281474588",
    "DESTINATION_IE" => "12345678",
    "DESTINATION_IM" => "12345678",
    "DESTINATION_TAXTYPE" => "F",
    "DESTINATION_STREET" => "Rua de teste",
    "DESTINATION_NUMBER" => "123",
    "DESTINATION_COMPLEMENT" => "Apt. 101",
    "DESTINATION_DISTRICT" => "Centro",
    "DESTINATION_CITY" => "Belo Horizonte",
    "DESTINATION_UF" => "MG",
    "DESTINATION_ZIPCODE" => "31320240",
    "DESTINATION_PHONE" => "31999998888",
    "DESTINATION_EMAIL" => "test@test.com",
    "DESTINATION_EMAIL_SEND" => array(
        "1" => array(
            "EMAIL" => "mail1@example.com" 
        ),
        "2" => array(
            "EMAIL" => "mail2@example.com" 
        ),
    ),
    "DOCUMENT_BASEVALUE" => "100.00",
    "DOCUMENT_DESCRIPTION" => "Prestação de Serviço em consultoria",
    "DOCUMENT_COMPETENCE" => "2017-01-01",
    "DOCUMENT_CNAE" => "8599604",
    "SERVICE_LIST_LC116" => "0802",
    "WITHHELD_ISS" => "0",
    "CITY_SERVICE_CODE" => "12345",
    "CITY_SERVICE_DESCRIPTION" => "Treinamento em Informática",
    "ALIQUOTAS" => array(
        "COFINS" => "0.00", 
        "CSLL" => "0.00", 
        "INSS" => "0.00", 
        "IR" => "0.00", 
        "PIS" => "0.00", 
        "ISS" => "2.00", 
    ),
    "DOCUMENT_ID" => "da140fd704eff1bf45652e07468053e1",                
    "EXTERNAL_ID" => "89678678",    
    "SALE_ID" => "127654"   
    "DOCUMENT_ISSUE_DATE" => 2018-12-17 15:44:27         
));
    
$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000"
  }

Ao atualizar uma nota fiscal, este será o objeto que você deverá enviar.

Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: update_nfse
DESTINATION_NAME
obrigatório
Nome completo do cliente
DESTINATION_TAXID
obrigatório
CPF ou CNPJ
DESTINATION_IE Inscrição Estadual
DESTINATION_IM Inscrição Municipal
DESTINATION_TAXTYPE
obrigatório
F = Física, J = Jurídica, E = Estrangeiro
DESTINATION_STREET
obrigatório
Logradouro
DESTINATION_NUMBER
obrigatório
Número
DESTINATION_COMPLEMENT Complemento
DESTINATION_DISTRICT
obrigatório
Bairro
DESTINATION_CITY
obrigatório
Cidade (não utilizar abreviações)
DESTINATION_UF
obrigatório
Estado
DESTINATION_ZIPCODE
obrigatório
CEP
DESTINATION_PHONE Telefone
DESTINATION_EMAIL E-mail
DESTINATION_EMAIL_SEND Esse parâmetro é um Array que irá conter os e-mails que será enviado após a nota ser autorizada ou cancelada.
OBS: Para cada e-mail que será enviado, passe os parâmetros abaixo alterando o índice em +1 para cada e-mail
DESTINATION_EMAIL_SEND[EMAIL] E-mail
DOCUMENT_BASEVALUE
obrigatório
Valor da nota fiscal
DOCUMENT_DESCRIPTION
obrigatório
Descrição da nota fiscal
DOCUMENT_COMPETENCE Competência. Utilizar padrão: YYYY-mm-dd
DOCUMENT_CNAE CNAE. Documentação: http://www.cnae.ibge.gov.br
SERVICE_LIST_LC116 Item da Lista de Serviço da LC 116.
WITHHELD_ISS ISS retido na fonte. 1 = Retido e 0 = Não retido.
CITY_SERVICE_CODE Código de serviço do município
CITY_SERVICE_DESCRIPTION Descrição do serviço do município
ALIQUOTAS[COFINS] Porcentagem (%) alíquota COFINS
ALIQUOTAS[CSLL] Porcentagem (%) alíquota CSLL
ALIQUOTAS[INSS] Porcentagem (%) alíquota INSS
ALIQUOTAS[IR] Porcentagem (%) alíquota IR
ALIQUOTAS[PIS] Porcentagem (%) alíquota PIS
ALIQUOTAS[ISS] Porcentagem (%) alíquota ISS
DOCUMENT_ID
obrigatório
ID do documento que será atualizado
EXTERNAL_ID
ID externo do documento que será atualizado
SALE_ID
ID da venda
DOCUMENT_ISSUE_DATE
Data de emissão automática da nota fiscal (por padrão é a data atual) formato YYYY-mm-dd HH:ii:ss

Consultar por ID

POST https://app.notazz.com/api

<?php
require("notazz-php.php");
            
$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "consult_nfse",
    "DOCUMENT_ID" => "da140fd704eff1bf45652e07468053e1",                
    "EXTERNAL_ID" => "89678678"                
    ),
));

$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000",
  "numero": "123",
  "codigoVerificacao": "AXE-87Y4",
  "pdf": "Link do PDF",
  "xml": "Link do XML",
  "linkPrefeitura": "Link do PDF da nota na prefeitura (nem todas prefeituras retornam)",
  "emissao": "2017-01-01 15:35:26",
  "statusNota": "Autorizada"
}

Ao consultar uma nota fiscal, este será o objeto que você deverá enviar.

Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: consult_nfse
DOCUMENT_ID
obrigatório
ID do documento que será consultado
EXTERNAL_ID
ID externo do documento que será consultado

Consultar (Personalizado)

POST https://app.notazz.com/api

<?php
require("notazz-php.php");

$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "consult_all_nfse",
    "FILTER" => array(
        "INITIAL_DATE" => "2017-01-01 13:00:00", 
        "FINAL_DATE" => "2017-01-01 14:00:00", 
        "STATUS" => "Autorizada", 
        "NUMBER" => "123",                 
        "PAGE" => "1",                 
));

$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000",
  "id": "da140fd704eff1bf45652e07468053e1",
  "external_id": "89678678",
  "numero": "123",
  "codigoVerificacao": "AXE-87Y4",
  "pdf": "Link do PDF",
  "xml": "Link do XML",
  "linkPrefeitura": "Link do PDF da nota na prefeitura (nem todas prefeituras retornam)",
  "emissao": "2017-01-01 15:35:26",
  "statusNota": "Autorizada"
}

Ao consultar uma nota fiscal de forma personalizada, este será o objeto que você deverá enviar.

Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: consult_all_nfse
FILTER
obrigatório
Esse parâmetro é um Array que irá conter os filtros que será enviado para a consulta.
FILTER[INITIAL_DATE]
obrigatório
Data / Hora Inicial
FILTER[FINAL_DATE]
obrigatório
Data / Hora Final
FILTER[STATUS] Status do documento
FILTER[NUMBER] Número da nota fiscal já autorizada
FILTER[PAGE] Número da página para consulta. É retornando 100 registros por página

Cancelar

POST https://app.notazz.com/api

<?php
require("notazz-php.php");

$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "cancel_nfse",
    "DOCUMENT_ID" => "da140fd704eff1bf45652e07468053e1",                
    "EXTERNAL_ID" => "89678678"                    
    ),
));

$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000"
  }

Ao cancelar uma nota fiscal, este será o objeto que você deverá enviar. Só será cancelado notas fiscais que já foram autorizadas

Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: cancel_nfse
DOCUMENT_ID
obrigatório
ID do documento que será cancelado
EXTERNAL_ID
ID externo do documento que será cancelado

Excluir

POST https://app.notazz.com/api

<?php
require("notazz-php.php");

$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "delete_nfse",
    "DOCUMENT_ID" => "da140fd704eff1bf45652e07468053e1",                
    "EXTERNAL_ID" => "89678678"                    
    ),
));

$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000",
  "motivo": "Registro da140fd704eff1bf45652e07468053e1 removido"
}

Ao excluir uma nota fiscal, este será o objeto que você deverá enviar. Só será excluido notas fiscais que ainda não foram autorizadas ou canceladas

Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: delete_nfse
DOCUMENT_ID
obrigatório
ID do documento que será removido
EXTERNAL_ID
ID externo do documento que será removido

Cidades Atendidas

POST https://app.notazz.com/api

<?php
require("notazz-php.php");

$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "cidades_atendidas",
    "FILTER" => array(
        "STATE" => "MG", 
        "CITY" => "Belo Horizonte", 
));

$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000",
  "estado": "MG"
  "cidade": "Belo Horizonte"
  "status_integracao": "homologada"
}

Ao consultar se uma cidade está atendida e homologada pela nossa API, este será o objeto que você deverá enviar.

Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: cidades_atendidas
FILTER
obrigatório
Esse parâmetro é um Array que irá conter os filtros que será enviado para a consulta.
FILTER[STATE]
obrigatório
Sigla do estado.
FILTER[CITY] Nome da cidade

NF-e (Nota Fiscal de Produto)

Através da rota /nfe e suas derivadas, você pode criar, consultar, atualizar e excluir uma nota fiscal de produto

Criar

POST https://app.notazz.com/api

<?php
require("notazz-php.php");

$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "create_nfe_55",
    "DESTINATION_NAME" => "Jose Maria da Silva",
    "DESTINATION_TAXID" => "35281474588",
    "DESTINATION_IE" => "12345678",
    "DESTINATION_IM" => "12345678",
    "DESTINATION_TAXTYPE" => "F",
    "DESTINATION_STREET" => "Rua de teste",
    "DESTINATION_NUMBER" => "123",
    "DESTINATION_COMPLEMENT" => "Apt. 101",
    "DESTINATION_DISTRICT" => "Centro",
    "DESTINATION_CITY" => "Belo Horizonte",
    "DESTINATION_UF" => "MG",
    "DESTINATION_ZIPCODE" => "31320240",
    "DESTINATION_PHONE" => "31999998888",
    "DESTINATION_EMAIL" => "test@test.com",
    "DESTINATION_EMAIL_SEND" => array(
        "1" => array(
            "EMAIL" => "mail1@example.com" 
        ),
        "2" => array(
            "EMAIL" => "mail2@example.com" 
        ),
    ),
    "DOCUMENT_BASEVALUE" => "100.00",
    "DOCUMENT_DESCRIPTION" => "DOCUMENTO EMITIDO POR ME OU EPP OPTANTE PELO SIMPLES NACIONAL",
    "DOCUMENT_CNAE" => "8599604",
    "DOCUMENT_GOAL" => "1",
    "DOCUMENT_OPERATION_TYPE" => "1",
    "DOCUMENT_REFERENCED" => "510807012123440001275500010000000981364117781",
    "DOCUMENT_NATURE_OPERATION" => "VENDA",
    "DOCUMENT_PRODUCT" => array(
        "1" => array(
            "DOCUMENT_PRODUCT_COD" => "1",
            "DOCUMENT_PRODUCT_EAN" => "190520367911",
            "DOCUMENT_PRODUCT_NAME" => "Camisa Polo",
            "DOCUMENT_PRODUCT_QTD" => "2",
            "DOCUMENT_PRODUCT_UNITARY_VALUE" => "5.00",
            "DOCUMENT_PRODUCT_NCM" => "62069000",
            "DOCUMENT_PRODUCT_CEST" => "2805900",
            "DOCUMENT_PRODUCT_CFOP" => "5101",
            "DOCUMENT_PRODUCT_DISCOUNT" => "2.00",
            "DOCUMENT_PRODUCT_ICMS_CST" => "102",
            "DOCUMENT_PRODUCT_IPI_CST" => "99",
            "DOCUMENT_PRODUCT_PIS_CST" => "99",
            "DOCUMENT_PRODUCT_COFINS_CST" => "99",
            "DOCUMENT_PRODUCT_ICMS_ALIQUOTA" => "0.00",
            "DOCUMENT_PRODUCT_IPI_ALIQUOTA" => "0.00",
            "DOCUMENT_PRODUCT_PIS_ALIQUOTA" => "0.00",
            "DOCUMENT_PRODUCT_COFINS_ALIQUOTA" => "0.00",                       
        ),
        "2" => array(
            "DOCUMENT_PRODUCT_COD" => "2",
            "DOCUMENT_PRODUCT_EAN" => "0020970",
            "DOCUMENT_PRODUCT_NAME" => "Oculos Feminino",
            "DOCUMENT_PRODUCT_QTD" => "1",
            "DOCUMENT_PRODUCT_UNITARY_VALUE" => "90.00",
            "DOCUMENT_PRODUCT_NCM" => "62069000",
            "DOCUMENT_PRODUCT_CEST" => "2805900",            
            "DOCUMENT_PRODUCT_CFOP" => "5101",
            "DOCUMENT_PRODUCT_DISCOUNT" => "2.00",
            "DOCUMENT_PRODUCT_ICMS_CST" => "102",
            "DOCUMENT_PRODUCT_IPI_CST" => "99",
            "DOCUMENT_PRODUCT_PIS_CST" => "99",
            "DOCUMENT_PRODUCT_COFINS_CST" => "99",
            "DOCUMENT_PRODUCT_ICMS_ALIQUOTA" => "0.00",
            "DOCUMENT_PRODUCT_IPI_ALIQUOTA" => "0.00",
            "DOCUMENT_PRODUCT_PIS_ALIQUOTA" => "0.00",
            "DOCUMENT_PRODUCT_COFINS_ALIQUOTA" => "0.00",                       
        ),
    ),
    "DOCUMENT_FRETE" => array(
        "DOCUMENT_FRETE_MOD" => "0",
        "DOCUMENT_FRETE_VALUE" => "100.00",
        "DOCUMENT_FRETE_TRANSPORTADORA" => array(
            "DOCUMENT_FRETE_TRANSPORTADORA_NAME" => "Empresa Brasileira de Correios e Telégrafos",
            "DOCUMENT_FRETE_TRANSPORTADORA_TAXID" => "34028316002742",
            "DOCUMENT_FRETE_TRANSPORTADORA_IE" => "12345678",
            "DOCUMENT_FRETE_TRANSPORTADORA_STREET" => "Rua de teste",
            "DOCUMENT_FRETE_TRANSPORTADORA_NUMBER" => "123",
            "DOCUMENT_FRETE_TRANSPORTADORA_DISTRICT" => "Centro",
            "DOCUMENT_FRETE_TRANSPORTADORA_CITY" => "Belo Horizonte",
            "DOCUMENT_FRETE_TRANSPORTADORA_UF" => "MG",
        ),
        "DOCUMENT_FRETE_VEICULO" => array(
            "DOCUMENT_FRETE_VEICULO_PLACA" => "ZZZ1100",
            "DOCUMENT_FRETE_VEICULO_UF" => "MG",
        ),
        "DOCUMENT_FRETE_VOLUMES" => array(
            "DOCUMENT_FRETE_VOLUMES_QTD" => "1",
            "DOCUMENT_FRETE_VOLUMES_SPECIES" => "CAIXA",
            "DOCUMENT_FRETE_VOLUMES_NET_WEIGHT" => "10.500",
            "DOCUMENT_FRETE_VOLUMES_GROSS_WEIGHT" => "12.000",
        ),
    ),
    "EXTERNAL_ID" => "89678678",        
    "SALE_ID" => "127654"    
    "DOCUMENT_ISSUE_DATE" => 2018-12-17 15:44:27       
    "LOGISTICS" => "5a5a165d8385feebec5a21eebd85fc2b"    
));

$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000",
  "id": "da140fd704eff1bf45652e07468053e1"
}

Ao criar uma nota fiscal, este será o objeto que você deverá enviar.





Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: create_nfe_55
DESTINATION_NAME
obrigatório
Nome completo do cliente
DESTINATION_TAXID
obrigatório
CPF ou CNPJ
DESTINATION_IE Inscrição Estadual
DESTINATION_IM Inscrição Municipal
DESTINATION_TAXTYPE
obrigatório
F = Física, J = Jurídica, E = Estrangeiro
DESTINATION_STREET
obrigatório
Logradouro
DESTINATION_NUMBER
obrigatório
Número
DESTINATION_COMPLEMENT Complemento
DESTINATION_DISTRICT
obrigatório
Bairro
DESTINATION_CITY
obrigatório
Cidade (não utilizar abreviações)
DESTINATION_UF
obrigatório
Estado
DESTINATION_ZIPCODE
obrigatório
CEP
DESTINATION_PHONE Telefone
DESTINATION_EMAIL E-mail
DESTINATION_EMAIL_SEND Esse parâmetro é um Array que irá conter os e-mails que será enviado após a nota ser autorizada ou cancelada.
OBS: Para cada e-mail que será enviado, passe os parâmetros abaixo alterando o índice em +1 para cada e-mail
DESTINATION_EMAIL_SEND[EMAIL] E-mail
DOCUMENT_BASEVALUE
obrigatório
Valor da nota fiscal
DOCUMENT_CNAE CNAE. Documentação: http://www.cnae.ibge.gov.br
DOCUMENT_GOAL Finalidade da Nota Fiscal. 1 = Normal, 2 = Complementar, 3 = Ajuste, 4 = Devolução/Retorno
DOCUMENT_REFERENCED Chave da nota fiscal referenciada. Utilizar quando DOCUMENT_GOAL for diferente de 1
DOCUMENT_OPERATION_TYPE Tipo de Operação. 0 = Entrada, 1 = Saída
DOCUMENT_NATURE_OPERATION Natureza da operação da nota fiscal
DOCUMENT_DESCRIPTION
Descrição da nota fiscal
DOCUMENT_PRODUCT
obrigatório
Esse parâmetro é um Array que irá conter os produtos contidos na nota fiscal.
OBS: Para cada produto que será enviado, passe os parâmetros abaixo alterando o índice em +1 para cada produto
[DOCUMENT_PRODUCT_COD]
obrigatório
Cód do produto
[DOCUMENT_PRODUCT_EAN]
Código de barras
[DOCUMENT_PRODUCT_NAME]
obrigatório
Nome do produto
[DOCUMENT_PRODUCT_QTD]
obrigatório
Quantidade de itens
[DOCUMENT_PRODUCT_UNITARY_VALUE]
obrigatório
Valor unitário do item
[DOCUMENT_PRODUCT_NCM]
Número NCM
[DOCUMENT_PRODUCT_CEST]
Código CEST
[DOCUMENT_PRODUCT_CFOP]
Número do CFOP
[DOCUMENT_PRODUCT_DISCOUNT]
Valor de desconto do item
[DOCUMENT_PRODUCT_ICMS_CST]
Código do ICMS
[DOCUMENT_PRODUCT_ICMS_ALIQUOTA]
Alíquota do ICMS
[DOCUMENT_PRODUCT_IPI_CST]
Código do IPI
[DOCUMENT_PRODUCT_IPI_ALIQUOTA]
Alíquota do IPI
[DOCUMENT_PRODUCT_PIS_CST]
Código do PIS
[DOCUMENT_PRODUCT_PIS_ALIQUOTA]
Alíquota do PIS
[DOCUMENT_PRODUCT_COFINS_CST]
Código do COFINS
[DOCUMENT_PRODUCT_COFINS_ALIQUOTA]
Alíquota do COFINS
DOCUMENT_FRETE Esse parâmetro é um Array que irá conter as informações referente ao frete.
[DOCUMENT_FRETE_MOD]
0 = Por conta do emitente, 1 = Por conta do destinatário / remetente, 2 = Por conta de terceiros, 9 = Sem frete
[DOCUMENT_FRETE_VALUE]
Valor total do frete
DOCUMENT_FRETE_TRANSPORTADORA Esse parâmetro é um Array que irá conter as informações referente a transportadora.
[DOCUMENT_FRETE_TRANSPORTADORA_NAME]
Nome ou Razão Social da transportadora
[DOCUMENT_FRETE_TRANSPORTADORA_TAXID]
CPF / CNPJ
[DOCUMENT_FRETE_TRANSPORTADORA_IE]
Inscrição estadual
[DOCUMENT_FRETE_TRANSPORTADORA_STREET]
Logradouro
[DOCUMENT_FRETE_TRANSPORTADORA_NUMBER]
Número
[DOCUMENT_FRETE_TRANSPORTADORA_DISTRICT]
Bairro
[DOCUMENT_FRETE_TRANSPORTADORA_CITY]
Cidade
[DOCUMENT_FRETE_TRANSPORTADORA_UF]
Bairro
DOCUMENT_FRETE_VEICULO Esse parâmetro é um Array que irá conter as informações referente ao veículo.
[DOCUMENT_FRETE_VEICULO_PLACA]
Placa do veículo
[DOCUMENT_FRETE_VEICULO_UF]
Estado do veículo
DOCUMENT_FRETE_VOLUMES Esse parâmetro é um Array que irá conter as informações referente aos volumes que estão sendo transportados.
[DOCUMENT_FRETE_VOLUMES_QTD]
Quantidade de volumes
[DOCUMENT_FRETE_VOLUMES_SPECIES]
Espécie dos volumes. Ex.: CAIXA, FARDO
[DOCUMENT_FRETE_VOLUMES_NET_WEIGHT]
Peso líquido em KG
[DOCUMENT_FRETE_VOLUMES_GROSS_WEIGHT]
Peso bruto em KG
EXTERNAL_ID
ID do sistema para consultar a nota posteriormente
SALE_ID
ID da venda
DOCUMENT_ISSUE_DATE
Data de emissão automática da nota fiscal (por padrão é a data atual) formato YYYY-mm-dd HH:ii:ss
LOGISTICS
Chave de integração da logística já configurada pelo sistema web. Se encontra no menu Configurações > Logística > Editar

Atualizar

POST https://app.notazz.com/api

<?php
require("notazz-php.php");

$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "create_nfe_55",
    "DESTINATION_NAME" => "Jose Maria da Silva",
    "DESTINATION_TAXID" => "35281474588",
    "DESTINATION_IE" => "12345678",
    "DESTINATION_IM" => "12345678",
    "DESTINATION_TAXTYPE" => "F",
    "DESTINATION_STREET" => "Rua de teste",
    "DESTINATION_NUMBER" => "123",
    "DESTINATION_COMPLEMENT" => "Apt. 101",
    "DESTINATION_DISTRICT" => "Centro",
    "DESTINATION_CITY" => "Belo Horizonte",
    "DESTINATION_UF" => "MG",
    "DESTINATION_ZIPCODE" => "31320240",
    "DESTINATION_PHONE" => "31999998888",
    "DESTINATION_EMAIL" => "test@test.com",
    "DESTINATION_EMAIL_SEND" => array(
        "1" => array(
            "EMAIL" => "mail1@example.com" 
        ),
        "2" => array(
            "EMAIL" => "mail2@example.com" 
        ),
    ),
    "DOCUMENT_BASEVALUE" => "100.00",
    "DOCUMENT_DESCRIPTION" => "DOCUMENTO EMITIDO POR ME OU EPP OPTANTE PELO SIMPLES NACIONAL",
    "DOCUMENT_CNAE" => "8599604",
    "DOCUMENT_GOAL" => "1",
    "DOCUMENT_OPERATION_TYPE" => "1",    
    "DOCUMENT_REFERENCED" => "510807012123440001275500010000000981364117781", 
    "DOCUMENT_NATURE_OPERATION" => "VENDA",
    "DOCUMENT_PRODUCT" => array(
        "1" => array(
            "DOCUMENT_PRODUCT_COD" => "1",
            "DOCUMENT_PRODUCT_EAN" => "190520367911",
            "DOCUMENT_PRODUCT_NAME" => "Camisa Polo",
            "DOCUMENT_PRODUCT_QTD" => "2",
            "DOCUMENT_PRODUCT_UNITARY_VALUE" => "5.00",
            "DOCUMENT_PRODUCT_NCM" => "62069000",
            "DOCUMENT_PRODUCT_CEST" => "2805900",            
            "DOCUMENT_PRODUCT_CFOP" => "5101",
            "DOCUMENT_PRODUCT_DISCOUNT" => "2.00", 
            "DOCUMENT_PRODUCT_ICMS_CST" => "102",
            "DOCUMENT_PRODUCT_IPI_CST" => "99",
            "DOCUMENT_PRODUCT_PIS_CST" => "99",
            "DOCUMENT_PRODUCT_COFINS_CST" => "99",
            "DOCUMENT_PRODUCT_ICMS_ALIQUOTA" => "0.00",
            "DOCUMENT_PRODUCT_IPI_ALIQUOTA" => "0.00",
            "DOCUMENT_PRODUCT_PIS_ALIQUOTA" => "0.00",
            "DOCUMENT_PRODUCT_COFINS_ALIQUOTA" => "0.00",                       
        ),
        "2" => array(
            "DOCUMENT_PRODUCT_COD" => "2",
            "DOCUMENT_PRODUCT_EAN" => "0020970",
            "DOCUMENT_PRODUCT_NAME" => "Oculos Feminino",
            "DOCUMENT_PRODUCT_QTD" => "1",
            "DOCUMENT_PRODUCT_UNITARY_VALUE" => "90.00",
            "DOCUMENT_PRODUCT_NCM" => "62069000",
            "DOCUMENT_PRODUCT_CEST" => "2805900",            
            "DOCUMENT_PRODUCT_CFOP" => "5101",
            "DOCUMENT_PRODUCT_DISCOUNT" => "2.00",
            "DOCUMENT_PRODUCT_ICMS_CST" => "102",
            "DOCUMENT_PRODUCT_IPI_CST" => "99",
            "DOCUMENT_PRODUCT_PIS_CST" => "99",
            "DOCUMENT_PRODUCT_COFINS_CST" => "99",
            "DOCUMENT_PRODUCT_ICMS_ALIQUOTA" => "0.00",
            "DOCUMENT_PRODUCT_IPI_ALIQUOTA" => "0.00",
            "DOCUMENT_PRODUCT_PIS_ALIQUOTA" => "0.00",
            "DOCUMENT_PRODUCT_COFINS_ALIQUOTA" => "0.00",                       
        ),
    ),
    "DOCUMENT_FRETE" => array(
        "DOCUMENT_FRETE_MOD" => "0",
        "DOCUMENT_FRETE_VALUE" => "100.00",
        "DOCUMENT_FRETE_TRANSPORTADORA" => array(
            "DOCUMENT_FRETE_TRANSPORTADORA_NAME" => "Empresa Brasileira de Correios e Telégrafos",
            "DOCUMENT_FRETE_TRANSPORTADORA_TAXID" => "34028316002742",
            "DOCUMENT_FRETE_TRANSPORTADORA_IE" => "12345678",
            "DOCUMENT_FRETE_TRANSPORTADORA_STREET" => "Rua de teste",
            "DOCUMENT_FRETE_TRANSPORTADORA_NUMBER" => "123",
            "DOCUMENT_FRETE_TRANSPORTADORA_DISTRICT" => "Centro",
            "DOCUMENT_FRETE_TRANSPORTADORA_CITY" => "Belo Horizonte",
            "DOCUMENT_FRETE_TRANSPORTADORA_UF" => "MG",
        ),
        "DOCUMENT_FRETE_VEICULO" => array(
            "DOCUMENT_FRETE_VEICULO_PLACA" => "ZZZ1100",
            "DOCUMENT_FRETE_VEICULO_UF" => "MG",
        ),
        "DOCUMENT_FRETE_VOLUMES" => array(
            "DOCUMENT_FRETE_VOLUMES_QTD" => "1",
            "DOCUMENT_FRETE_VOLUMES_SPECIES" => "CAIXA",
            "DOCUMENT_FRETE_VOLUMES_NET_WEIGHT" => "10.500",
            "DOCUMENT_FRETE_VOLUMES_GROSS_WEIGHT" => "12.000",
        ),
    ),
    "DOCUMENT_ID" => "da140fd704eff1bf45652e07468053e1",
    "EXTERNAL_ID" => "89678678",        
    "SALE_ID" => "127654"    
    "DOCUMENT_ISSUE_DATE" => 2018-12-17 15:44:27        
    "LOGISTICS" => "5a5a165d8385feebec5a21eebd85fc2b"        
));

$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000"
}

Ao atualizar uma nota fiscal, este será o objeto que você deverá enviar.





Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: update_nfe_55
DESTINATION_NAME
obrigatório
Nome completo do cliente
DESTINATION_TAXID
obrigatório
CPF ou CNPJ
DESTINATION_IE Inscrição Estadual
DESTINATION_IM Inscrição Municipal
DESTINATION_TAXTYPE
obrigatório
F = Física, J = Jurídica, E = Estrangeiro
DESTINATION_STREET
obrigatório
Logradouro
DESTINATION_NUMBER
obrigatório
Número
DESTINATION_COMPLEMENT Complemento
DESTINATION_DISTRICT
obrigatório
Bairro
DESTINATION_CITY
obrigatório
Cidade (não utilizar abreviações)
DESTINATION_UF
obrigatório
Estado
DESTINATION_ZIPCODE
obrigatório
CEP
DESTINATION_PHONE Telefone
DESTINATION_EMAIL E-mail
DESTINATION_EMAIL_SEND Esse parâmetro é um Array que irá conter os e-mails que será enviado após a nota ser autorizada ou cancelada.
OBS: Para cada e-mail que será enviado, passe os parâmetros abaixo alterando o índice em +1 para cada e-mail
DESTINATION_EMAIL_SEND[EMAIL] E-mail
DOCUMENT_BASEVALUE
obrigatório
Valor da nota fiscal
DOCUMENT_CNAE CNAE. Documentação: http://www.cnae.ibge.gov.br
DOCUMENT_GOAL Finalidade da Nota Fiscal. 1 = Normal, 2 = Complementar, 3 = Ajuste, 4 = Devolução/Retorno
DOCUMENT_REFERENCED Chave da nota fiscal referenciada. Utilizar quando DOCUMENT_GOAL for diferente de 1
DOCUMENT_OPERATION_TYPE Tipo de Operação. 0 = Entrada, 1 = Saída
DOCUMENT_NATURE_OPERATION Natureza da operação da nota fiscal
DOCUMENT_DESCRIPTION
Descrição da nota fiscal
DOCUMENT_PRODUCT
obrigatório
Esse parâmetro é um Array que irá conter os produtos contidos na nota fiscal.
OBS: Para cada produto que será enviado, passe os parâmetros abaixo alterando o índice em +1 para cada produto
[DOCUMENT_PRODUCT_COD]
obrigatório
Cód do produto
[DOCUMENT_PRODUCT_EAN]
Código de barras
[DOCUMENT_PRODUCT_NAME]
obrigatório
Nome do produto
[DOCUMENT_PRODUCT_QTD]
obrigatório
Quantidade de itens
[DOCUMENT_PRODUCT_UNITARY_VALUE]
obrigatório
Valor unitário do item
[DOCUMENT_PRODUCT_NCM]
Número NCM
[DOCUMENT_PRODUCT_CEST]
Código CEST
[DOCUMENT_PRODUCT_CFOP]
Número do CFOP
[DOCUMENT_PRODUCT_DISCOUNT]
Valor de desconto do item
[DOCUMENT_PRODUCT_ICMS_CST]
Código do ICMS
[DOCUMENT_PRODUCT_ICMS_ALIQUOTA]
Alíquota do ICMS
[DOCUMENT_PRODUCT_IPI_CST]
Código do IPI
[DOCUMENT_PRODUCT_IPI_ALIQUOTA]
Alíquota do IPI
[DOCUMENT_PRODUCT_PIS_CST]
Código do PIS
[DOCUMENT_PRODUCT_PIS_ALIQUOTA]
Alíquota do PIS
[DOCUMENT_PRODUCT_COFINS_CST]
Código do COFINS
[DOCUMENT_PRODUCT_COFINS_ALIQUOTA]
Alíquota do COFINS
DOCUMENT_FRETE Esse parâmetro é um Array que irá conter as informações referente ao frete.
[DOCUMENT_FRETE_MOD]
0 = Por conta do emitente, 1 = Por conta do destinatário / remetente, 2 = Por conta de terceiros, 9 = Sem frete
[DOCUMENT_FRETE_VALUE]
Valor total do frete
DOCUMENT_FRETE_TRANSPORTADORA Esse parâmetro é um Array que irá conter as informações referente a transportadora.
[DOCUMENT_FRETE_TRANSPORTADORA_NAME]
Nome ou Razão Social da transportadora
[DOCUMENT_FRETE_TRANSPORTADORA_TAXID]
CPF / CNPJ
[DOCUMENT_FRETE_TRANSPORTADORA_IE]
Inscrição estadual
[DOCUMENT_FRETE_TRANSPORTADORA_STREET]
Logradouro
[DOCUMENT_FRETE_TRANSPORTADORA_NUMBER]
Número
[DOCUMENT_FRETE_TRANSPORTADORA_DISTRICT]
Bairro
[DOCUMENT_FRETE_TRANSPORTADORA_CITY]
Cidade
[DOCUMENT_FRETE_TRANSPORTADORA_UF]
Bairro
DOCUMENT_FRETE_VEICULO Esse parâmetro é um Array que irá conter as informações referente ao veículo.
[DOCUMENT_FRETE_VEICULO_PLACA]
Placa do veículo
[DOCUMENT_FRETE_VEICULO_UF]
Estado do veículo
DOCUMENT_FRETE_VOLUMES Esse parâmetro é um Array que irá conter as informações referente aos volumes que estão sendo transportados.
[DOCUMENT_FRETE_VOLUMES_QTD]
Quantidade de volumes
[DOCUMENT_FRETE_VOLUMES_SPECIES]
Espécie dos volumes. Ex.: CAIXA, FARDO
[DOCUMENT_FRETE_VOLUMES_NET_WEIGHT]
Peso líquido em KG
[DOCUMENT_FRETE_VOLUMES_GROSS_WEIGHT]
Peso bruto em KG
DOCUMENT_ID
obrigatório
ID do documento que será atualizado
EXTERNAL_ID
ID externo do documento que será atualizado
SALE_ID
ID da venda
DOCUMENT_ISSUE_DATE
Data de emissão automática da nota fiscal (por padrão é a data atual) formato YYYY-mm-dd HH:ii:ss
LOGISTICS
Chave de integração da logística já configurada pelo sistema web. Se encontra no menu Configurações > Logística > Editar

Consultar por ID

POST https://app.notazz.com/api

<?php
require("notazz-php.php");

$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "consult_nfe_55",
    "DOCUMENT_ID" => "da140fd704eff1bf45652e07468053e1",                
    "EXTERNAL_ID" => "89678678"                    
    ),
));

$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000",
  "numero": "123",
  "chave": "51080701212344000127550010000000981364117781",
  "pdf": "Link do PDF",
  "xml": "Link do XML",
  "xmlCancelamento": "Link do XML de Cancelamento",
  "emissao": "2017-01-01 15:35:26",
  "statusNota": "Autorizada"
  "venda": "5987656"
  "rastreio": "DW98767876533"
}

Ao consultar uma nota fiscal, este será o objeto que você deverá enviar.

Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: consult_nfe_55
DOCUMENT_ID
obrigatório
ID do documento que será consultado
EXTERNAL_ID
ID externo do documento que será consultado

Consultar (Personalizado)

POST https://app.notazz.com/api

<?php
require("notazz-php.php");

$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "consult_all_nfe_55",
    "FILTER" => array(
        "INITIAL_DATE" => "2017-01-01 13:00:00", 
        "FINAL_DATE" => "2017-01-01 14:00:00", 
        "STATUS" => "Autorizada", 
        "NUMBER" => "123",                 
        "DOC" => "16849186000",                 
        "PAGE" => "1",                 
));

$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000",
  "id": "da140fd704eff1bf45652e07468053e1",
  "external_id": "89678678",
  "numero": "123",
  "chave": "51080701212344000127550010000000981364117781",
  "pdf": "Link do PDF",
  "xml": "Link do XML",
  "xmlCancelamento": "Link do XML de Cancelamento",
  "emissao": "2017-01-01 15:35:26",
  "statusNota": "Autorizada"
  "venda": "5987656"  
  "rastreio": "DW98767876533"
}

Ao consultar uma nota fiscal de forma personalizada, este será o objeto que você deverá enviar.

Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: consult_all_nfe_55
FILTER
obrigatório
Esse parâmetro é um Array que irá conter os filtros que será enviado para a consulta.
FILTER[INITIAL_DATE]
obrigatório
Data / Hora Inicial
FILTER[FINAL_DATE]
obrigatório
Data / Hora Final
FILTER[STATUS] Status do documento
FILTER[NUMBER] Número da nota fiscal já autorizada
FILTER[DOC] CPF / CNPJ do cliente. Pode também ser enviado um array com múltiplos CPFs/CNPJs
FILTER[PAGE] Número da página para consulta. É retornando 100 registros por página

Cancelar

POST https://app.notazz.com/api

<?php
require("notazz-php.php");

$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "cancel_nfe_55",
    "REASON" => "O valor da nota fiscal foi informado incorretamente",                
    "DOCUMENT_ID" => "da140fd704eff1bf45652e07468053e1",                
    "EXTERNAL_ID" => "89678678"                    
    ),
));

$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000"
}

Ao cancelar uma nota fiscal, este será o objeto que você deverá enviar. Só será cancelado notas fiscais que já foram autorizadas

Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: cancel_nfe_55
REASON
obrigatório
Motivo do cancelamento
DOCUMENT_ID
obrigatório
ID do documento que será cancelado
EXTERNAL_ID
ID externo do documento que será cancelado

Excluir

POST https://app.notazz.com/api

<?php
require("notazz-php.php");

$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "delete_nfe_55",
    "DOCUMENT_ID" => "da140fd704eff1bf45652e07468053e1",                
    "EXTERNAL_ID" => "89678678"                    
    ),
));

$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000",
  "motivo": "Registro da140fd704eff1bf45652e07468053e1 removido"
}

Ao excluir uma nota fiscal, este será o objeto que você deverá enviar. Só será excluido notas fiscais que ainda não foram autorizadas ou canceladas

Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: delete_nfe_55
DOCUMENT_ID
obrigatório
ID do documento que será removido
EXTERNAL_ID
ID externo do documento que será removido

Atualizar Estoque

Através da rota /update_stock você pode atualizar a quantidade de itens do seu estoque para mais ou para menos

POST https://app.notazz.com/api

<?php
require("notazz-php.php");

$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "update_stock",
    "PRODUCT_COD" => "123456",
    "PRODUCT_QTD" => "10"
));

$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000",
  "old_stock": "125"
  "new_stock": "135"
}

Ao atualizar a quantidade de itens do estoque de um produto, este será o objeto que você deverá enviar. Observação: quando for deduzir itens do estoque enviar o número com sinal negativo

Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: update_stock
PRODUCT_COD
obrigatório
Código do produto
PRODUCT_QTD
obrigatório
Quantidade que será acrescido ou deduzido

Atualizar Rastreio

Através da rota /update_tracking você pode atualizar o código / link de rastreio da mercadoria que está vinculada à nota fiscal. Nesse momento o Notazz enviará um e-mail e/ou SMS para o cliente com o código / link de rastreio.

POST https://app.notazz.com/api

<?php
require("notazz-php.php");

$fields = json_encode(array(
    "API_KEY" => "SUA CHAVE DE API",
    "METHOD" => "update_tracking",
    "TRACKING" => "PO7876543235BR",
    "DOCUMENT_ID" => "da140fd704eff1bf45652e07468053e1",
    "EXTERNAL_ID" => "89678678"
));

$retorno = send_data($fields);
?>   

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "sucesso",
  "codigoProcessamento": "000"
}

Ao atualizar o código / link de rastreio de uma nota fiscal, este será o objeto que você deverá enviar:

Propriedade Descrição
API_KEY
obrigatório
Chave de api fornecida pelo Notazz.
METHOD
obrigatório
Método de chamada na API: update_tracking
TRACKING
obrigatório
Código / link de rastreio
DOCUMENT_ID
obrigatório
ID do documento que será atualizado
EXTERNAL_ID
ID externo do documento que será atualizado

Webhook

Nossa API de POSTS / Webhook serve para automatizar o controle de suas notas fiscais, podendo ser integrada com qualquer sistema. Para cadastrar uma ou mais URLs de POSTBACK basta acessar a aplicação do Notazz e ir no menu Configurações > Empresas > Webhook. Abaixo são informados os campos que são retornados como array quando uma nota for Autorizada, Cancelada, Rejeitada ou Denegada.

ARRAY Retornado (exemplo):

[ 
  "token"=> "20bdaecb9950614d2e71870b8bcab6e8",
  "id"=> "da140fd704eff1bf45652e07468053e1",
  "numero"=> "1234",
  "chave"=> "45676543219874597432765219875398731234560987",
  "codigoVerificacao"=> "123456",
  "pdf"=> "Link do PDF",
  "xml"=> "Link do XML de Autorização",
  "xmlCancelamento"=> "Link do Xml de Cancelamento",
  "emissao"=> "2017-01-01 15:35:26",
  "statusNota"=> "Autorizada",
  "motivoStatus"=> "Rejeitada",
  "clienteEmail"=> "sucesso",
  "external_id"=> "O campo CPF é obrigatório",
  "venda"=> "123",
  "id_logistica"=> "1287654"
]
Propriedade Descrição
token
Cada empresa possui um token único e essa é a principal garantia de que o post está sendo enviado pelo Notazz. O token é adquirido dentro da aplicação do Notazz no menu Configurações > Empresas > Webhook
id
Identificador da nota fiscal no Notazz
numero
Número da nota fiscal caso esta esteja autorizada
chave
Chave de acesso da nota fiscal (NF-e)
codigoVerificacao
Código de verificação da nota fiscal (NFS-e)
pdf
Link para baixar o PDF da nota fiscal
xml
Link para baixar o XML da nota fiscal
linkPrefeitura
Link para baixar o PDF da nota fiscal na prefeitura (nem todas prefeituras retornam)
xmlCancelamento
Link para baixar o XML de cancelamento da nota fiscal
emissao
Data e hora de emissão da nota fiscal
statusNota
Status que a nota fiscal se encontra
motivoStatus
Caso a nota fiscal seja rejeitada é informado o motivo da rejeição nessa variável
clienteEmail
E-mail do cliente
external_id
Identificador externo enviado via API
venda
Número da(s) venda(s) da nota fiscal caso tenha. Se houver mais de uma venda serão separadas por vírgula
id_logistica
Número do identificador da logística que é enviado para as diversas plataformas que temos integração

Erros

Quando ocorre algum erro na API o retorno ocorrerá sempre da mesma forma, com apenas três variáveis.

JSON Retornado (exemplo):

{ 
  "statusProcessamento": "erro",
  "codigoProcessamento": "202",
  "motivo": "DOCUMENT_ID da140fd704eff1bf45652e07468053e1 não encontrado"
}
Propriedade Descrição
statusProcessamento
Status do processamento da requisição
codigoProcessamento
Código do processamento da requisição
motivo
Descrição do erro

000 - SUCESSO
100 = BLOCO COM ERROS DE VALIDAÇÕES
101 - EXTERNAL_ID já está vinculado em outro documento fiscal
102 - Validações de variáveis
103 - Registro não pode ser atualizado por motivo de status
104 - Registro não pode ser removido por motivo de status
105 - Não é possível cancelar a nota fiscal pois já foi encerrado a competência
106 - Não é possível cancelar a nota fiscal por motivo de status
107 - Deve-se informar no mínimo 30 caracteres no campo REASON
108 - Você deve preencher o campo REASON com o motivo do cancelamento
109 - Código ou link de rastreio não pode ser vazio
110 - Foi alcançado o limite de requisições por minuto
200 = BLOCO COM ERROS DE BANCO DE DADOS
201 - Erro ao inserir registro
202 - Registro não encontrado
300 = BLOCO COM ERROS DE ESTRUTURA
301 - DOCUMENT_ID inválido
302 - Método inválido
303 - APIKEY inválida
304 - Não foi informado os filtros para a consulta
305 - APIKEY não liberada para integração
306 - Requisição inválida
999 - API em manutenção


php