Jump to Content
API Reference
Guides
API Reference
Roadmap
v25.49
v25.52
v26.1
v26.2
API Reference
API Reference
26.2.2
Guides
API Reference
Roadmap
Testing the APIs
All
Pages
Start typing to search…
JUMP TO
Overview
Introduction
Authentication
Rate Limiting
Media types & variants
PDF Documents
Versioning
Filtering, Ordering, & Pagination
Testing the APIs
Feedback?
Xentral API
Business Documents
Collective Bill
Create collective bill
post
Credit Note
Create credit note
post
List credit notes
get
View credit note
get
Update credit note
patch
Send credit note
patch
View Credit Note Balance
get
View related documents for credit note
get
Delivery Note
List delivery notes
get
View delivery note
get
View delivery note shipments
get
Update delivery note positions customs data.
patch
Assign quality control attributes to delivery note
patch
Delivery
Create tracking information
post
List deliveries
get
View delivery
get
View shipment
get
Invoice
Create invoice
post
Create positions for invoice
post
List invoices
get
View invoice
get
Update invoice
patch
Update status for single invoice
patch
Send invoice V2
patch
View invoice balance
get
View related documents for invoice
get
Liability
Create liability
post
Create recurring liability
post
List liabilities
get
View liability
get
Release liability
patch
Add file to liability
post
Provisional Return
List provisional returns
get
Purchase Order
Create purchase order
post
List purchase orders
get
View purchase order
get
Update purchase order
patch
Cancel purchase order
patch
Release purchase order
patch
Return
Create return
post
List returns
get
View return
get
Release return
post
Create return document
post
List return documents
get
View return document
get
Update multiple return documents
patch
Delete multiple return documents
del
List return reasons
get
Sales Order
Import sales order
post
List sales orders
get
View sales order
get
Update sales order
patch
Delete sales order
del
Cancel sales order
post
Dispatch sales order
post
Create sales order document
post
List sales order documents
get
View sales order document
get
Update multiple sales order documents
patch
Delete multiple sales order documents
del
Create partial sales order
patch
Business Contacts
Customer
Create customer
post
List customers
get
View customer
get
Update customer
patch
Delete customer
del
Customer Address
Create address
post
List addresses
get
View address
get
Update address
patch
Delete address
del
Customer - Contact Person
Create contact person
post
List contact persons
get
View contact person
get
Update contact person
patch
Delete contact person
del
Employee
List employees
get
Supplier
List suppliers
get
View supplier
get
Delete supplier
del
Products
Product
Create product V2
post
List products V2
get
View product V2
get
Update product v2
patch
Update multiple products V2
patch
Delete product
del
Delete multiple products
del
View media
get
Update product properties
patch
View purchase prices
get
View sales prices
get
View purchase orders positions
get
View sales orders positions
get
View productions positions
get
View storage locations
get
Cross Sellings
Create cross selling
post
List cross sellings
get
Update cross selling
patch
Delete cross selling
del
Parts
Create parts v2
post
Update parts v2
patch
List parts
get
Delete parts
del
Reservations
View reservations
get
Texts
List product texts
get
External Reference
Create external reference
post
List external references
get
List external reference targets
get
Update external reference
patch
Delete external reference
del
Matrixproduct
Creates variants for a matrix product
post
Create product option
post
Update product option
patch
Create multiple product option values
post
List product option values
get
List product options
get
Update multiple product options
patch
Delete multiple product options
del
View product option value
get
Update product option value
patch
Delete product option value
del
Delete multiple product option values
del
Product Category
Create product category
post
List product categories
get
View product category
get
Update product category
patch
Delete product category
del
Product Free Field
List product free fields
get
View product free field
get
Update product free field
patch
Update multiple product free fields
patch
Product Media
Create product media
post
List product media
get
View product media
get
Update multiple product media
patch
Delete multiple product media
del
Create product media version
post
View product media version
get
Update product media version
patch
Delete product media version
del
Product Property
Create multiple product properties
post
List product properties
get
List product properties
get
Update multiple product properties
patch
Delete multiple product properties
del
Product Merchandise Group
Create product merchandise group
post
List product merchandise groups
get
View product merchandise group
get
Update product merchandise group
patch
Delete product merchandise group
del
Purchase Price
Create purchase price V2
post
List purchase prices V2
get
View purchase price
get
Update purchase price V2
patch
Update multiple purchase prices V2
patch
Delete purchase price
del
Sales Channels Product Settings
Create product sales channel settings
post
Update product sales channel settings
patch
Delete product sales channel settings
del
Sales Price
Create sales price
post
List sales prices
get
View sales price
get
Update sales price
patch
Update multiple sales prices
patch
Delete sales price
del
Product Label
Print product label
post
Download product label as pdf
get
Product Stock
View stock details of a product
get
Finance
Accounting Export
Check accounting export status
get
Download accounting export
get
Execute the accounting CSV export for invoices and credit notes
post
Execute the accounting CSV export for liabilities
post
Execute the accounting CSV export for account transactions
post
Execute the accounting XML export for invoices
post
Execute the accounting XML export for credit notes
post
Execute the accounting XML export for liabilities
post
Payment Service Provider
Create payment service provider transactions
post
List payment service provider transactions
get
Payment Methods
List payment methods
get
Payment Terms Group
Create payment terms group
post
List payment terms groups
get
View payment terms group
get
Payment Transaction
View payment transaction
get
Update payment transaction status
patch
Tax Rate
List tax rates
get
Warehousing
Delivery Terms
List delivery terms
get
Goods Receipt
Create goods receipt for purchase order
post
Create goods receipt for return
post
Shipping Methods
Create shipping method
post
List shipping methods
get
View shipping method
get
Update shipping method
put
Stock Movement Types
Create stock movement type
post
Storage Location
Create storage location
post
List storage locations
get
Update storage location
patch
Delete storage location
del
Set total stock on storage locations
patch
Storage Item
List storage items V2
get
Add item to storage location
post
Retrieve item from storage location
patch
Warehouse
Create warehouse
post
List warehouses
get
Update warehouse
patch
Delete warehouse
del
Analytics
Collection
Create collection
post
List collections
get
View collection
get
Update collection
patch
Delete collection
del
Credit
Get credit information
get
Documentation
List documentations
get
Query
Execute query
post
Create query export
post
List query exports
get
View query export
get
Report
Create report
post
List reports
get
View report
get
Update report
patch
Delete report
del
Create report export
post
List report exports
get
View report export
get
Execute report query
post
Create report permalink
post
List report permalink
get
Invalidate permalink for report
del
Download report
get
Create report schedule
post
List report schedules
get
Update report schedule
patch
Delete report schedule
del
List schedules
get
Report Usage
Get report usage
get
Reporting Settings
Get settings
get
Update reporting settings
patch
Point Of Sale
List cashiers
get
Cashier PIN check
post
View cash register balance
get
List POS journals
get
Add journal entry
post
Add cash count entry
post
Add qr code data to a document
post
Setting
Address Free Fields
Create address free field
post
List address free fields
get
Text Templates
List text templates
get
Update text templates
patch
AuthPlatform
Exchange subject token for platform access token
post
File
List files for a document
get
View file of a document by id
get
Print Jobs
Create print job
post
Project
List projects
get
List POS settings for project
get
Sales Channel
List sales channels V2
get
User
Create user
post
List users V2
get
View user
get
Update user
patch
Delete user
del
List user permissions
get
Download user permissions
get
Request reset password email
post
Webhook
Create webhook
post
List webhooks
get
View webhook
get
Update webhook
patch
Delete webhook
del
List webhook event types
get
Tag
List tags
get
Create a new tag
post
Delete tags
del
Update multiple tags
patch
Assign tags to multiple resources
post
Remove tags from multiple resources
del
Production
List productions
get
View production
get
Release production
patch
Cancel production
patch
Deprecated APIs
Standard API
REST API
Deprecated endpoints
Business Documents
Send invoice
patch
List delivery note deliveries
get
Products
Create new product V1
post
List products V1
get
View product v1
get
Update product v1
patch
Update multiple products V1
patch
Identify product
get
Product Purchase Prices
Update multiple purchase prices V1
patch
Update purchase price V1
patch
List purchase prices V1
get
Create purchase price V1
post
Product parts
Update parts v1
patch
Create parts v1
post
Tags
List suppliers tags
get
List Invoice tags
get
Update product tag
patch
Create product tag
post
List product tags
get
List Credit Notes tags
get
List delivery notes tags
get
Warehousing
List storage items V1
get
Settings
List users
get
Events
Webhooks
Xentral API v3
Invoice
Log custom invoice activity V3
patch
🔒 Attach a file to an invoice V3
post
🔒 Delete a file attached to an invoice V3
del
🔒 Update a file attached to an invoice V3
patch
Delete invoice V3
del
Delete invoice line item V3
del
🔒 List invoices V3
get
🔒 View invoice V3
get
🔒 View invoice line item V3
get
🔒 Update invoice V3
patch
🔒 Release invoice V3
patch
🔒 Update invoice line item V3
patch
🔒 Create invoice V3
post
🔒 Create invoice line item V3
post
SalesOrder
Release sales order V3
patch
Log custom sales order activity V3
patch
🔒 Cancel sales order V3
patch
🔒 Attach a file to a sales order V3
post
🔒 Delete a file attached to a sales order V3
del
🔒 Update a file attached to a sales order V3
patch
Delete sales order V3
del
Delete sales order line item V3
del
List sales orders V3
get
View sales order V3
get
🔒 View sales order line item V3
get
🔒 Update sales order V3
patch
🔒 Update sales order line item V3
patch
🔒 Create sales order V3
post
🔒 Create sales order line item V3
post
Offer
🔒 List offers V3
get
Delete offer V3
del
🔒 Create offer V3
post
🔒 Update offer V3
patch
Release offer V3
patch
Cancel offer V3
patch
Log custom offer activity V3
patch
🔒 Create offer line item V3
post
🔒 View offer line item V3
get
Delete offer line item V3
del
🔒 Update offer line item V3
patch
🔒 Attach a file to an offer V3
post
🔒 Delete a file attached to an offer V3
del
🔒 Update a file attached to an offer V3
patch
🔒 View offer V3
get
DeliveryNote
Release delivery note V3
patch
Log custom delivery note activity V3
patch
🔒 Cancel delivery note V3
patch
🔒 Attach a file to a delivery note V3
post
🔒 Delete a file attached to a delivery note V3
del
🔒 Update a file attached to a delivery note V3
patch
🔒 Delete delivery note V3
del
Delete delivery note line item V3
del
🔒 List delivery notes V3
get
🔒 View delivery note V3
get
🔒 View delivery note line item V3
get
🔒 Update delivery note V3
patch
🔒 Update delivery note line item V3
patch
🔒 Create delivery note V3
post
🔒 Create delivery note line item V3
post
SalesPrice
🔒 Update multiple sales prices V3
patch
Delete sales price V3
del
🔒 Create sales price V3
post
🔒 List sales prices V3
get
🔒 View sales price V3
get
CreditNote
🔒 List credit notes V3
get
🔒 Create credit note V3
post
🔒 View a single credit note V3
get
🔒 Delete credit note V3
del
🔒 Update credit note V3
patch
🔒 Release credit note V3
patch
🔒 Create credit note line item V3
post
🔒 View credit note line item V3
get
🔒 Delete credit note line item V3
del
🔒 Update credit note line item V3
patch
Log custom credit note activity V3
patch
🔒 Attach a file to a credit note V3
post
🔒 Delete a file attached to a credit note V3
del
🔒 Update a file attached to a credit note V3
patch
ProformaInvoice
🔒 List proforma invoices V3
get
🔒 View a single proforma invoice V3
get
Delete proforma invoice V3
del
🔒 Release proforma invoice V3
patch
🔒 Create proforma invoice line item V3
post
🔒 View proforma invoice line item V3
get
🔒 Delete proforma invoice line item V3
del
🔒 Update proforma invoice line item V3
patch
🔒 Create proforma invoice V3
post
🔒 Update proforma invoice V3
patch
Log custom proforma invoice activity V3
patch
🔒 Attach a file to a proforma invoice V3
post
🔒 Delete a file attached to a proforma invoice V3
del
🔒 Update a file attached to a proforma invoice V3
patch
ReturnOrder
🔒 List return orders V3
get
🔒 View return order V3
get
🔒 Delete return order V3
del
🔒 Cancel return order V3
patch
🔒 Release return order V3
patch
🔒 Create return order V3
post
🔒 Update return order V3
patch
🔒 Create return order line item V3
post
🔒 View return order line item V3
get
Delete return order line item V3
del
🔒 Update return order line item V3
patch
Log custom return order activity V3
patch
🔒 Attach a file to a return order V3
post
🔒 Delete a file attached to a return order V3
del
🔒 Update a file attached to a return order V3
patch
Customer
🔒 Create customer V3
post
🔒 View a single customer V3
get
Customer Contact Person
🔒 List contact persons V3
get
🔒 Create contact person V3
post
Customer Delivery Address
🔒 Paginated list of delivery addresses for a customer V3
get
ServiceOrder
🔒 Attach a file to a service order V3
post
🔒 Delete a file attached to a service order V3
del
🔒 Update a file attached to a service order V3
patch
PriceInquiry
🔒 Attach a file to a price inquiry V3
post
🔒 Delete a file attached to a price inquiry V3
del
🔒 Update a file attached to a price inquiry V3
patch
PurchaseOrder
🔒 Attach a file to a purchase order V3
post
🔒 Delete a file attached to a purchase order V3
del
🔒 Update a file attached to a purchase order V3
patch
Production
Log custom production activity V3
patch
🔒 Attach a file to a production V3
post
🔒 Delete a file attached to a production V3
del
🔒 Update a file attached to a production V3
patch
Delete production V3
del
🔒 List productions V3
get
🔒 View production V3
get
Release production V3
patch
Start production V3
patch
🔒 Create production V3
post
Carrier Integration Service Contract
Carrier Integration Service Contract
Check the liveness of the service
get
Get available carriers
get
Create shipment
post
Get shipment
get
Cancel shipment
del
Xentral Business Documents API v3
Customer Delivery Address
🔒 Create delivery address V3
post
PurchaseOrder
🔒 List purchase orders V3
get
🔒 Create purchase order V3
post
🔒 View purchase order V3
get
🔒 Delete purchase order V3
del
🔒 Update purchase order V3
patch
🔒 Log custom purchase order activity V3
patch
🔒 Release purchase order V3
patch
🔒 Create purchase order line item V3
post
🔒 View purchase order line item V3
get
🔒 Delete purchase order line item V3
del
🔒 Update purchase order line item V3
patch
Powered by
Testing the APIs
