Get an event by ID

GET

/v:version/events/:resourceId

GET

/v:version/events/:resourceId

1 curl https://test.api.solvimon.com/v1/events/ \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json"

1 {
2   "object_type": "event",
3   "id": "evt_9f8b7c6d-1234-4a56-8e9f-123456789abc",
4   "reference": "EVT-20240615-001",
5   "type": "INGEST",
6   "customer_id": "cus_4a3b2c1d-5678-4e90-8f7a-abcdef123456",
7   "customer_reference": "CUST-20240615-01",
8   "customer": {
9     "reference": "CUST-REF-001",
10     "type": "ORGANIZATION",
11     "email": "contact@acme-corp.com",
12     "roles": [
13       "DEFAULT"
14     ],
15     "object_type": "customer",
16     "id": "cus_4a3b2c1d-5678-4e90-8f7a-abcdef123456",
17     "created_at": "2023-11-20T10:15:30Z",
18     "parent_customer_id": "cus_parent_001",
19     "parent_customer_ids": [
20       "cus_parent_001",
21       "cus_grandparent_001"
22     ],
23     "status": "DRAFT",
24     "timezone": "Europe/Amsterdam",
25     "notification_preferences": [
26       {
27         "type": "INVOICE",
28         "channels": [
29           {
30             "type": "EMAIL",
31             "enabled": true
32           }
33         ]
34       }
35     ],
36     "locale": "en_NL",
37     "individual": {
38       "name": {
39         "first_name": "John",
40         "last_name": "Doe",
41         "infix": "van"
42       },
43       "residential_address": {
44         "line1": "123 Main Street",
45         "line2": "Apt 4B",
46         "city": "Amsterdam",
47         "postal_code": "1012 WX",
48         "state": "North Holland",
49         "country": "NL"
50       }
51     },
52     "organization": {
53       "legal_name": "Acme Corporation B.V.",
54       "tax_id": "NL123456789B01",
55       "tax_ids": [
56         {
57           "id": "NL123456789B01",
58           "type": "VAT"
59         }
60       ],
61       "registration_number": "KvK 12345678",
62       "tax_exempt": false,
63       "tax_exempt_note": "",
64       "registered_address": {
65         "line1": "456 Corporate Blvd",
66         "line2": "Suite 100",
67         "city": "Amsterdam",
68         "postal_code": "1017 ZX",
69         "state": "North Holland",
70         "country": "NL"
71       }
72     },
73     "custom_fields": [
74       {
75         "id": "cf_001",
76         "reference": "preferred_payment_gateway",
77         "value": "stripe",
78         "values": [
79           "stripe",
80           "adyen"
81         ],
82         "integration_details": {
83           "payment_gateway_variant": "STRIPE",
84           "id": "int_001",
85           "reference": "stripe_integration",
86           "adyen": {
87             "recurring_detail_reference": ""
88           },
89           "stripe": {
90             "payment_method_id": "pm_1GqIC8Lz0qyl6XeW3xYz5b6K"
91           }
92         }
93       }
94     ],
95     "processing_only": false,
96     "pricing_plan_subscription_selector": {
97       "data": [
98         {
99           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
100           "value": "NL"
101         }
102       ],
103       "rules": [
104         {
105           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
106           "type": "EQUALS"
107         }
108       ],
109       "filters": [
110         {
111           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
112           "type": "EQUALS",
113           "value": "NL"
114         }
115       ],
116       "fallback": "LATEST"
117     },
118     "linked_integrations": [
119       {
120         "id": "int_002",
121         "link_details": [
122           {
123             "url": "https://dashboard.stripe.com/customers/cus_4a3b2c1d",
124             "custom_field_name": "stripe_customer_link"
125           }
126         ]
127       }
128     ]
129   },
130   "meter_id": "meter_7890abcd-1234-5678-9abc-def012345678",
131   "meter_reference": "MTR-20240615-01",
132   "pricing_plan_subscription_id": "sub_12345678-90ab-cdef-1234-567890abcdef",
133   "pricing_plan_subscription_reference": "SUB-REF-20240615-01",
134   "pricing_plan_subscription_selector": {
135     "data": [
136       {
137         "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
138         "value": "NL"
139       }
140     ],
141     "rules": [
142       {
143         "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
144         "type": "EQUALS"
145       }
146     ],
147     "filters": [
148       {
149         "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
150         "type": "EQUALS",
151         "value": "NL"
152       }
153     ],
154     "fallback": "LATEST"
155   },
156   "timestamp": "2024-01-15T09:30:00Z",
157   "created_at": "2024-01-15T09:45:00Z",
158   "meter_properties": [
159     {
160       "id": "mp_001",
161       "reference": "temperature",
162       "value": "22.5"
163     }
164   ],
165   "meter_values": [
166     {
167       "id": "mv_001",
168       "reference": "energy_consumption",
169       "number": "1500",
170       "amount": {
171         "quantity": "1500",
172         "currency": "AED"
173       },
174       "count": "1"
175     }
176   ],
177   "cost_prediction": {
178     "response": "OK",
179     "details": [
180       {
181         "customer_id": "cus_4a3b2c1d-5678-4e90-8f7a-abcdef123456",
182         "periods": [
183           {
184             "period_order": 1,
185             "start_at": "2024-01-01T00:00:00Z",
186             "end_at": "2024-01-01T23:59:59Z",
187             "tax_categories": [
188               {
189                 "category": "STANDARD",
190                 "percentage": "10",
191                 "name": "VAT",
192                 "base_amount": {
193                   "quantity": "1200.00",
194                   "currency": "AED"
195                 },
196                 "tax_amount": {
197                   "quantity": "120.00",
198                   "currency": "AED"
199                 },
200                 "total_amount": {
201                   "quantity": "1320.00",
202                   "currency": "AED"
203                 },
204                 "local_amounts": {
205                   "display": true,
206                   "base_amount": {
207                     "quantity": "1200.00",
208                     "currency": "AED"
209                   },
210                   "tax_amount": {
211                     "quantity": "120.00",
212                     "currency": "AED"
213                   },
214                   "total_amount": {
215                     "quantity": "1320.00",
216                     "currency": "AED"
217                   },
218                   "used_exchange_rate": {
219                     "currency": "AED",
220                     "base_currency": "AED",
221                     "rate_timestamp": "2024-01-15T00:00:00Z",
222                     "rate": "1.0",
223                     "source": "internal"
224                   }
225                 },
226                 "notes": [
227                   "VAT at 10% rate"
228                 ],
229                 "rates": [
230                   {
231                     "name": "Standard VAT",
232                     "percentage": "10",
233                     "tax_amount": {
234                       "quantity": "120.00",
235                       "currency": "AED"
236                     }
237                   }
238                 ]
239               }
240             ],
241             "amount_excluding_tax": {
242               "quantity": "1200.00",
243               "currency": "AED"
244             },
245             "amount_including_tax": {
246               "quantity": "1320.00",
247               "currency": "AED"
248             },
249             "billing_period": {
250               "type": "DAY",
251               "value": 1
252             },
253             "groups": []
254           }
255         ],
256         "amount_excluding_tax": {
257           "quantity": "1200.00",
258           "currency": "AED"
259         },
260         "amount_including_tax": {
261           "quantity": "1320.00",
262           "currency": "AED"
263         },
264         "tax_summary": {
265           "country_code": "AE",
266           "base_amount": {
267             "quantity": "1200.00",
268             "currency": "AED"
269           },
270           "tax_amount": {
271             "quantity": "120.00",
272             "currency": "AED"
273           },
274           "total_amount": {
275             "quantity": "1320.00",
276             "currency": "AED"
277           },
278           "local_amounts": {
279             "display": true,
280             "base_amount": {
281               "quantity": "1200.00",
282               "currency": "AED"
283             },
284             "tax_amount": {
285               "quantity": "120.00",
286               "currency": "AED"
287             },
288             "total_amount": {
289               "quantity": "1320.00",
290               "currency": "AED"
291             },
292             "used_exchange_rate": {
293               "currency": "AED",
294               "base_currency": "AED",
295               "rate_timestamp": "2024-01-15T00:00:00Z",
296               "rate": "1.0",
297               "source": "internal"
298             }
299           },
300           "notes": [
301             "Standard VAT applied at 10%"
302           ]
303         }
304       }
305     ],
306     "used_change_rates": [
307       {
308         "currency": "AED",
309         "base_currency": "AED",
310         "rate_timestamp": "2024-01-15T00:00:00Z",
311         "rate": "1.0",
312         "source": "internal"
313       }
314     ]
315   },
316   "processed_details": {
317     "type": "DEFAULT",
318     "duplicate": {
319       "of_meter_data_id": "md_abcdef12-3456-7890-abcd-ef1234567890"
320     },
321     "not_matched": {
322       "variant": "none"
323     },
324     "duplicate_of_meter_data_id": "md_abcdef12-3456-7890-abcd-ef1234567890"
325   },
326   "deleted": false
327 }

Requires the METER_DATA.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Response

object_typestring or nullRead-only

idstring or nullRead-only

referencestring or nullformat: "^.*$"10-256 characters

typeenum or nullRead-only

The type of meter data.

Allowed values:

customer_idstring or null

The resource ID of the associated customer.

customer_referencestring or null

A custom reference assigned to the customer.

customerobject or null

meter_idstring or null

The resource ID of the meter.

meter_referencestring or null

A custom reference assigned to the meter.

pricing_plan_subscription_idstring or null

The resource ID of the associated pricing plan subscription.

pricing_plan_subscription_referencestring or null

A custom reference assigned to the pricing plan subscription.

pricing_plan_subscription_selectorobject

A selector to dynamically determine the subscription to use.

timestampdatetime or null

The associated timestamp presented in the ISO 8601 standard of the charge event, if not provided it will be set to 'now'.

created_atstring or nullRead-only

The associated timestamp presented in the ISO 8601 standard of the creation of the event in Solvimon.

meter_propertieslist of objects or null

The properties that provide information to give context to an event, used in the meter.

meter_valueslist of objects or null

The values used as input to calculate billable units, used in the meter.

cost_predictionobject or null

The cost prediction.

processed_detailsobject or null

Details of the result of processing the event.

deletedboolean or nullRead-only

Is MeterData marked as deleted.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors