Update your platform | Solvimon

curl -X PATCH https://test.api.solvimon.com/v1/platforms/ \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "reference": "Expense_NL",
  "default_product_tax_category": "STANDARD",
  "account_group_id": "accgrp_9f8b7c6d5e4a3b2c1d0e",
  "reporting_currency": "EUR",
  "default_pricing_currency": "EUR",
  "status": "ACTIVE",
  "timezone": "Europe/Amsterdam",
  "description": "ExpenseIT platform for managing expenses in the Netherlands",
  "default_pricing_plan_subscription_settings": {
    "billing_currency": "EUR",
    "init_invoice_on_hold": false,
    "billing_entity_id": "bile_EwDegI0tt0diFEBEed12",
    "due_date_configuration": {
      "type": "PERIOD_AFTER_INVOICE_DATE",
      "period": 1
    },
    "billing_period": 1,
    "billing_time": "EXACT",
    "combine": true,
    "payment_acceptor_ids": [
      "paya_EwDegI0tt0diFEBEed12",
      "paya_EwDegI0tt0diFEBEed13"
    ]
  },
  "branding": {
    "name": "ExpenseIT Branding",
    "domain": "expenseit.example.com",
    "colors": {
      "primary": "#003366",
      "secondary": "#FFCC00"
    },
    "logo": {
      "file_name": "expenseit-logo.jpg",
      "content_type": "image/jpeg",
      "content": "/9j/4AAQSkZJRgABAQEASABIAAD..."
    },
    "emblem": {
      "file_name": "expenseit-emblem.png",
      "content_type": "image/png",
      "content": "iVBORw0KGgoAAAANSUhEUgAA..."
    }
  },
  "invoice_settings": {
    "invoice_date_determination_type": "AFTER_END_OF_BILLING_PERIOD"
  }
}'

{
  "reference": "Expense_NL",
  "default_product_tax_category": "STANDARD",
  "account_group_id": "accgrp_9f8b7c6d5e4a3b2c1d0e",
  "reporting_currency": "EUR",
  "default_pricing_currency": "EUR",
  "object_type": "platform",
  "created_at": "2024-06-01T09:15:00Z",
  "id": "plat_1234567890abcdef",
  "status": "ACTIVE",
  "timezone": "Europe/Amsterdam",
  "description": "ExpenseIT platform for managing expenses in the Netherlands",
  "entity_id": "ent_9876543210fedcba",
  "default_billing_entity_id": "bile_EwDegI0tt0diFEBEed12",
  "default_pricing_plan_subscription_settings": {
    "billing_currency": "EUR",
    "init_invoice_on_hold": true,
    "billing_entity_id": "bile_EwDegI0tt0diFEBEed12",
    "due_date_configuration": {
      "type": "PERIOD_AFTER_INVOICE_DATE",
      "period": {
        "type": "DAY",
        "value": 15
      }
    },
    "billing_period": {
      "type": "MONTH",
      "value": 1
    },
    "billing_time": "EXACT",
    "combine": true,
    "payment_acceptor_ids": [
      "paya_EwDegI0tt0diFEBEed12"
    ],
    "display_invoice_sub_lines_per_processing_only_customer": true,
    "replicate_meter_data_ingest_to_parent": true
  },
  "crm_integrations": {
    "hubspot": {
      "portal_id": "1234567"
    }
  },
  "branding": {
    "name": "ExpenseIT Branding",
    "domain": "expenseit.example.com",
    "colors": {
      "primary": "#003366",
      "secondary": "#FFCC00"
    },
    "logo": {
      "file_name": "expenseit-logo.jpg",
      "content_type": "image/jpeg",
      "public_url": "https://cdn.expenseit.example.com/assets/logo.jpg"
    },
    "emblem": {
      "file_name": "expenseit-emblem.png",
      "content_type": "image/png",
      "public_url": "https://cdn.expenseit.example.com/assets/emblem.png"
    }
  },
  "invoice_settings": {
    "invoice_number_configuration": {
      "prefix": "INV",
      "dynamic_prefix": [
        "YEAR",
        "MONTH"
      ],
      "separator": "-",
      "increment_by": 1,
      "first_number": 1000,
      "minimum_number_of_digits": 5,
      "reset_period": {
        "type": "YEARLY",
        "month": "JANUARY"
      }
    },
    "credit_invoice_number_configuration": {
      "prefix": "CRD",
      "dynamic_prefix": [
        "YEAR",
        "MONTH"
      ],
      "separator": "-",
      "increment_by": 1,
      "first_number": 500,
      "minimum_number_of_digits": 5,
      "reset_period": {
        "type": "YEARLY",
        "month": "JANUARY"
      }
    },
    "send_by_email": {
      "trigger_type": "MANUAL"
    },
    "export_to_erp": {
      "trigger_type": "MANUAL"
    },
    "invoice_date_determination_type": "AT_END_OF_BILLING_PERIOD",
    "invoice_grace_period": {
      "type": "DAYS",
      "configuration": {
        "value": 7,
        "type": "DAYS"
      }
    },
    "invoice_extra_open_period": {
      "value": 3,
      "type": "DAYS"
    },
    "footnote": "Thank you for your business.",
    "add_zero_meter_value_invoice_lines": true
  },
  "quote_settings": {
    "quote_pdf_configuration": {
      "display_customer_details": true,
      "display_billing_entity_details": true
    }
  },
  "rounding_settings": [
    {
      "rounding_target": "INVOICE",
      "rounding_mode": "DEFAULT"
    }
  ]
}

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.

Request

This endpoint expects an object.

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

default_product_tax_categoryenumRequired

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

Allowed values:

account_group_idstringRequired

reporting_currencyenumRequired

currency for reporting on platform level

default_pricing_currencyenumRequired

initial/default currency when creating pricingPlanVersions

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_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

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

default_portal_url_settingsobjectOptional

The settings related with portal

Response

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

default_product_tax_categoryenum

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

Allowed values:

account_group_idstring

reporting_currencyenum

currency for reporting on platform level

default_pricing_currencyenum

initial/default currency when creating pricingPlanVersions

object_typestring or nullRead-only

created_atstring or nullRead-only

idstring or nullRead-only

statusstring or null

timezonestring or null

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

entity_idstring or null

The resource ID of the entity.

default_billing_entity_idstring or null

The resource ID of the billing entity.

default_pricing_plan_subscription_settingsobject

The default configuration when creating a pricing plan subscription.

crm_integrationsobject

The associated crm integrations

brandingobject

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

invoice_settingsobject

The settings of the invoice

quote_settingsobject

The settings of the quote

rounding_settingslist of objects or null

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

reprocessing_settingsobject

Settings for reprocessing

default_portal_url_settingsobject

The settings related with portal

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors