MishkaPay.CreditNote.Lines (Mishka Pay v0.0.1)

Copy Markdown View Source

Summary

Types

t()

The struct that builder/1 returns.

Functions

A sample %MishkaPay.CreditNote.Lines{} populated from defaults + type-based fallbacks.

Types

t()

@type t() :: %MishkaPay.CreditNote.Lines{
  amount: Money.t() | nil,
  id: String.t() | nil,
  invoice_line_id: String.t() | nil,
  name: String.t() | nil,
  quantity: pos_integer() | nil,
  type: (:invoice_line | :custom) | nil,
  unit_amount: Money.t() | nil
}

The struct that builder/1 returns.

FieldTypeRequiredDefaultDescriptionDerives
:idString.t() | nilnovalidate(string)
:type:invoice_line | :custom | nilnovalidate(enum=Atom[invoice_line::custom])
:invoice_line_idString.t() | nilnosanitize(trim) validate(string, not_empty)
:nameString.t() | nilnosanitize(trim) validate(string, not_empty, max_len=500)
:quantitypos_integer() | nilnovalidate(integer, min_len=1)
:unit_amountMoney.t() | nilnovalidator {MishkaPay.Money, :field}
:amountMoney.t() | nilnovalidator {MishkaPay.Money, :field}

Functions

builder(attrs_or_input, error \\ false)

enforce_keys()

enforce_keys(field)

example()

A sample %MishkaPay.CreditNote.Lines{} populated from defaults + type-based fallbacks.

keys()

keys(field)