List the organization's active companies (legal entities), default first

GET

/companies

const url = 'https://api.invogi.com/v1/companies?include_archived=false';
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/companies?include_archived=false' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

include_archived

boolean

Responses

200

Companies and the plan’s company allowance

application/json

object

items

required

Array<object>

object

required

string format: uuid

name

required

string

legal_name

string | null

country_code

string | null

>= 2 characters <= 2 characters

vat_id

string | null

registration_id

string | null

is_default

required

boolean

archived_at

string | null format: date-time

created_at

string format: date-time

invoice_rematch

Returned when creating, restoring, or setting the VAT ID of a company: what happened to BUYER_UNMATCHED invoices naming that VAT ID. The company is saved regardless of the outcome. Invoices already in the company are confirmed during the request; moves from other companies run as a background job (QUEUED), or inline where no queue is available (COMPLETED / FAILED). FAILED leaves those invoices flagged; setting the VAT ID again retries.

object

status

required

string

Allowed values: QUEUED COMPLETED FAILED

confirmed

required

Already in this company; flag cleared

integer

moved

Moved here from another company (COMPLETED only)

integer

skipped

Matched to a purchase order of their current company; still flagged (COMPLETED only)

integer

remaining

Beyond the inline run’s batch of 100; set the VAT ID again to continue (COMPLETED only)

integer

limit

required

Active companies the plan allows (1 included + purchased additional companies)

integer

used

required

integer

Example

{
  "items": [
    {
      "invoice_rematch": {
        "status": "QUEUED"
      }
    }
  ]
}

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"
  }
}