Tipalti.API.Payee.get_payee_details
You're seeing just the function
get_payee_details
, go back to Tipalti.API.Payee module for more information.
Specs
get_payee_details(Tipalti.idap()) :: {:ok, Tipalti.Payee.t()} | {:error, Tipalti.ClientError.t()} | {:error, Tipalti.RequestError.t()}
Returns details of a given payee.
Parameters
idap
: a payee id
Examples
iex> get_payee_details("somepayee")
{:ok,
%Tipalti.Payee{
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, %Tipalti.ClientError{error_code: "PayeeUnknown", error_message: "PayeeUnknown"}}