Skip to content
RipsClouddevelopers

List debit notes

GET/api/v1/workspaces/{workspaceId}/debit-notes

Operation ID: debitNotes.list · Access: PAT with read scope and authorized workspace where applicable · Effect: read.

Read the debit notes workflow before this operation.

Parameters

Section titled “Parameters”
Name In Required Type / allowed values
workspaceId path Yes string
page query No integer
pageSize query No integer
sortDirection query No asc, desc
clientName query No string
status query No string
createdFrom query No string
createdTo query No string
includeArchived query No true, false
sortBy query No debitNoteNumber, originalInvoiceNumber, clientName, status, createdAt, updatedAt, totalAmount
debitNoteNumber query No string
originalInvoiceNumber query No string

Responses

Section titled “Responses”
HTTP Content Schema
200 application/json DebitNotePage
400 application/json ApiError
401 application/json ApiError
403 application/json ApiError
404 application/json ApiError
500 application/json ApiError

Use error.code, error.issues, and requestId for JSON errors. Error and recovery guide.

cURL

Section titled “cURL”

Set the connection variables from the quickstart. Set each path variable to an authorized identifier or an allowed parameter value from the table above.

Terminal window
curl --fail-with-body --request GET \
  "$RIPSCLOUD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/debit-notes" \
  --header "Authorization: Bearer $RIPSCLOUD_TOKEN" \
  --header 'Accept: application/json'