{
  "opencollection": "1.0.0",
  "info": {
    "name": "Accounting subpackage_engagements API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_engagements",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.merge.dev/api/crm/v1/engagements",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "created_after",
                "value": "",
                "type": "query",
                "description": "If provided, will only return objects created after this datetime."
              },
              {
                "name": "created_before",
                "value": "",
                "type": "query",
                "description": "If provided, will only return objects created before this datetime."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "The pagination cursor value."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces."
              },
              {
                "name": "include_deleted_data",
                "value": "",
                "type": "query",
                "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."
              },
              {
                "name": "include_remote_data",
                "value": "",
                "type": "query",
                "description": "Whether to include the original data Merge fetched from the third-party to produce these models."
              },
              {
                "name": "include_remote_fields",
                "value": "",
                "type": "query",
                "description": "Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format."
              },
              {
                "name": "include_shell_data",
                "value": "",
                "type": "query",
                "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)."
              },
              {
                "name": "modified_after",
                "value": "",
                "type": "query",
                "description": "If provided, only objects synced by Merge after this date time will be returned."
              },
              {
                "name": "modified_before",
                "value": "",
                "type": "query",
                "description": "If provided, only objects synced by Merge before this date time will be returned."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page. The maximum limit is 100."
              },
              {
                "name": "remote_id",
                "value": "",
                "type": "query",
                "description": "The API provider's ID for the given object."
              },
              {
                "name": "started_after",
                "value": "",
                "type": "query",
                "description": "If provided, will only return engagements started after this datetime."
              },
              {
                "name": "started_before",
                "value": "",
                "type": "query",
                "description": "If provided, will only return engagements started before this datetime."
              }
            ]
          },
          "docs": "Returns a list of `Engagement` objects.{/* BEGIN_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"GET\" data=\"H4sIAAAAAAAAA+1Y/W/aOBj+V5B/RECuZXQr0unEgBv0lLQHWe+6qYpenJfE4MSu7UDLtP/9lPBReuvQNhnYtP2WWK8f28/7+P3wB0LBYCTUA2kSqhJSIYkIkZMm6aYRRJhgakiFgGQeJLg0CmanpEJ0JqVQBsM/GfJQ9xSOSZM4CaoIq1nKxgxDh6rEYanBSIFhItXOZlZ1XEwjFcJZOsWwRanIUrMDZ2lXhaXh/361w5nOdypBaxMrkUXxAO8y1Lsg893w4ozAqyEYcLamV9Vy/nNj+b5D5Ggw7ICBDhqk+QFXS8XGSN10nBi5rBXL1kKcOZg6oAyjHLXTq"
        },
        {
          "info": {
            "name": "Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.merge.dev/api/crm/v1/engagements",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "is_debug_mode",
                "value": "",
                "type": "query",
                "description": "Whether to include debug fields (such as log file links) in the response."
              },
              {
                "name": "run_async",
                "value": "",
                "type": "query",
                "description": "Whether or not third-party updates should be run asynchronously."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates an `Engagement` object with the given values.{/* BEGIN_CRM_ENGAGEMENT_CREATE_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"POST\" data=\"H4sIAAAAAAAAA72WUW/aMBSF/0rlRxSSAWVdkaaJAisgETpIu3UVihznEgxOHGwH2lT971MSoLSDMqa0b4l177Hz3ZOTPCKCFXhcPKAaIsJHGvK5CwzVUCvwsAc+BAppCIfUxD5kRfaijDQkozDkQoH7nQJzZVvAGNWQ4YPwoBgFdEzBNYjwDRoo8ARWlAfS2HQVx2kb0hCjwQzcOiE8CtQbOlldEWeFr26lwahMThpiKdVE8MibDGAegXxLMjkNS58Rs6KLFTa22osi69+1lpzbBQYK3CZWuAkKSPKAq60mSoWyZhgTYKGebqu7sDAgM"
        },
        {
          "info": {
            "name": "Retrieve",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.merge.dev/api/crm/v1/engagements/:id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces."
              },
              {
                "name": "include_remote_data",
                "value": "",
                "type": "query",
                "description": "Whether to include the original data Merge fetched from the third-party to produce these models."
              },
              {
                "name": "include_remote_fields",
                "value": "",
                "type": "query",
                "description": "Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format."
              },
              {
                "name": "include_shell_data",
                "value": "",
                "type": "query",
                "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)."
              }
            ]
          },
          "docs": "Returns an `Engagement` object with the given `id`.{/* BEGIN_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"GET\" data=\"H4sIAAAAAAAAA+1Y/W/aOBj+V5B/RECuZXQr0unEgBv0lLQHWe+6qYpenJfE4MSu7UDLtP/9lPBReuvQNhnYtP2WWK8f28/7+P3wB0LBYCTUA2kSqhJSIYkIkZMm6aYRRJhgakiFgGQeJLg0CmanpEJ0JqVQBsM/GfJQ9xSOSZM4CaoIq1nKxgxDh6rEYanBSIFhItXOZlZ1XEwjFcJZOsWwRanIUrMDZ2lXhaXh/361w5nOdypBaxMrkUXxAO8y1Lsg893w4ozAqyEYcLamV9Vy/nNj+b5D5Ggw7ICBDhqk+QFXS8XGSN10nBi5rBXL1kKcO"
        },
        {
          "info": {
            "name": "Partial Update",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.merge.dev/api/crm/v1/engagements/:id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "is_debug_mode",
                "value": "",
                "type": "query",
                "description": "Whether to include debug fields (such as log file links) in the response."
              },
              {
                "name": "run_async",
                "value": "",
                "type": "query",
                "description": "Whether or not third-party updates should be run asynchronously."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an `Engagement` object with the given `id`.{/* BEGIN_CRM_ENGAGEMENT_EDIT_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"PATCH\" data=\"H4sIAAAAAAAAA62Tb0/bMBDGv8u9rPJnpXSISNNU2o62UlwGAQ0hFF2ca+rWiVPbaSGI7z6l7Vi3AXvDS5/vnjv/7vETcLSUKf0IAXCdgwO5SklCAMMiw4xyKiw4gKVgmNMuKV4fgQOmKkulLaXfBMnUjDTNIAA/J52RWxViJij1uc59UVjKNFqhCuO/VLmzbRk4IEWxpLTHuaoK+47OLs/FXeJfR+NLYZpJSzTGzrWqsvklrSoy70k208jtG1G6KVr0D8pdvat/LdbMnZIkS+kALQ7IEm8euG81t7Y0ge/PSZbetq2X0tqnwkdtBZdk/G7n"
        },
        {
          "info": {
            "name": "Meta Patch Retrieve",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.merge.dev/api/crm/v1/engagements/meta/patch/:id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns metadata for `Engagement` PATCHs.{/* BEGIN_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"GET\" data=\"H4sIAAAAAAAAA+1Y/W/aOBj+V5B/RECuZXQr0unEgBv0lLQHWe+6qYpenJfE4MSu7UDLtP/9lPBReuvQNhnYtP2WWK8f28/7+P3wB0LBYCTUA2kSqhJSIYkIkZMm6aYRRJhgakiFgGQeJLg0CmanpEJ0JqVQBsM/GfJQ9xSOSZM4CaoIq1nKxgxDh6rEYanBSIFhItXOZlZ1XEwjFcJZOsWwRanIUrMDZ2lXhaXh/361w5nOdypBaxMrkUXxAO8y1Lsg893w4ozAqyEYcLamV9Vy/nNj+b5D5Ggw7ICBDhqk+QFXS8XGSN10nBi5rBXL1kKcOZg6oAyjHLX"
        },
        {
          "info": {
            "name": "Meta Post Retrieve",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.merge.dev/api/crm/v1/engagements/meta/post",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ]
          },
          "docs": "Returns metadata for `Engagement` POSTs.{/* BEGIN_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"GET\" data=\"H4sIAAAAAAAAA+1Y/W/aOBj+V5B/RECuZXQr0unEgBv0lLQHWe+6qYpenJfE4MSu7UDLtP/9lPBReuvQNhnYtP2WWK8f28/7+P3wB0LBYCTUA2kSqhJSIYkIkZMm6aYRRJhgakiFgGQeJLg0CmanpEJ0JqVQBsM/GfJQ9xSOSZM4CaoIq1nKxgxDh6rEYanBSIFhItXOZlZ1XEwjFcJZOsWwRanIUrMDZ2lXhaXh/361w5nOdypBaxMrkUXxAO8y1Lsg893w4ozAqyEYcLamV9Vy/nNj+b5D5Ggw7ICBDhqk+QFXS8XGSN10nBi5rBXL1kKcOZg6oAyjHLXT"
        },
        {
          "info": {
            "name": "Remote Field Classes List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.merge.dev/api/crm/v1/engagements/remote-field-classes",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "The pagination cursor value."
              },
              {
                "name": "include_deleted_data",
                "value": "",
                "type": "query",
                "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."
              },
              {
                "name": "include_remote_data",
                "value": "",
                "type": "query",
                "description": "Whether to include the original data Merge fetched from the third-party to produce these models."
              },
              {
                "name": "include_remote_fields",
                "value": "",
                "type": "query",
                "description": "Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format."
              },
              {
                "name": "include_shell_data",
                "value": "",
                "type": "query",
                "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)."
              },
              {
                "name": "is_common_model_field",
                "value": "",
                "type": "query",
                "description": "If provided, will only return remote field classes with this is_common_model_field value"
              },
              {
                "name": "is_custom",
                "value": "",
                "type": "query",
                "description": "If provided, will only return remote fields classes with this is_custom value"
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of results to return per page. The maximum limit is 100."
              }
            ]
          },
          "docs": "Returns a list of `RemoteFieldClass` objects.{/* BEGIN_CRM_ENGAGEMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"GET\" data=\"H4sIAAAAAAAAA+1Y/W/aOBj+V5B/RECuZXQr0unEgBv0lLQHWe+6qYpenJfE4MSu7UDLtP/9lPBReuvQNhnYtP2WWK8f28/7+P3wB0LBYCTUA2kSqhJSIYkIkZMm6aYRRJhgakiFgGQeJLg0CmanpEJ0JqVQBsM/GfJQ9xSOSZM4CaoIq1nKxgxDh6rEYanBSIFhItXOZlZ1XEwjFcJZOsWwRanIUrMDZ2lXhaXh/361w5nOdypBaxMrkUXxAO8y1Lsg893w4ozAqyEYcLamV9Vy/nNj+b5D5Ggw7ICBDhqk+QFXS8XGSN10nBi5rBXL1kKcOZg6oAy"
        }
      ]
    }
  ],
  "bundled": true
}