Organization Object
Root Connection
All Organization objects of an account are accessible by a query on the root connection organizations
.
Such a query will return a OrganizationConnection!
, which contains the Organization objects in its
nodes
field.
OrganizationConnection!
)
Root connection for retrieving Organization records.
Argument | Type | Description |
---|---|---|
after |
String
|
Returns the elements in the list that come after the specified cursor. |
before |
String
|
Returns the elements in the list that come before the specified cursor. |
filter |
OrganizationFilter
|
Filter to determine which Organization records are returned. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
order |
[OrganizationOrder!]
|
Order of the Organization records returned. |
view |
OrganizationView
|
View name. The default value is |
Fields
The fields in this section list which values can be retrieved when querying Organization records.
Account
)
The account this record belongs to.
Boolean
)
Whether the organization needs to be treated as a separate entity from a reporting perspective. This checkbox is only available for internal organizations.
Organization
)
Refers to itself if the organization is a business unit, or refers to the business unit that the organization belongs to.
ISO8601Timestamp
)
The date and time at which the record was created.
[CustomField!]
)
Values of custom fields.
Boolean
)
Whether the organization may no longer be related to other records.
Boolean
)
Whether end users from this organization should be prevented from seeing information of other end users.
String
)
The unique identifier by which the organization is known in the financial system.
ID!
)
Unique identifier of the record.
Person
)
The manager of the organization.
String
)
The full name of the organization.
RequestTemplate
)
Refers to the order template that is used for purchases of people defined in this organization or its descendants.
Organization
)
The organization's parent organization.
String
)
The hyperlink to the image file for the record.
String
)
Which region the organization belongs to. Examples of commonly used region names are:
- Asia Pacific (APAC)
- Europe, Middle East & Africa (EMEA)
- North America (NA)
String
)
Any additional information about the organization that might prove useful.
String
)
An identifier for the client application submitting the resource or the name of an external system.
String
)
The unique identifier of the resource in an external system.
Person
)
The person who acts as the substitute of the organization's manager.
UiExtension
)
UI extension that is linked to the record.
ISO8601Timestamp
)
The date and time of the last update of the record. If the record has no updates it contains the createdAt
value.
Connections
The connection fields in this section allow (paged) access to objects related to a specific Organization record.
The actual objects will be in the nodes
field of the connection.
AddressConnection
)
Addresses of the record.
Argument | Type | Description |
---|---|---|
after |
String
|
Returns the elements in the list that come after the specified cursor. |
before |
String
|
Returns the elements in the list that come before the specified cursor. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
OrganizationConnection
)
Child organizations of this organization, i.e. organizations that have this organization as their parent.
Argument | Type | Description |
---|---|---|
after |
String
|
Returns the elements in the list that come after the specified cursor. |
before |
String
|
Returns the elements in the list that come before the specified cursor. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
ContactConnection
)
Contact details for this entity.
Argument | Type | Description |
---|---|---|
after |
String
|
Returns the elements in the list that come after the specified cursor. |
before |
String
|
Returns the elements in the list that come before the specified cursor. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
ContractConnection
)
Contracts of this organization.
Argument | Type | Description |
---|---|---|
after |
String
|
Returns the elements in the list that come after the specified cursor. |
before |
String
|
Returns the elements in the list that come before the specified cursor. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
AttachmentConnection
)
Inline images linked to one of the custom fields.
Argument | Type | Description |
---|---|---|
after |
String
|
Returns the elements in the list that come after the specified cursor. |
before |
String
|
Returns the elements in the list that come before the specified cursor. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
PersonConnection
)
People of this organization.
Argument | Type | Description |
---|---|---|
after |
String
|
Returns the elements in the list that come after the specified cursor. |
before |
String
|
Returns the elements in the list that come before the specified cursor. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
AttachmentConnection
)
Files and inline images linked to the Remarks field.
Argument | Type | Description |
---|---|---|
after |
String
|
Returns the elements in the list that come after the specified cursor. |
before |
String
|
Returns the elements in the list that come before the specified cursor. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
RiskConnection
)
Risks of this organization.
Argument | Type | Description |
---|---|---|
after |
String
|
Returns the elements in the list that come after the specified cursor. |
before |
String
|
Returns the elements in the list that come before the specified cursor. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
ServiceLevelAgreementConnection
)
Service level agreements which coverage field is set to organizations
and which cover the organization.
Argument | Type | Description |
---|---|---|
after |
String
|
Returns the elements in the list that come after the specified cursor. |
before |
String
|
Returns the elements in the list that come before the specified cursor. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
TimeAllocationConnection
)
Time allocations of this organization.
Argument | Type | Description |
---|---|---|
after |
String
|
Returns the elements in the list that come after the specified cursor. |
before |
String
|
Returns the elements in the list that come before the specified cursor. |
first |
Int
|
Returns the first n elements from the list. |
last |
Int
|
Returns the last n elements from the list. |
Implements
Organization implements the following interfaces. This means that fragments defined on these interfaces may be used in queries returning a Organization.