Jump to

• Request
• Response

Get a payment record

get

/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRecords/{publicSectorPaymentRecordsUniqID}

Request

Path Parameters

• publicSectorPaymentRecordsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Payment Records resource and used to uniquely identify an instance of Payment Records. The client should not generate the hash key value. Instead, the client should query on the Payment Records collection resource in order to navigate to a specific instance of Payment Records to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : publicSectorPaymentRecords-item-response

Type: object

Show Source

• Address1: string
  Read Only: true

  Maximum Length: 240

  First line of the payer billing address. Requires a valid street number and name.
• Address2: string
  Read Only: true

  Maximum Length: 240

  Second line of the payer billing address such as apartment, suite, unit, building, floor, or village information.
• Address3: string
  Read Only: true

  Maximum Length: 240

  Third line of the payer billing address.
• Address4: string
  Read Only: true

  Maximum Length: 240

  Fourth line of the payer billing address.
• AgencyId: integer (int32)
  Read Only: true

  The unique identifier of the agency associated with the payment transaction.
• AmountDue: number
  Read Only: true

  Total Payment amount due that is the sum total of the amounts on payment history lines.
• BusinessEntityDbaName: string
  Read Only: true

  Maximum Length: 100

  Doing business as name of the business making the payment.
• BusinessEntityId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier for the business entity associated with this transaction.
• BusinessEntityName: string
  Read Only: true

  Maximum Length: 100

  Entity name of the business making the payment.
• BusinessEntityPartyId: integer (int64)
  Read Only: true

  The unique identifier for the business entity party associated with this transaction.
• BusinessLocationId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier for the location of the business entity.
• BusinessLocationPartyId: integer (int64)
  Read Only: true

  The unique identifier for the party associated with the business entity location.
• BusinessProfileId: integer (int64)
  Read Only: true

  The unique identifier for the profile of the business entity associated with this transaction.
• Classification: string
  Read Only: true

  Maximum Length: 3

  Source application that generated the fee.
• CreditCardDigits: integer (int32)
  Read Only: true

  The last four digits of the credit card number used for a payment.
• CreditCardType: string
  Read Only: true

  Maximum Length: 4

  The type of credit card used for a payment. Examples are Mastercard and Visa.
• ItemCurrency: string
  Read Only: true

  Maximum Length: 3

  Currency code for both the unit price and tax amount.
• ItemDescription: string
  Read Only: true

  Maximum Length: 100

  Item description provided by the requesting application.
• ItemLine: integer (int32)
  Read Only: true

  Item line provided by the requesting application. When none is provided, it is set to zero.
• ItemName: string
  Read Only: true

  Maximum Length: 30

  Item name provided by the requesting application.
• ItemRecKey: integer (int32)
  Read Only: true

  The key value for the item in the payment line.
• ItemReference: string
  Read Only: true

  Maximum Length: 50

  Custom reference value provided by the requesting application.
• ItemTaxAmount: number
  Read Only: true

  Tax amount assessed for the transaction.
• ItemUnitPrice: number
  Read Only: true

  Base price of the item being paid by the payment transaction.
• links: array Links
  Title: Links

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

  Maximum Length: 80

  Identifies the meaning that is associated with the payment method value.
• MigratedDataFlag: string
  Read Only: true

  Maximum Length: 3

  Indicates whether the data is migrated from another system.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier for the party associated with this transaction.
• PayerAddress: string
  Read Only: true

  Maximum Length: 240

  The address of the person who made the payment.
• PayerCity: string
  Read Only: true

  Maximum Length: 60

  City of the payer billing address.
• PayerCounty: string
  Read Only: true

  Maximum Length: 60

  County of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities.
• PayerEmail: string
  Read Only: true

  Maximum Length: 320

  Email address of the payer for a payment transaction.
• PayerFirstName: string
  Read Only: true

  Maximum Length: 150

  The first name of the payer for a payment transaction.
• PayerLastName: string
  Read Only: true

  Maximum Length: 150

  The last name of the payer for a payment transaction.
• PayerMiddleName: string
  Read Only: true

  Maximum Length: 60

  The middle name of the payer for a payment transaction.
• PayerName: string
  Read Only: true

  Maximum Length: 100

  The name of the person who made the payment.
• PayerPhone: string
  Read Only: true

  Maximum Length: 60

  Phone number of the person making the payment.
• PayerState: string
  Read Only: true

  Maximum Length: 60

  State code of the payer billing address. In the U.S, this is the two character USPS state abbreviation. For example, NY for New York.
• PaymentDate: string (date)
  Read Only: true

  Date on which the payment transaction occurred.
• PaymentHistoryKey: integer (int64)
  Read Only: true

  The unique identifier for the payment transaction.
• PaymentMethodCode: string
  Read Only: true

  Maximum Length: 30

  Method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check.
• PaymentReferenceId: string
  Read Only: true

  Maximum Length: 50

  A reference value created by the payment module and sent as pass through data to the payment processor, trust account, and cash drawer.
• PaymentTransactionId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier of the transaction that is received from the payment gateway or from the trust account system.
• ProfileId: integer (int64)
  Read Only: true

  The unique identifier for the profile of the user associated with this transaction.
• RecordId: string
  Read Only: true

  Maximum Length: 50

  Source application's record identifier.
• RecordType: string
  Read Only: true

  Maximum Length: 100

  Source application's record type.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

  Source application's record type identifier.
• TrustAccountNumber: string
  Read Only: true

  Maximum Length: 30

  An attribute that identifies the logical trust account number.

{
    "type":"object",
    "properties":{
        "PaymentTransactionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the transaction that is received from the payment gateway or from the trust account system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileId":{
            "type":"integer",
            "description":"The unique identifier for the profile of the user associated with this transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the data is migrated from another system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemLine":{
            "type":"integer",
            "description":"Item line provided by the requesting application. When none is provided, it is set to zero.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "BusinessEntityId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the business entity associated with this transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the payment transaction.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "BusinessProfileId":{
            "type":"integer",
            "description":"The unique identifier for the profile of the business entity associated with this transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PayerCity":{
            "maxLength":60,
            "type":"string",
            "description":"City of the payer billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayerAddress":{
            "maxLength":240,
            "type":"string",
            "description":"The address of the person who made the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayerEmail":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the payer for a payment transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":100,
            "type":"string",
            "description":"Item description provided by the requesting application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"A reference value created by the payment module and sent as pass through data to the payment processor, trust account, and cash drawer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayerFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the payer for a payment transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"Source application's record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the payer billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayerMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the payer for a payment transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"Source application that generated the fee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"Source application's record type identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":30,
            "type":"string",
            "description":"Item name provided by the requesting application.",
            "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"
            }
        },
        "RecordId":{
            "maxLength":50,
            "type":"string",
            "description":"Source application's record identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemTaxAmount":{
            "type":"number",
            "description":"Tax amount assessed for the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityDbaName":{
            "maxLength":100,
            "type":"string",
            "description":"Doing business as name of the business making the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemUnitPrice":{
            "type":"number",
            "description":"Base price of the item being paid by the payment transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AmountDue":{
            "type":"number",
            "description":"Total Payment amount due that is the sum total of the amounts on payment history lines.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditCardDigits":{
            "type":"integer",
            "description":"The last four digits of the credit card number used for a payment.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "PaymentDate":{
            "type":"string",
            "description":"Date on which the payment transaction occurred.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCurrency":{
            "maxLength":3,
            "type":"string",
            "description":"Currency code for both the unit price and tax amount.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"Second line of the payer billing address such as apartment, suite, unit, building, floor, or village information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TrustAccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"An attribute that identifies the logical trust account number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"Third line of the payer billing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayerState":{
            "maxLength":60,
            "type":"string",
            "description":"State code of the payer billing address. In the U.S, this is the two character USPS state abbreviation. For example, NY for New York.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessLocationPartyId":{
            "type":"integer",
            "description":"The unique identifier for the party  associated with the business entity location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"First line of the payer billing address. Requires a valid street number and name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayerName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the person who made the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditCardType":{
            "maxLength":4,
            "type":"string",
            "description":"The type of credit card used for a payment. Examples are Mastercard and Visa.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemReference":{
            "maxLength":50,
            "type":"string",
            "description":"Custom reference value provided by the requesting application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityPartyId":{
            "type":"integer",
            "description":"The unique identifier for the business entity party associated with this transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PayerLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the payer for a payment transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentHistoryKey":{
            "type":"integer",
            "description":"The unique identifier for the payment transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier for the party associated with this transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessLocationId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the location of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayerCounty":{
            "maxLength":60,
            "type":"string",
            "description":"County of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityName":{
            "maxLength":100,
            "type":"string",
            "description":"Entity name of the business making the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayerPhone":{
            "maxLength":60,
            "type":"string",
            "description":"Phone number of the person making the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemRecKey":{
            "type":"integer",
            "description":"The key value for the item in the payment line.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "description":"Identifies the meaning that is associated with the payment method value.",
            "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 : 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