List recovery cases (the Recoveries work surface)

GET

/recoveries

const url = 'https://api.invogi.com/v1/recoveries?view=open&limit=50&offset=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.invogi.com/v1/recoveries?view=open&limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Overdue next actions first, then the most value still open. Saved views follow docs/35_AP_RECOVERY_WORKFLOW_DESIGN.md §10.3. Readable by every role and by API keys.

Authorizations

bearerAuth

Parameters

Query Parameters

view

string

default: open

Allowed values: open mine overdue awaiting_contact waiting_on_supplier promise_overdue credits_unapplied partially_recovered completed closed all

limit

integer

default: 50 >= 1 <= 200

offset

integer

Responses

200

A page of cases

application/json

object

items

required

Array<object>

object

required

string format: uuid

status

required

CONFIRMED, IN_RECOVERY and AGREED are set by people (the stage); CREDIT_RECEIVED, PARTIALLY_REALIZED and REALIZED are derived from instruments and applications; the CLOSED statuses from closure.

string

Allowed values: CONFIRMED IN_RECOVERY AGREED CREDIT_RECEIVED PARTIALLY_REALIZED REALIZED CLOSED_UNRECOVERED CLOSED_PARTIALLY_RECOVERED MERGED

stage

required

string

Allowed values: CONFIRMED IN_RECOVERY AGREED

currency

required

string

confirmedAmount

required

string

verifiedAmount

required

Active applications only — cash received plus credit applied

string

openAmount

required

Confirmed less verified less closed

string

supplierId

string | null format: uuid

supplierName

string | null

primaryFindingId

string format: uuid

findingType

string

ownerUserId

string | null format: uuid

ownerName

string | null

nextAction

string | null

nextActionDueOn

string | null format: date

promisedResponseOn

string | null format: date

lastContactAt

string | null format: date-time

lastActivityAt

string | null format: date-time

vatAdjustmentStatus

string | null

Allowed values: REQUIRED DONE

legacy

Carried over from a RECOVERED invoice outcome

boolean

overdue

required

boolean

offsetAvailable

required

The supplier has recent bills with no recorded payment that could carry an offset

boolean

suggestedMatchCount

Ledger credits or imported refunds suggested for this case and waiting for a person (see suggestedMatches on the case)

integer

total

required

integer

limit

required

integer

offset

required

integer

Example

{
  "items": [
    {
      "status": "CONFIRMED",
      "stage": "CONFIRMED",
      "vatAdjustmentStatus": "REQUIRED"
    }
  ]
}

400

Invalid request

application/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}

401

Missing or invalid API key

application/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}