MOmodern-treasury

[DEPRECATED] Create Ledger Account Payout

Changed on
post/ledger_account_payouts

Request

  • Base URL
    https://app.moderntreasury.com/api
  • URL
    https://app.moderntreasury.com/api/ledger_account_payouts
  • Auth
    HTTP basic

Request body

descriptionstring
statusstring

It is set to pending by default. To post a ledger account payout at creation, use posted.

payout_ledger_account_idstring required

The ledger account whose ledger entries are queried against, and its balance is reduced as a result.

funding_ledger_account_idstring required

The ledger account that sends to or receives funds from the payout ledger account.

effective_at_upper_boundstring date

The maximum effective_at timestamp of the ledger entries to be included in the ledger account payout. The default value is the created_at timestamp of the ledger account payout.

allow_either_directionboolean

If true, the payout amount and payout_entry_direction will bring the payout ledger account’s balance closer to zero, even if the balance is negative.

metadatastring json

Metadata to be added to the ledger account payout. Must be a JSON object.

skip_payout_ledger_transactionboolean

It is set to false by default. It should be set to true when migrating existing payouts.

Response

201

idstring
objectstring
live_modeboolean
descriptionstring
payout_ledger_account_idstring
funding_ledger_account_idstring
effective_at_upper_boundstring
statusstring
amountunknown
currencystring
ledger_transaction_idunknown
created_atstring
updated_atstring

Example response

{
  "id": "dbdbbfe5-da56-4aaf-be36-3fbc415622dd",
  "object": "ledger_account_payout",
  "live_mode": true,
  "description": "Alice's January payout",
  "payout_ledger_account_id": "d44ad0d0-b3ea-4698-867d-09fe961e52a6",
  "funding_ledger_account_id": "3824af4d-4151-48f6-8e8b-bf859cbddbcd",
  "effective_at_upper_bound": "2023-01-01T00:00:00.000Z",
  "status": "processing",
  "currency": "USD",
  "metadata": {
    "foo": "bar"
  },
  "created_at": "2023-01-11T20:35:36Z",
  "updated_at": "2023-01-11T20:35:36Z"
}

Changes