---
updatedAt: 2026-04-23T13:29:19.000Z
agentTools:
projectIndex: https://developer.xentral.com/llms.txt
---
# Create credit note
Creates a credit note
Warning: Multiple request body content types
Due to technical limitations, the information provided here may not display all available request body content types.
We are currently working with our third-party documentation provider to address this issue.
For a complete and accurate representation of the available content types, we recommend referring to the full OpenAPI specification.
We apologize for any inconvenience caused and appreciate your understanding as we work to resolve this matter.
Available request content types:
- application/json
- application/vnd.xentral.minimal+json
- application/vnd.xentral.fromreturn+json
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"title": "Xentral API",
"version": "v0.1",
"description": "Xentral is an ERP platform.",
"contact": {
"name": "Xentral",
"url": "https://xentral.com",
"email": "api@xentral.com"
}
},
"tags": [
{
"name": "Credit Note",
"description": "A credit note is a document you send to your customer to correct a mistake on an order or an invoice, or to refund an amount paid for products or services."
}
],
"components": {
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "Bearer token obtained in POST /tokens endpoint or pregenerated in the system."
}
}
},
"security": [
{
"BearerAuth": []
}
],
"servers": [
{
"url": "https://{xentralId}.xentral.biz",
"description": "Your Xentral Instance",
"variables": {
"xentralId": {
"default": "xentral"
}
}
},
{
"url": "https://{domain}",
"description": "Xentral at a custom domain",
"variables": {
"domain": {
"default": "xentral.com"
}
}
}
],
"x-readme": {
"samples-languages": []
},
"paths": {
"/api/v1/creditNotes": {
"post": {
"tags": [
"Credit Note"
],
"operationId": "creditNote.create",
"summary": "Create credit note",
"description": "Creates a credit note
\nWarning: Multiple request body content types
\n\n Due to technical limitations, the information provided here may not display all available request body content types.\n We are currently working with our third-party documentation provider to address this issue.\n For a complete and accurate representation of the available content types, we recommend referring to the full OpenAPI specification.\n
\n\n We apologize for any inconvenience caused and appreciate your understanding as we work to resolve this matter.\n
\nAvailable request content types:
\n\n - application/json
\n- application/vnd.xentral.minimal+json
\n- application/vnd.xentral.fromreturn+json
\n
",
"requestBody": {
"description": "Create a credit note object",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"invoice"
],
"additionalProperties": false,
"properties": {
"invoice": {
"description": "Reference to another resource",
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "\\d+",
"example": "17",
"description": "Resource identifier."
}
},
"example": {
"id": "1337"
}
},
"documentNumber": {
"type": "string",
"minLength": 1,
"maxLength": 35
}
}
},
"examples": {
"Create credit not from an invoice": {
"value": {
"invoice": {
"id": "1337"
}
}
},
"Create credit not from an invoice with a document number": {
"value": {
"invoice": {
"id": "1337"
},
"documentNumber": "415263"
}
}
}
}
}
},
"responses": {
"201": {
"description": "Resource successfully created response",
"headers": {
"Location": {
"schema": {
"type": "string",
"example": "https://example.xentral.biz/api/users/17"
},
"description": "URI of the created resource"
}
},
"content": {
"text/html": {
"schema": {
"type": "string",
"enum": [
""
],
"nullable": true
}
}
}
},
"400": {
"description": "IETF RFC 9457 Problem API compliant response",
"content": {
"application/problem+json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"violations"
],
"properties": {
"type": {
"type": "string",
"enum": [
"https://api.xentral.biz/problems/request-validation"
]
},
"title": {
"type": "string",
"minLength": 1,
"example": "Request payload validation failed."
},
"violations": {
"oneOf": [
{
"type": "array",
"items": {
"type": "object",
"example": {
"username": [
"This value should not be blank."
],
"email": [
"This value is not a valid email address."
]
}
},
"description": "This field will be a mirrored request payload with only invalid fields and values replaced by error messages."
},
{
"type": "object",
"example": {
"_": [
"This value should contain at most `9` elements."
]
},
"description": "This field will be a mirrored request payload with only invalid fields and values replaced by error messages."
}
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"messages"
],
"properties": {
"type": {
"type": "string",
"enum": [
"https://api.xentral.biz/problems/generic-validation"
]
},
"title": {
"type": "string",
"minLength": 1
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"messages"
],
"properties": {
"type": {
"type": "string",
"enum": [
"https://api.xentral.biz/problems/conflict"
]
},
"title": {
"type": "string",
"minLength": 1
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"items"
],
"properties": {
"type": {
"type": "string",
"enum": [
"https://api.xentral.biz/problems/conflictItems"
]
},
"title": {
"type": "string",
"minLength": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"title",
"messages"
],
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string",
"minLength": 1
},
"messages": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"scopes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"https://developer.xentral.com/reference/problems#token-scopes"
]
},
"title": {
"type": "string",
"minLength": 1
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"messages"
],
"properties": {
"type": {
"type": "string",
"enum": [
"https://api.xentral.biz/problems/generic-validation"
]
},
"title": {
"type": "string",
"minLength": 1
},
"messages": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
}
}
},
"401": {
"description": "Unable to authenticate the client",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error message explaining why the request failed.",
"example": "Missing required scopes: customer:create."
}
}
},
"example": {
"message": "Missing required scopes: customer:create."
}
},
"text/html": {
"schema": {
"type": "string",
"example": "Unauthorized"
}
}
}
},
"403": {
"description": "Unable to authorize the client"
},
"404": {
"description": "Resource was not found or not enough access privileges"
},
"415": {
"description": "Resource representation send in the request is not supported."
},
"429": {
"description": "Too many API calls made."
}
}
}
}
}
}
```