API ReferenceTransactions

Create Transactions

<Badge>Available by Request</Badge> Create one or more transactions for households or applications. Transactions can include charges, payments, credits, and other financial records. At least one of householdId or applicationId must be provided for each transaction. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Request

This endpoint expects a list of objects.
idempotencyIdstringOptionalformat: "uuid"
codestringOptional
The code for the transaction
datedatetimeOptional
The date of the transaction
amountdoubleOptional
The amount of the transaction
documentNumberstringOptional<=255 characters
The document number for the transaction
notesstringOptional<=255 characters
Notes about the transaction
orderintegerOptional
The order of the transaction in the list
transactionIdstringOptionalformat: "uuid"
Optional transaction ID
customerIdstringOptionalformat: "uuid"
The customerId field is required when the transaction is associated with a household member other than the head of household.
householdIdstringOptionalformat: "uuid"
At least one of householdId or applicationId must be provided with each transaction.
applicationIdstringOptionalformat: "uuid"
At least one of householdId or applicationId must be provided with each transaction.

Response

The created transaction(s)

amountdouble
codestring
The code for the transaction
createdAtdatetime
customerIdstringformat: "uuid"
The ID of the customer associated with the transaction
datedatetime
deletedAtdatetime
depositIdstringformat: "uuid"
The ID of the deposit associated with the transaction
fiscalPeriodstring
The fiscal period for the transaction
householdobject
householdIdstringformat: "uuid"
The ID of the household associated with the transaction
idstringformat: "uuid"
isPaidboolean
Whether the transaction is paid
ledgerenum
The ledger for the transaction
Allowed values:
notestring
Notes about the transaction
organizationIdstringformat: "uuid"
The ID of the organization associated with the transaction
paymentDatedatetime
The date the charge was paid
propertyIdstringformat: "uuid"
The ID of the property associated with the transaction
readableIdstring
The readable ID for the transaction
reversedTransactionIdstringformat: "uuid"
The ID of the reversed transaction
runningBalanceAmountdouble
The running balance amount after the transaction
subjournalenum
The subjournal for the transaction
Allowed values:
typeenum
The type of the transaction
updatedAtdatetime