PUT

Set credit note pipeline

Scope: sales:invoices.write https://api.alladdin.com/api/v2/credit-notes/{creditNoteId}/pipeline

Moves the credit note to a specific pipeline stage.
You must provide the pipeline_id of the target stage.

Parameters

Path parameters

creditNoteId string required

Credit Note ID (24-char hex ObjectId)

Request body

object pipeline_id string required

Request

python

import requests

url = "https://api.alladdin.com/api/v2/credit-notes/{creditNoteId}/pipeline"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "pipeline_id": "string"
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())

Responses

Response

json

{
  "status": "ok"
}

Success responses

200 Pipeline set application/json object status string required

Confirmation status

Error responses

400 Bad request application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Credit note not found. application/json 429 Rate limit exceeded application/json 500 Internal server error application/json object type string title string status integer detail string

← PreviousUpdate a credit note →

Next →List credit note attachments →

Alladdin