PaperTiger.Resources.CreditNote (PaperTiger v1.1.2)

Copy Markdown View Source

Handles Credit Note resource endpoints.

Summary

Functions

create(conn)

Creates a credit note and adjusts the finalized invoice.

lines(conn, id)

Lists credit note line items.

list(conn)

Lists credit notes.

preview(conn)

Previews a credit note without persisting it.

preview_lines(conn)

Lists preview line items.

retrieve(conn, id)

Retrieves a credit note.

update(conn, id)

Updates a credit note's memo/metadata.

void(conn, id)

Voids a credit note.

Functions

create(conn)

@spec create(Plug.Conn.t()) :: Plug.Conn.t()

Creates a credit note and adjusts the finalized invoice.

lines(conn, id)

@spec lines(Plug.Conn.t(), String.t()) :: Plug.Conn.t()

Lists credit note line items.

list(conn)

@spec list(Plug.Conn.t()) :: Plug.Conn.t()

Lists credit notes.

preview(conn)

@spec preview(Plug.Conn.t()) :: Plug.Conn.t()

Previews a credit note without persisting it.

preview_lines(conn)

@spec preview_lines(Plug.Conn.t()) :: Plug.Conn.t()

Lists preview line items.

retrieve(conn, id)

@spec retrieve(Plug.Conn.t(), String.t()) :: Plug.Conn.t()

Retrieves a credit note.

update(conn, id)

@spec update(Plug.Conn.t(), String.t()) :: Plug.Conn.t()

Updates a credit note's memo/metadata.

void(conn, id)

@spec void(Plug.Conn.t(), String.t()) :: Plug.Conn.t()

Voids a credit note.