Referencia API

Documentacao completa de todos os endpoints disponiveis. Clique em um endpoint para ver parametros, schemas e exemplos de codigo.

Autenticacao

Todas as requisicoes exigem um token Bearer no header Authorization.

Header de autenticacaotext
Authorization: Bearer topo_sk_a1b2c3d4...

URLs Base

AmbienteURL
Producaohttps://api.topocontabil.com.br
Sandboxhttps://api-sandbox.topocontabil.com.br

Tenants

Connections

Imports

Reconciliations

Webhooks

Events

Schemas

Error

codestringobrigatorio

Codigo do erro (ex. VALIDATION_ERROR, NOT_FOUND)

Exemplo: "VALIDATION_ERROR"

messagestringobrigatorio

Mensagem legivel do erro

Exemplo: "O campo 'name' e obrigatorio."

requestIdstring (uuid)obrigatorio

ID unico da requisicao para suporte

Exemplo: "550e8400-e29b-41d4-a716-446655440000"

detailsobject[]

Detalhes de validacao por campo (quando aplicavel)

Tenant

idstring (uuid)

Exemplo: "d290f1ee-6c54-4b01-90e6-d701748f0851"

namestring

Exemplo: "Grupo Exemplo S.A."

slugstring

Exemplo: "grupo-exemplo"

planstarter | professional | enterprise

Exemplo: "professional"

statusactive | suspended | trial

Exemplo: "active"

createdAtstring (date-time)
updatedAtstring (date-time)

Connection

idstring (uuid)
namestring

Exemplo: "SAP - Producao"

providersap | oracle | totvs | custom

Exemplo: "sap"

statusactive | inactive | error | pending

Exemplo: "active"

lastSyncAtstring (date-time)nullable
createdAtstring (date-time)

Import

idstring (uuid)
typetrial_balance | bank_statement | subledger

Exemplo: "trial_balance"

statuspending | processing | completed | failed

Exemplo: "completed"

fileNamestring

Exemplo: "balancete-jan-2026.xlsx"

recordCountintegernullable

Exemplo: 1247

errorCountintegernullable

Exemplo: 0

companyIdstring (uuid)
periodstring

Exemplo: "2026-01"

createdAtstring (date-time)
completedAtstring (date-time)nullable

Reconciliation

idstring (uuid)
accountCodestring

Exemplo: "1.1.01.001"

accountNamestring

Exemplo: "Caixa e Equivalentes"

companyNamestring

Exemplo: "Filial SP"

periodstring

Exemplo: "2026-01"

statusdraft | in_review | approved | rejected

Exemplo: "in_review"

openingBalancenumber (double)

Exemplo: 150000

closingBalancenumber (double)

Exemplo: 175430.5

differencenumber (double)

Exemplo: 0

assigneeIdstring (uuid)nullable
slaStatuson_time | approaching | overdue | completed_on_time | completed_late

Exemplo: "on_time"

slaDeadlinestring (date-time)
createdAtstring (date-time)
updatedAtstring (date-time)

ReconciliationDetail

adjustmentsAdjustment[]
evidenceEvidence[]
commentsComment[]
historyHistoryEntry[]

Adjustment

idstring (uuid)
descriptionstring

Exemplo: "Ajuste de provisao"

amountnumber (double)

Exemplo: 5430.5

typedebit | credit

Exemplo: "credit"

createdAtstring (date-time)

Evidence

idstring (uuid)
fileNamestring

Exemplo: "nota-fiscal-123.pdf"

fileSizeinteger

Exemplo: 245760

mimeTypestring

Exemplo: "application/pdf"

urlstring (uri)

URL pre-assinada com validade de 1 hora

uploadedAtstring (date-time)

Comment

idstring (uuid)
textstring

Exemplo: "Verificar com a contabilidade."

authorNamestring

Exemplo: "Maria Silva"

createdAtstring (date-time)

HistoryEntry

idstring (uuid)
actioncreated | submitted | approved | rejected | reopened

Exemplo: "submitted"

performedBystring

Exemplo: "Maria Silva"

notestringnullable
timestampstring (date-time)

Webhook

idstring (uuid)
urlstring (uri)

Exemplo: "https://empresa.com/webhooks/topo"

eventsstring[]

Exemplo: ["reconciliation.approved","import.completed"]

secretstring

Segredo para validacao de assinatura HMAC-SHA256

Exemplo: "whsec_..."

statusactive | inactive

Exemplo: "active"

createdAtstring (date-time)

Event

idstring (uuid)
typestring

Exemplo: "reconciliation.approved"

resourceIdstring (uuid)

ID do recurso relacionado ao evento

dataobject

Payload do evento (varia por tipo)

Exemplo: {"reconciliationId":"550e8400-e29b-41d4-a716-446655440000","status":"approved","approvedBy":"Maria Silva"}

webhookDeliveriesobject[]
createdAtstring (date-time)