# xentral developer portal Documentation
> Documentation for xentral developer portal
## Guides
- [Create a sales order](https://developer.xentral.com/docs/create-sales-order-xentral-api-guide.md)
- [Create a customer (V2 API)](https://developer.xentral.com/docs/create-a-customer-v2-api.md)
- [Create a product (V2 API)](https://developer.xentral.com/docs/create-a-product-v2-api.md)
- [Read stock](https://developer.xentral.com/docs/read-stock.md)
- [Update stock](https://developer.xentral.com/docs/update-stock.md)
- [Fulfillment](https://developer.xentral.com/docs/fulfillment.md): From dispatched sales order to shipment
- [Returns & Credit Notes](https://developer.xentral.com/docs/returns-credit-notes.md)
- [Fiscal Integration (External Partner)](https://developer.xentral.com/docs/pos-fiscal-integration-external-partner.md)
- [Terminal Integration (Credit Debit Card Terminal)](https://developer.xentral.com/docs/pos-terminal-integration-guide-credit-debit-card-terminal.md)
- [🚚 Carrier Integration](https://developer.xentral.com/docs/carrier-integration.md)
- [1. Registering the carrier service (setup)](https://developer.xentral.com/docs/setting-up-a-carrier.md)
- [2. Label creation requests](https://developer.xentral.com/docs/creating-a-label.md)
- [3. Making your service production ready](https://developer.xentral.com/docs/3-making-your-service-production-ready.md): How an end user can setup a Carrier Integration as shipping method
- [FAQ](https://developer.xentral.com/docs/faq.md)
- [Example service](https://developer.xentral.com/docs/example-service.md): An example Carrier Integration Service in NextJS
## API Reference
- [Introduction](https://developer.xentral.com/reference/intro.md): This page will help you get started with the Xentral API.
- [Authentication](https://developer.xentral.com/reference/authentication.md)
- [Rate Limiting](https://developer.xentral.com/reference/rate-limiting.md)
- [Media types & variants](https://developer.xentral.com/reference/variants.md)
- [PDF Documents](https://developer.xentral.com/reference/pdf-documents.md)
- [Versioning](https://developer.xentral.com/reference/versioning.md)
- [V1 and V2 Filtering, Ordering, & Pagination](https://developer.xentral.com/reference/filtering-sorting-pagination.md)
- [V3 Filtering, Ordering & Pagination](https://developer.xentral.com/reference/v3-filterung-ordering-pagination.md)
- [Testing the APIs](https://developer.xentral.com/reference/e.md)
- [Feedback?](https://developer.xentral.com/reference/feedback.md)
- [Check accounting export status](https://developer.xentral.com/reference/accountingdatevdownloadstatus.md): Check the accounting export status.
- [Download accounting export](https://developer.xentral.com/reference/accountingdatevdownload.md): Returns a generated export file from the accounting export.
- [Execute the accounting CSV export for invoices and credit notes](https://developer.xentral.com/reference/accountingdatevcsvexportinvoicesandcreditnotes.md): Execute the accounting CSV export for invoices and credit notes.
- [Execute the accounting CSV export for liabilities](https://developer.xentral.com/reference/accountingdatevcsvexportliabilities.md): Execute the accounting CSV export for liabilities.
- [Execute the accounting CSV export for account transactions](https://developer.xentral.com/reference/accountingdatevcsvexportaccounttransactions.md): Execute the accounting CSV export for account transactions.
- [Execute the accounting XML export for invoices](https://developer.xentral.com/reference/accountingdatevxmlexportinvoices.md): Execute the accounting XML export for invoices.
- [Execute the accounting XML export for credit notes](https://developer.xentral.com/reference/accountingdatevxmlexportcreditnotes.md): Execute the accounting XML export for credit notes.
- [Execute the accounting XML export for liabilities](https://developer.xentral.com/reference/accountingdatevxmlexportliabilities.md): Execute the accounting XML export for liabilities.
- [Create payment service provider transactions](https://developer.xentral.com/reference/paymentserviceprovidertransactioncreatev1.md): Creates one or more transactions for a specific payment service provider.
- [List payment service provider transactions](https://developer.xentral.com/reference/paymentserviceprovidertransactionlistv1.md): Returns a collection of transactions for a specific payment service provider.
- [List payment methods](https://developer.xentral.com/reference/paymentmethodlist.md): Lists all payment methods.
- [Create payment terms group](https://developer.xentral.com/reference/paymenttermsgroupcreate.md): This endpoint is only available as early access version and will introduce breaking changes without further notice or versioning. PaymentTermsGroups can be used to group customers with identical payment terms such as different discounts, payment targets, and free postage options. For more details about the group feature have a look at our handbook article.
- [List payment terms groups](https://developer.xentral.com/reference/paymenttermsgrouplist.md): This endpoint is only available as early access version and will introduce breaking changes without further notice or versioning. PaymentTermsGroups can be used to group customers with identical payment terms such as different discounts, payment targets, and free postage options. For more details about the group feature have a look at our handbook article.
- [View payment terms group](https://developer.xentral.com/reference/paymenttermsgroupview.md): This endpoint is only available as early access version and will introduce breaking changes without further notice or versioning. PaymentTermsGroups can be used to group customers with identical payment terms such as different discounts, payment targets, and free postage options. For more details about the group feature have a look at our handbook article.
- [View payment transaction](https://developer.xentral.com/reference/paymenttransactionview.md): Returns details of a single payment transaction
- [Update payment transaction status](https://developer.xentral.com/reference/paymenttransactionstatus.md): Update status for single Payment Transaction
- [🔒 Create tax](https://developer.xentral.com/reference/taxcreatev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Creates a single tax entry.
- [🔒 List Tax Entries](https://developer.xentral.com/reference/taxlistv1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Retrieves a list of tax entries.
- [🔒 Get Tax Entry by ID](https://developer.xentral.com/reference/taxgetv1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Retrieves a specific tax entry by its ID.
- [🔒 Update tax](https://developer.xentral.com/reference/taxupdatev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Updates a single tax entry.
- [List tax rates](https://developer.xentral.com/reference/taxratelist.md): This endpoint returns the tax rate for a given country code. The country code is a two-letter ISO 3166-1 alpha-2 code. The response is a list of applicable tax rates for the given country code. To get a more granular response you can use the query parameters to filter the response, for example by product or project. The applicable tax rate is determined in the following order: 1. If a custom tax rate is defined for the product, it is returned. 2. If a tax rate is defined in the taxRates module for that country, it is returned. 3. If a tax rate is defined in the taxRates module for the project, or a generic tax Rate without country or project it is returned. 4. If a tax rate is defined for the applicable project it is returned. 5. If a tax rate is defined for the system it is returned. 6. If no tax rate is defined anywhere we will return an empty list. To see which step was used to determine the tax rate, the source field is returned in the response.
- [🔒 Create tax type](https://developer.xentral.com/reference/taxtypecreatev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Creates a single tax type.
- [🔒 List Tax Type Entries](https://developer.xentral.com/reference/taxtypelistv1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Retrieves a list of tax type entries.
- [🔒 Get Tax Type Entry by ID](https://developer.xentral.com/reference/taxtypegetv1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Retrieves a specific tax type entry by its ID.
- [🔒 Update tax type](https://developer.xentral.com/reference/taxtypeupdatev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Updates a single tax type.
- [🔒 Delete Tax Type Entry by ID](https://developer.xentral.com/reference/taxtypedeletev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Deletes a specific tax type entry by its ID.
- [🔒 List Tax Type Mapping Entries with Extended Detail](https://developer.xentral.com/reference/taxtypemappingextendeddetaillistv1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Retrieves a list of tax type mapping entries with preloaded related objects.
- [🔒 Get Tax Type Mapping Entry with Extended Detail by ID](https://developer.xentral.com/reference/taxtypemappingextendeddetailviewv1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Retrieves a specific tax type mapping entry by its ID with preloaded related objects.
- [🔒 Create tax obligation](https://developer.xentral.com/reference/taxobligationcreatev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Creates a single tax obligation.
- [🔒 List Tax Obligation Entries](https://developer.xentral.com/reference/taxobligationlistv1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Retrieves a list of tax obligations entries.
- [🔒 Create account](https://developer.xentral.com/reference/accountcreatev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Creates a single account.
- [🔒 List Account Entries](https://developer.xentral.com/reference/accountlistv1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. List account entries
- [🔒 Get Account Entry by ID](https://developer.xentral.com/reference/accountgetv1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Retrieves a specific account entry by its ID.
- [🔒 Update account](https://developer.xentral.com/reference/accountupdatev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Updates a single account.
- [🔒 Delete Account Entry by ID](https://developer.xentral.com/reference/accountdeletev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Deletes a specific account entry by its ID.
- [🔒 Create revenue account mapping](https://developer.xentral.com/reference/revenueaccountmappingcreatev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Create revenue account mapping
- [🔒 List Revenue Account Mapping Entries](https://developer.xentral.com/reference/revenueaccountmappinglistv1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. List revenue account mapping entries
- [🔒 Get Revenue Account Mapping Entry by ID](https://developer.xentral.com/reference/revenueaccountmappinggetv1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Retrieves a specific revenue account mapping entry by its ID.
- [🔒 Update revenue account mapping](https://developer.xentral.com/reference/revenueaccountmappingupdatev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Updates a single revenue account mapping.
- [🔒 Delete Revenue Account Mapping Entry by ID](https://developer.xentral.com/reference/revenueaccountmappingdeletev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Deletes a specific revenue account mapping entry by its ID.
- [🔒 Create tax account mapping](https://developer.xentral.com/reference/taxaccountmappingcreatev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Creates a single tax account mapping.
- [🔒 List Tax Account Mapping Entries](https://developer.xentral.com/reference/taxaccountmappinglistv1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Retrieves a list of tax account mapping entries.
- [🔒 Get Tax Account Mapping Entry by ID](https://developer.xentral.com/reference/taxaccountmappinggetv1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Retrieves a specific tax account mapping entry by its ID.
- [🔒 Update tax account mapping](https://developer.xentral.com/reference/taxaccountmappingupdatev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Updates a single tax account mapping.
- [🔒 Delete Tax Account Mapping Entry by ID](https://developer.xentral.com/reference/taxaccountmappingdeletev1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Deletes a specific tax account mapping entry by its ID.
- [🔒 List General Ledger Entries](https://developer.xentral.com/reference/generalledgerlist.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. List general ledger entries
- [🔒 List General Ledger Entries With Aggregated Document](https://developer.xentral.com/reference/generalledgerlistwithaggregateddocument.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. List general ledger entries with aggregated document
- [🔒 List General Ledger Entries With Aggregated Account](https://developer.xentral.com/reference/generalledgerlistwithaggregatedaccount.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. List general ledger entries with aggregated account
- [🔒 List General Ledger Entries With Aggregated Line Item](https://developer.xentral.com/reference/generalledgerlistwithaggregatedlineitem.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. List general ledger entries with aggregated line item
- [🔒 Get General Ledger Entry by ID](https://developer.xentral.com/reference/generalledgergetv1.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. Get general ledger entry by ID
- [Create address free field](https://developer.xentral.com/reference/settingsmasterdataaddresscustomfieldscreatev1.md): Creates a address custom field configuration.
- [List address free fields](https://developer.xentral.com/reference/settingsmasterdataaddresscustomfieldslistv2.md): Fetches all configured address custom fields. Pagination is not necessary because of limit of such fields (20).
- [List text templates](https://developer.xentral.com/reference/settingstext-templatesv2.md): Show all receipt related text template settings
- [Update text templates](https://developer.xentral.com/reference/settingstext-templatesv2update.md): Update one or more text template settings
- [Create print job](https://developer.xentral.com/reference/printjobscreate.md): Create a new print job.
- [List sales channels V2](https://developer.xentral.com/reference/saleschannellistv2.md): Returns a collection with all sales channels.
- [Exchange subject token for platform access token](https://developer.xentral.com/reference/auth-platformexchangetoken.md): Request body for token exchange
- [List files for a document](https://developer.xentral.com/reference/fileslist.md): Returns a collection with all files for a document.
- [View file of a document by id](https://developer.xentral.com/reference/filesview.md): Returns details of a single file. If you want to access the file itself please use accept-header `application/vnd.xentral.file`.
- [List projects](https://developer.xentral.com/reference/projectlist.md): Returns a collection of projects
- [List POS settings for project](https://developer.xentral.com/reference/projectpossettings.md): Returns a list of POS settings of a project
- [Create user](https://developer.xentral.com/reference/usercreate.md): Creates a new user using one of the available operations
- [List users V2](https://developer.xentral.com/reference/userlistv2.md): Returns a collection with all users.
- [View user](https://developer.xentral.com/reference/userview.md): Returns details of a single user
- [Update user](https://developer.xentral.com/reference/userupdate.md): Update a set of changes of an user.
Warning: Multiple request body content types
Due to technical limitations, the information provided here may not display all available request body content types. We are currently working with our third-party documentation provider to address this issue. For a complete and accurate representation of the available content types, we recommend referring to the full OpenAPI specification.
We apologize for any inconvenience caused and appreciate your understanding as we work to resolve this matter.
Available request content types:
- application/json
- application/vnd.xentral.password+json
- application/vnd.xentral.mfa+json
- [Delete user](https://developer.xentral.com/reference/userdelete.md): Deletes a single user resource identified by its URI
- [List user permissions](https://developer.xentral.com/reference/userpermissionview.md): Returns all permissions of an user.
- [Download user permissions](https://developer.xentral.com/reference/useractionsdownloadpermissions.md): Returns user permissions in a downloadable format with German field names preserved.
- [Request reset password email](https://developer.xentral.com/reference/userreset-password.md): Request reset password email
- [Create webhook](https://developer.xentral.com/reference/webhookcreate.md): Creates a new webhook.
- [List webhooks](https://developer.xentral.com/reference/webhooklist.md): List webhooks.
- [View webhook](https://developer.xentral.com/reference/webhookview.md): View a webhook.
- [Update webhook](https://developer.xentral.com/reference/webhookupdate.md): Update a webhook.
- [Delete webhook](https://developer.xentral.com/reference/webhookdelete.md): Delete a webhook
- [List webhook event types](https://developer.xentral.com/reference/webhookeventtypeslist.md): List webhooks event types.
- [List tags](https://developer.xentral.com/reference/taglist.md): Lists all tags
- [Create a new tag](https://developer.xentral.com/reference/tagcreateaction.md): Creates a new tag.
- [Delete tags](https://developer.xentral.com/reference/tagdeletemultiple.md): Deletes tags
- [Update multiple tags](https://developer.xentral.com/reference/tagupdatemultiple.md): Update multiple tags
- [Assign tags to multiple resources](https://developer.xentral.com/reference/tagbulkassign.md): Bulk assigns tags to multiple resources
- [Remove tags from multiple resources](https://developer.xentral.com/reference/tagbulkremove.md): Bulk removes tags from multiple resources
- [Get report usage](https://developer.xentral.com/reference/analyticsreportusageget.md): Get report usage which shows the history of chargeable requests made within the given timeframe
- [Get settings](https://developer.xentral.com/reference/analyticssettingsget.md): Returns current settings or default settings if none exist
- [Update reporting settings](https://developer.xentral.com/reference/analyticssettingsupdate.md): Updates the current settings
- [Get credit information](https://developer.xentral.com/reference/analyticscreditget.md): Get credit information regarding Report module usage.
- [Create collection](https://developer.xentral.com/reference/analyticscollectioncreate.md): Creates a new collection and returns the new record
- [List collections](https://developer.xentral.com/reference/analyticscollectionget.md): Returns a list of report collections (official Xentral collections and custom collections).
- [View collection](https://developer.xentral.com/reference/analyticscollectionlist.md): Returns a single collections by ID.
- [Update collection](https://developer.xentral.com/reference/analyticscollectionupdate.md): Updates an existing collection specified by its ID and returns the new record
- [Delete collection](https://developer.xentral.com/reference/analyticscollectiondelete.md): Deletes an existing collection specified by its ID and returns the deleted record
- [List documentations](https://developer.xentral.com/reference/analyticsdocumentationlist.md): Returns a list of table documentation for each queryable table in the report builder
- [Execute query](https://developer.xentral.com/reference/analyticsquery.md): Execute a query synchronously on the Analytics platform and get result table (Redshift dialect). The number of records that you receive as results is limited to a reasonable amount. This endpoint is mainly for viewing the data. Use the export endpoints in order to fetch all results.
- [Create query export](https://developer.xentral.com/reference/analyticsqueryexportcreate.md): Create a query export. This starts a query execution. The query will be executed asynchronously. You can check the status of the query using the `GET /api/analytics/query/export/{uuid}` endpoint.
- [List query exports](https://developer.xentral.com/reference/analyticsqueryexportlist.md): Get a list of recent query exports and their status. Possible statuses are `success`, `failed`, `running` and `pending`. If status is success, then we also show the download link.
- [View query export](https://developer.xentral.com/reference/analyticsqueryexportgetbyid.md): Get specific query export by ID which (if completed successfully) contains a download link to a file in CSV format
- [Create report](https://developer.xentral.com/reference/analyticsreportcreate.md): Creates a new report and returns the new record
- [List reports](https://developer.xentral.com/reference/analyticsreportlist.md): Returns a list of reports (official Xentral reports and custom reports)
- [View report](https://developer.xentral.com/reference/analyticsreportget.md): Returns a single report by ID
- [Update report](https://developer.xentral.com/reference/analyticsreportupdate.md): Updates an existing report specified by its ID and returns the new record
- [Delete report](https://developer.xentral.com/reference/analyticsreportdelete.md): Deletes an existing report specified by its ID and returns the deleted record
- [Create report export](https://developer.xentral.com/reference/analyticsreportexportcreate.md): Create an export for given report based on the SQL statement that is stored with the report. You can overwrite the stored query parameters by passing new parameters in the request body
- [List report exports](https://developer.xentral.com/reference/analyticsreportexportlist.md): List all exports for that report. Possible statuses are `success`, `failed`, `running` and `pending`. If status is success, then we also show the download link.
- [View report export](https://developer.xentral.com/reference/analyticsreportexportgetbyid.md): Get specific report export by ID which (if completed successfully) contains a download link to a file in CSV format
- [Execute report query](https://developer.xentral.com/reference/analyticsreportquery.md): Execute a stored report query synchronously and get result table. The number of records that you receive as results is limited to a reasonable amount (currently 5000 records). This endpoint is mainly for viewing the data. Use the export endpoints in order to fetch all results.
- [Create report permalink](https://developer.xentral.com/reference/analyticsreportpermalinkcreate.md): Create permanent download link for report. You can only have one valid permalink enabled at a time for each report. Creating a new one will invalidate all existing permalinks.
- [List report permalink](https://developer.xentral.com/reference/analyticsreportpermalinkget.md): List permanent download link for report. You can only have one valid permalink enabled at a time for each report. Creating a new one will invalidate all existing permalinks.
- [Invalidate permalink for report](https://developer.xentral.com/reference/analyticsreportpermalinkdelete.md): Invalidate permanent download link for downloading report results
- [Download report](https://developer.xentral.com/reference/analyticsreportpermalinkdownload.md): Download latest report export result via permalink. Using a permalink will allow anyone with the link to view the report. We recommend to use other export features for exporting data.
- [Create report schedule](https://developer.xentral.com/reference/analyticsreportschedulecreate.md): Create scheduled export for report
- [List report schedules](https://developer.xentral.com/reference/analyticsreportschedulelist.md): List all scheduled report exports
- [Update report schedule](https://developer.xentral.com/reference/analyticsreportscheduleupdate.md): Update scheduled report export
- [Delete report schedule](https://developer.xentral.com/reference/analyticsreportscheduledelete.md): Delete scheduled report export
- [List schedules](https://developer.xentral.com/reference/analyticsschedulelist.md): List all active export schedules for report exports
- [🔒 Create offer V3](https://developer.xentral.com/reference/postapi-v3-offers.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `offer:create`. Create an offer.
- [List offers V3](https://developer.xentral.com/reference/getapi-v3-offers.md): This endpoint requires the following scopes: `offer:read`. List offers.
- [View offer V3](https://developer.xentral.com/reference/getapi-v3-offers-id.md): This endpoint requires the following scopes: `offer:read`. View an offer. **Content Negotiation:** This endpoint supports additional response formats: `application/pdf`. Use the `Accept` header to request a specific format.
- [🔒 Update offer V3](https://developer.xentral.com/reference/patchapi-v3-offers-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `offer:update`. Update an offer.
- [Delete offer V3](https://developer.xentral.com/reference/deleteapi-v3-offers-id.md): This endpoint requires the following scopes: `offer:delete`. Delete an offer in status draft.
- [🔒 Create offer line item V3](https://developer.xentral.com/reference/postapi-v3-offers-id-lineitems.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `offer:update`. Create a new offer line item.
- [View offer line item V3](https://developer.xentral.com/reference/getapi-v3-offers-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `offer:read`. View a single offer line item.
- [🔒 Update offer line item V3](https://developer.xentral.com/reference/patchapi-v3-offers-id-lineitems-lineitemid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `offer:update`. Update a line item in an offer.
- [Delete offer line item V3](https://developer.xentral.com/reference/deleteapi-v3-offers-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `offer:update`. Delete a line item of an offer.
- [Attach file to offer V3](https://developer.xentral.com/reference/postapi-v3-offers-id-files.md): This endpoint requires the following scopes: `offer:update`. Attach a file to an offer.
- [Update file on offer V3](https://developer.xentral.com/reference/patchapi-v3-offers-id-files-fileid.md): This endpoint requires the following scopes: `offer:update`. Update a file attached to an offer.
- [Delete file from offer V3](https://developer.xentral.com/reference/deleteapi-v3-offers-id-files-fileid.md): This endpoint requires the following scopes: `offer:update`. Delete a file attached to an offer.
- [Release offer V3](https://developer.xentral.com/reference/patchapi-v3-offers-id-actions-release.md): This endpoint requires the following scopes: `offer:release`. Release an offer.
- [Cancel offer V3](https://developer.xentral.com/reference/patchapi-v3-offers-id-actions-cancel.md): This endpoint requires the following scopes: `offer:cancel`. Cancel an offer. Offers in status draft or completed cannot be cancelled.
- [Send offer V3](https://developer.xentral.com/reference/patchapi-v3-offers-id-actions-send.md): This endpoint requires the following scopes: `offer:send`. Send an offer.
- [Log custom offer activity V3](https://developer.xentral.com/reference/patchapi-v3-offers-id-actions-logactivity.md): This endpoint requires the following scopes: `offer:update`. Record a custom activity log entry for an offer.
- [Set offer write protection V3](https://developer.xentral.com/reference/patchapi-v3-offers-id-actions-setwriteprotection.md): This endpoint requires the following scopes: `offer:setWriteProtection`. Set write protection for an offer.
- [Remove offer write protection V3](https://developer.xentral.com/reference/patchapi-v3-offers-id-actions-removewriteprotection.md): This endpoint requires the following scopes: `offer:removeWriteProtection`. Remove write protection from an offer.
- [Create collective bill](https://developer.xentral.com/reference/collectivebillcreate.md): Creates a collective bill
- [Create credit note](https://developer.xentral.com/reference/creditnotecreate.md): Creates a credit note
Warning: Multiple request body content types
Due to technical limitations, the information provided here may not display all available request body content types. We are currently working with our third-party documentation provider to address this issue. For a complete and accurate representation of the available content types, we recommend referring to the full OpenAPI specification.
We apologize for any inconvenience caused and appreciate your understanding as we work to resolve this matter.
Available request content types:
- application/json
- application/vnd.xentral.minimal+json
- application/vnd.xentral.fromreturn+json
- [🔒 Create credit note V3](https://developer.xentral.com/reference/postapi-v3-creditnotes.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `creditNote:create`. Create a new credit note.
- [List credit notes](https://developer.xentral.com/reference/creditnotelist.md): Returns a collection with all credit notes.
- [List credit notes V3](https://developer.xentral.com/reference/getapi-v3-creditnotes.md): This endpoint requires the following scopes: `creditNote:read`. Paginated list of creditNotes.
- [View credit note](https://developer.xentral.com/reference/creditnoteview.md): Returns details of a single credit note.
- [View credit note V3](https://developer.xentral.com/reference/getapi-v3-creditnotes-id.md): This endpoint requires the following scopes: `creditNote:read`. View a single credit note. **Content Negotiation:** This endpoint supports additional response formats: `application/pdf`. Use the `Accept` header to request a specific format.
- [Update credit note](https://developer.xentral.com/reference/creditnoteupdate.md): Update a single credit note
- [🔒 Update credit note V3](https://developer.xentral.com/reference/patchapi-v3-creditnotes-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `creditNote:update`. Update a credit note.
- [Delete credit note V3](https://developer.xentral.com/reference/deleteapi-v3-creditnotes-id.md): This endpoint requires the following scopes: `creditNote:delete`. Delete a credit note in status draft.
- [View Credit Note Balance](https://developer.xentral.com/reference/creditnotebalance.md): Returns balance information (documents, payments) for a single credit note
- [View related documents for credit note](https://developer.xentral.com/reference/creditnotedocumentsview.md): Returns details for related documents of a single credit note.
- [🔒 Create credit note line item V3](https://developer.xentral.com/reference/postapi-v3-creditnotes-id-lineitems.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `creditNote:update`. Create a new credit note line item.
- [View credit note line item V3](https://developer.xentral.com/reference/getapi-v3-creditnotes-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `creditNote:read`. View a single credit note line item.
- [🔒 Update credit note line item V3](https://developer.xentral.com/reference/patchapi-v3-creditnotes-id-lineitems-lineitemid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `creditNote:update`. Update a line item in a credit note.
- [Delete credit note line item V3](https://developer.xentral.com/reference/deleteapi-v3-creditnotes-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `creditNote:update`. Delete a line item from a credit note.
- [Release credit note V3](https://developer.xentral.com/reference/patchapi-v3-creditnotes-id-actions-release.md): This endpoint requires the following scopes: `creditNote:release`. Release a credit note.
- [Send credit note](https://developer.xentral.com/reference/creditnotesend.md): Send credit note by email or to a printer. You can also mark the credit note as sent without actually sending it.
- [Send credit note V3](https://developer.xentral.com/reference/patchapi-v3-creditnotes-id-actions-send.md): This endpoint requires the following scopes: `creditNote:send`. Send a credit note.
- [Log custom credit note activity V3](https://developer.xentral.com/reference/patchapi-v3-creditnotes-id-actions-logactivity.md): This endpoint requires the following scopes: `creditNote:update`. Record a custom activity log entry for a credit note.
- [Set credit note write protection V3](https://developer.xentral.com/reference/patchapi-v3-creditnotes-id-actions-setwriteprotection.md): This endpoint requires the following scopes: `creditNote:setWriteProtection`. Set write protection for a credit note.
- [Remove credit note write protection V3](https://developer.xentral.com/reference/patchapi-v3-creditnotes-id-actions-removewriteprotection.md): This endpoint requires the following scopes: `creditNote:removeWriteProtection`. Remove write protection from a credit note.
- [Attach file to credit note V3](https://developer.xentral.com/reference/postapi-v3-creditnotes-id-files.md): This endpoint requires the following scopes: `creditNote:update`. Attach a file to a credit note.
- [Update file on credit note V3](https://developer.xentral.com/reference/patchapi-v3-creditnotes-id-files-fileid.md): This endpoint requires the following scopes: `creditNote:update`. Update a file attached to a credit note.
- [Delete file from credit note V3](https://developer.xentral.com/reference/deleteapi-v3-creditnotes-id-files-fileid.md): This endpoint requires the following scopes: `creditNote:update`. Delete a file attached to a credit note.
- [🔒 Create delivery note V3](https://developer.xentral.com/reference/postapi-v3-deliverynotes.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `deliveryNote:create`. Create a new delivery note.
- [List delivery notes](https://developer.xentral.com/reference/deliverynotelist.md): Returns all delivery notes with pagination and filtering options.
- [List delivery notes V3](https://developer.xentral.com/reference/getapi-v3-deliverynotes.md): This endpoint requires the following scopes: `deliveryNote:read`. Paginated list of Delivery Notes.
- [View delivery note](https://developer.xentral.com/reference/deliverynoteview.md): Returns details of a delivery note
- [View delivery note V3](https://developer.xentral.com/reference/getapi-v3-deliverynotes-id.md): This endpoint requires the following scopes: `deliveryNote:read`. View a single delivery note. **Content Negotiation:** This endpoint supports additional response formats: `application/pdf`. Use the `Accept` header to request a specific format.
- [View delivery note shipments](https://developer.xentral.com/reference/deliverynoteshipmentslist.md): Details of delivery note shipments
- [🔒 Update delivery note V3](https://developer.xentral.com/reference/patchapi-v3-deliverynotes-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `deliveryNote:update`. Update a delivery note.
- [Delete delivery note V3](https://developer.xentral.com/reference/deleteapi-v3-deliverynotes-id.md): This endpoint requires the following scopes: `deliveryNote:delete`. Delete a delivery note in status draft.
- [🔒 Create delivery note line item V3](https://developer.xentral.com/reference/postapi-v3-deliverynotes-id-lineitems.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `deliveryNote:update`. Create a new delivery note line item.
- [View delivery note line item V3](https://developer.xentral.com/reference/getapi-v3-deliverynotes-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `deliveryNote:read`. View a single delivery note line item.
- [🔒 Update delivery note line item V3](https://developer.xentral.com/reference/patchapi-v3-deliverynotes-id-lineitems-lineitemid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `deliveryNote:update`. Update a line item in a delivery note.
- [Delete delivery note line item V3](https://developer.xentral.com/reference/deleteapi-v3-deliverynotes-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `deliveryNote:update`. Delete a line item of a delivery note.
- [Release delivery note V3](https://developer.xentral.com/reference/patchapi-v3-deliverynotes-id-actions-release.md): This endpoint requires the following scopes: `deliveryNote:release`. Release a delivery note.
- [Cancel delivery note V3](https://developer.xentral.com/reference/patchapi-v3-deliverynotes-id-actions-cancel.md): This endpoint requires the following scopes: `deliveryNote:cancel`. Cancel a delivery note. Restocking the items associated with the delivery note must be handled manually. Delivery notes in status draft or completed cannot be cancelled.
- [Complete delivery note V3](https://developer.xentral.com/reference/patchapi-v3-deliverynotes-id-actions-complete.md): This endpoint requires the following scopes: `deliveryNote:complete`. Complete a delivery note. Only delivery notes for suppliers and released or sent delivery notes are allowed.
- [Log custom delivery note activity V3](https://developer.xentral.com/reference/patchapi-v3-deliverynotes-id-actions-logactivity.md): This endpoint requires the following scopes: `deliveryNote:update`. Record a custom activity log entry for a delivery note.
- [Send delivery note V3](https://developer.xentral.com/reference/patchapi-v3-deliverynotes-id-actions-send.md): This endpoint requires the following scopes: `deliveryNote:send`. Send a delivery note.
- [Set delivery note write protection V3](https://developer.xentral.com/reference/patchapi-v3-deliverynotes-id-actions-setwriteprotection.md): This endpoint requires the following scopes: `deliveryNote:setWriteProtection`. Set write protection for a delivery note.
- [Remove delivery note write protection V3](https://developer.xentral.com/reference/patchapi-v3-deliverynotes-id-actions-removewriteprotection.md): This endpoint requires the following scopes: `deliveryNote:removeWriteProtection`. Remove write protection from a delivery note.
- [Attach file to delivery note V3](https://developer.xentral.com/reference/postapi-v3-deliverynotes-id-files.md): This endpoint requires the following scopes: `deliveryNote:update`. Attach a file to a delivery note.
- [Update file on delivery note V3](https://developer.xentral.com/reference/patchapi-v3-deliverynotes-id-files-fileid.md): This endpoint requires the following scopes: `deliveryNote:update`. Update a file attached to a delivery note.
- [Delete file from delivery note V3](https://developer.xentral.com/reference/deleteapi-v3-deliverynotes-id-files-fileid.md): This endpoint requires the following scopes: `deliveryNote:update`. Delete a file attached to a delivery note.
- [Update delivery note positions customs data.](https://developer.xentral.com/reference/deliverynotepositionscustomsupdate.md): Update delivery note positions customs data. **Attention**: ⚠️ - This is an interims endpoint that will be _**deprecated and removed**_ in future. - We will inform all users of this endpoint about the deprecation and removal before.
- [Assign quality control attributes to delivery note](https://developer.xentral.com/reference/deliverynotesassignqualitycontrolattributes.md): Assign quality control attributes to a delivery note.
- [Create tracking information](https://developer.xentral.com/reference/shipmentscreate.md): Creates tracking information
- [List deliveries](https://developer.xentral.com/reference/deliverieslist.md): Lists existing deliveries
- [View delivery](https://developer.xentral.com/reference/deliveryview.md): Returns details of a delivery aka shipment
- [View shipment](https://developer.xentral.com/reference/shipmentview.md): Returns details of a shipment aka delivery
- [Create invoice](https://developer.xentral.com/reference/invoicecreate.md): Creates a invoice
- [🔒 Create invoice V3](https://developer.xentral.com/reference/postapi-v3-invoices.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `invoice:create`. Create a new invoice.
- [Create positions for invoice](https://developer.xentral.com/reference/invoicecreatepositions.md): Adds invoice positions
- [🔒 Create invoice from delivery note V3](https://developer.xentral.com/reference/postapi-v3-invoices-actions-createfromdeliverynote.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `invoice:create`. Create an invoice from an existing delivery note.
- [🔒 Create invoice from sales order V3](https://developer.xentral.com/reference/postapi-v3-invoices-actions-createfromsalesorder.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `invoice:create`. Create an invoice from an existing sales order.
- [List invoices](https://developer.xentral.com/reference/invoicelist.md): Returns a collection with all invoices.
- [List invoices V3](https://developer.xentral.com/reference/getapi-v3-invoices.md): This endpoint requires the following scopes: `invoice:read`. Paginated list of invoices.
- [View invoice](https://developer.xentral.com/reference/invoiceview.md): Returns details of a single invoice.
- [View invoice V3](https://developer.xentral.com/reference/getapi-v3-invoices-id.md): This endpoint requires the following scopes: `invoice:read`. View a single invoice. **Content Negotiation:** This endpoint supports additional response formats: `application/pdf`. Use the `Accept` header to request a specific format.
- [Update invoice](https://developer.xentral.com/reference/invoiceupdate.md): Update a single invoice
- [🔒 Update invoice V3](https://developer.xentral.com/reference/patchapi-v3-invoices-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `invoice:update`. Update an invoice.
- [Update status for single invoice](https://developer.xentral.com/reference/invoicestatus.md): Update status for single invoice
- [Delete invoice V3](https://developer.xentral.com/reference/deleteapi-v3-invoices-id.md): This endpoint requires the following scopes: `invoice:delete`. Delete an invoice in status draft.
- [🔒 Create invoice line item V3](https://developer.xentral.com/reference/postapi-v3-invoices-id-lineitems.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `invoice:update`. Create a new invoice line item.
- [View invoice line item V3](https://developer.xentral.com/reference/getapi-v3-invoices-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `invoice:read`. View a single invoice line item.
- [🔒 Update invoice line item V3](https://developer.xentral.com/reference/patchapi-v3-invoices-id-lineitems-lineitemid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `invoice:update`. Update a line item in an invoice.
- [Delete invoice line item V3](https://developer.xentral.com/reference/deleteapi-v3-invoices-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `invoice:update`. Delete a line item from an invoice.
- [Release invoice V3](https://developer.xentral.com/reference/patchapi-v3-invoices-id-actions-release.md): This endpoint requires the following scopes: `invoice:release`. Release an invoice.
- [Send invoice V2](https://developer.xentral.com/reference/invoicesendv2.md): Send invoice
- [Send invoice V3](https://developer.xentral.com/reference/patchapi-v3-invoices-id-actions-send.md): This endpoint requires the following scopes: `invoice:send`. Send an invoice.
- [Log custom invoice activity V3](https://developer.xentral.com/reference/patchapi-v3-invoices-id-actions-logactivity.md): This endpoint requires the following scopes: `invoice:update`. Record a custom activity log entry for an invoice.
- [Set invoice write protection V3](https://developer.xentral.com/reference/patchapi-v3-invoices-id-actions-setwriteprotection.md): This endpoint requires the following scopes: `invoice:setWriteProtection`. Set write protection for an invoice.
- [Remove invoice write protection V3](https://developer.xentral.com/reference/patchapi-v3-invoices-id-actions-removewriteprotection.md): This endpoint requires the following scopes: `invoice:removeWriteProtection`. Remove write protection from an invoice.
- [Attach file to invoice V3](https://developer.xentral.com/reference/postapi-v3-invoices-id-files.md): This endpoint requires the following scopes: `invoice:update`. Attach a file to an invoice.
- [Update file on invoice V3](https://developer.xentral.com/reference/patchapi-v3-invoices-id-files-fileid.md): This endpoint requires the following scopes: `invoice:update`. Update a file attached to an invoice.
- [Delete file from invoice V3](https://developer.xentral.com/reference/deleteapi-v3-invoices-id-files-fileid.md): This endpoint requires the following scopes: `invoice:update`. Delete a file attached to an invoice.
- [View invoice balance](https://developer.xentral.com/reference/invoicebalance.md): Returns balance information (documents, payments) for a single invoice
- [View related documents for invoice](https://developer.xentral.com/reference/invoicedocumentsview.md): Returns details for related documents of a single invoice.
- [🔒 Create proforma invoice V3](https://developer.xentral.com/reference/postapi-v3-proformainvoices.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `proformaInvoice:create`. Create a new proforma invoice.
- [🔒 List proforma invoices V3](https://developer.xentral.com/reference/getapi-v3-proformainvoices.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `proformaInvoice:read`. Paginated list of proforma invoices.
- [🔒 View proforma invoice V3](https://developer.xentral.com/reference/getapi-v3-proformainvoices-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `proformaInvoice:read`. View a single proforma invoice. **Content Negotiation:** This endpoint supports additional response formats: `application/pdf`. Use the `Accept` header to request a specific format.
- [🔒 Update proforma invoice V3](https://developer.xentral.com/reference/patchapi-v3-proformainvoices-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `proformaInvoice:update`. Update a proforma invoice.
- [Delete proforma invoice V3](https://developer.xentral.com/reference/deleteapi-v3-proformainvoices-id.md): This endpoint requires the following scopes: `proformaInvoice:delete`. Delete a proforma invoice in status draft.
- [🔒 Create proforma invoice line item V3](https://developer.xentral.com/reference/postapi-v3-proformainvoices-id-lineitems.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `proformaInvoice:update`. Create a new proforma invoice line item.
- [View proforma invoice line item V3](https://developer.xentral.com/reference/getapi-v3-proformainvoices-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `proformaInvoice:read`. View a single proforma invoice line item.
- [🔒 Update proforma invoice line item V3](https://developer.xentral.com/reference/patchapi-v3-proformainvoices-id-lineitems-lineitemid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `proformaInvoice:update`. Update a line item in a proforma invoice.
- [Delete proforma invoice line item V3](https://developer.xentral.com/reference/deleteapi-v3-proformainvoices-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `proformaInvoice:update`. Delete a line item from a proforma invoice.
- [Release proforma invoice V3](https://developer.xentral.com/reference/patchapi-v3-proformainvoices-id-actions-release.md): This endpoint requires the following scopes: `proformaInvoice:release`. Release a proforma invoice.
- [Send proforma invoice V3](https://developer.xentral.com/reference/patchapi-v3-proformainvoices-id-actions-send.md): This endpoint requires the following scopes: `proformaInvoice:send`. Send a proforma invoice.
- [Log custom proforma invoice activity V3](https://developer.xentral.com/reference/patchapi-v3-proformainvoices-id-actions-logactivity.md): This endpoint requires the following scopes: `proformaInvoice:update`. Record a custom activity log entry for a proforma invoice.
- [Set proforma invoice write protection V3](https://developer.xentral.com/reference/patchapi-v3-proformainvoices-id-actions-setwriteprotection.md): This endpoint requires the following scopes: `proformaInvoice:setWriteProtection`. Set write protection for a proforma invoice.
- [Remove proforma invoice write protection V3](https://developer.xentral.com/reference/patchapi-v3-proformainvoices-id-actions-removewriteprotection.md): This endpoint requires the following scopes: `proformaInvoice:removeWriteProtection`. Remove write protection from a proforma invoice.
- [Attach file to proforma invoice V3](https://developer.xentral.com/reference/postapi-v3-proformainvoices-id-files.md): This endpoint requires the following scopes: `proformaInvoice:update`. Attach a file to a proforma invoice.
- [Update file on proforma invoice V3](https://developer.xentral.com/reference/patchapi-v3-proformainvoices-id-files-fileid.md): This endpoint requires the following scopes: `proformaInvoice:update`. Update a file attached to a proforma invoice.
- [Delete file from proforma invoice V3](https://developer.xentral.com/reference/deleteapi-v3-proformainvoices-id-files-fileid.md): This endpoint requires the following scopes: `proformaInvoice:update`. Delete a file attached to a proforma invoice.
- [Create purchase order](https://developer.xentral.com/reference/purchaseordercreate.md): Creates a new purchase order.
- [🔒 Create purchase order V3](https://developer.xentral.com/reference/postapi-v3-purchaseorders.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `purchaseOrder:create`. Create a new purchase order.
- [List purchase orders](https://developer.xentral.com/reference/purchaseorderlist.md): Lists all available purchase orders.
- [List purchase orders V3](https://developer.xentral.com/reference/getapi-v3-purchaseorders.md): This endpoint requires the following scopes: `purchaseOrder:read`. Paginated list of Purchase Orders.
- [View purchase order](https://developer.xentral.com/reference/purchaseorderview.md): Returns details of a single purchase order
- [View purchase order V3](https://developer.xentral.com/reference/getapi-v3-purchaseorders-id.md): This endpoint requires the following scopes: `purchaseOrder:read`. View a single purchase order. **Content Negotiation:** This endpoint supports additional response formats: `application/pdf`. Use the `Accept` header to request a specific format.
- [Update purchase order](https://developer.xentral.com/reference/purchaseorderupdate.md): Updates an existing purchase order as long as no writing protection is active. When the writing protection is active only isConfirmed, confirmedVia, confirmedDeliveryDate and salesOrderConfirmationReference can be updated.
- [🔒 Update purchase order V3](https://developer.xentral.com/reference/patchapi-v3-purchaseorders-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `purchaseOrder:update`. Update a purchase order.
- [Delete purchase order V3](https://developer.xentral.com/reference/deleteapi-v3-purchaseorders-id.md): This endpoint requires the following scopes: `purchaseOrder:delete`. Delete a purchase order in status draft.
- [🔒 Create purchase order line item V3](https://developer.xentral.com/reference/postapi-v3-purchaseorders-id-lineitems.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `purchaseOrder:update`. Create a new purchase order line item.
- [View purchase order line item V3](https://developer.xentral.com/reference/getapi-v3-purchaseorders-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `purchaseOrder:read`. View a single purchase order line item.
- [🔒 Update purchase order line item V3](https://developer.xentral.com/reference/patchapi-v3-purchaseorders-id-lineitems-lineitemid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `purchaseOrder:update`. Update a line item in a purchase order.
- [Delete purchase order line item V3](https://developer.xentral.com/reference/deleteapi-v3-purchaseorders-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `purchaseOrder:update`. Delete a line item of a purchase order.
- [Release purchase order](https://developer.xentral.com/reference/purchaseorderactionsrelease.md): Releases the purchase order
- [Release purchase order V3](https://developer.xentral.com/reference/patchapi-v3-purchaseorders-id-actions-release.md): This endpoint requires the following scopes: `purchaseOrder:release`. Release a purchase order.
- [Cancel purchase order](https://developer.xentral.com/reference/purchaseorderactionscancel.md): Cancels the purchase order
- [Cancel purchase order V3](https://developer.xentral.com/reference/patchapi-v3-purchaseorders-id-actions-cancel.md): This endpoint requires the following scopes: `purchaseOrder:cancel`. Cancel a purchase order. Purchase orders in status draft or completed cannot be cancelled.
- [Complete purchase order V3](https://developer.xentral.com/reference/patchapi-v3-purchaseorders-id-actions-complete.md): This endpoint requires the following scopes: `purchaseOrder:complete`. Complete a purchase order. Purchase orders in status draft, cancelled, or already completed cannot be completed.
- [Send purchase order V3](https://developer.xentral.com/reference/patchapi-v3-purchaseorders-id-actions-send.md): This endpoint requires the following scopes: `purchaseOrder:send`. Send a purchase order.
- [Log custom purchase order activity V3](https://developer.xentral.com/reference/patchapi-v3-purchaseorders-id-actions-logactivity.md): This endpoint requires the following scopes: `purchaseOrder:update`. Record a custom activity log entry for a purchase order.
- [Set purchase order write protection V3](https://developer.xentral.com/reference/patchapi-v3-purchaseorders-id-actions-setwriteprotection.md): This endpoint requires the following scopes: `purchaseOrder:setWriteProtection`. Set write protection for a purchaseOrder.
- [Remove purchase order write protection V3](https://developer.xentral.com/reference/patchapi-v3-purchaseorders-id-actions-removewriteprotection.md): This endpoint requires the following scopes: `purchaseOrder:removeWriteProtection`. Remove write protection from a purchase order.
- [Attach file to purchase order V3](https://developer.xentral.com/reference/postapi-v3-purchaseorders-id-files.md): This endpoint requires the following scopes: `purchaseOrder:update`. Attach a file to a purchase order.
- [Update file on purchase order V3](https://developer.xentral.com/reference/patchapi-v3-purchaseorders-id-files-fileid.md): This endpoint requires the following scopes: `purchaseOrder:update`. Update a file attached to a purchase order.
- [Delete file from purchase order V3](https://developer.xentral.com/reference/deleteapi-v3-purchaseorders-id-files-fileid.md): This endpoint requires the following scopes: `purchaseOrder:update`. Delete a file attached to a purchase order.
- [Import sales order](https://developer.xentral.com/reference/salesorderimport.md): Import a sales order from external marketplace
- [🔒 Create sales order V3](https://developer.xentral.com/reference/postapi-v3-salesorders.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `salesOrder:create`. Create a new sales order.
- [Create partial sales order](https://developer.xentral.com/reference/salesorderactionscreatepartialsalesorder.md): This endpoint creates a partial delivery sales order for an existing sales order. The partial delivery sales order will be copied from the existing sales order without any positions and gets linked as partial delivery sales order. Adding positions to the partial delivery sales order needs to be done by using the Update existing sales order endpoint. Please pay attention to remove the positions in the original sales order or to adjust the quantities if you do not fully transfer the whole position to the partial delivery sales order.
- [List sales orders](https://developer.xentral.com/reference/salesorderlist.md): Returns a collection with all sales orders.
- [List sales orders V3](https://developer.xentral.com/reference/getapi-v3-salesorders.md): This endpoint requires the following scopes: `salesOrder:read`. Paginated list of Sales Orders
- [View sales order](https://developer.xentral.com/reference/salesorderview.md): Returns details of a sales order
- [View sales order V3](https://developer.xentral.com/reference/getapi-v3-salesorders-id.md): This endpoint requires the following scopes: `salesOrder:read`. View a single sales order **Content Negotiation:** This endpoint supports additional response formats: `application/pdf`. Use the `Accept` header to request a specific format.
- [Update sales order](https://developer.xentral.com/reference/salesorderupdate.md): CAUTION: Positions not specified in the payload will be DELETED. Please pass the ids along if you need them to be preserved.
The sales order edit endpoint allows for updating an existing sales order. When updating, any positions not included in the positions payload will be implicitly deleted from the order. This ensures that the positions list in the payload accurately reflects the desired state of the sales order after the update.
- [🔒 Update sales order V3](https://developer.xentral.com/reference/patchapi-v3-salesorders-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `salesOrder:update`. Update a sales order.
- [Delete sales order](https://developer.xentral.com/reference/salesorderdelete.md): Deletes a sales order in draft status
- [Delete sales order V3](https://developer.xentral.com/reference/deleteapi-v3-salesorders-id.md): This endpoint requires the following scopes: `salesOrder:delete`. Delete a sales order in status draft.
- [🔒 Create sales order line item V3](https://developer.xentral.com/reference/postapi-v3-salesorders-id-lineitems.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `salesOrder:update`. Create a new sales order line item.
- [View sales order line item V3](https://developer.xentral.com/reference/getapi-v3-salesorders-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `salesOrder:read`. View a single sales order line item.
- [🔒 Update sales order line item V3](https://developer.xentral.com/reference/patchapi-v3-salesorders-id-lineitems-lineitemid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `salesOrder:update`. Update a line item in a sales order.
- [Delete sales order line item V3](https://developer.xentral.com/reference/deleteapi-v3-salesorders-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `salesOrder:update`. Delete a line item of a sales order.
- [Release sales order V3](https://developer.xentral.com/reference/patchapi-v3-salesorders-id-actions-release.md): This endpoint requires the following scopes: `salesOrder:release`. Release a sales order.
- [Cancel sales order](https://developer.xentral.com/reference/salesorderactionscancel.md): Cancels a sales order. Only sales orders in status 'created' or 'completed' can be canceled. For draft sales orders use the delete endpoint.
Warning: Multiple request body content types
Due to technical limitations, the information provided here may not display all available request body content types. We are currently working with our third-party documentation provider to address this issue. For a complete and accurate representation of the available content types, we recommend referring to the full OpenAPI specification.
We apologize for any inconvenience caused and appreciate your understanding as we work to resolve this matter.
Available request content types:
- application/json
- application/x-www-form-urlencoded
- [Cancel sales order V3](https://developer.xentral.com/reference/patchapi-v3-salesorders-id-actions-cancel.md): This endpoint requires the following scopes: `salesOrder:cancel`. Cancel a sales order. Sales orders in status draft or completed cannot be cancelled.
- [Dispatch sales order](https://developer.xentral.com/reference/salesorderactionsdispatch.md): Dispatch a released sales order, if it fulfills all requirements
- [Complete sales order V3](https://developer.xentral.com/reference/patchapi-v3-salesorders-id-actions-complete.md): This endpoint requires the following scopes: `salesOrder:complete`. Complete a sales order. Sales orders in status draft, cancelled or already completed cannot be completed.
- [Send sales order V3](https://developer.xentral.com/reference/patchapi-v3-salesorders-id-actions-send.md): This endpoint requires the following scopes: `salesOrder:send`. Send a sales order.
- [Log custom sales order activity V3](https://developer.xentral.com/reference/patchapi-v3-salesorders-id-actions-logactivity.md): This endpoint requires the following scopes: `salesOrder:update`. Record a custom activity log entry for a sales order.
- [Set sales order write protection V3](https://developer.xentral.com/reference/patchapi-v3-salesorders-id-actions-setwriteprotection.md): This endpoint requires the following scopes: `salesOrder:setWriteProtection`. Set write protection for a sales order.
- [Remove sales order write protection V3](https://developer.xentral.com/reference/patchapi-v3-salesorders-id-actions-removewriteprotection.md): This endpoint requires the following scopes: `salesOrder:removeWriteProtection`. Remove write protection from a sales order.
- [Attach file to sales order V3](https://developer.xentral.com/reference/postapi-v3-salesorders-id-files.md): This endpoint requires the following scopes: `salesOrder:update`. Attach a file to a sales order.
- [Update file on sales order V3](https://developer.xentral.com/reference/patchapi-v3-salesorders-id-files-fileid.md): This endpoint requires the following scopes: `salesOrder:update`. Update a file attached to a sales order.
- [Delete file from sales order V3](https://developer.xentral.com/reference/deleteapi-v3-salesorders-id-files-fileid.md): This endpoint requires the following scopes: `salesOrder:update`. Delete a file attached to a sales order.
- [Create sales order document](https://developer.xentral.com/reference/salesordercreatedocument.md): Creates new sales order document
- [List sales order documents](https://developer.xentral.com/reference/salesorderlistdocument.md): Returns a list of given sales order documents
- [View sales order document](https://developer.xentral.com/reference/salesorderviewdocument.md): Returns details of a single sales order document
- [Update multiple sales order documents](https://developer.xentral.com/reference/salesorderupdatemultiple.md): Updates multiple sales order documents
- [Delete multiple sales order documents](https://developer.xentral.com/reference/salesorderdeletemultiple.md): Deletes a multiple sales order documents
- [Create liability](https://developer.xentral.com/reference/liabilitycreate.md): Creates a single new liability.
- [Create recurring liability](https://developer.xentral.com/reference/liabilitycreaterecurring.md): Creates a single new recurring liability.
- [List liabilities](https://developer.xentral.com/reference/liabilitylist.md): Returns a collection with all Liabilities
- [View liability](https://developer.xentral.com/reference/liabilityview.md): Returns details of a single liability.
- [Release liability](https://developer.xentral.com/reference/liabilityactionsrelease.md): Releases the liability, setting its status to released and enabling write protection
- [Add file to liability](https://developer.xentral.com/reference/liabilitydocumentupload.md): Upload a file and adds this file as document to given liability
- [Attach file to supplier invoice V3](https://developer.xentral.com/reference/postapi-v3-supplierinvoices-id-files.md): This endpoint requires the following scopes: `supplierInvoice:update`. Attach a file to a supplier invoice.
- [Delete file from supplier invoice V3](https://developer.xentral.com/reference/deleteapi-v3-supplierinvoices-id-files-fileid.md): This endpoint requires the following scopes: `supplierInvoice:update`. Delete a file attached to a supplier invoice.
- [Update file on supplier invoice V3](https://developer.xentral.com/reference/patchapi-v3-supplierinvoices-id-files-fileid.md): This endpoint requires the following scopes: `supplierInvoice:update`. Update a file attached to a supplier invoice.
- [Create return](https://developer.xentral.com/reference/returncreate.md): Creates a new return.
- [🔒 Create return order V3](https://developer.xentral.com/reference/postapi-v3-returnorders.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `return:create`. Create a new return order.
- [🔒 Create return order from delivery note V3](https://developer.xentral.com/reference/postapi-v3-returnorders-actions-createfromdeliverynote.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `return:create`. Create a return order from an existing delivery note with selected line items.
- [List returns](https://developer.xentral.com/reference/returnlist.md): Lists existing returns
- [List return orders V3](https://developer.xentral.com/reference/getapi-v3-returnorders.md): This endpoint requires the following scopes: `return:read`. Paginated list of return orders.
- [View return](https://developer.xentral.com/reference/returnview.md): Return details of an existing return
- [View return order V3](https://developer.xentral.com/reference/getapi-v3-returnorders-id.md): This endpoint requires the following scopes: `return:read`. View a single return order. **Content Negotiation:** This endpoint supports additional response formats: `application/pdf`. Use the `Accept` header to request a specific format.
- [🔒 Update return order V3](https://developer.xentral.com/reference/patchapi-v3-returnorders-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `return:update`. Update a return order.
- [Delete return order V3](https://developer.xentral.com/reference/deleteapi-v3-returnorders-id.md): This endpoint requires the following scopes: `return:delete`. Delete a return order in status draft.
- [List return reasons](https://developer.xentral.com/reference/returnreasonlist.md): Returns a list of return reasons
- [🔒 Create return order line item V3](https://developer.xentral.com/reference/postapi-v3-returnorders-id-lineitems.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `return:update`. Create a new return order line item.
- [View return order line item V3](https://developer.xentral.com/reference/getapi-v3-returnorders-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `return:read`. View a single return order line item.
- [🔒 Update return order line item V3](https://developer.xentral.com/reference/patchapi-v3-returnorders-id-lineitems-lineitemid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `return:update`. Update a line item in a return order.
- [Delete return order line item V3](https://developer.xentral.com/reference/deleteapi-v3-returnorders-id-lineitems-lineitemid.md): This endpoint requires the following scopes: `return:update`. Delete a line item of a return order.
- [Release return](https://developer.xentral.com/reference/returnactionsrelease.md): Releases a return.
- [Release return order V3](https://developer.xentral.com/reference/patchapi-v3-returnorders-id-actions-release.md): This endpoint requires the following scopes: `return:release`. Release a return order.
- [Cancel return order V3](https://developer.xentral.com/reference/patchapi-v3-returnorders-id-actions-cancel.md): This endpoint requires the following scopes: `return:cancel`. Cancel a return order. Return orders in status draft or completed cannot be cancelled.
- [Complete return order V3](https://developer.xentral.com/reference/patchapi-v3-returnorders-id-actions-complete.md): This endpoint requires the following scopes: `return:complete`. Complete a return order. Only return orders for suppliers and released or sent return orders are allowed.
- [Send return order V3](https://developer.xentral.com/reference/patchapi-v3-returnorders-id-actions-send.md): This endpoint requires the following scopes: `return:send`. Send a return order.
- [Log custom return order activity V3](https://developer.xentral.com/reference/patchapi-v3-returnorders-id-actions-logactivity.md): This endpoint requires the following scopes: `return:update`. Record a custom activity log entry for a return order.
- [Set return order write protection V3](https://developer.xentral.com/reference/patchapi-v3-returnorders-id-actions-setwriteprotection.md): This endpoint requires the following scopes: `return:setWriteProtection`. Set write protection for a return order.
- [Remove return order write protection V3](https://developer.xentral.com/reference/patchapi-v3-returnorders-id-actions-removewriteprotection.md): This endpoint requires the following scopes: `return:removeWriteProtection`. Remove write protection from a return order.
- [Attach file to return order V3](https://developer.xentral.com/reference/postapi-v3-returnorders-id-files.md): This endpoint requires the following scopes: `return:update`. Attach a file to a return order.
- [Update file on return order V3](https://developer.xentral.com/reference/patchapi-v3-returnorders-id-files-fileid.md): This endpoint requires the following scopes: `return:update`. Update a file attached to a return order.
- [Delete file from return order V3](https://developer.xentral.com/reference/deleteapi-v3-returnorders-id-files-fileid.md): This endpoint requires the following scopes: `return:update`. Delete a file attached to a return order.
- [Create return document](https://developer.xentral.com/reference/returncreatedocument.md): Creates new return document
- [List return documents](https://developer.xentral.com/reference/returnlistdocument.md): Returns a list of given return documents
- [View return document](https://developer.xentral.com/reference/returnviewdocument.md): Returns details of a single return document
- [Update multiple return documents](https://developer.xentral.com/reference/returnupdatemultiple.md): Updates multiple return documents
- [Delete multiple return documents](https://developer.xentral.com/reference/returndeletemultiple.md): Deletes a multiple return documents
- [Attach file to service order V3](https://developer.xentral.com/reference/postapi-v3-serviceorders-id-files.md): This endpoint requires the following scopes: `serviceOrder:update`. Attach a file to a service order.
- [Update file on service order V3](https://developer.xentral.com/reference/patchapi-v3-serviceorders-id-files-fileid.md): This endpoint requires the following scopes: `serviceOrder:update`. Update a file attached to a service order.
- [Delete file from service order V3](https://developer.xentral.com/reference/deleteapi-v3-serviceorders-id-files-fileid.md): This endpoint requires the following scopes: `serviceOrder:update`. Delete a file attached to a service order.
- [List provisional returns](https://developer.xentral.com/reference/provisionalreturnslist.md): Lists existing provisional returns
- [Attach file to price inquiry V3](https://developer.xentral.com/reference/postapi-v3-priceinquiries-id-files.md): This endpoint requires the following scopes: `priceInquiry:update`. Attach a file to a price inquiry.
- [Delete file from price inquiry V3](https://developer.xentral.com/reference/deleteapi-v3-priceinquiries-id-files-fileid.md): This endpoint requires the following scopes: `priceInquiry:update`. Delete a file attached to a price inquiry.
- [Update file on price inquiry V3](https://developer.xentral.com/reference/patchapi-v3-priceinquiries-id-files-fileid.md): This endpoint requires the following scopes: `priceInquiry:update`. Update a file attached to a price inquiry.
- [Create product calculation line item V3](https://developer.xentral.com/reference/postapi-v3-products-id-calculationitems.md): This endpoint requires the following scopes: `productCalculation:create`. Create a product calculation line item
- [List product calculation line items V3](https://developer.xentral.com/reference/getapi-v3-products-id-calculationitems.md): This endpoint requires the following scopes: `productCalculation:read`. List a product purchase price calculation line items
- [View product calculation line item V3](https://developer.xentral.com/reference/getapi-v3-products-id-calculationitems-itemid.md): This endpoint requires the following scopes: `productCalculation:read`. View a single product calculation line item
- [Update product calculation line item V3](https://developer.xentral.com/reference/patchapi-v3-products-id-calculationitems-itemid.md): This endpoint requires the following scopes: `productCalculation:update`. Update a product calculation line item
- [Delete product calculation line item V3](https://developer.xentral.com/reference/deleteapi-v3-products-id-calculationitems-itemid.md): This endpoint requires the following scopes: `productCalculation:delete`. Delete a product calculation line item
- [Create customer](https://developer.xentral.com/reference/customercreatev2.md): Creates a new customer.
- [🔒 Create customer V3](https://developer.xentral.com/reference/postapi-v3-customers.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:create`. Create a new customer.
- [List customers](https://developer.xentral.com/reference/customerlistv2.md): Fetches a list of customers based on provided filters and pagination parameters. This endpoint supports filtering by various customer attributes, as well as cursor and page-based pagination for efficient data retrieval.
- [🔒 List customers V3](https://developer.xentral.com/reference/getapi-v3-customers.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:read`. Paginated list of customers.
- [View customer](https://developer.xentral.com/reference/customerviewv2.md): Returns details of a single customer
- [🔒 View customer V3](https://developer.xentral.com/reference/getapi-v3-customers-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:read`. View a single customer.
- [Update customer](https://developer.xentral.com/reference/customerupdatev2.md): Update an existing customer.
- [🔒 Update customer V3](https://developer.xentral.com/reference/patchapi-v3-customers-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:update`. Update an existing customer.
- [Delete customer](https://developer.xentral.com/reference/customerdelete.md): Delete existing customer
- [🔒 Delete customer V3](https://developer.xentral.com/reference/deleteapi-v3-customers-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:delete`. Delete a customer. This performs a soft delete on the customer and all associated delivery addresses and contact persons.
- [Create address](https://developer.xentral.com/reference/customeraddresscreatev2.md): Create new customer address
- [List addresses](https://developer.xentral.com/reference/customeraddresslistv2.md): Fetches a list of addresses that belong to specified customer. The list includes the main address (type=masterdata), billing address (type=billingaddress) and all delivery addresses (type=deliveryaddress).
- [View address](https://developer.xentral.com/reference/customeraddressviewv2.md): Returns details of a single customer address
- [Update address](https://developer.xentral.com/reference/customeraddressupdatev2.md): Updates given fields for a given customer address
- [Delete address](https://developer.xentral.com/reference/customeraddressdeletev2.md): Delete customer address which could be inside of master data, billing address or a delivery address of a customer
- [Create contact person](https://developer.xentral.com/reference/customercontactpersoncreate.md): Creates new contact person for given customer.
- [🔒 Create contact person V3](https://developer.xentral.com/reference/postapi-v3-customers-customerid-contactpersons.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:create`. Create a new contact person for a customer.
- [List contact persons](https://developer.xentral.com/reference/customercontactpersongetlist.md): Provides a list of contact persons belongs to a customer related to given filters
- [🔒 List contact persons V3](https://developer.xentral.com/reference/getapi-v3-customers-customerid-contactpersons.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:read`. Paginated list of contact persons.
- [View contact person](https://developer.xentral.com/reference/customercontactpersonget.md): Gets a single contact person of given customer by ID.
- [🔒 View contact person V3](https://developer.xentral.com/reference/getapi-v3-customers-customerid-contactpersons-contactpersonid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:read`. View a single contact person.
- [Update contact person](https://developer.xentral.com/reference/customercontactpersonupdate.md): Updates new contact person for given customer.
- [🔒 Update contact person V3](https://developer.xentral.com/reference/patchapi-v3-customers-customerid-contactpersons-contactpersonid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:update`. Update an existing contact person for a customer.
- [Delete contact person](https://developer.xentral.com/reference/customercontactpersondelete.md): Deletes a contact person for given customer.
- [🔒 Delete contact person V3](https://developer.xentral.com/reference/deleteapi-v3-customers-customerid-contactpersons-contactpersonid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:update`. Delete a contact person for a customer.
- [🔒 Create delivery address V3](https://developer.xentral.com/reference/postapi-v3-customers-customerid-deliveryaddresses.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:update`. Create a new delivery address for a customer.
- [🔒 Paginated list of delivery addresses for a customer V3](https://developer.xentral.com/reference/getapi-v3-customers-customerid-deliveryaddresses.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:read`. Paginated list of delivery addresses for a customer.
- [🔒 View delivery address V3](https://developer.xentral.com/reference/getapi-v3-customers-customerid-deliveryaddresses-deliveryaddressid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:read`. View a single delivery address for a customer.
- [🔒 Update delivery address V3](https://developer.xentral.com/reference/patchapi-v3-customers-customerid-deliveryaddresses-deliveryaddressid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:update`. Update an existing delivery address for a customer.
- [🔒 Delete delivery address V3](https://developer.xentral.com/reference/deleteapi-v3-customers-customerid-deliveryaddresses-deliveryaddressid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `customer:update`. Delete a delivery address for a customer.
- [List employees](https://developer.xentral.com/reference/employeelist.md): Lists existing employees
- [🔒 Create supplier V3](https://developer.xentral.com/reference/postapi-v3-suppliers.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:create`. Create a new supplier.
- [List suppliers](https://developer.xentral.com/reference/supplierlist.md): Lists existing suppliers
- [🔒 List suppliers V3](https://developer.xentral.com/reference/getapi-v3-suppliers.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:read`. Paginated list of suppliers.
- [View supplier](https://developer.xentral.com/reference/supplierview.md): Shows an existing supplier details
- [🔒 View supplier V3](https://developer.xentral.com/reference/getapi-v3-suppliers-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:read`. View a single supplier.
- [🔒 Update supplier V3](https://developer.xentral.com/reference/patchapi-v3-suppliers-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:update`. Update an existing supplier.
- [Delete supplier](https://developer.xentral.com/reference/supplierdelete.md): Delete existing supplier
- [🔒 Delete supplier V3](https://developer.xentral.com/reference/deleteapi-v3-suppliers-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:delete`. Delete a supplier. This performs a soft delete on the supplier and all associated delivery addresses and contact persons.
- [🔒 Create contact person V3](https://developer.xentral.com/reference/postapi-v3-suppliers-supplierid-contactpersons.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:create`. Create a new contact person for a supplier.
- [🔒 Update contact person V3](https://developer.xentral.com/reference/patchapi-v3-suppliers-supplierid-contactpersons-contactpersonid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:update`. Update an existing contact person for a supplier.
- [🔒 View contact person V3](https://developer.xentral.com/reference/getapi-v3-suppliers-supplierid-contactpersons-contactpersonid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:read`. View a single contact person.
- [🔒 Delete contact person V3](https://developer.xentral.com/reference/deleteapi-v3-suppliers-supplierid-contactpersons-contactpersonid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:update`. Delete a contact person for a supplier.
- [🔒 List contact persons V3](https://developer.xentral.com/reference/getapi-v3-suppliers-supplierid-contactpersons.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:read`. Paginated list of contact persons.
- [🔒 Create delivery address V3](https://developer.xentral.com/reference/postapi-v3-suppliers-supplierid-deliveryaddresses.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:update`. Create a new delivery address for a supplier.
- [🔒 List supplier delivery addresses V3](https://developer.xentral.com/reference/getapi-v3-suppliers-supplierid-deliveryaddresses.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:read`. Paginated list of delivery addresses for a supplier.
- [🔒 Update delivery address V3](https://developer.xentral.com/reference/patchapi-v3-suppliers-supplierid-deliveryaddresses-deliveryaddressid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:update`. Update an existing delivery address for a supplier.
- [🔒 View delivery address V3](https://developer.xentral.com/reference/getapi-v3-suppliers-supplierid-deliveryaddresses-deliveryaddressid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:read`. View a single delivery address for a supplier.
- [🔒 Delete delivery address V3](https://developer.xentral.com/reference/deleteapi-v3-suppliers-supplierid-deliveryaddresses-deliveryaddressid.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `supplier:update`. Delete a delivery address for a supplier.
- [List delivery terms](https://developer.xentral.com/reference/deliverytermslist.md): Lists existing Delivery Terms
- [Create goods receipt for purchase order](https://developer.xentral.com/reference/purchaseordergoodsreceiptcreate.md): Creates a new goods receipt for a purchase order.
- [Create goods receipt for return](https://developer.xentral.com/reference/returngoodsreceiptcreate.md): Creates a new goods receipt for a return.
- [Create shipping method](https://developer.xentral.com/reference/shippingmethodcreate.md): Creates new shipping method.
- [List shipping methods](https://developer.xentral.com/reference/shippingmethodlist.md): Lists existing shipping methods
- [View shipping method](https://developer.xentral.com/reference/shippingmethodview.md): Shows the details of a Shipping Method
- [Update shipping method](https://developer.xentral.com/reference/shippingmethodupdate.md): Updates a Shipping Method
- [Create stock movement type](https://developer.xentral.com/reference/stockmovementtypecreate.md): Creates a new stock movement type.
- [Create storage location](https://developer.xentral.com/reference/storagelocationcreate.md): Creates a new storage location
- [List storage locations](https://developer.xentral.com/reference/storagelocationlist.md): This endpoint is only available as beta version and will introduce breaking changes without further notice or versioning. Returns all storage locations for the specified warehouse.
- [Update storage location](https://developer.xentral.com/reference/storagelocationupdate.md): Update a storage location for the specified warehouse.
- [Delete storage location](https://developer.xentral.com/reference/storagelocationdelete.md): Delete a storage location for the specified warehouse.
- [Set total stock on storage locations](https://developer.xentral.com/reference/storagelocationssettotalstock.md): This endpoint sets the total stock for one or more storage locations.
The stock data provided in the payload, including quality control attributes (batch, best-before date, and serial number), will be taken over as the new stock for the specified storage location(s).
CAUTION: Any stock that was previously present in the storage location and is not specified in the payload will be removed from the storage location. This also includes the quality control attributes.
- [List storage items V2](https://developer.xentral.com/reference/storagelocationlistv2.md): Returns all storage location items for the specified warehouse / location.
- [Add item to storage location](https://developer.xentral.com/reference/warehousestockitem.md): Adds stock for a given item to a specific Storage Location.
- [Retrieve item from storage location](https://developer.xentral.com/reference/warehouseretrieveitem.md): Retrieves certain units of stock for a given item from a specific Storage Location.
- [Create warehouse](https://developer.xentral.com/reference/warehousecreate.md): Create a warehouse
- [List warehouses](https://developer.xentral.com/reference/warehouselist.md): This endpoint is only available as beta version and will introduce breaking changes without further notice or versioning. Returns a list of active warehouses.
- [Update warehouse](https://developer.xentral.com/reference/warehouseupdate.md): Update warehouse
- [Delete warehouse](https://developer.xentral.com/reference/warehousedelete.md): Delete warehouse
- [Create product V2](https://developer.xentral.com/reference/productcreatev2.md): Creates a new product.
- [List products V2](https://developer.xentral.com/reference/productlistv2.md): Returns a collection with all products.
- [View product V2](https://developer.xentral.com/reference/productviewv2.md): Returns details of a single product
- [Update product v2](https://developer.xentral.com/reference/productupdatev2.md): Updates details of a single product
- [Update multiple products V2](https://developer.xentral.com/reference/productupdatemultiplev2.md): Update multiple products at once.
- [Delete product](https://developer.xentral.com/reference/productdelete.md): Deletes a single product
Warning: Multiple request body content types
Due to technical limitations, the information provided here may not display all available request body content types. We are currently working with our third-party documentation provider to address this issue. For a complete and accurate representation of the available content types, we recommend referring to the full OpenAPI specification.
We apologize for any inconvenience caused and appreciate your understanding as we work to resolve this matter.
Available request content types:
- */*
- application/vnd.xentral.force
- [Delete multiple products](https://developer.xentral.com/reference/productdeletemultiple.md): Deletes multiple products
Warning: Multiple request body content types
Due to technical limitations, the information provided here may not display all available request body content types. We are currently working with our third-party documentation provider to address this issue. For a complete and accurate representation of the available content types, we recommend referring to the full OpenAPI specification.
We apologize for any inconvenience caused and appreciate your understanding as we work to resolve this matter.
Available request content types:
- application/json
- application/vnd.xentral.force+json
- [View media](https://developer.xentral.com/reference/productlistmedia.md): Returns a list of given Products' Media
- [Update product properties](https://developer.xentral.com/reference/productupdateproperties.md): Update Properties of a single product
- [View purchase prices](https://developer.xentral.com/reference/productlistpurchaseprices.md): Returns a list of given Products' PurchasePrices
- [View sales prices](https://developer.xentral.com/reference/productlistsalesprices.md): Returns a list of given Products' SalesPrices
- [View purchase orders positions](https://developer.xentral.com/reference/productlistpurchaseorderspositions.md): Returns a list of given Products' positions in PurchaseOrders
- [View sales orders positions](https://developer.xentral.com/reference/productlistsalesorderspositions.md): Returns a list of given Products' positions in SalesOrders
- [View productions positions](https://developer.xentral.com/reference/productlistproductionspositions.md): Returns a list of given Products' positions in Productions
- [View storage locations](https://developer.xentral.com/reference/productstoragelocations.md): Returns a list of given Products' warehouses entries
- [Update account mapping](https://developer.xentral.com/reference/productupdateaccountmapping.md): Update account mapping for a single product
- [Create cross selling](https://developer.xentral.com/reference/productcreatecrosssellingproducts.md): Creates new cross selling for a product.
- [List cross sellings](https://developer.xentral.com/reference/productlistcrossselling.md): Returns a list of product's cross-selling products
- [Update cross selling](https://developer.xentral.com/reference/productupdatecrosssellingproducts.md): Updates cross selling products of a product.
- [Delete cross selling](https://developer.xentral.com/reference/productdeletecrossselling.md): Deletes cross selling items of a product.
- [Create parts v2](https://developer.xentral.com/reference/productcreatepartsv2.md): Creates new parts for a product.
- [Update parts v2](https://developer.xentral.com/reference/productupdatepartsv2.md): Updates parts of a product.
- [List parts](https://developer.xentral.com/reference/productlistparts.md): Returns a list of given Products' Parts
- [Delete parts](https://developer.xentral.com/reference/productdeleteparts.md): Deletes the parts of a product.
- [View reservations](https://developer.xentral.com/reference/productlistreservations.md): Returns a list of given Products' Reservations
- [List product texts](https://developer.xentral.com/reference/productlisttexts.md): The different product descriptions in all available locales for each of the shops.
- [Create external reference](https://developer.xentral.com/reference/externalreferencecreate.md): Creates new external references for a given Product
- [List external references](https://developer.xentral.com/reference/externalreferencelist.md): Returns list of external references for given Product.
- [List external reference targets](https://developer.xentral.com/reference/externalreferencetargetlist.md): Returns a collection with all External Reference Targets.
- [Update external reference](https://developer.xentral.com/reference/externalreferenceupdatemultiple.md): Updates external references for a given Product
- [Delete external reference](https://developer.xentral.com/reference/externalreferencedeletemultiple.md): Deletes external references of a given Product
- [Create product category](https://developer.xentral.com/reference/productcategorycreate.md): Creates a new product category.
- [List product categories](https://developer.xentral.com/reference/productcategorylist.md): Lists all available products categories.
- [View product category](https://developer.xentral.com/reference/productcategoryview.md): Returns details of a single product category
- [Update product category](https://developer.xentral.com/reference/productcategoryupdate.md): Updates details of a single product category
- [Delete product category](https://developer.xentral.com/reference/productcategorydelete.md): Deletes a single product
- [List product free fields](https://developer.xentral.com/reference/productfreefieldlist.md): Returns a list of information about product free fields from the company settings
- [View product free field](https://developer.xentral.com/reference/productfreefieldview.md): Returns details of a single product free field from company settings
- [Update product free field](https://developer.xentral.com/reference/productfreefieldupdate.md): Updates details of a single product free field from company settings
- [Update multiple product free fields](https://developer.xentral.com/reference/productfreefieldupdatemultiple.md): Updates details of multiple product free fields from company settings
- [Create product media](https://developer.xentral.com/reference/productmediacreate.md): Creates new product media
- [List product media](https://developer.xentral.com/reference/productmedialist.md): Returns list of a product media
- [View product media](https://developer.xentral.com/reference/productmediaview.md): Returns details of a single product media
- [Update multiple product media](https://developer.xentral.com/reference/productmediaupdatemultiple.md): Updates multiple product media
- [Delete multiple product media](https://developer.xentral.com/reference/productmediadeletemultiple.md): Deletes a multiple product media
- [Create product media version](https://developer.xentral.com/reference/productmediacreateversion.md): Creates new product media version
- [View product media version](https://developer.xentral.com/reference/productmediaviewversion.md): Returns content or details of a single product media
- [Update product media version](https://developer.xentral.com/reference/productmediaupdateversion.md): Updates product media
- [Delete product media version](https://developer.xentral.com/reference/productmediadeleteversion.md): Deletes a single product media version
- [Create multiple product properties](https://developer.xentral.com/reference/productpropertycreate.md): Creates new products properties.
- [List product properties](https://developer.xentral.com/reference/productpropertylist.md): Lists available products properties.
- [List product properties](https://developer.xentral.com/reference/productlistproperties.md): Returns a list of given Products' Properties
- [Update multiple product properties](https://developer.xentral.com/reference/productpropertyupdatemultiple.md): Updates multiple products properties.
- [Delete multiple product properties](https://developer.xentral.com/reference/productpropertydeletemultiple.md): Deletes multiple products properties.
- [Create product merchandise group](https://developer.xentral.com/reference/productmerchandisegroupcreate.md): Creates a new product merchandise group.
- [List product merchandise groups](https://developer.xentral.com/reference/productmerchandisegrouplist.md): Lists all available products merchandise groups.
- [View product merchandise group](https://developer.xentral.com/reference/productmerchandisegroupview.md): Returns details of a single product merchandise group
- [Update product merchandise group](https://developer.xentral.com/reference/productmerchandisegroupupdate.md): Updates details of a single product merchandise group
- [Delete product merchandise group](https://developer.xentral.com/reference/productmerchandisegroupdelete.md): Deletes a single merchandise group
- [Create purchase price V2](https://developer.xentral.com/reference/purchasepricecreatev2.md): Creates new purchase price
- [List purchase prices V2](https://developer.xentral.com/reference/purchasepricelistv2.md): Returns list of purchase prices.
- [View purchase price](https://developer.xentral.com/reference/purchasepriceview.md): Returns details of a single purchase price
- [Update purchase price V2](https://developer.xentral.com/reference/purchasepriceupdatev2.md): Updates details of a single purchase price
- [Update multiple purchase prices V2](https://developer.xentral.com/reference/purchasepriceupdatemultiplev2.md): Updates multiple purchase prices
- [Delete purchase price](https://developer.xentral.com/reference/purchasepricedelete.md): Deletes a single purchase price
- [Create product sales channel settings](https://developer.xentral.com/reference/productcreatesaleschannels.md): Creates sales channel settings for a single product.
- [Update product sales channel settings](https://developer.xentral.com/reference/productupdatesaleschannels.md): Updates sales channel settings for a single product.
- [Delete product sales channel settings](https://developer.xentral.com/reference/productdeletesaleschannels.md): Deletes sales channel settings for a single product.
- [Create sales price](https://developer.xentral.com/reference/salespricecreate.md): Creates new sales price
- [List sales prices](https://developer.xentral.com/reference/salespricelist.md): Returns list of a sales prices
- [View sales price](https://developer.xentral.com/reference/salespriceview.md): Returns details of a single sales price
- [Update sales price](https://developer.xentral.com/reference/salespriceupdate.md): Updates details of a single sales price
- [Update multiple sales prices](https://developer.xentral.com/reference/salespriceupdatemultiple.md): Updates multiple sales prices
- [Delete sales price](https://developer.xentral.com/reference/salespricedelete.md): Deletes a single sales price
- [Print product label](https://developer.xentral.com/reference/productlabelprint.md): Prints a product label for the given product.
- [Download product label as pdf](https://developer.xentral.com/reference/productlabeldownload.md): Downloads a product label for the given product as pdf.
- [Create product delivery threshold V3](https://developer.xentral.com/reference/postapi-v3-products-productid-deliverythresholds.md): This endpoint requires the following scopes: `deliveryThreshold:create`. Create a product delivery threshold.
- [View stock details of a product](https://developer.xentral.com/reference/productviewstocks.md): Returns stock details of a given product
- [Creates variants for a matrix product](https://developer.xentral.com/reference/productcreatevariants.md): Creates variants for a matrix product
- [Create product option](https://developer.xentral.com/reference/productcreateoption.md): Creates new option for a product.
- [Update product option](https://developer.xentral.com/reference/productupdateoption.md): Updates a single option of a matrix product.
- [Create multiple product option values](https://developer.xentral.com/reference/productcreatemultiplevalues.md): Creates multiple values for an option of a matrix product.
- [List product option values](https://developer.xentral.com/reference/productlistvalues.md): Lists all values from an option of a matrix product.
- [List product options](https://developer.xentral.com/reference/productlistoptions.md): Returns a list of product's options
- [Update multiple product options](https://developer.xentral.com/reference/productupdatemultipleoptions.md): Updates multiple options of a product.
- [Delete multiple product options](https://developer.xentral.com/reference/productdeletemultipleoptions.md): Deletes multiple options of a product.
- [View product option value](https://developer.xentral.com/reference/productviewvalue.md): Returns details of a single value from an option of a matrix product.
- [Update product option value](https://developer.xentral.com/reference/productupdatevalue.md): Updates a single value from an option of a matrix product.
- [Delete product option value](https://developer.xentral.com/reference/productdeletevalue.md): Deletes a single value from an option of a matrix product.
- [Delete multiple product option values](https://developer.xentral.com/reference/productdeletemultiplevalues.md): Deletes multiple values from an option of a matrix product.
- [List cashiers](https://developer.xentral.com/reference/cashierlist.md): Lists all active cashiers.
- [Cashier PIN check](https://developer.xentral.com/reference/cashierpincheck.md): Checks a pin for cashier.
- [View cash register balance](https://developer.xentral.com/reference/cashregisterbalance.md): Retrieves the balance of a cash register.
- [List POS journals](https://developer.xentral.com/reference/journallist.md): Lists all active POS journals.
- [Add journal entry](https://developer.xentral.com/reference/journaladd.md): Add a new journal entry.
- [Add cash count entry](https://developer.xentral.com/reference/cashcountadd.md): Add a new cash count entry.
- [Add qr code data to a document](https://developer.xentral.com/reference/qrcodeadd.md): Add qr code data to a document.
- [🔒 Create production V3](https://developer.xentral.com/reference/postapi-v3-productions.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `production:create`. Create a new production.
- [List productions](https://developer.xentral.com/reference/productionlist.md): List Productions
- [🔒 List productions V3](https://developer.xentral.com/reference/getapi-v3-productions.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `production:read`. Paginated list of productions.
- [View production](https://developer.xentral.com/reference/productionview.md): View a production
- [🔒 View production V3](https://developer.xentral.com/reference/getapi-v3-productions-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `production:read`. View a single production.
- [Cancel production](https://developer.xentral.com/reference/productionactionscancel.md): Cancel the production
- [Delete production V3](https://developer.xentral.com/reference/deleteapi-v3-productions-id.md): This endpoint requires the following scopes: `production:delete`. Delete a production in status draft.
- [Release production](https://developer.xentral.com/reference/productionactionsrelease.md): Releases the production
- [Release production V3](https://developer.xentral.com/reference/patchapi-v3-productions-id-actions-release.md): This endpoint requires the following scopes: `production:release`. Release a production.
- [Start production V3](https://developer.xentral.com/reference/patchapi-v3-productions-id-actions-start.md): This endpoint requires the following scopes: `production:start`. Start a production.
- [Log custom production activity V3](https://developer.xentral.com/reference/patchapi-v3-productions-id-actions-logactivity.md): This endpoint requires the following scopes: `production:update`. Record a custom activity log entry for a production.
- [Attach file to production V3](https://developer.xentral.com/reference/postapi-v3-productions-id-files.md): This endpoint requires the following scopes: `production:update`. Attach a file to a production.
- [Update file on production V3](https://developer.xentral.com/reference/patchapi-v3-productions-id-files-fileid.md): This endpoint requires the following scopes: `production:update`. Update a file attached to a production.
- [Delete file from production V3](https://developer.xentral.com/reference/deleteapi-v3-productions-id-files-fileid.md): This endpoint requires the following scopes: `production:update`. Delete a file attached to a production.
- [🔒 Create sales price V3](https://developer.xentral.com/reference/postapi-v3-salesprices.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `salesPrice:create`. Create a new sales price.
- [🔒 List sales prices V3](https://developer.xentral.com/reference/getapi-v3-salesprices.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `salesPrice:read`. Paginated list of SalesPrices.
- [🔒 View sales price V3](https://developer.xentral.com/reference/getapi-v3-salesprices-id.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `salesPrice:read`. View a sales price.
- [🔒 Update multiple sales prices V3](https://developer.xentral.com/reference/patchapi-v3-salesprices.md): This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues. This endpoint requires the following scopes: `salesPrice:update`. Update multiple sales prices.
- [Delete sales price V3](https://developer.xentral.com/reference/deleteapi-v3-salesprices-id.md): This endpoint requires the following scopes: `salesPrice:delete`. Delete a sales price.
- [Send email via email account V3](https://developer.xentral.com/reference/patchapi-v3-emailaccounts-id-actions-sendemail.md): This endpoint requires the following scopes: `mailAcct:sendEmail`. Send an email using an existing email account. Attachments are base64-encoded with a max size of 10MB each (25MB total).
- [Send invoice](https://developer.xentral.com/reference/invoicesend.md): Send invoice
- [List delivery note deliveries](https://developer.xentral.com/reference/deliverynotedeliverieslist.md): Details of delivery note
- [Update multiple purchase prices V1](https://developer.xentral.com/reference/purchasepriceupdatemultiple.md): Updates multiple purchase prices
- [Update purchase price V1](https://developer.xentral.com/reference/purchasepriceupdate.md): Updates details of a single purchase price
- [List purchase prices V1](https://developer.xentral.com/reference/purchasepricelist.md): Returns list of a purchase prices
- [Create purchase price V1](https://developer.xentral.com/reference/purchasepricecreate.md): Creates new purchase price
- [Update parts v1](https://developer.xentral.com/reference/productupdateparts.md): Updates the parts of a product.
- [Create parts v1](https://developer.xentral.com/reference/productcreateparts.md): Creates new parts for a product.
- [List suppliers tags](https://developer.xentral.com/reference/suppliertaglist.md): Returns a collection with all suppliers tags.
- [List Invoice tags](https://developer.xentral.com/reference/invoicetaglist.md): Returns a collection with all invoice tags.
- [Update product tag](https://developer.xentral.com/reference/producttagupdate.md): Updates details of a single product tag
- [Create product tag](https://developer.xentral.com/reference/producttagcreate.md): Creates a new product tag.
- [List product tags](https://developer.xentral.com/reference/producttaglist.md): Returns a collection with all products tags.
- [List Credit Notes tags](https://developer.xentral.com/reference/creditnotetaglist.md): Returns a collection with all credit notes tags.
- [List delivery notes tags](https://developer.xentral.com/reference/deliverynotetaglist.md): Returns a collection with all delivery notes tags.
- [List storage items V1](https://developer.xentral.com/reference/storage_itemlist.md): Returns all storage location items for the specified warehouse / location. If no Accept header is provided, or if Accept: application/json is specified, the response format is identical to version 2.
- [List users](https://developer.xentral.com/reference/userlist.md): Returns a collection with all users.
- [Create new product V1](https://developer.xentral.com/reference/productcreate.md): Creates a new product.
Warning: Multiple request body content types
Due to technical limitations, the information provided here may not display all available request body content types. We are currently working with our third-party documentation provider to address this issue. For a complete and accurate representation of the available content types, we recommend referring to the full OpenAPI specification.
We apologize for any inconvenience caused and appreciate your understanding as we work to resolve this matter.
Available request content types:
- application/json
- application/vnd.xentral.upsert+json
- [List products V1](https://developer.xentral.com/reference/productlist.md): Returns a collection with all products.
- [View product v1](https://developer.xentral.com/reference/productview.md): Returns details of a single product
- [Update product v1](https://developer.xentral.com/reference/productupdate.md): Updates details of a single product
- [Update multiple products V1](https://developer.xentral.com/reference/productupdatemultiple.md): Updates multiple products
- [Identify product](https://developer.xentral.com/reference/productidentifyproduct.md): Returns a collection with all products found with the identifier. Evaluates barcode, product number, manufacturer number, foreign number and packaging unit.
- [Webhooks](https://developer.xentral.com/reference/webhooks.md)
- [Check the liveness of the service](https://developer.xentral.com/reference/xentralcarrierintegrationserviceliveness.md): The request a Xentral instance makes to an external carrier service to check the liveness of the service. This request will be made roughly every minute.
- [Get available carriers](https://developer.xentral.com/reference/xentralcarrierintegrationservicecarriers.md): The request a Xentral instance makes to an external carrier service to get a list of available carriers and their products. This request will be made when a user wants to create a new shipping method.
- [Create shipment](https://developer.xentral.com/reference/xentralcarrierintegrationserviceshipmentcreate.md): The request a Xentral instance makes to an external carrier service to generate a shipping label.
- [Get shipment](https://developer.xentral.com/reference/xentralcarrierintegrationserviceshipmentget.md): The request a Xentral instance makes to an external carrier service to get a shipment.
- [Cancel shipment](https://developer.xentral.com/reference/xentralcarrierintegrationserviceshipmentcancel.md): The request a Xentral instance makes to an external carrier service to cancel a shipment.
## Pages
- [Roadmap](https://developer.xentral.com/roadmap.md)
- [Webhooks](https://developer.xentral.com/webhooks.md)