Apideck · Schema

AccountingLocation

IntegrationsUnified API

Properties

Name Type Description
id object
parent_id object
display_id object
downstream_id object
company_name object
display_name string The display name of the location.
status string Based on the status some functionality is enabled or disabled.
addresses array
subsidiaries array
custom_mappings object
row_version object
updated_by object
created_by object
updated_at object
created_at object
pass_through object
View JSON Schema on GitHub

JSON Schema

apideck-accountinglocation-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AccountingLocation",
  "title": "AccountingLocation",
  "type": "object",
  "x-apideck-schema-id": "AccountingLocation",
  "x-apideck-weights": {
    "id": "medium",
    "parent_id": "low",
    "company_name": "medium",
    "display_name": "critical",
    "display_id": "medium",
    "downstream_id": "low",
    "status": "critical",
    "addresses": "low",
    "subsidiaries": "low"
  },
  "additionalProperties": false,
  "properties": {
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "parent_id": {
      "$ref": "#/components/schemas/WritableId"
    },
    "display_id": {
      "$ref": "#/components/schemas/DisplayId"
    },
    "downstream_id": {
      "$ref": "#/components/schemas/DownstreamId"
    },
    "company_name": {
      "$ref": "#/components/schemas/CompanyName"
    },
    "display_name": {
      "type": "string",
      "title": "Location display name",
      "description": "The display name of the location.",
      "example": "11 UT - South Jordan",
      "nullable": true
    },
    "status": {
      "type": "string",
      "title": "Location status",
      "description": "Based on the status some functionality is enabled or disabled.",
      "x-apideck-enum-id": "location.status",
      "enum": [
        "active",
        "inactive"
      ],
      "example": "active"
    },
    "addresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Address"
      }
    },
    "subsidiaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubsidiaryReference"
      }
    },
    "custom_mappings": {
      "$ref": "#/components/schemas/CustomMappings"
    },
    "row_version": {
      "$ref": "#/components/schemas/RowVersion"
    },
    "updated_by": {
      "$ref": "#/components/schemas/UpdatedBy"
    },
    "created_by": {
      "$ref": "#/components/schemas/CreatedBy"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "pass_through": {
      "$ref": "#/components/schemas/PassThroughBody"
    }
  }
}