Seu Template de Dados para Gestão de Crédito e Cobrança

/*
 This is a configuration model for a HighRadius custom report. 
 It is not an executable SQL script but a blueprint for building the report in the UI.
 The report should be configured to UNION the following data blocks to create a single event log.
*/

// Report Name: ProcessMind_Credit_Collections_Log
// Report Output Format: CSV

// === BLOCK 1: Credit Limit Requested ===
{
  "ActivityName": "Credit Limit Requested",
  "Source Object": "CreditRequests",
  "Join Condition": "CreditRequests.CustomerId = Invoices.CustomerId",
  "Columns": {
    "InvoiceNumber": null, // May not be available at this stage
    "ActivityName": "Credit Limit Requested",
    "EventTime": "CreditRequests.RequestTimestamp",
    "CollectorName": "CreditRequests.CreditAnalystName",
    "CustomerId": "CreditRequests.CustomerId",
    "InvoiceAmount": null,
    "PaymentTerms": null,
    "DueDate": null,
    "PaymentStatus": null,
    "DisputeReason": null
  }
}

// === BLOCK 2: Credit Limit Approved ===
{
  "ActivityName": "Credit Limit Approved",
  "Source Object": "CreditRequests",
  "Join Condition": "CreditRequests.CustomerId = Invoices.CustomerId",
  "Columns": {
    "InvoiceNumber": null, // May not be available at this stage
    "ActivityName": "Credit Limit Approved",
    "EventTime": "CreditRequests.ApprovalTimestamp",
    "CollectorName": "CreditRequests.CreditAnalystName",
    "CustomerId": "CreditRequests.CustomerId",
    "InvoiceAmount": null,
    "PaymentTerms": null,
    "DueDate": null,
    "PaymentStatus": null,
    "DisputeReason": null
  }
}

// === BLOCK 3: Invoice Generated ===
{
  "ActivityName": "Invoice Generated",
  "Source Object": "Invoices",
  "Columns": {
    "InvoiceNumber": "Invoices.InvoiceNumber",
    "ActivityName": "Invoice Generated",
    "EventTime": "Invoices.CreationTimestamp",
    "CollectorName": null,
    "CustomerId": "Invoices.CustomerId",
    "InvoiceAmount": "Invoices.InvoiceAmount",
    "PaymentTerms": "Invoices.PaymentTerms",
    "DueDate": "Invoices.DueDate",
    "PaymentStatus": "Invoices.PaymentStatus",
    "DisputeReason": null
  }
}

// === BLOCK 4: Invoice Sent to Customer ===
{
  "ActivityName": "Invoice Sent to Customer",
  "Source Object": "CustomerCommunications",
  "Filter": "CustomerCommunications.Type = 'Invoice Delivery'",
  "Columns": {
    "InvoiceNumber": "CustomerCommunications.InvoiceNumber",
    "ActivityName": "Invoice Sent to Customer",
    "EventTime": "CustomerCommunications.SentTimestamp",
    "CollectorName": null,
    "CustomerId": "[From joined Invoice]",
    "InvoiceAmount": "[From joined Invoice]",
    "PaymentTerms": "[From joined Invoice]",
    "DueDate": "[From joined Invoice]",
    "PaymentStatus": "[From joined Invoice]",
    "DisputeReason": null
  }
}

// === BLOCK 5: Payment Due Date Passed ===
{
  "ActivityName": "Payment Due Date Passed",
  "Source Object": "Invoices",
  "Filter": "Invoices.DueDate < CURRENT_DATE AND Invoices.PaymentStatus = 'Open'",
  "Columns": {
    "InvoiceNumber": "Invoices.InvoiceNumber",
    "ActivityName": "Payment Due Date Passed",
    "EventTime": "Invoices.DueDate",
    "CollectorName": "Invoices.AssignedCollector",
    "CustomerId": "Invoices.CustomerId",
    "InvoiceAmount": "Invoices.InvoiceAmount",
    "PaymentTerms": "Invoices.PaymentTerms",
    "DueDate": "Invoices.DueDate",
    "PaymentStatus": "Invoices.PaymentStatus",
    "DisputeReason": null
  }
}

// === BLOCK 6: Overdue Reminder Sent ===
{
  "ActivityName": "Overdue Reminder Sent",
  "Source Object": "DunningHistory",
  "Filter": "DunningHistory.Action = 'Reminder'",
  "Columns": {
    "InvoiceNumber": "DunningHistory.InvoiceNumber",
    "ActivityName": "Overdue Reminder Sent",
    "EventTime": "DunningHistory.ExecutionTimestamp",
    "CollectorName": null, // Often automated
    "CustomerId": "[From joined Invoice]",
    "InvoiceAmount": "[From joined Invoice]",
    "PaymentTerms": "[From joined Invoice]",
    "DueDate": "[From joined Invoice]",
    "PaymentStatus": "[From joined Invoice]",
    "DisputeReason": null
  }
}

// === BLOCK 7: Dunning Procedure Initiated ===
{
  "ActivityName": "Dunning Procedure Initiated",
  "Source Object": "DunningHistory",
  "Filter": "DunningHistory.Action = 'Dunning Level 1'",
  "Columns": {
    "InvoiceNumber": "DunningHistory.InvoiceNumber",
    "ActivityName": "Dunning Procedure Initiated",
    "EventTime": "DunningHistory.ExecutionTimestamp",
    "CollectorName": null, // Often automated
    "CustomerId": "[From joined Invoice]",
    "InvoiceAmount": "[From joined Invoice]",
    "PaymentTerms": "[From joined Invoice]",
    "DueDate": "[From joined Invoice]",
    "PaymentStatus": "[From joined Invoice]",
    "DisputeReason": null
  }
}

// === BLOCK 8: Collection Call Logged ===
{
  "ActivityName": "Collection Call Logged",
  "Source Object": "CollectorActivityLog",
  "Filter": "CollectorActivityLog.Type = 'Call'",
  "Columns": {
    "InvoiceNumber": "CollectorActivityLog.InvoiceNumber",
    "ActivityName": "Collection Call Logged",
    "EventTime": "CollectorActivityLog.ActivityTimestamp",
    "CollectorName": "CollectorActivityLog.CollectorName",
    "CustomerId": "[From joined Invoice]",
    "InvoiceAmount": "[From joined Invoice]",
    "PaymentTerms": "[From joined Invoice]",
    "DueDate": "[From joined Invoice]",
    "PaymentStatus": "[From joined Invoice]",
    "DisputeReason": null
  }
}

// === BLOCK 9: Promise to Pay Created ===
{
  "ActivityName": "Promise to Pay Created",
  "Source Object": "PromiseToPay",
  "Columns": {
    "InvoiceNumber": "PromiseToPay.InvoiceNumber",
    "ActivityName": "Promise to Pay Created",
    "EventTime": "PromiseToPay.CreationTimestamp",
    "CollectorName": "PromiseToPay.CreatedByCollector",
    "CustomerId": "[From joined Invoice]",
    "InvoiceAmount": "[From joined Invoice]",
    "PaymentTerms": "[From joined Invoice]",
    "DueDate": "[From joined Invoice]",
    "PaymentStatus": "[From joined Invoice]",
    "DisputeReason": null
  }
}

// === BLOCK 10: Dispute Registered ===
{
  "ActivityName": "Dispute Registered",
  "Source Object": "DisputeCase",
  "Columns": {
    "InvoiceNumber": "DisputeCase.InvoiceNumber",
    "ActivityName": "Dispute Registered",
    "EventTime": "DisputeCase.CreationTimestamp",
    "CollectorName": "DisputeCase.AssignedAnalyst",
    "CustomerId": "[From joined Invoice]",
    "InvoiceAmount": "[From joined Invoice]",
    "PaymentTerms": "[From joined Invoice]",
    "DueDate": "[From joined Invoice]",
    "PaymentStatus": "Disputed",
    "DisputeReason": "DisputeCase.ReasonCode"
  }
}

// === BLOCK 11: Dispute Resolved ===
{
  "ActivityName": "Dispute Resolved",
  "Source Object": "DisputeCase",
  "Filter": "DisputeCase.Status = 'Closed' OR DisputeCase.Status = 'Resolved'",
  "Columns": {
    "InvoiceNumber": "DisputeCase.InvoiceNumber",
    "ActivityName": "Dispute Resolved",
    "EventTime": "DisputeCase.ResolutionTimestamp",
    "CollectorName": "DisputeCase.AssignedAnalyst",
    "CustomerId": "[From joined Invoice]",
    "InvoiceAmount": "[From joined Invoice]",
    "PaymentTerms": "[From joined Invoice]",
    "DueDate": "[From joined Invoice]",
    "PaymentStatus": "[From joined Invoice]",
    "DisputeReason": "DisputeCase.ReasonCode"
  }
}

// === BLOCK 12: Payment Received ===
{
  "ActivityName": "Payment Received",
  "Source Object": "CashApplication.Payments",
  "Columns": {
    "InvoiceNumber": null, // Often matched later
    "ActivityName": "Payment Received",
    "EventTime": "CashApplication.Payments.PaymentDate",
    "CollectorName": null,
    "CustomerId": "CashApplication.Payments.CustomerId",
    "InvoiceAmount": null,
    "PaymentTerms": null,
    "DueDate": null,
    "PaymentStatus": null,
    "DisputeReason": null
  }
}

// === BLOCK 13: Payment Posted ===
{
  "ActivityName": "Payment Posted",
  "Source Object": "CashApplication.AppliedPayments",
  "Columns": {
    "InvoiceNumber": "CashApplication.AppliedPayments.InvoiceNumber",
    "ActivityName": "Payment Posted",
    "EventTime": "CashApplication.AppliedPayments.ApplicationTimestamp",
    "CollectorName": null,
    "CustomerId": "[From joined Invoice]",
    "InvoiceAmount": "[From joined Invoice]",
    "PaymentTerms": "[From joined Invoice]",
    "DueDate": "[From joined Invoice]",
    "PaymentStatus": "[From joined Invoice]",
    "DisputeReason": null
  }
}

// === BLOCK 14: Invoice Settled ===
{
  "ActivityName": "Invoice Settled",
  "Source Object": "Invoices",
  "Filter": "Invoices.Status = 'Closed' AND Invoices.ClosureReason = 'Paid'",
  "Columns": {
    "InvoiceNumber": "Invoices.InvoiceNumber",
    "ActivityName": "Invoice Settled",
    "EventTime": "Invoices.ClosureTimestamp",
    "CollectorName": null,
    "CustomerId": "Invoices.CustomerId",
    "InvoiceAmount": "Invoices.InvoiceAmount",
    "PaymentTerms": "Invoices.PaymentTerms",
    "DueDate": "Invoices.DueDate",
    "PaymentStatus": "Paid",
    "DisputeReason": null
  }
}

// === BLOCK 15: Invoice Written Off ===
{
  "ActivityName": "Invoice Written Off",
  "Source Object": "Invoices",
  "Filter": "Invoices.Status = 'Closed' AND Invoices.ClosureReason = 'Write-Off'",
  "Columns": {
    "InvoiceNumber": "Invoices.InvoiceNumber",
    "ActivityName": "Invoice Written Off",
    "EventTime": "Invoices.ClosureTimestamp",
    "CollectorName": "Invoices.AssignedCollector",
    "CustomerId": "Invoices.CustomerId",
    "InvoiceAmount": "Invoices.InvoiceAmount",
    "PaymentTerms": "Invoices.PaymentTerms",
    "DueDate": "Invoices.DueDate",
    "PaymentStatus": "Written Off",
    "DisputeReason": null
  }
}

import requests
import pandas as pd
from datetime import datetime, time

class=class="hl-string">"hl-comment"># --- Configuration Settings ---
HIGH RADIUS_BASE_URL = class="hl-string">"https://[your-highradius-instance].highradius.com/api"
CLIENT_ID = class="hl-string">"[Your_Client_ID]"
CLIENT_SECRET = class="hl-string">"[Your_Client_Secret]"
START_DATE = class="hl-string">"2023-01-01"
END_DATE = class="hl-string">"2023-06-30"

class=class="hl-string">"hl-comment"># --- Helper Functions ---
def get_auth_token():
    class="hl-string">"""Authenticates with HighRadius and returns a bearer token."""
    auth_url = fclass="hl-string">"{HIGH RADIUS_BASE_URL}/auth/v1/token"
    payload = {
        class="hl-string">'grant_type': class="hl-string">'client_credentials',
        class="hl-string">'client_id': CLIENT_ID,
        class="hl-string">'client_secret': CLIENT_SECRET
    }
    response = requests.post(auth_url, data=payload)
    response.raise_for_status() class=class="hl-string">"hl-comment"># Raises an exception for bad status codes
    return response.json()[class="hl-string">'access_token']

def fetch_paginated_data(endpoint, params, headers):
    class="hl-string">"""Fetches all pages of data from a given HighRadius endpoint."""
    all_data = []
    page = 0
    limit = 200 class=class="hl-string">"hl-comment"># Records per page
    while True:
        params[class="hl-string">'offset'] = page * limit
        params[class="hl-string">'limit'] = limit
        response = requests.get(fclass="hl-string">"{HIGH RADIUS_BASE_URL}{endpoint}", headers=headers, params=params)
        response.raise_for_status()
        data = response.json()
        records = data.get(class="hl-string">'data', []) class=class="hl-string">"hl-comment"># Adjust based on actual API response structure
        if not records:
            break
        all_data.extend(records)
        page += 1
    return all_data

class=class="hl-string">"hl-comment"># --- Main Extraction Logic ---
def main():
    class="hl-string">"""Main function to extract, transform, and save the event log."""
    print(class="hl-string">"Starting HighRadius data extraction...")
    auth_token = get_auth_token()
    headers = {class="hl-string">'Authorization': fclass="hl-string">'Bearer {auth_token}'}
    events = []

    class=class="hl-string">"hl-comment"># 1. Fetch all relevant invoices in the date range
    print(class="hl-string">"Fetching invoice data...")
    invoice_params = {class="hl-string">'creationDate_gte': START_DATE, class="hl-string">'creationDate_lte': END_DATE}
    invoices = fetch_paginated_data(class="hl-string">"/invoices/v1/search", invoice_params, headers)

    class=class="hl-string">"hl-comment"># Fetch related data in bulk to reduce API calls
    invoice_ids = [inv[class="hl-string">'invoiceNumber'] for inv in invoices]
    print(fclass="hl-string">"Fetching related data for {len(invoice_ids)} invoices...")

    notes = fetch_paginated_data(class="hl-string">"/collections/v1/notes", {class="hl-string">'invoiceNumber_in': class="hl-string">','.join(invoice_ids)}, headers)
    disputes = fetch_paginated_data(class="hl-string">"/disputes/v1/search", {class="hl-string">'invoiceNumber_in': class="hl-string">','.join(invoice_ids)}, headers)
    payments = fetch_paginated_data(class="hl-string">"/cashapp/v1/applications", {class="hl-string">'invoiceNumber_in': class="hl-string">','.join(invoice_ids)}, headers)
    credit_requests = fetch_paginated_data(class="hl-string">"/credit/v1/requests", {class="hl-string">'requestDate_gte': START_DATE, class="hl-string">'requestDate_lte': END_DATE}, headers)

    class=class="hl-string">"hl-comment"># Create dictionaries for quick lookups
    notes_by_invoice = {k: [n for n in notes if n[class="hl-string">'invoiceNumber'] == k] for k in invoice_ids}
    disputes_by_invoice = {k: [d for d in disputes if d[class="hl-string">'invoiceNumber'] == k] for k in invoice_ids}
    payments_by_invoice = {k: [p for p in payments if p[class="hl-string">'invoiceNumber'] == k] for k in invoice_ids}
    
    class=class="hl-string">"hl-comment"># Process each invoice to create events
    print(class="hl-string">"Transforming data into event log...")
    for invoice in invoices:
        common_attrs = {
            class="hl-string">'InvoiceNumber': invoice.get(class="hl-string">'invoiceNumber'),
            class="hl-string">'CustomerId': invoice.get(class="hl-string">'customer', {}).get(class="hl-string">'id'),
            class="hl-string">'InvoiceAmount': invoice.get(class="hl-string">'invoiceAmount'),
            class="hl-string">'PaymentTerms': invoice.get(class="hl-string">'paymentTerms'),
            class="hl-string">'DueDate': invoice.get(class="hl-string">'dueDate'),
            class="hl-string">'PaymentStatus': invoice.get(class="hl-string">'paymentStatus'),
            class="hl-string">'CollectorName': invoice.get(class="hl-string">'collector', {}).get(class="hl-string">'name'),
            class="hl-string">'DisputeReason': None
        }

        class=class="hl-string">"hl-comment"># Invoice Generated
        events.append({**common_attrs, class="hl-string">'ActivityName': class="hl-string">'Invoice Generated', class="hl-string">'EventTime': invoice.get(class="hl-string">'creationDate')})
        
        class=class="hl-string">"hl-comment"># Invoice Sent to Customer (example from correspondence log)
        if invoice.get(class="hl-string">'sentDate'):
            events.append({**common_attrs, class="hl-string">'ActivityName': class="hl-string">'Invoice Sent to Customer', class="hl-string">'EventTime': invoice.get(class="hl-string">'sentDate')})

        class=class="hl-string">"hl-comment"># Payment Due Date Passed (calculated)
        due_date_obj = datetime.strptime(invoice.get(class="hl-string">'dueDate'), class="hl-string">'%Y-%m-%dT%H:%M:%S.%fZ').date()
        if due_date_obj < datetime.today().date() and invoice.get(class="hl-string">'paymentStatus') not in [class="hl-string">'PAID', class="hl-string">'CLOSED']:
            event_time_at_due_date = datetime.combine(due_date_obj, time(23, 59, 59)).isoformat()
            events.append({**common_attrs, class="hl-string">'ActivityName': class="hl-string">'Payment Due Date Passed', class="hl-string">'EventTime': event_time_at_due_date})

        class=class="hl-string">"hl-comment"># Invoice Settled / Written Off
        if invoice.get(class="hl-string">'closeDate'):
            if invoice.get(class="hl-string">'paymentStatus') == class="hl-string">'PAID':
                events.append({**common_attrs, class="hl-string">'ActivityName': class="hl-string">'Invoice Settled', class="hl-string">'EventTime': invoice.get(class="hl-string">'closeDate')})
            elif invoice.get(class="hl-string">'statusReason') == class="hl-string">'WRITTEN_OFF':
                events.append({**common_attrs, class="hl-string">'ActivityName': class="hl-string">'Invoice Written Off', class="hl-string">'EventTime': invoice.get(class="hl-string">'closeDate')})

        class=class="hl-string">"hl-comment"># Process related notes for this invoice
        for note in notes_by_invoice.get(invoice[class="hl-string">'invoiceNumber'], []):
            activity_map = {
                class="hl-string">'REMINDER_SENT': class="hl-string">'Overdue Reminder Sent',
                class="hl-string">'DUNNING_STARTED': class="hl-string">'Dunning Procedure Initiated',
                class="hl-string">'COLLECTION_CALL': class="hl-string">'Collection Call Logged',
                class="hl-string">'PROMISE_TO_PAY': class="hl-string">'Promise to Pay Created'
            }
            activity_name = activity_map.get(note.get(class="hl-string">'noteType'))
            if activity_name:
                events.append({**common_attrs, class="hl-string">'ActivityName': activity_name, class="hl-string">'EventTime': note.get(class="hl-string">'creationDate'), class="hl-string">'CollectorName': note.get(class="hl-string">'createdBy')})

        class=class="hl-string">"hl-comment"># Process related disputes for this invoice
        for dispute in disputes_by_invoice.get(invoice[class="hl-string">'invoiceNumber'], []):
            events.append({**common_attrs, class="hl-string">'ActivityName': class="hl-string">'Dispute Registered', class="hl-string">'EventTime': dispute.get(class="hl-string">'creationDate'), class="hl-string">'DisputeReason': dispute.get(class="hl-string">'reasonCode')})
            if dispute.get(class="hl-string">'resolutionDate'):
                events.append({**common_attrs, class="hl-string">'ActivityName': class="hl-string">'Dispute Resolved', class="hl-string">'EventTime': dispute.get(class="hl-string">'resolutionDate'), class="hl-string">'DisputeReason': dispute.get(class="hl-string">'reasonCode')})
        
        class=class="hl-string">"hl-comment"># Process related payments for this invoice
        for payment in payments_by_invoice.get(invoice[class="hl-string">'invoiceNumber'], []):
            if payment.get(class="hl-string">'paymentReceivedDate'):
                events.append({**common_attrs, class="hl-string">'ActivityName': class="hl-string">'Payment Received', class="hl-string">'EventTime': payment.get(class="hl-string">'paymentReceivedDate')})
            if payment.get(class="hl-string">'applicationDate'):
                events.append({**common_attrs, class="hl-string">'ActivityName': class="hl-string">'Payment Posted', class="hl-string">'EventTime': payment.get(class="hl-string">'applicationDate')})

    class=class="hl-string">"hl-comment"># Process credit requests (linked by customer ID)
    for request in credit_requests:
        class=class="hl-string">"hl-comment"># Note: Linking to a specific invoice is often not possible. Here we create a case-level event.
        class=class="hl-string">"hl-comment"># A more advanced logic could try to link based on customer and time proximity to an invoice.
        credit_attrs = {**common_attrs, class="hl-string">'InvoiceNumber': fclass="hl-string">"CREDIT-{request.get('customerId')}", class="hl-string">'CustomerId': request.get(class="hl-string">'customerId')}
        events.append({**credit_attrs, class="hl-string">'ActivityName': class="hl-string">'Credit Limit Requested', class="hl-string">'EventTime': request.get(class="hl-string">'requestDate')})
        if request.get(class="hl-string">'status') == class="hl-string">'APPROVED' and request.get(class="hl-string">'approvalDate'):
            events.append({**credit_attrs, class="hl-string">'ActivityName': class="hl-string">'Credit Limit Approved', class="hl-string">'EventTime': request.get(class="hl-string">'approvalDate')})

    class=class="hl-string">"hl-comment"># Finalize DataFrame
    if not events:
        print(class="hl-string">"No events found for the specified criteria.")
        return

    df = pd.DataFrame(events)
    df[class="hl-string">'EventTime'] = pd.to_datetime(df[class="hl-string">'EventTime'], errors=class="hl-string">'coerce')
    df.dropna(subset=[class="hl-string">'InvoiceNumber', class="hl-string">'ActivityName', class="hl-string">'EventTime'], inplace=True)
    df.sort_values(by=[class="hl-string">'InvoiceNumber', class="hl-string">'EventTime'], inplace=True)
    
    class=class="hl-string">"hl-comment"># Save to CSV
    output_file = class="hl-string">'highradius_event_log.csv'
    df.to_csv(output_file, index=False, date_format=class="hl-string">'%Y-%m-%d %H:%M:%S')
    print(fclass="hl-string">"Extraction complete. Event log saved to {output_file}")

if __name__ == class="hl-string">'__main__':
    main()