Mercury.Invoices (mercury_client v1.0.0)

The Mercury Invoices API — accounts-receivable invoices.

Summary

Functions

cancel(client, invoice_id)

Cancels an invoice. This action is irreversible. POST /invoices/{id}/cancel

cancel!(client, invoice_id)

create(client, attrs)

Creates a new invoice. attrs accepts snake_case keys, e.g.

create!(client, attrs)

download_pdf(client, invoice_id)

Downloads an invoice as a PDF, returning the raw bytes. GET /invoices/{id}/pdf

download_pdf!(client, invoice_id)

get(client, invoice_id)

Returns a single invoice by ID. GET /invoices/{id}

get!(client, invoice_id)

list(client, opts \\ [])

Returns one page of invoices. GET /invoices

list!(client, opts \\ [])

list_attachments(client, invoice_id)

Returns every attachment on an invoice. GET /invoices/{id}/attachments

list_attachments!(client, invoice_id)

stream(client, opts \\ [])

A lazy, auto-paginating stream of every invoice.

update(client, invoice_id, attrs)

Updates an existing invoice. PUT /invoices/{id}

update!(client, invoice_id, attrs)

Functions

cancel(client, invoice_id)

@spec cancel(client :: Mercury.Client.t(), invoice_id :: String.t()) ::
  {:ok, Mercury.Invoice.t()} | {:error, Exception.t()}

Cancels an invoice. This action is irreversible. POST /invoices/{id}/cancel

cancel!(client, invoice_id)

@spec cancel!(client :: Mercury.Client.t(), invoice_id :: String.t()) ::
  Mercury.Invoice.t()

create(client, attrs)

@spec create(client :: Mercury.Client.t(), attrs :: map() | keyword()) ::
  {:ok, Mercury.Invoice.t()} | {:error, Exception.t()}

Creates a new invoice. attrs accepts snake_case keys, e.g.:

Mercury.Invoices.create(client, %{
  amount: 500.0,
  recipient_id: recipient_id,
  due_date: "2026-08-01",
  line_items: [%{description: "Consulting", quantity: 5, unit_price: 100.0}]
})

POST /invoices

create!(client, attrs)

@spec create!(client :: Mercury.Client.t(), attrs :: map() | keyword()) ::
  Mercury.Invoice.t()

download_pdf(client, invoice_id)

@spec download_pdf(client :: Mercury.Client.t(), invoice_id :: String.t()) ::
  {:ok, binary()} | {:error, Exception.t()}

Downloads an invoice as a PDF, returning the raw bytes. GET /invoices/{id}/pdf

download_pdf!(client, invoice_id)

@spec download_pdf!(client :: Mercury.Client.t(), invoice_id :: String.t()) ::
  binary()

get(client, invoice_id)

@spec get(client :: Mercury.Client.t(), invoice_id :: String.t()) ::
  {:ok, Mercury.Invoice.t()} | {:error, Exception.t()}

Returns a single invoice by ID. GET /invoices/{id}

get!(client, invoice_id)

@spec get!(client :: Mercury.Client.t(), invoice_id :: String.t()) ::
  Mercury.Invoice.t()

list(client, opts \\ [])

@spec list(client :: Mercury.Client.t(), opts :: keyword()) ::
  {:ok, Mercury.Page.t(Mercury.Invoice.t())} | {:error, Exception.t()}

Returns one page of invoices. GET /invoices

list!(client, opts \\ [])

@spec list!(client :: Mercury.Client.t(), opts :: keyword()) ::
  Mercury.Page.t(Mercury.Invoice.t())

list_attachments(client, invoice_id)

@spec list_attachments(client :: Mercury.Client.t(), invoice_id :: String.t()) ::
  {:ok, [Mercury.InvoiceAttachment.t()]} | {:error, Exception.t()}

Returns every attachment on an invoice. GET /invoices/{id}/attachments

list_attachments!(client, invoice_id)

@spec list_attachments!(client :: Mercury.Client.t(), invoice_id :: String.t()) :: [
  Mercury.InvoiceAttachment.t()
]

stream(client, opts \\ [])

@spec stream(client :: Mercury.Client.t(), opts :: keyword()) :: Enumerable.t()

A lazy, auto-paginating stream of every invoice.

update(client, invoice_id, attrs)

@spec update(
  client :: Mercury.Client.t(),
  invoice_id :: String.t(),
  attrs :: map() | keyword()
) ::
  {:ok, Mercury.Invoice.t()} | {:error, Exception.t()}

Updates an existing invoice. PUT /invoices/{id}

update!(client, invoice_id, attrs)

@spec update!(
  client :: Mercury.Client.t(),
  invoice_id :: String.t(),
  attrs :: map() | keyword()
) ::
  Mercury.Invoice.t()