finov.ioDocumentationHome

List statuses

API Documentation / Resources / Connections and subsidiaries

Finovio Invoices register containing customer invoices and a customer credit note
Invoices keeps customer documents separate from supplier bills.

List accounting statuses

GET /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/statuses

Required OAuth scope: accounting:read

Lists extensible workflow status codes. Filter by resource when populating controls for a specific workflow.

Use code for comparisons and name for display. A terminal status marks a completed lifecycle state, but does not by itself imply that every mutation is prohibited; consult the resource operation rules.

Parameters

Name In Required Type Description
tenant_id path Yes string (uuid) UUID of the authorized company group.
subsidiary_id path Yes string (uuid) UUID of the subsidiary whose books contain the bank account.
resource query No string Resource family such as invoice or fixed_asset.
page query No integer
per_page query No integer

Request

GET /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/statuses HTTP/1.1
Host: api.finov.io
Authorization: Bearer {access_token}

Responses

Status Description
200 A page of accounting status values.
401 Access token is missing, expired, revoked, or invalid.
403 Token lacks the required scope or granted accounting context.
422 One or more supplied values failed validation.

200 example

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": [
    {
      "resource": "invoice",
      "code": "DRAFT",
      "name": "Draft",
      "terminal": false
    },
    {
      "resource": "invoice",
      "code": "AUTHORISED",
      "name": "Authorised",
      "terminal": false
    },
    {
      "resource": "invoice",
      "code": "VOIDED",
      "name": "Voided",
      "terminal": true
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 30,
    "last_page": 1,
    "total": 3
  }
}