Function ACHFilesApiAxiosParamCreator

Returns {
    addBatchToFile: (
        fileID: string,
        batch: Batch,
        xRequestID?: string,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    buildFile: (
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    checkFile: (
        fileID: string,
        skipAll?: boolean,
        allowEmptyIndividualName?: boolean,
        allowInvalidAmounts?: boolean,
        allowInvalidCheckDigit?: boolean,
        allowMissingFileControl?: boolean,
        allowMissingFileHeader?: boolean,
        allowSpecialCharacters?: boolean,
        allowUnorderedBatchNumbers?: boolean,
        allowZeroBatches?: boolean,
        bypassBatchValidation?: boolean,
        bypassCompanyIdentificationMatch?: boolean,
        bypassDestination?: boolean,
        bypassDestinationValidation?: boolean,
        bypassOrigin?: boolean,
        bypassOriginValidation?: boolean,
        customReturnCodes?: boolean,
        customTraceNumbers?: boolean,
        preserveSpaces?: boolean,
        requireABAOrigin?: boolean,
        skipFileCreationValidation?: boolean,
        skipBatchHeaderCompanyValidation?: boolean,
        unequalAddendaCounts?: boolean,
        unequalServiceClassCode?: boolean,
        unorderedBatchNumbers?: boolean,
        xRequestID?: string,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    createFile: (
        fileID: string,
        body: string,
        xRequestID?: string,
        skipAll?: boolean,
        allowEmptyIndividualName?: boolean,
        allowInvalidAmounts?: boolean,
        allowInvalidCheckDigit?: boolean,
        allowMissingFileControl?: boolean,
        allowMissingFileHeader?: boolean,
        allowSpecialCharacters?: boolean,
        allowUnorderedBatchNumbers?: boolean,
        allowZeroBatches?: boolean,
        bypassBatchValidation?: boolean,
        bypassCompanyIdentificationMatch?: boolean,
        bypassDestination?: boolean,
        bypassDestinationValidation?: boolean,
        bypassOrigin?: boolean,
        bypassOriginValidation?: boolean,
        customReturnCodes?: boolean,
        customTraceNumbers?: boolean,
        preserveSpaces?: boolean,
        requireABAOrigin?: boolean,
        skipBatchHeaderCompanyValidation?: boolean,
        skipFileCreationValidation?: boolean,
        unequalAddendaCounts?: boolean,
        unequalServiceClassCode?: boolean,
        unorderedBatchNumbers?: boolean,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    createNewFile: (
        fileID: string,
        body: string,
        xRequestID?: string,
        skipAll?: boolean,
        allowEmptyIndividualName?: boolean,
        allowInvalidAmounts?: boolean,
        allowInvalidCheckDigit?: boolean,
        allowMissingFileControl?: boolean,
        allowMissingFileHeader?: boolean,
        allowSpecialCharacters?: boolean,
        allowUnorderedBatchNumbers?: boolean,
        allowZeroBatches?: boolean,
        bypassBatchValidation?: boolean,
        bypassCompanyIdentificationMatch?: boolean,
        bypassDestination?: boolean,
        bypassDestinationValidation?: boolean,
        bypassOrigin?: boolean,
        bypassOriginValidation?: boolean,
        customReturnCodes?: boolean,
        customTraceNumbers?: boolean,
        preserveSpaces?: boolean,
        requireABAOrigin?: boolean,
        skipBatchHeaderCompanyValidation?: boolean,
        skipFileCreationValidation?: boolean,
        unequalAddendaCounts?: boolean,
        unequalServiceClassCode?: boolean,
        unorderedBatchNumbers?: boolean,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    deleteACHFile: (
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    deleteFileBatch: (
        fileID: string,
        batchID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    flattenFile: (
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    getFileBatch: (
        fileID: string,
        batchID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    getFileBatches: (
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    getFileByID: (
        fileID: string,
        xRequestID?: string,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    getFileContents: (
        fileID: string,
        xRequestID?: string,
        xLineEnding?: "LF" | "CRLF",
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    getFiles: (
        xRequestID?: string,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    mergeFiles: (
        mergeFilesRequest: MergeFilesRequest,
        xRequestID?: string,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    ping: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    reverseFile: (
        fileID: string,
        xRequestID?: string,
        reverseFileRequest?: ReverseFileRequest,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    segmentFile: (
        xRequestID?: string,
        body?: string,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    segmentFileID: (
        fileID: string,
        xRequestID?: string,
        body?: any,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
    validateFile: (
        fileID: string,
        skipAll?: boolean,
        allowEmptyIndividualName?: boolean,
        allowInvalidAmounts?: boolean,
        allowInvalidCheckDigit?: boolean,
        allowMissingFileControl?: boolean,
        allowMissingFileHeader?: boolean,
        allowSpecialCharacters?: boolean,
        allowUnorderedBatchNumbers?: boolean,
        allowZeroBatches?: boolean,
        bypassBatchValidation?: boolean,
        bypassCompanyIdentificationMatch?: boolean,
        bypassDestination?: boolean,
        bypassDestinationValidation?: boolean,
        bypassOrigin?: boolean,
        bypassOriginValidation?: boolean,
        customReturnCodes?: boolean,
        customTraceNumbers?: boolean,
        preserveSpaces?: boolean,
        requireABAOrigin?: boolean,
        skipFileCreationValidation?: boolean,
        skipBatchHeaderCompanyValidation?: boolean,
        unequalAddendaCounts?: boolean,
        unequalServiceClassCode?: boolean,
        unorderedBatchNumbers?: boolean,
        xRequestID?: string,
        validateOpts?: ValidateOpts,
        options?: AxiosRequestConfig,
    ) => Promise<RequestArgs>;
}

• addBatchToFile: (
      fileID: string,
      batch: Batch,
      xRequestID?: string,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Append a Batch record to the specified File.

  Throws

• buildFile: (
      fileID: string,
      xRequestID?: string,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.

  Throws

• checkFile: (
      fileID: string,
      skipAll?: boolean,
      allowEmptyIndividualName?: boolean,
      allowInvalidAmounts?: boolean,
      allowInvalidCheckDigit?: boolean,
      allowMissingFileControl?: boolean,
      allowMissingFileHeader?: boolean,
      allowSpecialCharacters?: boolean,
      allowUnorderedBatchNumbers?: boolean,
      allowZeroBatches?: boolean,
      bypassBatchValidation?: boolean,
      bypassCompanyIdentificationMatch?: boolean,
      bypassDestination?: boolean,
      bypassDestinationValidation?: boolean,
      bypassOrigin?: boolean,
      bypassOriginValidation?: boolean,
      customReturnCodes?: boolean,
      customTraceNumbers?: boolean,
      preserveSpaces?: boolean,
      requireABAOrigin?: boolean,
      skipFileCreationValidation?: boolean,
      skipBatchHeaderCompanyValidation?: boolean,
      unequalAddendaCounts?: boolean,
      unequalServiceClassCode?: boolean,
      unorderedBatchNumbers?: boolean,
      xRequestID?: string,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Validates the existing File. You need only supply the unique File identifier that was returned upon creation.

  Throws

• createFile: (
      fileID: string,
      body: string,
      xRequestID?: string,
      skipAll?: boolean,
      allowEmptyIndividualName?: boolean,
      allowInvalidAmounts?: boolean,
      allowInvalidCheckDigit?: boolean,
      allowMissingFileControl?: boolean,
      allowMissingFileHeader?: boolean,
      allowSpecialCharacters?: boolean,
      allowUnorderedBatchNumbers?: boolean,
      allowZeroBatches?: boolean,
      bypassBatchValidation?: boolean,
      bypassCompanyIdentificationMatch?: boolean,
      bypassDestination?: boolean,
      bypassDestinationValidation?: boolean,
      bypassOrigin?: boolean,
      bypassOriginValidation?: boolean,
      customReturnCodes?: boolean,
      customTraceNumbers?: boolean,
      preserveSpaces?: boolean,
      requireABAOrigin?: boolean,
      skipBatchHeaderCompanyValidation?: boolean,
      skipFileCreationValidation?: boolean,
      unequalAddendaCounts?: boolean,
      unequalServiceClassCode?: boolean,
      unorderedBatchNumbers?: boolean,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Create a new File object from either the plaintext or JSON representation.

  Throws

• createNewFile: (
      fileID: string,
      body: string,
      xRequestID?: string,
      skipAll?: boolean,
      allowEmptyIndividualName?: boolean,
      allowInvalidAmounts?: boolean,
      allowInvalidCheckDigit?: boolean,
      allowMissingFileControl?: boolean,
      allowMissingFileHeader?: boolean,
      allowSpecialCharacters?: boolean,
      allowUnorderedBatchNumbers?: boolean,
      allowZeroBatches?: boolean,
      bypassBatchValidation?: boolean,
      bypassCompanyIdentificationMatch?: boolean,
      bypassDestination?: boolean,
      bypassDestinationValidation?: boolean,
      bypassOrigin?: boolean,
      bypassOriginValidation?: boolean,
      customReturnCodes?: boolean,
      customTraceNumbers?: boolean,
      preserveSpaces?: boolean,
      requireABAOrigin?: boolean,
      skipBatchHeaderCompanyValidation?: boolean,
      skipFileCreationValidation?: boolean,
      unequalAddendaCounts?: boolean,
      unequalServiceClassCode?: boolean,
      unorderedBatchNumbers?: boolean,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Create a new File object from either the plaintext or JSON representation. This endpoint is the same as POST /files/{fileID} but it's documented to accept a string/generic body which helps some generated clients. (e.g. Java) See https://github.com/moov-io/ach/issues/1650 for more details.

  Throws

• deleteACHFile: (
      fileID: string,
      xRequestID?: string,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Permanently deletes a File and associated Batches. It cannot be undone.

  Throws

• deleteFileBatch: (
      fileID: string,
      batchID: string,
      xRequestID?: string,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Delete a Batch from a File.

  Throws

• flattenFile: (
      fileID: string,
      xRequestID?: string,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Consolidate Batches and Entries into the minimum number of Batches needed.

  Throws

• getFileBatch: (
      fileID: string,
      batchID: string,
      xRequestID?: string,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Get a specific Batch on a File.

  Throws

• getFileBatches: (
      fileID: string,
      xRequestID?: string,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Get the Batches on a File.

  Throws

• getFileByID: (
      fileID: string,
      xRequestID?: string,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Get the details of an existing File using the unique File identifier that was returned upon creation.

  Throws

• getFileContents: (
      fileID: string,
      xRequestID?: string,
      xLineEnding?: "LF" | "CRLF",
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.

  Throws

• getFiles: (xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>

  List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.

  Throws

• mergeFiles: (
      mergeFilesRequest: MergeFilesRequest,
      xRequestID?: string,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Combine multiple fileIDs and files together. Returned is the results of merging

  Throws

• ping: (options?: AxiosRequestConfig) => Promise<RequestArgs>

  Check if the ACH service is running.

  Throws

• reverseFile: (
      fileID: string,
      xRequestID?: string,
      reverseFileRequest?: ReverseFileRequest,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Creates a new file that is a REVERSAL of the given fileID.

  Throws

• segmentFile: (
      xRequestID?: string,
      body?: string,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Split one File into two. One with only debits and one with only credits.

  Throws

• segmentFileID: (
      fileID: string,
      xRequestID?: string,
      body?: any,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Split one FileID into two. One with only debits and one with only credits.

  Throws

• validateFile: (
      fileID: string,
      skipAll?: boolean,
      allowEmptyIndividualName?: boolean,
      allowInvalidAmounts?: boolean,
      allowInvalidCheckDigit?: boolean,
      allowMissingFileControl?: boolean,
      allowMissingFileHeader?: boolean,
      allowSpecialCharacters?: boolean,
      allowUnorderedBatchNumbers?: boolean,
      allowZeroBatches?: boolean,
      bypassBatchValidation?: boolean,
      bypassCompanyIdentificationMatch?: boolean,
      bypassDestination?: boolean,
      bypassDestinationValidation?: boolean,
      bypassOrigin?: boolean,
      bypassOriginValidation?: boolean,
      customReturnCodes?: boolean,
      customTraceNumbers?: boolean,
      preserveSpaces?: boolean,
      requireABAOrigin?: boolean,
      skipFileCreationValidation?: boolean,
      skipBatchHeaderCompanyValidation?: boolean,
      unequalAddendaCounts?: boolean,
      unequalServiceClassCode?: boolean,
      unorderedBatchNumbers?: boolean,
      xRequestID?: string,
      validateOpts?: ValidateOpts,
      options?: AxiosRequestConfig,
  ) => Promise<RequestArgs>

  Validates the existing File. You need only supply the unique File identifier that was returned upon creation.

  Throws