Jump to Content
API Reference
Home
Guides
API Reference
Roadmap
v25.14
v25.15
v25.16
v25.17
API Reference
API Reference
Moon (Dark Mode)
Sun (Light Mode)
25.16.5
Home
Guides
API Reference
Roadmap
Delete customer
Search
JUMP TO
Xentral API
Introduction
Authentication
Rate Limiting
Media types & variants
Versioning
Filtering, Ordering, & Pagination
Testing the APIs
Feedback?
Xentral API
Accounting API
Accounting Export
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
Check the export status
get
Download a generated export file
get
Credit
Get credit information
get
Credit Note
Create credit note
post
List credit notes
get
View credit note
get
Delete single credit note
delete
Update single credit note
patch
View Credit Note Balance
get
View related documents for credit note
get
Credit Note Tag
List Credit Notes tags
get
Invoice
Create invoice
post
List invoices
get
View invoice
get
Delete single invoice
delete
Update single invoice
patch
View Invoice Balance
get
View related documents for invoice
get
Create Positions for Invoice
post
Delete Position from Invoice
delete
Send invoice
patch
Update status for single invoice
patch
Invoice Tag
List Invoice tags
get
Liability
Create liability
post
List Liabilities
get
Create recurring liability
post
View liability
get
Add a liability document to an existing liability
post
Payment Methods
Payment method list
get
Payment Terms Group
Get a list of paymentTermsGroups
get
Create a new paymentTermsGroup
post
Get a single paymentTermsGroup
get
Payment Transaction
View a single payment transaction
get
[EARLY ACCESS] Update status for single Payment Transaction
patch
Point Of Sale
Cashier list
get
Cashier PIN check
post
Cash Register balance
get
Journals list
get
Add journal entry
post
Add cash count entry
post
Add qr code data to a document
post
Tax Rate
List tax rates
get
Analytics API
Collection
Get list of collections
get
Create collection
post
Get a collection
get
Update a collection
patch
Delete a collection
delete
Documentation
Get list of documentation
get
Query
Execute a query synchronously
post
Create query export
post
List recent query exports
get
List query export by ID
get
Report
Get list of reports.
get
Create report
post
Get report by ID
get
Update a report
patch
Delete a report
delete
List all recent report exports
get
Create report export
post
Execute a query synchronously
post
List permalink for report
get
Create permalink for report
post
Invalidate permalink for report
delete
Download report via permalink
get
List schedules for report
get
Create schedule for report
post
Delete schedule for report
delete
Report Usage
Get report usage
get
Reporting Settings
Get settings
get
Update settings
patch
Core API
Project
List projects
get
List POS settings for project
get
Webhook
Create a webhook
post
List webhooks
get
View a webhook
get
Update a webhook
patch
Delete a webhook.
delete
List webhook event types
get
CRM API
Customer
Delete customer
delete
List customers
get
List addresses
get
Create customer
post
View customer
get
Update customer
patch
Customer Address
Create address
post
View address
get
Update address
patch
Delete address
delete
Customer - Contact Person
List contact persons
get
Create contact person
post
Update contact person
patch
Delete contact person
delete
View contact person
get
Employee
List employees
get
Supplier
List suppliers
get
Update multiple suppliers tags
patch
View supplier
get
Update single Supplier tags
patch
Delete supplier
delete
Supplier Tag
List suppliers tags
get
User
Create user
post
List users
get
View user
get
Update user
patch
Delete single user
delete
View user's permissions
get
Request reset password email
post
Fulfillment API
Delivery Note
Delivery note list
get
View delivery note
get
View delivery note deliveries aka shipments
get
View delivery note shipments aka deliveries
get
Delivery Note Tag
List delivery notes tags
get
Delivery
List deliveries
get
View delivery aka shipment
get
View shipment aka delivery
get
Delivery Terms
List Delivery Terms
get
Goods Receipt
Create a new goods receipt for a purchase order
post
Create a new goods receipt for a return
post
Production
List Productions
get
View Production
get
Provisional Return
List provisional returns
get
Purchase Order
Lists available purchase orders
get
Create new purchase order
post
View a single purchase order
get
Update existing purchase order
patch
Cancels a purchase order
patch
Releases a purchase order
patch
Return
Create a return
post
List returns
get
View return
get
Create return document
post
Update multiple return documents
patch
Delete multiple return documents
delete
View return document list
get
View return document
get
Release a return
post
Return Reason
List of return reasons
get
Sales Order
List sales orders
get
Import sales order
post
Dispatch a released sales order
post
Cancel a sales order
post
View sales order
get
Update existing sales order
patch
Delete draft sales order
delete
Create sales order document
post
Update multiple sales order documents
patch
Delete multiple sales order documents
delete
View sales order document list
get
View sales order document
get
Shipping Methods
List shipping methods
get
Create Shipping Method
post
View Shipping Method
get
Update Shipping Method
put
Stock Movement Types
Create a stockMovementType
post
Storage Location
Storage location list
get
Storage Item
Storage item list
get
Add item to Storage Location
post
Retrieves item from Storage Location
patch
Warehouse
Warehouse list
get
Products API
External Reference
List external references for given Product
get
Create new external references for a given Product
post
Update external references for a given Product
patch
Delete external references of a given Product
delete
External Reference Target
List External Reference Targets
get
Matrixproduct
Updates a single option of a matrix product.
patch
View a single value from an option of a matrix product.
get
Updates a single value from an option of a matrix product.
patch
Lists all values from an option of a matrix product.
get
Creates multiple values for an option of a matrix product.
post
Product
Create new product
post
View options of a product
get
List products
get
Creates new option for a product
post
Update multiple products
patch
Update multiple options of a product
patch
Delete multiple products
delete
Deletes multiple options of a product
delete
View product
get
Update product
patch
Delete product
delete
View media
get
Deletes a single value from an option of a matrix product.
delete
View purchase prices
get
View sales prices
get
Deletes multiple values from an option of a matrix product.
delete
View purchase orders positions
get
View sales orders positions
get
View productions positions
get
View properties
get
Update properties
patch
View reservations
get
View parts
get
Create new parts for product
post
Update parts of a product
patch
Deletes parts of a product
delete
View storage locations
get
List cross selling of a product
get
Create new cross selling for a product
post
Update cross selling of a product
patch
Delete cross selling of a product
delete
Creates variants for a matrix product
post
List products
get
Product Category
Lists available products categories
get
Create new product category
post
View a single product category
get
Update a single product category
patch
Delete a single product category
delete
Product Free Field
list of information about product free fields from company settings
get
update information of multiple product free fields from company settings
patch
view information about a single product free field from company settings
get
update information about a single product free field from company settings
patch
Product Media
Create product media
post
Update multiple product media
patch
Delete multiple product media
delete
List product media
get
View product media
get
Create product media version
post
View product media version
get
Updates product media version
patch
Delete product media version
delete
Product Tag
List products tags
get
Create new product tag
post
Update a single product tag
patch
Product Property
Create products properties
post
List products properties
get
Update multiple products properties
patch
Delete multiple products properties
delete
Product Merchandise Group
Lists available products merchandise groups
get
Create new product merchandise group
post
View a single product merchandise group
get
Update a single product merchandise group
patch
Delete a single product merchandise group
delete
Purchase Price
Create purchase price
post
List purchase prices
get
Update multiple purchase prices
patch
View purchase price
get
Update purchase price
patch
Delete purchase price
delete
Sales Channels Product Settings
Creates sales channel settings for a single product.
post
Deletes sales channel settings for a single product.
delete
Updates sales channel settings for a single product.
patch
Sales Price
Create sales price
post
List sales prices
get
Update multiple sales prices
patch
View sales price
get
Update sales price
patch
Delete sales price
delete
Product Label
Print product label
post
Download product label as pdf
get
Sales Channel
List all sales channels
get
Setting
List address custom fields
get
Create address custom field configuration
post
Events
Webhooks [BETA]
Legacy APIs
Standard API
REST API
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
delete
Delete customer
delete
https://{xentralId}.xentral.biz/api/v1/customers/
{id}
Delete existing customer
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
Bearer
URL
Base URL
https://
xentral
.xentral.biz
/api/v1/customers/{id}
RESPONSE
Click
Try It!
to start a request and see the response here!