CampaignFlow.Client.Invoices (CampaignFlow Client v2.0.0)

View Source

Invoice resource operations for the Campaign Flow API.

Summary

Functions

Applies a payment to an invoice.

Retrieves a specific invoice by ID.

Retrieves a specific payment for an invoice.

Lists all invoices.

Functions

create_payment(client, invoice_id, params)

Applies a payment to an invoice.

Examples

{:ok, payment} = CampaignFlow.Client.Invoices.create_payment(client, 123, %{
  amount: 500.00,
  payment_method: "credit_card"
})

get(client, id)

Retrieves a specific invoice by ID.

Examples

{:ok, invoice} = CampaignFlow.Client.Invoices.get(client, 123)

get_payment(client, invoice_id, payment_number)

Retrieves a specific payment for an invoice.

Examples

{:ok, payment} = CampaignFlow.Client.Invoices.get_payment(client, 123, 1)

list(client, params \\ [])

Lists all invoices.

Options

  • :page - Page number for pagination
  • :per_page - Number of items per page

Examples

{:ok, invoices} = CampaignFlow.Client.Invoices.list(client)
{:ok, invoices} = CampaignFlow.Client.Invoices.list(client, page: 2)