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

Criação de um novo lançamento contábil no ledger com os dados da conta juntos com a requisição

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

accounts

Obrigatório

Array of objects

account_group_id
String

ID do grupo de contas

Ex: 123456

account_name

Obrigatório

String

Nome da conta

Ex: Conta Corrente

account_type

Obrigatório

String

Tipo da conta

Ex: current_account

external_reference
String

Referência externa da conta

Ex: 123456

external_uid

Obrigatório

String

ID externo da conta

Ex: 123456

timezone
String

Fuso horário da conta no formato IANA Time Zone Database - (America/Sao_Paulo, America/New_York, ...)

Ex: America/Sao_Paulo

account_metadatas
Array of objects

meta_key

Obrigatório

String

Chave do metadado

Ex: key

meta_value

Obrigatório

String

Valor do metadado

Ex: value

journal

Obrigatório

Object

journal_description

Obrigatório

String

Descrição do lançamento

Ex: Lançamento de teste

external_reference
String

Referência externa do lançamento

Ex: 123456

external_uid

Obrigatório

String

ID externo do lançamento

Ex: 123456

entry_date

Data do lançamento

Ex: 2021-10-01

journal_entries

Obrigatório

Array of objects

account_external_uid

Obrigatório

String

ID externo da conta

Ex: 123456

entry_description

Obrigatório

String

Descrição do lançamento

Ex: Lançamento de teste

amount

Obrigatório

Number

Valor do lançamento

Ex: 100.0

entry_type

Obrigatório

String

Tipo do lançamento

Ex: credit

external_reference
String

Referência externa do lançamento

Ex: 123456

skip_balance_check
Boolean

Pular verificação de saldo

external_uid

Obrigatório

String

ID externo do lançamento

Ex: 123456

Exemplo
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
  "accounts": [
    {
      "account_group_id": "123456",
      "account_name": "Conta Corrente",
      "account_type": "current_account",
      "external_reference": "123456",
      "external_uid": "123456",
      "timezone": "America/Sao_Paulo",
      "account_metadatas": [
        {
          "meta_key": "key",
          "meta_value": "value"
        }
      ]
    }
  ],
  "journal": {
    "journal_description": "Lançamento de teste",
    "external_reference": "123456",
    "external_uid": "123456",
    "entry_date": "2021-10-01",
    "journal_entries": [
      {
        "account_external_uid": "123456",
        "entry_description": "Lançamento de teste",
        "amount": 100.0,
        "entry_type": "credit",
        "external_reference": "123456",
        "skip_balance_check": "",
        "external_uid": "123456"
      }
    ]
  }
}

Respostas

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

journal_description
String

Descrição do lançamento

Ex: Lançamento de teste

external_reference
String <= 255 characters

external_uid
String

journal_entries
Array of objects

account_id
String

entry_description
String <= 255 characters

amount
Number

external_uid
String <= 255 characters

entry_type
String

skip_balance_check
Boolean

journal_metadatas
Array of objects

meta_key

Obrigatório

String

meta_value

Obrigatório

String

entry_date
String

accounts
Array of objects

account_id
String

account_name
String

account_type
String

external_reference
String

external_uid
String

timezone
String

account_metadatas
Array of objects

meta_key

Obrigatório

String

meta_value

Obrigatório

String

workspace_id
String