🔒 Create return order V3

post

https://{xentralId}.xentral.biz/api/v3/returnOrders

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.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

address

object

required

project

documentDate

date

Date of the document. Current date is used when omitted.

language

string

Language of the document in an ISO-639-1 format.

tags

array of objects

List of tags associated with the document. New tags will be automatically created if they do not exist.

tags

documentAddress

object

The recipients postal address of the document. If not provided, the address of the business partner will be used.

internalDesignation

string

length ≤ 255

Internal designation, might be displayed in the letterhead

bodyIntroduction

string

Introduction text for the body of the document

bodyOutroduction

string

Outroduction text for the body of the document

vatId

string

VAT ID of the business partner

deliveryTerms

string

Delivery terms for the document

internalComment

string

Internal comment for the document

printSettings

object

editor

object

Editor information

sales

object

Sales information

salesOrder

Linked sales order to the return order

creditNote

object | null

Credit note connected to the return order.

deliveryNote

object | null

Delivery note connected to the return order.

replacementSalesOrder

Replacement sales order connected to the return order.

customerOrderNumber

string

length ≤ 255

Customer order number of the return order.

progress

string

enum

Progress of the return order.

Allowed:

isReturnOrderToSupplier

boolean

Indicates whether this is a return order to a supplier.

lineItems

array of objects

List of line items for the return order

lineItems

Headers

accept

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json