frex v0.1.4 Frex.Client.Payments

Client module for interacting with the Freshbooks payments endpoint.

Staff have access to the API calls listed below if the Invoices tab is enabled for staff. Staff users can only access payments that belong to clients they are assigned to.

Summary

Functions

Retrieve payment details according to payment_id

Returns a list of recorded payments. You can optionally filter by invoice_id or client_id

Functions

get(credentials, payment_id)

Retrieve payment details according to payment_id.

Parameters

  • payment_id (required) — payments ID
list(credentials, filters \\ %{})

Returns a list of recorded payments. You can optionally filter by invoice_id or client_id.

Parameters

  • filters (optional) — a map of filters for the list request
  • invoice_id
  • client_id
  • updated_from
  • updated_to
  • page
  • per_page