{ "opencollection": "1.0.0", "info": { "name": "Accounting API", "version": "1.0.0" }, "items": [ { "info": { "name": "", "type": "folder" }, "items": [ { "info": { "name": "Field Mappings Create", "type": "http" }, "http": { "method": "POST", "url": "https://api.merge.dev/api/hris/v1/field-mappings", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Account-Token", "value": "" } ], "params": [ { "name": "exclude_remote_field_metadata", "value": "", "type": "query", "description": "If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations." }, { "name": "remote_data_iteration_count", "value": "", "type": "query", "description": "Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start." }, { "info": { "name": "Field Mappings Partial Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.merge.dev/api/hris/v1/field-mappings/:field_mapping_id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Account-Token", "value": "" } ], "params": [ { "name": "field_mapping_id", "value": "", "type": "path" }, { "name": "remote_data_iteration_count", "value": "", "type": "query", "description": "Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start." }, { "info": { "name": "Field Mappings Destroy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.merge.dev/api/hris/v1/field-mappings/:field_mapping_id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Account-Token", "value": "" } ], "params": [ { "name": "field_mapping_id", "value": "", "type": "path" } ] }, "docs": "Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start." }, { "info": { "name": "Remote Fields Retrieve", "type": "http" }, "http": { "method": "GET", "url": "https://api.merge.dev/api/hris/v1/remote-fields", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Account-Token", "value": "" } ], "params": [ { "name": "common_models", "value": "", "type": "query", "description": "A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models." }, { "name": "include_example_values", "value": "", "type": "query", "description": "If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers." } ] }, "docs": "Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/)." }, { "info": { "name": "Target Fields Retrieve", "type": "http" }, "http": { "method": "GET", "url": "https://api.merge.dev/api/hris/v1/target-fields", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Account-Token", "value": "" } ] }, "docs": "Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/)." } ] } ], "bundled": true }