# AI_INDEX.md — Compact API Reference for AI Agents

> Auto-generated from spec on 2026-07-27T15:47:14.204Z.
> ~267 endpoints, 48 models.
> Use this for quick lookup, then fetch `/openapi.json` for full schemas.

## 1. Tag Tree

| Group | Tags | Endpoints |
|---|---|---|
| access | access > sessions, access > external-app-tokens | 12 |
| accounts | accounts, accounts > recipient, accounts > resources, accounts > professional contracts, accounts > professional invoices, accounts > fiscal entities, accounts > fiscal entities > certificate, accounts > fiscal entities > pass-gov, accounts > fiscal entities > pass-invoices, accounts > fiscal entities > mei, accounts > invoices | 59 |
| businesses | businesses > professional invoices, businesses > fiscal entities > certificate, businesses > documents, businesses > representatives, businesses, businesses > requests, businesses > fiscal entities > revenue, businesses > fiscal entities > diagnosis, businesses > fiscal entities, businesses > fiscal entities > pass-gov, businesses > fiscal entities > pass-invoices, businesses > fiscal entities > invoices-emission, businesses > categories, businesses > settings, businesses > professional categories, businesses > services, businesses > schedules | 85 |
| internal ★ | internal ★ > fiscal entities, internal ★ > fiscal entities > mei, internal ★ > fiscal entities > revenue, internal ★ > fiscal entities > pass-gov, internal ★ > fiscal entities > pass-invoices, internal ★ > fiscal entities > certificate, internal ★ > fiscal entities > requests, internal ★ > fiscal entities > invoices, internal ★ > fiscal entities > invoices-emission, internal ★ > buyer fiscal entities, internal ★ > search, internal ★ > callbacks | 71 |
| platform | platform > resources, platform > constants | 4 |
| professionals | professionals > fiscal entities, professionals > fiscal entities > certificate, professionals > documents, professionals > requests, professionals > contracts, professionals > fiscal entities > revenue, professionals > fiscal entities > diagnosis, professionals > fiscal entities > pass-gov, professionals > fiscal entities > pass-invoices, professionals > fiscal entities > invoices-emission, professionals | 36 |

## 2. Endpoints

| Method | Path | Tag | Response | Request | Errors |
|---|---|---|---|---|---|
| POST | `/sessions` | access > sessions | — | Object | 401 |
| DELETE | `/sessions` | access > sessions | — | — | 401 |
| POST | `/sessions/token-refresh` | access > sessions | — | — | 401 |
| POST | `/sessions/request` | access > sessions | — | Object | 422 |
| POST | `/sessions/password/forgot` | access > sessions | — | Object | 422 |
| POST | `/sessions/password/reset` | access > sessions | — | Object | 422 |
| POST | `/sessions/password/change` | access > sessions | — | Object | 401, 422 |
| POST | `/accounts/beauty-fair` | accounts | — | Object | — |
| POST | `/accounts/external` | accounts | — | Object | — |
| POST | `/accounts/accept-terms` | accounts | — | — | 401 |
| POST | `/accounts/{accountId}/impersonate` | accounts | — | — | 403 |
| POST | `/accounts/phone/request` | accounts | — | Object | 422 |
| PATCH | `/accounts/phone` | accounts | — | Object | 422 |
| POST | `/accounts/{accountId}/recipient` | accounts > recipient | PaymentsRecipient | Object | 422 |
| POST | `/accounts/{accountId}/recipient/pix/authorization` | accounts > recipient | — | Object | 422 |
| PATCH | `/accounts/{accountId}/recipient/pix` | accounts > recipient | PaymentsRecipient | Object | 422 |
| DELETE | `/accounts/{accountId}/recipient/pix` | accounts > recipient | — | — | 401 |
| PUT | `/accounts/{accountId}/resources` | accounts > resources | — | — | 422 |
| POST | `/accounts/{accountId}/documents` | accounts > resources | — | Object | 422 |
| DELETE | `/accounts/{accountId}/documents/{documentId}` | accounts > resources | — | — | 404 |
| GET | `/accounts/{accountId}/documents` | accounts > resources | List of PersonalDocument | — | — |
| GET | `/external-app-tokens` | access > external-app-tokens | List of ExternalAppToken | — | — |
| POST | `/external-app-tokens` | access > external-app-tokens | — | Object | 422 |
| GET | `/external-app-tokens/{tokenId}` | access > external-app-tokens | ExternalAppToken | — | 404 |
| PATCH | `/external-app-tokens/{tokenId}` | access > external-app-tokens | ExternalAppToken | Object | 422 |
| DELETE | `/external-app-tokens/{tokenId}` | access > external-app-tokens | — | — | — |
| PATCH | `/professional-invoices/{professionalinvoiceId}/emit` | businesses > professional invoices | ProfessionalInvoice | — | 400, 422 |
| PATCH | `/professional-invoices/{professionalinvoiceId}/cancel/confirmation` | businesses > professional invoices | ProfessionalInvoice | — | 400, 422 |
| POST | `/professional-invoices/{professionalinvoiceId}/reemit` | businesses > professional invoices | ProfessionalInvoice | — | 400, 422 |
| PUT | `/professional-invoices/{professionalinvoiceId}/nfse` | businesses > professional invoices | ProfessionalInvoice | — | 404, 422 |
| PATCH | `/professionals/{professionalId}/fiscal-entity/revalidate` | professionals > fiscal entities | ProfessionalFiscalEntity | — | 400, 422 |
| PUT | `/businesses/{businessId}/fiscal-entity/certificate` | businesses > fiscal entities > certificate | FiscalEntityCertificate | — | 400, 422 |
| PUT | `/professionals/{professionalId}/fiscal-entity/certificate` | professionals > fiscal entities > certificate | FiscalEntityCertificate | — | 422 |
| GET | `/professionals/{professionalId}/personal-documents` | professionals > documents | List of PersonalDocument | — | — |
| POST | `/professionals/{professionalId}/personal-documents` | professionals > documents | — | Object | 422 |
| DELETE | `/professionals/{professionalId}/personal-documents/{documentId}` | professionals > documents | — | — | 404 |
| GET | `/personal-documents` | businesses > documents | List of PersonalDocument | — | — |
| POST | `/personal-documents` | businesses > documents | — | Object | 422 |
| GET | `/personal-documents/{id}` | businesses > documents | PersonalDocument | — | 404 |
| DELETE | `/personal-documents/{id}` | businesses > documents | — | — | 404 |
| GET | `/representatives` | businesses > representatives | List of Representative | — | — |
| GET | `/representatives/{representativeId}` | businesses > representatives | Representative | — | 404 |
| POST | `/representatives` | businesses > representatives | — | Object | 422 |
| PATCH | `/representatives/{representativeId}` | businesses > representatives | Representative | Object | 422 |
| PATCH | `/professional-contracts/{professionalcontractId}/update-status` | businesses | ProfessionalContract | Object | 422 |
| PATCH | `/professional-contracts/{professionalcontractId}/cancel` | businesses | ProfessionalContract | — | 422 |
| GET | `/accounts/{accountId}/professional-contracts` | accounts > professional contracts | List of ProfessionalContract | — | — |
| GET | `/accounts/{accountId}/professional-invoices` | accounts > professional invoices | List of ProfessionalInvoice | — | — |
| POST | `/resources` | platform > resources | — | — | 400, 422 |
| DELETE | `/resources` | platform > resources | — | Object | 404 |
| POST | `/postbacks/n8n/business-requests` | businesses > requests | — | Object | — |
| PATCH | `/business-requests/{businessrequestId}/update-status` | businesses > requests | BusinessRequest | Object | 404, 422 |
| PATCH | `/business-requests/update-status` | businesses > requests | BusinessRequest | Object | 404, 422 |
| POST | `/business-requests/{businessrequestId}/update-status` | businesses > requests | BusinessRequest | Object | 404, 422 |
| GET | `/professionals/{professionalId}/business-requests/history` | professionals > requests | List of BusinessRequest | — | — |
| GET | `/professionals/{professionalId}/professional-contracts/active` | professionals > contracts | ProfessionalContract | — | — |
| GET | `/professional-fiscal-entities/revenue` | professionals > fiscal entities > revenue | List of FiscalEntityRevenueResume | — | 401, 403 |
| GET | `/businesses/{businessId}/revenue` | businesses > fiscal entities > revenue | List of FiscalEntityRevenueResume | — | 401, 403 |
| GET | `/businesses/{businessId}/fiscal-entity/diagnosis` | businesses > fiscal entities > diagnosis | Diagnosis | — | 401, 403 |
| POST | `/businesses/{businessId}/fiscal-entity/diagnosis` | businesses > fiscal entities > diagnosis | Diagnosis | — | 401, 403 |
| GET | `/professionals/{professionalId}/fiscal-entity/revenue` | professionals > fiscal entities > revenue | List of FiscalEntityRevenue | — | 401, 403 |
| GET | `/professionals/{professionalId}/fiscal-entity/diagnosis` | professionals > fiscal entities > diagnosis | Diagnosis | — | 401, 403 |
| POST | `/professionals/{professionalId}/fiscal-entity/diagnosis` | professionals > fiscal entities > diagnosis | Diagnosis | — | 401, 403 |
| GET | `/businesses/{businessId}/fiscal-entity/certificate` | businesses > fiscal entities > certificate | FiscalEntityCertificate | — | 404 |
| DELETE | `/businesses/{businessId}/fiscal-entity/certificate` | businesses > fiscal entities > certificate | — | — | — |
| POST | `/businesses/{businessId}/fiscal-entity/certificate/validate` | businesses > fiscal entities > certificate | FiscalEntityCertificate | — | 422 |
| GET | `/businesses/{businessId}/fiscal-entity` | businesses > fiscal entities | BusinessFiscalEntity | — | 404 |
| PATCH | `/businesses/{businessId}/fiscal-entity` | businesses > fiscal entities | BusinessFiscalEntity | Object | 422 |
| POST | `/businesses/{businessId}/fiscal-entity` | businesses > fiscal entities | — | Object | 422 |
| DELETE | `/businesses/{businessId}/fiscal-entity` | businesses > fiscal entities | — | — | 404 |
| GET | `/businesses/{businessId}/fiscal-entity/pass-gov` | businesses > fiscal entities > pass-gov | PassGov | — | 404 |
| POST | `/businesses/{businessId}/fiscal-entity/pass-gov` | businesses > fiscal entities > pass-gov | — | Object | 422 |
| PATCH | `/businesses/{businessId}/fiscal-entity/pass-gov` | businesses > fiscal entities > pass-gov | PassGov | Object | 422 |
| POST | `/businesses/{businessId}/fiscal-entity/pass-gov/validate` | businesses > fiscal entities > pass-gov | PassGov | — | 422 |
| GET | `/businesses/{businessId}/fiscal-entity/pass-invoices` | businesses > fiscal entities > pass-invoices | PassInvoice | — | 404 |
| POST | `/businesses/{businessId}/fiscal-entity/pass-invoices` | businesses > fiscal entities > pass-invoices | — | Object | 422 |
| PATCH | `/businesses/{businessId}/fiscal-entity/pass-invoices` | businesses > fiscal entities > pass-invoices | PassInvoice | Object | 422 |
| POST | `/businesses/{businessId}/fiscal-entity/pass-invoices/validate` | businesses > fiscal entities > pass-invoices | PassInvoice | — | 422 |
| POST | `/businesses/{businessId}/fiscal-entity/invoices-emission` | businesses > fiscal entities > invoices-emission | — | — | 422 |
| DELETE | `/businesses/{businessId}/fiscal-entity/invoices-emission` | businesses > fiscal entities > invoices-emission | — | — | — |
| POST | `/businesses/{businessId}/fiscal-entity/invoices-emission/validate` | businesses > fiscal entities > invoices-emission | EmissionValidation | — | 422 |
| GET | `/businesses/{businessId}/fiscal-entity/invoices-emission/validate` | businesses > fiscal entities > invoices-emission | EmissionValidation | — | 404 |
| GET | `/businesses/{businessId}/municipal-details` | businesses | — | — | 404 |
| GET | `/businesses/{businessId}/professionals-fiscal-details` | businesses | — | — | — |
| GET | `/professionals/{professionalId}/fiscal-entity` | professionals > fiscal entities | ProfessionalFiscalEntity | — | 404 |
| POST | `/professionals/{professionalId}/fiscal-entity` | professionals > fiscal entities | — | Object | 422 |
| PATCH | `/professionals/{professionalId}/fiscal-entity` | professionals > fiscal entities | ProfessionalFiscalEntity | Object | 422 |
| DELETE | `/professionals/{professionalId}/fiscal-entity/certificate` | professionals > fiscal entities > certificate | — | — | — |
| GET | `/professionals/{professionalId}/fiscal-entity/certificate` | professionals > fiscal entities > certificate | FiscalEntityCertificate | — | 404 |
| POST | `/professionals/{professionalId}/fiscal-entity/certificate/validate` | professionals > fiscal entities > certificate | FiscalEntityCertificate | — | 422 |
| GET | `/professionals/{professionalId}/fiscal-entity/pass-gov` | professionals > fiscal entities > pass-gov | PassGov | — | 404 |
| POST | `/professionals/{professionalId}/fiscal-entity/pass-gov` | professionals > fiscal entities > pass-gov | — | Object | 422 |
| PATCH | `/professionals/{professionalId}/fiscal-entity/pass-gov` | professionals > fiscal entities > pass-gov | PassGov | Object | 422 |
| POST | `/professionals/{professionalId}/fiscal-entity/pass-gov/validate` | professionals > fiscal entities > pass-gov | PassGov | — | 422 |
| GET | `/professionals/{professionalId}/fiscal-entity/pass-invoices` | professionals > fiscal entities > pass-invoices | PassInvoice | — | 404 |
| POST | `/professionals/{professionalId}/fiscal-entity/pass-invoices` | professionals > fiscal entities > pass-invoices | — | Object | 422 |
| PATCH | `/professionals/{professionalId}/fiscal-entity/pass-invoices` | professionals > fiscal entities > pass-invoices | PassInvoice | Object | 422 |
| POST | `/professionals/{professionalId}/fiscal-entity/pass-invoices/validate` | professionals > fiscal entities > pass-invoices | PassInvoice | — | 422 |
| POST | `/professionals/{professionalId}/fiscal-entity/invoices-emission` | professionals > fiscal entities > invoices-emission | — | — | 422 |
| DELETE | `/professionals/{professionalId}/fiscal-entity/invoices-emission` | professionals > fiscal entities > invoices-emission | — | — | — |
| POST | `/professionals/{professionalId}/fiscal-entity/invoices-emission/validate` | professionals > fiscal entities > invoices-emission | EmissionValidation | Object | 422 |
| GET | `/professionals/{professionalId}/fiscal-entity/invoices-emission/validate` | professionals > fiscal entities > invoices-emission | EmissionValidation | — | 404 |
| GET | `/accounts/{accountId}/fiscal-entity` | accounts > fiscal entities | AccountFiscalEntity | — | 404 |
| POST | `/accounts/{accountId}/fiscal-entity` | accounts > fiscal entities | — | Object | 422 |
| PATCH | `/accounts/{accountId}/fiscal-entity` | accounts > fiscal entities | AccountFiscalEntity | Object | 422 |
| PATCH | `/accounts/{accountId}/fiscal-entity/revalidate` | accounts > fiscal entities | AccountFiscalEntity | — | 422 |
| PUT | `/accounts/{accountId}/fiscal-entity/certificate` | accounts > fiscal entities > certificate | FiscalEntityCertificate | — | 422 |
| GET | `/accounts/{accountId}/fiscal-entity/certificate` | accounts > fiscal entities > certificate | FiscalEntityCertificate | — | 404 |
| POST | `/accounts/{accountId}/fiscal-entity/certificate` | accounts > fiscal entities > certificate | — | Object | 422 |
| DELETE | `/accounts/{accountId}/fiscal-entity/certificate` | accounts > fiscal entities > certificate | — | — | — |
| POST | `/accounts/{accountId}/fiscal-entity/certificate/validate` | accounts > fiscal entities > certificate | FiscalEntityCertificate | — | 422 |
| GET | `/accounts/{accountId}/fiscal-entity/pass-gov` | accounts > fiscal entities > pass-gov | PassGov | — | 404 |
| POST | `/accounts/{accountId}/fiscal-entity/pass-gov` | accounts > fiscal entities > pass-gov | — | Object | 422 |
| PATCH | `/accounts/{accountId}/fiscal-entity/pass-gov` | accounts > fiscal entities > pass-gov | PassGov | Object | 422 |
| POST | `/accounts/{accountId}/fiscal-entity/pass-gov/validate` | accounts > fiscal entities > pass-gov | PassGov | — | 422 |
| GET | `/accounts/{accountId}/fiscal-entity/pass-invoices` | accounts > fiscal entities > pass-invoices | PassInvoice | — | 404 |
| POST | `/accounts/{accountId}/fiscal-entity/pass-invoices` | accounts > fiscal entities > pass-invoices | — | Object | 422 |
| PATCH | `/accounts/{accountId}/fiscal-entity/pass-invoices` | accounts > fiscal entities > pass-invoices | PassInvoice | Object | 422 |
| POST | `/accounts/{accountId}/fiscal-entity/pass-invoices/validate` | accounts > fiscal entities > pass-invoices | PassInvoice | — | 422 |
| GET | `/accounts/{accountId}/fiscal-entity/mei` | accounts > fiscal entities > mei | — | — | 404 |
| GET | `/accounts/{accountId}/fiscal-entity/mei/diagnosis` | accounts > fiscal entities > mei | Diagnosis | — | 404 |
| POST | `/accounts/{accountId}/fiscal-entity/mei/diagnosis` | accounts > fiscal entities > mei | Diagnosis | — | 422 |
| GET | `/accounts/{accountId}/fiscal-entity/mei/cnd` | accounts > fiscal entities > mei | — | — | 404 |
| PATCH | `/accounts/{accountId}/fiscal-entity/mei/cnd` | accounts > fiscal entities > mei | — | — | 422 |
| POST | `/accounts/{accountId}/fiscal-entity/mei/cnd/notify` | accounts > fiscal entities > mei | — | — | — |
| GET | `/accounts/{accountId}/fiscal-entity/mei/das` | accounts > fiscal entities > mei | List of Das | — | — |
| PATCH | `/accounts/{accountId}/fiscal-entity/mei/das` | accounts > fiscal entities > mei | — | — | 422 |
| POST | `/accounts/{accountId}/fiscal-entity/mei/das/notify` | accounts > fiscal entities > mei | — | — | — |
| GET | `/accounts/{accountId}/fiscal-entity/mei/das/pdf` | accounts > fiscal entities > mei | — | — | 404 |
| POST | `/accounts/{accountId}/fiscal-entity/mei/ccmei/notify` | accounts > fiscal entities > mei | — | — | — |
| GET | `/accounts/{accountId}/fiscal-entity/mei/dasn` | accounts > fiscal entities > mei | — | — | 404 |
| PATCH | `/accounts/{accountId}/fiscal-entity/mei/dasn` | accounts > fiscal entities > mei | — | Object | 422 |
| POST | `/accounts/{accountId}/fiscal-entity/mei/cnpj` | accounts > fiscal entities > mei | — | Object | 422 |
| POST | `/accounts/{accountId}/invoices` | accounts > invoices | — | Object | 422 |
| GET | `/accounts/{accountId}/invoices` | accounts > invoices | List of Invoice | — | — |
| GET | `/accounts/{accountId}/invoices/{invoiceId}` | accounts > invoices | Invoice | — | 404 |
| POST | `/accounts/{accountId}/invoices/{invoiceId}/emit` | accounts > invoices | Invoice | — | 422 |
| POST | `/accounts/{accountId}/invoices/{invoiceId}/cancel` | accounts > invoices | Invoice | — | 422 |
| GET | `/accounts/{accountId}` | accounts | Account | — | 404 |
| PATCH | `/accounts/{accountId}` | accounts | Account | Object | 404, 422 |
| GET | `/accounts/{accountId}/professional-contracts/{contractId}` | accounts > professional contracts | ProfessionalContract | — | 404 |
| GET | `/accounts/{accountId}/professional-invoices/{invoiceId}` | accounts > professional invoices | ProfessionalInvoice | — | 404 |
| PATCH | `/accounts/{accountId}/professional-invoices/{invoiceId}/cancel` | accounts > professional invoices | ProfessionalInvoice | — | 422 |
| PATCH | `/accounts/{accountId}/professional-invoices/{invoiceId}/emit` | accounts > professional invoices | ProfessionalInvoice | — | 422 |
| POST | `/accounts/{accountId}/professional-invoices/{invoiceId}/reemit` | accounts > professional invoices | ProfessionalInvoice | — | 422 |
| GET | `/business-categories` | businesses > categories | List of BusinessCategory | — | — |
| POST | `/business-categories` | businesses > categories | — | Object | 422 |
| DELETE | `/business-categories/{businesscategoryId}` | businesses > categories | — | — | 404 |
| GET | `/business-categories/{businesscategoryId}` | businesses > categories | BusinessCategory | — | 404 |
| PATCH | `/business-categories/{businesscategoryId}` | businesses > categories | BusinessCategory | Object | 404, 422 |
| GET | `/business-requests` | businesses > requests | List of BusinessRequest | — | — |
| GET | `/business-requests/{businessrequestId}` | businesses > requests | BusinessRequest | — | 404 |
| GET | `/business-requests/{businessrequestId}/status` | businesses > requests | BusinessRequest | — | 404 |
| GET | `/business-settings` | businesses > settings | List of BusinessSetting | — | — |
| POST | `/business-settings` | businesses > settings | — | Object | 422 |
| DELETE | `/business-settings/{businesssettingId}` | businesses > settings | — | — | 404 |
| GET | `/business-settings/{businesssettingId}` | businesses > settings | BusinessSetting | — | 404 |
| PATCH | `/business-settings/{businesssettingId}` | businesses > settings | BusinessSetting | Object | 404, 422 |
| GET | `/businesses` | businesses | List of Business | — | — |
| POST | `/businesses` | businesses | — | Object | 422 |
| GET | `/businesses/{businessId}` | businesses | Business | — | 404 |
| PATCH | `/businesses/{businessId}` | businesses | Business | Object | 404, 422 |
| GET | `/businesses/{businessId}/constants` | platform > constants | — | — | — |
| GET | `/businesses/{businessId}/representative` | businesses > representatives | Representative | — | 404 |
| GET | `/constants` | platform > constants | — | — | — |
| GET | `/professional-categories` | businesses > professional categories | List of ProfessionalCategory | — | — |
| POST | `/professional-categories` | businesses > professional categories | — | Object | 422 |
| DELETE | `/professional-categories/{professionalcategoryId}` | businesses > professional categories | — | — | 400, 404 |
| GET | `/professional-categories/{professionalcategoryId}` | businesses > professional categories | ProfessionalCategory | — | 404 |
| PATCH | `/professional-categories/{professionalcategoryId}` | businesses > professional categories | ProfessionalCategory | Object | 404, 422 |
| GET | `/professional-contracts` | businesses | List of ProfessionalContract | — | — |
| DELETE | `/professional-contracts/{professionalcontractId}` | businesses | — | — | 404 |
| GET | `/professional-contracts/{professionalcontractId}` | businesses | ProfessionalContract | — | 404 |
| PATCH | `/professional-contracts/{professionalcontractId}/cancellation-request` | businesses | ProfessionalContract | — | 404 |
| PATCH | `/professional-contracts/{professionalcontractId}/in-approval` | businesses | ProfessionalContract | Object | 404, 422 |
| PATCH | `/professional-contracts/{professionalcontractId}/status` | businesses | ProfessionalContract | Object | 404, 422 |
| PATCH | `/professional-contracts/update-status` | businesses | ProfessionalContract | Object | 404, 422 |
| GET | `/professional-fiscal-entities` | professionals > fiscal entities | List of ProfessionalFiscalEntity | — | — |
| GET | `/professional-invoices` | businesses > professional invoices | List of ProfessionalInvoice | — | — |
| GET | `/professional-invoices/{professionalinvoiceId}` | businesses > professional invoices | ProfessionalInvoice | — | 404 |
| PATCH | `/professional-invoices/{professionalinvoiceId}` | businesses > professional invoices | ProfessionalInvoice | Object | 404, 422 |
| GET | `/professional-services` | businesses > services | List of ProfessionalService | — | — |
| POST | `/professional-services` | businesses > services | — | Object | 422 |
| DELETE | `/professional-services/{professionalserviceId}` | businesses > services | — | — | 404 |
| GET | `/professional-services/{professionalserviceId}` | businesses > services | ProfessionalService | — | 404 |
| PATCH | `/professional-services/{professionalserviceId}` | businesses > services | ProfessionalService | Object | 404, 422 |
| GET | `/professionals` | professionals | List of Professional | — | — |
| POST | `/professionals` | professionals | — | Object | 422 |
| DELETE | `/professionals/{professionalId}` | professionals | — | — | 404 |
| GET | `/professionals/{professionalId}` | professionals | Professional | — | 404 |
| PATCH | `/professionals/{professionalId}` | professionals | Professional | Object | 404, 422 |
| GET | `/professionals/{professionalId}/is-owned-by-account` | professionals | — | — | — |
| GET | `/week-schedules` | businesses > schedules | List of WeekSchedule | — | — |
| POST | `/week-schedules` | businesses > schedules | — | Object | 422 |
| DELETE | `/week-schedules/{weekscheduleId}` | businesses > schedules | — | — | 404 |
| GET | `/week-schedules/{weekscheduleId}` | businesses > schedules | WeekSchedule | — | 404 |
| GET | `/fiscal-entities` | internal ★ > fiscal entities | List of SellerFiscalEntity | — | 401, 403 |
| POST | `/fiscal-entities` | internal ★ > fiscal entities | — | Object | 401, 403, 422 |
| GET | `/fiscal-entities/{fiscalEntityId}` | internal ★ > fiscal entities | SellerFiscalEntity | — | 401, 403, 404 |
| PATCH | `/fiscal-entities/{fiscalEntityId}` | internal ★ > fiscal entities | SellerFiscalEntity | Object | 401, 403, 422 |
| DELETE | `/fiscal-entities/{fiscalEntityId}` | internal ★ > fiscal entities | — | — | 401, 403, 404 |
| POST | `/fiscal-entities/{fiscalEntityId}/revalidate` | internal ★ > fiscal entities | — | — | 401, 403, 422 |
| POST | `/fiscal-entities/{fiscalEntityId}/validate-emission` | internal ★ > fiscal entities | EmissionValidation | — | 401, 403, 422 |
| GET | `/fiscal-entities/{fiscalEntityId}/validation-status` | internal ★ > fiscal entities | EmissionValidation | — | 401, 403, 404 |
| GET | `/fiscal-entities/{fiscalEntityId}/mei` | internal ★ > fiscal entities > mei | FiscalEntityMei | — | 401, 403, 404 |
| PATCH | `/fiscal-entities/{fiscalEntityId}/mei` | internal ★ > fiscal entities > mei | FiscalEntityMei | — | 401, 403 |
| GET | `/fiscal-entities/{fiscalEntityId}/mei/das` | internal ★ > fiscal entities > mei | List of Das | — | 401, 403 |
| PATCH | `/fiscal-entities/{fiscalEntityId}/mei/das` | internal ★ > fiscal entities > mei | Das | — | 401, 403 |
| GET | `/fiscal-entities/{fiscalEntityId}/mei/das/pdf` | internal ★ > fiscal entities > mei | — | — | 401, 403, 404 |
| GET | `/fiscal-entities/{fiscalEntityId}/mei/dasn` | internal ★ > fiscal entities > mei | FiscalEntityMeiDasn | — | 401, 403 |
| PATCH | `/fiscal-entities/{fiscalEntityId}/mei/dasn` | internal ★ > fiscal entities > mei | FiscalEntityMeiDasn | — | 401, 403 |
| GET | `/fiscal-entities/{fiscalEntityId}/mei/cnd` | internal ★ > fiscal entities > mei | FiscalEntityMeiCnd | — | 401, 403 |
| PATCH | `/fiscal-entities/{fiscalEntityId}/mei/cnd` | internal ★ > fiscal entities > mei | FiscalEntityMeiCnd | — | 401, 403 |
| GET | `/fiscal-entities/{fiscalEntityId}/mei/diagnosis` | internal ★ > fiscal entities > mei | Diagnosis | — | 401, 403 |
| POST | `/fiscal-entities/{fiscalEntityId}/mei/diagnosis` | internal ★ > fiscal entities > mei | Diagnosis | — | 401, 403 |
| GET | `/fiscal-entities/{fiscalEntityId}/revenue` | internal ★ > fiscal entities > revenue | List of FiscalEntityRevenue | — | 401, 403 |
| GET | `/fiscal-entities/{fiscalEntityId}/revenue/resume` | internal ★ > fiscal entities > revenue | FiscalEntityRevenueResume | — | 401, 403 |
| GET | `/fiscal-entities/{fiscalEntityId}/pass-govs` | internal ★ > fiscal entities > pass-gov | List of PassGov | — | 401, 403 |
| POST | `/fiscal-entities/{fiscalEntityId}/pass-govs` | internal ★ > fiscal entities > pass-gov | — | Object | 401, 403, 422 |
| PATCH | `/fiscal-entities/{fiscalEntityId}/pass-govs/{passGovId}` | internal ★ > fiscal entities > pass-gov | PassGov | Object | 401, 403, 422 |
| DELETE | `/fiscal-entities/{fiscalEntityId}/pass-govs/{passGovId}` | internal ★ > fiscal entities > pass-gov | — | — | 401, 403, 404 |
| POST | `/fiscal-entities/{fiscalEntityId}/pass-govs/{passGovId}/validate` | internal ★ > fiscal entities > pass-gov | — | — | 401, 403 |
| DELETE | `/fiscal-entities/{fiscalEntityId}/pass-govs/{passGovId}/clear` | internal ★ > fiscal entities > pass-gov | — | — | 401, 403, 404 |
| GET | `/fiscal-entities/{fiscalEntityId}/pass-invoices` | internal ★ > fiscal entities > pass-invoices | List of PassInvoice | — | 401, 403 |
| POST | `/fiscal-entities/{fiscalEntityId}/pass-invoices` | internal ★ > fiscal entities > pass-invoices | — | Object | 401, 403, 422 |
| PATCH | `/fiscal-entities/{fiscalEntityId}/pass-invoices/{passInvoiceId}` | internal ★ > fiscal entities > pass-invoices | PassInvoice | Object | 401, 403, 422 |
| DELETE | `/fiscal-entities/{fiscalEntityId}/pass-invoices/{passInvoiceId}` | internal ★ > fiscal entities > pass-invoices | — | — | 401, 403, 404 |
| POST | `/fiscal-entities/{fiscalEntityId}/pass-invoices/{passInvoiceId}/validate` | internal ★ > fiscal entities > pass-invoices | — | — | 401, 403 |
| DELETE | `/fiscal-entities/{fiscalEntityId}/pass-invoices/{passInvoiceId}/clear` | internal ★ > fiscal entities > pass-invoices | — | — | 401, 403, 404 |
| GET | `/fiscal-entities/{fiscalEntityId}/certificates` | internal ★ > fiscal entities > certificate | List of FiscalEntityCertificate | — | 401, 403 |
| POST | `/fiscal-entities/{fiscalEntityId}/certificates` | internal ★ > fiscal entities > certificate | — | Object | 401, 403, 422 |
| PATCH | `/fiscal-entities/{fiscalEntityId}/certificates/{certificateId}` | internal ★ > fiscal entities > certificate | FiscalEntityCertificate | — | 401, 403 |
| DELETE | `/fiscal-entities/{fiscalEntityId}/certificates/{certificateId}` | internal ★ > fiscal entities > certificate | — | — | 401, 403, 404 |
| POST | `/fiscal-entities/{fiscalEntityId}/certificates/{certificateId}/validate` | internal ★ > fiscal entities > certificate | — | — | 401, 403 |
| DELETE | `/fiscal-entities/{fiscalEntityId}/certificates/{certificateId}/clear` | internal ★ > fiscal entities > certificate | — | — | 401, 403, 404 |
| GET | `/fiscal-entities/{fiscalEntityId}/requests` | internal ★ > fiscal entities > requests | List of FiscalEntityRequest | — | 401, 403 |
| POST | `/fiscal-entities/{fiscalEntityId}/requests` | internal ★ > fiscal entities > requests | — | Object | 401, 403 |
| GET | `/fiscal-entities/{fiscalEntityId}/requests/{requestId}` | internal ★ > fiscal entities > requests | FiscalEntityRequest | — | 401, 403, 404 |
| PATCH | `/fiscal-entities/{fiscalEntityId}/requests/{requestId}` | internal ★ > fiscal entities > requests | FiscalEntityRequest | — | 401, 403 |
| GET | `/fiscal-entities/{fiscalEntityId}/invoices` | internal ★ > fiscal entities > invoices | List of Invoice | — | 401, 403 |
| POST | `/fiscal-entities/{fiscalEntityId}/invoices` | internal ★ > fiscal entities > invoices | — | Object | 401, 403, 422 |
| GET | `/fiscal-entities/{fiscalEntityId}/invoices/{invoiceId}` | internal ★ > fiscal entities > invoices | Invoice | — | 401, 403, 404 |
| PATCH | `/fiscal-entities/{fiscalEntityId}/invoices/{invoiceId}` | internal ★ > fiscal entities > invoices | Invoice | — | 401, 403 |
| PATCH | `/fiscal-entities/{fiscalEntityId}/invoices/{invoiceId}/emit` | internal ★ > fiscal entities > invoices | — | — | 401, 403 |
| PATCH | `/fiscal-entities/{fiscalEntityId}/invoices/{invoiceId}/cancel` | internal ★ > fiscal entities > invoices | — | — | 401, 403 |
| POST | `/fiscal-entities/{fiscalEntityId}/invoices/{invoiceId}/reemit` | internal ★ > fiscal entities > invoices | — | — | 401, 403 |
| PUT | `/fiscal-entities/{fiscalEntityId}/invoices/{invoiceId}/nfse` | internal ★ > fiscal entities > invoices | — | — | 401, 403 |
| POST | `/fiscal-entities/{fiscalEntityId}/invoices-emission` | internal ★ > fiscal entities > invoices-emission | — | — | 401, 403, 422 |
| DELETE | `/fiscal-entities/{fiscalEntityId}/invoices-emission` | internal ★ > fiscal entities > invoices-emission | — | — | 401, 403 |
| POST | `/fiscal-entities/{fiscalEntityId}/invoices-emission/validate` | internal ★ > fiscal entities > invoices-emission | EmissionValidation | Object | 400, 401, 403 |
| GET | `/fiscal-entities/{fiscalEntityId}/invoices-emission/validate` | internal ★ > fiscal entities > invoices-emission | EmissionValidation | — | 401, 403 |
| GET | `/buyer-fiscal-entities` | internal ★ > buyer fiscal entities | List of BuyerFiscalEntity | — | 401, 403 |
| POST | `/buyer-fiscal-entities` | internal ★ > buyer fiscal entities | — | Object | 401, 403, 422 |
| GET | `/buyer-fiscal-entities/{buyerFiscalEntityId}` | internal ★ > buyer fiscal entities | BuyerFiscalEntity | — | 401, 403, 404 |
| PATCH | `/buyer-fiscal-entities/{buyerFiscalEntityId}` | internal ★ > buyer fiscal entities | BuyerFiscalEntity | Object | 401, 403 |
| DELETE | `/buyer-fiscal-entities/{buyerFiscalEntityId}` | internal ★ > buyer fiscal entities | — | — | 401, 403, 404 |
| GET | `/accounting/search/cnpj/{cnpj}` | internal ★ > search | — | — | 401, 403, 404 |
| GET | `/accounting/search/cpf/{cpf}` | internal ★ > search | — | — | 401, 403, 404 |
| GET | `/accounting/search/address/{address}` | internal ★ > search | — | — | 401, 403 |
| GET | `/accounting/search/municipal-details/{taxNumber}` | internal ★ > search | — | — | 401, 403, 404 |
| POST | `/accounting/callbacks/enotas` | internal ★ > callbacks | — | — | 401 |
| POST | `/accounting/callbacks/serpro` | internal ★ > callbacks | — | — | 401 |
| POST | `/accounting/callbacks/serpro-cnd` | internal ★ > callbacks | — | — | 401 |
| POST | `/accounting/callbacks/serpro-das` | internal ★ > callbacks | — | — | 401 |
| POST | `/accounting/callbacks/serpro-dasn` | internal ★ > callbacks | — | — | 401 |
| POST | `/accounting/callbacks/serpro-diagnosis` | internal ★ > callbacks | — | — | 401 |
| GET | `/accounting/diagnosis/{taxNumber}` | internal ★ > fiscal entities > mei | Diagnosis | — | 401, 403, 404 |

## 3. Models

| Name | JSON:API Type | Attributes | Relationships | Used By |
|---|---|---|---|---|
| Account | accounts | 17 | 1 | 2 endpoints |
| AccountFiscalEntity | account-fiscal-entities | 21 | 1 | 3 endpoints |
| AccountType | account-types | 1 | 0 | 0 endpoints |
| Address | — | 0 | 0 | 0 endpoints |
| Business | businesses | 12 | 6 | 3 endpoints |
| BusinessCategory | business-categories | 2 | 0 | 3 endpoints |
| BusinessFiscalEntity | business-fiscal-entities | 20 | 1 | 2 endpoints |
| BusinessRequest | business-requests | 12 | 1 | 7 endpoints |
| BusinessSetting | business-settings | 3 | 1 | 3 endpoints |
| BuyerFiscalEntity | buyer-fiscal-entities | 8 | 0 | 3 endpoints |
| CnaeItem | — | 0 | 0 | 0 endpoints |
| Das | fiscal-entity-dases | 7 | 1 | 3 endpoints |
| Diagnosis | fiscal-entity-diagnoses | 5 | 1 | 9 endpoints |
| EmissionValidation | emission-validations | 11 | 1 | 8 endpoints |
| ExternalAppToken | external-app-tokens | 5 | 0 | 3 endpoints |
| ExtraData | — | 0 | 0 | 0 endpoints |
| FiscalEntityCertificate | fiscal-entity-certificates | 11 | 2 | 11 endpoints |
| FiscalEntityMei | fiscal-entity-meis | 4 | 1 | 2 endpoints |
| FiscalEntityMeiCcmei | fiscal-entity-mei-ccmeis | 4 | 1 | 0 endpoints |
| FiscalEntityMeiCnd | fiscal-entity-mei-cnds | 4 | 1 | 2 endpoints |
| FiscalEntityMeiDasn | fiscal-entity-mei-dasns | 1 | 2 | 2 endpoints |
| FiscalEntityRequest | fiscal-entity-requests | 7 | 1 | 3 endpoints |
| FiscalEntityRevenue | fiscal-entity-revenues | 6 | 1 | 2 endpoints |
| FiscalEntityRevenueResume | fiscal-entity-revenue-resumes | 6 | 1 | 3 endpoints |
| Invoice | invoices | 18 | 2 | 7 endpoints |
| InvoiceItem | — | 0 | 0 | 0 endpoints |
| PassGov | fiscal-entity-pass-govs | 11 | 2 | 11 endpoints |
| PassInvoice | fiscal-entity-pass-invoices | 13 | 2 | 11 endpoints |
| PaymentsRecipient | billing-recipients | 5 | 1 | 2 endpoints |
| Permission | permissions | 1 | 0 | 0 endpoints |
| PersonalDocument | personal-documents | 8 | 1 | 4 endpoints |
| Phone | phones | 2 | 0 | 0 endpoints |
| PinCred | pin-creds | 1 | 0 | 0 endpoints |
| Professional | professionals | 19 | 4 | 3 endpoints |
| ProfessionalCategory | professional-categories | 7 | 1 | 3 endpoints |
| ProfessionalContract | professional-contracts | 9 | 3 | 11 endpoints |
| ProfessionalFiscalEntity | professional-fiscal-entities | 21 | 1 | 4 endpoints |
| ProfessionalInvoice | professional-invoices | 19 | 4 | 12 endpoints |
| ProfessionalService | professional-services | 4 | 2 | 3 endpoints |
| Representative | representatives | 21 | 1 | 4 endpoints |
| Resource | resources | 5 | 0 | 0 endpoints |
| SellerFiscalEntity | fiscal-entities | 26 | 3 | 3 endpoints |
| ServiceCategory | service-categories | 3 | 0 | 0 endpoints |
| Session | sessions | 4 | 0 | 0 endpoints |
| TaxData | — | 0 | 0 | 0 endpoints |
| TaxRules | — | 0 | 0 | 0 endpoints |
| TaxSystem | — | 0 | 0 | 0 endpoints |
| WeekSchedule | week-schedules | 3 | 1 | 2 endpoints |

## 4. Error Codes

| Status | Codes |
|---|---|
| 400 | fiscal_entities.cpf_validation_error, fiscal_entity_certificate.expired, invoices.emission_not_active, invoices.emissions.not_pending_or_failed, invoices.is_canceled, invoices.is_final, professional_categories.delete.has_professionals, resource.file_missing |
| 401 | auth.unauthorized |
| 403 | auth.permission_denied |
| 404 | professional_invoice.not_found, resource.not_found |
| 422 | business_request.invalid_transition, business_request.invalid_type, fiscal_entity_certificate.cnpj_required, professional_contract.invalid_transition |