Skip to main content
POST

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId
string<uuid>
required

Company identifier

eventId
string<uuid>
required

Event identifier — an unknown event is 404

Body

application/json
invoices
object[]
required

The event's new invoice slate, created in order — each linked to the path event

reserves
object[]
required

The expected total per reserved category — at most one entry per category

author
string

Optional display label for the source system's author (e.g. the integrator-side user). Stamped as the journal record's display attribution; the acting principal stays the External API service user, so a label can never impersonate an in-app user. Ignored on idempotent replays

Required string length: 1 - 255

Response

A fresh run returns EVERY emitted journal id in execution order (sweep — companions included — then creates, then sets); a short-circuited retry returns the client-authored ids. Either way: the created invoices' current rows and each set scope's refreshed expected total

journalIds
string<uuid>[]
required

Every emitted journal id in execution order (client-authored ids only, on a replayed retry)

invoices
object[]
required

The created invoices' current rows, in request order

reserves
object[]
required

Each set scope's refreshed expected total