POST api/CustomerCardInformation

Provides information about a customer card

Request Information

URI Parameters

None.

Body Parameters

CustomerCardInformationRequestModel
NameDescriptionTypeAdditional information
MaxLastWashingResults

When set, the quantity of last washing items is limited to this value (optional). Value 0 prevent from returning last washings

integer

None.

CardNumber

The card number of the customer card If not available you can use the License Plate instead.

string

None.

CardUID

The UID of the customercard, if RFID card This is optional. The prefered identification should be done via the Card Number

integer

None.

LicensePlate

The license plate of the customer This is optional. The prefered identification should be done via the Card Number

string

None.

ClientNumber

The current Client Number (Unique POS ID number)

byte

None.

Request Formats

application/json, text/json

Sample:
{
  "MaxLastWashingResults": 1,
  "CardNumber": "sample string 1",
  "CardUID": 1,
  "LicensePlate": "sample string 2",
  "ClientNumber": 64
}

application/xml, text/xml

Sample:
<CustomerCardInformationRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CardNumber>sample string 1</CardNumber>
  <CardUID>1</CardUID>
  <LicensePlate>sample string 2</LicensePlate>
  <ClientNumber>64</ClientNumber>
  <MaxLastWashingResults>1</MaxLastWashingResults>
</CustomerCardInformationRequestModel>

Response Information

Resource Description

CustomerCardInformationResponseModel
NameDescriptionTypeAdditional information
CardNumber

CardNumber

string

None.

IsLocked

When true, the card is locked and can not be used

boolean

None.

Credit

The current credits of a prepaid card or the credit line, if it's an credit card

decimal number

None.

IsCreditCard

When false, it is a normal prepaid card, when true it is a credit card

boolean

None.

Birthday

Information about the Birthday

BirthdayWashInformationData

None.

CustomerData

Stored data about the customer

CustomerData

None.

CardMessage

The card message

string

None.

Bonus

Information about the Boni of an card

CardBonusInformation

None.

LastWashings

The last washings

Collection of WashingItem

None.

Response Formats

application/json, text/json

Sample:
{
  "CardNumber": "sample string 1",
  "IsLocked": true,
  "Credit": 3.0,
  "IsCreditCard": true,
  "Birthday": {
    "Birthday": "2026-01-28T19:11:58.5971444+01:00",
    "BirthdayOfTheYear": "2026-01-28T19:11:58.5971444+01:00",
    "RequiredWashings": 1,
    "WashingsSinceLastFreeWash": 2,
    "LastBirthdayWash": "2026-01-28T19:11:58.5971444+01:00",
    "BirthdayWashReceived": true,
    "BirthDayWashPeriodStart": "2026-01-28T19:11:58.5971444+01:00",
    "BirthDayWashPeriodEnd": "2026-01-28T19:11:58.5971444+01:00"
  },
  "CustomerData": {
    "FirstName": "sample string 1",
    "Name": "sample string 2",
    "Company": "sample string 3",
    "Street": "sample string 4",
    "Zip": "sample string 5",
    "City": "sample string 6",
    "Phone": "sample string 7",
    "Fax": "sample string 8",
    "Email": "sample string 9",
    "ContactPerson": "sample string 10",
    "ContactPersonPhone": "sample string 11",
    "Remark": "sample string 12",
    "Salutation": "sample string 13"
  },
  "CardMessage": "sample string 5",
  "Bonus": {
    "SpecialDiscountPercent": 64,
    "IsSpecialDiscountTemporary": true,
    "SpecialDiscountValidUntil": "2026-01-28T19:11:58.5971444+01:00",
    "BonusTiers": [
      {
        "ThresholdAmount": 1.0,
        "BonusPercentage": 2.1
      },
      {
        "ThresholdAmount": 1.0,
        "BonusPercentage": 2.1
      }
    ]
  },
  "LastWashings": [
    {
      "Options": [
        {
          "ReceiptTime": "2026-01-28T19:11:58.5971444+01:00",
          "Quantity": 2.0,
          "TotalPrice": 3.0,
          "ArticleId": 4,
          "ArticleNumber": "sample string 5",
          "Label": "sample string 6",
          "LabelReceipt": "sample string 7"
        },
        {
          "ReceiptTime": "2026-01-28T19:11:58.5971444+01:00",
          "Quantity": 2.0,
          "TotalPrice": 3.0,
          "ArticleId": 4,
          "ArticleNumber": "sample string 5",
          "Label": "sample string 6",
          "LabelReceipt": "sample string 7"
        }
      ],
      "PaymentMethod": 0,
      "ReceiptTime": "2026-01-28T19:11:58.6127542+01:00",
      "Quantity": 2.0,
      "TotalPrice": 3.0,
      "ArticleId": 4,
      "ArticleNumber": "sample string 5",
      "Label": "sample string 6",
      "LabelReceipt": "sample string 7"
    },
    {
      "Options": [
        {
          "ReceiptTime": "2026-01-28T19:11:58.5971444+01:00",
          "Quantity": 2.0,
          "TotalPrice": 3.0,
          "ArticleId": 4,
          "ArticleNumber": "sample string 5",
          "Label": "sample string 6",
          "LabelReceipt": "sample string 7"
        },
        {
          "ReceiptTime": "2026-01-28T19:11:58.5971444+01:00",
          "Quantity": 2.0,
          "TotalPrice": 3.0,
          "ArticleId": 4,
          "ArticleNumber": "sample string 5",
          "Label": "sample string 6",
          "LabelReceipt": "sample string 7"
        }
      ],
      "PaymentMethod": 0,
      "ReceiptTime": "2026-01-28T19:11:58.6127542+01:00",
      "Quantity": 2.0,
      "TotalPrice": 3.0,
      "ArticleId": 4,
      "ArticleNumber": "sample string 5",
      "Label": "sample string 6",
      "LabelReceipt": "sample string 7"
    }
  ]
}

Error Handling

HTTP Status Codes

An expected error is indicated through the HTTP Status Code 400. In this case you can read the details about the error in the body of the response. Make sure you always check for the HTTP Status Code 200, since many things can go wrong. Unexpected errors are sended with HTTP Status Code 500 for example.

Application Error Codes

Code Name Description

1

CardNotFound

The given customer card was not found

2

ClientNotFound

The given Client was not found in the system

Error Formats

application/json, text/json

Sample:
{
  "Data": null,
  "ApplicationErrorCode": 2,
  "ApplicationMessage": "ClientNotFound"
}