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 and combining two narrows
to the contracts that satisfy both; 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.
授权
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.
查询参数
响应
OK
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