> ## Documentation Index
> Fetch the complete documentation index at: https://docs.layerfi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Vendor Payout object

A Vendor Payout represents a transfer of funds from a Business to vendors through a payment processor or platform.

Vendor payouts typically include the total amount of bill payments made to vendors, minus any vendor refunds received, and are the AP equivalent of [Customer Payouts]("api-reference/customer-payouts/payout").

### Attributes

<ParamField body="id" type="string" required="true">
  Unique identifier for the vendor payout.
</ParamField>

<ParamField body="external_id" type="string">
  Unique ID of the vendor payout in your system for linking purposes and idempotency.
</ParamField>

<ParamField body="business_id" type="string" required="true">
  ID of the Business that made the vendor payout.
</ParamField>

<ParamField body="paid_out_amount" type="integer" required="true">
  The amount of the vendor payout, in cents. This amount can be negative if vendor refunds exceed bill payments.
</ParamField>

<ParamField body="processor" type="string">
  Processor used to make the payment. Any processor name can be provided and will be tracked. If not null, every bill payment or vendor refund payment associated with the vendor payout must have the same processor.
</ParamField>

<ParamField body="imported_at" type="ISO8601 timestamp" required="true">
  Timestamp of when the vendor payout was imported into Layer.
</ParamField>

<ParamField body="completed_at" type="ISO8601 timestamp" required="true">
  Timestamp of when the vendor payout was completed.
</ParamField>

<ParamField body="match" type="Match object">
  The transaction match associated with the vendor payout, if any.
</ParamField>

<ParamField body="payments" type="array of BillPayment objects">
  A list of [Bill Payments](/api-reference/bill/payments) associated with the vendor payout. Note: Unlike customer payouts, you must reference existing bill payments - new bill payments cannot be created as part of vendor payout creation.
</ParamField>

<ParamField body="refunds" type="array of VendorRefund objects">
  List of [Vendor Refund Payments](/api-reference/vendor-refunds/vendor-refund#vendor-refund-payment-object) associated with this vendor payout. Note: You must reference existing vendor refund payments, not vendor refunds themselves.
</ParamField>

<ParamField body="other_transactions" type="array of OtherVendorPayoutTransaction objects">
  A list of other transactions associated with the vendor payout for adjustments or fees.

  <Expandable title="Other transaction properties">
    <ResponseField name="id" required="true" type="string">
      Unique identifier for the transaction
    </ResponseField>

    <ResponseField name="amount" required="true" type="integer">
      Amount of the transaction, in cents (must be positive)
    </ResponseField>

    <ResponseField name="direction" required="true" type="string">
      Direction of the transaction (MONEY\_IN or MONEY\_OUT)
    </ResponseField>

    <ResponseField name="account" required="true" type="AccountIdentifier">
      Account identifier for the transaction
    </ResponseField>

    <ResponseField name="description" required="true" type="string">
      Description of the transaction
    </ResponseField>

    <ResponseField name="external_id" type="string">
      External ID of the transaction in your system
    </ResponseField>
  </Expandable>
</ParamField>

<ParamField body="suggested_matches" type="array of SuggestedMatch objects">
  List of suggested bank transaction matches for the vendor payout.
</ParamField>

<ParamField body="transaction_tags" type="Array of Tags">
  Tags associated with the vendor payout.

  <Expandable title="Tag properties">
    <ResponseField name="key" required="true" type="string">
      The tag's key
    </ResponseField>

    <ResponseField name="value" required="true" type="string">
      The tag's value
    </ResponseField>

    <ResponseField name="created_at" required="true" type="ISO8601 timestamp">
      When the tag was created
    </ResponseField>

    <ResponseField name="updated_at" required="true" type="ISO8601 timestamp">
      When the tag was last updated
    </ResponseField>

    <ResponseField name="deleted_at" type="ISO8601 timestamp">
      When the tag was deleted
    </ResponseField>
  </Expandable>
</ParamField>

<ParamField body="memo" type="string">
  Memo for any text you would like to associate with the vendor payout (for example, to display to end users).
</ParamField>

<ParamField body="metadata" type="json object">
  Arbitrary metadata you can include with the vendor payout
</ParamField>

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "vendor-payout-1234",
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "paid_out_amount": 15000,
    "processor": "STRIPE",
    "imported_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "match": {
      "id": "6b0a3734-f4ef-4fb0-9fc1-3f59b0c1cf99",
      "match_type": "VENDOR_PAYOUT",
      "bank_transaction": {
        "type": "Bank_Transaction_Data",
        "id": "a703c8d6-cfe8-453d-a275-b92eacc6fc6e",
        "business_id": "738ec216-e8e5-48f2-b7f2-cdc89c96b3d4",
        "source": "PLAID",
        "source_transaction_id": "trxn_1sdOeLQiFAKE2LQBkcvrJw95f",
        "source_account_id": "738ec216-e154-48f2-1111-cdc89c96b3d4",
        "imported_at": "2024-03-19T22:09:53.290591Z",
        "date": "2024-03-06T06:06:40Z",
        "direction": "DEBIT",
        "amount": 15000,
        "counterparty_name": "Stripe",
        "description": "Stripe Payment",
        "account_name": "Layer Banking",
        "categorization_status": "MATCHED"
      },
      "details": {
        "type": "Vendor_Payout_Match",
        "id": "d224508b-b05e-41da-89de-0fbd8a573507",
        "amount": 15000,
        "date": "2024-03-06T00:00:00Z",
        "description": "Vendor payout via STRIPE",
        "adjustment": null
      }
    },
    "suggested_matches": [
      {
        "id": "f81ca739-7931-475e-b88f-c2b324523f3a",
        "matchType": "VENDOR_PAYOUT",
        "details": {
          "type": "Vendor_Payout_Match",
          "id": "d224508b-b05e-41da-89de-0fbd8a573507",
          "amount": 15000,
          "date": "2024-03-06T00:00:00Z",
          "description": "Vendor payout via STRIPE",
          "adjustment": null
        }
      }
    ],
    "payments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "bill-payment-1",
        "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "paid_to_vendor_amount": 10000,
        "platform_fee": 50,
        "processor": "STRIPE",
        "paid_at": "2023-11-07T05:31:56Z",
        "imported_at": "2023-11-07T05:31:56Z",
        "allocations": [
          {
            "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "amount": 10000,
            "transaction_tags": []
          }
        ],
        "transaction_tags": []
      },
      {
        "id": "4d91d4dd-1e55-5c61-9999-9ee36847163b",
        "external_id": "bill-payment-2",
        "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vendor_id": "4d91d4dd-1e55-5c61-9999-9ee36847163b",
        "paid_to_vendor_amount": 5000,
        "platform_fee": 25,
        "processor": "STRIPE",
        "paid_at": "2023-11-07T05:31:56Z",
        "imported_at": "2023-11-07T05:31:56Z",
        "allocations": [
          {
            "bill_id": "4d91d4dd-1e55-5c61-9999-9ee36847163b",
            "payment_id": "4d91d4dd-1e55-5c61-9999-9ee36847163b",
            "amount": 5000,
            "transaction_tags": []
          }
        ],
        "transaction_tags": []
      }
    ],
    "refunds": [],
    "other_transactions": [],
    "transaction_tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "Department",
        "value": "Operations",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": null
      }
    ],
    "memo": "Weekly vendor payments batch",
    "metadata": {
      "batch_id": "batch-789",
      "approval_code": "MGR-456"
    }
  }
  ```
</ResponseExample>