Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Xentral

Xentral CreditNote API

CreditNote

Documentation Provider Profile APIs.io OpenAPI GitHub

Xentral CreditNote API is one of 90 APIs that Xentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CreditNote. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 17 operations across 11 paths. It is described by OpenAPI 3.0.0, at version v0.1.

Requests are made against 2 base URLs: https://{xentralId}.xentral.biz, https://{domain}.

17 operations 11 paths 0 schemas 3 DELETE3 GET8 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v0.1
Base URL
https://xentral.xentral.biz
Authentication
HTTP Bearer
Contact
Xentral
Resource Areas
1

Authentication & Security 1

Xentral CreditNote API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Bearer token obtained in POST /tokens endpoint or pregenerated in the system.

Paths & Operations 17

Across 11 paths, the API surfaces 17 operations — 3 DELETE, 3 GET, 8 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

CreditNote 17

CreditNote

GET
/api/v3/creditNotes
List credit notes V3
GET::api-v3-creditnotes 8 params → 200401403429
POST
/api/v3/creditNotes
🔒 Create credit note V3
POST::api-v3-creditnotes body → 201400401403429
GET
/api/v3/creditNotes/{id}
View credit note V3
GET::api-v3-creditnotes-id 2 params → 200401403404429
DELETE
/api/v3/creditNotes/{id}
Delete credit note V3
DELETE::api-v3-creditnotes-id 1 param → 204401403404409429
PATCH
/api/v3/creditNotes/{id}
🔒 Update credit note V3
PATCH::api-v3-creditnotes-id 1 param body → 200400401403404409429
PATCH
/api/v3/creditNotes/{id}/actions/logActivity
Log custom credit note activity V3
PATCH::api-v3-creditnotes-id-actions-logactivity 1 param body → 204400401403404429
PATCH
/api/v3/creditNotes/{id}/actions/release
Release credit note V3
PATCH::api-v3-creditnotes-id-actions-release 1 param body → 204400401403404409429
PATCH
/api/v3/creditNotes/{id}/actions/removeWriteProtection
Remove credit note write protection V3
PATCH::api-v3-creditnotes-id-actions-removewriteprotection 1 param → 204401403404409429
PATCH
/api/v3/creditNotes/{id}/actions/send
Send credit note V3
PATCH::api-v3-creditnotes-id-actions-send 1 param body → 204400401403404409429
PATCH
/api/v3/creditNotes/{id}/actions/setWriteProtection
Set credit note write protection V3
PATCH::api-v3-creditnotes-id-actions-setwriteprotection 1 param → 204401403404409429
POST
/api/v3/creditNotes/{id}/files
Attach file to credit note V3
POST::api-v3-creditnotes-id-files 1 param body → 201400401403404429
DELETE
/api/v3/creditNotes/{id}/files/{fileId}
Delete file from credit note V3
DELETE::api-v3-creditnotes-id-files-fileid 2 params → 204401403404429
PATCH
/api/v3/creditNotes/{id}/files/{fileId}
Update file on credit note V3
PATCH::api-v3-creditnotes-id-files-fileid 2 params body → 204400401403404429
POST
/api/v3/creditNotes/{id}/lineItems
🔒 Create credit note line item V3
POST::api-v3-creditnotes-id-lineitems 1 param body → 201400401403404409429
GET
/api/v3/creditNotes/{id}/lineItems/{lineItemId}
View credit note line item V3
GET::api-v3-creditnotes-id-lineitems-lineitemid 3 params → 200401403404429
DELETE
/api/v3/creditNotes/{id}/lineItems/{lineItemId}
Delete credit note line item V3
DELETE::api-v3-creditnotes-id-lineitems-lineitemid 2 params → 204401403404409429
PATCH
/api/v3/creditNotes/{id}/lineItems/{lineItemId}
🔒 Update credit note line item V3
PATCH::api-v3-creditnotes-id-lineitems-lineitemid 2 params body → 200400401403404409429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xentral-creditnote-api-openapi.yml Raw ↑

Other APIs Xentral publishes across the network.

Xentral Account API
AE Profile APIs.io
Xentral Accounting Export API
AE Profile APIs.io
Xentral AuthPlatform API
AE Profile APIs.io
Xentral Collection API
AE Profile APIs.io
Xentral Collective Bill API
AE Profile APIs.io
Xentral Credit API
AE Profile APIs.io
Xentral Credit Note API
AE Profile APIs.io
Xentral Credit Note Tag API
AE Profile APIs.io
Xentral Customer Address API
AE Profile APIs.io
Xentral Customer API
AE Profile APIs.io
Xentral Customer - Contact Person API
AE Profile APIs.io
Xentral Customer Delivery Address API
AE Profile APIs.io
#CreditNote
← Back to X APIs
API Details
ID
xentral:xentral-creditnote-api
Base URL
https://xentral.xentral.biz
Docs
https://developer.xentral.com/reference/intro
Provider
Xentral
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network