Skip to main content

SftpConfigExport

SFTP destination for scheduled daily charges exports. The previous day's charges are pushed at 06:00 UTC when enabled is true.

type SftpConfigExport {
  id: ID!
  host: String!
  port: Int!
  username: String!
  path: String!
  columns: [String!]
  timezone: String
  enabled: Boolean
}

Fields​

SftpConfigExport.id ● ID! non-null scalar​

Config ID.

SftpConfigExport.host ● String! non-null scalar​

SFTP server hostname.

SftpConfigExport.port ● Int! non-null scalar​

SFTP server port.

SftpConfigExport.username ● String! non-null scalar​

SFTP username.

SftpConfigExport.path ● String! non-null scalar​

Target directory on the SFTP server where CSV files are written.

SftpConfigExport.columns ● [String!] list scalar​

Columns to include in the CSV. When omitted, the default column set is used. See exportCharges for the available columns.

SftpConfigExport.timezone ● String scalar​

IANA timezone used to format date columns (e.g. Europe/Madrid). Defaults to UTC.

SftpConfigExport.enabled ● Boolean scalar​

Whether the scheduled export is active. Disabled configs are kept but skipped at run time.

Returned By​

createExportSftpConfig mutation ● exportSftpConfig query ● updateExportSftpConfig mutation

Member Of​

SftpConfigExportsConnection object