Articles in this section

Available Xentral APIs

When you configure an export, import, or other type of flow step using the prebuilt Xentral connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Xentral API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Accounting export

Execute the accounting CSV export for invoices and credit notes

 

X

Execute the accounting CSV export for liabilities

 

X

Execute the accounting CSV export for account transactions

 

X

Execute the accounting XML export for invoices

 

X

Execute the accounting XML export for credit notes

 

X

Execute the accounting XML export for liabilities

 

X

Check the export status

X

 

Download a generated export file

X

 

Collection

Get list of collections

X

 

Create collection

 

X

Get a collection

X

 

Update a collection

 

X

Delete a collection

 

X

Credit

Get credit information

X

 

Credit note

Create credit note

 

X

List credit notes

X

 

View credit note

X

 

Delete single credit note

 

X

Update single credit note

 

X

View credit note balance

X

 

View related documents for credit note

X

 

Credit note tag

List credit notes tags

X

 

Customer

Delete customer

 

X

List customers

X

 

Create customer

 

X

View customer

X

 

Update customer

 

X

Customer address

Create address

 

X

List addresses

X

 

View address

X

 

Update address

 

X

Delete address

 

X

Customer contact person

List contact persons

X

 

Create contact person

 

X

Update contact person

 

X

Delete contact person

 

X

View contact person

X

 

Delivery

List deliveries

X

 

View delivery aka shipment

X

 

View shipment aka delivery

X

 

Delivery note

Delivery note list

X

 

View delivery note

X

 

View delivery note deliveries aka shipments

X

 

View delivery note shipments aka deliveries

X

 

Delivery note tag

List delivery notes tags

X

 

Delivery terms

List delivery terms

X

 

Documentation

Get list of documentation

X

 

Employee

List employees

X

 

External reference

List external references for given product

X

 

Create new external references for a given product

 

X

Update external references for a given product

 

X

Delete external references of a given product

 

X

External reference target

List external reference targets

X

 

Goods receipt

Create a new goods receipt for a purchase order

 

X

Goods receipt

Create a new goods receipt for a return

 

X

Invoice

Create invoice

 

X

List invoices

X

 

View invoice

X

 

Delete single invoice

 

X

Update single invoice

 

X

View invoice balance

X

 

View related documents for invoice

X

 

Create Positions for invoice

 

X

Delete Position from invoice

 

X

Send invoice

 

X

Update status for single invoice

 

X

Invoice tag

List invoice tags

X

 

Liability

Create liability

 

X

List liabilities

X

 

Create recurring liability

 

X

View liability

X

 

Add a liability document to an existing liability

 

X

Matrix product

View options of a product

X

 

Creates new option for a product

 

X

Update multiple options of a product

 

X

Deletes multiple options of a product

 

X

Updates a single option of a matrix product

 

X

View a single value from an option of a matrix product

X

 

Updates a single value from an option of a matrix product

 

X

Deletes a single value from an option of a matrix product

 

X

Lists all values from an option of a matrix product

X

 

Deletes multiple values from an option of a matrix product

 

X

Creates multiple values for an option of a matrix product

 

X

Payment methods

Payment method list

X

 

Payment terms group

Get a list of payment terms groups

X

 

Create a new payment terms group

 

X

Get a single payment terms group

X

 

Payment transaction

View a single payment transaction

X

 

Early access] update status for single payment transaction

 

X

Point of sale

Cashier list

X

 

Cashier pin check

 

X

Cash register balance

X

 

Journals list

X

 

Add journal entry

 

X

Add cash count entry

 

X

Add QR code data to a document

 

X

Product

Create new product

 

X

List products

X

 

Update multiple products

 

X

Delete multiple products

 

X

View product

X

 

Update product

 

X

Delete product

 

X

View media

X

 

View purchase prices

X

 

View sales prices

X

 

View purchase orders POSitions

X

 

View sales orders POSitions

X

 

View productions POSitions

X

 

View properties

X

 

Update properties

 

X

View reservations

X

 

View parts

X

 

Create new parts for product

 

X

Update parts of a product

 

X

Deletes parts of a product

 

X

View storage locations

X

 

List cross selling of a product

X

 

Create new cross selling for a product

 

X

Update cross selling of a product

 

X

Delete cross selling of a product

 

X

Creates variants for a matrix product

 

X

List products

X

 

Product category

Lists available products categories

X

 

Create new product category

 

X

View a single product category

X

 

Update a single product category

 

X

Delete a single product category

 

X

Product free field

List of information about product free fields from company settings

X

 

Update information of multiple product free fields from company settings

 

X

View information about a single product free field from company settings

X

 

Update information about a single product free field from company settings

 

X

Product label

Print product label

 

X

Download product label as PDF

X

 

Product media

Create product media

 

X

Update multiple product media

 

X

Delete multiple product media

 

X

List product media

X

 

View product media

X

 

Create product media version

 

X

View product media version

X

 

Updates product media version

 

X

Delete product media version

 

X

Product merchandise group

Lists available products merchandise groups

X

 

Create new product merchandise group

 

X

View a single product merchandise group

X

 

Update a single product merchandise group

 

X

Delete a single product merchandise group

 

X

Product property

Create products properties

 

X

List products properties

X

 

Update multiple products properties

 

X

Delete multiple products properties

 

X

Product tag

List products tags

X

 

Create new product tag

 

X

Update a single product tag

 

X

Production

List productions

X

 

View production

X

 

Project

List projects

X

 

Project

List POS settings for project

X

 

Provisional return

List provisional returns

X

 

Purchase order

Lists available purchase orders

X

 

Create new purchase order

 

X

View a single purchase order

X

 

Update existing purchase order

 

X

Cancels a purchase order

 

X

Releases a purchase order

 

X

Purchase price

Create purchase price

 

X

List purchase prices

X

 

Update multiple purchase prices

 

X

View purchase price

X

 

Update purchase price

 

X

Delete purchase price

 

X

Query

Execute a query synchronously

 

X

Create query export

 

X

List recent query exports

X

 

List query export by ID

X

 

Report

Get list of reports

X

 

Create report

 

X

Get report by ID

X

 

Update a report

 

X

Delete a report

 

X

List all recent report exports

X

 

Create report export

 

X

Execute a query synchronously

 

X

List permalink for report

X

 

Create permalink for report

 

X

Invalidate permalink for report

 

X

Download report via permalink

X

 

List schedules for report

X

 

Create schedule for report

 

X

Delete schedule for report

 

X

Report usage

Get report usage

X

 

Reporting settings

Get settings

X

 

Update settings

 

X

Return

Create a return

 

X

List returns

X

 

View return

X

 

Create return document

 

X

Update multiple return documents

 

X

Delete multiple return documents

 

X

View return document list

X

 

View return document

X

 

Release a return

 

X

Return reason

List of return reasons

X

 

Sales channel

List all sales channels

X

 

Sales channels product settings

Creates sales channel settings for a single product

 

X

Deletes sales channel settings for a single product

 

X

Updates sales channel settings for a single product

 

X

Sales order

List sales orders

X

 

Import sales order

 

X

Dispatch a released sales order

 

X

Cancel a sales order

 

X

View sales order

X

 

Update existing sales order

 

X

Delete draft sales order

 

X

Create sales order document

 

X

Update multiple sales order documents

 

X

Delete multiple sales order documents

 

X

View sales order document list

X

 

View sales order document

X

 

Sales price

Create sales price

 

X

List sales prices

X

 

Update multiple sales prices

 

X

View sales price

X

 

Update sales price

 

X

Delete sales price

 

X

Setting

List address custom fields

X

 

Create address custom field configuration

 

X

Shipping methods

List shipping methods

X

 

Create shipping method

 

X

View shipping method

X

 

Update shipping method

 

X

Stock movement types

Create a stock movement type

 

X

Storage item

Storage item list

X

 

Add item to storage location

 

X

Retrieves item from storage location

 

X

Storage location

Storage location list

X

 

Supplier

List suppliers

X

 

Update multiple suppliers tags

 

X

View supplier

X

 

Update single supplier tags

 

X

Delete supplier

 

X

Supplier tag

List suppliers tags

X

 

Tax rate

List tax rates

X

 

User

Create user

 

X

List users

X

 

View user

X

 

Update user

 

X

Delete single user

 

X

View user's permissions

X

 

Request reset password email

 

X

Warehouse

Warehouse list

X

 

Webhook

Create a webhook

 

X

List webhooks

X

 

View a webhook

X

 

Update a webhook

 

X

Delete a webhook

 

X

List webhook event types

X