APIs

List

List tax form resources per tax year. Filtering and paging can be applied.

Verb	GET
URL	https://api.s.unit.sh/tax-forms
Required Scope	statements
Timeout (Seconds)	5

Name	Type	Default	Description
page[limit]	integer	100	Optional. Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Optional. Number of resources to skip. See Pagination.
filter[customerId]	string	(empty)	Optional. Filters the results by the specified customer id.
filter[accountId]	string	(empty)	Optional. Filters the results by the specified account id.
filter[taxYears]	ISO8601 Year string	Latest tax year	Optional. Returns the available tax forms for one or more tax years. e.g. Usage example: filter[taxYears][0]=2023
filter[taxFormTypes]	string	(empty)	Optional. Usage example: filter[taxFormsType][0]=1099-INT

curl -X GET 'https://api.s.unit.sh/tax-forms?page[limit]=20&page[offset]=10' \
-H "Authorization: Bearer ${TOKEN}"

Response

Response is a JSON:API document.

200 OK

data

Array of tax forms

Array of tax form resources for a given tax year.

Example Response:

{
  "data": [
    {
      "type": "taxForm",
      "id": "1",
      "attributes": {
        "formType": "1099-INT",
        "taxYear": "2023"
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer",
            "id": "10"
          }
        },
        "account": {
          "data": {
            "type": "account",
            "id": "1000"
          }
        }
      }
    },
    {
      "type": "taxForm",
      "id": "2",
      "attributes": {
        "taxYear": "2023"
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer",
            "id": "1"
          }
        },
        "accounts": {
          "data": [
            {
              "type": "account",
              "id": "10000"
            },
            {
              "type": "account",
              "id": "3000"
            }
          ]
        }
      }
    }
  ]
}

Get Tax Form by Id

Get a tax form by id.

Verb	GET
URL	https://api.s.unit.sh/tax-forms/{id}
Required Scope	statements
Timeout (Seconds)	5

Response

Response is a JSON:API document.

200 OK

data

taxForm

Tax form resource. Can be 1099-INT as indicated by the type field.

curl -X GET 'https://api.s.unit.sh/tax-forms/4333' \
-H "Authorization: Bearer ${TOKEN}"

Get Tax Form PDF by Id

Get a tax form PDF file by id.

Verb	GET
URL	https://api.s.unit.sh/tax-forms/{id}/pdf
Required Scope	statements
Timeout (Seconds)	180

Response

Response is a PDF document.

curl -X GET 'https://api.s.unit.sh/tax-forms/1/pdf' \
-H "Authorization: Bearer ${TOKEN}"