Skip to main content
POST
Submit a net gain/loss journal to Xero

Query Parameters

orgId
string
required

Organization ID. Use GET /v1/companies to discover available org/company pairs.

Example:

"1"

companyId
string
required

Company ID. Use GET /v1/companies to discover available companies and their access levels.

Example:

"1"

Body

application/json
id
integer
required

Breezing transaction ID whose net gain/loss to book. This is the database id from GET /transactions, not the blockchain hash.

Required range: x > 0
nglAmount
string
required

Net gain/loss amount to book, as a positive decimal string. Journal lines under 0.01 are skipped, so an amount below 0.01 books nothing.

Pattern: ^\d+(\.\d+)?$

Response

Net gain/loss journal submitted to Xero

success
enum<boolean>
required
Available options:
true
data
object
required
Last modified on July 5, 2026