C1c1st
POSPayments

Add a list of articles to an existing payment.

post/pospayments/{paymentId}/articles

Request

  • Base URL
    https://api.c1st.com/api
  • URL
    https://api.c1st.com/api/pospayments/{paymentId}/articles
  • Auth
    HTTP bearer

Request body

idinteger nullable

A unique ID generated automatically

titlestring

The title of the article sold

pricenumber double

Price of the article. By default price includes VAT but can be changed in the store config "prices_include_vat".

costpricenumber double nullable

The cost price of the article sold

quantitynumber

Number of articles sold.

vatnumber double

VAT percentage.

vatmode'normal' | 'second_hand'

< normal vat calculation is based on price second_hand vat calulation is based on price - costprice

pricewithoutvatnumber double nullable

Consistently give the calculcated price without VAT. Regardless of the value of store config "prices_include_vat"

vatamountnumber double nullable

The calculated VAT for the price field.

giftcardnostring nullable

Provide this if you want to issue a giftcard with the payment. The amount on the giftcard will be the value of price.

usedGiftcardIdinteger nullable

Provide this if you want use a giftcard as means of payment. The value of price will be deducted from the giftcard balance

giftcardidinteger nullable

Id of issued giftcard

customerarticleidinteger nullable

Id of the attached customerarticle

productnostring nullable

For legacy support, instead refer to product.productno. This is only used for voucher and deposit

productidinteger nullable

< The the id of the product you want to sell. Stock will be deducted from the product after succesful payment. Deleted products are allowed. This is useful for return sales and payments of tickets with deleted products.

taskmaterialidinteger nullable

Relate the payment article to a taskmaterial. Use this to keep track of the payment status of task.

discount_ppm_idnumber nullable

If the article has a discount. This will be a reference to the discount article. This will be autofilled by matching the value of discountToken and discountedToken

discountTokennumber
discountedTokennumber nullable
paymentidinteger nullable
deletedpromotioninteger nullable

If a promotion is deleted from an article, this is set to 1, thus no further promotions will be applied to it

discounttagidinteger nullable
promotionidinteger nullable
bundleidinteger nullable
typestring nullable

Can either be "recurringpaymentterm", "newservicesubscription" or "newrecurringpayment"

recurringpaymentidinteger nullable

The id of the recurring payment

servicesubscriptionidinteger nullable

The id of the servicesubscription to be activated when payment completed

loyaltypointsnumber nullable

The amount of desired loyalty points to be credited by this paymentmaterial.

loyaltypoints_transactionednumber nullable

The transactioned changed of loyalty points when payment is completed.

addonparentmaterialidinteger nullable

The id of the parent material. If set, this paymentmaterial is considered to be an addon

datestring nullable
salesorder_fulfillmentboolean nullable
discountidinteger nullable

The id of the discount added to the paymentmaterial

returnmaterialidnumber nullable

An id referencing the paymentmaterial being returned

returntagidnumber nullable

An id referencing the return tag (reason) of the paymentmaterial being returned

total_vatnumber double nullable

Total vat amount

total_ex_vatnumber double nullable

Total price excluding VAT

total_incl_vatnumber double nullable

Total price including VAT

total_discount_incl_vatnumber double nullable

Total discount including VAT for this line item (negative number; 0 when no discount)

vat_type_idinteger nullable

The id of the vat type from the product at the time it was created.

Response

Ok

idinteger nullable

A unique ID generated automatically

titlestring

The title of the article sold

pricenumber double

Price of the article. By default price includes VAT but can be changed in the store config "prices_include_vat".

costpricenumber double nullable

The cost price of the article sold

quantitynumber

Number of articles sold.

vatnumber double

VAT percentage.

vatmode'normal' | 'second_hand'

< normal vat calculation is based on price second_hand vat calulation is based on price - costprice

pricewithoutvatnumber double nullable

Consistently give the calculcated price without VAT. Regardless of the value of store config "prices_include_vat"

vatamountnumber double nullable

The calculated VAT for the price field.

giftcardnostring nullable

Provide this if you want to issue a giftcard with the payment. The amount on the giftcard will be the value of price.

usedGiftcardIdinteger nullable

Provide this if you want use a giftcard as means of payment. The value of price will be deducted from the giftcard balance

giftcardidinteger nullable

Id of issued giftcard

customerarticleidinteger nullable

Id of the attached customerarticle

productnostring nullable

For legacy support, instead refer to product.productno. This is only used for voucher and deposit

productidinteger nullable

< The the id of the product you want to sell. Stock will be deducted from the product after succesful payment. Deleted products are allowed. This is useful for return sales and payments of tickets with deleted products.

taskmaterialidinteger nullable

Relate the payment article to a taskmaterial. Use this to keep track of the payment status of task.

discount_ppm_idnumber nullable

If the article has a discount. This will be a reference to the discount article. This will be autofilled by matching the value of discountToken and discountedToken

discountTokennumber
discountedTokennumber nullable
paymentidinteger nullable
deletedpromotioninteger nullable

If a promotion is deleted from an article, this is set to 1, thus no further promotions will be applied to it

discounttagidinteger nullable
promotionidinteger nullable
bundleidinteger nullable
typestring nullable

Can either be "recurringpaymentterm", "newservicesubscription" or "newrecurringpayment"

recurringpaymentidinteger nullable

The id of the recurring payment

servicesubscriptionidinteger nullable

The id of the servicesubscription to be activated when payment completed

loyaltypointsnumber nullable

The amount of desired loyalty points to be credited by this paymentmaterial.

loyaltypoints_transactionednumber nullable

The transactioned changed of loyalty points when payment is completed.

addonparentmaterialidinteger nullable

The id of the parent material. If set, this paymentmaterial is considered to be an addon

datestring nullable
salesorder_fulfillmentboolean nullable
discountidinteger nullable

The id of the discount added to the paymentmaterial

returnmaterialidnumber nullable

An id referencing the paymentmaterial being returned

returntagidnumber nullable

An id referencing the return tag (reason) of the paymentmaterial being returned

total_vatnumber double nullable

Total vat amount

total_ex_vatnumber double nullable

Total price excluding VAT

total_incl_vatnumber double nullable

Total price including VAT

total_discount_incl_vatnumber double nullable

Total discount including VAT for this line item (negative number; 0 when no discount)

vat_type_idinteger nullable

The id of the vat type from the product at the time it was created.

Changes

No recorded changes to this operation across all 1 revision of this API.