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

# Payment Request

A `Payment Request` is created every time a `Worker` on your team submits a request to be paid.
This can be used to faciliate bill payments or invoice workflows, where the amount you’re going to
pay to the worker isn’t known ahead of time.

<Frame>
  <iframe width="100%" height="200" src="https://whimsical.com/embed/5RQh6sXNEgsk9fhZnXURY1" />
</Frame>

### Attributes

<ResponseField name="id" type="string">
  Unique identifier for the object.
</ResponseField>

<ResponseField name="worker" type="string">
  The ID of the worker who submitted this request.
</ResponseField>

<ParamField body="amount" type="string">
  The amount requested in decimal format.
</ParamField>

<ResponseField name="currency" type="string">
  Three-letter ISO currency code, in uppercase.
</ResponseField>

<ResponseField name="status" type="string">
  The status of the payment request. Possible values are `pending`, `approved`, `declined` or
  `processed`. Withdrawn requests are returned as `cancelled`.
</ResponseField>

<ResponseField name="reference" type="string">
  A reference for this payment request submitted by the worker. Most commonly used to include an
  invoice number. This will be automatically entered as the payment reference when this request is
  paid.
</ResponseField>

<ResponseField name="note" type="string">
  An additional memo describing the request. This memo will not be included in the payment.
</ResponseField>

<ResponseField name="period" type="string">
  An period this request is related to.

  <Expandable title="child attributes">
    <ResponseField name="starts" type="string">
      The start of the period. This value is inclusive.
    </ResponseField>

    <ResponseField name="ends" type="string">
      The end of the period, which must be greater than or equal to the start. This value is inclusive.
    </ResponseField>
  </Expandable>
</ResponseField>

<ParamField body="documents" type="string[]">
  An array containing IDs for all documents attached to this payment request.
</ParamField>

<ParamField body="approvals" type="string[]">
  An array containing IDs for all approvals associated with this request.

  **Note:** Declined approvals will also be listed here, so you shouldn't rely on the presence
  of items in this field to indicate that the request has been approved.
</ParamField>

<ParamField body="payment" type="string">
  When completed, the ID of the Payment associated with this Payment Request.
</ParamField>

<ResponseExample>
  ```json Payment Request theme={null}
  {
    "id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX",
    "worker": "wr_anqRSFcK36ie85",
    "amount": "1200.00",
    "currency": "EUR",
    "status": "pending",
    "reference": "EV1S3GDM",
    "note": "Payment for July",
    "period": {
      "starts": "2023-07-01",
      "ends": "2023-07-31"
    },
    "documents": [],
    "approvals": [],
    "payment": null
  }
  ```
</ResponseExample>