List AccountReceivablePayment [GET]

Operation

This operation gives as a result all the credit payments that have been done in a given date

GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/accountReceivablePayment


Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
fromDatefalserequest parameter
Date from
toDatefalserequest parameter
Date to
offsetIntegerfalserequest parameter0Offset of the array of results.
limitIntegerfalserequest parameter10Limit of results.
sortStringfalserequest parameteridProperty of the entity to sort by.
sortModeStringfalserequest parameterAscMode of sorting (Asc/Desc).
searchStringfalserequest parameter
Find by code, name or reference an AccountReceivablePayment

Example request

GET 
https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/2/accountReceivablePayment?from=2020-06-21&to=2020-06-21




Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity



FieldTypeRequiredDescription
idIntegertrueUnique identifier for the AccountReceivablePayment.
accountReceivableAccountReceivabletrueRelated AccountReceivable.
paymentPaymenttrueProduct of type Payment associated.
amountAfterTaxBigDecimaltrueValue of the payment.
currencyCurrencytrueRelated Currency.
referenceStringtrueReference of the AccountReceivablePayment.
createdBusinessDateLocalDatetrueThe date of the business date when it was created.
accountReceivablePaymentInvoiceListArray of AccountReceivablePaymentInvoicetrue

Example response

{
  "count": 1,
  "offset": 0,
  "limit": 10,
  "list": [
    {
      "id": 1,
      "accountReceivable": {
        "id": 11,
        "code": "AM",
        "name": "American Express"
      },
      "payment": {
        "code": "VI",
        "name": "Visa",
        "id": 50
      },
      "amountAfterTax": 394.000000,
      "currency": {
        "id": 1,
        "code": "EUR",
        "name": "Euro"
      },
      "reference": "Ref #121561",
      "createdBusinessDate": "2020-05-04",
	  "accountReceivablePaymentInvoiceList": [
        {
          "amountAfterTax": 108.000000,
          "invoice": {
            "id": 537,
            "invoiceSerie": "GHD/",
            "invoiceNumber": 174,
            "invoiceDate": "2020-06-21",
            "company": null,
            "customer": null,
           ...
          }
        }
      ]
    }
  ]
}