Input fields

accountNumber : String! required

The account number.
displayNote : String

Optional short note about the credit, to be displayed to the user.
idempotencyKey : UUID

An optional unique key that makes the request safe to retry. If a credit has already been posted with this key, no new credit is posted and an error is returned.
ledgerId : ID

The ID of the ledger where the credit will be posted.
Deprecation
The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
ledgerNumber : String

The number of the ledger where the credit will be posted.
netAmount : Int! required

The net amount of the credit to be posted. Amount should be posted in the smallest unit of currency.
note : String

Optional short note about the credit, to be displayed to internal systems.
postedDate : Date

The posted date of the credit to be posted. Defaults to today. Credits cannot be posted before the end of the latest closed statement on the ledger.
reason : String! required

The reason why the credit is posted. This should be a valid credit reason code.
taxAmount : Int! required

The tax amount of the credit to be posted. Amount should be posted in the smallest unit of currency.
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

{ "accountNumber": "A-4D7E52FB", "displayNote": "blood-method-try-fall-throw", "idempotencyKey": "b8fe2f4b-e915-43a9-8ba5-6d3424452ecf", "ledgerNumber": "all-firm-total-sound-trade", "netAmount": 96, "note": "would-day-federal-Mr-any", "postedDate": "2019-01-01", "reason": "easy-sing-radio-land-involve", "taxAmount": 33 }