Cmdlets for FreshBooks

Build 20.0.7654


A list of payments stored in FreshBooks. Staff members can access payments for clients assigned to them.

Table Specific Information


The Classic API allows only a subset of columns to be used as filter criteria in the WHERE clause. The following columns can be used:

  • PaymentId
  • InvoiceId
  • ClientId
  • Updated

Note: PaymentId cannot be used at the same time as the other columns.

Other filters are processed client side by the cmdlet. See SupportEnhancedSQL for more information.


Name Type ReadOnly Description
PaymentId [KEY] String True

The unique identifier of a payment.

InvoiceId String False

The Id for an invoice associated with the payment.

Date Datetime False

A time value associated with a payment.

Type String False

The type associated with a payment.

Notes String False

A custom note for a payment.

ClientId String False

The Id for a client associated with the payment.

CurrencyCode String False

The currency code for an item.

Updated Datetime True

A time value representing the last time the payment was updated.

ReferenceId String True

Gateway transaction information associated with a payment.

GatewayName String True

Gateway transaction information associated with a payment.

Amount Decimal False

The amount associated with a payment.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654