Fiscal
Emisión de NF-e, las empresas emisoras y sus certificados digitales, reglas y períodos de cálculo de impuestos, y las retenciones en la fuente.
Familias en esta página
| Familia | Tools | read | write | destructive |
|---|---|---|---|---|
nfes — Notas fiscales (NF-e) | 24 | 8 | 13 | 3 |
companies — Empresas emisoras | 12 | 4 | 6 | 2 |
certificates — Certificados digitales | 3 | 2 | 0 | 1 |
tax-rules — Reglas fiscales | 6 | 2 | 3 | 1 |
tax-periods — Períodos de cálculo | 5 | 2 | 2 | 1 |
withholdings — Retenciones | 8 | 2 | 5 | 1 |
nfes
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
billing_invoices_issue_nfe | write | nfes.create | POST /v1/invoices/:id/issue-nfe | Issue the NFe for an invoice now, outside the automatic issuance policy. |
billing_nfes_list | read | nfes.list | GET /v1/nfes | List NFes. |
billing_nfes_get | read | nfes.show | GET /v1/nfes/:id | Fetch one NFe with its status and tax breakdown. |
billing_nfes_create | write | nfes.create | POST /v1/nfes | Create an NFe record. |
billing_nfes_upsert | write | nfes.create | PUT /v1/nfes | Create or update an NFe matched on id → external_id. |
billing_nfes_update | write | nfes.update | PATCH /v1/nfes/:id | Update an NFe. |
billing_nfes_delete | destructive | nfes.update | DELETE /v1/nfes/:id | Soft-delete an NFe record. |
billing_nfes_issue | write | nfes.create | POST /v1/nfes/:id/issue | Transmit an NFe to the municipality. |
billing_nfes_cancel | destructive | nfes.cancel | POST /v1/nfes/:id/cancel | Cancel an issued NFe at the municipality. |
billing_nfes_retry_cancel | write | nfes.retry | POST /v1/nfes/:id/retry-cancel | Retry a cancellation that failed at the municipality. |
billing_nfes_sync | write | nfes.update | POST /v1/nfes/:id/sync | Re-read one NFe from the provider and update its local status. |
billing_nfes_sync_all | write | nfes.update | POST /v1/nfes/sync | Re-read every pending NFe of the organization from the provider. |
billing_nfes_validate_barueri | write | nfes.show | POST /v1/nfes/:id/validate-barueri | Validate an NFe against the Barueri municipal service before issuing it. |
billing_nfes_pdf | read | nfes.show | GET /v1/nfes/:id/pdf | Metadata for the NFe PDF (DANFSe). |
billing_nfes_xml | read | nfes.show | GET /v1/nfes/:id/xml | Metadata for the NFe XML. |
billing_nfes_requests_list | read | nfes.show | GET /v1/nfes/:id/requests | Request/response log between this service and the NFe provider for one note — the first place to look when an issuance fails. |
billing_nfes_requests_get | read | nfes.show | GET /v1/nfes/:id/requests/:requestId | Fetch one provider request/response pair in full. |
billing_nfes_request_tries | read | nfes.show | GET /v1/nfes/:id/request-tries | Issuance attempts for one NFe, with the error that stopped each. |
billing_nfes_request_tries_all | read | nfes.list | GET /v1/nfes/request-tries | Issuance attempts across every NFe of the organization, newest first. |
billing_nfes_bulk_link_invoice | write | nfes.update | POST /v1/nfes/bulk | Link up to 100 NFes to an invoice, or unlink them with invoice_id: null. |
billing_nfes_bulk_delete | destructive | nfes.update | POST /v1/nfes/bulk-delete | Soft-delete up to 100 NFe records in one call. |
billing_nfes_fetch_from_sefaz | write | nfes.create | POST /v1/nfes/fetch-from-sefaz | Fetch an NFe from SEFAZ by its access key, signed with one of the organization certificates. |
billing_nfes_fetch_barueri | write | nfes.show | POST /v1/nfes/fetch-barueri | Look a Barueri NFSe up by its authenticity code without importing it — use to check before billing_nfes_import_barueri. |
billing_nfes_import_barueri | write | nfes.create | POST /v1/nfes/import-barueri | Import a Barueri NFSe into the organization. |
companies
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
billing_companies_list | read | companies.list | GET /v1/companies | List the legal entities that issue invoices and NFes for this organization. |
billing_companies_get | read | companies.show | GET /v1/companies/:id | Fetch one legal entity with its addresses and default flag. |
billing_companies_matriz | read | companies.show | GET /v1/companies/matriz | Fetch the head office (matriz) — the company with no parent. |
billing_companies_create | write | companies.create | POST /v1/companies | Create a legal entity. |
billing_companies_upsert | write | companies.create | PUT /v1/companies | Create or update a company matched on id → external_id → document_number. |
billing_companies_update | write | companies.update | PATCH /v1/companies/:id | Update a company. |
billing_companies_delete | destructive | companies.delete | DELETE /v1/companies/:id | Soft-delete a company. |
billing_companies_set_default | write | companies.update | POST /v1/companies/:id/set-default | Make this the default issuing entity — used whenever an invoice or NFe names no company. |
billing_companies_deactivate | destructive | companies.update | POST /v1/companies/:id/deactivate | Deactivate a company: no new invoice or NFe can be issued under it. |
billing_companies_reactivate | write | companies.update | POST /v1/companies/:id/reactivate | Reactivate a company so invoices and NFes can be issued under it again. |
billing_companies_fiscal_profile_get | read | companies.show | GET /v1/companies/:id/fiscal | Read the fiscal profile of a company: taxation regime, Simples annex, RBT12, factor R and every tax rate used to price an invoice. |
billing_companies_fiscal_profile_update | write | companies.update | PATCH /v1/companies/:id/fiscal | Upsert the fiscal profile of a company. |
certificates
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
billing_certificates_list | read | certificates.list | GET /v1/certificates | List the digital certificates used to sign NFes. |
billing_certificates_get | read | certificates.show | GET /v1/certificates/:id | Fetch one certificate: subject, serial number and validity window. |
billing_certificates_delete | destructive | certificates.delete | DELETE /v1/certificates/:id | Remove a certificate. |
tax-rules
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
billing_tax_rules_list | read | tax-rules.list | GET /v1/tax_rules | List tax rules, most specific scope first. |
billing_tax_rules_get | read | tax-rules.show | GET /v1/tax_rules/:id | Fetch one tax rule with its items. |
billing_tax_rules_create | write | tax-rules.create | POST /v1/tax_rules | Create a tax rule with its items. |
billing_tax_rules_upsert | write | tax-rules.create | PUT /v1/tax_rules | Create or update a tax rule matched on id → external_id. |
billing_tax_rules_update | write | tax-rules.update | PATCH /v1/tax_rules/:id | Update a tax rule. |
billing_tax_rules_delete | destructive | tax-rules.delete | DELETE /v1/tax_rules/:id | Delete a tax rule. |
tax-periods
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
billing_tax_periods_list | read | tax-periods.list | GET /v1/tax_periods | List fiscal periods (apurações) with their gross revenue and estimated DAS. |
billing_tax_periods_get | read | tax-periods.show | GET /v1/tax_periods/:id | Fetch one fiscal period with its computed taxes. |
billing_tax_periods_process_month | write | tax-periods.create | POST /v1/tax_periods | Compute (or recompute) the monthly fiscal period of a company. |
billing_tax_periods_action | write | tax-periods.update | PATCH /v1/tax_periods/:id | Act on a fiscal period: recalculate (monthly only), close to freeze it, or reopen to unfreeze. |
billing_tax_periods_delete | destructive | tax-periods.update | DELETE /v1/tax_periods/:id | Delete a fiscal period. |
withholdings
| Tool | Tipo | Permiso | Endpoint | Qué hace |
|---|---|---|---|---|
billing_withholdings_list | read | withholdings.list | GET /v1/withholdings | List tax withholdings (retenções). |
billing_withholdings_get | read | withholdings.show | GET /v1/withholdings/:id | Fetch one tax withholding with how much of it has been compensated. |
billing_withholdings_create | write | withholdings.create | POST /v1/withholdings | Record a tax withheld at source by a customer, against an invoice or an NFe. |
billing_withholdings_upsert | write | withholdings.create | PUT /v1/withholdings | Create or update a withholding matched on id → external_id. |
billing_withholdings_update | write | withholdings.update | PATCH /v1/withholdings/:id | Update a withholding — its base, amount or competence period. |
billing_withholdings_delete | destructive | withholdings.delete | DELETE /v1/withholdings/:id | Soft-delete a withholding. |
billing_withholdings_convert_to_credit | write | withholdings.update | POST /v1/withholdings/:id/convert-to-credit | Turn one retained withholding into a credit on the customer billing account, so it offsets the next invoice. |
billing_withholdings_convert_to_credits | write | withholdings.update | POST /v1/withholdings/convert-to-credits | Convert several retained withholdings into credits in one call. |
Los campos de cada recurso están en la Referencia de la API y en billing_schemas_get.
Una tool que no puedes ejecutar no aparece en tools/list. Si falta alguna de esta página, ve Autenticación.