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 Invoice API

An invoice is a commercial document issued by a seller to a buyer relating to a sale transaction and indicating the products, quantities, and agreed-upon prices for products or services the seller had provided the buyer.

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

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

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

29 operations 21 paths 0 schemas 3 DELETE7 GET12 PATCH7 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 Invoice 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 29

Across 21 paths, the API surfaces 29 operations β€” 3 DELETE, 7 GET, 12 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Invoice 29

An invoice is a commercial document issued by a seller to a buyer relating to a sale transaction and indicating the products, quantities, and agreed-upon prices for products or se…

POST
/api/v1/invoices
Create invoice
invoice.create body → 201400401403404415429
GET
/api/v1/invoices
List invoices
invoice.list 3 params → 200400401403406429
GET
/api/v1/invoices/{id}
View invoice
invoice.view 1 param → 200400401403404406429
PATCH
/api/v1/invoices/{id}
Update invoice
invoice.update 1 param body → 204400401403404406429
GET
/api/v1/invoices/{id}/balance
View invoice balance
invoice.balance 1 param → 200400401403404406429
GET
/api/v1/invoices/{id}/documents
View related documents for invoice
invoice.documents.view 1 param → 200400401403404406429
POST
/api/v1/invoices/{id}/positions
Create positions for invoice
invoice.createPositions 1 param body → 201400401403404415429
PATCH
/api/v1/invoices/{id}/senddeprecated
Send invoice
invoice.send 1 param body → 204400401403404406429
PATCH
/api/v1/invoices/{id}/status
Update status for single invoice
invoice.status 1 param body → 204400401403404406429
PATCH
/api/v2/invoices/{id}/actions/send
Send invoice V2
invoice.send.v2 1 param body → 204400401403404429
GET
/api/v3/invoices
List invoices V3
GET::api-v3-invoices 8 params → 200401403429
POST
/api/v3/invoices
πŸ”’ Create invoice V3
POST::api-v3-invoices body → 201400401403429
POST
/api/v3/invoices/actions/createFromDeliveryNote
πŸ”’ Create invoice from delivery note V3
POST::api-v3-invoices-actions-createfromdeliverynote body → 201400401403429
POST
/api/v3/invoices/actions/createFromSalesOrder
πŸ”’ Create invoice from sales order V3
POST::api-v3-invoices-actions-createfromsalesorder body → 201400401403429
GET
/api/v3/invoices/{id}
View invoice V3
GET::api-v3-invoices-id 2 params → 200401403404429
DELETE
/api/v3/invoices/{id}
Delete invoice V3
DELETE::api-v3-invoices-id 1 param → 204401403404409429
PATCH
/api/v3/invoices/{id}
πŸ”’ Update invoice V3
PATCH::api-v3-invoices-id 1 param body → 200400401403404409429
PATCH
/api/v3/invoices/{id}/actions/logActivity
Log custom invoice activity V3
PATCH::api-v3-invoices-id-actions-logactivity 1 param body → 204400401403404429
PATCH
/api/v3/invoices/{id}/actions/release
Release invoice V3
PATCH::api-v3-invoices-id-actions-release 1 param body → 204400401403404409429
PATCH
/api/v3/invoices/{id}/actions/removeWriteProtection
Remove invoice write protection V3
PATCH::api-v3-invoices-id-actions-removewriteprotection 1 param → 204401403404409429
PATCH
/api/v3/invoices/{id}/actions/send
Send invoice V3
PATCH::api-v3-invoices-id-actions-send 1 param body → 204400401403404409429
PATCH
/api/v3/invoices/{id}/actions/setWriteProtection
Set invoice write protection V3
PATCH::api-v3-invoices-id-actions-setwriteprotection 1 param → 204401403404409429
POST
/api/v3/invoices/{id}/files
Attach file to invoice V3
POST::api-v3-invoices-id-files 1 param body → 201400401403404429
DELETE
/api/v3/invoices/{id}/files/{fileId}
Delete file from invoice V3
DELETE::api-v3-invoices-id-files-fileid 2 params → 204401403404429
PATCH
/api/v3/invoices/{id}/files/{fileId}
Update file on invoice V3
PATCH::api-v3-invoices-id-files-fileid 2 params body → 204400401403404429
POST
/api/v3/invoices/{id}/lineItems
πŸ”’ Create invoice line item V3
POST::api-v3-invoices-id-lineitems 1 param body → 201400401403404409429
GET
/api/v3/invoices/{id}/lineItems/{lineItemId}
View invoice line item V3
GET::api-v3-invoices-id-lineitems-lineitemid 3 params → 200401403404429
DELETE
/api/v3/invoices/{id}/lineItems/{lineItemId}
Delete invoice line item V3
DELETE::api-v3-invoices-id-lineitems-lineitemid 2 params → 204401403404409429
PATCH
/api/v3/invoices/{id}/lineItems/{lineItemId}
πŸ”’ Update invoice line item V3
PATCH::api-v3-invoices-id-lineitems-lineitemid 2 params body → 200400401403404409429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xentral-invoice-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 API
Xentral Credit Note Tag API
Xentral CreditNote API
Xentral Customer Address API
Xentral Customer API
Xentral Customer - Contact Person API