Sensibill Core/com.getsensibill.core.apimodule.exports.model

Package-level declarations

Types

data class CompletedExport(val destructionTime: OffsetDateTime, val createdAt: OffsetDateTime, val updatedAt: OffsetDateTime, val resultSize: Int, val outputFormats: List<ExportFormat>, val documentIds: List<String>, val id: String, val completionTime: OffsetDateTime, val fileUrl: String, val fileSize: Int)

An additional convenience Export model that is used to represent a "completed" (ExportStatus.COMPLETED) export.

CreateExportPayload

data class CreateExportPayload(val outputFormats: List<ExportFormat>, val criteria: ExportItemCriteria, val localeCode: String?)

Payload object used to provide export creation parameters to the API

CreateExportResponse

data class CreateExportResponse(val destructionTime: OffsetDateTime, val createdAt: OffsetDateTime, val outputFormats: List<ExportFormat>, val documentsCount: Int, val status: ExportStatus, val id: String)

The Response payload received when creating an export. In this model, status can only contain a reduced set of ExportStatuses that are possible right after export creation.

DownloadExportResult

data class DownloadExportResult(val downloadedExportFile: File)

Model that describes the result of an export download

Export

data class Export(val destructionTime: OffsetDateTime, val createdAt: OffsetDateTime, val updatedAt: OffsetDateTime, val resultSize: Int, val outputFormats: List<ExportFormat>, val documentIds: List<String>, val status: ExportStatus, val id: String, val completionTime: OffsetDateTime? = null, val fileUrl: String? = null, val fileSize: Int? = null)

Model containing all the properties of a created Document Export.

ExportFormat

enum ExportFormat : Enum<ExportFormat> , KeyedEnum

The set of possible export formats

ExportItemCriteria

data class ExportItemCriteria(val accountMetadataAccount: List<String>? = null, val accountMetadataAccountExists: Boolean? = null, val accountMetadataTransactionId: List<String>? = null, val accountMetadataTransactionIdExists: Boolean? = null, val amountDue: List<BigDecimal>? = null, val amountDueGte: BigDecimal? = null, val amountDueLte: BigDecimal? = null, val arrivalDateTimeGte: OffsetDateTime? = null, val arrivalDateTimeLte: OffsetDateTime? = null, val categoryCode: List<String>? = null, val currencyCode: List<String>? = null, val description: List<String>? = null, val documentDate: List<LocalDate>? = null, val documentDateGte: LocalDate? = null, val documentDateLte: LocalDate? = null, val documentNumber: List<String>? = null, val documentTime: List<String>? = null, val documentTimeGte: String? = null, val documentTimeLte: String? = null, val documentType: List<DocumentTypeEnum>? = null, val folder: List<String>? = null, val foreignId: List<String>? = null, val id: List<String>? = null, val lastUpdateDateTimeGte: OffsetDateTime? = null, val lastUpdateDateTimeLte: OffsetDateTime? = null, val merchantName: List<String>? = null, val merchantTaxIdNumber: List<String>? = null, val paymentTender: List<TenderTypesEnum>? = null, val total: List<BigDecimal>? = null, val totalGte: BigDecimal? = null, val totalLte: BigDecimal? = null, val status: List<DocumentStatusTypeEnum>? = null, val sourceFormat: List<DocumentSourceFormatsEnum>? = null)

Document filter criteria that can be used in order to generate an export.

ExportStatus

enum ExportStatus : Enum<ExportStatus> , KeyedEnum

Enum representing the different possible export server statuses.