Xentral Credit Note API
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.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/xentral-credit-note-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Xentral Account Credit Note API
version: v0.1
description: Xentral is an ERP platform.
contact:
name: Xentral
url: https://xentral.com
email: api@xentral.com
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
security:
- BearerAuth: []
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.
paths:
/api/v1/creditNotes:
post:
tags:
- Credit Note
operationId: creditNote.create
summary: Create credit note
description: Creates a credit note
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'
application/vnd.xentral.minimal+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'
application/vnd.xentral.fromreturn+json:
schema:
type: object
additionalProperties: false
properties:
return:
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'
isApproved:
type: boolean
default: false
isPaid:
type: boolean
default: false
examples:
return:
value:
return:
id: '1337'
isApproved: true
isPaid: false
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
- 'null'
enum:
- ''
'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.
get:
tags:
- Credit Note
operationId: creditNote.list
summary: List credit notes
description: Returns a collection with all credit notes.
parameters:
- name: filter
in: query
style: deepObject
schema:
oneOf:
- type: object
additionalProperties: false
properties:
id:
type: array
items:
type: string
pattern: \d+
example: '17'
description: Resource identifier.
- type: array
items:
type: object
additionalProperties: false
properties:
key:
type: string
enum:
- search
- id
- creditNote
- date
- status
- customerName
- customerNumber
- country
- projectId
- projectName
- projectAbbr
- paymentMethod
- paymentStatus
- amount
- currency
op:
type: string
enum:
- equals
- notEquals
- in
- notIn
- exactlyIn
- allIn
- allNotIn
- contains
- notContains
- startsWith
- endsWith
- greaterThan
- lessThan
- is
- lessThanOrEquals
- greaterThanOrEquals
value:
oneOf:
- type: string
description: Used for the operations 'equals', 'notEquals', 'contains', 'notContains', 'startsWith', 'endsWith' and 'is'.
title: String
- type: array
description: Used for the operations 'in', 'notIn', 'exactlyIn', 'allIn' and 'allNotIn'.
title: Array
items:
type: string
- in: query
name: page
required: false
style: deepObject
schema:
type: object
additionalProperties: false
required:
- number
- size
properties:
number:
type: string
pattern: \d+
description: Page number should be an integer greater than or equal to 1
size:
type: string
pattern: \d+
description: Page size should usually be an integer between 10 and 50.
- name: order
in: query
style: deepObject
schema:
type: array
items:
type: object
additionalProperties: false
properties:
field:
type: string
enum:
- id
- creditNote
- date
- customerName
- customerNumber
- country
- project
- paymentMethod
- amount
- currency
- paymentStatus
- status
dir:
type: string
enum:
- asc
- desc
responses:
'200':
description: Operation completed successfully.
content:
application/vnd.xentral.minimal+json:
schema:
type: object
additionalProperties: false
properties:
data:
type: array
items:
type: object
additionalProperties: false
properties:
id:
type: string
pattern: \d+
example: '17'
description: Resource identifier.
number:
description: The credit note document number
type:
- string
- 'null'
example: 2024-900000
date:
description: The document date of the credit note
type: string
format: date
example: '2024-05-29'
status:
description: The status of the credit note
type: string
enum:
- approved
- closed
- completed
- created
- canceled
- sent
example: created
amount:
x-description-missing: true
type: object
additionalProperties: false
required:
- amount
- currencyCode
properties:
amount:
type: string
currencyCode:
type: string
example:
amount: '142.78'
currencyCode: EUR
invoice:
x-description-missing: true
type:
- object
- 'null'
additionalProperties: false
required:
- number
properties:
number:
type: string
example:
number: 2022-400085
address:
x-description-missing: true
type:
- object
- 'null'
additionalProperties: false
required:
- id
- name
- customerNumber
- country
properties:
id:
type: string
pattern: \d+
example: '17'
description: Resource identifier.
name:
type: string
customerNumber:
type: string
country:
type: string
example:
id: '18'
name: Richard E.
customerNumber: '10011'
country: DE
project:
x-description-missing: true
type:
- object
- 'null'
additionalProperties: false
required:
- id
- name
- abbreviation
properties:
id:
type: string
pattern: \d+
example: '17'
description: Resource identifier.
name:
type: string
abbreviation:
type: string
example:
id: '5'
name: Amazon FBM
abbreviation: FBM
payment:
x-description-missing: true
type:
- object
- 'null'
additionalProperties: false
required:
- method
- status
properties:
method:
type: string
status:
type: string
example:
method: shopify_payments
status: offen
paymentTransaction:
x-description-missing: true
type:
- object
- 'null'
additionalProperties: false
required:
- id
- paymentStatus
properties:
id:
type: string
pattern: \d+
example: '17'
description: Resource identifier.
paymentStatus:
type: string
example:
id: '2'
paymentStatus: recorded
updatedBy:
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'
updatedAt:
x-description-missing: true
type: string
format: date-time
example: '2021-12-15T11:31:44+01:00'
tags:
description: A list of tags
type: array
items:
type: object
additionalProperties: false
properties:
id:
description: The identifier of the tag
type: string
pattern: \d+
example: '1337'
name:
description: The name of the tag
type: string
example: Active
color:
type: string
pattern: '[a-fA-F0-9]{6}'
example: ff0000
description: 'Hexadecimal color value in 6-digit format without the leading # character.'
extra:
type: object
required:
- totalCount
- page
additionalProperties: false
x-description-ignore: true
properties:
totalCount:
description: the total count of all items
type: integer
example: 1
page:
description: The pagination object containing the current page number and size
type: object
required:
- number
- size
additionalProperties: false
properties:
number:
description: The current page number
type: integer
example: 1
size:
description: The size of the pages
type: integer
example: 10
example:
number: 1
size: 10
example:
totalCount: 1
page:
number: 1
size: 10
text/csv:
schema:
type: string
'403':
description: Unable to authorize the client
'406':
description: Requested resource representation does not exist.
'429':
description: Too many API calls made.
/api/v1/creditNotes/{id}:
get:
tags:
- Credit Note
operationId: creditNote.view
summary: View credit note
description: Returns details of a single credit note.
parameters:
- in: path
name: id
required: true
description: The resource's identifier.
schema:
type: string
pattern: \d+
example: '17'
description: Resource identifier.
responses:
'200':
description: Operation completed successfully.
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- data
properties:
data:
x-description-missing: true
type: object
additionalProperties: false
properties:
id:
type: string
pattern: \d+
example: '17'
description: Resource identifier.
number:
x-description-missing: true
type:
- string
- 'null'
example: '9000000'
date:
x-description-missing: true
type: string
format: date
example: '2021-11-08'
createdAt:
x-description-missing: true
type: string
format: date-time
example: '2021-12-09T10:16:07+01:00'
createdBy:
x-description-missing: true
type:
- object
- 'null'
additionalProperties: false
required:
- name
properties:
name:
type: string
example:
name: Administrator
sentAt:
x-description-missing: true
type:
- string
- 'null'
format: date-time
example: '2021-12-09T10:19:18+01:00'
sentBy:
x-description-missing: true
type:
- object
- 'null'
additionalProperties: false
required:
- name
properties:
name:
type: string
example:
name: Administrator
updatedAt:
x-description-missing: true
type: string
format: date-time
example: '2023-01-13T10:43:58+01:00'
grossValue:
description: Money object with amount and currency
example:
amount: '13.37'
currency: EUR
type: object
additionalProperties: false
properties:
amount:
description: A string representing the amount
type: string
format: float
example: '24.99'
currency:
type: string
pattern: '[A-Z]{3}'
enum:
- EUR
- USD
- JPY
- BGN
- CZK
- DKK
- GBP
- HUF
- PLN
- RON
- SEK
- CHF
- ISK
- NOK
- HRK
- RUB
- TRY
- AUD
- BRL
- CAD
- CNY
- HKD
- IDR
- ILS
- INR
- KRW
- MXN
- MYR
- NZD
- PHP
- SGD
- THB
- ZAR
- ARS
- CLP
- SAR
- AED
- QAR
description: Currency matches one of currency values as specified in ISO-4217.
example: PLN
netValue:
description: Money object with amount and currency
example:
amount: '13.37'
currency: EUR
type: object
additionalProperties: false
properties:
amount:
description: A string representing the amount
type: string
format: float
example: '24.99'
currency:
type: string
pattern: '[A-Z]{3}'
enum:
- EUR
- USD
- JPY
- BGN
- CZK
- DKK
- GBP
- HUF
- PLN
- RON
- SEK
- CHF
- ISK
- NOK
- HRK
- RUB
- TRY
- AUD
- BRL
- CAD
- CNY
- HKD
- IDR
- ILS
- INR
- KRW
- MXN
- MYR
- NZD
- PHP
- SGD
- THB
- ZAR
- ARS
- CLP
- SAR
- AED
- QAR
description: Currency matches one of currency values as specified in ISO-4217.
example: PLN
costCenter:
x-description-missing: true
type: string
example: '41000'
status:
x-description-missing: true
type: string
enum:
- approved
- sent
- created
- closed
- canceled
example: sent
project:
x-description-missing: true
# --- truncated at 32 KB (103 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/xentral/refs/heads/main/openapi/xentral-credit-note-api-openapi.yml