Get a customer account activity
get
/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}
Request
Path Parameters
-
AccountId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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: string
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: string
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 TopResponse
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.
Root Schema : receivablesCustomerAccountActivities-item-response
Type:
Show Source
object-
AccountId: integer
(int64)
Read Only:
trueThe unique identifier of a customer account for a REST service. -
AccountNumber: string
Title:
Account NumberRead Only:trueMaximum Length:30The number that identifies a customer account. -
CreatedBy: string
Read Only:
trueMaximum Length:64The name of the user who created the customer account for a REST service. -
CreationDate: string
(date-time)
Read Only:
trueThe date the customer account was created for a REST service. -
creditMemoApplications: array
Credit Memo Applications
Title:
Credit Memo ApplicationsThe resource that provides details of credit memo applications created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. -
creditMemos: array
Credit Memos
Title:
Credit MemosThe resource that provides details of credit memos created for customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. It includes standard and on account credit memos. -
CustomerId: integer
(int64)
Title:
Party IDRead Only:trueThe identifier of the customer party associated with the customer account for a REST service. -
CustomerName: string
Title:
NameRead Only:trueMaximum Length:360The name of the customer party associated with the customer account for a REST service. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date the customer account was last updated for a REST service. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The name of the user who has last updated the customer account for a REST service. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
standardReceiptApplications: array
Standard Receipt Applications
Title:
Standard Receipt ApplicationsThe resource that provides details of standard receipt applications created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. -
standardReceipts: array
Standard Receipts
Title:
Standard ReceiptsThe resource that provides details of standard receipts created for customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. -
TaxpayerIdentificationNumber: string
Title:
Taxpayer Identification NumberRead Only:trueMaximum Length:20The number that identifies the customer party to a tax authority to pay and report direct taxes for a REST service. -
TaxRegistrationNumber: string
Title:
Tax Registration NumberRead Only:trueMaximum Length:50The registration number for tax purposes assigned to the bill-to customer for a REST service. -
TotalOpenReceivablesForAccount: number
Read Only:
trueThe total open receivables amount in the ledger currency of a customer account for a REST service. -
TotalTransactionsDueForAccount: number
Read Only:
trueThe total transaction amount due in the ledger currency of a customer account for a REST service. -
transactionAdjustments: array
Transaction Adjustments
Title:
Transaction AdjustmentsThe resource that provides details of adjustments created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. -
transactionPaymentSchedules: array
Transaction Payment Schedules
Title:
Transaction Payment SchedulesThe resource that provides details of payment schedules for transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. Transactions include invoices, debit memos, and chargebacks. -
transactionsPaidByOtherCustomers: array
Transactions Paid by Other Customers
Title:
Transactions Paid by Other CustomersThe transactions paid by other customers resource provides details of receipt applications for transactions that are paid on behalf of the customer account.
Nested Schema : Credit Memo Applications
Type:
arrayTitle:
Credit Memo ApplicationsThe resource that provides details of credit memo applications created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource.
Show Source
Nested Schema : Credit Memos
Type:
arrayTitle:
Credit MemosThe resource that provides details of credit memos created for customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. It includes standard and on account credit memos.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Standard Receipt Applications
Type:
arrayTitle:
Standard Receipt ApplicationsThe resource that provides details of standard receipt applications created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource.
Show Source
Nested Schema : Standard Receipts
Type:
arrayTitle:
Standard ReceiptsThe resource that provides details of standard receipts created for customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource.
Show Source
Nested Schema : Transaction Adjustments
Type:
arrayTitle:
Transaction AdjustmentsThe resource that provides details of adjustments created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource.
Show Source
Nested Schema : Transaction Payment Schedules
Type:
arrayTitle:
Transaction Payment SchedulesThe resource that provides details of payment schedules for transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. Transactions include invoices, debit memos, and chargebacks.
Show Source
Nested Schema : Transactions Paid by Other Customers
Type:
arrayTitle:
Transactions Paid by Other CustomersThe transactions paid by other customers resource provides details of receipt applications for transactions that are paid on behalf of the customer account.
Show Source
Nested Schema : receivablesCustomerAccountActivities-creditMemoApplications-item-response
Type:
Show Source
object-
AccountingDate: string
(date)
Title:
Application Accounting DateRead Only:trueThe accounting date of the credit memo application for a REST service. -
ActivityName: string
Title:
Receivables Activity NameRead Only:trueMaximum Length:50The name of the credit memo activity for a REST service. -
ApplicationAmount: number
Title:
Applied AmountRead Only:trueThe amount in the entered currency of the credit memo application against a transaction for a REST service. -
ApplicationDate: string
(date)
Title:
Application DateRead Only:trueThe date of the credit memo application against a transaction for a REST service. -
ApplicationId: integer
(int64)
Read Only:
trueThe identifier of the credit memo application against a transaction for a REST service. -
ApplicationStatus: string
Read Only:
trueMaximum Length:80The value that identifies the application status of an activity on a credit memo for a REST service. -
BillToSiteNumber: string
Title:
SiteRead Only:trueMaximum Length:150The name of the customer bill-to site of the credit memo applied against a transaction. -
CreatedBy: string
Read Only:
trueMaximum Length:64The name of the user who created the credit memo application for a REST service. -
CreationDate: string
(date-time)
Read Only:
trueThe date the credit memo application was created for a REST service. -
creditMemoApplicationDFF: array
creditMemoApplicationDFF
-
CreditMemoId: integer
(int64)
Read Only:
trueThe identifier of the credit memo for a REST service. -
CreditMemoNumber: string
Title:
Transaction NumberRead Only:trueMaximum Length:20The number of the credit memo for a REST service. -
CreditMemoStatus: string
Read Only:
trueMaximum Length:80The status of the credit memo application for a REST service. -
EnteredCurrency: string
Read Only:
trueMaximum Length:15The currency code of the entered currency of the credit memo application against a transaction for a REST service. -
IsLatestApplication: string
Title:
Latest ApplicationRead Only:trueMaximum Length:1The value that identifies whether the activity is the latest application on a credit memo for a REST service. Valid values are Y and N. -
LastUpdateDate: string
(date-time)
Title:
Invoice Last Update DateRead Only:trueThe date the credit memo application was last updated for a REST service. -
LastUpdatedBy: string
Title:
Invoice Last Updated ByRead Only:trueMaximum Length:64The name of the user who has last updated the credit memo application for a REST service. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ReferenceInstallmentId: integer
(int64)
Title:
Applied Payment ScheduleRead Only:trueThe identifier of the transaction installment that the credit memo is applied against for a REST service. -
ReferenceTransactionId: integer
(int64)
Read Only:
trueThe identifier of the transaction that the credit memo is applied against for a REST service. -
ReferenceTransactionNumber: string
Read Only:
trueMaximum Length:30The number of the transaction that the credit memo is applied against for a REST service. -
ReferenceTransactionStatus: string
Read Only:
trueMaximum Length:30The status of the transaction that the credit memo is applied against for a REST API. Valid values are Open and Closed. -
TransactionType: string
Title:
Transaction Type NameRead Only:trueMaximum Length:20The credit memo application transaction type for a REST service.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : receivablesCustomerAccountActivities-creditMemoApplications-creditMemoApplicationDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueRead Only:trueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ReceivableApplicationId: integer
(int64)
Read Only:
true
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : receivablesCustomerAccountActivities-creditMemos-item-response
Type:
Show Source
object-
AccountingDate: string
(date)
Title:
Payment Schedule Accounting DateRead Only:trueThe credit memo accounting date for a REST service. -
AvailableAmount: number
Read Only:
trueThe remaining credit memo amount in the entered currency of the credit memo application for a REST service. -
BillToSiteNumber: string
Title:
SiteRead Only:trueMaximum Length:150The name of the customer bill-to site of the credit memo. -
CreatedBy: string
Read Only:
trueMaximum Length:64The name of the user who created the credit memo for a REST service. -
CreationDate: string
(date-time)
Read Only:
trueThe date the credit memo was created for a REST service. -
CreditMemoCurrency: string
Read Only:
trueMaximum Length:15The credit memo currency for a REST service. -
CreditMemoDate: string
(date)
Title:
Transaction DateRead Only:trueThe credit memo transaction date for a REST service. -
CreditMemoId: integer
(int64)
Read Only:
trueThe identifier of the credit memo for a REST service. -
CreditMemoNumber: string
Title:
Transaction NumberRead Only:trueMaximum Length:20The credit memo number for a REST service. -
CreditMemoStatus: string
Read Only:
trueMaximum Length:80The credit memo status for a REST service. -
InstallmentId: integer
(int64)
Read Only:
trueThe identifier of the credit memo installment for a REST service. -
LastUpdateDate: string
(date-time)
Title:
Invoice Last Update DateRead Only:trueThe date the credit memo was last updated for a REST service. -
LastUpdatedBy: string
Title:
Invoice Last Updated ByRead Only:trueMaximum Length:64The name of the user who has last updated the credit memo for a REST service. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PurchaseOrder: string
Title:
PO NumberRead Only:trueMaximum Length:50The purchase order number assigned to the credit memo for a REST service. -
TotalBalanceAmount: number
Title:
Payment Schedule Balance Due AmountRead Only:trueThe remaining credit memo balance amount in the entered currency for a REST service. -
TotalOriginalAmount: number
Title:
Payment Schedule Original Amount DueRead Only:trueThe original credit memo balance amount in the entered currency for a REST service. -
TransactionClass: string
Read Only:
trueMaximum Length:80The credit memo transaction class for a REST service. -
TransactionType: string
Title:
Transaction Type NameRead Only:trueMaximum Length:20The credit memo transaction type for a REST service.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : receivablesCustomerAccountActivities-standardReceiptApplications-item-response
Type:
Show Source
object-
AccountingDate: string
(date)
Title:
Application Accounting DateRead Only:trueThe accounting date of the receipt application for a REST service. -
ActivityName: string
Title:
Receivables Activity NameRead Only:trueMaximum Length:50The name of the receipt activity for a REST service. -
ApplicationAmount: number
Title:
Applied AmountRead Only:trueThe amount of the receipt application against a transaction for a REST service. -
ApplicationDate: string
(date)
Title:
Application DateRead Only:trueThe date of the receipt application against a transaction for a REST service. -
ApplicationId: integer
(int64)
Read Only:
trueThe identifier of the receipt application against a transaction for a REST service. -
ApplicationStatus: string
Read Only:
trueMaximum Length:80The value that identifies the application status of an activity on a standard receipt for a REST service. -
CreatedBy: string
Read Only:
trueMaximum Length:64The name of the user who created the receipt application for a REST service. -
CreationDate: string
(date-time)
Read Only:
trueThe date the receipt application was created for a REST service. -
CustomerSite: string
Title:
SiteRead Only:trueMaximum Length:150The name of the customer bill-to site of the receipt applied against a transaction. -
EnteredCurrency: string
Read Only:
trueMaximum Length:15The currency code of the entered currency of the receipt applied against a transaction for a REST service. -
IsLatestApplication: string
Title:
Latest ApplicationRead Only:trueMaximum Length:1The value that identifies whether the activity is the latest application on a standard receipt for a REST service. Valid values are Y and N. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date the receipt application was last updated for a REST service. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The name of the user who has last updated the receipt application for a REST service. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProcessStatus: string
Read Only:
trueMaximum Length:80The process status of the receipt application for a REST service. -
ReceiptMethod: string
Title:
Receipt MethodRead Only:trueMaximum Length:30The receipt method used for the receipt application against a transaction for a REST service. -
ReceiptNumber: string
Title:
Receipt NumberRead Only:trueMaximum Length:30The number of the receipt application against a transaction for a REST service. -
ReferenceInstallmentId: integer
(int64)
Title:
Applied Payment ScheduleRead Only:trueThe identifier of the transaction installment the receipt is applied against for a REST service. -
ReferenceTransactionId: integer
(int64)
Read Only:
trueThe identifier of the transaction the receipt is applied against for a REST service. -
ReferenceTransactionNumber: string
Read Only:
trueMaximum Length:30The number of the transaction the receipt is applied against for a REST service. -
ReferenceTransactionStatus: string
Read Only:
trueMaximum Length:30The status of the transaction that the receipt is applied against for a REST API. Valid values are Open and Closed. -
standardReceiptApplicationDFF: array
standardReceiptApplicationDFF
-
StandardReceiptId: integer
(int64)
Title:
Cash Receipt IDRead Only:trueThe identifier of the receipt number for a REST service.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : receivablesCustomerAccountActivities-standardReceiptApplications-standardReceiptApplicationDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueRead Only:trueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ReceivableApplicationId: integer
(int64)
Read Only:
true
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : receivablesCustomerAccountActivities-standardReceipts-item-response
Type:
Show Source
object-
AccountingDate: string
(date)
Title:
Receipt History Accounting DateRead Only:trueThe accounting date of the receipt applied against a transaction for a REST service. -
Amount: number
Title:
Receipt AmountRead Only:trueThe original receipt amount in the entered currency of the receipt application for a REST service. -
AvailableAmount: number
Read Only:
trueThe remaining receipt amount in the entered currency of the receipt application for a REST service. -
BusinessUnit: string
Title:
Business UnitRead Only:trueMaximum Length:240The business unit of the receipt applied against a transaction for a REST service. -
CreatedBy: string
Read Only:
trueMaximum Length:64The name of the user who created the receipt for a REST service. -
CreationDate: string
(date-time)
Read Only:
trueThe date the receipt applied against a transaction was created for a REST service. -
Currency: string
Read Only:
trueMaximum Length:15The currency code of the receipt applied against a transaction for a REST service. -
CustomerSite: string
Title:
SiteRead Only:trueMaximum Length:150The name of the customer bill-to site of the receipt. -
DocumentNumber: integer
(int64)
Title:
Document NumberRead Only:trueThe document sequence number of the receipt applied against a transaction for a REST service. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date the receipt applied against a transaction was last updated for a REST service. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The name of the user who has last updated the receipt applied against a transaction for a REST service. -
LegalEntity: string
Title:
Legal Entity NameRead Only:trueMaximum Length:240The legal entity of the receipt applied against a transaction for a REST service. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProcessStatus: string
Read Only:
trueMaximum Length:10The process status of the receipt applied against a transaction for a REST service. -
ReceiptDate: string
(date)
Title:
Receipt DateRead Only:trueThe date of the receipt applied against a transaction for a REST service. -
ReceiptMethod: string
Title:
Receipt MethodRead Only:trueMaximum Length:30The receipt method used to create the receipt applied against a transaction for a REST service. -
ReceiptNumber: string
Title:
Receipt NumberRead Only:trueMaximum Length:30The number of the receipt applied against a transaction for a REST service. -
StandardReceiptId: integer
(int64)
Title:
Cash Receipt IDRead Only:trueThe identifier of the receipt applied against a transaction for a REST service. -
State: string
Read Only:
trueMaximum Length:80The tag that identifies the state of a receipt for a REST service. Valid values are: Applied, Unapplied, Unidentified, Insufficient Funds, Reverse Payment, and Stop Payment. -
UnappliedAmount: number
Read Only:
trueThe unapplied amount in the entered currency of the receipt applied against a transaction for a REST service.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : receivablesCustomerAccountActivities-transactionAdjustments-item-response
Type:
Show Source
object-
AccountingDate: string
(date)
Read Only:
trueThe accounting date of the transaction adjustment for a REST service. -
AdjustmentAmount: number
Read Only:
trueThe amount of the transaction adjustment for a REST service. -
AdjustmentId: integer
(int64)
Read Only:
trueThe identifier of the transaction adjustment for a REST service. -
AdjustmentNumber: string
Read Only:
trueMaximum Length:20The number assigned to the transaction adjustment for a REST service. -
AdjustmentReason: string
Read Only:
trueMaximum Length:80The reason code assigned to the transaction adjustment for a REST service. -
AdjustmentType: string
Read Only:
trueMaximum Length:80The adjustment type assigned to the transaction adjustment for a REST service. -
ApplicationDate: string
(date)
Read Only:
trueThe application date of the transaction adjustment for a REST service. -
BillToSiteNumber: string
Title:
SiteRead Only:trueMaximum Length:150The name of the customer bill-to site of the transaction adjustment. -
CreatedBy: string
Read Only:
trueMaximum Length:64The name of the user who created the transaction adjustment for a REST service. -
CreationDate: string
(date-time)
Read Only:
trueThe creation date of the transaction adjustment for a REST service. -
EnteredCurrency: string
Read Only:
trueMaximum Length:15The currency code of the transaction adjustment for a REST service. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date the transaction adjustment was last updated for a REST service. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The name of the user who last updated the transaction adjustment for a REST service. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProcessStatus: string
Read Only:
trueMaximum Length:80The process status of the transaction adjustment for a REST service. -
ReferenceInstallmentId: integer
(int64)
Read Only:
trueThe identifier of the adjusted transaction installment for a REST service. -
ReferenceTransactionId: integer
(int64)
Read Only:
trueThe identifier of the adjusted transaction for a REST service. -
ReferenceTransactionNumber: string
Title:
Transaction NumberRead Only:trueMaximum Length:20The number of the adjusted transaction for a REST service. -
ReferenceTransactionStatus: string
Read Only:
trueMaximum Length:80The status of the transaction that the adjustment is made against for a REST API. Valid values are Open and Closed.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : receivablesCustomerAccountActivities-transactionPaymentSchedules-item-response
Type:
Show Source
object-
AccountingDate: string
(date)
Title:
Payment Schedule Accounting DateRead Only:trueThe payment schedule installment accounting date for a REST service. -
BillToSiteNumber: string
Title:
SiteRead Only:trueMaximum Length:150The name of the customer bill-to site of the transaction payment schedule. -
CreatedBy: string
Read Only:
trueMaximum Length:64The name of the user who created the payment schedule installment for a REST service. -
CreationDate: string
(date-time)
Read Only:
trueThe creation date of the payment schedule installment for a REST service. -
EnteredCurrency: string
Read Only:
trueMaximum Length:15The currency code of the payment schedule installment for a REST service. -
InstallmentId: integer
(int64)
Read Only:
trueThe identifier of the payment schedule installment for a REST service. -
InstallmentNumber: integer
(int64)
Read Only:
trueThe number of the payment schedule installment for a REST service. -
InstallmentStatus: string
Read Only:
trueMaximum Length:80The status of the payment schedule installment for a REST service. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date the payment schedule installment was last updated for a REST service. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The name of the user who last updated the payment schedule installment for a REST service. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PaymentDaysLate: integer
Read Only:
trueThe number of days the payment schedule installment is past due for a REST service. -
PaymentScheduleDueDate: string
(date)
Title:
Maturity DateRead Only:trueThe payment terms due date of the payment schedule installment for a REST service. -
PurchaseOrder: string
Title:
PO NumberRead Only:trueMaximum Length:50The purchase order number assigned to the payment schedule installment for a REST service. -
ReceiptMethod: string
Title:
Receipt MethodRead Only:trueMaximum Length:30The receipt method used for the receipt applied against the payment schedule installment for a REST service. -
StructuredPaymentReference: string
Read Only:
trueMaximum Length:256The name of the structured payment reference assigned to the payment schedule transaction for a REST service. -
TotalBalanceAmount: number
Title:
Payment Schedule Balance Due AmountRead Only:trueThe open balance amount on the payment schedule installment for a REST service. -
TotalOriginalAmount: number
Title:
Payment Schedule Original Amount DueRead Only:trueThe original balance amount on the payment schedule installment for a REST service. -
TransactionClass: string
Read Only:
trueMaximum Length:80The transaction class of the payment schedule installment for a REST service. -
TransactionDate: string
(date)
Title:
Transaction DateRead Only:trueThe transaction date of the payment schedule installment for a REST service. -
TransactionId: integer
(int64)
Read Only:
trueThe transaction identifier of the payment schedule installment for a REST service. -
TransactionNumber: string
Title:
Transaction NumberRead Only:trueMaximum Length:20The transaction number of the payment schedule installment for a REST service. -
TransactionSourceName: string
Read Only:
trueMaximum Length:50The name of the transaction source assigned to the payment schedule transaction for a REST service. -
TransactionType: string
Title:
Transaction Type NameRead Only:trueMaximum Length:20The transaction type of the payment schedule installment for a REST service.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : receivablesCustomerAccountActivities-transactionsPaidByOtherCustomers-item-response
Type:
Show Source
object-
AccountingDate: string
(date)
Title:
Application Accounting DateRead Only:trueThe accounting date of the receipt application for a REST service. -
ApplicationAmount: number
Title:
Applied AmountRead Only:trueThe amount of the receipt application against a transaction for a REST service. -
ApplicationDate: string
(date)
Title:
Application DateRead Only:trueThe date of the receipt application against a transaction for a REST service. -
ApplicationId: integer
(int64)
Read Only:
trueThe identifier of the receipt application against a transaction for a REST service. -
ApplicationStatus: string
Read Only:
trueMaximum Length:80The value that identifies the application status of an activity on a standard receipt for a REST service. -
CreatedBy: string
Read Only:
trueMaximum Length:64The name of the user who created the receipt application for a REST service. -
CreationDate: string
(date-time)
Read Only:
trueThe date the receipt application was created for a REST service. -
EnteredCurrency: string
Read Only:
trueMaximum Length:15The currency code of the entered currency of the receipt applied against a transaction for a REST service. -
IsLatestApplication: string
Title:
Latest ApplicationRead Only:trueMaximum Length:1The value that identifies whether the activity is the latest application on a standard receipt for a REST service. Valid values are Y and N. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date the receipt application was last updated for a REST service. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The name of the user who has last updated the receipt application for a REST service. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProcessStatus: string
Read Only:
trueMaximum Length:80The process status of the receipt application for a REST service. -
ReceiptMethod: string
Title:
Receipt MethodRead Only:trueMaximum Length:30The receipt method used for the receipt application against a transaction for a REST service. -
ReceiptNumber: string
Title:
Receipt NumberRead Only:trueMaximum Length:30The number of the receipt application against a transaction for a REST service. -
ReferenceInstallmentId: integer
(int64)
Title:
Applied Payment ScheduleRead Only:trueThe identifier of the transaction installment the receipt is applied against for a REST service. -
ReferenceTransactionId: integer
(int64)
Read Only:
trueThe identifier of the transaction the receipt is applied against for a REST service. -
ReferenceTransactionNumber: string
Read Only:
trueMaximum Length:30The number of the transaction the receipt is applied against for a REST service. -
ReferenceTransactionStatus: string
Read Only:
trueMaximum Length:30The status of the transaction that the receipt is applied against for a REST API. Valid values are Open and Closed. -
StandardReceiptId: integer
(int64)
Title:
Cash Receipt IDRead Only:trueThe identifier of the receipt number for a REST service.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- creditMemoApplications
-
Parameters:
- AccountId:
$request.path.AccountId
The resource that provides details of credit memo applications created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. - AccountId:
- creditMemos
-
Parameters:
- AccountId:
$request.path.AccountId
The resource that provides details of credit memos created for customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. It includes standard and on account credit memos. - AccountId:
- standardReceiptApplications
-
Parameters:
- AccountId:
$request.path.AccountId
The resource that provides details of standard receipt applications created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. - AccountId:
- standardReceipts
-
Parameters:
- AccountId:
$request.path.AccountId
The resource that provides details of standard receipts created for customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. - AccountId:
- transactionAdjustments
-
Parameters:
- AccountId:
$request.path.AccountId
The resource that provides details of adjustments created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. - AccountId:
- transactionPaymentSchedules
-
Parameters:
- AccountId:
$request.path.AccountId
The resource that provides details of payment schedules for transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. Transactions include invoices, debit memos, and chargebacks. - AccountId:
- transactionsPaidByOtherCustomers
-
Parameters:
- AccountId:
$request.path.AccountId
The transactions paid by other customers resource provides details of receipt applications for transactions that are paid on behalf of the customer account. - AccountId: