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
Property | Type | Required | Type parameter | Default value | Description |
---|---|---|---|---|---|
chainId | Integer | true | path parameter | Unique identificator of the chain. | |
propertyId | Integer | true | path parameter | Unique identificator of the property. | |
from | Date | false | request parameter | Date from | |
to | Date | false | request parameter | Date to | |
offset | Integer | false | request parameter | 0 | Offset of the array of results. |
limit | Integer | false | request parameter | 10 | Limit of results. |
sort | String | false | request parameter | id | Property of the entity to sort by. |
sortMode | String | false | request parameter | Asc | Mode of sorting (Asc/Desc). |
search | String | false | request 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
Property | Type | Required | Description |
---|---|---|---|
Page | Page | true | Description of the response of the success operation |
Entity
Field | Type | Required | Description |
---|---|---|---|
id | Integer | true | Unique identifier for the AccountReceivablePayment. |
accountReceivable | AccountReceivable | true | Related AccountReceivable. |
payment | Payment | true | Product of type Payment associated. |
amountAfterTax | BigDecimal | true | Value of the payment. |
currency | Currency | true | Related Currency. |
reference | String | true | Reference of the AccountReceivablePayment. |
createdBusinessDate | LocalDate | true | The date of the business date when it was created. |
accountReceivablePaymentInvoiceList | Array of AccountReceivablePaymentInvoice | true |
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, ... } } ] } ] }