Legacy SOAP API — Payee Functions (PayeeFunctions.asmx).
Every operation here signs the request per Tipalti.SOAP.Signature and
goes through Tipalti.SOAP.Client.call/5. Each function documents the
operation's EAT (Encryption Additional Terms) parameter, if it has one —
this is handled automatically, you never need to think about signing.
Every function has a raising ! counterpart.
Summary
Functions
Cancels an invoice.
Permanently closes a payee account.
Creates a payee with a Tipalti-assigned IDAP. EAT: street1.
Retrieves extended payee details (including banking/payment method) for one payee.
Retrieves extended payee details for a list of payee IDs.
Retrieves extended purchase/payment order details for a list of reference codes. EAT: poRefCode.
Returns the total payable amount across a payee's invoices.
Returns details of a payee's most recent payment.
Retrieves a payee's details.
Lists a payee's invoices.
Lists a payee's invoices changed since a Unix timestamp. EAT: timestamp.
Returns the total of a payee's pending invoices.
Retrieves payees changed since a Unix timestamp. EAT: timestamp.
Retrieves a purchase/payment order by reference code. EAT: poRefCode.
Checks whether a payee is currently payable for the given amount. EAT: amount.
Retrieves a payee's currently selected payment method.
Sets a payee's status. status is one of :active, :suspended, :blocked.
Updates a payee's address. EAT: street1.
Updates a payee's email address. EAT: email.
Returns total payments to a payee between two dates. EAT: from (ISO8601 date).
Creates or updates a payee's basic info. EAT: street1.
Sets custom field values on a payee.
Functions
@spec cancel_invoice(Tipalti.Config.t(), String.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Cancels an invoice.
@spec close_payee_account(Tipalti.Config.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Permanently closes a payee account.
@spec create_payee_info_auto_idap(Tipalti.Config.t(), map()) :: {:ok, map()} | {:error, Exception.t()}
Creates a payee with a Tipalti-assigned IDAP. EAT: street1.
@spec get_extended_payee_details(Tipalti.Config.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Retrieves extended payee details (including banking/payment method) for one payee.
@spec get_extended_payee_details_list(Tipalti.Config.t(), [String.t()]) :: {:ok, map()} | {:error, Exception.t()}
Retrieves extended payee details for a list of payee IDs.
@spec get_extended_po_details_list(Tipalti.Config.t(), String.t(), [String.t()]) :: {:ok, map()} | {:error, Exception.t()}
Retrieves extended purchase/payment order details for a list of reference codes. EAT: poRefCode.
@spec get_invoices_payable_amount(Tipalti.Config.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Returns the total payable amount across a payee's invoices.
@spec get_last_payment_details_by_idap(Tipalti.Config.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Returns details of a payee's most recent payment.
@spec get_payee_details(Tipalti.Config.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Retrieves a payee's details.
@spec get_payee_invoice_list(Tipalti.Config.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Lists a payee's invoices.
@spec get_payee_invoices_changed_since_timestamp( Tipalti.Config.t(), String.t(), integer() ) :: {:ok, map()} | {:error, Exception.t()}
Lists a payee's invoices changed since a Unix timestamp. EAT: timestamp.
@spec get_payee_pending_invoice_total(Tipalti.Config.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Returns the total of a payee's pending invoices.
@spec get_payees_changed_since_timestamp(Tipalti.Config.t(), integer()) :: {:ok, map()} | {:error, Exception.t()}
Retrieves payees changed since a Unix timestamp. EAT: timestamp.
@spec get_po_details(Tipalti.Config.t(), String.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Retrieves a purchase/payment order by reference code. EAT: poRefCode.
@spec payee_payable(Tipalti.Config.t(), String.t(), number()) :: {:ok, map()} | {:error, Exception.t()}
Checks whether a payee is currently payable for the given amount. EAT: amount.
@spec payee_payment_method(Tipalti.Config.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Retrieves a payee's currently selected payment method.
@spec payee_status_update( Tipalti.Config.t(), String.t(), :active | :suspended | :blocked ) :: {:ok, map()} | {:error, Exception.t()}
Sets a payee's status. status is one of :active, :suspended, :blocked.
@spec payee_update_address(Tipalti.Config.t(), String.t(), map()) :: {:ok, map()} | {:error, Exception.t()}
Updates a payee's address. EAT: street1.
@spec payee_update_email(Tipalti.Config.t(), String.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Updates a payee's email address. EAT: email.
@spec payments_between_dates(Tipalti.Config.t(), String.t(), String.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Returns total payments to a payee between two dates. EAT: from (ISO8601 date).
@spec update_or_create_payee_info(Tipalti.Config.t(), String.t(), map()) :: {:ok, map()} | {:error, Exception.t()}
Creates or updates a payee's basic info. EAT: street1.
@spec update_payee_custom_fields(Tipalti.Config.t(), String.t(), map()) :: {:ok, map()} | {:error, Exception.t()}
Sets custom field values on a payee.