Cala GraphQL API reference
+
+
+
+
+
+
+ Get started on cala.sh/docs
+
+
+
+
+ API Endpoints
+http://localhost:2252/graphqlQueries
+
+ account
+
+
+
+
+
+
+
+ Response
+ Returns an Account
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ id - UUID!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +query account($id: UUID!) {
+ account(id: $id) {
+ id
+ accountId
+ version
+ code
+ name
+ normalBalanceType
+ status
+ externalId
+ description
+ metadata
+ createdAt
+ modifiedAt
+ balance {
+ ...BalanceFragment
+ }
+ sets {
+ ...AccountSetConnectionFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{
+ "id": "7264d0c7-acf6-4069-913d-bb6ffd933733"
+}
+
+
+ Response
+ + +{
+ "data": {
+ "account": {
+ "id": 4,
+ "accountId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "version": 987,
+ "code": "abc123",
+ "name": "abc123",
+ "normalBalanceType": "DEBIT",
+ "status": "ACTIVE",
+ "externalId": "abc123",
+ "description": "abc123",
+ "metadata": {},
+ "createdAt": 1592577642,
+ "modifiedAt": 1592577642,
+ "balance": Balance,
+ "sets": AccountSetConnection
+ }
+ }
+}
+
+ Queries
+
+
+ accountByCode
+
+
+
+
+
+
+
+ Response
+ Returns an Account
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ code - String!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +query accountByCode($code: String!) {
+ accountByCode(code: $code) {
+ id
+ accountId
+ version
+ code
+ name
+ normalBalanceType
+ status
+ externalId
+ description
+ metadata
+ createdAt
+ modifiedAt
+ balance {
+ ...BalanceFragment
+ }
+ sets {
+ ...AccountSetConnectionFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{"code": "abc123"}
+
+
+ Response
+ + +{
+ "data": {
+ "accountByCode": {
+ "id": "4",
+ "accountId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "version": 987,
+ "code": "abc123",
+ "name": "xyz789",
+ "normalBalanceType": "DEBIT",
+ "status": "ACTIVE",
+ "externalId": "xyz789",
+ "description": "xyz789",
+ "metadata": {},
+ "createdAt": 1592577642,
+ "modifiedAt": 1592577642,
+ "balance": Balance,
+ "sets": AccountSetConnection
+ }
+ }
+}
+
+ Queries
+
+
+ accountByExternalId
+
+
+
+
+
+
+
+ Response
+ Returns an Account
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ externalId - String!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +query accountByExternalId($externalId: String!) {
+ accountByExternalId(externalId: $externalId) {
+ id
+ accountId
+ version
+ code
+ name
+ normalBalanceType
+ status
+ externalId
+ description
+ metadata
+ createdAt
+ modifiedAt
+ balance {
+ ...BalanceFragment
+ }
+ sets {
+ ...AccountSetConnectionFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{"externalId": "abc123"}
+
+
+ Response
+ + +{
+ "data": {
+ "accountByExternalId": {
+ "id": 4,
+ "accountId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "version": 123,
+ "code": "abc123",
+ "name": "abc123",
+ "normalBalanceType": "DEBIT",
+ "status": "ACTIVE",
+ "externalId": "abc123",
+ "description": "abc123",
+ "metadata": {},
+ "createdAt": 1592577642,
+ "modifiedAt": 1592577642,
+ "balance": Balance,
+ "sets": AccountSetConnection
+ }
+ }
+}
+
+ Queries
+
+
+ accountSet
+
+
+
+
+
+
+
+ Response
+ Returns an AccountSet
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ id - UUID!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +query accountSet($id: UUID!) {
+ accountSet(id: $id) {
+ id
+ accountSetId
+ version
+ journalId
+ name
+ normalBalanceType
+ description
+ metadata
+ createdAt
+ modifiedAt
+ balance {
+ ...BalanceFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{
+ "id": "7264d0c7-acf6-4069-913d-bb6ffd933733"
+}
+
+
+ Response
+ + +{
+ "data": {
+ "accountSet": {
+ "id": "4",
+ "accountSetId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "version": 123,
+ "journalId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "name": "abc123",
+ "normalBalanceType": "DEBIT",
+ "description": "xyz789",
+ "metadata": {},
+ "createdAt": 1592577642,
+ "modifiedAt": 1592577642,
+ "balance": Balance
+ }
+ }
+}
+
+ Queries
+
+
+ accounts
+
+
+
+
+
+
+
+
+ Response
+ Returns an AccountConnection!
+
+
+ Example
+
+
+ Query
+ + +query accounts(
+ $first: Int!,
+ $after: String
+) {
+ accounts(
+ first: $first,
+ after: $after
+ ) {
+ pageInfo {
+ ...PageInfoFragment
+ }
+ edges {
+ ...AccountEdgeFragment
+ }
+ nodes {
+ ...AccountFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{"first": 123, "after": "abc123"}
+
+
+ Response
+ + +{
+ "data": {
+ "accounts": {
+ "pageInfo": PageInfo,
+ "edges": [AccountEdge],
+ "nodes": [Account]
+ }
+ }
+}
+
+ Queries
+
+
+ balance
+
+
+
+
+
+
+
+ Response
+ Returns a Balance
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ journalId - UUID!
+ |
+ + | +
+ accountId - UUID!
+ |
+ + | +
+ currency - CurrencyCode!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +query balance(
+ $journalId: UUID!,
+ $accountId: UUID!,
+ $currency: CurrencyCode!
+) {
+ balance(
+ journalId: $journalId,
+ accountId: $accountId,
+ currency: $currency
+ ) {
+ id
+ journalId
+ accountId
+ entryId
+ currency
+ settled {
+ ...BalanceAmountFragment
+ }
+ pending {
+ ...BalanceAmountFragment
+ }
+ encumbrance {
+ ...BalanceAmountFragment
+ }
+ version
+ }
+}
+
+
+ Variables
+ + +{
+ "journalId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "accountId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "currency": CurrencyCode
+}
+
+
+ Response
+ + +{
+ "data": {
+ "balance": {
+ "id": "4",
+ "journalId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "accountId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "entryId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "currency": CurrencyCode,
+ "settled": BalanceAmount,
+ "pending": BalanceAmount,
+ "encumbrance": BalanceAmount,
+ "version": 123
+ }
+ }
+}
+
+ Queries
+
+
+ jobs
+
+
+
+
+
+
+
+
+ Response
+ Returns a JobConnection!
+
+
+ Example
+
+
+ Query
+ + +query jobs(
+ $first: Int!,
+ $after: String
+) {
+ jobs(
+ first: $first,
+ after: $after
+ ) {
+ pageInfo {
+ ...PageInfoFragment
+ }
+ edges {
+ ...JobEdgeFragment
+ }
+ nodes {
+ ...JobFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{"first": 123, "after": "abc123"}
+
+
+ Response
+ + +{
+ "data": {
+ "jobs": {
+ "pageInfo": PageInfo,
+ "edges": [JobEdge],
+ "nodes": [Job]
+ }
+ }
+}
+
+ Queries
+
+
+ journal
+
+
+
+
+
+
+
+ Response
+ Returns a Journal
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ id - UUID!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +query journal($id: UUID!) {
+ journal(id: $id) {
+ id
+ journalId
+ version
+ name
+ status
+ description
+ createdAt
+ modifiedAt
+ }
+}
+
+
+ Variables
+ + +{
+ "id": "7264d0c7-acf6-4069-913d-bb6ffd933733"
+}
+
+
+ Response
+ + +{
+ "data": {
+ "journal": {
+ "id": 4,
+ "journalId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "version": 123,
+ "name": "xyz789",
+ "status": "ACTIVE",
+ "description": "xyz789",
+ "createdAt": 1592577642,
+ "modifiedAt": 1592577642
+ }
+ }
+}
+
+ Queries
+
+
+ serverVersion
+
+
+
+
+
+
+
+ Response
+ Returns a String!
+
+
+ Example
+
+
+ Query
+ + +query serverVersion {
+ serverVersion
+}
+
+
+ Response
+ + +{"data": {"serverVersion": "abc123"}}
+
+ Queries
+
+
+ transaction
+
+
+
+
+
+
+
+ Response
+ Returns a Transaction
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ id - UUID!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +query transaction($id: UUID!) {
+ transaction(id: $id) {
+ id
+ transactionId
+ version
+ txTemplateId
+ journalId
+ effective
+ correlationId
+ externalId
+ description
+ metadata
+ createdAt
+ modifiedAt
+ }
+}
+
+
+ Variables
+ + +{
+ "id": "7264d0c7-acf6-4069-913d-bb6ffd933733"
+}
+
+
+ Response
+ + +{
+ "data": {
+ "transaction": {
+ "id": "4",
+ "transactionId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "version": 987,
+ "txTemplateId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "journalId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "effective": "2007-12-03",
+ "correlationId": "xyz789",
+ "externalId": "xyz789",
+ "description": "abc123",
+ "metadata": {},
+ "createdAt": 1592577642,
+ "modifiedAt": 1592577642
+ }
+ }
+}
+
+ Queries
+
+
+ transactionByExternalId
+
+
+
+
+
+
+
+ Response
+ Returns a Transaction
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ externalId - String!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +query transactionByExternalId($externalId: String!) {
+ transactionByExternalId(externalId: $externalId) {
+ id
+ transactionId
+ version
+ txTemplateId
+ journalId
+ effective
+ correlationId
+ externalId
+ description
+ metadata
+ createdAt
+ modifiedAt
+ }
+}
+
+
+ Variables
+ + +{"externalId": "xyz789"}
+
+
+ Response
+ + +{
+ "data": {
+ "transactionByExternalId": {
+ "id": "4",
+ "transactionId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "version": 987,
+ "txTemplateId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "journalId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "effective": "2007-12-03",
+ "correlationId": "xyz789",
+ "externalId": "xyz789",
+ "description": "abc123",
+ "metadata": {},
+ "createdAt": 1592577642,
+ "modifiedAt": 1592577642
+ }
+ }
+}
+
+ Queries
+
+
+ txTemplate
+
+
+
+
+
+
+
+ Response
+ Returns a TxTemplate
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ id - UUID!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +query txTemplate($id: UUID!) {
+ txTemplate(id: $id) {
+ id
+ txTemplateId
+ version
+ code
+ params {
+ ...ParamDefinitionFragment
+ }
+ txInput {
+ ...TxInputFragment
+ }
+ entries {
+ ...EntryInputFragment
+ }
+ description
+ metadata
+ createdAt
+ modifiedAt
+ }
+}
+
+
+ Variables
+ + +{
+ "id": "7264d0c7-acf6-4069-913d-bb6ffd933733"
+}
+
+
+ Response
+ + +{
+ "data": {
+ "txTemplate": {
+ "id": 4,
+ "txTemplateId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "version": 123,
+ "code": "xyz789",
+ "params": [ParamDefinition],
+ "txInput": TxInput,
+ "entries": [EntryInput],
+ "description": "xyz789",
+ "metadata": {},
+ "createdAt": 1592577642,
+ "modifiedAt": 1592577642
+ }
+ }
+}
+
+ Queries
+
+
+ txTemplateByCode
+
+
+
+
+
+
+
+ Response
+ Returns a TxTemplate
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ code - String!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +query txTemplateByCode($code: String!) {
+ txTemplateByCode(code: $code) {
+ id
+ txTemplateId
+ version
+ code
+ params {
+ ...ParamDefinitionFragment
+ }
+ txInput {
+ ...TxInputFragment
+ }
+ entries {
+ ...EntryInputFragment
+ }
+ description
+ metadata
+ createdAt
+ modifiedAt
+ }
+}
+
+
+ Variables
+ + +{"code": "xyz789"}
+
+
+ Response
+ + +{
+ "data": {
+ "txTemplateByCode": {
+ "id": 4,
+ "txTemplateId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "version": 987,
+ "code": "xyz789",
+ "params": [ParamDefinition],
+ "txInput": TxInput,
+ "entries": [EntryInput],
+ "description": "abc123",
+ "metadata": {},
+ "createdAt": 1592577642,
+ "modifiedAt": 1592577642
+ }
+ }
+}
+Mutations
+
+ accountCreate
+
+
+
+
+
+
+
+ Response
+ Returns an AccountCreatePayload!
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ input - AccountCreateInput!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +mutation accountCreate($input: AccountCreateInput!) {
+ accountCreate(input: $input) {
+ account {
+ ...AccountFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{"input": AccountCreateInput}
+
+
+ Response
+ + +{"data": {"accountCreate": {"account": Account}}}
+
+ Mutations
+
+
+ accountSetCreate
+
+
+
+
+
+
+
+ Response
+ Returns an AccountSetCreatePayload!
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ input - AccountSetCreateInput!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +mutation accountSetCreate($input: AccountSetCreateInput!) {
+ accountSetCreate(input: $input) {
+ accountSet {
+ ...AccountSetFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{"input": AccountSetCreateInput}
+
+
+ Response
+ + +{"data": {"accountSetCreate": {"accountSet": AccountSet}}}
+
+ Mutations
+
+
+ accountSetUpdate
+
+
+
+
+
+
+
+ Response
+ Returns an AccountSetUpdatePayload!
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ id - UUID!
+ |
+ + | +
+ input - AccountSetUpdateInput!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +mutation accountSetUpdate(
+ $id: UUID!,
+ $input: AccountSetUpdateInput!
+) {
+ accountSetUpdate(
+ id: $id,
+ input: $input
+ ) {
+ accountSet {
+ ...AccountSetFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{
+ "id": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "input": AccountSetUpdateInput
+}
+
+
+ Response
+ + +{"data": {"accountSetUpdate": {"accountSet": AccountSet}}}
+
+ Mutations
+
+
+ accountUpdate
+
+
+
+
+
+
+
+ Response
+ Returns an AccountUpdatePayload!
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ id - UUID!
+ |
+ + | +
+ input - AccountUpdateInput!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +mutation accountUpdate(
+ $id: UUID!,
+ $input: AccountUpdateInput!
+) {
+ accountUpdate(
+ id: $id,
+ input: $input
+ ) {
+ account {
+ ...AccountFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{
+ "id": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "input": AccountUpdateInput
+}
+
+
+ Response
+ + +{"data": {"accountUpdate": {"account": Account}}}
+
+ Mutations
+
+
+ addToAccountSet
+
+
+
+
+
+
+
+ Response
+ Returns an AddToAccountSetPayload!
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ input - AddToAccountSetInput!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +mutation addToAccountSet($input: AddToAccountSetInput!) {
+ addToAccountSet(input: $input) {
+ accountSet {
+ ...AccountSetFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{"input": AddToAccountSetInput}
+
+
+ Response
+ + +{"data": {"addToAccountSet": {"accountSet": AccountSet}}}
+
+ Mutations
+
+
+ calaOutboxImportJobCreate
+
+
+
+
+
+
+
+ Response
+ Returns a CalaOutboxImportJobCreatePayload!
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ input - CalaOutboxImportJobCreateInput!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +mutation calaOutboxImportJobCreate($input: CalaOutboxImportJobCreateInput!) {
+ calaOutboxImportJobCreate(input: $input) {
+ job {
+ ...JobFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{"input": CalaOutboxImportJobCreateInput}
+
+
+ Response
+ + +{"data": {"calaOutboxImportJobCreate": {"job": Job}}}
+
+ Mutations
+
+
+ journalCreate
+
+
+
+
+
+
+
+ Response
+ Returns a JournalCreatePayload!
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ input - JournalCreateInput!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +mutation journalCreate($input: JournalCreateInput!) {
+ journalCreate(input: $input) {
+ journal {
+ ...JournalFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{"input": JournalCreateInput}
+
+
+ Response
+ + +{"data": {"journalCreate": {"journal": Journal}}}
+
+ Mutations
+
+
+ journalUpdate
+
+
+
+
+
+
+
+ Response
+ Returns a JournalUpdatePayload!
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ id - UUID!
+ |
+ + | +
+ input - JournalUpdateInput!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +mutation journalUpdate(
+ $id: UUID!,
+ $input: JournalUpdateInput!
+) {
+ journalUpdate(
+ id: $id,
+ input: $input
+ ) {
+ journal {
+ ...JournalFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{
+ "id": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "input": JournalUpdateInput
+}
+
+
+ Response
+ + +{"data": {"journalUpdate": {"journal": Journal}}}
+
+ Mutations
+
+
+ postTransaction
+
+
+
+
+
+
+
+ Response
+ Returns a PostTransactionPayload!
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ input - TransactionInput!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +mutation postTransaction($input: TransactionInput!) {
+ postTransaction(input: $input) {
+ transaction {
+ ...TransactionFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{"input": TransactionInput}
+
+
+ Response
+ + +{
+ "data": {
+ "postTransaction": {"transaction": Transaction}
+ }
+}
+
+ Mutations
+
+
+ removeFromAccountSet
+
+
+
+
+
+
+
+ Response
+ Returns a RemoveFromAccountSetPayload!
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ input - RemoveFromAccountSetInput!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +mutation removeFromAccountSet($input: RemoveFromAccountSetInput!) {
+ removeFromAccountSet(input: $input) {
+ accountSet {
+ ...AccountSetFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{"input": RemoveFromAccountSetInput}
+
+
+ Response
+ + +{
+ "data": {
+ "removeFromAccountSet": {"accountSet": AccountSet}
+ }
+}
+
+ Mutations
+
+
+ txTemplateCreate
+
+
+
+
+
+
+
+ Response
+ Returns a TxTemplateCreatePayload!
+
+
+
+
+
+ Arguments
+| Name | +Description | +
|---|---|
+ input - TxTemplateCreateInput!
+ |
+ + | +
+
+ Example
+
+
+ Query
+ + +mutation txTemplateCreate($input: TxTemplateCreateInput!) {
+ txTemplateCreate(input: $input) {
+ txTemplate {
+ ...TxTemplateFragment
+ }
+ }
+}
+
+
+ Variables
+ + +{"input": TxTemplateCreateInput}
+
+
+ Response
+ + +{"data": {"txTemplateCreate": {"txTemplate": TxTemplate}}}
+Types
+Account
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
id - ID!
+ |
+ + | +
accountId - UUID!
+ |
+ + | +
version - Int!
+ |
+ + | +
code - String!
+ |
+ + | +
name - String!
+ |
+ + | +
normalBalanceType - DebitOrCredit!
+ |
+ + | +
status - Status!
+ |
+ + | +
externalId - String
+ |
+ + | +
description - String
+ |
+ + | +
metadata - JSON
+ |
+ + | +
createdAt - Timestamp!
+ |
+ + | +
modifiedAt - Timestamp!
+ |
+ + | +
balance - Balance
+ |
+ + | +
|
+
+
+ Arguments+
+
+
+
+
+ |
+ |
sets - AccountSetConnection!
+ |
+ + | +
| + + | +|
+
+
+
+ Example
+ + +{
+ "id": 4,
+ "accountId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "version": 987,
+ "code": "xyz789",
+ "name": "xyz789",
+ "normalBalanceType": "DEBIT",
+ "status": "ACTIVE",
+ "externalId": "xyz789",
+ "description": "abc123",
+ "metadata": {},
+ "createdAt": 1592577642,
+ "modifiedAt": 1592577642,
+ "balance": Balance,
+ "sets": AccountSetConnection
+}
+
+ Types
+
+ AccountConnection
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
pageInfo - PageInfo!
+ |
+ Information to aid in pagination. | +
edges - [AccountEdge!]!
+ |
+ A list of edges. | +
nodes - [Account!]!
+ |
+ A list of nodes. | +
+
+
+
+ Example
+ + +{
+ "pageInfo": PageInfo,
+ "edges": [AccountEdge],
+ "nodes": [Account]
+}
+
+ Types
+
+ AccountCreateInput
+
+
+
+
+
+
+
+
+
+ Fields
+| Input Field | +Description | +
|---|---|
+ accountId - UUID!
+ |
+ + | +
+ externalId - String
+ |
+ + | +
+ code - String!
+ |
+ + | +
+ name - String!
+ |
+ + | +
+ normalBalanceType - DebitOrCredit!
+ |
+ + | +
+ description - String
+ |
+ + | +
+ status - Status!
+ |
+ + | +
+ metadata - JSON
+ |
+ + | +
+ accountSetIds - [UUID!]
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "accountId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "externalId": "abc123",
+ "code": "xyz789",
+ "name": "xyz789",
+ "normalBalanceType": "DEBIT",
+ "description": "abc123",
+ "status": "ACTIVE",
+ "metadata": {},
+ "accountSetIds": [
+ "7264d0c7-acf6-4069-913d-bb6ffd933733"
+ ]
+}
+
+ Types
+
+ AccountCreatePayload
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
account - Account!
+ |
+ + | +
+
+
+
+ Example
+ + +{"account": Account}
+
+ Types
+
+ AccountEdge
+ +
+ Types
+
+ AccountSet
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
id - ID!
+ |
+ + | +
accountSetId - UUID!
+ |
+ + | +
version - Int!
+ |
+ + | +
journalId - UUID!
+ |
+ + | +
name - String!
+ |
+ + | +
normalBalanceType - DebitOrCredit!
+ |
+ + | +
description - String
+ |
+ + | +
metadata - JSON
+ |
+ + | +
createdAt - Timestamp!
+ |
+ + | +
modifiedAt - Timestamp!
+ |
+ + | +
balance - Balance
+ |
+ + | +
|
+
+
+ Arguments+
+
+
+
+
+ |
+ |
+
+
+
+ Example
+ + +{
+ "id": "4",
+ "accountSetId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "version": 987,
+ "journalId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "name": "abc123",
+ "normalBalanceType": "DEBIT",
+ "description": "xyz789",
+ "metadata": {},
+ "createdAt": 1592577642,
+ "modifiedAt": 1592577642,
+ "balance": Balance
+}
+
+ Types
+
+ AccountSetConnection
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
pageInfo - PageInfo!
+ |
+ Information to aid in pagination. | +
edges - [AccountSetEdge!]!
+ |
+ A list of edges. | +
nodes - [AccountSet!]!
+ |
+ A list of nodes. | +
+
+
+
+ Example
+ + +{
+ "pageInfo": PageInfo,
+ "edges": [AccountSetEdge],
+ "nodes": [AccountSet]
+}
+
+ Types
+
+ AccountSetCreateInput
+
+
+
+
+
+
+
+
+
+ Example
+ + +{
+ "accountSetId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "journalId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "name": "abc123",
+ "normalBalanceType": "DEBIT",
+ "description": "abc123",
+ "metadata": {}
+}
+
+ Types
+
+ AccountSetCreatePayload
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
accountSet - AccountSet!
+ |
+ + | +
+
+
+
+ Example
+ + +{"accountSet": AccountSet}
+
+ Types
+
+ AccountSetEdge
+
+
+
+
+
+
+ Description
+An edge in a connection.
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
node - AccountSet!
+ |
+ The item at the end of the edge | +
cursor - String!
+ |
+ A cursor for use in pagination | +
+
+
+
+ Example
+ + +{
+ "node": AccountSet,
+ "cursor": "abc123"
+}
+
+ Types
+
+ AccountSetMemberType
+
+
+
+
+
+
+
+
+
+ Values
+| Enum Value | +Description | +
|---|---|
|
+
|
+ + | +
|
+
|
+ + | +
+
+
+
+ Example
+ + +"ACCOUNT"
+
+ Types
+
+ AccountSetUpdateInput
+
+
+
+
+
+
+
+
+
+ Fields
+| Input Field | +Description | +
|---|---|
+ name - String
+ |
+ + | +
+ normalBalanceType - DebitOrCredit
+ |
+ + | +
+ description - String
+ |
+ + | +
+ metadata - JSON
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "name": "xyz789",
+ "normalBalanceType": "DEBIT",
+ "description": "abc123",
+ "metadata": {}
+}
+
+ Types
+
+ AccountSetUpdatePayload
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
accountSet - AccountSet!
+ |
+ + | +
+
+
+
+ Example
+ + +{"accountSet": AccountSet}
+
+ Types
+
+ AccountUpdateInput
+
+
+
+
+
+
+
+
+
+ Example
+ + +{
+ "externalId": "xyz789",
+ "code": "xyz789",
+ "name": "abc123",
+ "normalBalanceType": "DEBIT",
+ "description": "abc123",
+ "status": "ACTIVE",
+ "metadata": {}
+}
+
+ Types
+
+ AccountUpdatePayload
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
account - Account!
+ |
+ + | +
+
+
+
+ Example
+ + +{"account": Account}
+
+ Types
+
+ AddToAccountSetInput
+
+
+
+
+
+
+
+
+
+ Fields
+| Input Field | +Description | +
|---|---|
+ accountSetId - UUID!
+ |
+ + | +
+ memberId - UUID!
+ |
+ + | +
+ memberType - AccountSetMemberType!
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "accountSetId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "memberId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "memberType": "ACCOUNT"
+}
+
+ Types
+
+ AddToAccountSetPayload
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
accountSet - AccountSet!
+ |
+ + | +
+
+
+
+ Example
+ + +{"accountSet": AccountSet}
+
+ Types
+
+ Balance
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
id - ID!
+ |
+ + | +
journalId - UUID!
+ |
+ + | +
accountId - UUID!
+ |
+ + | +
entryId - UUID!
+ |
+ + | +
currency - CurrencyCode!
+ |
+ + | +
settled - BalanceAmount!
+ |
+ + | +
pending - BalanceAmount!
+ |
+ + | +
encumbrance - BalanceAmount!
+ |
+ + | +
version - Int!
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "id": "4",
+ "journalId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "accountId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "entryId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "currency": CurrencyCode,
+ "settled": BalanceAmount,
+ "pending": BalanceAmount,
+ "encumbrance": BalanceAmount,
+ "version": 123
+}
+
+ Types
+
+ BalanceAmount
+
+
+
+
+
+
+
+
+
+ Example
+ + +{
+ "drBalance": Money,
+ "crBalance": Money,
+ "normalBalance": Money,
+ "entryId": "7264d0c7-acf6-4069-913d-bb6ffd933733"
+}
+
+ Types
+
+ Boolean
+
+
+
+
+
+
+ Description
+The Boolean scalar type represents true or false.
+
+
+ Types
+
+ CalaOutboxImportJobCreateInput
+
+
+
+
+
+
+
+
+
+ Example
+ + +{
+ "jobId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "name": "abc123",
+ "description": "abc123",
+ "endpoint": "abc123"
+}
+
+ Types
+
+ CalaOutboxImportJobCreatePayload
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
job - Job!
+ |
+ + | +
+
+
+
+ Example
+ + +{"job": Job}
+
+ Types
+
+ CurrencyCode
+
+
+
+
+
+
+
+
+ Example
+ + +CurrencyCode
+
+ Types
+
+ Date
+
+
+
+
+
+
+
+
+ Example
+ + +"2007-12-03"
+
+ Types
+
+ DebitOrCredit
+
+
+
+
+
+
+
+
+
+ Values
+| Enum Value | +Description | +
|---|---|
|
+
|
+ + | +
|
+
|
+ + | +
+
+
+
+ Example
+ + +"DEBIT"
+
+ Types
+
+ Decimal
+
+
+
+
+
+
+
+
+ Example
+ + +Decimal
+
+ Types
+
+ EntryInput
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
entryType - Expression!
+ |
+ + | +
accountId - Expression!
+ |
+ + | +
layer - Expression!
+ |
+ + | +
direction - Expression!
+ |
+ + | +
units - Expression!
+ |
+ + | +
currency - Expression!
+ |
+ + | +
description - Expression
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "entryType": Expression,
+ "accountId": Expression,
+ "layer": Expression,
+ "direction": Expression,
+ "units": Expression,
+ "currency": Expression,
+ "description": Expression
+}
+
+ Types
+
+ Expression
+
+
+
+
+
+
+
+
+ Example
+ + +Expression
+
+ Types
+
+ ID
+
+
+
+
+
+
+ Description
+The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
+
+
+
+ Example
+ + +4
+
+ Types
+
+ Int
+
+
+
+
+
+
+ Description
+The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
+
+
+
+ Example
+ + +987
+
+ Types
+
+ JSON
+
+
+
+
+
+
+
+
+ Example
+ + +{}
+
+ Types
+
+ Job
+
+
+
+
+
+
+
+
+
+ Example
+ + +{
+ "id": "4",
+ "jobId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "name": "abc123",
+ "description": "xyz789"
+}
+
+ Types
+
+ JobConnection
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
pageInfo - PageInfo!
+ |
+ Information to aid in pagination. | +
edges - [JobEdge!]!
+ |
+ A list of edges. | +
nodes - [Job!]!
+ |
+ A list of nodes. | +
+
+
+
+ Example
+ + +{
+ "pageInfo": PageInfo,
+ "edges": [JobEdge],
+ "nodes": [Job]
+}
+
+ Types
+
+ JobEdge
+ +
+ Types
+
+ Journal
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
id - ID!
+ |
+ + | +
journalId - UUID!
+ |
+ + | +
version - Int!
+ |
+ + | +
name - String!
+ |
+ + | +
status - Status!
+ |
+ + | +
description - String
+ |
+ + | +
createdAt - Timestamp!
+ |
+ + | +
modifiedAt - Timestamp!
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "id": "4",
+ "journalId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "version": 123,
+ "name": "xyz789",
+ "status": "ACTIVE",
+ "description": "xyz789",
+ "createdAt": 1592577642,
+ "modifiedAt": 1592577642
+}
+
+ Types
+
+ JournalCreateInput
+
+
+
+
+
+
+
+
+
+ Example
+ + +{
+ "journalId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "name": "abc123",
+ "status": "ACTIVE",
+ "description": "xyz789"
+}
+
+ Types
+
+ JournalCreatePayload
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
journal - Journal!
+ |
+ + | +
+
+
+
+ Example
+ + +{"journal": Journal}
+
+ Types
+
+ JournalUpdateInput
+ +
+ Types
+
+ JournalUpdatePayload
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
journal - Journal!
+ |
+ + | +
+
+
+
+ Example
+ + +{"journal": Journal}
+
+ Types
+
+ Money
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
units - Decimal!
+ |
+ + | +
currency - CurrencyCode!
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "units": Decimal,
+ "currency": CurrencyCode
+}
+
+ Types
+
+ PageInfo
+
+
+
+
+
+
+ Description
+Information about pagination in a connection
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
hasPreviousPage - Boolean!
+ |
+ When paginating backwards, are there more items? | +
hasNextPage - Boolean!
+ |
+ When paginating forwards, are there more items? | +
startCursor - String
+ |
+ When paginating backwards, the cursor to continue. | +
endCursor - String
+ |
+ When paginating forwards, the cursor to continue. | +
+
+
+
+ Example
+ + +{
+ "hasPreviousPage": true,
+ "hasNextPage": false,
+ "startCursor": "abc123",
+ "endCursor": "abc123"
+}
+
+ Types
+
+ ParamDataType
+
+
+
+
+
+
+
+
+
+ Values
+| Enum Value | +Description | +
|---|---|
|
+
|
+ + | +
|
+
|
+ + | +
|
+
|
+ + | +
|
+
|
+ + | +
|
+
|
+ + | +
|
+
|
+ + | +
|
+
|
+ + | +
|
+
|
+ + | +
+
+
+
+ Example
+ + +"STRING"
+
+ Types
+
+ ParamDefinition
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
name - String!
+ |
+ + | +
type - ParamDataType!
+ |
+ + | +
default - Expression
+ |
+ + | +
description - String
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "name": "abc123",
+ "type": "STRING",
+ "default": Expression,
+ "description": "abc123"
+}
+
+ Types
+
+ ParamDefinitionInput
+
+
+
+
+
+
+
+
+
+ Fields
+| Input Field | +Description | +
|---|---|
+ name - String!
+ |
+ + | +
+ type - ParamDataType!
+ |
+ + | +
+ default - Expression
+ |
+ + | +
+ description - String
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "name": "xyz789",
+ "type": "STRING",
+ "default": Expression,
+ "description": "xyz789"
+}
+
+ Types
+
+ PostTransactionPayload
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
transaction - Transaction!
+ |
+ + | +
+
+
+
+ Example
+ + +{"transaction": Transaction}
+
+ Types
+
+ RemoveFromAccountSetInput
+
+
+
+
+
+
+
+
+
+ Fields
+| Input Field | +Description | +
|---|---|
+ accountSetId - UUID!
+ |
+ + | +
+ memberId - UUID!
+ |
+ + | +
+ memberType - AccountSetMemberType!
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "accountSetId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "memberId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "memberType": "ACCOUNT"
+}
+
+ Types
+
+ RemoveFromAccountSetPayload
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
accountSet - AccountSet!
+ |
+ + | +
+
+
+
+ Example
+ + +{"accountSet": AccountSet}
+
+ Types
+
+ Status
+
+
+
+
+
+
+
+
+
+ Values
+| Enum Value | +Description | +
|---|---|
|
+
|
+ + | +
|
+
|
+ + | +
+
+
+
+ Example
+ + +"ACTIVE"
+
+ Types
+
+ String
+
+
+
+
+
+
+ Description
+The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
+
+
+
+ Example
+ + +"xyz789"
+
+ Types
+
+ Timestamp
+
+
+
+
+
+
+
+
+ Example
+ + +1592577642
+
+ Types
+
+ Transaction
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
id - ID!
+ |
+ + | +
transactionId - UUID!
+ |
+ + | +
version - Int!
+ |
+ + | +
txTemplateId - UUID!
+ |
+ + | +
journalId - UUID!
+ |
+ + | +
effective - Date!
+ |
+ + | +
correlationId - String!
+ |
+ + | +
externalId - String
+ |
+ + | +
description - String
+ |
+ + | +
metadata - JSON
+ |
+ + | +
createdAt - Timestamp!
+ |
+ + | +
modifiedAt - Timestamp!
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "id": "4",
+ "transactionId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "version": 987,
+ "txTemplateId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "journalId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "effective": "2007-12-03",
+ "correlationId": "abc123",
+ "externalId": "xyz789",
+ "description": "xyz789",
+ "metadata": {},
+ "createdAt": 1592577642,
+ "modifiedAt": 1592577642
+}
+
+ Types
+
+ TransactionInput
+
+
+
+
+
+
+
+
+
+ Example
+ + +{
+ "transactionId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "txTemplateCode": "xyz789",
+ "params": {}
+}
+
+ Types
+
+ TxInput
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
effective - Expression!
+ |
+ + | +
journalId - Expression!
+ |
+ + | +
correlationId - Expression
+ |
+ + | +
externalId - Expression
+ |
+ + | +
description - Expression
+ |
+ + | +
metadata - Expression
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "effective": Expression,
+ "journalId": Expression,
+ "correlationId": Expression,
+ "externalId": Expression,
+ "description": Expression,
+ "metadata": Expression
+}
+
+ Types
+
+ TxTemplate
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
id - ID!
+ |
+ + | +
txTemplateId - UUID!
+ |
+ + | +
version - Int!
+ |
+ + | +
code - String!
+ |
+ + | +
params - [ParamDefinition!]
+ |
+ + | +
txInput - TxInput!
+ |
+ + | +
entries - [EntryInput!]!
+ |
+ + | +
description - String
+ |
+ + | +
metadata - JSON
+ |
+ + | +
createdAt - Timestamp!
+ |
+ + | +
modifiedAt - Timestamp!
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "id": 4,
+ "txTemplateId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "version": 123,
+ "code": "xyz789",
+ "params": [ParamDefinition],
+ "txInput": TxInput,
+ "entries": [EntryInput],
+ "description": "xyz789",
+ "metadata": {},
+ "createdAt": 1592577642,
+ "modifiedAt": 1592577642
+}
+
+ Types
+
+ TxTemplateCreateInput
+
+
+
+
+
+
+
+
+
+ Fields
+| Input Field | +Description | +
|---|---|
+ txTemplateId - UUID!
+ |
+ + | +
+ code - String!
+ |
+ + | +
+ params - [ParamDefinitionInput!]
+ |
+ + | +
+ txInput - TxTemplateTxInput!
+ |
+ + | +
+ entries - [TxTemplateEntryInput!]!
+ |
+ + | +
+ description - String
+ |
+ + | +
+ metadata - JSON
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "txTemplateId": "7264d0c7-acf6-4069-913d-bb6ffd933733",
+ "code": "abc123",
+ "params": [ParamDefinitionInput],
+ "txInput": TxTemplateTxInput,
+ "entries": [TxTemplateEntryInput],
+ "description": "abc123",
+ "metadata": {}
+}
+
+ Types
+
+ TxTemplateCreatePayload
+
+
+
+
+
+
+
+
+
+ Fields
+| Field Name | +Description | +
|---|---|
txTemplate - TxTemplate!
+ |
+ + | +
+
+
+
+ Example
+ + +{"txTemplate": TxTemplate}
+
+ Types
+
+ TxTemplateEntryInput
+
+
+
+
+
+
+
+
+
+ Fields
+| Input Field | +Description | +
|---|---|
+ entryType - Expression!
+ |
+ + | +
+ accountId - Expression!
+ |
+ + | +
+ layer - Expression!
+ |
+ + | +
+ direction - Expression!
+ |
+ + | +
+ units - Expression!
+ |
+ + | +
+ currency - Expression!
+ |
+ + | +
+ description - Expression
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "entryType": Expression,
+ "accountId": Expression,
+ "layer": Expression,
+ "direction": Expression,
+ "units": Expression,
+ "currency": Expression,
+ "description": Expression
+}
+
+ Types
+
+ TxTemplateTxInput
+
+
+
+
+
+
+
+
+
+ Fields
+| Input Field | +Description | +
|---|---|
+ effective - Expression!
+ |
+ + | +
+ journalId - Expression!
+ |
+ + | +
+ correlationId - Expression
+ |
+ + | +
+ externalId - Expression
+ |
+ + | +
+ description - Expression
+ |
+ + | +
+ metadata - Expression
+ |
+ + | +
+
+
+
+ Example
+ + +{
+ "effective": Expression,
+ "journalId": Expression,
+ "correlationId": Expression,
+ "externalId": Expression,
+ "description": Expression,
+ "metadata": Expression
+}
+
+ Types
+
+ UUID
+
+
+
+
+
+
+
+
+ Example
+ + +"7264d0c7-acf6-4069-913d-bb6ffd933733"
+
+
+
+