Returns extended details and custom fields of given payees.

Parameters

• idaps: list of payee ids

Returns

{:ok, map} where map contains the following fields:

• custom_fields

  • array of %{key: key, value: value} custom field maps

• properties

  • actual_payer_entity
  • alias
  • city
  • company_name
  • country
  • email
  • first_name
  • idap
  • last_name
  • middle_name
  • payable
  • payment_currency
  • payment_method
  • phone
  • portal_user
  • preferred_payer_entity
  • state
  • status
  • street1
  • street2
  • tax_form_entity_name
  • tax_form_entity_type
  • tax_form_status
  • tax_form_type
  • withholding_rate
  • zip

Examples

iex> get_extended_payee_details_list(["somepayee"])
  {:ok,
   %{
     payees: [
       %{
         custom_fields: [],
         properties: %{
           actual_payer_entity: "Peek",
           alias: "acmepayee",
           city: nil,
           company_name: "ACME",
           country: "--",
           email: "someone@example.com",
           first_name: "Some",
           idap: "somepayee",
           last_name: "Payee",
           middle_name: nil,
           payable: false,
           payment_currency: "USD",
           payment_method: "NoPM",
           phone: nil,
           portal_user: "NotRegistered",
           preferred_payer_entity: "Peek",
           state: nil,
           status: "Active",
           street1: "123 Somewhere St.",
           street2: nil,
           tax_form_entity_name: nil,
           tax_form_entity_type: "UNKNOWN",
           tax_form_status: "NOT_SUBMITTED",
           tax_form_type: nil,
           withholding_rate: nil,
           zip: nil
         }
       }
     ]
   }}

  iex> get_extended_payee_details_list(["badpayee"])
  {:ok, %{payees: []}}

Returns details of a given payee.

Parameters

• idap: a payee id

Returns

{:ok, map} where map contains the following fields:

• name
• company_name
• alias
• address
• payment_method
• email
• payment_terms_id
• payment_terms_name

Examples

iex> get_payee_details("somepayee")
  {:ok,
    %{
      address: "123 Somewhere St.",
      alias: "acmepayee",
      company_name: "ACME",
      email: "someone@example.com",
      name: "Some Payee",
      payment_method: "Check",
      payment_terms_id: nil,
      payment_terms_name: nil
    }}

  iex> get_payee_details("badpayee")
  {:error, %{error_code: "PayeeUnknown", error_message: "PayeeUnknown"}}

Return payable status of payee.

If a payment request were to be issued, the payee might not get paid. Possible reasons for not being paid are - missing tax documents, payment below threshold, account locked, address missing, or other.

Parameters

• idap: a payee id
• amount: the amount for which you’d want to pay this payee (default: 100.0)

Returns

{:ok, map} where map contains the following fields:

• payable - boolean
• reason - nil or a string for the reason the payee is not payable

Examples

iex> payee_payable("payablepayee", 100)
  {:ok, %{payable: true, reason: nil}}

  iex> payee_payable("unpayablepayee")
  {:ok, %{payable: false, reason: "Tax,No PM"}}

  iex> payee_payable("badpayee", 123.45)
  {:error, %{error_code: "PayeeUnknown", error_message: "PayeeUnknown"}}

Returns the name of the payee’s selected payment method.

Examples

iex> payee_payment_method("payablepayee")
  {:ok, %{payment_method: "Check"}}

  iex> payee_payment_method("unpayablepayee")
  {:ok, %{payment_method: "No payment method"}}

  iex> payee_payment_method("badpayee")
  {:error, %{error_code: "PayeeUnknown", error_message: "PayeeUnknown"}}

Update the status of payee.

Valid values for status are: :active, :suspended, or :blocked. When blocking a payee, a blocking reason may be supplied

Examples

iex> payee_status_update("somepayee", :blocked, "Business closed")
  {:ok, :ok}

Updates a payee’s basic info.

If the payee does not exist, it will be created. The details must match the ones in the payee bank records. State can either be null, or a valid 2 letter US state. If skip_nulls=true the parameters with null values will be ignored. If skip_nulls=false the null values will overwrite existing values. Country is a 2 letter ISO 3166 code.

Possible fields:

• first_name - string
• last_name - string
• street1 - string
• street2 - string
• city - string
• state - string
• zip - string
• country - string
• email - string
• company - string
• alias - string
• preferred_payer_entity - string
• ap_account_number - string
• payment_terms_id - string

Required options:

• skip_nulls - boolean
• override_payable_country - boolean

Examples

iex> update_or_create_payee_info("newpayee", %{first_name: "John", last_name: "Smith"}, skip_nulls: true, override_payable_country: false)
  {:ok, :ok}

  iex> update_or_create_payee_info("invalidname", %{first_name: "José", last_name: "Valim"}, skip_nulls: true, override_payable_country: false)
  {:error, %{error_code: "ParameterError", error_message: "Invalid payee first name"}}