@maxio-com/advanced-billing-sdk/src/models/invoiceLineItem.ts

Ultimate billing and pricing flexibility for B2B SaaS. Maxio integrates directly into your product, so you can seamlessly manage your product catalog, bill customers, and collect payments.

/**
 * AdvancedBilling
 *
 * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import {
  boolean,
  expandoObject,
  lazy,
  nullable,
  number,
  optional,
  Schema,
  string,
} from '../schema';
import {
  InvoiceLineItemComponentCostData,
  invoiceLineItemComponentCostDataSchema,
} from './invoiceLineItemComponentCostData';

export interface InvoiceLineItem {
  /** Unique identifier for the line item.  Useful when cross-referencing the line against individual discounts in the `discounts` or `taxes` lists. */
  uid?: string;
  /** A short descriptor for the charge or item represented by this line. */
  title?: string;
  /**
   * Detailed description for the charge or item represented by this line.  May include proration details in plain text.
   * Note: this string may contain line breaks that are hints for the best display format on the invoice.
   */
  description?: string;
  /**
   * The quantity or count of units billed by the line item.
   * This is a decimal number represented as a string. (See "About Decimal Numbers".)
   */
  quantity?: string;
  /**
   * The price per unit for the line item.
   * When tiered pricing was used (i.e. not every unit was actually priced at the same price) this will be the blended average cost per unit and the `tiered_unit_price` field will be set to `true`.
   */
  unitPrice?: string;
  /** The line subtotal, generally calculated as `quantity * unit_price`. This is the canonical amount of record for the line - when rounding differences are in play, `subtotal_amount` takes precedence over the value derived from `quantity * unit_price` (which may not have the proper precision to exactly equal this amount). */
  subtotalAmount?: string;
  /**
   * The approximate discount applied to just this line.
   * The value is approximated in cases where rounding errors make it difficult to apportion exactly a total discount among many lines. Several lines may have been summed prior to applying the discount to arrive at `discount_amount` for the invoice - backing that out to the discount on a single line may introduce rounding or precision errors.
   */
  discountAmount?: string;
  /**
   * The approximate tax applied to just this line.
   * The value is approximated in cases where rounding errors make it difficult to apportion exactly a total tax among many lines. Several lines may have been summed prior to applying the tax rate to arrive at `tax_amount` for the invoice - backing that out to the tax on a single line may introduce rounding or precision errors.
   */
  taxAmount?: string;
  /**
   * The non-canonical total amount for the line.
   * `subtotal_amount` is the canonical amount for a line. The invoice `total_amount` is derived from the sum of the line `subtotal_amount`s and discounts or taxes applied thereafter.  Therefore, due to rounding or precision errors, the sum of line `total_amount`s may not equal the invoice `total_amount`.
   */
  totalAmount?: string;
  /** When `true`, indicates that the actual pricing scheme for the line was tiered, so the `unit_price` shown is the blended average for all units. */
  tieredUnitPrice?: boolean;
  /**
   * Start date for the period covered by this line. The format is `"YYYY-MM-DD"`.
   * * For periodic charges paid in advance, this date will match the billing date, and the end date will be in the future.
   * * For periodic charges paid in arrears (e.g. metered charges), this date will be the date of the previous billing, and the end date will be the current billing date.
   * * For non-periodic charges, this date and the end date will match.
   */
  periodRangeStart?: string;
  /**
   * End date for the period covered by this line. The format is `"YYYY-MM-DD"`.
   * * For periodic charges paid in advance, this date will match the next (future) billing date.
   * * For periodic charges paid in arrears (e.g. metered charges), this date will be the date of the current billing date.
   * * For non-periodic charges, this date and the start date will match.
   */
  periodRangeEnd?: string;
  transactionId?: number;
  /**
   * The ID of the product subscribed when the charge was made.
   * This may be set even for component charges, so true product-only (non-component) charges will also have a nil `component_id`.
   */
  productId?: number | null;
  /** The version of the product subscribed when the charge was made. */
  productVersion?: number | null;
  /** The ID of the component being billed. Will be `nil` for non-component charges. */
  componentId?: number | null;
  /** The price point ID of the component being billed. Will be `nil` for non-component charges. */
  pricePointId?: number | null;
  billingScheduleItemId?: number | null;
  hide?: boolean;
  componentCostData?: InvoiceLineItemComponentCostData | null;
  /** The price point ID of the line item's product */
  productPricePointId?: number | null;
  customItem?: boolean;
  kind?: string;
  [key: string]: unknown;
}

export const invoiceLineItemSchema: Schema<InvoiceLineItem> = expandoObject({
  uid: ['uid', optional(string())],
  title: ['title', optional(string())],
  description: ['description', optional(string())],
  quantity: ['quantity', optional(string())],
  unitPrice: ['unit_price', optional(string())],
  subtotalAmount: ['subtotal_amount', optional(string())],
  discountAmount: ['discount_amount', optional(string())],
  taxAmount: ['tax_amount', optional(string())],
  totalAmount: ['total_amount', optional(string())],
  tieredUnitPrice: ['tiered_unit_price', optional(boolean())],
  periodRangeStart: ['period_range_start', optional(string())],
  periodRangeEnd: ['period_range_end', optional(string())],
  transactionId: ['transaction_id', optional(number())],
  productId: ['product_id', optional(nullable(number()))],
  productVersion: ['product_version', optional(nullable(number()))],
  componentId: ['component_id', optional(nullable(number()))],
  pricePointId: ['price_point_id', optional(nullable(number()))],
  billingScheduleItemId: [
    'billing_schedule_item_id',
    optional(nullable(number())),
  ],
  hide: ['hide', optional(boolean())],
  componentCostData: [
    'component_cost_data',
    optional(nullable(lazy(() => invoiceLineItemComponentCostDataSchema))),
  ],
  productPricePointId: ['product_price_point_id', optional(nullable(number()))],
  customItem: ['custom_item', optional(boolean())],
  kind: ['kind', optional(string())],
});