com.classpass.moderntreasury.model.LedgerTransaction.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of client Show documentation
com.classpass.oss.moderntreasury:client
The newest version!
/**
 * Copyright 2024 ClassPass
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package com.classpass.moderntreasury.model

import com.fasterxml.jackson.annotation.JsonCreator
import com.fasterxml.jackson.annotation.JsonProperty
import com.fasterxml.jackson.annotation.JsonValue
import java.time.Instant
import java.time.LocalDate
import java.util.UUID

/**
 * A LedgerTransaction is a transaction between two LedgerAccounts. To create a LedgerTransaction, there must be at
 * least one CREDIT ledger entry and one DEBIT ledger entry. Additionally, the sum of all credit entry amounts must
 * equal the sum of all debit entry amounts. The LedgerTransaction is immutable once it has posted.
 */
data class LedgerTransaction(
    /**
     * Unique identifier for the ledger transaction.
     */
    val id: LedgerTransactionId,
    /**
     * An optional free-form description for internal use.
     */
    val description: String?,
    /**
     * One of pending, posted, or archived.
     */
    val status: LedgerTransactionStatus,
    /**
     * Additional data represented as key-value pairs. Both the key and value must be strings. See
     * https://docs.moderntreasury.com/reference#metadata.
     */
    val metadata: Map,
    val ledgerEntries: Set,
    /**
     * The time on which the ledger transaction posted. This is null if the ledger transaction is pending.
     */
    val postedAt: Instant?,
    /**
     * The date on which the ledger transaction happened for reporting purposes.
     */
    val effectiveDate: LocalDate,
    /**
     * The ID of the ledger this account belongs to.
     */
    val ledgerId: LedgerId,
    /**
     * If the ledger transaction can be reconciled to another object in Modern Treasury, the type will be populated here,
     * otherwise null.
     */
    val ledgerableType: LedgerableType?,
    /**
     * If the ledger transaction can be reconciled to another object in Modern Treasury, the id will be populated here,
     * otherwise null.
     */
    val ledgerableId: String?,
    /**
     * A unique string to represent the ledger transaction. Only one ledger transaction may have this ID in the ledger.
     */
    val externalId: String,
    /**
     * This field will be true if this object was created with a production API key or false if created with a test API
     * key.
     */
    val liveMode: Boolean
)

enum class LedgerTransactionStatus {
    @JsonProperty("pending")
    PENDING,
    @JsonProperty("posted")
    POSTED,
    @JsonProperty("archived")
    ARCHIVED
}

enum class LedgerableType {
    @JsonProperty("payment_order")
    PAYMENT_ORDER,
    @JsonProperty("expected_payment")
    EXPECTED_PAYMENT,
    @JsonProperty("paper_item")
    PAPER_ITEM,
    @JsonProperty("return")
    RETURN
}

data class LedgerTransactionId(
    val uuid: UUID
) {
    @JsonCreator
    constructor(uuidString: String) : this(UUID.fromString(uuidString))

    @JsonValue
    override fun toString() = uuid.toString()
}