/api/reports/
Parameters for GET Queries
| PARAMETER NAME | TYPE | DESCRIPTION | REQUIRED |
|---|---|---|---|
| dateFrom | String | Format: 2012-12-29T00:00:00 | |
| isOverdue | boolean | ||
| getByContact | boolean | ||
| getEverything | boolean | ||
| showCustomers | boolean | ||
| documentId | String | Project ID (internal) | |
| keyword | String | ||
| typeOfPrintout | String | ||
| currencyCode | String | CURRENCY | |
| getByTransactionDate | boolean | ||
| partnerCustomerId | String | ||
| start | int | ||
| limit | int |
Response
| FIELD NAME | TYPE | DESCRIPTION | REQUIRED | |
|---|---|---|---|---|
| APIAgedDebtsInfo | payerId | long | Payment ID (internal) | |
| APIAgedDebtsInfo | name | String | payer name | |
| APIAgedDebtsInfo | registrationCode | String | Registration code | |
| APIAgedDebtsInfo | vatNumber | String | VAT nr | |
| APIAgedDebtsInfo | country | String | payer country | |
| APIAgedDebtsInfo | String | payer email | ||
| APIAgedDebtsInfo | typeCode | String | Type of Transaction | |
| APIAgedDebtsInfo | prepayments | BigDecimal | Prepayments made by payer | |
| APIAgedDebtsInfo | totalDebt | BigDecimal | Total outstanding amount from unpaid invoices | |
| APIAgedDebtsInfo | notYetDueDebt | BigDecimal | Total number of invoices that aren’t gone over deadline but are unpaid | |
| APIAgedDebtsInfo | aged7 | BigDecimal | Number of invoices that are gone over for less than 8 days | |
| APIAgedDebtsInfo | aged15 | BigDecimal | Number of invoices that are gone over for more than 7days but less than 16 days | |
| APIAgedDebtsInfo | aged30 | BigDecimal | Number of invoices that are gone over for more than 15days but less than 31 days | |
| APIAgedDebtsInfo | aged60 | BigDecimal | Number of invoices that are gone over for more than 30 days but less than 61 days | |
| APIAgedDebtsInfo | aged90 | BigDecimal | Number of invoices that are gone over for more than 60 days but less than 91 days | |
| APIAgedDebtsInfo | aged180 | BigDecimal | Number of invoices that are gone over for more than 90 days but less than 180 days | |
| APIAgedDebtsInfo | aged360 | BigDecimal | Number of invoices that are gone over for more than 180 days but less than 361 days | |
| APIAgedDebtsInfo | agedAllOther | BigDecimal | Number of invoices that are gone over for more than 360 days | |
| APIAgedDebtsInfo | lastMonth0 | BigDecimal | Number of invoices that are gone over for less than 1 Month | |
| APIAgedDebtsInfo | lastMonth1 | BigDecimal | Number of invoices that are gone over for 1 to 2 months | |
| APIAgedDebtsInfo | lastMonth2 | BigDecimal | Number of invoices that are gone over for 2 to 3 months | |
| APIAgedDebtsInfo | lastMonth3 | BigDecimal | Number of invoices that are gone over for 3 to 4 months | |
| APIAgedDebtsInfo | lastMonth4 | BigDecimal | Number of invoices that are gone over for 4 to 5 months | |
| APIAgedDebtsInfo | lastMonthAllOther | BigDecimal | Number of invoices that are gone over for more than 5 months |
EXAMPLE:
GET
https://api.erplybooks.com/api/reports/aged
JSON:
{"items":[{"id":3136916,"customerId":3136916,"partnerCustomerId":"0","overdueInvoiceDays":0,"daysToDeadline":7,"invoiceId":0,"customerIds":[3136916],"payerId":0,"name":"CUSTOMERNAME","registrationCode":null,"vatNumber":null,"country":null,"email":null,"typeCode":null,"prepayments":0,"totalDebt":38.500000,"notYetDueDebt":38.500000,"aged7":0,"aged15":0,"aged30":0,"aged60":0,"aged90":0,"aged180":0,"aged360":0,"agedAllOther":0,"lastMonth0":38.500000,"lastMonth1":0,"lastMonth2":0,"lastMonth3":0,"lastMonth4":0,"lastMonthAllOther":0},{"id":3137841,"customerId":3137841,"partnerCustomerId":"0","overdueInvoiceDays":6,"daysToDeadline":7,"invoiceId":0,"customerIds":[3137841],"payerId":0,"name":"CUSTOMERNAME2","registrationCode":"","vatNumber":"","country":"","email":"","typeCode":null,"prepayments":0,"totalDebt":26.000000,"notYetDueDebt":13.000000,"aged7":13.000000,"aged15":0,"aged30":0,"aged60":0,"aged90":0,"aged180":0,"aged360":0,"agedAllOther":0,"lastMonth0":26.000000,"lastMonth1":0,"lastMonth2":0,"lastMonth3":0,"lastMonth4":0,"lastMonthAllOther":0},{"id":3139631,"customerId":3139631,"partnerCustomerId":"0","overdueInvoiceDays":5,"daysToDeadline":7,"invoiceId":0,"customerIds":[3139631],"payerId":0,"name":" CUSTOMERNAME3","registrationCode":"","vatNumber":"","country":"","email":"","typeCode":null,"prepayments":0,"totalDebt":12.000000,"notYetDueDebt":11.000000,"aged7":1.000000,"aged15":0,"aged30":0,"aged60":0,"aged90":0,"aged180":0,"aged360":0,"agedAllOther":0,"lastMonth0":12.000000,"lastMonth1":0,"lastMonth2":0,"lastMonth3":0,"lastMonth4":0,"lastMonthAllOther":0},{"id":3139597,"customerId":3139597,"partnerCustomerId":"0","overdueInvoiceDays":5,"daysToDeadline":7,"invoiceId":0,"customerIds":[3139597],"payerId":0,"name":"CUSTOMERNAME4","registrationCode":"","vatNumber":"","country":"","email":"","typeCode":null,"prepayments":0,"totalDebt":8.800000,"notYetDueDebt":0,"aged7":8.800000,"aged15":0,"aged30":0,"aged60":0,"aged90":0,"aged180":0,"aged360":0,"agedAllOther":0,"lastMonth0":8.800000,"lastMonth1":0,"lastMonth2":0,"lastMonth3":0,"lastMonth4":0,"lastMonthAllOther":0}],"totalCount":4}