Get your platform details

GET

/v:version/platforms/:resourceId

GET

/v:version/platforms/:resourceId

$ curl https://test.api.solvimon.com/v1/platforms/ \
>      -H "X-API-KEY: <apiKey>"

1 {
2   "object_type": "string",
3   "created_at": "string",
4   "id": "string",
5   "reference": "string",
6   "status": "string",
7   "timezone": "string",
8   "description": "string",
9   "entity_id": "string",
10   "default_billing_entity_id": "string",
11   "default_product_tax_category": "STANDARD",
12   "account_group_id": "string",
13   "default_pricing_plan_subscription_settings": {
14     "billing_entity_id": "string",
15     "due_date_configuration": {
16       "type": "PERIOD_AFTER_INVOICE_DATE",
17       "period": {
18         "type": "DAY",
19         "value": 1
20       }
21     },
22     "billing_period": {
23       "type": "DAY",
24       "value": 1
25     },
26     "billing_currency": "AED",
27     "billing_time": "EXACT",
28     "combine": true,
29     "init_invoice_on_hold": true,
30     "payment_acceptor_ids": [
31       "string"
32     ],
33     "display_invoice_sub_lines_per_processing_only_customer": true,
34     "replicate_meter_data_ingest_to_parent": true,
35     "initial_term": {
36       "type": "DAY",
37       "value": 1
38     },
39     "renewal_term": {
40       "type": "DAY",
41       "value": 1
42     },
43     "auto_renewal": true
44   },
45   "crm_integrations": {
46     "hubspot": {
47       "portal_id": "string"
48     }
49   },
50   "branding": {
51     "colors": {
52       "primary": "string",
53       "secondary": "string"
54     },
55     "logo": {
56       "file_name": "string",
57       "content_type": "string",
58       "public_url": "string"
59     },
60     "emblem": {
61       "file_name": "string",
62       "content_type": "string",
63       "public_url": "string"
64     },
65     "name": "string",
66     "domain": "string"
67   },
68   "invoice_settings": {
69     "invoice_number_configuration": {
70       "prefix": "string",
71       "dynamic_prefix": [
72         "string"
73       ],
74       "separator": "string",
75       "increment_by": 1,
76       "first_number": 1,
77       "minimum_number_of_digits": 1,
78       "reset_period": {
79         "type": "string",
80         "month": "JANUARY"
81       }
82     },
83     "credit_invoice_number_configuration": {
84       "prefix": "string",
85       "dynamic_prefix": [
86         "string"
87       ],
88       "separator": "string",
89       "increment_by": 1,
90       "first_number": 1,
91       "minimum_number_of_digits": 1,
92       "reset_period": {
93         "type": "string",
94         "month": "JANUARY"
95       }
96     },
97     "self_billing_invoice_number_configuration": {
98       "prefix": "string",
99       "dynamic_prefix": [
100         "string"
101       ],
102       "separator": "string",
103       "increment_by": 1,
104       "first_number": 1,
105       "minimum_number_of_digits": 1,
106       "reset_period": {
107         "type": "string",
108         "month": "JANUARY"
109       }
110     },
111     "self_billing_credit_invoice_number_configuration": {
112       "prefix": "string",
113       "dynamic_prefix": [
114         "string"
115       ],
116       "separator": "string",
117       "increment_by": 1,
118       "first_number": 1,
119       "minimum_number_of_digits": 1,
120       "reset_period": {
121         "type": "string",
122         "month": "JANUARY"
123       }
124     },
125     "send_by_email": {
126       "trigger_type": "MANUAL"
127     },
128     "export_to_erp": {
129       "trigger_type": "MANUAL"
130     },
131     "invoice_date_determination_type": "AT_END_OF_BILLING_PERIOD",
132     "invoice_grace_period": {
133       "type": "string",
134       "configuration": {
135         "value": 1,
136         "type": "string"
137       }
138     },
139     "invoice_extra_open_period": {
140       "value": 1,
141       "type": "string"
142     },
143     "footnote": "string",
144     "add_zero_meter_value_invoice_lines": true
145   },
146   "reporting_currency": "AED",
147   "default_pricing_currency": "AED",
148   "quote_settings": {
149     "quote_pdf_configuration": {
150       "display_customer_details": true,
151       "display_billing_entity_details": true
152     }
153   },
154   "rounding_settings": [
155     {
156       "rounding_target": "INVOICE",
157       "rounding_mode": "DEFAULT"
158     }
159   ],
160   "reprocessing_settings": {
161     "default_delay": {
162       "type": "SECOND",
163       "value": 1
164     }
165   },
166   "processing_settings": {
167     "put_after_invoice_final_on_next_invoice": true
168   },
169   "default_portal_url_settings": {
170     "customer": {
171       "expiry_period": {
172         "type": "DAY",
173         "value": 1
174       }
175     }
176   }
177 }

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Response

object_typestring or nullOptionalRead-only

created_atstring or nullOptionalRead-only

idstring or nullOptionalRead-only

referencestringOptionalformat: "^\S+$"0-256 characters

statusstring or nullOptional

timezonestring or nullOptional

descriptionstring or nullOptionalformat: "^[a-zA-Z0-9_\-\s+]*"0-256 characters

entity_idstring or nullOptional

The resource ID of the entity.

default_billing_entity_idstring or nullOptional

The resource ID of the billing entity.

default_product_tax_categoryenumOptional

The default tax category that will be applied to the product.

account_group_idstringOptional

default_pricing_plan_subscription_settingsobjectOptional

The default configuration when creating a pricing plan subscription.

crm_integrationsobjectOptional

The associated crm integrations

brandingobjectOptional

Custom branding for the platform, the logo & colors can be set

invoice_settingsobjectOptional

The settings of the invoice

reporting_currencyenumOptional

currency for reporting on platform level

default_pricing_currencyenumOptional

initial/default currency when creating pricingPlanVersions

quote_settingsobjectOptional

The settings of the quote

rounding_settingslist of objects or nullOptional

Allow platforms to configure rounding behavior for different kinds of objects.

reprocessing_settingsobjectOptional

Settings for reprocessing

processing_settingsobjectOptional

Settings for processing

default_portal_url_settingsobjectOptional

The settings related with portal

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors