Invoices

Invoices are statements of amounts payed for by a customer. They consist of multiple Invoice Items and are usually created when a Transaction completes.

Endpoints

The invoice object

Attributes

_id
Required
string

The ID of the invoice.

sellerId
Required
string

The ID of the seller associated with the invoice.

recipient
Required
object

Information on the recipient of the invoice.

recipient.name
Required
string

The name of the recipient.

recipient.firstname
Required
string

The first name of the recipient.

recipient.lastname
Required
string

The last name of the recipient.

Optional Attributes

Collapse all
counter
Required
number float

The counter used to create no.

no
Required
string

A unique number for the invoice consisting of the creation date and an increasing counter.

items
Required
array

An array of invoice items.

items[].title
Required
string

The title of the invoice item.

items[].amount
Required
number float

The amount of the invoice item.

items[].total
Required
number float

The total of the invoice item.

items[].regularTotal
Required
number float

The non-discounted total of the invoice item.

items[].includedTax
Required
number float

The total of taxes included in the invoice item.

items[].taxRate
Required
number float

The tax rate applied on the invoice item.

Optional Attributes

Collapse all
currency
Required
string

An ISO 4217 3-character code of the currency.

EURUSDGBPAUDCHFTHBILSCOPMXNDKKNOKSEKQARCADISKGTQINRDOPSGDPLNSARTTDZARKYDHKDCZKKRWJPYNZDAEDMADTWD

Optional Attributes

Collapse all
Was this section helpful?
YesNo
Example
{
"_id": "string",
"type": "invoice",
"sellerId": "string",
"recipient": {
"company": "string",
"name": "string",
"firstname": "string",
"lastname": "string",
"address": {
"street": "string",
"line2": "string",
"postal": "string",
"city": "string",
"country": "string",
"state": "string"
}
},
"transactionId": "string",
"cancellationId": "string",
"counter": 10.5,
"no": "string",
"items": [
{
"type": "product",
"title": "string",
"amount": 10.5,
"total": 10.5,
"regularTotal": 10.5,
"includedTax": 10.5,
"taxRate": 10.5
}
],
"total": 10.5,
"discountSum": 10.5,
"detailsPerRate": [
{
"taxRate": 10.5,
"includedTax": 10.5,
"reducedTax": 10.5
}
],
"taxItems": [
{
"name": "string",
"taxTypeId": "string",
"rate": 10.5,
"perUnit": 10.5,
"total": 10.5,
"taxPayableAccountId": "string",
"taxPayableAccountCode": "string"
}
],
"includedTax": 10.5,
"taxRate": 10.5,
"includedOuterChargeTax": 10.5,
"outerChargeTaxRate": 10.5,
"origin": "onlinesale",
"currency": "EUR",
"extraFields": {},
"secret": "string",
"referenceInvoiceId": "string",
"footerText": [
"string"
],
"createdAt": "2030-01-23T23:00:00.123Z",
"updatedAt": "2030-01-23T23:00:00.123Z"
}

Get All Invoices

Query

top
Optional
number float

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip
Optional
number float

The number of objects to skip for the requested result

transactionId
Optional
string
no
Optional
string

The invoice number to filter for.

createdAt
Optional
object

The range of dates indicating when the invoice was created in ISO format.

Optional Attributes

Collapse all
type
Optional
array<string>

The invoice type to filter for.

Responses
200
OK
400
Bad Request
401
Unauthorized

Was this section helpful?

YesNo
get
/api/invoices
Response
application/json
{
"rows": [
{
"_id": "string",
"type": "invoice",
"sellerId": "string",
"recipient": {
"company": "string",
"name": "string",
"firstname": "string",
"lastname": "string",
"address": {
"street": "string",
"line2": "string",
"postal": "string",
"city": "string",
"country": "string",
"state": "string"
}
},
"transactionId": "string",
"cancellationId": "string",
"counter": 10.5,
"no": "string",
"items": [
{
"type": "product",
"title": "string",
"amount": 10.5,
"total": 10.5,
"regularTotal": 10.5,
"includedTax": 10.5,
"taxRate": 10.5
}
],
"total": 10.5,
"discountSum": 10.5,
"detailsPerRate": [
{
"taxRate": 10.5,
"includedTax": 10.5,
"reducedTax": 10.5
}
],
"taxItems": [
{
"name": "string",
"taxTypeId": "string",
"rate": 10.5,
"perUnit": 10.5,
"total": 10.5,
"taxPayableAccountId": "string",
"taxPayableAccountCode": "string"
}
],
"includedTax": 10.5,
"taxRate": 10.5,
"includedOuterChargeTax": 10.5,
"outerChargeTaxRate": 10.5,
"origin": "onlinesale",
"currency": "EUR",
"extraFields": {},
"secret": "string",
"referenceInvoiceId": "string",
"footerText": [
"string"
],
"createdAt": "2030-01-23T23:00:00.123Z",
"updatedAt": "2030-01-23T23:00:00.123Z"
}
],
"total": 1
}

Get an Invoice

Query

No supported query parameters
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found

Was this section helpful?

YesNo
get
/api/invoices/{id}
Response
application/json
{
"_id": "string",
"type": "invoice",
"sellerId": "string",
"recipient": {
"company": "string",
"name": "string",
"firstname": "string",
"lastname": "string",
"address": {
"street": "string",
"line2": "string",
"postal": "string",
"city": "string",
"country": "string",
"state": "string"
}
},
"transactionId": "string",
"cancellationId": "string",
"counter": 10.5,
"no": "string",
"items": [
{
"type": "product",
"title": "string",
"amount": 10.5,
"total": 10.5,
"regularTotal": 10.5,
"includedTax": 10.5,
"taxRate": 10.5
}
],
"total": 10.5,
"discountSum": 10.5,
"detailsPerRate": [
{
"taxRate": 10.5,
"includedTax": 10.5,
"reducedTax": 10.5
}
],
"taxItems": [
{
"name": "string",
"taxTypeId": "string",
"rate": 10.5,
"perUnit": 10.5,
"total": 10.5,
"taxPayableAccountId": "string",
"taxPayableAccountCode": "string"
}
],
"includedTax": 10.5,
"taxRate": 10.5,
"includedOuterChargeTax": 10.5,
"outerChargeTaxRate": 10.5,
"origin": "onlinesale",
"currency": "EUR",
"extraFields": {},
"secret": "string",
"referenceInvoiceId": "string",
"footerText": [
"string"
],
"createdAt": "2030-01-23T23:00:00.123Z",
"updatedAt": "2030-01-23T23:00:00.123Z"
}

Get Invoice for Transaction

Query

No supported query parameters
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found

Was this section helpful?

YesNo
get
/api/invoices/trans/{transactionId}
Response
application/json
{
"_id": "string",
"type": "invoice",
"sellerId": "string",
"recipient": {
"company": "string",
"name": "string",
"firstname": "string",
"lastname": "string",
"address": {
"street": "string",
"line2": "string",
"postal": "string",
"city": "string",
"country": "string",
"state": "string"
}
},
"transactionId": "string",
"cancellationId": "string",
"counter": 10.5,
"no": "string",
"items": [
{
"type": "product",
"title": "string",
"amount": 10.5,
"total": 10.5,
"regularTotal": 10.5,
"includedTax": 10.5,
"taxRate": 10.5
}
],
"total": 10.5,
"discountSum": 10.5,
"detailsPerRate": [
{
"taxRate": 10.5,
"includedTax": 10.5,
"reducedTax": 10.5
}
],
"taxItems": [
{
"name": "string",
"taxTypeId": "string",
"rate": 10.5,
"perUnit": 10.5,
"total": 10.5,
"taxPayableAccountId": "string",
"taxPayableAccountCode": "string"
}
],
"includedTax": 10.5,
"taxRate": 10.5,
"includedOuterChargeTax": 10.5,
"outerChargeTaxRate": 10.5,
"origin": "onlinesale",
"currency": "EUR",
"extraFields": {},
"secret": "string",
"referenceInvoiceId": "string",
"footerText": [
"string"
],
"createdAt": "2030-01-23T23:00:00.123Z",
"updatedAt": "2030-01-23T23:00:00.123Z"
}

Create Invoice for Transaction

Query

No supported query parameters
Responses
201
Created
400
Bad Request
401
Unauthorized
404
Not Found

Was this section helpful?

YesNo
post
/api/invoices/trans/{transactionId}
Response
application/json
{
"_id": "string",
"type": "invoice",
"sellerId": "string",
"recipient": {
"company": "string",
"name": "string",
"firstname": "string",
"lastname": "string",
"address": {
"street": "string",
"line2": "string",
"postal": "string",
"city": "string",
"country": "string",
"state": "string"
}
},
"transactionId": "string",
"cancellationId": "string",
"counter": 10.5,
"no": "string",
"items": [
{
"type": "product",
"title": "string",
"amount": 10.5,
"total": 10.5,
"regularTotal": 10.5,
"includedTax": 10.5,
"taxRate": 10.5
}
],
"total": 10.5,
"discountSum": 10.5,
"detailsPerRate": [
{
"taxRate": 10.5,
"includedTax": 10.5,
"reducedTax": 10.5
}
],
"taxItems": [
{
"name": "string",
"taxTypeId": "string",
"rate": 10.5,
"perUnit": 10.5,
"total": 10.5,
"taxPayableAccountId": "string",
"taxPayableAccountCode": "string"
}
],
"includedTax": 10.5,
"taxRate": 10.5,
"includedOuterChargeTax": 10.5,
"outerChargeTaxRate": 10.5,
"origin": "onlinesale",
"currency": "EUR",
"extraFields": {},
"secret": "string",
"referenceInvoiceId": "string",
"footerText": [
"string"
],
"createdAt": "2030-01-23T23:00:00.123Z",
"updatedAt": "2030-01-23T23:00:00.123Z"
}
PUBLIC

Get Public Invoice for Transaction

Query

No supported query parameters
Responses
200
OK
400
Bad Request
404
Not Found

Was this section helpful?

YesNo
get
/api/invoices/{transactionId}/info/{secret}
Response
application/json
{
"trans": {
"_id": "string",
"sellerId": "string",
"customerId": "string",
"eventId": "string",
"company": "string",
"name": "string",
"prename": "string",
"lastname": "string",
"email": "[email protected]",
"street": "string",
"line2": "string",
"city": "string",
"state": "string",
"country": "string",
"postal": "string",
"deliveryAddress": {
"street": "string",
"line2": "string",
"postal": "string",
"city": "string",
"country": "string",
"state": "string",
"name": "string"
},
"tickets": [],
"products": [],
"additionalItems": [],
"currency": "EUR",
"regularPrice": 10.5,
"realPrice": 10.5,
"paymentCharge": 10.5,
"innerCharge": 10.5,
"outerCharge": 10.5,
"innerFeeComponents": {
"_id": "string",
"fix": [
{
"_id": "string",
"amount": 10.5,
"value": 10.5,
"total": 10.5,
"type": "onTicket",
"name": "string",
"exposed": true,
"scheme": {
"schemeId": "string",
"feeId": "string"
}
}
],
"var": [
{
"_id": "string",
"amount": 10.5,
"value": 10.5,
"total": 10.5,
"type": "onTicket",
"name": "string",
"exposed": true,
"scheme": {
"schemeId": "string",
"feeId": "string"
}
}
]
},
"outerFeeComponents": {
"_id": "string",
"fix": [
{
"_id": "string",
"amount": 10.5,
"value": 10.5,
"total": 10.5,
"type": "onTicket",
"name": "string",
"exposed": true,
"scheme": {
"schemeId": "string",
"feeId": "string"
}
}
],
"var": [
{
"_id": "string",
"amount": 10.5,
"value": 10.5,
"total": 10.5,
"type": "onTicket",
"name": "string",
"exposed": true,
"scheme": {
"schemeId": "string",
"feeId": "string"
}
}
]
},
"cancellationFee": {
"_id": "string",
"amount": 10.5,
"value": 10.5,
"total": 10.5,
"type": "onTicket",
"name": "string",
"exposed": true,
"scheme": {
"schemeId": "string",
"feeId": "string"
}
},
"cancellationInfo": {
"cancellableItems": [
{
"cartItemId": "string",
"type": "ticket",
"name": "string",
"price": 10.5,
"taxRate": 10.5,
"origin": {
"fee": {
"_id": "string",
"amount": 10.5,
"value": 10.5,
"total": 10.5,
"type": "onTicket",
"name": "string",
"exposed": true,
"scheme": {
"schemeId": "string",
"feeId": "string"
}
}
},
"cancellationFee": {
"_id": "string",
"amount": 10.5,
"value": 10.5,
"total": 10.5,
"type": "onTicket",
"name": "string",
"exposed": true,
"scheme": {
"schemeId": "string",
"feeId": "string"
}
},
"refundId": "string",
"cancelledAt": "2030-01-23T23:00:00.123Z"
}
]
},
"taxRate": 0.19,
"createdAt": "2030-01-23T23:00:00.123Z",
"updatedAt": "2030-01-23T23:00:00.123Z",
"status": "NEW",
"psp": "string",
"paymentMethod": "adyen",
"paymentInfo": {
"_id": "string",
"psp": "string",
"gateway": "managed",
"providerType": "vivenu",
"providerId": "string",
"method": "string",
"methodVariant": "string",
"locale": "string",
"riskLevel": "string",
"riskScore": 10.5,
"refundId": "string",
"collectedApplicationFee": 10.5
},
"paymentStatus": "AWAITING",
"origin": "yourticket",
"userId": "string",
"posId": "string",
"posInfo": {
"_id": "string",
"sessionId": "string",
"billingNo": "string",
"taxId": "string",
"paymentMethod": "cash",
"canceledAt": "2030-01-23T23:00:00.123Z",
"cancellationNo": "2030-01-23T23:00:00.123Z"
},
"history": [
{
"_id": "string",
"date": "2030-01-23T23:00:00.123Z",
"title": "string",
"message": "string",
"type": "YOURTICKET",
"risk": "NEUTRAL"
}
],
"historyEntries": [
{
"_id": "string",
"date": "2030-01-23T23:00:00.123Z",
"userId": "string",
"data": {},
"type": "created",
"risk": "NEUTRAL"
}
],
"ticketMailSend": true,
"orderMailSend": true,
"extraFields": {},
"channel": "string",
"underShop": "string",
"userAgent": {
"_id": "string",
"ua": "string",
"browser": {},
"device": {},
"engine": {},
"os": {},
"cpu": {}
},
"ipLookup": {
"ip": "string",
"lookup": {
"range": [
10.5
],
"country": "string",
"region": "string",
"eu": "string",
"timezone": "string",
"city": "string",
"ll": [
10.5
],
"metro": 10.5,
"area": 10.5
}
},
"locationCenter": [
10.5
],
"secret": "string",
"vouchers": [
"string"
],
"redeemedVouchers": {
"totalRedeemedAmount": 10.5,
"vouchers": [
{
"_id": "string",
"code": "string",
"redeemedAmount": 10.5
}
]
},
"appliedCoupons": [
{
"_id": "string",
"code": "string"
}
],
"appliedDiscountGroups": [
"string"
],
"posDiscounts": [
{
"_id": "string",
"name": "string",
"discountType": "fix",
"value": 10.5
}
],
"preferredLanguage": "de",
"cancellationReason": "REQUESTED_BY_CUSTOMER",
"appliedDiscountInfo": {
"items": [
{
"_id": "string",
"itemId": "string",
"amount": 10.5,
"regularPrice": 10.5,
"price": 10.5,
"varDiscounts": [
{
"_id": "string",
"discountId": "string",
"category": "coupon",
"name": "string",
"type": "fix",
"value": 10.5,
"allowedItems": [
"string"
]
}
],
"fixDiscounts": [
{
"_id": "string",
"discountId": "string",
"category": "coupon",
"name": "string",
"type": "fix",
"value": 10.5,
"allowedItems": [
"string"
]
}
]
}
],
"discounts": [
{
"_id": "string",
"discountId": "string",
"category": "coupon",
"name": "string",
"type": "fix",
"value": 10.5,
"allowedItems": [
"string"
],
"maxItemsInCart": 10.5,
"maxAbsoluteValue": 10.5,
"absoluteDiscountValue": 10.5
}
]
},
"invoiceVersion": "v2",
"seatingReservationToken": "string"
},
"invoice": {
"_id": "string",
"type": "invoice",
"sellerId": "string",
"recipient": {
"company": "string",
"name": "string",
"firstname": "string",
"lastname": "string",
"address": {
"street": "string",
"line2": "string",
"postal": "string",
"city": "string",
"country": "string",
"state": "string"
}
},
"transactionId": "string",
"cancellationId": "string",
"counter": 10.5,
"no": "string",
"items": [
{
"type": "product",
"title": "string",
"amount": 10.5,
"total": 10.5,
"regularTotal": 10.5,
"includedTax": 10.5,
"taxRate": 10.5
}
],
"total": 10.5,
"discountSum": 10.5,
"detailsPerRate": [
{
"taxRate": 10.5,
"includedTax": 10.5,
"reducedTax": 10.5
}
],
"taxItems": [
{
"name": "string",
"taxTypeId": "string",
"rate": 10.5,
"perUnit": 10.5,
"total": 10.5,
"taxPayableAccountId": "string",
"taxPayableAccountCode": "string"
}
],
"includedTax": 10.5,
"taxRate": 10.5,
"includedOuterChargeTax": 10.5,
"outerChargeTaxRate": 10.5,
"origin": "onlinesale",
"currency": "EUR",
"extraFields": {},
"secret": "string",
"referenceInvoiceId": "string",
"footerText": [
"string"
],
"createdAt": "2030-01-23T23:00:00.123Z",
"updatedAt": "2030-01-23T23:00:00.123Z"
},
"referenceInvoice": {
"_id": "string",
"type": "invoice",
"sellerId": "string",
"recipient": {
"company": "string",
"name": "string",
"firstname": "string",
"lastname": "string",
"address": {
"street": "string",
"line2": "string",
"postal": "string",
"city": "string",
"country": "string",
"state": "string"
}
},
"transactionId": "string",
"cancellationId": "string",
"counter": 10.5,
"no": "string",
"items": [
{
"type": "product",
"title": "string",
"amount": 10.5,
"total": 10.5,
"regularTotal": 10.5,
"includedTax": 10.5,
"taxRate": 10.5
}
],
"total": 10.5,
"discountSum": 10.5,
"detailsPerRate": [
{
"taxRate": 10.5,
"includedTax": 10.5,
"reducedTax": 10.5
}
],
"taxItems": [
{
"name": "string",
"taxTypeId": "string",
"rate": 10.5,
"perUnit": 10.5,
"total": 10.5,
"taxPayableAccountId": "string",
"taxPayableAccountCode": "string"
}
],
"includedTax": 10.5,
"taxRate": 10.5,
"includedOuterChargeTax": 10.5,
"outerChargeTaxRate": 10.5,
"origin": "onlinesale",
"currency": "EUR",
"extraFields": {},
"secret": "string",
"referenceInvoiceId": "string",
"footerText": [
"string"
],
"createdAt": "2030-01-23T23:00:00.123Z",
"updatedAt": "2030-01-23T23:00:00.123Z"
},
"seller": {
"_id": "string",
"image": "string",
"name": "string",
"city": "string",
"documentSettings": {
"image": "string",
"invoice": {
"footerColumns": [
{
"text": "string",
"active": true
}
]
}
},
"street": "string",
"postal": "string",
"locationName": "string",
"country": "string",
"taxRate": 0.19,
"taxNo": "string",
"localTaxName": "string"
},
"customer": {
"_id": "string",
"company": "string",
"name": "string",
"prename": "string",
"lastname": "string",
"image": "string",
"primaryEmail": "[email protected]",
"number": 10.5,
"phone": "string",
"location": {
"street": "string",
"line2": "string",
"postal": "string",
"city": "string",
"locale": "string",
"state": "string",
"center": [
10.5
],
"country": "string"
},
"transactions": [
"string"
],
"sellerId": "string",
"notes": "string",
"extraFields": {},
"tags": [
"string"
],
"blocked": true,
"verified": true,
"_account": {
"verificationToken": "string",
"passwordResetToken": "string",
"limitations": {
"nextVerificationMailRequest": "2030-01-23T23:00:00.123Z"
},
"loginType": "password"
},
"meta": {},
"createdAt": "2030-01-23T23:00:00.123Z",
"updatedAt": "2030-01-23T23:00:00.123Z"
},
"timezone": "Europe/Amsterdam",
"customPaymentMethod": []
}