Download an artifact — Credit notes

GET/api/v1/workspaces/{workspaceId}/credit-notes/{creditNoteId}/artifacts/{artifact}

Operation ID: creditNotes.downloadArtifact · Access: PAT with send scope and authorized workspace where applicable · Effect: external.

Production action

This operation can send data to an external service. Use a new idempotency key for each new intent. A timeout does not prove that the action failed.

Read the credit notes workflow before this operation.

Parameters

Name	In	Required	Type / allowed values
workspaceId	path	Yes	string
creditNoteId	path	Yes	string
artifact	path	Yes	pdf, xml, attached

Responses

HTTP	Content	Schema
200	application/octet-stream	string
400	application/json	ApiError
401	application/json	ApiError
403	application/json	ApiError
404	application/json	ApiError
409	application/json	ApiError
500	application/json	ApiError
502	application/json	ApiError

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

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.

curl --fail-with-body --request GET \
  "$RIPSCLOUD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/credit-notes/$CREDIT_NOTE_ID/artifacts/$ARTIFACT" \
  --header "Authorization: Bearer $RIPSCLOUD_TOKEN" \
  --header 'Accept: application/octet-stream' \
  --output artifact.bin