v1
latestOpenAPI 3.0.02026-08-063014193.1 MBReturn the data for all Allocations
Outlines the parameters, optional and required, used when requesting the data for all Allocations
Query parameters
The unique identifier for a single Bill. The keyword null is not valid for this field. The list will be filtered to include only the Allocation records with the matching property.
The unique identifier for a single Contact. The keyword null is not valid for this field. The list will be filtered to include only the Allocation records with the matching property.
Filter Allocation records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).
The fields to be returned. See response samples for what fields are available. For more information see the fields section.
Filter Allocation records to those having the specified unique identifiers.
Filter Allocation records to only those associated with a credit note ("credit_note") or a write-off ("write_off").
A limit on the number of Allocation records to be returned. Limit can range between 1 and 200. Default: 200.
The unique identifier for a single Matter. The keyword null is not valid for this field. The list will be filtered to include only the Allocation records with the matching property.
Orders the Allocation records by the given field. Default: date(asc).
A token specifying which page to return.
ID of parent (either a Payment or CreditMemo) this allocation belongs to
Filter Allocation records based on whether the parent is a CreditMemo or a Payment.
Filter Allocation records to only those that are voided ("invalid") or not voided ("valid").
Filter Allocation records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).
Headers
The API minor version. Default: latest version.
Response
Ok