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 Query String 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

CampoDescriçãoTipoObrigatoriedade
descricaoDescrição do lançamentoStringRequerido
conta_idID da conta bancáriaIntegerRequerido
categoria_idID da categoriaIntegerRequerido
valorUse negativo para despesa e positivo para receita. Ex.: -10.00 e 10.00DecimalRequerido
data_vencimentoData de vencimento do lançamentoStringRequerido
data_pagamentoData do pagamento. Indica que o lançamento está pagoStringOpcional
data_competenciaData da competência. Data que indica a efetiva data do recebimento.StringOpcional
centro_custo_lucro_idID do centro de custo e lucroIntegerOpcional
forma_pagamento_idID da forma de pagamentoIntegerOpcional
pessoa_idID do cliente no caso de Receita e ID do fornecedor no caso de DespesaIntegerOpcional
tipo_documento_idID do tipo de documentoIntegerOpcional
documentoNúmero do documentoStringOpcional
tipo_custo_nivel_producao_idEnvia a ID de um tipo custo nivel produçãoIntegerOpcional
tipo_custo_apropriacao_produto_idEnvia a ID de um tipo custo apropriação produtoIntegerOpcional
tags[][id]ID da tag, pode ser passado uma lista de tagsArray[Integer]Opcional
periodicidadePeriodicidade da repetição:
  • D7 - Semanal
  • D15 - Quinzenal
  • M1 - Mensal
  • M2 - Bimestral
  • M3 - Trimestral
  • M6 - Semestral
  • M12 - Anual
StringOpcional
total_repeticoesNúmero de vezes que o lançamento será repetido
*O valor deve ser sempre NULL se o campo infinito estiver definido como TRUE
IntegerOpcional
infinitoCaso a repetição não tenha data para acabar, valor padrão é FALSE
*O valor deve ser sempre FALSE se o campo total_repeticoes estiver definido
BooleanOpcional
observacaoObservação do lançamentoStringOpcional
pagamento_automaticoDar baixa automática do lançamento na data de vencimento, valor padrão é FALSEBooleanOpcional
itens_adicionais[]Itens adicionais para criar lançamento composto
*Ver parâmetros na tabela abaixo
ArrayOpcional

Paramêtros dos itens_adicionais

CampoDescriçãoTipoObrigatoriedade
descricaoDescrição do itemStringRequerido
categoria_idID da categoriaIntegerRequerido
valorUse negativo para despesa e positivo para receita. Ex.: -10.00 e 10.00DecimalRequerido
centro_custo_lucro_idID do centro de custo e lucroIntegerOpcional
forma_pagamento_idID da forma de pagamentoIntegerOpcional
pessoa_idID do cliente no caso de Receita e ID do fornecedor no caso de DespesaIntegerOpcional
tipo_custo_nivel_producao_idEnvia a ID de um tipo custo nivel produçãoIntegerOpcional
tipo_custo_apropriacao_produto_idEnvia a ID de um tipo custo apropriação produtoIntegerOpcional
tags[][id]ID da tag, pode ser passado uma lista de tagsArray[Integer]Opcional

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 'tags[][id]=12' \
  -d 'tags[][id]=34' \
  -d 'itens_adicionais[][descricao]=Conta de água' \
  -d 'itens_adicionais[][valor]=321.00' \
  -d 'itens_adicionais[][categoria_id]=50' \
  -d 'itens_adicionais[][tags][][id]=25' \
  '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,
  "modified": "2016-04-29 04:53:25",
  "anexos": [
    {"id": 3},
    {"id": 4}
  ],
  "tags": [
    {"id": 12},
    {"id": 34}
  ],
  "itens_adicionais": [
    {"id": 92, "descricao": "Conta de água", "valor": "321.00", "categoria_id": 50, "lancamento_composto_id": 21 ...
      "tags": [
        {"id": 25}
      ]
    }
  ]
}

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

CampoDescriçãoTipoObrigatoriedade
descricaoDescrição do lançamentoStringOpcional
conta_idID da conta bancáriaIntegerOpcional
categoria_idID da categoriaIntegerOpcional
valorUse negativo para despesa e positivo para receita. Ex.: -10.00 e 10.00DecimalOpcional
data_vencimentoData de vencimento do lançamentoStringOpcional
data_pagamentoData do pagamento. Indica que o lançamento está pagoStringOpcional
data_competenciaData da competência. Data que indica a efetiva data do recebimento.StringOpcional
centro_custo_lucro_idID do centro de custo e lucroIntegerOpcional
forma_pagamento_idID da forma de pagamentoIntegerOpcional
pessoa_idID do cliente no caso de Receita e ID do fornecedor no caso de DespesaIntegerOpcional
tipo_documento_idID do tipo de documentoIntegerOpcional
documentoNúmero do documentoStringOpcional
tipo_custo_nivel_producao_idEnvia a ID de um tipo custo nivel produçãoIntegerOpcional
tipo_custo_apropriacao_produto_idEnvia a ID de um tipo custo apropriação produtoIntegerOpcional
tags[][id]ID da tag, pode ser passado uma lista de tagsArray[Integer]Opcional
periodicidadePeriodicidade da repetição:
  • D7 - Semanal
  • D15 - Quinzenal
  • M1 - Mensal
  • M2 - Bimestral
  • M3 - Trimestral
  • M6 - Semestral
  • M12 - Anual
StringOpcional
total_repeticoesNúmero de vezes que o lançamento será repetido
*O valor deve ser sempre NULL se o campo infinito estiver definido como TRUE
IntegerOpcional
infinitoCaso a repetição não tenha data para acabar, valor padrão é FALSE
*O valor deve ser sempre FALSE se o campo total_repeticoes estiver definido
BooleanOpcional
observacaoObservação do lançamentoStringOpcional
pagamento_automaticoDar baixa automática do lançamento na data de vencimento, valor padrão é FALSEBooleanOpcional
propagar_alteracaoPropagar as alterações para as próximas parcelas, valor padrão é FALSEBooleanOpcional
itens_adicionais[]Itens adicionais para criar lançamento composto
*Ver parâmetros na tabela abaixo
*Caso você esteja editando um lançamento composto, é necessário sempre passar todos os itens
ArrayOpcional*
itens_excluir[][id]IDs dos itens a excluirArray[Integer]Opcional*
*Caso você esteja editando um lançamento composto, é necessário sempre passar todos os itens considerando os campo itens_adicionais e itens_excluir

Paramêtros dos itens_adicionais

CampoDescriçãoTipoObrigatoriedade
idID do itemIntegerRequerido
descricaoDescrição do itemStringRequerido
categoria_idID da categoriaIntegerRequerido
valorUse negativo para despesa e positivo para receita. Ex.: -10.00 e 10.00DecimalRequerido
centro_custo_lucro_idID do centro de custo e lucroIntegerOpcional
forma_pagamento_idID da forma de pagamentoIntegerOpcional
pessoa_idID do cliente no caso de Receita e ID do fornecedor no caso de DespesaIntegerOpcional
tipo_custo_nivel_producao_idEnvia a ID de um tipo custo nivel produçãoIntegerOpcional
tipo_custo_apropriacao_produto_idEnvia a ID de um tipo custo apropriação produtoIntegerOpcional
tags[][id]ID da tag, pode ser passado uma lista de tagsArray[Integer]Opcional

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,
  "modified": "2016-04-29 04:53:25",
  "anexos": [],
  "tags": [],
  "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_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
conta_idID da Conta BancáriaIntegerRequerido
pessoa_idID do cliente no caso de Receita e ID do fornecedor no caso de Despesa
*Caso o campo pessoa_id seja informado, não é necessário passar a conta_id
IntegerOpcional
grupo_idID de agrupamento da repetição dos LançamentosIntegerOpcional
lancamento_composto_idID de agrupamento dos itens de um lançamentoIntegerOpcional
categoria_idID da categoriaIntegerOpcional
centro_custo_lucro_idID do centro de custo e lucroIntegerOpcional
forma_pagamento_idID da Forma de PagamentoIntegerOpcional
tipo_documento_idID do tipo de documentoIntegerOpcional
documentoBUsca exata no campo documentoStringOpcional
tag_idID da tag. Para filtrar as tags, é possível utilizar operadores lógicos na consulta:
  • Para operador "OU": informar os ids de tags separados por "|", ficando "1|2|3"
  • Para operador "E": informar os ids de tags separados por "&", ficando "1&2&3"
StringOpcional
data_inicioData de início para filtro da data conforme o regimeStringOpcional
data_fimData de fim para filtro da data conforme o regime
*Sempre informar as duas datas para o filtro funcionar
StringOpcional
regimeDefine qual data considerar nos filtros de data_inicio e data_fim, o valor padrão é caixa:
  • caixa: Considerara a data de vencimento para lançamentos em aberto ou data de pagamento para lançamentos consolidados
  • competencia: Considera a data de competência
StringOpcional
buscaRealiza busca aproximada no valor, descrição, observação e nome de cliente/fornecedorStringOpcional
tipoFiltra o tipo de lançamento:
  • P: Lancamentos a pagar
  • R: Lançamentos a receber
  • LP: Lancamentos pagos
  • LR: Lançamentos recebidos
  • PA: Lancamentos a pagar atrasados
  • RA: Lançamentos a receber atrasados
  • DT: Desconsiderar transferências
StringOpcional
tipo_viewFormato do retorno dos dados:
  • list: lista simples com o ID e descrição de cada lançamento
  • count: número de lançamentos encontrados com base nos filtros
  • Se não enviar esse parâmetro, a lista de lançamentos será completa com todos os dados
StringOpcional
limitIndica o número de registros por página. o padrão é 50 registros e limite máximo é 500.IntegerOpcional
startIndica o offset da paginação.
Ex.: Para pegar o registros de 151 à 200 use: start=150&limit=50
IntegerOpcional

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,
  "modified": "2016-04-29 04:53:25",
  "anexos": [
    {"id": 3},
    {"id": 4}
  ],
  "tags": [
    {"id": 12},
    {"id": 34}
  ],
  "itens_adicionais": [
    {"id": 92, "descricao": "Tarifa extra", "valor": "321.00", "categoria_id": 50, "lancamento_composto_id": 21 ...}
  ]
}]

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,
  "modified": "2016-04-29 04:53:25",
  "anexos": [
    {"id": 3},
    {"id": 4}
  ],
  "tags": [
    {"id": 12},
    {"id": 34}
  ],
  "itens_adicionais": [
    {"id": 92, "descricao": "Tarifa extra", "valor": "321.00", "categoria_id": 50, "lancamento_composto_id": 21 ...}
  ]
}

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

Transferências

Criar uma transferência

Cria dois lançamentos relacionados entre si através do campo lancamento_transferencia_id, indicando a transferência de uma conta para a outra.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
descricaoDescrição da transferênciaStringRequerido
valorUse no formato 10.00, o valor sempre deve ser positivoDecimalRequerido
dataData da transferência, caso a data seja no futuro, ela ficará agendada e com a baixa automática no dia do vencimentoStringRequerido
conta_origem_idID da conta bancária de origem do dinheiroIntegerRequerido
conta_destino_idID da conta bancária de destino do dinheiroIntegerRequerido

Exemplo de chamada

curl -i -X POST \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'descricao=Transferência entre contas' \
  -d 'valor=123.92' \
  -d 'data=2018-06-12' \
  -d 'conta_origem_id=8' \
  -d 'conta_destino_id=9' \
  'https://api.granatum.com.br/v1/transferencias?access_token=token_cliente_granatum'

Exemplo de resposta

[{
  "id": 91,
  "lancamento_transferencia_id": 92,
  "categoria_id": 98,
  "conta_id": 8,
  "tipo_lancamento_id": 2,
  "descricao": "Transferência entre contas",
  "data_vencimento": "2018-06-12",
  "valor": "123.92",
  "anexos":[],
  "data_pagamento": "2018-06-12",
  "data_competencia": "2018-06-12",
},{
  "id": 92,
  "lancamento_transferencia_id": 91,
  "categoria_id": 98,
  "conta_id": 9,
  "tipo_lancamento_id": 1,
  "descricao": "Transferência entre contas",
  "data_vencimento": "2018-06-12",
  "valor": "-123.92",
  "anexos":[],
  "data_pagamento": "2018-06-12",
  "data_competencia": "2018-06-12",
}]

Editar uma transferência

Altera os dados da transferência informada pelo ID, o ID pode ser qualquer um dos dois lançamentos relacionados.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
descricaoDescrição da transferênciaStringRequerido
valorUse no formato 10.00, o valor sempre deve ser positivoDecimalRequerido
dataData da transferência, caso a data seja no futuro, ela ficará agendada e com a baixa automática no dia do vencimentoStringRequerido
conta_origem_idID da conta bancária de origem do dinheiroIntegerRequerido
conta_destino_idID da conta bancária de destino do dinheiroIntegerRequerido

Exemplo de chamada

curl -i -X PUT \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'descricao=Transferência de valores' \
  -d 'data=2018-06-10' \
  'https://api.granatum.com.br/v1/transferencias/91?access_token=token_cliente_granatum'

Exemplo de resposta

[{
  "id": 91,
  "lancamento_transferencia_id": 92,
  "categoria_id": 98,
  "conta_id": 8,
  "tipo_lancamento_id": 2,
  "descricao": "Transferência de valores",
  "data_vencimento": "2018-06-10",
  "valor": "123.92",
  "anexos":[
    {
      "id": 86
    }
  ],
  "data_pagamento": "2018-06-10",
  "data_competencia": "2018-06-10",
},{
  "id": 92,
  "lancamento_transferencia_id": 91,
  "categoria_id": 98,
  "conta_id": 9,
  "tipo_lancamento_id": 1,
  "descricao": "Transferência de valores",
  "data_vencimento": "2018-06-10",
  "valor": "-123.92",
  "anexos":[
    {
      "id": 86
    }
  ],
  "data_pagamento": "2018-06-10",
  "data_competencia": "2018-06-10",
}]

Consultar uma transferência

Retorna os lançamentos da transferência informada pelo ID, o ID pode ser qualquer um dos dois lançamentos relacionados.

Método e URL

GET https://api.granatum.com.br/v1/transferencias/: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/transferencias/91?access_token=token_cliente_granatum'

Exemplo de resposta

[{
  "id": 91,
  "lancamento_transferencia_id": 92,
  "categoria_id": 98,
  "conta_id": 8,
  "tipo_lancamento_id": 2,
  "descricao": "Transferência entre contas",
  "data_vencimento": "2018-06-12",
  "valor": "123.92",
  "anexos":[
    {
      "id": 86
    }
  ],
  "data_pagamento": "2018-06-12",
  "data_competencia": "2018-06-12",
},{
  "id": 92,
  "lancamento_transferencia_id": 91,
  "categoria_id": 98,
  "conta_id": 9,
  "tipo_lancamento_id": 1,
  "descricao": "Transferência entre contas",
  "data_vencimento": "2018-06-12",
  "valor": "-123.92",
  "anexos":[
    {
      "id": 86
    }
  ],
  "data_pagamento": "2018-06-12",
  "data_competencia": "2018-06-12",
}]

Excluir uma transferência

Remove do sistema a transferência informada pelo ID, o ID pode ser qualquer um dos dois lançamentos relacionados.

Método e URL

DELETE https://api.granatum.com.br/v1/transferencias/: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/transferencias/91?access_token=token_cliente_granatum'

Exemplo de resposta

true

Fazer upload de um anexo em uma transferência

Cria um anexo na transferência informado pelo ID. O ID informado deve ser o do lançamento de despesa/origem da transferência

Método e URL

POST https://api.granatum.com.br/v1/transferencias/:id/anexos

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
fileA requisição precisa ter o cabeçalho 'content-type: multipart/form-data;' para aceitar o envio de arquivos.FileRequerido
filenameNome do anexoStringRequerido

Exemplo de chamada

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

Exemplo de resposta

        {
          "id": 91,
          "filename": "comprovante.pdf",
          "content_type": "application/pdf", 
          "size": 53421, 
          "transferencia_id": 18, 
          "model_id": 2
        }
      

Consultar anexo de uma transferência

Retorna anexo de uma transferência informado pelo ID.

Método e URL

GET https://api.granatum.com.br/v1/transferencias/:id/anexos/:id

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
with_fileEnviar true para receber o conteúdo do arquivoBooleanOpcional
with_urlEnviar true para receber a url do arquivoBooleanOpcional

Exemplo de chamada

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

Exemplo de resposta

{
  "id": 91,
  "filename": "comprovante.pdf",
  "content_type": "application/pdf",
  "size": 53421,
  "transferencia_id": 18,
  "model_id": 7844358,
  "file": "[Arquivo em Base64]"
}

Excluir anexo de uma transferência

Apaga o anexo informado pelo ID.

Método e URL

DELETE https://api.granatum.com.br/v1/transferencias/:id/anexos/: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/transferencias/18/anexos/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

CampoDescriçãoTipoObrigatoriedade
conta_idID da conta bancáriaIntegerRequerido
cliente_idID do clienteIntegerRequerido
data_vencimentoData de vencimento da cobrançaStringRequerido
tipo_cobrancaEscolha a foma de pagamento ('boleto' ou 'cartao_credito')StringRequerido
itens[]Itens da cobrança
*Ver parâmetros na tabela abaixo
ArrayRequerido
data_competenciaData de competência do lançamentoStringOpcional
emailEmail do cliente caso deseje enviar a cobrança por e-mail automaticamenteStringOpcional
percentual_multaO percentual de multa padrão é %2 para boletos atrasadosIntegerOpcional
cobrar_jurosO padrão é cobrar juros de 1% para boletos atrasadosBooleanOpcional
instrucoes_boletoEspecificar um texto que será inserido nas instruções do boletoStringOpcional
permitir_segunda_viaO padrão é permitir a emissão da 2ª via do boletoBooleanOpcional
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 diasIntegerOpcional
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
IntegerOpcional
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
StringOpcional
parcelasInforme o número de parcelas que deseja gerar. Caso não seja informado, a repetição será para sempre.IntegerOpcional

Paramêtros dos itens

CampoDescriçãoTipoObrigatoriedade
descricaoDescrição do itemStringRequerido
categoria_idID da categoriaIntegerRequerido
valorSomente é permitido valores positivosDecimalRequerido
centro_custo_lucro_idID do centro de custo e lucroIntegerOpcional

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",
  "cobranca_hash":"A0SD0S0DSA00DAS0DS0AD0SA"
  "link_publico":"https://secure.granatum.com.br/pagar/A0SD0S0DSA00DAS0DS0AD0SA"
}

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_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
conta_idID da conta bancáriaStringOpcional*
cliente_idID do clienteStringOpcional*
cobranca_hashHash de identificação da cobrançaStringOpcional*
lancamento_composto_idID do lançamento composto para buscar a cobrançaStringOpcional*
data_inicioData de vencimento maior ou igual a data_inicioStringOpcional*
data_fimData de vencimento menor ou igual a data_fimStringOpcional*
startIndica o offset da paginação. 50 registros por listagem.StringOpcional
tipo_viewOpções: all ou countStringOpcional
statusOpções: agendado, pendente, cliente_pagou, transferindo ou transferidoStringOpcional

*Informe pelo menos 1 dos campos opcionais

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",
  "cobranca_hash":"A0SD0S0DSA00DAS0DS0AD0SA"
  "link_publico":"https://secure.granatum.com.br/pagar/A0SD0S0DSA00DAS0DS0AD0SA"
}]

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",
  "cobranca_hash":"A0SD0S0DSA00DAS0DS0AD0SA"
  "link_publico":"https://secure.granatum.com.br/pagar/A0SD0S0DSA00DAS0DS0AD0SA"
}

Cancelar uma cobrança

Cancalar uma cobrança informada pelo ID.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
excluir_lancamentosExcluir os lançamentos associados a cobrança, valor padrão é FALSEBooleanOpcional
enviar_email_avisoEnviar aviso ao cliente que a cobrança foi cancelada, valor padrão é FALSEBooleanOpcional

Exemplo de chamada

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

Exemplo de resposta

{
  "success": "Cobrança cancelada com sucesso."
}

Anexos

Fazer upload de um arquivo

Permite fazer upload de uma arquivo a um Lançamento existente.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
fileA requisição precisa ter o cabeçalho 'content-type: multipart/form-data;' para aceitar o envio de arquivos.FileRequerido
filenameNome do anexoStringRequerido
lancamento_idID do lançamentoIntegerRequerido

Exemplo de chamada

curl -i -X POST \
  -H 'content-type: multipart/form-data;' \
  --form lancamento_id=123 \
  --form file=[arquivo] \
  --form filename=comprovante.pdf \
  'https://api.granatum.com.br/v1/anexos.json?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 91,
  "filename": "comprovante.pdf",
  "content_type": "application/pdf", 
  "size": 53421, 
  "lancamento_id": 123, 
  "lancamento_compost_id": 2
}

Consultar um anexo

Retorna os dados do anexo informado pelo ID.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
with_fileEnviar true para receber o conteúdo do arquivoBooleanOpcional

Exemplo de chamada

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

Exemplo de resposta

{
  "id": 91,
  "filename": "comprovante.pdf",
  "content_type": "application/pdf", 
  "size": 53421, 
  "lancamento_id": 123, 
  "lancamento_compost_id": 2,
  "file": "[Arquivo em Base64]"
}

Excluir um anexo

Apaga o anexo informado pelo ID.

Método e URL

DELETE https://api.granatum.com.br/v1/anexos/: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/anexos/43?access_token=token_cliente_granatum'

Exemplo de resposta

true

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

CampoDescriçãoTipoObrigatoriedade
descricaoNome da categoriaStringRequerido
corEm formato hexadecimalStringOpcional
parent_idIdentifica a categoria pai desta categoria que está sendo criadaIntegerOpcional

Exemplo de chamada

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

Exemplo de resposta

{
  "id": 91,
  "descricao": "Automotivo",
  "cor": "#232323",
  "parent_id": 90, 
  "ativo": true,
  "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

CampoDescriçãoTipoObrigatoriedade
descricaoNome da categoriaString
corEm formato hexadecimalStringOpcional
parent_idIdentifica a categoria pai desta categoria que está sendo editadaIntegerOpcional
ativoAo inativar uma categoria ela não poderá mais ser usada no registro de um lançamentoBooleanOpcional

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,  
  "ativo": true,
  "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

Paramêtros de busca

CampoDescriçãoTipoObrigatoriedade
considerar_inativosListar também as categorias inativas, por padrão é FALSEBooleanOpcional

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",
    "parent_id": 29, 
    "ativo": true,
    "categorias_filhas": []
  },
  {
    "id": 90,
    "descricao": "Automotivo",
    "cor": "#232323",
    "parent_id": 29, 
    "ativo": true,
    "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",
  "parent_id": 29, 
  "ativo": true,
  "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

Paramêtros

CampoDescriçãoTipoObrigatoriedade
acaoTipo de exclusão, informe uma das opções:
  • remove_lancamentos: para excluir todos lançamentos junto com a categoria
  • migra_lancamentos: para migrar os lançametos para outra categoria
StringRequerido
migracao_idInformar o ID da outra categoria caso deseje migrar os lançamentos que estão na categoria a ser excluída
*Obrigatório se a ação for migra_lancamentos
IntegerOpcional

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

CampoDescriçãoTipoObrigatoriedade
nomeNome/Razão Social do clienteStringRequerido
nome_fantasiaNome fantasia do clienteStringOpcional
documentoCPF/CNPJ do clienteStringOpcional
inscricao_estadualInscrição Estadual do clienteStringOpcional
inscricao_municipalInscrição Municipal do clienteStringOpcional
telefoneTelefone do clienteStringOpcional
emailEmail do clienteStringOpcional
enderecoApenas logradouro. Ex: Rua 13 de maio.StringOpcional
endereco_numeroNúmero do endereçoStringOpcional
endereco_complementoComplemento do endereçoStringOpcional
bairroBairro do endereçoStringOpcional
cepCódigo postal do endereçoStringOpcional
cidade_idID da cidade do endereçoIntegerOpcional
estado_idID do estado do endereçoIntegerOpcional
banco_idID do bancoIntegerOpcional
agenciaNúmero da agênciaStringOpcional
numero_contaNúmero da contaStringOpcional
observacaoCampo aberto para informação adicionais sobre o clienteStringOpcional
fornecedorIndica se o cliente cadastro é também um fornecedor, por padrão é FALSEBooleanOpcional
classificacao_cliente_idID da classificação de clientesIntegerOpcional
classificacao_fornecedor_idID da classificação de fornecedoresIntegerOpcional

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/clientes?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": false,
  "cliente": true,
  "banco_id": null,
  "agencia": null,
  "numero_conta", null,
  "ativo": true,
  "estado": null,
  "cidade": null,
  "classificacao_cliente_id": null,
  "classificacao_fornecedor_id": null
}

Editar 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

CampoDescriçãoTipoObrigatoriedade
nomeNome/Razão Social do clienteStringRequerido
nome_fantasiaNome fantasia do clienteStringOpcional
documentoCPF/CNPJ do clienteStringOpcional
inscricao_estadualInscrição Estadual do clienteStringOpcional
inscricao_municipalInscrição Municipal do clienteStringOpcional
telefoneTelefone do clienteStringOpcional
emailEmail do clienteStringOpcional
enderecoApenas logradouro. Ex: Rua 13 de maio.StringOpcional
endereco_numeroNúmero do endereçoStringOpcional
endereco_complementoComplemento do endereçoStringOpcional
bairroBairro do endereçoStringOpcional
cepCódigo postal do endereçoStringOpcional
cidade_idID da cidade do endereçoIntegerOpcional
estado_idID do estado do endereçoIntegerOpcional
banco_idID do bancoIntegerOpcional
agenciaNúmero da agênciaStringOpcional
numero_contaNúmero da contaStringOpcional
observacaoCampo aberto para informação adicionais sobre o clienteStringOpcional
fornecedorIndica se o cliente cadastro é também um fornecedor, por padrão é FALSEBooleanOpcional
ativoAo inativar um cliente ele não poderá mais ser usado no registro de um lançamentoBooleanOpcional
classificacao_cliente_idID da classificação de clientesIntegerOpcional
classificacao_fornecedor_idID da classificação de fornecedoresIntegerOpcional

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/clientes/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": null,
  "endereco": "11 99653-5631",
  "endereco_numero": null,
  "endereco_complemento": null,
  "bairro": null,
  "cep": null,
  "cidade_id": null,
  "estado_id": null,
  "email": null,
  "observacao": null,
  "fornecedor": false,
  "cliente": true,
  "banco_id": null,
  "agencia": null,
  "numero_conta", null,
  "ativo": true,
  "classificacao_cliente_id": null,
  "classificacao_fornecedor_id": null,
  "estado": null,
  "cidade": null,
  "anexos": [
    {
      "id": 53
    },
    {
      "id": 59
    }
  ]
}

Listar clientes

Retorna a lista de 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

CampoDescriçãoTipoObrigatoriedade
considerar_inativosListar também os clientes inativos, por padrão é FALSEBooleanOpcional
documentoCNPJ/CPF sem máscaraStringOpcional
termBusca aproximada na razão social, e-mail, endereço e telefoneStringOpcional

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'considerar_inativos=true' \
  'https://api.granatum.com.br/v1/clientes?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": "11 99653-5631",
    "endereco_numero": null,
    "endereco_complemento": null,
    "bairro": null,
    "cep": null,
    "cidade_id": null,
    "estado_id": null,
    "email": null,
    "observacao": null,
    "fornecedor": false,
    "cliente": true,
    "banco_id": null,
    "agencia": null,
    "numero_conta", null,
    "ativo": true,
    "classificacao_cliente_id": null,
    "classificacao_fornecedor_id": null,
    "estado": null,
    "cidade": null,
    "anexos": [
      {
        "id": 53
      },
      {
        "id": 59
      }
    ]
  },
  {
    "id": 23,
    "nome": "Agencia WEB LTDA",
    "nome_fantasia": "Agencia Max",
    "documento": "34725187000165",
    "inscricao_estadual": null,
    "inscricao_municipal": null,
    "telefone": null,
    "endereco": null,
    "endereco_numero": null,
    "endereco_complemento": null,
    "bairro": null,
    "cep": null,
    "cidade_id": 234,
    "estado_id": 23,
    "email": null,
    "observacao": null,
    "fornecedor": false,
    "fornecedor": true,
    "banco_id": null,
    "agencia": null,
    "numero_conta", null,
    "ativo": false,
    "classificacao_cliente_id": null,
    "classificacao_fornecedor_id": null
    "estado": null,
    "cidade": null,
    "anexos": [
      {
        "id": 53
      },
      {
        "id": 59
      }
    ]
  },
  ...
]

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/18?access_token=token_cliente_granatum'

Exemplo de resposta

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

Excluir um cliente

Remove um 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

Paramêtros

CampoDescriçãoTipoObrigatoriedade
migracao_idInformar o ID do outro cliente caso deseje migrar os lançamentos que estão no cliente a ser excluído ou não envie nada caso deseje apenas excluirIntegerOpcional

Exemplo de chamada

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

Exemplo de resposta

true

Fazer upload de um anexo em um cliente

Cria um anexo no cliente informado pelo ID.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
fileA requisição precisa ter o cabeçalho 'content-type: multipart/form-data;' para aceitar o envio de arquivos.FileRequerido
filenameNome do anexoStringRequerido

Exemplo de chamada

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

Exemplo de resposta

        {
          "id": 91,
          "filename": "comprovante.pdf",
          "content_type": "application/pdf", 
          "size": 53421, 
          "cliente_id": 18, 
          "model_id": 2
        }
      

Consultar anexo de um cliente

Retorna anexo de um cliente informado pelo ID.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
with_fileEnviar true para receber o conteúdo do arquivoBooleanOpcional
with_urlEnviar true para receber a url do arquivoBooleanOpcional

Exemplo de chamada

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

Exemplo de resposta

{
  "id": 91,
  "filename": "comprovante.pdf",
  "content_type": "application/pdf",
  "size": 53421,
  "cliente_id": 18,
  "model_id": 7844358,
  "file": "[Arquivo em Base64]"
}

Excluir anexo de um cliente

Apaga o anexo informado pelo ID.

Método e URL

DELETE https://api.granatum.com.br/v1/clientes/:id/anexos/: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/18/anexos/91?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

CampoDescriçãoTipoObrigatoriedade
nomeNome/Razão Social do fornecedorStringRequerido
nome_fantasiaNome fantasia do fornecedorStringOpcional
documentoCPF/CNPJ do fornecedorStringOpcional
inscricao_estadualInscrição Estadual do fornecedorStringOpcional
inscricao_municipalInscrição Municipal do fornecedorStringOpcional
telefoneTelefone do fornecedorStringOpcional
emailEmail do fornecedorStringOpcional
enderecoApenas logradouro. Ex: Rua 13 de maio.StringOpcional
endereco_numeroNúmero do endereçoStringOpcional
endereco_complementoComplemento do endereçoStringOpcional
bairroBairro do endereçoStringOpcional
cepCódigo postal do endereçoStringOpcional
cidade_idID da cidade do endereçoIntegerOpcional
estado_idID do estado do endereçoIntegerOpcional
banco_idID do bancoIntegerOpcional
agenciaNúmero da agênciaStringOpcional
numero_contaNúmero da contaStringOpcional
observacaoCampo aberto para informação adicionais sobre o fornecedorStringOpcional
clienteIndica se o fornecedor cadastro é também um cliente, por padrão é FALSEBooleanOpcional
classificacao_cliente_idID da classificação de clientesIntegerOpcional
classificacao_fornecedor_idID da classificação de fornecedoresIntegerOpcional

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,
  "cliente": false,
  "banco_id": null,
  "agencia": null,
  "numero_conta", null,
  "ativo": true,
  "estado": null,
  "cidade": null,
  "classificacao_cliente_id": null,
  "classificacao_fornecedor_id": 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

CampoDescriçãoTipoObrigatoriedade
nomeNome/Razão Social do fornecedorStringRequerido
nome_fantasiaNome fantasia do fornecedorStringOpcional
documentoCPF/CNPJ do fornecedorStringOpcional
inscricao_estadualInscrição Estadual do fornecedorStringOpcional
inscricao_municipalInscrição Municipal do fornecedorStringOpcional
telefoneTelefone do fornecedorStringOpcional
emailEmail do fornecedorStringOpcional
enderecoApenas logradouro. Ex: Rua 13 de maio.StringOpcional
endereco_numeroNúmero do endereçoStringOpcional
endereco_complementoComplemento do endereçoStringOpcional
bairroBairro do endereçoStringOpcional
cepCódigo postal do endereçoStringOpcional
cidade_idID da cidade do endereçoIntegerOpcional
estado_idID do estado do endereçoIntegerOpcional
banco_idID do bancoIntegerOpcional
agenciaNúmero da agênciaStringOpcional
numero_contaNúmero da contaStringOpcional
observacaoCampo aberto para informação adicionais sobre o fornecedorStringOpcional
clienteIndica se o fornecedor cadastro é também um cliente, por padrão é FALSEBooleanOpcional
ativoAo inativar um fornecedor ele não poderá mais ser usado no registro de um lançamentoBooleanOpcional
classificacao_cliente_idID da classificação de clientesIntegerOpcional
classificacao_fornecedor_idID da classificação de fornecedoresIntegerOpcional

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": null,
  "endereco": "11 99653-5631",
  "endereco_numero": null,
  "endereco_complemento": null,
  "bairro": null,
  "cep": null,
  "cidade_id": null,
  "estado_id": null,
  "email": null,
  "observacao": null,
  "fornecedor": true,
  "cliente": false,
  "banco_id": null,
  "agencia": null,
  "numero_conta", null,
  "ativo": true,
  "estado": null,
  "cidade": null,
  "classificacao_cliente_id": null,
  "classificacao_fornecedor_id": null,
  "estado": null,
  "cidade": null,
  "anexos": [
    {
      "id": 53
    },
    {
      "id": 59
    }
  ]
}

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

CampoDescriçãoTipoObrigatoriedade
considerar_inativosListar também os fornecedores inativos, por padrão é FALSEBooleanOpcional
documentoCNPJ/CPF sem máscaraStringOpcional
termBusca aproximada na razão social, e-mail, endereço e telefoneStringOpcional

Exemplo de chamada

curl -i -X GET \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'considerar_inativos=true' \
  '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": "11 99653-5631",
    "endereco_numero": null,
    "endereco_complemento": null,
    "bairro": null,
    "cep": null,
    "cidade_id": null,
    "estado_id": null,
    "email": null,
    "observacao": null,
    "fornecedor": true,
    "cliente": false,
    "banco_id": null,
    "agencia": null,
    "numero_conta", null,
    "ativo": true,
    "classificacao_cliente_id": null,
    "classificacao_fornecedor_id": null,
    "estado": null,
    "cidade": null,
    "anexos": [
      {
        "id": 53
      },
      {
        "id": 59
      }
    ]
  },
  {
    "id": 23,
    "nome": "Agencia WEB LTDA",
    "nome_fantasia": "Agencia Max",
    "documento": "34725187000165",
    "inscricao_estadual": null,
    "inscricao_municipal": null,
    "telefone": null,
    "endereco": null,
    "endereco_numero": null,
    "endereco_complemento": null,
    "bairro": null,
    "cep": null,
    "cidade_id": 234,
    "estado_id": 23,
    "email": null,
    "observacao": null,
    "fornecedor": true,
    "cliente": true,
    "banco_id": null,
    "agencia": null,
    "numero_conta", null,
    "ativo": false,
    "classificacao_cliente_id": null,
    "classificacao_fornecedor_id": null,
    "estado": null,
    "cidade": null,
    "anexos": [
      {
        "id": 53
      },
      {
        "id": 59
      }
    ]
  },
  ...
]

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",
  "inscricao_estadual": null,
  "inscricao_municipal": null,
  "telefone": null,
  "endereco": "11 99653-5631",
  "endereco_numero": null,
  "endereco_complemento": null,
  "bairro": null,
  "cep": null,
  "cidade_id": null,
  "estado_id": null,
  "email": null,
  "observacao": null,
  "fornecedor": true,
  "cliente": false,
  "banco_id": null,
  "agencia": null,
  "numero_conta", null,
  "ativo": true,
  "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

Paramêtros

CampoDescriçãoTipoObrigatoriedade
migracao_idInformar o ID do outro fornecedor caso deseje migrar os lançamentos que estão no fornecedor a ser excluído ou não envie nada caso deseje apenas excluirIntegerOpcional

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

Fazer upload de um anexo em um fornecedor

Cria um anexo no fornecedor informado pelo ID.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
fileA requisição precisa ter o cabeçalho 'content-type: multipart/form-data;' para aceitar o envio de arquivos.FileRequerido
filenameNome do anexoStringRequerido

Exemplo de chamada

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

Exemplo de resposta

        {
          "id": 91,
          "filename": "comprovante.pdf",
          "content_type": "application/pdf", 
          "size": 53421, 
          "fornecedor_id": 18, 
          "model_id": 2
        }
      

Consultar anexo de um fornecedor

Retorna anexo de um fornecedor informado pelo ID.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
with_fileEnviar true para receber o conteúdo do arquivoBooleanOpcional
with_urlEnviar true para receber a url do arquivoBooleanOpcional

Exemplo de chamada

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

Exemplo de resposta

{
  "id": 91,
  "filename": "comprovante.pdf",
  "content_type": "application/pdf",
  "size": 53421,
  "fornecedor_id": 18,
  "model_id": 7844358,
  "file": "[Arquivo em Base64]"
}

Excluir anexo de um fornecedor

Apaga o anexo informado pelo ID.

Método e URL

DELETE https://api.granatum.com.br/v1/fornecedores/:id/anexos/: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/anexos/91?access_token=token_cliente_granatum'

Exemplo de resposta

True

Classificações

Criar uma classificação

Cria uma classificação que pode organizar melhor os cadastros de clientes e fornecedores.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
nomeNome da classificaçãoStringRequerido
tipo_classificacao_idTipo da classificação:
  • 0 - Mista
  • 1 - Cliente
  • 2 - Fornecedor
IntegerRequerido

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/classificacoes?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 1,
  "nome": "Granatum Financeiro",
  "tipo_classificacao_id": 0,
  "ativo": true
}

Editar uma classificação

Altera os dados de uma classificação informada pelo ID.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
nomeNome da classificaçãoStringRequerido
tipo_classificacao_idTipo da classificação:
  • 0 - Mista
  • 1 - Cliente
  • 2 - Fornecedor
IntegerRequerido
ativoAo desativar uma classificação você não poderá mais atrelar a um cliente / fornecedorBooleanOpcional

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/classificacoes/1?access_token=token_cliente_granatum'

Exemplo de resposta

{
        "id": 1,
        "nome": "Granatum Financeiro",
        "tipo_classificacao_id": 0,
        "ativo": true
}

Listar classificações

Retorna a lista de classificações.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros de busca

CampoDescriçãoTipoObrigatoriedade
considerar_inativosListar também os classificações inativos, por padrão é FALSEBooleanOpcional
tipo_classificacaoQual o tipo de classificação deseja listar. O padrão é Cliente, as Mistas são incluidas automaticamente em ambas as listagens:
  • 1 - Cliente
  • 2 - Fornecedor
IntegerOpcional

Exemplo de chamada

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

Exemplo de resposta

[
  {
    "id": 1,
    "nome": "Granatum Financeiro",
    "tipo_classificacao_id": 0,
    "ativo": true
  },
  {
    "id": 23,
    "nome": "Granatum Financeiro",
    "tipo_classificacao_id": 0,
    "ativo": true
  },
  ...
]

Consultar classificação

Retorna os dados de uma classificação informada pelo ID.

Método e URL

GET https://api.granatum.com.br/v1/classificacoes/: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/classificacoes/18?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 18,
  "nome": "Granatum Financeiro",
  "tipo_classificacao_id": 0,
  "ativo": true
}

Excluir uma classificação

Remove uma classificação informada pelo ID.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
migracao_idInformar o ID do outra classificação caso deseje migrar as pessoas que estão nessa classificação ou não envie nada caso deseje apenas excluirIntegerOpcional

Exemplo de chamada

curl -i -X DELETE \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/classificacacoes/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

CampoDescriçãoTipoObrigatoriedade
descricaoNome da contaStringRequerido
banco_idID do bancoIntegerOpcional
agenciaNúmero da agênciaStringOpcional
numeroNúmero da contaStringOpcional
nome_gerenteGerente responsável pela conta no bancoStringOpcional
telefone_gerenteTelefone do gerenteStringOpcional
permite_lancamentoO padrão é TRUE, a conta que NÃO permite lançamentos, podem apenas receber movimentações através de TransferênciasBooleanOpcional
data_saldo_inicialData do saldo da conta de quando irá iniciar o controle dentro do sistemaDateOpcional
valor_saldo_inicialValor do saldo da conta de quando irá iniciar o controle dentro do sistemaDecimalOpcional

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' \
  -d 'permite_lancamento=true' \
  -d 'data_saldo_inicial=2020-01-23' \
  -d 'valor_saldo_inicial=11 1500.80' \
  '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",
  "permite_lancamento": true,
  "ativo": true,
  "lancamentos": [
    {
      "id": 133,
      "valor": "1500.80",
      "data_pagamento": "2020-01-23"
    }
  ]
}

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

CampoDescriçãoTipoObrigatoriedade
descricaoNome da contaStringOpcional
banco_idID do bancoIntegerOpcional
agenciaNúmero da agênciaStringOpcional
numeroNúmero da contaStringOpcional
nome_gerenteGerente responsável pela conta no bancoStringOpcional
telefone_gerenteTelefone do gerenteStringOpcional
permite_lancamentoO padrão é TRUE, a conta que NÃO permite lançamentos, podem apenas receber movimentações através de TransferênciasBooleanOpcional
data_saldo_inicialData do saldo da conta de quando irá iniciar o controle dentro do sistemaDateOpcional
valor_saldo_inicialValor do saldo da conta de quando irá iniciar o controle dentro do sistemaDecimalOpcional
ativoAo inativar uma conta ela não poderá mais ser usada no registro de um lançamentoBooleanOpcional

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",
  "permite_lancamento": true,
  "ativo": true,
  "lancamentos": [
    {
      "id": 133,
      "valor": "1500.80",
      "data_pagamento": "2020-01-23"
    }
  ]
}

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

Paramêtros de busca

CampoDescriçãoTipoObrigatoriedade
considerar_inativosListar também as contas inativas, por padrão é FALSEBooleanOpcional

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",
    "permite_lancamento": true,
    "ativo": true,
    "saldo": "0.0"
  },
  {
    "id": 2,
    "descricao": "Conta Nubank",
    "permite_lancamento": true,
    "ativo": true,
    "saldo": "2890.0"
  },
  {
    "id": 3,
    "descricao": "XP Investimentos",
    "permite_lancamento": false,
    "ativo": true,
    "saldo": "35876.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",
  "banco_id": "10",
  "agencia": "123-0",
  "numero": "32423-3",
  "nome_gerente": "Marcio Almeida",
  "telefone_gerente": "11 2332-3455",
  "permite_lancamento": true,
  "ativo": true,
  "lancamentos": [
    {
      "id": 133,
      "valor": "1500.80",
      "data_pagamento": "2020-01-23"
    }
  ]
}

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

Paramêtros

CampoDescriçãoTipoObrigatoriedade
acaoTipo de exclusão, informe uma das opções:
  • remove_lancamentos: para excluir todos lançamentos junto com a conta
  • migra_lancamentos: para migrar os lançametos para outra conta
StringRequerido
migracao_idInformar o ID da outra conta caso deseje migrar os lançamentos que estão na conta a ser excluída
*Obrigatório se a ação for migra_lancamentos
IntegerOpcional

Exemplo de chamada

$ curl -i -X DELETE \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'acao=remove_lancamentos' \
  '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

CampoDescriçãoTipoObrigatoriedade
descricaoNome do centro de custo e lucroStringRequerido
parent_idIdentifica o centro ce custo e lucro pai deste centro ce custo e lucro que está sendo criadoIntegerOpcional

Exemplo de chamada

curl -i -X POST \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'descricao=Setor de Compras' \
  -d 'parent_id=2' \
  '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,
  "ativo": true,
  "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

CampoDescriçãoTipoObrigatoriedade
descricaoNome do centro de custo e lucroStringRequerido
parent_idIdentifica o centro ce custo e lucro pai deste centro ce custo e lucro que está sendo editadoIntegerOpcional
ativoAo inativar um centro de custo e lucro ele não poderá mais ser usado no registro de um lançamentoBooleanOpcional

Exemplo de chamada

curl -i -X PUT \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'descricao=Recursos Humanos' \
  -d 'parent_id=2' \
  '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,
  "ativo": true,
  "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

Paramêtros de busca

CampoDescriçãoTipoObrigatoriedade
considerar_inativosListar também os centros de custo e lucro inativos, por padrão é FALSEBooleanOpcional

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",
    "ativo": true,
    "centros_custo_lucro_filhos":[]
  },
  {
    "id": 2,
    "descricao": "Automóvel",
    "ativo": true,
    "centros_custo_lucro_filhos":[]
  },
  {
    "id": 3,
    "descricao": "Setor Compras",
    "ativo": true,
    "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",
  "ativo": true,
  "centros_custo_lucro_filhos":[
    {
      "id": 3, 
      "descricao": "Recursos Humanos",
      "ativo": true,
      "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

Paramêtros

CampoDescriçãoTipoObrigatoriedade
migracao_idInformar o ID do outro centro de custo e lucro caso deseje migrar os lançamentos que estão no centro de custo e lucro a ser excluído ou não envie nada caso deseje apenas excluirIntegerOpcional

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

CampoDescriçãoTipoObrigatoriedade
descricaoNome da forma de pagamentoStringRequerido

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",
  "ativo": true
}

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

CampoDescriçãoTipoObrigatoriedade
descricaoNome da forma de pagamentoStringRequerido
ativoAo inativar uma forma de pagamento ela não poderá mais ser usada no registro de um lançamentoBooleanOpcional

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",
  "ativo": true
}

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

Paramêtros de busca

CampoDescriçãoTipoObrigatoriedade
considerar_inativosListar também as formas de pagamento inativas, por padrão é FALSEBooleanOpcional

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",
    "ativo": true
  },
  {
    "id":2,
    "descricao":"Boleto",
    "ativo": true
  },
  ...
]

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",
  "ativo": true
}

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

Paramêtros

CampoDescriçãoTipoObrigatoriedade
migracao_idInformar o ID da outra forma de pagamento caso deseje migrar os lançamentos que estão na forma de pagamento a ser excluída ou não envie nada caso deseje apenas excluirIntegerOpcional

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

Tipos documento fiscal

Criar um tipo documento fiscal

Cria um tipo documento fiscal que pode ser utilizado como complemento ao criar um Lançamento.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
descricaoNome do tipo documento fiscalStringRequerido

Exemplo de chamada

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

Exemplo de resposta

{
  "id": 1,
  "descricao": "Nota fiscal",
  "ativo": true
}

Editar um tipo documento fiscal

Altera os dados do tipo documento fiscal informado pelo ID.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
descricaoNome do tipo documento fiscalStringRequerido
ativoAo inativar um tipo documento fiscal ele não poderá mais ser usado no registro de um lançamentoBooleanOpcional

Exemplo de chamada

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

Exemplo de resposta

{
  "id": 1,
  "descricao": "Nota fiscal",
  "ativo": true
}

Listar tipos documento fiscal

Retorna a lista os tipos documento fiscal.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros de busca

CampoDescriçãoTipoObrigatoriedade
considerar_inativosListar também os tipos documento fiscal inativos, por padrão é FALSEBooleanOpcional

Exemplo de chamada

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

Exemplo de resposta

[
  {
    "id": 1,
    "descricao": "Nota fiscal",
    "ativo": true
  },
  {
    "id": 2,
    "descricao": "Recibo",
    "ativo": true
  },
  {
    ...
  }
]

Consultar um tipo documento fiscal

Retorna os dados do tipo documento fiscal informado pelo ID.

Método e URL

GET https://api.granatum.com.br/v1/tipos_documento_fiscal/: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/tipos_documento_fiscal/2?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 2,
  "descricao": "Recibo",
  "ativo": true
}

Excluir um tipo documento fiscal

Remove do sistema o tipo documento fiscal informado pelo ID.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
migracao_idInformar o ID do outro tipo documento fiscal caso deseje migrar os lançamentos que estão no tipo documento fiscal a ser excluído ou não envie nada caso deseje apenas excluirIntegerOpcional

Exemplo de chamada

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

Exemplo de resposta

true

Tipos custo nível de produção

Listar tipos custo nível de produção

Retorna a lista de tipos custo nível de produção

Método e URL

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

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/tipos_custo_nivel_producao?access_token=token_cliente_granatum'

Exemplo de resposta

[
  {
    "id": 1,
    "descricao": "Fixo"
  },
  {
    "id": 2,
    "descricao": "Variável"
  }
]

Tipos custo apropriação de produto

Listar tipos custo apropriação de produto

Retorna a lista de tipos custo apropriação de produto

Método e URL

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

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/tipos_custo_apropriacao_produto?access_token=token_cliente_granatum'

Exemplo de resposta

[
  {
    "id": 1,
    "descricao": "Direto"
  },
  {
    "id": 2,
    "descricao": "Indireto"
  }
]

Tags

Criar uma tag

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

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
descricaoNome da tagStringRequerido

Exemplo de chamada

curl -i -X POST \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'descricao=Promoção Natal' \
  'https://api.granatum.com.br/v1/tags?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 91,
  "descricao": "Promoção Natal",
  "ativo": true
}

Editar uma tag

Altera os dados da tag informada pelo ID.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
descricaoNome da tagStringRequerido
ativoAo inativar uma tag ela não poderá mais ser usada no registro de um lançamentoBooleanOpcional

Exemplo de chamada

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

Exemplo de resposta

{
  "id": 91,
  "descricao": "Promoção Natal",
  "ativo": true
}

Listar tags

Retorna a lista as tags.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros de busca

CampoDescriçãoTipoObrigatoriedade
considerar_inativosListar também as tags inativas, por padrão é FALSEBooleanOpcional

Exemplo de chamada

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

Exemplo de resposta

[
  {
    "id": 43,
    "descricao": "Black Friday",
    "ativo": true
  },
  {
    "id": 65,
    "descricao": "Projeto crescimento",
    "ativo": true
  }
]

Consultar uma tag

Retorna os dados da tag informada pelo ID.

Método e URL

GET https://api.granatum.com.br/v1/tags/: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/tags/43?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "id": 43,
  "descricao": "Black Friday",
  "ativo": true
}

Excluir uma tag

Remove do sistema a tag informada pelo ID.

Método e URL

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

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
migracao_idInformar o ID da outra tag caso deseje migrar os lançamentos que estão na tag a ser excluída ou não envie nada caso deseje apenas excluirIntegerOpcional

Exemplo de chamada

$ curl -i -X DELETE \
  -H "Content-Type:application/x-www-form-urlencoded" \
  'https://api.granatum.com.br/v1/tags/43?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": 26
  },{
    "id": 493,
    "nome": "Anadia",
    "estado_id": 26
  },{
    "id": 494,
    "nome": "Arapiraca",
    "estado_id": 26
  },
  ...
]

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"
  },
  ...
]

Relatórios

Fluxo de caixa

Dados do fluxo de caixa de um período.

Método e URL

GET https://api.granatum.com.br/v1/relatorios/fluxo_caixa

Query String

access_token=[token_cliente_granatum]

Substitua inclusive os colchetes

Paramêtros

CampoDescriçãoTipoObrigatoriedade
data_inicioData de início para filtro da data conforme o regimeStringRequerido
data_fimData de fim para filtro da data conforme o regime
*Sempre informar as duas datas para o filtro funcionar
StringRequerido
regimeDefine qual data considerar nos filtros de data_inicio e data_fim, o valor padrão é caixa:
  • caixa: Considerara a data de vencimento para lançamentos em aberto ou data de pagamento para lançamentos consolidados
  • competencia: Considera a data de competência
StringRequerido
agruparDefine a forma como os dados serão agrupados nas colunas, valor padrão é FluxoCaixaMensal. Veja a lista aquiStringOpcional
conta_id[]ID da Conta BancáriaArrayOpcional
cliente_id[]ID do cliente no caso de ReceitasArrayOpcional
fornecedor_id[]ID do Fornecedor no caso de DespesasArrayOpcional
categoria_id[]ID da categoriaArrayOpcional
centro_custo_lucro_id[]ID do centro de custo e lucroArrayOpcional
forma_pagamento_id[]ID da Forma de PagamentoArrayOpcional
tipo_documento_id[]ID do tipo de documentoArrayOpcional
tag_id[]ID da tagArrayOpcional
buscaRealiza busca aproximada no valor, descrição, observação e nome de cliente/fornecedorStringOpcional
tipoFiltra o tipo de lançamento:
  • P: Lancamentos a pagar
  • R: Lançamentos a receber
  • LP: Lancamentos pagos
  • LR: Lançamentos recebidos
  • PA: Lancamentos a pagar atrasados
  • RA: Lançamentos a receber atrasados
  • DT: Desconsiderar transferências
StringOpcional

Exemplo de chamada

curl -i -X POST \
  -H "Content-Type:application/x-www-form-urlencoded" \
  -d 'agrupar=FluxoCaixaMensal' \
  -d 'data_inicio=2020-01-01' \
  -d 'data_fim=2020-06-30' \
  -d 'regime=caixa' \
  'https://api.granatum.com.br/v1/relatorios/fluxo_caixa?access_token=token_cliente_granatum'

Exemplo de resposta

{
  "data": {
    "colunas": {
      "2020-1": "01/2020",
      "2020-2": "02/2020",
      "2020-3": "03/2020",
      "2020-4": "04/2020",
      "2020-5": "05/2020",
      "2020-6": "06/2020",
      "Total": "Total"
    },
    "status": {
      "2020-1": "Realizado e Previsto",
      "2020-2": "Previsto",
      "2020-3": "Previsto",
      "2020-4": "Previsto",
      "2020-5": "Previsto",
      "2020-6": "Previsto",
      "Total": "Realizado e Previsto"
    },
    "linhas": {
      "categorias_receita": {
        "280169": {
          "id": "280169","parent_id": "0","descricao": "Assinaturas","cor": "#2dbf4b","tipo_categoria_id": "2","nivel": 0,"tem_filhas": false,"filhas": []
        },
        "278723": {
          "id": "278723","parent_id": "0","descricao": "Vendas","cor": "#ffda2f","tipo_categoria_id": "2","nivel": 0,"tem_filhas": true,"filhas": ["279912"]
        },
        "279912": {
          "id": "279912","parent_id": "278723","descricao": "Projetos","cor": "#fdff0f","tipo_categoria_id": "2","nivel": 1,"tem_filhas": false,"filhas": []
        }
      },
      "categorias_despesa": {
        "278847": {
          "id": "278847","parent_id": "0","descricao": "Gastos fixos","cor": "#E70000","tipo_categoria_id": "1","nivel": 0,"tem_filhas": true,"filhas": ["278849","278850","278852","278848"]
        },
        "278849": {
          "id": "278849","parent_id": "278847","descricao": "Aluguel","cor": "#B60000","tipo_categoria_id": "1","nivel": 1,"tem_filhas": false,"filhas": []
        },
        "278850": {
          "id": "278850","parent_id": "278847","descricao": "Contabilidade","cor": "#9B0000","tipo_categoria_id": "1","nivel": 1,"tem_filhas": false,"filhas": []
        },
        "278852": {
          "id": "278852","parent_id": "278847","descricao": "Internet","cor": "#730000","tipo_categoria_id": "1","nivel": 1,"tem_filhas": false,"filhas": []
        },
        "278848": {
          "id": "278848","parent_id": "278847","descricao": "Água","cor": "#C70000","tipo_categoria_id": "1","nivel": 1,"tem_filhas": false,"filhas": []
        }
      }
    },
    "dados_lancamentos": {
      "despesas": {
        "278848": {
          "2020-1": "-56.00",
          "2020-2": "-56.00",
          "2020-3": "-56.00",
          "2020-4": "-56.00",
          "2020-5": "-56.00",
          "2020-6": "-56.00",
          "Total": "-336.00"
        },
        "278849": {
          "2020-1": "-1320.00",
          "2020-2": "-1320.00",
          "2020-3": "-1320.00",
          "2020-4": "-1320.00",
          "2020-5": "-1320.00",
          "2020-6": "-1320.00",
          "Total": "-7920.00"
        },
        "278850": {
          "2020-2": "-2232.22",
          "2020-3": "-2232.22",
          "2020-4": "-2232.22",
          "2020-5": "-2232.22",
          "2020-6": "-2232.22",
          "Total": "-11161.10"
        },
        "278852": {
          "2020-1": "-230.00",
          "2020-2": "-230.00",
          "2020-3": "-230.00",
          "2020-4": "-230.00",
          "2020-5": "-230.00",
          "2020-6": "-230.00",
          "Total": "-1380.00"
        },
        "278847": {
          "2020-1": "-1606.00",
          "2020-2": "-3838.22",
          "2020-3": "-3838.22",
          "2020-4": "-3838.22",
          "2020-5": "-3838.22",
          "2020-6": "-3838.22",
          "Total": "-20797.10"
        },
        "Total": {
          "2020-1": "-1606.00",
          "2020-2": "-3838.22",
          "2020-3": "-3838.22",
          "2020-4": "-3838.22",
          "2020-5": "-3838.22",
          "2020-6": "-3838.22",
          "Total": "-20797.10"
        }
      },
      "receitas": {
        "278723": {
          "2020-1": "3867.50",
          "2020-2": "4696.88",
          "2020-3": "4922.84",
          "2020-4": "4559.78",
          "2020-5": "4696.88",
          "2020-6": "4922.84",
          "Total": "27666.72"
        },
        "279912": {
          "2020-1": "3850.00",
          "2020-2": "3850.00",
          "2020-3": "3850.00",
          "2020-4": "3850.00",
          "2020-5": "3850.00",
          "2020-6": "3850.00",
          "Total": "23100.00"
        },
        "280169": {
          "2020-1": "1560.00",
          "2020-2": "1560.00",
          "2020-3": "1560.00",
          "2020-4": "1560.00",
          "2020-5": "1560.00",
          "2020-6": "1560.00",
          "Total": "9360.00"
        },
        "Total": {
          "2020-1": "5427.50",
          "2020-2": "6256.88",
          "2020-3": "6482.84",
          "2020-4": "6119.78",
          "2020-5": "6256.88",
          "2020-6": "6482.84",
          "Total": "37026.72"
        }
      },
      "saldo_inicial": {
        "2020-1": "-11004.53",
        "2020-2": "-7183.03",
        "2020-3": "-4764.37",
        "2020-4": "-2119.75",
        "2020-5": "161.81",
        "2020-6": "2580.47"
        "Total": "-11004.53",
      },
      "saldo_periodo": {
        "2020-1": "3821.50",
        "2020-2": "2418.66",
        "2020-3": "2644.62",
        "2020-4": "2281.56",
        "2020-5": "2418.66",
        "2020-6": "2644.62",
        "Total": "16229.62"
      },
      "saldo_final": {
        "2020-1": "-7183.03",
        "2020-2": "-4764.37",
        "2020-3": "-2119.75",
        "2020-4": "161.81",
        "2020-5": "2580.47",
        "2020-6": "5225.09",
        "Total": "5225.09"
      }
    }
  }
}

Exemplo de como utilizar os dados de resposta na construção do fluxo de caixa

Agrupamentos do fluxo de caixa

Lista de agrumanetos disponíveis para o fluxo de caixa.

Método e URL

GET https://api.granatum.com.br/v1/relatorios/agrupamentos/fluxo_caixa

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/relatorios/agrupamentos/fluxo_caixa?access_token=token_cliente_granatum'

Exemplo de resposta

[
  {
    "texto": "Agrupar por dia",
    "valor": "FluxoCaixaDiario"
  },
  {
    "texto": "Agrupar por semana",
    "valor": "FluxoCaixaSemanal"
  },
  {
    "texto": "Agrupar por mês",
    "valor": "FluxoCaixaMensal"
  },
  {
    "texto": "Agrupar por trimestre",
    "valor": "FluxoCaixaTrimestral"
  },
  {
    "texto": "Agrupar por semestre",
    "valor": "FluxoCaixaSemestral"
  },
  {
    "texto": "Agrupar por ano",
    "valor": "FluxoCaixaAnual"
  }
]

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

Bibliotecas e Plugins

Veja abaixo algumas bibliotecas e plugins desenvolvidos pela comunidade que podem te ajudar na integração do seu sistema com a nossa API.





*Por serem bibliotecas e plugins deservolvidos por terceiros, não conseguimos garantir a continuidade e manutenção dos mesmos.

Utilizamos seus dados para analisar e personalizar nossos conteúdos e anúncios durante a sua navegação em nossa plataforma e em serviços de terceiros parceiros. Ao navegar pelo site, você autoriza o Granatum a coletar tais informações e utilizá-las para estas finalidades. Em caso de dúvidas, acesse nossa Política de Privacidade.

Entendi e aceito