Package com.getsensibill.core.apimodule.documents.model.api

Types

DeleteDocumentBody

data class DeleteDocumentBody(ids: List<String>)

DeleteDocumentResponse

data class DeleteDocumentResponse(ids: List<String>)

Document

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

DocumentAccountMetadata

data class DocumentAccountMetadata(account: String?, transactionId: String?)

DocumentContent

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

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

DocumentError

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

DocumentListItem

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

This is a subset of the properties that are available when fetching a single document.

DocumentListRequestParams

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

DocumentListResponse

data class DocumentListResponse(documents: List<DocumentListItem>, count: Int)

DocumentSource

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

DocumentStatusErrorItem

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

DocumentTax

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

DocumentTaxableAmount

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

DocumentUploadPayload

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

DocumentUserMetadata

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

EditDocumentBody

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

GetDocumentResponse

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

GetDocumentStatusResponse

data class GetDocumentStatusResponse(documents: List<SimpleDocumentWithStatus>, errors: List<DocumentStatusErrorItem>?)

SimpleDocumentWithStatus

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

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