Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 1.95 KB

AccountIntegration.md

File metadata and controls

34 lines (28 loc) · 1.95 KB

MergeAccountingClient::AccountIntegration

Properties

Name Type Description Notes
name String Company name.
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]
is_in_beta Boolean If checked, this integration will not appear in the linking flow, and will appear elsewhere with a Beta tag. [optional]
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]

Example

require 'merge_accounting_client'

instance = MergeAccountingClient::AccountIntegration.new(
  name: null,
  categories: null,
  image: null,
  square_image: null,
  color: null,
  slug: null,
  is_in_beta: null,
  api_endpoints_to_documentation_urls: null,
  webhook_setup_guide_url: null
)