FTOS_TPM_GetAvailableDetails

Retrieves the pre-invoice details of the specified customer and agreement combination which were not attached to an invoice yet. You can further filter the results to display only the details for a certain product or product type, according to your needs.

Syntax

The FTOS_TPM_GetAvailableDetails custom endpoint is called from within the Endpoint API endpoint. Visit the Endpoint API page for more details.

Copy 
POST <host_address>/ftosapi/automation-processors/actions/FTOS_TPM_GetAvailableDetails
Content-Type: application/json
            
{
  "agreementNo": "<third_party_agreement_number>",
  "customerNo": "<customer_number>",
  "productTypeCode": "<product_type_code>",
  "productCode": "<product_code>"
}

Here's a list of the available parameters:

Parameter Description
host_address URL of the FintechOS Platform server.
customerNo Mandatory. The number of the customer for whom an agreement is searched.
agreementNo Mandatory. The agreement number.
productTypeCode Optional, text. The code of the product type for which you wish to return the pre-invoice details generated for the customer/ agreement combination.
productCode Optional, text. The code of the product for which you wish to return the pre-invoice details generated for the customer/ agreement combination.

Response

The response indicates the result of the code execution and it returns a json containing the pre-invoice details filtered according to the sent parameters, where Invoiced = False.

Copy

Response JSON Schema

{
  "IsSuccess": false,
  "AvailableDetails": [
    {
      "Agreement": "Agreement",
      "AgreementPricing": "AgreementPricing",
      "CalculatedValue": 0.0,
      "Commission": "Commission",
      "Contract": "Contract",
      "Currency": "Currency",
      "Event": "Event",
      "PaymentType": "PaymentType",
      "PreInvoiceDetail": "PreInvoiceDetail"
    }
  ]
}

Example

To retrieve all the pre-invoice details of the specified customer/ agreement combination which are not attached to an invoice yet, send the following request, making sure you replace the parameter values with your own values:

Request

Copy 
POST https://FintechOSStudio/ftosapi/automation-processors/actions/FTOS_TPM_GetAvailableDetails
Content-Type: application/json
            
{
    "customerNo": "756",
    "agreementNo": "AG000000384",
    "productTypeCode": "",
    "productCode": ""
}

Response

Copy 
{
    "IsSuccess": true,
    "AvailableDetails": [
        {
            "PreInvoiceDetail": "12697",
            "Agreement": "AG000000384",
            "AgreementPricing": "AGP00000168",
            "Contract": "12697",
            "Event": null,
            "Commission": "OnePercentLoanAmount",
            "Currency": "Euro",
            "PaymentType": "Payment In",
            "CalculatedValue": 120.000000
        }
    ]
}