---
updatedAt: 2026-08-21T05:01:21.000Z
agentTools:
  projectIndex: https://developer.avinodegroup.com/llms.txt
---

# Read a system for the current company by unique ID

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Paynode API",
    "version": "2026-11-12T06:11:40.521311568Z"
  },
  "externalDocs": {
    "description": "Avinode Group Devportal",
    "url": "https://developer.avinodegroup.com"
  },
  "servers": [
    {
      "url": "https://sandbox.avinode.com/payapi",
      "description": "Paynode (development)"
    },
    {
      "url": "https://sandbox.avinode.com/api",
      "description": "Avinode (development)"
    }
  ],
  "security": [
    {
      "Bearer": []
    }
  ],
  "tags": [
    {
      "name": "Companies",
      "description": ""
    }
  ],
  "paths": {
    "/systems/{systemId}": {
      "get": {
        "tags": [
          "Companies"
        ],
        "summary": "Read a system for the current company by unique ID",
        "operationId": "readExternalSystem",
        "parameters": [
          {
            "name": "systemId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-Avinode-SentTimestamp",
            "in": "header",
            "description": "ISO8601 Timestamp",
            "schema": {}
          },
          {
            "name": "X-Avinode-ApiToken",
            "in": "header",
            "description": "API Token",
            "required": false,
            "schema": {}
          },
          {
            "name": "X-Avinode-Product",
            "in": "header",
            "description": "Calling product / software (ex: AcmeApp-v10.2)",
            "schema": {}
          }
        ],
        "responses": {
          "default": {
            "description": "default response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResourceRestServerResponseCompanySystemResource"
                }
              }
            }
          }
        },
        "security": [
          {
            "Bearer": []
          }
        ],
        "x-avi-products": {
          "Avinode": "true",
          "SchedAero": "true",
          "Paynode": "true"
        }
      },
      "servers": [
        {
          "url": "https://sandbox.avinode.com/api",
          "description": "Avinode (development)"
        }
      ]
    }
  },
  "components": {
    "schemas": {
      "ActionLinkJSON": {
        "type": "object",
        "description": "A link describing an action that can be performed on the parent object.",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of action"
          },
          "description": {
            "type": "string",
            "description": "A description of what this action is intended to do"
          },
          "httpMethod": {
            "type": "string",
            "description": "The HTTP method expected by the resource at the target URI"
          },
          "href": {
            "type": "string",
            "description": "The URI for invoking the action"
          }
        }
      },
      "CompanySystemResource": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "A unique identifier for this resource"
          },
          "href": {
            "type": "string",
            "description": "A URI at which this resource may be read"
          },
          "type": {
            "type": "string",
            "description": "The type of resource"
          },
          "links": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/ResourceLinkJSON"
              }
            },
            "description": "Associated links related to this resource"
          },
          "actions": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/ActionLinkJSON"
            },
            "description": "Associated actions related to this resource"
          },
          "name": {
            "type": "string",
            "description": "A name for the system.  This must be unique within the scope of the owning company."
          },
          "active": {
            "type": "boolean",
            "description": "Is this system active?"
          }
        },
        "required": [
          "active",
          "name"
        ]
      },
      "MessageJSON": {
        "type": "object",
        "description": "A single message, could be either an error, warning or a info message.",
        "externalDocs": {
          "url": "https://jsonapi.org/format/#error-objects"
        },
        "properties": {
          "title": {
            "type": "string",
            "description": "a short, human-readable summary of the message"
          },
          "code": {
            "type": "string",
            "description": "an application-specific code, expressed as a string value"
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "deprecated": true,
            "description": "The HTTP status code applicable to this message, expressed as a string value"
          },
          "detail": {
            "type": "string",
            "description": "a human-readable explanation specific to this occurrence of the message"
          },
          "technicalDetail": {
            "type": "string",
            "description": "a human-readable technical explanation intended for technical staff (not end-users)"
          },
          "path": {
            "type": "string",
            "description": "if this message related to a property in the input, the path to the input property in the message"
          }
        },
        "required": [
          "code",
          "title"
        ]
      },
      "MetadataJSON": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "description": "Error messages for this response.",
            "items": {
              "$ref": "#/components/schemas/MessageJSON"
            }
          },
          "warnings": {
            "type": "array",
            "description": "Warning messages for this response.",
            "items": {
              "$ref": "#/components/schemas/MessageJSON"
            }
          },
          "infos": {
            "type": "array",
            "description": "Information messages for this response.",
            "items": {
              "$ref": "#/components/schemas/MessageJSON"
            }
          },
          "pagination": {
            "$ref": "#/components/schemas/PaginationJSON",
            "description": "Associated links related to this response"
          },
          "duplicatePOST": {
            "type": "boolean",
            "description": "Will be 'true' if Avinode detected a duplicate POST and replayed the original response"
          }
        }
      },
      "PaginationJSON": {
        "type": "object",
        "properties": {
          "totalCount": {
            "type": "integer",
            "format": "int64",
            "description": "The total number of results in the listing, or matching a search"
          },
          "pageNumber": {
            "type": "integer",
            "format": "int32",
            "description": "The page number"
          },
          "batchSize": {
            "type": "integer",
            "format": "int32",
            "description": "The number of results requested per page."
          }
        }
      },
      "ResourceLinkJSON": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "A unique identifier for this resource"
          },
          "href": {
            "type": "string",
            "description": "A URI at which this resource may be read"
          },
          "type": {
            "type": "string",
            "description": "The type of resource"
          },
          "links": {
            "description": "Associated links related to this resource"
          },
          "actions": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/ActionLinkJSON"
            },
            "description": "Associated actions related to this resource"
          },
          "displayName": {
            "type": "string",
            "description": "If this link is intended to be visually display, a display name to show."
          }
        }
      },
      "ResourceRestServerResponseCompanySystemResource": {
        "type": "object",
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/MetadataJSON",
            "description": "Metadata associated with the response (errors, warnings, etc.)"
          },
          "links": {
            "type": "object",
            "additionalProperties": {
              "type": "string",
              "format": "uri"
            },
            "description": "Associated links related to this response"
          },
          "data": {
            "$ref": "#/components/schemas/CompanySystemResource"
          }
        },
        "required": [
          "meta"
        ]
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    }
  }
}
```