Server definition
- Hash
- sha256:85f4e80b1a3fff33d18732aade937aec26b35673153e7d908b4e46e43c8f8c4e
- What it is
- What a remote MCP server returned when asked what it offers: 16 tools
The blob, as servednamed by its sha256
{
"instructions": "Issue, consult and cancel Brazilian fiscal documents\nthrough the Stackin API: NFS-e for services and NF-e for goods. Every amount\nis in BRL.\n\nCorrection letters, numbering invalidation and recipient manifestations are\nNF-e only — an NFS-e has none of them, and a wrong one there is cancelled and\nissued again.\n\nAn NF-e needs an ncm and a cfop on every item and a complete recipient\naddress; the SEFAZ refuses a partial one. Never infer either code — they\ndecide the tax owed.\n\nAn issued document is legally binding: confirm the data with the user\nrather than inferring it.",
"tools": [
{
"description": "Cancel an authorized invoice.\n\nLegal cancellation, with fiscal and accounting effect, inside a window\nthe NFS-e authorizer enforces for the municipality. Ask the human to confirm before calling; never call it\nspeculatively. The reason reaches the tax authority verbatim and must\nbe at least 15 characters.\n\nPass idempotency_key to make a retry safe: repeating the same key with\nthe same access key and reason replays the first answer instead of\ncancelling a second time. Reuse the key only when retrying that exact\ncall; a genuinely new cancellation needs a new key, or none. Nothing\ngenerates one for you — two calls without a key are two cancellations.\n",
"inputSchema": {
"properties": {
"access_key": {
"title": "Access Key",
"type": "string"
},
"document_type": {
"enum": [
"nfse",
"nfe"
],
"title": "Document Type",
"type": "string"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Idempotency Key"
},
"reason": {
"maxLength": 256,
"minLength": 15,
"title": "Reason",
"type": "string"
}
},
"required": [
"access_key",
"document_type",
"reason"
],
"title": "cancel_invoiceArguments",
"type": "object"
},
"name": "cancel_invoice",
"outputSchema": {
"additionalProperties": true,
"description": "One document, as the fiscal API describes it.",
"properties": {
"access_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The authorizer's key. Absent while the document is not authorized.",
"title": "Access Key"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Local id. Use it for reissue and for submissions, and when a document was rejected and has no key.",
"title": "Id"
},
"protocol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The authorization protocol, when granted.",
"title": "Protocol"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "issued, rejected or cancelled.",
"title": "Status"
}
},
"title": "InvoiceResult",
"type": "object"
}
},
{
"description": "Look up an invoice's current status by its access key.\n\nRead-only: it never changes the document.\n",
"inputSchema": {
"properties": {
"access_key": {
"title": "Access Key",
"type": "string"
},
"document_type": {
"enum": [
"nfse",
"nfe"
],
"title": "Document Type",
"type": "string"
}
},
"required": [
"access_key",
"document_type"
],
"title": "consult_invoiceArguments",
"type": "object"
},
"name": "consult_invoice",
"outputSchema": {
"additionalProperties": true,
"description": "One document, as the fiscal API describes it.",
"properties": {
"access_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The authorizer's key. Absent while the document is not authorized.",
"title": "Access Key"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Local id. Use it for reissue and for submissions, and when a document was rejected and has no key.",
"title": "Id"
},
"protocol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The authorization protocol, when granted.",
"title": "Protocol"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "issued, rejected or cancelled.",
"title": "Status"
}
},
"title": "InvoiceResult",
"type": "object"
}
},
{
"description": "File an electronic correction letter (CC-e) against an NF-e.\n\nNF-e only: there is no correction letter for an NFS-e, where a wrong\ndocument is cancelled and issued again.\n\nIt corrects wording and non-fiscal fields only. It cannot change\nvalues, taxes, the recipient or the products — those still require\ncancelling and issuing again, and telling the user a CC-e will fix\nan amount is wrong in a way they only discover at an audit.\n\nEach letter supersedes the previous one and the SEFAZ keeps at most\n20 per document. The text reaches the tax authority verbatim.\n",
"inputSchema": {
"properties": {
"access_key": {
"title": "Access Key",
"type": "string"
},
"correction": {
"maxLength": 1000,
"minLength": 15,
"title": "Correction",
"type": "string"
}
},
"required": [
"access_key",
"correction"
],
"title": "correct_invoiceArguments",
"type": "object"
},
"name": "correct_invoice",
"outputSchema": {
"additionalProperties": true,
"description": "One document, as the fiscal API describes it.",
"properties": {
"access_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The authorizer's key. Absent while the document is not authorized.",
"title": "Access Key"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Local id. Use it for reissue and for submissions, and when a document was rejected and has no key.",
"title": "Id"
},
"protocol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The authorization protocol, when granted.",
"title": "Protocol"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "issued, rejected or cancelled.",
"title": "Status"
}
},
"title": "InvoiceResult",
"type": "object"
}
},
{
"description": "Return the printable rendering of a document, as a PDF.\n\nWorks for both types — a DANFE for nfe, a DANFSe for nfse. The PDF\ncomes back base64-encoded in content_base64; the XML, not this, is\nthe legally valid document. A 502 from here means the authorizer is\nunavailable, not that the invoice is wrong.\n",
"inputSchema": {
"properties": {
"access_key": {
"title": "Access Key",
"type": "string"
},
"document_type": {
"enum": [
"nfse",
"nfe"
],
"title": "Document Type",
"type": "string"
}
},
"required": [
"access_key",
"document_type"
],
"title": "get_invoice_pdfArguments",
"type": "object"
},
"name": "get_invoice_pdf",
"outputSchema": {
"description": "A printed document, base64-encoded because a tool answer is JSON.",
"properties": {
"access_key": {
"title": "Access Key",
"type": "string"
},
"content_base64": {
"description": "The PDF bytes, base64-encoded. Decode before saving.",
"title": "Content Base64",
"type": "string"
},
"content_type": {
"default": "application/pdf",
"title": "Content Type",
"type": "string"
}
},
"required": [
"access_key",
"content_base64"
],
"title": "InvoicePdf",
"type": "object"
}
},
{
"description": "Show every attempt made for one invoice and what came back.\n\nThis is the tool that answers \"why was it rejected\". consult_invoice\ngives the status; this gives the tax authority's own code, its\nmessage, and the request and response exactly as they went over the\nwire. Read-only.\n\nIt takes the invoice_id, like reissue_invoice — a rejected document\nhas no access key to look it up by. Get the id from list_invoices.\n\nThe rows are attempts, not documents: a reissued invoice has more\nthan one, oldest first, and only the last describes the current\nstate. Quote the authority's message rather than paraphrasing it;\nthe code is what the user will search for.\n",
"inputSchema": {
"properties": {
"invoice_id": {
"title": "Invoice Id",
"type": "string"
}
},
"required": [
"invoice_id"
],
"title": "get_invoice_submissionsArguments",
"type": "object"
},
"name": "get_invoice_submissions",
"outputSchema": {
"$defs": {
"SubmissionAttempt": {
"additionalProperties": true,
"description": "One transmission attempt, and what the authorizer answered.\n\nThis is where a rejection's reason lives: `detail` carries the tax\nauthority's own words, and `raw_response` its full answer.",
"properties": {
"access_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Access Key"
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"detail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The authorizer's message. The reason a document was rejected, in its own words.",
"title": "Detail"
},
"environment": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "homologation or production.",
"title": "Environment"
},
"http_status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Http Status"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"raw_request": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Raw Request"
},
"raw_response": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Raw Response"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"title": "SubmissionAttempt",
"type": "object"
}
},
"additionalProperties": true,
"description": "Every attempt made for one document, oldest first.\n\nOnly the last attempt describes the current state; the earlier ones\nare why it got there.",
"properties": {
"attempts": {
"items": {
"$ref": "#/$defs/SubmissionAttempt"
},
"title": "Attempts",
"type": "array"
},
"invoice_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invoice Id"
}
},
"title": "SubmissionList",
"type": "object"
}
},
{
"description": "Declare an NF-e numbering range reserved but never used.\n\nNF-e numbering has to be continuous, so a gap left by a failed\nissuance is explained to the SEFAZ with this — not with a new\ndocument. Irreversible: a number declared unused can never be used.\n\nOnly for numbers that were never authorized. An authorized document\nis cancelled, never invalidated. Confirm the range with the user and\nread it back before calling: the range is inclusive, and one digit\nwrong burns numbers the company still needs.\n\nThe SDK refuses a backwards range and a reason outside 15-255\ncharacters before anything is transmitted.\n",
"inputSchema": {
"properties": {
"number_end": {
"minimum": 1,
"title": "Number End",
"type": "integer"
},
"number_start": {
"minimum": 1,
"title": "Number Start",
"type": "integer"
},
"reason": {
"maxLength": 255,
"minLength": 15,
"title": "Reason",
"type": "string"
},
"series": {
"title": "Series",
"type": "string"
}
},
"required": [
"series",
"number_start",
"number_end",
"reason"
],
"title": "invalidate_numberingArguments",
"type": "object"
},
"name": "invalidate_numbering",
"outputSchema": {
"additionalProperties": true,
"description": "One document, as the fiscal API describes it.",
"properties": {
"access_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The authorizer's key. Absent while the document is not authorized.",
"title": "Access Key"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Local id. Use it for reissue and for submissions, and when a document was rejected and has no key.",
"title": "Id"
},
"protocol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The authorization protocol, when granted.",
"title": "Protocol"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "issued, rejected or cancelled.",
"title": "Status"
}
},
"title": "InvoiceResult",
"type": "object"
}
},
{
"description": "Issue a Brazilian fiscal document: NFS-e or NF-e.\n\nThis produces a legal fiscal document. Confirm the data with the\nuser before calling when you inferred any field.\n\nEvery item needs a price: unit_price is what one unit costs and\namount is the line's gross total. Send unit_price with quantity\nwhen the user quotes a price per unit, amount when they quote the\nline. Sending both asserts they agree and is refused if they do\nnot.\n\ndocument_type nfse is a service invoice: each item needs a\ndescription and a price, the recipient address is optional, and\nservice_code (LC 116/2003 item.subitem) falls back to the\ncompany's fiscal profile when omitted.\n\ndocument_type nfe is for goods, and the SEFAZ rejects a partial\none: every item needs ncm and cfop, and recipient_address is\nrequired with street, number, neighborhood, city, state, zip_code\nand city_code all filled. Call validate_invoice_payload first when\nany of that was inferred rather than given.\n\nPass idempotency_key when a retry is possible: repeating the same\nkey with the same payload replays the first answer instead of\nissuing a second document. Without one, a retry after a lost\nresponse issues again — another credit, another number burned,\nand undoing it means cancelling, which has a deadline. Nothing\ngenerates the key for you; use one per business event, not per\ncall.\n",
"inputSchema": {
"$defs": {
"Address": {
"description": "A plain postal address.",
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "City"
},
"city_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "City Code"
},
"neighborhood": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Neighborhood"
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Number"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"street": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Street"
},
"zip_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Zip Code"
}
},
"title": "Address",
"type": "object"
},
"CofinsAliq": {
"description": "COFINS taxed by rate.",
"properties": {
"cst": {
"enum": [
"01",
"02"
],
"title": "Cst",
"type": "string"
},
"p_cofins": {
"title": "P Cofins",
"type": "string"
},
"v_bc": {
"title": "V Bc",
"type": "string"
},
"v_cofins": {
"title": "V Cofins",
"type": "string"
}
},
"required": [
"cst",
"v_bc",
"p_cofins",
"v_cofins"
],
"title": "CofinsAliq",
"type": "object"
},
"CofinsNt": {
"description": "COFINS not taxed.",
"properties": {
"cst": {
"enum": [
"04",
"05",
"06",
"07",
"08",
"09"
],
"title": "Cst",
"type": "string"
}
},
"required": [
"cst"
],
"title": "CofinsNt",
"type": "object"
},
"CofinsOutr": {
"description": "COFINS taxed some other way.",
"properties": {
"cst": {
"enum": [
"49",
"50",
"51",
"52",
"53",
"54",
"55",
"56",
"60",
"61",
"62",
"63",
"64",
"65",
"66",
"67",
"70",
"71",
"72",
"73",
"74",
"75",
"98",
"99"
],
"title": "Cst",
"type": "string"
},
"p_cofins": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Cofins"
},
"q_bc_prod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q Bc Prod"
},
"v_aliq_prod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Aliq Prod"
},
"v_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc"
},
"v_cofins": {
"title": "V Cofins",
"type": "string"
}
},
"required": [
"cst",
"v_cofins"
],
"title": "CofinsOutr",
"type": "object"
},
"CofinsQtde": {
"description": "COFINS taxed by quantity.",
"properties": {
"cst": {
"const": "03",
"default": "03",
"title": "Cst",
"type": "string"
},
"q_bc_prod": {
"title": "Q Bc Prod",
"type": "string"
},
"v_aliq_prod": {
"title": "V Aliq Prod",
"type": "string"
},
"v_cofins": {
"title": "V Cofins",
"type": "string"
}
},
"required": [
"q_bc_prod",
"v_aliq_prod",
"v_cofins"
],
"title": "CofinsQtde",
"type": "object"
},
"CofinsSt": {
"description": "COFINS withheld by substitution.",
"properties": {
"ind_soma_cofins_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ind Soma Cofins St"
},
"p_cofins": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Cofins"
},
"q_bc_prod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q Bc Prod"
},
"v_aliq_prod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Aliq Prod"
},
"v_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc"
},
"v_cofins": {
"title": "V Cofins",
"type": "string"
}
},
"required": [
"v_cofins"
],
"title": "CofinsSt",
"type": "object"
},
"IbsCbs": {
"description": "The Reforma Tributária group for one item.",
"properties": {
"base": {
"anyOf": [
{
"exclusiveMinimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Base"
},
"classification": {
"pattern": "^\\d{6}$",
"title": "Classification",
"type": "string"
},
"cst": {
"pattern": "^\\d{3}$",
"title": "Cst",
"type": "string"
},
"rate_city": {
"minimum": 0,
"title": "Rate City",
"type": "number"
},
"rate_federal": {
"minimum": 0,
"title": "Rate Federal",
"type": "number"
},
"rate_state": {
"minimum": 0,
"title": "Rate State",
"type": "number"
}
},
"required": [
"cst",
"classification",
"rate_state",
"rate_city",
"rate_federal"
],
"title": "IbsCbs",
"type": "object"
},
"Icms00": {
"description": "ICMS fully taxed.",
"properties": {
"cst": {
"const": "00",
"default": "00",
"title": "Cst",
"type": "string"
},
"mod_bc": {
"title": "Mod Bc",
"type": "string"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp"
},
"p_icms": {
"title": "P Icms",
"type": "string"
},
"v_bc": {
"title": "V Bc",
"type": "string"
},
"v_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp"
},
"v_icms": {
"title": "V Icms",
"type": "string"
}
},
"required": [
"orig",
"mod_bc",
"v_bc",
"p_icms",
"v_icms"
],
"title": "Icms00",
"type": "object"
},
"Icms02": {
"description": "ICMS monofasico, taxed by unit.",
"properties": {
"ad_rem_icms": {
"title": "Ad Rem Icms",
"type": "string"
},
"cst": {
"const": "02",
"default": "02",
"title": "Cst",
"type": "string"
},
"orig": {
"title": "Orig",
"type": "string"
},
"q_bc_mono": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q Bc Mono"
},
"v_icms_mono": {
"title": "V Icms Mono",
"type": "string"
}
},
"required": [
"orig",
"ad_rem_icms",
"v_icms_mono"
],
"title": "Icms02",
"type": "object"
},
"Icms10": {
"description": "ICMS taxed with substitution.",
"properties": {
"cst": {
"const": "10",
"default": "10",
"title": "Cst",
"type": "string"
},
"mod_bc": {
"title": "Mod Bc",
"type": "string"
},
"mod_bc_st": {
"title": "Mod Bc St",
"type": "string"
},
"mot_des_icms_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mot Des Icms St"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp"
},
"p_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp St"
},
"p_icms": {
"title": "P Icms",
"type": "string"
},
"p_icms_st": {
"title": "P Icms St",
"type": "string"
},
"p_mva_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Mva St"
},
"p_red_bc_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc St"
},
"v_bc": {
"title": "V Bc",
"type": "string"
},
"v_bc_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp"
},
"v_bc_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp St"
},
"v_bc_st": {
"title": "V Bc St",
"type": "string"
},
"v_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp"
},
"v_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp St"
},
"v_icms": {
"title": "V Icms",
"type": "string"
},
"v_icms_st": {
"title": "V Icms St",
"type": "string"
},
"v_icms_st_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms St Deson"
}
},
"required": [
"orig",
"mod_bc",
"v_bc",
"p_icms",
"v_icms",
"mod_bc_st",
"v_bc_st",
"p_icms_st",
"v_icms_st"
],
"title": "Icms10",
"type": "object"
},
"Icms15": {
"description": "ICMS monofasico with retention.",
"properties": {
"ad_rem_icms": {
"title": "Ad Rem Icms",
"type": "string"
},
"ad_rem_icms_reten": {
"title": "Ad Rem Icms Reten",
"type": "string"
},
"cst": {
"const": "15",
"default": "15",
"title": "Cst",
"type": "string"
},
"mot_red_ad_rem": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mot Red Ad Rem"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_red_ad_rem": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Ad Rem"
},
"q_bc_mono": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q Bc Mono"
},
"q_bc_mono_reten": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q Bc Mono Reten"
},
"v_icms_mono": {
"title": "V Icms Mono",
"type": "string"
},
"v_icms_mono_reten": {
"title": "V Icms Mono Reten",
"type": "string"
}
},
"required": [
"orig",
"ad_rem_icms",
"v_icms_mono",
"ad_rem_icms_reten",
"v_icms_mono_reten"
],
"title": "Icms15",
"type": "object"
},
"Icms20": {
"description": "ICMS with a reduced base.",
"properties": {
"cst": {
"const": "20",
"default": "20",
"title": "Cst",
"type": "string"
},
"ind_deduz_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ind Deduz Deson"
},
"mod_bc": {
"title": "Mod Bc",
"type": "string"
},
"mot_des_icms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mot Des Icms"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp"
},
"p_icms": {
"title": "P Icms",
"type": "string"
},
"p_red_bc": {
"title": "P Red Bc",
"type": "string"
},
"v_bc": {
"title": "V Bc",
"type": "string"
},
"v_bc_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp"
},
"v_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp"
},
"v_icms": {
"title": "V Icms",
"type": "string"
},
"v_icms_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Deson"
}
},
"required": [
"orig",
"mod_bc",
"p_red_bc",
"v_bc",
"p_icms",
"v_icms"
],
"title": "Icms20",
"type": "object"
},
"Icms30": {
"description": "ICMS exempt with substitution.",
"properties": {
"cst": {
"const": "30",
"default": "30",
"title": "Cst",
"type": "string"
},
"ind_deduz_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ind Deduz Deson"
},
"mod_bc_st": {
"title": "Mod Bc St",
"type": "string"
},
"mot_des_icms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mot Des Icms"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp St"
},
"p_icms_st": {
"title": "P Icms St",
"type": "string"
},
"p_mva_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Mva St"
},
"p_red_bc_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc St"
},
"v_bc_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp St"
},
"v_bc_st": {
"title": "V Bc St",
"type": "string"
},
"v_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp St"
},
"v_icms_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Deson"
},
"v_icms_st": {
"title": "V Icms St",
"type": "string"
}
},
"required": [
"orig",
"mod_bc_st",
"v_bc_st",
"p_icms_st",
"v_icms_st"
],
"title": "Icms30",
"type": "object"
},
"Icms40": {
"description": "ICMS exempt or not taxed.",
"properties": {
"cst": {
"enum": [
"40",
"41",
"50"
],
"title": "Cst",
"type": "string"
},
"ind_deduz_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ind Deduz Deson"
},
"mot_des_icms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mot Des Icms"
},
"orig": {
"title": "Orig",
"type": "string"
},
"v_icms_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Deson"
}
},
"required": [
"orig",
"cst"
],
"title": "Icms40",
"type": "object"
},
"Icms51": {
"description": "ICMS deferred.",
"properties": {
"c_benef_rbc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "C Benef Rbc"
},
"cst": {
"const": "51",
"default": "51",
"title": "Cst",
"type": "string"
},
"mod_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mod Bc"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_dif": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Dif"
},
"p_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp"
},
"p_fcp_dif": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp Dif"
},
"p_icms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Icms"
},
"p_red_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc"
},
"v_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc"
},
"v_bc_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp"
},
"v_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp"
},
"v_fcp_dif": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp Dif"
},
"v_fcp_efet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp Efet"
},
"v_icms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms"
},
"v_icms_dif": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Dif"
},
"v_icms_op": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Op"
}
},
"required": [
"orig"
],
"title": "Icms51",
"type": "object"
},
"Icms53": {
"description": "ICMS monofasico deferred.",
"properties": {
"ad_rem_icms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ad Rem Icms"
},
"ad_rem_icms_dif": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ad Rem Icms Dif"
},
"cst": {
"const": "53",
"default": "53",
"title": "Cst",
"type": "string"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_dif": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Dif"
},
"q_bc_mono": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q Bc Mono"
},
"q_bc_mono_dif": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q Bc Mono Dif"
},
"v_icms_mono": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Mono"
},
"v_icms_mono_dif": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Mono Dif"
},
"v_icms_mono_op": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Mono Op"
}
},
"required": [
"orig"
],
"title": "Icms53",
"type": "object"
},
"Icms60": {
"description": "ICMS already charged by an earlier substitution.",
"properties": {
"cst": {
"const": "60",
"default": "60",
"title": "Cst",
"type": "string"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_fcp_st_ret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp St Ret"
},
"p_icms_efet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Icms Efet"
},
"p_red_bc_efet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc Efet"
},
"p_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P St"
},
"v_bc_efet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Efet"
},
"v_bc_fcp_st_ret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp St Ret"
},
"v_bc_st_ret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc St Ret"
},
"v_fcp_st_ret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp St Ret"
},
"v_icms_efet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Efet"
},
"v_icms_st_ret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms St Ret"
},
"v_icms_substituto": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Substituto"
}
},
"required": [
"orig"
],
"title": "Icms60",
"type": "object"
},
"Icms61": {
"description": "ICMS monofasico already charged earlier.",
"properties": {
"ad_rem_icms_ret": {
"title": "Ad Rem Icms Ret",
"type": "string"
},
"cst": {
"const": "61",
"default": "61",
"title": "Cst",
"type": "string"
},
"orig": {
"title": "Orig",
"type": "string"
},
"q_bc_mono_ret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q Bc Mono Ret"
},
"v_icms_mono_ret": {
"title": "V Icms Mono Ret",
"type": "string"
}
},
"required": [
"orig",
"ad_rem_icms_ret",
"v_icms_mono_ret"
],
"title": "Icms61",
"type": "object"
},
"Icms70": {
"description": "ICMS with a reduced base and substitution.",
"properties": {
"cst": {
"const": "70",
"default": "70",
"title": "Cst",
"type": "string"
},
"ind_deduz_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ind Deduz Deson"
},
"mod_bc": {
"title": "Mod Bc",
"type": "string"
},
"mod_bc_st": {
"title": "Mod Bc St",
"type": "string"
},
"mot_des_icms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mot Des Icms"
},
"mot_des_icms_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mot Des Icms St"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp"
},
"p_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp St"
},
"p_icms": {
"title": "P Icms",
"type": "string"
},
"p_icms_st": {
"title": "P Icms St",
"type": "string"
},
"p_mva_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Mva St"
},
"p_red_bc": {
"title": "P Red Bc",
"type": "string"
},
"p_red_bc_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc St"
},
"v_bc": {
"title": "V Bc",
"type": "string"
},
"v_bc_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp"
},
"v_bc_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp St"
},
"v_bc_st": {
"title": "V Bc St",
"type": "string"
},
"v_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp"
},
"v_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp St"
},
"v_icms": {
"title": "V Icms",
"type": "string"
},
"v_icms_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Deson"
},
"v_icms_st": {
"title": "V Icms St",
"type": "string"
},
"v_icms_st_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms St Deson"
}
},
"required": [
"orig",
"mod_bc",
"p_red_bc",
"v_bc",
"p_icms",
"v_icms",
"mod_bc_st",
"v_bc_st",
"p_icms_st",
"v_icms_st"
],
"title": "Icms70",
"type": "object"
},
"Icms90": {
"description": "ICMS, other cases.",
"properties": {
"c_benef_rbc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "C Benef Rbc"
},
"cst": {
"const": "90",
"default": "90",
"title": "Cst",
"type": "string"
},
"ind_deduz_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ind Deduz Deson"
},
"mod_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mod Bc"
},
"mod_bc_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mod Bc St"
},
"mot_des_icms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mot Des Icms"
},
"mot_des_icms_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mot Des Icms St"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_dif": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Dif"
},
"p_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp"
},
"p_fcp_dif": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp Dif"
},
"p_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp St"
},
"p_icms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Icms"
},
"p_icms_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Icms St"
},
"p_mva_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Mva St"
},
"p_red_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc"
},
"p_red_bc_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc St"
},
"v_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc"
},
"v_bc_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp"
},
"v_bc_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp St"
},
"v_bc_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc St"
},
"v_fcp": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp"
},
"v_fcp_dif": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp Dif"
},
"v_fcp_efet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp Efet"
},
"v_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp St"
},
"v_icms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms"
},
"v_icms_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Deson"
},
"v_icms_dif": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Dif"
},
"v_icms_op": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Op"
},
"v_icms_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms St"
},
"v_icms_st_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms St Deson"
}
},
"required": [
"orig"
],
"title": "Icms90",
"type": "object"
},
"IcmsPart": {
"description": "ICMS split between the origin and destination states.",
"properties": {
"cst": {
"enum": [
"10",
"20",
"90"
],
"title": "Cst",
"type": "string"
},
"ind_deduz_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ind Deduz Deson"
},
"mod_bc": {
"title": "Mod Bc",
"type": "string"
},
"mod_bc_st": {
"title": "Mod Bc St",
"type": "string"
},
"mot_des_icms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mot Des Icms"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_bc_op": {
"title": "P Bc Op",
"type": "string"
},
"p_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp St"
},
"p_icms": {
"title": "P Icms",
"type": "string"
},
"p_icms_st": {
"title": "P Icms St",
"type": "string"
},
"p_mva_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Mva St"
},
"p_red_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc"
},
"p_red_bc_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc St"
},
"uf_st": {
"title": "Uf St",
"type": "string"
},
"v_bc": {
"title": "V Bc",
"type": "string"
},
"v_bc_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp St"
},
"v_bc_st": {
"title": "V Bc St",
"type": "string"
},
"v_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp St"
},
"v_icms": {
"title": "V Icms",
"type": "string"
},
"v_icms_deson": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Deson"
},
"v_icms_st": {
"title": "V Icms St",
"type": "string"
}
},
"required": [
"orig",
"cst",
"mod_bc",
"v_bc",
"p_icms",
"v_icms",
"mod_bc_st",
"v_bc_st",
"p_icms_st",
"v_icms_st",
"p_bc_op",
"uf_st"
],
"title": "IcmsPart",
"type": "object"
},
"IcmsSn101": {
"description": "Simples Nacional ICMS with a credit.",
"properties": {
"csosn": {
"const": "101",
"default": "101",
"title": "Csosn",
"type": "string"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_cred_sn": {
"title": "P Cred Sn",
"type": "string"
},
"v_cred_icms_sn": {
"title": "V Cred Icms Sn",
"type": "string"
}
},
"required": [
"orig",
"p_cred_sn",
"v_cred_icms_sn"
],
"title": "IcmsSn101",
"type": "object"
},
"IcmsSn102": {
"description": "Simples Nacional ICMS without a credit.",
"properties": {
"csosn": {
"enum": [
"102",
"103",
"300",
"400"
],
"title": "Csosn",
"type": "string"
},
"orig": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Orig"
}
},
"required": [
"csosn"
],
"title": "IcmsSn102",
"type": "object"
},
"IcmsSn201": {
"description": "Simples Nacional ICMS with a credit and substitution.",
"properties": {
"csosn": {
"const": "201",
"default": "201",
"title": "Csosn",
"type": "string"
},
"mod_bc_st": {
"title": "Mod Bc St",
"type": "string"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_cred_sn": {
"title": "P Cred Sn",
"type": "string"
},
"p_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp St"
},
"p_icms_st": {
"title": "P Icms St",
"type": "string"
},
"p_mva_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Mva St"
},
"p_red_bc_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc St"
},
"v_bc_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp St"
},
"v_bc_st": {
"title": "V Bc St",
"type": "string"
},
"v_cred_icms_sn": {
"title": "V Cred Icms Sn",
"type": "string"
},
"v_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp St"
},
"v_icms_st": {
"title": "V Icms St",
"type": "string"
}
},
"required": [
"orig",
"mod_bc_st",
"v_bc_st",
"p_icms_st",
"v_icms_st",
"p_cred_sn",
"v_cred_icms_sn"
],
"title": "IcmsSn201",
"type": "object"
},
"IcmsSn202": {
"description": "Simples Nacional ICMS without a credit, with substitution.",
"properties": {
"csosn": {
"enum": [
"202",
"203"
],
"title": "Csosn",
"type": "string"
},
"mod_bc_st": {
"title": "Mod Bc St",
"type": "string"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp St"
},
"p_icms_st": {
"title": "P Icms St",
"type": "string"
},
"p_mva_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Mva St"
},
"p_red_bc_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc St"
},
"v_bc_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp St"
},
"v_bc_st": {
"title": "V Bc St",
"type": "string"
},
"v_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp St"
},
"v_icms_st": {
"title": "V Icms St",
"type": "string"
}
},
"required": [
"orig",
"csosn",
"mod_bc_st",
"v_bc_st",
"p_icms_st",
"v_icms_st"
],
"title": "IcmsSn202",
"type": "object"
},
"IcmsSn500": {
"description": "Simples Nacional ICMS already charged by substitution.",
"properties": {
"csosn": {
"const": "500",
"default": "500",
"title": "Csosn",
"type": "string"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_fcp_st_ret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp St Ret"
},
"p_icms_efet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Icms Efet"
},
"p_red_bc_efet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc Efet"
},
"p_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P St"
},
"v_bc_efet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Efet"
},
"v_bc_fcp_st_ret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp St Ret"
},
"v_bc_st_ret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc St Ret"
},
"v_fcp_st_ret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp St Ret"
},
"v_icms_efet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Efet"
},
"v_icms_st_ret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms St Ret"
},
"v_icms_substituto": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Substituto"
}
},
"required": [
"orig"
],
"title": "IcmsSn500",
"type": "object"
},
"IcmsSn900": {
"description": "Simples Nacional ICMS, other cases.",
"properties": {
"csosn": {
"const": "900",
"default": "900",
"title": "Csosn",
"type": "string"
},
"mod_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mod Bc"
},
"mod_bc_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mod Bc St"
},
"orig": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Orig"
},
"p_cred_sn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Cred Sn"
},
"p_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp St"
},
"p_icms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Icms"
},
"p_icms_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Icms St"
},
"p_mva_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Mva St"
},
"p_red_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc"
},
"p_red_bc_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc St"
},
"v_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc"
},
"v_bc_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp St"
},
"v_bc_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc St"
},
"v_cred_icms_sn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Cred Icms Sn"
},
"v_fcp_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp St"
},
"v_icms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms"
},
"v_icms_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms St"
}
},
"title": "IcmsSn900",
"type": "object"
},
"IcmsSt": {
"description": "ICMS charged earlier, for the substituted taxpayer.",
"properties": {
"cst": {
"enum": [
"41",
"60"
],
"title": "Cst",
"type": "string"
},
"orig": {
"title": "Orig",
"type": "string"
},
"p_fcp_st_ret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp St Ret"
},
"p_icms_efet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Icms Efet"
},
"p_red_bc_efet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Red Bc Efet"
},
"p_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P St"
},
"v_bc_efet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Efet"
},
"v_bc_fcp_st_ret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp St Ret"
},
"v_bc_st_dest": {
"title": "V Bc St Dest",
"type": "string"
},
"v_bc_st_ret": {
"title": "V Bc St Ret",
"type": "string"
},
"v_fcp_st_ret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp St Ret"
},
"v_icms_efet": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Efet"
},
"v_icms_st_dest": {
"title": "V Icms St Dest",
"type": "string"
},
"v_icms_st_ret": {
"title": "V Icms St Ret",
"type": "string"
},
"v_icms_substituto": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Icms Substituto"
}
},
"required": [
"orig",
"cst",
"v_bc_st_ret",
"v_icms_st_ret",
"v_bc_st_dest",
"v_icms_st_dest"
],
"title": "IcmsSt",
"type": "object"
},
"IcmsUfDest": {
"description": "Interstate ICMS share owed to the destination state.",
"properties": {
"p_fcp_uf_dest": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Fcp Uf Dest"
},
"p_icms_inter": {
"title": "P Icms Inter",
"type": "string"
},
"p_icms_inter_part": {
"title": "P Icms Inter Part",
"type": "string"
},
"p_icms_uf_dest": {
"title": "P Icms Uf Dest",
"type": "string"
},
"v_bc_fcp_uf_dest": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc Fcp Uf Dest"
},
"v_bc_uf_dest": {
"title": "V Bc Uf Dest",
"type": "string"
},
"v_fcp_uf_dest": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Fcp Uf Dest"
},
"v_icms_uf_dest": {
"title": "V Icms Uf Dest",
"type": "string"
},
"v_icms_uf_remet": {
"title": "V Icms Uf Remet",
"type": "string"
}
},
"required": [
"v_bc_uf_dest",
"p_icms_uf_dest",
"p_icms_inter",
"p_icms_inter_part",
"v_icms_uf_dest",
"v_icms_uf_remet"
],
"title": "IcmsUfDest",
"type": "object"
},
"Ipi": {
"description": "This item's IPI.",
"properties": {
"c_enq": {
"title": "C Enq",
"type": "string"
},
"c_selo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "C Selo"
},
"cnpj_prod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cnpj Prod"
},
"q_selo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q Selo"
},
"trib": {
"anyOf": [
{
"$ref": "#/$defs/IpiTrib"
},
{
"$ref": "#/$defs/IpiNt"
},
{
"additionalProperties": true,
"type": "object"
}
],
"title": "Trib"
}
},
"required": [
"c_enq",
"trib"
],
"title": "Ipi",
"type": "object"
},
"IpiNt": {
"description": "IPI not taxed.",
"properties": {
"cst": {
"enum": [
"01",
"02",
"03",
"04",
"05",
"51",
"52",
"53",
"54",
"55"
],
"title": "Cst",
"type": "string"
}
},
"required": [
"cst"
],
"title": "IpiNt",
"type": "object"
},
"IpiTrib": {
"description": "IPI taxed by rate or by quantity.",
"properties": {
"cst": {
"enum": [
"00",
"49",
"50",
"99"
],
"title": "Cst",
"type": "string"
},
"p_ipi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Ipi"
},
"q_unid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q Unid"
},
"v_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc"
},
"v_ipi": {
"title": "V Ipi",
"type": "string"
},
"v_unid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Unid"
}
},
"required": [
"cst",
"v_ipi"
],
"title": "IpiTrib",
"type": "object"
},
"PisAliq": {
"description": "PIS taxed by rate.",
"properties": {
"cst": {
"enum": [
"01",
"02"
],
"title": "Cst",
"type": "string"
},
"p_pis": {
"title": "P Pis",
"type": "string"
},
"v_bc": {
"title": "V Bc",
"type": "string"
},
"v_pis": {
"title": "V Pis",
"type": "string"
}
},
"required": [
"cst",
"v_bc",
"p_pis",
"v_pis"
],
"title": "PisAliq",
"type": "object"
},
"PisNt": {
"description": "PIS not taxed.",
"properties": {
"cst": {
"enum": [
"04",
"05",
"06",
"07",
"08",
"09"
],
"title": "Cst",
"type": "string"
}
},
"required": [
"cst"
],
"title": "PisNt",
"type": "object"
},
"PisOutr": {
"description": "PIS taxed some other way.",
"properties": {
"cst": {
"enum": [
"49",
"50",
"51",
"52",
"53",
"54",
"55",
"56",
"60",
"61",
"62",
"63",
"64",
"65",
"66",
"67",
"70",
"71",
"72",
"73",
"74",
"75",
"98",
"99"
],
"title": "Cst",
"type": "string"
},
"p_pis": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Pis"
},
"q_bc_prod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q Bc Prod"
},
"v_aliq_prod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Aliq Prod"
},
"v_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc"
},
"v_pis": {
"title": "V Pis",
"type": "string"
}
},
"required": [
"cst",
"v_pis"
],
"title": "PisOutr",
"type": "object"
},
"PisQtde": {
"description": "PIS taxed by quantity.",
"properties": {
"cst": {
"const": "03",
"default": "03",
"title": "Cst",
"type": "string"
},
"q_bc_prod": {
"title": "Q Bc Prod",
"type": "string"
},
"v_aliq_prod": {
"title": "V Aliq Prod",
"type": "string"
},
"v_pis": {
"title": "V Pis",
"type": "string"
}
},
"required": [
"q_bc_prod",
"v_aliq_prod",
"v_pis"
],
"title": "PisQtde",
"type": "object"
},
"PisSt": {
"description": "PIS withheld by substitution.",
"properties": {
"ind_soma_pis_st": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ind Soma Pis St"
},
"p_pis": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "P Pis"
},
"q_bc_prod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q Bc Prod"
},
"v_aliq_prod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Aliq Prod"
},
"v_bc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Bc"
},
"v_pis": {
"title": "V Pis",
"type": "string"
}
},
"required": [
"v_pis"
],
"title": "PisSt",
"type": "object"
},
"PresumedCredit": {
"description": "A presumed tax credit applied to this item.",
"properties": {
"amount": {
"title": "Amount",
"type": "number"
},
"code": {
"pattern": "^[\\x21-\\xff]{8}$|^[\\x21-\\xff]{10}$",
"title": "Code",
"type": "string"
},
"percentage": {
"title": "Percentage",
"type": "number"
}
},
"required": [
"code",
"percentage",
"amount"
],
"title": "PresumedCredit",
"type": "object"
},
"Product": {
"description": "One product or service line item on an invoice.",
"properties": {
"amount": {
"anyOf": [
{
"exclusiveMinimum": 0,
"type": "number"
},
{
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount"
},
"barcode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Barcode"
},
"cest": {
"anyOf": [
{
"pattern": "^\\d{7}$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cest"
},
"cfop": {
"anyOf": [
{
"pattern": "^[123567]\\d{3}$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cfop"
},
"description": {
"minLength": 1,
"title": "Description",
"type": "string"
},
"discount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Discount"
},
"ex_tipi": {
"anyOf": [
{
"pattern": "^\\d{2,3}$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ex Tipi"
},
"extra_groups": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Extra Groups"
},
"freight": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Freight"
},
"ibs_cbs": {
"anyOf": [
{
"$ref": "#/$defs/IbsCbs"
},
{
"type": "null"
}
],
"default": null
},
"import_content_control_number": {
"anyOf": [
{
"pattern": "^[A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12}$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Import Content Control Number"
},
"ind_escala": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ind Escala"
},
"insurance": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Insurance"
},
"manufacturer_cnpj": {
"anyOf": [
{
"pattern": "^[0-9A-Z]{12}\\d{2}$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer Cnpj"
},
"ncm": {
"anyOf": [
{
"pattern": "^\\d{2}$|^\\d{8}$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ncm"
},
"nve_codes": {
"anyOf": [
{
"items": {
"pattern": "^[A-Z]{2}\\d{4}$",
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Nve Codes"
},
"observations": {
"anyOf": [
{
"maxLength": 2000,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "nfse only.",
"title": "Observations"
},
"other_expenses": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Other Expenses"
},
"presumed_credits": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/PresumedCredit"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Presumed Credits"
},
"purchase_order": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Purchase Order"
},
"purchase_order_item": {
"anyOf": [
{
"pattern": "^\\d{1,6}$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Purchase Order Item"
},
"quantity": {
"default": 1,
"exclusiveMinimum": 0,
"title": "Quantity",
"type": "number"
},
"recopi_number": {
"anyOf": [
{
"pattern": "^\\d{20}$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Recopi Number"
},
"service_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "LC 116/2003 item.subitem, nfse only.",
"title": "Service Code"
},
"service_discount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Unconditional discount, nfse only.",
"title": "Service Discount"
},
"tax": {
"anyOf": [
{
"$ref": "#/$defs/Tax"
},
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Tax"
},
"tax_benefit_code": {
"anyOf": [
{
"pattern": "^(SEM CBENEF|[\\x21-\\xff]{8}|[\\x21-\\xff]{10})$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Tax Benefit Code"
},
"tax_retained": {
"default": false,
"description": "ISSQN retained by the tomador, nfse only.",
"title": "Tax Retained",
"type": "boolean"
},
"unit": {
"default": "UN",
"title": "Unit",
"type": "string"
},
"unit_price": {
"anyOf": [
{
"exclusiveMinimum": 0,
"type": "number"
},
{
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit Price"
},
"used_movable_asset": {
"default": false,
"title": "Used Movable Asset",
"type": "boolean"
}
},
"required": [
"description"
],
"title": "Product",
"type": "object"
},
"Tax": {
"description": "This item's taxes, already computed by the caller.",
"properties": {
"cofins": {
"anyOf": [
{
"$ref": "#/$defs/CofinsAliq"
},
{
"$ref": "#/$defs/CofinsQtde"
},
{
"$ref": "#/$defs/CofinsNt"
},
{
"$ref": "#/$defs/CofinsOutr"
},
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Cofins"
},
"cofins_st": {
"anyOf": [
{
"$ref": "#/$defs/CofinsSt"
},
{
"type": "null"
}
],
"default": null
},
"icms": {
"anyOf": [
{
"$ref": "#/$defs/Icms00"
},
{
"$ref": "#/$defs/Icms02"
},
{
"$ref": "#/$defs/Icms10"
},
{
"$ref": "#/$defs/Icms15"
},
{
"$ref": "#/$defs/Icms20"
},
{
"$ref": "#/$defs/Icms30"
},
{
"$ref": "#/$defs/Icms40"
},
{
"$ref": "#/$defs/Icms51"
},
{
"$ref": "#/$defs/Icms53"
},
{
"$ref": "#/$defs/Icms60"
},
{
"$ref": "#/$defs/Icms61"
},
{
"$ref": "#/$defs/Icms70"
},
{
"$ref": "#/$defs/Icms90"
},
{
"$ref": "#/$defs/IcmsPart"
},
{
"$ref": "#/$defs/IcmsSt"
},
{
"$ref": "#/$defs/IcmsSn101"
},
{
"$ref": "#/$defs/IcmsSn102"
},
{
"$ref": "#/$defs/IcmsSn201"
},
{
"$ref": "#/$defs/IcmsSn202"
},
{
"$ref": "#/$defs/IcmsSn500"
},
{
"$ref": "#/$defs/IcmsSn900"
},
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Icms"
},
"icms_uf_dest": {
"anyOf": [
{
"$ref": "#/$defs/IcmsUfDest"
},
{
"type": "null"
}
],
"default": null
},
"ipi": {
"anyOf": [
{
"$ref": "#/$defs/Ipi"
},
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Ipi"
},
"pis": {
"anyOf": [
{
"$ref": "#/$defs/PisAliq"
},
{
"$ref": "#/$defs/PisQtde"
},
{
"$ref": "#/$defs/PisNt"
},
{
"$ref": "#/$defs/PisOutr"
},
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Pis"
},
"pis_st": {
"anyOf": [
{
"$ref": "#/$defs/PisSt"
},
{
"type": "null"
}
],
"default": null
},
"v_tot_trib": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "V Tot Trib"
}
},
"title": "Tax",
"type": "object"
}
},
"properties": {
"client_name": {
"maxLength": 120,
"minLength": 1,
"title": "Client Name",
"type": "string"
},
"document_type": {
"enum": [
"nfse",
"nfe"
],
"title": "Document Type",
"type": "string"
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Idempotency Key"
},
"items": {
"items": {
"$ref": "#/$defs/Product"
},
"title": "Items",
"type": "array"
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Number"
},
"recipient_address": {
"anyOf": [
{
"$ref": "#/$defs/Address"
},
{
"type": "null"
}
],
"default": null
},
"series": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Series"
},
"tax_id": {
"maxLength": 18,
"minLength": 11,
"title": "Tax Id",
"type": "string"
}
},
"required": [
"document_type",
"client_name",
"tax_id",
"items"
],
"title": "issue_invoiceArguments",
"type": "object"
},
"name": "issue_invoice",
"outputSchema": {
"additionalProperties": true,
"description": "One document, as the fiscal API describes it.",
"properties": {
"access_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The authorizer's key. Absent while the document is not authorized.",
"title": "Access Key"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Local id. Use it for reissue and for submissions, and when a document was rejected and has no key.",
"title": "Id"
},
"protocol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The authorization protocol, when granted.",
"title": "Protocol"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "issued, rejected or cancelled.",
"title": "Status"
}
},
"title": "InvoiceResult",
"type": "object"
}
},
{
"description": "Which classifications this country has data for, right now.\n\nAsk this before assuming a classification exists. The answer\ngrows as the source data does, so a name absent here is absent\ntoday rather than absent forever.\n",
"inputSchema": {
"properties": {
"country": {
"default": "BR",
"description": "ISO 3166-1 alpha-2 code. A code means nothing without it, and Brazil is the default rather than a guess.",
"maxLength": 2,
"minLength": 2,
"title": "Country",
"type": "string"
}
},
"title": "list_fiscal_kindsArguments",
"type": "object"
},
"name": "list_fiscal_kinds",
"outputSchema": {
"additionalProperties": true,
"description": "Which classifications this country has data for, right now.",
"properties": {
"kinds": {
"items": {
"type": "string"
},
"title": "Kinds",
"type": "array"
}
},
"title": "FiscalReferenceKinds",
"type": "object"
}
},
{
"description": "List the invoices this company issued, newest first.\n\nOne document type at a time: pass nfse for services or nfe for\ngoods. A company that issues both has to be asked twice.\n\nUse it for \"my last invoices\", \"what was rejected today\", and to find\na document whose access key the user does not have at hand. Read-only.\n\nAn authorized document is stored as issued, which is the value the\nrows carry; authorized is accepted as a synonym and asks for the\nsame thing.\n\nEvery row carries both identifiers the other tools need: id, which\nreissue_invoice takes, and access_key, which consult_invoice,\ncancel_invoice and get_invoice_pdf take. A rejected\nrow has an id and no access key — the authorizer never assigned one.\n",
"inputSchema": {
"properties": {
"document_type": {
"default": "nfse",
"enum": [
"nfse",
"nfe"
],
"title": "Document Type",
"type": "string"
},
"limit": {
"default": 20,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"minimum": 0,
"title": "Offset",
"type": "integer"
},
"status": {
"anyOf": [
{
"enum": [
"pending",
"issued",
"authorized",
"rejected",
"cancelled"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"title": "list_invoicesArguments",
"type": "object"
},
"name": "list_invoices",
"outputSchema": {
"$defs": {
"InvoiceListItem": {
"additionalProperties": true,
"description": "One row of the issuance history.",
"properties": {
"access_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Access Key"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount"
},
"client_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Client Name"
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Created At"
},
"document_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Document Type"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"title": "InvoiceListItem",
"type": "object"
}
},
"additionalProperties": true,
"description": "A page of documents this company issued, newest first.",
"properties": {
"data": {
"description": "The rows on this page.",
"items": {
"$ref": "#/$defs/InvoiceListItem"
},
"title": "Data",
"type": "array"
},
"next_page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Page"
},
"page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Page"
},
"per_page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Per Page"
},
"prev_page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Prev Page"
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "How many exist, not how many are here.",
"title": "Total"
},
"total_pages": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Total Pages"
}
},
"title": "InvoiceList",
"type": "object"
}
},
{
"description": "List NF-e documents other companies issued against this one.\n\nThe mirror of list_invoices: that one shows what this company issued,\nthis one what it received. Read-only.\n\nIt reads what the API already collected and never calls the tax\nauthority, which caps how often a company may ask per day. Each row\ncarries the issuer, the amount and, once one was filed, the\nmanifestation. Before a manifestation the authority sends a summary\nonly; the full document arrives after one.\n",
"inputSchema": {
"properties": {
"limit": {
"default": 20,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"minimum": 0,
"title": "Offset",
"type": "integer"
}
},
"title": "list_received_invoicesArguments",
"type": "object"
},
"name": "list_received_invoices",
"outputSchema": {
"$defs": {
"ReceivedItem": {
"additionalProperties": true,
"description": "One document another company issued against this one.",
"properties": {
"access_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Access Key"
},
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount"
},
"issued_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Issued At"
},
"issuer_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Who issued it against this company.",
"title": "Issuer Name"
},
"issuer_tax_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Issuer Tax Id"
},
"manifestation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The position already filed, when there is one. Before a manifestation the authority sends a summary only.",
"title": "Manifestation"
}
},
"title": "ReceivedItem",
"type": "object"
}
},
"additionalProperties": true,
"description": "A page of documents issued against this company, newest first.",
"properties": {
"data": {
"items": {
"$ref": "#/$defs/ReceivedItem"
},
"title": "Data",
"type": "array"
},
"next_page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Page"
},
"page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Page"
},
"per_page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Per Page"
},
"prev_page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Prev Page"
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
}
},
"title": "ReceivedList",
"type": "object"
}
},
{
"description": "Resolve one code of one classification, when you know both.\n\nUse this to confirm a code before putting it on a document —\nan NCM that does not exist is rejected by the tax authority\nafter issuing, which costs a cancellation.\n\nA code that is not there answers 404. That means the code is\nwrong, not that the lookup failed; do not retry it.\n\n`metadata` differs per kind and is passed through as published:\nutrib on an NCM, ncm_code on a CEST, tax_type on a CST, and\nnothing at all on an ISS service.\n",
"inputSchema": {
"properties": {
"code": {
"description": "The code itself, as published: 84716052 for an NCM, 5102 for a CFOP. Digits only, no dots.",
"title": "Code",
"type": "string"
},
"country": {
"default": "BR",
"description": "ISO 3166-1 alpha-2 code. A code means nothing without it, and Brazil is the default rather than a guess.",
"maxLength": 2,
"minLength": 2,
"title": "Country",
"type": "string"
},
"kind": {
"description": "cfop, ncm, cest, cst, csosn, ...",
"title": "Kind",
"type": "string"
}
},
"required": [
"kind",
"code"
],
"title": "lookup_fiscal_codeArguments",
"type": "object"
},
"name": "lookup_fiscal_code",
"outputSchema": {
"additionalProperties": true,
"description": "One code of one classification.",
"properties": {
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Code"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Country"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"kind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "cfop, ncm, cest, cst, csosn, ...",
"title": "Kind"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Whatever the classification carries beyond a code and a description, and it differs per kind: utrib on an NCM, ncm_code on a CEST, tax_type on a CST, null on an ISS service.",
"title": "Metadata"
}
},
"title": "FiscalReferenceItem",
"type": "object"
}
},
{
"description": "Look up one taxpayer by exact tax id, to confirm who it is.\n\nUse it to check a recipient's name before issuing against them.\nIt takes the id exactly — punctuation is fine, but there is no\nsearch by name, by prefix or by state, and there will not be:\nthe registry holds the names and addresses of real people.\n\nA 404 does not mean the company does not exist. The registry\nreloads monthly from the RFB's dump, so a recently registered\nCNPJ is simply not in it yet. Say that to the user rather than\nreporting the tax id as invalid, and never turn a 404 here into\na validation rule.\n",
"inputSchema": {
"properties": {
"country": {
"default": "BR",
"description": "ISO 3166-1 alpha-2 code. A code means nothing without it, and Brazil is the default rather than a guess.",
"maxLength": 2,
"minLength": 2,
"title": "Country",
"type": "string"
},
"tax_id": {
"description": "The exact tax id. A CNPJ is 14 digits.",
"title": "Tax Id",
"type": "string"
}
},
"required": [
"tax_id"
],
"title": "lookup_taxpayerArguments",
"type": "object"
},
"name": "lookup_taxpayer",
"outputSchema": {
"additionalProperties": true,
"description": "One registered taxpayer, as the registry describes it.\n\nEverything but country, tax_id, kind and name can be absent: the\nregistry publishes what it has.",
"properties": {
"activity_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Activity Code"
},
"city_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "City Code"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Country"
},
"kind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Whether it is a company or a person.",
"title": "Kind"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Whatever the registry holds beyond these.",
"title": "Metadata"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"postal_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Postal Code"
},
"started_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Started At"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "State"
},
"status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"tax_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Tax Id"
},
"trade_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Trade Name"
}
},
"title": "TaxpayerResult",
"type": "object"
}
},
{
"description": "Declare this company's position on a document issued against it.\n\nLegally binding and irreversible once the tax authority accepts it —\nask the human to confirm before calling, and read back which\ndocument and which of the four positions is being filed.\n\nDenying a document (210220) or declaring the operation did not\nhappen (210240) is an accusation against whoever issued it. Never\npick either because the user sounds unsure — ask.\n\n210200 confirms the operation happened, 210210 acknowledges the\ndocument exists, 210220 denies knowing it, and 210240 states the\noperation was not carried out. Only 210240 takes a reason, and it\nrequires one; the others are refused if a reason is sent.\n",
"inputSchema": {
"properties": {
"access_key": {
"title": "Access Key",
"type": "string"
},
"manifestation": {
"enum": [
"210200",
"210210",
"210220",
"210240"
],
"title": "Manifestation",
"type": "string"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reason"
}
},
"required": [
"access_key",
"manifestation"
],
"title": "manifest_received_invoiceArguments",
"type": "object"
},
"name": "manifest_received_invoice",
"outputSchema": {
"additionalProperties": true,
"description": "What the tax authority answered to a filed manifestation.",
"properties": {
"access_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Access Key"
},
"manifestation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The code that was filed.",
"title": "Manifestation"
},
"protocol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The receipt, when the authority gave one.",
"title": "Protocol"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"title": "ManifestationResult",
"type": "object"
}
},
{
"description": "Retry a rejected invoice after the data that caused the rejection\nwas fixed.\n\nTakes the local invoice_id, not the access key: a rejected document\nnever got one. Consumes a credit like a new issuance, so it takes\nan idempotency_key for the same reason issue_invoice does. An\nauthorized invoice is corrected or cancelled, never reissued.\n",
"inputSchema": {
"properties": {
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Idempotency Key"
},
"invoice_id": {
"title": "Invoice Id",
"type": "string"
}
},
"required": [
"invoice_id"
],
"title": "reissue_invoiceArguments",
"type": "object"
},
"name": "reissue_invoice",
"outputSchema": {
"additionalProperties": true,
"description": "One document, as the fiscal API describes it.",
"properties": {
"access_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The authorizer's key. Absent while the document is not authorized.",
"title": "Access Key"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Local id. Use it for reissue and for submissions, and when a document was rejected and has no key.",
"title": "Id"
},
"protocol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The authorization protocol, when granted.",
"title": "Protocol"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "issued, rejected or cancelled.",
"title": "Status"
}
},
"title": "InvoiceResult",
"type": "object"
}
},
{
"description": "Find a code from a description, or page through a table.\n\nThis is the tool for \"what NCM is a keyboard\" — the one the\nuser actually asks. Prefer it over guessing a code from memory:\nthe tables change, and a plausible wrong code is worse than a\nlookup.\n\nLeaving `kind` unset searches every classification of that\ncountry at once, which is the most expensive call here. Set it\nwhenever the question already names one.\n\nRows come back ordered by kind then code; there is no sort\nargument, and asking for one changes nothing.\n",
"inputSchema": {
"properties": {
"country": {
"default": "BR",
"description": "ISO 3166-1 alpha-2 code. A code means nothing without it, and Brazil is the default rather than a guess.",
"maxLength": 2,
"minLength": 2,
"title": "Country",
"type": "string"
},
"kind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Narrows to one classification. All if unset.",
"title": "Kind"
},
"limit": {
"default": 20,
"description": "Rows per page. 20 by default.",
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "Rows to skip. Use it to page, not to narrow — a term is cheaper than paging to find one row.",
"minimum": 0,
"title": "Offset",
"type": "integer"
},
"term": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Matches the code or the description.",
"title": "Term"
}
},
"title": "search_fiscal_codesArguments",
"type": "object"
},
"name": "search_fiscal_codes",
"outputSchema": {
"$defs": {
"FiscalReferenceItem": {
"additionalProperties": true,
"description": "One code of one classification.",
"properties": {
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Code"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Country"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"kind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "cfop, ncm, cest, cst, csosn, ...",
"title": "Kind"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Whatever the classification carries beyond a code and a description, and it differs per kind: utrib on an NCM, ncm_code on a CEST, tax_type on a CST, null on an ISS service.",
"title": "Metadata"
}
},
"title": "FiscalReferenceItem",
"type": "object"
}
},
"additionalProperties": true,
"description": "A page of one classification, ordered by kind then code.",
"properties": {
"data": {
"items": {
"$ref": "#/$defs/FiscalReferenceItem"
},
"title": "Data",
"type": "array"
},
"next_page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Page"
},
"page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Page"
},
"per_page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Per Page"
},
"prev_page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Prev Page"
},
"total": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Total"
}
},
"title": "FiscalReferenceList",
"type": "object"
}
},
{
"description": "Check invoice data against the field rules without issuing anything.\n\nNothing is sent to the tax authority and no document is created.\nThe SDK models check field formats, and for nfe the rules the SEFAZ\nrefuses a document over: ncm and cfop on every item, and a complete\nrecipient address. Worth calling before issue_invoice whenever a\nfield was inferred rather than given.\n\nThis does not replace issuing: the authorizer's cross-field and\nfiscal rules are only checked when the document is transmitted.\n",
"inputSchema": {
"properties": {
"document_type": {
"enum": [
"nfse",
"nfe"
],
"title": "Document Type",
"type": "string"
},
"items": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Items",
"type": "array"
},
"recipient_address": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Recipient Address"
}
},
"required": [
"document_type",
"items"
],
"title": "validate_invoice_payloadArguments",
"type": "object"
},
"name": "validate_invoice_payload",
"outputSchema": {
"$defs": {
"ValidationProblem": {
"description": "One field the SDK models refused.",
"properties": {
"field": {
"title": "Field",
"type": "string"
},
"problem": {
"title": "Problem",
"type": "string"
}
},
"required": [
"field",
"problem"
],
"title": "ValidationProblem",
"type": "object"
}
},
"description": "The result of checking a payload without issuing anything.",
"properties": {
"checked": {
"description": "What was checked, so the answer is not read as more than it is.",
"title": "Checked",
"type": "string"
},
"document_type": {
"title": "Document Type",
"type": "string"
},
"errors": {
"items": {
"$ref": "#/$defs/ValidationProblem"
},
"title": "Errors",
"type": "array"
},
"valid": {
"description": "True when no field rule was broken. It does not promise the authorizer will accept the document.",
"title": "Valid",
"type": "boolean"
}
},
"required": [
"document_type",
"valid",
"checked"
],
"title": "ValidationReport",
"type": "object"
}
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:85f4e80b1a3fff33d18732aade937aec26b35673153e7d908b4e46e43c8f8c4e | sha256sum