Exportação contábil
Como a loja entrega ao contador os dados do mês: pacotes de exportação, plano de contas, fechamento e convites.
A plataforma não faz contabilidade: ela exporta os dados para que o contador faça. Esta área reúne o que a loja precisa para fechar um mês: gerar pacotes (XML das notas, lançamentos nos layouts Domínio e Contmatic, CSV genérico), mapear cada evento financeiro para contas do plano de contas, convidar o contador e travar o mês depois de entregue.
Como funciona
- O dono mapeia os eventos financeiros para contas contábeis (Plano de contas).
- O dono convida o contador, que recebe um usuário só com leitura, exportação e fechamento (Contadores).
- No começo do mês seguinte alguém pede os pacotes da competência (Exportações) e baixa os arquivos prontos.
- Sem pendências, o contador fecha o mês (Períodos). Mês fechado bloqueia operações retroativas sobre pedidos daquele mês.
Estados
| Objeto | Estado | Significado |
|---|---|---|
| Convite | pending, accepted, expired, revoked | Convites valem 7 dias; só pending pode ser revogado. |
| Exportação | queued, running, done, failed | Só done pode ser baixada. failed traz error_msg. |
| Período | open, closed | Reabrir devolve a open e exige um motivo. |
Tipos de pacote (kind)
| Valor | Conteúdo |
|---|---|
xml_zip | ZIP com os XMLs das notas fiscais da competência e um manifesto. |
dominio | ZIP com dominio.txt (layout Domínio) e MANIFESTO.txt. |
contmatic | ZIP com contmatic.txt (layout Contmatic) e MANIFESTO.txt. |
csv | ZIP com lancamentos.csv e MANIFESTO.txt. |
Eventos financeiros (event_key)
venda, frete, taxa_gateway, comissao, recebimento, pagamento, devolucao. Um evento sem conta mapeada não some: sai com a conta NAO_MAPEADO e um aviso no manifesto. Os eventos recebimento, pagamento e taxa_gateway dependem do módulo Financeiro Essencial; sem ele são marcados como indisponíveis.
Endpoints
| Método | Caminho | Para quê | Privilégio |
|---|---|---|---|
| GET | /api/v1/admin/accounting/accountants | Lista contadores e convites | view_accounting |
| POST | /api/v1/admin/accounting/accountants/invites | Convida um contador | manage_accounting |
| DELETE | /api/v1/admin/accounting/accountants/invites/{id} | Revoga um convite | manage_accounting |
| GET | /api/v1/admin/accounting/account-map | Lê o plano de contas | view_accounting |
| PUT | /api/v1/admin/accounting/account-map | Grava o plano de contas | manage_accounting |
| POST | /api/v1/admin/accounting/exports | Pede um pacote | export_accounting |
| GET | /api/v1/admin/accounting/exports | Lista pacotes | view_accounting |
| GET | /api/v1/admin/accounting/exports/{id}/download | Baixa o ZIP | view_accounting |
| GET | /api/v1/admin/accounting/downloads | Trilha de downloads | view_accounting |
| GET | /api/v1/admin/accounting/periods | Lista os meses | view_accounting |
| POST | /api/v1/admin/accounting/periods/{competence}/close | Fecha um mês | close_accounting_period |
| POST | /api/v1/admin/accounting/periods/{competence}/reopen | Reabre um mês | manage_accounting |
Erros comuns
- Pedir pacote com
kinderrado. Sóxml_zip,dominio,contmaticecsvexistem; outro valor volta 400export_failed. - Tentar fechar o mês corrente. Só meses já encerrados podem ser fechados (400
close_failed). - Baixar antes de ficar pronto. O download de um pacote
queued,runningoufailedvolta 404. Consulte o estado antes. - Pedir de novo o mesmo pacote. Existe um pacote por
kinde competência: pedir outra vez substitui o arquivo anterior. - Esperar e-mail do convite. A API cria o convite, mas hoje não envia o link por e-mail (veja Contadores).
- Achar que tudo está atrás de um só privilégio. Um usuário com só
view_accountinglê, mas não gera nem fecha.