com.fintecsystems.xs2a.java.models.common.Turnover.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xs2a-java Show documentation
Java SDK for XS2A API
The newest version!
package com.fintecsystems.xs2a.java.models.common


import com.fintecsystems.xs2a.java.helper.OffsetDateTimeAdapter
import com.fintecsystems.xs2a.java.models.risk.Category
import com.squareup.moshi.FromJson
import com.squareup.moshi.Json
import java.time.OffsetDateTime

/**
 *
 * @param id ID if feature is enabled always null otherwise.
 * @param transactionId Transaction ID of this turnover if the bank supports it.
 * @param bookingDate The booking date.
 * @param amount The turnover amount. Negative for expenditures.
 * @param currency The two-letter currency ID
 * @param purpose A string array of purpose lines. The contents vary from bank to bank.
 * @param counterIban The counter IBAN of the booking. This is not always present.
 * @param counterBic The counter BIC of the booking. This is not always present.
 * @param counterHolder The counter holder of the booking. This is not always present.
 * @param prebooked True, if the turnover has not been booked yet
 * @param canceled True, if the turnover has been canceled.
 * @param tags An array of strings of tags for this turnover. Find all possible tags here: https://manage.xs2a.com/documentation/tags
 * @param categoryId The ID of the category found for this turnover.  The structure of this `category_id` string is hierarchical, meaning,  the more numbers there are, the more detailed the category is. For example, while `K.1` means \"expenses for wholesale and retail trade\", some  turnovers might be categorized more detailed as `K.1.1` (\"expenses in retail stores\"), or even as `K.1.1.1` (\"groceries full-range trader\"). You can find the complete list of categories [here](https://manage.xs2a.com/documentation/categories).  **NOTE**: As new categories are introduced and the categorization itself is improved constantly, it is possible that  the same turnover can be categorized with a different (more detailed) `category_id` at a future point in time. You should develop your application in such a way,  that, for example, if your logic relies on something happening when a `category_id` is `K.1.1`, but you get `K.1.2` for which no logic is in place (because it might be  a new `category_id` or the turnover is now categorized more detailed), **you should always fall back to the next higher level category**, in this case `K.1`. This way, your logic can  still handle the turnover based on a more general category, while not throwing an error.
 * @param creditorId The ID of the creditor.
 * @param new True, if this turnover is new since the last sync.
 */

data class Turnover(
    @Json(name = "id")
    var id: String? = null,
    @Json(name = "transaction_id")
    var transactionId: String? = null,
    @Json(name = "booking_date")
    var bookingDate: OffsetDateTime,
    @Json(name = "amount")
    var amount: Float,
    @Json(name = "currency")
    var currency: CurrencyId,
    @Json(name = "purpose")
    var purpose: List,
    @Json(name = "counter_iban")
    var counterIban: String? = null,
    @Json(name = "counter_bic")
    var counterBic: String? = null,
    @Json(name = "counter_holder")
    var counterHolder: String? = null,
    @Json(name = "prebooked")
    var prebooked: Boolean? = null,
    @Json(name = "canceled")
    var canceled: Boolean? = null,
    @Json(name = "tags")
    var tags: List? = null,
    @Json(name = "category_id")
    var categoryId: Category? = null,
    @Json(name = "creditor_id")
    var creditorId: String? = null,
    @Json(name = "new")
    var new: Boolean? = null,
) {
    companion object Adapter {
        @FromJson
        fun fromJson(data: Map): Turnover {
            @Suppress("UNCHECKED_CAST")
            return Turnover(
                id = data["id"] as String?,
                transactionId = data["transaction_id"] as String?,
                bookingDate = OffsetDateTimeAdapter.fromJson(data["booking_date"] as String)!!,
                amount = (data["amount"] as Double).toFloat(),
                currency = CurrencyId.valueOf((data["currency"] ?: data["currency_id"]) as String),
                purpose = data["purpose"] as List,
                counterIban = data["counter_iban"] as String?,
                counterBic = data["counter_bic"] as String?,
                counterHolder = data["counter_holder"] as String?,
                prebooked = data["prebooked"] as Boolean?,
                tags = (data["tags"] as List?)?.let { stringList -> stringList.mapNotNull { Tag.fromJson(it) } },
                categoryId = (data["category_id"] as String?)?.let { Category.fromJson(it) },
                creditorId = data["creditor_id"] as String?,
                new = data["new"] as Boolean?,
            )
        }
    }
}