/invoices/{id}

get https://example.com/api/finance/v1/invoices/{id}

This endpoint will return a single Invoice using its associated id as a path parameter.

Responses

Response body

object

string

required

length ≤ 64

Unique identifier for this invoice

uid

string

length ≤ 64

Internal unique identifier

number

string

required

length ≤ 64

Invoice number, a combination of store terminal and invoice

cancelled

boolean

date

date-time

required

DateTime of this invoice in ISO 8601 format

dateAdded

date-time

DateTime when the first article was added to this table (invoice), in ISO 8601 format

numberOfGuests

int32

Number of guests (if recorded during payment process)

location

object

store

object

required

terminal

object

required

shift

object

table

object

required

articles

array of objects

required

length between 1 and 9999

Sold articles on this invoice

articles*

object

string

required

length ≤ 64

Unique identifier for this invoice article

articleGroupId

string

length ≤ 64

Id of article group this article is attached to

plu

string

length ≤ 64

PLU of the article sold

name

string

length ≤ 64

Name of the article sold

basePrice

int32

Base price in smallest monetary unit (Cents/Rappen)

price

int32

required

Actual price this article has been sold in smallest monetary unit (Cents/Rappen)

quantity

int32

required

How many items are sold?

totalPrice

int32

required

Quantity times gross price, including discount if applicable

taxRate

int32

required

Tax rate applied times 100 (1900 equals 19%)

dateAdded

date-time

DateTime when this article was first added, in ISO 8601 format

isTakeAway

boolean

payment

object

waiter

object

cashChangeCurrency

string

Foreign currency changed if applicable

cashChangeExchanged

int32

Amount of foreign currency changed if applicable in smallest monetary unit

cashTenderedCurrency

string

Foreign currency tendered if applicable

cashTenderedExchanged

int32

Amount of foreign currency tendered if applicable in smallest monetary unit

discounts

array of objects

length between 1 and 99

Discounts applied on the whole invoice

discounts

object

string

required

length ≤ 64

Unique identifier for this discount

name

string

required

length ≤ 64

Name of this discount

type

integer

Describes the type of discount

1: absolute 2: percentage

amountInPercent

integer

The percentage amount for this discount times 100, e.g 5000 equals 50%.
This is only effective if type equals 2.

amountInCents

integer

The discounted amount in smallest monetary unit (Cent/Rappen).
This is only effective if type equals 1.

enterDiscountOnPaying

boolean

If this is set, the amount can be set freely during the payment process.

externalPLU

string | null

An external PLU has no meaning within helloTESS! and can be used for your reference, e.g. matching external id's.

active

boolean

Is this discount active?

methods

array of objects

length between 1 and 99

Payment methods being used to balance the invoice

methods

object

string

length ≤ 64

Unique identifier for this payment method

name

string

length ≤ 64

Name of this payment Method

amount

int32

Amount being payed with this payment method in smallest monetary unit

qrcode

string

userGroup

object

Has additional fields

taxRates

array of objects

required

length between 1 and 99

All applied tax rates for this invoice, summed up by tax rate

taxRates*

object

rate

int32

Tax rate

gross

int32

Gross amount

net

int32

Net amount

tax

int32

Tax amount

totals

object

gross

int32

Gross amount

net

int32

Net amount

tax

int32

Tax amount

subvention

int32

Subvention amount

surcharge

int32

Surcharge amount

customer

object

firstName

string

First name of this customer

surname

string

Last name of this customer

company

string

Company name of this customer

address1

string

Addressline one of this customer

address2

string

Addressline two of this customer

postalCode

string

Postalcode of this customer

city

string

City of this customer

country

string

Country of this customer

401

You are not unauthorized

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://example.com/api/finance/v1/invoices/id?exportLogo=false&format=json' \
3
     --header 'accept: application/json'

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

application/json

application/pdf

200return a specific invoice

400The response in case of a bad request