Tipalti.API.Payee.get_extended_payee_details_list
You're seeing just the function
get_extended_payee_details_list
, go back to Tipalti.API.Payee module for more information.
Specs
get_extended_payee_details_list([Tipalti.idap()]) :: {:ok, [Tipalti.PayeeExtended.t()]} | {:error, Tipalti.ClientError.t()} | {:error, Tipalti.RequestError.t()}
Returns extended details and custom fields of given payees.
Parameters
idaps
: list of payee ids
Examples
iex> get_extended_payee_details_list(["somepayee"])
{:ok,
[
%Tipalti.PayeeExtended{
custom_fields: [],
properties: %Tipalti.PayeeExtended.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, []}