Get Account Invoices

Returns invoices list for a given account

Body Response - Schema

200 OK

invoice_details_reponse:
  type: object
  properties:
    _embedded:
      type: object
      $ref: '#/definitions/InvoiceList'
    total:
      type: integer

definitions:
  InvoiceList:
    type: object
    properties:
      invoices:
        type: array
        items:
          type: object
          $ref: '#/definitions/InvoiceDetails'

  InvoiceDetails:
    type: object
    properties:
      amount:
        type: string
      due_amount:
        type: string
      invoice_bill_date:
        type: string
        format: date
      invoice_due_date:
        type: string
        format: date
      invoice_items_details:
        type: array
        items:
          type: object
          $ref: '#/definitions/InvoiceItemDetails'
      invoice_number:
        type: string
      paid_amount:
        type: string
      status:
        type: string

  InvoiceItemDetails:
    type: object
    properties:
      amount:
        type: string
      category:
        type: string
      description:
        type: string
      installment_number:
        type: integer
      paid_amount:
        type: string
      policy_number:
        type: string
      product:
        type: string      

400's

ErrorInfo:
  type: object
  properties:
    details:
      type: array
      items:
        type: object
        $ref: '#/definitions/ErrorDetails'
    developerMessage:
      type: string
    errorCode:
      type: string
    status:
      type: integer
    userMessage:
      type: string

definitions:
  ErrorDetails:
    type: object
    properties:
      message:
        type: string
      properties:
        type: object
        $ref: '#/definitions/ErrorDetailsProperties'
      stackTrace:
        type: string
  
  ErrorDetailsProperties:
    type: object
    properties:
      lineNumber:
        type: integer
      parameterLocation:
        type: string
      parameterName:
        type: string

❗️

API Availability

The Financial Services Experience Cloud for Insurance - Integrations Bridge is only available for customers enrolled in Talkdesk's Early Access (EA) program. To enter the EA program, contact a Customer Success Manager.

The Financial Services Experience Cloud for Insurance - Integrations Bridge has been in EA since November 2023.

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!