Sensibill Core/com.getsensibill.core.apimodule.documents.model.api

Package-level declarations

Types

data class DeleteDocumentError(val id: String, val message: String)

data class Document(val id: String, val foreignId: String? = null, val arrivalDateTime: OffsetDateTime, val lastUpdateDateTime: OffsetDateTime, val documentType: DocumentType, val status: DocumentServerStatus, val description: String? = null, val content: DocumentContent, val source: DocumentSource? = null, val accountMetadata: DocumentAccountMetadata? = null, val userMetadata: DocumentUserMetadata? = null)

data class DocumentAccountMetadata(val account: String? = null, val transactionId: String? = null)

data class DocumentContent(val amountDue: DocumentTaxableAmount? = null, val barcodes: List<DocumentContent.Barcode>? = null, val countryCode: CountryCode? = null, val currencyCode: CurrencyCodeEnum? = null, val customer: DocumentContent.Customer? = null, val discounts: List<DocumentContent.Discount>? = null, val documentNumber: String? = null, val dueDate: LocalDate? = null, val documentDate: LocalDate? = null, val documentTime: LocalTime? = null, val fees: List<DocumentContent.Fee>? = null, val items: List<DocumentContent.Item>? = null, val languageCode: String? = null, val merchant: DocumentContent.Merchant? = null, val savings: BigDecimal? = null, val deliveries: List<DocumentContent.Delivery>? = null, val loyaltyRewards: DocumentContent.LoyaltyRewards? = null, val payments: List<DocumentContent.Payment>? = null, val tipAmount: BigDecimal? = null, val total: DocumentTaxableAmount? = null, val totalBeforeTips: DocumentTaxableAmount? = null, val totalBeforeDiscountsFeesTips: DocumentTaxableAmount? = null)

Note: CurrencyCodeEnum and CountryCode enums taken from generated dto's

data class DocumentError(val code: String, val description: String)

data class DocumentListItem(val id: String, val foreignId: String? = null, val accountMetadata: DocumentAccountMetadata? = null, val arrivalDateTime: OffsetDateTime, val lastUpdateDateTime: OffsetDateTime, val documentType: DocumentType, val description: String? = null, val status: DocumentServerStatus, val content: DocumentListItem.Content, val source: DocumentSource? = null, val userMetadata: DocumentUserMetadata? = null)

This is a subset of the properties that are available when fetching a single document. Similar to Document but containing reduced content

data class DocumentListRequestParams(val limit: Int? = null, val offset: Int? = null, val sortBy: DocumentSortByEnum? = DocumentSortByEnum.DOCUMENT_DATE, val orderBy: DocumentOrderByEnum? = null, val filters: DocumentListRequestParams.Filters = Filters())

data class DocumentSource(val type: DocumentSource.SourceType, val url: String, val imagePreview: String)

data class DocumentStatusErrorItem(val id: String, val message: String)

data class DocumentTax(val amount: BigDecimal? = null, val percent: BigDecimal? = null, val type: String? = null)

data class DocumentTaxableAmount(val taxes: List<DocumentTax>? = null, val beforeTax: BigDecimal? = null, val afterTax: BigDecimal? = null)

data class DocumentUploadPayload(val imageRepresentation: DocumentUploadPayload.ImageRepresentation, val documentType: DocumentType, val foreignId: String? = null, val accountId: String? = null, val description: String? = null, val transactionId: String? = null)

data class DocumentUserMetadata(val expenseType: DocumentUserMetadata.ExpenseType? = null, val folderIds: List<String>? = null, val notes: String? = null, val warrantyPeriod: DocumentUserMetadata.TimePeriod? = null, val returnPeriod: DocumentUserMetadata.TimePeriod? = null)

data class EditDocumentBody(val description: String? = null, val content: EditDocumentBody.EditableContent? = null, val accountMetadata: DocumentAccountMetadata? = null, val userMetadata: DocumentUserMetadata? = null)

data class GetDocumentResponse(val document: Document, val error: DocumentError? = null)

data class SimpleDocumentWithStatus(val id: String, val foreignId: String? = null, val arrivalDateTime: OffsetDateTime, val lastUpdateDateTime: OffsetDateTime?, val documentType: DocumentType, val status: DocumentServerStatus)

A much simplified version of Document which is returned when we query the API for the status of document(s)