GET /debts/find

Searches for a list of debts that meet the specified search criteria.

This request is idempotent.

curl -XGET \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer 4b1e8df2ff50110ca86e28f2b499facbd78310c9cda0125543ad80ac70cc28d1" \
  https://api.invisiblecollector.com/debts/find?number=12345

import com.ic.invisiblecollector.IcApiFacade;
import com.ic.invisiblecollector.model.Debt;

IcApiFacade apiFacade = new IcApiFacade("56a73507b66cd761caae7547ef2a66fc3a393746ba4bb9a91e303fcb3ceefb98");

FindDebtsBuilder builder = new FindDebtsBuilder();
// ... set builder search parameters
List<Debt> = apiFacade.findDebts(builder);

using InvisibleCollectorLib;
using InvisibleCollectorLib.Model;

var ic = new InvisibleCollector("56a73507b66cd761caae7547ef2a66fc3a393746ba4bb9a91e303fcb3ceefb98");
var findDebts = new FindDebts
{
    // ... set search parameters
};
IList<Debt> debt = await ic.GetFindDebts(findDebts);

This request will return, for example, the following JSON response:

[
  {
    "number": "12345",
    "id": "1fb0c683-bedc-45be-a88a-ff76da7bf650",
    "customerId": "0d3987e3-a6df-422c-8722-3fde26eec9a8",
    "type": "FT",
    "status": "PENDING",
    "date": "2018-05-02",
    "dueDate": "2019-01-02",
    "netTotal": 1000.0,
    "tax": 200.0,
    "grossTotal": 1200.0,
    "currency": "EUR",
    "items": [
      {
        "name": "an item name",
        "description": "a debt item description",
        "quantity": 3.0,
        "vat": 23.0,
        "price": 15.0
      },
      {
        "name": "another item name",
        "description": "another debt item description",
        "quantity": 4.0,
        "vat": 23.0,
        "price": 20.0
      },
    ],
    "attributes": {
      "name_1": "attribute_1",
      "name_2": "attribute_2"
    }
  }
]

Endpoint

GET https://api.invisiblecollector.com/debts/find

Query parameters

Response body

Debt

<tr>
  <td>id</td>
  <td>string</td>
  <td>An unique identifier of this debt</td>
</tr>

<tr>
  <td>customerId</td>
  <td>string</td>
  <td>The identification of the debtor to whom this debt was issued to</td>
</tr>

<tr>
  <td>type</td>
  <td>string</td>
  <td>The type of debt</td>
</tr>

<tr>
  <td>status</td>
  <td>string</td>
  <td>The current status of this debt</td>
</tr>

<tr>
  <td>date</td>
  <td>date</td>
  <td>The date this debt was created in <a href="https://en.wikipedia.org/wiki/ISO_8601" class="highlight">ISO 8601</a> format (YYYY-MM-DD)</td>
</tr>

<tr>
  <td>dueDate</td>
  <td>date</td>
  <td>The payment expiration date in <a href="https://en.wikipedia.org/wiki/ISO_8601" class="highlight">ISO 8601</a> format (YYYY-MM-DD)</td>
</tr>

<tr>
  <td>netTotal</td>
  <td>double</td>
  <td>This debt’s total net total</td>
</tr>

<tr>
  <td>tax</td>
  <td>double</td>
  <td>The total amount being paid for tax purposes</td>
</tr>

<tr>
  <td>grossTotal</td>
  <td>double</td>
  <td>The gross total of this debt</td>
</tr>

<tr>
  <td>debitTotal</td>
  <td>double</td>
  <td>The debit total of this debt. This is the total amount of the corrections that have increased the value of this debt.</td>
</tr>

<tr>
  <td>creditTotal</td>
  <td>double</td>
  <td>The credit total of this debt. This is the total amount of the corrections that have decreased the value of this debt.</td>
</tr>

<tr>
  <td>paidTotal</td>
  <td>double</td>
  <td>The total amount paid. This is the sum of all payments that have been registered for this debt.</td>
</tr>

<tr>
  <td>currency</td>
  <td>string</td>
  <td>The <a href="https://en.wikipedia.org/wiki/ISO_4217" class="highlight">ISO 4217</a> currency code.</td>
</tr>

<tr>
  <td>items</td>
  <td>array</td>
  <td>A list of items included in the transaction</td>
</tr>

<tr>
  <td>attributes</td>
  <td>map</td>
  <td>A map of custom attributes related with this debt. Each attribute is a string-string key-value pair.</td>
</tr>

Item

<tr>
  <td>description</td>
  <td>string</td>
  <td>A human readable description of the item.</td>
</tr>

<tr>
  <td>quantity</td>
  <td>double</td>
  <td>The amount of items of this type included in the transaction.</td>
</tr>

<tr>
  <td>netPrice</td>
  <td>double</td>
  <td>The item’s net total price (value without taxes).</td>
</tr>

<tr>
  <td>vat</td>
  <td>percentage</td>
  <td>The percentage being applied to this item for tax purposes.</td>
</tr>

<tr>
  <td>taxes</td>
  <td>double</td>
  <td>The value being paid for tax purposes.</td>
</tr>

<tr>
  <td>price</td>
  <td>double</td>
  <td>This item’s gross total.</td>
</tr>

Errors

This endpoint may return the following errors: