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

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.

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

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

This API exposes 7 operations across 5 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}.

7 operations 5 paths 0 schemas 4 GET2 PATCH1 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
Resource Areas
1

Authentication & Security 1

Xentral Credit Note 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 7

Across 5 paths, the API surfaces 7 operations — 4 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Credit Note 7

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.

POST
/api/v1/creditNotes
Create credit note
creditNote.create body → 201400401403404415429
GET
/api/v1/creditNotes
List credit notes
creditNote.list 3 params → 200403406429
GET
/api/v1/creditNotes/{id}
View credit note
creditNote.view 1 param → 200400401403404406429
PATCH
/api/v1/creditNotes/{id}
Update credit note
creditNote.update 1 param body → 204400401403404406429
PATCH
/api/v1/creditNotes/{id}/actions/send
Send credit note
creditNote.send 1 param body → 204400401403404406429
GET
/api/v1/creditNotes/{id}/balance
View Credit Note Balance
creditNote.balance 1 param → 200400404406429
GET
/api/v1/creditNotes/{id}/documents
View related documents for credit note
creditNote.documents.view 1 param → 200400401403404406429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xentral-credit-note-api-openapi.yml Raw ↑

Other APIs Xentral publishes across the network.

Xentral Account API
Xentral Accounting Export API
Xentral AuthPlatform API
Xentral Collection API
Xentral Collective Bill API
Xentral Credit API
Xentral Credit Note Tag API
Xentral CreditNote API
Xentral Customer Address API
Xentral Customer API
Xentral Customer - Contact Person API
Xentral Customer Delivery Address API