Plano de contas (de-para)
Lê e grava a conta de débito, a conta de crédito e o código de histórico de cada evento financeiro.
O contador do cliente usa o próprio plano de contas. O de-para diz à plataforma qual conta de débito e de crédito usar para cada evento (venda, frete, taxa_gateway, comissao, recebimento, pagamento, devolucao) ao montar os lançamentos. Contas são texto livre: a plataforma não valida o formato.
Ler o de-para
Devolve uma entrada por evento já gravado. Uma loja nova pode devolver todos os eventos com contas vazias.
/api/v1/admin/accounting/account-mapAdminLê o plano de contas
Exemplo de requisição
bash
curl "$BASE_URL/api/v1/admin/accounting/account-map" \
-H "Authorization: Bearer $TOKEN"Resposta
200Entradas do de-para
json
{
"entries": [
{
"event_key": "venda",
"debit_account": "1.1.2.01",
"credit_account": "3.1.1.01",
"history_code": "001"
},
{
"event_key": "frete",
"debit_account": "",
"credit_account": "",
"history_code": ""
}
]
}Campos da resposta
entries[].event_keystringvendafretetaxa_gatewaycomissaorecebimentopagamentodevolucaoEvento financeiro.
entries[].debit_accountstringConta de débito. Vazia = ainda não mapeado.
entries[].credit_accountstringConta de crédito. Vazia = ainda não mapeado.
entries[].history_codestringCódigo de histórico do lançamento (opcional).
Erros
| Status | Quando | Corpo de exemplo |
|---|---|---|
| 401 | Sem token ou token inválido. | {"error":"missing authorization header"} |
| 403 | O usuário não tem o privilégio view_accounting (administrador raiz e administrador total passam). | {"error":"insufficient privileges","required":"view_accounting"} |
| 403 | O módulo Exportação Contábil (accounting-export) está desligado na loja. | {"error":"module_disabled","module":"accounting-export"} |
Gravar o de-para
Cria ou atualiza as entradas enviadas, em uma única transação. Eventos que você não enviar ficam como estão. A resposta é a leitura completa do de-para depois da gravação.
/api/v1/admin/accounting/account-mapAdminGrava o plano de contas
Corpo da requisição
entriesarrayobrigatórioEntradas a gravar.
event_keystringobrigatóriovendafretetaxa_gatewaycomissaorecebimentopagamentodevolucaoUm dos sete eventos.
debit_accountstringConta de débito.
credit_accountstringConta de crédito.
history_codestringCódigo de histórico.
Exemplo de requisição
bash
curl -X PUT "$BASE_URL/api/v1/admin/accounting/account-map" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"entries": [
{
"event_key": "venda",
"debit_account": "1.1.2.01",
"credit_account": "3.1.1.01",
"history_code": "001"
}
]
}'Resposta
200De-para atualizado
json
{
"entries": [
{
"event_key": "venda",
"debit_account": "1.1.2.01",
"credit_account": "3.1.1.01",
"history_code": "001"
},
{
"event_key": "frete",
"debit_account": "",
"credit_account": "",
"history_code": ""
}
]
}Erros
| Status | Quando | Corpo de exemplo |
|---|---|---|
| 400 | Corpo inválido ou event_key desconhecido. Nada é gravado. | {"error":"map_save_failed","detail":"invalid event_key \"frete2\""} |
| 401 | Sem token ou token inválido. | {"error":"missing authorization header"} |
| 403 | O usuário não tem o privilégio manage_accounting (administrador raiz e administrador total passam). | {"error":"insufficient privileges","required":"manage_accounting"} |
| 403 | O módulo Exportação Contábil (accounting-export) está desligado na loja. | {"error":"module_disabled","module":"accounting-export"} |