Skip to main content
GET
/
v1
/
tax_forms
List all tax forms
curl --request GET \
  --url https://api.yorlet.com/v1/tax_forms \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "tax_form",
      "client_secret": "<string>",
      "currency": "gbp",
      "description": "<string>",
      "options": {
        "quarter": 123,
        "year": 123
      },
      "owner": "<string>",
      "period": {
        "end": 123,
        "start": 123
      },
      "account": "<string>",
      "deleted": false,
      "metadata": {},
      "nrl6": {
        "collected": 0,
        "refunded": 0
      },
      "nrlq": {
        "collected": 0,
        "refunded": 0
      },
      "nrly": {
        "collected": 0,
        "refunded": 0
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A object with a data property that contains an array of tax forms.

​
count
number
required

Total number of items in the list.

Example:

1

​
has_more
boolean
required

Whether more items are available.

Example:

false

​
object
enum<string>
required
Available options:
list
​
data
object[]
required