Retrieve tax credit

GET

tax_credits

{id}

Retrieve tax credit

curl --request GET \
  --url https://app.finta.com/api/v1/tax_credits/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.finta.com/api/v1/tax_credits/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.finta.com/api/v1/tax_credits/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.finta.com/api/v1/tax_credits/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.finta.com/api/v1/tax_credits/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "tcred_example1",
  "object": "tax_credit",
  "type": "research_and_development",
  "jurisdiction": "US",
  "year": 2025,
  "claim_status": "claimed",
  "amount_cents": 2500000,
  "currency": "usd",
  "amount_basis": "filed_return",
  "applied_to_income_tax_cents": 500000,
  "payroll_credit_cents": 2000000,
  "payroll_submission": {
    "provider": "gusto",
    "status": "pending"
  },
  "created": 1769000000,
  "updated": 1791850000
}

Authorizations

Authorization

string

header

required

API key prefixed with finta_

Path Parameters

string

required

Pattern: ^tcred_[A-Za-z0-9]+$

Response

The tax credit.

string

required

Pattern: ^tcred_[A-Za-z0-9]+$

object

enum<string>

required

Available options:

tax_credit

type

enum<string>

required

Available options:

research_and_development

jurisdiction

enum<string>

required

Available options:

US

year

integer

required

claim_status

enum<string>

required

undecided means no decision is recorded; not_claimed means the user declined; pending means opted in but inclusion in the filed return is not yet established; claimed means a positive credit is recorded in the filed income-tax return. Legacy filed returns with positive recorded credits can be claimed without a saved opt-in. This says nothing about payroll submission, provider acceptance, or refunds received.

Available options:

undecided,

not_claimed,

pending,

claimed

amount_cents

integer | null

required

Total credit, before income-tax allocation. Recorded return amounts take precedence over estimates. Unknown amounts are null, including unverified database-default zeroes. A zero return total accompanied by an explicit zero allocation is a known zero. Declined years may retain their estimated potential credit.

Required range: x >= 0

currency

enum<string>

required

Available options:

usd

amount_basis

enum<string> | null

required

Source of amount_cents; null when the amount is unknown.

Available options:

estimate,

prepared_return,

filed_return

applied_to_income_tax_cents

integer | null

required

Recorded allocation against income tax; null when absent or inconsistent with the return total.

Required range: x >= 0

payroll_credit_cents

integer | null

required

Recorded return total less the income-tax allocation; null unless both are known. This allocation is not a refund received and can be shown before filing.

Required range: x >= 0

payroll_submission

object

required

Show child attributes

created

integer

required

Unix seconds when the source questionnaire was created.

updated

integer

required

Latest update of the source questionnaire, income-tax filing, or return package, in Unix seconds.

Retrieve tax credit

curl --request GET \
  --url https://app.finta.com/api/v1/tax_credits/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.finta.com/api/v1/tax_credits/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.finta.com/api/v1/tax_credits/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.finta.com/api/v1/tax_credits/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.finta.com/api/v1/tax_credits/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "tcred_example1",
  "object": "tax_credit",
  "type": "research_and_development",
  "jurisdiction": "US",
  "year": 2025,
  "claim_status": "claimed",
  "amount_cents": 2500000,
  "currency": "usd",
  "amount_basis": "filed_return",
  "applied_to_income_tax_cents": 500000,
  "payroll_credit_cents": 2000000,
  "payroll_submission": {
    "provider": "gusto",
    "status": "pending"
  },
  "created": 1769000000,
  "updated": 1791850000
}

API Reference

Taxes

Company

Team

Categories

Rules

Departments

Integrations

Aggregations

Transactions

Forms

Journal Entries

Invoices

Parties

Reports

Feedback

Tax Credits

Retrieve tax credit

Authorizations

Path Parameters

Response