Ingest a list of meter events

POST

/v:version/events/ingest-list

POST

/v:version/events/ingest-list

1 curl -X POST https://test.api.solvimon.com/v1/events/ingest-list \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "meter_datas": [
6     {
7       "reference": "reference_1664176205",
8       "customer_id": "cust_zwDeN40tsF98JTBsea1j",
9       "customer_reference": "customerReference_1664176205",
10       "meter_id": "metr_owDe9k0tsIY5LkBAel1E",
11       "meter_reference": "meterReference_1664176205",
12       "pricing_plan_subscription_id": "ppsu_gwDeeN0tBe7h5NAw9d1q",
13       "pricing_plan_subscription_reference": "pricingPlanSubscriptionReference_1664176205",
14       "timestamp": "2024-04-12T15:22:37Z",
15       "meter_properties": [
16         {
17           "id": "metp_owDe9k0tsIY5LkBAel1E",
18           "reference": "meterPropertyReference_1664176205",
19           "value": "DE"
20         }
21       ],
22       "meter_values": [
23         {
24           "id": "metv_owDe9k0tsIY5LkBAel1E",
25           "reference": "meterValueReference_1664176205",
26           "number": "1"
27         }
28       ]
29     }
30   ]
31 }'

1 {
2   "meter_datas": [
3     {
4       "object_type": "string",
5       "id": "string",
6       "reference": "string",
7       "type": "INGEST",
8       "customer_id": "string",
9       "customer_reference": "string",
10       "customer": {
11         "reference": "string",
12         "type": "ORGANIZATION",
13         "email": "string",
14         "roles": [
15           "DEFAULT"
16         ],
17         "object_type": "string",
18         "id": "string",
19         "created_at": "string",
20         "parent_customer_id": "string",
21         "parent_customer_ids": [
22           "string"
23         ],
24         "status": "DRAFT",
25         "timezone": "string",
26         "notification_preferences": [
27           {
28             "type": "INVOICE",
29             "channels": [
30               {
31                 "type": "EMAIL",
32                 "enabled": true
33               }
34             ]
35           }
36         ],
37         "locale": "string",
38         "individual": {
39           "name": {
40             "first_name": "string",
41             "last_name": "string",
42             "infix": "string"
43           },
44           "residential_address": {
45             "line1": "string",
46             "line2": "string",
47             "city": "string",
48             "postal_code": "string",
49             "state": "string",
50             "country": "AD"
51           }
52         },
53         "organization": {
54           "legal_name": "string",
55           "tax_id": "string",
56           "tax_ids": [
57             {
58               "id": "string",
59               "type": "GENERIC_TAX_ID",
60               "tax_id_validation_result": {
61                 "id": "string",
62                 "validation_date": "string",
63                 "source": "string",
64                 "valid": "VALID",
65                 "message": "string"
66               }
67             }
68           ],
69           "registration_number": "string",
70           "tax_exempt": true,
71           "tax_exempt_note": "string",
72           "registered_address": {
73             "line1": "string",
74             "line2": "string",
75             "city": "string",
76             "postal_code": "string",
77             "state": "string",
78             "country": "AD"
79           },
80           "tax_registrations": [
81             {
82               "id": "string",
83               "description": "string",
84               "tax_id": "string",
85               "tax_ids": [
86                 {
87                   "id": "string",
88                   "type": "GENERIC_TAX_ID",
89                   "tax_id_validation_result": {
90                     "id": "string",
91                     "validation_date": "string",
92                     "source": "string",
93                     "valid": "VALID",
94                     "message": "string"
95                   }
96                 }
97               ],
98               "registration_number": "string",
99               "registered_address": {
100                 "line1": "string",
101                 "line2": "string",
102                 "city": "string",
103                 "postal_code": "string",
104                 "state": "string",
105                 "country": "AD"
106               }
107             }
108           ]
109         },
110         "custom_fields": [
111           {
112             "id": "string",
113             "reference": "string",
114             "value": "string",
115             "values": [
116               "string"
117             ],
118             "integration_details": {
119               "payment_gateway_variant": "ADYEN",
120               "id": "string",
121               "reference": "string",
122               "adyen": {
123                 "recurring_detail_reference": "string"
124               },
125               "stripe": {
126                 "payment_method_id": "string"
127               }
128             }
129           }
130         ],
131         "processing_only": true,
132         "pricing_plan_subscription_selector": {
133           "data": [
134             {
135               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
136               "value": "string"
137             }
138           ],
139           "rules": [
140             {
141               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
142               "type": "EQUALS"
143             }
144           ],
145           "filters": [
146             {
147               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
148               "type": "EQUALS",
149               "value": "string"
150             }
151           ],
152           "fallback": "LATEST"
153         },
154         "linked_integrations": [
155           {
156             "id": "string",
157             "link_details": [
158               {
159                 "url": "string",
160                 "custom_field_name": "string"
161               }
162             ]
163           }
164         ]
165       },
166       "meter_id": "string",
167       "meter_reference": "string",
168       "pricing_plan_subscription_id": "string",
169       "pricing_plan_subscription_reference": "string",
170       "pricing_plan_subscription_selector": {
171         "data": [
172           {
173             "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
174             "value": "string"
175           }
176         ],
177         "rules": [
178           {
179             "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
180             "type": "EQUALS"
181           }
182         ],
183         "filters": [
184           {
185             "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
186             "type": "EQUALS",
187             "value": "string"
188           }
189         ],
190         "fallback": "LATEST"
191       },
192       "timestamp": "2024-01-15T09:30:00Z",
193       "created_at": "string",
194       "meter_properties": [
195         {
196           "id": "string",
197           "reference": "string",
198           "value": "string"
199         }
200       ],
201       "meter_values": [
202         {
203           "id": "string",
204           "reference": "string",
205           "number": "string",
206           "amount": {
207             "quantity": "string",
208             "currency": "AED"
209           },
210           "count": "string"
211         }
212       ],
213       "cost_prediction": {
214         "response": "OK",
215         "details": [
216           {
217             "customer_id": "string",
218             "periods": [
219               {
220                 "period_order": 1,
221                 "start_at": "string",
222                 "end_at": "string",
223                 "tax_categories": [
224                   {
225                     "category": "string",
226                     "percentage": "string",
227                     "name": "string",
228                     "base_amount": {
229                       "quantity": "string",
230                       "currency": "AED"
231                     },
232                     "tax_amount": {
233                       "quantity": "string",
234                       "currency": "AED"
235                     },
236                     "total_amount": {
237                       "quantity": "string",
238                       "currency": "AED"
239                     },
240                     "local_amounts": {
241                       "display": true,
242                       "base_amount": {
243                         "quantity": "string",
244                         "currency": "AED"
245                       },
246                       "tax_amount": {
247                         "quantity": "string",
248                         "currency": "AED"
249                       },
250                       "total_amount": {
251                         "quantity": "string",
252                         "currency": "AED"
253                       },
254                       "used_exchange_rate": {
255                         "currency": "string",
256                         "base_currency": "string",
257                         "rate_timestamp": "string",
258                         "rate": "string",
259                         "source": "string"
260                       }
261                     },
262                     "notes": [
263                       "string"
264                     ],
265                     "rates": [
266                       {
267                         "name": "string",
268                         "percentage": "string",
269                         "tax_amount": {
270                           "quantity": "string",
271                           "currency": "AED"
272                         }
273                       }
274                     ]
275                   }
276                 ],
277                 "amount_excluding_tax": {
278                   "quantity": "string",
279                   "currency": "AED"
280                 },
281                 "amount_including_tax": {
282                   "quantity": "string",
283                   "currency": "AED"
284                 },
285                 "billing_period": {
286                   "type": "DAY",
287                   "value": 1
288                 },
289                 "groups": [
290                   {
291                     "group_order": 1,
292                     "tax_categories": [
293                       {
294                         "category": "string",
295                         "percentage": "string",
296                         "name": "string",
297                         "base_amount": {
298                           "quantity": "string",
299                           "currency": "AED"
300                         },
301                         "tax_amount": {
302                           "quantity": "string",
303                           "currency": "AED"
304                         },
305                         "total_amount": {
306                           "quantity": "string",
307                           "currency": "AED"
308                         },
309                         "local_amounts": {
310                           "display": true,
311                           "base_amount": {
312                             "quantity": "string",
313                             "currency": "AED"
314                           },
315                           "tax_amount": {
316                             "quantity": "string",
317                             "currency": "AED"
318                           },
319                           "total_amount": {
320                             "quantity": "string",
321                             "currency": "AED"
322                           },
323                           "used_exchange_rate": {
324                             "currency": "string",
325                             "base_currency": "string",
326                             "rate_timestamp": "string",
327                             "rate": "string",
328                             "source": "string"
329                           }
330                         },
331                         "notes": [
332                           "string"
333                         ],
334                         "rates": [
335                           {
336                             "name": "string",
337                             "percentage": "string",
338                             "tax_amount": {
339                               "quantity": "string",
340                               "currency": "AED"
341                             }
342                           }
343                         ]
344                       }
345                     ],
346                     "amount_excluding_tax": {
347                       "quantity": "string",
348                       "currency": "AED"
349                     },
350                     "amount_including_tax": {
351                       "quantity": "string",
352                       "currency": "AED"
353                     },
354                     "billing_period": {
355                       "type": "DAY",
356                       "value": 1
357                     },
358                     "start_at": "string",
359                     "end_at": "string",
360                     "type": "string",
361                     "product_category": {
362                       "name": "string",
363                       "reference": "string",
364                       "object_type": "string",
365                       "id": "string",
366                       "description": "string",
367                       "tax_category": "STANDARD",
368                       "display_order": 1
369                     },
370                     "products": [
371                       {
372                         "category_id": "string",
373                         "name": "string",
374                         "reference": "string",
375                         "product_type": "DEFAULT",
376                         "object_type": "string",
377                         "id": "string",
378                         "category": {
379                           "name": "string",
380                           "reference": "string",
381                           "object_type": "string",
382                           "id": "string",
383                           "description": "string",
384                           "tax_category": "STANDARD",
385                           "display_order": 1
386                         },
387                         "parent_product_id": "string",
388                         "description": "string",
389                         "status": "DRAFT",
390                         "tax_category": "STANDARD",
391                         "features": [
392                           {
393                             "reference": "string",
394                             "id": "string"
395                           }
396                         ],
397                         "custom_fields": [
398                           {
399                             "id": "string",
400                             "reference": "string",
401                             "value": "string",
402                             "values": [
403                               "string"
404                             ],
405                             "integration_details": {
406                               "payment_gateway_variant": "ADYEN",
407                               "id": "string",
408                               "reference": "string",
409                               "adyen": {
410                                 "recurring_detail_reference": "string"
411                               },
412                               "stripe": {
413                                 "payment_method_id": "string"
414                               }
415                             }
416                           }
417                         ],
418                         "display_order": 1,
419                         "linked_integrations": [
420                           {
421                             "id": "string",
422                             "link_details": [
423                               {
424                                 "url": "string",
425                                 "custom_field_name": "string"
426                               }
427                             ]
428                           }
429                         ],
430                         "billing_entity_id": "string"
431                       }
432                     ],
433                     "pricing": {
434                       "id": "string",
435                       "name": "string"
436                     },
437                     "description": "string",
438                     "pricing_plan_subscription_id": "string",
439                     "pricing_plan_schedule_id": "string",
440                     "forwarded_from_customer_id": "string",
441                     "lines": [
442                       {
443                         "id": "string",
444                         "line_order": 1,
445                         "description": "string",
446                         "pricing_item_id": "string",
447                         "pricing_item_config_id": "string",
448                         "product_items": [
449                           {
450                             "reference": "string",
451                             "object_type": "string",
452                             "id": "string",
453                             "product_id": "string",
454                             "product": {
455                               "category_id": "string",
456                               "name": "string",
457                               "reference": "string",
458                               "product_type": "DEFAULT",
459                               "object_type": "string",
460                               "id": "string",
461                               "category": {
462                                 "name": "string",
463                                 "reference": "string",
464                                 "object_type": "string",
465                                 "id": "string",
466                                 "description": "string",
467                                 "tax_category": "STANDARD",
468                                 "display_order": 1
469                               },
470                               "parent_product_id": "string",
471                               "description": "string",
472                               "status": "DRAFT",
473                               "tax_category": "STANDARD",
474                               "features": [
475                                 {
476                                   "reference": "string",
477                                   "id": "string"
478                                 }
479                               ],
480                               "custom_fields": [
481                                 {
482                                   "id": "string",
483                                   "reference": "string",
484                                   "value": "string",
485                                   "values": [
486                                     "string"
487                                   ],
488                                   "integration_details": {
489                                     "payment_gateway_variant": "ADYEN",
490                                     "id": "string",
491                                     "reference": "string",
492                                     "adyen": {
493                                       "recurring_detail_reference": "string"
494                                     },
495                                     "stripe": {
496                                       "payment_method_id": "string"
497                                     }
498                                   }
499                                 }
500                               ],
501                               "display_order": 1,
502                               "linked_integrations": [
503                                 {
504                                   "id": "string",
505                                   "link_details": [
506                                     {
507                                       "url": "string",
508                                       "custom_field_name": "string"
509                                     }
510                                   ]
511                                 }
512                               ],
513                               "billing_entity_id": "string"
514                             },
515                             "name": "string",
516                             "status": "DRAFT",
517                             "description": "string",
518                             "type": "REVENUE",
519                             "model_type": "USAGE_BASED",
520                             "usage_based": {
521                               "meter_value_calculation_id": "string",
522                               "meter_value_calculation": {
523                                 "reference": "string",
524                                 "object_type": "string",
525                                 "id": "string",
526                                 "name": "string",
527                                 "description": "string",
528                                 "calculation_type": "SUM",
529                                 "persist": true,
530                                 "meter_id": "string",
531                                 "meter": {
532                                   "reference": "string",
533                                   "object_type": "string",
534                                   "id": "string",
535                                   "name": "string",
536                                   "description": "string",
537                                   "status": "DRAFT",
538                                   "meter_values": [
539                                     {
540                                       "id": "string",
541                                       "object": {
542                                         "reference": {},
543                                         "object_type": {},
544                                         "id": {},
545                                         "name": {},
546                                         "description": {},
547                                         "status": {},
548                                         "type": {}
549                                       },
550                                       "required": true
551                                     }
552                                   ],
553                                   "meter_properties": [
554                                     {
555                                       "id": "string",
556                                       "object": {
557                                         "reference": {},
558                                         "status": {},
559                                         "object_type": {},
560                                         "id": {},
561                                         "name": {},
562                                         "description": {},
563                                         "type": {},
564                                         "enum_values": {}
565                                       },
566                                       "required": true
567                                     }
568                                   ]
569                                 },
570                                 "meter_value_id": "string",
571                                 "meter_value": {
572                                   "reference": "string",
573                                   "object_type": "string",
574                                   "id": "string",
575                                   "name": "string",
576                                   "description": "string",
577                                   "status": "DRAFT",
578                                   "type": "NUMBER"
579                                 },
580                                 "meter_property_id": "string",
581                                 "meter_property": {
582                                   "reference": "string",
583                                   "status": "DRAFT",
584                                   "object_type": "string",
585                                   "id": "string",
586                                   "name": "string",
587                                   "description": "string",
588                                   "type": "NUMBER",
589                                   "enum_values": [
590                                     "string"
591                                   ]
592                                 }
593                               },
594                               "tiering_meter_value_calculation_id": "string",
595                               "tiering_meter_value_calculation": {
596                                 "reference": "string",
597                                 "object_type": "string",
598                                 "id": "string",
599                                 "name": "string",
600                                 "description": "string",
601                                 "calculation_type": "SUM",
602                                 "persist": true,
603                                 "meter_id": "string",
604                                 "meter": {
605                                   "reference": "string",
606                                   "object_type": "string",
607                                   "id": "string",
608                                   "name": "string",
609                                   "description": "string",
610                                   "status": "DRAFT",
611                                   "meter_values": [
612                                     {
613                                       "id": "string",
614                                       "object": {
615                                         "reference": {},
616                                         "object_type": {},
617                                         "id": {},
618                                         "name": {},
619                                         "description": {},
620                                         "status": {},
621                                         "type": {}
622                                       },
623                                       "required": true
624                                     }
625                                   ],
626                                   "meter_properties": [
627                                     {
628                                       "id": "string",
629                                       "object": {
630                                         "reference": {},
631                                         "status": {},
632                                         "object_type": {},
633                                         "id": {},
634                                         "name": {},
635                                         "description": {},
636                                         "type": {},
637                                         "enum_values": {}
638                                       },
639                                       "required": true
640                                     }
641                                   ]
642                                 },
643                                 "meter_value_id": "string",
644                                 "meter_value": {
645                                   "reference": "string",
646                                   "object_type": "string",
647                                   "id": "string",
648                                   "name": "string",
649                                   "description": "string",
650                                   "status": "DRAFT",
651                                   "type": "NUMBER"
652                                 },
653                                 "meter_property_id": "string",
654                                 "meter_property": {
655                                   "reference": "string",
656                                   "status": "DRAFT",
657                                   "object_type": "string",
658                                   "id": "string",
659                                   "name": "string",
660                                   "description": "string",
661                                   "type": "NUMBER",
662                                   "enum_values": [
663                                     "string"
664                                   ]
665                                 }
666                               },
667                               "report_meter_value_calculation_ids": [
668                                 "string"
669                               ],
670                               "conditions": {
671                                 "name": "string",
672                                 "expression": {
673                                   "operator": "AND",
674                                   "operands": [
675                                     {
676                                       "meter_property": {
677                                         "comparator": {},
678                                         "id": {},
679                                         "reference": {},
680                                         "meter_property": {},
681                                         "value": {},
682                                         "values": {}
683                                       },
684                                       "expression": {}
685                                     }
686                                   ]
687                                 },
688                                 "meter_properties": [
689                                   {
690                                     "comparator": "EQUALS",
691                                     "id": "string",
692                                     "reference": "string",
693                                     "meter_property": {
694                                       "reference": "string",
695                                       "status": "DRAFT",
696                                       "object_type": "string",
697                                       "id": "string",
698                                       "name": "string",
699                                       "description": "string",
700                                       "type": "NUMBER",
701                                       "enum_values": [
702                                         "string"
703                                       ]
704                                     },
705                                     "value": "string",
706                                     "values": [
707                                       "string"
708                                     ]
709                                   }
710                                 ]
711                               }
712                             },
713                             "credits": {
714                               "credit_type_id": "string",
715                               "credit_type": {
716                                 "reference": "string",
717                                 "name": "string",
718                                 "object_type": "string",
719                                 "id": "string",
720                                 "status": "DRAFT",
721                                 "description": "string",
722                                 "unit_name": {
723                                   "singular": "string",
724                                   "plural": "string"
725                                 },
726                                 "created_at": "string",
727                                 "updated_at": "string"
728                               }
729                             },
730                             "meter_value_calculation": {
731                               "reference": "string",
732                               "object_type": "string",
733                               "id": "string",
734                               "name": "string",
735                               "description": "string",
736                               "calculation_type": "SUM",
737                               "persist": true,
738                               "meter_id": "string",
739                               "meter": {
740                                 "reference": "string",
741                                 "object_type": "string",
742                                 "id": "string",
743                                 "name": "string",
744                                 "description": "string",
745                                 "status": "DRAFT",
746                                 "meter_values": [
747                                   {
748                                     "id": "string",
749                                     "object": {
750                                       "reference": "string",
751                                       "object_type": "string",
752                                       "id": "string",
753                                       "name": "string",
754                                       "description": "string",
755                                       "status": "DRAFT",
756                                       "type": "NUMBER"
757                                     },
758                                     "required": true
759                                   }
760                                 ],
761                                 "meter_properties": [
762                                   {
763                                     "id": "string",
764                                     "object": {
765                                       "reference": "string",
766                                       "status": "DRAFT",
767                                       "object_type": "string",
768                                       "id": "string",
769                                       "name": "string",
770                                       "description": "string",
771                                       "type": "NUMBER",
772                                       "enum_values": [
773                                         "string"
774                                       ]
775                                     },
776                                     "required": true
777                                   }
778                                 ]
779                               },
780                               "meter_value_id": "string",
781                               "meter_value": {
782                                 "reference": "string",
783                                 "object_type": "string",
784                                 "id": "string",
785                                 "name": "string",
786                                 "description": "string",
787                                 "status": "DRAFT",
788                                 "type": "NUMBER"
789                               },
790                               "meter_property_id": "string",
791                               "meter_property": {
792                                 "reference": "string",
793                                 "status": "DRAFT",
794                                 "object_type": "string",
795                                 "id": "string",
796                                 "name": "string",
797                                 "description": "string",
798                                 "type": "NUMBER",
799                                 "enum_values": [
800                                   "string"
801                                 ]
802                               }
803                             },
804                             "tax_category": "STANDARD",
805                             "display_order": 1,
806                             "unit_name": {
807                               "singular": "string",
808                               "plural": "string"
809                             },
810                             "custom_fields": [
811                               {
812                                 "id": "string",
813                                 "reference": "string",
814                                 "value": "string",
815                                 "values": [
816                                   "string"
817                                 ],
818                                 "integration_details": {
819                                   "payment_gateway_variant": "ADYEN",
820                                   "id": "string",
821                                   "reference": "string",
822                                   "adyen": {
823                                     "recurring_detail_reference": "string"
824                                   },
825                                   "stripe": {
826                                     "payment_method_id": "string"
827                                   }
828                                 }
829                               }
830                             ],
831                             "meter_value_calculation_id": "string",
832                             "report_meter_value_calculation_ids": [
833                               "string"
834                             ]
835                           }
836                         ],
837                         "type": "string",
838                         "pricing_type": "string",
839                         "commitment_type": "string",
840                         "discount_type": "string",
841                         "coupon_data": {
842                           "coupon_id": "string",
843                           "promotion_code_id": "string"
844                         },
845                         "tax_categories": [
846                           {
847                             "category": "string",
848                             "percentage": "string",
849                             "name": "string",
850                             "base_amount": {
851                               "quantity": "string",
852                               "currency": "AED"
853                             },
854                             "tax_amount": {
855                               "quantity": "string",
856                               "currency": "AED"
857                             },
858                             "total_amount": {
859                               "quantity": "string",
860                               "currency": "AED"
861                             },
862                             "local_amounts": {
863                               "display": true,
864                               "base_amount": {
865                                 "quantity": "string",
866                                 "currency": "AED"
867                               },
868                               "tax_amount": {
869                                 "quantity": "string",
870                                 "currency": "AED"
871                               },
872                               "total_amount": {
873                                 "quantity": "string",
874                                 "currency": "AED"
875                               },
876                               "used_exchange_rate": {
877                                 "currency": "string",
878                                 "base_currency": "string",
879                                 "rate_timestamp": "string",
880                                 "rate": "string",
881                                 "source": "string"
882                               }
883                             },
884                             "notes": [
885                               "string"
886                             ],
887                             "rates": [
888                               {
889                                 "name": "string",
890                                 "percentage": "string",
891                                 "tax_amount": {
892                                   "quantity": "string",
893                                   "currency": "AED"
894                                 }
895                               }
896                             ]
897                           }
898                         ],
899                         "amount_excluding_tax": {
900                           "quantity": "string",
901                           "currency": "AED"
902                         },
903                         "amount_including_tax": {
904                           "quantity": "string",
905                           "currency": "AED"
906                         },
907                         "conditions": {
908                           "name": "string",
909                           "expression": {
910                             "operator": "AND",
911                             "operands": [
912                               {
913                                 "meter_property": {
914                                   "comparator": "EQUALS",
915                                   "id": "string",
916                                   "reference": "string",
917                                   "meter_property": {
918                                     "reference": "string",
919                                     "status": "DRAFT",
920                                     "object_type": "string",
921                                     "id": "string",
922                                     "name": "string",
923                                     "description": "string",
924                                     "type": "NUMBER",
925                                     "enum_values": [
926                                       "string"
927                                     ]
928                                   },
929                                   "value": "string",
930                                   "values": [
931                                     "string"
932                                   ]
933                                 },
934                                 "expression": {}
935                               }
936                             ]
937                           },
938                           "meter_properties": [
939                             {
940                               "comparator": "EQUALS",
941                               "id": "string",
942                               "reference": "string",
943                               "meter_property": {
944                                 "reference": "string",
945                                 "status": "DRAFT",
946                                 "object_type": "string",
947                                 "id": "string",
948                                 "name": "string",
949                                 "description": "string",
950                                 "type": "NUMBER",
951                                 "enum_values": [
952                                   "string"
953                                 ]
954                               },
955                               "value": "string",
956                               "values": [
957                                 "string"
958                               ]
959                             }
960                           ]
961                         },
962                         "meter_value": {
963                           "reference": "string",
964                           "type": "string",
965                           "number": "string",
966                           "amount": {
967                             "quantity": "string",
968                             "currency": "AED"
969                           }
970                         },
971                         "details": {
972                           "meter_values": [
973                             {
974                               "count": 1,
975                               "number": "string",
976                               "amount": {
977                                 "quantity": "string",
978                                 "currency": "AED"
979                               },
980                               "amount_in_pricing_currency": {
981                                 "quantity": "string",
982                                 "currency": "AED"
983                               },
984                               "ratio": "string"
985                             }
986                           ],
987                           "report_meter_values": [
988                             {
989                               "meter_value_calculation_id": "string",
990                               "number": "string",
991                               "amount": {
992                                 "quantity": "string",
993                                 "currency": "AED"
994                               },
995                               "amount_in_pricing_currency": {
996                                 "quantity": "string",
997                                 "currency": "AED"
998                               },
999                               "count": "string",
1000                               "ratio": "string"
1001                             }
1002                           ],
1003                           "amount": {
1004                             "quantity": "string",
1005                             "currency": "AED"
1006                           },
1007                           "pricing_currency": "string",
1008                           "pricing_amount": {
1009                             "quantity": "string",
1010                             "currency": "AED"
1011                           },
1012                           "conversion": {
1013                             "convert_from_meter_value_id": "string",
1014                             "credits": {
1015                               "quantity": "string",
1016                               "credit_type_id": "string"
1017                             }
1018                           },
1019                           "band": {
1020                             "amount": {
1021                               "quantity": "string",
1022                               "currency": "AED"
1023                             },
1024                             "percentage": "string",
1025                             "credits": {
1026                               "quantity": "string",
1027                               "credit_type_id": "string"
1028                             },
1029                             "maximum_amount": {
1030                               "quantity": "string",
1031                               "currency": "AED"
1032                             },
1033                             "minimum_amount": {
1034                               "quantity": "string",
1035                               "currency": "AED"
1036                             },
1037                             "maximum_number": "string",
1038                             "minimum_number": "string",
1039                             "block_size": {
1040                               "number": "string",
1041                               "amount": {
1042                                 "quantity": "string",
1043                                 "currency": "AED"
1044                               },
1045                               "count": "string"
1046                             },
1047                             "tier_lower_bound": {
1048                               "number": "string",
1049                               "amount": {
1050                                 "quantity": "string",
1051                                 "currency": "AED"
1052                               },
1053                               "count": "string"
1054                             },
1055                             "tier_top_bound": {
1056                               "number": "string",
1057                               "amount": {
1058                                 "quantity": "string",
1059                                 "currency": "AED"
1060                               },
1061                               "count": "string"
1062                             },
1063                             "volume_share": "string",
1064                             "included_volume": {
1065                               "number": "string",
1066                               "amount": {
1067                                 "quantity": "string",
1068                                 "currency": "AED"
1069                               },
1070                               "count": "string"
1071                             }
1072                           },
1073                           "meter_value": {
1074                             "id": "string",
1075                             "reference": "string",
1076                             "number": "string",
1077                             "amount": {
1078                               "quantity": "string",
1079                               "currency": "AED"
1080                             },
1081                             "count": "string",
1082                             "ratio": "string",
1083                             "type": "NUMBER"
1084                           },
1085                           "tiering_meter_value": {
1086                             "id": "string",
1087                             "reference": "string",
1088                             "number": "string",
1089                             "amount": {
1090                               "quantity": "string",
1091                               "currency": "AED"
1092                             },
1093                             "count": "string",
1094                             "ratio": "string",
1095                             "type": "NUMBER"
1096                           },
1097                           "price_bound": "string",
1098                           "description": "string",
1099                           "used_exchange_rates": [
1100                             {
1101                               "currency": "string",
1102                               "base_currency": "string",
1103                               "rate_timestamp": "string",
1104                               "rate": "string",
1105                               "source": "string"
1106                             }
1107                           ],
1108                           "included_volume_details": {
1109                             "included_volume": {
1110                               "id": "string",
1111                               "reference": "string",
1112                               "number": "string",
1113                               "amount": {
1114                                 "quantity": "string",
1115                                 "currency": "AED"
1116                               },
1117                               "count": "string",
1118                               "ratio": "string",
1119                               "type": "NUMBER"
1120                             },
1121                             "available_included_volume": {
1122                               "id": "string",
1123                               "reference": "string",
1124                               "number": "string",
1125                               "amount": {
1126                                 "quantity": "string",
1127                                 "currency": "AED"
1128                               },
1129                               "count": "string",
1130                               "ratio": "string",
1131                               "type": "NUMBER"
1132                             },
1133                             "period_volume": {
1134                               "id": "string",
1135                               "reference": "string",
1136                               "number": "string",
1137                               "amount": {
1138                                 "quantity": "string",
1139                                 "currency": "AED"
1140                               },
1141                               "count": "string",
1142                               "ratio": "string",
1143                               "type": "NUMBER"
1144                             }
1145                           },
1146                           "split_pricing": {
1147                             "meter_properties": [
1148                               {
1149                                 "id": "string",
1150                                 "reference": "string",
1151                                 "value": "string",
1152                                 "meter_property": {
1153                                   "reference": "string",
1154                                   "status": "DRAFT",
1155                                   "object_type": "string",
1156                                   "id": "string",
1157                                   "name": "string",
1158                                   "description": "string",
1159                                   "type": "NUMBER",
1160                                   "enum_values": [
1161                                     "string"
1162                                   ]
1163                                 }
1164                               }
1165                             ]
1166                           },
1167                           "meter_value_share_of_total": "string",
1168                           "meter_value_share_of_processing_only_customer_total": "string",
1169                           "priceBound": "string"
1170                         },
1171                         "sub_lines": [
1172                           {
1173                             "sub_line_order": 1,
1174                             "details": {
1175                               "meter_values": [
1176                                 {
1177                                   "count": 1,
1178                                   "number": "string",
1179                                   "amount": {
1180                                     "quantity": "string",
1181                                     "currency": "AED"
1182                                   },
1183                                   "amount_in_pricing_currency": {
1184                                     "quantity": "string",
1185                                     "currency": "AED"
1186                                   },
1187                                   "ratio": "string"
1188                                 }
1189                               ],
1190                               "report_meter_values": [
1191                                 {
1192                                   "meter_value_calculation_id": "string",
1193                                   "number": "string",
1194                                   "amount": {
1195                                     "quantity": "string",
1196                                     "currency": "AED"
1197                                   },
1198                                   "amount_in_pricing_currency": {
1199                                     "quantity": "string",
1200                                     "currency": "AED"
1201                                   },
1202                                   "count": "string",
1203                                   "ratio": "string"
1204                                 }
1205                               ],
1206                               "amount": {
1207                                 "quantity": "string",
1208                                 "currency": "AED"
1209                               },
1210                               "pricing_currency": "string",
1211                               "pricing_amount": {
1212                                 "quantity": "string",
1213                                 "currency": "AED"
1214                               },
1215                               "conversion": {
1216                                 "convert_from_meter_value_id": "string",
1217                                 "credits": {
1218                                   "quantity": "string",
1219                                   "credit_type_id": "string"
1220                                 }
1221                               },
1222                               "band": {
1223                                 "amount": {
1224                                   "quantity": "string",
1225                                   "currency": "AED"
1226                                 },
1227                                 "percentage": "string",
1228                                 "credits": {
1229                                   "quantity": "string",
1230                                   "credit_type_id": "string"
1231                                 },
1232                                 "maximum_amount": {
1233                                   "quantity": "string",
1234                                   "currency": "AED"
1235                                 },
1236                                 "minimum_amount": {
1237                                   "quantity": "string",
1238                                   "currency": "AED"
1239                                 },
1240                                 "maximum_number": "string",
1241                                 "minimum_number": "string",
1242                                 "block_size": {
1243                                   "number": "string",
1244                                   "amount": {
1245                                     "quantity": "string",
1246                                     "currency": "AED"
1247                                   },
1248                                   "count": "string"
1249                                 },
1250                                 "tier_lower_bound": {
1251                                   "number": "string",
1252                                   "amount": {
1253                                     "quantity": "string",
1254                                     "currency": "AED"
1255                                   },
1256                                   "count": "string"
1257                                 },
1258                                 "tier_top_bound": {
1259                                   "number": "string",
1260                                   "amount": {
1261                                     "quantity": "string",
1262                                     "currency": "AED"
1263                                   },
1264                                   "count": "string"
1265                                 },
1266                                 "volume_share": "string",
1267                                 "included_volume": {
1268                                   "number": "string",
1269                                   "amount": {
1270                                     "quantity": "string",
1271                                     "currency": "AED"
1272                                   },
1273                                   "count": "string"
1274                                 }
1275                               },
1276                               "meter_value": {
1277                                 "id": "string",
1278                                 "reference": "string",
1279                                 "number": "string",
1280                                 "amount": {
1281                                   "quantity": "string",
1282                                   "currency": "AED"
1283                                 },
1284                                 "count": "string",
1285                                 "ratio": "string",
1286                                 "type": "NUMBER"
1287                               },
1288                               "tiering_meter_value": {
1289                                 "id": "string",
1290                                 "reference": "string",
1291                                 "number": "string",
1292                                 "amount": {
1293                                   "quantity": "string",
1294                                   "currency": "AED"
1295                                 },
1296                                 "count": "string",
1297                                 "ratio": "string",
1298                                 "type": "NUMBER"
1299                               },
1300                               "price_bound": "string",
1301                               "description": "string",
1302                               "used_exchange_rates": [
1303                                 {
1304                                   "currency": "string",
1305                                   "base_currency": "string",
1306                                   "rate_timestamp": "string",
1307                                   "rate": "string",
1308                                   "source": "string"
1309                                 }
1310                               ],
1311                               "included_volume_details": {
1312                                 "included_volume": {
1313                                   "id": "string",
1314                                   "reference": "string",
1315                                   "number": "string",
1316                                   "amount": {
1317                                     "quantity": "string",
1318                                     "currency": "AED"
1319                                   },
1320                                   "count": "string",
1321                                   "ratio": "string",
1322                                   "type": "NUMBER"
1323                                 },
1324                                 "available_included_volume": {
1325                                   "id": "string",
1326                                   "reference": "string",
1327                                   "number": "string",
1328                                   "amount": {
1329                                     "quantity": "string",
1330                                     "currency": "AED"
1331                                   },
1332                                   "count": "string",
1333                                   "ratio": "string",
1334                                   "type": "NUMBER"
1335                                 },
1336                                 "period_volume": {
1337                                   "id": "string",
1338                                   "reference": "string",
1339                                   "number": "string",
1340                                   "amount": {
1341                                     "quantity": "string",
1342                                     "currency": "AED"
1343                                   },
1344                                   "count": "string",
1345                                   "ratio": "string",
1346                                   "type": "NUMBER"
1347                                 }
1348                               },
1349                               "split_pricing": {
1350                                 "meter_properties": [
1351                                   {
1352                                     "id": "string",
1353                                     "reference": "string",
1354                                     "value": "string",
1355                                     "meter_property": {
1356                                       "reference": "string",
1357                                       "status": "DRAFT",
1358                                       "object_type": "string",
1359                                       "id": "string",
1360                                       "name": "string",
1361                                       "description": "string",
1362                                       "type": "NUMBER",
1363                                       "enum_values": [
1364                                         "string"
1365                                       ]
1366                                     }
1367                                   }
1368                                 ]
1369                               },
1370                               "meter_value_share_of_total": "string",
1371                               "meter_value_share_of_processing_only_customer_total": "string",
1372                               "priceBound": "string"
1373                             },
1374                             "description": "string",
1375                             "processing_only_customer_id": "string",
1376                             "type": "USAGE_BASED_CONVERSION",
1377                             "usage_based_conversion": {
1378                               "conditions": {
1379                                 "name": "string",
1380                                 "expression": {
1381                                   "operator": "AND",
1382                                   "operands": [
1383                                     {
1384                                       "meter_property": {
1385                                         "comparator": {},
1386                                         "id": {},
1387                                         "reference": {},
1388                                         "meter_property": {},
1389                                         "value": {},
1390                                         "values": {}
1391                                       },
1392                                       "expression": {}
1393                                     }
1394                                   ]
1395                                 },
1396                                 "meter_properties": [
1397                                   {
1398                                     "comparator": "EQUALS",
1399                                     "id": "string",
1400                                     "reference": "string",
1401                                     "meter_property": {
1402                                       "reference": "string",
1403                                       "status": "DRAFT",
1404                                       "object_type": "string",
1405                                       "id": "string",
1406                                       "name": "string",
1407                                       "description": "string",
1408                                       "type": "NUMBER",
1409                                       "enum_values": [
1410                                         "string"
1411                                       ]
1412                                     },
1413                                     "value": "string",
1414                                     "values": [
1415                                       "string"
1416                                     ]
1417                                   }
1418                                 ]
1419                               }
1420                             },
1421                             "processing_only_customer_resource_id": "string"
1422                           }
1423                         ]
1424                       }
1425                     ],
1426                     "billing_customer_id": "string"
1427                   }
1428                 ]
1429               }
1430             ],
1431             "amount_excluding_tax": {
1432               "quantity": "string",
1433               "currency": "AED"
1434             },
1435             "amount_including_tax": {
1436               "quantity": "string",
1437               "currency": "AED"
1438             },
1439             "tax_summary": {
1440               "country_code": "string",
1441               "base_amount": {
1442                 "quantity": "string",
1443                 "currency": "AED"
1444               },
1445               "tax_amount": {
1446                 "quantity": "string",
1447                 "currency": "AED"
1448               },
1449               "total_amount": {
1450                 "quantity": "string",
1451                 "currency": "AED"
1452               },
1453               "local_amounts": {
1454                 "display": true,
1455                 "base_amount": {
1456                   "quantity": "string",
1457                   "currency": "AED"
1458                 },
1459                 "tax_amount": {
1460                   "quantity": "string",
1461                   "currency": "AED"
1462                 },
1463                 "total_amount": {
1464                   "quantity": "string",
1465                   "currency": "AED"
1466                 },
1467                 "used_exchange_rate": {
1468                   "currency": "string",
1469                   "base_currency": "string",
1470                   "rate_timestamp": "string",
1471                   "rate": "string",
1472                   "source": "string"
1473                 }
1474               },
1475               "notes": [
1476                 "string"
1477               ]
1478             }
1479           }
1480         ],
1481         "used_change_rates": [
1482           {
1483             "currency": "string",
1484             "base_currency": "string",
1485             "rate_timestamp": "string",
1486             "rate": "string",
1487             "source": "string"
1488           }
1489         ]
1490       },
1491       "processed_details": {
1492         "type": "DEFAULT",
1493         "duplicate": {
1494           "of_meter_data_id": "string"
1495         },
1496         "not_matched": {
1497           "variant": "string"
1498         },
1499         "duplicate_of_meter_data_id": "string"
1500       },
1501       "deleted": true
1502     }
1503   ]
1504 }

Requires the METER_DATA.INGEST 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

Query parameters

cost_predictionbooleanOptional

The option to return cost prediction.

Request

This endpoint expects an object.

meter_dataslist of objectsRequired

Response

Created

meter_dataslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error