Create a payment data
post
/fscmRestApi/resources/11.13.18.05/publicSectorPayments
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountPurpose: string
Maximum Length:
30
The purpose assigned with the deposit account. -
AccountType: string
Maximum Length:
30
The type assigned with the deposit account. -
ActivityType: string
Maximum Length:
30
Default Value:ORA_FEE
The type of activity. -
Address1: string
Maximum Length:
240
The first line of the payer billing address. Requires a valid street number and name. -
Address2: string
Maximum Length:
240
The second line of the payer billing address such as apartment, suite, unit, building, floor, or village information. -
Address3: string
Maximum Length:
240
The third line of the payer billing address. -
Address4: string
Maximum Length:
240
The fourth line of the payer billing address. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the agency associated with the payment transaction. -
AmountDue(required): number
The total payment amount due that is the sum total of the amounts on payment history lines.
-
AuthorizationCode: string
Maximum Length:
10
The authorization code value returned by the payment gateway or trust account system. -
AuthorizationDttm(required): string
(date-time)
The authorization date returned by the payment gateway, by the trust account system, or a timestamp given by the agency staff for cash drawer and manual confirmation of trust account funds.
-
AuthorizationStatus(required): string
Maximum Length:
4
The status value returned by the payment gateway or trust account system. -
BusinessEntityDbaName: string
Maximum Length:
100
Doing business as name of the business making the payment. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier for the business entity associated with this transaction. -
BusinessEntityName: string
Maximum Length:
100
The entity name of the business making the payment. -
BusinessEntityPartyId: integer
(int64)
The unique identifier for the business entity party associated with this transaction.
-
BusinessLocationId: string
Maximum Length:
50
The unique identifier for the location of the business entity. -
BusinessLocationPartyId: integer
(int64)
The unique identifier for the party associated with the business entity location.
-
BusinessProfileId: integer
(int64)
The unique identifier for the profile of the business entity associated with this transaction.
-
CheckoutId: integer
(int64)
Checkout identifier for the credit applied.
-
CreditAmountApplied: number
Default Value:
0
The amount of the credit applied to the payment. -
CreditAmountAvailable: number
Default Value:
0
The amount available to apply a payment on account credit. -
CreditAppliedFlag: string
Maximum Length:
1
Default Value:N
Payment on account credit is applied. -
EcheckAgreeDttm: string
(date-time)
The date and time of the user???s consent and agreement on the electronic check terms and conditions. This is required only for the electronic check payment method.
-
ExternalPaymentReference: string
Maximum Length:
50
An attribute that identifies the external payment reference provided by the third party payment system. -
FarReceiptStatus: string
Title:
Receivables Receipt Status
Maximum Length:30
Default Value:ORA_NONE
The status to indicate the creation of a receipt in Oracle Receivables. -
FirstResponseMessage: string
Maximum Length:
100
The first part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account. -
PartyId: integer
(int64)
The unique identifier for the party associated with this transaction.
-
PayerAddress: string
Maximum Length:
240
The address of the person who made the payment. -
PayerCity: string
Maximum Length:
60
The city of the payer billing address. -
PayerCountryThreeCharacterCode: string
Maximum Length:
3
The international three-digit country code call prefix of the payer's phone number. -
PayerCountryTwoCharacterCode: string
Maximum Length:
2
The international two-digit country code call prefix of the payer's phone number. -
PayerCounty: string
Maximum Length:
60
The county of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities. -
PayerEmail: string
Title:
Email
Maximum Length:320
The email address of the payer for a payment transaction. -
PayerFirstName: string
Title:
First Name
Maximum Length:150
The first name of the payer for a payment transaction. -
PayerLastName: string
Title:
Last Name
Maximum Length:150
The last name of the payer for a payment transaction. -
PayerMiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the payer for a payment transaction. -
PayerName: string
Maximum Length:
100
The name of the person who made the payment. -
PayerNameSuffix: string
Title:
Suffix
Maximum Length:30
The suffix for the name of the payer for a payment transaction. -
PayerPhone: string
Maximum Length:
60
The phone number of the person making the payment. -
PayerPostalAddOnCode: string
Maximum Length:
10
The additional digits used to identify a specific mail delivery route. -
PayerPostalCode: string
Maximum Length:
60
The postal code of the payer billing address. It can be a series of digits or letters or both. -
PayerProvince: string
Maximum Length:
60
The region code for the payer billing address in non-US countries. In Canada, this is the two-character province abbreviation by the Canada Post. -
PayerState: string
Maximum Length:
60
The 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. -
PaymentAdapterId: string
Maximum Length:
100
The unique identifier of the payment adapter associated with the agency and payment method. -
PaymentAmount(required): number
Title:
Amount Paid
The total payment amount authorized and settled by the payment gateway or verified by the trust account system. -
PaymentCurrency(required): string
Title:
Currency
Maximum Length:3
The currency used for the payment transaction. -
PaymentDate(required): string
(date)
Title:
Receipt Date
The date on which the payment transaction occurred. -
PaymentHeaderId: string
Maximum Length:
50
Identifies the alpha numeric payment header reference for a payment processed by third party payment system. -
PaymentHeaderKey: integer
(int64)
Identifies payment header key.
-
PaymentHistoryKey: integer
(int64)
The unique identifier for the payment transaction.
-
PaymentHistoryLine: array
Payment Lines
Title:
Payment Lines
The payment lines resource is used to view or create payment detail lines. -
PaymentMethodCode(required): string
Maximum Length:
30
The method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check. -
PaymentReferenceId(required): string
Title:
Payment Reference ID
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. -
PaymentStatus: string
Maximum Length:
30
Default Value:ORA_PAID
Indicates the status of the payment. -
PaymentTrackingData: string
Title:
Primary Payment Tracking Data
Maximum Length:50
The identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTrackingDataPlus: string
Title:
Secondary Payment Tracking Data
Maximum Length:50
The additional identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTransactionId(required): string
Title:
Payment Transaction ID
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)
The unique identifier for the profile of the user associated with this transaction.
-
PublishedStatusCode: string
Maximum Length:
30
Default Value:ORA_UNPUBLISHED
Indicates whether reconciliation activity has been created for the transaction by code. -
ReconcileDatetime: string
(date-time)
The date and time of the payment reconciliation.
-
ReconcileType: string
Maximum Length:
30
Indicates whether the payment was reconciled through an online API or by the ESS job. -
ReconHistoryKey: integer
(int64)
Unique identifier for each bank reconciliation activity record.
-
ReversalFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the record is a reversal of a payment. -
ReversalReasonCd: string
Maximum Length:
30
Identifies the reason code when payment is reversed or voided. -
ReversalTransactionType: string
Title:
Reversal Transaction Type
Maximum Length:30
Default Value:ORA_NONE
Indicates the type of reversal transaction. -
SecondResponseMessage: string
Maximum Length:
100
The second part of the response message returned by the payment gateway, or a free form message entered by agency staff for cash drawer or trust account. -
ServiceChargeAmount: number
A convenience fee assessed by the department for using a specific payment method.
-
ServiceChargeCurrency: string
Maximum Length:
3
The currency used for the service charge. -
ThirdPartyPayFlag: string
Maximum Length:
1
Default Value:N
Identifies the payment was processed by a third party payment system. -
ThirdResponseMessage: string
Maximum Length:
100
The third part of the response message returned by the payment gateway, or a free form message entered by agency staff for a cash drawer or deposit account. -
TrustAccountNumber: string
Title:
Deposit Account Number
Maximum Length:30
An attribute that identifies the deposit account number. -
UnappliedFlag: string
Maximum Length:
1
Default Value:N
Identifies an unapplied payment record.
Nested Schema : Payment Lines
Type:
array
Title:
Payment Lines
The payment lines resource is used to view or create payment detail lines.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
Address1: string
Maximum Length:
240
The first line of the property address. -
Address2: string
Maximum Length:
240
The second line of the property address. -
Address3: string
Maximum Length:
240
The third line of the property address. -
Address4: string
Maximum Length:
240
The fourth line of the property address. -
AgencyId: integer
Default Value:
1
The unique identifier of the agency associated with the row. -
ApplicationReferenceId: string
Maximum Length:
50
The key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus: string
Maximum Length:
50
An additional key identifier passed by the consuming application. -
BillAgencyId: integer
(int64)
The unique identifier of the agency associated with the invoice.
-
BillType: string
Maximum Length:
15
Determines the default invoice values for invoice form and invoice number ID. -
BusBusinessLegalName: string
Maximum Length:
240
The legal name of a business. -
BusBusinessName: string
Maximum Length:
100
The name of a business. -
BusDbaBusinessName: string
Maximum Length:
100
The doing business as name of a business. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier of a business. -
BusinessLocationId: string
Maximum Length:
50
The unique identifier of a business location. -
BusinessLocationPartyId: integer
(int64)
The party identifier of a business location.
-
BusPartyId: integer
(int64)
The party identifier of a business.
-
CaseId: string
Maximum Length:
50
The case identifier for a code enforcement fee. -
City: string
Maximum Length:
60
The city of the property address. -
Classification: string
Maximum Length:
3
The source application that generated the fee. -
Country: string
Maximum Length:
60
The country of the property address. -
County: string
Maximum Length:
60
The county of the property address. -
DepartmentId: string
Maximum Length:
30
The department associated with the fee item. -
FarCashReceiptId: integer
(int64)
The receipt identifier created in Oracle Receivables.
-
FarReceiptStatus: string
Maximum Length:
30
Default Value:ORA_NONE
The status to indicate the creation of receipts in Oracle Receivables. -
FeeItemId: string
Maximum Length:
30
The unique identifier for the fee item. -
FeeReferenceId: string
Maximum Length:
50
The reference identifier for the fee item. -
FeeReferencePuid: string
Maximum Length:
480
The PUID reference identifier for the fee item. -
Invoice: string
Maximum Length:
50
The unique billing identifier. -
ItemCurrency: string
Title:
Item Currency
Maximum Length:3
The currency code for both the unit price and the tax amount. -
ItemDescription: string
Title:
Item Description
Maximum Length:50
The item description provided by the requesting application. -
ItemLine: integer
Default Value:
0
The item line provided by the requesting application. When none is provided, it is set to zero. -
ItemName: string
Maximum Length:
30
The item name provided by the requesting application. -
ItemRecKey: integer
The key value for the item in the payment line.
-
ItemReference: string
Title:
Item Reference
Maximum Length:50
The custom reference value provided by the requesting application. -
ItemTaxAmount: number
Title:
Item Tax Amount
The tax amount assessed for the transaction. -
ItemUnitPrice: number
Title:
Item Amount
The base price of the item being paid by the payment transaction. -
OrganizationName: string
Maximum Length:
360
The name of an organization. -
PaymentHistoryKey: integer
The unique identifier for the payment transaction.
-
PaymentLinePuid: string
Maximum Length:
480
The unique key identifier for the payment-related data migration transaction. -
PaymentReferenceId: string
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. -
PostalCode: string
Maximum Length:
60
The postal code of the property address. -
PostalPlus4Code: string
Maximum Length:
10
The extended postal code of the property address. -
Province: string
Maximum Length:
60
The province of the property address. -
RecordId: string
Title:
Record ID
Maximum Length:50
The source application's record identifier. -
RecordTypeId: string
Title:
Record Type
Maximum Length:30
The source application's record type. -
ReversalFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the record is a reversal of a payment. -
ReversalTransactionType: string
Title:
Reversal Transaction Type
Maximum Length:30
Default Value:ORA_NONE
Indicates the type of reversal transaction. -
State: string
Maximum Length:
60
The state of the property address. -
UnappliedFlag: string
Maximum Length:
1
Default Value:N
Identifies an unapplied payment record.
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.
Root Schema : publicSectorPayments-item-response
Type:
Show Source
object
-
AccountPurpose: string
Maximum Length:
30
The purpose assigned with the deposit account. -
AccountType: string
Maximum Length:
30
The type assigned with the deposit account. -
ActivityType: string
Maximum Length:
30
Default Value:ORA_FEE
The type of activity. -
Address1: string
Maximum Length:
240
The first line of the payer billing address. Requires a valid street number and name. -
Address2: string
Maximum Length:
240
The second line of the payer billing address such as apartment, suite, unit, building, floor, or village information. -
Address3: string
Maximum Length:
240
The third line of the payer billing address. -
Address4: string
Maximum Length:
240
The fourth line of the payer billing address. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the agency associated with the payment transaction. -
AmountDue: number
The total payment amount due that is the sum total of the amounts on payment history lines.
-
AuthorizationCode: string
Maximum Length:
10
The authorization code value returned by the payment gateway or trust account system. -
AuthorizationDttm: string
(date-time)
The authorization date returned by the payment gateway, by the trust account system, or a timestamp given by the agency staff for cash drawer and manual confirmation of trust account funds.
-
AuthorizationStatus: string
Maximum Length:
4
The status value returned by the payment gateway or trust account system. -
BusinessEntityDbaName: string
Maximum Length:
100
Doing business as name of the business making the payment. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier for the business entity associated with this transaction. -
BusinessEntityName: string
Maximum Length:
100
The entity name of the business making the payment. -
BusinessEntityPartyId: integer
(int64)
The unique identifier for the business entity party associated with this transaction.
-
BusinessLocationId: string
Maximum Length:
50
The unique identifier for the location of the business entity. -
BusinessLocationPartyId: integer
(int64)
The unique identifier for the party associated with the business entity location.
-
BusinessProfileId: integer
(int64)
The unique identifier for the profile of the business entity associated with this transaction.
-
CheckoutId: integer
(int64)
Checkout identifier for the credit applied.
-
CreditAmountApplied: number
Default Value:
0
The amount of the credit applied to the payment. -
CreditAmountAvailable: number
Default Value:
0
The amount available to apply a payment on account credit. -
CreditAppliedFlag: string
Maximum Length:
1
Default Value:N
Payment on account credit is applied. -
CreditCardDigits: integer
(int32)
Title:
Credit Card Digits
Read Only:true
The last four digits of the credit card number used for a payment. -
CreditCardType: string
Title:
Credit Card Type
Read Only:true
Maximum Length:4
The type of credit card used for a payment. Examples are MasterCard and Visa. -
EcheckAgreeDttm: string
(date-time)
The date and time of the user???s consent and agreement on the electronic check terms and conditions. This is required only for the electronic check payment method.
-
ExternalPaymentReference: string
Maximum Length:
50
An attribute that identifies the external payment reference provided by the third party payment system. -
FarReceiptStatus: string
Title:
Receivables Receipt Status
Maximum Length:30
Default Value:ORA_NONE
The status to indicate the creation of a receipt in Oracle Receivables. -
FarReceiptStatusDescr: string
Read Only:
true
Maximum Length:80
The status to indicate the creation of a receipt in Oracle Receivables. -
FirstResponseMessage: string
Maximum Length:
100
The first part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Meaning: string
Read Only:
true
Maximum Length:80
The payment method description. -
MigratedDataFlag: string
Read Only:
true
Maximum Length:3
Default Value:N
A flag to indicate that the data was migrated from another system. -
PartyId: integer
(int64)
The unique identifier for the party associated with this transaction.
-
PayerAddress: string
Maximum Length:
240
The address of the person who made the payment. -
PayerCity: string
Maximum Length:
60
The city of the payer billing address. -
PayerCountryThreeCharacterCode: string
Maximum Length:
3
The international three-digit country code call prefix of the payer's phone number. -
PayerCountryTwoCharacterCode: string
Maximum Length:
2
The international two-digit country code call prefix of the payer's phone number. -
PayerCounty: string
Maximum Length:
60
The county of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities. -
PayerEmail: string
Title:
Email
Maximum Length:320
The email address of the payer for a payment transaction. -
PayerFirstName: string
Title:
First Name
Maximum Length:150
The first name of the payer for a payment transaction. -
PayerLastName: string
Title:
Last Name
Maximum Length:150
The last name of the payer for a payment transaction. -
PayerMiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the payer for a payment transaction. -
PayerName: string
Maximum Length:
100
The name of the person who made the payment. -
PayerNameSuffix: string
Title:
Suffix
Maximum Length:30
The suffix for the name of the payer for a payment transaction. -
PayerPhone: string
Maximum Length:
60
The phone number of the person making the payment. -
PayerPostalAddOnCode: string
Maximum Length:
10
The additional digits used to identify a specific mail delivery route. -
PayerPostalCode: string
Maximum Length:
60
The postal code of the payer billing address. It can be a series of digits or letters or both. -
PayerProvince: string
Maximum Length:
60
The region code for the payer billing address in non-US countries. In Canada, this is the two-character province abbreviation by the Canada Post. -
PayerState: string
Maximum Length:
60
The 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. -
PaymentAdapterId: string
Maximum Length:
100
The unique identifier of the payment adapter associated with the agency and payment method. -
PaymentAmount: number
Title:
Amount Paid
The total payment amount authorized and settled by the payment gateway or verified by the trust account system. -
PaymentCurrency: string
Title:
Currency
Maximum Length:3
The currency used for the payment transaction. -
PaymentDate: string
(date)
Title:
Receipt Date
The date on which the payment transaction occurred. -
PaymentHeaderId: string
Maximum Length:
50
Identifies the alpha numeric payment header reference for a payment processed by third party payment system. -
PaymentHeaderKey: integer
(int64)
Identifies payment header key.
-
PaymentHistoryKey: integer
(int64)
The unique identifier for the payment transaction.
-
PaymentHistoryLine: array
Payment Lines
Title:
Payment Lines
The payment lines resource is used to view or create payment detail lines. -
PaymentMethodCode: string
Maximum Length:
30
The method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check. -
PaymentReferenceId: string
Title:
Payment Reference ID
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. -
PaymentStatus: string
Maximum Length:
30
Default Value:ORA_PAID
Indicates the status of the payment. -
PaymentTrackingData: string
Title:
Primary Payment Tracking Data
Maximum Length:50
The identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTrackingDataPlus: string
Title:
Secondary Payment Tracking Data
Maximum Length:50
The additional identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTransactionId: string
Title:
Payment Transaction ID
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)
The unique identifier for the profile of the user associated with this transaction.
-
PublishedStatusCode: string
Maximum Length:
30
Default Value:ORA_UNPUBLISHED
Indicates whether reconciliation activity has been created for the transaction by code. -
PublishedStatusName: string
Read Only:
true
Maximum Length:80
Indicates whether reconciliation activity has been created for the transaction by name. -
ReconcileDatetime: string
(date-time)
The date and time of the payment reconciliation.
-
ReconcileType: string
Maximum Length:
30
Indicates whether the payment was reconciled through an online API or by the ESS job. -
ReconHistoryKey: integer
(int64)
Unique identifier for each bank reconciliation activity record.
-
ReversalFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the record is a reversal of a payment. -
ReversalReasonCd: string
Maximum Length:
30
Identifies the reason code when payment is reversed or voided. -
ReversalTransactionType: string
Title:
Reversal Transaction Type
Maximum Length:30
Default Value:ORA_NONE
Indicates the type of reversal transaction. -
SecondResponseMessage: string
Maximum Length:
100
The second part of the response message returned by the payment gateway, or a free form message entered by agency staff for cash drawer or trust account. -
ServiceChargeAmount: number
A convenience fee assessed by the department for using a specific payment method.
-
ServiceChargeCurrency: string
Maximum Length:
3
The currency used for the service charge. -
ThirdPartyPayFlag: string
Maximum Length:
1
Default Value:N
Identifies the payment was processed by a third party payment system. -
ThirdResponseMessage: string
Maximum Length:
100
The third part of the response message returned by the payment gateway, or a free form message entered by agency staff for a cash drawer or deposit account. -
TrustAccountNumber: string
Title:
Deposit Account Number
Maximum Length:30
An attribute that identifies the deposit account number. -
UnappliedFlag: string
Maximum Length:
1
Default Value:N
Identifies an unapplied payment record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Payment Lines
Type:
array
Title:
Payment Lines
The payment lines resource is used to view or create payment detail lines.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorPayments-PaymentHistoryLine-item-response
Type:
Show Source
object
-
Address1: string
Maximum Length:
240
The first line of the property address. -
Address2: string
Maximum Length:
240
The second line of the property address. -
Address3: string
Maximum Length:
240
The third line of the property address. -
Address4: string
Maximum Length:
240
The fourth line of the property address. -
AgencyId: integer
Default Value:
1
The unique identifier of the agency associated with the row. -
ApplicationReferenceId: string
Maximum Length:
50
The key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus: string
Maximum Length:
50
An additional key identifier passed by the consuming application. -
BillAgencyId: integer
(int64)
The unique identifier of the agency associated with the invoice.
-
BillType: string
Maximum Length:
15
Determines the default invoice values for invoice form and invoice number ID. -
BusBusinessLegalName: string
Maximum Length:
240
The legal name of a business. -
BusBusinessName: string
Maximum Length:
100
The name of a business. -
BusDbaBusinessName: string
Maximum Length:
100
The doing business as name of a business. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier of a business. -
BusinessLocationId: string
Maximum Length:
50
The unique identifier of a business location. -
BusinessLocationPartyId: integer
(int64)
The party identifier of a business location.
-
BusPartyId: integer
(int64)
The party identifier of a business.
-
CaseId: string
Maximum Length:
50
The case identifier for a code enforcement fee. -
City: string
Maximum Length:
60
The city of the property address. -
Classification: string
Maximum Length:
3
The source application that generated the fee. -
Country: string
Maximum Length:
60
The country of the property address. -
County: string
Maximum Length:
60
The county of the property address. -
DepartmentId: string
Maximum Length:
30
The department associated with the fee item. -
FarCashReceiptId: integer
(int64)
The receipt identifier created in Oracle Receivables.
-
FarReceiptStatus: string
Maximum Length:
30
Default Value:ORA_NONE
The status to indicate the creation of receipts in Oracle Receivables. -
FeeItemId: string
Maximum Length:
30
The unique identifier for the fee item. -
FeeReferenceId: string
Maximum Length:
50
The reference identifier for the fee item. -
FeeReferencePuid: string
Maximum Length:
480
The PUID reference identifier for the fee item. -
Invoice: string
Maximum Length:
50
The unique billing identifier. -
ItemCurrency: string
Title:
Item Currency
Maximum Length:3
The currency code for both the unit price and the tax amount. -
ItemDescription: string
Title:
Item Description
Maximum Length:50
The item description provided by the requesting application. -
ItemLine: integer
Default Value:
0
The item line provided by the requesting application. When none is provided, it is set to zero. -
ItemName: string
Maximum Length:
30
The item name provided by the requesting application. -
ItemRecKey: integer
The key value for the item in the payment line.
-
ItemReference: string
Title:
Item Reference
Maximum Length:50
The custom reference value provided by the requesting application. -
ItemTaxAmount: number
Title:
Item Tax Amount
The tax amount assessed for the transaction. -
ItemUnitPrice: number
Title:
Item Amount
The base price of the item being paid by the payment transaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MigratedDataFlag: string
Read Only:
true
Maximum Length:3
Default Value:N
Indicates if the data is migrated from another system. -
OrganizationName: string
Maximum Length:
360
The name of an organization. -
PaymentHistoryKey: integer
The unique identifier for the payment transaction.
-
PaymentLinePuid: string
Maximum Length:
480
The unique key identifier for the payment-related data migration transaction. -
PaymentReferenceId: string
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. -
PostalCode: string
Maximum Length:
60
The postal code of the property address. -
PostalPlus4Code: string
Maximum Length:
10
The extended postal code of the property address. -
Province: string
Maximum Length:
60
The province of the property address. -
RecordId: string
Title:
Record ID
Maximum Length:50
The source application's record identifier. -
RecordTypeId: string
Title:
Record Type
Maximum Length:30
The source application's record type. -
ReversalFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the record is a reversal of a payment. -
ReversalTransactionType: string
Title:
Reversal Transaction Type
Maximum Length:30
Default Value:ORA_NONE
Indicates the type of reversal transaction. -
State: string
Maximum Length:
60
The state of the property address. -
UnappliedFlag: string
Maximum Length:
1
Default Value:N
Identifies an unapplied payment record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- PaymentHistoryLine
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}/child/PaymentHistoryLineParameters:
- PaymentHistoryKey:
$request.path.PaymentHistoryKey
The payment lines resource is used to view or create payment detail lines. - PaymentHistoryKey: