List inbox
Lists the Copy B statements furnished to the caller org — every 1099 a payer on Hanzo delivered to it electronically, corrected ones beside the ones they supersede.
GET /v1/tax/inbox
| Address | https://api.hanzo.ai/v1/tax/inbox |
| Method | GET |
| Operation | get_tax_inbox |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Lists the Copy B statements furnished to the caller org — every 1099 a payer on Hanzo delivered to it electronically, corrected ones beside the ones they supersede. Any member may read it; nothing here can be changed or removed.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
year | query | integer | — | Year narrows the list to one tax year; absent lists every year. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | tax.statementList | ok |
default | problem-details | refused |
200 body — 46 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | tax.Statement[] | — | Data are the statements, oldest first. |
data[].account | body | string | — | Account is the account number the form prints. |
data[].backup | body | tax.Withholding | — | |
data[].backup.dueCents | body | integer (int64) | — | DueCents is what 24% of the reported boxes comes to — what should have been withheld. |
data[].backup.rate | body | integer (int64) | — | Rate is the backup withholding rate, in percent: 24. |
data[].backup.reason | body | string | — | Reason says why, and which rule — or, when nothing is required, what the payer should still know. |
data[].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. |
data[].boxes | body | tax.Amount[] | — | Boxes are the figures. |
data[].boxes[].box | body | string | — | Box is the box number, e.g. "1a". |
data[].boxes[].cents | body | integer (int64) | — | Cents is the amount in cents. |
data[].boxes[].label | body | string | — | Label is the box's caption on the form. |
data[].corrected | body | boolean | — | Corrected is true for a statement that corrects an earlier one. |
data[].furnishedAt | body | integer (int64) | — | FurnishedAt is when it was delivered, unix seconds. |
data[].id | body | string | — | ID is the form id the payer issued it under. |
data[].kind | body | string | — | Kind is 1099-NEC or 1099-MISC. |
data[].payer | body | tax.Party | — | |
data[].payer.address | body | tax.Address | — | |
data[].payer.address.city | body | string | — | City is the city or town. |
data[].payer.address.country | body | string | — | Country is ISO 3166-1 alpha-2; "US" when absent. |
data[].payer.address.line1 | body | string | — | Line1 is the number, street, and apartment or suite. |
data[].payer.address.line2 | body | string | — | Line2 continues the street address, when there is more of it. |
data[].payer.address.state | body | string | — | State is the two-letter state or territory code. |
data[].payer.address.zip | body | string | — | ZIP is five or nine digits. |
data[].payer.businessName | body | string | — | BusinessName is W-9 line 2, when there is one. |
data[].payer.name | body | string | — | Name is W-9 line 1. |
data[].payer.org | body | string | — | Org is the Hanzo org. |
data[].payer.phone | body | string | — | Phone is the payer's telephone number; a recipient has none on the form. |
data[].payer.tin | body | string | — | TIN is masked here always. |
data[].payer.tinType | body | string | — | TINType is ssn or ein; empty when no TIN is held. |
data[].recipient | body | tax.Party | — | |
data[].recipient.address | body | tax.Address | — | |
data[].recipient.address.city | body | string | — | City is the city or town. |
data[].recipient.address.country | body | string | — | Country is ISO 3166-1 alpha-2; "US" when absent. |
data[].recipient.address.line1 | body | string | — | Line1 is the number, street, and apartment or suite. |
data[].recipient.address.line2 | body | string | — | Line2 continues the street address, when there is more of it. |
data[].recipient.address.state | body | string | — | State is the two-letter state or territory code. |
data[].recipient.address.zip | body | string | — | ZIP is five or nine digits. |
data[].recipient.businessName | body | string | — | BusinessName is W-9 line 2, when there is one. |
data[].recipient.name | body | string | — | Name is W-9 line 1. |
data[].recipient.org | body | string | — | Org is the Hanzo org. |
data[].recipient.phone | body | string | — | Phone is the payer's telephone number; a recipient has none on the form. |
data[].recipient.tin | body | string | — | TIN is masked here always. |
data[].recipient.tinType | body | string | — | TINType is ssn or ein; empty when no TIN is held. |
data[].supersededBy | body | string | — | SupersededBy is the later statement that corrects this one. |
data[].supersedes | body | string | — | Supersedes is the earlier statement this corrects. |
data[].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.getTaxInbox();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()cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.TaxAPI.GetTaxInbox(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(&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).getTaxInbox();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 \
-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.
How is this guide?