Billing

Lists the service provider's invoices, filtered and sorted.

Every filter is optional and combining two narrows to invoices that satisfy both. Each id filter is a comma-separated list and an invoice matches if its id is any of them; a value that is not an id is rejected with 400. A well-formed value that matches nothing is an empty page, not a 404. Deleted invoices are never listed.

SubTotal is the line-item total before discount and tax; Total is SubTotal - TotalDiscount + TotalTax. AmountPaid is computed live from recorded payments, and AmountDue is Total - AmountPaid, floored at 0.

InvoiceDate and DueDate are calendar dates. InvoiceDateSince/Before and DueDateSince/Before bound them the same way every other date filter on this surface does: the lower bound includes the day it names and the upper bound excludes it.

SortBy is one of createdOn (default), updatedOn, date (InvoiceDate), dueDate or totalAmount; SortOrder is asc or desc (default).

GET

invoices

Lists the service provider's invoices, filtered and sorted.

curl --request GET \
  --url https://api.usw.gorelo.io/v1/invoices \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": [
    {
      "Id": "3f1a9e2b-6c4d-4e2a-8b1a-0e2f7c9d1a44",
      "Number": 1042,
      "DisplayNumber": "INV-1042",
      "ClientId": 88,
      "ContractId": 4021,
      "Status": {
        "Id": 1,
        "Name": "<string>"
      },
      "InvoiceDate": "2026-09-01",
      "DueDate": "2026-10-01",
      "SubTotal": 1200,
      "TotalDiscount": 60,
      "TotalTax": 85.5,
      "Total": 1225.5,
      "AmountPaid": 500,
      "AmountDue": 725.5,
      "Reference": "PO-4471",
      "ExternalId": "<string>",
      "PaymentLink": "<string>",
      "InvoiceTemplateId": 123,
      "InvoiceEmailTemplateId": 123,
      "BrandingThemeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "IsEmailSent": true,
      "EmailSentOn": "2023-11-07T05:31:56Z",
      "CreatedOn": "2023-11-07T05:31:56Z",
      "UpdatedOn": "2023-11-07T05:31:56Z"
    }
  ],
  "DataContext": {
    "Pagination": {
      "NextCursor": "<string>",
      "PreviousCursor": "<string>",
      "HasMore": true,
      "HasPrevious": true,
      "TotalCount": 123
    }
  },
  "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>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

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.

Query Parameters

Cursor

string

Opaque pagination cursor from a previous page; omit for the first page. Only valid against the same filters and sort that produced it.

PageSize

integer<int32>

default:50

Number of items per page. 1-200 (default 50); out of range is a 400, never clamped.

ClientIds

string

Comma-separated client ids; keeps only invoices billed to any of them.

StatusIds

string

Comma-separated status ids: 1 Draft, 2 Submitted, 3 Paid, 4 Void, 5 Approved. Any other id is a 400. Omitted returns every status; deleted invoices are never listed.

ContractIds

string

Comma-separated contract ids; keeps only invoices raised from any of them.

Number

string

Exact match on the invoice's bare sequential number (the wire's Number, not DisplayNumber). A value that does not parse as a whole number is a 400.

InvoiceDateSince

string<date-time>

Keeps only invoices dated at or after this date.

InvoiceDateBefore

string<date-time>

Keeps only invoices dated strictly before this date.

DueDateSince

string<date-time>

Keeps only invoices due at or after this date.

DueDateBefore

string<date-time>

Keeps only invoices due strictly before this date.

IsEmailSent

boolean

Keeps only invoices that have (true) or have not (false) been emailed to the client.

CreatedSince

string<date-time>

Keeps only invoices created at or after this instant.

CreatedBefore

string<date-time>

Keeps only invoices created at or before this instant.

UpdatedSince

string<date-time>

Keeps only invoices last updated at or after this instant.

UpdatedBefore

string<date-time>

Keeps only invoices last updated at or before this instant.

Query

string

Free-text search against the invoice number, reference and name.

SortBy

string

default:createdOn

Sort field: createdOn (default), updatedOn, date, dueDate or totalAmount.

SortOrder

string

default:desc

Sort direction: asc or desc (default).

Response

StatusCode

enum<integer>

Available options:

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[] | null

Show child attributes

DataContext

object

The DataContext of a cursor-paginated success response: carries the paging metadata for the returned page.

Show child attributes

Notifications

object[]

Show child attributes

⌘I

Lists the service provider's invoices, filtered and sorted.

curl --request GET \
  --url https://api.usw.gorelo.io/v1/invoices \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": [
    {
      "Id": "3f1a9e2b-6c4d-4e2a-8b1a-0e2f7c9d1a44",
      "Number": 1042,
      "DisplayNumber": "INV-1042",
      "ClientId": 88,
      "ContractId": 4021,
      "Status": {
        "Id": 1,
        "Name": "<string>"
      },
      "InvoiceDate": "2026-09-01",
      "DueDate": "2026-10-01",
      "SubTotal": 1200,
      "TotalDiscount": 60,
      "TotalTax": 85.5,
      "Total": 1225.5,
      "AmountPaid": 500,
      "AmountDue": 725.5,
      "Reference": "PO-4471",
      "ExternalId": "<string>",
      "PaymentLink": "<string>",
      "InvoiceTemplateId": 123,
      "InvoiceEmailTemplateId": 123,
      "BrandingThemeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "IsEmailSent": true,
      "EmailSentOn": "2023-11-07T05:31:56Z",
      "CreatedOn": "2023-11-07T05:31:56Z",
      "UpdatedOn": "2023-11-07T05:31:56Z"
    }
  ],
  "DataContext": {
    "Pagination": {
      "NextCursor": "<string>",
      "PreviousCursor": "<string>",
      "HasMore": true,
      "HasPrevious": true,
      "TotalCount": 123
    }
  },
  "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>"
    }
  ]
}