Solvimon customers API

openapi: 3.2.0
info:
  title: Configuration alertRules Customers API
  version: 1.0.0
servers:
- url: https://test.api.solvimon.com
  description: The TEST environment for our API
- url: https://api.solvimon.com
  description: The live environment for our API
tags:
- name: customers
paths:
  /v{version}/customers:
    get:
      operationId: getCustomers
      summary: Get a list of all customers
      description: Requires the CUSTOMER.VIEW permission.
      tags:
      - customers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: limit
        in: query
        description: The amount of records shown in the list
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: The page which is going to be shown
        required: false
        schema:
          type: integer
      - name: order_by
        in: query
        description: The parameter by which the response is ordered.
        required: false
        schema:
          type: string
      - name: custom_field
        in: query
        description: Filter the response by a custom field value.
        required: false
        schema:
          type: string
      - name: order_direction
        in: query
        description: The order direction by which the response is ordered.
        required: false
        schema:
          type: string
      - name: reference
        in: query
        description: The reference by which the resource will be filtered.
        required: false
        schema:
          type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerResponseWrapper'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    post:
      operationId: postCustomers
      summary: Create a customer
      description: Requires the CUSTOMER.CREATE permission.
      tags:
      - customers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerCreateRequest'
    put:
      operationId: putCustomers
      summary: Update or create a customer (upsert)
      description: Requires the CUSTOMER.CREATE, CUSTOMER.UPDATE or CUSTOMER.STATUS.DRAFT.UPDATE permission.
      tags:
      - customers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: identifier_field
        in: query
        description: Which field to use to identify whether the resource exists or not
        required: false
        schema:
          type: string
      - name: custom_field_reference
        in: query
        description: Which custom field to use to identify whether the resource exists or not
        required: false
        schema:
          type: string
      - name: field_actions
        in: query
        description: The list of actions for specific fields.
        required: false
        schema:
          type: object
          additionalProperties:
            type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerCreateRequest'
  /v{version}/customers/{resourceIdOrReference}:
    get:
      operationId: getCustomersByResourceIdOrReference
      summary: Get a customer by ID or reference
      description: Requires the CUSTOMER.VIEW permission.
      tags:
      - customers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    delete:
      operationId: deleteCustomersByResourceIdOrReference
      summary: Delete a customer by ID or reference
      description: Requires the CUSTOMER.DELETE or CUSTOMER.STATUS.DRAFT.DELETE permission.
      tags:
      - customers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    patch:
      operationId: patchCustomersByResourceIdOrReference
      summary: Update a customer by ID or reference
      description: Requires the CUSTOMER.UPDATE or CUSTOMER.STATUS.DRAFT.UPDATE permission.
      tags:
      - customers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerUpdateRequest'
  /v{version}/customers/{resourceIdOrReference}/entitlements:
    get:
      operationId: getCustomersByResourceIdOrReferenceEntitlements
      summary: Get a customer its entitlements
      description: Requires the CUSTOMER.VIEW permission.
      tags:
      - customers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entitlements'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/customers/{resourceIdOrReference}/activate:
    post:
      operationId: postCustomersByResourceIdOrReferenceActivate
      summary: Activate a customer
      description: Requires the CUSTOMER.UPDATE or CUSTOMER.STATUS.DRAFT.UPDATE permission.
      tags:
      - customers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/customers/{resourceIdOrReference}/deprecate:
    post:
      operationId: postCustomersByResourceIdOrReferenceDeprecate
      summary: Deprecate a customer
      description: Requires the CUSTOMER.UPDATE permission.
      tags:
      - customers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/customers/{resourceIdOrReference}/archive:
    post:
      operationId: postCustomersByResourceIdOrReferenceArchive
      summary: Archive a customer
      description: Requires the CUSTOMER.UPDATE permission.
      tags:
      - customers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/customers/{resourceIdOrReference}/forget:
    post:
      operationId: postCustomersByResourceIdOrReferenceForget
      summary: Forget a customer
      description: Requires the CUSTOMER.UPDATE permission.
      tags:
      - customers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /v{version}/customers/{resourceIdOrReference}/wallets/balance:
    post:
      operationId: postCustomersByResourceIdOrReferenceWalletsBalance
      summary: Get the balance of all wallets of a customer
      description: Requires the CUSTOMER.VIEW or WALLET.VIEW permission.
      tags:
      - customers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceIdOrReference
        in: path
        description: The ID or reference of the resource.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerWalletBalancesStatus'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WalletBalanceStatusRequestCreateRequest'
  /v{version}/customers/search:
    post:
      operationId: postCustomersSearch
      summary: Search customers
      description: Requires the CUSTOMER.VIEW permission.
      tags:
      - customers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: expand[]
        in: query
        description: The id fields of the resources that are going to be expanded.
        required: false
        schema:
          type: array
          items:
            type: string
      - name: limit
        in: query
        description: The amount of records shown in the list
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: The page which is going to be shown
        required: false
        schema:
          type: integer
      - name: order_by
        in: query
        description: The parameter by which the response is ordered. default = name
        required: false
        schema:
          type: string
      - name: order_direction
        in: query
        description: The parameter for the response ordering direction (asc, desc) default asc
        required: false
        schema:
          type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerResponseWrapper'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCreateRequest'
  /v{version}/customers/validate-tax-id:
    post:
      operationId: postCustomersValidateTaxId
      summary: Validate tax id values
      description: Requires the CUSTOMER.CREATE permission.
      tags:
      - customers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxIdValidationWrapper'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerCreateRequest'
components:
  schemas:
    LinkedIntegrationUpdateRequest:
      type: object
      properties:
        id:
          type: string
        link_details:
          type: array
          items:
            $ref: '#/components/schemas/LinkDetail'
      title: LinkedIntegrationUpdateRequest
    ApiError:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ApiErrorType'
        code:
          $ref: '#/components/schemas/ApiErrorCode'
        field:
          type:
          - string
          - 'null'
        message:
          type: string
        resource_id:
          type:
          - string
          - 'null'
        resource_type:
          oneOf:
          - $ref: '#/components/schemas/ApiErrorResourceType'
          - type: 'null'
      required:
      - type
      - code
      - message
      title: ApiError
    CustomerRolesItems:
      type: string
      enum:
      - DEFAULT
      - NON_PROCESSING
      - SELF_BILLING
      - SELLER
      - PROCESSING_ONLY
      title: CustomerRolesItems
    Individual:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/Name'
        residential_address:
          $ref: '#/components/schemas/Address'
      title: Individual
    PricingPlanSubscriptionSelectorCreateRequestFallback:
      type: string
      enum:
      - LATEST
      - NONE
      description: The fallback logic what to do when no subscription is found. By default it is LATEST
      title: PricingPlanSubscriptionSelectorCreateRequestFallback
    WalletBalanceValue:
      type: object
      properties:
        credits:
          oneOf:
          - $ref: '#/components/schemas/Credits'
          - type: 'null'
        amount:
          oneOf:
          - $ref: '#/components/schemas/Amount'
          - type: 'null'
      title: WalletBalanceValue
    NotificationPreference:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/NotificationPreferenceType'
          description: The notification type to configure.
        channels:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/NotificationChannel'
          description: The channels for this notification type.
      title: NotificationPreference
    EntitlementSummaryItem:
      type: object
      properties:
        feature_reference:
          type:
          - string
          - 'null'
        feature_id:
          type:
          - string
          - 'null'
        overwrite:
          type:
          - boolean
          - 'null'
        override:
          type:
          - boolean
          - 'null'
        number:
          type:
          - string
          - 'null'
        switch:
          type:
          - boolean
          - 'null'
        amount:
          $ref: '#/components/schemas/Amount'
        enums:
          type:
          - array
          - 'null'
          items:
            type: string
        strings:
          type:
          - array
          - 'null'
          items:
            type: string
      title: EntitlementSummaryItem
    CustomerType:
      type: string
      enum:
      - ORGANIZATION
      - INDIVIDUAL
      description: The type of customer entity.
      title: CustomerType
    CustomerCreateRequestType:
      type: string
      enum:
      - ORGANIZATION
      - INDIVIDUAL
      description: The type of customer entity.
      title: CustomerCreateRequestType
    FilterFieldCreateRequest:
      type: object
      properties:
        name:
          type: string
        reference:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        values:
          type: array
          items:
            type: string
      title: FilterFieldCreateRequest
    CustomerSellerDetails:
      type: object
      properties:
        default_billing_entity_id:
          type:
          - string
          - 'null'
          description: Resource ID of type BILLING_ENTITY
      title: CustomerSellerDetails
    Customer:
      type: object
      properties:
        object_type:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        created_at:
          type:
          - string
          - 'null'
        parent_customer_id:
          type:
          - string
          - 'null'
          description: The parent of the customer. Only returned when there is a single parent.
        parent_customer_ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: A list of parents of the customer. Will also be returned if there is a single parent.
        reference:
          type: string
          description: A custom reference assigned to the customer.
        status:
          oneOf:
          - $ref: '#/components/schemas/CustomerStatus'
          - type: 'null'
        timezone:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/CustomerType'
          description: The type of customer entity.
        email:
          type: string
          description: The email of the customer.
        notification_preferences:
          type:
          - array
          - 'null

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/solvimon/refs/heads/main/openapi/solvimon-customers-api-openapi.yml