API docs by Redocly

QASIDA.API technical documentation. (1.0)

Download OpenAPI specification:

This API provides endpoints to interact with the Qasida application.

Can be used for integration with E-shop , CRM, Cash register systems or others.


Authentication

Endpoints that require authentication are protected by JWT (JSON Web Token) authentication. Clients should include a valid JWT in the Authorization header of their requests. The token can be required by Qasida (SPIN) application.

Relations between entities

Foreign keys in entities have primary entity and its primary key in description.QasidaEnum has one schema for different entities.


Business Cases

Integration with e-shop




Description: This API allows to synchronize products and pricelists to e-shop and insert new customers and customer orders from e-shop

Synchronization of products and prices to e-shop:

Request: HTTP GET api/eshop/v1/Product/GetAll

Response: Returns a JSON object containing all products information

Request: HTTP GET /api/eshop/v1/PriceListItem/GetAllByPriceListId

Response: Returns a JSON object containing all prices information for products

Submit of customer order from e-shop:

Request: HTTP GET /api/eshop/v1/Customer/GetByEmail

Response: Returns a JSON object containing customer information by e-mail

Request: HTTP POST /api/eshop/v1/Customer/InsertCustomer

Response: Inserts new customer from e-shop if not found by /api/eshop/v1/Customer/GetByEmail

Request: HTTP POST api/eshop/v1/CustomerOrder/InsertCustomerOrder

Response: Inserts new customer order from e-shop containing previously inserted or found customer

Error Codes

This API may return the following error codes in responses:
  • 400 Bad Request: The request was malformed or invalid.
  • 401 Unauthorized: The client is not authorized to access the requested resource.
  • 403 Forbidden: The client is authenticated but not authorized to access the requested resource.
  • 404 Not Found: The requested resource was not found.
  • 500 Internal Server Error: An unexpected error occurred on the server.

CashReceipt

Cash receipt is a document that serves as evidence of a cash transaction, typically issued when a payment is made in cash or received in cash.

/api/eshop/v1/CashReceipt/GetById

Authorizations:
Bearer
query Parameters
id
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "cashReceiptId": 0,
  • "cashVatReceiptId": 0,
  • "cashReceiptNumber": "string",
  • "cashReceiptType": "string",
  • "issueDate": "string",
  • "cashBookId": "string",
  • "customerId": 0,
  • "mandantId": 0,
  • "purpose": "string",
  • "cashReceiptItems": [
    ],
  • "cashReceiptVatItems": [
    ],
  • "cashReceiptVatTotals": [
    ]
}

/api/eshop/v1/CashReceipt/InsertCashReceipt

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
cashReceiptId
integer <int64> (Cash receipt id)

The id of the cash receipt

cashVatReceiptId
integer <int64> (Cash VAT receipt id)

The cash VAT receipt Id

cashReceiptNumber
string or null <string> (Cash receipt number)

The number of the cash receipt

cashReceiptType
string or null <string> (Cash receipt type)

Id of the document type, foreign key from QasidaEnum.GetCashReceiptTypes.code

issueDate
string or null <datetime> (Issue date)

The created date of the cash receipt

cashBookId
string or null <string> (Cash book id)

The id of the cash book, foreign key from QasidaEnum.GetCashBooks.code

customerId
integer or null <int64> (Customer id)

The id of the customer, foreign key from Customer.id

mandantId
integer or null <int64> (Mandant id)

The id of the mandant to which the cash receipt belongs, foreign key from QasidaEnum.GetMandant.code

purpose
string or null <string> (Purpose)

The purpose of the cash receipt

cashVatReceipt
boolean or null <boolean> (Cash VAT receipt)

The cash VAT receipt

Array of objects or null (The cash receipt items)

The cash receipt items

Array of objects or null (The cash receipt VAT items)

The cash receipt VAT items

Array of objects or null (The cash receipt VAT totals)

The cash receipt VAT totals

Responses

Request samples

Content type
application/json
{
  • "cashReceiptId": 0,
  • "cashVatReceiptId": 0,
  • "cashReceiptNumber": "string",
  • "cashReceiptType": "string",
  • "issueDate": "string",
  • "cashBookId": "string",
  • "customerId": 0,
  • "mandantId": 0,
  • "purpose": "string",
  • "cashVatReceipt": true,
  • "cashReceiptItems": [
    ],
  • "cashReceiptVatItems": [
    ],
  • "cashReceiptVatTotals": [
    ]
}

Response samples

Content type
application/json
{
  • "cashReceiptId": 0,
  • "cashVatReceiptId": 0,
  • "cashReceiptNumber": "string",
  • "cashReceiptType": "string",
  • "issueDate": "string",
  • "cashBookId": "string",
  • "customerId": 0,
  • "mandantId": 0,
  • "purpose": "string",
  • "cashReceiptItems": [
    ],
  • "cashReceiptVatItems": [
    ],
  • "cashReceiptVatTotals": [
    ]
}

ClaimList

Claim list is a list of delayed customer invoices that have to be paid

/api/eshop/v1/ClaimList/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

customerId
required
integer <int64>
allClaims
boolean
Default: false
onlyDelayed
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

ClaimListItem

Claim list item is a list of items of delayed customer invoice from claim list

/api/eshop/v1/ClaimListItem/GetAllByInvoiceId

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

invoiceId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Customer

A customer is an individual, organization, or entity that purchases goods or services or engages in a commercial transaction with a company

/api/eshop/v1/Customer/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Customer/GetById

Authorizations:
Bearer
query Parameters
id
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "internalCode": "string",
  • "ico": "string",
  • "dic": "string",
  • "name": "string",
  • "isVATPayer": true,
  • "validTo": "string",
  • "customerTypeId": "string",
  • "purchaserId": 0,
  • "isPurchaser": true,
  • "priceListId": 0,
  • "supplierId": 0,
  • "isSupplier": true,
  • "edited": "string",
  • "addresses": [
    ],
  • "contacts": [
    ],
  • "icdpHs": [
    ],
  • "loyaltyId": "string",
  • "cardNumber": "string",
  • "optionalData": [
    ]
}

/api/eshop/v1/Customer/GetByName

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

name
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Customer/GetByCode

Authorizations:
Bearer
query Parameters
internalCode
required
string
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "internalCode": "string",
  • "ico": "string",
  • "dic": "string",
  • "name": "string",
  • "isVATPayer": true,
  • "validTo": "string",
  • "customerTypeId": "string",
  • "purchaserId": 0,
  • "isPurchaser": true,
  • "priceListId": 0,
  • "supplierId": 0,
  • "isSupplier": true,
  • "edited": "string",
  • "addresses": [
    ],
  • "contacts": [
    ],
  • "icdpHs": [
    ],
  • "loyaltyId": "string",
  • "cardNumber": "string",
  • "optionalData": [
    ]
}

/api/eshop/v1/Customer/GetByIco

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

ico
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Customer/UpdateCustomer

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <int64> (Id)

Unique id of the customer, foreign key from Customer.id

mandantId
integer <int64> (Mandant id)

The id of the mandant, foreign key from QasidaEnum.GetMandant.code

internalCode
string or null <string> (Customer internal code)

The internal customer code, foreign key from Customer.internalCode

ico
string or null <string> (ICO)

The business ID of the customer, foreign key from Customer.ico

dic
string or null <string> (DIC)

The tax ID of the customer, foreign key from Customer.dic

name
string or null <string> (Customer name)

Full Customer (company) name

isVATPayer
boolean <boolean> (Is VAT payer)

Indicates if customer is a VAT payer

validTo
string or null <datetime> (Valid to)

Validity of the customer, if null then it's valid

customerTypeId
string or null <string> (Customer type id)

Customer type id (FO, PO, SO,...), foreign key from QasidaEnum.CustomerType.code

isPurchaser
boolean <boolean> (Is purchaser)

ITrue if is purchaser

priceListId
integer or null <int64> (Price list id)

Price list id , foreign key from PriceList.id

isSupplier
boolean <boolean> (Is supplier)

True if is a supplier

Array of objects or null (Addresses)

Addresses

Array of objects or null (Contacts)

Contacts

Array of objects or null (ICDPHs)

ICDPHs

loyaltyId
string or null <string> (Loyality Id)

The loyalty identification of the customer, used in the loyalty system.

cardNumber
string or null <string> (Card number)

Number of a loyality card, used in the loyalty system.

Array of objects or null (OptionalData)

Optional data of customer

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "internalCode": "string",
  • "ico": "string",
  • "dic": "string",
  • "name": "string",
  • "isVATPayer": true,
  • "validTo": "string",
  • "customerTypeId": "string",
  • "isPurchaser": true,
  • "priceListId": 0,
  • "isSupplier": true,
  • "addresses": [
    ],
  • "contacts": [
    ],
  • "icdpHs": [
    ],
  • "loyaltyId": "string",
  • "cardNumber": "string",
  • "optionalData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "internalCode": "string",
  • "ico": "string",
  • "dic": "string",
  • "name": "string",
  • "isVATPayer": true,
  • "validTo": "string",
  • "customerTypeId": "string",
  • "purchaserId": 0,
  • "isPurchaser": true,
  • "priceListId": 0,
  • "supplierId": 0,
  • "isSupplier": true,
  • "edited": "string",
  • "addresses": [
    ],
  • "contacts": [
    ],
  • "icdpHs": [
    ],
  • "loyaltyId": "string",
  • "cardNumber": "string",
  • "optionalData": [
    ]
}

/api/eshop/v1/Customer/InsertCustomer

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
mandantId
integer <int64> (Mandant id)

The id of the mandant, foreign key from QasidaEnum.GetMandant.code

internalCode
string or null <string> (Customer internal code)

The internal customer code

ico
string or null <string> (ICO)

The business Id of the customer

dic
string or null <string> (DIC)

The tax ID of the customer

name
string or null <string> (Customer name)

Full Customer (company) name

isVATPayer
boolean <boolean> (Is VAT payer)

Indicates if customer is a VAT payer

customerTypeId
string or null <string> (Customer type id)

Customer type id (FO, PO, SO,...), foreign key from QasidaEnum.CustomerType.code

isPurchaser
boolean <int64> (Purchaser id)

True if is purchaser

priceListId
integer or null <int64> (Price list id)

Price list id , foreign key from PriceList.id

isSupplier
boolean <boolean> (Is supplier)

True if is a supplier

Array of objects or null (Addresses)

The adresses for customer

Array of objects or null (Contacts)

The contacts for customer

Array of objects or null (ICDPHs)

The ICDPHs for customer

loyaltyId
string or null <string> (LoyaltyId)

The loyalty id from loyalty system

cardNumber
string or null <string> (Card number)

The card number from loyalty system

validTo
string or null <datetime> (Valid to)

The validity of the customer, if null then it's valid

Array of objects or null (Optional data)

Optional data for customer

Responses

Request samples

Content type
application/json
{
  • "mandantId": 0,
  • "internalCode": "string",
  • "ico": "string",
  • "dic": "string",
  • "name": "string",
  • "isVATPayer": true,
  • "customerTypeId": "string",
  • "isPurchaser": true,
  • "priceListId": 0,
  • "isSupplier": true,
  • "addresses": [
    ],
  • "contacts": [
    ],
  • "icdpHs": [
    ],
  • "loyaltyId": "string",
  • "cardNumber": "string",
  • "validTo": "string",
  • "optionalData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "internalCode": "string",
  • "ico": "string",
  • "dic": "string",
  • "name": "string",
  • "isVATPayer": true,
  • "validTo": "string",
  • "customerTypeId": "string",
  • "purchaserId": 0,
  • "isPurchaser": true,
  • "priceListId": 0,
  • "supplierId": 0,
  • "isSupplier": true,
  • "edited": "string",
  • "addresses": [
    ],
  • "contacts": [
    ],
  • "icdpHs": [
    ],
  • "loyaltyId": "string",
  • "cardNumber": "string",
  • "optionalData": [
    ]
}

/api/eshop/v1/Customer/InsertCustomerAddress

Authorizations:
Bearer
query Parameters
customerId
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
street
string or null <string> (Street)

Street

city
string or null <string> (City)

City

postalCode
string or null <string> (Postal code)

The postal code

buildingNumber
string or null <string> (Building number)

The number of the building

propertyRegistrationNumber
string or null <string> (Property registration number)

The registration number of the property

addressTypeCode
string or null <string> (Address type code)

If it's empty, than it's a default address (adresa sídla), otherwise foreign key from QasidaEnums.AddressType.code

validTo
string or null <datetime> (Valid to)

Validity of the address, if null then it's valid

isoA2CountryCode
string or null <string> (IsoA2 country code)

Country ISO Alpha-2 code (SK, CZ, US, ... )

Responses

Request samples

Content type
application/json
{
  • "street": "string",
  • "city": "string",
  • "postalCode": "string",
  • "buildingNumber": "string",
  • "propertyRegistrationNumber": "string",
  • "addressTypeCode": "string",
  • "validTo": "string",
  • "isoA2CountryCode": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "street": "string",
  • "city": "string",
  • "postalCode": "string",
  • "buildingNumber": "string",
  • "propertyRegistrationNumber": "string",
  • "addressTypeCode": "string",
  • "validTo": "string",
  • "isoA2CountryCode": "string"
}

/api/eshop/v1/Customer/UpdateCustomerAddress

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <int64> (Id)

The unique id of the address

customerId
integer <int64> (Customer Id)

The id of the customer, foreign key from Customer.id

street
string or null <string> (Street)

The street

city
string or null <string> (City)

The city

postalCode
string or null <string> (Postal code)

The postal code

buildingNumber
string or null <string> (Building number)

The building number

propertyRegistrationNumber
string or null <string> (Property registration number)

The Property registration number

addressTypeCode
string or null <string> (Adress type code)

If it's empty, than it's a default address (billing address), otherwise check in QasidaEnums.AddressType

validTo
string or null <datetime> (Valid to)

Validity of the address, if null then it's valid

isoA2CountryCode
string or null <string> (IsoA2 country code)

Country ISO Alpha-2 code (SK, CZ, US, ... )

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "customerId": 0,
  • "street": "string",
  • "city": "string",
  • "postalCode": "string",
  • "buildingNumber": "string",
  • "propertyRegistrationNumber": "string",
  • "addressTypeCode": "string",
  • "validTo": "string",
  • "isoA2CountryCode": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "street": "string",
  • "city": "string",
  • "postalCode": "string",
  • "buildingNumber": "string",
  • "propertyRegistrationNumber": "string",
  • "addressTypeCode": "string",
  • "validTo": "string",
  • "isoA2CountryCode": "string"
}

/api/eshop/v1/Customer/InsertCustomerContact

Authorizations:
Bearer
query Parameters
customerId
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
value
string or null
type
string or null
note
string or null <= 50 characters

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "type": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "value": "string",
  • "type": "string",
  • "note": "string",
  • "validTo": "string"
}

/api/eshop/v1/Customer/UpdateCustomerContact

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <int64> (Id)

The unique id of the contact

value
string or null <string> (Value)

The contact value itself

type
string or null <string> (Type)

The type of the contact, foreign key from QasidaEnums.ContactConnectionType.code

note
string or null <string> (Note)

Optional note for the contact

validTo
string or null <datetime> (Valid to)

Validity of the contact, if null then it's valid

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "value": "string",
  • "type": "string",
  • "note": "string",
  • "validTo": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "value": "string",
  • "type": "string",
  • "note": "string",
  • "validTo": "string"
}

/api/eshop/v1/Customer/InsertCustomerIcdph

Authorizations:
Bearer
query Parameters
customerId
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
value
string or null <string> (Value)

The VAT number for customer or supplier

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "value": "string"
}

/api/eshop/v1/Customer/UpdateCustomerIcdph

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <string> (Value)

The Id of the VAT number for purchaser or supplier

value
string or null <string> (Value)

The VAT number for purchaser or supplier

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "value": "string"
}

/api/eshop/v1/Customer/GetByEmail

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

email
required
string
since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Customer/GetByCardNumber

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

cardNumber
required
string
since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Customer/GetByLoyaltyId

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

loyaltyId
required
string
since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Customer/InsertCustomerOptionalData

Authorizations:
Bearer
query Parameters
customerId
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <int64> (Id)

The id of customer optional data, foreign key from QasidaEnum.OptionalData.code

customerId
integer or null <int64> (Customer Id)

The id of customer, foreign key from Customer.id

listValueShortcut
string or null <string> (List value shortcut)

The code of customer optional data picker value, foreign key from QasidaEnum.OptionalData.shortcut

nonListValue
string or null <string> (Non List value)

The non list value of customer optional data

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "customerId": 0,
  • "listValueShortcut": "string",
  • "nonListValue": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "customerId": 0,
  • "code": "string",
  • "listValueShortcut": "string",
  • "listValueName": "string",
  • "nonListValue": "string"
}

/api/eshop/v1/Customer/UpdateCustomerOptionalData

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <int64>
customerId
integer or null <int64>
listValueShortcut
string or null
nonListValue
string or null

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "customerId": 0,
  • "listValueShortcut": "string",
  • "nonListValue": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "customerId": 0,
  • "code": "string",
  • "listValueShortcut": "string",
  • "listValueName": "string",
  • "nonListValue": "string"
}

/api/eshop/v1/Customer/GetBankAccountsByCustomerId

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

customerId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Customer/CheckCustomer

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

id
required
integer <int64>

Responses

CustomerDiscountPriceList

A customer discount is a reduction in the price of a product or service offered to customers

/api/eshop/v1/CustomerDiscountPriceList/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

customerId
required
integer <int64>
priceListId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/CustomerDiscountPriceList/GetAllByVuepAndDiscountCategory

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

priceListId
required
integer <int64>
discountCategoryCode
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/CustomerDiscountPriceList/GetAllByVuepAndCustomer

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

priceListId
required
integer <int64>
customerId
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

CustomerInvoicePaymentInfo

Payment information of customer invoices

/api/eshop/v1/CustomerInvoicePaymentInfo/GetByVariableSymbol

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

variableSymbol
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/CustomerInvoicePaymentInfo/GetById

Authorizations:
Bearer
query Parameters
id
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "variableSymbol": "string",
  • "customerId": 0,
  • "mandantId": 0,
  • "paymentMethod": "string",
  • "customerName": "string",
  • "customerIco": "string",
  • "customerInternalCode": "string",
  • "totalSum": 0,
  • "notPaidSum": 0,
  • "lastPaymentDate": "string",
  • "invoiceType": "string",
  • "parentId": 0
}

CustomerOptionalDataDefinition

Definition of optional data for customer

/api/eshop/v1/CustomerOptionalDataDefinition/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withListValues
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

CustomerOrder

A CustomerOrder is a representation of a purchase made by a customer, containing information such as order details, customer information, billing and shipping information, and payment information. The CustomerOrder entity helps businesses keep track of their sales transactions, manage inventory, and provide customers with accurate and timely order information.

Get all customer orders.

This API method allows retrieving a list of all customer orders with items. This information can be filtered by warehouse, last updated date, fulfillment and reservation status, and the response can be paginated according to the provided query parameters.Price in items can be returned without or with VAT

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <datetime> (Date of last synchronization)

Returns only orders changed after date of last synchronization, if not specified returns all

warehouseId
integer <int64> (Warehouse id)

Warehouse id , foreign key from WareHouse.id

priceWithVat
boolean <boolean> (Price with VAT)
Default: false

Return unit price with VAT , if not specified price is without VAT

onlyNotFulfilled
boolean <boolean> (Only not fulfilled orders)
Default: false

Return only not fulfilled orders , if not specified returns all

onlyReserved
boolean <boolean> (Only reserved orders)
Default: false

Return only reserved orders , if not specified returns all

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Get one customer order.

This API method allows retrieving one customer order filtered by id with items

Authorizations:
Bearer
query Parameters
id
required
integer <int64> (Customer order id)

Customer order id

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

priceWithVat
boolean <boolean> (Price with VAT)
Default: false

Return unit price with VAT , if not specified price is without VAT

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "orderNumber": "string",
  • "orderStatus": "string",
  • "typeDocumentId": "string",
  • "issueDate": "string",
  • "fulfillmentDate": "string",
  • "warehouseId": 0,
  • "warehouseNumber": "string",
  • "economicalObject": "string",
  • "organizationStructureId": "string",
  • "organizationStructureName": "string",
  • "currency": "string",
  • "priceListId": 0,
  • "customerId": 0,
  • "mandantId": 0,
  • "note": "string",
  • "shippingCode": "string",
  • "shippingServiceTypeId": "string",
  • "paymentMethod": "string",
  • "fullClientName": "string",
  • "clientCustomerName": "string",
  • "clientPhone": "string",
  • "clientEmail": "string",
  • "clientAddressStreet": "string",
  • "clientCity": "string",
  • "clientPostalCode": "string",
  • "clientCountry": "string",
  • "branchId": "string",
  • "price": 0,
  • "cashOfDeliveryPrice": 0,
  • "cashOfDeliveryCurrency": "string",
  • "internalTrackSymbol": "string",
  • "manipulationUnitId": "string",
  • "weight": 0,
  • "additionalServices": "string",
  • "externalOrderNumber": "string",
  • "shippingNote": "string",
  • "isPaid": true,
  • "workflowStatusCode": "string",
  • "workflowStatusName": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "invoiceId": 0,
  • "customerOrderItems": [
    ],
  • "packets": [
    ],
  • "customerInvoicePayments": [
    ],
  • "deliveryNotes": [
    ]
}

Get all customer orders for one customer

This API method allows retrieving a list of all customer orders with items. This information can be filtered by customer ,warehouse, last updated date, fulfillment and reservation status, and the response can be paginated according to the provided query parameters.Price in items can be returned without or with VAT

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

customerId
required
integer <int64> (Customer id)

Customer id , foreign key from Customer.id

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

warehouseId
integer <int64> (Warehouse id)

Warehouse id , foreign key from WareHouse.id

priceWithVat
boolean <boolean> (Price with VAT)
Default: false

Return unit price with VAT , if not specified price is without VAT

onlyNotFulfilled
boolean <boolean> (Only not fulfilled orders)
Default: false

Return only not fulfilled orders , if not specified returns all

onlyReserved
boolean <boolean> (Only reserved orders)
Default: false

Return only reserved orders , if not specified returns all

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Add new customer order.

This API method adds one customer order with items.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
mandantId
required
integer <int64> (Mandant id)

Id of mandant

customerId
required
integer <int64> (Customer id)

Customer id , foreign key from Customer.id

orderNumber
string or null <string> (Customer order number)

Internal customer order number , when left empty it is filled automatically

typeDocumentId
required
string <string> (Customer order document type id) non-empty

Customer order document type id foreign key from QasidaEnum.GetCustomerOrderDocumentTypes.code

issueDate
required
string <datetime> (Issue date)

Customer order issue date

fulfillmentDate
string or null <datetime> (Fulfillment date)

Customer order supposed fulfillment date

currency
required
string <string> (Currency) non-empty

Currency code, foreign key from QasidaEnum.GetCurrencies.code

note
string or null <string> (Note)

Note for customer order

organizationStructureId
string or null <int64> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.id

economicalObject
string or null <string> (Economical object)

Economical object , multiple values from QasidaEnum.GetEconomicalObjects.shortcut separated by comma (,)

shippingCode
string or null <string> (Shipping code)

Shipping code, foreign key from QasidaEnum.GetShippingCodes.code

shippingServiceTypeId
string or null <string> (Shipping service type id)

Shipping service type id, foreign key from QasidaEnum.GetShippingServiceTypes.code

paymentMethod
string or null <string> (Payment method)

Payment method code, foreign key from QasidaEnum.GetPaymentMethods.code

fullClientName
string or null <string> (Full name of person)

Full name of person used for shipping

clientCustomerName
string or null <string> (Full name of company)

Full name of company used for shipping

clientPhone
string or null <string> (Phone number)

Phone number used for shipping

clientEmail
string or null <string> (Email address)

Email address used for shipping

clientAddressStreet
string or null <string> (Street with number)

Street with number used for shipping

clientCity
string or null <string> (City)

City name used for shipping

clientPostalCode
string or null <string> (Postal code)

Postal code used for shipping

clientCountry
string or null <string> (Country code)

Country ISOA2 code used for shipping

branchId
string or null <string> (Shipping delivery point id)

Shipping delivery point id , foreign key from QasidaEnum.GetShippingBranches.code

price
number or null <decimal> (Total price)

Total price of customer order for shipping

cashOfDeliveryPrice
number or null <decimal> (Cash of delivery price)

Cash of delivery price of customer order for shipping

cashOfDeliveryCurrency
string or null <string> (Cash of delivery currency)

Cash of delivery currency code, foreign key from QasidaEnum.GetCurrencies.code

internalTrackSymbol
string or null <string> (Internal tracking symbol)

Internal tracking symbol used for shipping

manipulationUnitId
string or null <string> (Manipulation unit id)

Manipulation unit id, foreign key from QasidaEnum.GetShippingMeasureUnits.code

weight
number or null <decimal> (Total weight)

Total weight of customer order for shipping in kg

additionalServices
string or null <string> (Additional services for shipping)

Additional services codes for shipping for shipping service type id separated by comma (,)

externalOrderNumber
string or null <string> (External customer order number)

External customer order number

shippingNote
string or null <string> (Shipping note)

Shipping note

isPaid
boolean <boolean> (Customer order is paid)

Customer order is already paid

priceListId
integer or null <int64> (Price list id)

Price list id , foreign key from PriceList.id

warehouseId
integer or null <int64> (Warehouse id)

Customer order warehouse id , foreign key from WareHouse.id

rabat
number or null <decimal> (Discount in %)

Discount in %

rabat2
number or null <decimal> (Discount 2 in %)

Discount 2 in %

invoiceType
string or null <string> (Invoice type)

Invoice type used for creating invoice from customer order , possible values : FV - customer invoice , FVZ - customer proforma invoice

writeInvoiceDocument
boolean <boolean> (Write invoice document)

When invoice is created from customer order invoice pdf document should be created

sendInvoiceDocument
boolean <boolean> (Send invoice document)

When invoice pdf document is created it should be send to customer

Array of objects or null (Customer order items)

Items of customer order

Responses

Request samples

Content type
application/json
{
  • "mandantId": 0,
  • "customerId": 0,
  • "orderNumber": "string",
  • "typeDocumentId": "string",
  • "issueDate": "string",
  • "fulfillmentDate": "string",
  • "currency": "string",
  • "note": "string",
  • "organizationStructureId": "string",
  • "economicalObject": "string",
  • "shippingCode": "string",
  • "shippingServiceTypeId": "string",
  • "paymentMethod": "string",
  • "fullClientName": "string",
  • "clientCustomerName": "string",
  • "clientPhone": "string",
  • "clientEmail": "string",
  • "clientAddressStreet": "string",
  • "clientCity": "string",
  • "clientPostalCode": "string",
  • "clientCountry": "string",
  • "branchId": "string",
  • "price": 0,
  • "cashOfDeliveryPrice": 0,
  • "cashOfDeliveryCurrency": "string",
  • "internalTrackSymbol": "string",
  • "manipulationUnitId": "string",
  • "weight": 0,
  • "additionalServices": "string",
  • "externalOrderNumber": "string",
  • "shippingNote": "string",
  • "isPaid": true,
  • "priceListId": 0,
  • "warehouseId": 0,
  • "rabat": 0,
  • "rabat2": 0,
  • "invoiceType": "string",
  • "writeInvoiceDocument": true,
  • "sendInvoiceDocument": true,
  • "customerOrderItems": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "orderNumber": "string",
  • "orderStatus": "string",
  • "typeDocumentId": "string",
  • "issueDate": "string",
  • "fulfillmentDate": "string",
  • "warehouseId": 0,
  • "warehouseNumber": "string",
  • "economicalObject": "string",
  • "organizationStructureId": "string",
  • "organizationStructureName": "string",
  • "currency": "string",
  • "priceListId": 0,
  • "customerId": 0,
  • "mandantId": 0,
  • "note": "string",
  • "shippingCode": "string",
  • "shippingServiceTypeId": "string",
  • "paymentMethod": "string",
  • "fullClientName": "string",
  • "clientCustomerName": "string",
  • "clientPhone": "string",
  • "clientEmail": "string",
  • "clientAddressStreet": "string",
  • "clientCity": "string",
  • "clientPostalCode": "string",
  • "clientCountry": "string",
  • "branchId": "string",
  • "price": 0,
  • "cashOfDeliveryPrice": 0,
  • "cashOfDeliveryCurrency": "string",
  • "internalTrackSymbol": "string",
  • "manipulationUnitId": "string",
  • "weight": 0,
  • "additionalServices": "string",
  • "externalOrderNumber": "string",
  • "shippingNote": "string",
  • "isPaid": true,
  • "workflowStatusCode": "string",
  • "workflowStatusName": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "invoiceId": 0,
  • "customerOrderItems": [
    ],
  • "packets": [
    ],
  • "customerInvoicePayments": [
    ],
  • "deliveryNotes": [
    ]
}

Update isPaid attribute of customer order.

This API method updates isPaid attribute of one customer order filtered by id

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
required
integer <int64> (Customer order id)

Customer order id

isPaid
required
boolean <boolean> (Customer order is paid)

Customer order is already paid

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "isPaid": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "isPaid": true
}

Get customer orders by order number with packets , delivery notes and invoice payments

This API method allows retrieving a list of customer orders filtered by order number with items.Price in items can be returned without or with VAT.Optionally packets ,delivery note and invoice payments information for customer order can be retrieved

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

orderNumber
required
string <string> (Customer order number)

Customer order number

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

priceWithVat
boolean <boolean> (Price with VAT)
Default: false

Return unit price with VAT , if not specified price is without VAT

withPackets
boolean <boolean> (With packets)
Default: false

Return also related packets information

withInvoicePayments
boolean <boolean> (With invoice payments)
Default: false

Return also related invoice payments

withDeliveryNotes
boolean <boolean> (With delivery notes)
Default: false

Return also related delivery notes

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Get customer orders with changed workflow status

This API method allows retrieving a list of customer orders filtered by workflow status change after date given by parameter since

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
required
string <datetime> (Date of last synchronization of workflow)

Returns only orders with workflow changed after date of last synchronization

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Update payment method of customer order.

This API method updates payment method of one customer order filtered by id

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
required
integer <int64> (Customer order id)

Customer order id

paymentMethod
string or null <string> (Payment method)

Payment method code, foreign key from QasidaEnum.GetPaymentMethods.code

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "paymentMethod": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "paymentMethod": "string"
}

Change workflow status of customer order

This API method changes workflow status of one customer order

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
required
integer <int64> (Customer order id)

Customer order id

workflowStatusCode
string or null <string> (Workflow status code)

The code of the workflow status - QasidaEnums.GetCustomerOrderWorkflowStatus

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "workflowStatusCode": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "workflowStatusCode": "string"
}

Write optional data of customer order.

This API method writes optional data of one customer order

Authorizations:
Bearer
query Parameters
customerOrderId
required
integer <int64> (customer order id)

customer order id

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
Array
id
integer <int64> (Id)

The Id of the optional data

parentId
integer or null <int64> (Parent Id)

The Id of the parent evidence

pickerValueId
integer or null <int64> (Picker value Id)

The id of the picker value , foreign key from OptionalDataDefinition.optionalDataDefinitionPickerValues.id

nonPickerValue
string or null <string> (Non picker value)

The optional data non picker value , format by OptionalDataDefinition.type : char , number ,datetime in SK regional format

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

CustomerProductPriceDiscount

Discount and prices values for customer , product and price list

/api/eshop/v1/CustomerProductPriceDiscount/GetRow

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

productId
required
integer <int64>
priceListId
required
integer <int64>
customerId
required
integer <int64>
quantity
required
number <double>

Responses

Response samples

Content type
application/json
{
  • "productId": 0,
  • "customerId": 0,
  • "priceListId": 0,
  • "quantity": 0.1,
  • "vatRate": 0.1,
  • "unitPriceWithoutVat": 0.1,
  • "unitPriceWithVat": 0.1,
  • "totalPriceWithoutVat": 0.1,
  • "totalPriceWithVat": 0.1,
  • "discount": 0.1,
  • "unitPriceWithoutVatDiscount": 0.1,
  • "unitPriceWithVatDiscount": 0.1,
  • "totalPriceWithoutVatDiscount": 0.1,
  • "totalPriceWithVatDiscount": 0.1
}

DeliveryNote

A DeliveryNote is a representation of a purchase made by a customer, containing delivery note items with products that are available on warehouse to be released.The DeliveryNote entity helps businesses keep track of their sales transactions, manage inventory.

Get one delivery note

This API method allows retrieving one delivery note with items by its id

Authorizations:
Bearer
query Parameters
id
required
integer <int64> (Delivery note id)

Delivery note id

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

priceWithVat
boolean <boolean> (Price with VAT)
Default: false

Return unit price with VAT , if not specified price is without VAT

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "noteNumber": "string",
  • "typeDocumentId": "string",
  • "issueDate": "string",
  • "warehouseId": 0,
  • "economicalObject": "string",
  • "organizationStructureId": "string",
  • "currency": "string",
  • "priceListId": 0,
  • "customerId": 0,
  • "mandantId": 0,
  • "customerOrderId": 0,
  • "notAllowedEdit": true,
  • "parentId": 0,
  • "deliveryNoteItems": [
    ]
}

Add new delivery note.

This API method adds one delivery note with items.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
mandantId
integer or null <int64> (Mandant id)

Id of mandant

customerId
integer or null <int64> (Customer id)

Customer id , foreign key from Customer.id

noteNumber
string or null <string> (Delivery note number)

Delivery note number

typeDocumentId
string or null <string> (Document type id)

Delivery note document type id, foreign key from QasidaEnum.DocumentTypeCustomerOrder.code

issueDate
string or null <datetime> (Delivery note issue date)

Delivery note issue date

currency
string or null <string> (Currency)

Currency code 'EUR', 'CZK', 'USD', ... , foreign key from QasidaEnum.GetCurrencies.code

organizationStructureId
string or null <string> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.code

economicalObject
string or null <string> (Economical object)

Economical object , multiple values from QasidaEnum.GetEconomicalObjects.shortcut separated by comma (,)

warehouseId
integer or null <int64> (Warehouse id)

Delivery note warehouse id , foreign key from WareHouse.id

priceListId
integer or null <int64> (Price list id)

Price list id , foreign key from PriceList.id

customerOrderId
integer or null <int64> (Customer order id)

Internal customer order id, foreign key from

notAllowedEdit
boolean <boolean> (Not allowed edit)

Option edit the delivery note after creation

Array of objects or null (Delivery note items)

Items of the delivery note

Responses

Request samples

Content type
application/json
{
  • "mandantId": 0,
  • "customerId": 0,
  • "noteNumber": "string",
  • "typeDocumentId": "string",
  • "issueDate": "string",
  • "currency": "string",
  • "organizationStructureId": "string",
  • "economicalObject": "string",
  • "warehouseId": 0,
  • "priceListId": 0,
  • "customerOrderId": 0,
  • "notAllowedEdit": true,
  • "deliveryNoteItems": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "noteNumber": "string",
  • "typeDocumentId": "string",
  • "issueDate": "string",
  • "warehouseId": 0,
  • "economicalObject": "string",
  • "organizationStructureId": "string",
  • "currency": "string",
  • "priceListId": 0,
  • "customerId": 0,
  • "mandantId": 0,
  • "customerOrderId": 0,
  • "notAllowedEdit": true,
  • "parentId": 0,
  • "deliveryNoteItems": [
    ]
}

Insert released quantity

This API method inserts released quantity for all items of delivery note found by its id.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

deliveryNoteId
required
integer <int64> (Delivery note id)

Delivery note id

releasedDate
string <datetime> (Released date)

Date of release of all delivery note items

pickedBy
string <string> (Picked by)

Name of person who picked the delivery note items (max.50 chars)

Responses

DeliveryNoteItem

A DeliveryNoteItem is an item of DeliveryNote with product that is available on warehouse to be released, quantity and price

Insert released quantity

This API method inserts released quantity for one delivery note item found by its id.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

deliveryNoteItemId
required
integer <int64> (Delivery note item id)

Delivery note item id

releasedQuantity
required
number <decimal> (Released quantity)

Quantity of product to be released

releasedDate
string <datetime> (Released date)

Date of release of delivery note item

pickedBy
string <string> (Picked by)

Name of person who picked the delivery note item (max.50 chars)

Responses

Add new delivery note items into existing DeliveryNote.

This API method adds one or more delivery note items to existing DeliveryNote.

Authorizations:
Bearer
query Parameters
DeliveryNoteId
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
Array
deliveryNoteId
integer or null <int64> (Delivery note item id)

Unique delivery note item id

productId
integer or null <int64> (Product id)

The product id of the item, foreign key from Product.productId

quantity
number or null <decimal> (Quantity)

The quantity of the order item

price
number or null <decimal> (Unit price)

Unit product price without VAT

rabat
number or null <decimal> (Discount)

Discount in % or sum

rabatType
string or null <string> (Discount type)

Discount type , foreign key from QasidaEnum​.GetRabatTypes.code

rabat2
number or null <decimal> (Discount)

Discount in % or sum

rabat2Type
string or null <string> (Discount type)

Discount type , foreign key from QasidaEnum​.GetRabatTypes.code

order
integer or null <int64> (Order id)

Internal order id

economicalObject
string or null <string> (Economic object)

Economic object , multiple values from QasidaEnum.GetEconomicalObjects.shortcut separated by comma (,)

organizationStructureId
string or null <string> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.id

priceListId
integer or null <int64> (Price list id)

Price list id , foreign key from PriceList.id

stockCardId
integer or null <int64> (Stockcard id)

The product stockcard id

isPriceWithVat
boolean
customerOrderItemId
integer or null <int64> (Order item id)

Unique order item id

stockSubcardId
integer or null <int64> (Stock subcard id)

The subcard id of the stockard

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "deliveryNoteId": 0,
  • "productId": 0,
  • "quantity": 0,
  • "price": 0,
  • "rabat": 0,
  • "rabatType": "string",
  • "rabat2": 0,
  • "rabat2Type": "string",
  • "order": 0,
  • "economicalObject": "string",
  • "organizationStructureId": "string",
  • "priceListId": 0,
  • "stockCardId": 0,
  • "isPriceWithVat": true,
  • "customerOrderItemId": 0,
  • "stockSubcardId": 0
}

DiscountSurcharge

Discount - surcharge values for customer and product

/api/eshop/v1/DiscountSurcharge/GetByProductIdAndCustomerId

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

productId
required
integer <int64>
customerId
required
integer <int64>
validFor
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "productId": 0,
  • "customerId": 0,
  • "validFor": "string",
  • "discountSurchargeValue1": 0,
  • "discountSurchargeType1": "string",
  • "discountSurchargeValue2": 0,
  • "discountSurchargeType2": "string",
  • "priceListId": 0
}

Document

Document is an e-document which contains pdf report or image related to other entity such as Customer, Invoice or Product

/api/eshop/v1/Document/GetByParentId

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

parentId
required
integer <int64>
withOptionalData
boolean
documentTypeId
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Document/GetById

Authorizations:
Bearer
query Parameters
id
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "number": "string",
  • "name": "string",
  • "lastChanged": "string",
  • "note": "string",
  • "parentId": 0,
  • "url": "string",
  • "size": 0,
  • "originalExtension": "string",
  • "isZip": true,
  • "isTemplate": true,
  • "documentTypeId": "string",
  • "documentTypeName": "string",
  • "optionalData": [
    ]
}

/api/eshop/v1/Document/GetContentById

Authorizations:
Bearer
query Parameters
id
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
"string"

/api/eshop/v1/Document/GetInvoicesByCustomerOrderId

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

customerOrderId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Add new document

This API method adds one document

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
mandantId
integer <int64> (Mandant id)

The id of the mandant, foreign key from QasidaEnum.GetMandant.code

number
string or null <string> (Number)

The number of the document

name
string or null <string> (Name)

The name of the document

note
string or null <string> (Note)

The note of the document

parentId
integer or null <int64> (Parent Id)

Parent Id of the document (DeliveryNoteId, CustomerOrderId, InvoiceId, ProductId...)

url
string or null <string> (Url)

Url Path for the document

size
integer or null <int64> (Size)

Size of the documnt in bytes

originalExtension
string or null <string> (Original extension)

Original extension

isZip
boolean <boolean> (Is Zip)

The file is zipped

isTemplate
boolean <boolean> (Is template)

Is template

documentTypeId
string or null <string> (Document type id)

Document type id

content
string or null <byte> (Content)

The content of the document

Array of objects or null (Optional data)

Optional data

Responses

Request samples

Content type
application/json
{
  • "mandantId": 0,
  • "number": "string",
  • "name": "string",
  • "note": "string",
  • "parentId": 0,
  • "url": "string",
  • "size": 0,
  • "originalExtension": "string",
  • "isZip": true,
  • "isTemplate": true,
  • "documentTypeId": "string",
  • "content": "string",
  • "optionalData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "number": "string",
  • "name": "string",
  • "lastChanged": "string",
  • "note": "string",
  • "parentId": 0,
  • "url": "string",
  • "size": 0,
  • "originalExtension": "string",
  • "isZip": true,
  • "isTemplate": true,
  • "documentTypeId": "string",
  • "documentTypeName": "string",
  • "optionalData": [
    ]
}

EconomicObject

Economic object refers to a specific unit or entity that is the subject of economic analysis, planning, and management. Economic objects can take various forms, such as businesses, organizations, individuals, sectors, industries, projects, or specific activities.

/api/eshop/v1/EconomicObject/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

validFor
string <date-time>
parentId
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/EconomicObject/GetById

Authorizations:
Bearer
query Parameters
id
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "shortcut": "string",
  • "name": "string",
  • "validFrom": "string",
  • "validTo": "string",
  • "note": "string",
  • "parentId": 0,
  • "type": "string",
  • "sortingCode": "string"
}

/api/eshop/v1/EconomicObject/GetByShortcut

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

shortcut
required
string
validFor
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/EconomicObject/GetByIco

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

ico
required
string
validFor
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/EconomicObject/UpdateEconomicObject

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer or null <int64> (Id)

The id of the economical object

shortcut
string or null <string> (Shortcut)

The economical object shortcut

name
string or null <string> (Name)

The economical object name

validFrom
string or null <datetime> (Valid from)

The economical object valid from

validTo
string or null <datetime> (Valid to)

Economical object valid to, if null is valid

note
string or null <string> (Note)

The note for the economical object

type
string or null <string> (Type)

The economical object type from QasidaEnum.GetEconomicObjectTypes.code

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "shortcut": "string",
  • "name": "string",
  • "validFrom": "string",
  • "validTo": "string",
  • "note": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "shortcut": "string",
  • "name": "string",
  • "validFrom": "string",
  • "validTo": "string",
  • "note": "string",
  • "type": "string"
}

/api/eshop/v1/EconomicObject/InsertEconomicObject

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer or null <int64> (Id)

The id of the economic object

mandantId
integer or null <int64> (Mandant id)

The id of the mandant to which the economic object belongs, foreign key from QasidaEnum.GetMandant.code

shortcut
string or null <string> (Shortcut)

The economic object shortcut

name
string or null <string> (Name)

The economic object name

validFrom
string or null <datetime> (Valid from)

The economic object valid from

validTo
string or null <datetime> (Valid to)

Economic object valid to, if null is valid

note
string or null <string> (Note)

The note for the economic object

parentId
integer or null <int64> (Parent id)

Parent id for economic object

type
string or null <string> (Type)

The economic object type from QasidaEnum.GetEconomicObjectTypes.code

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "shortcut": "string",
  • "name": "string",
  • "validFrom": "string",
  • "validTo": "string",
  • "note": "string",
  • "parentId": 0,
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "shortcut": "string",
  • "name": "string",
  • "validFrom": "string",
  • "validTo": "string",
  • "note": "string",
  • "parentId": 0,
  • "type": "string"
}

FinancialResult

The financial result refers to the outcome of the financial performance of an entity over a specific period. It represents the net financial gain or loss resulting from the operations, investments, and financing activities of the entity.

/api/eshop/v1/FinancialResult/GetByEconomicalObject

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

economicalObjectId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

FirmsioCompany

Turnover refers to the total sales or revenue generated by a company within a specific period.It represents the company's ability to generate sales and is often used as an indicator of its financial performance

/api/eshop/v1/FirmsioCompany/GetByIco

Authorizations:
Bearer
query Parameters
ico
required
string
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "ico": "string",
  • "dic": 0,
  • "corporateBodyName": "string",
  • "city": "string",
  • "street": "string",
  • "postalCode": "string",
  • "icdph": "string",
  • "name": "string",
  • "registrationKind": "string",
  • "effectiveTo": "2019-08-24T14:15:22Z",
  • "country": "string",
  • "registrationKindUpdatedOn": "2019-08-24T14:15:22Z",
  • "registeredOn": "2019-08-24T14:15:22Z"
}

IssueNote

A IssueNote is a representation of a purchase made by a customer, containing delivery note items with products that are available on warehouse to be released.The DeliveryNote entity helps businesses keep track of their sales transactions, manage inventory.

Get one issue note

This API method allows retrieving one issue note with items by its id

Authorizations:
Bearer
query Parameters
id
required
integer <int64> (Issue note id)

Issue note id

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "noteNumber": "string",
  • "typeDocumentId": "string",
  • "issueDate": "string",
  • "warehouseId": 0,
  • "economicalObject": "string",
  • "organizationStructureId": "string",
  • "mandantId": 0,
  • "issueNoteItems": [
    ]
}

Add new issue note.

This API method adds one issue note with items.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
noteNumber
string or null <string> (Issue note number)

Issue note number

typeDocumentId
string or null <string> (Document type id)

Issue note document type id, foreign key from QasidaEnum.DocumentTypeIssueNote.code

issueDate
string or null <datetime> (Issue note issue date)

Issue note IssueDate

warehouseId
integer or null <int64> (Warehouse id)

Issue note warehouse id , foreign key from WareHouse.id

economicalObject
string or null <string> (Economical object)

Economical object , multiple values from QasidaEnum.GetEconomicalObjects.shortcut separated by comma (,)

organizationStructureId
string or null <string> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.code

mandantId
integer or null <int64> (Mandant id)

Id of mandant

Array of objects or null (IssueNoteItemPostContract)

Responses

Request samples

Content type
application/json
{
  • "noteNumber": "string",
  • "typeDocumentId": "string",
  • "issueDate": "string",
  • "warehouseId": 0,
  • "economicalObject": "string",
  • "organizationStructureId": "string",
  • "mandantId": 0,
  • "issueNoteItems": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "noteNumber": "string",
  • "typeDocumentId": "string",
  • "issueDate": "string",
  • "warehouseId": 0,
  • "economicalObject": "string",
  • "organizationStructureId": "string",
  • "mandantId": 0,
  • "issueNoteItems": [
    ]
}

LiabilityList

Liability list is a document that outlines the obligations or debts of an entity. It provides an overview of the liabilities owed by the entity, including their nature, amounts, and any relevant details.

/api/eshop/v1/LiabilityList/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

customerId
required
integer <int64>
allLiabilities
boolean
Default: false
onlyDelayed
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

LiabilityListItem

Liability list item is an item of invoice included in liability list

/api/eshop/v1/LiabilityListItem/GetAllByInvoiceId

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

invoiceId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

OptionalDataDefinition

Definition of optional data for an entity

/api/eshop/v1/OptionalDataDefinition/GetForProduct

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withPickerValues
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/OptionalDataDefinition/GetForPacket

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withPickerValues
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/OptionalDataDefinition/GetForReceipt

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withPickerValues
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/OptionalDataDefinition/GetForReceiptItem

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withPickerValues
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/OptionalDataDefinition/GetForCustomerInvoice

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withPickerValues
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/OptionalDataDefinition/GetForCustomerInvoiceItem

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withPickerValues
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/OptionalDataDefinition/GetForSupplierInvoice

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withPickerValues
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/OptionalDataDefinition/GetForSupplierInvoiceItem

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withPickerValues
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/OptionalDataDefinition/GetForCustomerProformaInvoice

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withPickerValues
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/OptionalDataDefinition/GetForCustomerProformaInvoiceItem

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withPickerValues
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/OptionalDataDefinition/GetForSupplierProformaInvoice

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withPickerValues
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/OptionalDataDefinition/GetForSupplierProformaInvoiceItem

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withPickerValues
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/OptionalDataDefinition/GetForCustomerOrder

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withPickerValues
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

OrganizationStructure

Organization structure refers to a specific unit of organization

/api/eshop/v1/OrganizationStructure/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

validFor
string <date-time>
parentId
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/OrganizationStructure/GetById

Authorizations:
Bearer
query Parameters
id
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "shortcut": "string",
  • "name": "string",
  • "validFrom": "string",
  • "validTo": "string",
  • "parentId": 0,
  • "typeId": "string",
  • "typeName": "string",
  • "sortingCode": "string"
}

/api/eshop/v1/OrganizationStructure/GetByShortcut

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

shortcut
required
string
validFor
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Packet

Packet can refer to a small package or parcel of goods that is prepared for shipping or delivery

/api/eshop/v1/Packet/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withOptionalData
boolean
workflowStatusCode
string
shippingServiceTypeId
string
priceWithVat
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Packet/GetById

Authorizations:
Bearer
query Parameters
id
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withOptionalData
boolean
priceWithVat
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "packetNumber": "string",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "customerId": 0,
  • "customerName": "string",
  • "mandantId": 0,
  • "shippingServiceTypeId": "string",
  • "paymentMethod": "string",
  • "fullClientName": "string",
  • "clientCustomerName": "string",
  • "clientPhone": "string",
  • "clientEmail": "string",
  • "clientAddressStreet": "string",
  • "clientCity": "string",
  • "clientPostalCode": "string",
  • "clientCountry": "string",
  • "branchId": "string",
  • "branchName": "string",
  • "price": 0.1,
  • "cashOfDeliveryPrice": 0.1,
  • "cashOfDeliveryCurrency": "string",
  • "internalTrackSymbol": "string",
  • "manipulationUnitId": "string",
  • "weight": 0.1,
  • "additionalServices": "string",
  • "externalOrderNumber": "string",
  • "shippingNote": "string",
  • "isPaid": true,
  • "workflowStatusCode": "string",
  • "workflowStatusName": "string",
  • "packetShippingNumber": "string",
  • "packetListNumber": "string",
  • "trackingUrl": "string",
  • "labelUrl": "string",
  • "parentId": 0,
  • "optionalData": [
    ],
  • "packetItems": [
    ]
}

/api/eshop/v1/Packet/GetByPacketNumber

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

packetNumber
required
string
priceWithVat
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Packet/GetByPacketShippingNumber

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

packetShippingNumber
required
string
priceWithVat
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Packet/ChangeWorkflowStatus

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <int64> (Packet Id)

The unique Id of the packet

workflowStatusCode
string or null <string> (Workflow status code)

The code of the workflow status - QasidaEnums.GetPacketWorkflowStatus

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "workflowStatusCode": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "workflowStatusCode": "string"
}

PriceList

A price list is a document or list that provides the prices of goods or services offered by a business or organization

/api/eshop/v1/PriceList/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

priceListType
string
onlyValid
boolean
Default: true

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/PriceList/GetById

Authorizations:
Bearer
query Parameters
id
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "priceListDesc": "string",
  • "priceListCode": "string",
  • "priceListType": "string",
  • "order": 0,
  • "priceListValidity": true,
  • "mandantId": 0,
  • "vatIncluded": true,
  • "currencyCode": "string",
  • "macro2": "string"
}

/api/eshop/v1/PriceList/GetByCode

Authorizations:
Bearer
query Parameters
code
required
string
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

priceListType
string
onlyValid
boolean
Default: true

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "priceListDesc": "string",
  • "priceListCode": "string",
  • "priceListType": "string",
  • "order": 0,
  • "priceListValidity": true,
  • "mandantId": 0,
  • "vatIncluded": true,
  • "currencyCode": "string",
  • "macro2": "string"
}

/api/eshop/v1/PriceList/UpdatePriceList

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer or null <int64>
priceListDesc
string or null
priceListCode
string or null
priceListType
string or null
order
integer or null <int32>
priceListValidity
boolean
mandantId
integer or null <int64>
vatIncluded
boolean
currencyCode
string or null
macro2
string or null

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "priceListDesc": "string",
  • "priceListCode": "string",
  • "priceListType": "string",
  • "order": 0,
  • "priceListValidity": true,
  • "mandantId": 0,
  • "vatIncluded": true,
  • "currencyCode": "string",
  • "macro2": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "priceListDesc": "string",
  • "priceListCode": "string",
  • "priceListType": "string",
  • "order": 0,
  • "priceListValidity": true,
  • "mandantId": 0,
  • "vatIncluded": true,
  • "currencyCode": "string",
  • "macro2": "string"
}

/api/eshop/v1/PriceList/InsertPriceList

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer or null <int64> (Price list id)

The unique identifier for the price list

priceListDesc
string or null <string> (Price list description)

The price list description

priceListCode
string or null <string> (Price list code)

The code of the pricelist

priceListType
string or null <string> (Price list type)

Price list type, foreign key from QasidaEnum.GetPriceListType.code

order
integer or null <int> (Price list order)

The order among other price lists

priceListValidity
boolean <boolean> (Price list validity)

PriceList validity (Y | N)

mandantId
integer or null <int64> (Mandant id)

The id of the mandant to which the price list belongs, foreign key from QasidaEnum.GetMandant.code

vatIncluded
boolean <boolean> (Vat Included)

Is vat included (Y | N)

currencyCode
string or null <string> (Currency code)

The currency code, foreign key from QasidaEnum.GetCurrencies.code

macro2
string or null <string> (Macro2)

The Macro2 attribute from the SPIN. The formula for price calculation.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "priceListDesc": "string",
  • "priceListCode": "string",
  • "priceListType": "string",
  • "order": 0,
  • "priceListValidity": true,
  • "mandantId": 0,
  • "vatIncluded": true,
  • "currencyCode": "string",
  • "macro2": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "priceListDesc": "string",
  • "priceListCode": "string",
  • "priceListType": "string",
  • "order": 0,
  • "priceListValidity": true,
  • "mandantId": 0,
  • "vatIncluded": true,
  • "currencyCode": "string",
  • "macro2": "string"
}

PriceListItem

Item of price list contains product, customer, quantity and price with date validity

/api/eshop/v1/PriceListItem/GetAllByPriceListId

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

priceListId
required
integer <int64>
since
string <date-time>
productId
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/PriceListItem/GetAllByPriceListIdAndWarehouseId

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

priceListId
required
integer <int64>
warehouseId
required
integer <int64>
since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/PriceListItem/UpdatePriceListItem

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer or null <int64> (Id)

The id of the price list item

priceListId
integer or null <int64> (Price list id)

Price list id, foreign key from Pricelist.id

productId
integer or null <int64> (Product id)

The id of the product, foreign key from Product.productId

value
number or null <decimal> (Value)

The value of the pricelist item

validFrom
string or null <decimal> (Valid from)

The date from which the price list item is valid

validTo
string or null <decimal> (Valid to)

The date until which the price list item is valid

customerId
integer or null <int64> (Customer id)

The id of the customer to which the price list item belongs, foreign key from Customer.id

priceTypeId
integer or null <decimal> (Price type id)

The type of the price list item, foreign key from QasidaEnum.GetPriceListType.code

note
string or null <string> (Note)

The Note of the price list item

quantityFrom
number or null <decimal> (Quantity from)

The price is valid for at least x items. Default is 0.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "priceListId": 0,
  • "productId": 0,
  • "value": 0,
  • "validFrom": "string",
  • "validTo": "string",
  • "customerId": 0,
  • "priceTypeId": 0,
  • "note": "string",
  • "quantityFrom": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "priceListId": 0,
  • "productId": 0,
  • "value": 0,
  • "validFrom": "string",
  • "validTo": "string",
  • "customerId": 0,
  • "priceTypeId": 0,
  • "note": "string",
  • "priceKindDescription": "string",
  • "priceKindCode": "string",
  • "mandantId": 0,
  • "productCode": "string",
  • "productName": "string",
  • "unitShortName": "string",
  • "currencyCode": "string",
  • "categoryCode": "string",
  • "categoryName": "string",
  • "customerRegistrationNumber": "string",
  • "taxRegistrationNumber": "string",
  • "customerName": "string",
  • "internalCode": "string",
  • "priceKindType": "string",
  • "quantityFrom": 0,
  • "warehouseQuantity": 0,
  • "warehouseAvailableQuantity": 0
}

/api/eshop/v1/PriceListItem/InsertPriceListItem

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
priceListId
integer or null <int64> (Price list id)

Price list id, foreign key from Pricelist.id

productId
integer or null <int64> (Product id)

The id of the product, foreign key from Product.productId

value
number or null <decimal> (Value)

The value of the pricelist item

validFrom
string or null <decimal> (Valid from)

The date from which the price list item is valid

validTo
string or null <decimal> (Valid to)

The date until which the price list item is valid

customerId
integer or null <int64> (Customer id)

The id of the customer to which the price list item belongs, foreign key from Customer.id

priceTypeId
integer or null <decimal> (Price type id)

The type of the price list item, foreign key from QasidaEnum.GetPriceListType.code

note
string or null <string> (Note)

The Note of the price list item

quantityFrom
number or null <decimal> (Quantity from)

The price is valid for at least x items. Default is 0.

Responses

Request samples

Content type
application/json
{
  • "priceListId": 0,
  • "productId": 0,
  • "value": 0,
  • "validFrom": "string",
  • "validTo": "string",
  • "customerId": 0,
  • "priceTypeId": 0,
  • "note": "string",
  • "quantityFrom": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "priceListId": 0,
  • "productId": 0,
  • "value": 0,
  • "validFrom": "string",
  • "validTo": "string",
  • "customerId": 0,
  • "priceTypeId": 0,
  • "note": "string",
  • "priceKindDescription": "string",
  • "priceKindCode": "string",
  • "mandantId": 0,
  • "productCode": "string",
  • "productName": "string",
  • "unitShortName": "string",
  • "currencyCode": "string",
  • "categoryCode": "string",
  • "categoryName": "string",
  • "customerRegistrationNumber": "string",
  • "taxRegistrationNumber": "string",
  • "customerName": "string",
  • "internalCode": "string",
  • "priceKindType": "string",
  • "quantityFrom": 0,
  • "warehouseQuantity": 0,
  • "warehouseAvailableQuantity": 0
}

ProductCategory

Product category refers to a classification or grouping of related products based on their shared characteristics, features, or purpose.It is a way to organize and categorize products

/api/eshop/v1/ProductCategory/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/ProductCategory/GetById

Authorizations:
Bearer
query Parameters
id
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "productCategoryId": 0,
  • "mandantId": 0,
  • "productCategoryName": "string",
  • "productCategoryCode": "string",
  • "productCategoryType": "string",
  • "parentProductCategoryId": 0,
  • "parentProductCategory": { }
}

/api/eshop/v1/ProductCategory/GetByCode

Authorizations:
Bearer
query Parameters
code
required
string
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "productCategoryId": 0,
  • "mandantId": 0,
  • "productCategoryName": "string",
  • "productCategoryCode": "string",
  • "productCategoryType": "string",
  • "parentProductCategoryId": 0,
  • "parentProductCategory": { }
}

/api/eshop/v1/ProductCategory/GetByType

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

productCategoryTypeId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Product

A product is an item that is created, produced, or offered for sale. Products can be physical objects, services, or a combination of both

/api/eshop/v1/Product/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <date-time>
withOptionalData
boolean
withAlternativeCodes
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Product/GetAllByPriceListIdAndWarehouseId

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

priceListId
required
integer <int64>
warehouseId
required
integer <int64>
since
string <date-time>
withOptionalData
boolean
withAlternativeCodes
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Product/GetById

Authorizations:
Bearer
query Parameters
id
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withOptionalData
boolean
withAlternativeCodes
boolean

Responses

Response samples

Content type
application/json
{
  • "productId": 0,
  • "mandantId": 0,
  • "productName": "string",
  • "productCode": "string",
  • "productType": "string",
  • "vat": 0,
  • "vatId": 0,
  • "vatName": "string",
  • "accountingGroup": "string",
  • "organizationStructureName": "string",
  • "listEO": "string",
  • "unit1Code": "string",
  • "unit1Shortcut": "string",
  • "unit2Code": "string",
  • "unit2Shortcut": "string",
  • "unit3Code": "string",
  • "unit3Shortcut": "string",
  • "organizationStructureId": 0,
  • "coefUnit2": 0,
  • "coefUnit3": 0,
  • "cpaId": 0,
  • "cpaCode": "string",
  • "cpaName": "string",
  • "cpaLongName": "string",
  • "cpaUnit": "string",
  • "cpaUnitCode": "string",
  • "cpaUnitName": "string",
  • "coefCPAUnit": "string",
  • "coefCustomsTariffUnit": "string",
  • "coefExciseTaxUnit": "string",
  • "weight": 0,
  • "weight2": 0,
  • "categoryId": 0,
  • "categoryCode": "string",
  • "categoryName": "string",
  • "productValidity": "string",
  • "stockItem": "string",
  • "negativeQuantityAllowed": "string",
  • "substituteProductId": 0,
  • "internet": "string",
  • "unit2Tracking": "string",
  • "serialNumberTracking": "string",
  • "serialNumberMandatory": "string",
  • "expirationDateTracking": "string",
  • "expirationDateMandatory": "string",
  • "description": "string",
  • "parentProductId": 0,
  • "edited": "string",
  • "alternativeProductCodes": [
    ],
  • "optionalData": [
    ]
}

/api/eshop/v1/Product/GetByCode

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

code
required
string
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

withOptionalData
boolean
withAlternativeCodes
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Product/InsertProduct

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
mandantId
integer or null <int64> (Mandant id)

The id of the mandant to which the product belongs, foreign key from QasidaEnum.GetMandant.code. If 0, the product is for all mandants.

productName
string or null <string> (Product name)

The name of the product

productCode
string or null <string> (Product code)

The code of the product

productType
string or null <string> (Product type)

The type of the product (M-material, T-goods, O-cover, S-service, ...), foreign key from QasidaEnum.GetProductTypes.code

vat
number or null <decimal> (Vat)

Vat rate in [%]

vatId
integer or null <string> (Vat id)

The Code (identification) of the VAT, foreign key from QasidaEnum.GetVatTypesIn.code or QasidaEnum.GetVatTypesOut.code

accountingGroup
string or null <string> (Accounting group)

Defines the accounting group of product, foreign key from QasidaEnum.GetAccountingGroup.code

listEO
string or null <string> (List EO)

List of economic dimensions , foreign key from QasidaEnum.GetEconomicalObjects.code

unit1Code
string or null <string> (Unit 1 code)

The code of the 1st measure unit , foreign key from QasidaEnum.GetMeasureUnit.code

unit2Code
string or null <string> (Unit 2 code)

The code of the 2nd measure unit , foreign key from QasidaEnum.GetMeasureUnit.code

unit3Code
string or null <string> (Unit 3 code)

The code of the 3rd measure unit , foreign key from QasidaEnum.GetMeasureUnit.code

organizationStructureId
integer or null <int64> (Organization structure id)

The id (code) of the organization structure , foreign key from QasidaEnum.GetOrganizationStructure.code

coefUnit2
number or null <decimal> (Coeficient unit 2)

Coefficient Unit1 / Unit2

coefUnit3
number or null <decimal> (Coeficient unit 3)

Coefficient Unit1 / Unit3

cpaId
integer or null <string> (CpaId)

CPA - Classification of Products by Activity

cpaCode
string or null
cpaName
string or null <string> (CpaCode)

CPA - Classification of Products by Activity

cpaLongName
string or null <string> (CpaLongName)

CPA - Classification of Products by Activity

cpaUnit
string or null <string> (CPAUnit)

Unit1 of CPA

cpaUnitCode
string or null <string> (CPAUnitCode)

Unit1 of CPA - code

cpaUnitName
string or null <string> (CPAUnitName)

Unit1 of CPA - name

coefCPAUnit
string or null <string> (CoefCPAUnit)

Coefficient Unit1 / Unit1 of CPA

coefCustomsTariffUnit
string or null <string> (CoefCustomsTariffUnit)

Coefficient Unit1 / Unit1 of customs tariff

coefExciseTaxUnit
string or null <string> (CoefExciseTaxUnit)

Coefficient Unit1 / Unit1 of excise tax

weight
number or null <decimal> (Weight)

Weight of the product

weight2
number or null <decimal> (Weight 2)

Weight 2 of the product

categoryId
integer or null <int64> (Category id)

Product category id, foreign key from ProductCategory.productCategoryId

categoryCode
string or null <string> (Category code)

Product category code, foreign key from ProductCategory.productCategoryCode

categoryName
string or null <string> (Category name)

Product category name, foreign key from ProductCategory.productCategoryName

productValidity
string or null <string> (Product validity)

Product is valid (Y | N)

stockItem
string or null <string> (Stock item)

Product is stock item (Y | N)

negativeQuantityAllowed
string or null <string> (Negative quantity allowed)

Product negative quantity allowed (Y | N)

substituteProductId
integer or null <int64> (Substitute product id)

Product ID of substitute product, foreign key from Product.productId

internet
string or null <string> (Internet)

Product is visible for eshop

unit2Tracking
string or null <string> (Unit 2 tracking)

Unit 2 to tracking

serialNumberTracking
string or null <string> (Serial number tracking)

Serial number tracking (Yes | No | by Issue)

serialNumberMandatory
string or null <string> (Serial number mandatory)

Serial number tracking is mandatory (Yes | No)

expirationDateTracking
string or null <string> (Expiration date tracking)

Expiration date tracking (Yes | No | Receipt date)

expirationDateMandatory
string or null <string> (Expiration date mandatory)

Expiration date is mandatory (Yes | No)

description
string or null <string> (Description)

The description for product

Responses

Request samples

Content type
application/json
{
  • "mandantId": 0,
  • "productName": "string",
  • "productCode": "string",
  • "productType": "string",
  • "vat": 0,
  • "vatId": 0,
  • "accountingGroup": "string",
  • "listEO": "string",
  • "unit1Code": "string",
  • "unit2Code": "string",
  • "unit3Code": "string",
  • "organizationStructureId": 0,
  • "coefUnit2": 0,
  • "coefUnit3": 0,
  • "cpaId": 0,
  • "cpaCode": "string",
  • "cpaName": "string",
  • "cpaLongName": "string",
  • "cpaUnit": "string",
  • "cpaUnitCode": "string",
  • "cpaUnitName": "string",
  • "coefCPAUnit": "string",
  • "coefCustomsTariffUnit": "string",
  • "coefExciseTaxUnit": "string",
  • "weight": 0,
  • "weight2": 0,
  • "categoryId": 0,
  • "categoryCode": "string",
  • "categoryName": "string",
  • "productValidity": "string",
  • "stockItem": "string",
  • "negativeQuantityAllowed": "string",
  • "substituteProductId": 0,
  • "internet": "string",
  • "unit2Tracking": "string",
  • "serialNumberTracking": "string",
  • "serialNumberMandatory": "string",
  • "expirationDateTracking": "string",
  • "expirationDateMandatory": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "productId": 0,
  • "mandantId": 0,
  • "productName": "string",
  • "productCode": "string",
  • "productType": "string",
  • "vat": 0,
  • "vatId": 0,
  • "vatName": "string",
  • "accountingGroup": "string",
  • "organizationStructureName": "string",
  • "listEO": "string",
  • "unit1Code": "string",
  • "unit1Shortcut": "string",
  • "unit2Code": "string",
  • "unit2Shortcut": "string",
  • "unit3Code": "string",
  • "unit3Shortcut": "string",
  • "organizationStructureId": 0,
  • "coefUnit2": 0,
  • "coefUnit3": 0,
  • "cpaId": 0,
  • "cpaCode": "string",
  • "cpaName": "string",
  • "cpaLongName": "string",
  • "cpaUnit": "string",
  • "cpaUnitCode": "string",
  • "cpaUnitName": "string",
  • "coefCPAUnit": "string",
  • "coefCustomsTariffUnit": "string",
  • "coefExciseTaxUnit": "string",
  • "weight": 0,
  • "weight2": 0,
  • "categoryId": 0,
  • "categoryCode": "string",
  • "categoryName": "string",
  • "productValidity": "string",
  • "stockItem": "string",
  • "negativeQuantityAllowed": "string",
  • "substituteProductId": 0,
  • "internet": "string",
  • "unit2Tracking": "string",
  • "serialNumberTracking": "string",
  • "serialNumberMandatory": "string",
  • "expirationDateTracking": "string",
  • "expirationDateMandatory": "string",
  • "description": "string",
  • "parentProductId": 0,
  • "edited": "string",
  • "alternativeProductCodes": [
    ],
  • "optionalData": [
    ]
}

/api/eshop/v1/Product/GetAllByPriceListId

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

priceListId
required
integer <int64>
since
string <date-time>
withOptionalData
boolean
withAlternativeCodes
boolean

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Product/UpdateInternet

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
productId
required
integer <int64> (Product id)

The id of the product, foreign key from Product.productId

internet
required
boolean <boolean> (Internet)

If true, product is visible for eshop

Responses

Request samples

Content type
application/json
{
  • "productId": 0,
  • "internet": true
}

Response samples

Content type
application/json
{
  • "productId": 0,
  • "internet": true
}

/api/eshop/v1/Product/GetAllByPriceListIdAndWarehouseIdAndCategoryTypeId

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

priceListId
required
integer <int64>
warehouseId
required
integer <int64>
since
string <date-time>
withOptionalData
boolean
withAlternativeCodes
boolean
productCategoryTypeId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Product/GetAllByCategoryTypeId

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <date-time>
withOptionalData
boolean
withAlternativeCodes
boolean
productCategoryTypeId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

ProductCostPrice

Definition of optional data for an entity

/api/eshop/v1/ProductCostPrice/GetByProductIdAndWarehouseId

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

productId
required
integer <int64>
warehouseId
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "productId": 0,
  • "warehouseId": 0,
  • "averageStockPrice": 0,
  • "lastPurchasePrice": 0
}

ProductPrice

Product price returned from price settings according to various criteria

/api/eshop/v1/ProductPrice/GetByPriority2

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

productId
required
integer <int64>
priceListId
required
integer <int64>
customerId
integer <int64>
priceList2Id
integer <int64>
validForDate
string <date-time>
quantity
number <double>
priceWithVat
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "priceListId": 0,
  • "priceListItemId": 0,
  • "currency": "string",
  • "price": 0,
  • "productId": 0,
  • "customerId": 0,
  • "isPriceWithVat": true
}

Get prices for multiple price lists

Get prices for multiple price lists and the response can be paginated according to the provided query parameters.Price in items can be returned without or with VAT

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <datetime> (Date of last synchronization)

Returns only prices changed after date of last synchronization, if not specified returns all

priceWithVat
boolean <boolean> (Price with VAT)
Default: false

Return unit price with VAT , if not specified price is without VAT

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

ProductQuantity

Calculate product quantity according to various criteria

Get minimal set quantity

This API method retrieves minimal available set quantity for product id and warehouse id

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

productId
required
integer <int64> (Product id)

Product with relation type set

warehouseId
required
integer <int64> (Warehouse id)

Warehouse used to calculate quantity

Responses

Response samples

Content type
application/json
{
  • "productId": 0,
  • "warehouseId": 0,
  • "quantity": 0
}

Get minimal set quantity for all products

This API method allows retrieving a list of minimal set quantity for all products with relation to set

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

warehouseId
required
integer <int64> (Warehouse id)

Warehouse id , foreign key from WareHouse.id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

ProductRelation

Product relations are relations between products with relation type (master product ,packing for product)

/api/eshop/v1/ProductRelation/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

type
string
since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/ProductRelation/GetByParentProductId

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

parentProductId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/ProductRelation/GetByChildProductId

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

childProductId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/ProductRelation/GetByProductId

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

productId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

ProductSales

Product sales data for various criteria

/api/eshop/v1/ProductSales/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

customerId
required
integer <int64>
from
required
string <date-time>
to
required
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Receipt

A receipt is a document provided by a seller to a buyer as proof of a transaction. It serves as evidence that a financial transaction has occurred, typically involving the exchange of goods, services, or both

Get one receipt

This API method allows retrieving one receipt with items by its id

Authorizations:
Bearer
query Parameters
id
required
integer <int64> (Receipt id)

Receipt id

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "receiptNumber": "string",
  • "documentTypeId": "string",
  • "issueDate": "string",
  • "warehouseId": 0,
  • "economicObject": "string",
  • "organizationStructureId": "string",
  • "currency": "string",
  • "priceListId": 0,
  • "supplierId": 0,
  • "mandantId": 0,
  • "supplierOrderId": 0,
  • "deliveryNoteNumber": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "shippingCode": "string",
  • "termsOfDeliveryCode": "string",
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "supplierName": "string",
  • "documentTypeShortcut": "string",
  • "warehouseNumber": "string",
  • "organizationStructureShortcut": "string",
  • "noticeOfDeliveryId": 0,
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "receiptItems": [
    ]
}

Add new receipt

This API method adds one receipt with items.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
receiptNumber
string or null <string> (Receipt number)

Receipt number

documentTypeId
string or null <string> (Receipt document type id)

Receipt document type id foreign key from QasidaEnum.GetDocumentTypeReceipt.code

issueDate
string or null <datetime> (Issue date)

Receipt issue date

warehouseId
integer or null <int64> (Warehouse id)

Warehouse id foreign key from Warehouse.id

economicObject
string or null <string> (Economic object)

Economic object , multiple values from QasidaEnum.GetEconomicalObjects.shortcut separated by comma (,)

organizationStructureId
string or null <string> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.code

currency
string or null <string> (Currency)

Currency code, foreign key from QasidaEnum.GetCurrencies.code

supplierId
integer or null <int64> (Supplier id)

Supplier id , foreign key from Supplier.id

mandantId
integer or null <int64> (Mandant id)

Mandant id

deliveryNoteNumber
string or null <string> (Delivery note number)

Delivery note number

customerVatRegNoId
integer or null <int64> (Customer Vat Reg No Id)

Customer Vat Reg No Id, foreign key from Customer.icdpHs.id

supplierVatRegNoId
integer or null <int64> (Supplier Vat Reg No Id)

Supplier Vat Reg No Id, foreign key from Supplier.icdpHs.id

isoA2CountryCode
string or null <string> (Country code)

Country ISOA2 code used for delivery

vatDocumentTypeId
string or null <string> (Vat document type id)

Vat document type id, foreign key from QasidaEnum.GetVatDocumentType.code

shippingCode
string or null <string> (Shipping code)

Shipping code, foreign key from QasidaEnum.GetShippingCode.code

termsOfDeliveryCode
string or null <string> (Terms of delivery code)

Terms of delivery code, foreign key from QasidaEnum.GetTermsOfDelivery.code

supplierOrderId
integer or null <int64> (Supplier order id)

Supplier order id

noticeOfDeliveryId
integer or null <int64> (Notice of delivery id)

Notice of delivery id

Array of objects or null (Receipt optional data)

Optional data of receipt

Array of objects or null (Receipt optional text)

Optional text of receipt

Array of objects or null (Receipt items)

Items of receipt

Responses

Request samples

Content type
application/json
{
  • "receiptNumber": "string",
  • "documentTypeId": "string",
  • "issueDate": "string",
  • "warehouseId": 0,
  • "economicObject": "string",
  • "organizationStructureId": "string",
  • "currency": "string",
  • "supplierId": 0,
  • "mandantId": 0,
  • "deliveryNoteNumber": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "shippingCode": "string",
  • "termsOfDeliveryCode": "string",
  • "supplierOrderId": 0,
  • "noticeOfDeliveryId": 0,
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "receiptItems": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "receiptNumber": "string",
  • "documentTypeId": "string",
  • "issueDate": "string",
  • "warehouseId": 0,
  • "economicObject": "string",
  • "organizationStructureId": "string",
  • "currency": "string",
  • "priceListId": 0,
  • "supplierId": 0,
  • "mandantId": 0,
  • "supplierOrderId": 0,
  • "deliveryNoteNumber": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "shippingCode": "string",
  • "termsOfDeliveryCode": "string",
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "supplierName": "string",
  • "documentTypeShortcut": "string",
  • "warehouseNumber": "string",
  • "organizationStructureShortcut": "string",
  • "noticeOfDeliveryId": 0,
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "receiptItems": [
    ]
}

Delete receipt

This API method deletes one receipt with items.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

id
integer <int64>

Responses

ReceiptItem

A receipt item is a item of receipt document provided by a seller to a buyer as proof of a transaction. It serves as evidence that a financial transaction has occurred, typically involving the exchange of goods, services, or both

Add new receipt item

This API method adds one receipt item

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
receiptId
integer or null <int64> (Receipt id)

Receipt id for item

productId
integer or null <int64> (Product id)

Product id, foreign key from Product.productId

quantity
number or null <decimal> (Quantity)

Product quantity

quantity2
number or null <decimal> (Quantity2)

Product quantity2

price
number or null <decimal> (Unit price)

Unit product price without VAT

priceInForeignCurrency
number or null <decimal> (Unit price in foreign currency)

Unit price without VAT in foreign currency

order
integer or null <int> (Item line number)

Receipt item line number

economicObject
string or null <string> (Economic object)

Economic object , multiple values from QasidaEnum.GetEconomicalObjects.shortcut separated by comma (,)

organizationStructureId
string or null <string> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.id

serialNumber
string or null <string> (Serial number)

Serial number for product when serial number tracking is set on product

expirationDate
string or null <datetime> (Expiration date)

Expiration date when expiration date tracking is set on product

warrantyDate
string or null <datetime> (Warranty date)

Warranty date when warranty date tracking is set on product

stockPlacementId
integer or null <int64> (Stock placement id)

Stock placement id for item

stockCardId
integer or null <int64> (Stock card id)

Stock card id for item

supplierOrderItemId
integer or null <int64> (Supplier order item id)

Supplier order item id for item

issueItemId
integer or null <int64> (Issue item id)

Issue item id for item

stockSubcardId
integer or null <int64> (Stock subcard id)

Stock subcard id for item

noticeOfDeliveryItemId
integer or null <int64> (Notice of delivery item id)

Notice of delivery item id

Array of objects or null (Receipt item optional data)

Optional data of receipt item

Array of objects or null (Receipt item optional text)

Optional text of receipt item

Responses

Request samples

Content type
application/json
{
  • "receiptId": 0,
  • "productId": 0,
  • "quantity": 0,
  • "quantity2": 0,
  • "price": 0,
  • "priceInForeignCurrency": 0,
  • "order": 0,
  • "economicObject": "string",
  • "organizationStructureId": "string",
  • "serialNumber": "string",
  • "expirationDate": "string",
  • "warrantyDate": "string",
  • "stockPlacementId": 0,
  • "stockCardId": 0,
  • "supplierOrderItemId": 0,
  • "issueItemId": 0,
  • "stockSubcardId": 0,
  • "noticeOfDeliveryItemId": 0,
  • "optionalData": [
    ],
  • "optionalText": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "receiptNumber": "string",
  • "documentTypeId": "string",
  • "issueDate": "string",
  • "warehouseId": 0,
  • "economicObject": "string",
  • "organizationStructureId": "string",
  • "currency": "string",
  • "priceListId": 0,
  • "supplierId": 0,
  • "mandantId": 0,
  • "supplierOrderId": 0,
  • "deliveryNoteNumber": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "shippingCode": "string",
  • "termsOfDeliveryCode": "string",
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "supplierName": "string",
  • "documentTypeShortcut": "string",
  • "warehouseNumber": "string",
  • "organizationStructureShortcut": "string",
  • "noticeOfDeliveryId": 0,
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "receiptItems": [
    ]
}

Update existing receipt item

This API method updates one receipt item

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <int64> (Receipt item id)

Receipt item id

receiptId
integer or null <int64> (Receipt id)

Receipt id for item

productId
integer or null <int64> (Product id)

Product id, foreign key from Product.productId

quantity
number or null <decimal> (Quantity)

Product quantity

quantity2
number or null <decimal> (Quantity2)

Product quantity2

price
number or null <decimal> (Unit price)

Unit product price without VAT

priceInForeignCurrency
number or null <decimal> (Unit price in foreign currency)

Unit price without VAT in foreign currency

order
integer or null <int> (Item line number)

Receipt item line number

economicObject
string or null <string> (Economic object)

Economic object , multiple values from QasidaEnum.GetEconomicalObjects.shortcut separated by comma (,)

organizationStructureId
string or null <string> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.id

serialNumber
string or null <string> (Serial number)

Serial number for product when serial number tracking is set on product

expirationDate
string or null <datetime> (Expiration date)

Expiration date when expiration date tracking is set on product

warrantyDate
string or null <datetime> (Warranty date)

Warranty date when warranty date tracking is set on product

stockPlacementId
integer or null <int64> (Stock placement id)

Stock placement id for item

stockCardId
integer or null <int64> (Stock card id)

Stock card id for item

supplierOrderItemId
integer or null <int64> (Supplier order item id)

Supplier order item id for item

issueItemId
integer or null <int64> (Issue item id)

Issue item id for item

stockSubcardId
integer or null <int64> (Stock subcard id)

Stock subcard id for item

noticeOfDeliveryItemId
integer or null <int64> (Notice of delivery item id)

Notice of delivery item id for item

Array of objects or null (Receipt item optional data)

Optional data of receipt item

Array of objects or null (Receipt item optional text)

Optional text of receipt item

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "receiptId": 0,
  • "productId": 0,
  • "quantity": 0,
  • "quantity2": 0,
  • "price": 0,
  • "priceInForeignCurrency": 0,
  • "order": 0,
  • "economicObject": "string",
  • "organizationStructureId": "string",
  • "serialNumber": "string",
  • "expirationDate": "string",
  • "warrantyDate": "string",
  • "stockPlacementId": 0,
  • "stockCardId": 0,
  • "supplierOrderItemId": 0,
  • "issueItemId": 0,
  • "stockSubcardId": 0,
  • "noticeOfDeliveryItemId": 0,
  • "optionalData": [
    ],
  • "optionalText": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "receiptNumber": "string",
  • "documentTypeId": "string",
  • "issueDate": "string",
  • "warehouseId": 0,
  • "economicObject": "string",
  • "organizationStructureId": "string",
  • "currency": "string",
  • "priceListId": 0,
  • "supplierId": 0,
  • "mandantId": 0,
  • "supplierOrderId": 0,
  • "deliveryNoteNumber": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "shippingCode": "string",
  • "termsOfDeliveryCode": "string",
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "supplierName": "string",
  • "documentTypeShortcut": "string",
  • "warehouseNumber": "string",
  • "organizationStructureShortcut": "string",
  • "noticeOfDeliveryId": 0,
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "receiptItems": [
    ]
}

Delete existing receipt item

This API method updates one receipt item

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

id
required
integer <int64>

Responses

RelatedInvoice

Invoices related to various entities

/api/eshop/v1/RelatedInvoice/GetByEconomicalObject

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

economicalObjectId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

RelatedWarehouseDocument

Warehouse documents related to various entities

/api/eshop/v1/RelatedWarehouseDocument/GetByEconomicalObject

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

economicalObjectId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

QasidaEnum

Various entities that are used in other entities in foreign key relations

/api/eshop/v1/QasidaEnum/GetAddressTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetContactConnectionTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetCustomerTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetOrderStatus

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetEconomicalObjects

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetOrganizationStructures

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetCurrencies

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetShippingCodes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetShippingServiceTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetPaymentMethods

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetProductTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetVatTypesOut

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

vatDocumentTypeId
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetRabatTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetPriceListTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetWarehouseTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetMeasureUnits

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetAccountingGroups

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetTimePeriods

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetCustomerOrderDocumentTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetDeliveryNoteDocumentTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetCashBooks

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetCashReceiptTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetCashReceiptVatItemTypesOut

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetCashReceiptItemTypesIn

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetProductCategoryTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetShippingBranches

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

shippingServiceTypeId
required
integer <int64>
shortcut
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetShippingMeasureUnits

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

shippingServiceTypeId
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetBalanceItemDateTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetDocumentTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetCustomerOrderWorkflowStatus

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetPacketWorkflowStatus

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetProductRelationTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetAccountTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetAccountingDocumentTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetEconomicObjectTypes

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetCreditDebit

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetDiscountCategory

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetDocumentTypeCustomerInvoice

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetDocumentTypeSupplierInvoice

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetCustomerVatDocumentType

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetSupplierVatDocumentType

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetVatDocumentTransformationType

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetOptionalTextTypeCustomerInvoice

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetOptionalTextTypeSupplierInvoice

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetClerk

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetConstantSymbol

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

territorialDivision
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetInterestOnDelayTypeCustomerInvoice

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetInterestOnDelayTypeSupplierInvoice

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetVatTypesIn

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

vatDocumentTypeId
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetSumType

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetSumAlgorithm

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetDocumentTypeReceipt

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetTermsOfDelivery

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetBankPaymentType

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetOwnBankAccount

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetCustomer

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetProduct

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetUniversalBalanceEvidenceType

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetUniversalBalanceType

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetMandant

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetBank

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetCashReceiptItemTypesOut

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetCashReceiptVatItemTypesIn

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetDocumentTypeCustomerProformaInvoice

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetDocumentTypeSupplierProformaInvoice

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetOrganizationStructureTypes

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetDocumentTypeIssueNote

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/eshop/v1/QasidaEnum/GetAvailableMandants

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

agenda
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

StockCard

A stock card is a document used to track and record the movement of inventory items within a business

/api/eshop/v1/StockCard/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <date-time>
reservationType
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/StockCard/GetById

Authorizations:
Bearer
query Parameters
id
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "totalValue": 0,
  • "quantity": 0,
  • "quantity2": 0,
  • "reserveQuantity": 0,
  • "key": "string",
  • "unitPrice": 0,
  • "warehouseId": 0,
  • "warehouseNumber": "string",
  • "warehouseName": "string",
  • "warehouseType": "string",
  • "mandantId": 0,
  • "isPaletteWarehouse": true,
  • "productId": 0,
  • "productCode": "string",
  • "productName": "string",
  • "productType": "string",
  • "coefUnit2": 0,
  • "productValidity": true,
  • "unit1Code": "string",
  • "unit1Shortcut": "string",
  • "unit1Name": "string",
  • "unit2Code": "string",
  • "unit2Shortcut": "string",
  • "unit2Name": "string",
  • "accountingGroupCode": "string",
  • "accountingGroupName": "string",
  • "accountingGroupShortcut": "string",
  • "priceInCurrency": 0,
  • "availableQuantity": 0
}

/api/eshop/v1/StockCard/GetAllForWarehouseAndProduct

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <date-time>
warehouseId
required
integer <int64>
productId
required
integer <int64>
reservationType
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/StockCard/GetAllForWarehouse

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <date-time>
warehouseId
required
integer <int64>
reservationType
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/StockCard/GetAllForProduct

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <date-time>
productId
required
integer <int64>
reservationType
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/StockCard/UpdateStockCard

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer or null <int64> (Stockcard id)

The unique id of the stockcard

warehouseId
integer or null <int64> (Warehouse id)

The unique identifier for the warehouse to which the stock card belongs, foreign key from Warehouse.id

key
string or null <string> (Key)

The key of the stock card

quantity
number or null <decimal> (Quantity)

Quantity on the stock card

reserveQuantity
number or null <decimal> (Reserve quantity)

The quantity of the reserves on the stock card

unitPrice
number or null <decimal> (Unit price)

The unit price

productId
integer or null <int64> (Product id)

The Id of the product that belongs to the stock card, foreign key from Product.productId

isValid
boolean <boolean> (Is valid)

Product validity (Y | N)

quantity2
number or null <decimal> (Quantity2)

The second quantity on the stock card. Quantity / CoefUnit

priceInCurrency
number or null <decimal> (Price in currency)

The price recalculated in the currency

totalValue
number or null <decimal> (Total value)

The total value of the stock card. (Quantity * UnitPrice)

postponeRecalculateToDate
string or null <datetime> (Postpone recalculate to date)

The date from which the stock card should be recalculated. If not provided, the recalculation is done immediately

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "warehouseId": 0,
  • "key": "string",
  • "quantity": 0,
  • "reserveQuantity": 0,
  • "unitPrice": 0,
  • "productId": 0,
  • "isValid": true,
  • "quantity2": 0,
  • "priceInCurrency": 0,
  • "totalValue": 0,
  • "postponeRecalculateToDate": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "totalValue": 0,
  • "quantity": 0,
  • "quantity2": 0,
  • "reserveQuantity": 0,
  • "key": "string",
  • "unitPrice": 0,
  • "warehouseId": 0,
  • "warehouseNumber": "string",
  • "warehouseName": "string",
  • "warehouseType": "string",
  • "mandantId": 0,
  • "isPaletteWarehouse": true,
  • "productId": 0,
  • "productCode": "string",
  • "productName": "string",
  • "productType": "string",
  • "coefUnit2": 0,
  • "productValidity": true,
  • "unit1Code": "string",
  • "unit1Shortcut": "string",
  • "unit1Name": "string",
  • "unit2Code": "string",
  • "unit2Shortcut": "string",
  • "unit2Name": "string",
  • "accountingGroupCode": "string",
  • "accountingGroupName": "string",
  • "accountingGroupShortcut": "string",
  • "priceInCurrency": 0,
  • "availableQuantity": 0
}

/api/eshop/v1/StockCard/InsertStockCard

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
warehouseId
integer or null <int64> (Warehouse id)

The unique identifier for the warehouse to which the stock card belongs, foreign key from Warehouse.id

key
string or null <string> (Key)

The key of the stock card

quantity
number or null <string> (Quantity)

The quantity on the stock card

reserveQuantity
number or null <decimal> (Reserve quantity)

The quantity of the reserves on the stock card

unitPrice
number or null <decimal> (Unit price)

The unit price

productId
integer or null <int64> (Product id)

The Id of the product that belongs to the stock card, foreign key from Product.productId

isValid
boolean <boolean> (Is valid)

Product is valid (Y | N)

quantity2
number or null <demimal> (Quantity2)

The second quantity on the stock card (quantity / coefecient)

priceInCurrency
number or null <decimal> (Price in currency)

The price recalculated in the currency

totalValue
number or null <decimal> (Total value)

The total value on the stock card

postponeRecalculateToDate
string or null <datetime> (Postpone recalculate to date)

The date from which the stock card should be recalculated. If not provided, the recalculation is done immediately

Responses

Request samples

Content type
application/json
{
  • "warehouseId": 0,
  • "key": "string",
  • "quantity": 0,
  • "reserveQuantity": 0,
  • "unitPrice": 0,
  • "productId": 0,
  • "isValid": true,
  • "quantity2": 0,
  • "priceInCurrency": 0,
  • "totalValue": 0,
  • "postponeRecalculateToDate": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "totalValue": 0,
  • "quantity": 0,
  • "quantity2": 0,
  • "reserveQuantity": 0,
  • "key": "string",
  • "unitPrice": 0,
  • "warehouseId": 0,
  • "warehouseNumber": "string",
  • "warehouseName": "string",
  • "warehouseType": "string",
  • "mandantId": 0,
  • "isPaletteWarehouse": true,
  • "productId": 0,
  • "productCode": "string",
  • "productName": "string",
  • "productType": "string",
  • "coefUnit2": 0,
  • "productValidity": true,
  • "unit1Code": "string",
  • "unit1Shortcut": "string",
  • "unit1Name": "string",
  • "unit2Code": "string",
  • "unit2Shortcut": "string",
  • "unit2Name": "string",
  • "accountingGroupCode": "string",
  • "accountingGroupName": "string",
  • "accountingGroupShortcut": "string",
  • "priceInCurrency": 0,
  • "availableQuantity": 0
}

StockSubcard

A stock subcard is detail of stock card with various attributes

/api/eshop/v1/StockSubcard/GetAllForWarehouseAndProduct

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <date-time>
warehouseId
required
integer <int64>
productId
required
integer <int64>
onlyNonZeroQuantity
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/StockSubcard/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <date-time>
onlyNonZeroQuantity
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/StockSubcard/GetById

Authorizations:
Bearer
query Parameters
id
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "stockCardId": 0,
  • "quantity": 0,
  • "quantity2": 0,
  • "serialNumber": "string",
  • "unitPrice": 0,
  • "warehouseId": 0,
  • "warehouseNumber": "string",
  • "warehouseName": "string",
  • "productId": 0,
  • "productCode": "string",
  • "productName": "string",
  • "date": "string",
  • "receiptDate": "string",
  • "location": "string",
  • "unit1Code": "string",
  • "unit2Code": "string"
}

/api/eshop/v1/StockSubcard/GetAllForWarehouse

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <date-time>
warehouseId
required
integer <int64>
onlyNonZeroQuantity
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/StockSubcard/GetAllForProduct

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <date-time>
productId
required
integer <int64>
onlyNonZeroQuantity
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/StockSubcard/GetAllForSerialNumber

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <date-time>
serialNumber
required
string
onlyNonZeroQuantity
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/StockSubcard/AddMissingQuantityToStock

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer or null <int64> (Id)

The unique identifier for the stock subcard

quantity
number or null <string> (Quantity)

The quantity on the stock subcard

serialNumber
string or null <string> (Serial number)

The serial number of the stock subcard.

warehouseId
integer or null <int64> (Warehouse id)

The unique identifier for the warehouse to which the stock subcard belongs, foreign key from Warehouse.id

productId
integer or null <int64> (Product id)

The Id of the product that belongs to the stock subcard, foreign key from Product.productId

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "quantity": 0,
  • "serialNumber": "string",
  • "warehouseId": 0,
  • "productId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "stockCardId": 0,
  • "quantity": 0,
  • "quantity2": 0,
  • "serialNumber": "string",
  • "unitPrice": 0,
  • "warehouseId": 0,
  • "warehouseNumber": "string",
  • "warehouseName": "string",
  • "productId": 0,
  • "productCode": "string",
  • "productName": "string",
  • "date": "string",
  • "receiptDate": "string",
  • "location": "string",
  • "unit1Code": "string",
  • "unit2Code": "string"
}

Supplier

A supplier is an individual, organization, or entity that supplies goods or services or engages in a commercial transaction with a company

/api/eshop/v1/Supplier/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Supplier/GetById

Authorizations:
Bearer
query Parameters
id
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "internalCode": "string",
  • "ico": "string",
  • "dic": "string",
  • "name": "string",
  • "isVATPayer": true,
  • "validTo": "string",
  • "supplierTypeId": "string",
  • "purchaserId": 0,
  • "isPurchaser": true,
  • "priceListId": 0,
  • "supplierId": 0,
  • "isSupplier": true,
  • "edited": "string",
  • "addresses": [
    ],
  • "contacts": [
    ],
  • "icdpHs": [
    ],
  • "loyaltyId": "string",
  • "cardNumber": "string",
  • "optionalData": [
    ],
  • "bankAccounts": [
    ]
}

/api/eshop/v1/Supplier/GetByName

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

name
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Supplier/GetByCode

Authorizations:
Bearer
query Parameters
internalCode
required
string
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "internalCode": "string",
  • "ico": "string",
  • "dic": "string",
  • "name": "string",
  • "isVATPayer": true,
  • "validTo": "string",
  • "supplierTypeId": "string",
  • "purchaserId": 0,
  • "isPurchaser": true,
  • "priceListId": 0,
  • "supplierId": 0,
  • "isSupplier": true,
  • "edited": "string",
  • "addresses": [
    ],
  • "contacts": [
    ],
  • "icdpHs": [
    ],
  • "loyaltyId": "string",
  • "cardNumber": "string",
  • "optionalData": [
    ],
  • "bankAccounts": [
    ]
}

/api/eshop/v1/Supplier/GetByIco

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

ico
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Supplier/UpdateSupplier

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <int64> (Id)

The id of the supplier, foreign key from Customer.supplierId

mandantId
integer <int64> (Mandant id)

The id of the mandant, foreign key from QasidaEnum.GetMandant.code

internalCode
string or null <string> (Internal code)

The customer internal code, foreign key from Customer.internalCode

ico
string or null <string> (ICO)

The business ID of the customer, foreign key from Customer.ico

dic
string or null <string> (DIC)

The tax ID of the customer, foreign key from Customer.dic

name
string or null <string> (Name)

The full customer (company) name, foreign key from Customer.name

isVATPayer
boolean <boolean> (Is VAT payer)

Indicates if customer is a VAT payer, foreign key from Customer.isVATPayer

validTo
string or null <datetime> (Valid to)

Validity of the customer, if null then it's valid

supplierTypeId
string or null <string> (Supplier type id)

Customer type id (FO, PO, SO,...), foreign key from QasidaEnum.CustomerType.code

isPurchaser
boolean <int64> (Purchaser id)

The id of the purcharser, foreign key from Customer.purchaserId

priceListId
integer or null <int64> (Pricelist id)

The id of the pricelist, foreign key from Pricelist.id

isSupplier
boolean <int64> (Supplier id)

The id of the supplier, foreign key from Customer.supplierId

Array of objects or null (Addresses)

Addresses of the customer

Array of objects or null (Contacts)

Contacts of the customer

Array of objects or null (ICDPHs)

IC DPH of the customer

loyaltyId
string or null <string> (LoyaltyId)

The loyalty identification of the customer. Used in the loyalty system.

cardNumber
string or null <string> (CardNumber)

The number of the card of the customer in loyalty system

Array of objects or null (OptionalData)

The optional data for supplier

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "internalCode": "string",
  • "ico": "string",
  • "dic": "string",
  • "name": "string",
  • "isVATPayer": true,
  • "validTo": "string",
  • "supplierTypeId": "string",
  • "isPurchaser": true,
  • "priceListId": 0,
  • "isSupplier": true,
  • "addresses": [
    ],
  • "contacts": [
    ],
  • "icdpHs": [
    ],
  • "loyaltyId": "string",
  • "cardNumber": "string",
  • "optionalData": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "internalCode": "string",
  • "ico": "string",
  • "dic": "string",
  • "name": "string",
  • "isVATPayer": true,
  • "validTo": "string",
  • "supplierTypeId": "string",
  • "purchaserId": 0,
  • "isPurchaser": true,
  • "priceListId": 0,
  • "supplierId": 0,
  • "isSupplier": true,
  • "edited": "string",
  • "addresses": [
    ],
  • "contacts": [
    ],
  • "icdpHs": [
    ],
  • "loyaltyId": "string",
  • "cardNumber": "string",
  • "optionalData": [
    ],
  • "bankAccounts": [
    ]
}

/api/eshop/v1/Supplier/InsertSupplier

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
mandantId
integer <int64> (Mandant id)

The id of the mandant, foreign key from QasidaEnum.GetMandant.code

internalCode
string or null <string> (Internal code)

The customer internal code, foreign key from Customer.internalCode

ico
string or null <string> (ICO)

The business ID of the customer, foreign key from Customer.ico

dic
string or null <string> (DIC)

The tax ID of the customer, foreign key from Customer.dic

name
string or null <string> (Name)

The full customer (company) name, foreign key from Customer.name

isVATPayer
boolean <boolean> (Is VAT payer)

Indicates if customer is a VAT payer, foreign key from Customer.isVATPayer

supplierTypeId
string or null <string> (Supplier type id)

Customer type id (FO, PO, SO,...), foreign key from QasidaEnum.CustomerType.code

isPurchaser
boolean <boolean> (Is purchaser)

Indicates if customer is a purchaser, foreign key from Customer.isPurchaser

priceListId
integer or null <int64> (Pricelist id)

The id of the pricelist, foreign key from Pricelist.id

isSupplier
boolean <boolean> (Is supplier)

Indicates if customer is a supplier, foreign key from Customer.isSupplier

Array of objects or null (Addresses)

The addresses for supplier

Array of objects or null (Contacts)

The contacts for supplier

Array of objects or null (ICDPHs)

The ICDPHs for supplier

loyaltyId
string or null <string> (LoyaltyId)

The loyalty identification of the customer. Used in the loyalty system

cardNumber
string or null <string> (Card number)

The number of the card, used in the loyalty system

validTo
string or null <datetime> (Valid to)

The validity of the supplier, if null then it's valid

Array of objects or null (Optional data for supplier)

The optional data for supplier

Array of objects or null (Bank accounts for supplier)

Bank accounts data for supplier

Responses

Request samples

Content type
application/json
{
  • "mandantId": 0,
  • "internalCode": "string",
  • "ico": "string",
  • "dic": "string",
  • "name": "string",
  • "isVATPayer": true,
  • "supplierTypeId": "string",
  • "isPurchaser": true,
  • "priceListId": 0,
  • "isSupplier": true,
  • "addresses": [
    ],
  • "contacts": [
    ],
  • "icdpHs": [
    ],
  • "loyaltyId": "string",
  • "cardNumber": "string",
  • "validTo": "string",
  • "optionalData": [
    ],
  • "bankAccounts": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "internalCode": "string",
  • "ico": "string",
  • "dic": "string",
  • "name": "string",
  • "isVATPayer": true,
  • "validTo": "string",
  • "supplierTypeId": "string",
  • "purchaserId": 0,
  • "isPurchaser": true,
  • "priceListId": 0,
  • "supplierId": 0,
  • "isSupplier": true,
  • "edited": "string",
  • "addresses": [
    ],
  • "contacts": [
    ],
  • "icdpHs": [
    ],
  • "loyaltyId": "string",
  • "cardNumber": "string",
  • "optionalData": [
    ],
  • "bankAccounts": [
    ]
}

/api/eshop/v1/Supplier/InsertSupplierAddress

Authorizations:
Bearer
query Parameters
supplierId
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
street
string or null <string> (Street)

Street

city
string or null <string> (City)

City

postalCode
string or null <string> (Postal code)

The postal code

buildingNumber
string or null <string> (Building number)

The number of the building

propertyRegistrationNumber
string or null <string> (Property registration number)

The registration number of the property

addressTypeCode
string or null <string> (Address type code)

If it's empty, than it's a default address (adresa sídla), otherwise foreign key from QasidaEnums.AddressType.code

validTo
string or null <datetime> (Valid to)

Validity of the address, if null then it's valid

isoA2CountryCode
string or null <string> (IsoA2 country code)

Country ISO Alpha-2 code (SK, CZ, US, ... )

Responses

Request samples

Content type
application/json
{
  • "street": "string",
  • "city": "string",
  • "postalCode": "string",
  • "buildingNumber": "string",
  • "propertyRegistrationNumber": "string",
  • "addressTypeCode": "string",
  • "validTo": "string",
  • "isoA2CountryCode": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "street": "string",
  • "city": "string",
  • "postalCode": "string",
  • "buildingNumber": "string",
  • "propertyRegistrationNumber": "string",
  • "addressTypeCode": "string",
  • "validTo": "string",
  • "isoA2CountryCode": "string"
}

/api/eshop/v1/Supplier/UpdateSupplierAddress

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <int64> (Id)

The Id of the address, foreign key from

supplierId
integer <int64> (Supplier Id)

The Id of the customer, foreign key from Customer.SupplierId

street
string or null <string> (Street)

Street

city
string or null <string> (City)

City

postalCode
string or null <string> (Postal code)

The postal code

buildingNumber
string or null <string> (Building number)

The number of the building

propertyRegistrationNumber
string or null <string> (Property registration number)

The registration number of the property

addressTypeCode
string or null <string> (Address type code)

If it's empty, than it's a default address (billing address), otherwise foreign key from QasidaEnums.AddressType

validTo
string or null <datetime> (Valid to)

Validity of the address, if null then it's valid

isoA2CountryCode
string or null <string> (IsoA2 country code)

Country ISO Alpha-2 code (SK, CZ, US, ... )

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "supplierId": 0,
  • "street": "string",
  • "city": "string",
  • "postalCode": "string",
  • "buildingNumber": "string",
  • "propertyRegistrationNumber": "string",
  • "addressTypeCode": "string",
  • "validTo": "string",
  • "isoA2CountryCode": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "street": "string",
  • "city": "string",
  • "postalCode": "string",
  • "buildingNumber": "string",
  • "propertyRegistrationNumber": "string",
  • "addressTypeCode": "string",
  • "validTo": "string",
  • "isoA2CountryCode": "string"
}

/api/eshop/v1/Supplier/InsertSupplierContact

Authorizations:
Bearer
query Parameters
supplierId
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
value
string or null
type
string or null
note
string or null <= 50 characters

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "type": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "value": "string",
  • "type": "string",
  • "note": "string",
  • "validTo": "string"
}

/api/eshop/v1/Supplier/UpdateSupplierContact

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <int64> (Id)

The unique id of the contact

value
string or null <string> (Value)

The contact value itself

type
string or null <string> (Type)

The type of the contact, foreign key from QasidaEnums.ContactConnectionType.code

note
string or null <string> (Note)

Optional note for the contact

validTo
string or null <datetime> (Valid to)

Validity of the contact, if null then it's valid

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "value": "string",
  • "type": "string",
  • "note": "string",
  • "validTo": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "value": "string",
  • "type": "string",
  • "note": "string",
  • "validTo": "string"
}

/api/eshop/v1/Supplier/InsertSupplierIcdph

Authorizations:
Bearer
query Parameters
supplierId
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
value
string or null <string> (Value)

The VAT number for customer or supplier

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "value": "string"
}

/api/eshop/v1/Supplier/UpdateSupplierIcdph

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <string> (Value)

The Id of the VAT number for purchaser or supplier

value
string or null <string> (Value)

The VAT number for purchaser or supplier

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "value": "string"
}

/api/eshop/v1/Supplier/GetByEmail

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

email
required
string
since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Supplier/GetByCardNumber

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

cardNumber
required
string
since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Supplier/GetByLoyaltyId

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

loyaltyId
required
string
since
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Supplier/InsertSupplierOptionalData

Authorizations:
Bearer
query Parameters
supplierId
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <int64> (Id)

The Id of the optional data

supplierId
integer or null <int64> (Supplier Id)

The Id of the customer, foreign key from Customer.SupplierId

listValueShortcut
string or null <string> (List value shortcut)

The shortcut of the optional data value for supplier

nonListValue
string or null <string> (Non list value)

The value of the optional data for supplier

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "supplierId": 0,
  • "listValueShortcut": "string",
  • "nonListValue": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "supplierId": 0,
  • "code": "string",
  • "listValueShortcut": "string",
  • "listValueName": "string",
  • "nonListValue": "string"
}

/api/eshop/v1/Supplier/UpdateSupplierOptionalData

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <int64> (Id)

The Id of the optional data

supplierId
integer or null <int64> (Supplier Id)

The Id of the supplier, foreign key from Customer.SupplierId

listValueShortcut
string or null <string> (List value shortcut)

The shortcut of the optional data value

nonListValue
string or null <string> (Non list value)

The value of the optional data

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "supplierId": 0,
  • "listValueShortcut": "string",
  • "nonListValue": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "supplierId": 0,
  • "code": "string",
  • "listValueShortcut": "string",
  • "listValueName": "string",
  • "nonListValue": "string"
}

/api/eshop/v1/Supplier/GetBankAccountsBySupplierId

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

supplierId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Supplier/InsertSupplierBankAccount

Authorizations:
Bearer
query Parameters
supplierId
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
bankAccountNumber
required
string <string> (Bank account number) non-empty

Bank account number / IBAN number

note
string or null <string> (Note)

Note for bank account number

bankId
required
string <string> (Bank id) non-empty

The id of the bank, foreign key from QasidaEnum.GetBank.code

order
integer or null <int> (Order of bank account number)

Order of bank account number

Responses

Request samples

Content type
application/json
{
  • "bankAccountNumber": "string",
  • "note": "string",
  • "bankId": "string",
  • "order": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "bankAccountNumber": "string",
  • "note": "string",
  • "validTo": "2019-08-24T14:15:22Z",
  • "bankName": "string",
  • "bankCode": "string",
  • "order": 0
}

/api/eshop/v1/Supplier/UpdateSupplierBankAccount

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
required
integer <int64> (Id)

The unique id of the bank account

bankAccountNumber
required
string <string> (Bank account number) non-empty

Bank account number / IBAN number

note
string or null <string> (Note)

Note for bank account number

bankId
required
string <string> (Bank id) non-empty

The id of the bank, foreign key from QasidaEnum.GetBank.code

order
integer or null <int> (Order of bank account number)

Order of bank account number

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "bankAccountNumber": "string",
  • "note": "string",
  • "bankId": "string",
  • "order": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "bankAccountNumber": "string",
  • "note": "string",
  • "bankId": "string",
  • "order": 0
}

SupplierInvoicePaymentInfo

Payment information of supplier invoices

/api/eshop/v1/SupplierInvoicePaymentInfo/GetByVariableSymbol

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

variableSymbol
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/SupplierInvoicePaymentInfo/GetById

Authorizations:
Bearer
query Parameters
id
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "variableSymbol": "string",
  • "supplierId": 0,
  • "mandantId": 0,
  • "paymentMethod": "string",
  • "supplierName": "string",
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "totalSum": 0,
  • "notPaidSum": 0,
  • "lastPaymentDate": "string",
  • "invoiceType": "string",
  • "parentId": 0
}

Turnover

Turnover refers to the total sales or revenue generated by a company within a specific period.It represents the company's ability to generate sales and is often used as an indicator of its financial performance

/api/eshop/v1/Turnover/GetByCustomerId

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

customerId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "period": "string",
  • "purchaserTurnover": 0.1,
  • "purchaserPayment": 0.1,
  • "supplierTurnover": 0.1,
  • "supplierPayment": 0.1
}

UniversalBalanceItem

Universal balance item is item that can be used in other documents to set its balance status

Get one universal balance item

This API method allows retrieving one universal balance item with items by its id

Authorizations:
Bearer
query Parameters
id
required
integer <int64> (Universal balance item id)

Universal balance item id

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "itemEvidenceTypeId": "string",
  • "organizationStructureId": "string",
  • "itemShortcut": "string",
  • "itemName": "string",
  • "itemDate": "string",
  • "itemVs": "string",
  • "itemCs": "string",
  • "itemSs": "string",
  • "itemBalanceTypeId": "string",
  • "companyId": 0,
  • "bankAccountId": 0,
  • "validFrom": "string",
  • "validTo": "string",
  • "companyIco": "string",
  • "companyInternalCode": "string",
  • "companyName": "string",
  • "bankAccountNumber": "string",
  • "organizationStructureShortcut": "string",
  • "itemBalanceTypeName": "string",
  • "itemEvidenceTypeName": "string",
  • "mandantId": 0
}

/api/eshop/v1/UniversalBalanceItem/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Add new universal balance item

This API method adds one universal balance item

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
itemEvidenceTypeId
string or null <string> (Evidence type id)

Evidence type id from QasidaEnum/GetUniversalBalanceEvidenceType.Code

organizationStructureId
string or null <string> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.code

itemShortcut
string or null <string> (Item shortcut)

Item shortcut

itemName
string or null <string> (Item name)

Item name

itemDate
string or null <datetime> (Item date)

Item date

itemVs
string or null <string> (Variable symbol)

Variable symbol

itemCs
string or null <string> (Constant symbol)

Variable symbol

itemSs
string or null <string> (Variable symbol)

Variable symbol

companyId
integer or null <int64> (Company id)

Company id , foreign key from Supplier.id or Customer.id

itemBalanceTypeId
string or null <string> (Balance type id)

Balance type id , foreign key from QasidaEnum.GetUniversalBalanceType.code

bankAccountId
integer or null <int64> (Bank account id)

Bank account id , foreign key from BankAccount.id

validFrom
string or null <datetime> (Valid from)

Valid from

validTo
string or null <datetime> (Valid to)

Valid to

Responses

Request samples

Content type
application/json
{
  • "itemEvidenceTypeId": "string",
  • "organizationStructureId": "string",
  • "itemShortcut": "string",
  • "itemName": "string",
  • "itemDate": "string",
  • "itemVs": "string",
  • "itemCs": "string",
  • "itemSs": "string",
  • "companyId": 0,
  • "itemBalanceTypeId": "string",
  • "bankAccountId": 0,
  • "validFrom": "string",
  • "validTo": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "itemEvidenceTypeId": "string",
  • "organizationStructureId": "string",
  • "itemShortcut": "string",
  • "itemName": "string",
  • "itemDate": "string",
  • "itemVs": "string",
  • "itemCs": "string",
  • "itemSs": "string",
  • "itemBalanceTypeId": "string",
  • "companyId": 0,
  • "bankAccountId": 0,
  • "validFrom": "string",
  • "validTo": "string",
  • "companyIco": "string",
  • "companyInternalCode": "string",
  • "companyName": "string",
  • "bankAccountNumber": "string",
  • "organizationStructureShortcut": "string",
  • "itemBalanceTypeName": "string",
  • "itemEvidenceTypeName": "string",
  • "mandantId": 0
}

Warehouse

Warehouse is evidence used for the storage of goods and products on stock cards

/api/eshop/v1/Warehouse/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/eshop/v1/Warehouse/GetById

Authorizations:
Bearer
query Parameters
id
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": "string",
  • "name": "string",
  • "type": "string",
  • "mandantId": 0,
  • "organizationStructureId": 0,
  • "organizationStructureName": "string",
  • "workingTimePeriod": "string",
  • "inventoryTimePeriod": "string",
  • "isLocked": true,
  • "watchingSubCard": "string",
  • "isExpenditureWatched": true,
  • "isPaletteWarehouse": true,
  • "isManufacturingWarehouse": true,
  • "identification": "string",
  • "isAccountingWarehouse": true,
  • "isBranchWarehouse": true,
  • "isPurchasePriceEditable": true,
  • "isValid": true,
  • "registrationNumber": "string",
  • "accountingDateFrom": "string",
  • "accountingDateTo": "string",
  • "isZeroPrice": true,
  • "isMinusExpenditure": true,
  • "isPlanned": true,
  • "isExternal": true,
  • "isImported": true
}

/api/eshop/v1/Warehouse/GetByWarehouseNumber

Authorizations:
Bearer
query Parameters
number
required
string
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": "string",
  • "name": "string",
  • "type": "string",
  • "mandantId": 0,
  • "organizationStructureId": 0,
  • "organizationStructureName": "string",
  • "workingTimePeriod": "string",
  • "inventoryTimePeriod": "string",
  • "isLocked": true,
  • "watchingSubCard": "string",
  • "isExpenditureWatched": true,
  • "isPaletteWarehouse": true,
  • "isManufacturingWarehouse": true,
  • "identification": "string",
  • "isAccountingWarehouse": true,
  • "isBranchWarehouse": true,
  • "isPurchasePriceEditable": true,
  • "isValid": true,
  • "registrationNumber": "string",
  • "accountingDateFrom": "string",
  • "accountingDateTo": "string",
  • "isZeroPrice": true,
  • "isMinusExpenditure": true,
  • "isPlanned": true,
  • "isExternal": true,
  • "isImported": true
}

WorkflowDocument

Workflow Document

Get documents to send

Get documents to send

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Write Sync Status

WriteSyncStatus

Authorizations:
Bearer
Request Body schema: application/json
sourceDocumentId
string or null
executionStatus
boolean

Responses

Request samples

Content type
application/json
{
  • "sourceDocumentId": "string",
  • "executionStatus": true
}

Response samples

Content type
application/json
{
  • "sourceDocumentId": "string",
  • "executionStatus": true
}

Send One Document

SendOneDocument

Authorizations:
Bearer
query Parameters
id
required
integer <int64>

Responses

Send One Document stream

SendOneDocument stream

Authorizations:
Bearer
query Parameters
id
required
integer <int64>

Responses

WorkflowEntityFlow

Workflow entity flow

Get entity flow

Get workflow tasks to send

Authorizations:
Bearer
query Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Get entity flow

Get workflow tasks to send

Authorizations:
Bearer
query Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Send One flow

Send One flow

Authorizations:
Bearer
query Parameters
id
required
integer <int64>

Responses

WorkflowTask

Workflow Task

Get tasks to send

Get workflow tasks to send

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Write Sync Status

WriteSyncStatus

Authorizations:
Bearer
Request Body schema: application/json
Array
sourceTaskId
string or null
executionStatus
boolean
executionError
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "sourceTaskId": "string",
  • "executionStatus": true,
  • "executionError": "string"
}

Write Sync Status

WriteAnswer

Authorizations:
Bearer
Request Body schema: application/json
Array
sourceTaskId
string or null
answerValue
string or null
answerText
string or null
answerTimeUtc
string or null <date-time>
Array of objects or null (WorkflowAnswerOptionalDataPutContract)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "sourceTaskId": "string",
  • "executionStatus": true,
  • "businessValidationMessage": "string",
  • "executionError": "string"
}

Send One Task

SendOneTask

Authorizations:
Bearer
query Parameters
id
required
integer <int64>

Responses

Synchronize all tasks

SyncAllTasks

Authorizations:
Bearer

Responses

SupplierOrder

A supplier order is order sent to supplier

Get supplier orders

This API method allows retrieving supplier orders with items

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

since
required
string <datetime> (Changed from)

Returns only orders changed after date

warehouseId
required
integer <int64> (Warehouse id)

Returns only orders with Warehouse id

onlyNotFulfilled
boolean <boolean> (Only not fulfilled)

Returns only orders which are not fulfilled

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "orderNumber": "string",
  • "orderStatus": "string",
  • "documentTypeId": "string",
  • "issueDate": "string",
  • "fulfillmentDate": "string",
  • "warehouseId": 0,
  • "warehouseNumber": "string",
  • "economicObject": "string",
  • "organizationStructureId": "string",
  • "organizationStructureShortcut": "string",
  • "currency": "string",
  • "priceListId": 0,
  • "supplierId": 0,
  • "mandantId": 0,
  • "note": "string",
  • "shippingCode": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "supplierName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "clerkId": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "customerVatRegNo": "string",
  • "supplierVatRegNo": "string",
  • "contractNumber": "string",
  • "supplierContactPersonId": 0,
  • "supplierContactPersonName": "string",
  • "deliveryCode": "string",
  • "priceListShortcut": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTypeShortcut": "string",
  • "destination": "string",
  • "paymentTermId": "string",
  • "paymentTermShortcut": "string",
  • "orderStatusName": "string",
  • "processingStatusCode": "string",
  • "processingStatusName": "string",
  • "orderItems": [
    ]
}

Get one supplier order

This API method allows retrieving one supplier order with items by its id

Authorizations:
Bearer
query Parameters
id
required
integer <int64> (Supplier order id)

Supplier order id

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "orderNumber": "string",
  • "orderStatus": "string",
  • "documentTypeId": "string",
  • "issueDate": "string",
  • "fulfillmentDate": "string",
  • "warehouseId": 0,
  • "warehouseNumber": "string",
  • "economicObject": "string",
  • "organizationStructureId": "string",
  • "organizationStructureShortcut": "string",
  • "currency": "string",
  • "priceListId": 0,
  • "supplierId": 0,
  • "mandantId": 0,
  • "note": "string",
  • "shippingCode": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "supplierName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "clerkId": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "customerVatRegNo": "string",
  • "supplierVatRegNo": "string",
  • "contractNumber": "string",
  • "supplierContactPersonId": 0,
  • "supplierContactPersonName": "string",
  • "deliveryCode": "string",
  • "priceListShortcut": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTypeShortcut": "string",
  • "destination": "string",
  • "paymentTermId": "string",
  • "paymentTermShortcut": "string",
  • "orderStatusName": "string",
  • "processingStatusCode": "string",
  • "processingStatusName": "string",
  • "orderItems": [
    ]
}

CustomerInvoice

A customer invoice is invoice issued to customer

Get customer invoices by date interval

This API method allows retrieving customer invoices with items by date interval

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

from
required
string <datetime> (Date from)

Returns only invoices after date

to
required
string <datetime> (Date to)

Returns only invoices before date

withOptionalData
boolean <boolean> (With Optional Data)

Return optional data for invoice and invoice items

withOptionalText
boolean <boolean> (With Optional Text)

Return optional texts for invoice and invoice items

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "sentDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "customerId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "supplierVatRegNoId": 0,
  • "customerVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "domesticCurrencyType": "string",
  • "invoiceStatus": "string",
  • "customerIco": "string",
  • "customerInternalCode": "string",
  • "customerName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "supplierVatRegNo": "string",
  • "customerVatRegNo": "string",
  • "edited": "string",
  • "organizationStructureShortcut": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "bankAccountNumber": "string",
  • "vatDocumentTypeShortcut": "string",
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Get one customer invoice

This API method allows retrieving one customer invoice with items by its id

Authorizations:
Bearer
query Parameters
id
required
integer <int64> (Customer invoice id)

Customer invoice id

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "sentDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "customerId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "supplierVatRegNoId": 0,
  • "customerVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "domesticCurrencyType": "string",
  • "invoiceStatus": "string",
  • "customerIco": "string",
  • "customerInternalCode": "string",
  • "customerName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "supplierVatRegNo": "string",
  • "customerVatRegNo": "string",
  • "edited": "string",
  • "organizationStructureShortcut": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "bankAccountNumber": "string",
  • "vatDocumentTypeShortcut": "string",
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Add new customer invoice.

This API method adds one customer order with items.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer or null <int64> (Customer invoice id)

Unique customer invoice id

mandantId
integer or null <int64> (Mandant id)

Mandant id

invoiceNumber
string or null <string> (Customer invoice number)

Customer invoice internal number

issueDate
string or null <datetime> (Issue date)

Customer invoice issue date

paymentDueDate
string or null <datetime> (Payment due date)

Customer invoice payment due date

sentDate
string or null <datetime> (Sent date)

Customer invoice sent date

variableSymbol
string or null <string> (Variable symbol)

Customer invoice variable symbol

specificSymbol
string or null <string> (Specific symbol)

Customer invoice specific symbol

constantSymbol
string or null <string> (Constant symbol)

Constant symbol, foreign key from QasidaEnum.GetConstantSymbol.code

customerId
integer or null <int64> (Customer id)

Customer id , foreign key from Customer.id

documentTypeId
string or null <string> (Customer invoice document type id)

Customer invoice document type id foreign key from QasidaEnum.GetDocumentTypeCustomerInvoice.code

paymentMethod
string or null <string> (Payment method)

Payment method code, foreign key from QasidaEnum.GetPaymentMethods.code

orderNumber
string or null <string> (Customer order number)

Internal customer order number

contractNumber
string or null <string> (Customer contract number)

Customer contract number

currency
string or null <string> (Currency)

Currency code, foreign key from QasidaEnum.GetCurrencies.code

bankAccountId
integer or null <int64> (Bank account Id)

Supplier bank account Id, foreign key from BankAccount.id

taxDutyDate
string or null <datetime> (Tax duty date)

Customer invoice tax duty date

accountingDate
string or null <datetime> (Accounting date)

Customer invoice accounting date

rabat
number or null <decimal> (Discount in %)

Discount in %

rabat2
number or null <decimal> (Discount 2 in %)

Discount 2 in %

percentageToBePaid
number or null <decimal> (Percentage to be paid)

Percentage to be paid, only for proforma invoice

interestOnDelayTypeId
string or null <string> (Interest on delay type id)

Interest on delay type id, foreign key from QasidaEnum.GetInterestOnDelayType.code

clerkId
string or null <string> (Clerk id)

Clerk id, foreign key from QasidaEnum.GetClerk.code

organizationStructureId
string or null <string> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.code

economicObject
string or null <string> (Economic object)

Economic object , multiple values from QasidaEnum.GetEconomicalObjects.shortcut separated by comma (,)

supplierVatRegNoId
integer or null <int64> (Supplier Vat Reg No Id)

Supplier Vat Reg No Id, foreign key from Supplier.icdpHs.id

customerVatRegNoId
integer or null <int64> (Customer Vat Reg No Id)

Customer Vat Reg No Id, foreign key from Customer.icdpHs.id

isoA2CountryCode
string or null <string> (Country code)

Country ISOA2 code used for delivery

vatDocumentTypeId
string or null <string> (Vat document type id)

Vat document type id, foreign key from QasidaEnum.GetVatDocumentType.code

vatDocumentTransformationTypeId
string or null <string> (Vat document transformation type id)

Vat document type id, foreign key from QasidaEnum.GetVatDocumentTransformationType.code

externalInvoiceNumber
string or null <string> (External invoice number)

External invoice number

vatDocumentCoefficient
number or null <decimal> (Vat document coefficient)

Vat document coefficient

Array of objects or null (Invoice items)

Items of invoice

Array of objects or null (Customer invoice VAT totals)

VAT totals of customer invoice

Array of objects or null (Customer invoice total sum)

Total sum of customer invoice

Array of objects or null (Customer invoice rounding difference)

Rounding difference of customer invoice

Array of objects or null (Customer invoice optional data)

Optional data of customer invoice

Array of objects or null (Customer invoice optional text)

Optional text of customer invoice

Array of objects or null (Customer invoice credited invoices)

Credited invoices of customer invoice

Array of objects or null (Customer invoice advance payments)

Advance payments of customer invoice

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "sentDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "customerId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "supplierVatRegNoId": 0,
  • "customerVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "sentDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "customerId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "supplierVatRegNoId": 0,
  • "customerVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "domesticCurrencyType": "string",
  • "invoiceStatus": "string",
  • "customerIco": "string",
  • "customerInternalCode": "string",
  • "customerName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "supplierVatRegNo": "string",
  • "customerVatRegNo": "string",
  • "edited": "string",
  • "organizationStructureShortcut": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "bankAccountNumber": "string",
  • "vatDocumentTypeShortcut": "string",
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Send customer invoice.

This API method adds one customer order with items.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

id
required
integer <int64>

Responses

Response samples

Content type
application/json
"string"

CustomerProformaInvoice

A customer proforma invoice is proforma invoice issued to customer

Get customer invoices by date interval

This API method allows retrieving customer proforma invoices with items by date interval

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

from
required
string <datetime> (Date from)

Returns only invoices after date

to
required
string <datetime> (Date to)

Returns only invoices before date

withOptionalData
boolean <boolean> (With Optional Data)

Return optional data for invoice and invoice items

withOptionalText
boolean <boolean> (With Optional Text)

Return optional texts for invoice and invoice items

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "sentDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "customerId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "supplierVatRegNoId": 0,
  • "customerVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "domesticCurrencyType": "string",
  • "invoiceStatus": "string",
  • "customerIco": "string",
  • "customerInternalCode": "string",
  • "customerName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "supplierVatRegNo": "string",
  • "customerVatRegNo": "string",
  • "edited": "string",
  • "organizationStructureShortcut": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "bankAccountNumber": "string",
  • "vatDocumentTypeShortcut": "string",
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Get one customer invoice

This API method allows retrieving one customer invoice with items by its id

Authorizations:
Bearer
query Parameters
id
required
integer <int64> (Customer proforma invoice id)

Customer proforma invoice id

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "sentDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "customerId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "supplierVatRegNoId": 0,
  • "customerVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "domesticCurrencyType": "string",
  • "invoiceStatus": "string",
  • "customerIco": "string",
  • "customerInternalCode": "string",
  • "customerName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "supplierVatRegNo": "string",
  • "customerVatRegNo": "string",
  • "edited": "string",
  • "organizationStructureShortcut": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "bankAccountNumber": "string",
  • "vatDocumentTypeShortcut": "string",
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Add new customer invoice.

This API method adds one proforma invoice with items.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer or null <int64> (Customer invoice id)

Unique customer invoice id

mandantId
integer or null <int64> (Mandant id)

Mandant id

invoiceNumber
string or null <string> (Customer invoice number)

Customer invoice internal number

issueDate
string or null <datetime> (Issue date)

Customer invoice issue date

paymentDueDate
string or null <datetime> (Payment due date)

Customer invoice payment due date

sentDate
string or null <datetime> (Sent date)

Customer invoice sent date

variableSymbol
string or null <string> (Variable symbol)

Customer invoice variable symbol

specificSymbol
string or null <string> (Specific symbol)

Customer invoice specific symbol

constantSymbol
string or null <string> (Constant symbol)

Constant symbol, foreign key from QasidaEnum.GetConstantSymbol.code

customerId
integer or null <int64> (Customer id)

Customer id , foreign key from Customer.id

documentTypeId
string or null <string> (Customer invoice document type id)

Customer invoice document type id foreign key from QasidaEnum.GetDocumentTypeCustomerInvoice.code

paymentMethod
string or null <string> (Payment method)

Payment method code, foreign key from QasidaEnum.GetPaymentMethods.code

orderNumber
string or null <string> (Customer order number)

Internal customer order number

contractNumber
string or null <string> (Customer contract number)

Customer contract number

currency
string or null <string> (Currency)

Currency code, foreign key from QasidaEnum.GetCurrencies.code

bankAccountId
integer or null <int64> (Bank account Id)

Supplier bank account Id, foreign key from BankAccount.id

taxDutyDate
string or null <datetime> (Tax duty date)

Customer invoice tax duty date

accountingDate
string or null <datetime> (Accounting date)

Customer invoice accounting date

rabat
number or null <decimal> (Discount in %)

Discount in %

rabat2
number or null <decimal> (Discount 2 in %)

Discount 2 in %

percentageToBePaid
number or null <decimal> (Percentage to be paid)

Percentage to be paid, only for proforma invoice

interestOnDelayTypeId
string or null <string> (Interest on delay type id)

Interest on delay type id, foreign key from QasidaEnum.GetInterestOnDelayType.code

clerkId
string or null <string> (Clerk id)

Clerk id, foreign key from QasidaEnum.GetClerk.code

organizationStructureId
string or null <string> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.code

economicObject
string or null <string> (Economic object)

Economic object , multiple values from QasidaEnum.GetEconomicalObjects.shortcut separated by comma (,)

supplierVatRegNoId
integer or null <int64> (Supplier Vat Reg No Id)

Supplier Vat Reg No Id, foreign key from Supplier.icdpHs.id

customerVatRegNoId
integer or null <int64> (Customer Vat Reg No Id)

Customer Vat Reg No Id, foreign key from Customer.icdpHs.id

isoA2CountryCode
string or null <string> (Country code)

Country ISOA2 code used for delivery

vatDocumentTypeId
string or null <string> (Vat document type id)

Vat document type id, foreign key from QasidaEnum.GetVatDocumentType.code

vatDocumentTransformationTypeId
string or null <string> (Vat document transformation type id)

Vat document type id, foreign key from QasidaEnum.GetVatDocumentTransformationType.code

externalInvoiceNumber
string or null <string> (External invoice number)

External invoice number

vatDocumentCoefficient
number or null <decimal> (Vat document coefficient)

Vat document coefficient

Array of objects or null (Invoice items)

Items of invoice

Array of objects or null (Customer invoice VAT totals)

VAT totals of customer invoice

Array of objects or null (Customer invoice total sum)

Total sum of customer invoice

Array of objects or null (Customer invoice rounding difference)

Rounding difference of customer invoice

Array of objects or null (Customer invoice optional data)

Optional data of customer invoice

Array of objects or null (Customer invoice optional text)

Optional text of customer invoice

Array of objects or null (Customer invoice credited invoices)

Credited invoices of customer invoice

Array of objects or null (Customer invoice advance payments)

Advance payments of customer invoice

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "sentDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "customerId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "supplierVatRegNoId": 0,
  • "customerVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "sentDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "customerId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "supplierVatRegNoId": 0,
  • "customerVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "domesticCurrencyType": "string",
  • "invoiceStatus": "string",
  • "customerIco": "string",
  • "customerInternalCode": "string",
  • "customerName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "supplierVatRegNo": "string",
  • "customerVatRegNo": "string",
  • "edited": "string",
  • "organizationStructureShortcut": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "bankAccountNumber": "string",
  • "vatDocumentTypeShortcut": "string",
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

SupplierInvoice

A supplier invoice is invoice received from supplier

Get supplier invoices by date interval

This API method allows retrieving supplier invoices with items by date interval

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

from
required
string <datetime> (Date from)

Returns only invoices after date

to
required
string <datetime> (Date to)

Returns only invoices before date

withOptionalData
boolean <boolean> (With Optional Data)

Return optional data for invoice and invoice items

withOptionalText
boolean <boolean> (With Optional Text)

Return optional texts for invoice and invoice items

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "receivedDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "supplierId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "domesticCurrencyType": "string",
  • "invoiceStatus": "string",
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "supplierName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "customerVatRegNo": "string",
  • "supplierVatRegNo": "string",
  • "edited": "string",
  • "organizationStructureShortcut": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "bankAccountNumber": "string",
  • "vatDocumentTypeShortcut": "string",
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Get one supplier invoice

This API method allows retrieving one supplier invoice with items by its id

Authorizations:
Bearer
query Parameters
id
required
integer <int64> (Supplier invoice id)

Supplier invoice id

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "receivedDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "supplierId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "domesticCurrencyType": "string",
  • "invoiceStatus": "string",
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "supplierName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "customerVatRegNo": "string",
  • "supplierVatRegNo": "string",
  • "edited": "string",
  • "organizationStructureShortcut": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "bankAccountNumber": "string",
  • "vatDocumentTypeShortcut": "string",
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Add new supplier invoice.

This API method adds one supplier invoice with items.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer or null <int64> (Supplier invoice id)

Unique supplier invoice id

mandantId
integer or null <int64> (Mandant id)

Mandant id

invoiceNumber
string or null <string> (Supplier invoice number)

Supplier invoice internal number

issueDate
string or null <datetime> (Issue date)

Supplier invoice issue date

paymentDueDate
string or null <datetime> (Payment due date)

Supplier invoice payment due date

receivedDate
string or null <datetime> (Received date)

Supplier invoice received date

variableSymbol
string or null <string> (Variable symbol)

Supplier invoice variable symbol

specificSymbol
string or null <string> (Specific symbol)

Supplier invoice specific symbol

constantSymbol
string or null <string> (Constant symbol)

Constant symbol, foreign key from QasidaEnum.GetConstantSymbol.code

supplierId
integer or null <int64> (Supplier id)

Supplier id , foreign key from Supplier.id

documentTypeId
string or null <string> (Supplier invoice document type id)

Supplier invoice document type id foreign key from QasidaEnum.GetDocumentTypeSupplierInvoice.code

paymentMethod
string or null <string> (Payment method)

Payment method code, foreign key from QasidaEnum.GetPaymentMethods.code

orderNumber
string or null <string> (Supplier order number)

Internal supplier order number

contractNumber
string or null <string> (Supplier contract number)

Supplier contract number

currency
string or null <string> (Currency)

Currency code, foreign key from QasidaEnum.GetCurrencies.code

bankAccountId
integer or null <int64> (Bank account Id)

Supplier bank account Id, foreign key from BankAccount.id

taxDutyDate
string or null <datetime> (Tax duty date)

Supplier invoice tax duty date

accountingDate
string or null <datetime> (Accounting date)

Supplier invoice accounting date

rabat
number or null <decimal> (Discount in %)

Discount in %

rabat2
number or null <decimal> (Discount 2 in %)

Discount 2 in %

percentageToBePaid
number or null <decimal> (Percentage to be paid)

Percentage to be paid, only for proforma invoice

interestOnDelayTypeId
string or null <string> (Interest on delay type id)

Interest on delay type id, foreign key from QasidaEnum.GetInterestOnDelayType.code

clerkId
string or null <string> (Clerk id)

Clerk id, foreign key from QasidaEnum.GetClerk.code

organizationStructureId
string or null <string> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.code

economicObject
string or null <string> (Economic object)

Economic object , multiple values from QasidaEnum.GetEconomicalObjects.shortcut separated by comma (,)

supplierVatRegNoId
integer or null <int64> (Supplier Vat Reg No Id)

Supplier Vat Reg No Id, foreign key from Supplier.icdpHs.id

customerVatRegNoId
integer or null <int64> (Customer Vat Reg No Id)

Customer Vat Reg No Id, foreign key from Customer.icdpHs.id

isoA2CountryCode
string or null <string> (Country code)

Country ISOA2 code used for delivery

vatDocumentTypeId
string or null <string> (Vat document type id)

Vat document type id, foreign key from QasidaEnum.GetVatDocumentType.code

vatDocumentTransformationTypeId
string or null <string> (Vat document transformation type id)

Vat document type id, foreign key from QasidaEnum.GetVatDocumentTransformationType.code

externalInvoiceNumber
string or null <string> (External invoice number)

External invoice number

vatDocumentCoefficient
number or null <decimal> (Vat document coefficient)

Vat document coefficient

Array of objects or null (Invoice items)

Items of invoice

Array of objects or null (Supplier invoice VAT totals)

VAT totals of supplier invoice

Array of objects or null (Supplier invoice total sum)

Total sum of supplier invoice

Array of objects or null (Supplier invoice rounding difference)

Rounding difference of supplier invoice

Array of objects or null (Supplier invoice optional data)

Optional data of supplier invoice

Array of objects or null (Supplier invoice optional text)

Optional text of supplier invoice

Array of objects or null (Supplier invoice credited invoices)

Credited invoices of supplier invoice

Array of objects or null (Supplier invoice advance payments)

Advance payments of supplier invoice

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "receivedDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "supplierId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "supplierVatRegNoId": 0,
  • "customerVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "receivedDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "supplierId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "domesticCurrencyType": "string",
  • "invoiceStatus": "string",
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "supplierName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "customerVatRegNo": "string",
  • "supplierVatRegNo": "string",
  • "edited": "string",
  • "organizationStructureShortcut": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "bankAccountNumber": "string",
  • "vatDocumentTypeShortcut": "string",
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Updates supplier invoice.

This API method updates one supplier invoice

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <int64> (Supplier invoice id)

Unique supplier invoice id

issueDate
string or null <datetime> (Issue date)

Supplier invoice issue date

paymentDueDate
string or null <datetime> (Payment due date)

Supplier invoice payment due date

receivedDate
string or null <datetime> (Received date)

Supplier invoice received date

variableSymbol
string or null <string> (Variable symbol)

Supplier invoice variable symbol

specificSymbol
string or null <string> (Specific symbol)

Supplier invoice specific symbol

constantSymbol
string or null <string> (Constant symbol)

Constant symbol, foreign key from QasidaEnum.GetConstantSymbol.code

supplierId
integer or null <int64> (Supplier id)

Supplier id , foreign key from Supplier.id

documentTypeId
string or null <string> (Supplier invoice document type id)

Supplier invoice document type id foreign key from QasidaEnum.GetDocumentTypeSupplierInvoice.code

paymentMethod
string or null <string> (Payment method)

Payment method code, foreign key from QasidaEnum.GetPaymentMethods.code

orderNumber
string or null <string> (Supplier order number)

Internal supplier order number

contractNumber
string or null <string> (Supplier contract number)

Supplier contract number

currency
string or null <string> (Currency)

Currency code, foreign key from QasidaEnum.GetCurrencies.code

bankAccountId
integer or null <int64> (Bank account Id)

Supplier bank account Id, foreign key from BankAccount.id

taxDutyDate
string or null <datetime> (Tax duty date)

Supplier invoice tax duty date

accountingDate
string or null <datetime> (Accounting date)

Supplier invoice accounting date

percentageToBePaid
number or null <decimal> (Percentage to be paid)

Percentage to be paid, only for proforma invoice

interestOnDelayTypeId
string or null <string> (Interest on delay type id)

Interest on delay type id, foreign key from QasidaEnum.GetInterestOnDelayType.code

clerkId
string or null <string> (Clerk id)

Clerk id, foreign key from QasidaEnum.GetClerk.code

organizationStructureId
string or null <string> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.code

economicObject
string or null <string> (Economic object)

Economic object , multiple values from QasidaEnum.GetEconomicalObjects.shortcut separated by comma (,)

supplierVatRegNoId
integer or null <int64> (Supplier Vat Reg No Id)

Supplier Vat Reg No Id, foreign key from Supplier.icdpHs.id

customerVatRegNoId
integer or null <int64> (Customer Vat Reg No Id)

Customer Vat Reg No Id, foreign key from Customer.icdpHs.id

isoA2CountryCode
string or null <string> (Country code)

Country ISOA2 code used for delivery

vatDocumentTypeId
string or null <string> (Vat document type id)

Vat document type id, foreign key from QasidaEnum.GetVatDocumentType.code

vatDocumentTransformationTypeId
string or null <string> (Vat document transformation type id)

Vat document type id, foreign key from QasidaEnum.GetVatDocumentTransformationType.code

externalInvoiceNumber
string or null <string> (External invoice number)

External invoice number

vatDocumentCoefficient
number or null <decimal> (Vat document coefficient)

Vat document coefficient

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "receivedDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "supplierId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "supplierVatRegNoId": 0,
  • "customerVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "receivedDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "supplierId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "domesticCurrencyType": "string",
  • "invoiceStatus": "string",
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "supplierName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "customerVatRegNo": "string",
  • "supplierVatRegNo": "string",
  • "edited": "string",
  • "organizationStructureShortcut": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "bankAccountNumber": "string",
  • "vatDocumentTypeShortcut": "string",
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

SupplierProformaInvoice

A supplier proforma invoice is proforma invoice received from supplier

Get supplier proforma invoices by date interval

This API method allows retrieving supplier proforma invoices with items by date interval

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

from
required
string <datetime> (Date from)

Returns only invoices after date

to
required
string <datetime> (Date to)

Returns only invoices before date

withOptionalData
boolean <boolean> (With Optional Data)

Return optional data for invoice and invoice items

withOptionalText
boolean <boolean> (With Optional Text)

Return optional texts for invoice and invoice items

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "receivedDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "supplierId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "domesticCurrencyType": "string",
  • "invoiceStatus": "string",
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "supplierName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "customerVatRegNo": "string",
  • "supplierVatRegNo": "string",
  • "edited": "string",
  • "organizationStructureShortcut": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "bankAccountNumber": "string",
  • "vatDocumentTypeShortcut": "string",
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Get one supplier proforma invoice

This API method allows retrieving one supplier proforma invoice with items by its id

Authorizations:
Bearer
query Parameters
id
required
integer <int64> (Supplier proforma invoice id)

Supplier proforma invoice id

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "receivedDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "supplierId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "domesticCurrencyType": "string",
  • "invoiceStatus": "string",
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "supplierName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "customerVatRegNo": "string",
  • "supplierVatRegNo": "string",
  • "edited": "string",
  • "organizationStructureShortcut": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "bankAccountNumber": "string",
  • "vatDocumentTypeShortcut": "string",
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Add new supplier proforma invoice.

This API method adds one supplier invoice with items.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer or null <int64> (Supplier invoice id)

Unique supplier invoice id

mandantId
integer or null <int64> (Mandant id)

Mandant id

invoiceNumber
string or null <string> (Supplier invoice number)

Supplier invoice internal number

issueDate
string or null <datetime> (Issue date)

Supplier invoice issue date

paymentDueDate
string or null <datetime> (Payment due date)

Supplier invoice payment due date

receivedDate
string or null <datetime> (Received date)

Supplier invoice received date

variableSymbol
string or null <string> (Variable symbol)

Supplier invoice variable symbol

specificSymbol
string or null <string> (Specific symbol)

Supplier invoice specific symbol

constantSymbol
string or null <string> (Constant symbol)

Constant symbol, foreign key from QasidaEnum.GetConstantSymbol.code

supplierId
integer or null <int64> (Supplier id)

Supplier id , foreign key from Supplier.id

documentTypeId
string or null <string> (Supplier invoice document type id)

Supplier invoice document type id foreign key from QasidaEnum.GetDocumentTypeSupplierInvoice.code

paymentMethod
string or null <string> (Payment method)

Payment method code, foreign key from QasidaEnum.GetPaymentMethods.code

orderNumber
string or null <string> (Supplier order number)

Internal supplier order number

contractNumber
string or null <string> (Supplier contract number)

Supplier contract number

currency
string or null <string> (Currency)

Currency code, foreign key from QasidaEnum.GetCurrencies.code

bankAccountId
integer or null <int64> (Bank account Id)

Supplier bank account Id, foreign key from BankAccount.id

taxDutyDate
string or null <datetime> (Tax duty date)

Supplier invoice tax duty date

accountingDate
string or null <datetime> (Accounting date)

Supplier invoice accounting date

rabat
number or null <decimal> (Discount in %)

Discount in %

rabat2
number or null <decimal> (Discount 2 in %)

Discount 2 in %

percentageToBePaid
number or null <decimal> (Percentage to be paid)

Percentage to be paid, only for proforma invoice

interestOnDelayTypeId
string or null <string> (Interest on delay type id)

Interest on delay type id, foreign key from QasidaEnum.GetInterestOnDelayType.code

clerkId
string or null <string> (Clerk id)

Clerk id, foreign key from QasidaEnum.GetClerk.code

organizationStructureId
string or null <string> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.code

economicObject
string or null <string> (Economic object)

Economic object , multiple values from QasidaEnum.GetEconomicalObjects.shortcut separated by comma (,)

supplierVatRegNoId
integer or null <int64> (Supplier Vat Reg No Id)

Supplier Vat Reg No Id, foreign key from Supplier.icdpHs.id

customerVatRegNoId
integer or null <int64> (Customer Vat Reg No Id)

Customer Vat Reg No Id, foreign key from Customer.icdpHs.id

isoA2CountryCode
string or null <string> (Country code)

Country ISOA2 code used for delivery

vatDocumentTypeId
string or null <string> (Vat document type id)

Vat document type id, foreign key from QasidaEnum.GetVatDocumentType.code

vatDocumentTransformationTypeId
string or null <string> (Vat document transformation type id)

Vat document type id, foreign key from QasidaEnum.GetVatDocumentTransformationType.code

externalInvoiceNumber
string or null <string> (External invoice number)

External invoice number

vatDocumentCoefficient
number or null <decimal> (Vat document coefficient)

Vat document coefficient

Array of objects or null (Invoice items)

Items of invoice

Array of objects or null (Supplier invoice VAT totals)

VAT totals of supplier invoice

Array of objects or null (Supplier invoice total sum)

Total sum of supplier invoice

Array of objects or null (Supplier invoice rounding difference)

Rounding difference of supplier invoice

Array of objects or null (Supplier invoice optional data)

Optional data of supplier invoice

Array of objects or null (Supplier invoice optional text)

Optional text of supplier invoice

Array of objects or null (Supplier invoice credited invoices)

Credited invoices of supplier invoice

Array of objects or null (Supplier invoice advance payments)

Advance payments of supplier invoice

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "receivedDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "supplierId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "supplierVatRegNoId": 0,
  • "customerVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "receivedDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "supplierId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "domesticCurrencyType": "string",
  • "invoiceStatus": "string",
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "supplierName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "customerVatRegNo": "string",
  • "supplierVatRegNo": "string",
  • "edited": "string",
  • "organizationStructureShortcut": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "bankAccountNumber": "string",
  • "vatDocumentTypeShortcut": "string",
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

Updates supplier proforma invoice.

This API method updates one supplier proforma invoice

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer <int64> (Supplier invoice id)

Unique supplier invoice id

issueDate
string or null <datetime> (Issue date)

Supplier invoice issue date

paymentDueDate
string or null <datetime> (Payment due date)

Supplier invoice payment due date

receivedDate
string or null <datetime> (Received date)

Supplier invoice received date

variableSymbol
string or null <string> (Variable symbol)

Supplier invoice variable symbol

specificSymbol
string or null <string> (Specific symbol)

Supplier invoice specific symbol

constantSymbol
string or null <string> (Constant symbol)

Constant symbol, foreign key from QasidaEnum.GetConstantSymbol.code

supplierId
integer or null <int64> (Supplier id)

Supplier id , foreign key from Supplier.id

documentTypeId
string or null <string> (Supplier invoice document type id)

Supplier invoice document type id foreign key from QasidaEnum.GetDocumentTypeSupplierInvoice.code

paymentMethod
string or null <string> (Payment method)

Payment method code, foreign key from QasidaEnum.GetPaymentMethods.code

orderNumber
string or null <string> (Supplier order number)

Internal supplier order number

contractNumber
string or null <string> (Supplier contract number)

Supplier contract number

currency
string or null <string> (Currency)

Currency code, foreign key from QasidaEnum.GetCurrencies.code

bankAccountId
integer or null <int64> (Bank account Id)

Supplier bank account Id, foreign key from BankAccount.id

taxDutyDate
string or null <datetime> (Tax duty date)

Supplier invoice tax duty date

accountingDate
string or null <datetime> (Accounting date)

Supplier invoice accounting date

percentageToBePaid
number or null <decimal> (Percentage to be paid)

Percentage to be paid, only for proforma invoice

interestOnDelayTypeId
string or null <string> (Interest on delay type id)

Interest on delay type id, foreign key from QasidaEnum.GetInterestOnDelayType.code

clerkId
string or null <string> (Clerk id)

Clerk id, foreign key from QasidaEnum.GetClerk.code

organizationStructureId
string or null <string> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.code

economicObject
string or null <string> (Economic object)

Economic object , multiple values from QasidaEnum.GetEconomicalObjects.shortcut separated by comma (,)

supplierVatRegNoId
integer or null <int64> (Supplier Vat Reg No Id)

Supplier Vat Reg No Id, foreign key from Supplier.icdpHs.id

customerVatRegNoId
integer or null <int64> (Customer Vat Reg No Id)

Customer Vat Reg No Id, foreign key from Customer.icdpHs.id

isoA2CountryCode
string or null <string> (Country code)

Country ISOA2 code used for delivery

vatDocumentTypeId
string or null <string> (Vat document type id)

Vat document type id, foreign key from QasidaEnum.GetVatDocumentType.code

vatDocumentTransformationTypeId
string or null <string> (Vat document transformation type id)

Vat document type id, foreign key from QasidaEnum.GetVatDocumentTransformationType.code

externalInvoiceNumber
string or null <string> (External invoice number)

External invoice number

vatDocumentCoefficient
number or null <decimal> (Vat document coefficient)

Vat document coefficient

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "receivedDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "supplierId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "supplierVatRegNoId": 0,
  • "customerVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "mandantId": 0,
  • "invoiceNumber": "string",
  • "issueDate": "string",
  • "paymentDueDate": "string",
  • "receivedDate": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "supplierId": 0,
  • "documentTypeId": "string",
  • "paymentMethod": "string",
  • "orderNumber": "string",
  • "contractNumber": "string",
  • "currency": "string",
  • "bankAccountId": 0,
  • "taxDutyDate": "string",
  • "accountingDate": "string",
  • "rabat": 0,
  • "rabat2": 0,
  • "percentageToBePaid": 0,
  • "interestOnDelayTypeId": "string",
  • "clerkId": "string",
  • "organizationStructureId": "string",
  • "economicObject": "string",
  • "customerVatRegNoId": 0,
  • "supplierVatRegNoId": 0,
  • "isoA2CountryCode": "string",
  • "vatDocumentTypeId": "string",
  • "vatDocumentTransformationTypeId": "string",
  • "externalInvoiceNumber": "string",
  • "vatDocumentCoefficient": 0,
  • "domesticCurrencyType": "string",
  • "invoiceStatus": "string",
  • "supplierIco": "string",
  • "supplierInternalCode": "string",
  • "supplierName": "string",
  • "documentTypeShortcut": "string",
  • "documentTypeName": "string",
  • "customerVatRegNo": "string",
  • "supplierVatRegNo": "string",
  • "edited": "string",
  • "organizationStructureShortcut": "string",
  • "clerkShortcut": "string",
  • "clerkName": "string",
  • "bankAccountNumber": "string",
  • "vatDocumentTypeShortcut": "string",
  • "invoiceItems": [
    ],
  • "vatTotalItems": [
    ],
  • "totalSumItems": [
    ],
  • "roundingDifference": [
    ],
  • "optionalData": [
    ],
  • "optionalText": [
    ],
  • "creditedInvoices": [
    ],
  • "advancePayments": [
    ]
}

BankPaymentNotice

A bank payment notice is a document with notifications of bank payments

Get bank payment notices

This API method allows retrieving bank payment notices

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

ownBankAccountId
integer <int64> (Own bank account id)

Own bank account id

noticeDate
string <DateTime> (Bank payment notice date)

Bank payment notice date

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Get one bank payment notice

This API method allows retrieving one bank payment notice with items by its id

Authorizations:
Bearer
query Parameters
id
required
integer <int64> (Bank payment notice id)

Bank payment notice id

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "noticeNumber": "string",
  • "noticeDate": "string",
  • "ownBankAccountId": "string",
  • "ownBankAccountNumber": "string",
  • "mandantId": 0,
  • "bankPaymentNoticeItems": [
    ]
}

Add new bank payment notice

This API method adds one bank payment notice with items.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
noticeNumber
string or null <string> (Bank payment notice number)

Bank payment notice number

noticeDate
string or null <datetime> (Bank payment notice date)

Bank payment notice date

ownBankAccountId
string or null <string> (Own bank account id)

Own bank account id , foreign key from QasidaEnum.GetOwnBankAccount.Code

Array of objects or null (Bank payment notice items)

Bank payment notice items

Responses

Request samples

Content type
application/json
{
  • "noticeNumber": "string",
  • "noticeDate": "string",
  • "ownBankAccountId": "string",
  • "bankPaymentNoticeItems": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "noticeNumber": "string",
  • "noticeDate": "string",
  • "ownBankAccountId": "string",
  • "ownBankAccountNumber": "string",
  • "mandantId": 0,
  • "bankPaymentNoticeItems": [
    ]
}

BankPaymentNoticeItem

A bank payment notice item is a notification of bank payment

Add new bank payment notice items

This API method adds bank payment notice items.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
Array
bankPaymentNoticeId
integer <int64> (Bank payment notice id)

Bank payment notice id

paymentType
string or null <string> (Payment type)

Payment type , foreign key from GetBankPaymentType.Code

itemDate
string or null <datetime> (Item Date)

Item Date

bankAccountId
integer or null <int64> (Partner bank account id)

Partner bank account id

amount
number or null <decimal> (Amount)

Payment notice item amount

note
string or null <string> (Item note)

Item note

variableSymbol
string or null <string> (Variable symbol)

Variable symbol

specificSymbol
string or null <string> (Specific symbol)

Specific symbol

constantSymbol
string or null <string> (Constant symbol)

Constant symbol, foreign key from QasidaEnum.GetConstantSymbol.code

currency
string or null <string> (Currency)

Currency code, foreign key from QasidaEnum.GetCurrencies.code

accountId
integer or null <int64> (Account id)

Account id , foreign key from Account.Id

bankAccountNumber
string or null <string> (Bank account number)

Partner bank account number from BankAccount.BankAccountNumber

economicObject
string or null <string> (Economic object)

Economic object , multiple values from QasidaEnum.GetEconomicalObjects.shortcut separated by comma (,)

organizationStructureId
string or null <string> (Organization structure id)

Organization structure id, foreign key from QasidaEnum.OrganizationStructures.id

balanceItemCode
string or null <string> (Balance item code)

Balance item code

balanceItemId
integer or null <int64> (Balance item id)

Balance item , foreign key from Invoice.Id

bankCode
string or null <string> (Bank code)

Partner bank account bank code

amountInForeignCurrency
number or null <decimal> (Amount in foreign currency)

Amount in foreign currency

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "id": 0,
  • "bankPaymentNoticeId": 0,
  • "paymentType": "string",
  • "itemDate": "string",
  • "bankAccountId": 0,
  • "amount": 0,
  • "note": "string",
  • "variableSymbol": "string",
  • "specificSymbol": "string",
  • "constantSymbol": "string",
  • "currency": "string",
  • "accountId": 0,
  • "bankAccountNumber": "string",
  • "accountNumber": "string",
  • "economicObject": "string",
  • "organizationStructureId": "string",
  • "organizationStructureShortcut": "string",
  • "balanceItemCode": "string",
  • "balanceItemId": 0,
  • "bankCode": "string",
  • "amountInForeignCurrency": 0
}

BankStatement

A bank statement is a financial document with transactions provided by a bank to an account holder

Get one bank statement

This API method allows retrieving one bank statement with items by its id

Authorizations:
Bearer
query Parameters
id
required
integer <int64> (Bank statement id)

Bank statement id

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "statementNumber": "string",
  • "statementDate": "string",
  • "ownBankAccountId": "string",
  • "balance": 0,
  • "ownBankAccountNumber": "string",
  • "mandantId": 0,
  • "bankStatementItems": [
    ]
}

Add new bank statement

This API method adds one bank statement with items.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
statementNumber
string or null <string> (Bank statement number)

Bank statement number

statementDate
string or null <datetime> (Bank statement date)

Bank statement date

ownBankAccountId
string or null <string> (Own bank account id)

Own bank account id , foreign key from QasidaEnum.GetOwnBankAccount.Code

balance
number or null <decimal> (Balance)

Balance amount

Array of objects or null (Bank statement items)

Bank statement items

Responses

Request samples

Content type
application/json
{
  • "statementNumber": "string",
  • "statementDate": "string",
  • "ownBankAccountId": "string",
  • "balance": 0,
  • "bankStatementItems": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "statementNumber": "string",
  • "statementDate": "string",
  • "ownBankAccountId": "string",
  • "balance": 0,
  • "ownBankAccountNumber": "string",
  • "mandantId": 0,
  • "bankStatementItems": [
    ]
}

Account

An account is the basic unit for recording financial transactions within an accounting entity, such as a business, organization, or other entity. Accounts are used to systematically track and categorize income, expenses, assets, liabilities, capital, and other financial events.

/api/accounting/v1/Account/GetAll

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

/api/accounting/v1/Account/GetById

Authorizations:
Bearer
query Parameters
id
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "accountNumber": "string",
  • "accountName": "string",
  • "accountShortcut": "string",
  • "accountType": "string",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "isForeignCurrency": true,
  • "isOrganizationStructure": true,
  • "isEconomicalObject": true,
  • "mandantId": 0,
  • "balanceName": "string",
  • "balanceId": 0,
  • "accountNameLanguage1": "string",
  • "accountNameLanguage2": "string",
  • "accountNameLanguage3": "string"
}

/api/accounting/v1/Account/GetByAccountNumber

Authorizations:
Bearer
query Parameters
PageNumber
integer <int> (Page number)

The number of the page to return. If not specified, the first page is returned.

PageSize
integer <int> (Page size)

The number of items to return per page. If not specified, the default page size is returned.

MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

accountNumber
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

AccountingDocument

Accounting document is a written or electronic record that provides evidence of a financial transaction within an accounting system.It typically contains details such as the date of the transaction, a description of the transaction, the amount involved, and the accounts affected.

/api/accounting/v1/AccountingDocument/GetById

Authorizations:
Bearer
query Parameters
id
required
integer <int64>
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "documentNumber": "string",
  • "documentTypeId": "string",
  • "documentDate": "2019-08-24T14:15:22Z",
  • "documentText": "string",
  • "documentCreated": "2019-08-24T14:15:22Z",
  • "mandantId": 0,
  • "accountingDocumentItems": [
    ]
}

/api/accounting/v1/AccountingDocument/InsertAccountingDocument

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
integer or null <int64>
documentNumber
string or null
documentTypeId
string or null
documentDate
string or null <date-time>
documentText
string or null
documentCreated
string or null <date-time>
mandantId
integer or null <int64>
Array of objects or null (AccountingDocumentItemPostContract)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "documentNumber": "string",
  • "documentTypeId": "string",
  • "documentDate": "2019-08-24T14:15:22Z",
  • "documentText": "string",
  • "documentCreated": "2019-08-24T14:15:22Z",
  • "mandantId": 0,
  • "accountingDocumentItems": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "documentNumber": "string",
  • "documentTypeId": "string",
  • "documentDate": "2019-08-24T14:15:22Z",
  • "documentText": "string",
  • "documentCreated": "2019-08-24T14:15:22Z",
  • "mandantId": 0,
  • "accountingDocumentItems": [
    ]
}

/api/accounting/v1/AccountingDocument/DeleteAccountingDocument

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

id
required
integer <int64>

Responses

AbsenceClose

Absence

Get absence closes

Get absence closes

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Synchronize all closes

SyncAbsenceCloses

Authorizations:
Bearer

Responses

Absence

Absence

Synchronize all absences, employments and employment balances

SyncAll

Authorizations:
Bearer

Responses

Synchronize all absence types

SyncAbsenceTypes

Authorizations:
Bearer

Responses

Synchronize all employment absences

SyncEmploymentAbsences

Authorizations:
Bearer

Responses

Synchronize all employment absence balances

SyncEmploymentAbsenceBalances

Authorizations:
Bearer

Responses

Synchronize all employments

SyncEmployments

Authorizations:
Bearer

Responses

Get absence types to send

Get absence types to send

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Get employments to send

Get employments to send

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Get employment absences to send

Get employment absences to send

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

Add employment absence

Add a new employment absence

Authorizations:
Bearer
Request Body schema: application/json
sourceEmploymentId
string or null
durationType
string or null
sourceAbsenceTypeId
string or null
absenceFromUtc
string <date-time>
absenceToUtc
string <date-time>
absenceStateColor
string or null
requestedTimeUtc
string <date-time>
lastChangeStateTimeUtc
string <date-time>
absenceComment
string or null
allowAttachments
boolean
absenceAdditionalTripInfoDestination
string or null
absenceAdditionalTripInfoPurpose
string or null
absenceAdditionalTripInfoStart
string or null
absenceAdditionalTripInfoEnd
string or null

Responses

Request samples

Content type
application/json
{
  • "sourceEmploymentId": "string",
  • "durationType": "string",
  • "sourceAbsenceTypeId": "string",
  • "absenceFromUtc": "2019-08-24T14:15:22Z",
  • "absenceToUtc": "2019-08-24T14:15:22Z",
  • "absenceStateColor": "string",
  • "requestedTimeUtc": "2019-08-24T14:15:22Z",
  • "lastChangeStateTimeUtc": "2019-08-24T14:15:22Z",
  • "absenceComment": "string",
  • "allowAttachments": true,
  • "absenceAdditionalTripInfoDestination": "string",
  • "absenceAdditionalTripInfoPurpose": "string",
  • "absenceAdditionalTripInfoStart": "string",
  • "absenceAdditionalTripInfoEnd": "string"
}

Response samples

Content type
application/json
{
  • "sourceEmploymentAbsenceId": "string",
  • "executionStatus": true,
  • "businessValidationMessage": "string",
  • "executionError": "string"
}

Update employment absence

Update an existing employment absence, if attribute is NULL, then it is not updated. Fill only those attributes, that need to be updated.

Authorizations:
Bearer
Request Body schema: application/json
sourceEmploymentAbsenceId
string or null
sourceEmploymentId
string or null
durationType
string or null
sourceAbsenceTypeId
string or null
absenceFromUtc
string <date-time>
absenceToUtc
string <date-time>
absenceState
string or null
absenceStateColor
string or null
requestedTimeUtc
string or null <date-time>
lastChangeStateTimeUtc
string or null <date-time>
absenceComment
string or null
allowAttachments
boolean or null
absenceAdditionalTripInfoDestination
string or null
absenceAdditionalTripInfoPurpose
string or null
absenceAdditionalTripInfoStart
string or null
absenceAdditionalTripInfoEnd
string or null

Responses

Request samples

Content type
application/json
{
  • "sourceEmploymentAbsenceId": "string",
  • "sourceEmploymentId": "string",
  • "durationType": "string",
  • "sourceAbsenceTypeId": "string",
  • "absenceFromUtc": "2019-08-24T14:15:22Z",
  • "absenceToUtc": "2019-08-24T14:15:22Z",
  • "absenceState": "string",
  • "absenceStateColor": "string",
  • "requestedTimeUtc": "2019-08-24T14:15:22Z",
  • "lastChangeStateTimeUtc": "2019-08-24T14:15:22Z",
  • "absenceComment": "string",
  • "allowAttachments": true,
  • "absenceAdditionalTripInfoDestination": "string",
  • "absenceAdditionalTripInfoPurpose": "string",
  • "absenceAdditionalTripInfoStart": "string",
  • "absenceAdditionalTripInfoEnd": "string"
}

Response samples

Content type
application/json
{
  • "sourceEmploymentAbsenceId": "string",
  • "executionStatus": true,
  • "businessValidationMessage": "string",
  • "executionError": "string"
}

Delete employment absence

Delete an employment absence by EmploymentId from external system.

Authorizations:
Bearer
query Parameters
SourceEmploymentAbsenceId
string
SourceEmploymentId
string

Responses

Response samples

Content type
application/json
{
  • "sourceEmploymentAbsenceId": "string",
  • "executionStatus": true,
  • "businessValidationMessage": "string",
  • "executionError": "string"
}

Upload EmploymentAbsence Document Data - by chunks

Upload a data document related to an absence. It can be split to chunks.

Authorizations:
Bearer
query Parameters
SourceEmploymentAbsenceId
string
SourceDocumentId
string
QmDocumentId
string
Name
string
DocumentType
string
ChunkNumber
integer <int32>
TotalChunks
integer <int32>
Content
string <byte>
ContentSize
integer <int32>
ContentLoadStatus
string

Responses

Response samples

Content type
application/json
{
  • "sourceDocumentId": "string",
  • "executionStatus": true,
  • "businessValidationMessage": "string",
  • "executionError": "string"
}

Delete employment absence document

Delete an employment absence document by EmploymentId from external system.

Authorizations:
Bearer
query Parameters
SourceDocumentId
string
SourceEmploymentAbsenceId
string

Responses

Response samples

Content type
application/json
{
  • "sourceDocumentId": "string",
  • "executionStatus": true,
  • "businessValidationMessage": "string",
  • "executionError": "string"
}

Get employment absence balances to send

Get employment absence balances to send

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}

AbsenceType

Absence

EmploymentAbsenceBalance

Absence

EmploymentAbsence

Absence

Employment

Absence

Employee

Spin MZD Employee related methods

InsertSpinMzdEmployee

Insert or update Employee

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
mandantId
required
integer <int64> (Mandant id)

Id of Mandant

period
required
string <datetime> (Period)

Relevant Period - Month

iud
required
string <string> (IU) non-empty

Insert or update record : Insert - I or Update - U

personalNumber
integer or null <int> (PersonalNumber)

Company issued personal number of employee

surname
string or null <string> (Surname)

Employee Surname

name
string or null <string> (Name)

Employee Name

identificationNumber
string or null <string> (Identification Number)

Employee's state issued Identification number, do not input in case of foreigner

gender
string or null <string> (Gender)

Employee gender : male - 1, female - 2

dateOfBirth
string or null <datetime> (Date of Birth)

Employee date of birth

healthInsuranceProvider
string or null <string> (Health Insurance Provider)

Health insurance company code - codelist value

typeOfEmployoment
string or null <string> (Type of Employoment)

Employment type - codelist value. Value is ignored if IUD value == U(Update) called, need to crete new Employment

employmentStartDate
string or null <datetime> (Employment Start Date)

Employment Start Date

employmentEndDate
string or null <datetime> (Employment End Date)

Employment End Date

typeOfCompensation
string or null <string> (Type of Compensation)

Type of compensation - if not provided, default value MesPlat - monthly wage will be used

basicSalary
number or null <decimal> (Basic Salary)

Basic salary - basic salary value entering into calculations

placeOfBirth
string or null <string> (Place of Birth)

Place of Birth

street
string or null <string> (Street)

Address street

houseNumber
string or null <string> (HouseNumber)

Address House reference/Orientation number

city
string or null <string> (City)

Address City

zipCode
string or null <string> (ZipCode)

Address ZipCode

state
string or null <string> (State)

Address State

bban
string or null <string> (BBAN)

Bank account in BBAN format

bank
string or null <string> (Bank)

Bank - codelist value

iban
string or null <string> (IBAN)

Bank account in IBAN format

weeklyWorkHours
number or null <decimal> (Weekly Work Hours)

Work hours per week - if not provided, default value of 40 hours per week used

taxDeductible
string or null <string> (Tax Deductible)

Tax Deductible used - A/N representing Yes/No

fixedTermContractExpirationDate
string or null <datetime> (Fixed Term Contract Expiration Date)

Fixed Term Contract Expiration Date

oS_Abbr
string or null <string> (OS Abbr)

OS abbr - organisational department abbreviation

eO_Abbr
string or null <string> (EO Abbr)

EO abbr - additional (i.e. specific project) abbreviation

title
string or null <string> (Title)

Title

degree
string or null <string> (Degree)

Degree

birthName
string or null <string> (BirthName)

BirthName

street_TR
string or null <string> (Street Temporary Residence)

Address Street Temporary Residence

houseNumber_TR
string or null <string> (HouseNumber Temporary Residence)

Address HouseNumber Temporary Residence. House reference/Orientation number

city_TR
string or null <string> (City Temporary Residence)

Address City Temporary Residence

zipCode_TR
string or null <string> (ZipCode Temporary Residence)

Address ZipCode Temporary Residence

state_TR
string or null <string> (State Temporary Residence)

Address State Temporary Residence

educationLevel
string or null <string> (Education Level)

Education Level

maritalStatus
string or null <string> (Marital Status)

Marital Status

typeOfSchool
string or null <string> (Type of School)

Type of School

identificationCardNumber
string or null <string> (Identification Card Number)

Identification Card Number

stayUntil
string or null <datetime> (Stay Until)

Stay Until

workPermit
string or null <datetime> (Work Permit)

Work Permit

dateOfTrialPeriod
string or null <datetime> (Date of Trial Period)

Date of Trial Period

changedWorkingConditions
string or null <string> (Changed Working Conditions)

Changed Working Conditions

jobDescription
string or null <string> (Job Description)

Job Description

egId
string or null <string> (Eg Id)

Eg Id

Responses

Request samples

Content type
application/json
{
  • "mandantId": 0,
  • "period": "string",
  • "iud": "string",
  • "personalNumber": 0,
  • "surname": "string",
  • "name": "string",
  • "identificationNumber": "string",
  • "gender": "string",
  • "dateOfBirth": "string",
  • "healthInsuranceProvider": "string",
  • "typeOfEmployoment": "string",
  • "employmentStartDate": "string",
  • "employmentEndDate": "string",
  • "typeOfCompensation": "string",
  • "basicSalary": 0,
  • "placeOfBirth": "string",
  • "street": "string",
  • "houseNumber": "string",
  • "city": "string",
  • "zipCode": "string",
  • "state": "string",
  • "bban": "string",
  • "bank": "string",
  • "iban": "string",
  • "weeklyWorkHours": 0,
  • "taxDeductible": "string",
  • "fixedTermContractExpirationDate": "string",
  • "oS_Abbr": "string",
  • "eO_Abbr": "string",
  • "title": "string",
  • "degree": "string",
  • "birthName": "string",
  • "street_TR": "string",
  • "houseNumber_TR": "string",
  • "city_TR": "string",
  • "zipCode_TR": "string",
  • "state_TR": "string",
  • "educationLevel": "string",
  • "maritalStatus": "string",
  • "typeOfSchool": "string",
  • "identificationCardNumber": "string",
  • "stayUntil": "string",
  • "workPermit": "string",
  • "dateOfTrialPeriod": "string",
  • "changedWorkingConditions": "string",
  • "jobDescription": "string",
  • "egId": "string"
}

Response samples

Content type
application/json
{
  • "mandantId": 0,
  • "period": "string",
  • "iud": "string",
  • "personalNumber": 0,
  • "surname": "string",
  • "name": "string",
  • "identificationNumber": "string",
  • "gender": "string",
  • "dateOfBirth": "string",
  • "healthInsuranceProvider": "string",
  • "typeOfEmployoment": "string",
  • "employmentStartDate": "string",
  • "employmentEndDate": "string",
  • "typeOfCompensation": "string",
  • "basicSalary": 0,
  • "placeOfBirth": "string",
  • "street": "string",
  • "houseNumber": "string",
  • "city": "string",
  • "zipCode": "string",
  • "state": "string",
  • "bban": "string",
  • "bank": "string",
  • "iban": "string",
  • "weeklyWorkHours": 0,
  • "taxDeductible": "string",
  • "fixedTermContractExpirationDate": "string",
  • "oS_Abbr": "string",
  • "eO_Abbr": "string",
  • "title": "string",
  • "degree": "string",
  • "birthName": "string",
  • "street_TR": "string",
  • "houseNumber_TR": "string",
  • "city_TR": "string",
  • "zipCode_TR": "string",
  • "state_TR": "string",
  • "educationLevel": "string",
  • "maritalStatus": "string",
  • "typeOfSchool": "string",
  • "identificationCardNumber": "string",
  • "stayUntil": "string",
  • "workPermit": "string",
  • "dateOfTrialPeriod": "string",
  • "changedWorkingConditions": "string",
  • "jobDescription": "string",
  • "egId": "string"
}

EmploymentPayroll

Spin MZD Employment related methods

InsertEmployment

Insert Employment

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
required
integer <int64> (PP ID)

Identifier of the employment record

employeeId
required
integer <int64> (Employee Id)

Identifier of the EmployeeId

typeOfEmployment
required
string (Type of Employment) non-empty

Specifies the type of employment (e.g. full-time, contract)

period
required
string <date-time>
employmentStartDate
required
string <date-time> (Employment Start Date)

Date when the employment begins

employmentEndDate
string or null <date-time> (Employment End Date)

Date when the employment ends

dateOfTrialPeriod
string or null <date-time> (Date of Trial Period)

End date of the trial period

fixedTermContractExpirationDate
string or null <date-time> (Fixed-Term Contract Expiration Date)

End date of the fixed-term contract

calendarCode
required
string (Calendar Code) non-empty

Code of the work calendar

changedWorkingConditions
number or null <decimal> (Changed Working Conditions)

Percentage representing the changes in working conditions

typeOfCompensation
required
string (Type of Compensation) non-empty

Specifies the compensation model (e.g. fixed, hourly)

jobDescription
string or null (Job Description)

Text description of the employee's job duties

isco
string or null (Isco)

Isco

icpv
string or null (Icpv)

Icpv

category
string or null (Category)

Category

profession
string or null (Profession)

Profession

minimumWageLevel
number or null <double> (MinimumWageLevel)

MinimumWageLevel

irregularIncome
string or null (IrregularIncome)

IrregularIncome

osAbbr
string or null (OsAbbr)

OsAbbr

eoAbbr
string or null (EoAbbr)

EoAbbr

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "employeeId": 0,
  • "typeOfEmployment": "string",
  • "period": "2019-08-24T14:15:22Z",
  • "employmentStartDate": "2019-08-24T14:15:22Z",
  • "employmentEndDate": "2019-08-24T14:15:22Z",
  • "dateOfTrialPeriod": "2019-08-24T14:15:22Z",
  • "fixedTermContractExpirationDate": "2019-08-24T14:15:22Z",
  • "calendarCode": "string",
  • "changedWorkingConditions": 0,
  • "typeOfCompensation": "string",
  • "jobDescription": "string",
  • "isco": "string",
  • "icpv": "string",
  • "category": "string",
  • "profession": "string",
  • "minimumWageLevel": 0.1,
  • "irregularIncome": "string",
  • "osAbbr": "string",
  • "eoAbbr": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "employeeId": 0,
  • "typeOfEmployment": "string",
  • "period": "2019-08-24T14:15:22Z",
  • "employmentStartDate": "2019-08-24T14:15:22Z",
  • "employmentEndDate": "2019-08-24T14:15:22Z",
  • "dateOfTrialPeriod": "2019-08-24T14:15:22Z",
  • "fixedTermContractExpirationDate": "2019-08-24T14:15:22Z",
  • "calendarCode": "string",
  • "changedWorkingConditions": 0,
  • "typeOfCompensation": "string",
  • "jobDescription": "string",
  • "isco": "string",
  • "icpv": "string",
  • "category": "string",
  • "profession": "string",
  • "minimumWageLevel": 0.1,
  • "irregularIncome": "string",
  • "osAbbr": "string",
  • "eoAbbr": "string"
}

UpdateEmployment

Update Employment

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

Request Body schema: application/json
id
required
integer <int64> (PP ID)

Identifier of the employment record

employeeId
required
integer <int64> (Employee Id)

Identifier of the EmployeeId

typeOfEmployment
required
string (Type of Employment) non-empty

Specifies the type of employment (e.g. full-time, contract)

period
required
string <date-time>
employmentStartDate
required
string <date-time> (Employment Start Date)

Date when the employment begins

employmentEndDate
string or null <date-time> (Employment End Date)

Date when the employment ends

dateOfTrialPeriod
string or null <date-time> (Date of Trial Period)

End date of the trial period

fixedTermContractExpirationDate
string or null <date-time> (Fixed-Term Contract Expiration Date)

End date of the fixed-term contract

calendarCode
required
string (Calendar Code) non-empty

Code of the work calendar

changedWorkingConditions
number or null <decimal> (Changed Working Conditions)

Percentage representing the changes in working conditions

typeOfCompensation
required
string (Type of Compensation) non-empty

Specifies the compensation model (e.g. fixed, hourly)

jobDescription
string or null (Job Description)

Text description of the employee's job duties

isco
string or null (Isco)

Isco

icpv
string or null (Icpv)

Icpv

category
string or null (Category)

Category

profession
string or null (Profession)

Profession

minimumWageLevel
number or null <double> (MinimumWageLevel)

MinimumWageLevel

irregularIncome
string or null (IrregularIncome)

IrregularIncome

osAbbr
string or null (OsAbbr)

OsAbbr

eoAbbr
string or null (EoAbbr)

EoAbbr

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "employeeId": 0,
  • "typeOfEmployment": "string",
  • "period": "2019-08-24T14:15:22Z",
  • "employmentStartDate": "2019-08-24T14:15:22Z",
  • "employmentEndDate": "2019-08-24T14:15:22Z",
  • "dateOfTrialPeriod": "2019-08-24T14:15:22Z",
  • "fixedTermContractExpirationDate": "2019-08-24T14:15:22Z",
  • "calendarCode": "string",
  • "changedWorkingConditions": 0,
  • "typeOfCompensation": "string",
  • "jobDescription": "string",
  • "isco": "string",
  • "icpv": "string",
  • "category": "string",
  • "profession": "string",
  • "minimumWageLevel": 0.1,
  • "irregularIncome": "string",
  • "osAbbr": "string",
  • "eoAbbr": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "employeeId": 0,
  • "typeOfEmployment": "string",
  • "period": "2019-08-24T14:15:22Z",
  • "employmentStartDate": "2019-08-24T14:15:22Z",
  • "employmentEndDate": "2019-08-24T14:15:22Z",
  • "dateOfTrialPeriod": "2019-08-24T14:15:22Z",
  • "fixedTermContractExpirationDate": "2019-08-24T14:15:22Z",
  • "calendarCode": "string",
  • "changedWorkingConditions": 0,
  • "typeOfCompensation": "string",
  • "jobDescription": "string",
  • "isco": "string",
  • "icpv": "string",
  • "category": "string",
  • "profession": "string",
  • "minimumWageLevel": 0.1,
  • "irregularIncome": "string",
  • "osAbbr": "string",
  • "eoAbbr": "string"
}

GetByIdAndPeriod.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

id
required
integer <int64> (Id)
period
required
string <DateTime> (Period)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "employeeId": 0,
  • "typeOfEmployment": "string",
  • "period": "2019-08-24T14:15:22Z",
  • "employmentStartDate": "2019-08-24T14:15:22Z",
  • "employmentEndDate": "2019-08-24T14:15:22Z",
  • "dateOfTrialPeriod": "2019-08-24T14:15:22Z",
  • "fixedTermContractExpirationDate": "2019-08-24T14:15:22Z",
  • "calendarCode": "string",
  • "changedWorkingConditions": 0,
  • "typeOfCompensation": "string",
  • "jobDescription": "string",
  • "isco": "string",
  • "icpv": "string",
  • "category": "string",
  • "profession": "string",
  • "minimumWageLevel": 0.1,
  • "irregularIncome": "string",
  • "osAbbr": "string",
  • "eoAbbr": "string"
}

GetByEmployeeId.

Authorizations:
Bearer
query Parameters
MandantId
required
integer <int64> (Mandant Id)

The id of the mandant for which the data should be returned.

employeeId
required
integer <int64> (Employee id)
period
required
string <DateTime> (Period)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pageNumber": 0,
  • "pageSize": 0,
  • "nextPage": "string",
  • "previousPage": "string"
}