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 or null
codestring or null
The code for the transaction
createdAtdatetime or null
customerIdstring or nullformat: "uuid"
The ID of the customer associated with the transaction
datedatetime or null
deletedAtdatetime or null
depositIdstring or nullformat: "uuid"
The ID of the deposit associated with the transaction
fiscalPeriodstring or null
The fiscal period for the transaction
householdobject or null
householdIdstring or nullformat: "uuid"
The ID of the household associated with the transaction
idstring or nullformat: "uuid"
isPaidboolean or null
Whether the transaction is paid
ledgerenum or null
The ledger for the transaction
Allowed values:
notestring or null
Notes about the transaction
organizationIdstring or nullformat: "uuid"
The ID of the organization associated with the transaction
paymentDatedatetime or null
The date the charge was paid
propertyIdstring or nullformat: "uuid"
The ID of the property associated with the transaction
readableIdstring or null
The readable ID for the transaction
reversedTransactionIdstring or nullformat: "uuid"
The ID of the reversed transaction
runningBalanceAmountdouble or null
The running balance amount after the transaction
subjournalenum or null
The subjournal for the transaction
Allowed values:
typeenum or null
The type of the transaction
updatedAtdatetime or null