Jump to

• Request
• Response

Get all on account payment data

get

/fscmRestApi/resources/11.13.18.05/publicSectorOnAccountPayments

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:
  
  

  • PrimaryKey: Finds on account payments that match the primary key criteria specified.
    Finder Variables:
    • OnaccountHistoryKey; integer; The unique identifier for the transaction.
  • simpleSearchFinder: Finds on account payments records that match the simple search finder criteria specified.
    Finder Variables:
    • value; string; The bind variable for the simple search finder.
• 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:
  

  • AdditionalReferenceId; string; The additional identifier provided along with the payment.
  • AdditionalReferenceType; string; The type of additional identifier provided along with the payment.
  • AgencyId; integer; The unique identifier of the agency associated with the on account record.
  • AmountDue; number; The PSCR payment amount on the payment history record.
  • AmountPaid; number; The PSCR payment received on the payment history record.
  • BusinessEntityDbaName; string; The PSCR business entity doing business as name on the payment history record.
  • BusinessEntityName; string; The PSCR business entity name on the payment history record.
  • CheckoutId; integer; Checkout identifier for the credit applied.
  • CreditAppliedFlag; string; Payment on account credit is applied.
  • FarCashReceiptId; integer; The identifier for the receipt in Fusion Receivables.
  • FarReceiptStatus; string; The status of the receipt in Fusion Receivables.
  • Meaning; string; The description for the Fusion Receivables receipt status.
  • MigratedDataFlag; string; Indicates whether the data is migrated from a legacy system.
  • OnAccountStatusDesc; string; Describes the on account status.
  • OnaccountAction; string; The action the user wants to take for the on account record.
  • OnaccountAmount; number; The amount that is held on account.
  • OnaccountCredit; number; Indicates the on account credit amount.
  • OnaccountCurrency; string; The currency of the amount held on account.
  • OnaccountDate; string; The date on which the payment was received.
  • OnaccountHistoryKey; integer; The unique identifier for the transaction.
  • OnaccountReasonCode; string; The reason payment was not applied to an invoice or a fee record.
  • OnaccountReferenceId; string; Combination value consisting of the ON prefix plus the value using the PSC GUID function. This value is passed to the calling app and displayed to the user.
  • OnaccountSource; string; The source of the record.
  • OnaccountStatus; string; The status of the on account record.
  • PartyId; integer; The party associated to the on account record.
  • PayerEmail; string; The PSCR payer email address on the payment history record.
  • PayerFirstName; string; The PSCR payer first name on the payment history record.
  • PayerLastName; string; The PSCR payer last name on the payment history record.
  • PayerMiddleName; string; The PSCR payer middle name on the payment history record.
  • PayerNameSuffix; string; The PSCR payer name suffix on the payment history record.
  • PaymentInstrumentDate; string; The date on the payment instrument.
  • PaymentInstrumentNumber; string; The payment instrument number that can identify the on account payment.
  • PaymentMethodCode; string; The PSCR payment method code.
  • PaymentReferenceId; string; The PSCR payment reference identifier on the payment history record.
  • PaymentTransactionId; string; The PSCR payment transaction identifier on the payment history record.
  • PrimaryReferenceId; string; The primary identifier provided along with the payment.
  • PrimaryReferenceType; string; The type of primary identifier provided along with the payment.
  • PrimaryTrackingData; string; The primary PSCR payment tracking data on the payment history record.
  • ProfileId; integer; The profile associated to the on account record.
  • RefundAmount; number; The amount to be refunded.
  • RefundCurrency; string; The currency of the refund amount.
  • RefundDate; string; The date the refund was initiated.
  • RefundMethodCode; string; The method used for the refund.
  • RefundReasonCode; string; The reason for the refund.
  • RefundReferenceId; string; The refund reference identifier.
  • RefundStatus; string; The status of the refund.
  • RequireAccounting; string; Indicates whether accounting entries should be created for the on account record.
  • ReversalFlag; string; Specifies whether the record is a reversal of an overpayment.
  • ReversalTransactionType; string; Indicates the type of reversal transaction.
  • SecondaryReferenceId; string; The secondary identifier provided along with the payment.
  • SecondaryReferenceType; string; The type of secondary identifier provided along with the payment.
  • SecondaryTrackingData; string; The secondary PSCR payment tracking data on the payment history record.
  • TrustAccountNumber; string; The PSCR trust account on the payment history record.
  • UnappliedFlag; string; Identifies the unapplied payment record.
• 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:
  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.

Body ()

Root Schema : publicSectorOnAccountPayments

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/publicSectorOnAccountPayments-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"BillingandPayment",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorOnAccountPayments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorOnAccountPayments-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 : publicSectorOnAccountPayments-item-response

Type: object

Show Source

• AdditionalReferenceId: string
  Title: Additional Reference ID

  Maximum Length: 50

  The additional identifier provided along with the payment.
• AdditionalReferenceType: string
  Title: Additional Reference Type

  Maximum Length: 30

  The type of additional identifier provided along with the payment.
• AgencyId: integer (int32)
  The unique identifier of the agency associated with the on account record.
• AmountDue: number
  Title: Amount Due

  The PSCR payment amount on the payment history record.
• AmountPaid: number
  The PSCR payment received on the payment history record.
• BusinessEntityDbaName: string
  Maximum Length: 100

  The PSCR business entity doing business as name on the payment history record.
• BusinessEntityName: string
  Maximum Length: 100

  The PSCR business entity name on the payment history record.
• CheckoutId: integer (int64)
  Checkout identifier for the credit applied.
• CreditAppliedFlag: string
  Title: Credit Applied

  Maximum Length: 1

  Default Value: N

  Payment on account credit is applied.
• FarCashReceiptId: integer (int64)
  Title: Receivables Receipt ID

  The identifier for the receipt in Fusion Receivables.
• FarReceiptStatus: string
  Maximum Length: 30

  The status of the receipt in Fusion Receivables.
• links: array Links
  Title: Links

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

  Maximum Length: 80

  The description for the Fusion Receivables receipt status.
• MigratedDataFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the data is migrated from a legacy system.
• OnaccountAction: string
  Title: On Account Action

  Maximum Length: 30

  The action the user wants to take for the on account record.
• OnaccountAmount: number
  Title: On Account Amount

  The amount that is held on account.
• OnaccountCredit: number
  Title: On Account Credit

  Default Value: 0

  Indicates the on account credit amount.
• OnaccountCurrency: string
  Title: On Account Currency

  Maximum Length: 3

  The currency of the amount held on account.
• OnaccountDate: string (date)
  Title: On Account Date

  The date on which the payment was received.
• OnaccountHistoryKey: integer (int64)
  The unique identifier for the transaction.
• OnaccountReasonCode: string
  Title: On Account Reason Code

  Maximum Length: 30

  The reason payment was not applied to an invoice or a fee record.
• OnaccountReferenceId: string
  Title: On Account Reference ID

  Maximum Length: 30

  Combination value consisting of the ON prefix plus the value using the PSC GUID function. This value is passed to the calling app and displayed to the user.
• OnaccountSource: string
  Title: On Account Source

  Maximum Length: 30

  The source of the record.
• OnaccountStatus: string
  Title: On Account Status

  Maximum Length: 30

  The status of the on account record.
• OnAccountStatusDesc: string
  Read Only: true

  Maximum Length: 80

  Describes the on account status.
• PartyId: integer (int64)
  The party associated to the on account record.
• PayerEmail: string
  Maximum Length: 320

  The PSCR payer email address on the payment history record.
• PayerFirstName: string
  Title: Payer First Name

  Maximum Length: 150

  The PSCR payer first name on the payment history record.
• PayerLastName: string
  Title: Payer Last Name

  Maximum Length: 150

  The PSCR payer last name on the payment history record.
• PayerMiddleName: string
  Title: Payer Middle Name

  Maximum Length: 60

  The PSCR payer middle name on the payment history record.
• PayerNameSuffix: string
  Title: Payer Name Suffix

  Maximum Length: 30

  The PSCR payer name suffix on the payment history record.
• PaymentInstrumentDate: string (date)
  Title: Payment Instrument Date

  The date on the payment instrument.
• PaymentInstrumentNumber: string
  Title: Payment Instrument Number

  Maximum Length: 50

  The payment instrument number that can identify the on account payment.
• PaymentMethodCode: string
  Maximum Length: 30

  The PSCR payment method code.
• PaymentReferenceId: string
  Maximum Length: 50

  The PSCR payment reference identifier on the payment history record.
• PaymentTransactionId: string
  Maximum Length: 50

  The PSCR payment transaction identifier on the payment history record.
• PrimaryReferenceId: string
  Title: Primary Reference ID

  Maximum Length: 50

  The primary identifier provided along with the payment.
• PrimaryReferenceType: string
  Title: Primary Reference Type

  Maximum Length: 30

  The type of primary identifier provided along with the payment.
• PrimaryTrackingData: string
  Maximum Length: 50

  The primary PSCR payment tracking data on the payment history record.
• ProfileId: integer (int64)
  The profile associated to the on account record.
• RefundAmount: number
  The amount to be refunded.
• RefundCurrency: string
  Maximum Length: 3

  The currency of the refund amount.
• RefundDate: string (date)
  The date the refund was initiated.
• RefundMethodCode: string
  Maximum Length: 30

  The method used for the refund.
• RefundReasonCode: string
  Maximum Length: 30

  The reason for the refund.
• RefundReferenceId: string
  Maximum Length: 50

  The refund reference identifier.
• RefundStatus: string
  Maximum Length: 30

  The status of the refund.
• RequireAccounting: string
  Title: Require Accounting

  Maximum Length: 1

  Default Value: Y

  Indicates whether accounting entries should be created for the on account record.
• ReversalFlag: string
  Maximum Length: 1

  Default Value: N

  Specifies whether the record is a reversal of an overpayment.
• ReversalTransactionType: string
  Maximum Length: 30

  Default Value: ORA_NONE

  Indicates the type of reversal transaction.
• SecondaryReferenceId: string
  Title: Secondary Reference ID

  Maximum Length: 50

  The secondary identifier provided along with the payment.
• SecondaryReferenceType: string
  Title: Secondary Reference Type

  Maximum Length: 30

  The type of secondary identifier provided along with the payment.
• SecondaryTrackingData: string
  Maximum Length: 50

  The secondary PSCR payment tracking data on the payment history record.
• TrustAccountNumber: string
  Maximum Length: 30

  The PSCR trust account on the payment history record.
• UnappliedFlag: string
  Title: Unapplied

  Maximum Length: 1

  Default Value: N

  Identifies the unapplied payment record.

{
    "type":"object",
    "properties":{
        "MigratedDataFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the data is migrated from a legacy system.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ProfileId":{
            "type":"integer",
            "description":"The profile associated to the on account record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AmountPaid":{
            "type":"number",
            "description":"The PSCR payment received on the payment history record.",
            "nullable":false,
            "x-queryable":true
        },
        "RequireAccounting":{
            "title":"Require Accounting",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether accounting entries should be created for the on account record.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "AdditionalReferenceType":{
            "title":"Additional Reference Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of additional identifier provided along with the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "OnaccountCurrency":{
            "title":"On Account Currency",
            "maxLength":"3",
            "type":"string",
            "description":"The currency of the amount held on account.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "maxLength":"50",
            "type":"string",
            "description":"The PSCR payment reference identifier on the payment history record.",
            "nullable":false,
            "x-queryable":true
        },
        "PayerFirstName":{
            "title":"Payer First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The PSCR payer first name on the payment history record.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryReferenceType":{
            "title":"Primary Reference Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of primary identifier provided along with the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "OnaccountHistoryKey":{
            "type":"integer",
            "description":"The unique identifier for the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RefundReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The reason for the refund.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AmountDue":{
            "title":"Amount Due",
            "type":"number",
            "description":"The PSCR payment amount on the payment history record.",
            "nullable":false,
            "x-queryable":true
        },
        "SecondaryReferenceId":{
            "title":"Secondary Reference ID",
            "maxLength":"50",
            "type":"string",
            "description":"The secondary identifier provided along with the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The status of the refund.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryTrackingData":{
            "maxLength":"50",
            "type":"string",
            "description":"The secondary PSCR payment tracking data on the payment history record.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundDate":{
            "type":"string",
            "description":"The date the refund was initiated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The PSCR payment method code.",
            "nullable":false,
            "x-queryable":true
        },
        "OnaccountCredit":{
            "title":"On Account Credit",
            "type":"number",
            "description":"Indicates the on account credit amount.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "PayerLastName":{
            "title":"Payer Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The PSCR payer last name on the payment history record.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundCurrency":{
            "maxLength":"3",
            "type":"string",
            "description":"The currency of the refund amount.",
            "nullable":true,
            "x-queryable":true
        },
        "OnaccountAction":{
            "title":"On Account Action",
            "maxLength":"30",
            "type":"string",
            "description":"The action the user wants to take for the on account record.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessEntityName":{
            "maxLength":"100",
            "type":"string",
            "description":"The PSCR business entity name on the payment history record.",
            "nullable":true,
            "x-queryable":true
        },
        "ReversalFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Specifies whether the record is a reversal of an overpayment.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "SecondaryReferenceType":{
            "title":"Secondary Reference Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of secondary identifier provided along with the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentTransactionId":{
            "maxLength":"50",
            "type":"string",
            "description":"The PSCR payment transaction identifier on the payment history record.",
            "nullable":true,
            "x-queryable":true
        },
        "ReversalTransactionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of reversal transaction.",
            "nullable":false,
            "default":"ORA_NONE",
            "x-queryable":true
        },
        "OnaccountDate":{
            "title":"On Account Date",
            "type":"string",
            "description":"The date on which the payment was received.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RefundMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The method used for the refund.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryReferenceId":{
            "title":"Primary Reference ID",
            "maxLength":"50",
            "type":"string",
            "description":"The primary identifier provided along with the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the on account record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AdditionalReferenceId":{
            "title":"Additional Reference ID",
            "maxLength":"50",
            "type":"string",
            "description":"The additional identifier provided along with the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryTrackingData":{
            "maxLength":"50",
            "type":"string",
            "description":"The primary PSCR payment tracking data on the payment history record.",
            "nullable":true,
            "x-queryable":true
        },
        "UnappliedFlag":{
            "title":"Unapplied",
            "maxLength":"1",
            "type":"string",
            "description":"Identifies the unapplied payment record.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "PayerEmail":{
            "maxLength":"320",
            "type":"string",
            "description":"The PSCR payer email address on the payment history record.",
            "nullable":true,
            "x-queryable":true
        },
        "OnAccountStatusDesc":{
            "maxLength":"80",
            "type":"string",
            "description":"Describes the on account status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentInstrumentNumber":{
            "title":"Payment Instrument Number",
            "maxLength":"50",
            "type":"string",
            "description":"The payment instrument number that can identify the on account payment.",
            "nullable":false,
            "x-queryable":true
        },
        "FarReceiptStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The status of the receipt in Fusion Receivables.",
            "nullable":true,
            "x-queryable":true
        },
        "OnaccountStatus":{
            "title":"On Account Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the on account record.",
            "nullable":false,
            "x-queryable":true
        },
        "PayerMiddleName":{
            "title":"Payer Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The PSCR payer middle name on the payment history record.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditAppliedFlag":{
            "title":"Credit Applied",
            "maxLength":"1",
            "type":"string",
            "description":"Payment on account credit is applied.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "OnaccountAmount":{
            "title":"On Account Amount",
            "type":"number",
            "description":"The amount that is held on account.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessEntityDbaName":{
            "maxLength":"100",
            "type":"string",
            "description":"The PSCR business entity doing business as name on the payment history record.",
            "nullable":true,
            "x-queryable":true
        },
        "OnaccountReferenceId":{
            "title":"On Account Reference ID",
            "maxLength":"30",
            "type":"string",
            "description":"Combination value consisting of the ON prefix plus the value using the PSC GUID function. This value is passed to the calling app and displayed to the user.",
            "nullable":true,
            "x-queryable":true
        },
        "FarCashReceiptId":{
            "title":"Receivables Receipt ID",
            "type":"integer",
            "description":"The identifier for the receipt in Fusion Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TrustAccountNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The PSCR trust account on the payment history record.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundAmount":{
            "type":"number",
            "description":"The amount to be refunded.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerNameSuffix":{
            "title":"Payer Name Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The PSCR payer name suffix on the payment history record.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundReferenceId":{
            "maxLength":"50",
            "type":"string",
            "description":"The refund reference identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckoutId":{
            "type":"integer",
            "description":"Checkout identifier for the credit applied.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The party associated to the on account record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OnaccountSource":{
            "title":"On Account Source",
            "maxLength":"30",
            "type":"string",
            "description":"The source of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "OnaccountReasonCode":{
            "title":"On Account Reason Code",
            "maxLength":"30",
            "type":"string",
            "description":"The reason payment was not applied to an invoice or a fee record.",
            "nullable":true,
            "x-queryable":true
        },
        "Meaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The description for the Fusion Receivables receipt status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentInstrumentDate":{
            "title":"Payment Instrument Date",
            "type":"string",
            "description":"The date on the payment instrument.",
            "format":"date",
            "nullable":false,
            "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."
        }
    }
}

Back to Top