/api/payments/
Parameters for GET Queries
| PARAMETER NAME | TYPE | DESCRIPTION | REQUIRED |
|---|---|---|---|
| dateFrom | String | Format: 2012-12-29T00:00:00 | |
| dateTo | String | Format: 2012-12-29T00:00:00 | |
| entityId | long | ||
| isIncome | boolean | ||
| getEverything | boolean | ||
| documentId | long | ||
| type | String | ||
| paymentType | String | PAYMENT_TYPE |  |
| showOnlyPrepayments | boolean | ||
| documentStatusType | String | ||
| accountId | long | Account ID (internal) | |
| projectId | long | Project ID (internal) | |
| description | String | Payment Description | |
| sortBy | String | ||
| start | int | ||
| limit | int |
Response
| FIELD NAME | TYPE | DESCRIPTION | REQUIRED | |
|---|---|---|---|---|
| PaymentInfo | id | long | Payment ID (internal) | |
| PaymentInfo | opDate | Date | Format: 2012-12-29T00:00:00 | |
| PaymentInfo | invoiceId | long | Invoice ID (internal) | |
| PaymentInfo | transactionIdentifier | String | ||
| PaymentInfo | transactionEntryId | long | ||
| PaymentInfo | sumPaid | BigDecimal | Sum Paid | |
| PaymentInfo | sumWithVat | BigDecimal | Sum With VAT | |
| PaymentInfo | currencyCode | String | Currency Code | |
| PaymentInfo | typeCode | String | PAYMENT_TYPE | |
| PaymentInfo | accountId | long | Account ID | |
| PaymentInfo | customerName | String | Customer Name | |
| PaymentInfo | number | String | ||
| PaymentInfo | referenceNumber | String | Reference Number | |
| PaymentInfo | archivingId | String | Archiving ID | |
| PaymentInfo | note | String | Note | |
| PaymentInfo | code | String | Code | |
| PaymentInfo | badDebt | boolean | Undoubtful income | |
| PaymentInfo | partnerPaymentId | long | Payment ID (from ERPLY) | |
| PaymentInfo | customerId | long | Customer ID (internal) | |
| PaymentInfo | originalSum | BigDecimal | Original Sum | |
| PaymentInfo | partnerDocumentId | long | Document ID (from ERPLY) | |
| PaymentInfo | imported | boolean | Is imported from EPRLY | |
| PaymentInfo | documentStatusTypeCode | String | DOCUMENT_STATUS_TYPE | |
| PaymentInfo | statusChangeDatetime | Date | Date of change of Documen’ts Status | |
| PaymentInfo | currencyRate | |||
| PaymentInfo | projectId | long | Project ID (internal) | |
| PaymentInfo | entityName | |||
| PaymentInfo | parentPaymentId |
API Examples
GET
PaymentType is required!
Using id: https://api.erplybooks.com/api/payments
DELETE
Id is required!
https://api.erplybooks.com/api/payments/2575151
PUT
Used to update data. Id is required.
https://api.erplybooks.com/api/payments/2575151
JSON: {"id":2749305, "opDate":"2014-04-14T12:00:00", "invoiceId":2622468, "transactionIdentifier":null, "transactionEntryId":7782152, "sumPaid":10.000000, "sumWithVat":null, "currencyCode":"CURRENCY_EUR", "typeCode":"INVOICE_PAYMENT", "accountId":583287, "customerName":null, "number":null, "referenceNumber":null, "archivingId":"", "note":"", "code":null, "badDebt":false, "partnerPaymentId":477, "customerId":725113, "originalSum":10.000000, "partnerDocumentId":0, "imported":true, "documentStatusTypeCode":"STATUS_CONFIRMED", "statusChangeDatetime":"2014-04-14T12:00:00", "currencyRate":null, "projectId":0, "entityName":null, "parentPaymentId":0}
POST
Id must be 0 in all cases! All id’s are automatically generated.https://api.erplybooks.com/api/payments
JSON:
{
"id":0, "opDate":"2012-09-26T12:00:00", "invoiceId":2460653, "transactionIdentifier":null, "transactionEntryId":7665466, "sumPaid":120.000000, "sumWithVat":null, "currencyCode":"CURRENCY_EUR", "typeCode":"INVOICE_PAYMENT", "accountId":583287, "customerName":null, "number":null, "referenceNumber":null, "archivingId":"2012092600236540", "note":"Invoice nr 2", "code":null, "badDebt":false, "partnerPaymentId":0, "customerId":700373, "originalSum":435.560000, "partnerDocumentId":0, "imported":false, "documentStatusTypeCode":"STATUS_CONFIRMED", "statusChangeDatetime":"2012-09-26T12:00:00", "currencyRate":null, "projectId":0, "entityName":"Client 2", "parentPaymentId":0
}