> This page is for Docs.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://zuora.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://zuora.ferndocs.com/_mcp/server.

# Field descriptions of InvoicePayment

> This reference lists the description of the fields of the InvoicePayment object.

This reference lists the description of the fields of the InvoicePayment object.

All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing.

<table>
  <tr>
    <th>
      **Name**
    </th>

    <th>
      **Required to create?**
    </th>

    <th>
      **Allowed operations**
    </th>

    <th>
      **Description**
    </th>
  </tr>

  <tr>
    <td>
      Amount
    </td>

    <td>
      required
    </td>

    <td>
      Create Query Update Filter
    </td>

    <td>
      The amount of the payment.

      **Type**: decimal (currency) **Character limit**: 16 **Version notes**: type is double in WSDL 18.0 and older **Values**: a valid currency amount
    </td>
  </tr>

  <tr>
    <td>
      CreatedById
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The user ID of the person who created the invoice payment.

      **Type**: zns:ID **Character limit**: 32 **Version notes**: WSDL 20.0+ **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      CreatedDate
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The date when the invoice payment was generated.

      **Type**: dateTime **Character limit**: 29 **Version notes**: WSDL 20.0+ **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      Id
    </td>

    <td>
      required
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The ID of this object. Upn creation, the ID of this object is `InvoicePaymentId` .

      **Type**: zns:ID **Character limit**: 32 **Version notes**: -- **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      InvoiceId
    </td>

    <td>
      required
    </td>

    <td>
      Create Query Filter
    </td>

    <td>
      The unique ID of the invoice associated with this invoice payment.

      **Type**: zns:ID **Character limit**: 32 **Version notes**: -- **Values**: a valid invoice ID
    </td>
  </tr>

  <tr>
    <td>
      PaymentId
    </td>

    <td>
      required
    </td>

    <td>
      Create Query Filter
    </td>

    <td>
      The unique ID of the payment associated with this invoice payment.

      **Type**: zns:ID **Character limit**: 32 **Version notes**: -- **Values**: a valid payment ID
    </td>
  </tr>

  <tr>
    <td>
      RefundAmount
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      Specifies the amount of a refund applied against this InvoicePayment.

      **Type**: decimal (currency) **Character limit**: 16 **Version notes**: -- **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      UpdatedById
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The ID of the user who last updated the invoice payment.

      **Type**: zns:ID **Character limit**: 32 **Version notes**: WSDL 20.0+ **Values**: automatically generated
    </td>
  </tr>

  <tr>
    <td>
      UpdatedDate
    </td>

    <td>
      optional
    </td>

    <td>
      Query Filter
    </td>

    <td>
      The date when the invoice payment was last updated.

      **Type**: dateTime **Character limit**: 29 **Version notes**: WSDL 20.0+ **Values**: automatically generated
    </td>
  </tr>
</table>