C1c1st
POSPayments

Add a new POS payment

Add a new payment. For a payment use must provide the products sold via articles and the payment transactions via paymenttypes

post/pospayments

Request

  • Base URL
    https://api.c1st.com/api
  • URL
    https://api.c1st.com/api/pospayments
  • Auth
    HTTP bearer

Request body

idinteger nullable

A global unique payment id

paymentnointeger nullable

a sequential autoincremented payment no

useridinteger nullable

The id of the user who created the payment

customeridinteger nullable

The id of the customer if any was attached to the payment

datestring nullable

The date of the payment

numberofmaterialsnumber double nullable

the total number of payment articles sold

sumnumber double nullable

The sum of the payment materials

discountsumnumber double nullable

the sum of all discounts in the purchase

remainingamountnumber nullable

The amount left to pay for the payment

cashRegisterIdinteger nullable

The id of the cash register used for the payment. Provide null if you don't use cash regiters

cashRegisterTitlestring nullable

Deprecated. Refer to cashregister.title

updated_atstring nullable

Timestamp for when the last time the payment is updated.

invoiceinteger

1 if payment is a invoice payment. For example if the payment is paid via an invoice in economic.

customerpaymentinteger

1 if payment is a customer payment

receiptcopycountinteger nullable

Number of receipt copies printed (requires Efsta)

taskidsinteger[]

An optional list of ticket id attached to the payment. Not provided with GET payments

salesOrderIdinteger nullable

The id of the sales order if any was attached to the payment Not provided with GET payments

paidwithcashnumber nullable

The sum of payment types considered cash payments.

surcharge_amountnumber nullable

The surcharge amount that was applied to the payment, if any.

storeidinteger nullable

Included when partner store payments are included

customerpaymentsumnumber nullable

Total payment sum for customer, only set if customerid and customerPaymentSum query parameters are set

cashinteger nullable

Deprecated. To be removed soon

secondhandinteger nullable

Set to 1 i f the return of the payment has secondhand products (only necessary to set if you want statistics of secondhand sales)

status'initialized' | 'parked' | 'in_progress' | 'completed' | 'cancelled'
returnpaymentidinteger nullable

A reference ID to the POSPayment being returned. Only relevant for return sales.

lastmodifiedbyuseridinteger nullable

ID of the user who last modified the payment by changing the status from in_progress to complete/cancelled

notestring nullable

A piece of text attached to the payment.

permission'none' | 'readonly' | 'full'
source'assisted-checkout' | 'pos' nullable

Source of the payment. Can either be 'assisted-checkout' or 'pos'

Response

Ok

idinteger nullable

A global unique payment id

paymentnointeger nullable

a sequential autoincremented payment no

useridinteger nullable

The id of the user who created the payment

customeridinteger nullable

The id of the customer if any was attached to the payment

datestring nullable

The date of the payment

numberofmaterialsnumber double nullable

the total number of payment articles sold

sumnumber double nullable

The sum of the payment materials

discountsumnumber double nullable

the sum of all discounts in the purchase

remainingamountnumber nullable

The amount left to pay for the payment

cashRegisterIdinteger nullable

The id of the cash register used for the payment. Provide null if you don't use cash regiters

cashRegisterTitlestring nullable

Deprecated. Refer to cashregister.title

updated_atstring nullable

Timestamp for when the last time the payment is updated.

invoiceinteger

1 if payment is a invoice payment. For example if the payment is paid via an invoice in economic.

customerpaymentinteger

1 if payment is a customer payment

receiptcopycountinteger nullable

Number of receipt copies printed (requires Efsta)

taskidsinteger[]

An optional list of ticket id attached to the payment. Not provided with GET payments

salesOrderIdinteger nullable

The id of the sales order if any was attached to the payment Not provided with GET payments

paidwithcashnumber nullable

The sum of payment types considered cash payments.

surcharge_amountnumber nullable

The surcharge amount that was applied to the payment, if any.

storeidinteger nullable

Included when partner store payments are included

customerpaymentsumnumber nullable

Total payment sum for customer, only set if customerid and customerPaymentSum query parameters are set

cashinteger nullable

Deprecated. To be removed soon

secondhandinteger nullable

Set to 1 i f the return of the payment has secondhand products (only necessary to set if you want statistics of secondhand sales)

status'initialized' | 'parked' | 'in_progress' | 'completed' | 'cancelled'
returnpaymentidinteger nullable

A reference ID to the POSPayment being returned. Only relevant for return sales.

lastmodifiedbyuseridinteger nullable

ID of the user who last modified the payment by changing the status from in_progress to complete/cancelled

notestring nullable

A piece of text attached to the payment.

permission'none' | 'readonly' | 'full'
source'assisted-checkout' | 'pos' nullable

Source of the payment. Can either be 'assisted-checkout' or 'pos'

Changes

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