From e60f531573916e150dded211df5790e7374f08a1 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Fri, 28 Jun 2024 18:20:25 +0000
Subject: [PATCH] deploy: 43591ec3fbc9a3a71dd51f1ddcabf34a97c023a4
---
api-reference.html | 599 +++++++++++++++++++++++----------------------
1 file changed, 304 insertions(+), 295 deletions(-)
diff --git a/api-reference.html b/api-reference.html
index 077ac9dc..43aa9cf5 100644
--- a/api-reference.html
+++ b/api-reference.html
@@ -101,7 +101,6 @@ Types
Date
DebitOrCredit
Decimal
- EntryInput
Expression
ID
Int
@@ -127,12 +126,13 @@ Types
Transaction
TransactionInput
TransactionPostPayload
- TxInput
TxTemplate
TxTemplateCreateInput
TxTemplateCreatePayload
+ TxTemplateEntry
TxTemplateEntryInput
- TxTemplateTxInput
+ TxTemplateTransaction
+ TxTemplateTransactionInput
UUID
@@ -230,7 +230,7 @@ Variables
{
- "id": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350"
+ "id": "3d031693-c2d7-4dfe-882b-f72635d05e5c"
}
@@ -244,13 +244,13 @@ Response
"data": {
"account": {
"id": 4,
- "accountId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "accountId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"version": 987,
- "code": "abc123",
- "name": "xyz789",
+ "code": "xyz789",
+ "name": "abc123",
"normalBalanceType": "DEBIT",
"status": "ACTIVE",
- "externalId": "xyz789",
+ "externalId": "abc123",
"description": "xyz789",
"metadata": {},
"createdAt": 1592577642,
@@ -350,10 +350,10 @@ Response
{
"data": {
"accountByCode": {
- "id": "4",
- "accountId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "version": 987,
- "code": "abc123",
+ "id": 4,
+ "accountId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "version": 123,
+ "code": "xyz789",
"name": "abc123",
"normalBalanceType": "DEBIT",
"status": "ACTIVE",
@@ -457,15 +457,15 @@ Response
{
"data": {
"accountByExternalId": {
- "id": 4,
- "accountId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "version": 987,
+ "id": "4",
+ "accountId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "version": 123,
"code": "xyz789",
- "name": "abc123",
+ "name": "xyz789",
"normalBalanceType": "DEBIT",
"status": "ACTIVE",
"externalId": "abc123",
- "description": "xyz789",
+ "description": "abc123",
"metadata": {},
"createdAt": 1592577642,
"modifiedAt": 1592577642,
@@ -554,7 +554,7 @@ Variables
{
- "id": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350"
+ "id": "3d031693-c2d7-4dfe-882b-f72635d05e5c"
}
@@ -568,10 +568,10 @@ Response
"data": {
"accountSet": {
"id": "4",
- "accountSetId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "accountSetId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"version": 987,
- "journalId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "name": "xyz789",
+ "journalId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "name": "abc123",
"normalBalanceType": "DEBIT",
"description": "abc123",
"metadata": {},
@@ -665,7 +665,7 @@ Query
Variables
- {"first": 123, "after": "abc123"}
+ {"first": 123, "after": "xyz789"}
@@ -781,8 +781,8 @@ Variables
{
- "journalId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "accountId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "journalId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "accountId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"currency": CurrencyCode
}
@@ -797,9 +797,9 @@ Response
"data": {
"balance": {
"id": 4,
- "journalId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "accountId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "entryId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "journalId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "accountId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "entryId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"currency": CurrencyCode,
"settled": BalanceAmount,
"pending": BalanceAmount,
@@ -890,7 +890,7 @@ Query
Variables
- {"first": 123, "after": "xyz789"}
+ {"first": 987, "after": "abc123"}
@@ -977,7 +977,7 @@ Variables
{
- "id": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350"
+ "id": "3d031693-c2d7-4dfe-882b-f72635d05e5c"
}
@@ -991,11 +991,11 @@ Response
"data": {
"journal": {
"id": 4,
- "journalId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "journalId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"version": 987,
- "name": "xyz789",
+ "name": "abc123",
"status": "ACTIVE",
- "description": "xyz789",
+ "description": "abc123",
"createdAt": 1592577642,
"modifiedAt": 1592577642
}
@@ -1040,7 +1040,7 @@ Query
Response
- {"data": {"serverVersion": "xyz789"}}
+ {"data": {"serverVersion": "abc123"}}
@@ -1114,7 +1114,7 @@ Variables
{
- "id": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350"
+ "id": "3d031693-c2d7-4dfe-882b-f72635d05e5c"
}
@@ -1127,15 +1127,15 @@ Response
{
"data": {
"transaction": {
- "id": 4,
- "transactionId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "version": 987,
- "txTemplateId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "journalId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "id": "4",
+ "transactionId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "version": 123,
+ "txTemplateId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "journalId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"effective": "2007-12-03",
"correlationId": "abc123",
"externalId": "abc123",
- "description": "xyz789",
+ "description": "abc123",
"metadata": {},
"createdAt": 1592577642,
"modifiedAt": 1592577642
@@ -1214,7 +1214,7 @@ Query
Variables
- {"externalId": "abc123"}
+ {"externalId": "xyz789"}
@@ -1226,15 +1226,15 @@ Response
{
"data": {
"transactionByExternalId": {
- "id": "4",
- "transactionId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "version": 123,
- "txTemplateId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "journalId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "id": 4,
+ "transactionId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "version": 987,
+ "txTemplateId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "journalId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"effective": "2007-12-03",
"correlationId": "abc123",
"externalId": "abc123",
- "description": "xyz789",
+ "description": "abc123",
"metadata": {},
"createdAt": 1592577642,
"modifiedAt": 1592577642
@@ -1298,11 +1298,11 @@ Query
params {
...ParamDefinitionFragment
}
- txInput {
- ...TxInputFragment
+ transaction {
+ ...TxTemplateTransactionFragment
}
entries {
- ...EntryInputFragment
+ ...TxTemplateEntryFragment
}
description
metadata
@@ -1319,7 +1319,7 @@ Variables
{
- "id": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350"
+ "id": "3d031693-c2d7-4dfe-882b-f72635d05e5c"
}
@@ -1332,14 +1332,14 @@ Response
{
"data": {
"txTemplate": {
- "id": "4",
- "txTemplateId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "id": 4,
+ "txTemplateId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"version": 123,
- "code": "xyz789",
+ "code": "abc123",
"params": [ParamDefinition],
- "txInput": TxInput,
- "entries": [EntryInput],
- "description": "abc123",
+ "transaction": TxTemplateTransaction,
+ "entries": [TxTemplateEntry],
+ "description": "xyz789",
"metadata": {},
"createdAt": 1592577642,
"modifiedAt": 1592577642
@@ -1403,11 +1403,11 @@ Query
params {
...ParamDefinitionFragment
}
- txInput {
- ...TxInputFragment
+ transaction {
+ ...TxTemplateTransactionFragment
}
entries {
- ...EntryInputFragment
+ ...TxTemplateEntryFragment
}
description
metadata
@@ -1423,7 +1423,7 @@ Query
Variables
- {"code": "xyz789"}
+ {"code": "abc123"}
@@ -1436,13 +1436,13 @@ Response
"data": {
"txTemplateByCode": {
"id": "4",
- "txTemplateId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "txTemplateId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"version": 123,
"code": "abc123",
"params": [ParamDefinition],
- "txInput": TxInput,
- "entries": [EntryInput],
- "description": "abc123",
+ "transaction": TxTemplateTransaction,
+ "entries": [TxTemplateEntry],
+ "description": "xyz789",
"metadata": {},
"createdAt": 1592577642,
"modifiedAt": 1592577642
@@ -1670,7 +1670,7 @@ Variables
{
- "id": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "id": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"input": AccountSetUpdateInput
}
@@ -1759,7 +1759,7 @@ Variables
{
- "id": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "id": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"input": AccountUpdateInput
}
@@ -2067,7 +2067,7 @@ Variables
{
- "id": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "id": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"input": JournalUpdateInput
}
@@ -2457,9 +2457,9 @@ Example
{
"id": 4,
- "accountId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "version": 987,
- "code": "xyz789",
+ "accountId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "version": 123,
+ "code": "abc123",
"name": "abc123",
"normalBalanceType": "DEBIT",
"status": "ACTIVE",
@@ -2621,16 +2621,16 @@ Example
{
- "accountId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "accountId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"externalId": "xyz789",
"code": "xyz789",
- "name": "abc123",
+ "name": "xyz789",
"normalBalanceType": "DEBIT",
- "description": "xyz789",
+ "description": "abc123",
"status": "ACTIVE",
"metadata": {},
"accountSetIds": [
- "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350"
+ "3d031693-c2d7-4dfe-882b-f72635d05e5c"
]
}
@@ -2883,13 +2883,13 @@ Example
{
- "id": "4",
- "accountSetId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "id": 4,
+ "accountSetId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"version": 123,
- "journalId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "journalId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"name": "xyz789",
"normalBalanceType": "DEBIT",
- "description": "xyz789",
+ "description": "abc123",
"metadata": {},
"createdAt": 1592577642,
"modifiedAt": 1592577642,
@@ -3026,11 +3026,11 @@ Example
{
- "accountSetId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "journalId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "name": "xyz789",
+ "accountSetId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "journalId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "name": "abc123",
"normalBalanceType": "DEBIT",
- "description": "xyz789",
+ "description": "abc123",
"metadata": {}
}
@@ -3122,7 +3122,7 @@ Example
{
"node": AccountSet,
- "cursor": "abc123"
+ "cursor": "xyz789"
}
@@ -3269,7 +3269,7 @@ Example
{
"node": Account,
- "cursor": "abc123"
+ "cursor": "xyz789"
}
@@ -3381,9 +3381,9 @@ Example
{
- "name": "abc123",
+ "name": "xyz789",
"normalBalanceType": "DEBIT",
- "description": "abc123",
+ "description": "xyz789",
"metadata": {}
}
@@ -3511,7 +3511,7 @@ Example
{
"externalId": "xyz789",
"code": "xyz789",
- "name": "xyz789",
+ "name": "abc123",
"normalBalanceType": "DEBIT",
"description": "xyz789",
"status": "ACTIVE",
@@ -3612,8 +3612,8 @@ Example
{
- "accountSetId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "memberId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "accountSetId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "memberId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"memberType": "ACCOUNT"
}
@@ -3744,10 +3744,10 @@ Example
{
- "id": 4,
- "journalId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "accountId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "entryId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "id": "4",
+ "journalId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "accountId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "entryId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"currency": CurrencyCode,
"settled": BalanceAmount,
"pending": BalanceAmount,
@@ -3815,7 +3815,7 @@ Example
"drBalance": Money,
"crBalance": Money,
"normalBalance": Money,
- "entryId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350"
+ "entryId": "3d031693-c2d7-4dfe-882b-f72635d05e5c"
}
@@ -3837,6 +3837,15 @@ Description
+
+
Example
+
+
+
true
+
+
+
+
Example
{
- "jobId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "jobId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"name": "xyz789",
- "description": "abc123",
- "endpoint": "abc123"
+ "description": "xyz789",
+ "endpoint": "xyz789"
}
@@ -4051,90 +4060,6 @@ Example
Decimal
-
-
-
-
-
-
-
-
-
- EntryInput
-
-
-
-
-
Example
-
-
-
{
- "entryType": Expression,
- "accountId": Expression,
- "layer": Expression,
- "direction": Expression,
- "units": Expression,
- "currency": Expression,
- "description": Expression
-}
@@ -4180,7 +4105,7 @@
Description
Example
-
4
+ "4"
@@ -4286,7 +4211,7 @@ Example
{
"id": 4,
- "jobId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "jobId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"name": "xyz789",
"description": "xyz789"
}
@@ -4476,12 +4401,12 @@ Example
{
- "id": "4",
- "journalId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "version": 987,
+ "id": 4,
+ "journalId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "version": 123,
"name": "xyz789",
"status": "ACTIVE",
- "description": "abc123",
+ "description": "xyz789",
"createdAt": 1592577642,
"modifiedAt": 1592577642
}
@@ -4547,8 +4472,8 @@ Example
{
- "journalId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "name": "xyz789",
+ "journalId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "name": "abc123",
"status": "ACTIVE",
"description": "abc123"
}
@@ -4649,7 +4574,7 @@ Example
{
"name": "xyz789",
"status": "ACTIVE",
- "description": "xyz789"
+ "description": "abc123"
}
@@ -4799,7 +4724,7 @@ Example
{
"hasPreviousPage": true,
- "hasNextPage": true,
+ "hasNextPage": false,
"startCursor": "xyz789",
"endCursor": "xyz789"
}
@@ -4954,7 +4879,7 @@ Example
"name": "abc123",
"type": "STRING",
"default": Expression,
- "description": "abc123"
+ "description": "xyz789"
}
@@ -5021,7 +4946,7 @@ Example
"name": "abc123",
"type": "STRING",
"default": Expression,
- "description": "abc123"
+ "description": "xyz789"
}
@@ -5078,8 +5003,8 @@ Example
{
- "accountSetId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "memberId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "accountSetId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "memberId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"memberType": "ACCOUNT"
}
@@ -5322,15 +5247,15 @@ Example
{
- "id": "4",
- "transactionId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "id": 4,
+ "transactionId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"version": 987,
- "txTemplateId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "journalId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
+ "txTemplateId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "journalId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
"effective": "2007-12-03",
- "correlationId": "abc123",
+ "correlationId": "xyz789",
"externalId": "xyz789",
- "description": "xyz789",
+ "description": "abc123",
"metadata": {},
"createdAt": 1592577642,
"modifiedAt": 1592577642
@@ -5390,8 +5315,8 @@ Example
{
- "transactionId": "d5e11fbe-83ae-4e4d-85f0-e1e8ad197350",
- "txTemplateCode": "xyz789",
+ "transactionId": "3d031693-c2d7-4dfe-882b-f72635d05e5c",
+ "txTemplateCode": "abc123",
"params": {}
}
@@ -5434,83 +5359,6 @@ Example
{"transaction": Transaction}
-
-
-
-
-
-