1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Receivables Customer Account Site Activities

Get all customer account activities

get

/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • CustomerAccountSiteActivitiesFinder Finds customer account activity details using the finder attributes specified.
      Finder Variables
      • AccountNumber; string; The number of the customer account to use in the customer inquiry for a REST service.
      • BillToSiteNumber; string; The number that identifies the bill-to site associated with a customer party for a REST service.
      • CustomerName; string; The name of the customer to use in the customer inquiry for a REST service.
      • TaxRegistrationNumber; string; The registration number for tax purposes assigned to the bill-to customer to use in the customer inquiry for a REST service.
      • TaxpayerIdentificationNumber; string; The number that identifies the customer party to a tax authority to pay and report direct taxes to use for inclusion in the customer inquiry for a REST service.
      • TransactionLimitByDays; integer; The number of days past the transaction date to consider transactions for inclusion in the customer inquiry for a REST service. The default value is 90 days.
      • TransactionStatus; string; The status of transactions to consider for inclusion in the customer inquiry for a REST service. Valid values are Complete and Incomplete.
    • PrimaryKey Finds customer account activities using the finder attributes specified.
      Finder Variables
      • BillToSiteUseId; integer; The unique identifier of a customer bill-to site used for a REST service.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AccountId; integer; The unique identifier of a customer account for a REST service.
    • AccountNumber; string; The number that identifies a customer account.
    • BillToSiteNumber; string; The customer site number of the bill-to site associated with a customer party for a REST service.
    • BillToSiteUseId; integer; The unique identifier of the bill-to site business purpose associated with a customer party for a REST service.
    • CustomerId; integer; The identifier of the customer party associated with the customer account for a REST service.
    • CustomerName; string; The name of the customer party associated with the customer account for a REST service.
    • TaxRegistrationNumber; string; The registration number for tax purposes assigned to the bill-to customer for a REST service.
    • TaxpayerIdentificationNumber; string; The number that identifies the customer party to a tax authority to pay and report direct taxes for a REST service.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : receivablesCustomerAccountSiteActivities
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : receivablesCustomerAccountSiteActivities-item-response
Type: object
Show Source
  • Read Only: true
    The unique identifier of a customer account for a REST service.
  • Title: Account Number
    Read Only: true
    Maximum Length: 30
    The number that identifies a customer account.
  • Read Only: true
    Maximum Length: 700
    The address of the bill-to site associated with a customer party for a REST service.
  • Title: Site
    Read Only: true
    Maximum Length: 150
    The customer site number of the bill-to site associated with a customer party for a REST service.
  • Read Only: true
    The unique identifier of the bill-to site business purpose associated with a customer party for a REST service.
  • Read Only: true
    Maximum Length: 64
    The name of the user who created the customer account for a REST service.
  • Read Only: true
    The date the customer account was created for a REST service.
  • Credit Memo Applications
    Title: Credit Memo Applications
    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.
  • Credit Memos
    Title: Credit Memos
    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.
  • Title: Party ID
    Read Only: true
    The identifier of the customer party associated with the customer account for a REST service.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The name of the customer party associated with the customer account for a REST service.
  • Read Only: true
    The date the customer account was last updated for a REST service.
  • Read Only: true
    Maximum Length: 64
    The name of the user who has last updated the customer account for a REST service.
  • Links
  • Standard Receipt Applications
    Title: Standard Receipt Applications
    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.
  • Standard Receipts
    Title: Standard Receipts
    The resource that provides details of standard receipts created for customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource.
  • Title: Taxpayer Identification Number
    Read Only: true
    Maximum Length: 20
    The number that identifies the customer party to a tax authority to pay and report direct taxes for a REST service.
  • Title: Tax Registration Number
    Read Only: true
    Maximum Length: 50
    The registration number for tax purposes assigned to the bill-to customer for a REST service.
  • Read Only: true
    The total open receivables amount in the ledger currency of a customer bill-to site for a REST service.
  • Read Only: true
    The total transaction amount due in the ledger currency of a customer bill-to site for a REST service.
  • Transaction Adjustments
    Title: Transaction Adjustments
    The resource that provides details of adjustments created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource.
  • Transaction Payment Schedules
    Title: Transaction Payment Schedules
    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.
  • Transactions Paid by Other Customers
    Title: Transactions Paid by Other Customers
    The 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: array
Title: Credit Memo Applications
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.
Show Source
Nested Schema : Credit Memos
Type: array
Title: Credit Memos
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.
Show Source
Nested Schema : Standard Receipt Applications
Type: array
Title: Standard Receipt Applications
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.
Show Source
Nested Schema : Standard Receipts
Type: array
Title: Standard Receipts
The 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: array
Title: Transaction Adjustments
The 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: array
Title: Transaction Payment Schedules
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.
Show Source
Nested Schema : Transactions Paid by Other Customers
Type: array
Title: Transactions Paid by Other Customers
The 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 : receivablesCustomerAccountSiteActivities-creditMemoApplications-item-response
Type: object
Show Source
Nested Schema : creditMemoApplicationDFF
Type: array
Show Source
Nested Schema : receivablesCustomerAccountSiteActivities-creditMemoApplications-creditMemoApplicationDFF-item-response
Type: object
Show Source
Nested Schema : receivablesCustomerAccountSiteActivities-creditMemos-item-response
Type: object
Show Source
Nested Schema : receivablesCustomerAccountSiteActivities-standardReceiptApplications-item-response
Type: object
Show Source
Nested Schema : standardReceiptApplicationDFF
Type: array
Show Source
Nested Schema : receivablesCustomerAccountSiteActivities-standardReceiptApplications-standardReceiptApplicationDFF-item-response
Type: object
Show Source
Nested Schema : receivablesCustomerAccountSiteActivities-standardReceipts-item-response
Type: object
Show Source
  • Title: Receipt History Accounting Date
    Read Only: true
    The accounting date of the receipt applied against a transaction for a REST service.
  • Title: Receipt Amount
    Read Only: true
    The original receipt amount in the entered currency of the receipt application for a REST service.
  • Read Only: true
    The remaining receipt amount in the entered currency of the receipt application for a REST service.
  • Title: Business Unit
    Read Only: true
    Maximum Length: 240
    The business unit of the receipt applied against a transaction for a REST service.
  • Read Only: true
    Maximum Length: 64
    The name of the user who created the receipt for a REST service.
  • Read Only: true
    The date the receipt applied against a transaction was created for a REST service.
  • Read Only: true
    Maximum Length: 15
    The currency code of the receipt applied against a transaction for a REST service.
  • Title: Site
    Read Only: true
    Maximum Length: 150
    The name of the customer bill-to site of the receipt.
  • Title: Document Number
    Read Only: true
    The document sequence number of the receipt applied against a transaction for a REST service.
  • Read Only: true
    The date the receipt applied against a transaction was last updated for a REST service.
  • Read Only: true
    Maximum Length: 64
    The name of the user who has last updated the receipt applied against a transaction for a REST service.
  • Title: Legal Entity Name
    Read Only: true
    Maximum Length: 240
    The legal entity of the receipt applied against a transaction for a REST service.
  • Links
  • Read Only: true
    Maximum Length: 10
    The process status of the receipt applied against a transaction for a REST service.
  • Title: Receipt Date
    Read Only: true
    The date of the receipt applied against a transaction for a REST service.
  • Title: Receipt Method
    Read Only: true
    Maximum Length: 30
    The receipt method used to create the receipt applied against a transaction for a REST service.
  • Title: Receipt Number
    Read Only: true
    Maximum Length: 30
    The number of the receipt applied against a transaction for a REST service.
  • Title: Cash Receipt ID
    Read Only: true
    The identifier of the receipt applied against a transaction for a REST service.
  • Read Only: true
    Maximum Length: 80
    The 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.
  • Read Only: true
    The unapplied amount in the entered currency of the receipt applied against a transaction for a REST service.
Nested Schema : receivablesCustomerAccountSiteActivities-transactionAdjustments-item-response
Type: object
Show Source
Nested Schema : receivablesCustomerAccountSiteActivities-transactionPaymentSchedules-item-response
Type: object
Show Source
  • Title: Payment Schedule Accounting Date
    Read Only: true
    The payment schedule installment accounting date for a REST service.
  • Title: Site
    Read Only: true
    Maximum Length: 150
    The name of the customer bill-to site of the transaction payment schedule.
  • Read Only: true
    Maximum Length: 64
    The name of the user who created the payment schedule installment for a REST service.
  • Read Only: true
    The creation date of the payment schedule installment for a REST service.
  • Read Only: true
    Maximum Length: 15
    The currency code of the payment schedule installment for a REST service.
  • Read Only: true
    The identifier of the payment schedule installment for a REST service.
  • Read Only: true
    The number of the payment schedule installment for a REST service.
  • Read Only: true
    Maximum Length: 80
    The status of the payment schedule installment for a REST service.
  • Read Only: true
    The date the payment schedule installment was last updated for a REST service.
  • Read Only: true
    Maximum Length: 64
    The name of the user who last updated the payment schedule installment for a REST service.
  • Links
  • Read Only: true
    The number of days the payment schedule installment is past due for a REST service.
  • Title: Maturity Date
    Read Only: true
    The payment terms due date of the payment schedule installment for a REST service.
  • Title: PO Number
    Read Only: true
    Maximum Length: 50
    The purchase order number assigned to the payment schedule installment for a REST service.
  • Title: Receipt Method
    Read Only: true
    Maximum Length: 30
    The receipt method used for the receipt applied against the payment schedule installment for a REST service.
  • Read Only: true
    Maximum Length: 256
    The name of the structured payment reference assigned to the payment schedule transaction for a REST service.
  • Title: Payment Schedule Balance Due Amount
    Read Only: true
    The open balance amount on the payment schedule installment for a REST service.
  • Title: Payment Schedule Original Amount Due
    Read Only: true
    The original balance amount on the payment schedule installment for a REST service.
  • Read Only: true
    Maximum Length: 80
    The transaction class of the payment schedule installment for a REST service.
  • Title: Transaction Date
    Read Only: true
    The transaction date of the payment schedule installment for a REST service.
  • Read Only: true
    The transaction identifier of the payment schedule installment for a REST service.
  • Title: Transaction Number
    Read Only: true
    Maximum Length: 20
    The transaction number of the payment schedule installment for a REST service.
  • Read Only: true
    Maximum Length: 50
    The name of the transaction source assigned to the payment schedule transaction for a REST service.
  • Title: Transaction Type Name
    Read Only: true
    Maximum Length: 20
    The transaction type of the payment schedule installment for a REST service.
Nested Schema : receivablesCustomerAccountSiteActivities-transactionsPaidByOtherCustomers-item-response
Type: object
Show Source
  • Title: Application Accounting Date
    Read Only: true
    The accounting date of the receipt application for a REST service.
  • Title: Applied Amount
    Read Only: true
    The amount of the receipt application against a transaction for a REST service.
  • Title: Application Date
    Read Only: true
    The date of the receipt application against a transaction for a REST service.
  • Read Only: true
    The identifier of the receipt application against a transaction for a REST service.
  • Read Only: true
    Maximum Length: 80
    The value that identifies the application status of an activity on a standard receipt for a REST service.
  • Read Only: true
    Maximum Length: 64
    The name of the user who created the receipt application for a REST service.
  • Read Only: true
    The date the receipt application was created for a REST service.
  • Read Only: true
    Maximum Length: 15
    The currency code of the entered currency of the receipt applied against a transaction for a REST service.
  • Title: Latest Application
    Read Only: true
    Maximum Length: 1
    The value that identifies whether the activity is the latest application on a standard receipt for a REST service. Valid values are Y and N.
  • Read Only: true
    The date the receipt application was last updated for a REST service.
  • Read Only: true
    Maximum Length: 64
    The name of the user who has last updated the receipt application for a REST service.
  • Links
  • Read Only: true
    Maximum Length: 80
    The process status of the receipt application for a REST service.
  • Title: Receipt Method
    Read Only: true
    Maximum Length: 30
    The receipt method used for the receipt application against a transaction for a REST service.
  • Title: Receipt Number
    Read Only: true
    Maximum Length: 30
    The number of the receipt application against a transaction for a REST service.
  • Title: Applied Payment Schedule
    Read Only: true
    The identifier of the transaction installment the receipt is applied against for a REST service.
  • Read Only: true
    The identifier of the transaction the receipt is applied against for a REST service.
  • Read Only: true
    Maximum Length: 30
    The number of the transaction the receipt is applied against for a REST service.
  • Read Only: true
    Maximum Length: 30
    The status of the transaction that the receipt is applied against for a REST API. Valid values are Open and Closed.
  • Title: Cash Receipt ID
    Read Only: true
    The identifier of the receipt number for a REST service.
Back to Top

Examples

The following example shows how to retrieve all the customer account activities details by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "items": [
    {
      "BillToSiteUseId": 10726,
      "BillToSiteNumber": "10721",
      "BillToSiteAddress": "1800 Sinclair Street  42201 ABERDEEN ",
      "AccountNumber": "1270",
      "AccountId": 2763,
      "CustomerName": "Lauri Reilly",
      "CustomerId": 3179,
      "TaxRegistrationNumber": null,
      "TaxpayerIdentificationNumber": null,
      "TotalOpenReceivablesForSite": 0,
      "TotalTransactionsDueForSite": 0,
      "CreatedBy": "1318",
      "CreationDate": "2004-10-14T07:31:07+00:00",
      "LastUpdateDate": "2004-10-14T07:31:07+00:00",
      "LastUpdatedBy": "1318",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/10726",
          "name": "receivablesCustomerAccountSiteActivities",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/10726",
          "name": "receivablesCustomerAccountSiteActivities",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/10726/child/creditMemoApplications",
          "name": "creditMemoApplications",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/10726/child/creditMemos",
          "name": "creditMemos",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/10726/child/standardReceiptApplications",
          "name": "standardReceiptApplications",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/10726/child/standardReceipts",
          "name": "standardReceipts",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/10726/child/transactionAdjustments",
          "name": "transactionAdjustments",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/10726/child/transactionPaymentSchedules",
          "name": "transactionPaymentSchedules",
          "kind": "collection"
        }
      ]
    },
    {
      "BillToSiteUseId": 3028,
      "BillToSiteNumber": "New York",
      "BillToSiteAddress": "10 Charles  94303 Paris ",
      "AccountNumber": "1040",
      "AccountId": 2480,
      "CustomerName": "Global Enterprises",
      "CustomerId": 2780,
      "TaxRegistrationNumber": null,
      "TaxpayerIdentificationNumber": "8-98876532",
      "TotalOpenReceivablesForSite": 0,
      "TotalTransactionsDueForSite": 0,
      "CreatedBy": "1000200",
      "CreationDate": "2000-07-18T00:00:00+00:00",
      "LastUpdateDate": "2001-02-19T11:22:56+00:00",
      "LastUpdatedBy": "1000049",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/3028",
          "name": "receivablesCustomerAccountSiteActivities",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/3028",
          "name": "receivablesCustomerAccountSiteActivities",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/3028/child/creditMemoApplications",
          "name": "creditMemoApplications",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/3028/child/creditMemos",
          "name": "creditMemos",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/3028/child/standardReceiptApplications",
          "name": "standardReceiptApplications",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/3028/child/standardReceipts",
          "name": "standardReceipts",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/3028/child/transactionAdjustments",
          "name": "transactionAdjustments",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/3028/child/transactionPaymentSchedules",
          "name": "transactionPaymentSchedules",
          "kind": "collection"
        }
      ]
    }
  ]
}
Back to Top