Saltar al contenido principal

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​

FamiliaToolsreadwritedestructive
nfes — Notas fiscales (NF-e)248133
companies — Empresas emisoras12462
certificates — Certificados digitales3201
tax-rules — Reglas fiscales6231
tax-periods — Períodos de cálculo5221
withholdings — Retenciones8251

nfes​

ToolTipoPermisoEndpointQué hace
billing_invoices_issue_nfewritenfes.createPOST /v1/invoices/:id/issue-nfeIssue the NFe for an invoice now, outside the automatic issuance policy.
billing_nfes_listreadnfes.listGET /v1/nfesList NFes.
billing_nfes_getreadnfes.showGET /v1/nfes/:idFetch one NFe with its status and tax breakdown.
billing_nfes_createwritenfes.createPOST /v1/nfesCreate an NFe record.
billing_nfes_upsertwritenfes.createPUT /v1/nfesCreate or update an NFe matched on id → external_id.
billing_nfes_updatewritenfes.updatePATCH /v1/nfes/:idUpdate an NFe.
billing_nfes_deletedestructivenfes.updateDELETE /v1/nfes/:idSoft-delete an NFe record.
billing_nfes_issuewritenfes.createPOST /v1/nfes/:id/issueTransmit an NFe to the municipality.
billing_nfes_canceldestructivenfes.cancelPOST /v1/nfes/:id/cancelCancel an issued NFe at the municipality.
billing_nfes_retry_cancelwritenfes.retryPOST /v1/nfes/:id/retry-cancelRetry a cancellation that failed at the municipality.
billing_nfes_syncwritenfes.updatePOST /v1/nfes/:id/syncRe-read one NFe from the provider and update its local status.
billing_nfes_sync_allwritenfes.updatePOST /v1/nfes/syncRe-read every pending NFe of the organization from the provider.
billing_nfes_validate_barueriwritenfes.showPOST /v1/nfes/:id/validate-barueriValidate an NFe against the Barueri municipal service before issuing it.
billing_nfes_pdfreadnfes.showGET /v1/nfes/:id/pdfMetadata for the NFe PDF (DANFSe).
billing_nfes_xmlreadnfes.showGET /v1/nfes/:id/xmlMetadata for the NFe XML.
billing_nfes_requests_listreadnfes.showGET /v1/nfes/:id/requestsRequest/response log between this service and the NFe provider for one note — the first place to look when an issuance fails.
billing_nfes_requests_getreadnfes.showGET /v1/nfes/:id/requests/:requestIdFetch one provider request/response pair in full.
billing_nfes_request_triesreadnfes.showGET /v1/nfes/:id/request-triesIssuance attempts for one NFe, with the error that stopped each.
billing_nfes_request_tries_allreadnfes.listGET /v1/nfes/request-triesIssuance attempts across every NFe of the organization, newest first.
billing_nfes_bulk_link_invoicewritenfes.updatePOST /v1/nfes/bulkLink up to 100 NFes to an invoice, or unlink them with invoice_id: null.
billing_nfes_bulk_deletedestructivenfes.updatePOST /v1/nfes/bulk-deleteSoft-delete up to 100 NFe records in one call.
billing_nfes_fetch_from_sefazwritenfes.createPOST /v1/nfes/fetch-from-sefazFetch an NFe from SEFAZ by its access key, signed with one of the organization certificates.
billing_nfes_fetch_barueriwritenfes.showPOST /v1/nfes/fetch-barueriLook a Barueri NFSe up by its authenticity code without importing it — use to check before billing_nfes_import_barueri.
billing_nfes_import_barueriwritenfes.createPOST /v1/nfes/import-barueriImport a Barueri NFSe into the organization.

companies​

ToolTipoPermisoEndpointQué hace
billing_companies_listreadcompanies.listGET /v1/companiesList the legal entities that issue invoices and NFes for this organization.
billing_companies_getreadcompanies.showGET /v1/companies/:idFetch one legal entity with its addresses and default flag.
billing_companies_matrizreadcompanies.showGET /v1/companies/matrizFetch the head office (matriz) — the company with no parent.
billing_companies_createwritecompanies.createPOST /v1/companiesCreate a legal entity.
billing_companies_upsertwritecompanies.createPUT /v1/companiesCreate or update a company matched on id → external_id → document_number.
billing_companies_updatewritecompanies.updatePATCH /v1/companies/:idUpdate a company.
billing_companies_deletedestructivecompanies.deleteDELETE /v1/companies/:idSoft-delete a company.
billing_companies_set_defaultwritecompanies.updatePOST /v1/companies/:id/set-defaultMake this the default issuing entity — used whenever an invoice or NFe names no company.
billing_companies_deactivatedestructivecompanies.updatePOST /v1/companies/:id/deactivateDeactivate a company: no new invoice or NFe can be issued under it.
billing_companies_reactivatewritecompanies.updatePOST /v1/companies/:id/reactivateReactivate a company so invoices and NFes can be issued under it again.
billing_companies_fiscal_profile_getreadcompanies.showGET /v1/companies/:id/fiscalRead 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_updatewritecompanies.updatePATCH /v1/companies/:id/fiscalUpsert the fiscal profile of a company.

certificates​

ToolTipoPermisoEndpointQué hace
billing_certificates_listreadcertificates.listGET /v1/certificatesList the digital certificates used to sign NFes.
billing_certificates_getreadcertificates.showGET /v1/certificates/:idFetch one certificate: subject, serial number and validity window.
billing_certificates_deletedestructivecertificates.deleteDELETE /v1/certificates/:idRemove a certificate.

tax-rules​

ToolTipoPermisoEndpointQué hace
billing_tax_rules_listreadtax-rules.listGET /v1/tax_rulesList tax rules, most specific scope first.
billing_tax_rules_getreadtax-rules.showGET /v1/tax_rules/:idFetch one tax rule with its items.
billing_tax_rules_createwritetax-rules.createPOST /v1/tax_rulesCreate a tax rule with its items.
billing_tax_rules_upsertwritetax-rules.createPUT /v1/tax_rulesCreate or update a tax rule matched on id → external_id.
billing_tax_rules_updatewritetax-rules.updatePATCH /v1/tax_rules/:idUpdate a tax rule.
billing_tax_rules_deletedestructivetax-rules.deleteDELETE /v1/tax_rules/:idDelete a tax rule.

tax-periods​

ToolTipoPermisoEndpointQué hace
billing_tax_periods_listreadtax-periods.listGET /v1/tax_periodsList fiscal periods (apurações) with their gross revenue and estimated DAS.
billing_tax_periods_getreadtax-periods.showGET /v1/tax_periods/:idFetch one fiscal period with its computed taxes.
billing_tax_periods_process_monthwritetax-periods.createPOST /v1/tax_periodsCompute (or recompute) the monthly fiscal period of a company.
billing_tax_periods_actionwritetax-periods.updatePATCH /v1/tax_periods/:idAct on a fiscal period: recalculate (monthly only), close to freeze it, or reopen to unfreeze.
billing_tax_periods_deletedestructivetax-periods.updateDELETE /v1/tax_periods/:idDelete a fiscal period.

withholdings​

ToolTipoPermisoEndpointQué hace
billing_withholdings_listreadwithholdings.listGET /v1/withholdingsList tax withholdings (retenções).
billing_withholdings_getreadwithholdings.showGET /v1/withholdings/:idFetch one tax withholding with how much of it has been compensated.
billing_withholdings_createwritewithholdings.createPOST /v1/withholdingsRecord a tax withheld at source by a customer, against an invoice or an NFe.
billing_withholdings_upsertwritewithholdings.createPUT /v1/withholdingsCreate or update a withholding matched on id → external_id.
billing_withholdings_updatewritewithholdings.updatePATCH /v1/withholdings/:idUpdate a withholding — its base, amount or competence period.
billing_withholdings_deletedestructivewithholdings.deleteDELETE /v1/withholdings/:idSoft-delete a withholding.
billing_withholdings_convert_to_creditwritewithholdings.updatePOST /v1/withholdings/:id/convert-to-creditTurn one retained withholding into a credit on the customer billing account, so it offsets the next invoice.
billing_withholdings_convert_to_creditswritewithholdings.updatePOST /v1/withholdings/convert-to-creditsConvert 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.