Ingest a list of meter events

POST

/v:version/events/ingest-list

POST

/v:version/events/ingest-list

$ curl -X POST https://test.api.solvimon.com/v1/events/ingest-list \
>      -H "X-API-KEY: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "meter_datas": [
>     {
>       "reference": "reference_1664176205",
>       "customer_id": "cust_zwDeN40tsF98JTBsea1j",
>       "customer_reference": "customerReference_1664176205",
>       "meter_id": "metr_owDe9k0tsIY5LkBAel1E",
>       "meter_reference": "meterReference_1664176205",
>       "pricing_plan_subscription_id": "ppsu_gwDeeN0tBe7h5NAw9d1q",
>       "pricing_plan_subscription_reference": "pricingPlanSubscriptionReference_1664176205",
>       "timestamp": "2024-04-12T15:22:37Z",
>       "meter_properties": [
>         {
>           "id": "metp_owDe9k0tsIY5LkBAel1E",
>           "reference": "meterPropertyReference_1664176205",
>           "value": "DE"
>         }
>       ],
>       "meter_values": [
>         {
>           "id": "metv_owDe9k0tsIY5LkBAel1E",
>           "reference": "meterValueReference_1664176205",
>           "number": "1",
>           "amount": {
>             "quantity": "1500.00",
>             "currency": "EUR"
>           }
>         }
>       ]
>     }
>   ]
> }'

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

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

Headers

x-platform-idstringOptional

Platform ID.

Query parameters

cost_predictionbooleanOptional

The option to return cost prediction.

meter_validationstringOptional

The validation strategy applied to the referenced meter. STATIC (the default) requires the meter, its values and properties to already exist. DYNAMIC creates the meter and its missing values/properties/enum values on the fly during ingest.

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