View Source ExChargebee.CreditNote (ex_chargebee v0.4.5)

An interface for Interacting with credit_notes

For More information see Chargebee credit_note Documentation

Summary

Functions

create(params, opts \\ [])

Creates a credit_note.

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

Perform a delete on individual credit_note.

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

Perform a download_einvoice on individual credit_note.

import_credit_note(params, opts \\ [])

Perform a credit_note import_credit_note.

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

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

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

Perform a pdf on individual credit_note.

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

Perform a record_refund on individual credit_note.

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

Perform a refund on individual credit_note.

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

Perform a remove_tax_withheld_refund on individual credit_note.

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

Perform a resend_einvoice on individual credit_note.

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

Perform a send_einvoice on individual credit_note.

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

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

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

Perform a void on individual credit_note.

Functions

Link to this function

create(params, opts \\ [])

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

Creates a credit_note.

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 credit_note.

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 credit_note.

Find more information in the Chargebee Documentation

Link to this function

import_credit_note(params, opts \\ [])

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

Perform a credit_note import_credit_note.

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 credit_notes. 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

operations()

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

operations(group)

View Source
Link to this function

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

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

Perform a pdf on individual credit_note.

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

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_tax_withheld_refund(resource_id, params \\ %{}, opts \\ [])

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

Perform a remove_tax_withheld_refund on individual credit_note.

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 credit_note.

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 credit_note.

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 credit_notes. Pagination is handled automatically as the stream is consumed.

Link to this function

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

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

Perform a void on individual credit_note.

Find more information in the Chargebee Documentation