Increase.InboundMailItems.InboundMailItem (Increase v1.0.0)

Copy Markdown View Source

Inbound Mail Items represent pieces of physical mail delivered to a Lockbox Address.

Fields

  • id - The Inbound Mail Item identifier.
  • checks - The checks in the mail item.
  • created_at - The ISO 8601 time at which the Inbound Mail Item was created.
  • file_id - The identifier for the File containing the scanned contents of the mail item.
  • lockbox_address_id - The identifier for the Lockbox Address that received this mail item.
  • lockbox_recipient_id - The identifier for the Lockbox Recipient that received this mail item. For mail items that could not be routed to a Lockbox Recipient, this will be null.
  • recipient_name - The recipient name as written on the mail item.
  • rejection_reason - If the mail item has been rejected, why it was rejected.
  • status - If the mail item has been processed.
  • type - A constant representing the object's type. For this resource it will always be inbound_mail_item.

Summary

Types

t()

Types

t()

@type t() :: %Increase.InboundMailItems.InboundMailItem{
  checks: [Increase.InboundMailItems.InboundMailItem.Check.t()],
  created_at: DateTime.t(),
  file_id: String.t(),
  id: String.t(),
  lockbox_address_id: String.t(),
  lockbox_recipient_id: String.t() | nil,
  recipient_name: String.t() | nil,
  rejection_reason: String.t() | nil,
  status: String.t(),
  type: String.t()
}