Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Credit Memos

Return the data for all CreditMemos

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

get/credit_memos.json

Query parameters

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 CreditMemo records with the matching property.

created_sincestring date-time

Filter CreditMemo 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 CreditMemo records to those having the specified unique identifiers.

limitinteger

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

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

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

page_tokenstring

A token specifying which page to return.

updated_sincestring date-time

Filter CreditMemo 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