AccountIntegration.md

MergeHRISClient::AccountIntegration

Properties

Name	Type	Description	Notes
name	String	Company name.
abbreviated_name	String	Optional. This shortened name appears in places with limited space, usually in conjunction with the platform's logo (e.g., Merge Link menu).<br><br>Example: <i>Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP SuccessFactors)</i>	[optional]
categories	Array<CategoriesEnum>	Category or categories this integration belongs to. Multiple categories should be comma separated, i.e. [ats, hris].	[optional][readonly]
image	String	Company logo in rectangular shape. <b>Upload an image with a clear background.</b>	[optional]
square_image	String	Company logo in square shape. <b>Upload an image with a white background.</b>	[optional]
color	String	The color of this integration used for buttons and text throughout the app and landing pages. <b>Choose a darker, saturated color.</b>	[optional]
slug	String		[optional][readonly]
api_endpoints_to_documentation_urls	Hash<String, AnyType>	Mapping of API endpoints to documentation urls for support. Example: {'GET': [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']], 'POST': []}	[optional]
webhook_setup_guide_url	String	Setup guide URL for third party webhook creation. Exposed in Merge Docs.	[optional]
category_beta_status	Object	Category or categories this integration is in beta status for.	[optional][readonly]

Example

require 'merge_hris_client'

instance = MergeHRISClient::AccountIntegration.new(
  name: null,
  abbreviated_name: null,
  categories: null,
  image: null,
  square_image: null,
  color: null,
  slug: null,
  api_endpoints_to_documentation_urls: null,
  webhook_setup_guide_url: null,
  category_beta_status: null
)