@ts4ocds/core/contract/transaction.ts

TS4OCDS is a library of TypeScript entities that takes an approach to befriend large OCDS JSONs with your per-project routine of writing whole lotta interfaces for them.

/**
 * @packageDocumentation
 * @module Standard.Contract
 */

import { Initializable } from '@ts4ocds/utils';

import type { Value } from '../value';
import type { OrganizationReference } from '../organization';

/**
 * A spending transaction related to the contracting process.
 * Draws upon the data models of the [Fiscal Data Package](https://frictionlessdata.io/specs/fiscal-data-package/)
 * and the [International Aid Transparency Initiative](http://iatistandard.org/activity-standard/iati-activities/iati-activity/transaction/)
 * and should be used to cross-reference to more detailed information held using a Fiscal Data Package, IATI file,
 * or to provide enough information to allow a user to manually or automatically cross-reference with some other
 * published source of transactional spending data.
 */
export class Transaction extends Initializable<Transaction> {
  /**
   * A unique identifier for this transaction.
   * This identifier should be possible to cross-reference against the provided data source.
   * For IATI this is the transaction reference.
   */
  public id!: string | number;

  /**
   * The date of the transaction.
   */
  public date?: Date | string;

  /**
   * The {@link Value.Value | value} of the transaction.
   */
  public value!: Value;

  /**
   * An {@link OrganizationReference | organization reference} for the {@link Organization.Organization | organization} from which the funds in this transaction originate.
   */
  public payer!: OrganizationReference;

  /**
   * An {@link OrganizationReference | organization reference} for the {@link Organization.Organization | organization} which receives the funds in this transaction.
   */
  public payee!: OrganizationReference;

  /**
   * Used to point either to a corresponding Fiscal Data Package, IATI file,
   * or machine or human-readable source where users can find further information on the {@link Budget | budget} {@link Item | line item} identifiers,
   * or project identifiers, provided here.
   */
  public source?: string;

  /**
   * A URI pointing directly to a machine-readable record about this spending transaction.
   */
  public uri?: string;
}