WinShopAPI docs
ReferenceCredit

Get a credit account

Returns one credit account by `id`, with its current balance. Requires `Permissions.Credit.View`.

GET
/api/credit/{id}

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

id*integer
Formatint32

Response Body

application/json
  1. response
amount?|
Formatdecimal
barcode?|
Lengthlength <= 50
createdAt?|
Formatdate-time
id?|
Formatint32
lastModify?|
Formatdate-time
number?|
Lengthlength <= 50
pinCode?|
Lengthlength <= 10
soldDate?|
Formatdate-time
statusId?|

0 - vystavena, neaktivovaná 1 - aktivni 2 - dočasně deaktivovaná 3 - zrušená

Formatint32
userId?|
Formatint32
validFrom?|
Formatdate-time
validTo?|
Formatdate-time
validity?|
Formatint32
curl -X GET 'https://<your-instance>/api/credit/0' \  -H 'Authorization: Bearer <access-token>'
{  "amount": 0,  "barcode": "string",  "createdAt": "2019-08-24T14:15:22Z",  "id": 0,  "lastModify": "2019-08-24T14:15:22Z",  "number": "string",  "pinCode": "string",  "soldDate": "2019-08-24T14:15:22Z",  "statusId": 0,  "userId": 0,  "validFrom": "2019-08-24T14:15:22Z",  "validTo": "2019-08-24T14:15:22Z",  "validity": 0}

Search credit accounts POST

Returns one page of credit accounts matching the filter. A credit account holds a customer's prepaid balance, which a till can draw on. Body is a `PaginationRequest` — see the *Filtering & pagination* concept in the developer docs. Sortable and limitable fields depend on the instance's data-grid view. Requires `Permissions.Credit.View`.

Book a credit movement PUT

Applies the requested change to the credit account's balance and returns the account's movements, including the one just booked. Requires `Permissions.Credit.View`.