Billie Connect Converse API Prerequisites

Technical Requirements

1. OAuth 2.0 Implementation
   • Client must implement OAuth 2.0 client credential flow
   • Support for JWT token handling
   • Token caching mechanisms
2. API Client Configuration
   • HTTPS support for secure communication
   • JSON request/response handling
   • Bearer token authentication headers
3. Webhook Support (v3 only)
   • Public HTTPS endpoint for receiving webhook callbacks
   • SSL/TLS certificate validation
   • Request signature verification (recommended)
4. Client Registration
   • Valid client number (clientNo) assigned by Aria
   • OAuth 2.0 credentials (client_id, client_secret) configured through a service account

1. Configure Client Parameters

You must set the following client parameters in your Aria instance:

2. Create a Billie Service Account

1. Create a service account with a unique name.
2. Once the Service account is saved, access that, return to the update screen, and generate a key.

3. Subscribe to Pending Invoice Event in Aria

Getting here: Configuration > Notifications > Events > Financial Transactions

Subscribe to the Pending Invoice Created event. Learn more about Financial Transactions events, or how to enable and subscribe to events.

1. On the Financial Transactions events page, on the Events Fired tab, check the Pending Invoice Created event.
   
2. Click the Add another step button.
   
3. Choose "Transaction Data via Secure HTTP (XML Document)" from the Method dropdown.
   
4. Type the Billie Connect URL in the Destination text box. This may vary, depending on where you plan to deploy Billie.
5. In the Server Response text box, type {"message": "Event processed successfully"}.
6. Click the Add header button and, in the Name text box, type x-api-key.
7. In the Value text box, type your API key.

   Note: You can obtain the API key from Aria DevOps.

8. Click the Save button.

4. Validation & Testing

1. Trigger Test Event: Generate a test pending invoice in Aria for the client instance.
2. Monitor CloudWatch Logs:
   • Pre-filter function: aria-billie-{stage}-aria-events-bill-shock-pre-filter
   • Agent invocation logs: aria-billie-{stage}-bill-shock-*
3. Verify Webhook Delivery: Check the client's notification URL receives the analysis result.

Troubleshooting