Add Payment [POST]
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 | Integer | true | path parameter | ||
propertyId | Integer | true | path parameter | ||
folioId | Integer | true | path parameter | ||
cashierId | Integer | false | Request 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.
Field Type Required Description id Integer true Identificator of the BillingPayment sequence Integer true Sequence of the folioProduct/invoiceProduct productionDate Integer true Date when the payment enters in production postingDate String true Date when the payment is posted. payment Payment true The product of type payment associated to this billingPayment. quantity Integer true amount BigDecimal true currency Currency true invoice Invoice false The Invoice related to this payment folio Folio false The Folio related to this payment paymentReceipt PaymentReceipt false Payment 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
Property | Type | Required | Description |
---|---|---|---|
ResponseAPIMessage | ResponseAPIMessage | true | The response of the operation |
Example response
{ "httpStatus": "201", "userMessage": "Success", "technicalMessage": "Success payment added, "errorCode": "0", "id": 1 }