Skip to main content
DELETE
/
creditnotes
/
{id}
Delete credit note (draft only)
curl --request DELETE \
  --url https://api.piriod.com/creditnotes/{id}/ \
  --header 'Authorization: <api-key>' \
  --header 'x-simple-workspace: <x-simple-workspace>'
{
  "name": [
    "This field is required."
  ],
  "non_field_errors": [
    "x-simple-workspace header is required."
  ]
}

Authorizations

​
Authorization
string
header
required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

​
x-simple-workspace
string
required

Workspace (account) identifier. Required for every request.

​
x-piriod-test-mode
boolean
default:false

Whether to operate against test-mode data. Defaults to false.

Path Parameters

​
id
string
required

Resource identifier.

Response

Deleted.