Referência / Quadra Command API
GL Accounts
3 operações em Quadra Command API 0.2.0.
/v1/gl/accountsCreate a sub-GL account (operator)
Create an operator-defined sub-GL account under an existing GL parent (RFC-025 §6): a derived GL row (no on-chain keys) that mapping rules can route entries to and that rolls up into its parent in the trial balance.
Raises: 404: PARENT_NOT_FOUND 409: IDEMPOTENCY_KEY_REUSED or GL_ACCOUNT_EXISTS 422: PARENT_NOT_GL or PARENT_INACTIVE
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| Idempotency-Key | string | headerobrigatório |
Corpo da requisição
GLSubAccountCreateRequest — obrigatório. Os campos estão listados em Esquemas, abaixo.
Respostas
| Status | Corpo | Detalhe |
|---|---|---|
| 201 | — | Resposta bem-sucedidaO contrato não declara um modelo para esta resposta, então a forma dela não está documentada aqui. Um roteiro de demonstração mostra a forma que ela realmente devolve. |
| 422 | HTTPValidationError | Erro de validação |
/v1/gl/accounts/{account_id}Rename or deactivate a GL account (operator; never delete)
Rename or deactivate any GL node (built-in or sub-GL). GL accounts are never deleted; INACTIVE only blocks new mapping-rule targets.
Raises: 404: NOT_FOUND (unknown id, or not a GL account)
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| account_id | string | pathobrigatório |
Corpo da requisição
GLAccountPatchRequest — obrigatório. Os campos estão listados em Esquemas, abaixo.
Respostas
| Status | Corpo | Detalhe |
|---|---|---|
| 200 | — | Resposta bem-sucedidaO contrato não declara um modelo para esta resposta, então a forma dela não está documentada aqui. Um roteiro de demonstração mostra a forma que ela realmente devolve. |
| 422 | HTTPValidationError | Erro de validação |
/v1/gl/mapping-rulesAppend a mapping-ruleset version and flip CURRENT (operator)
Append a new transaction-type→node mapping ruleset version (RFC-025 §7). Rules apply prospectively only — already-projected entries keep the ruleset_version they were stamped with (re-projection is a non-goal).
Raises: 409: IDEMPOTENCY_KEY_REUSED or RULESET_CONFLICT (concurrent append) 422: UNKNOWN_GL_NODE, INACTIVE_GL_NODE, UNKNOWN_ACCOUNT_TYPE, UNKNOWN_EVENT_KIND
Parâmetros
| Nome | Tipo | Detalhe |
|---|---|---|
| Idempotency-Key | string | headerobrigatório |
Corpo da requisição
GLMappingRulesetCreateRequest — obrigatório. Os campos estão listados em Esquemas, abaixo.
Respostas
| Status | Corpo | Detalhe |
|---|---|---|
| 201 | — | Resposta bem-sucedidaO contrato não declara um modelo para esta resposta, então a forma dela não está documentada aqui. Um roteiro de demonstração mostra a forma que ela realmente devolve. |
| 422 | HTTPValidationError | Erro de validação |
Esquemas
Os modelos que as operações acima aceitam e devolvem. Campos opcionais estão marcados como tal; um campo tipado como outro modelo está documentado sob o nome dele.
GLAccountPatchRequest
Rename or deactivate a GL account. GL nodes are never deleted.
| Campo | Tipo | Detalhe |
|---|---|---|
| name | string, opcional | New display name |
| status | "ACTIVE" | "INACTIVE", opcional | INACTIVE blocks new mapping-rule targets; history is never deleted |
GLMappingRuleIn
One ordered mapping rule: match → COA node.
| Campo | Tipo | Detalhe |
|---|---|---|
| gl_node_id | string | obrigatórioTarget COA node for matching legs |
| match | GLMappingRuleMatchIn | obrigatórioConditions (missing key = wildcard) |
GLMappingRulesetCreateRequest
Append a new ruleset version (full replacement list; prospective-only).
| Campo | Tipo | Detalhe |
|---|---|---|
| rules | array de GLMappingRuleIn | obrigatórioOrdered, first-match-wins; unmatched legs fall back to built-in per-type defaults |
GLSubAccountCreateRequest
Create a sub-GL account (derived GL row, no on-chain keys).
| Campo | Tipo | Detalhe |
|---|---|---|
| account_id | string | obrigatórioOperator-chosen node id (gl_* slug; referenced by mapping rules) |
| currency | string | ISO 4217 currency codePadrão "BRL" |
| name | string | obrigatórioHuman-readable node name |
| normal_balance | "DR" | "CR", opcional | Defaults to the parent's normal_balance, else the type default |
| parent_account_id | string | obrigatórioMust be an existing GL node |
| type | string, opcional | One of ASSET|LIABILITY|TRANSIT|REVENUE|EXCEPTION; defaults to the parent's type |
HTTPValidationError
| Campo | Tipo | Detalhe |
|---|---|---|
| detail | array de ValidationError |
ValidationError
| Campo | Tipo | Detalhe |
|---|---|---|
| ctx | object | |
| input | não declarado | |
| loc | array de string ou integer | obrigatório |
| msg | string | obrigatório |
| type | string | obrigatório |