/
Add Payment [POST]

Add Payment [POST]

Owned by David Garcerán
Last updated: Oct 26, 2022 by Jordi Artal

Operation

Adds a BillingPayment to a Folio.

POST
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/folio/{folioId}/payment


Request

Property
Type
Required
Type parameter
Default value
Description

chainId

Integertruepath parameter

propertyIdIntegertruepath parameter

folioIdIntegertruepath parameter

cashierIdIntegerfalseRequest parameter
Re-assign to other cashier this operation and posteriors.

Example request

POST https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/folio/1/payment


Body

An element of type BillingPayment.


FieldTypeRequiredDescription
idIntegertrueIdentificator of the BillingPayment
sequenceIntegertrueSequence of the folioProduct/invoiceProduct
productionDateIntegertrueDate when the payment enters in production
postingDateStringtrueDate when the payment is posted.
paymentPaymenttrueThe product of type payment associated to this billingPayment.
quantityIntegertrue
amountBigDecimaltrue
currencyCurrencytrue
invoiceInvoicefalseThe Invoice related to this payment
folioFoliofalseThe Folio related to this payment
paymentReceiptPaymentReceiptfalsePayment receipt related to this billing payment

Example body

{
	"amount": 235,
	"displayDate": "2019-07-23",
	"currency": {
		"id": 1,
		"code": "EUR",
		"name": "Euro"
	},
	"payment": {
		"id": 632,
		"name": "Diners"
	}
}


Response

PropertyTypeRequiredDescription
ResponseAPIMessageResponseAPIMessagetrueThe response of the operation

Example response

{
  "httpStatus": "201",
  "userMessage": "Success",
  "technicalMessage": "Success payment added,
  "errorCode": "0",
  "id": 1
}

Related content