Billing

Lists billing contracts, each with the service lines it is made of.

A contract is the agreement with a client; a service line is one set of labour terms and products inside it. Most contracts have a single service line. A service line’s id is the same identifier a time entry’s ServiceLineId carries, so a contract’s service lines are what a time entry can be billed against.

Service lines ride inside the contract rather than being fetched per contract, so a page of contracts costs a fixed number of queries. Every filter is optional; the client filter is a comma-separated list and a contract matches if its client is any of them. A well-formed value that matches nothing - a client id that owns no contracts - is an empty page, not a 404. Timestamps are UTC; StartDate and EndDate are stored as dates, so they are always midnight.

Status is derived, because a contract has no stored status: 3 Archived when the contract has been archived, 2 Expired when its end date is behind the service provider’s own today, and 1 Active otherwise. Deleted contracts are not listed at all. Archived contracts are left out unless statusIds names Archived; expired ones are listed by default, so a caller that wants only live contracts passes statusIds=1.

RecurringAmount and RecurringCost cover the products billed on the contract’s own recurring schedule, excluding one-off lines. Amount is before tax; cost is the unit cost recorded against each product line multiplied by its quantity, so the difference between them is the periodic margin. A contract’s two figures are exactly the sum of its service lines’.

LaborTerms says how a service line bills time - Unlimited Hours, Hourly, Block Hours, No Labor Terms, or Limited Hours - and LaborRates says how an hour is priced for the two that bill hourly, and is null for the rest.

GET

contracts

Lists billing contracts, each with the service lines it is made of.

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

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

fetch('https://api.usw.gorelo.io/v1/contracts', 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/contracts",
  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/contracts"

	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/contracts")

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": 4021,
      "Name": "All Labor Terms Example",
      "Status": {
        "Id": 1,
        "Name": "<string>"
      },
      "ClientId": 88,
      "LocationIds": [
        123
      ],
      "IsForAllLocations": true,
      "CreatedOn": "2023-11-07T05:31:56Z",
      "UpdatedOn": "2023-11-07T05:31:56Z",
      "Reference": "MSA-2025-014",
      "StartDate": "2023-12-25",
      "EndDate": "2023-12-25",
      "RepeatPeriod": {
        "Id": 1,
        "Name": "<string>"
      },
      "RecurringAmount": 3870,
      "RecurringCost": 1681.36,
      "ServiceLines": [
        {
          "Id": 88214,
          "Name": "Managed Services",
          "CreatedOn": "2023-11-07T05:31:56Z",
          "UpdatedOn": "2023-11-07T05:31:56Z",
          "LaborTerms": {
            "Id": 1,
            "Name": "<string>"
          },
          "LaborRates": {
            "Id": 1,
            "Name": "<string>"
          },
          "RecurringAmount": 2280,
          "RecurringCost": 591.36
        }
      ]
    }
  ],
  "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>"
    }
  ]
}

授权

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.

查询参数

Cursor

string

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

PageSize

integer<int32>

默认值:50

Number of items per page, 1-200 (default 50). Out of range is rejected, not clamped.

ClientIds

string

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

StatusIds

string

Comma-separated status ids: 1 Active, 2 Expired, 3 Archived. Omitted returns Active and Expired (archived excluded). Any other id is a 400.

响应

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[] | 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 billing contracts, each with the service lines it is made of.

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

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

fetch('https://api.usw.gorelo.io/v1/contracts', 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/contracts",
  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/contracts"

	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/contracts")

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": 4021,
      "Name": "All Labor Terms Example",
      "Status": {
        "Id": 1,
        "Name": "<string>"
      },
      "ClientId": 88,
      "LocationIds": [
        123
      ],
      "IsForAllLocations": true,
      "CreatedOn": "2023-11-07T05:31:56Z",
      "UpdatedOn": "2023-11-07T05:31:56Z",
      "Reference": "MSA-2025-014",
      "StartDate": "2023-12-25",
      "EndDate": "2023-12-25",
      "RepeatPeriod": {
        "Id": 1,
        "Name": "<string>"
      },
      "RecurringAmount": 3870,
      "RecurringCost": 1681.36,
      "ServiceLines": [
        {
          "Id": 88214,
          "Name": "Managed Services",
          "CreatedOn": "2023-11-07T05:31:56Z",
          "UpdatedOn": "2023-11-07T05:31:56Z",
          "LaborTerms": {
            "Id": 1,
            "Name": "<string>"
          },
          "LaborRates": {
            "Id": 1,
            "Name": "<string>"
          },
          "RecurringAmount": 2280,
          "RecurringCost": 591.36
        }
      ]
    }
  ],
  "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>"
    }
  ]
}