Create vendor payout

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/vendor-payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "vendor-payout-1234",
  "paid_out_amount": 123,
  "processor": "STRIPE",
  "completed_at": "2023-11-07T05:31:56Z",
  "bill_payments": [
    {
      "bill_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bill_payment_external_id": "<string>"
    }
  ],
  "vendor_refund_payments": [
    {
      "vendor_refund_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vendor_refund_payment_external_id": "<string>"
    }
  ],
  "other_transactions": [
    {
      "amount": 123,
      "direction": "CREDIT",
      "account": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "description": "<string>",
      "external_id": "<string>"
    }
  ],
  "tags": [
    {
      "key": "department",
      "value": "sales",
      "dimension_display_name": "Department",
      "value_display_name": "Sales Department"
    }
  ],
  "memo": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  },
  "reference_number": "<string>"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "vendor-payout-1234",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paid_out_amount": 123,
  "processor": "STRIPE",
  "imported_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "payments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "at": "2023-11-07T05:31:56Z",
      "method": "CASH",
      "amount": 123,
      "processor": "<string>",
      "payment_clearing_account": {
        "id": {
          "type": "AccountId",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "name": "Current Assets",
        "account_number": "4000",
        "stable_name": {
          "type": "StableName",
          "stable_name": "CURRENT_ASSETS"
        },
        "normality": "CREDIT",
        "account_type": {
          "value": "ASSET",
          "display_name": "Asset"
        },
        "account_subtype": {
          "value": "BANK_ACCOUNTS",
          "display_name": "Current Assets"
        }
      },
      "imported_at": "2023-11-07T05:31:56Z",
      "allocations": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 123,
          "transaction_tags": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "key": "ExampleTagKey",
              "value": "ExampleTagValue",
              "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "dimension_display_name": "<string>",
              "value_display_name": "<string>",
              "archived_at": "2023-11-07T05:31:56Z"
            }
          ],
          "memo": "<string>",
          "metadata": {
            "custom_field": "value",
            "any valid json": "below 1kb",
            "nested": {
              "meaning of life": 42,
              "array": []
            }
          },
          "reference_number": "<string>"
        }
      ],
      "transaction_tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "key": "ExampleTagKey",
          "value": "ExampleTagValue",
          "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dimension_display_name": "<string>",
          "value_display_name": "<string>",
          "archived_at": "2023-11-07T05:31:56Z"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "refunds": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "vendor-refund-123",
      "refunded_amount": 123,
      "status": "PAID",
      "completed_at": "2023-11-07T05:31:56Z",
      "allocations": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 123,
          "line_items": [
            {
              "external_id": "<string>",
              "amount": 123,
              "ledger_account": {
                "id": {
                  "type": "AccountId",
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                },
                "name": "Current Assets",
                "account_number": "4000",
                "stable_name": {
                  "type": "StableName",
                  "stable_name": "CURRENT_ASSETS"
                },
                "normality": "CREDIT",
                "account_type": {
                  "value": "ASSET",
                  "display_name": "Asset"
                },
                "account_subtype": {
                  "value": "BANK_ACCOUNTS",
                  "display_name": "Current Assets"
                }
              },
              "prepayment_account": {
                "id": {
                  "type": "AccountId",
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                },
                "name": "Current Assets",
                "account_number": "4000",
                "stable_name": {
                  "type": "StableName",
                  "stable_name": "CURRENT_ASSETS"
                },
                "normality": "CREDIT",
                "account_type": {
                  "value": "ASSET",
                  "display_name": "Asset"
                },
                "account_subtype": {
                  "value": "BANK_ACCOUNTS",
                  "display_name": "Current Assets"
                }
              },
              "transaction_tags": [
                {
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "key": "ExampleTagKey",
                  "value": "ExampleTagValue",
                  "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "dimension_display_name": "<string>",
                  "value_display_name": "<string>",
                  "archived_at": "2023-11-07T05:31:56Z"
                }
              ],
              "memo": "<string>",
              "metadata": {
                "custom_field": "value",
                "any valid json": "below 1kb",
                "nested": {
                  "meaning of life": 42,
                  "array": []
                }
              },
              "reference_number": "<string>"
            }
          ],
          "bill_external_id": "<string>",
          "bill_line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "bill_line_item_external_id": "<string>",
          "bill_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "bill_payment_external_id": "<string>",
          "vendor": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "external_id": "<string>",
            "individual_name": "<string>",
            "company_name": "<string>",
            "email": "<string>",
            "mobile_phone": "<string>",
            "office_phone": "<string>",
            "address_string": "<string>",
            "memo": "<string>",
            "status": "ACTIVE",
            "transaction_tags": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "key": "ExampleTagKey",
                "value": "ExampleTagValue",
                "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "dimension_display_name": "<string>",
                "value_display_name": "<string>",
                "archived_at": "2023-11-07T05:31:56Z"
              }
            ]
          },
          "transaction_tags": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "key": "ExampleTagKey",
              "value": "ExampleTagValue",
              "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "dimension_display_name": "<string>",
              "value_display_name": "<string>",
              "archived_at": "2023-11-07T05:31:56Z"
            }
          ],
          "memo": "<string>",
          "metadata": {
            "custom_field": "value",
            "any valid json": "below 1kb",
            "nested": {
              "meaning of life": 42,
              "array": []
            }
          },
          "reference_number": "<string>"
        }
      ],
      "payments": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "external_id": "payment-456",
          "refunded_amount": 123,
          "refund_processing_fee": 123,
          "completed_at": "2023-11-07T05:31:56Z",
          "method": "ACH",
          "processor": "STRIPE",
          "payment_clearing_account": {
            "id": {
              "type": "AccountId",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            },
            "name": "Current Assets",
            "account_number": "4000",
            "stable_name": {
              "type": "StableName",
              "stable_name": "CURRENT_ASSETS"
            },
            "normality": "CREDIT",
            "account_type": {
              "value": "ASSET",
              "display_name": "Asset"
            },
            "account_subtype": {
              "value": "BANK_ACCOUNTS",
              "display_name": "Current Assets"
            }
          },
          "transaction_tags": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "key": "ExampleTagKey",
              "value": "ExampleTagValue",
              "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "dimension_display_name": "<string>",
              "value_display_name": "<string>",
              "archived_at": "2023-11-07T05:31:56Z"
            }
          ],
          "memo": "<string>",
          "metadata": {
            "custom_field": "value",
            "any valid json": "below 1kb",
            "nested": {
              "meaning of life": 42,
              "array": []
            }
          },
          "reference_number": "<string>"
        }
      ],
      "transaction_tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "key": "ExampleTagKey",
          "value": "ExampleTagValue",
          "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dimension_display_name": "<string>",
          "value_display_name": "<string>",
          "archived_at": "2023-11-07T05:31:56Z"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "other_transactions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "direction": "CREDIT",
      "account": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "description": "<string>",
      "external_id": "<string>"
    }
  ],
  "transaction_tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "ExampleTagKey",
      "value": "ExampleTagValue",
      "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dimension_display_name": "<string>",
      "value_display_name": "<string>",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "match": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "match_type": "TRANSFER",
    "bank_transaction": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "date": "2023-11-07T05:31:56Z",
      "amount": 123,
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": "UNIT",
      "source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
      "source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
      "imported_at": "2023-11-07T05:31:56Z",
      "direction": "CREDIT",
      "counterparty_name": "WeWork",
      "description": "WeWork monthly rent payment",
      "account_name": "Plaid Checking",
      "categorizationStatus": "PENDING",
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    },
    "details": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "date": "2023-11-07T05:31:56Z",
      "description": "Transfer from SavingsAccount to CheckingAccount"
    }
  },
  "suggested_matches": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "matchType": "TRANSFER",
      "details": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "date": "2023-11-07T05:31:56Z",
        "description": "Transfer from SavingsAccount to CheckingAccount"
      }
    }
  ],
  "memo": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  },
  "reference_number": "<string>"
}

POST

businesses

{businessId}

vendor-payouts

Create vendor payout

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/vendor-payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "vendor-payout-1234",
  "paid_out_amount": 123,
  "processor": "STRIPE",
  "completed_at": "2023-11-07T05:31:56Z",
  "bill_payments": [
    {
      "bill_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "bill_payment_external_id": "<string>"
    }
  ],
  "vendor_refund_payments": [
    {
      "vendor_refund_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "vendor_refund_payment_external_id": "<string>"
    }
  ],
  "other_transactions": [
    {
      "amount": 123,
      "direction": "CREDIT",
      "account": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "description": "<string>",
      "external_id": "<string>"
    }
  ],
  "tags": [
    {
      "key": "department",
      "value": "sales",
      "dimension_display_name": "Department",
      "value_display_name": "Sales Department"
    }
  ],
  "memo": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  },
  "reference_number": "<string>"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "vendor-payout-1234",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paid_out_amount": 123,
  "processor": "STRIPE",
  "imported_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "payments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "at": "2023-11-07T05:31:56Z",
      "method": "CASH",
      "amount": 123,
      "processor": "<string>",
      "payment_clearing_account": {
        "id": {
          "type": "AccountId",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "name": "Current Assets",
        "account_number": "4000",
        "stable_name": {
          "type": "StableName",
          "stable_name": "CURRENT_ASSETS"
        },
        "normality": "CREDIT",
        "account_type": {
          "value": "ASSET",
          "display_name": "Asset"
        },
        "account_subtype": {
          "value": "BANK_ACCOUNTS",
          "display_name": "Current Assets"
        }
      },
      "imported_at": "2023-11-07T05:31:56Z",
      "allocations": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 123,
          "transaction_tags": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "key": "ExampleTagKey",
              "value": "ExampleTagValue",
              "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "dimension_display_name": "<string>",
              "value_display_name": "<string>",
              "archived_at": "2023-11-07T05:31:56Z"
            }
          ],
          "memo": "<string>",
          "metadata": {
            "custom_field": "value",
            "any valid json": "below 1kb",
            "nested": {
              "meaning of life": 42,
              "array": []
            }
          },
          "reference_number": "<string>"
        }
      ],
      "transaction_tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "key": "ExampleTagKey",
          "value": "ExampleTagValue",
          "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dimension_display_name": "<string>",
          "value_display_name": "<string>",
          "archived_at": "2023-11-07T05:31:56Z"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "refunds": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "vendor-refund-123",
      "refunded_amount": 123,
      "status": "PAID",
      "completed_at": "2023-11-07T05:31:56Z",
      "allocations": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 123,
          "line_items": [
            {
              "external_id": "<string>",
              "amount": 123,
              "ledger_account": {
                "id": {
                  "type": "AccountId",
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                },
                "name": "Current Assets",
                "account_number": "4000",
                "stable_name": {
                  "type": "StableName",
                  "stable_name": "CURRENT_ASSETS"
                },
                "normality": "CREDIT",
                "account_type": {
                  "value": "ASSET",
                  "display_name": "Asset"
                },
                "account_subtype": {
                  "value": "BANK_ACCOUNTS",
                  "display_name": "Current Assets"
                }
              },
              "prepayment_account": {
                "id": {
                  "type": "AccountId",
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                },
                "name": "Current Assets",
                "account_number": "4000",
                "stable_name": {
                  "type": "StableName",
                  "stable_name": "CURRENT_ASSETS"
                },
                "normality": "CREDIT",
                "account_type": {
                  "value": "ASSET",
                  "display_name": "Asset"
                },
                "account_subtype": {
                  "value": "BANK_ACCOUNTS",
                  "display_name": "Current Assets"
                }
              },
              "transaction_tags": [
                {
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "key": "ExampleTagKey",
                  "value": "ExampleTagValue",
                  "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "dimension_display_name": "<string>",
                  "value_display_name": "<string>",
                  "archived_at": "2023-11-07T05:31:56Z"
                }
              ],
              "memo": "<string>",
              "metadata": {
                "custom_field": "value",
                "any valid json": "below 1kb",
                "nested": {
                  "meaning of life": 42,
                  "array": []
                }
              },
              "reference_number": "<string>"
            }
          ],
          "bill_external_id": "<string>",
          "bill_line_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "bill_line_item_external_id": "<string>",
          "bill_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "bill_payment_external_id": "<string>",
          "vendor": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "external_id": "<string>",
            "individual_name": "<string>",
            "company_name": "<string>",
            "email": "<string>",
            "mobile_phone": "<string>",
            "office_phone": "<string>",
            "address_string": "<string>",
            "memo": "<string>",
            "status": "ACTIVE",
            "transaction_tags": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "key": "ExampleTagKey",
                "value": "ExampleTagValue",
                "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "dimension_display_name": "<string>",
                "value_display_name": "<string>",
                "archived_at": "2023-11-07T05:31:56Z"
              }
            ]
          },
          "transaction_tags": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "key": "ExampleTagKey",
              "value": "ExampleTagValue",
              "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "dimension_display_name": "<string>",
              "value_display_name": "<string>",
              "archived_at": "2023-11-07T05:31:56Z"
            }
          ],
          "memo": "<string>",
          "metadata": {
            "custom_field": "value",
            "any valid json": "below 1kb",
            "nested": {
              "meaning of life": 42,
              "array": []
            }
          },
          "reference_number": "<string>"
        }
      ],
      "payments": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "external_id": "payment-456",
          "refunded_amount": 123,
          "refund_processing_fee": 123,
          "completed_at": "2023-11-07T05:31:56Z",
          "method": "ACH",
          "processor": "STRIPE",
          "payment_clearing_account": {
            "id": {
              "type": "AccountId",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            },
            "name": "Current Assets",
            "account_number": "4000",
            "stable_name": {
              "type": "StableName",
              "stable_name": "CURRENT_ASSETS"
            },
            "normality": "CREDIT",
            "account_type": {
              "value": "ASSET",
              "display_name": "Asset"
            },
            "account_subtype": {
              "value": "BANK_ACCOUNTS",
              "display_name": "Current Assets"
            }
          },
          "transaction_tags": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "key": "ExampleTagKey",
              "value": "ExampleTagValue",
              "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "dimension_display_name": "<string>",
              "value_display_name": "<string>",
              "archived_at": "2023-11-07T05:31:56Z"
            }
          ],
          "memo": "<string>",
          "metadata": {
            "custom_field": "value",
            "any valid json": "below 1kb",
            "nested": {
              "meaning of life": 42,
              "array": []
            }
          },
          "reference_number": "<string>"
        }
      ],
      "transaction_tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "key": "ExampleTagKey",
          "value": "ExampleTagValue",
          "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dimension_display_name": "<string>",
          "value_display_name": "<string>",
          "archived_at": "2023-11-07T05:31:56Z"
        }
      ],
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "other_transactions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "direction": "CREDIT",
      "account": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "description": "<string>",
      "external_id": "<string>"
    }
  ],
  "transaction_tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "ExampleTagKey",
      "value": "ExampleTagValue",
      "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dimension_display_name": "<string>",
      "value_display_name": "<string>",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "match": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "match_type": "TRANSFER",
    "bank_transaction": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "date": "2023-11-07T05:31:56Z",
      "amount": 123,
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": "UNIT",
      "source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
      "source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
      "imported_at": "2023-11-07T05:31:56Z",
      "direction": "CREDIT",
      "counterparty_name": "WeWork",
      "description": "WeWork monthly rent payment",
      "account_name": "Plaid Checking",
      "categorizationStatus": "PENDING",
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    },
    "details": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "date": "2023-11-07T05:31:56Z",
      "description": "Transfer from SavingsAccount to CheckingAccount"
    }
  },
  "suggested_matches": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "matchType": "TRANSFER",
      "details": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "date": "2023-11-07T05:31:56Z",
        "description": "Transfer from SavingsAccount to CheckingAccount"
      }
    }
  ],
  "memo": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  },
  "reference_number": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type

string

Content-Type must be set to application/json

Path Parameters

businessId

string

required

The UUID of the business to create a vendor payout for

Body

application/json

external_id

string | null

Unique ID of the vendor payout in your system for linking purposes.

Example:

"vendor-payout-1234"

paid_out_amount

integer<int64>

The amount of the vendor payout, in cents. This amount can be negative if vendor refunds exceed bill payments.

processor

enum<string> | null

Processor used to make the payment. If not null, every bill payment or vendor refund payment associated with the vendor payout must have the same processor

Available options:

STRIPE,

PAYPAL,

SHOPIFY,

ADYEN,

RAINFOREST

Example:

"STRIPE"

completed_at

string<date-time>

Timestamp of when the vendor payout was completed

bill_payments

object[]

List of bill payments to associate with the vendor payout

Show child attributes

bill_payments.bill_payment_id

string<uuid> | null

UUID of the bill payment to associate with the vendor payout

bill_payments.bill_payment_external_id

string | null

External ID of the bill payment to associate with the vendor payout

vendor_refund_payments

object[]

List of vendor refund payments to associate with the vendor payout

Show child attributes

vendor_refund_payments.vendor_refund_payment_id

string<uuid> | null

UUID of the vendor refund payment to associate with the vendor payout

vendor_refund_payments.vendor_refund_payment_external_id

string | null

External ID of the vendor refund payment to associate with the vendor payout

other_transactions

object[]

A list of other transactions associated with the vendor payout

Show child attributes

other_transactions.amount

integer<int64>

Amount of the transaction, in cents. This amount must be a positive value.

other_transactions.direction

enum<string>

Direction of the transaction.

Available options:

CREDIT,

DEBIT

other_transactions.account

Account ID · object

Account identifier for the transaction.

Account ID
Account Stable Name

Show child attributes

other_transactions.account.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

other_transactions.account.id

string<uuid>

ID of the account

other_transactions.description

string

Description of the transaction.

other_transactions.external_id

string | null

External ID of the transaction in your system for linking purposes.

Response

Vendor payout has been successfully updated or unchanged.

string<uuid>

Unique ID for the Vendor Payout. Idempotency key.

external_id

string | null

Unique ID of the vendor payout in your system for linking purposes.

Example:

"vendor-payout-1234"

business_id

string<uuid>

ID of the Business that generated the vendor payout.

paid_out_amount

integer<int64>

The amount of the vendor payout, in cents

processor

enum<string> | null

Processor used to make the payment, if any. If not null, every bill payment or vendor refund payment associated with the vendor payout must have the same processor

Available options:

STRIPE,

PAYPAL,

SHOPIFY,

ADYEN,

RAINFOREST

Example:

"STRIPE"

imported_at

string<date-time>

Timestamp of when the vendor payout was imported

completed_at

string<date-time>

Timestamp of when the vendor payout was completed

payments

object[]

A list of bill payments associated with the vendor payout

Show child attributes

payments.id

string<uuid>

Unique identifier for the payment

payments.external_id

string | null

External ID for the payment

payments.at

string<date-time>

When the payment was made

payments.method

enum<string>

Method used for payment

Available options:

CASH,

CHECK,

CREDIT_CARD,

ACH,

CREDIT_BALANCE,

OTHER

payments.amount

integer<int64>

Payment amount in cents

payments.processor

string | null

Payment processor used

payments.payment_clearing_account

object

The the ledger account to use for the payment (overrides the default determined by the payment method), if specified.

Show child attributes

payments.payment_clearing_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

payments.payment_clearing_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

payments.payment_clearing_account.id.id

string<uuid>

ID of the account

payments.payment_clearing_account.name

string

Name of the account

Example:

"Current Assets"

payments.payment_clearing_account.account_number

string | null

Account number if configured

Example:

"4000"

payments.payment_clearing_account.stable_name

object

Show child attributes

payments.payment_clearing_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

payments.payment_clearing_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

payments.payment_clearing_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

payments.payment_clearing_account.account_type

object

Show child attributes

payments.payment_clearing_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

payments.payment_clearing_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

payments.payment_clearing_account.account_subtype

object

Show child attributes

payments.payment_clearing_account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

payments.payment_clearing_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

payments.imported_at

string<date-time>

When the payment was imported

payments.allocations

object[]

How the payment is allocated across bills

Show child attributes

payments.allocations.id

string<uuid>

Unique identifier for the allocation

payments.allocations.bill_id

string<uuid>

ID of the bill

payments.allocations.payment_id

string<uuid>

ID of the payment

payments.allocations.amount

integer<int64>

Amount allocated in cents

payments.allocations.transaction_tags

object[]

Tags associated with the allocation

Show child attributes

payments.allocations.transaction_tags.id

string<uuid>

required

ID for the tag

payments.allocations.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

payments.allocations.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

payments.allocations.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

payments.allocations.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

payments.allocations.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

payments.allocations.transaction_tags.value_display_name

string | null

Display name for the tag value definition

payments.allocations.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

payments.allocations.memo

string | null

Memo for any text you would like to associate with the bill payment allocation (for example, to display to end users).

payments.allocations.metadata

object

Arbitrary custom metadata in JSON format with a size limit of 1KB

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

payments.allocations.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the bill payment allocation.

payments.transaction_tags

object[]

Tags associated with the payment

Show child attributes

payments.transaction_tags.id

string<uuid>

required

ID for the tag

payments.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

payments.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

payments.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

payments.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

payments.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

payments.transaction_tags.value_display_name

string | null

Display name for the tag value definition

payments.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

payments.memo

string | null

Memo for any text you would like to associate with the bill payment (for example, to display to end users).

payments.metadata

object

Arbitrary custom metadata in JSON format with a size limit of 1KB

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

payments.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the bill payment. Can be used to filter when listing bill payments.

refunds

object[]

A list of vendor refund payments associated with the vendor payout

Show child attributes

refunds.id

string<uuid>

Unique identifier for the vendor refund.

refunds.external_id

string | null

Unique ID of the vendor refund in your system for linking purposes. Idempotency key.

Example:

"vendor-refund-123"

refunds.refunded_amount

integer<int64>

Amount refunded to the business in cents.

refunds.status

string

Status of the vendor refund.

Example:

"PAID"

refunds.completed_at

string<date-time>

Time when the vendor refund was completed.

refunds.allocations

object[]

Allocations associated with this vendor refund.

Show child attributes

refunds.allocations.id

string<uuid>

Unique identifier for the vendor refund allocation.

refunds.allocations.bill_id

string<uuid> | null

ID of the bill this allocation is associated with.

refunds.allocations.amount

integer<int64>

Amount of the allocation in cents.

refunds.allocations.line_items

object[]

Line items that make up this allocation.

Show child attributes

refunds.allocations.line_items.external_id

string | null

External identifier for the line item.

refunds.allocations.line_items.amount

integer<int64>

Amount of the line item in cents.

refunds.allocations.line_items.ledger_account

object

The ledger account associated with this line item.

Show child attributes

refunds.allocations.line_items.ledger_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

refunds.allocations.line_items.ledger_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

refunds.allocations.line_items.ledger_account.id.id

string<uuid>

ID of the account

refunds.allocations.line_items.ledger_account.name

string

Name of the account

Example:

"Current Assets"

refunds.allocations.line_items.ledger_account.account_number

string | null

Account number if configured

Example:

"4000"

refunds.allocations.line_items.ledger_account.stable_name

object

Show child attributes

refunds.allocations.line_items.ledger_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

refunds.allocations.line_items.ledger_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

refunds.allocations.line_items.ledger_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

refunds.allocations.line_items.ledger_account.account_type

object

Show child attributes

refunds.allocations.line_items.ledger_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

refunds.allocations.line_items.ledger_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

refunds.allocations.line_items.ledger_account.account_subtype

object

Show child attributes

refunds.allocations.line_items.ledger_account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

refunds.allocations.line_items.ledger_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

refunds.allocations.line_items.prepayment_account

object

The prepayment account associated with this line item, if applicable.

Show child attributes

refunds.allocations.line_items.prepayment_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

refunds.allocations.line_items.prepayment_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

refunds.allocations.line_items.prepayment_account.id.id

string<uuid>

ID of the account

refunds.allocations.line_items.prepayment_account.name

string

Name of the account

Example:

"Current Assets"

refunds.allocations.line_items.prepayment_account.account_number

string | null

Account number if configured

Example:

"4000"

refunds.allocations.line_items.prepayment_account.stable_name

object

Show child attributes

refunds.allocations.line_items.prepayment_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

refunds.allocations.line_items.prepayment_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

refunds.allocations.line_items.prepayment_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

refunds.allocations.line_items.prepayment_account.account_type

object

Show child attributes

refunds.allocations.line_items.prepayment_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

refunds.allocations.line_items.prepayment_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

refunds.allocations.line_items.prepayment_account.account_subtype

object

Show child attributes

refunds.allocations.line_items.prepayment_account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

refunds.allocations.line_items.prepayment_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

refunds.allocations.line_items.transaction_tags

object[]

Show child attributes

refunds.allocations.line_items.transaction_tags.id

string<uuid>

required

ID for the tag

refunds.allocations.line_items.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

refunds.allocations.line_items.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

refunds.allocations.line_items.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

refunds.allocations.line_items.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

refunds.allocations.line_items.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

refunds.allocations.line_items.transaction_tags.value_display_name

string | null

Display name for the tag value definition

refunds.allocations.line_items.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

refunds.allocations.line_items.memo

string | null

Memo for any text you would like to associate with the line item.

refunds.allocations.line_items.metadata

object

Arbitrary custom metadata in JSON format with a size limit of 1KB

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

refunds.allocations.line_items.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the vendor refund allocation line item.

refunds.allocations.bill_external_id

string | null

External ID of the bill this allocation is associated with.

refunds.allocations.bill_line_item_id

string<uuid> | null

ID of the bill line item this allocation is associated with. If specified, must not refer to a different bill than bill_id or bill_external_id.

refunds.allocations.bill_line_item_external_id

string | null

The external ID of the bill line item to refund. If specified alongside bill_line_item_id, they must refer to the same bill line item.

refunds.allocations.bill_payment_id

string<uuid> | null

ID of the bill payment this allocation is associated with.

refunds.allocations.bill_payment_external_id

string | null

External ID of the bill payment this allocation is associated with.

refunds.allocations.vendor

object

Show child attributes

refunds.allocations.vendor.id

string<uuid>

Unique identifier for the vendor.

refunds.allocations.vendor.external_id

string

Unique ID of the vendor in your system for linking purposes. Idempotency key.

refunds.allocations.vendor.individual_name

string | null

Full name of the individual vendor or contact at a corporate vendor.

refunds.allocations.vendor.company_name

string | null

Name of the company vendor.

refunds.allocations.vendor.email

string | null

Email address of the vendor.

refunds.allocations.vendor.mobile_phone

string | null

Mobile phone number of the vendor.

refunds.allocations.vendor.office_phone

string | null

Office phone number of the vendor.

refunds.allocations.vendor.address_string

string | null

Address of the vendor.

refunds.allocations.vendor.memo

string | null

Memo for any text you would like to associate with the vendor (for example, to display to end users).

refunds.allocations.vendor.status

enum<string>

Status of the vendor.

Available options:

ACTIVE,

ARCHIVED

refunds.allocations.vendor.transaction_tags

object[]

Show child attributes

refunds.allocations.vendor.transaction_tags.id

string<uuid>

required

ID for the tag

refunds.allocations.vendor.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

refunds.allocations.vendor.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

refunds.allocations.vendor.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

refunds.allocations.vendor.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

refunds.allocations.vendor.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

refunds.allocations.vendor.transaction_tags.value_display_name

string | null

Display name for the tag value definition

refunds.allocations.vendor.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

refunds.allocations.transaction_tags

object[]

Show child attributes

refunds.allocations.transaction_tags.id

string<uuid>

required

ID for the tag

refunds.allocations.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

refunds.allocations.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

refunds.allocations.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

refunds.allocations.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

refunds.allocations.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

refunds.allocations.transaction_tags.value_display_name

string | null

Display name for the tag value definition

refunds.allocations.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

refunds.allocations.memo

string | null

Memo for any text you would like to associate with the vendor refund allocation (for example, to display to end users).

refunds.allocations.metadata

object

Arbitrary custom metadata in JSON format with a size limit of 1KB

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

refunds.allocations.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the vendor refund allocation.

refunds.payments

object[]

Payments associated with this vendor refund.

Show child attributes

refunds.payments.id

string<uuid>

Unique identifier for the payment.

refunds.payments.external_id

string | null

Unique ID of the payment in your system for linking purposes. Idempotency key.

Example:

"payment-456"

refunds.payments.refunded_amount

integer<int64>

Amount refunded to the business in cents.

refunds.payments.refund_processing_fee

integer<int64> | null

Fee charged for the refund processing in cents.

refunds.payments.completed_at

string<date-time>

Time when the payment was completed.

refunds.payments.method

string

Method of the payment.

Example:

"ACH"

refunds.payments.processor

string | null

Processor used for the payment.

Example:

"STRIPE"

refunds.payments.payment_clearing_account

object

The the ledger account to use for the payment (overrides the default determined by the payment method), if specified.

Show child attributes

refunds.payments.payment_clearing_account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

refunds.payments.payment_clearing_account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

refunds.payments.payment_clearing_account.id.id

string<uuid>

ID of the account

refunds.payments.payment_clearing_account.name

string

Name of the account

Example:

"Current Assets"

refunds.payments.payment_clearing_account.account_number

string | null

Account number if configured

Example:

"4000"

refunds.payments.payment_clearing_account.stable_name

object

Show child attributes

refunds.payments.payment_clearing_account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

refunds.payments.payment_clearing_account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

refunds.payments.payment_clearing_account.normality

enum<string>

Available options:

CREDIT,

DEBIT

refunds.payments.payment_clearing_account.account_type

object

Show child attributes

refunds.payments.payment_clearing_account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

refunds.payments.payment_clearing_account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

refunds.payments.payment_clearing_account.account_subtype

object

Show child attributes

refunds.payments.payment_clearing_account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

refunds.payments.payment_clearing_account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

refunds.payments.transaction_tags

object[]

Show child attributes

refunds.payments.transaction_tags.id

string<uuid>

required

ID for the tag

refunds.payments.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

refunds.payments.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

refunds.payments.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

refunds.payments.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

refunds.payments.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

refunds.payments.transaction_tags.value_display_name

string | null

Display name for the tag value definition

refunds.payments.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

refunds.payments.memo

string | null

Memo for any text you would like to associate with the vendor refund payment (for example, to display to end users).

refunds.payments.metadata

object

Arbitrary custom metadata in JSON format with a size limit of 1KB

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

refunds.payments.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the vendor refund payment. Can be used to filter when listing vendor refund payments.

refunds.transaction_tags

object[]

Show child attributes

refunds.transaction_tags.id

string<uuid>

required

ID for the tag

refunds.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

refunds.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

refunds.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

refunds.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

refunds.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

refunds.transaction_tags.value_display_name

string | null

Display name for the tag value definition

refunds.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

refunds.memo

string | null

Memo for any text you would like to associate with the vendor refund (for example, to display to end users).

refunds.metadata

object

Arbitrary custom metadata in JSON format with a size limit of 1KB

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

refunds.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the vendor refund. Can be used to filter when listing vendor refunds.

other_transactions

object[]

A list of other transactions associated with the vendor payout

Show child attributes

other_transactions.id

string<uuid>

Unique ID for the other vendor payout transaction.

other_transactions.amount

integer<int64>

Amount of the transaction, in cents

other_transactions.direction

enum<string>

Direction of the transaction

Available options:

CREDIT,

DEBIT

other_transactions.account

Account ID · object

Account identifier for the transaction

Account ID
Account Stable Name

Show child attributes

other_transactions.account.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

other_transactions.account.id

string<uuid>

ID of the account

other_transactions.description

string

Description of the transaction

other_transactions.external_id

string | null

External ID of the transaction

transaction_tags

object[]

A list of tags associated with the vendor payout

Show child attributes

transaction_tags.id

string<uuid>

required

ID for the tag

transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

transaction_tags.value_display_name

string | null

Display name for the tag value definition

transaction_tags.archived_at

string<date-time> | null

When the tag was archived

match

object

The transaction match associated with the vendor payout

Show child attributes

match.id

string<uuid>

Layer's UUID for the match

match.match_type

enum<string>

Type of the object to match

Available options:

TRANSFER,

INVOICE_PAYMENT,

PAYOUT

match.bank_transaction

object

Show child attributes

match.bank_transaction.id

string<uuid>

required

Layer's UUID for the bank transaction

match.bank_transaction.date

string<date-time>

required

Timestamp when the transaction was created.

match.bank_transaction.amount

integer<int64>

required

Amount of the transaction, in cents.

match.bank_transaction.business_id

string<uuid>

UUID of the business the transaction is for

match.bank_transaction.source

enum<string>

Source of the bank transaction.

Available options:

UNIT,

PLAID,

API,

STRIPE,

CUSTOM

match.bank_transaction.source_transaction_id

string

External transaction ID from the source platform (e.g, Plaid transaction ID)

Example:

"g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko"

match.bank_transaction.source_account_id

string

External account ID from the source platform (e.g, Plaid account ID)

Example:

"Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG"

match.bank_transaction.imported_at

string<date-time>

Timestamp when the transaction was imported.

match.bank_transaction.direction

enum<string>

Direction of the transaction.

Available options:

CREDIT,

DEBIT

match.bank_transaction.counterparty_name

string | null

Name of the transaction counterparty

Example:

"WeWork"

match.bank_transaction.description

string | null

Description of the transaction.

Example:

"WeWork monthly rent payment"

match.bank_transaction.account_name

string | null

Name of the bank account

Example:

"Plaid Checking"

match.bank_transaction.categorizationStatus

enum<string>

The status of the transaction’s categorization in Layer’s systems.

Available options:

PENDING,

READY_FOR_INPUT,

CATEGORIZED,

SPLIT,

LAYER_REVIEW,

JOURNALING,

MATCHED

match.bank_transaction.memo

string | null

Memo for any text you would like to associate with the bank transaction (for example, to display to end users).

match.bank_transaction.metadata

object

Arbitrary custom metadata in JSON format with a size limit of 1KB

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

match.bank_transaction.reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the bank transaction. Can be used to filter when listing bank transactions.

match.details

object

Show child attributes

match.details.id

string<uuid>

required

Layer's ID for the match

match.details.amount

integer<int64>

required

Monetary amount of the matched transaction, in cents

match.details.date

string<date-time>

required

Date that the matched transaction occurred

match.details.description

string | null

Description of the match

Example:

"Transfer from SavingsAccount to CheckingAccount"

suggested_matches

object[]

A list of suggested matches for the vendor payout

Show child attributes

suggested_matches.id

string<uuid>

Layer's identifier for the suggested match

suggested_matches.matchType

enum<string>

Type of the matched object.

Available options:

TRANSFER,

INVOICE_PAYMENT,

PAYOUT

suggested_matches.details

object

Details of the suggested match

Show child attributes

suggested_matches.details.id

string<uuid>

required

Layer's ID for the match

suggested_matches.details.amount

integer<int64>

required

Monetary amount of the matched transaction, in cents

suggested_matches.details.date

string<date-time>

required

Date that the matched transaction occurred

suggested_matches.details.description

string | null

Description of the match

Example:

"Transfer from SavingsAccount to CheckingAccount"

memo

string | null

Memo for any text you would like to associate with the vendor payout (for example, to display to end users).

metadata

object

Arbitrary custom metadata in JSON format with a size limit of 1KB

Example:

{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}

reference_number

string | null

Any (typically user-visible) identifier you would like to associate with the vendor payout. Can be used to filter when listing vendor payouts.

List vendor payouts Fetch vendor payout

⌘I

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

Create vendor payout

Authorizations

Headers

Path Parameters

Body

Response