v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Allocations

Return the data for all Allocations

Outlines the parameters, optional and required, used when requesting the data for all Allocations

get/allocations.json

Query parameters

bill_idinteger

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.

contact_idinteger

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.

created_sincestring date-time

Filter Allocation records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

ids[]integer

Filter Allocation records to those having the specified unique identifiers.

kind'credit_note' | 'write_off'

Filter Allocation records to only those associated with a credit note ("credit_note") or a write-off ("write_off").

limitinteger

A limit on the number of Allocation records to be returned. Limit can range between 1 and 200. Default: 200.

matter_idinteger

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.

order'id(asc)' | 'id(desc)' | 'date(asc)' | 'date(desc)'

Orders the Allocation records by the given field. Default: date(asc).

page_tokenstring

A token specifying which page to return.

parent_idinteger

ID of parent (either a Payment or CreditMemo) this allocation belongs to

parent_typeinteger

Filter Allocation records based on whether the parent is a CreditMemo or a Payment.

status'valid' | 'invalid'

Filter Allocation records to only those that are voided ("invalid") or not voided ("valid").

updated_sincestring date-time

Filter Allocation records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok