Powered by Redocly

Product lines

Ticket product lines describe the services performed within a ticket.

Product line

product_id
string <uuid>

Product identifier.

ticket_id
string <uuid>

Ticket identifier.

quantity
integer <int32> >= 1

Quantity.

object (Customer Money)

The gross price of one unit of the product line. This is the product gross price of the referenced product at the time of adding this product line.

amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

object (Customer Money)

The gross price of the product line. This is calculated using unit_gross_price x quantity.

amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

object (Customer Money)

The order debtor discount for this product line.

This is the sum of the percentual discount and the monetary discount for the order debtor (customer) of the ticket.

For example:

Given

  • Gross price: €105.50
  • Order debtor percentual discount: 20.5%
  • Order debtor monetary discount: €5.50

Then the order debtor discount becomes:

(20.5% of €105.50) + €5.50 = 
€21.63 + €5.50 = 
€27.13
amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

order_debtor_monetary_discount
number <float> >= 0
Default: 0

The monetary discount for the order debtor (customer) of the ticket.

order_debtor_percentual_discount
number <float> [ 0 .. 100 ]
Default: 0

The percentual discount for the order debtor (customer) of the ticket. This defaults to the discount the order debtor (customer) receives according to its price list code.

object (Customer Money)

The invoice debtor discount for this product line.

This is the sum of the percentual discount and the monetary discount for the invoice debtor of the ticket's customer.

For example:

Given

  • Gross price: €105.50
  • Invoice debtor percentual discount: 30.5%
  • Invoice debtor monetary discount: €10.50

Then the invoice debtor discount becomes:

(30.5% of €105.50) + €10.50 = 
€32.18 + €10.50 =
€42.68
amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

invoice_debtor_monetary_discount
number <float> >= 0
Default: 0

The monetary discount for the invoice debtor of the ticket's customer.

invoice_debtor_percentual_discount
number <float> [ 0 .. 100 ]
Default: 0

The percentual discount for the invoice debtor of the ticket's customer. This defaults to the discount the invoice debtor receives according to its price list code.

object (Customer Money)

The original equipment service fee for this product line. This is the original equipment service fee of the referenced product at the time of adding this product line.

amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
  • "quantity": 1,
  • "unit_gross_price": {
    },
  • "gross_price": {
    },
  • "order_debtor_discount": {
    },
  • "order_debtor_monetary_discount": 5.5,
  • "order_debtor_percentual_discount": 20.5,
  • "invoice_debtor_discount": {
    },
  • "invoice_debtor_monetary_discount": 10.5,
  • "invoice_debtor_percentual_discount": 30.5,
  • "original_equipment_service_fee": {
    }
}

Retrieve ticket product lines

Retrieve a list of product lines belonging to a ticket.

SecurityOAuth2
Request
query Parameters
limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

ticket_created_after
string <date-time>

Return only product lines that are associated with tickets that are created after the provided date and time.

Example: ticket_created_after=2023-03-15T08:34:28Z
ticket_created_before
string <date-time>

Return only product lines that are associated with tickets that are created before the provided date and time.

Example: ticket_created_before=2023-03-15T08:34:28Z
ticket_finished_after
string <date-time>

Return only product lines that are associated with tickets that are finished after the provided date and time.

Example: ticket_finished_after=2023-03-15T08:34:28Z
ticket_finished_before
string <date-time>

Return only product lines that are associated with tickets that are finished before the provided date and time.

Example: ticket_finished_before=2023-03-15T08:34:28Z
ticket_id
string <uuid>

Filter product lines by ticket identifier.

ticket_state
Array of strings (Ticket-state) non-empty unique

Only return product lines that are associated with tickets that are in the provided state(s).

Items Enum Value Description
prepared

The ticket is prepared and can be used by a customer.

pending

The ticket is waiting to be worked on.

in_progress

The ticket is being worked by an operator.

outsourced

The ticket is outsourced to another provider.

closed

The ticket is successfully finished.

cancelled

The ticket is cancelled, see cancel_reason_id as to why.

Responses
200

Successful response.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

property name*
additional property
any
Array of objects (Product line) >= 0 items

List of product lines.

Array (>= 0 items)
product_id
string <uuid>

Product identifier.

ticket_id
string <uuid>

Ticket identifier.

quantity
integer <int32> >= 1

Quantity.

object (Customer Money)

The gross price of one unit of the product line. This is the product gross price of the referenced product at the time of adding this product line.

object (Customer Money)

The gross price of the product line. This is calculated using unit_gross_price x quantity.

object (Customer Money)

The order debtor discount for this product line.

This is the sum of the percentual discount and the monetary discount for the order debtor (customer) of the ticket.

For example:

Given

  • Gross price: €105.50
  • Order debtor percentual discount: 20.5%
  • Order debtor monetary discount: €5.50

Then the order debtor discount becomes:

(20.5% of €105.50) + €5.50 = 
€21.63 + €5.50 = 
€27.13
order_debtor_monetary_discount
number <float> >= 0
Default: 0

The monetary discount for the order debtor (customer) of the ticket.

order_debtor_percentual_discount
number <float> [ 0 .. 100 ]
Default: 0

The percentual discount for the order debtor (customer) of the ticket. This defaults to the discount the order debtor (customer) receives according to its price list code.

object (Customer Money)

The invoice debtor discount for this product line.

This is the sum of the percentual discount and the monetary discount for the invoice debtor of the ticket's customer.

For example:

Given

  • Gross price: €105.50
  • Invoice debtor percentual discount: 30.5%
  • Invoice debtor monetary discount: €10.50

Then the invoice debtor discount becomes:

(30.5% of €105.50) + €10.50 = 
€32.18 + €10.50 =
€42.68
invoice_debtor_monetary_discount
number <float> >= 0
Default: 0

The monetary discount for the invoice debtor of the ticket's customer.

invoice_debtor_percentual_discount
number <float> [ 0 .. 100 ]
Default: 0

The percentual discount for the invoice debtor of the ticket's customer. This defaults to the discount the invoice debtor receives according to its price list code.

object (Customer Money)

The original equipment service fee for this product line. This is the original equipment service fee of the referenced product at the time of adding this product line.

total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/tickets/product-lines
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Add ticket product line

Add a product line to a ticket.

SecurityOAuth2
Request
Request Body schema: application/json
required

The product line you want to add.

product_id
required
string <uuid>

Product identifier.

ticket_id
required
string <uuid>

Ticket identifier.

quantity
required
integer <int32> >= 1

Quantity.

order_debtor_monetary_discount
number <float> >= 0
Default: 0

The monetary discount for the order debtor (customer) of the ticket.

order_debtor_percentual_discount
number <float> [ 0 .. 100 ]
Default: 0

The percentual discount for the order debtor (customer) of the ticket. This defaults to the discount the order debtor (customer) receives according to its price list code.

invoice_debtor_monetary_discount
number <float> >= 0
Default: 0

The monetary discount for the invoice debtor of the ticket's customer.

invoice_debtor_percentual_discount
number <float> [ 0 .. 100 ]
Default: 0

The percentual discount for the invoice debtor of the ticket's customer. This defaults to the discount the invoice debtor receives according to its price list code.

Responses
200

Successful response.

Response Schema: application/json
product_id
string <uuid>

Product identifier.

ticket_id
string <uuid>

Ticket identifier.

quantity
integer <int32> >= 1

Quantity.

object (Customer Money)

The gross price of one unit of the product line. This is the product gross price of the referenced product at the time of adding this product line.

amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

object (Customer Money)

The gross price of the product line. This is calculated using unit_gross_price x quantity.

amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

object (Customer Money)

The order debtor discount for this product line.

This is the sum of the percentual discount and the monetary discount for the order debtor (customer) of the ticket.

For example:

Given

  • Gross price: €105.50
  • Order debtor percentual discount: 20.5%
  • Order debtor monetary discount: €5.50

Then the order debtor discount becomes:

(20.5% of €105.50) + €5.50 = 
€21.63 + €5.50 = 
€27.13
amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

order_debtor_monetary_discount
number <float> >= 0
Default: 0

The monetary discount for the order debtor (customer) of the ticket.

order_debtor_percentual_discount
number <float> [ 0 .. 100 ]
Default: 0

The percentual discount for the order debtor (customer) of the ticket. This defaults to the discount the order debtor (customer) receives according to its price list code.

object (Customer Money)

The invoice debtor discount for this product line.

This is the sum of the percentual discount and the monetary discount for the invoice debtor of the ticket's customer.

For example:

Given

  • Gross price: €105.50
  • Invoice debtor percentual discount: 30.5%
  • Invoice debtor monetary discount: €10.50

Then the invoice debtor discount becomes:

(30.5% of €105.50) + €10.50 = 
€32.18 + €10.50 =
€42.68
amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

invoice_debtor_monetary_discount
number <float> >= 0
Default: 0

The monetary discount for the invoice debtor of the ticket's customer.

invoice_debtor_percentual_discount
number <float> [ 0 .. 100 ]
Default: 0

The percentual discount for the invoice debtor of the ticket's customer. This defaults to the discount the invoice debtor receives according to its price list code.

object (Customer Money)

The original equipment service fee for this product line. This is the original equipment service fee of the referenced product at the time of adding this product line.

amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

default

An error occurred - see status code and problem response for more information.

post/v2/tickets/product-lines
Request samples
application/json
{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
  • "quantity": 1,
  • "order_debtor_monetary_discount": 5.5,
  • "order_debtor_percentual_discount": 20.5,
  • "invoice_debtor_monetary_discount": 10.5,
  • "invoice_debtor_percentual_discount": 30.5
}
Response samples
application/json
{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
  • "quantity": 1,
  • "unit_gross_price": {
    },
  • "gross_price": {
    },
  • "order_debtor_discount": {
    },
  • "order_debtor_monetary_discount": 5.5,
  • "order_debtor_percentual_discount": 20.5,
  • "invoice_debtor_discount": {
    },
  • "invoice_debtor_monetary_discount": 10.5,
  • "invoice_debtor_percentual_discount": 30.5,
  • "original_equipment_service_fee": {
    }
}

Retrieve ticket product line

Retrieve a ticket product line by its identifier.

SecurityOAuth2
Request
path Parameters
product-id
required
string <uuid>

The identifier of the product.

ticket-id
required
string <uuid>

The identifier of the ticket of which you want to handle a product line.

Responses
200

Successful response.

Response Schema: application/json
product_id
string <uuid>

Product identifier.

ticket_id
string <uuid>

Ticket identifier.

quantity
integer <int32> >= 1

Quantity.

object (Customer Money)

The gross price of one unit of the product line. This is the product gross price of the referenced product at the time of adding this product line.

amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

object (Customer Money)

The gross price of the product line. This is calculated using unit_gross_price x quantity.

amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

object (Customer Money)

The order debtor discount for this product line.

This is the sum of the percentual discount and the monetary discount for the order debtor (customer) of the ticket.

For example:

Given

  • Gross price: €105.50
  • Order debtor percentual discount: 20.5%
  • Order debtor monetary discount: €5.50

Then the order debtor discount becomes:

(20.5% of €105.50) + €5.50 = 
€21.63 + €5.50 = 
€27.13
amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

order_debtor_monetary_discount
number <float> >= 0
Default: 0

The monetary discount for the order debtor (customer) of the ticket.

order_debtor_percentual_discount
number <float> [ 0 .. 100 ]
Default: 0

The percentual discount for the order debtor (customer) of the ticket. This defaults to the discount the order debtor (customer) receives according to its price list code.

object (Customer Money)

The invoice debtor discount for this product line.

This is the sum of the percentual discount and the monetary discount for the invoice debtor of the ticket's customer.

For example:

Given

  • Gross price: €105.50
  • Invoice debtor percentual discount: 30.5%
  • Invoice debtor monetary discount: €10.50

Then the invoice debtor discount becomes:

(30.5% of €105.50) + €10.50 = 
€32.18 + €10.50 =
€42.68
amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

invoice_debtor_monetary_discount
number <float> >= 0
Default: 0

The monetary discount for the invoice debtor of the ticket's customer.

invoice_debtor_percentual_discount
number <float> [ 0 .. 100 ]
Default: 0

The percentual discount for the invoice debtor of the ticket's customer. This defaults to the discount the invoice debtor receives according to its price list code.

object (Customer Money)

The original equipment service fee for this product line. This is the original equipment service fee of the referenced product at the time of adding this product line.

amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

default

An error occurred - see status code and problem response for more information.

get/v2/tickets/product-lines/{ticket-id}/{product-id}
Response samples
application/json
{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
  • "quantity": 1,
  • "unit_gross_price": {
    },
  • "gross_price": {
    },
  • "order_debtor_discount": {
    },
  • "order_debtor_monetary_discount": 5.5,
  • "order_debtor_percentual_discount": 20.5,
  • "invoice_debtor_discount": {
    },
  • "invoice_debtor_monetary_discount": 10.5,
  • "invoice_debtor_percentual_discount": 30.5,
  • "original_equipment_service_fee": {
    }
}

Update ticket product line

Update a ticket product line by its identifier.

SecurityOAuth2
Request
path Parameters
product-id
required
string <uuid>

The identifier of the product.

ticket-id
required
string <uuid>

The identifier of the ticket of which you want to handle a product line.

Request Body schema: application/json
required

The product line you want to update.

quantity
required
integer <int32> >= 1

Quantity.

order_debtor_monetary_discount
number <float> >= 0
Default: 0

The monetary discount for the order debtor (customer) of the ticket.

order_debtor_percentual_discount
number <float> [ 0 .. 100 ]
Default: 0

The percentual discount for the order debtor (customer) of the ticket. This defaults to the discount the order debtor (customer) receives according to its price list code.

invoice_debtor_monetary_discount
number <float> >= 0
Default: 0

The monetary discount for the invoice debtor of the ticket's customer.

invoice_debtor_percentual_discount
number <float> [ 0 .. 100 ]
Default: 0

The percentual discount for the invoice debtor of the ticket's customer. This defaults to the discount the invoice debtor receives according to its price list code.

Responses
200

Successful response.

Response Schema: application/json
product_id
string <uuid>

Product identifier.

ticket_id
string <uuid>

Ticket identifier.

quantity
integer <int32> >= 1

Quantity.

object (Customer Money)

The gross price of one unit of the product line. This is the product gross price of the referenced product at the time of adding this product line.

amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

object (Customer Money)

The gross price of the product line. This is calculated using unit_gross_price x quantity.

amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

object (Customer Money)

The order debtor discount for this product line.

This is the sum of the percentual discount and the monetary discount for the order debtor (customer) of the ticket.

For example:

Given

  • Gross price: €105.50
  • Order debtor percentual discount: 20.5%
  • Order debtor monetary discount: €5.50

Then the order debtor discount becomes:

(20.5% of €105.50) + €5.50 = 
€21.63 + €5.50 = 
€27.13
amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

order_debtor_monetary_discount
number <float> >= 0
Default: 0

The monetary discount for the order debtor (customer) of the ticket.

order_debtor_percentual_discount
number <float> [ 0 .. 100 ]
Default: 0

The percentual discount for the order debtor (customer) of the ticket. This defaults to the discount the order debtor (customer) receives according to its price list code.

object (Customer Money)

The invoice debtor discount for this product line.

This is the sum of the percentual discount and the monetary discount for the invoice debtor of the ticket's customer.

For example:

Given

  • Gross price: €105.50
  • Invoice debtor percentual discount: 30.5%
  • Invoice debtor monetary discount: €10.50

Then the invoice debtor discount becomes:

(30.5% of €105.50) + €10.50 = 
€32.18 + €10.50 =
€42.68
amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

invoice_debtor_monetary_discount
number <float> >= 0
Default: 0

The monetary discount for the invoice debtor of the ticket's customer.

invoice_debtor_percentual_discount
number <float> [ 0 .. 100 ]
Default: 0

The percentual discount for the invoice debtor of the ticket's customer. This defaults to the discount the invoice debtor receives according to its price list code.

object (Customer Money)

The original equipment service fee for this product line. This is the original equipment service fee of the referenced product at the time of adding this product line.

amount
number <float>

The monetary amount in the currency of the provider.

currency
string <iso-4217>

The currency of the monetary amount of the provider.

customer_amount
number <float>

The monetary amount in the currency of the customer. The exchange rate that was available when the ticket was created is used which, under normal operating circumstances, is the determined at the beginning of each day. This is done to the best of our ability. Use at own risk.

customer_currency
string <iso-4217>

The currency of the monetary amount of the customer as available when the ticket was created.

default

An error occurred - see status code and problem response for more information.

put/v2/tickets/product-lines/{ticket-id}/{product-id}
Request samples
application/json
{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
  • "quantity": 1,
  • "order_debtor_monetary_discount": 5.5,
  • "order_debtor_percentual_discount": 20.5,
  • "invoice_debtor_monetary_discount": 10.5,
  • "invoice_debtor_percentual_discount": 30.5
}
Response samples
application/json
{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "ticket_id": "595be628-f6f2-4262-9c10-6389c6c4a5b8",
  • "quantity": 1,
  • "unit_gross_price": {
    },
  • "gross_price": {
    },
  • "order_debtor_discount": {
    },
  • "order_debtor_monetary_discount": 5.5,
  • "order_debtor_percentual_discount": 20.5,
  • "invoice_debtor_discount": {
    },
  • "invoice_debtor_monetary_discount": 10.5,
  • "invoice_debtor_percentual_discount": 30.5,
  • "original_equipment_service_fee": {
    }
}

Remove ticket product line

Remove a ticket product line by its identifier.

SecurityOAuth2
Request
path Parameters
product-id
required
string <uuid>

The identifier of the product.

ticket-id
required
string <uuid>

The identifier of the ticket of which you want to handle a product line.

Responses
204

Successfully removed.

default

An error occurred - see status code and problem response for more information.

delete/v2/tickets/product-lines/{ticket-id}/{product-id}
Response samples
application/problem+json

Returned when the request cannot be handled due to something that is perceived to be a client error.

{
  • "detail": "The request violates one or more constraints. Please resolve all of them and try again.",
  • "status": 400,
  • "title": "Bad request",
  • "type": "/problems/violations",
  • "violations": [
    ]
}
➔ Next to Outsources