View Source ExChargebee.Invoice (ex_chargebee v0.4.5)

An interface for Interacting with invoices

For More information see Chargebee invoice Documentation

Summary

Functions

Perform a add_charge on individual invoice.

Perform a add_charge_item on individual invoice.

Perform a apply_credits on individual invoice.

Perform a apply_payments on individual invoice.

Perform a close on individual invoice.

Perform a collect_payment on individual invoice.

Perform a invoice create_for_charge_items_and_charges.

Perform a delete on individual invoice.

Perform a delete_line_items on individual invoice.

Perform a download_einvoice on individual downloads.

Perform a invoice import_invoice.

Returns a list of invoices. Pagination is handled automatically unless the opt paginate is set to false.

Returns a list of invoices payment_vouchers.

Returns a list of invoices payments.

Perform a pdf on individual download.

Perform a record_payment on individual invoice.

Perform a record_refund on individual credit_note.

Perform a record_tax_withheld on individual invoice.

Perform a refund on individual credit_note.

Perform a remove_credit_note on individual credit_note.

Perform a remove_payment on individual invoice.

Perform a remove_tax_withheld on individual invoice.

Perform a resend_einvoice on individual invoice.

Perform a send_einvoice on individual invoice.

Perform a stop_dunning on individual invoice.

Returns a stream of invoices. Pagination is handled automatically as the stream is consumed.

Perform a sync_usages on individual invoice.

Perform a update_details on individual invoice.

Perform a void on individual invoice.

Perform a write_off on individual credit_note.

Functions

Link to this function

add_charge(resource_id, params \\ %{}, opts \\ [])

View Source
@spec add_charge(String.t(), map(), keyword()) :: map() | nil

Perform a add_charge on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

add_charge_item(resource_id, params \\ %{}, opts \\ [])

View Source
@spec add_charge_item(String.t(), map(), keyword()) :: map() | nil

Perform a add_charge_item on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

apply_credits(resource_id, params \\ %{}, opts \\ [])

View Source
@spec apply_credits(String.t(), map(), keyword()) :: map() | nil

Perform a apply_credits on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

apply_payments(resource_id, params \\ %{}, opts \\ [])

View Source
@spec apply_payments(String.t(), map(), keyword()) :: map() | nil

Perform a apply_payments on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

close(resource_id, params \\ %{}, opts \\ [])

View Source
@spec close(String.t(), map(), keyword()) :: map() | nil

Perform a close on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

collect_payment(resource_id, params \\ %{}, opts \\ [])

View Source
@spec collect_payment(String.t(), map(), keyword()) :: map() | nil

Perform a collect_payment on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

create_for_charge_items_and_charges(params, opts \\ [])

View Source
@spec create_for_charge_items_and_charges(
  map(),
  keyword()
) :: map() | nil

Perform a invoice create_for_charge_items_and_charges.

Find more information in the Chargebee Documentation

Link to this function

delete(resource_id, params \\ %{}, opts \\ [])

View Source
@spec delete(String.t(), map(), keyword()) :: map() | nil

Perform a delete on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

delete_line_items(resource_id, params \\ %{}, opts \\ [])

View Source
@spec delete_line_items(String.t(), map(), keyword()) :: map() | nil

Perform a delete_line_items on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

download_einvoice(resource_id, params \\ %{}, opts \\ [])

View Source
@spec download_einvoice(String.t(), map(), keyword()) :: map() | nil

Perform a download_einvoice on individual downloads.

Find more information in the Chargebee Documentation

Link to this function

import_invoice(params, opts \\ [])

View Source
@spec import_invoice(
  map(),
  keyword()
) :: map() | nil

Perform a invoice import_invoice.

Find more information in the Chargebee Documentation

Link to this function

list(params \\ %{}, opts \\ [])

View Source
@spec list(
  map(),
  keyword()
) :: [map()] | nil

Returns a list of invoices. Pagination is handled automatically unless the opt paginate is set to false.

opts:

  • site: the site to use for the request. Defaults to the default site.
  • paginate: whether to paginate the results. Defaults to false. If false, all results will be returned.
Link to this function

list_payment_vouchers(resource_id, params \\ %{}, opts \\ [])

View Source
@spec list_payment_vouchers(String.t(), map(), keyword()) :: [map()] | nil

Returns a list of invoices payment_vouchers.

Pagination is handled automatically. For more information see the Chargebee Documentation

Link to this function

list_payments(resource_id, params \\ %{}, opts \\ [])

View Source
@spec list_payments(String.t(), map(), keyword()) :: [map()] | nil

Returns a list of invoices payments.

Pagination is handled automatically. For more information see the Chargebee Documentation

@spec operations() :: Keyword.t()
Link to this function

pdf(resource_id, params \\ %{}, opts \\ [])

View Source
@spec pdf(String.t(), map(), keyword()) :: map() | nil

Perform a pdf on individual download.

Find more information in the Chargebee Documentation

Link to this function

record_payment(resource_id, params \\ %{}, opts \\ [])

View Source
@spec record_payment(String.t(), map(), keyword()) :: map() | nil

Perform a record_payment on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

record_refund(resource_id, params \\ %{}, opts \\ [])

View Source
@spec record_refund(String.t(), map(), keyword()) :: map() | nil

Perform a record_refund on individual credit_note.

Find more information in the Chargebee Documentation

Link to this function

record_tax_withheld(resource_id, params \\ %{}, opts \\ [])

View Source
@spec record_tax_withheld(String.t(), map(), keyword()) :: map() | nil

Perform a record_tax_withheld on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

refund(resource_id, params \\ %{}, opts \\ [])

View Source
@spec refund(String.t(), map(), keyword()) :: map() | nil

Perform a refund on individual credit_note.

Find more information in the Chargebee Documentation

Link to this function

remove_credit_note(resource_id, params \\ %{}, opts \\ [])

View Source
@spec remove_credit_note(String.t(), map(), keyword()) :: map() | nil

Perform a remove_credit_note on individual credit_note.

Find more information in the Chargebee Documentation

Link to this function

remove_payment(resource_id, params \\ %{}, opts \\ [])

View Source
@spec remove_payment(String.t(), map(), keyword()) :: map() | nil

Perform a remove_payment on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

remove_tax_withheld(resource_id, params \\ %{}, opts \\ [])

View Source
@spec remove_tax_withheld(String.t(), map(), keyword()) :: map() | nil

Perform a remove_tax_withheld on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

resend_einvoice(resource_id, params \\ %{}, opts \\ [])

View Source
@spec resend_einvoice(String.t(), map(), keyword()) :: map() | nil

Perform a resend_einvoice on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

retrieve(resource_id, opts \\ [])

View Source
@spec retrieve(
  String.t(),
  keyword()
) :: map() | nil
Link to this function

send_einvoice(resource_id, params \\ %{}, opts \\ [])

View Source
@spec send_einvoice(String.t(), map(), keyword()) :: map() | nil

Perform a send_einvoice on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

stop_dunning(resource_id, params \\ %{}, opts \\ [])

View Source
@spec stop_dunning(String.t(), map(), keyword()) :: map() | nil

Perform a stop_dunning on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

stream_list(params \\ %{}, opts \\ [])

View Source
@spec stream_list(
  map(),
  keyword()
) :: Enumerable.t()

Returns a stream of invoices. Pagination is handled automatically as the stream is consumed.

Link to this function

sync_usages(resource_id, params \\ %{}, opts \\ [])

View Source
@spec sync_usages(String.t(), map(), keyword()) :: map() | nil

Perform a sync_usages on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

update_details(resource_id, params \\ %{}, opts \\ [])

View Source
@spec update_details(String.t(), map(), keyword()) :: map() | nil

Perform a update_details on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

void(resource_id, params \\ %{}, opts \\ [])

View Source
@spec void(String.t(), map(), keyword()) :: map() | nil

Perform a void on individual invoice.

Find more information in the Chargebee Documentation

Link to this function

write_off(resource_id, params \\ %{}, opts \\ [])

View Source
@spec write_off(String.t(), map(), keyword()) :: map() | nil

Perform a write_off on individual credit_note.

Find more information in the Chargebee Documentation