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

Parameter Type Description
number string The number of the debt to search for. This is usually unique within the scope of a company so specifying this parameter should yield a single debt.
from_date date Search for debts created as early as this parameters (inclusive).
to_date date Search for debts created until this date (inclusive).
from_duedate date Search for debts whose payment expiration date is later than this date (inclusive).
to_duedate date Search for debts whose payment expiration date is sooner than this date (inclusive).

Response body

Debt

Attribute Type Description
number string The debt number
id string An unique identifier of this debt
customerId string The identification of the customer to whom this debt was issued to
type string The type of debt
status string The current status of this debt
date date The date this debt was created in ISO 8601 format (YYYY-MM-DD)
dueDate date The payment expiration date in ISO 8601 format (YYYY-MM-DD)
netTotal double This debt’s total net total
tax double The total amount being paid for tax purposes
grossTotal double The gross total of this debt
debitTotal double The debit total of this debt. This is the total amount of the corrections that have increased the value of this debt.
creditTotal double The credit total of this debt. This is the total amount of the corrections that have decreased the value of this debt.
paidTotal double The total amount paid. This is the sum of all payments that have been registered for this debt.
currency string The ISO 4217 currency code.
items array A list of items included in the transaction
attributes map A map of custom attributes related with this debt. Each attribute is a string-string key-value pair.

Item

Attribute Type Description
name string The name if the item.
description string A human readable description of the item.
quantity double The amount of items of this type included in the transaction.
netPrice double The item’s net total price (value without taxes).
vat percentage The percentage being applied to this item for tax purposes.
taxes double The value being paid for tax purposes.
price double This item’s gross total.

Errors

This endpoint may return the following errors:

HTTP Code Description
401 Unauthorized Invalid credentials were supplied

Feedback

If you have a question that needs an answer, please contact support.