Fields

action : String

Whether the scheduled transaction is a 'charge' or a 'credit'.
ancillaryData : JSONString

Additional data that is consumed and associated with the scheduled transaction.
displayNote : String

Optional short note about the scheduled transaction for customer display.
grossAmount : BigInt

The gross amount of the scheduled transaction.
internalNote : String

Optional short note about the scheduled transaction for internal use.
ledgerNumber : String

The ledger the scheduled transaction is for.
metadata : JSONString

Any extra data that is associated with scheduled transaction.
netAmount : BigInt

The net amount of the scheduled transaction.
postedAfter : DateTime

The datetime after which the scheduled transaction can be added to the ledger.
reason : String

The reason why the scheduled transaction is added to the account.
salesTaxAmount : BigInt

The tax amount of the scheduled transaction.
salesTaxRate : Decimal

The tax rate of the scheduled transaction.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "action": "develop-do-last-seek-wind", "ancillaryData": {"key": "value"}, "displayNote": "dog-exist-natural-hope-later", "grossAmount": 1, "internalNote": "election-many-book-degree-bad", "ledgerNumber": "address-accept-lose-threat-summer", "metadata": {"key": "value"}, "netAmount": 1, "postedAfter": "1986-04-02T17:58:51.152881+00:00", "reason": "cultural-civil-station-position-soldier", "salesTaxAmount": 1, "salesTaxRate": "1.0" }