{ "components": { "schemas": { "BillingPeriod": { "properties": { "filings_accepted": { "description": "Accepted count for the period: for the API, forms the IRS accepted; for the firm plan, transmissions the IRS accepted in full.", "title": "Filings Accepted", "type": "integer" }, "filings_submitted": { "description": "Transmissions to the IRS, drafts excluded, that changed during the period, whatever their outcome.", "title": "Filings Submitted", "type": "integer" }, "period_end": { "description": "End of the invoiced period, a date and time with UTC offset in the same format as period_start.", "title": "Period End", "type": "string" }, "period_start": { "description": "Start of the invoiced period, a date and time with UTC offset such as \"2026-11-01 00:00:00+00:00\".", "title": "Period Start", "type": "string" }, "product": { "description": "The product this invoice was for: information_returns for the firm plan or api for the API.", "title": "Product", "type": "string" } }, "required": [ "period_start", "period_end", "product", "filings_submitted", "filings_accepted" ], "title": "BillingPeriod", "type": "object" }, "Body_api_bulk_1099_info_returns_1099_nec_bulk_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "description": "A UTF-8 CSV file, one 1099-NEC per row and at most 1,000 rows; the header must include recipient_name and nonemployee_compensation.", "title": "File", "type": "string" }, "payer_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's city, at most 40 characters in the US or 50 abroad; ignored when payer_id is given.", "title": "Payer City" }, "payer_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A payer abroad: the IRS country code, which selects the foreign address; ignored when payer_id is given.", "title": "Payer Country" }, "payer_first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An individual payer's first name; ignored when payer_id is given.", "title": "Payer First Name" }, "payer_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "A saved payer's id (UUID) whose details are copied onto every form; send this or payer_name, not both.", "title": "Payer Id" }, "payer_last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An individual payer's last name; ignored when payer_id is given.", "title": "Payer Last Name" }, "payer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's name when no saved payer is used; send this or payer_id, not both.", "title": "Payer Name" }, "payer_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's phone number, which the IRS requires to file; ignored when payer_id is given.", "title": "Payer Phone" }, "payer_postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A payer abroad: postal code, at most 16 characters; ignored when payer_id is given.", "title": "Payer Postal Code" }, "payer_province": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A payer abroad: province or state, at most 17 characters; ignored when payer_id is given.", "title": "Payer Province" }, "payer_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A US payer's two-letter state code; leave out when payer_country is set. Ignored when payer_id is given.", "title": "Payer State" }, "payer_street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's street address, at most 35 characters; ignored when payer_id is given.", "title": "Payer Street" }, "payer_street2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A second address line, such as a suite, at most 35 characters; ignored when payer_id is given.", "title": "Payer Street2" }, "payer_tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The unsaved payer's TIN, nine digits with or without hyphens; ignored when payer_id is given.", "title": "Payer Tin" }, "payer_tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ssn, ein or itin, the kind of number payer_tin is; it follows payer_type when left out. Ignored when payer_id is given.", "title": "Payer Tin Type" }, "payer_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "business or individual; business when left out. Ignored when payer_id is given.", "title": "Payer Type" }, "payer_zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A US payer's ZIP code, five digits or ZIP+4; leave out when payer_country is set. Ignored when payer_id is given.", "title": "Payer Zip" }, "tax_year": { "default": 2026, "description": "The tax year of every form in the file; only 2026 is accepted this season.", "title": "Tax Year", "type": "integer" } }, "required": [ "file" ], "title": "Body_api_bulk_1099_info_returns_1099_nec_bulk_post", "type": "object" }, "Body_api_bulk_1099k_info_returns_1099_k_bulk_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "description": "A UTF-8 CSV file, one 1099-K per row and at most 1,000 rows; the header must include recipient_name, filer_type, transaction_type and gross_amount.", "title": "File", "type": "string" }, "payer_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's city, at most 40 characters in the US or 50 abroad; ignored when payer_id is given.", "title": "Payer City" }, "payer_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A payer abroad: the IRS country code, which selects the foreign address; ignored when payer_id is given.", "title": "Payer Country" }, "payer_first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An individual payer's first name; ignored when payer_id is given.", "title": "Payer First Name" }, "payer_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "A saved payer's id (UUID) whose details are copied onto every form; send this or payer_name, not both.", "title": "Payer Id" }, "payer_last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An individual payer's last name; ignored when payer_id is given.", "title": "Payer Last Name" }, "payer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's name when no saved payer is used; send this or payer_id, not both.", "title": "Payer Name" }, "payer_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's phone number, which the IRS requires to file; ignored when payer_id is given.", "title": "Payer Phone" }, "payer_postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A payer abroad: postal code, at most 16 characters; ignored when payer_id is given.", "title": "Payer Postal Code" }, "payer_province": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A payer abroad: province or state, at most 17 characters; ignored when payer_id is given.", "title": "Payer Province" }, "payer_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A US payer's two-letter state code; leave out when payer_country is set. Ignored when payer_id is given.", "title": "Payer State" }, "payer_street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's street address, at most 35 characters; ignored when payer_id is given.", "title": "Payer Street" }, "payer_street2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A second address line, such as a suite, at most 35 characters; ignored when payer_id is given.", "title": "Payer Street2" }, "payer_tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The unsaved payer's TIN, nine digits with or without hyphens; ignored when payer_id is given.", "title": "Payer Tin" }, "payer_tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ssn, ein or itin, the kind of number payer_tin is; it follows payer_type when left out. Ignored when payer_id is given.", "title": "Payer Tin Type" }, "payer_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "business or individual; business when left out. Ignored when payer_id is given.", "title": "Payer Type" }, "payer_zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A US payer's ZIP code, five digits or ZIP+4; leave out when payer_country is set. Ignored when payer_id is given.", "title": "Payer Zip" }, "tax_year": { "default": 2026, "description": "The tax year of every form in the file; only 2026 is accepted this season.", "title": "Tax Year", "type": "integer" } }, "required": [ "file" ], "title": "Body_api_bulk_1099k_info_returns_1099_k_bulk_post", "type": "object" }, "Body_api_bulk_1099misc_info_returns_1099_misc_bulk_post": { "properties": { "file": { "contentMediaType": "application/octet-stream", "description": "A UTF-8 CSV file, one 1099-MISC per row and at most 1,000 rows; the header must include recipient_name.", "title": "File", "type": "string" }, "payer_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's city, at most 40 characters in the US or 50 abroad; ignored when payer_id is given.", "title": "Payer City" }, "payer_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A payer abroad: the IRS country code, which selects the foreign address; ignored when payer_id is given.", "title": "Payer Country" }, "payer_first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An individual payer's first name; ignored when payer_id is given.", "title": "Payer First Name" }, "payer_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "A saved payer's id (UUID) whose details are copied onto every form; send this or payer_name, not both.", "title": "Payer Id" }, "payer_last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An individual payer's last name; ignored when payer_id is given.", "title": "Payer Last Name" }, "payer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's name when no saved payer is used; send this or payer_id, not both.", "title": "Payer Name" }, "payer_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's phone number, which the IRS requires to file; ignored when payer_id is given.", "title": "Payer Phone" }, "payer_postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A payer abroad: postal code, at most 16 characters; ignored when payer_id is given.", "title": "Payer Postal Code" }, "payer_province": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A payer abroad: province or state, at most 17 characters; ignored when payer_id is given.", "title": "Payer Province" }, "payer_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A US payer's two-letter state code; leave out when payer_country is set. Ignored when payer_id is given.", "title": "Payer State" }, "payer_street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's street address, at most 35 characters; ignored when payer_id is given.", "title": "Payer Street" }, "payer_street2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A second address line, such as a suite, at most 35 characters; ignored when payer_id is given.", "title": "Payer Street2" }, "payer_tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The unsaved payer's TIN, nine digits with or without hyphens; ignored when payer_id is given.", "title": "Payer Tin" }, "payer_tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ssn, ein or itin, the kind of number payer_tin is; it follows payer_type when left out. Ignored when payer_id is given.", "title": "Payer Tin Type" }, "payer_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "business or individual; business when left out. Ignored when payer_id is given.", "title": "Payer Type" }, "payer_zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A US payer's ZIP code, five digits or ZIP+4; leave out when payer_country is set. Ignored when payer_id is given.", "title": "Payer Zip" }, "tax_year": { "default": 2026, "description": "The tax year of every form in the file; only 2026 is accepted this season.", "title": "Tax Year", "type": "integer" } }, "required": [ "file" ], "title": "Body_api_bulk_1099misc_info_returns_1099_misc_bulk_post", "type": "object" }, "BulkKResponse": { "description": "`BulkMISCResponse`'s shape, under the K's name. See there for each field.", "properties": { "batch_id": { "description": "UUID of the import batch; every form it created carries it as batch_job_id.", "title": "Batch Id", "type": "string" }, "count": { "description": "How many 1099-K forms the CSV file created, one per row.", "title": "Count", "type": "integer" }, "form_ids": { "default": [], "description": "UUIDs of the forms created, in CSV row order. Filled only by the web app's draft import; always empty on an API key import, where you list the forms instead.", "items": { "type": "string" }, "title": "Form Ids", "type": "array" }, "message": { "description": "A plain-English sentence saying what happened and what to do next.", "title": "Message", "type": "string" }, "recipients_created": { "default": 0, "description": "How many rows created a new recipient on the roster.", "title": "Recipients Created", "type": "integer" }, "recipients_reused": { "default": 0, "description": "How many rows matched a recipient already on the roster and reused it.", "title": "Recipients Reused", "type": "integer" }, "status": { "description": "\"queued\" when the forms were created to be filed (an API key import), \"created\" when they were saved as drafts and nothing was sent (the web app's import).", "title": "Status", "type": "string" } }, "required": [ "batch_id", "status", "count", "message" ], "title": "BulkKResponse", "type": "object" }, "BulkMISCResponse": { "properties": { "batch_id": { "description": "UUID of the import batch; each form it created carries it as batch_job_id.", "title": "Batch Id", "type": "string" }, "count": { "description": "How many 1099-MISC forms the import created from the CSV file.", "title": "Count", "type": "integer" }, "form_ids": { "default": [], "description": "UUIDs of the forms created, in CSV row order, when they were saved as drafts. Empty on the API import; list the forms to follow them.", "items": { "type": "string" }, "title": "Form Ids", "type": "array" }, "message": { "description": "One sentence on what happened and how to follow the forms.", "title": "Message", "type": "string" }, "recipients_created": { "default": 0, "description": "How many rows created a new recipient.", "title": "Recipients Created", "type": "integer" }, "recipients_reused": { "default": 0, "description": "How many rows matched a recipient already on file and reused it.", "title": "Recipients Reused", "type": "integer" }, "status": { "description": "\"queued\" when the forms will be filed in the background (the API import); \"created\" when they were saved as drafts and nothing was sent.", "title": "Status", "type": "string" } }, "required": [ "batch_id", "status", "count", "message" ], "title": "BulkMISCResponse", "type": "object" }, "BulkResponse": { "properties": { "batch_id": { "description": "UUID of the import batch; each form it created carries it as batch_job_id.", "title": "Batch Id", "type": "string" }, "count": { "description": "How many 1099-NEC forms the import created from the CSV file.", "title": "Count", "type": "integer" }, "form_ids": { "default": [], "description": "UUIDs of the forms created, in CSV row order, when they were saved as drafts. Empty on the API import; list the forms to follow them.", "items": { "type": "string" }, "title": "Form Ids", "type": "array" }, "message": { "description": "One sentence on what happened and how to follow the forms.", "title": "Message", "type": "string" }, "recipients_created": { "default": 0, "description": "How many rows created a new recipient.", "title": "Recipients Created", "type": "integer" }, "recipients_reused": { "default": 0, "description": "How many rows matched a recipient already on file and reused it.", "title": "Recipients Reused", "type": "integer" }, "status": { "description": "\"queued\" when the forms will be filed in the background (the API import); \"created\" when they were saved as drafts and nothing was sent.", "title": "Status", "type": "string" } }, "required": [ "batch_id", "status", "count", "message" ], "title": "BulkResponse", "type": "object" }, "DirectFilingRecordSummary": { "description": "The firm's own statement that it filed a state directly. Never our observation.", "properties": { "changed_since": { "default": false, "description": "True where a 1099 the state is owed changed after the filing was recorded, so the recorded filing may be missing it.", "title": "Changed Since", "type": "boolean" }, "confirmation_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The confirmation number the state's portal gave, if the firm recorded one.", "title": "Confirmation Number" }, "filed_on": { "description": "The day the firm says it filed (ISO 8601 date).", "title": "Filed On", "type": "string" }, "record_id": { "description": "The id of the firm's direct filing record.", "title": "Record Id", "type": "string" }, "recorded_at": { "description": "When the firm recorded it (ISO 8601 date and time, UTC).", "title": "Recorded At", "type": "string" }, "recorded_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The team member who recorded it, or null where that user no longer exists.", "title": "Recorded By" } }, "required": [ "record_id", "recorded_at", "recorded_by", "confirmation_number", "filed_on" ], "title": "DirectFilingRecordSummary", "type": "object" }, "Form1099KChainResponse": { "description": "The whole chain for one 1099-K record, oldest first: original, then each\ncorrection.", "properties": { "links": { "description": "Every form in the chain, oldest first: the original, then each correction in order.", "items": { "$ref": "#/components/schemas/Form1099KResponse" }, "title": "Links", "type": "array" }, "root_form_id": { "description": "UUID of the original 1099-K at the start of the chain, whichever link was asked for.", "title": "Root Form Id", "type": "string" } }, "required": [ "root_form_id", "links" ], "title": "Form1099KChainResponse", "type": "object" }, "Form1099KCorrectRequest": { "description": "`Form1099MISCCorrectRequest`'s twin over the K's own boxes.\n\nThe same contract: everything omitted is carried over, because Pub 5718\n§6.1.1 requires the COMPLETE record to be re-filed and the caller states the\ncorrection rather than the whole form again. The payer block is not\ncorrectable here, because §6.1.1 requires a correction's `IssuerDetail` to be\nidentical to the original submission's.\n\nThe two checkbox pairs ARE correctable: a form filed with the wrong filer or\nthe wrong transaction type is wrong on its face, and a correction is how a\nfiled form is put right.", "properties": { "account_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The corrected account number, at most 30 characters. Omitted or blank keeps the original's.", "title": "Account Number" }, "april": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5d, the corrected gross amount for April, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "April" }, "august": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5h, the corrected gross amount for August, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "August" }, "card_not_present": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 1b, the corrected card not present amount, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "Card Not Present" }, "cash_tips": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 1c, the corrected cash tips, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "Cash Tips" }, "december": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5l, the corrected gross amount for December, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "December" }, "february": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5b, the corrected gross amount for February, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "February" }, "federal_income_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 4, the corrected federal income tax withheld, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "Federal Income Tax Withheld" }, "filer_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The corrected filer checkbox: \"pse\" or \"epf\", case-insensitive. Omit it to keep the original's.", "title": "Filer Type" }, "gross_amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 1a, the corrected gross amount, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "Gross Amount" }, "january": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5a, the corrected gross amount for January, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "January" }, "july": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5g, the corrected gross amount for July, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "July" }, "june": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5f, the corrected gross amount for June, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "June" }, "march": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5c, the corrected gross amount for March, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "March" }, "may": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5e, the corrected gross amount for May, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "May" }, "merchant_category_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 2, the corrected four-digit merchant category code. Omitted or blank keeps the original's.", "title": "Merchant Category Code" }, "november": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5k, the corrected gross amount for November, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "November" }, "october": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5j, the corrected gross amount for October, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "October" }, "payment_transaction_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Box 3, the corrected number of payment transactions, zero or more. Omit it to keep the original's count.", "title": "Payment Transaction Count" }, "pse_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The corrected payment settlement entity's name, at most 35 characters. Omitted or blank keeps the original's.", "title": "Pse Name" }, "pse_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The corrected payment settlement entity's telephone number, at most 30 characters. Omitted or blank keeps the original's.", "title": "Pse Phone" }, "recipient_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "UUID of a different recipient on the firm's roster for the correction; 404 when there is none. Omit it to keep the original's recipient.", "title": "Recipient Id" }, "second_tin_notice": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "The corrected 2nd TIN notice checkbox. Omit it to keep the original's.", "title": "Second Tin Notice" }, "september": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5i, the corrected gross amount for September, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "September" }, "state_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 8, the corrected two-letter state code, upper-cased. Omit it to keep the original's; an empty string clears it.", "title": "State Code" }, "state_id_num": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 7, the corrected payer's state identification number. Omit it to keep the original's.", "title": "State Id Num" }, "state_income": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The corrected state income figure (not a box on Form 1099-K), in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "State Income" }, "state_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 6, the corrected state income tax withheld, in US dollars as a decimal string such as \"4200.00\"; omit it to keep the original's amount.", "title": "State Tax Withheld" }, "tipped_occupation_codes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Box 1d, the corrected list of at most two three-digit Treasury Tipped Occupation Codes. Omit it to keep the original's; an empty list clears them.", "title": "Tipped Occupation Codes" }, "transaction_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The corrected transaction type: \"payment_card\" or \"third_party_network\". Omit it to keep the original's.", "title": "Transaction Type" }, "zero_all_amounts": { "default": false, "description": "Set true when the form should not have been filed: every amount, state amounts included, and box 3 become zero, whatever else is sent. Defaults to false.", "title": "Zero All Amounts", "type": "boolean" } }, "title": "Form1099KCorrectRequest", "type": "object" }, "Form1099KCreateRequest": { "properties": { "account_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The account number the filer assigned to this payee, at most 30 characters. Blank is treated as none.", "title": "Account Number" }, "april": { "default": "0", "description": "Box 5d, the gross amount for April, in US dollars as a decimal string such as \"4200.00\". The twelve months must add up to box 1a to the cent before the form can be filed. Defaults to \"0\".", "title": "April", "type": "string" }, "august": { "default": "0", "description": "Box 5h, the gross amount for August, in US dollars as a decimal string such as \"4200.00\". The twelve months must add up to box 1a to the cent before the form can be filed. Defaults to \"0\".", "title": "August", "type": "string" }, "card_not_present": { "default": "0", "description": "Box 1b, card not present transactions, in US dollars as a decimal string such as \"4200.00\". Part of box 1a, so it cannot be larger to file. Defaults to \"0\".", "title": "Card Not Present", "type": "string" }, "cash_tips": { "default": "0", "description": "Box 1c, cash tips, in US dollars as a decimal string such as \"4200.00\". Included in box 1a, so it cannot be larger to file; above zero, box 1d needs a code. Defaults to \"0\".", "title": "Cash Tips", "type": "string" }, "december": { "default": "0", "description": "Box 5l, the gross amount for December, in US dollars as a decimal string such as \"4200.00\". The twelve months must add up to box 1a to the cent before the form can be filed. Defaults to \"0\".", "title": "December", "type": "string" }, "february": { "default": "0", "description": "Box 5b, the gross amount for February, in US dollars as a decimal string such as \"4200.00\". The twelve months must add up to box 1a to the cent before the form can be filed. Defaults to \"0\".", "title": "February", "type": "string" }, "federal_income_tax_withheld": { "default": "0", "description": "Box 4, federal income tax withheld, in US dollars as a decimal string such as \"4200.00\". It cannot be larger than box 1a to file. Defaults to \"0\".", "title": "Federal Income Tax Withheld", "type": "string" }, "filer_type": { "description": "The filer checkbox: \"pse\" (payment settlement entity) or \"epf\" (electronic payment facilitator or other third party). Case-insensitive; anything else is refused.", "title": "Filer Type", "type": "string" }, "gross_amount": { "default": "0", "description": "Box 1a, the gross amount of the payment card or third party network transactions for the year, in US dollars as a decimal string such as \"4200.00\". Defaults to \"0\".", "title": "Gross Amount", "type": "string" }, "january": { "default": "0", "description": "Box 5a, the gross amount for January, in US dollars as a decimal string such as \"4200.00\". The twelve months must add up to box 1a to the cent before the form can be filed. Defaults to \"0\".", "title": "January", "type": "string" }, "july": { "default": "0", "description": "Box 5g, the gross amount for July, in US dollars as a decimal string such as \"4200.00\". The twelve months must add up to box 1a to the cent before the form can be filed. Defaults to \"0\".", "title": "July", "type": "string" }, "june": { "default": "0", "description": "Box 5f, the gross amount for June, in US dollars as a decimal string such as \"4200.00\". The twelve months must add up to box 1a to the cent before the form can be filed. Defaults to \"0\".", "title": "June", "type": "string" }, "march": { "default": "0", "description": "Box 5c, the gross amount for March, in US dollars as a decimal string such as \"4200.00\". The twelve months must add up to box 1a to the cent before the form can be filed. Defaults to \"0\".", "title": "March", "type": "string" }, "may": { "default": "0", "description": "Box 5e, the gross amount for May, in US dollars as a decimal string such as \"4200.00\". The twelve months must add up to box 1a to the cent before the form can be filed. Defaults to \"0\".", "title": "May", "type": "string" }, "merchant_category_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 2, the four-digit merchant category code, such as \"5812\"; at most 4 characters, and four digits to file. Leave it out when the filer uses none.", "title": "Merchant Category Code" }, "november": { "default": "0", "description": "Box 5k, the gross amount for November, in US dollars as a decimal string such as \"4200.00\". The twelve months must add up to box 1a to the cent before the form can be filed. Defaults to \"0\".", "title": "November", "type": "string" }, "october": { "default": "0", "description": "Box 5j, the gross amount for October, in US dollars as a decimal string such as \"4200.00\". The twelve months must add up to box 1a to the cent before the form can be filed. Defaults to \"0\".", "title": "October", "type": "string" }, "payer_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's city: at most 40 characters for a US address, 50 for an address abroad. Required to file for a US address.", "title": "Payer City" }, "payer_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "For a payer abroad only: the IRS country code (the IRS's own list, not ISO 3166). Setting it files the foreign address, so payer_state and payer_zip must be empty.", "title": "Payer Country" }, "payer_first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's first name, required to file when payer_type is \"individual\" or \"itin\"; at most 20 characters to file.", "title": "Payer First Name" }, "payer_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "UUID of a saved payer whose details are copied onto the form. Send either payer_id or payer_name with the payer_* fields, never both; when omitted, payer_name is required.", "title": "Payer Id" }, "payer_last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's last name, required to file when payer_type is \"individual\" or \"itin\"; at most 20 characters to file.", "title": "Payer Last Name" }, "payer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's name as it goes to the IRS. Required when payer_id is omitted, and refused alongside payer_id.", "title": "Payer Name" }, "payer_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's telephone number, required to file. Only its digits are sent to the IRS.", "title": "Payer Phone" }, "payer_postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "For a payer abroad only: the postal code, at most 16 characters. Refused when payer_country is not set.", "title": "Payer Postal Code" }, "payer_province": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "For a payer abroad only: the province or state, at most 17 characters. Refused when payer_country is not set.", "title": "Payer Province" }, "payer_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's two-letter USPS state, territory or APO code, upper-cased. US addresses only: refused when payer_country is set. Required to file for a US address.", "title": "Payer State" }, "payer_street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's street address, at most 35 characters. Optional on a draft, required to file.", "title": "Payer Street" }, "payer_street2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A second address line for the payer, such as a suite or unit, at most 35 characters.", "title": "Payer Street2" }, "payer_tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's EIN, SSN or ITIN: nine digits, dashes allowed. Encrypted at rest and never returned; required to file. With payer_type \"itin\" it must have an ITIN's structure.", "title": "Payer Tin" }, "payer_tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of number payer_tin is: \"ssn\", \"ein\" or \"itin\". Left out, it follows payer_type (business EIN, individual SSN, itin ITIN). A sole proprietor who files under their own name with an EIN is payer_type \"individual\" and payer_tin_type \"ein\". Leave it out when payer_id is sent.", "title": "Payer Tin Type" }, "payer_type": { "default": "business", "description": "\"business\" (files under payer_name), \"individual\" (a person, filing under payer_first_name and payer_last_name) or \"itin\" (a person with an ITIN). Defaults to \"business\".", "title": "Payer Type", "type": "string" }, "payer_zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's ZIP code: five digits or ZIP+4. US addresses only: refused when payer_country is set. Required to file for a US address.", "title": "Payer Zip" }, "payment_transaction_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Box 3, the number of payment transactions (a count, not dollars), zero or more. Required to file; the form can be saved without it but not filed.", "title": "Payment Transaction Count" }, "pse_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payment settlement entity's name, required to file when filer_type is \"epf\". At most 35 characters: letters, digits, hyphens, apostrophes and single spaces.", "title": "Pse Name" }, "pse_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payment settlement entity's telephone number, required to file when filer_type is \"epf\". At most 30 characters, with 10 to 30 digits to file.", "title": "Pse Phone" }, "recipient_id": { "description": "UUID of a recipient already on the firm's roster; the request is refused with 404 when no such recipient exists.", "format": "uuid", "title": "Recipient Id", "type": "string" }, "second_tin_notice": { "default": false, "description": "Checks the 2nd TIN notice box: the IRS has twice in three years told the filer this payee's TIN was wrong. Shown on Copy A only. Defaults to false.", "title": "Second Tin Notice", "type": "boolean" }, "september": { "default": "0", "description": "Box 5i, the gross amount for September, in US dollars as a decimal string such as \"4200.00\". The twelve months must add up to box 1a to the cent before the form can be filed. Defaults to \"0\".", "title": "September", "type": "string" }, "state_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 8, the two-letter code of the state the state line belongs to, upper-cased. Required when box 6, box 7 or state_income carries a value.", "title": "State Code" }, "state_id_num": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 7, the payer's state identification number for the state in state_code. Blank is treated as none; when set, state_code is required.", "title": "State Id Num" }, "state_income": { "default": "0", "description": "Not a box on Form 1099-K: a state income figure kept so the three forms share one state line, in US dollars as a decimal string such as \"4200.00\". Above zero, state_code is required. Defaults to \"0\".", "title": "State Income", "type": "string" }, "state_tax_withheld": { "default": "0", "description": "Box 6, state income tax withheld, in US dollars as a decimal string such as \"4200.00\". Above zero, state_code is required. Defaults to \"0\".", "title": "State Tax Withheld", "type": "string" }, "tax_year": { "default": 2026, "description": "The tax year of the form; defaults to 2026. This season files tax year 2026 forms only, and any other year is refused.", "title": "Tax Year", "type": "integer" }, "tipped_occupation_codes": { "default": [], "description": "Box 1d, at most two three-digit Treasury Tipped Occupation Codes, such as [\"101\"]. Required to file when box 1c has cash tips. Defaults to an empty list.", "items": { "type": "string" }, "title": "Tipped Occupation Codes", "type": "array" }, "transaction_type": { "description": "What the form reports: \"payment_card\" or \"third_party_network\". A payee paid both ways gets a separate 1099-K for each. Anything else is refused.", "title": "Transaction Type", "type": "string" } }, "required": [ "recipient_id", "filer_type", "transaction_type" ], "title": "Form1099KCreateRequest", "type": "object" }, "Form1099KResponse": { "properties": { "account_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The account number the filer assigned to this payee; null when none was given.", "title": "Account Number" }, "april": { "description": "Box 5d, the gross amount for April, in US dollars as a decimal string such as \"4200.00\". The twelve months add up to box 1a on any form that was filed.", "title": "April", "type": "string" }, "august": { "description": "Box 5h, the gross amount for August, in US dollars as a decimal string such as \"4200.00\". The twelve months add up to box 1a on any form that was filed.", "title": "August", "type": "string" }, "batch_job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "UUID of the CSV import that created this form; null for a form created on its own.", "title": "Batch Job Id" }, "card_not_present": { "description": "Box 1b, card not present transactions, in US dollars as a decimal string such as \"4200.00\". Part of box 1a.", "title": "Card Not Present", "type": "string" }, "cash_tips": { "description": "Box 1c, cash tips, in US dollars as a decimal string such as \"4200.00\". Included in box 1a.", "title": "Cash Tips", "type": "string" }, "checked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this draft last passed the pre-filing check against the IRS schema and business rules, with nothing sent, as an ISO 8601 datetime; null unless it is an unedited draft that passed.", "title": "Checked At" }, "corrected": { "default": false, "description": "True when this form is a correction of an earlier accepted 1099-K; false on an original.", "title": "Corrected", "type": "boolean" }, "correction_seq": { "default": 0, "description": "Position in the correction chain: 0 for an original, 1 for its correction, 2 for the correction of that correction, and so on.", "title": "Correction Seq", "type": "integer" }, "corrects_form_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "UUID of the form this correction corrects; null on an original.", "title": "Corrects Form Id" }, "corrects_unique_record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The IRS record id of the form this correction corrects, which is what the correction tells the IRS; null on an original.", "title": "Corrects Unique Record Id" }, "created_at": { "description": "When the form was created, as an ISO 8601 datetime.", "title": "Created At", "type": "string" }, "december": { "description": "Box 5l, the gross amount for December, in US dollars as a decimal string such as \"4200.00\". The twelve months add up to box 1a on any form that was filed.", "title": "December", "type": "string" }, "engine_submission_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The filing service's submission id for this form's latest transmission; null until the form has been sent.", "title": "Engine Submission Id" }, "environment": { "anyOf": [ { "enum": [ "sandbox", "live" ], "type": "string" }, { "type": "null" } ], "description": "Where the form was filed: sandbox, live, or null before it is submitted.", "title": "Environment" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why the latest filing attempt failed or what the IRS acknowledgement reported, in plain English; null when there is nothing to report.", "title": "Error Message" }, "february": { "description": "Box 5b, the gross amount for February, in US dollars as a decimal string such as \"4200.00\". The twelve months add up to box 1a on any form that was filed.", "title": "February", "type": "string" }, "federal_income_tax_withheld": { "description": "Box 4, federal income tax withheld, in US dollars as a decimal string such as \"4200.00\".", "title": "Federal Income Tax Withheld", "type": "string" }, "filer_type": { "description": "The filer checkbox: \"pse\" (payment settlement entity) or \"epf\" (electronic payment facilitator or other third party).", "title": "Filer Type", "type": "string" }, "form_id": { "description": "UUID of this 1099-K.", "title": "Form Id", "type": "string" }, "furnish_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why the latest attempt to furnish Copy B failed; null when it has not failed.", "title": "Furnish Error" }, "furnish_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "How Copy B was furnished: \"email\" or \"print\"; null until it is furnished.", "title": "Furnish Method" }, "furnished_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When Copy B was furnished to the recipient (emailed, or the print copy generated), as an ISO 8601 datetime; null until it is furnished.", "title": "Furnished At" }, "gross_amount": { "description": "Box 1a, the gross amount of the payment card or third party network transactions for the year, in US dollars as a decimal string such as \"4200.00\".", "title": "Gross Amount", "type": "string" }, "in_line_reason": { "anyOf": [ { "enum": [ "busy", "transmissions_off", "release_hold", "released" ], "type": "string" }, { "type": "null" } ], "description": "Why the form is in line: busy (the filing service could not take it yet), transmissions_off (sending is switched off for now), release_hold (it waits for our review) or released (reviewed, and being sent now). It is sent from the line or returned with the reason in error_message; send nothing again meanwhile.", "title": "In Line Reason" }, "in_line_since": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this form went into line to send, as an ISO 8601 date-time: the filing service could not take it yet, so it waits at queued and is sent automatically once the service is ready. Null for any other form, including one waiting its ordinary turn in a batch.", "title": "In Line Since" }, "irs_last_answer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The IRS's last answer about this form's current transmission, in the IRS's own words: \"Accepted\", \"Accepted with Errors\", \"Partially Accepted\", \"Rejected\", \"Processing\" or \"Not Found\". Null when the IRS has not been asked. Kept while the form is submit_indeterminate.", "title": "Irs Last Answer" }, "irs_last_answer_since": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Since when the IRS has given that same answer, as an ISO 8601 date-time: how long it has said Not Found, for instance. Null when it has not been asked.", "title": "Irs Last Answer Since" }, "irs_last_asked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the IRS gave irs_last_answer, as an ISO 8601 date-time; null when it has not been asked.", "title": "Irs Last Asked At" }, "irs_receipt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The IRS's receipt id for this form's current transmission while it is unconfirmed, once the IRS's status search finds it; null when not known. A filed form's receipt is in engine_submission_id.", "title": "Irs Receipt Id" }, "january": { "description": "Box 5a, the gross amount for January, in US dollars as a decimal string such as \"4200.00\". The twelve months add up to box 1a on any form that was filed.", "title": "January", "type": "string" }, "july": { "description": "Box 5g, the gross amount for July, in US dollars as a decimal string such as \"4200.00\". The twelve months add up to box 1a on any form that was filed.", "title": "July", "type": "string" }, "june": { "description": "Box 5f, the gross amount for June, in US dollars as a decimal string such as \"4200.00\". The twelve months add up to box 1a on any form that was filed.", "title": "June", "type": "string" }, "march": { "description": "Box 5c, the gross amount for March, in US dollars as a decimal string such as \"4200.00\". The twelve months add up to box 1a on any form that was filed.", "title": "March", "type": "string" }, "may": { "description": "Box 5e, the gross amount for May, in US dollars as a decimal string such as \"4200.00\". The twelve months add up to box 1a on any form that was filed.", "title": "May", "type": "string" }, "merchant_category_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 2, the four-digit merchant category code; null when none was given.", "title": "Merchant Category Code" }, "november": { "description": "Box 5k, the gross amount for November, in US dollars as a decimal string such as \"4200.00\". The twelve months add up to box 1a on any form that was filed.", "title": "November", "type": "string" }, "october": { "description": "Box 5j, the gross amount for October, in US dollars as a decimal string such as \"4200.00\". The twelve months add up to box 1a on any form that was filed.", "title": "October", "type": "string" }, "payer_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's city; null when not given.", "title": "Payer City" }, "payer_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The IRS country code of a payer abroad; null or empty for a US payer.", "title": "Payer Country" }, "payer_first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's first name, used when payer_type is \"individual\" or \"itin\"; null when not given.", "title": "Payer First Name" }, "payer_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "UUID of the saved payer whose details were copied onto this form; null when the payer was typed in or the saved payer was removed.", "title": "Payer Id" }, "payer_last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's last name, used when payer_type is \"individual\" or \"itin\"; null when not given.", "title": "Payer Last Name" }, "payer_name": { "description": "The payer's name as filed on this form. Copied from the saved payer and updated with it until the form is filed; a filed form and a correction keep theirs.", "title": "Payer Name", "type": "string" }, "payer_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's telephone number as entered; null when not given.", "title": "Payer Phone" }, "payer_postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The postal code of a payer abroad; null for a US payer or when not given.", "title": "Payer Postal Code" }, "payer_province": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The province or state of a payer abroad; null for a US payer or when not given.", "title": "Payer Province" }, "payer_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's two-letter USPS state code, for a US address; null for a payer abroad or when not given.", "title": "Payer State" }, "payer_street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's street address as filed on this form; null when not given.", "title": "Payer Street" }, "payer_street2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's second address line, such as a suite or unit; null when not given.", "title": "Payer Street2" }, "payer_tin_on_file": { "description": "Whether a payer TIN is stored for this form. The TIN itself is encrypted and never returned.", "title": "Payer Tin On File", "type": "boolean" }, "payer_tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of TIN the payer files under on this form: \"ssn\", \"ein\" or \"itin\". The TIN type copied with the payer, otherwise what payer_type implies. The IRS record, Copy B and the state files follow it.", "title": "Payer Tin Type" }, "payer_type": { "description": "\"business\", \"individual\" or \"itin\": whether the payer files under a business name, as a person, or as a person with an ITIN.", "title": "Payer Type", "type": "string" }, "payer_zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's ZIP code, five digits or ZIP+4, for a US address; null for a payer abroad or when not given.", "title": "Payer Zip" }, "payment_transaction_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Box 3, the number of payment transactions (a count, not dollars); null when it has not been entered yet.", "title": "Payment Transaction Count" }, "pse_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payment settlement entity's name, given when filer_type is \"epf\"; null when not given.", "title": "Pse Name" }, "pse_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payment settlement entity's telephone number, given when filer_type is \"epf\"; null when not given.", "title": "Pse Phone" }, "recipient_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "UUID of the recipient this form reports; null when that recipient record has been removed.", "title": "Recipient Id" }, "recipient_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The recipient's name as it is on the roster now; null when the form has no recipient or the name was not loaded with it.", "title": "Recipient Name" }, "recipient_tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of TIN the recipient holds: \"ssn\", \"ein\" or \"itin\". The payee's Form W-9 answer when one is on file, otherwise the tin_type the firm saved with the recipient, otherwise what its recipient_type implies. Null when none says, or when the recipient was not loaded with the form.", "title": "Recipient Tin Type" }, "resend_offered": { "default": false, "description": "True only when the form is submit_indeterminate, the IRS has answered \"Not Found\" for its transmission, on a live account. Then the resend route files it again as a new transmission; the earlier attempt stays on record.", "title": "Resend Offered", "type": "boolean" }, "resent_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the firm last resent this form as a new transmission after the IRS answered Not Found for the earlier one, as an ISO 8601 date-time; null when it was never resent. The earlier attempt stays on record.", "title": "Resent At" }, "second_tin_notice": { "default": false, "description": "Whether the 2nd TIN notice box is checked: the IRS has twice in three years told the filer this payee's TIN was wrong.", "title": "Second Tin Notice", "type": "boolean" }, "september": { "description": "Box 5i, the gross amount for September, in US dollars as a decimal string such as \"4200.00\". The twelve months add up to box 1a on any form that was filed.", "title": "September", "type": "string" }, "state_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 8, the two-letter code of the state the state line belongs to; null when the form has no state line.", "title": "State Code" }, "state_file_generated": { "default": false, "description": "True only when state_filing is \"state_file\" and SimplifyGigTax writes that state a file carrying this 1099-K; false when the firm files with the state itself.", "title": "State File Generated", "type": "boolean" }, "state_filing": { "default": "none", "description": "What the firm still owes a state for this form: \"none\" (nothing), \"cfsf\" (the payer's Combined Federal/State Filing election covers it) or \"state_file\" (file with the state directly).", "title": "State Filing", "type": "string" }, "state_filing_reason": { "default": "", "description": "The plain-English sentence behind state_filing: which state, what it requires for a 1099-K and why.", "title": "State Filing Reason", "type": "string" }, "state_filing_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The two-letter code of the state state_filing_reason is about, which can differ from box 8; null when the recipient has no US state on record.", "title": "State Filing State" }, "state_id_num": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 7, the payer's state identification number; null when none was given.", "title": "State Id Num" }, "state_income": { "description": "A state income figure that is not a box on Form 1099-K and is not printed, in US dollars as a decimal string such as \"4200.00\". \"0\" unless one was entered.", "title": "State Income", "type": "string" }, "state_tax_withheld": { "description": "Box 6, state income tax withheld, in US dollars as a decimal string such as \"4200.00\".", "title": "State Tax Withheld", "type": "string" }, "status": { "description": "Filing status: draft, pending_review, queued, validating, validation_failed, submitted, pending_ack, accepted, accepted_with_errors, partially_accepted, rejected, duplicate, error, submit_indeterminate, cancelled or paper_filed.", "title": "Status", "type": "string" }, "taken_out_of_line_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this form, waiting in line, went back to draft with nothing sent because the account switched to sandbox mode, as an ISO 8601 date-time. Cleared once the form is checked or edited; null otherwise.", "title": "Taken Out Of Line At" }, "tax_year": { "description": "The tax year the form reports. This season files tax year 2026 only.", "title": "Tax Year", "type": "integer" }, "tenant_id": { "description": "UUID of the firm that owns this form.", "title": "Tenant Id", "type": "string" }, "tipped_occupation_codes": { "default": [], "description": "Box 1d, the Treasury Tipped Occupation Codes on the form (at most two, three digits each); an empty list when there are none.", "items": { "type": "string" }, "title": "Tipped Occupation Codes", "type": "array" }, "transaction_type": { "description": "What the form reports: \"payment_card\" or \"third_party_network\".", "title": "Transaction Type", "type": "string" }, "unique_record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The IRS's own id for this record, from its acknowledgement; null until the IRS acknowledges the form. A correction cannot be made without it.", "title": "Unique Record Id" }, "updated_at": { "description": "When the form was last changed, as an ISO 8601 datetime.", "title": "Updated At", "type": "string" }, "voided": { "description": "Whether the form is voided. A voided form reports nothing and cannot be corrected.", "title": "Voided", "type": "boolean" }, "voided_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the form was voided: the moment the IRS accepted the zero-amount correction filed against it. Null unless voided is true.", "title": "Voided At" } }, "required": [ "form_id", "tenant_id", "recipient_id", "batch_job_id", "payer_id", "payer_name", "payer_type", "payer_first_name", "payer_last_name", "payer_street", "payer_city", "payer_state", "payer_zip", "payer_phone", "payer_tin_on_file", "tax_year", "filer_type", "transaction_type", "gross_amount", "card_not_present", "cash_tips", "federal_income_tax_withheld", "january", "february", "march", "april", "may", "june", "july", "august", "september", "october", "november", "december", "state_tax_withheld", "state_code", "state_income", "status", "voided", "engine_submission_id", "environment", "error_message", "created_at", "updated_at" ], "title": "Form1099KResponse", "type": "object" }, "Form1099MISCChainResponse": { "description": "`Form1099NECChainResponse`'s twin: the whole chain for one MISC record,\noldest first: original, then each correction.", "properties": { "links": { "description": "Every form in the chain, oldest first: the original, then each correction in turn.", "items": { "$ref": "#/components/schemas/Form1099MISCResponse" }, "title": "Links", "type": "array" }, "root_form_id": { "description": "UUID of the original form the chain starts from, whichever link was asked about.", "title": "Root Form Id", "type": "string" } }, "required": [ "root_form_id", "links" ], "title": "Form1099MISCChainResponse", "type": "object" }, "Form1099MISCCorrectRequest": { "description": "`Form1099NECCorrectRequest`'s twin over MISC's own boxes.\n\nSame contract: everything omitted is carried over, because Pub 5718 §6.1.1\nrequires the COMPLETE record to be re-filed and the caller states the\ncorrection rather than the whole form again. The payer block is not\ncorrectable here either: §6.1.1 requires a correction's `IssuerDetail` to\nbe identical to the original submission's, and a wrong payer is a different\nremedy.\n\n`fatca_filing_requirement` and `account_number` ARE correctable, unlike\nanything on the NEC request, because they are MISC's own and they travel\ntogether: rule SHAREDIRFORM018 requires an account number whenever the FATCA\nflag is set, so a correction that could change one and not the other could\nproduce a record the engine refuses.", "properties": { "account_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The account number the payer assigned to this recipient, at most 30 characters. Omitted or blank keeps the corrected form's value.", "title": "Account Number" }, "attorney_gross_proceeds": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 10, gross proceeds paid to an attorney, in US dollars as a decimal string such as \"5000.00\"; omitted or null keeps the corrected form's value, an empty string clears the box.", "title": "Attorney Gross Proceeds" }, "cash_tips": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 13a, cash tips, in US dollars as a decimal string such as \"120.00\"; omitted or null keeps the corrected form's value, an empty string clears the box.", "title": "Cash Tips" }, "crop_insurance_proceeds": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 9, crop insurance proceeds, in US dollars as a decimal string such as \"0\"; omitted or null keeps the corrected form's value, an empty string clears the box.", "title": "Crop Insurance Proceeds" }, "direct_sale_above_threshold": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Box 7 checkbox: direct sales of $5,000 or more of consumer products to the recipient for resale. Omitted or null keeps the corrected form's value.", "title": "Direct Sale Above Threshold" }, "fatca_filing_requirement": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "FATCA filing requirement checkbox; omitted or null keeps the corrected form's value. If it ends up true with no account_number, the correction is refused.", "title": "Fatca Filing Requirement" }, "federal_income_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 4, federal income tax withheld, in US dollars as a decimal string such as \"0\"; omitted keeps the corrected form's value.", "title": "Federal Income Tax Withheld" }, "fish_purchased_for_resale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 11, fish purchased for resale, in US dollars as a decimal string such as \"0\"; omitted or null keeps the corrected form's value, an empty string clears the box.", "title": "Fish Purchased For Resale" }, "fishing_boat_proceeds": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5, fishing boat proceeds, in US dollars as a decimal string such as \"800.00\"; omitted or null keeps the corrected form's value, an empty string clears the box.", "title": "Fishing Boat Proceeds" }, "local_income_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Local income tax withheld, as a decimal string, for the state in state_code; omitted or null keeps the corrected form's value, an empty string clears it.", "title": "Local Income Tax Withheld" }, "medical_health_care_payments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 6, medical and health care payments, in US dollars as a decimal string such as \"2500.00\"; omitted or null keeps the corrected form's value, an empty string clears the box.", "title": "Medical Health Care Payments" }, "nonqualified_deferred_compensation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 15, nonqualified deferred compensation, in US dollars as a decimal string such as \"0\"; omitted or null keeps the corrected form's value, an empty string clears the box.", "title": "Nonqualified Deferred Compensation" }, "other_income": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 3, other income, in US dollars as a decimal string such as \"600.00\"; omitted keeps the corrected form's value.", "title": "Other Income" }, "overtime_compensation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 14, overtime compensation, in US dollars as a decimal string such as \"300.00\"; omitted or null keeps the corrected form's value, an empty string clears the box.", "title": "Overtime Compensation" }, "recipient_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "UUID of a different saved recipient, to correct a form filed under the wrong name or TIN. Omitted keeps the original recipient; an unknown id is refused with 404.", "title": "Recipient Id" }, "rent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 1, rents, in US dollars as a decimal string such as \"1500.00\"; omitted keeps the corrected form's value.", "title": "Rent" }, "royalties": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 2, royalties, in US dollars as a decimal string such as \"0\"; omitted keeps the corrected form's value.", "title": "Royalties" }, "school_district_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ohio school district income tax withheld, as a decimal string; not sent to the IRS but used for Ohio's filing. Omitted keeps the corrected form's value; it cannot be cleared.", "title": "School District Tax Withheld" }, "second_tin_notice": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "True when the IRS has told the payer twice within three calendar years that this recipient's TIN was incorrect. Omitted or null keeps the corrected form's value.", "title": "Second Tin Notice" }, "section_409a_deferrals": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 12, section 409A deferrals, in US dollars as a decimal string such as \"0\"; omitted or null keeps the corrected form's value, an empty string clears the box.", "title": "Section 409A Deferrals" }, "state_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 17, the two-letter code of the state the state amounts belong to; omitted keeps the corrected form's value.", "title": "State Code" }, "state_id_num": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 17, the payer's identification number with that state; omitted keeps the corrected form's value.", "title": "State Id Num" }, "state_income": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 18, state income, in US dollars as a decimal string such as \"4200.00\"; omitted keeps the corrected form's value.", "title": "State Income" }, "state_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 16, state income tax withheld, in US dollars as a decimal string such as \"0\"; omitted keeps the corrected form's value.", "title": "State Tax Withheld" }, "substitute_payments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 8, substitute payments in lieu of dividends or interest, in US dollars as a decimal string such as \"0\"; omitted or null keeps the corrected form's value, an empty string clears the box.", "title": "Substitute Payments" }, "tipped_occupation_codes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Box 13b, up to two Treasury tipped occupation codes such as [\"101\"]; omitted or null keeps the corrected form's codes, an empty list clears them.", "title": "Tipped Occupation Codes" }, "zero_all_amounts": { "default": false, "description": "True when the form should not have been filed: every amount the form carries becomes \"0\" (empty boxes stay empty), whatever amounts are sent. Defaults to false.", "title": "Zero All Amounts", "type": "boolean" } }, "title": "Form1099MISCCorrectRequest", "type": "object" }, "Form1099MISCCreateRequest": { "properties": { "account_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The account number the payer assigned to this recipient, at most 30 characters of letters, numbers and ordinary punctuation. Optional.", "title": "Account Number" }, "attorney_gross_proceeds": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 10, gross proceeds paid to an attorney, in US dollars as a decimal string such as \"5000.00\". Optional; left out, the box is empty.", "title": "Attorney Gross Proceeds" }, "cash_tips": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 13a, cash tips, in US dollars as a decimal string such as \"120.00\". Optional; when above zero, the form cannot be filed until box 13b has a tipped occupation code.", "title": "Cash Tips" }, "crop_insurance_proceeds": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 9, crop insurance proceeds, in US dollars as a decimal string such as \"0\". Optional; left out, the box is empty.", "title": "Crop Insurance Proceeds" }, "direct_sale_above_threshold": { "default": false, "description": "Box 7 checkbox: the payer made direct sales totaling $5,000 or more of consumer products to the recipient for resale. Defaults to false.", "title": "Direct Sale Above Threshold", "type": "boolean" }, "fatca_filing_requirement": { "default": false, "description": "FATCA filing requirement checkbox. When true, the IRS requires an account_number on the record. Defaults to false.", "title": "Fatca Filing Requirement", "type": "boolean" }, "federal_income_tax_withheld": { "default": "0", "description": "Box 4, federal income tax withheld, in US dollars as a decimal string such as \"0\". Defaults to \"0\".", "title": "Federal Income Tax Withheld", "type": "string" }, "fish_purchased_for_resale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 11, fish purchased for resale, in US dollars as a decimal string such as \"0\". Optional; left out, the box is empty.", "title": "Fish Purchased For Resale" }, "fishing_boat_proceeds": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5, fishing boat proceeds, in US dollars as a decimal string such as \"800.00\". Optional; left out, the box is empty.", "title": "Fishing Boat Proceeds" }, "local_income_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Local income tax withheld, as a decimal string, for the state in state_code. Filed with the IRS; the paper form has no box for it. Optional.", "title": "Local Income Tax Withheld" }, "medical_health_care_payments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 6, medical and health care payments, in US dollars as a decimal string such as \"2500.00\". Optional; left out, the box is empty.", "title": "Medical Health Care Payments" }, "nonqualified_deferred_compensation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 15, nonqualified deferred compensation, in US dollars as a decimal string such as \"0\". Optional; left out, the box is empty.", "title": "Nonqualified Deferred Compensation" }, "other_income": { "default": "0", "description": "Box 3, other income, in US dollars as a decimal string such as \"600.00\". Defaults to \"0\".", "title": "Other Income", "type": "string" }, "overtime_compensation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 14, overtime compensation, in US dollars as a decimal string such as \"300.00\". Optional; left out, the box is empty.", "title": "Overtime Compensation" }, "payer_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's city, at most 40 characters for a US address or 50 for one abroad. Required to file for a US payer.", "title": "Payer City" }, "payer_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "IRS country code for a payer outside the United States (the IRS's own list, not ISO: Germany is GM). Leave out for a US payer; when set, payer_state and payer_zip must be empty.", "title": "Payer Country" }, "payer_first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's first name, required to file when payer_type is \"individual\" or \"itin\"; a name longer than 20 characters is refused at filing.", "title": "Payer First Name" }, "payer_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "UUID of a saved payer whose details are copied onto the form. Send this or payer_name and the other payer fields, never both (400).", "title": "Payer Id" }, "payer_last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's last name, required to file when payer_type is \"individual\" or \"itin\"; a name longer than 20 characters is refused at filing.", "title": "Payer Last Name" }, "payer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's name as it files with the IRS. Required when payer_id is left out; leave it out when payer_id is sent.", "title": "Payer Name" }, "payer_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's contact phone number. Required to file unless payer_id supplies it.", "title": "Payer Phone" }, "payer_postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Postal code of a payer abroad, at most 16 characters. Only with payer_country.", "title": "Payer Postal Code" }, "payer_province": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Province or state of a payer abroad, at most 17 characters. Only with payer_country.", "title": "Payer Province" }, "payer_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's two-letter USPS state, territory or APO code, upper-cased. US addresses only; required to file for a US payer.", "title": "Payer State" }, "payer_street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's street address, line 1, at most 35 characters. Required to file unless payer_id supplies it.", "title": "Payer Street" }, "payer_street2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's street address, line 2, such as a suite or unit, at most 35 characters. Sent to the IRS as its own line.", "title": "Payer Street2" }, "payer_tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's nine-digit EIN, SSN or ITIN; dashes and spaces are stripped. Encrypted at rest and never returned. Required to file unless payer_id supplies it.", "title": "Payer Tin" }, "payer_tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of number payer_tin is: \"ssn\", \"ein\" or \"itin\". Left out, it follows payer_type (business EIN, individual SSN, itin ITIN). A sole proprietor who files under their own name with an EIN is payer_type \"individual\" and payer_tin_type \"ein\". Leave it out when payer_id is sent.", "title": "Payer Tin Type" }, "payer_type": { "default": "business", "description": "\"business\" (files under payer_name), \"individual\" (a person, filing under payer_first_name and payer_last_name) or \"itin\" (a person with an ITIN). Defaults to \"business\".", "title": "Payer Type", "type": "string" }, "payer_zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's ZIP code, five digits or ZIP+4. US addresses only; required to file for a US payer.", "title": "Payer Zip" }, "recipient_id": { "description": "UUID of a saved recipient, the contractor this form reports. An unknown id is refused with 404.", "format": "uuid", "title": "Recipient Id", "type": "string" }, "rent": { "default": "0", "description": "Box 1, rents, in US dollars as a decimal string such as \"1500.00\". Defaults to \"0\".", "title": "Rent", "type": "string" }, "royalties": { "default": "0", "description": "Box 2, royalties, in US dollars as a decimal string such as \"0\". Defaults to \"0\".", "title": "Royalties", "type": "string" }, "school_district_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ohio school district income tax withheld, as a decimal string; not sent to the IRS but used for Ohio's filing. Left out means not answered; \"0\" means none withheld.", "title": "School District Tax Withheld" }, "second_tin_notice": { "default": false, "description": "True when the IRS has told the payer twice within three calendar years that this recipient's TIN was incorrect. Filed with the IRS; not printed on Copy B.", "title": "Second Tin Notice", "type": "boolean" }, "section_409a_deferrals": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 12, section 409A deferrals, in US dollars as a decimal string such as \"0\". Optional; left out, the box is empty.", "title": "Section 409A Deferrals" }, "state_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 17, the two-letter code of the state the state amounts belong to. Required when a state amount or the local tax is above zero, or state_id_num is given.", "title": "State Code" }, "state_id_num": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 17, the payer's own identification number with the state in state_code. Optional; needs state_code when given.", "title": "State Id Num" }, "state_income": { "default": "0", "description": "Box 18, state income, in US dollars as a decimal string such as \"4200.00\". Defaults to \"0\"; needs state_code when above zero.", "title": "State Income", "type": "string" }, "state_tax_withheld": { "default": "0", "description": "Box 16, state income tax withheld, in US dollars as a decimal string such as \"0\". Defaults to \"0\"; needs state_code when above zero.", "title": "State Tax Withheld", "type": "string" }, "substitute_payments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 8, substitute payments in lieu of dividends or interest, in US dollars as a decimal string such as \"0\". Optional; left out, the box is empty.", "title": "Substitute Payments" }, "tax_year": { "default": 2026, "description": "Tax year the form reports. Defaults to 2026; this season files tax year 2026 forms only, and any other year is refused.", "title": "Tax Year", "type": "integer" }, "tipped_occupation_codes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Box 13b, up to two Treasury tipped occupation codes such as [\"101\"], or \"000\" for a nonqualifying occupation. Unknown or repeated codes are refused.", "title": "Tipped Occupation Codes" } }, "required": [ "recipient_id" ], "title": "Form1099MISCCreateRequest", "type": "object" }, "Form1099MISCResponse": { "properties": { "account_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The account number the payer assigned to this recipient; null when none.", "title": "Account Number" }, "attorney_gross_proceeds": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 10, gross proceeds paid to an attorney, in US dollars as a decimal string such as \"5000.00\"; null when the box was not entered.", "title": "Attorney Gross Proceeds" }, "batch_job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "UUID of the bulk import that created this form; null for a form created on its own or as a correction.", "title": "Batch Job Id" }, "cash_tips": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 13a, cash tips, in US dollars as a decimal string such as \"120.00\"; null when the box was not entered.", "title": "Cash Tips" }, "checked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this draft last passed a pre-filing check with nothing sent, as an ISO 8601 date-time; null once the draft is edited or filed, and on any form that is not a draft.", "title": "Checked At" }, "corrected": { "default": false, "description": "True when this form is a correction of an earlier accepted form; false on an original.", "title": "Corrected", "type": "boolean" }, "correction_seq": { "default": 0, "description": "Place in the correction chain: 0 for an original, 1 for its correction, 2 for a correction of that, and so on.", "title": "Correction Seq", "type": "integer" }, "corrects_form_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "UUID of the form this correction corrects; null on an original.", "title": "Corrects Form Id" }, "corrects_unique_record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The IRS record id of the form this correction corrects, which the correction is addressed to; null on an original.", "title": "Corrects Unique Record Id" }, "created_at": { "description": "When the form was created, as an ISO 8601 date-time.", "title": "Created At", "type": "string" }, "crop_insurance_proceeds": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 9, crop insurance proceeds, in US dollars as a decimal string such as \"0\"; null when the box was not entered.", "title": "Crop Insurance Proceeds" }, "direct_sale_above_threshold": { "default": false, "description": "Box 7 checkbox: the payer made direct sales of $5,000 or more of consumer products to the recipient for resale.", "title": "Direct Sale Above Threshold", "type": "boolean" }, "engine_submission_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The filing service's id for the transmission that carried this form; null until the form is sent.", "title": "Engine Submission Id" }, "environment": { "anyOf": [ { "enum": [ "sandbox", "live" ], "type": "string" }, { "type": "null" } ], "description": "Where the form was filed: sandbox, live, or null before it is submitted.", "title": "Environment" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why the form was not filed, or what the IRS flagged on an accepted form, in plain English; null when there is nothing to report.", "title": "Error Message" }, "fatca_filing_requirement": { "description": "FATCA filing requirement checkbox; when true the IRS requires the record to carry an account_number.", "title": "Fatca Filing Requirement", "type": "boolean" }, "federal_income_tax_withheld": { "description": "Box 4, federal income tax withheld, in US dollars as a decimal string such as \"0\".", "title": "Federal Income Tax Withheld", "type": "string" }, "fish_purchased_for_resale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 11, fish purchased for resale, in US dollars as a decimal string such as \"0\"; null when the box was not entered.", "title": "Fish Purchased For Resale" }, "fishing_boat_proceeds": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5, fishing boat proceeds, in US dollars as a decimal string such as \"800.00\"; null when the box was not entered.", "title": "Fishing Boat Proceeds" }, "form_id": { "description": "UUID of this 1099-MISC.", "title": "Form Id", "type": "string" }, "furnish_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why the last attempt to email Copy B failed; null when no attempt has failed since the last success.", "title": "Furnish Error" }, "furnish_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "How Copy B reached the recipient: \"email\" or \"print\"; null until it is furnished.", "title": "Furnish Method" }, "furnished_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When Copy B was delivered to the recipient (emailed, or the print copy made), as an ISO 8601 date-time; null until then.", "title": "Furnished At" }, "in_line_reason": { "anyOf": [ { "enum": [ "busy", "transmissions_off", "release_hold", "released" ], "type": "string" }, { "type": "null" } ], "description": "Why the form is in line: busy (the filing service could not take it yet), transmissions_off (sending is switched off for now), release_hold (it waits for our review) or released (reviewed, and being sent now). It is sent from the line or returned with the reason in error_message; send nothing again meanwhile.", "title": "In Line Reason" }, "in_line_since": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this form went into line to send, as an ISO 8601 date-time: the filing service could not take it yet, so it waits at queued and is sent automatically once the service is ready. Null for any other form, including one waiting its ordinary turn in a batch.", "title": "In Line Since" }, "irs_last_answer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The IRS's last answer about this form's current transmission, in the IRS's own words: \"Accepted\", \"Accepted with Errors\", \"Partially Accepted\", \"Rejected\", \"Processing\" or \"Not Found\". Null when the IRS has not been asked. Kept while the form is submit_indeterminate.", "title": "Irs Last Answer" }, "irs_last_answer_since": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Since when the IRS has given that same answer, as an ISO 8601 date-time: how long it has said Not Found, for instance. Null when it has not been asked.", "title": "Irs Last Answer Since" }, "irs_last_asked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the IRS gave irs_last_answer, as an ISO 8601 date-time; null when it has not been asked.", "title": "Irs Last Asked At" }, "irs_receipt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The IRS's receipt id for this form's current transmission while it is unconfirmed, once the IRS's status search finds it; null when not known. A filed form's receipt is in engine_submission_id.", "title": "Irs Receipt Id" }, "local_income_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Local income tax withheld, as a decimal string, for the state in state_code; null when not entered.", "title": "Local Income Tax Withheld" }, "medical_health_care_payments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 6, medical and health care payments, in US dollars as a decimal string such as \"2500.00\"; null when the box was not entered.", "title": "Medical Health Care Payments" }, "nonqualified_deferred_compensation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 15, nonqualified deferred compensation, in US dollars as a decimal string such as \"0\"; null when the box was not entered.", "title": "Nonqualified Deferred Compensation" }, "other_income": { "description": "Box 3, other income, in US dollars as a decimal string such as \"600.00\".", "title": "Other Income", "type": "string" }, "overtime_compensation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 14, overtime compensation, in US dollars as a decimal string such as \"300.00\"; null when the box was not entered.", "title": "Overtime Compensation" }, "payer_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's city; null when not given.", "title": "Payer City" }, "payer_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "IRS country code of a payer outside the United States; null for a US payer.", "title": "Payer Country" }, "payer_first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's first name, for an individual or ITIN payer; null when not given.", "title": "Payer First Name" }, "payer_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "UUID of the saved payer the payer details were copied from; null when they were typed onto the form. Editing the saved payer updates this form until it is filed; a filed form and a correction keep the details they carry.", "title": "Payer Id" }, "payer_last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's last name, for an individual or ITIN payer; null when not given.", "title": "Payer Last Name" }, "payer_name": { "description": "Payer's name as it files on this form.", "title": "Payer Name", "type": "string" }, "payer_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's contact phone number as entered; null when not given.", "title": "Payer Phone" }, "payer_postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Postal code of a payer abroad; null for a US payer.", "title": "Payer Postal Code" }, "payer_province": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Province or state of a payer abroad; null for a US payer.", "title": "Payer Province" }, "payer_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's two-letter USPS state code; null for a payer abroad or when not given.", "title": "Payer State" }, "payer_street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's street address, line 1; null when not given.", "title": "Payer Street" }, "payer_street2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's street address, line 2; null when not given.", "title": "Payer Street2" }, "payer_tin_on_file": { "description": "Whether a payer TIN is stored for this form. The TIN itself is never returned.", "title": "Payer Tin On File", "type": "boolean" }, "payer_tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of TIN the payer files under on this form: \"ssn\", \"ein\" or \"itin\". The TIN type copied with the payer, otherwise what payer_type implies. The IRS record, Copy B and the state files follow it.", "title": "Payer Tin Type" }, "payer_type": { "description": "\"business\", \"individual\" (sole proprietor) or \"itin\" (a person with an ITIN).", "title": "Payer Type", "type": "string" }, "payer_zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's ZIP code, five digits or ZIP+4; null for a payer abroad or when not given.", "title": "Payer Zip" }, "recipient_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "UUID of the recipient this form reports; null only when no recipient is linked.", "title": "Recipient Id" }, "recipient_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The recipient's name, for display. It can be null even when recipient_id is set, so treat recipient_id as the identity.", "title": "Recipient Name" }, "recipient_tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of TIN the recipient holds: \"ssn\", \"ein\" or \"itin\". The payee's Form W-9 answer when one is on file, otherwise the tin_type the firm saved with the recipient, otherwise what its recipient_type implies. Null when none says, or when the recipient was not loaded with the form.", "title": "Recipient Tin Type" }, "rent": { "description": "Box 1, rents, in US dollars as a decimal string such as \"1500.00\".", "title": "Rent", "type": "string" }, "resend_offered": { "default": false, "description": "True only when the form is submit_indeterminate, the IRS has answered \"Not Found\" for its transmission, on a live account. Then the resend route files it again as a new transmission; the earlier attempt stays on record.", "title": "Resend Offered", "type": "boolean" }, "resent_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the firm last resent this form as a new transmission after the IRS answered Not Found for the earlier one, as an ISO 8601 date-time; null when it was never resent. The earlier attempt stays on record.", "title": "Resent At" }, "royalties": { "description": "Box 2, royalties, in US dollars as a decimal string such as \"0\".", "title": "Royalties", "type": "string" }, "school_district_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ohio school district income tax withheld, as a decimal string; not sent to the IRS. Null means nobody answered; \"0\" means none was withheld.", "title": "School District Tax Withheld" }, "second_tin_notice": { "default": false, "description": "True when the IRS has told the payer twice within three calendar years that this recipient's TIN was incorrect.", "title": "Second Tin Notice", "type": "boolean" }, "section_409a_deferrals": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 12, section 409A deferrals, in US dollars as a decimal string such as \"0\"; null when the box was not entered.", "title": "Section 409A Deferrals" }, "state_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 17, the two-letter code of the state the state amounts belong to; null when the form names no state.", "title": "State Code" }, "state_file_generated": { "default": false, "description": "True when state_filing is \"state_file\" and SimplifyGigTax writes that state an upload file including this form; false when the firm files with the state directly.", "title": "State File Generated", "type": "boolean" }, "state_filing": { "default": "none", "description": "What this form still owes a state once filed with the IRS: \"none\", \"cfsf\" (the payer's Combined Federal/State Filing election covers it) or \"state_file\" (the firm files with the state).", "title": "State Filing", "type": "string" }, "state_filing_reason": { "default": "", "description": "One plain-English sentence saying why state_filing has its value, citing the state's own source where a state rule applies.", "title": "State Filing Reason", "type": "string" }, "state_filing_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Two-letter code of the state state_filing_reason is about: the state with the strongest claim, or where the recipient worked or lives. Null when the recipient has no US state; not always the Box 17 state.", "title": "State Filing State" }, "state_id_num": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 17, the payer's identification number with that state; null when not given.", "title": "State Id Num" }, "state_income": { "description": "Box 18, state income, in US dollars as a decimal string such as \"4200.00\".", "title": "State Income", "type": "string" }, "state_tax_withheld": { "description": "Box 16, state income tax withheld, in US dollars as a decimal string such as \"0\".", "title": "State Tax Withheld", "type": "string" }, "status": { "description": "Where the form stands, such as \"submitted\", \"queued\", \"accepted\", \"accepted_with_errors\", \"rejected\", \"error\", \"submit_indeterminate\" or \"draft\" (a correction not yet filed).", "title": "Status", "type": "string" }, "substitute_payments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 8, substitute payments in lieu of dividends or interest, in US dollars as a decimal string such as \"0\"; null when the box was not entered.", "title": "Substitute Payments" }, "taken_out_of_line_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this form, waiting in line, went back to draft with nothing sent because the account switched to sandbox mode, as an ISO 8601 date-time. Cleared once the form is checked or edited; null otherwise.", "title": "Taken Out Of Line At" }, "tax_year": { "description": "Tax year the form reports; 2026 this season.", "title": "Tax Year", "type": "integer" }, "tenant_id": { "description": "UUID of the firm account that owns the form.", "title": "Tenant Id", "type": "string" }, "tipped_occupation_codes": { "default": [], "description": "Box 13b, the Treasury tipped occupation codes, at most two; an empty list when none.", "items": { "type": "string" }, "title": "Tipped Occupation Codes", "type": "array" }, "unique_record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The IRS's id for this record, from its acknowledgement; null until the IRS answers. A form without one cannot be corrected yet.", "title": "Unique Record Id" }, "updated_at": { "description": "When the form last changed, as an ISO 8601 date-time.", "title": "Updated At", "type": "string" }, "voided": { "description": "Whether the form is marked void; a voided form cannot be corrected.", "title": "Voided", "type": "boolean" }, "voided_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the form was voided: the moment the IRS accepted the zero-amount correction filed against it. Null unless voided is true.", "title": "Voided At" } }, "required": [ "form_id", "tenant_id", "recipient_id", "batch_job_id", "payer_id", "payer_name", "payer_type", "payer_first_name", "payer_last_name", "payer_street", "payer_city", "payer_state", "payer_zip", "payer_phone", "payer_tin_on_file", "tax_year", "rent", "royalties", "other_income", "federal_income_tax_withheld", "fatca_filing_requirement", "account_number", "state_tax_withheld", "state_code", "state_income", "status", "voided", "engine_submission_id", "environment", "error_message", "created_at", "updated_at" ], "title": "Form1099MISCResponse", "type": "object" }, "Form1099NECChainResponse": { "description": "The whole chain for one record, oldest first: original, then each\ncorrection. What a CPA needs to answer \"what did we actually file for this\ncontractor, and what did we say afterwards\".", "properties": { "links": { "description": "Every form in the chain, oldest first: the original, then each correction in turn.", "items": { "$ref": "#/components/schemas/Form1099NECResponse" }, "title": "Links", "type": "array" }, "root_form_id": { "description": "UUID of the original form the chain starts from, whichever link was asked about.", "title": "Root Form Id", "type": "string" } }, "required": [ "root_form_id", "links" ], "title": "Form1099NECChainResponse", "type": "object" }, "Form1099NECCorrectRequest": { "description": "What changed. Everything omitted is carried over from the record being\ncorrected, because Pub 5718 requires the COMPLETE record to be re-filed:\nthe caller states the correction, not the whole form again.\n\nThe payer block is deliberately NOT correctable here: §6.1.1 requires the\n`IssuerDetail` in a correction to be identical to the original submission's.\nA wrong payer is a different remedy, not this one.", "properties": { "account_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The account number the payer assigned to this recipient, at most 30 characters. Omitted or blank keeps the corrected form's value.", "title": "Account Number" }, "cash_tips": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 1b, cash tips, in US dollars as a decimal string such as \"120.00\"; omitted or null keeps the corrected form's value, an empty string clears the box.", "title": "Cash Tips" }, "direct_sale_above_threshold": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Box 2 checkbox: direct sales of $5,000 or more of consumer products to the recipient for resale. Omitted or null keeps the corrected form's value.", "title": "Direct Sale Above Threshold" }, "excess_parachute_payment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 3, excess golden parachute payments, in US dollars as a decimal string such as \"0\"; omitted or null keeps the corrected form's value, an empty string clears the box.", "title": "Excess Parachute Payment" }, "federal_income_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 4, federal income tax withheld, in US dollars as a decimal string such as \"0\"; omitted keeps the corrected form's value.", "title": "Federal Income Tax Withheld" }, "local_income_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Local income tax withheld, as a decimal string, for the state in state_code; omitted or null keeps the corrected form's value, an empty string clears it.", "title": "Local Income Tax Withheld" }, "nonemployee_compensation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 1, nonemployee compensation, in US dollars as a decimal string such as \"4200.00\"; omitted keeps the corrected form's value.", "title": "Nonemployee Compensation" }, "overtime_compensation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 1d, overtime compensation, in US dollars as a decimal string such as \"300.00\"; omitted or null keeps the corrected form's value, an empty string clears the box.", "title": "Overtime Compensation" }, "recipient_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "UUID of a different saved recipient, to correct a form filed under the wrong name or TIN. Omitted keeps the original recipient; an unknown id is refused with 404.", "title": "Recipient Id" }, "school_district_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ohio school district income tax withheld, as a decimal string; not sent to the IRS but used for Ohio's filing. Omitted keeps the corrected form's value; it cannot be cleared.", "title": "School District Tax Withheld" }, "second_tin_notice": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "True when the IRS has told the payer twice within three calendar years that this recipient's TIN was incorrect. Omitted or null keeps the corrected form's value.", "title": "Second Tin Notice" }, "state_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 6, the two-letter code of the state the state amounts belong to; omitted keeps the corrected form's value.", "title": "State Code" }, "state_id_num": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 6, the payer's identification number with that state; omitted keeps the corrected form's value.", "title": "State Id Num" }, "state_income": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 7, state income, in US dollars as a decimal string such as \"4200.00\"; omitted keeps the corrected form's value.", "title": "State Income" }, "state_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 5, state income tax withheld, in US dollars as a decimal string such as \"0\"; omitted keeps the corrected form's value.", "title": "State Tax Withheld" }, "tipped_occupation_codes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Box 1c, up to two Treasury tipped occupation codes such as [\"101\"]; omitted or null keeps the corrected form's codes, an empty list clears them.", "title": "Tipped Occupation Codes" }, "zero_all_amounts": { "default": false, "description": "True when the form should not have been filed: every amount the form carries becomes \"0\" (empty boxes stay empty), whatever amounts are sent. Defaults to false.", "title": "Zero All Amounts", "type": "boolean" } }, "title": "Form1099NECCorrectRequest", "type": "object" }, "Form1099NECCreateRequest": { "properties": { "account_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The account number the payer assigned to this recipient, at most 30 characters of letters, numbers and ordinary punctuation. Optional.", "title": "Account Number" }, "cash_tips": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 1b, cash tips, in US dollars as a decimal string such as \"120.00\". Optional; when above zero, the form cannot be filed until box 1c has a tipped occupation code.", "title": "Cash Tips" }, "direct_sale_above_threshold": { "default": false, "description": "Box 2 checkbox: the payer made direct sales totaling $5,000 or more of consumer products to the recipient for resale. Defaults to false.", "title": "Direct Sale Above Threshold", "type": "boolean" }, "excess_parachute_payment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 3, excess golden parachute payments, in US dollars as a decimal string such as \"0\". Optional; left out, the box is empty.", "title": "Excess Parachute Payment" }, "federal_income_tax_withheld": { "default": "0", "description": "Box 4, federal income tax withheld, in US dollars as a decimal string such as \"0\". Defaults to \"0\".", "title": "Federal Income Tax Withheld", "type": "string" }, "local_income_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Local income tax withheld, as a decimal string, for the state in state_code. Filed with the IRS; the paper form has no box for it. Optional.", "title": "Local Income Tax Withheld" }, "nonemployee_compensation": { "description": "Box 1, nonemployee compensation, in US dollars as a decimal string such as \"4200.00\". Required; zero or more.", "title": "Nonemployee Compensation", "type": "string" }, "overtime_compensation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 1d, overtime compensation, in US dollars as a decimal string such as \"300.00\". Optional; left out, the box is empty.", "title": "Overtime Compensation" }, "payer_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's city, at most 40 characters for a US address or 50 for one abroad. Required to file for a US payer.", "title": "Payer City" }, "payer_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "IRS country code for a payer outside the United States (the IRS's own list, not ISO: Germany is GM). Leave out for a US payer; when set, payer_state and payer_zip must be empty.", "title": "Payer Country" }, "payer_first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's first name, required to file when payer_type is \"individual\" or \"itin\"; a name longer than 20 characters is refused at filing.", "title": "Payer First Name" }, "payer_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "UUID of a saved payer whose details are copied onto the form. Send this or payer_name and the other payer fields, never both (400).", "title": "Payer Id" }, "payer_last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's last name, required to file when payer_type is \"individual\" or \"itin\"; a name longer than 20 characters is refused at filing.", "title": "Payer Last Name" }, "payer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's name as it files with the IRS. Required when payer_id is left out; leave it out when payer_id is sent.", "title": "Payer Name" }, "payer_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's contact phone number. Required to file unless payer_id supplies it.", "title": "Payer Phone" }, "payer_postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Postal code of a payer abroad, at most 16 characters. Only with payer_country.", "title": "Payer Postal Code" }, "payer_province": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Province or state of a payer abroad, at most 17 characters. Only with payer_country.", "title": "Payer Province" }, "payer_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's two-letter USPS state, territory or APO code, upper-cased. US addresses only; required to file for a US payer.", "title": "Payer State" }, "payer_street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's street address, line 1, at most 35 characters. Required to file unless payer_id supplies it.", "title": "Payer Street" }, "payer_street2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's street address, line 2, such as a suite or unit, at most 35 characters. Sent to the IRS as its own line.", "title": "Payer Street2" }, "payer_tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's nine-digit EIN, SSN or ITIN; dashes and spaces are stripped. Encrypted at rest and never returned. Required to file unless payer_id supplies it.", "title": "Payer Tin" }, "payer_tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of number payer_tin is: \"ssn\", \"ein\" or \"itin\". Left out, it follows payer_type (business EIN, individual SSN, itin ITIN). A sole proprietor who files under their own name with an EIN is payer_type \"individual\" and payer_tin_type \"ein\". Leave it out when payer_id is sent.", "title": "Payer Tin Type" }, "payer_type": { "default": "business", "description": "\"business\" (files under payer_name), \"individual\" (a person, filing under payer_first_name and payer_last_name) or \"itin\" (a person with an ITIN). Defaults to \"business\".", "title": "Payer Type", "type": "string" }, "payer_zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's ZIP code, five digits or ZIP+4. US addresses only; required to file for a US payer.", "title": "Payer Zip" }, "recipient_id": { "description": "UUID of a saved recipient, the contractor this form reports. An unknown id is refused with 404.", "format": "uuid", "title": "Recipient Id", "type": "string" }, "school_district_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ohio school district income tax withheld, as a decimal string; not sent to the IRS but used for Ohio's filing. Left out means not answered; \"0\" means none withheld.", "title": "School District Tax Withheld" }, "second_tin_notice": { "default": false, "description": "True when the IRS has told the payer twice within three calendar years that this recipient's TIN was incorrect. Filed with the IRS; not printed on Copy B.", "title": "Second Tin Notice", "type": "boolean" }, "state_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 6, the two-letter code of the state the state amounts belong to. Required when a state amount or the local tax is above zero, or state_id_num is given.", "title": "State Code" }, "state_id_num": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 6, the payer's own identification number with the state in state_code. Optional; needs state_code when given.", "title": "State Id Num" }, "state_income": { "default": "0", "description": "Box 7, state income, in US dollars as a decimal string such as \"4200.00\". Defaults to \"0\"; needs state_code when above zero.", "title": "State Income", "type": "string" }, "state_tax_withheld": { "default": "0", "description": "Box 5, state income tax withheld, in US dollars as a decimal string such as \"0\". Defaults to \"0\"; needs state_code when above zero.", "title": "State Tax Withheld", "type": "string" }, "tax_year": { "default": 2026, "description": "Tax year the form reports. Defaults to 2026; this season files tax year 2026 forms only, and any other year is refused.", "title": "Tax Year", "type": "integer" }, "tipped_occupation_codes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Box 1c, up to two Treasury tipped occupation codes such as [\"101\"], or \"000\" for a nonqualifying occupation. Unknown or repeated codes are refused.", "title": "Tipped Occupation Codes" } }, "required": [ "recipient_id", "nonemployee_compensation" ], "title": "Form1099NECCreateRequest", "type": "object" }, "Form1099NECResponse": { "properties": { "account_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The account number the payer assigned to this recipient; null when none.", "title": "Account Number" }, "batch_job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "UUID of the bulk import that created this form; null for a form created on its own or as a correction.", "title": "Batch Job Id" }, "cash_tips": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 1b, cash tips, in US dollars as a decimal string such as \"120.00\"; null when the box was not entered.", "title": "Cash Tips" }, "checked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this draft last passed a pre-filing check with nothing sent, as an ISO 8601 date-time; null once the draft is edited or filed, and on any form that is not a draft.", "title": "Checked At" }, "corrected": { "description": "True when this form is a correction of an earlier accepted form; false on an original.", "title": "Corrected", "type": "boolean" }, "correction_seq": { "description": "Place in the correction chain: 0 for an original, 1 for its correction, 2 for a correction of that, and so on.", "title": "Correction Seq", "type": "integer" }, "corrects_form_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "UUID of the form this correction corrects; null on an original.", "title": "Corrects Form Id" }, "corrects_unique_record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The IRS record id of the form this correction corrects, which the correction is addressed to; null on an original.", "title": "Corrects Unique Record Id" }, "created_at": { "description": "When the form was created, as an ISO 8601 date-time.", "title": "Created At", "type": "string" }, "direct_sale_above_threshold": { "default": false, "description": "Box 2 checkbox: the payer made direct sales of $5,000 or more of consumer products to the recipient for resale.", "title": "Direct Sale Above Threshold", "type": "boolean" }, "engine_submission_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The filing service's id for the transmission that carried this form; null until the form is sent.", "title": "Engine Submission Id" }, "environment": { "anyOf": [ { "enum": [ "sandbox", "live" ], "type": "string" }, { "type": "null" } ], "description": "Where the form was filed: sandbox, live, or null before it is submitted.", "title": "Environment" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why the form was not filed, or what the IRS flagged on an accepted form, in plain English; null when there is nothing to report.", "title": "Error Message" }, "excess_parachute_payment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 3, excess golden parachute payments, in US dollars as a decimal string such as \"0\"; null when the box was not entered.", "title": "Excess Parachute Payment" }, "federal_income_tax_withheld": { "description": "Box 4, federal income tax withheld, in US dollars as a decimal string such as \"0\".", "title": "Federal Income Tax Withheld", "type": "string" }, "form_id": { "description": "UUID of this 1099-NEC.", "title": "Form Id", "type": "string" }, "furnish_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why the last attempt to email Copy B failed; null when no attempt has failed since the last success.", "title": "Furnish Error" }, "furnish_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "How Copy B reached the recipient: \"email\" or \"print\"; null until it is furnished.", "title": "Furnish Method" }, "furnished_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When Copy B was delivered to the recipient (emailed, or the print copy made), as an ISO 8601 date-time; null until then.", "title": "Furnished At" }, "in_line_reason": { "anyOf": [ { "enum": [ "busy", "transmissions_off", "release_hold", "released" ], "type": "string" }, { "type": "null" } ], "description": "Why the form is in line: busy (the filing service could not take it yet), transmissions_off (sending is switched off for now), release_hold (it waits for our review) or released (reviewed, and being sent now). It is sent from the line or returned with the reason in error_message; send nothing again meanwhile.", "title": "In Line Reason" }, "in_line_since": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this form went into line to send, as an ISO 8601 date-time: the filing service could not take it yet, so it waits at queued and is sent automatically once the service is ready. Null for any other form, including one waiting its ordinary turn in a batch.", "title": "In Line Since" }, "irs_last_answer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The IRS's last answer about this form's current transmission, in the IRS's own words: \"Accepted\", \"Accepted with Errors\", \"Partially Accepted\", \"Rejected\", \"Processing\" or \"Not Found\". Null when the IRS has not been asked. Kept while the form is submit_indeterminate.", "title": "Irs Last Answer" }, "irs_last_answer_since": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Since when the IRS has given that same answer, as an ISO 8601 date-time: how long it has said Not Found, for instance. Null when it has not been asked.", "title": "Irs Last Answer Since" }, "irs_last_asked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the IRS gave irs_last_answer, as an ISO 8601 date-time; null when it has not been asked.", "title": "Irs Last Asked At" }, "irs_receipt_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The IRS's receipt id for this form's current transmission while it is unconfirmed, once the IRS's status search finds it; null when not known. A filed form's receipt is in engine_submission_id.", "title": "Irs Receipt Id" }, "local_income_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Local income tax withheld, as a decimal string, for the state in state_code; null when not entered.", "title": "Local Income Tax Withheld" }, "nonemployee_compensation": { "description": "Box 1, nonemployee compensation, in US dollars as a decimal string such as \"4200.00\".", "title": "Nonemployee Compensation", "type": "string" }, "overtime_compensation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 1d, overtime compensation, in US dollars as a decimal string such as \"300.00\"; null when the box was not entered.", "title": "Overtime Compensation" }, "payer_city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's city; null when not given.", "title": "Payer City" }, "payer_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "IRS country code of a payer outside the United States; null for a US payer.", "title": "Payer Country" }, "payer_first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's first name, for an individual or ITIN payer; null when not given.", "title": "Payer First Name" }, "payer_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "UUID of the saved payer the payer details were copied from; null when they were typed onto the form. Editing the saved payer updates this form until it is filed; a filed form and a correction keep the details they carry.", "title": "Payer Id" }, "payer_last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's last name, for an individual or ITIN payer; null when not given.", "title": "Payer Last Name" }, "payer_name": { "description": "Payer's name as it files on this form.", "title": "Payer Name", "type": "string" }, "payer_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's contact phone number as entered; null when not given.", "title": "Payer Phone" }, "payer_postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Postal code of a payer abroad; null for a US payer.", "title": "Payer Postal Code" }, "payer_province": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Province or state of a payer abroad; null for a US payer.", "title": "Payer Province" }, "payer_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's two-letter USPS state code; null for a payer abroad or when not given.", "title": "Payer State" }, "payer_street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's street address, line 1; null when not given.", "title": "Payer Street" }, "payer_street2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's street address, line 2; null when not given.", "title": "Payer Street2" }, "payer_tin_on_file": { "description": "Whether a payer TIN is stored for this form. The TIN itself is never returned.", "title": "Payer Tin On File", "type": "boolean" }, "payer_tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of TIN the payer files under on this form: \"ssn\", \"ein\" or \"itin\". The TIN type copied with the payer, otherwise what payer_type implies. The IRS record, Copy B and the state files follow it.", "title": "Payer Tin Type" }, "payer_type": { "description": "\"business\", \"individual\" (sole proprietor) or \"itin\" (a person with an ITIN).", "title": "Payer Type", "type": "string" }, "payer_zip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Payer's ZIP code, five digits or ZIP+4; null for a payer abroad or when not given.", "title": "Payer Zip" }, "recipient_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "UUID of the recipient this form reports; null only when no recipient is linked.", "title": "Recipient Id" }, "recipient_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The recipient's name, for display. It can be null even when recipient_id is set, so treat recipient_id as the identity.", "title": "Recipient Name" }, "recipient_tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of TIN the recipient holds: \"ssn\", \"ein\" or \"itin\". The payee's Form W-9 answer when one is on file, otherwise the tin_type the firm saved with the recipient, otherwise what its recipient_type implies. Null when none says, or when the recipient was not loaded with the form.", "title": "Recipient Tin Type" }, "resend_offered": { "default": false, "description": "True only when the form is submit_indeterminate, the IRS has answered \"Not Found\" for its transmission, on a live account. Then the resend route files it again as a new transmission; the earlier attempt stays on record.", "title": "Resend Offered", "type": "boolean" }, "resent_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the firm last resent this form as a new transmission after the IRS answered Not Found for the earlier one, as an ISO 8601 date-time; null when it was never resent. The earlier attempt stays on record.", "title": "Resent At" }, "school_district_tax_withheld": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ohio school district income tax withheld, as a decimal string; not sent to the IRS. Null means nobody answered; \"0\" means none was withheld.", "title": "School District Tax Withheld" }, "second_tin_notice": { "default": false, "description": "True when the IRS has told the payer twice within three calendar years that this recipient's TIN was incorrect.", "title": "Second Tin Notice", "type": "boolean" }, "state_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 6, the two-letter code of the state the state amounts belong to; null when the form names no state.", "title": "State Code" }, "state_file_generated": { "default": false, "description": "True when state_filing is \"state_file\" and SimplifyGigTax writes that state an upload file including this form; false when the firm files with the state directly.", "title": "State File Generated", "type": "boolean" }, "state_filing": { "default": "none", "description": "What this form still owes a state once filed with the IRS: \"none\", \"cfsf\" (the payer's Combined Federal/State Filing election covers it) or \"state_file\" (the firm files with the state).", "title": "State Filing", "type": "string" }, "state_filing_reason": { "default": "", "description": "One plain-English sentence saying why state_filing has its value, citing the state's own source where a state rule applies.", "title": "State Filing Reason", "type": "string" }, "state_filing_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Two-letter code of the state state_filing_reason is about: the state with the strongest claim, or where the recipient worked or lives. Null when the recipient has no US state; not always the Box 6 state.", "title": "State Filing State" }, "state_id_num": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Box 6, the payer's identification number with that state; null when not given.", "title": "State Id Num" }, "state_income": { "description": "Box 7, state income, in US dollars as a decimal string such as \"4200.00\".", "title": "State Income", "type": "string" }, "state_tax_withheld": { "description": "Box 5, state income tax withheld, in US dollars as a decimal string such as \"0\".", "title": "State Tax Withheld", "type": "string" }, "status": { "description": "Where the form stands, such as \"submitted\", \"queued\", \"accepted\", \"accepted_with_errors\", \"rejected\", \"error\", \"submit_indeterminate\" or \"draft\" (a correction not yet filed).", "title": "Status", "type": "string" }, "taken_out_of_line_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When this form, waiting in line, went back to draft with nothing sent because the account switched to sandbox mode, as an ISO 8601 date-time. Cleared once the form is checked or edited; null otherwise.", "title": "Taken Out Of Line At" }, "tax_year": { "description": "Tax year the form reports; 2026 this season.", "title": "Tax Year", "type": "integer" }, "tenant_id": { "description": "UUID of the firm account that owns the form.", "title": "Tenant Id", "type": "string" }, "tipped_occupation_codes": { "default": [], "description": "Box 1c, the Treasury tipped occupation codes, at most two; an empty list when none.", "items": { "type": "string" }, "title": "Tipped Occupation Codes", "type": "array" }, "unique_record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The IRS's id for this record, from its acknowledgement; null until the IRS answers. A form without one cannot be corrected yet.", "title": "Unique Record Id" }, "updated_at": { "description": "When the form last changed, as an ISO 8601 date-time.", "title": "Updated At", "type": "string" }, "voided": { "description": "Whether the form is marked void; a voided form cannot be corrected.", "title": "Voided", "type": "boolean" }, "voided_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the form was voided: the moment the IRS accepted the zero-amount correction filed against it. Null unless voided is true.", "title": "Voided At" } }, "required": [ "form_id", "tenant_id", "recipient_id", "batch_job_id", "payer_id", "payer_name", "payer_type", "payer_first_name", "payer_last_name", "payer_street", "payer_city", "payer_state", "payer_zip", "payer_phone", "payer_tin_on_file", "tax_year", "nonemployee_compensation", "federal_income_tax_withheld", "state_tax_withheld", "state_code", "state_income", "status", "corrected", "voided", "unique_record_id", "corrects_form_id", "corrects_unique_record_id", "correction_seq", "engine_submission_id", "environment", "error_message", "furnished_at", "furnish_method", "furnish_error", "created_at", "updated_at" ], "title": "Form1099NECResponse", "type": "object" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "PayerCreateRequest": { "properties": { "al_withholding_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Alabama withholding tax account number: below 700000, digits stored zero filled to ten; at or above it, R and nine digits such as R123456789. Carried in the Alabama 1099 file. Blank means none.", "title": "Al Withholding Account" }, "cfsf_election": { "default": false, "description": "Whether the payer elects Combined Federal/State Filing, so the IRS forwards its 1099s to participating states. Defaults to false.", "title": "Cfsf Election", "type": "boolean" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City, at most 40 characters for a US address or 50 for a foreign one. Needed before filing a US address.", "title": "City" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "IRS country code for a payer outside the US, from the IRS's own list rather than ISO (Germany is GM), upper-cased. Leave it out for a US address; when set, state and ZIP are refused.", "title": "Country" }, "ct_registration_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Connecticut Tax Registration Number, 10 or 11 digits; non-digits are dropped. Optional, since an unregistered payer may file without one.", "title": "Ct Registration Number" }, "de_withholding_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Delaware withholding account number, which is the payer's nine-digit federal EIN; a hyphen is allowed and it is stored as nine digits. Blank means none.", "title": "De Withholding Id" }, "external_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Your own reference for this payer, such as your client ID. Stored as sent and not checked for uniqueness.", "title": "External Ref" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of an individual or itin payer, used for the IRS name. Needed before filing for those payer types, and at most 20 characters at filing. Never derived from name.", "title": "First Name" }, "ga_withholding_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Georgia withholding number: seven digits then two letters, such as 1234567AB. Dashes and spaces are dropped and letters upper-cased. Blank means none.", "title": "Ga Withholding Id" }, "ia_withholding_permit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Iowa withholding permit number, 9 digits or 12 for a permit issued before November 15, 2021; hyphens and spaces are dropped. Carried in the Iowa 1099 file. Blank means none.", "title": "Ia Withholding Permit" }, "in_withholding_tid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Indiana withholding TID and location number: ten digits then the three-digit location, 13 in all, such as 0123456789 001; spaces and hyphens are dropped. Blank means none.", "title": "In Withholding Tid" }, "ky_withholding_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Kentucky withholding tax account number, 6 or 9 digits; hyphens and spaces are dropped. Carried in the Kentucky 1099 file. Blank means none.", "title": "Ky Withholding Account" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of an individual or itin payer, used for the IRS name and its name control. Needed before filing for those payer types, and at most 20 characters at filing.", "title": "Last Name" }, "md_central_registration_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Maryland Central Registration Number, the 8-digit withholding account number; not the FEIN and not the 10-digit Unemployment Insurance number. Carried in the Maryland 1099 file. Blank means none.", "title": "Md Central Registration Number" }, "name": { "description": "The payer's legal name. A business payer's 1099s file under it; for an individual or itin payer the IRS name comes from first_name and last_name and this is the display name.", "title": "Name", "type": "string" }, "nc_withholding_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "North Carolina withholding account number, nine digits; spaces and hyphens are dropped and APPLIEDFOR is refused. Blank means none.", "title": "Nc Withholding Account" }, "ne_id_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Nebraska ID number, the digits after 21- such as 21-1234567; the 21- is dropped and it is stored as nine digits zero filled. Carried in the Nebraska 1099 file. Blank means none.", "title": "Ne Id Number" }, "oh_withholding_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ohio employer withholding account number: 8 digits beginning 51 to 55; non-digits are dropped. Ohio's file does not carry it; it names the Ohio account the upload belongs to.", "title": "Oh Withholding Account" }, "or_bin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Oregon Business Identification Number, eight digits such as 1234567-8; hyphens and spaces are dropped and it is stored as eight digits. Carried in the Oregon 1099 file. Blank means none.", "title": "Or Bin" }, "pa_withholding_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pennsylvania employer withholding Account ID, 8 digits, or the 11-digit myPATH account identifier; non-digits are dropped and a 10-digit Revenue ID is refused. Blank means none.", "title": "Pa Withholding Account" }, "payer_type": { "default": "business", "description": "\"business\" (files under the business name), \"individual\" (a person, filing under first_name and last_name) or \"itin\" (a person with an ITIN). Defaults to \"business\"; any other value is refused.", "title": "Payer Type", "type": "string" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Phone number, needed before filing: 10 digits for a US payer (a leading 1 is allowed) or 7 to 15 for one abroad. Dashes, spaces, dots and parentheses are allowed; extensions are refused.", "title": "Phone" }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Postal code of a foreign address, at most 16 characters. Refused unless country is set.", "title": "Postal Code" }, "province": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Province or region of a foreign address, at most 17 characters. Refused unless country is set.", "title": "Province" }, "sc_withholding_file_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "South Carolina withholding file number, 9 digits; a hyphen is dropped. Carried in the South Carolina 1099 file. Blank means none.", "title": "Sc Withholding File Number" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Two-letter USPS state, territory or military code, upper-cased. Needed before filing a US address; refused when country is set.", "title": "State" }, "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street address, line 1, at most 35 characters. Needed before filing.", "title": "Street" }, "street2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Apartment, suite or unit, sent to the IRS as its own address line, at most 35 characters.", "title": "Street2" }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The payer's EIN, SSN or ITIN: nine digits, dashes and spaces allowed. Encrypted and never returned. An itin payer's number must have an ITIN's shape; a TIN already on another active payer is refused (409).", "title": "Tin" }, "tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of number tin is: \"ssn\", \"ein\" or \"itin\". Left out or null, it follows payer_type (business EIN, individual SSN, itin ITIN). A sole proprietor who files under their own name with an EIN is payer_type \"individual\" and tin_type \"ein\". An ITIN on a business, or an SSN on an itin payer, is refused.", "title": "Tin Type" }, "ut_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Utah withholding Account ID, 11 digits followed by WTH such as 12345678901WTH; hyphens and spaces are dropped. Carried in the Utah 1099 file. Blank means none.", "title": "Ut Account Id" }, "vt_withholding_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vermont withholding account number, WHT and eight digits; taken with or without the WHT prefix, hyphen or spaces, in any case, and stored as WHT12345678. Blank means none.", "title": "Vt Withholding Account" }, "wi_withholding_tax_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Wisconsin withholding tax number (TAN), 15 digits beginning 036; dashes are dropped. Carried in the Wisconsin 1099 file. Blank means none.", "title": "Wi Withholding Tax Number" }, "wv_account_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "West Virginia withholding account number, 8 digits; a hyphen is dropped. Carried in the West Virginia 1099 file. Blank means none.", "title": "Wv Account Number" }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ZIP code, five digits or ZIP+4 such as 12345-6789, stored as sent. Needed before filing a US address; refused when country is set.", "title": "Zip Code" } }, "required": [ "name" ], "title": "PayerCreateRequest", "type": "object" }, "PayerResponse": { "properties": { "active": { "description": "False once the payer has been removed from the roster.", "title": "Active", "type": "boolean" }, "al_withholding_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Alabama withholding tax account number, ten digits or R and nine digits; null when none is on file.", "title": "Al Withholding Account" }, "cfsf_election": { "default": false, "description": "Whether this payer has elected Combined Federal/State Filing; false unless it was turned on.", "title": "Cfsf Election", "type": "boolean" }, "cfsf_states": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "default": {}, "description": "The states the IRS forwards to under Combined Federal/State Filing, keyed by \"1099-NEC\", \"1099-MISC\" and \"1099-K\", each a list of two-letter codes. Returned whether or not the payer elected.", "title": "Cfsf States", "type": "object" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City; null when none is on file.", "title": "City" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "IRS country code of a foreign address; null for a US payer.", "title": "Country" }, "created_at": { "description": "When the payer was created, an ISO 8601 datetime with a UTC offset.", "title": "Created At", "type": "string" }, "ct_registration_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Connecticut Tax Registration Number, 10 or 11 digits; null when none is on file.", "title": "Ct Registration Number" }, "de_withholding_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Delaware withholding account number, the payer's nine-digit EIN; null when none is on file.", "title": "De Withholding Id" }, "external_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Your own reference for this payer, as sent; null when none.", "title": "External Ref" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of an individual or itin payer; null when none is on file.", "title": "First Name" }, "ga_withholding_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Georgia withholding number, seven digits then two letters, returned in full; null when none is on file.", "title": "Ga Withholding Id" }, "ia_withholding_permit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Iowa withholding permit number, 9 or 12 digits; null when none is on file.", "title": "Ia Withholding Permit" }, "in_withholding_tid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Indiana withholding TID and location number, 13 digits; null when none is on file.", "title": "In Withholding Tid" }, "ky_withholding_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Kentucky withholding tax account number, 6 or 9 digits; null when none is on file.", "title": "Ky Withholding Account" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of an individual or itin payer; null when none is on file.", "title": "Last Name" }, "md_central_registration_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Maryland Central Registration Number, 8 digits; null when none is on file.", "title": "Md Central Registration Number" }, "name": { "description": "The payer's legal name. A business payer's 1099s file under it; for an individual or itin payer it is the display name.", "title": "Name", "type": "string" }, "nc_withholding_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "North Carolina withholding account number, nine digits; null when none is on file.", "title": "Nc Withholding Account" }, "ne_id_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Nebraska ID number, nine digits zero filled; null when none is on file.", "title": "Ne Id Number" }, "oh_withholding_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Ohio employer withholding account number, 8 digits beginning 51 to 55, returned in full; null when none is on file.", "title": "Oh Withholding Account" }, "or_bin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Oregon Business Identification Number, eight digits; null when none is on file.", "title": "Or Bin" }, "pa_withholding_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pennsylvania withholding account number, 8 or 11 digits, returned in full; null when none is on file.", "title": "Pa Withholding Account" }, "payer_id": { "description": "The payer's id, a UUID string. Use it as payer_id on a form.", "title": "Payer Id", "type": "string" }, "payer_type": { "description": "\"business\", \"individual\" or \"itin\". A payer saved without one reads as \"business\".", "title": "Payer Type", "type": "string" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Phone number as sent; null when none is on file.", "title": "Phone" }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Postal code of a foreign address; null when none.", "title": "Postal Code" }, "province": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Province or region of a foreign address; null when none.", "title": "Province" }, "sc_withholding_file_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "South Carolina withholding file number, 9 digits; null when none is on file.", "title": "Sc Withholding File Number" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Two-letter USPS state code of a US address; null for a foreign address or when none is on file.", "title": "State" }, "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street address, line 1; null when none is on file.", "title": "Street" }, "street2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Apartment, suite or unit; null when none.", "title": "Street2" }, "tenant_id": { "description": "The id of the account that owns this payer, a UUID string.", "title": "Tenant Id", "type": "string" }, "tin_on_file": { "description": "True when a TIN is stored for this payer. The TIN itself is never returned.", "title": "Tin On File", "type": "boolean" }, "tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of TIN this payer holds: \"ssn\", \"ein\" or \"itin\". The TIN type saved for the payer (a sole proprietor filing under their own name may hold an EIN), otherwise what payer_type implies. The IRS record, Copy B and the state files follow it.", "title": "Tin Type" }, "tin_warning": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What the structural check of the payer's own TIN found, as a sentence; null when it found nothing or no TIN is on file. Advisory: it never blocks saving.", "title": "Tin Warning" }, "transmittable": { "description": "True when the payer has a TIN, street, phone, a complete US or foreign address, and the name its type needs. Advisory: filing checks the form itself.", "title": "Transmittable", "type": "boolean" }, "updated_at": { "description": "When the payer was last changed, an ISO 8601 datetime with a UTC offset.", "title": "Updated At", "type": "string" }, "ut_account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Utah withholding Account ID, 11 digits and WTH; null when none is on file.", "title": "Ut Account Id" }, "vt_withholding_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vermont withholding account number in the form WHT12345678; null when none is on file.", "title": "Vt Withholding Account" }, "wi_withholding_tax_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Wisconsin withholding tax number, 15 digits; null when none is on file.", "title": "Wi Withholding Tax Number" }, "wv_account_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "West Virginia withholding account number, 8 digits; null when none is on file.", "title": "Wv Account Number" }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ZIP code, five digits or ZIP+4, as sent; null for a foreign address or when none is on file.", "title": "Zip Code" } }, "required": [ "payer_id", "tenant_id", "name", "payer_type", "first_name", "last_name", "tin_on_file", "external_ref", "street", "city", "state", "zip_code", "phone", "transmittable", "active", "created_at", "updated_at" ], "title": "PayerResponse", "type": "object" }, "PayerStateObligations": { "description": "One payer's states for the tax year.", "properties": { "cfsf_election": { "description": "Whether the payer elected the Combined Federal/State Filing program.", "title": "Cfsf Election", "type": "boolean" }, "payer_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The saved payer's id, or null for a payer entered on a form without being saved.", "title": "Payer Id" }, "payer_name": { "description": "The payer's name as it appears on its forms.", "title": "Payer Name", "type": "string" }, "states": { "description": "One entry per state the payer's forms reach, in state code order.", "items": { "$ref": "#/components/schemas/StateObligationCounts" }, "title": "States", "type": "array" } }, "required": [ "payer_name", "payer_id", "cfsf_election", "states" ], "title": "PayerStateObligations", "type": "object" }, "ProductUsage": { "description": "One product a firm holds, and where it stands in its billing window.\n\nA subscription YEAR for the firm plans; the billing MONTH for the API, whose\n`included_allowance` and `price_cents` are zero and whose every accepted\nform is in `overage_count` at `overage_rate_cents` ($0.30).", "properties": { "billing_interval": { "description": "How often the product invoices, and so how long the window below is: annual for the firm plan, monthly for the API.", "enum": [ "annual", "monthly" ], "title": "Billing Interval", "type": "string" }, "included_allowance": { "description": "Accepted forms the fee covers in this window, fixed when the product was bought: 1,000 for the firm plan at today's price, 0 for the API.", "title": "Included Allowance", "type": "integer" }, "name": { "description": "The product's display name, such as \"Information Returns\" or \"API\".", "title": "Name", "type": "string" }, "overage_count": { "description": "Accepted forms beyond the allowance in this window; for the API, every accepted form this month.", "title": "Overage Count", "type": "integer" }, "overage_estimate_cents": { "description": "overage_count times overage_rate_cents, in US cents: what the overage would invoice at if filing stopped now.", "title": "Overage Estimate Cents", "type": "integer" }, "overage_rate_cents": { "description": "Price of each form beyond the allowance, in US cents, fixed when the product was bought: 25 for the firm plan, 30 for the API at today's prices.", "title": "Overage Rate Cents", "type": "integer" }, "period_end": { "description": "End of the current window, an ISO 8601 date and time; the allowance starts over after it.", "title": "Period End", "type": "string" }, "period_start": { "description": "Start of the current window (subscription year, or billing month for the API), an ISO 8601 date and time.", "title": "Period Start", "type": "string" }, "price_cents": { "description": "The product's fee for the window, in US cents: 20000 for the firm plan at today's price, 0 for the API.", "title": "Price Cents", "type": "integer" }, "pricing": { "description": "annual for the firm plan, which has a yearly fee and an allowance; usage for the API, which charges per accepted form only.", "enum": [ "annual", "usage" ], "title": "Pricing", "type": "string" }, "product": { "$ref": "#/components/schemas/TenantProduct", "description": "Which product this line is: information_returns for the firm plan or api for the API." }, "projected_total_cents": { "description": "price_cents plus overage_estimate_cents, in US cents: the window's cost so far.", "title": "Projected Total Cents", "type": "integer" }, "remaining": { "description": "Forms still inside the allowance; never below 0, and always 0 for the API.", "title": "Remaining", "type": "integer" }, "status": { "description": "The subscription's state: pending (chosen but not yet paid), active, past_due or canceled.", "title": "Status", "type": "string" }, "used_count": { "description": "Accepted forms counted in this window. Corrections and sandbox forms are free and not counted.", "title": "Used Count", "type": "integer" } }, "required": [ "product", "name", "pricing", "billing_interval", "status", "period_start", "period_end", "included_allowance", "used_count", "remaining", "overage_count", "overage_rate_cents", "overage_estimate_cents", "price_cents", "projected_total_cents" ], "title": "ProductUsage", "type": "object" }, "RecipientCreateRequest": { "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City, at most 40 characters for a US address or 50 for a foreign one.", "title": "City" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "IRS country code for a recipient outside the US, from the IRS's own list rather than ISO (Germany is GM), upper-cased. Leave it out for a US address; when set, state and ZIP are refused.", "title": "Country" }, "e_delivery_consent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "true records that the recipient consented to electronic Copy B and needs a scope and e_delivery_disclosures_shown; false records a withdrawal. Omit to record nothing. Not accepted through an API key: consent is recorded in the app only for now.", "title": "E Delivery Consent" }, "e_delivery_consent_attested": { "default": false, "description": "Must be true when e_delivery_consent turns consent on: you confirm your firm holds the recipient's own electronic consent and its record, after reading the Pub 1179 section 4.6.2 notice. Refused with 422 otherwise, through an API key too. Consent itself is recorded in the app only for now.", "title": "E Delivery Consent Attested", "type": "boolean" }, "e_delivery_consent_scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "\"until_withdrawn\" or \"single_year\". Required when e_delivery_consent is true; ignored otherwise. Not accepted through an API key: consent is recorded in the app only for now.", "title": "E Delivery Consent Scope" }, "e_delivery_consent_tax_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The tax year a single_year consent covers. Required with scope \"single_year\"; ignored for \"until_withdrawn\". Not accepted through an API key: consent is recorded in the app only for now.", "title": "E Delivery Consent Tax Year" }, "e_delivery_disclosures_shown": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Must be true to record consent: you affirm the recipient was shown the electronic-delivery disclosures before consenting. Not accepted through an API key: consent is recorded in the app only for now.", "title": "E Delivery Disclosures Shown" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where statements and requests to this recipient are emailed; not checked for format. Without one, Copy B can only go on paper.", "title": "Email" }, "external_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Your own reference for this recipient, such as your payee ID. Stored as sent; bulk imports use it to match rows to an existing recipient.", "title": "External Ref" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of an individual or itin recipient, used for the IRS name. Needed before filing for those types, and at most 20 characters at filing.", "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of an individual or itin recipient, used for the IRS name and its name control. Needed before filing for those types, and at most 20 characters at filing.", "title": "Last Name" }, "name": { "description": "The recipient's name as the roster shows it. A business recipient's 1099s file under it; an individual or itin recipient files under first_name and last_name, which are never split from it.", "title": "Name", "type": "string" }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Postal code of a foreign address, at most 16 characters. Refused unless country is set.", "title": "Postal Code" }, "province": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Province or region of a foreign address, at most 17 characters. Refused unless country is set.", "title": "Province" }, "recipient_type": { "default": "individual", "description": "\"individual\" (a person, filing under first_name and last_name), \"business\" (files under name) or \"itin\" (a person with an ITIN). Defaults to \"individual\"; any other value is refused.", "title": "Recipient Type", "type": "string" }, "services_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Two-letter code of the state where the work was done, when not the address state; anything but two letters is refused, and the address state itself is stored as null.", "title": "Services State" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Two-letter USPS state, territory or military code, upper-cased. Refused when country is set.", "title": "State" }, "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street address, line 1, at most 35 characters. Copy B is mailed here.", "title": "Street" }, "street2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Apartment, suite or unit, sent to the IRS as its own address line, at most 35 characters.", "title": "Street2" }, "tin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The recipient's SSN, ITIN or EIN: nine digits, dashes and spaces allowed. Encrypted and never returned. A TIN already on another active recipient is refused (409).", "title": "Tin" }, "tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of number tin is: \"ssn\", \"ein\" or \"itin\". Left out or null, it follows recipient_type. A W-9 answer overrides it, except that a W-9 \"ssn\" with a stated \"itin\" reads as an ITIN. A sole proprietor with an EIN is \"individual\" with tin_type \"ein\". An ITIN on a business, or an SSN on an itin recipient, is refused.", "title": "Tin Type" }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ZIP code, five digits or ZIP+4 such as 12345-6789, stored as sent. Refused when country is set.", "title": "Zip Code" } }, "required": [ "name" ], "title": "RecipientCreateRequest", "type": "object" }, "RecipientResponse": { "properties": { "active": { "description": "False once the recipient has been removed from the roster.", "title": "Active", "type": "boolean" }, "backup_withholding": { "default": false, "description": "True when the payee's Form W-9 says the IRS notified them they are subject to backup withholding; a 1099 for them is then refused unless it reports federal income tax withheld.", "title": "Backup Withholding", "type": "boolean" }, "backup_withholding_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "\"24%\" when backup_withholding is true; null otherwise.", "title": "Backup Withholding Rate" }, "business_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The business or disregarded entity name the payee gave on line 2 of Form W-9; null when none.", "title": "Business Name" }, "certification_signed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the payee signed Part II (the certification) of the W-9 on file; null when no W-9 is certified or when not filled (API-key endpoints).", "title": "Certification Signed" }, "certified_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When the payee answered the W-9 link, an ISO 8601 datetime; certified_on is its UTC day. Null for a paper W-9, when none, or when not filled (API-key endpoints).", "title": "Certified At" }, "certified_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The W-9's certification date, an ISO 8601 date: the date written on a paper form, or the day the payee answered the link. Null when none or not filled (API-key endpoints).", "title": "Certified On" }, "certified_tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "\"ssn\" or \"ein\", as the payee certified on Form W-9; null when no W-9 is on file, and the 1099 then uses the type recipient_type implies.", "title": "Certified Tin Type" }, "certified_via": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "\"electronic\" when the payee answered the W-9 link, \"paper\" when the firm recorded a paper form; null when nothing is certified or the field is not filled (API-key endpoints).", "title": "Certified Via" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City; null when none is on file.", "title": "City" }, "consent_declined_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When the recipient declined the latest electronic-delivery consent invitation, an ISO 8601 datetime; null when they did not decline it, none was sent, or not filled (API-key endpoints).", "title": "Consent Declined At" }, "consent_expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When the latest electronic-delivery consent invitation expires, an ISO 8601 datetime; null when none was sent or not filled (API-key endpoints).", "title": "Consent Expires At" }, "consent_requested_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When the latest electronic-delivery consent invitation was sent, an ISO 8601 datetime; null when none was sent or not filled (API-key endpoints).", "title": "Consent Requested At" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "IRS country code of a foreign address; null for a US recipient.", "title": "Country" }, "created_at": { "description": "When the recipient was created, an ISO 8601 datetime with a UTC offset.", "title": "Created At", "type": "string" }, "document_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the stored scan of a paper W-9, a UUID string; null otherwise or when not filled (API-key endpoints).", "title": "Document Id" }, "e_delivery_consent_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When consent to electronic Copy B was recorded, an ISO 8601 datetime; null when none was ever recorded. A withdrawal keeps it and sets e_delivery_consent_withdrawn_at.", "title": "E Delivery Consent At" }, "e_delivery_consent_attested_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When a firm user confirmed holding the recipient's own electronic consent, an ISO 8601 datetime; null for a consent the recipient gave through the link, or when none was recorded.", "title": "E Delivery Consent Attested At" }, "e_delivery_consent_attested_by_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the firm user who confirmed it. Filled on the dashboard's recipient list and detail responses; null from the API-key endpoints.", "title": "E Delivery Consent Attested By Name" }, "e_delivery_consent_scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "\"until_withdrawn\" or \"single_year\", as recorded with the consent; null when no consent was recorded.", "title": "E Delivery Consent Scope" }, "e_delivery_consent_tax_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The tax year a single_year consent covers; null for \"until_withdrawn\" or when no consent was recorded.", "title": "E Delivery Consent Tax Year" }, "e_delivery_consent_withdrawn_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When the recipient's withdrawal of consent was recorded, an ISO 8601 datetime; null when not withdrawn. A fresh consent clears it.", "title": "E Delivery Consent Withdrawn At" }, "e_delivery_disclosures_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Version of the electronic-delivery disclosures in force when consent was recorded, such as \"2026.2\"; null when no consent was recorded.", "title": "E Delivery Disclosures Version" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The recipient's email address; null when none is on file.", "title": "Email" }, "external_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Your own reference for this recipient, as sent; null when none.", "title": "External Ref" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of an individual or itin recipient; null when none is on file.", "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of an individual or itin recipient; null when none is on file.", "title": "Last Name" }, "name": { "description": "The recipient's name as the roster shows it; a business recipient's 1099s file under it.", "title": "Name", "type": "string" }, "postal_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Postal code of a foreign address; null when none.", "title": "Postal Code" }, "province": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Province or region of a foreign address; null when none.", "title": "Province" }, "recipient_id": { "description": "The recipient's id, a UUID string. Use it as recipient_id on a form.", "title": "Recipient Id", "type": "string" }, "recipient_type": { "description": "\"individual\", \"business\" or \"itin\".", "title": "Recipient Type", "type": "string" }, "recorded_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the firm user who recorded a paper W-9; null for an electronic one or when not filled (API-key endpoints).", "title": "Recorded By" }, "services_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Two-letter code of the state where the work was done; null means the same state as the address.", "title": "Services State" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Two-letter USPS state code of a US address; null for a foreign address or when none is on file.", "title": "State" }, "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street address, line 1; null when none is on file.", "title": "Street" }, "street2": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Apartment, suite or unit; null when none.", "title": "Street2" }, "tenant_id": { "description": "The id of the account that owns this recipient, a UUID string.", "title": "Tenant Id", "type": "string" }, "tin_on_file": { "description": "True when a TIN is stored for this recipient. The TIN itself is never returned.", "title": "Tin On File", "type": "boolean" }, "tin_shared_with": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "The names of the account's other active recipients holding the same TIN, oldest first; empty when none; null when not filled (API-key endpoints).", "title": "Tin Shared With" }, "tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The kind of TIN this recipient holds: \"ssn\", \"ein\" or \"itin\". The payee's Form W-9 answer when one is on file (a sole proprietor may certify an EIN), otherwise the tin_type the firm saved, otherwise what recipient_type implies. The IRS record, Copy B and the state files follow it. Null when none says.", "title": "Tin Type" }, "tin_type_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where tin_type comes from: \"w9\" (the payee's Form W-9), \"stated\" (the tin_type the firm saved) or \"implied\" (what recipient_type implies). Null when tin_type is null.", "title": "Tin Type Source" }, "updated_at": { "description": "When the recipient was last changed, an ISO 8601 datetime with a UTC offset.", "title": "Updated At", "type": "string" }, "w9_applied_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When a W-9 answered after a 1099 for this recipient was filed was applied to the recipient, each filed 1099 keeping what it filed, an ISO 8601 datetime. Null when no 1099 was filed when it arrived, while it is held, or when not filled (API-key endpoints).", "title": "W9 Applied At" }, "w9_email_sent": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the latest W-9 request was emailed to the recipient: true when the mail left, false when the link was made and not emailed (no address, link copied instead, or the mail did not leave); null when none was requested or not filled (API-key endpoints).", "title": "W9 Email Sent" }, "w9_expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When the latest W-9 link expires, an ISO 8601 datetime; null when none was sent or not filled (API-key endpoints).", "title": "W9 Expires At" }, "w9_held_different_tin": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "True when a W-9 is held because its TIN is not the one on file now. Those answers are never applied to this recipient: a different TIN is a new recipient. False otherwise; null when not filled (API-key endpoints).", "title": "W9 Held Different Tin" }, "w9_held_tin_on": { "anyOf": [ { "$ref": "#/components/schemas/W9HeldTinOn" }, { "type": "null" } ], "description": "When a W-9 with a different TIN is held for this recipient and another recipient in the account already has that TIN: that recipient's id and name. Null otherwise, and when not filled (API-key endpoints). The TIN is never returned." }, "w9_pending_update": { "anyOf": [ { "$ref": "#/components/schemas/W9PendingUpdate" }, { "type": "null" } ], "description": "A W-9 answered after a 1099 for this recipient was filed, held rather than applied; null in the ordinary case and from the API-key endpoints." }, "w9_requested_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When the latest W-9 link was sent, an ISO 8601 datetime; null when none was sent or not filled (API-key endpoints).", "title": "W9 Requested At" }, "w9_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "\"not_requested\", \"requested\", \"expired\" or \"completed\". Filled on the dashboard's recipient list and detail responses; null from the API-key endpoints.", "title": "W9 Status" }, "withdrawal_confirmation_emailed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Set only on the update that records a consent withdrawal: whether the written confirmation was emailed. False means confirm on paper; null on every other response.", "title": "Withdrawal Confirmation Emailed" }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ZIP code, five digits or ZIP+4, as sent; null for a foreign address or when none is on file.", "title": "Zip Code" } }, "required": [ "recipient_id", "tenant_id", "name", "recipient_type", "tin_on_file", "email", "external_ref", "first_name", "last_name", "street", "city", "state", "zip_code", "e_delivery_consent_at", "active", "created_at", "updated_at" ], "title": "RecipientResponse", "type": "object" }, "RegisterWebhookRequest": { "properties": { "url": { "description": "The https address to POST events to. Must be a public host; http, private and internal addresses are refused.", "format": "uri", "maxLength": 2083, "minLength": 1, "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "RegisterWebhookRequest", "type": "object" }, "StateObligationCounts": { "description": "One state's tally for one payer.", "properties": { "artifact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The newest current state file generated for this payer, state and year, or null where none has been.", "title": "Artifact Id" }, "awaiting_acceptance_forms": { "default": 0, "description": "Of the forms this row owes the state, how many are filed with the IRS and waiting for its acceptance.", "title": "Awaiting Acceptance Forms", "type": "integer" }, "cfsf_count": { "description": "Of those forms, how many the Combined Federal/State Filing election covers.", "title": "Cfsf Count", "type": "integer" }, "eligible_forms": { "default": 0, "description": "How many of the payer's forms the state's file would carry if it were generated now. Only forms the IRS has accepted count. Always 0 where generates_file is false.", "title": "Eligible Forms", "type": "integer" }, "filed_directly": { "anyOf": [ { "$ref": "#/components/schemas/DirectFilingRecordSummary" }, { "type": "null" } ], "description": "The firm's own record that it filed this state directly, where the state gets no file from SimplifyGigTax, or null where none was recorded." }, "forms": { "description": "How many of the payer's forms for the tax year reach this state.", "title": "Forms", "type": "integer" }, "generated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When that file was generated (ISO 8601 date and time, UTC), or null.", "title": "Generated At" }, "generates_file": { "default": false, "description": "True where SimplifyGigTax writes this state an upload file that carries the forms this row owes it. False where the state is filed some other way.", "title": "Generates File", "type": "boolean" }, "k_count": { "default": 0, "description": "Of those forms, how many are 1099-Ks.", "title": "K Count", "type": "integer" }, "misc_count": { "description": "Of those forms, how many are 1099-MISCs.", "title": "Misc Count", "type": "integer" }, "nec_count": { "description": "Of those forms, how many are 1099-NECs.", "title": "Nec Count", "type": "integer" }, "none_count": { "description": "Of those forms, how many owe the state nothing.", "title": "None Count", "type": "integer" }, "not_filed_forms": { "default": 0, "description": "Of the forms this row owes the state, how many are not filed with the IRS: drafts and forms the IRS rejected.", "title": "Not Filed Forms", "type": "integer" }, "number_changed": { "default": false, "description": "True where the file is out of date because the payer's account number with the state changed after it was generated.", "title": "Number Changed", "type": "boolean" }, "reason": { "description": "The sentence behind state_filing, from the state's own publication.", "title": "Reason", "type": "string" }, "stale": { "default": false, "description": "True where a form that belongs in the state's file changed after the file was generated. Generate the file again before uploading it.", "title": "Stale", "type": "boolean" }, "stale_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The sentence that says what changed, or null when not stale.", "title": "Stale Reason" }, "state": { "description": "Two-letter state code.", "title": "State", "type": "string" }, "state_file_count": { "description": "Of those forms, how many owe the state its own return.", "title": "State File Count", "type": "integer" }, "state_filing": { "description": "The strongest answer across the payer's forms for this state: \"state_file\" if any form owes the state a return, else \"cfsf\" if the Combined Federal/State Filing election covers any, else \"none\".", "title": "State Filing", "type": "string" } }, "required": [ "state", "state_filing", "reason", "forms", "none_count", "cfsf_count", "state_file_count", "nec_count", "misc_count" ], "title": "StateObligationCounts", "type": "object" }, "StateObligationsResponse": { "description": "Per payer, per state, for one tax year.", "properties": { "forms_counted": { "description": "How many 1099 forms of the tax year were read, whatever their status.", "title": "Forms Counted", "type": "integer" }, "forms_outside_guide_states": { "description": "Forms whose recipient is in none of the fifty states or the District of Columbia: no state on record, or a territory.", "title": "Forms Outside Guide States", "type": "integer" }, "guide_states": { "description": "The states SimplifyGigTax writes a filing guide for. Every state answers in payers.", "items": { "type": "string" }, "title": "Guide States", "type": "array" }, "payers": { "description": "One entry per payer with a form that reaches a state, ordered by payer name.", "items": { "$ref": "#/components/schemas/PayerStateObligations" }, "title": "Payers", "type": "array" }, "tax_year": { "description": "The tax year answered.", "title": "Tax Year", "type": "integer" } }, "required": [ "tax_year", "guide_states", "payers", "forms_counted", "forms_outside_guide_states" ], "title": "StateObligationsResponse", "type": "object" }, "TenantProduct": { "description": "The things a firm can buy. A firm may hold either, both, or neither.", "enum": [ "information_returns", "api" ], "title": "TenantProduct", "type": "string" }, "UpdateKeyRequest": { "properties": { "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When the key should stop working, an ISO 8601 date and time. Send null to remove the expiry; leave it out to keep the current one.", "title": "Expires At" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A new name for the key. Leave it out or send null to keep the current one.", "title": "Label" } }, "title": "UpdateKeyRequest", "type": "object" }, "ValidationError": { "properties": { "ctx": { "title": "Context", "type": "object" }, "input": { "title": "Input" }, "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Location", "type": "array" }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" }, "W9HeldTinOn": { "description": "The recipient that already holds a held W-9's different TIN.", "properties": { "name": { "description": "That recipient's name.", "title": "Name", "type": "string" }, "recipient_id": { "description": "That recipient's id, a UUID string.", "title": "Recipient Id", "type": "string" } }, "required": [ "recipient_id", "name" ], "title": "W9HeldTinOn", "type": "object" }, "W9PendingUpdate": { "description": "A completed W-9 whose answers were NOT applied to the recipient.\n\nReview 2026-09-28, R9. The payee answered after a 1099 under this recipient\nwas already with the IRS, and that form was filed under the TIN, name and\naddress on the recipient now. Changing them in place would make Copy B and\nany resend disagree with what the IRS holds, so the answers are held. A\ncorrection files them: it keeps its own copy of the recipient with the held\nTIN type, name and address laid over it (`api/recipient_snapshot.py`), and\nthe filed number, which never changes on a correction. The TIN is never\nreturned. `tin_differs` says the payee certified a DIFFERENT number: then a\ncorrection of this recipient files none of these answers, and the new number\nis filed as a correction for a new recipient (the firm adds the recipient\nand names it as `recipient_id` on the correction request). Answers for the\nTIN on file are held only until they are applied to the recipient.", "properties": { "business_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The business or disregarded entity name from line 2 of the W-9; null when none.", "title": "Business Name" }, "certified_tin_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "\"ssn\" or \"ein\", as the payee certified.", "title": "Certified Tin Type" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City the payee gave.", "title": "City" }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name the payee gave; null for a business.", "title": "First Name" }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name the payee gave; null for a business.", "title": "Last Name" }, "message": { "default": "This contractor completed a W-9 after a 1099 for them was filed. Its answers are being applied, and that 1099 keeps what the IRS received.", "description": "A sentence for display, chosen by tin_differs. When false: the answers are being applied, and the filed 1099 keeps what the IRS received. When true: its TIN, name and address were not applied, and if that TIN is right the 1099 is corrected onto a recipient with it.", "title": "Message", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name the payee certified on line 1 of the W-9.", "title": "Name" }, "received_at": { "description": "When the payee's W-9 answers arrived and were held, an ISO 8601 datetime.", "title": "Received At", "type": "string" }, "recipient_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "\"individual\" or \"business\", from the tax classification the payee chose.", "title": "Recipient Type" }, "services_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "State where the payee said the work was done; null when it is the address state.", "title": "Services State" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Two-letter state code the payee gave, upper-cased.", "title": "State" }, "street": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street address the payee gave.", "title": "Street" }, "tin_differs": { "default": false, "description": "True when the certified TIN differs from the one on file. A correction of this recipient keeps the filed TIN and files none of these answers; the different TIN is filed by a correction onto a recipient with it, named by recipient_id on the correction request. The TIN itself is never returned.", "title": "Tin Differs", "type": "boolean" }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ZIP code the payee gave.", "title": "Zip Code" } }, "required": [ "received_at" ], "title": "W9PendingUpdate", "type": "object" }, "WebhookDeliveryResponse": { "properties": { "attempt_num": { "description": "How many times it has been sent, from 1 to 5. Failed sends are retried after 1, 5, 15 and 60 minutes.", "title": "Attempt Num", "type": "integer" }, "created_at": { "description": "When the event was first queued for this endpoint, an ISO 8601 date and time.", "title": "Created At", "type": "string" }, "delivered_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When your endpoint accepted the delivery with a 2xx, an ISO 8601 date and time; null until then.", "title": "Delivered At" }, "delivery_id": { "description": "This delivery's id, a UUID string. Retries reuse the same delivery.", "title": "Delivery Id", "type": "string" }, "endpoint_id": { "description": "The endpoint the delivery was sent to, a UUID string.", "title": "Endpoint Id", "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why the latest attempt failed, such as \"HTTP 500\" or a connection error; null once delivered.", "title": "Error" }, "event_type": { "description": "The event delivered: filing.accepted, filing.rejected, filing.error, info_return.accepted or info_return.rejected.", "title": "Event Type", "type": "string" }, "filing_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The transmission's id for a filing.* event; null for an info_return.* event, whose payload carries the form instead.", "title": "Filing Id" }, "response_status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The HTTP status your endpoint returned on the latest attempt; null when no response arrived.", "title": "Response Status" }, "status": { "description": "pending (sent or awaiting a retry), delivered (your endpoint answered 2xx) or failed (all attempts used, or the address was refused).", "title": "Status", "type": "string" } }, "required": [ "delivery_id", "endpoint_id", "filing_id", "event_type", "attempt_num", "status", "response_status", "delivered_at", "error", "created_at" ], "title": "WebhookDeliveryResponse", "type": "object" }, "WebhookEndpointResponse": { "properties": { "active": { "description": "Whether the endpoint receives deliveries; deleting an endpoint deactivates it, and only active endpoints are listed.", "title": "Active", "type": "boolean" }, "created_at": { "description": "When the endpoint was registered, an ISO 8601 date and time.", "title": "Created At", "type": "string" }, "endpoint_id": { "description": "The endpoint's id, a UUID string.", "title": "Endpoint Id", "type": "string" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The signing secret, returned only when the endpoint is registered and null after. Each delivery's X-SGT-Signature is t=,v1=, the hex HMAC-SHA256 under it of t, a period and the raw body.", "title": "Secret" }, "url": { "description": "The address deliveries are POSTed to.", "title": "Url", "type": "string" } }, "required": [ "endpoint_id", "url", "active", "created_at" ], "title": "WebhookEndpointResponse", "type": "object" }, "WebhookTestRequest": { "properties": { "url": { "description": "The public https address to send a test delivery to. Signed with that endpoint's secret when it matches a registered endpoint exactly; otherwise sent unsigned.", "format": "uri", "maxLength": 2083, "minLength": 1, "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "WebhookTestRequest", "type": "object" }, "WebhookTestResponse": { "properties": { "delivered": { "description": "True when your address answered every test POST with a 2xx; sending stops at the first failure.", "title": "Delivered", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The connection error when the address could not be reached; null whenever a response came back.", "title": "Error" }, "status_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The HTTP status of the last test POST; null when the address could not be reached.", "title": "Status Code" } }, "required": [ "delivered", "status_code", "error" ], "title": "WebhookTestResponse", "type": "object" }, "api__routes__billing__BillingPortalResponse": { "description": "Where to send the account owner. Short-lived and single-purpose: the URL\ncarries its own Stripe session, so it is not something to cache or email.", "properties": { "url": { "description": "Stripe Customer Portal link where the account owner manages payment method, invoices and subscriptions. Short-lived; do not cache or share it.", "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "BillingPortalResponse", "type": "object" }, "api__routes__billing__CheckoutRequest": { "properties": { "cancel_url": { "description": "Where Stripe sends the buyer who leaves checkout without paying; nothing is granted or charged.", "title": "Cancel Url", "type": "string" }, "product": { "$ref": "#/components/schemas/TenantProduct", "description": "What to buy: information_returns ($200 a year with 1,000 accepted forms, then $0.25 a form) or api ($0.30 per accepted form, billed monthly)." }, "success_url": { "description": "Where Stripe sends the buyer after paying. The product is granted when Stripe confirms the payment, not by this redirect.", "title": "Success Url", "type": "string" } }, "required": [ "product", "success_url", "cancel_url" ], "title": "CheckoutRequest", "type": "object" }, "api__routes__billing__CheckoutResponse": { "properties": { "checkout_url": { "description": "The Stripe Checkout page to send the buyer to.", "title": "Checkout Url", "type": "string" }, "customer_id": { "description": "Stripe's customer id for your account, created on your first checkout and reused after.", "title": "Customer Id", "type": "string" }, "session_id": { "description": "Stripe's id for this Checkout session.", "title": "Session Id", "type": "string" } }, "required": [ "checkout_url", "session_id", "customer_id" ], "title": "CheckoutResponse", "type": "object" }, "api__routes__billing__UsageResponse": { "properties": { "products": { "description": "One line per product your account has chosen, oldest first, including pending and canceled ones; empty when you have none.", "items": { "$ref": "#/components/schemas/ProductUsage" }, "title": "Products", "type": "array" }, "projected_total_cents": { "description": "Every product's projected_total_cents added up, in US cents; 0 when you hold no product.", "title": "Projected Total Cents", "type": "integer" }, "tenant_id": { "description": "Your account's id, a UUID string.", "title": "Tenant Id", "type": "string" } }, "required": [ "tenant_id", "products", "projected_total_cents" ], "title": "UsageResponse", "type": "object" }, "api__routes__keys__CreateKeyResponse": { "properties": { "api_key": { "description": "The full key, shown only in this response and never again. Starts with sgt_test_ in the sandbox and sgt_live_ live; send it in the X-API-Key header.", "title": "Api Key", "type": "string" }, "id": { "description": "The new key's id, a UUID string; use it to rename, expire or revoke the key.", "title": "Id", "type": "string" }, "message": { "description": "A fixed reminder to store the key now, because it is not shown again.", "title": "Message", "type": "string" }, "prefix": { "description": "The key's first characters, sgt_test_ or sgt_live_ plus eight more, safe to show in listings to tell keys apart.", "title": "Prefix", "type": "string" }, "scope": { "description": "The key's access level; a key created here is always user.", "title": "Scope", "type": "string" } }, "required": [ "id", "api_key", "prefix", "scope", "message" ], "title": "CreateKeyResponse", "type": "object" }, "api__routes__keys__KeySummary": { "properties": { "created_at": { "description": "When the key was created, an ISO 8601 date and time.", "title": "Created At", "type": "string" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "When the key stops working, an ISO 8601 date and time; null when it never expires.", "title": "Expires At" }, "id": { "description": "The key's id, a UUID string.", "title": "Id", "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Your name for the key; null when none was set.", "title": "Label" }, "prefix": { "description": "The key's first characters, sgt_test_ or sgt_live_ plus eight more. The full key is never returned after creation.", "title": "Prefix", "type": "string" }, "scope": { "description": "The key's access level, such as user, which every key created through this API has.", "title": "Scope", "type": "string" } }, "required": [ "id", "prefix", "scope", "label", "expires_at", "created_at" ], "title": "KeySummary", "type": "object" }, "api__routes__usage__UsageResponse": { "properties": { "counts_by_status": { "additionalProperties": { "type": "integer" }, "description": "Your 1099 transmissions to the IRS counted by status, such as {\"accepted\": 3}, for all time. Drafts are not counted.", "title": "Counts By Status", "type": "object" }, "mode": { "description": "The account's environment: sandbox or production.", "title": "Mode", "type": "string" }, "tenant_id": { "description": "Your account's id, a UUID string.", "title": "Tenant Id", "type": "string" }, "total_filings": { "description": "The sum of counts_by_status: every transmission except drafts.", "title": "Total Filings", "type": "integer" } }, "required": [ "tenant_id", "mode", "counts_by_status", "total_filings" ], "title": "UsageResponse", "type": "object" } }, "securitySchemes": { "APIKeyHeader": { "description": "Tenant API key. Send as `X-API-Key: sgt_live_…` (or `sgt_test_…` for a sandbox tenant). The key resolves the tenant; a sandbox tenant's key reaches only sandbox behavior and only that tenant's data.", "in": "header", "name": "X-API-Key", "type": "apiKey" } } }, "info": { "title": "SimplifyGigTax API", "version": "0.1.0" }, "openapi": "3.1.0", "paths": { "/billing/checkout": { "post": { "operationId": "create_billing_checkout_billing_checkout_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routes__billing__CheckoutRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routes__billing__CheckoutResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Start a checkout for a product", "tags": [ "Billing" ] } }, "/billing/history": { "get": { "operationId": "billing_history_billing_history_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/BillingPeriod" }, "title": "Response Billing History Billing History Get", "type": "array" } } }, "description": "Successful Response" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "List past billing periods", "tags": [ "Billing" ] } }, "/billing/portal": { "post": { "operationId": "billing_portal_billing_portal_post", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routes__billing__BillingPortalResponse" } } }, "description": "Successful Response" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Open the billing portal", "tags": [ "Billing" ] } }, "/billing/usage": { "get": { "operationId": "billing_usage_billing_usage_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routes__billing__UsageResponse" } } }, "description": "Successful Response" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Show each product's usage and charges", "tags": [ "Billing" ] } }, "/info-returns": { "get": { "operationId": "api_list_1099_info_returns_get", "parameters": [ { "description": "How many to return: 50 when left out, from 1 to 200.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "description": "How many to return: 50 when left out, from 1 to 200.", "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "How many to skip, for paging; 0 when left out.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "description": "How many to skip, for paging; 0 when left out.", "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Form1099NECResponse" }, "title": "Response Api List 1099 Info Returns Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "List 1099-NECs", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-k": { "get": { "operationId": "api_list_1099k_info_returns_1099_k_get", "parameters": [ { "description": "How many to return: 50 when left out, from 1 to 200.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "description": "How many to return: 50 when left out, from 1 to 200.", "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "How many to skip, for paging; 0 when left out.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "description": "How many to skip, for paging; 0 when left out.", "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Form1099KResponse" }, "title": "Response Api List 1099K Info Returns 1099 K Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "List 1099-Ks", "tags": [ "Info Returns (1099-NEC)" ] }, "post": { "operationId": "api_create_1099k_info_returns_1099_k_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099KCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099KResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Create and file a 1099-K", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-k/bulk": { "post": { "operationId": "api_bulk_1099k_info_returns_1099_k_bulk_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_api_bulk_1099k_info_returns_1099_k_bulk_post" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkKResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Import 1099-Ks from a CSV file", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-k/{form_id}": { "get": { "operationId": "api_get_1099k_info_returns_1099_k__form_id__get", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099KResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Get a 1099-K", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-k/{form_id}/chain": { "get": { "operationId": "api_get_1099k_chain_info_returns_1099_k__form_id__chain_get", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099KChainResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Get a 1099-K's correction chain", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-k/{form_id}/correct": { "post": { "operationId": "api_correct_1099k_info_returns_1099_k__form_id__correct_post", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099KCorrectRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099KResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Correct an accepted 1099-K", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-k/{form_id}/resend": { "post": { "operationId": "api_resend_1099k_info_returns_1099_k__form_id__resend_post", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099KResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Resend a 1099-K the IRS answered Not Found for", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-k/{form_id}/submit": { "post": { "operationId": "api_submit_1099k_info_returns_1099_k__form_id__submit_post", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099KResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "File a 1099-K draft or resend a rejected one", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-misc": { "get": { "operationId": "api_list_1099misc_info_returns_1099_misc_get", "parameters": [ { "description": "How many to return: 50 when left out, from 1 to 200.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "description": "How many to return: 50 when left out, from 1 to 200.", "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "How many to skip, for paging; 0 when left out.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "description": "How many to skip, for paging; 0 when left out.", "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Form1099MISCResponse" }, "title": "Response Api List 1099Misc Info Returns 1099 Misc Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "List 1099-MISCs", "tags": [ "Info Returns (1099-NEC)" ] }, "post": { "operationId": "api_create_1099misc_info_returns_1099_misc_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099MISCCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099MISCResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Create and file a 1099-MISC", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-misc/bulk": { "post": { "operationId": "api_bulk_1099misc_info_returns_1099_misc_bulk_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_api_bulk_1099misc_info_returns_1099_misc_bulk_post" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkMISCResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Import 1099-MISCs from a CSV file", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-misc/{form_id}": { "get": { "operationId": "api_get_1099misc_info_returns_1099_misc__form_id__get", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099MISCResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Get a 1099-MISC", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-misc/{form_id}/chain": { "get": { "operationId": "api_get_1099misc_chain_info_returns_1099_misc__form_id__chain_get", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099MISCChainResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Get a 1099-MISC's correction chain", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-misc/{form_id}/correct": { "post": { "operationId": "api_correct_1099misc_info_returns_1099_misc__form_id__correct_post", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099MISCCorrectRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099MISCResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Correct an accepted 1099-MISC", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-misc/{form_id}/resend": { "post": { "operationId": "api_resend_1099misc_info_returns_1099_misc__form_id__resend_post", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099MISCResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Resend a 1099-MISC the IRS answered Not Found for", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-misc/{form_id}/submit": { "post": { "operationId": "api_submit_1099misc_info_returns_1099_misc__form_id__submit_post", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099MISCResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "File a 1099-MISC draft or resend a rejected one", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-nec": { "post": { "operationId": "api_create_1099_info_returns_1099_nec_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099NECCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099NECResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Create and file a 1099-NEC", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-nec/bulk": { "post": { "operationId": "api_bulk_1099_info_returns_1099_nec_bulk_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_api_bulk_1099_info_returns_1099_nec_bulk_post" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Import 1099-NECs from a CSV file", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-nec/{form_id}/correct": { "post": { "operationId": "api_correct_1099_info_returns_1099_nec__form_id__correct_post", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099NECCorrectRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099NECResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Correct an accepted 1099-NEC", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-nec/{form_id}/resend": { "post": { "operationId": "api_resend_1099_info_returns_1099_nec__form_id__resend_post", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099NECResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Resend a 1099-NEC the IRS answered Not Found for", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/1099-nec/{form_id}/submit": { "post": { "operationId": "api_submit_1099_info_returns_1099_nec__form_id__submit_post", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099NECResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "File a 1099-NEC draft or resend a rejected one", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/{form_id}": { "get": { "operationId": "api_get_1099_info_returns__form_id__get", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099NECResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Get a 1099-NEC", "tags": [ "Info Returns (1099-NEC)" ] } }, "/info-returns/{form_id}/chain": { "get": { "operationId": "api_get_1099_chain_info_returns__form_id__chain_get", "parameters": [ { "in": "path", "name": "form_id", "required": true, "schema": { "format": "uuid", "title": "Form Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form1099NECChainResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Get a 1099-NEC's correction chain", "tags": [ "Info Returns (1099-NEC)" ] } }, "/keys": { "get": { "operationId": "list_keys_keys_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/api__routes__keys__KeySummary" }, "title": "Response List Keys Keys Get", "type": "array" } } }, "description": "Successful Response" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "List API keys", "tags": [ "API Keys" ] }, "post": { "operationId": "create_key_keys_post", "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routes__keys__CreateKeyResponse" } } }, "description": "Successful Response" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Create an API key", "tags": [ "API Keys" ] } }, "/keys/{key_id}": { "delete": { "operationId": "revoke_key_keys__key_id__delete", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "format": "uuid", "title": "Key Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Revoke an API key", "tags": [ "API Keys" ] }, "patch": { "operationId": "update_key_keys__key_id__patch", "parameters": [ { "in": "path", "name": "key_id", "required": true, "schema": { "format": "uuid", "title": "Key Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateKeyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routes__keys__KeySummary" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Change an API key's label or expiry", "tags": [ "API Keys" ] } }, "/payers": { "get": { "operationId": "api_list_payers_payers_get", "parameters": [ { "description": "Only records whose name or external_ref contains this text, ignoring case.", "in": "query", "name": "search", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Only records whose name or external_ref contains this text, ignoring case.", "title": "Search" } }, { "description": "How many to return: 50 when left out, from 1 to 200.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "description": "How many to return: 50 when left out, from 1 to 200.", "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "How many to skip, for paging; 0 when left out.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "description": "How many to skip, for paging; 0 when left out.", "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PayerResponse" }, "title": "Response Api List Payers Payers Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "List payers", "tags": [ "Info Returns (1099-NEC)" ] }, "post": { "operationId": "api_create_payer_payers_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayerCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayerResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Save a payer", "tags": [ "Info Returns (1099-NEC)" ] } }, "/recipients": { "get": { "operationId": "api_list_recipients_recipients_get", "parameters": [ { "description": "Only records whose name or external_ref contains this text, ignoring case.", "in": "query", "name": "search", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Only records whose name or external_ref contains this text, ignoring case.", "title": "Search" } }, { "description": "How many to return: 50 when left out, from 1 to 200.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "description": "How many to return: 50 when left out, from 1 to 200.", "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "How many to skip, for paging; 0 when left out.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "description": "How many to skip, for paging; 0 when left out.", "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RecipientResponse" }, "title": "Response Api List Recipients Recipients Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "List recipients", "tags": [ "Info Returns (1099-NEC)" ] }, "post": { "operationId": "api_create_recipient_recipients_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Save a recipient", "tags": [ "Info Returns (1099-NEC)" ] } }, "/state-files/package": { "get": { "operationId": "api_state_package_state_files_package_get", "parameters": [ { "description": "The saved payer.", "in": "query", "name": "payer_id", "required": true, "schema": { "description": "The saved payer.", "format": "uuid", "title": "Payer Id", "type": "string" } }, { "description": "Two-letter state code, for example PA.", "in": "query", "name": "state", "required": true, "schema": { "description": "Two-letter state code, for example PA.", "maxLength": 2, "minLength": 2, "title": "State", "type": "string" } }, { "description": "The tax year. Left out, 2026.", "in": "query", "name": "tax_year", "required": false, "schema": { "default": 2026, "description": "The tax year. Left out, 2026.", "maximum": 2100, "minimum": 2000, "title": "Tax Year", "type": "integer" } } ], "responses": { "200": { "content": { "application/zip": { "schema": { "format": "binary", "type": "string" } } }, "description": "A zip of every current upload file for the payer, state and tax year, each under its stored name: the income records first, then any transmittal. Content-Disposition names the zip." }, "404": { "description": "payer_id is not a saved payer of this account, or the payer has no current file for this state and tax year." }, "410": { "description": "A stored file is missing." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Download a payer's state 1099 upload files as one zip", "tags": [ "States (1099)" ] } }, "/state-obligations": { "get": { "operationId": "api_state_obligations_state_obligations_get", "parameters": [ { "description": "The tax year to answer for.", "in": "query", "name": "tax_year", "required": true, "schema": { "description": "The tax year to answer for.", "maximum": 2100, "minimum": 2000, "title": "Tax Year", "type": "integer" } }, { "description": "Only this saved payer. Left out, every payer with a form that reaches a state. forms_counted and forms_outside_guide_states then count this payer's forms only.", "in": "query", "name": "payer_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "Only this saved payer. Left out, every payer with a form that reaches a state. forms_counted and forms_outside_guide_states then count this payer's forms only.", "title": "Payer Id" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateObligationsResponse" } } }, "description": "Successful Response" }, "404": { "description": "payer_id is not a saved payer of this account." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Which states each payer owes a 1099 return to", "tags": [ "States (1099)" ] } }, "/usage": { "get": { "operationId": "get_usage_usage_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routes__usage__UsageResponse" } } }, "description": "Successful Response" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Count filings by status", "tags": [ "Usage" ] } }, "/webhooks": { "get": { "operationId": "list_webhooks_webhooks_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/WebhookEndpointResponse" }, "title": "Response List Webhooks Webhooks Get", "type": "array" } } }, "description": "Successful Response" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "List webhook endpoints", "tags": [ "Webhooks" ] }, "post": { "operationId": "register_webhook_webhooks_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterWebhookRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Register a webhook endpoint", "tags": [ "Webhooks" ] } }, "/webhooks/test": { "post": { "operationId": "test_webhook_webhooks_test_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookTestRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookTestResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Send a test delivery", "tags": [ "Webhooks" ] } }, "/webhooks/{endpoint_id}": { "delete": { "operationId": "delete_webhook_webhooks__endpoint_id__delete", "parameters": [ { "in": "path", "name": "endpoint_id", "required": true, "schema": { "format": "uuid", "title": "Endpoint Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "Deactivate a webhook endpoint", "tags": [ "Webhooks" ] } }, "/webhooks/{endpoint_id}/deliveries": { "get": { "operationId": "list_deliveries_webhooks__endpoint_id__deliveries_get", "parameters": [ { "in": "path", "name": "endpoint_id", "required": true, "schema": { "format": "uuid", "title": "Endpoint Id", "type": "string" } }, { "description": "How many to return, newest first: 50 when left out, from 1 to 200.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "description": "How many to return, newest first: 50 when left out, from 1 to 200.", "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } }, { "description": "How many to skip, for paging; 0 when left out.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "description": "How many to skip, for paging; 0 when left out.", "minimum": 0, "title": "Offset", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/WebhookDeliveryResponse" }, "title": "Response List Deliveries Webhooks Endpoint Id Deliveries Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "APIKeyHeader": [] } ], "summary": "List deliveries for a webhook endpoint", "tags": [ "Webhooks" ] } } }, "servers": [ { "url": "https://simplifygigtax.com/api" } ] }