The report object

The report object represents an instance of a generated report based on specific a type. Once a report object is created, it will return a URL to a file where you can retrieve its results.

Attributes

---

id

string

Unique identifier for the report.

---

type

enum

The report type generated.

Possible enum values

payments.created.current

Payments created in the current cutoff cycle

payments.created.previous

Payments created in the previous cutoff cycle

payments.updated.current

Payments updated in the current cutoff cycle

payments.updated.previous

Payments updated in the previous cutoff cycle

---

url

string

The HTTPS URL to a file containing the results of the report.

---

status

enum

The processing status of the report.

Possible enum values

processing

completed

---

metadata

object,null

Additional data provided during creation. See metadata.

---

created_at

string

Timestamp of when the report was created.

---

updated_at

string

Timestamp of when the report was last updated.

---

THE REPORT OBJECT

{
  "id": "rpt_cj2mkA3hFyHT5",
  "type": "payments.created.current",
  "url": "https://production.methodfi.com/reports/rpt_cj2mkA3hFyHT5/download",
  "status": "completed",
  "metadata": null,
  "created_at": "2021-08-25T23:18:05.261Z",
  "updated_at": "2021-08-25T23:18:05.261Z"
}