/api/v1/things/{id}/costs

GET

const url = 'https://example.com/api/v1/things/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/costs';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/things/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/costs

Parameters

Path Parameters

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Query Parameters

from

string

<= 40 characters

string

<= 40 characters

Responses

200

Default Response

application/json

object

period

required

object

from

required

string

required

string

distance

required

Any of:

object
null

object

value

required

string

unit

required

string

basis

required

string

Allowed values: readings

months

required

Array<object>

object

month

required

string

soFar

required

boolean

byCurrency

required

Array<object>

object

currency

required

string

fuel

required

string

service

required

string

fees

required

string

total

required

string

notes

required

Array<string>

totals

required

Array<object>

object

currency

required

string

fuel

required

string

service

required

string

fees

required

string

total

required

string

perDistance

string

monthlyAverage

required

string

moneyHidden

boolean

Example

{
  "distance": {
    "basis": "readings"
  },
  "moneyHidden": true
}