Create a billing entity | Solvimon

curl -X POST https://test.api.solvimon.com/v1/billing-entities \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "reference": "Expense_NL",
  "default_customer_country_selector": [
    "AD"
  ],
  "default_billing_currency_selector": [
    "AED"
  ],
  "timezone": "GMT+1",
  "legal_name": "ExpenseIt B.V.",
  "tax_id": "12345678",
  "registered_address": {
    "line1": "Daalsesingel 51",
    "line2": "",
    "city": "Utrecht",
    "postal_code": "3511SW",
    "state": "Utrecht",
    "country": "NL"
  },
  "email": "info@expense.nl",
  "tax_registrations": [
    {
      "description": "Frederiksplein Amsterdam Tax Registration",
      "tax_id": "NL000099998B57",
      "registration_number": "86385879",
      "registered_address": {
        "line1": "Frederiksplein 61",
        "line2": "",
        "city": "Amsterdam",
        "postal_code": "1017 XL",
        "state": "Noord-Holland",
        "country": "NL"
      }
    }
  ]
}'

{
  "reference": "string",
  "default_customer_country_selector": [
    "AD"
  ],
  "default_billing_currency_selector": [
    "AED"
  ],
  "object_type": "string",
  "id": "string",
  "created_at": "string",
  "status": "string",
  "timezone": "string",
  "legal_name": "string",
  "tax_id": "string",
  "tax_ids": [
    {
      "id": "string",
      "type": "GENERIC_TAX_ID",
      "tax_id_validation_result": {
        "id": "string",
        "validation_date": "string",
        "source": "string",
        "valid": "VALID",
        "message": "string"
      }
    }
  ],
  "registration_number": "string",
  "registered_address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postal_code": "string",
    "state": "string",
    "country": "AD"
  },
  "email": "string",
  "tax_settings": {
    "apply_local_vat_for_missing_tax_id": true
  },
  "tax_registrations": [
    {
      "id": "string",
      "description": "string",
      "tax_id": "string",
      "tax_ids": [
        {
          "id": "string",
          "type": "GENERIC_TAX_ID",
          "tax_id_validation_result": {
            "id": "string",
            "validation_date": "string",
            "source": "string",
            "valid": "VALID",
            "message": "string"
          }
        }
      ],
      "registration_number": "string",
      "registered_address": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "postal_code": "string",
        "state": "string",
        "country": "AD"
      }
    }
  ],
  "custom_fields": [
    {
      "id": "string",
      "reference": "string",
      "value": "string",
      "values": [
        "string"
      ],
      "integration_details": {
        "payment_gateway_variant": "ADYEN",
        "id": "string",
        "reference": "string",
        "adyen": {
          "recurring_detail_reference": "string"
        },
        "stripe": {
          "payment_method_id": "string"
        }
      }
    }
  ],
  "linked_integrations": [
    {
      "id": "string",
      "link_details": [
        {
          "url": "string",
          "custom_field_name": "string"
        }
      ]
    }
  ]
}

Requires the BILLING_ENTITY.CREATE 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

Request

This endpoint expects an object.

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

default_customer_country_selectorlist of enumsRequired

default_billing_currency_selectorlist of enumsRequired

statusstring or nullOptional

timezonestring or nullOptional

legal_namestring or nullOptional

The legal name of the billing entity.

tax_idstring or nullOptionalformat: "^[a-zA-Z0-9\-]*"0-256 characters

The ID used for tax purposes of the billing entity.

tax_idslist of objects or nullOptional

Tax IDs used for tax purposes of the billing entity

registration_numberstring or nullOptional

The registration number of the billing entity.

registered_addressobjectOptional

The address of this tax registration, if different from the billing entity. Currently, only the address will be used for tax calculations

emailstring or nullOptionalformat: "(\S*@\S*\..*)"0-256 characters

The email address of the billing entity.

tax_settingsobjectOptional

Customise tax settings for this Billing Entity

tax_registrationslist of objects or nullOptional

Extra tax registrations for this billing entity

custom_fieldslist of objects or nullOptional

linked_integrationslist of objects or nullOptional

Response

Created

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

default_customer_country_selectorlist of enums

default_billing_currency_selectorlist of enums

object_typestring or nullRead-only

idstring or nullRead-only

created_atstring or nullRead-only

statusstring or null

timezonestring or null

legal_namestring or null

The legal name of the billing entity.

tax_idstring or nullformat: "^[a-zA-Z0-9\-]*"0-256 characters

The ID used for tax purposes of the billing entity.

tax_idslist of objects or null

Tax IDs used for tax purposes of the billing entity

registration_numberstring or null

The registration number of the billing entity.

registered_addressobject

The address of this tax registration, if different from the billing entity. Currently, only the address will be used for tax calculations

emailstring or nullformat: "(\S*@\S*\..*)"0-256 characters

The email address of the billing entity.

tax_settingsobject

Customise tax settings for this Billing Entity

tax_registrationslist of objects or null

Extra tax registrations for this billing entity

custom_fieldslist of objects or null

linked_integrationslist of objects or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors