Get inbox

GET /v1/tax/inbox/{id}

Tax → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/tax/inbox/{id}`
Method	`GET`
Operation	`get_tax_inbox_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Reads one Copy B furnished to the caller org. Any member may read it; another org's statement is not found.

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the form id, "f1099_"-prefixed.

Response

Status	Body	Meaning
`200`	tax.Statement	ok
`default`	problem-details	refused

200 body — 45 fields.

Field	In	Type	Always	Description
`account`	body	string	—	Account is the account number the form prints.
`backup`	body	tax.Withholding	—
`backup.dueCents`	body	integer (int64)	—	DueCents is what 24% of the reported boxes comes to — what should have been withheld.
`backup.rate`	body	integer (int64)	—	Rate is the backup withholding rate, in percent: 24.
`backup.reason`	body	string	—	Reason says why, and which rule — or, when nothing is required, what the payer should still know.
`backup.required`	body	boolean	—	Required is true when the payer holds no TIN for the payee — the IRC §3406(a)(1)(A) trigger these forms can know.
`boxes`	body	tax.Amount[]	—	Boxes are the figures.
`boxes[].box`	body	string	—	Box is the box number, e.g. "1a".
`boxes[].cents`	body	integer (int64)	—	Cents is the amount in cents.
`boxes[].label`	body	string	—	Label is the box's caption on the form.
`corrected`	body	boolean	—	Corrected is true for a statement that corrects an earlier one.
`furnishedAt`	body	integer (int64)	—	FurnishedAt is when it was delivered, unix seconds.
`id`	body	string	—	ID is the form id the payer issued it under.
`kind`	body	string	—	Kind is 1099-NEC or 1099-MISC.
`payer`	body	tax.Party	—
`payer.address`	body	tax.Address	—
`payer.address.city`	body	string	—	City is the city or town.
`payer.address.country`	body	string	—	Country is ISO 3166-1 alpha-2; "US" when absent.
`payer.address.line1`	body	string	—	Line1 is the number, street, and apartment or suite.
`payer.address.line2`	body	string	—	Line2 continues the street address, when there is more of it.
`payer.address.state`	body	string	—	State is the two-letter state or territory code.
`payer.address.zip`	body	string	—	ZIP is five or nine digits.
`payer.businessName`	body	string	—	BusinessName is W-9 line 2, when there is one.
`payer.name`	body	string	—	Name is W-9 line 1.
`payer.org`	body	string	—	Org is the Hanzo org.
`payer.phone`	body	string	—	Phone is the payer's telephone number; a recipient has none on the form.
`payer.tin`	body	string	—	TIN is masked here always.
`payer.tinType`	body	string	—	TINType is ssn or ein; empty when no TIN is held.
`recipient`	body	tax.Party	—
`recipient.address`	body	tax.Address	—
`recipient.address.city`	body	string	—	City is the city or town.
`recipient.address.country`	body	string	—	Country is ISO 3166-1 alpha-2; "US" when absent.
`recipient.address.line1`	body	string	—	Line1 is the number, street, and apartment or suite.
`recipient.address.line2`	body	string	—	Line2 continues the street address, when there is more of it.
`recipient.address.state`	body	string	—	State is the two-letter state or territory code.
`recipient.address.zip`	body	string	—	ZIP is five or nine digits.
`recipient.businessName`	body	string	—	BusinessName is W-9 line 2, when there is one.
`recipient.name`	body	string	—	Name is W-9 line 1.
`recipient.org`	body	string	—	Org is the Hanzo org.
`recipient.phone`	body	string	—	Phone is the payer's telephone number; a recipient has none on the form.
`recipient.tin`	body	string	—	TIN is masked here always.
`recipient.tinType`	body	string	—	TINType is ssn or ein; empty when no TIN is held.
`supersededBy`	body	string	—	SupersededBy is the later statement that corrects this one.
`supersedes`	body	string	—	Supersedes is the earlier statement this corrects.
`year`	body	integer (int64)	—	Year is the calendar year of the payments.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

import { Configuration, TaxApi } from 'hanzoai';

const api = new TaxApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getTaxInboxById({ id: 'id' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import TaxApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TaxApi(client).get_tax_inbox_by_id(id='id')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.TaxAPI.GetTaxInboxById(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, tax_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = tax_api::get_tax_inbox_by_id(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.TaxApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new TaxApi(client).getTaxInboxById();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl https://api.hanzo.ai/v1/tax/inbox/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP declares no tool for tax — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.

Tax API · All Hanzo APIs · Interactive reference

Request

Response

Examples

On this page