Billing

Raises a manual invoice against a client, with line items.

Required: ClientId, and at least one line item with ItemId and Quantity.

Optional:StatusId (defaults to Draft), InvoiceDate (defaults to today), DueDate (defaults to InvoiceDate), Reference, RecipientEmails. Per line: UnitPrice, UnitCost, TaxId, CoaCode, Description, BillableStatusId and DiscountPercent each fall back to the referenced item’s own value when omitted.

StatusId is 1 (Draft) or 5 (Approved). Approving on create also pushes the invoice to the connected accounting system. An Approved invoice whose total comes to exactly 0 is created as Paid instead - check Status on the response rather than assuming it matches what you sent.

The response is just the created invoice’s Id - the same shape Create Ticket and Create Time Entry return.

POST

invoices

Raises a manual invoice against a client, with line items.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/invoices \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "ClientId": 88,
  "StatusId": 1,
  "InvoiceDate": "2026-09-15T00:00:00.0000000+00:00",
  "DueDate": "2026-10-15T00:00:00.0000000+00:00",
  "Reference": "PO-4471",
  "RecipientEmails": [
    "<string>"
  ],
  "LineItems": [
    {
      "ItemId": "9214",
      "Description": "<string>",
      "Quantity": 2,
      "UnitPrice": 150,
      "UnitCost": 90,
      "DiscountPercent": 10,
      "TaxId": 123,
      "CoaCode": "<string>",
      "BillableStatusId": 123
    }
  ]
}
'

import requests

url = "https://api.usw.gorelo.io/v1/invoices"

payload = {
    "ClientId": 88,
    "StatusId": 1,
    "InvoiceDate": "2026-09-15T00:00:00.0000000+00:00",
    "DueDate": "2026-10-15T00:00:00.0000000+00:00",
    "Reference": "PO-4471",
    "RecipientEmails": ["<string>"],
    "LineItems": [
        {
            "ItemId": "9214",
            "Description": "<string>",
            "Quantity": 2,
            "UnitPrice": 150,
            "UnitCost": 90,
            "DiscountPercent": 10,
            "TaxId": 123,
            "CoaCode": "<string>",
            "BillableStatusId": 123
        }
    ]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    ClientId: 88,
    StatusId: 1,
    InvoiceDate: '2026-09-15T00:00:00.0000000+00:00',
    DueDate: '2026-10-15T00:00:00.0000000+00:00',
    Reference: 'PO-4471',
    RecipientEmails: ['<string>'],
    LineItems: [
      {
        ItemId: '9214',
        Description: '<string>',
        Quantity: 2,
        UnitPrice: 150,
        UnitCost: 90,
        DiscountPercent: 10,
        TaxId: 123,
        CoaCode: '<string>',
        BillableStatusId: 123
      }
    ]
  })
};

fetch('https://api.usw.gorelo.io/v1/invoices', 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.usw.gorelo.io/v1/invoices",
  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([
    'ClientId' => 88,
    'StatusId' => 1,
    'InvoiceDate' => '2026-09-15T00:00:00.0000000+00:00',
    'DueDate' => '2026-10-15T00:00:00.0000000+00:00',
    'Reference' => 'PO-4471',
    'RecipientEmails' => [
        '<string>'
    ],
    'LineItems' => [
        [
                'ItemId' => '9214',
                'Description' => '<string>',
                'Quantity' => 2,
                'UnitPrice' => 150,
                'UnitCost' => 90,
                'DiscountPercent' => 10,
                'TaxId' => 123,
                'CoaCode' => '<string>',
                'BillableStatusId' => 123
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <api-key>"
  ],
]);

$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.usw.gorelo.io/v1/invoices"

	payload := strings.NewReader("{\n  \"ClientId\": 88,\n  \"StatusId\": 1,\n  \"InvoiceDate\": \"2026-09-15T00:00:00.0000000+00:00\",\n  \"DueDate\": \"2026-10-15T00:00:00.0000000+00:00\",\n  \"Reference\": \"PO-4471\",\n  \"RecipientEmails\": [\n    \"<string>\"\n  ],\n  \"LineItems\": [\n    {\n      \"ItemId\": \"9214\",\n      \"Description\": \"<string>\",\n      \"Quantity\": 2,\n      \"UnitPrice\": 150,\n      \"UnitCost\": 90,\n      \"DiscountPercent\": 10,\n      \"TaxId\": 123,\n      \"CoaCode\": \"<string>\",\n      \"BillableStatusId\": 123\n    }\n  ]\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+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.usw.gorelo.io/v1/invoices")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"ClientId\": 88,\n  \"StatusId\": 1,\n  \"InvoiceDate\": \"2026-09-15T00:00:00.0000000+00:00\",\n  \"DueDate\": \"2026-10-15T00:00:00.0000000+00:00\",\n  \"Reference\": \"PO-4471\",\n  \"RecipientEmails\": [\n    \"<string>\"\n  ],\n  \"LineItems\": [\n    {\n      \"ItemId\": \"9214\",\n      \"Description\": \"<string>\",\n      \"Quantity\": 2,\n      \"UnitPrice\": 150,\n      \"UnitCost\": 90,\n      \"DiscountPercent\": 10,\n      \"TaxId\": 123,\n      \"CoaCode\": \"<string>\",\n      \"BillableStatusId\": 123\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/invoices")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"ClientId\": 88,\n  \"StatusId\": 1,\n  \"InvoiceDate\": \"2026-09-15T00:00:00.0000000+00:00\",\n  \"DueDate\": \"2026-10-15T00:00:00.0000000+00:00\",\n  \"Reference\": \"PO-4471\",\n  \"RecipientEmails\": [\n    \"<string>\"\n  ],\n  \"LineItems\": [\n    {\n      \"ItemId\": \"9214\",\n      \"Description\": \"<string>\",\n      \"Quantity\": 2,\n      \"UnitPrice\": 150,\n      \"UnitCost\": 90,\n      \"DiscountPercent\": 10,\n      \"TaxId\": 123,\n      \"CoaCode\": \"<string>\",\n      \"BillableStatusId\": 123\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

授权

X-API-Key

string

header

必填

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

请求体

The invoice to create.

Raises a manual invoice against a client, with line items.

ClientId

integer<int64>

Client to bill. Validated against the service provider - an unknown client is a 404.

示例:

88

StatusId

integer<int32> | null

Status to create the invoice in: 1 = Draft (default) or 5 = Approved. Any other value is rejected. Approving on create pushes the invoice to the connected accounting system, the same as approving it in the app. An Approved invoice whose computed total is exactly 0 is recorded as Paid instead.

示例:

1

InvoiceDate

string<date-time> | null

Date the invoice is raised, a calendar date. Defaults to today (service provider's local date) when omitted.

示例:

"2026-09-15T00:00:00.0000000+00:00"

DueDate

string<date-time> | null

Date payment is due, a calendar date. Defaults to InvoiceDate when omitted. Must not be earlier than InvoiceDate.

示例:

"2026-10-15T00:00:00.0000000+00:00"

Reference

string | null

Free-text reference for the invoice, or omit for none.

示例:

"PO-4471"

RecipientEmails

string[] | null

Email addresses to send the invoice to. Optional.

LineItems

object[]

Line items for this invoice. At least one is required. Lines carry no task/ticket/time-entry linkage - that belongs to contract-generated invoices, out of scope for a manual one. A line whose ItemId is a bundle is billed as one line and stored as the bundle's parts, the same way the app stores it; the caller never sends the parts.

Show child attributes

响应

StatusCode

enum<integer>

可用选项:

100,

101,

102,

103,

200,

201,

202,

203,

204,

205,

206,

207,

208,

226,

300,

301,

302,

303,

304,

305,

306,

307,

308,

400,

401,

402,

403,

404,

405,

406,

407,

408,

409,

410,

411,

412,

413,

414,

415,

416,

417,

421,

422,

423,

424,

426,

428,

429,

431,

451,

500,

501,

502,

503,

504,

505,

506,

507,

508,

510,

511

IsSuccess

boolean

Data

object

Result of a create-invoice request. Matches Create Ticket/Create Time Entry's minimal shape: just the new record's Id. Fetch the invoice back through GET /v1/invoices/{invoiceId} for the full record.

Show child attributes

DataContext

object | null

示例:

null

Notifications

object[]

Show child attributes

⌘I

Raises a manual invoice against a client, with line items.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/invoices \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "ClientId": 88,
  "StatusId": 1,
  "InvoiceDate": "2026-09-15T00:00:00.0000000+00:00",
  "DueDate": "2026-10-15T00:00:00.0000000+00:00",
  "Reference": "PO-4471",
  "RecipientEmails": [
    "<string>"
  ],
  "LineItems": [
    {
      "ItemId": "9214",
      "Description": "<string>",
      "Quantity": 2,
      "UnitPrice": 150,
      "UnitCost": 90,
      "DiscountPercent": 10,
      "TaxId": 123,
      "CoaCode": "<string>",
      "BillableStatusId": 123
    }
  ]
}
'

import requests

url = "https://api.usw.gorelo.io/v1/invoices"

payload = {
    "ClientId": 88,
    "StatusId": 1,
    "InvoiceDate": "2026-09-15T00:00:00.0000000+00:00",
    "DueDate": "2026-10-15T00:00:00.0000000+00:00",
    "Reference": "PO-4471",
    "RecipientEmails": ["<string>"],
    "LineItems": [
        {
            "ItemId": "9214",
            "Description": "<string>",
            "Quantity": 2,
            "UnitPrice": 150,
            "UnitCost": 90,
            "DiscountPercent": 10,
            "TaxId": 123,
            "CoaCode": "<string>",
            "BillableStatusId": 123
        }
    ]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    ClientId: 88,
    StatusId: 1,
    InvoiceDate: '2026-09-15T00:00:00.0000000+00:00',
    DueDate: '2026-10-15T00:00:00.0000000+00:00',
    Reference: 'PO-4471',
    RecipientEmails: ['<string>'],
    LineItems: [
      {
        ItemId: '9214',
        Description: '<string>',
        Quantity: 2,
        UnitPrice: 150,
        UnitCost: 90,
        DiscountPercent: 10,
        TaxId: 123,
        CoaCode: '<string>',
        BillableStatusId: 123
      }
    ]
  })
};

fetch('https://api.usw.gorelo.io/v1/invoices', 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.usw.gorelo.io/v1/invoices",
  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([
    'ClientId' => 88,
    'StatusId' => 1,
    'InvoiceDate' => '2026-09-15T00:00:00.0000000+00:00',
    'DueDate' => '2026-10-15T00:00:00.0000000+00:00',
    'Reference' => 'PO-4471',
    'RecipientEmails' => [
        '<string>'
    ],
    'LineItems' => [
        [
                'ItemId' => '9214',
                'Description' => '<string>',
                'Quantity' => 2,
                'UnitPrice' => 150,
                'UnitCost' => 90,
                'DiscountPercent' => 10,
                'TaxId' => 123,
                'CoaCode' => '<string>',
                'BillableStatusId' => 123
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <api-key>"
  ],
]);

$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.usw.gorelo.io/v1/invoices"

	payload := strings.NewReader("{\n  \"ClientId\": 88,\n  \"StatusId\": 1,\n  \"InvoiceDate\": \"2026-09-15T00:00:00.0000000+00:00\",\n  \"DueDate\": \"2026-10-15T00:00:00.0000000+00:00\",\n  \"Reference\": \"PO-4471\",\n  \"RecipientEmails\": [\n    \"<string>\"\n  ],\n  \"LineItems\": [\n    {\n      \"ItemId\": \"9214\",\n      \"Description\": \"<string>\",\n      \"Quantity\": 2,\n      \"UnitPrice\": 150,\n      \"UnitCost\": 90,\n      \"DiscountPercent\": 10,\n      \"TaxId\": 123,\n      \"CoaCode\": \"<string>\",\n      \"BillableStatusId\": 123\n    }\n  ]\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+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.usw.gorelo.io/v1/invoices")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"ClientId\": 88,\n  \"StatusId\": 1,\n  \"InvoiceDate\": \"2026-09-15T00:00:00.0000000+00:00\",\n  \"DueDate\": \"2026-10-15T00:00:00.0000000+00:00\",\n  \"Reference\": \"PO-4471\",\n  \"RecipientEmails\": [\n    \"<string>\"\n  ],\n  \"LineItems\": [\n    {\n      \"ItemId\": \"9214\",\n      \"Description\": \"<string>\",\n      \"Quantity\": 2,\n      \"UnitPrice\": 150,\n      \"UnitCost\": 90,\n      \"DiscountPercent\": 10,\n      \"TaxId\": 123,\n      \"CoaCode\": \"<string>\",\n      \"BillableStatusId\": 123\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/invoices")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"ClientId\": 88,\n  \"StatusId\": 1,\n  \"InvoiceDate\": \"2026-09-15T00:00:00.0000000+00:00\",\n  \"DueDate\": \"2026-10-15T00:00:00.0000000+00:00\",\n  \"Reference\": \"PO-4471\",\n  \"RecipientEmails\": [\n    \"<string>\"\n  ],\n  \"LineItems\": [\n    {\n      \"ItemId\": \"9214\",\n      \"Description\": \"<string>\",\n      \"Quantity\": 2,\n      \"UnitPrice\": 150,\n      \"UnitCost\": 90,\n      \"DiscountPercent\": 10,\n      \"TaxId\": 123,\n      \"CoaCode\": \"<string>\",\n      \"BillableStatusId\": 123\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}