Skip to main content
POST
/
xero
/
ngl
Submit a net gain/loss journal to Xero
curl --request POST \
  --url https://api.breezing.io/v1/xero/ngl \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 1,
  "nglAmount": "<string>"
}
'
import requests

url = "https://api.breezing.io/v1/xero/ngl"

payload = {
    "id": 1,
    "nglAmount": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({id: 1, nglAmount: '<string>'})
};

fetch('https://api.breezing.io/v1/xero/ngl', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.breezing.io/v1/xero/ngl",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => 1,
    'nglAmount' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.breezing.io/v1/xero/ngl"

	payload := strings.NewReader("{\n  \"id\": 1,\n  \"nglAmount\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.breezing.io/v1/xero/ngl")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": 1,\n  \"nglAmount\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.breezing.io/v1/xero/ngl")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": 1,\n  \"nglAmount\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "id": 123,
    "synced": true
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

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