Input fields

action : String! required

Whether the scheduled transaction is a 'CHARGE' or a 'CREDIT'.
ancillaryData : JSONString default: {}

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

Optional short note about the scheduled transaction for customer display.
grossAmount : Int! required

The gross amount of the scheduled transaction.
idempotencyKey : String! required

Unique identifier for the scheduled transaction.
internalNote : String

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

The number of the ledger the scheduled transaction is for.
metadata : JSONString default: {}

Any extra data that will be associated with scheduled transaction.
netAmount : Int! required

The net amount of the scheduled transaction.
postedAfter : DateTime! required

The schedule on which the scheduled transaction will be posted.
reason : String! required

The reason why the scheduled transaction is added to the account. Based on the input this should be a valid charge or a valid credit reason code.
taxAmount : Int! required

The tax amount of the scheduled transaction.
taxRate : Decimal! required

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": "only-class-late-race-city", "ancillaryData": {"key": "value"}, "displayNote": "suddenly-itself-who-southern-myself", "grossAmount": 38, "idempotencyKey": "nearly-represent-fire-debate-fish", "internalNote": "agree-skin-understand-risk-floor", "ledgerNumber": "hospital-huge-ask-fish-own", "metadata": {"key": "value"}, "netAmount": 59, "postedAfter": "1976-04-20T11:21:38.270559+00:00", "reason": "Democrat-pay-woman-myself-read", "taxAmount": 85, "taxRate": "1.0" }