Infusionsoft v0.7.0

Infusionsoft.Endpoints.XML.Invoice (Infusionsoft v0.7.0) View Source

Provides the raw endpoints to Infusionsoft's XML API for Invoice.

Link to this section Summary

Functions

add_a_commission_to_an_invoice(invoice_id, affiliate_id, product_id, percent, amount, payout_type, description, date, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-add-a-commission-to-an-invoice

add_a_payment_to_an_invoice(invoice_id, amount, date, payment_type, description, bypass_commissions, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-add-a-payment-to-an-invoice

add_an_item_to_an_invoice(invoice_id, product_id, type, price, quantity, description, notes, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-add-an-item-to-an-invoice

calculate_invoice_tax(invoice_id, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-calculate-invoice-tax

create_a_contact_subscription(contact_id, allow_duplicate, subscription_id, quantity, price, taxable, merchant_account_id, credit_card_id, affiliate_id, trial_period, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-create-a-contact-subscription

create_a_subscription_invoice(subscription_id, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-create-a-subscription-invoice

create_an_invoice(contact_id, name, order_date, lead_affiliate_id, sale_affiliate_id, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-create-an-invoice

create_custom_recurring_payment(invoice_id, auto_charge, credit_card_id, merchant_account_id, days_until_retry, max_retry, initial_payment_amount, initial_payment_date, plan_start_date, number_of_payments, days_between_payments, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-create-a-custom-recurring-payment

delete_a_subscription(subscription_id, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-delete-a-subscription

delete_an_invoice(invoice_id, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-delete-an-invoice

pay_an_invoice(invoice_id, notes, credit_card_id, merchant_account_id, bypass_commissions, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-pay-an-invoice

retrieve_available_payment_options(token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-retrieve-available-payment-options

retrieve_credit_card(contact_id, last_four, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-retrieve-credit-card

retrieve_invoice_amount_due(invoice_id, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-retrieve-invoice-amount-due

retrieve_invoice_payments(invoice_id, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-retrieve-invoice-payments

update_subscription_billing_date(subscription_id, next_bill_date, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-update-subscription-billing-date

validate_a_new_credit_card(card_type, contact_id, card_number, expiration_month, expiration_year, security_code, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-validate-a-new-credit-card

validate_an_existing_credit_card(card_id, token, app \\ nil)

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-validate-an-existing-credit-card

Link to this section Functions

Link to this function

add_a_commission_to_an_invoice(invoice_id, affiliate_id, product_id, percent, amount, payout_type, description, date, token, app \\ nil)

View Source

Specs

add_a_commission_to_an_invoice(
  integer(),
  integer(),
  integer(),
  integer(),
  float(),
  integer(),
  String.t(),
  %NaiveDateTime{
    calendar: term(),
    day: term(),
    hour: term(),
    microsecond: term(),
    minute: term(),
    month: term(),
    second: term(),
    year: term()
  },
  String.t(),
  nil | String.t()
) :: {:ok, integer()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-add-a-commission-to-an-invoice

Link to this function

add_a_payment_to_an_invoice(invoice_id, amount, date, payment_type, description, bypass_commissions, token, app \\ nil)

View Source

Specs

add_a_payment_to_an_invoice(
  integer(),
  float(),
  %NaiveDateTime{
    calendar: term(),
    day: term(),
    hour: term(),
    microsecond: term(),
    minute: term(),
    month: term(),
    second: term(),
    year: term()
  },
  String.t(),
  String.t(),
  boolean(),
  String.t(),
  nil | String.t()
) :: {:ok, integer()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-add-a-payment-to-an-invoice

Link to this function

add_an_item_to_an_invoice(invoice_id, product_id, type, price, quantity, description, notes, token, app \\ nil)

View Source

Specs

add_an_item_to_an_invoice(
  integer(),
  integer(),
  integer(),
  float(),
  integer(),
  String.t(),
  String.t(),
  String.t(),
  nil | String.t()
) :: {:ok, integer()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-add-an-item-to-an-invoice

Link to this function

calculate_invoice_tax(invoice_id, token, app \\ nil)

View Source

Specs

calculate_invoice_tax(integer(), String.t(), nil | String.t()) ::
  {:ok, integer()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-calculate-invoice-tax

Link to this function

create_a_contact_subscription(contact_id, allow_duplicate, subscription_id, quantity, price, taxable, merchant_account_id, credit_card_id, affiliate_id, trial_period, token, app \\ nil)

View Source

Specs

create_a_contact_subscription(
  integer(),
  boolean(),
  integer(),
  integer(),
  float(),
  boolean(),
  integer(),
  integer(),
  integer(),
  integer(),
  String.t(),
  nil | String.t()
) :: {:ok, integer()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-create-a-contact-subscription

Link to this function

create_a_subscription_invoice(subscription_id, token, app \\ nil)

View Source

Specs

create_a_subscription_invoice(integer(), String.t(), nil | String.t()) ::
  {:ok, integer()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-create-a-subscription-invoice

Link to this function

create_an_invoice(contact_id, name, order_date, lead_affiliate_id, sale_affiliate_id, token, app \\ nil)

View Source

Specs

create_an_invoice(
  integer(),
  String.t(),
  %NaiveDateTime{
    calendar: term(),
    day: term(),
    hour: term(),
    microsecond: term(),
    minute: term(),
    month: term(),
    second: term(),
    year: term()
  },
  integer(),
  integer(),
  String.t(),
  nil | String.t()
) :: {:ok, integer()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-create-an-invoice

Link to this function

create_custom_recurring_payment(invoice_id, auto_charge, credit_card_id, merchant_account_id, days_until_retry, max_retry, initial_payment_amount, initial_payment_date, plan_start_date, number_of_payments, days_between_payments, token, app \\ nil)

View Source

Specs

create_custom_recurring_payment(
  integer(),
  boolean(),
  integer(),
  integer(),
  integer(),
  integer(),
  float(),
  %NaiveDateTime{
    calendar: term(),
    day: term(),
    hour: term(),
    microsecond: term(),
    minute: term(),
    month: term(),
    second: term(),
    year: term()
  },
  %NaiveDateTime{
    calendar: term(),
    day: term(),
    hour: term(),
    microsecond: term(),
    minute: term(),
    month: term(),
    second: term(),
    year: term()
  },
  integer(),
  integer(),
  String.t(),
  nil | String.t()
) :: {:ok, boolean()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-create-a-custom-recurring-payment

Link to this function

delete_a_subscription(subscription_id, token, app \\ nil)

View Source

Specs

delete_a_subscription(integer(), String.t(), nil | String.t()) ::
  {:ok, boolean()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-delete-a-subscription

Link to this function

delete_an_invoice(invoice_id, token, app \\ nil)

View Source

Specs

delete_an_invoice(integer(), String.t(), nil | String.t()) ::
  {:ok, boolean()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-delete-an-invoice

Link to this function

pay_an_invoice(invoice_id, notes, credit_card_id, merchant_account_id, bypass_commissions, token, app \\ nil)

View Source

Specs

pay_an_invoice(
  integer(),
  String.t(),
  integer(),
  integer(),
  boolean(),
  String.t(),
  nil | String.t()
) :: {:ok, map()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-pay-an-invoice

Link to this function

retrieve_available_payment_options(token, app \\ nil)

View Source

Specs

retrieve_available_payment_options(String.t(), nil | String.t()) ::
  {:ok, map()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-retrieve-available-payment-options

Link to this function

retrieve_credit_card(contact_id, last_four, token, app \\ nil)

View Source

Specs

retrieve_credit_card(integer(), String.t(), String.t(), nil | String.t()) ::
  {:ok, integer()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-retrieve-credit-card

Link to this function

retrieve_invoice_amount_due(invoice_id, token, app \\ nil)

View Source

Specs

retrieve_invoice_amount_due(integer(), String.t(), nil | String.t()) ::
  {:ok, float()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-retrieve-invoice-amount-due

Link to this function

retrieve_invoice_payments(invoice_id, token, app \\ nil)

View Source

Specs

retrieve_invoice_payments(integer(), String.t(), nil | String.t()) ::
  {:ok, list()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-retrieve-invoice-payments

Link to this function

update_subscription_billing_date(subscription_id, next_bill_date, token, app \\ nil)

View Source

Specs

update_subscription_billing_date(
  integer(),
  %NaiveDateTime{
    calendar: term(),
    day: term(),
    hour: term(),
    microsecond: term(),
    minute: term(),
    month: term(),
    second: term(),
    year: term()
  },
  String.t(),
  nil | String.t()
) :: {:ok, boolean()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-update-subscription-billing-date

Link to this function

validate_a_new_credit_card(card_type, contact_id, card_number, expiration_month, expiration_year, security_code, token, app \\ nil)

View Source

Specs

validate_a_new_credit_card(
  String.t(),
  integer(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  nil | String.t()
) :: {:ok, map()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-validate-a-new-credit-card

Link to this function

validate_an_existing_credit_card(card_id, token, app \\ nil)

View Source

Specs

validate_an_existing_credit_card(integer(), String.t(), nil | String.t()) ::
  {:ok, map()} | {:error, any()}

https://developer.infusionsoft.com/docs/xml-rpc/#invoice-validate-an-existing-credit-card