API Reference tipalti_client v#1.0.0

Copy Markdown View Source

Modules

A production-grade Elixir client for the full Tipalti API surface.

Raised when the API responds with a well-formed error payload.

Caches an OAuth 2.0 client-credentials access token for the modern REST API and refreshes it automatically shortly before it expires.

Raised when credentials are missing, invalid, or an OAuth2 token could not be obtained/refreshed.

Shared JSON/REST request helper used by Tipalti.Payees, Tipalti.Invoices, Tipalti.Payments, and the Tipalti.Procurement.* modules.

Holds credentials and connection settings for all three Tipalti API families. Build one with new/1 and pass it as the first argument to every Tipalti.* function.

Base exception raised by every ! function in this package and returned (unraised, as the error element of an {:error, exception} tuple) by every non-bang function.

Minimal HTTP transport used by every Tipalti API family.

Modern REST API — invoice/bill submission and management. See the caveat in Tipalti.Payees about endpoint-shape assumptions; the same applies here.

Raised when a request fails at the transport level after retries are exhausted.

Builds lazy Streams over paginated list endpoints so callers can Enum.take/2, pipe into Enum.reduce/3, etc. without manually tracking page cursors.

Modern REST API — payee onboarding and management.

Modern REST API — mass payout initiation and tracking. See the caveat in Tipalti.Payees about endpoint-shape assumptions; the same applies here.

Procurement REST API — bulk employee import via CSV.

Procurement REST API — purchase order sync.

Raised on HTTP 429 or a Procurement API rate-limit rejection.

An optional, self-contained token-bucket rate limiter.

Legacy SOAP API — Payee Functions (PayeeFunctions.asmx).

Legacy SOAP API — Payer Functions (PayerFunctions.asmx).

Implements Tipalti's SOAP API request signing scheme.

Raised when the SOAP API returns a <soap:Fault> element.

Documents the :telemetry events this package emits. There's nothing to call here — attach your own handler with :telemetry.attach/4 or :telemetry.attach_many/4.

Raised for locally-detected or server-rejected malformed input.

Parses Tipalti IPN (Instant Payment Notification) callbacks.