Em breve

Guardia
Home
APIs
Guadia
Guardia
  • Ledger
  • Chapter
    • Cria um novo chapterPOST
    • Obtém um chapter específicoGET
    • Atualiza um chapter específicoPATCH
    • Exclui um chapter específicoDELETE
    • Lista todos os chaptersGET
logoPowered by Apidog
  1. Chapter

Cria um novo chapter

Developing
POST/v1/chapters
Last modified: a month ago
Maintainer: 

Permite criar uma segmentação da ledger em Chapters (Capítulos), organizando transações e saldos por critérios específicos, como unidade de negócio ou centro de custo, para facilitar análises, relatórios e auditorias com maior precisão e flexibilidade.

Request

Header Params
Accept
string 
optional

Tipo de contrato esperado na resposta da API. O valor padrão é application/vnd.guardia.v1+json ou a versao mais recente.

Example:
application/vnd.guardia.v1+json
Accept-Language
string 
optional

O idioma em que a API deve retornar as mensagens de erro. Use en para inglês americano ou pt-BR para português brasileiro. O valor padrão é en.

Example:
en
Content-Type
string 
optional

Tipo de contrato enviado na requisição para a API. O valor padrão é application/vnd.guardia.v1+json ou a versao mais recente.

Example:
application/vnd.guardia.v1+json
Body Params application/json
external_entity_id
string  | null 
optional

Um ID externo único do chapter. Pode ser associado para uso externo. Recomendado o formato UUID.

<= 36 characters
Example:
fff78a0d3b5146a1ae80007e3d316714
name
string 
required

Nome único dentro do chapter

Example:
Investimentos
description
string  | null 
optional

Uma descrição personalizada do chapter. Mínimo de 3 caracteres e Máximo de 512 caracteres.

Example:
Unidade de Negócio voltada para produtos de Investimentos.
ledger_entity_id
string <uuid>
required

Identificador único do ledger ao qual o chapter pertence. Alternativamente pode ser utilizado o external_entity_id ou o urn da ledger.

>= 32 characters<= 36 characters
Example:
f636cb1c46c4468e93c384a12530ee30
tags
array[string | null]
optional

Uma lista de tags para o chapter.

metadata
object (Metadata) 
optional

Os metadados a serem adicionados à entidade devem ser fornecidos como pares de chave-valor em um formato de objeto JSON, com chave e valor como strings.

foo
string  | null 
optional
Example:
bar
Example
{
  "external_entity_id": "fff78a0d3b5146a1ae80007e3d316714",
  "name": "Investimentos",
  "description": "Unidade de Negócio voltada para produtos de Investimentos.",
  "ledger_entity_id": "f636cb1c46c4468e93c384a12530ee30",
  "tags": [
    "guardia"
  ],
  "metadata": {
    "foo": "bar"
  }
}

Request samples

Responses

Created(201)
HTTP Code: 201
Content Type : JSONapplication/vnd.guardia.v1+json

Chapter criado

Headers
Content-Type
string 
required

Tipo de contrato retornado

Example:
application/vnd.guardia.v1+json
Content-Length
string 
required
Example:
<length>
Content-Language
string 
required

O idioma em que a API retorna as mensagens de erro. Use en para inglês americano ou pt-BR para português brasileiro.

Example:
en
X-RateLimit-Limit
string 
required

Cota de requisições por segundos por cliente (org id + tenant id)

Example:
30
X-RateLimit-Remaining
string 
required

Cota de requisições restantes no mesmo segundo

Example:
10
 Retry-After
string 
optional

Indica quanto tempo o cliente (org id + tenant id) deve aguardar antes de fazer uma requisição. Zero indica que não há tempo de espera.

Example:
0
Strict-Transport-Security
string 
required

Indica que o navegador deve acessar o site apenas por HTTPS.

Example:
max-age=31536000; includeSubDomains
Data Schema
entity_id
string <uuid>
required

Identificador único do chapter

>= 32 characters<= 36 characters
Example:
56d9687171394d909ee3ed85b9d1e825
entity_type
string 
required

Tipo da entidade.

Example:
CHAPTER
external_entity_id
string  | null 
optional

Um ID externo único do chapter. Pode ser associado para uso externo. Recomendado o formato UUID.

<= 36 characters
Example:
fff78a0d3b5146a1ae80007e3d316714
urn
string <urn>
required

URN do recurso no servidor no formato urn:{org_id}:{tenant_id}:{entity_type}:{entity_id}.

Example:
urn:org:b1d492f8adaf40e390ff38dd95da7942:tenant:92da48203af44ce9bbccb49d6709881a:chapter:56d9687171394d909ee3ed85b9d1e825
Match pattern:
^urn:org:(?<org_id>[a-fA-F0-9]{32}):tenant:(?<tenant_id>[a-fA-F0-9]{32}):(?<entity_type>[a-z_]+):(?<entity_id>[a-fA-F0-9]{32})$
name
string 
required

Nome único dentro do chapter.

Example:
Investimentos
description
string  | null 
optional

Descrição do chapter.

Example:
Unidade de Negocio para produtos de Investimentos.
created_at
string <date-time>
required

Data e hora de criação do chapter no formato ISO 8601 (UTC).

Example:
2024-11-17T00:00:00.000Z
Match pattern:
^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\.(?<fraction>[0-9]{1,9}))?Z$
updated_at
string <date-time>
required

Data e hora da última atualização do chapter no formato ISO 8601 (UTC).

Example:
2024-11-17T00:00:00.000Z
Match pattern:
^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\.(?<fraction>[0-9]{1,9}))?Z$
discarded_at
optional

Data e hora de descarte do chapter no formato ISO 8601 (UTC).

Any of

Data e hora no formato no formato ISO 8601 (UTC).

Example:
2024-11-17T00:00:00.000Z
Match pattern:
^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\.(?<fraction>[0-9]{1,9}))?Z$
tags
array[string | null]
optional

Uma lista de tags para o chapter.

metadata
object (Metadata) 
optional

Os metadados a serem adicionados à entidade devem ser fornecidos como pares de chave-valor em um formato de objeto JSON, com chave e valor como strings.

foo
string  | null 
optional
Example:
bar
ledger
object (Ledger) 
required
entity_id
string <uuid>
required

Identificador único do ledger.

Example:
f636cb1c46c4468e93c384a12530ee30
entity_type
string 
required

Tipo da entidade.

Example:
LEDGER
external_entity_id
string  | null 
optional

Identificador único externo da ledger. Pode ser associado para uso externo.

Example:
9606e83f427b44c298192c0f110129bc
urn
string <urn>
required

URN do recurso no servidor no formato urn:{org_id}:{tenant_id}:{entity_type}:{entity_id}.

Example:
urn:org:b1d492f8adaf40e390ff38dd95da7942:tenant:92da48203af44ce9bbccb49d6709881a:ledger:f636cb1c46c4468e93c384a12530ee30
Match pattern:
^urn:org:(?<org_id>[a-fA-F0-9]{32}):tenant:(?<tenant_id>[a-fA-F0-9]{32}):(?<entity_type>[a-z_]+):(?<entity_id>[a-fA-F0-9]{32})$
name
string 
required

Nome único do ledger.

>= 3 characters<= 256 characters
Example:
General Ledger
description
string  | null 
optional

Descrição do ledger.

>= 3 characters<= 512 characters
Example:
Ledger da ACME Corp.
created_at
string <date-time>
required

Data e hora de criação do ledger no formato ISO 8601 (UTC).

Example:
2024-11-17T00:00:00.000Z
Match pattern:
^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\.(?<fraction>[0-9]{1,9}))?Z$
updated_at
string <date-time>
required

Data e hora da última atualização do ledger no formato ISO 8601 (UTC).

Example:
2024-11-17T00:00:00.000Z
Match pattern:
^(?<year>[0-9]{4})-?(?<month>1[0-2]|0[1-9])-?(?<day>3[01]|0[1-9]|[12][0-9])T(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])(?:\.(?<fraction>[0-9]{1,9}))?Z$
discarded_at
optional

Data e hora de descarte do ledger no formato ISO 8601 (UTC).

tags
array[string | null]
optional

Uma lista de tags para a ledger.

metadata
object (Metadata) 
optional

Os metadados a serem adicionados à entidade devem ser fornecidos como pares de chave-valor em um formato de objeto JSON, com chave e valor como strings.

Example
{
  "entity_id": "56d9687171394d909ee3ed85b9d1e825",
  "entity_type": "CHAPTER",
  "external_entity_id": "fff78a0d3b5146a1ae80007e3d316714",
  "urn": "urn:org:b1d492f8adaf40e390ff38dd95da7942:tenant:92da48203af44ce9bbccb49d6709881a:chapter:56d9687171394d909ee3ed85b9d1e825",
  "name": "Investimentos",
  "description": "Unidade de Negocio para produtos de Investimentos.",
  "created_at": "2024-11-17T00:00:00.000Z",
  "updated_at": "2024-11-17T00:00:00.000Z",
  "discarded_at": "2024-11-17T00:00:00.000Z",
  "tags": [
    "guardia"
  ],
  "metadata": {
    "foo": "bar"
  },
  "ledger": {
    "entity_id": "f636cb1c46c4468e93c384a12530ee30",
    "entity_type": "LEDGER",
    "external_entity_id": "9606e83f427b44c298192c0f110129bc",
    "urn": "urn:org:b1d492f8adaf40e390ff38dd95da7942:tenant:92da48203af44ce9bbccb49d6709881a:ledger:f636cb1c46c4468e93c384a12530ee30",
    "name": "General Ledger",
    "description": "Ledger da ACME Corp.",
    "created_at": "2024-11-17T00:00:00.000Z",
    "updated_at": "2024-11-17T00:00:00.000Z",
    "discarded_at": null,
    "tags": [
      "guardia"
    ],
    "metadata": {
      "foo": "bar"
    }
  }
}
Last modified: a month ago