# Save Electronic File Subscription

Save Electronic File Subscription

Endpoint: POST /rest/2.0/EFILE
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

  - `brmObjects.SchedulerDay` (string)
    Scheduler Day

  - `brmObjects.EfileStatus` (string, required)
    Status

  - `brmObjects.FtpDir` (string)
    Directory

  - `brmObjects.NextRunDate` (string)
    Scheduler Next Run Date

  - `brmObjects.EfileDeliveryMethod` (string, required)
    Delivery Method

  - `brmObjects.EfileFormat` (string)
    E-File Format

  - `brmObjects.LastRunDate` (string)
    Last Run Date

  - `brmObjects.RecipientCc` (string)
    Recipient Cc

  - `brmObjects.EfileNamePattern` (string, required)
    E-File Naming Pattern: Efile Name Pattern can be specified with the following tags: {DD},{MM},{YY},{YYYY},{FROM_ID},{TO_ID},{UNIQUE_EFILE_ID}. Example: efile_invoice_{FROM_ID}_{MM}/{DD}/{YYYY}.csv

  - `brmObjects.Id` (string, required)
    Electronic File Setup ID: EFILE_ID

  - `brmObjects.FtpIp` (string)
    IP or Server Name

  - `brmObjects.IncludeHierarchyFlag` (integer)
    Include Hierarchy

  - `brmObjects.RecipientBcc` (string)
    Recipient Bcc

  - `brmObjects.AccountId` (integer, required)
    Account

  - `brmObjects.RecipientTo` (string)
    Recipient

  - `brmObjects.EfileDeliveryCycle` (string, required)
    Deliver For

  - `brmObjects.EfileTemplateId` (integer, required)
    E-File Template Name

  - `brmObjects.CompressionFlag` (integer)
    Compress Output

  - `brmObjects.EmailTemplateId` (string)
    Email Template

  - `brmObjects.FtpUsername` (string)
    Username

  - `brmObjects.SchedulerPeriod` (string)
    E-File Period

  - `brmObjects.Description` (string)
    Description

  - `brmObjects.LastId` (string)
    LastId

  - `brmObjects.IncludeHeaderFlag` (integer)
    IncludeHeaderFlag

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.SchedulerDay` (string)
    Scheduler Day

  - `retrieveResponse.EfileStatus` (string)
    Status

  - `retrieveResponse.FtpDir` (string)
    Directory

  - `retrieveResponse.NextRunDate` (string)
    Scheduler Next Run Date

  - `retrieveResponse.EfileDeliveryMethod` (string)
    Delivery Method

  - `retrieveResponse.EfileFormat` (string)
    E-File Format

  - `retrieveResponse.LastRunDate` (string)
    Last Run Date

  - `retrieveResponse.RecipientCc` (string)
    Recipient Cc

  - `retrieveResponse.EfileNamePattern` (string)
    E-File Naming Pattern: Efile Name Pattern can be specified with the following tags: {DD},{MM},{YY},{YYYY},{FROM_ID},{TO_ID},{UNIQUE_EFILE_ID}. Example: efile_invoice_{FROM_ID}_{MM}/{DD}/{YYYY}.csv

  - `retrieveResponse.Id` (string)
    Electronic File Setup ID: EFILE_ID

  - `retrieveResponse.FtpIp` (string)
    IP or Server Name

  - `retrieveResponse.IncludeHierarchyFlag` (integer)
    Include Hierarchy

  - `retrieveResponse.RecipientBcc` (string)
    Recipient Bcc

  - `retrieveResponse.AccountId` (integer)
    Account

  - `retrieveResponse.RecipientTo` (string)
    Recipient

  - `retrieveResponse.EfileDeliveryCycle` (string)
    Deliver For

  - `retrieveResponse.EfileTemplateId` (integer)
    E-File Template Name

  - `retrieveResponse.CompressionFlag` (integer)
    Compress Output

  - `retrieveResponse.EmailTemplateId` (string)
    Email Template

  - `retrieveResponse.FtpUsername` (string)
    Username

  - `retrieveResponse.SchedulerPeriod` (string)
    E-File Period

  - `retrieveResponse.Description` (string)
    Description

  - `retrieveResponse.LastId` (string)
    LastId

  - `retrieveResponse.IncludeHeaderFlag` (integer)
    IncludeHeaderFlag

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error