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
        • Invoice Inquiry (Partner Portal)
        • Retrieve payment allocations
        • Retrieve GL transactions
        • Retrieve Intermediated Invoices data
        • Retrieve Lifecycle Invoices data
    • 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?

    Settlement

    Payout status of the received payments (received by the agency vs. settled to the creditor).

    {
    "settledAmount": 0,
    "unsettledAmount": 0,
    "lastSettlementNo": 0,
    "lastSettlementDate": "2019-08-24"
}
    Built with