Introdução

API para integração com o Granatum Financeiro

Configuração

A configuração do Header deve ser utilizada em todas as requisições de envio de dados: POST e PUT. Nas outras requisições o Header é opcional.

  • Content-Type: application/x-www-form-urlencoded

Autenticação

Para ocorrer a comunicação com a API será necessário utilizar o Access Token.

Esse token está disponível no Granatum dentro de Configurações -> Minha Empresa -> Sidebar(API).

Todas as requisições devem ter obrigatoriamente o Access Token na QueryString para funcionar.

Lançamentos

Criar um lançamento

Cria um lançamento que pode ser uma Conta a Pagar (despesa) ou uma Conta a Receber (receita).

Método e URL

POST https://api.granatum.com.br/v1/lancamentos

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

descricaoDescrição do lançamentoRequerido
conta_idID da conta bancáriaRequerido
categoria_idID da categoriaRequerido
valorUse negativo para despesa e positivo para receita. Ex.: -10.00 e 10.00Requerido
data_vencimentoData de vencimento do lançamentoRequerido
data_pagamentoData do pagamento. Indica que o lançamento está pagoOpcional
data_competenciaData da competência. Data que indica a efetiva data do recebimento.Opcional
centro_custo_lucro_idID do centro de custo e lucroOpcional
forma_pagamento_idID da forma de pagamentoOpcional
pessoa_idID do cliente no caso de Receita e ID do fornecedor no caso de DespesaOpcional
tipo_documento_idID do tipo de documentoOpcional
total_repeticoesNúmero de vezes que o lançamento será repetidoOpcional
observacaoObservação do lançamentoOpcional
itens_adicionais[]Itens adicionais para criar lançamento compostoOpcional

Paramêtros dos itens_adicionais

descricaoDescrição do itemRequerido
categoria_idID da categoriaRequerido
valorSomente é permitido valores positivosRequerido
centro_custo_lucro_idID do centro de custo e lucroOpcional
forma_pagamento_idID da forma de pagamentoOpcional
pessoa_idID do cliente no caso de Receita e ID do fornecedor no caso de DespesaOpcional

Exemplo de chamada

curl -i -X POST \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'descricao=Conta de luz' \
  -d 'valor=123.92' \
  -d 'data_vencimento=2015-10-10' \
  -d 'tipo_lancamento_id=1' \
  -d 'conta_id=8' \
  -d 'categoria_id=98' \
  -d 'itens_adicionais[][descricao]=Conta de água' \
  -d 'itens_adicionais[][valor]=321.00' \
  -d 'itens_adicionais[][categoria_id]=50' \
  'https://api.granatum.com.br/v1/lancamentos?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 91,
  "grupo_id": null,
  "lancamento_transferencia_id": null,
  "categoria_id": 98,
  "centro_custo_lucro_id": null,
  "tipo_custo_nivel_producao_id": null,
  "tipo_custo_apropriacao_produto_id": null,
  "conta_id": 8,
  "forma_pagamento_id": null,
  "pessoa_id": null,
  "tipo_lancamento_id": 2,
  "descricao": "Conta de luz",
  "tipo_documento_id": null,
  "documento": "",
  "data_vencimento": "2015-10-10",
  "valor": "123.92",
  "data_pagamento": null,
  "data_competencia": "2015-10-10",
  "observacao": "",
  "pagamento_automatico": false,
  "numero_repeticao": 1,
  "total_repeticoes": 1,
  "periodicidade": null,
  "pedido_id": null,
  "lancamento_composto_id": 21
  "itens_adicionais": [
    {"id": 92, "descricao": "Conta de água", "valor": "321.00", "categoria_id": 50, "lancamento_composto_id": 21 ...}
  ]
}

Editar um lançamento

Altera os dados do lançamento informado pelo ID.

Método e URL

PUT https://api.granatum.com.br/v1/lancamentos/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

descricaoDescrição do lançamentoOpcional
conta_idID da conta bancáriaOpcional
categoria_idID da categoriaOpcional
valorUse negativo para despesa e positivo para receita. Ex.: -10.00 e 10.00Opcional
data_vencimentoData de vencimento do lançamentoOpcional
data_pagamentoData do pagamento. Indica que o lançamento está pagoOpcional
data_competenciaData da competência. Data que indica a efetiva data do recebimento.Opcional
centro_custo_lucro_idID do centro de custo e lucroOpcional
forma_pagamento_idID da forma de pagamentoOpcional
pessoa_idID do cliente no caso de Receita e ID do fornecedor no caso de DespesaOpcional
tipo_documento_idID do tipo de documentoOpcional
total_repeticoesNúmero de vezes que o lançamento será repetidoOpcional
observacaoObservação do lançamentoOpcional
itens_adicionais[]Itens adicionais do lançamento composto
*Caso você esteja editando um lançamento composto, é necessário sempre passar todos os itens
Opcional

Paramêtros dos itens_adicionais

idID do itemRequerido
descricaoDescrição do itemOpcional
categoria_idID da categoriaOpcional
valorSomente é permitido valores positivosOpcional
centro_custo_lucro_idID do centro de custo e lucroOpcional
forma_pagamento_idID da forma de pagamentoOpcional
pessoa_idID do cliente no caso de Receita e ID do fornecedor no caso de DespesaOpcional

Exemplo de chamada

curl -i -X PUT \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'data_vencimento=2015-10-18' \
  -d 'itens_adicionais[][id]=92' \
  -d 'itens_adicionais[][descricao]=Tarifa extra' \
  'https://api.granatum.com.br/v1/lancamentos/91?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 91,
  "grupo_id": null,
  "lancamento_transferencia_id": null,
  "categoria_id": 98,
  "centro_custo_lucro_id": null,
  "tipo_custo_nivel_producao_id": null,
  "tipo_custo_apropriacao_produto_id": null,
  "conta_id": 8,
  "forma_pagamento_id": null,
  "pessoa_id": null,
  "tipo_lancamento_id": 2,
  "descricao": "Conta de luz",
  "tipo_documento_id": null,
  "documento": "",
  "data_vencimento": "2015-10-18",
  "valor": "123.92",
  "data_pagamento": null,
  "data_competencia": "2015-10-10",
  "observacao": "",
  "pagamento_automatico": false,
  "numero_repeticao": 1,
  "total_repeticoes": 1,
  "periodicidade": null,
  "pedido_id": null,
  "lancamento_composto_id": 21
  "itens_adicionais": [
    {"id": 92, "descricao": "Tarifa extra", "valor": "321.00", "categoria_id": 50, "lancamento_composto_id": 21 ...}
  ]
}

Listar lançamentos

Lista todos lançamentos

Método e URL

GET https://api.granatum.com.br/v1/lancamentos

Substitua inclusive os colchetes

Query String

access_token Token do cliente Granatum Requerido
conta_id ID da Conta Bancária Requerido
grupo_id ID de agrupamento da repetição dos Lançamentos Opcional
lancamento_composto_id ID de agrupamento dos itens de um lançamento Opcional
data_inicio Data de início para filtro da data de vencimento ou pagamento Opcional
data_fim Data de fim para filtro da data de vencimento ou pagamento
*Sempre informar as duas datas para o filtro funcionar
Opcional
start Indica o offset da paginação. 50 registros por listagem. Opcional
tipo_view Opções: list e count Opcional
tipo Opções: recebido, pago, a_pagar, a_receber Opcional
access_token=[token_cliente_granatum]&conta_id=[conta_bancaria_id]

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/lancamentos?access_token=token_cliente_granatum&conta_id=[conta_bancaria_id]'

Exemplo de resposta

[{
  "id": 91,
  "grupo_id": null,
  "lancamento_transferencia_id": null,
  "categoria_id": 98,
  "centro_custo_lucro_id": null,
  "tipo_custo_nivel_producao_id": null,
  "tipo_custo_apropriacao_produto_id": null,
  "conta_id": 8,
  "forma_pagamento_id": null,
  "pessoa_id": null,
  "descricao": "Conta de luz",
  "tipo_documento_id": null,
  "documento": "",
  "data_vencimento": "2015-10-10",
  "valor": "-123.92",
  "data_pagamento": null,
  "data_competencia": "2015-10-10",
  "observacao": "",
  "pagamento_automatico": false,
  "numero_repeticao": 1,
  "total_repeticoes": 1,
  "periodicidade": null,
  "pedido_id": null,
  "lancamento_composto_id": null
}]

Consultar um lançamento

Retorna os dados do lançamento informado pelo ID.

Método e URL

GET https://api.granatum.com.br/v1/lancamentos/:id

Substitua inclusive os colchetes

Query String

access_token=[token_cliente_granatum]

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/lancamentos/91?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 91,
  "grupo_id": null,
  "lancamento_transferencia_id": null,
  "categoria_id": 98,
  "centro_custo_lucro_id": null,
  "tipo_custo_nivel_producao_id": null,
  "tipo_custo_apropriacao_produto_id": null,
  "conta_id": 8,
  "forma_pagamento_id": null,
  "pessoa_id": null,
  "descricao": "Conta de luz",
  "tipo_documento_id": null,
  "documento": "",
  "data_vencimento": "2015-10-18",
  "valor": "-123.92",
  "data_pagamento": null,
  "data_competencia": "2015-10-10",
  "observacao": "",
  "pagamento_automatico": false,
  "numero_repeticao": 1,
  "total_repeticoes": 1,
  "periodicidade": null,
  "pedido_id": null,
  "lancamento_composto_id": null
}

Excluir um lançamento

Remove do sistema o lançamento informado pelo ID.

Método e URL

DELETE https://api.granatum.com.br/v1/lancamentos/:id

Substitua inclusive os colchetes

Query String

access_token=[token_cliente_granatum]

Exemplo de chamada

curl -i -X DELETE \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/lancamentos/91?access_token=token_cliente_granatum'

Exemplo de resposta

true

Cobranças - Granatum Pagamentos

Criar uma cobrança

Cria uma cobrança que pode ser via boleto ou cartão de crédito, com envio por e-mail.

Método e URL

POST https://api.granatum.com.br/v1/cobrancas

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

conta_idID da conta bancáriaRequerido
cliente_idID do clienteRequerido
data_vencimentoData de vencimento do lançamentoRequerido
tipo_cobrancaEscolha a foma de pagamento ('boleto' ou 'cartao_credito')Requerido
itens[]Itens da cobrançaRequerido
emailEmail do cliente caso deseje enviar a cobrança por e-mail automaticamenteOpcional
percentual_multaO percentual de multa padrão é %2 para boletos atrasadosOpcional
cobrar_jurosO padrão é cobrar juros de 1% para boletos atrasadosOpcional
instrucoes_boletoEspecificar um texto que será inserido nas instruções do boletoOpcional
permitir_segunda_viaO padrão é permitir a emissão da 2ª via do boletoOpcional
dias_para_emissaoO número de dias antes do vencimento que a cobrança deve ser emitida, se não informado será usada a configuração padrão de 5 diasOpcional
tipo_emissao 1 - Emitir a cobrança agora independente da data de vencimento e dos dias para emissão
2 - Agendar ou emitir a cobrança de acordo com a data de vencimento e os dias para emissão
*Caso não seja informado, será usado o tipo 2
Opcional
periodicidade Use uma das opções caso queira gerar uma cobrança com repetição:
D7 - Semanal
D15 - Quinzenal
M1 - Mensal
M2 - Bimestral
M3 - Trimestral
M6 - Semestral
M12 - Anual
Opcional
parcelasInforme o número de parcelas que deseja gerar. Caso não seja informado, a repetição será para sempre.Opcional

Paramêtros dos itens

descricaoDescrição do itemRequerido
categoria_idID da categoriaRequerido
valorSomente é permitido valores positivosRequerido
centro_custo_lucro_idID do centro de custo e lucroOpcional

Exemplo de chamada

curl -i -X POST \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'conta_id=8' \
  -d 'cliente_id=10' \
  -d 'data_vencimento=2016-08-12' \
  -d 'tipo_cobranca=boleto' \
  -d 'itens[][descricao]=Criação de site' \
  -d 'itens[][valor]=123.92' \
  -d 'itens[][categoria_id]=98' \
  'https://api.granatum.com.br/v1/cobrancas?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id":1245,
  "valor":"123.92",
  "valor_taxa":"-4.9",
  "percentual_multa":"2.0",
  "cobrar_juros":1,
  "valor_multa_juros":"0.0",
  "valor_pago":null,
  "instrucoes_boleto":null,
  "permitir_segunda_via":1,
  "lancamento_ids":"7835741,7835742",
  "forma_pagamento_id":123096,
  "cliente_id":10,
  "conta_id":8,
  "email":null,
  "data_vencimento":"2016-08-12",
  "data_a_transferir":null,
  "data_transferindo":null,
  "data_transferido":null,
  "data_cancelamento":null,
  "status_id":1,
  "status_descricao":"Pendente",
  "link_publico":"https://secure.granatum.com.br/pagar/EBA16D9D3F064F9FA14113375671B127"
}

Listar cobranças

Lista todas cobranças

Método e URL

GET https://api.granatum.com.br/v1/cobrancas

Substitua inclusive os colchetes

Query String

access_token Token do cliente Granatum Requerido
data_inicio Data de vencimento maior ou igual a data_inicio Requerido
data_fim Data de vencimento menor ou igual a data_fim Requerido
start Indica o offset da paginação. 50 registros por listagem. Opcional
tipo_view Opções: all ou count Opcional
status Opções: agendado, pendente, cliente_pagou, transferindo ou transferido Opcional
access_token=[token_cliente_granatum]&data_inicio=[data_inicio]

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/cobrancas?access_token=token_cliente_granatum&data_inicio=2015-01-01'

Exemplo de resposta

[{
  "id":1245,
  "valor":"123.92",
  "valor_taxa":"-4.9",
  "percentual_multa":"2.0",
  "cobrar_juros":1,
  "valor_multa_juros":"0.0",
  "valor_pago":null,
  "instrucoes_boleto":null,
  "permitir_segunda_via":1,
  "lancamento_ids":"7835741,7835742",
  "forma_pagamento_id":123096,
  "cliente_id":10,
  "conta_id":8,
  "email":null,
  "data_vencimento":"2016-08-12",
  "data_a_transferir":null,
  "data_transferindo":null,
  "data_transferido":null,
  "data_cancelamento":null,
  "status_id":1,
  "status_descricao":"Pendente",
  "link_publico":"https://secure.granatum.com.br/pagar/EBA16D9D3F064F9FA14113375671B127"
}]

Consultar uma cobrança

Retorna os dados da cobrança informada pelo ID.

Método e URL

GET https://api.granatum.com.br/v1/cobrancas/:id

Substitua inclusive os colchetes

Query String

access_token=[token_cliente_granatum]

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/cobrancas/1245?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id":1245,
  "valor":"123.92",
  "valor_taxa":"-4.9",
  "percentual_multa":"2.0",
  "cobrar_juros":1,
  "valor_multa_juros":"0.0",
  "valor_pago":null,
  "instrucoes_boleto":null,
  "permitir_segunda_via":1,
  "lancamento_ids":"7835741,7835742",
  "forma_pagamento_id":123096,
  "cliente_id":10,
  "conta_id":8,
  "email":null,
  "data_vencimento":"2016-08-12",
  "data_a_transferir":null,
  "data_transferindo":null,
  "data_transferido":null,
  "data_cancelamento":null,
  "status_id":1,
  "status_descricao":"Pendente",
  "link_publico":"https://secure.granatum.com.br/pagar/EBA16D9D3F064F9FA14113375671B127"
}

Categorias

Criar uma categoria

Cria uma categoria que pode ser utilizada como complemento ao criar um Lançamento.

Método e URL

POST https://api.granatum.com.br/v1/categorias

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

descricaoNome da categoriaRequerido
corEm formato hexadecimalOpcional
parent_idIdentifica a categoria pai desta que está sendo criadaOpcional

Exemplo de chamada

curl -i -X POST \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'descricao=Automotivo' \
  -d 'cor=#123123' \
  'https://api.granatum.com.br/v1/categorias?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 91,
  "descricao": "Automotivo",
  "cor": "#232323",
  "parent_id": 90, 
  "categorias_filhas":[]
}

Editar uma categoria

Altera os dados da categoria informada pelo ID.

Método e URL

PUT https://api.granatum.com.br/v1/categorias/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

descricaoNome da categoria
corEm formato hexadecimalOpcional
parent_idIdentifica a categoria pai desta que está sendo criadaOpcional

Exemplo de chamada

curl -i -X PUT \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'descricao=Automotivo' \
  'https://api.granatum.com.br/v1/categorias/91?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 91,
  "descricao": "Automotivo",
  "cor": "#232323",
  "parent_id": 90, 
  "categorias_filhas":[]
}

Listar categorias

Retorna a lista as categorias.

Método e URL

GET https://api.granatum.com.br/v1/categorias

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

$ curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/categorias?access_token=token_cliente_granatum'

Exemplo de resposta

[{
  "id": 43,
  "descricao": "Alimentos",
  "cor": "#114477",
  "wgi_usuario_id": 29,
  "categorias_filhas": []
}]

Consultar uma categoria

Retorna os dados da categoria informada pelo ID.

Método e URL

GET https://api.granatum.com.br/v1/categorias/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

$ curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/categorias/43?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 43,
  "descricao": "Alimentos",
  "cor": "#114477",
  "wgi_usuario_id": 29,
  "categorias_filhas": []
}

Excluir uma categoria

Remove do sistema a categoria informada pelo ID.

Método e URL

DELETE https://api.granatum.com.br/v1/categorias/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

$ curl -i -X DELETE \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/categorias/43?access_token=token_cliente_granatum'

Exemplo de resposta

true

Clientes

Criar um cliente

Cria um Cliente que pode ser utilizado como complemento ao criar um Lançamento.

Método e URL

POST https://api.granatum.com.br/v1/clientes

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

Nome fantasia do fornecedor
nomeNome do fornecedorRequerido
nome_fantasiaOpcional
documentoCNPJ da empresaOpcional
inscricao_estadualInscrição Estadual da empresaOpcional
telefoneTelefone da empresaOpcional
emailEmail da empresaOpcional
enderecoApenas logradouro. Ex: Rua 13 de maio.Opcional
endereco_numeroNúmero do imóvelOpcional
endereco_complementoComplemento do endereço do imóvelOpcional
bairroOpcional
cepCódigo postal do imóvelOpcional
cidade_idID da cidade do Imóvel.Opcional
estado_idID do estado do Imóvel. Verifique os códigos aqui.Opcional
observacaoOpcional
fornecedorIndica se o fornecedor cadastro é também um fornecedor. Valor booleano.Opcional

Exemplo de chamada

curl -i -X POST \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'nome=Granatum Financeiro' \
  -d 'nome_fantasia=Granatum Financeiro Controle Financeiro Online' \
  -d 'documento=68527025000181' \
  'https://api.granatum.com.br/v1/clientes?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id":3,
  "nome":"Granatum Financeiro",
  "nome_fantasia":"Granatum Financeiro Controle Financeiro Online",
  "documento":"68527025000181",
  "telefone":"",
  "endereco":"",
  "endereco_numero":"",
  "endereco_complemento":"",
  "bairro":"",
  "cep":"",
  "cidade_id":null,
  "estado_id":null,
  "email":"",
  "observacao":"",
  "estado":null,
  "cidade":null
}

Edtar um cliente

Altera os dados do cliente informado pelo ID.

Método e URL

PUT https://api.granatum.com.br/v1/clientes/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

Nome fantasia do fornecedor
nomeNome do fornecedorOpcional
nome_fantasiaOpcional
documentoCNPJ da empresaOpcional
inscricao_estadualInscrição Estadual da empresaOpcional
telefoneTelefone da empresaOpcional
emailEmail da empresaOpcional
enderecoApenas logradouro. Ex: Rua 13 de maio.Opcional
endereco_numeroNúmero do imóvelOpcional
endereco_complementoComplemento do endereço do imóvelOpcional
bairroOpcional
cepCódigo postal do imóvelOpcional
cidade_idID da cidade do Imóvel.Opcional
estado_idID do estado do Imóvel. Verifique os códigos aqui.Opcional
observacaoOpcional
fornecedorIndica se o fornecedor cadastro é também um fornecedor. Valor booleano.Opcional

Exemplo de chamada

curl -i -X PUT \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'email=contato@granatum.com.br' \
  'https://api.granatum.com.br/v1/clientes/3?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id":3,
  "nome":"Granatum Financeiro",
  "nome_fantasia":"Granatum Financeiro Controle Financeiro Online",
  "documento":"68527025000181",
  "telefone":"",
  "endereco":"",
  "endereco_numero":"",
  "endereco_complemento":"",
  "bairro":"",
  "cep":"",
  "cidade_id":null,
  "estado_id":null,
  "email":"contato@granatum.com.br",
  "observacao":"",
  "estado":null,
  "cidade":null
}

Listar clientes

Retorna a lista de todos os clientes.

Método e URL

GET https://api.granatum.com.br/v1/clientes

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros de busca

documentoCNPJ/CPF sem máscaraOpcional
termBusca aproximada na razão social, e-mail, endereço e telefoneOpcional

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/clientes? \
  access_token=token_cliente_granatum'

Exemplo de resposta

[
  {"id":1,"nome":"Empresa ficticia 1","nome_fantasia":null,"documento":"","telefone":"","endereco":"","endereco_numero":null,"endereco_complemento":null,"bairro":null,"cep":"","cidade_id":null,"estado_id":null,"email":"","observacao":"","estado":null,"cidade":null},
  {"id":2,"nome":"Empresa ficticia 2","nome_fantasia":null,"documento":"","telefone":"","endereco":"","endereco_numero":null,"endereco_complemento":null,"bairro":null,"cep":"","cidade_id":null,"estado_id":null,"email":"","observacao":"","estado":null,"cidade":null},
  {"id":3,"nome":"Granatum Financeiro","nome_fantasia":"Granatum Financeiro Controle Financeiro Online","documento":"68527025000181","telefone":"","endereco":"","endereco_numero":"","endereco_complemento":"","bairro":"","cep":"","cidade_id":null,"estado_id":null,"email":"","observacao":"","estado":null,"cidade":null}
]

Consultar cliente

Retorna os dados do cliente informado pelo ID.

Método e URL

GET https://api.granatum.com.br/v1/clientes/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/clientes/2? \
  access_token=token_cliente_granatum'

Exemplo de resposta

{"id":2,"nome":"Empresa ficticia 2","nome_fantasia":null,"documento":"","telefone":"","endereco":"","endereco_numero":null,"endereco_complemento":null,"bairro":null,"cep":"","cidade_id":null,"estado_id":null,"email":"","observacao":"","estado":null,"cidade":null}

Excluir cliente

Remove do sistema o cliente informado pelo ID.

Método e URL

DELETE https://api.granatum.com.br/v1/clientes/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

curl -i -X DELETE \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/clientes/2? \
  access_token=token_cliente_granatum'

Exemplo de resposta

true

Fornecedores

Criar um fornecedor

Cria um Fornecedor que pode ser utilizado como complemento ao criar um Lançamento.

Método e URL

POST https://api.granatum.com.br/v1/fornecedores

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

Nome fantasia do fornecedor
nomeNome do fornecedorRequerido
nome_fantasiaOpcional
documentoCNPJ da empresaOpcional
inscricao_estadualInscrição Estadual da empresaOpcional
telefoneTelefone da empresaOpcional
emailEmail da empresaOpcional
enderecoApenas logradouro. Ex: Rua 13 de maio.Opcional
endereco_numeroNúmero do imóvelOpcional
endereco_complementoComplemento do endereço do imóvelOpcional
bairroOpcional
cepCódigo postal do imóvelOpcional
cidade_idID da cidade do Imóvel.Opcional
estado_idID do estado do Imóvel. Verifique os códigos aqui.Opcional
observacaoOpcional
clienteIndica se o fornecedor cadastro é também um cliente. Valor booleano.Opcional

Exemplo de chamada

curl -i -X POST \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'nome=Granatum Financeiro' \
  -d 'nome_fantasia=Granatum Financeiro Online' \
  -d 'documento=26328240000103' \
  'https://api.granatum.com.br/v1/fornecedores?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 1,
  "nome": "Granatum Financeiro",
  "nome_fantasia": "Granatum Financeiro Online",
  "documento": "26328240000103",
  "inscricao_estadual": null,
  "inscricao_municipal": null,
  "telefone": null,
  "endereco": null,
  "endereco_numero": null,
  "endereco_complemento": null,
  "bairro": null,
  "cep": null,
  "cidade_id": null,
  "estado_id": null,
  "email": null,
  "observacao": null,
  "fornecedor": true,
  "estado": null,
  "cidade": null
}

Editar um fornecedor

Altera os dados do Fornecedor informado pelo ID.

Método e URL

PUT https://api.granatum.com.br/v1/fornecedores/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

Nome fantasia do fornecedor
nomeNome do fornecedorOpcional
nome_fantasiaOpcional
documentoCNPJ da empresaOpcional
inscricao_estadualInscrição Estadual da empresaOpcional
telefoneTelefone da empresaOpcional
emailEmail da empresaOpcional
enderecoApenas logradouro. Ex: Rua 13 de maio.Opcional
endereco_numeroNúmero do imóvelOpcional
endereco_complementoComplemento do endereço do imóvelOpcional
bairroOpcional
cepCódigo postal do imóvelOpcional
cidade_idID da cidade do Imóvel.Opcional
estado_idID do estado do Imóvel. Verifique os códigos aqui.Opcional
observacaoOpcional
clienteIndica se o fornecedor cadastro é também um cliente. Valor booleano.Opcional

Exemplo de chamada

curl -i -X PUT \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'telefone=11 99653-5631' \
  'https://api.granatum.com.br/v1/fornecedores/1?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 1,
  "nome": "Granatum Financeiro",
  "nome_fantasia": "Granatum Financeiro Online",
  "documento": "26328240000103",
  "inscricao_estadual": null,
  "inscricao_municipal": null,
  "telefone": "11 99653-5631",
  "endereco": null,
  "endereco_numero": null,
  "endereco_complemento": null,
  "bairro": null,
  "cep": null,
  "cidade_id": null,
  "estado_id": null,
  "email": null,
  "observacao": null,
  "fornecedor": true,
  "estado": null,
  "cidade": null
}

Listar fornecedores

Retorna a lista de fornecedores.

Método e URL

GET https://api.granatum.com.br/v1/fornecedores

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros de busca

documentoCNPJ/CPF sem máscaraOpcional
termBusca aproximada na razão social, e-mail, endereço e telefoneOpcional

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/fornecedores?access_token=token_cliente_granatum'

Exemplo de resposta

[{
  "id": 18,
  "nome": "Granatum Financeiro",
  "nome_fantasia": "Granatum Financeiro Online",
  "documento": "26328240000103",
  "telefone": null,
  "endereco": null,
  "endereco_numero": null,
  "endereco_complemento": null,
  "bairro": null,
  "cep": null,
  "cidade_id": null,
  "estado_id": null,
  "email": null,
  "observacao": null,
  "estado": null,
  "cidade": null
}]

Consultar fornecedor

Retorna os dados do fornecedor informado pelo ID.

Método e URL

GET https://api.granatum.com.br/v1/fornecedores/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/fornecedores/18?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 18,
  "nome": "Granatum Financeiro",
  "nome_fantasia": "Granatum Financeiro Online",
  "documento": "26328240000103",
  "telefone": null,
  "endereco": null,
  "endereco_numero": null,
  "endereco_complemento": null,
  "bairro": null,
  "cep": null,
  "cidade_id": null,
  "estado_id": null,
  "email": null,
  "observacao": null,
  "estado": null,
  "cidade": null
}

Excluir um fornecedor

Remove um fornecedor informado pelo ID.

Método e URL

DELETE https://api.granatum.com.br/v1/fornecedores/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

curl -i -X DELETE \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/fornecedores/18?access_token=token_cliente_granatum'

Exemplo de resposta

true

Contas bancárias

Criar uma conta bancária

Cria uma conta bancária que deve ser utilizada como complemento ao criar um Lançamento.

Método e URL

POST https://api.granatum.com.br/v1/contas

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

descricaoNome da categoriaRequerido
banco_idCódigo do bancoOpcional
agenciaNúmero da agência (somente números)Opcional
numeroNúmero da conta (somente números)Opcional
nome_gerenteGerente responsável pela conta no bancoOpcional
telefone_gerenteTelefone do gerenteOpcional

Exemplo de chamada

curl -i -X POST \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'descricao=Conta Santander' \
  -d 'banco_id=10' \
  -d 'agencia=123-0' \
  -d 'numero=32423-3' \
  -d 'nome_gerente=Marcio Almeida' \
  -d 'telefone_gerente=11 2332-3455' \
  'https://api.granatum.com.br/v1/contas?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 1,
  "descricao": "Conta Santander",
  "banco_id": "10",
  "agencia": "123-0",
  "numero": "32423-3",
  "nome_gerente": "Marcio Almeida",
  "telefone_gerente": "11 2332-3455"
}

Editar uma conta bancária

Altera os dados da conta bancária informada pelo ID.

Método e URL

PUT https://api.granatum.com.br/v1/contas/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

descricaoNome da categoriaOpcional
banco_idCódigo do bancoOpcional
agenciaNúmero da agência (somente números)Opcional
numeroNúmero da conta (somente números)Opcional
nome_gerenteGerente responsável pela conta no bancoOpcional
telefone_gerenteTelefone do gerenteOpcional

Exemplo de chamada

curl -i -X POST \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'descricao=C/C Santander' \
  'https://api.granatum.com.br/v1/contas/1?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 1,
  "descricao": "C/C Santander",
  "banco_id": "10",
  "agencia": "123-0",
  "numero": "32423-3",
  "nome_gerente": "Marcio Almeida",
  "telefone_gerente": "11 2332-3455"
}

Listar contas bancárias

Retorna a lista as contas.

Método e URL

GET https://api.granatum.com.br/v1/contas

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

$ curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/contas?access_token=token_cliente_granatum'

Exemplo de resposta

[{
  "id": 1,
  "descricao": "Conta Santander",
  "saldo": "0.0"
}]

Consultar uma conta bancária

Retorna os dados da conta informada pelo ID.

Método e URL

GET https://api.granatum.com.br/v1/contas/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

$ curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/contas/1?access_token=token_cliente_granatum'

Exemplo de resposta

[{
  "id": 1,
  "descricao": "C/C Santander",
  "saldo": "0.0"
}]

Excluir uma conta bancária

Remove do sistema a conta informada pelo ID.

Método e URL

DELETE https://api.granatum.com.br/v1/contas/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

$ curl -i -X DELETE \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/contas/1?access_token=token_cliente_granatum'

Exemplo de resposta

true

Centros de Custo e Lucro

Criar um centro de custo e lucro

Cria um Centro de Custo/Lucro que pode ser utilizado como complemento ao criar um Lançamento.

Método e URL

POST https://api.granatum.com.br/v1/centros_custo_lucro

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

descricaoNome do centro de custo e lucroRequerido
parent_idIdentifica a categoria pai desta que está sendo criadaOpcional

Exemplo de chamada

curl -i -X POST \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'descricao=Setor de Compras' \
  'https://api.granatum.com.br/v1/centros_custo_lucro?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 3, 
  "descricao": "Setor Compras",
  "parent_id": 2,
  "centros_custo_lucro_filhos":[]
}

Editar um centro de custo e lucro

Altera os dados do Centro de Custo/Lucro informado pelo ID.

Método e URL

PUT https://api.granatum.com.br/v1/centros_custo_lucro/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

descricaoNome do centro de custo e lucroOpcional
parent_idIdentifica a categoria pai desta que está sendo criadaOpcional

Exemplo de chamada

curl -i -X PUT \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'descricao=Recursos Humanos' \
  'https://api.granatum.com.br/v1/centros_custo_lucro/3?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 3, 
  "descricao": "Recursos Humanos",
  "parent_id": 2,
  "centros_custo_lucro_filhos":[]
}

Listar centros de custo e lucro

Retorna a lista todos os centros de custo e lucro.

Método e URL

GET https://api.granatum.com.br/v1/centros_custo_lucro

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/centros_custo_lucro?access_token=token_cliente_granatum'

Exemplo de resposta

[
  { "id": 1, "descricao": "Prédio", "centros_custo_lucro_filhos":[] },
  { "id": 2, "descricao": "Automóvel", "centros_custo_lucro_filhos":[] },
  { "id": 3, "descricao": "Setor Compras", "centros_custo_lucro_filhos":[] }
]			

Consultar um centro de custo e lucro

Retorna os dados do Centro de Custo/Lucro informado pelo ID.

Método e URL

GET https://api.granatum.com.br/v1/centros_custo_lucro/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/centros_custo_lucro/2?access_token=token_cliente_granatum'

Exemplo de resposta

{ 
  "id": 2, 
  "descricao": "Automóvel" ,
  "centros_custo_lucro_filhos":[]
}

Excluir um centro de custo e lucro

Remove do sistema o Centro de Custo/Lucro informado pelo ID.

Método e URL

DELETE https://api.granatum.com.br/v1/centros_custo_lucro/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

curl -i -X DELETE \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/centros_custo_lucro/2?access_token=token_cliente_granatum'

Exemplo de resposta

true

Formas de pagamento

Criar uma forma de pagamento

Cria uma Forma de Pagamento que pode ser utilizado como complemento ao criar um Lançamento.

Método e URL

POST https://api.granatum.com.br/v1/formas_pagamento

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

descricaoNome da forma de pagamentoRequerido

Exemplo de chamada

curl -i -X POST \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'descricao=Transferência' \
   'https://api.granatum.com.br/v1/formas_pagamento?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 2, 
  "descricao": "Transferência"
}

Editar uma forma de pagamento

Altera os dados de uma Forma de Pagamento informada pelo ID.

Método e URL

PUT https://api.granatum.com.br/v1/formas_pagamento/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

descricaoNome da forma de pagamentoOpcional

Exemplo de chamada

curl -i -X PUT \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'descricao=Boleto' \
   'https://api.granatum.com.br/v1/formas_pagamento/2?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 2, 
  "descricao": "Boleto"
}

Listar formas de pagamento

Lista todos os formas de pagamento

Método e URL

GET https://api.granatum.com.br/v1/formas_pagamento

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/formas_pagamento?access_token=token_cliente_granatum'

Exemplo de resposta

[
  {"id":1,"descricao":"Dinheiro"}
  {"id":2,"descricao":"Boleto"},
]

Consultar uma forma de pagamento

Retorna os dados de uma forma de pagamento informada pelo ID.

Método e URL

GET https://api.granatum.com.br/v1/formas_pagamento/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/formas_pagamento/1?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id":1,
  "descricao":"Dinheiro"
}

Excluir uma forma de pagamento

Remove do sistema a forma de pagamento informada pelo ID.

Método e URL

DELETE https://api.granatum.com.br/v1/formas_pagamento/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

curl -i -X DELETE \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/formas_pagamento/1?access_token=token_cliente_granatum'

Exemplo de resposta

true

Cidades

Listar cidades

Retorna a lista de cidades referente ao estado informado na requisição.

Método e URL

GET https://api.granatum.com.br/v1/cidades

Query String

access_token=[token_cliente_granatum]&estado_id=[id_do_estado]

Substitua inclusive os colchetes

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/cidades?access_token=token_cliente_granatum&estado_id=26'

Exemplo de resposta

[{
  "id": 492,
  "nome": "Água Branca",
  "estado_id": 2
},{
  "id": 493,
  "nome": "Anadia",
  "estado_id": 2
},{
  "id": 494,
  "nome": "Arapiraca",
  "estado_id": 2
},
  ...
]

Estados

Listar estados

Retorna a lista as estados.

Método e URL

GET https://api.granatum.com.br/v1/estados

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/estados?access_token=token_cliente_granatum'

Exemplo de resposta

[{
  "id": 1,
  "sigla": "AC",
  "nome": "Acre"
},{
  "id": 2,
  "sigla": "AL",
  "nome": "Alagoas"
},{
  "id": 3,
  "sigla": "AM",
  "nome": "Amazonas"
},{
  ... 
}]
      

Bancos

Listar bancos

Retorna a lista de bancos

Método e URL

GET https://api.granatum.com.br/v1/bancos

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/bancos?access_token=token_cliente_granatum'

Exemplo de resposta

[
  {
    "id": 1,
    "nome": "Banco do Brasil S/A"
  },
  {
    "id": 2,
    "nome": "Banco da Amazônia S/A"
  },
  {
    "id": 3,
    "nome": "Banco do Nordeste do Brasil S/A"
  },
  {
    "id": 4,
    "nome": "Banco do Estado de São Paulo S/A"
  },
  {
    ...
  }
]

Pluga

Integrações prontas

O Granatum está integrado a Pluga, uma plataforma que te ajuda a fazer integrações entre ferramentas sem precisar saber nada de programação. É Bem simples!

Você só precisa definir regras para ver a mágica acontecer.

Por exemplo, se você usa o PagSeguro para receber dos seus clientes você poderá definir uma regra como essa: A cada recebimento no PagSeguro, inclua um lançamento de recebimento no Granatum.

E dá para fazer muito mais, veja só alguns exemplos:

Exemplos de integrações prontas