Sensibill Rest API/com.getsensibill.rest.generated.v2.model

Package-level declarations

Types

data class AccessTokenRequestDto(val grantType: String = "", val redirectUri: String = "", val refreshToken: String = "", val code: String? = "")

AccessTokenResponseDto

data class AccessTokenResponseDto(val tokenId: String? = null, val accessToken: String? = null, val refreshToken: String? = null, val tokenType: String? = null, val expiresIn: Int? = null, val refreshExpiresIn: Int? = null)

AddOrRemoveDocumentsFromFolderDto

data class AddOrRemoveDocumentsFromFolderDto(val documentIds: List<String>)

AlertDto

data class AlertDto(val name: AlertDto.Name? = null, val count: Int? = null, val list: List<UserReceiptDto>? = null)

ApiInfoDto

data class ApiInfoDto(val hostname: String? = null, val version: String? = null, val status: String? = null, val environment: String? = null, val name: String? = null, val bootedAt: OffsetDateTime? = null, val baseUrl: String? = null, val endpoints: ApiInfoDtoEndpoints? = null)

ApiInfoDtoEndpoints

data class ApiInfoDtoEndpoints(val authorizationGrant: String? = null, val accessToken: String? = null, val logout: String? = null, val clientInfo: String? = null, val invalidateAccessToken: String? = null, val jwtAuthenticate: String? = null, val usernameAvailability: String? = null, val emailAvailability: String? = null, val registerUser: String? = null, val jwtRegister: String? = null, val users: String? = null, val userDetail: String? = null, val deleteUser: String? = null, val updateUser: String? = null, val forgotpassword: String? = null, val resetpassword: String? = null, val exportDocuments: String? = null, val listExports: String? = null, val exportStatus: String? = null, val lookupSupportedCurrencies: String? = null, val lookupSupportedLocales: String? = null, val merchantsList: String? = null, val documentsList: String? = null, val documentsPost: String? = null, val documentsDelete: String? = null, val documentsPatch: String? = null, val documentsDetail: String? = null, val listFolders: String? = null, val createFolder: String? = null, val deleteFolders: String? = null, val updateFolder: String? = null, val deleteFolder: String? = null, val addDocumentsToFolder: String? = null, val deleteDocumentsFromFolder: String? = null)

AuthorizationResponse

data class AuthorizationResponse(val code: String? = null)

ClientInfoResponseDto

data class ClientInfoResponseDto(val clientID: String? = null, val name: String? = null, val type: String? = null, val status: String? = null, val key: String? = null, val redirectURI: String? = null, val policies: List<ClientPoliciesDto>? = null, val authenticationSettings: ClientInfoResponseDtoAuthenticationSettings? = null, val notificationSettings: ClientInfoResponseDtoNotificationSettings? = null, val providerIDs: ClientInfoResponseDtoProviderIDs? = null, val accessTokenExpiry: OffsetDateTime? = null)

ClientInfoResponseDtoAuthenticationSettings

data class ClientInfoResponseDtoAuthenticationSettings(val oauth: Boolean? = null, val refreshTokenExpiryDays: Int? = null, val accessTokenExpiryMinutes: Int? = null, val setTempAccessSecret: Boolean? = null, val disablePasswordStrengthCheck: Boolean? = null, val maximumFailedLoginAttempts: Int? = null, val jwt: Boolean? = null)

ClientInfoResponseDtoNotificationSettings

data class ClientInfoResponseDtoNotificationSettings(val accountUpdates: Boolean? = null)

An object describing which notifications could be sent for this client.

ClientInfoResponseDtoProviderIDs

data class ClientInfoResponseDtoProviderIDs(val gmail: String? = null, val outlook: String? = null)

Identifiers for external integrations used by this client.

ClientPoliciesDto

data class ClientPoliciesDto(val id: String? = null, val webSDKOptions: ClientPoliciesDtoWebSDKOptions? = null, val registrationEmails: List<String>? = null, val registrationEmailPolicyMode: String? = null, val receiptEmailDomainPolicyMode: String? = null, val credentialTypePolicyMode: String? = null, val featurePolicyMode: String? = null, val features: List<String>? = null, val allowedFeatures: ClientPoliciesDtoAllowedFeatures? = null, val credentialTypes: List<String>? = null, val receiptEmailDomains: List<String>? = null, val receiptEmailDomainsAndAliases: List<ClientPoliciesDtoReceiptEmailDomainsAndAliasesInner>? = null, val featureOptions: ClientPoliciesDtoFeatureOptions? = null)

ClientPoliciesDtoAllowedFeatures

data class ClientPoliciesDtoAllowedFeatures(val clientCanDisableUser: Boolean? = null, val clientCanRetrieveUserData: Boolean? = null, val clientCanDestroyUsers: Boolean? = null, val enhancedReceiptView: Boolean? = null, val editing: Boolean? = null, val userManagement: Boolean? = null, val navigation: Boolean? = null, val registration: Boolean? = null, val noReceiptAccount: Boolean? = null, val nonEmailUsernames: Boolean? = null, val merchantLogo: Boolean? = null, val merchantColor: Boolean? = null, val menuViewAll: Boolean? = null, val forgotPassword: Boolean? = null, val feedback: Boolean? = null, val enableExportEmails: Boolean? = null, val emailNotifications: Boolean? = null, val advertiseEmailForwarding: Boolean? = null)

ClientPoliciesDtoFeatureOptions

data class ClientPoliciesDtoFeatureOptions(val insights: ClientPoliciesDtoFeatureOptionsInsights? = null, val achievements: ClientPoliciesDtoFeatureOptionsInsights? = null, val outgoingEmail: ClientPoliciesDtoFeatureOptionsOutgoingEmail? = null, val metrics: ClientPoliciesDtoFeatureOptionsMetrics? = null, val camera: ClientPoliciesDtoFeatureOptionsCamera? = null, val showNotificationCenter: Boolean? = null, val enableOfflineSupport: Boolean? = null, val filters: ClientPoliciesDtoFeatureOptionsFilters? = null, val listingScreen: ClientPoliciesDtoFeatureOptionsListingScreen? = null, val issueReporting: ClientPoliciesDtoFeatureOptionsIssueReporting? = null, val showExpenseType: Boolean? = null, val showTips: Boolean? = null, val reminders: ClientPoliciesDtoFeatureOptionsReminders? = null, val showCategories: Boolean? = null, val showNotes: Boolean? = null, val showTags: Boolean? = null, val showFavorites: Boolean? = null, val showFolders: Boolean? = null, val exports: ClientPoliciesDtoFeatureOptionsExports? = null, val showUserManagement: Boolean? = null, val registration: ClientPoliciesDtoFeatureOptionsRegistration? = null, val showEditing: Boolean? = null, val showBarcodeDisplay: Boolean? = null, val showNavigation: Boolean? = null, val enableReceiptLinking: Boolean? = null, val enableEnhancedReceiptView: Boolean? = null, val receiptDisplayLevel: Int? = null, val enableEmailNotifications: Boolean? = null, val showForgotPassword: Boolean? = null, val branding: ClientPoliciesDtoFeatureOptionsBranding? = null)

ClientPoliciesDtoFeatureOptionsBranding

data class ClientPoliciesDtoFeatureOptionsBranding(val emailPrimaryColor: String? = null, val showPoweredByLogo: Boolean? = null, val showMerchantLogos: Boolean? = null, val showMerchantColors: Boolean? = null)

ClientPoliciesDtoFeatureOptionsCamera

data class ClientPoliciesDtoFeatureOptionsCamera(val frontendAutomaticCaptureTimeout: Int? = null, val showLongReceiptCapture: Boolean? = null, val frontendCameraCaptureDefault: String? = null, val showAutomaticCapture: Boolean? = null)

ClientPoliciesDtoFeatureOptionsExports

data class ClientPoliciesDtoFeatureOptionsExports(val populateName: Boolean? = null, val requireAuthentication: Boolean? = null, val enableExportNotifications: Boolean? = null, val showExports: Boolean? = null)

ClientPoliciesDtoFeatureOptionsFilters

data class ClientPoliciesDtoFeatureOptionsFilters(val showPaymentFilter: Boolean? = null, val showDateFilter: Boolean? = null, val showCurrencyFilter: Boolean? = null, val showFilters: Boolean? = null)

ClientPoliciesDtoFeatureOptionsInsights

data class ClientPoliciesDtoFeatureOptionsInsights(val deactivationDate: String? = null, val activationDate: String? = null)

ClientPoliciesDtoFeatureOptionsIssueReporting

data class ClientPoliciesDtoFeatureOptionsIssueReporting(val showAdditionalFeedback: Boolean? = null, val showIssueReporting: Boolean? = null)

ClientPoliciesDtoFeatureOptionsListingScreen

data class ClientPoliciesDtoFeatureOptionsListingScreen(val showWeeklyGrouping: Boolean? = null, val showMonthlyGrouping: Boolean? = null)

ClientPoliciesDtoFeatureOptionsMetrics

data class ClientPoliciesDtoFeatureOptionsMetrics(val siteID: String? = null, val trackingURL: String? = null, val enableMetrics: Boolean? = null)

ClientPoliciesDtoFeatureOptionsOutgoingEmail

data class ClientPoliciesDtoFeatureOptionsOutgoingEmail(val frontendUrlBase: String? = null, val emailViewPrefix: String? = null, val senderAddress: String? = null)

ClientPoliciesDtoFeatureOptionsRegistration

data class ClientPoliciesDtoFeatureOptionsRegistration(val receiptAccountEmail: ClientPoliciesDtoFeatureOptionsRegistration.ReceiptAccountEmail? = null, val requireReceiptAccount: Boolean? = null, val requireEmails: Boolean? = null, val showRegistration: Boolean? = null)

ClientPoliciesDtoFeatureOptionsReminders

data class ClientPoliciesDtoFeatureOptionsReminders(val enableReturnReminders: Boolean? = null, val enableWarrantyReminders: Boolean? = null, val showReminders: Boolean? = null)

ClientPoliciesDtoReceiptEmailDomainsAndAliasesInner

data class ClientPoliciesDtoReceiptEmailDomainsAndAliasesInner(val id: String? = null, val emailDomain: String? = null, val aliases: List<String>? = null)

ClientPoliciesDtoWebSDKOptions

data class ClientPoliciesDtoWebSDKOptions(val webDebug: Boolean? = null, val webBaseUrl: String? = null, val webSDKUrl: String? = null)

CommonRegistrationParameters

data class CommonRegistrationParameters(val receiptAccountEmail: String? = null, val firstName: String? = null, val lastName: String? = null, val defaultCurrency: String? = null, val folders: List<CommonRegistrationParametersFoldersInner>? = arrayListOf(), val createTestReceipts: Boolean? = null)

CommonRegistrationParametersFoldersInner

data class CommonRegistrationParametersFoldersInner(val name: String? = null, val color: String? = null, val id: String? = null)

CountryCode

enum CountryCode : Enum<CountryCode>

2 character country code (lower case)

CourierDto

data class CourierDto(val name: String? = null, val serviceLevel: String? = null)

Information about the courier being used.

CurrencyCodeEnum

enum CurrencyCodeEnum : Enum<CurrencyCodeEnum>

3 character ISO-4217 currency code

DeliveryDto

data class DeliveryDto(val addressLines: List<String>? = null, val courier: CourierDto? = null, val deliveryType: DeliveryTypesEnum? = null, val expectedShipmentDate: LocalDate? = null, val name: String? = null, val telephoneNumber: String? = null, val trackingNumber: String? = null)

Details about an expected delivery. Note: these details are as they appear on the receipt, they are NOT updated automatically

DeliveryTypesEnum

enum DeliveryTypesEnum : Enum<DeliveryTypesEnum>

Type of delivery

DiscountTypesEnum

enum DiscountTypesEnum : Enum<DiscountTypesEnum>

May be set to describe how this discount was obtained.

DocumentAccountMetadataDto

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

DocumentCategoryListItemDto

data class DocumentCategoryListItemDto(val code: String, val name: String, val icon: URI)

DocumentContentBarcodeDto

data class DocumentContentBarcodeDto(val text: String? = null, val type: String? = null)

Describes a barcode as read from a document.

DocumentContentCustomerDto

data class DocumentContentCustomerDto(val customerId: String? = null, val billingAddressLines: List<String>? = null, val email: String? = null, val name: String? = null, val telephoneNumber: String? = null)

Information about the customer as presented on the document.

DocumentContentDto

data class DocumentContentDto(val currencyCode: CurrencyCodeEnum?, val amountDue: DocumentTaxableAmountDto? = null, val barcodes: List<DocumentContentBarcodeDto>? = null, val countryCode: CountryCode? = null, val customer: DocumentContentCustomerDto? = null, val discounts: List<DocumentDiscountDto>? = null, val documentNumber: String? = null, val dueDate: LocalDate? = null, val documentDate: LocalDate? = null, val documentTime: String? = null, val fees: List<DocumentFeeDto>? = null, val items: List<DocumentItemDto>? = null, val languageCode: String? = null, val merchant: DocumentMerchantDto? = null, val savings: BigDecimal? = null, val deliveries: List<DeliveryDto>? = null, val loyaltyRewards: DocumentLoyaltyRewardsDto? = null, val payments: List<DocumentPaymentDto>? = null, val tipAmount: BigDecimal? = null, val total: DocumentTaxableAmountDto? = null, val totalBeforeTips: DocumentTaxableAmountDto? = null, val totalBeforeDiscountsFeesTips: DocumentTaxableAmountDto? = null)

DocumentCreationResponseDto

data class DocumentCreationResponseDto(val id: String)

DocumentCurrencyListItemDto

data class DocumentCurrencyListItemDto(val name: String, val code: String, val symbol: String)

DocumentDeleteDto

data class DocumentDeleteDto(val ids: List<String>)

DocumentDeleteResponseDto

data class DocumentDeleteResponseDto(val ids: List<String>, val errors: List<DocumentsDeleteErrorItemDto>? = null)

The list of document Ids which were deleted from the system

DocumentDiscountDto

data class DocumentDiscountDto(val taxes: List<DocumentTaxDto>? = null, val beforeTax: BigDecimal? = null, val afterTax: BigDecimal? = null, val description: String? = null, val methodCode: String? = null, val percent: BigDecimal? = null, val type: DiscountTypesEnum? = null)

Contains info about one applied discount.

DocumentDiscountDtoAllOf

data class DocumentDiscountDtoAllOf(val description: String? = null, val methodCode: String? = null, val percent: BigDecimal? = null, val type: DiscountTypesEnum? = null, val taxes: List<DocumentTaxDto>? = null)

DocumentDto

data class DocumentDto(val id: String, val arrivalDateTime: OffsetDateTime, val lastUpdateDateTime: OffsetDateTime, val documentType: DocumentTypeEnum, val status: DocumentStatusTypeEnum, val content: DocumentContentDto, val foreignId: String? = null, val accountMetadata: DocumentAccountMetadataDto? = null, val description: String? = null, val source: DocumentSourceDto? = null, val userMetadata: DocumentUserMetadataDto? = null)

DocumentFeeDto

data class DocumentFeeDto(val taxes: List<DocumentTaxDto>? = null, val beforeTax: BigDecimal? = null, val afterTax: BigDecimal? = null, val description: String? = null, val type: FeeTypesEnum? = null)

Contains info about one applied fee.

DocumentFeeDtoAllOf

data class DocumentFeeDtoAllOf(val description: String? = null, val type: FeeTypesEnum? = null, val taxes: List<DocumentTaxDto>? = null)

DocumentItemDto

data class DocumentItemDto(val description: String? = null, val brand: String? = null, val buyLink: String? = null, val discounts: List<DocumentDiscountDto>? = null, val fees: List<DocumentFeeDto>? = null, val imageUrl: String? = null, val itemIds: List<String>? = null, val listPrice: DocumentTaxableAmountDto? = null, val loyaltyRewards: DocumentLoyaltyRewardsDto? = null, val name: String? = null, val price: DocumentTaxableAmountDto? = null, val priceBeforeDiscountsFees: DocumentTaxableAmountDto? = null, val properties: List<DocumentItemDtoPropertiesInner>? = null, val serialNumbers: List<String>? = null, val sku: String? = null, val unitListPrice: DocumentTaxableAmountDto? = null, val unitOfMeasure: String? = null, val unitPrice: DocumentTaxableAmountDto? = null, val unitQuantity: BigDecimal? = null)

DocumentItemDtoPropertiesInner

data class DocumentItemDtoPropertiesInner(val name: String? = null, val value: String? = null)

DocumentListItemContentDto

data class DocumentListItemContentDto(val currencyCode: CurrencyCodeEnum?, val documentNumber: String? = null, val documentDate: LocalDate? = null, val documentTime: String? = null, val dueDate: LocalDate? = null, val payments: List<DocumentPaymentDto>? = null, val merchant: DocumentListMerchantDto? = null, val total: DocumentTaxableAmountDto? = null, val amountDue: DocumentTaxableAmountDto? = null)

DocumentListItemDto

data class DocumentListItemDto(val id: String, val arrivalDateTime: OffsetDateTime, val lastUpdateDateTime: OffsetDateTime, val documentType: DocumentTypeEnum, val status: DocumentStatusTypeEnum, val content: DocumentListItemContentDto, val foreignId: String? = null, val accountMetadata: DocumentAccountMetadataDto? = null, val description: String? = null, val source: DocumentSourceDto? = null, val userMetadata: DocumentUserMetadataDto? = null)

DocumentListMerchantDto

data class DocumentListMerchantDto(val merchantName: String? = null, val categoryCode: String? = null)

The merchant infomation on this document.

DocumentLocaleListItemDto

data class DocumentLocaleListItemDto(val name: String, val code: String)

DocumentLoyaltyRewardsDto

data class DocumentLoyaltyRewardsDto(val accountNumber: String? = null, val currentBalance: BigDecimal? = null, val nextRewardLevel: BigDecimal? = null, val pointsAwarded: BigDecimal? = null, val programName: String? = null)

Describes loyalty rewards read from the receipt.

DocumentMerchantDto

data class DocumentMerchantDto(val addressLines: List<String>? = null, val merchantId: String? = null, val merchantName: String? = null, val email: String? = null, val geoLocation: String? = null, val storeName: String? = null, val storeId: String? = null, val telephone: String? = null, val channel: OrderChannelTypesEnum? = null, val categoryCode: String? = null, val taxIdNumber: String? = null, val url: String? = null)

DocumentOrderByEnum

enum DocumentOrderByEnum : Enum<DocumentOrderByEnum>

Values: ASC,DESC

DocumentPaymentDto

data class DocumentPaymentDto(val afterTax: BigDecimal? = null, val cashBack: BigDecimal? = null, val changeAdjustment: BigDecimal? = null, val changeDue: BigDecimal? = null, val changeIssued: BigDecimal? = null, val currencyCode: CurrencyCodeEnum? = null, val maskedCardNumber: String? = null, val type: TenderTypesEnum? = null)

DocumentsAddedOrRemovedFromFolderResponseDto

data class DocumentsAddedOrRemovedFromFolderResponseDto(val updated: Int)

DocumentsDeleteErrorItemDto

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

Represents an error that can occur while deleting one or more documents

DocumentSortByEnum

enum DocumentSortByEnum : Enum<DocumentSortByEnum>

Values: ARRIVAL_DATE_TIME,DOCUMENT_DATE,DOCUMENT_TIME

DocumentSourceDto

data class DocumentSourceDto(val format: DocumentSourceFormatsEnum, val url: String, val imagePreview: String)

DocumentSourceFormatsEnum

enum DocumentSourceFormatsEnum : Enum<DocumentSourceFormatsEnum>

Values: PDF,IMAGE,RAW_TEXT,PDF_EMAIL,HTML_EMAIL,IMAGE_EMAIL,TEXT_EMAIL

DocumentsStatusResponseDto

data class DocumentsStatusResponseDto(val documents: List<DocumentStatusListItemDto>, val errors: List<DocumentStatusErrorItemDto>? = null)

Response schema for the documents/status endpoint

DocumentStatusErrorItemDto

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

Represents an error that can occur while polling for document processing status

DocumentStatusListItemDto

data class DocumentStatusListItemDto(val id: String, val arrivalDateTime: OffsetDateTime, val documentType: DocumentTypeEnum, val status: DocumentStatusTypeEnum, val foreignId: String? = null, val lastUpdateDateTime: OffsetDateTime? = null)

Schema for an entry in the documents/status endpoint response

DocumentStatusTypeEnum

enum DocumentStatusTypeEnum : Enum<DocumentStatusTypeEnum>

The status of the document involved or used for the operation. Supported statusses include : * CompletedSuccess * CompletedFailed * InProcessing

DocumentTaxableAmountDto

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

DocumentTaxDto

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

DocumentTypeEnum

enum DocumentTypeEnum : Enum<DocumentTypeEnum>

The document type that is being posted. Only clients with the feature flag enableInvoice enabled are allowed to submit documentType = 'invoice'.

DocumentUserMetadataDto

data class DocumentUserMetadataDto(val expenseType: ExpenseTypeEnum? = null, val folders: List<String>? = null, val notes: String? = null, val warrantyPeriod: DocumentUserMetadataPeriodDto? = null, val returnPeriod: DocumentUserMetadataPeriodDto? = null)

DocumentUserMetadataPeriodDto

data class DocumentUserMetadataPeriodDto(val unit: PeriodUnitEnum? = null, val duration: Int? = null)

The details about the document's warranty or return period. These fields can only be edited if the document date is known.

EditDocumentMerchantDto

data class EditDocumentMerchantDto(val merchantName: String? = null, val taxIdNumber: String? = null, val categoryCode: String? = null)

If the merchantName is empty or null, the whole merchant data structure will be unset.

EditDocumentRequestDto

data class EditDocumentRequestDto(val description: String? = null, val accountMetadata: NullableDocumentAccountMetadataDto? = null, val content: EditDocumentRequestDtoContent? = null, val userMetadata: EditDocumentUserMetadataDto? = null)

Object that contains the field that will be updated in a Document. Pass the field set to \"\" (an empty zero-length string) to unset its value.' Numeric or Enum fileds must be null to unset.

EditDocumentRequestDtoContent

data class EditDocumentRequestDtoContent(val merchant: EditDocumentMerchantDto? = null, val documentNumber: String? = null, val dueDate: LocalDate? = null, val documentDate: LocalDate? = null, val documentTime: String? = null, val amountDue: EditDocumentTaxableAmountDto? = null, val tipAmount: BigDecimal? = null, val totalBeforeDiscountsFeesTips: EditDocumentTaxableAmountDto? = null, val total: EditDocumentTaxableAmountDto? = null, val currencyCode: CurrencyCodeEnum? = null)

EditDocumentResponseDto

data class EditDocumentResponseDto(val id: String)

Object with the Id of the updated Document

EditDocumentTaxableAmountDto

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

EditDocumentUserMetadataDto

data class EditDocumentUserMetadataDto(val expenseType: String? = null, val notes: String? = null, val warrantyPeriod: EditDocumentUserMetadataPeriodDto? = null, val returnPeriod: EditDocumentUserMetadataPeriodDto? = null)

EditDocumentUserMetadataPeriodDto

data class EditDocumentUserMetadataPeriodDto(val unit: String? = null, val duration: Int? = null)

The details about the document's warranty or return period. This can only be edited if the document date is populated. If either unit or duration is unset, the full applicable warrantyPeriod or returnPeriod structure is unset.

EmailAvailabilityResponseDto

data class EmailAvailabilityResponseDto(val available: Boolean? = null)

EmptyObjectResponseDto

data class EmptyObjectResponseDto(val noProperties: String? = null)

An empty object. The noProperties property is a placeholder to help API generation

ExpenseTypeEnum

enum ExpenseTypeEnum : Enum<ExpenseTypeEnum>

Expense type associated with the document. Can be either business or personal.

ExportCreateDto

data class ExportCreateDto(val outputFormats: List<ExportOutputFormatsEnum>, val criteria: ListDocumentsCriteriaDto, val locale: String? = null)

ExportCreateResponseDto

data class ExportCreateResponseDto(val destructionTime: OffsetDateTime, val createdAt: OffsetDateTime, val outputFormats: List<ExportOutputFormatsEnum>, val documentsCount: Int, val status: ExportResponseStatusEnum, val id: String)

ExportItemStatusEnum

enum ExportItemStatusEnum : Enum<ExportItemStatusEnum>

The status of the export. Possible values are: 'queued', 'running', 'completed', 'failed'

ExportOutputFormatsEnum

enum ExportOutputFormatsEnum : Enum<ExportOutputFormatsEnum>

Indicates which formats should be generated. Valid values are: * 'csv' - indicates a comma separated file should be produced summarizing the exported data * 'xlsx' - indicates an excel spreadsheet should be produced summarizing the exported data * 'pdf' - indicates individual documents should be exported to a PDF file

ExportResponseStatusEnum

enum ExportResponseStatusEnum : Enum<ExportResponseStatusEnum>

Values: QUEUED,NO_DOCUMENTS_FOUND

ExportsResponseDto

data class ExportsResponseDto(val destructionTime: OffsetDateTime, val createdAt: OffsetDateTime, val updatedAt: OffsetDateTime, val resultSize: Int, val outputFormats: List<ExportOutputFormatsEnum>, val documents: List<ExportsResponseDtoDocumentsInner>, val status: ExportItemStatusEnum, val id: String, val completionTime: OffsetDateTime? = null, val fileURL: String? = null, val filesize: Int? = null)

ExportsResponseDtoDocumentsInner

data class ExportsResponseDtoDocumentsInner(val id: String)

FeeTypesEnum

enum FeeTypesEnum : Enum<FeeTypesEnum>

May be set to give more details on the type of fee.

FolderCreateRequestDto

data class FolderCreateRequestDto(val name: String, val color: String)

FolderCreationResponseDto

data class FolderCreationResponseDto(val id: String)

FolderDeleteRequestDto

data class FolderDeleteRequestDto(val deleteDocuments: Boolean? = false)

FolderListItemDto

data class FolderListItemDto(val id: String, val name: String, val color: String, val updatedAt: OffsetDateTime, val createdAt: OffsetDateTime, val count: Int, val totals: List<FolderListItemTotalsDto>? = null)

FolderListItemTotalsDto

data class FolderListItemTotalsDto(val amount: BigDecimal, val count: Int, val currencyCode: String, val displayAmount: String)

FoldersDeleteRequestDto

data class FoldersDeleteRequestDto(val folders: List<String>, val deleteDocuments: Boolean? = false)

FolderUpdateRequestDto

data class FolderUpdateRequestDto(val name: String? = null, val color: String? = null)

GetDocumentErrorDto

data class GetDocumentErrorDto(val errorDescription: String, val code: String)

Describes the error related to the request if there was a failure

GetDocumentListResponseDto

data class GetDocumentListResponseDto(val documents: List<DocumentListItemDto>, val count: Int)

Structure of the response on the document list endpoint

GetDocumentResponseDto

data class GetDocumentResponseDto(val document: DocumentDto, val error: GetDocumentErrorDto? = null)

Structure of the response on the document details endpoint

GetFoldersListResponseDto

data class GetFoldersListResponseDto(val folders: List<FolderListItemDto>)

GetLookupCategoryListResponseDto

data class GetLookupCategoryListResponseDto(val documentCategories: List<DocumentCategoryListItemDto>? = null)

GetLookupCurrencyListResponseDto

data class GetLookupCurrencyListResponseDto(val currencies: List<DocumentCurrencyListItemDto>)

GetLookupLocaleListResponseDto

data class GetLookupLocaleListResponseDto(val locales: List<DocumentLocaleListItemDto>)

JwtAuthenticateRequestDto

data class JwtAuthenticateRequestDto(val client: String)

JwtAuthenticateResponseDto

data class JwtAuthenticateResponseDto(val tokenId: String? = null, val accessToken: String? = null, val expiresIn: Int? = null)

JwtUserRequestDto

data class JwtUserRequestDto(val client: String, val receiptAccountEmail: String? = null, val firstName: String? = null, val lastName: String? = null, val defaultCurrency: String? = null, val folders: List<CommonRegistrationParametersFoldersInner>? = arrayListOf(), val createTestReceipts: Boolean? = null)

JwtUserRequestDtoProperties

data class JwtUserRequestDtoProperties(val client: String)

ListDocumentsCriteriaDto

data class ListDocumentsCriteriaDto(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)

The search criteria used to find the documents to be exported. \\ This will be identical to the filters used in the GET documents endpoint.

MerchantsDto

data class MerchantsDto(val merchants: List<MerchantsDtoMerchantsInner>)

MerchantsDtoMerchantsInner

data class MerchantsDtoMerchantsInner(val merchantID: String, val name: String, val documentCateogry: String? = null)

NullableDocumentAccountMetadataDto

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

OrderChannelTypesEnum

enum OrderChannelTypesEnum : Enum<OrderChannelTypesEnum>

Indicates if the receipt came from a brick and mortar or online channel. Not related to format of receipt.

PeriodUnitEnum

enum PeriodUnitEnum : Enum<PeriodUnitEnum>

Available period units. Can be day, week, month or year. As a parameter, this should be used together with the duration parameter. Document must have the documentDate set or it should be supplied as another edit parameter within the same request.

ReceiptEmailAvailabilityResponseDto

data class ReceiptEmailAvailabilityResponseDto(val available: Boolean? = null, val alternatives: List<String>? = null)

RegisterUserResponseDto

data class RegisterUserResponseDto(val id: String? = null)

SimplifiedFolderDto

data class SimplifiedFolderDto(val id: String? = null, val name: String? = null, val color: String? = null, val updatedAt: OffsetDateTime? = null, val createdAt: OffsetDateTime? = null)

TenderTypesEnum

enum TenderTypesEnum : Enum<TenderTypesEnum>

Values: AMEX,CASH,CHECK,COUPON,CREDIT,CREDIT_DEBIT,CUSTOMER_ACCOUNT,DEBIT,DINERS_CLUB,FLEET,GIFT_CARD,GIFT_CERTIFICATE,HOUSE_ACCOUNT,INTERAC,INTERNATIONAL_MAESTRO,LOYALTY,MASTER_CARD,PAYPAL,PREPAID,STORE_CARD,STORED_VALUE,TRAVELERS_CHECK,UK_MAESTRO,VISA_CREDIT,VISA_DEBIT,VISA,VOUCHER

UsernameAvailabilityResponseDto

data class UsernameAvailabilityResponseDto(val available: Boolean? = null)

UserReceiptDto

data class UserReceiptDto(val objectType: String? = null, val receiptDate: OffsetDateTime? = null, val listingSortDate: OffsetDateTime? = null, val merchantName: String? = null, val renderURL: String? = null, val total: UserReceiptDtoTotal? = null, val id: String? = null)

UserReceiptDtoTotal

data class UserReceiptDtoTotal(val grand: BigDecimal? = null, val currencyCode: String? = null)

UserRequestDto

data class UserRequestDto(val receiptAccountEmail: String? = null, val firstName: String? = null, val lastName: String? = null, val defaultCurrency: String? = null, val folders: List<CommonRegistrationParametersFoldersInner>? = arrayListOf(), val createTestReceipts: Boolean? = null, val credentialType: String? = "sensibill", val accessID: String? = null, val accessSecret: String? = null, val email: String? = null, val password: String? = null)

UserRequestProperties

data class UserRequestProperties(val credentialType: String? = "sensibill", val accessID: String? = null, val accessSecret: String? = null, val email: String? = null, val password: String? = null)

UserResponseDto

data class UserResponseDto(val email: String? = null, val receiptAccountEmail: String? = null, val receiptCounts: UserResponseDtoReceiptCounts? = null, val emailCounts: UserResponseDtoEmailCounts? = null, val folders: List<SimplifiedFolderDto>? = null, val notificationSettings: UserResponseDtoNotificationSettings? = null, val locale: String? = null, val status: String? = null, val lastName: String? = null, val firstName: String? = null, val id: String? = null, val accessID: String? = null, val credentialType: String? = null, val nickname: String? = null, val alerts: List<AlertDto>? = null, val pilotAccess: UserResponseDtoPilotAccess? = null, val accessTokenExpiry: OffsetDateTime? = null, val refreshTokenExpiry: OffsetDateTime? = null)

Get account info for current user

UserResponseDtoEmailCounts

data class UserResponseDtoEmailCounts(val nonreceipt: Int? = null, val receipt: Int? = null, val total: Int? = null)

UserResponseDtoNotificationSettings

data class UserResponseDtoNotificationSettings(val accountUpdates: UserResponseDtoNotificationSettingsAccountUpdates? = null, val receiptExport: UserResponseDtoNotificationSettingsReceiptExport? = null, val other: UserResponseDtoNotificationSettingsOther? = null, val receipt: UserResponseDtoNotificationSettingsReceipt? = null)

UserResponseDtoNotificationSettingsAccountUpdates

data class UserResponseDtoNotificationSettingsAccountUpdates(val email: Boolean? = null)

UserResponseDtoNotificationSettingsOther

data class UserResponseDtoNotificationSettingsOther(val email: Boolean? = null)

UserResponseDtoNotificationSettingsReceipt

data class UserResponseDtoNotificationSettingsReceipt(val includeOriginal: Boolean? = null, val email: Boolean? = null, val push: Boolean? = null)

UserResponseDtoNotificationSettingsReceiptExport

data class UserResponseDtoNotificationSettingsReceiptExport(val email: Boolean? = null, val push: Boolean? = null)

UserResponseDtoPilotAccess

data class UserResponseDtoPilotAccess(val diagnostics: UserResponseDtoPilotAccessDiagnostics? = null)

UserResponseDtoPilotAccessDiagnostics

data class UserResponseDtoPilotAccessDiagnostics(val enabled: Boolean? = null)

UserResponseDtoReceiptCounts

data class UserResponseDtoReceiptCounts(val favorite: Int? = null, val thisMonth: Int? = null, val total: Int? = null)

UserUpdateDtoProperties

data class UserUpdateDtoProperties(val status: String? = null, val receiptAccountEmail: String? = null, val firstName: String? = null, val lastName: String? = null, val defaultCurrency: String? = null, val locale: String? = null)