Docs
post https://ledger.iugu.com.br/api/journals

Criação de um novo lançamento contábil no ledger

Permissão necessária:

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Schema Obrigatório

Tipo de conteúdo: application/json

journal_description

Obrigatório

String

Descrição do lançamento

external_reference
String

Referência externa do lançamento

Ex: 123456

external_uid

Obrigatório

String

ID externo do lançamento

Ex: 123456

journal_entries

Obrigatório

Array of objects

account_id
String

ID da conta

Ex: 123456

entry_description
String

Descrição do lançamento

Ex: Lançamento de teste

amount
Number

Valor do lançamento

Ex: 100.0

external_uid
String

ID externo do lançamento

Ex: 123456

entry_type
String

Tipo do lançamento

Ex: credit

skip_balance_check
Boolean

Pular verificação de saldo

Exemplo
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "journal_description": "",
  "external_reference": "123456",
  "external_uid": "123456",
  "journal_entries": [
    {
      "account_id": "123456",
      "entry_description": "Lançamento de teste",
      "amount": 100.0,
      "external_uid": "123456",
      "entry_type": "credit",
      "skip_balance_check": ""
    }
  ]
}

Respostas

201
Lançamento contábil criado com sucesso
id
String

ID do lançamento

journal_description
String

Descrição do lançamento

external_reference
String

Referência externa do lançamento

external_uid
String

ID externo do lançamento

journal_entries
Array of objects

account_id
String

ID da conta

entry_description
String

Descrição do lançamento

amount
Number

Valor do lançamento

external_uid
String

ID externo do lançamento

entry_type
String

Tipo do Lançamento

skip_balance_check
Boolean

Pular verificação de saldo

journal_metadatas
Array of objects

meta_key

Obrigatório

String

Chave do metadado

Ex: key

meta_value

Obrigatório

String

Valor do metadado

Ex: value

entry_date
String

400
Parâmetros ou cabeçalhos obrigatórios não informados
error
String

Ex: The 'journal_description' parameter is required but missing or empty.

401
Não autorizado ou token expirado.
error
String

Ex: Your session has expired. Please log in again.