Inttegro.Invoices.SettingsInput (inttegro v0.2.0)

Copy Markdown View Source

Parameters for Settings Input in the Invoices API.

Build this struct with new!/1 and pass it to the corresponding function on Inttegro.Invoices. Required keys are enforced immediately; optional values left as nil are omitted from the request sent to Inttegro.

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()

A validated settings input request.

Functions

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

Types

t()

@type t() :: %Inttegro.Invoices.SettingsInput{
  custom_data: %{optional(String.t()) => String.t()} | nil,
  footer: String.t() | nil,
  memo: String.t() | nil,
  number: String.t() | nil
}

A validated settings input request.

Functions

new!(attrs \\ %{})

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

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