API - Unpaid Debtor Invoices (Openstaande Debiteuren)


Resource:
/acumulus/stable/reports/report_unpaid_debtors.php
Since API:
Authentication:
API user
Communication:
Basic submit, including below structure


Submit

<?xml version="1.0" encoding="UTF-8"?>
<myxml>
    ...
    <year></year>
    <due></due>
</myxml>

year
Year for which the overview is requested. Use 4-digit YYYY format. Defaults to current year.

due
Optional tag to indicate whether you want to include the due invoices to the list.

Option
Description
0
Do not include due invoices.
1
Include due invoices in the return structure. (DEFAULT)

Response

There are two types of response structures possible. One where there are no unpaid creditor invoices and one where there are. Depending on the situation the XML response will be slightly different.

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <unpaiddebtorinvoices>
        <numberunpaiddebtors></numberunpaiddebtors>
        <amountunpaiddebtors></amountunpaiddebtors>
        <numberoverduedebtors></numberoverduedebtors>
        <amountoverduedebtors></amountoverduedebtors>
    </unpaiddebtorinvoices>
</response>

Or, when unpaid creditor invoices are available:

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <unpaiddebtorinvoices>
        <entry>
            <entryid></entryid>
            <token></token>
            <number></number>
            <issuedate></issuedate>
            <expirationdate></expirationdate>
            <daysdue></daysdue>
            <invoicedaylimit></invoicedaylimit>
            <contactid></contactid>
            <contactname></contactname>
            <accountid></accountid>
            <accountnumber></accountnumber>
            <amount></amount>
        </entry>
        <entry>
            ...
        </entry>
        <numberunpaiddebtors></numberunpaiddebtors>
        <amountunpaiddebtors></amountunpaiddebtors>
        <numberoverduedebtors></numberoverduedebtors>
        <amountoverduedebtors></amountoverduedebtors>
    </unpaiddebtorinvoices>
</response>

entryid
Integer.
number
String.
issuedate
String.
expirationdate
String.
daysoverdue
Integer.
contactid
Integer.
contactname
(in CDATA format).
accountid
Integer.
accountnumber
(in CDATA format).
amount
Float. 2 Decimals.
numberunpaiddebtors
Integer.
amountunpaiddebtors
Integer.
numberoverduedebtors
Integer.
amountoverduedebtors
Integer.