Credit Notes

List credit notes

get/credit-notes

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/credit-notes
  • Auth: HTTP bearer

Query parameters

startingAfterstring

A cursor ID (uuid) used to request the next page of results. If not provided, defaults to the first page of results.

endingBeforestring

A cursor ID (uuid) used to request the previous page of results. Is mutually exclusive with startingAfter.

limitinteger

The maximum number of results to be returned. Can be any number from 1 to 100. Defaults to 10, if not provided.

string date
OR
string date-time

A filter on the list based on the credit note's modifiedAt field. Accepts an ISO 8601 date or datetime. This will match timestamps after (>) the value specified.

string date
OR
string date-time

A filter on the list based on the credit note's modifiedAt field. Accepts an ISO 8601 date or datetime. This will match timestamps on and after (>=) the value specified.

string date
OR
string date-time

A filter on the list based on the credit note's modifiedAt field. Accepts an ISO 8601 date or datetime. This will match timestamps before (<) the value specified.

string date
OR
string date-time

A filter on the list based on the credit note's modifiedAt field. Accepts an ISO 8601 date or datetime. This will match timestamps on and before (<=) the value specified.

clientIdstring

A client ID (uuid) used to filter credit notes for a specific client.

Response

200

hasMoreboolean

Whether there are more results available after this page.

Changes

No recorded changes to this operation across all 1 revision of this API.