Inttegro.Invoices.OrderFormat (inttegro v0.2.0)

Copy Markdown View Source

Represents Order Format data in the Invoices API.

Inttegro decodes API responses into this struct. Required fields are always present; optional fields are nil when they do not apply or were not returned. Follow the linked types in t/0 for nested domain values.

Invoice, receipt, document-format, and document-delivery values attached to orders. Document availability and delivery attempts are modeled separately so integrations can distinguish generation from successful recipient delivery.

Summary

Types

t()

The decoded order format value.

Functions

new!(attrs \\ %{})

Builds a Inttegro.Invoices.OrderFormat and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Invoices.OrderFormat{
  pdf: Inttegro.Invoices.OrderDocumentFormat.t(),
  receipt: Inttegro.Invoices.OrderDocumentFormat.t() | nil,
  web: Inttegro.Invoices.OrderDocumentFormat.t()
}

The decoded order format value.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.Invoices.OrderFormat and raises KeyError when a required field is missing.