1. Operations
Confirma Finance Integrations API
  • Introduction
  • Authentication
  • Environments
  • Data validation
  • Contact information
  • Go Live & Deployment Guide
  • Services
    • Services
    • Invoice Intermediation service
    • Invoice Lifecycle service
    • Debt Collection services
    • Accounting integrations
    • Print and Distribution service
      • Overview
    • Operations
      • Retrieve Finvoice Credentials
      • Case & Invoice Status Lookup
  • Core endpoints
    • Onboarding
      • Introduction to onboarding
      • Create a new client
      • Validate access token
      • Renew access token
    • Invoices
      • Introduction to Invoices
      • Create an invoice
      • Create an Invoice Action
      • Retrieve case details
      • Retrieve distribution Information
    • Payments
      • Introduction to Payments
      • Retrieve Payments
      • Retrieve settlements
    • Accounting
      • Introduction to accounting
      • Invoice
        • Invoice
      • Ledger
        • Ledger
        • Ledger
      • Payment
        • Payment
        • Payment
      • Settings
        • GetCOA
    • Operations
      • Retrieve Finvoice Credentials
        GET
      • Invoice Inquiry (Partner Portal)
        POST
      • Retrieve payment allocations
        GET
      • Retrieve GL transactions
        GET
      • Retrieve Intermediated Invoices data
        GET
      • Retrieve Lifecycle Invoices data
        GET
  • Schemas
    • Finvoice Credentials Response
    • Invoice Header object
    • Invoice Parties
    • Invoice Attachments
    • InvoiceExtensions
    • Client Settings
    • DebtorBalanceResponse
    • Accounting
    • Address
    • Creditor
    • DebtorBalanceQuery
    • BuyerParty
    • CurrencyTotals
    • Collection
    • Collection Costs
    • Debtor
    • Collection Interest
    • Balance
    • Contact
    • Settlement
    • Contact Person
    • DebtorInvoice
    • Generic400
    • Unauthorized
    • Definition Detail
    • Delivery Party
    • Distribution
    • Factoring
    • Interest
    • InvoiceAmounts
    • Invoice Content Data
    • Invoice Recipient Party
    • InvoiceReferences
    • InvoiceRowData
    • InvoiceTerms
    • PaymentData
    • Payment Details
    • PaymentState
    • PaymentTerms
    • Processing
    • SalesInvoiceRequest
    • Seller Party
Need help?
  1. Operations

Invoice Inquiry (Partner Portal)

POST
https://staging-integrations.confirmafinance.com/api/v1/partner/invoice-inquiry
inquiriesinvoicecase
Returns the real-time data related to invoice / case, the response body contains a secure, encrypted URL scoped to that specific case or invoice via Confirma Finance Partner Portal. Each URL generated is valid for 20 minutes.
About the response body
Use the URL in data section to redirect your application to get to the portal page (iframe)

Request

Authorization
Add parameter in header
X-Api-Key
Example:
X-Api-Key: ********************
Body Params application/jsonRequired

Example
{
  "invoiceNumber": "303",
  "languageCode": "FI"
}

Responses

🟢200Success
application/json
After verification of the API Access Token, the response will be produced by the API endpoint / Partner Portal
Bodyapplication/json

Example
Successful response contains the URL to the partner portal page.
{
    "launchUrl": "https://portal.confirmafinance.com/embed/4ixvfOJQ3BDTXs76hynU6tEW8xgXTpp8nCb-544n4F0?embed=iframe"
}
🟠400Bad Request
🟠403Forbidden
Previous
Retrieve Finvoice Credentials
Next
Retrieve payment allocations
Built with