Glific v5.1.6

View Source Glific.Partners.Invoice (Glific v5.1.6)

Invoice model wrapper

Link to this section Summary

Types

t()

Functions

changeset(invoice, attrs)

Standard changeset pattern we use for all data types

count_invoices(args)

Return the count of invoices, based on filters

create_invoice(attrs)

Create an invoice record

fetch_invoice(clauses)

Fetch an invoice record by clauses

update_invoice(invoice, attrs)

Update an invoice record

update_invoice_status(invoice_id, status)

Update the status of an invoice

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Glific.Partners.Invoice{
  __meta__: Ecto.Schema.Metadata.t(),
  amount: integer(),
  consulting_hours: integer(),
  customer_id: String.t() | nil,
  end_date: :utc_datetime_usec | nil,
  id: non_neg_integer() | nil,
  inserted_at: :utc_datetime | nil,
  invoice_id: String.t() | nil,
  line_items: map(),
  messages: integer(),
  organization:
    Glific.Partners.Organization.t() | Ecto.Association.NotLoaded.t() | nil,
  organization_id: non_neg_integer() | nil,
  start_date: :utc_datetime_usec | nil,
  status: String.t() | nil,
  updated_at: :utc_datetime | nil,
  users: integer()
}

Link to this section Functions

Link to this function

changeset(invoice, attrs)

View Source 
@spec changeset(t(), map()) :: Ecto.Changeset.t()

Standard changeset pattern we use for all data types

Link to this function

count_invoices(args)

View Source 
@spec count_invoices(map()) :: integer()

Return the count of invoices, based on filters

Link to this function

create_invoice(attrs)

View Source 
@spec create_invoice(map()) :: {:ok, t()} | {:error, String.t()}

Create an invoice record

Link to this function

fetch_invoice(clauses)

View Source 
@spec fetch_invoice(map()) :: t() | nil

Fetch an invoice record by clauses

Link to this function

update_invoice(invoice, attrs)

View Source 
@spec update_invoice(t(), map()) :: t() | {:error, Ecto.Changeset.t()}

Update an invoice record

Link to this function

update_invoice_status(invoice_id, status)

View Source 
@spec update_invoice_status(non_neg_integer(), String.t()) ::
  {:ok | :error, String.t()}

Update the status of an invoice