Jump to

• Request
• Response

Get action not supported

get

/fscmRestApi/resources/11.13.18.05/studentAccounts

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • AccountFinder: Find the student account that matches the party ID.
    Finder Variables:
    • PartyId; integer; Unique identifier for a student account.
  • PrimaryKey: Finds all student accounts matching the primary key criteria specified.
    Finder Variables:
    • AccountId; integer; Unique identifier for a student account.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AccountId; integer; Unique identifier for the account created for a student.
  • AccountNumber; string; Unique student account number assigned for display purposes.
  • AllowManualPaymentFlag; boolean; Indicates that the manual payment is allowed. The default value is false.
  • BalanceAmount; number; Total amount due on the student account.
  • BankAccountSupportFlag; boolean; Indicates whether the student can make a payment using their bank account details.
  • BusinessUnitId; integer; Unique identifier for a business unit.
  • BusinessUnitName; string; Name of the business unit.
  • CountryCode; string; A short alphabetic code representing the country that is used as the default address.
  • CreditCardSupportFlag; boolean; Indicates whether the student can make a payment using his credit card.
  • CurrencyCode; string; Currency code associated with the business unit.
  • CurrencySymbol; string; Currency symbol associated with the currency code.
  • CustomerAccountSiteUseId; integer; Unique identifier for the customer account site to be used for billing purposes. For example, student's home address instead of the dormitory address.
  • DueAmount; number; Amount due from the student.
  • DueDate; string; The date when the student must pay an amount due.
  • LastPaymentAmount; number; Amount of the last payment received from the student.
  • LastPaymentDate; string; The date when the last payment was received from the student.
  • ManualPaymentInformation; string; The detailed description for the manual payment.
  • PartySiteId; integer; Unique identifier of the party site, matching the customer account site. Primarily used to identify the default credit card address for making a payment.
  • PaymentOptionCode; string; The code of the payment option. Examples are ORA_IBY_CYBERSOURCE or ORA_OTHER_SERVICE_PROVIDER.
  • StudentPartyId; integer; Unique identifier for a student.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : studentAccounts

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/studentAccounts-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object studentAccounts-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/studentAccounts-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : studentAccounts-item-response

Type: object

Show Source

• AccountId: integer
  Unique identifier for the account created for a student.
• AccountNumber: string
  Unique student account number assigned for display purposes.
• accountRelationships: array Account Relationships
  Title: Account Relationships

  The account relationships resource is a child of the student accounts resource. It lists the financial accounts that are actively related to this student account.
• AllowManualPaymentFlag: boolean
  Maximum Length: 255

  Indicates that the manual payment is allowed. The default value is false.
• BalanceAmount: number
  Total amount due on the student account.
• BankAccountSupportFlag: boolean
  Indicates whether the student can make a payment using their bank account details.
• bills: array Bills
  Title: Bills

  The bills resource is a child of the student accounts resource and provides a list of bill numbers for a student account.
• BusinessUnitId: integer
  Unique identifier for a business unit.
• BusinessUnitName: string
  Name of the business unit.
• CountryCode: string
  Maximum Length: 255

  A short alphabetic code representing the country that is used as the default address.
• CreditCardSupportFlag: boolean
  Indicates whether the student can make a payment using his credit card.
• CurrencyCode: string
  Currency code associated with the business unit.
• CurrencySymbol: string
  Currency symbol associated with the currency code.
• CustomerAccountSiteUseId: integer
  Unique identifier for the customer account site to be used for billing purposes. For example, student's home address instead of the dormitory address.
• DueAmount: number
  Amount due from the student.
• DueDate: string (date)
  The date when the student must pay an amount due.
• LastPaymentAmount: number
  Amount of the last payment received from the student.
• LastPaymentDate: string (date)
  The date when the last payment was received from the student.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualPaymentInformation: string
  Read Only: true

  Maximum Length: 255

  The detailed description for the manual payment.
• PartySiteId: integer
  Unique identifier of the party site, matching the customer account site. Primarily used to identify the default credit card address for making a payment.
• PaymentOptionCode: string
  Maximum Length: 255

  The code of the payment option. Examples are ORA_IBY_CYBERSOURCE or ORA_OTHER_SERVICE_PROVIDER.
• StudentPartyId: integer
  Unique identifier for a student.
• transactionApplications: array Transaction Applications
  Title: Transaction Applications

  The transaction applications resource is a child of the student accounts resource. It lists all the payments applied to a charge for a student account.
• transactions: array Transactions
  Title: Transactions

  The transactions resource is a child of the student accounts resource and provides a list of charges and payments for a student account.

{
    "type":"object",
    "properties":{
        "CreditCardSupportFlag":{
            "type":"boolean",
            "description":"Indicates whether the student can make a payment using his credit card.",
            "nullable":true,
            "x-queryable":true
        },
        "BankAccountSupportFlag":{
            "type":"boolean",
            "description":"Indicates whether the student can make a payment using their bank account details.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountId":{
            "type":"integer",
            "description":"Unique identifier for the account created for a student.",
            "nullable":true,
            "x-queryable":true
        },
        "DueAmount":{
            "type":"number",
            "description":"Amount due from the student.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentOptionCode":{
            "maxLength":255,
            "type":"string",
            "description":"The code of the payment option. Examples are ORA_IBY_CYBERSOURCE or ORA_OTHER_SERVICE_PROVIDER.",
            "nullable":true,
            "x-queryable":true
        },
        "accountRelationships":{
            "title":"Account Relationships",
            "type":"array",
            "description":"The account relationships resource is a child of the student accounts resource. It lists the financial accounts that are actively related to this student account.",
            "items":{
                "$ref":"#/components/schemas/studentAccounts-accountRelationships-item-response"
            }
        },
        "CurrencySymbol":{
            "type":"string",
            "description":"Currency symbol associated with the currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"Currency code associated with the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySiteId":{
            "type":"integer",
            "description":"Unique identifier of the party site, matching the customer account site. Primarily used to identify the default credit card address for making a payment.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "bills":{
            "title":"Bills",
            "type":"array",
            "description":"The bills resource is a child of the student accounts resource and provides a list of bill numbers for a student account.",
            "items":{
                "$ref":"#/components/schemas/studentAccounts-bills-item-response"
            }
        },
        "BusinessUnitName":{
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "DueDate":{
            "type":"string",
            "description":"The date when the student must pay an amount due.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountSiteUseId":{
            "type":"integer",
            "description":"Unique identifier for the customer account site to be used for billing purposes. For example, student's home address instead of the dormitory address.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryCode":{
            "maxLength":255,
            "type":"string",
            "description":"A short alphabetic code representing the country that is used as the default address.",
            "nullable":true,
            "x-queryable":true
        },
        "transactionApplications":{
            "title":"Transaction Applications",
            "type":"array",
            "description":"The transaction applications resource is a child of the student accounts resource.  It lists all the payments applied to a charge for a student account.",
            "items":{
                "$ref":"#/components/schemas/studentAccounts-transactionApplications-item-response"
            }
        },
        "AllowManualPaymentFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates that the manual payment is allowed. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceAmount":{
            "type":"number",
            "description":"Total amount due on the student account.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Unique identifier for a business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "LastPaymentDate":{
            "type":"string",
            "description":"The date when the last payment was received from the student.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StudentPartyId":{
            "type":"integer",
            "description":"Unique identifier for a student.",
            "nullable":true,
            "x-queryable":true
        },
        "transactions":{
            "title":"Transactions",
            "type":"array",
            "description":"The transactions resource is a child of the student accounts resource and provides a list of charges and payments for a student account.",
            "items":{
                "$ref":"#/components/schemas/studentAccounts-transactions-item-response"
            }
        },
        "AccountNumber":{
            "type":"string",
            "description":"Unique student account number assigned for display purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "LastPaymentAmount":{
            "type":"number",
            "description":"Amount of the last payment received from the student.",
            "nullable":true,
            "x-queryable":true
        },
        "ManualPaymentInformation":{
            "maxLength":255,
            "type":"string",
            "description":"The detailed description for the manual payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Account Relationships

Type: array

Title: Account Relationships

The account relationships resource is a child of the student accounts resource. It lists the financial accounts that are actively related to this student account.

Show Source

• Array of: object studentAccounts-accountRelationships-item-response

{
    "title":"Account Relationships",
    "type":"array",
    "description":"The account relationships resource is a child of the student accounts resource. It lists the financial accounts that are actively related to this student account.",
    "items":{
        "$ref":"#/components/schemas/studentAccounts-accountRelationships-item-response"
    }
}

Nested Schema : Bills

Type: array

Title: Bills

The bills resource is a child of the student accounts resource and provides a list of bill numbers for a student account.

Show Source

• Array of: object studentAccounts-bills-item-response

{
    "title":"Bills",
    "type":"array",
    "description":"The bills resource is a child of the student accounts resource and provides a list of bill numbers for a student account.",
    "items":{
        "$ref":"#/components/schemas/studentAccounts-bills-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Transaction Applications

Type: array

Title: Transaction Applications

The transaction applications resource is a child of the student accounts resource. It lists all the payments applied to a charge for a student account.

Show Source

• Array of: object studentAccounts-transactionApplications-item-response

{
    "title":"Transaction Applications",
    "type":"array",
    "description":"The transaction applications resource is a child of the student accounts resource.  It lists all the payments applied to a charge for a student account.",
    "items":{
        "$ref":"#/components/schemas/studentAccounts-transactionApplications-item-response"
    }
}

Nested Schema : Transactions

Type: array

Title: Transactions

The transactions resource is a child of the student accounts resource and provides a list of charges and payments for a student account.

Show Source

• Array of: object studentAccounts-transactions-item-response

{
    "title":"Transactions",
    "type":"array",
    "description":"The transactions resource is a child of the student accounts resource and provides a list of charges and payments for a student account.",
    "items":{
        "$ref":"#/components/schemas/studentAccounts-transactions-item-response"
    }
}

Nested Schema : studentAccounts-accountRelationships-item-response

Type: object

Show Source

• CustomerAccountRelationshipId: integer (int64)
  Read Only: true

  The unique identifier of the account relationship.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RelatedCustomerAccountId: integer (int64)
  Read Only: true

  The unique identifier of the learner's account.
• RelationshipType: string
  Title: Relationship Type

  Read Only: true

  Maximum Length: 30

  Indicates the relationship type of a customer to a learner. The default value is "Parent".

{
    "type":"object",
    "properties":{
        "CustomerAccountRelationshipId":{
            "type":"integer",
            "description":"The unique identifier of the account relationship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the relationship type of a customer to a learner. The default value is \"Parent\".",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RelatedCustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the learner's account.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : studentAccounts-bills-item-response

Type: object

Show Source

• BalanceAmount: number
  Read Only: true

  The total current amount due remaining in this bill.
• BillingDate: string (date)
  Read Only: true

  The date when balance forward transactions are billed.
• BillNumber: string
  Read Only: true

  Maximum Length: 30

  Consolidated billing invoice number.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Currency code of the transaction.
• CurrencySymbol: string
  Read Only: true

  Maximum Length: 12

  Currency symbol associated with the currency code.
• DueDate: string (date)
  Read Only: true

  The date when this bill is due.
• EventDate: string (date)
  Read Only: true

  The date when a communication event is triggered.
• FormattedAmount: string
  Read Only: true

  The formatted amount to be displayed to recipient.
• Institution: string
  Read Only: true

  Maximum Length: 255

  The institution sending the communication.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonFirstName: string
  Read Only: true

  Maximum Length: 255

  The preferred first name of the recipient.
• PersonLastName: string
  Read Only: true

  Maximum Length: 255

  The preferred last name of the recipient.
• PreferredName: string
  Read Only: true

  Maximum Length: 255

  The preferred full name of the recipient.
• RecipientId: integer (int64)
  Read Only: true

  Unique identifier of the recipient of the bill communication.
• Report: string (byte)
  Read Only: true

  The business intelligence publisher report containing the information for this bill.
• ViewBillURL: string
  Read Only: true

  The token to hold the URL of bill.

{
    "type":"object",
    "properties":{
        "EventDate":{
            "type":"string",
            "description":"The date when a communication event is triggered.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceAmount":{
            "type":"number",
            "description":"The total current amount due remaining in this bill.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientId":{
            "type":"integer",
            "description":"Unique identifier of the recipient of the bill communication.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonLastName":{
            "maxLength":255,
            "type":"string",
            "description":"The preferred last name of the recipient.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Report":{
            "type":"string",
            "description":"The business intelligence publisher report containing the information for this bill.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ViewBillURL":{
            "type":"string",
            "description":"The token to hold the URL of bill.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAmount":{
            "type":"string",
            "description":"The formatted amount to be displayed to recipient.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingDate":{
            "type":"string",
            "description":"The date when balance forward transactions are billed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Institution":{
            "maxLength":255,
            "type":"string",
            "description":"The institution sending the communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"The preferred first name of the recipient.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Consolidated billing invoice number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "maxLength":12,
            "type":"string",
            "description":"Currency symbol associated with the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PreferredName":{
            "maxLength":255,
            "type":"string",
            "description":"The preferred full name of the recipient.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DueDate":{
            "type":"string",
            "description":"The date when this bill is due.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : studentAccounts-transactionApplications-item-response

Type: object

Show Source

• ApplicationDate: string (date)
  Read Only: true

  The date when a payment was applied to a charge.
• AppliedAmount: number
  Title: Applied Amount

  Read Only: true

  Payment amount applied to the charge.
• AppliedTransactionId: integer (int64)
  Read Only: true

  Unique identifier for the charge being paid for.
• AppliedTransactionNumber: string
  Read Only: true

  Maximum Length: 20

  Transaction number of the charge being paid for.
• AppliedTrxDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the charge being paid for.
• CreditDescription: string
  Read Only: true

  Maximum Length: 30

  Description of the payment applying to a charge.
• CreditTransactionId: integer (int64)
  Read Only: true

  Unique identifier for the payment applying to a charge.
• CreditTransactionNumber: string
  Read Only: true

  Maximum Length: 30

  Unique transaction number used for the payment of a charge.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  Currency code of the charge.
• CurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  Maximum Length: 12

  Currency symbol associated with the currency code.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaidBy: string
  This shows the names of the proxies who made the payment. A single invoice records the amount paid by multiple proxies.
• PaidFor: string
  This shows the names of the users whose bills were paid by a proxy. A single receipt acknowledges the payment.
• StatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  Status of payment application.
• TransactionApplicationId: integer
  Read Only: true

  Unique identifier for the transaction application.

{
    "type":"object",
    "properties":{
        "AppliedTransactionId":{
            "type":"integer",
            "description":"Unique identifier for the charge being paid for.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditTransactionId":{
            "type":"integer",
            "description":"Unique identifier for the payment applying to a charge.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AppliedAmount":{
            "title":"Applied Amount",
            "type":"number",
            "description":"Payment amount applied to the charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaidBy":{
            "type":"string",
            "description":"This shows the names of the proxies who made the payment. A single invoice records the amount paid by multiple proxies.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationDate":{
            "type":"string",
            "description":"The date when a payment was applied to a charge.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of payment application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":12,
            "type":"string",
            "description":"Currency symbol associated with the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionApplicationId":{
            "type":"integer",
            "description":"Unique identifier for the transaction application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AppliedTrxDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the charge being paid for.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaidFor":{
            "type":"string",
            "description":"This shows the names of the users whose bills were paid by a proxy. A single receipt acknowledges the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditTransactionNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Unique transaction number used for the payment of a charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AppliedTransactionNumber":{
            "maxLength":20,
            "type":"string",
            "description":"Transaction number of the charge being paid for.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditDescription":{
            "maxLength":30,
            "type":"string",
            "description":"Description of the payment applying to a charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : studentAccounts-transactions-item-response

Type: object

Show Source

• AcademicPeriodId: string
  Title: Academic Period ID

  Read Only: true

  Maximum Length: 30

  Unique identifier for an academic period.
• AcademicPeriodName: string
  Read Only: true

  Name of the academic period in which student is enrolled.
• AcademicSubjectCode: string
  Title: Subject Code

  Read Only: true

  Maximum Length: 30

  Unique identifier for the subject of the scheduled course.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the transaction is posted.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  Currency code of the transaction.
• CurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  Maximum Length: 12

  Currency symbol associated with the currency code.
• CurriculumCatalogNumber: string
  Title: Catalog Number

  Read Only: true

  Maximum Length: 10

  Catalog number of the scheduled course.
• CurriculumId: string
  Title: Curriculum ID

  Read Only: true

  Maximum Length: 120

  Unique identifier of a scheduled course.
• CurriculumName: string
  Title: Curriculum Name

  Read Only: true

  Maximum Length: 50

  Name of the scheduled course student is enrolled in.
• EnrollmentId: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for student enrollment in a scheduled course.
• IndicatorMessage: string
  Message that indicates payment was made on behalf of a user.
• InstitutionId: string
  Title: Institution ID

  Read Only: true

  Maximum Length: 30

  Unique identifier for an institution.
• InstitutionName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  Name of the institution to which the scheduled course belongs.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwningCurriculumName: string
  Title: Owning Name

  Read Only: true

  Maximum Length: 50

  Translated name for the parent curriculum item of the scheduled course.
• ProgramCurriculumId: number
  Read Only: true

  Curriculum ID of the program to which fee is attached.
• ProgramName: string
  Read Only: true

  Maximum Length: 50

  Name of the program to which fee is attached.
• ReportingAcademicPeriodId: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for a reporting academic period.
• ReportingAcademicPeriodName: string
  Read Only: true

  Name of the reporting academic period in which student is enrolled.
• ScheduledCourseCode: string
  Read Only: true

  Maximum Length: 30

  Unique code of the scheduled course.
• StatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  Indicates the status of the receipt, such as cleared or reversed.
• transactionActivities: array Transaction Activities
  Title: Transaction Activities

  The transaction activities resource is a child of the transactions resource. For a charge, it lists the initial charge details and any changes in the amount of the charge, such as a charge reversal, or a discount. For a payment, it lists any refunds emanating from that payment.
• TransactionAmount: number
  Title: Transaction Amount

  Read Only: true

  Actual amount of the transaction.
• TransactionBalanceAmount: number
  Title: Balance

  Read Only: true

  Balance amount on the transaction.
• TransactionClassCode: string
  Read Only: true

  Maximum Length: 20

  Identifies the type of transaction, such as invoice or receipt.
• TransactionDate: string (date)
  Title: Transaction Date

  Read Only: true

  The date when the transaction originated.
• TransactionDescription: string
  Read Only: true

  Maximum Length: 240

  The description of the transaction.
• TransactionId: integer
  Read Only: true

  Unique identifier for a transaction.
• TransactionNumber: string
  Title: Transaction Number

  Read Only: true

  Maximum Length: 30

  User-defined number used to identify a transaction in accounts receivable.

{
    "type":"object",
    "properties":{
        "OwningCurriculumName":{
            "title":"Owning Name",
            "maxLength":50,
            "type":"string",
            "description":"Translated name for the parent curriculum item of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumCatalogNumber":{
            "title":"Catalog Number",
            "maxLength":10,
            "type":"string",
            "description":"Catalog number of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramCurriculumId":{
            "type":"number",
            "description":"Curriculum ID of the program to which fee is attached.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the transaction is posted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionNumber":{
            "title":"Transaction Number",
            "maxLength":30,
            "type":"string",
            "description":"User-defined number used to identify a transaction in accounts receivable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionBalanceAmount":{
            "title":"Balance",
            "type":"number",
            "description":"Balance amount on the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Curriculum Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the scheduled course student is enrolled in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the receipt, such as cleared or reversed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportingAcademicPeriodName":{
            "type":"string",
            "description":"Name of the reporting academic period in which student is enrolled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":12,
            "type":"string",
            "description":"Currency symbol associated with the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionClassCode":{
            "maxLength":20,
            "type":"string",
            "description":"Identifies the type of transaction, such as invoice or receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportingAcademicPeriodId":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for a reporting academic period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for an academic period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date when the transaction originated.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the institution to which the scheduled course belongs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for an institution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique code of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionActivities":{
            "title":"Transaction Activities",
            "type":"array",
            "description":"The transaction activities resource is a child of the transactions resource.  For a charge, it lists the initial charge details and any changes in the amount of the charge, such as a charge reversal, or a discount.  For a payment, it lists any refunds emanating from that payment.",
            "items":{
                "$ref":"#/components/schemas/studentAccounts-transactions-transactionActivities-item-response"
            }
        },
        "ProgramName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the program to which fee is attached.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Unique identifier for a transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IndicatorMessage":{
            "type":"string",
            "description":"Message that indicates payment was made on behalf of a user.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionAmount":{
            "title":"Transaction Amount",
            "type":"number",
            "description":"Actual amount of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectCode":{
            "title":"Subject Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the subject of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "maxLength":120,
            "type":"string",
            "description":"Unique identifier of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollmentId":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for student enrollment in a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodName":{
            "type":"string",
            "description":"Name of the academic period in which student is enrolled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Transaction Activities

Type: array

Title: Transaction Activities

The transaction activities resource is a child of the transactions resource. For a charge, it lists the initial charge details and any changes in the amount of the charge, such as a charge reversal, or a discount. For a payment, it lists any refunds emanating from that payment.

Show Source

• Array of: object studentAccounts-transactions-transactionActivities-item-response

{
    "title":"Transaction Activities",
    "type":"array",
    "description":"The transaction activities resource is a child of the transactions resource.  For a charge, it lists the initial charge details and any changes in the amount of the charge, such as a charge reversal, or a discount.  For a payment, it lists any refunds emanating from that payment.",
    "items":{
        "$ref":"#/components/schemas/studentAccounts-transactions-transactionActivities-item-response"
    }
}

Nested Schema : studentAccounts-transactions-transactionActivities-item-response

Type: object

Show Source

• ActivityAmount: number
  Read Only: true

  Amount of the transaction activity.
• ActivityDescription: string
  Read Only: true

  Maximum Length: 960

  Description of the charge or receipt. Examples are tuition, housing, or cash.
• ActivityTypeCode: string
  Read Only: true

  Maximum Length: 80

  Code to identify the type of activity.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the transaction occurred.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  Currency code of the activity.
• CurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  Maximum Length: 12

  Currency symbol associated with the currency code.
• DueDate: string (date)
  Title: Due Date

  Read Only: true

  The date when the charge is due.
• LineNumber: number
  Read Only: true

  Line number of the transaction activity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TransactionActivityId: integer
  Read Only: true

  Unique identifier for a transaction activity.
• TransactionClassCode: string
  Read Only: true

  Maximum Length: 3

  Identifies the type of transaction.
• TransactionDate: string (date)
  Title: Transaction Date

  Read Only: true

  The date when the transaction occurred.
• TransactionId: integer (int64)
  Read Only: true

  Unique identifier for a transaction.
• TransactionNumber: string
  Title: Transaction Number

  Read Only: true

  Maximum Length: 30

  User-defined number used to identify a transaction in accounts receivable.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the transaction occurred.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionNumber":{
            "title":"Transaction Number",
            "maxLength":30,
            "type":"string",
            "description":"User-defined number used to identify a transaction in accounts receivable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityTypeCode":{
            "maxLength":80,
            "type":"string",
            "description":"Code to identify the type of activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityDescription":{
            "maxLength":960,
            "type":"string",
            "description":"Description of the charge or receipt. Examples are tuition, housing, or cash.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityAmount":{
            "type":"number",
            "description":"Amount of the transaction activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionActivityId":{
            "type":"integer",
            "description":"Unique identifier for a transaction activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineNumber":{
            "type":"number",
            "description":"Line number of the transaction activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":12,
            "type":"string",
            "description":"Currency symbol associated with the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Unique identifier for a transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionClassCode":{
            "maxLength":3,
            "type":"string",
            "description":"Identifies the type of transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date when the charge is due.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date when the transaction occurred.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top