Nominal Transactions
This document provides an overview of the operations available for the Financials (Nominal) Transactions business entity. Please note that the queries shown below only present a subset of the fields.
For a full list of fields, please refer to our schema documentation provided within our API. See Explore the API.
Mutations
Create Journal Transactions
To create new Nominal transactions within a Financials or Dimensions database, the Transaction bulk create endpoint can be used. This operation supports both batching and posting of transactions. You can create one or more of the following types of Nominal transactions using this operation:
- Journal
- Debit Tax(VAT) Journal
- Credit Tax(VAT) Journal
- Currency Transfer
Request
Here's an example of how you can use the create
mutation:
mutation (
$transactions: [NominalTransactionBulkInput!]!
$validateOnly: Boolean
) {
financials {
transactions {
bulkTransactions {
bulkCreate(transactions: $transactions, validateOnly: $validateOnly) {
... on IntEntityIds {
...IntEntityIdDetails
}
... on FailedValidation {
...FailedValidationDetails
}
... on UnexpectedError {
...UnexpectedErrorDetails
}
}
}
}
}
}
fragment IntEntityIdDetails on IntEntityIds {
ids
}
fragment FailedValidationDetails on FailedValidation {
errors {
...ValidationItemDetails
}
warnings {
...ValidationItemDetails
}
}
fragment ValidationItemDetails on ValidationItem {
message
details {
primaryKey
field
value
}
}
fragment UnexpectedErrorDetails on UnexpectedError {
errorMessage
}
When you execute the create
mutation, it performs several steps to create new transactions:
-
Running business validations: The API performs a number of business validations on the input data to ensure that it meets the required criteria. These validations can include checks for things like valid nominal accounts, correct gross amount, and any other business rules specific to your application. If any validation errors occur, the mutation will return a response with the details of the errors.
-
Calculating missing information: If any required information is missing from the input object, the mutation will calculate the missing values based on default settings or any other logic defined in the system. This ensures that the transaction has all the necessary data before it is created.
-
Saving the transaction: If all the necessary information is present and the business validations pass successfully, the mutation will save the transaction in the system and make it available for further processing or retrieval.