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

# getSpendAccountPaycheckDepositForm

> Retrieves a PDF paycheck direct-deposit form for a virtual account number belonging to a spend account (cash balance) of the authenticated user's account.

Retrieves a PDF paycheck direct-deposit form for a virtual account number belonging to a
spend account (cash balance) of the authenticated user's account. Defaults to the spend
account's primary virtual account number when virtualAccountNumberId is omitted.
depositAmount is required when depositType is FIXED. depositPercentage (1-100) is required
when depositType is PERCENTAGE. Requires LIST\_PAYMENT scope.

```graphql theme={null}
query {
  getSpendAccountPaycheckDepositForm(
    userCashBalanceId: UUID!
    virtualAccountNumberId: UUID
    depositType: PaycheckDepositType!
    depositAmount: Float
    depositPercentage: Float
    employerName: String
    employeeName: String
    eSignForm: Boolean
  ): SpendAccountPdfDocument!
}
```

## Arguments

<ParamField body="userCashBalanceId" type="UUID!" required>
  The spend account (cash balance) the virtual account number belongs to.
</ParamField>

<ParamField body="virtualAccountNumberId" type="UUID">
  Which of the spend account's virtual account numbers to document. Defaults to the primary one.
</ParamField>

<ParamField body="depositType" type="PaycheckDepositType!" required>
  How much of each paycheck to deposit: the entire check, a fixed amount, or a percentage.
</ParamField>

<ParamField body="depositAmount" type="Float">
  Dollar amount to deposit each paycheck. Required when depositType is FIXED, ignored otherwise.
</ParamField>

<ParamField body="depositPercentage" type="Float">
  Percentage (1-100) of each paycheck to deposit. Required when depositType is PERCENTAGE,
  ignored otherwise.
</ParamField>

<ParamField body="employerName" type="String">
  Employer name to print on the form's employer line, 1-150 characters. Left blank when omitted.
</ParamField>

<ParamField body="employeeName" type="String">
  Name to print as the account holder on the form, 1-150 characters. Defaults to the account's
  legal name, with any DBA name on a second line.
</ParamField>

<ParamField body="eSignForm" type="Boolean">
  When true, pre-fills the signature line with the printed account-holder name in italics.
  Defaults to false, which leaves the signature line blank to be signed by hand.
</ParamField>

## Returns

[`SpendAccountPdfDocument!`](/api-reference/types/spend-account-pdf-document) — A PDF artifact containing ACH routing and account instructions for funding a spend account's virtual account number, returned as a base64-encoded string for the client to decode and render or download.
