List company transactions

GET 
/companies/:companyID/transactions

List company transactions

Request

Query Parameters

page number

Possible values: >= 1

Default value: 1

limit number

Possible values: >= 1 and <= 100

Default value: 20

assetId uuid
type string
status string
processed string

Possible values: [true, false]

startDate string
endDate string
sort string

Default value: -createdAt

productCatalogueId uuid

Responses

200

A list of transactions for the company

application/json

Schema

Schema

data

object[]

required

Array [

id uuidrequired

The unique identifier of the transaction

name stringrequired

The name/description of the transaction

date stringnullablerequired

The date of the transaction

amount numberrequired

The amount of the transaction (in EUR)

type stringrequired

The transaction type key

typeOperation stringnullable

The legacy operation type

statusValidation stringnullable

Validation status (pending, valid, reject, etc.)

statusBo stringnullable

Back-office status (pending, complete, incomplete, etc.)

processed booleannullable

Whether the transaction has been processed

comment stringnullable

Optional comment on the transaction

manager uuidnullable

The manager linked to the transaction

managerBo uuidnullable

The back-office manager linked to the transaction

created stringnullablerequired

Creation date

updated stringnullablerequired

Last update date

assetId uuidrequired

The ID of the related asset/contract

assetName stringnullable

The name of the related asset/contract

clientId uuidnullable

The ID of the customer reference linked through the contract

insurerName stringnullable

The name of the insurer for the related contract

productCatalogue

object

Product catalogue information linked to this asset

id uuidrequired

The product catalogue ID (coalesce of parentCatalogueId or catalogue.id)

name stringnullable

Product name (coalesce: referential.name, catalogue.catalogueName)

insurerId uuidnullable

The insurer/partner institution ID

insurerName stringnullable

The insurer/partner institution name

]

pagination

object

required

page numberrequired

Current pagination page

limit numberrequired

Maximum number of transactions per page

total numberrequired

Total number of matching transactions

totalPages numberrequired

Total number of pages

Example (from schema)

{
  "data": [
    {
      "id": "tx-123456-abcdef",
      "name": "Payment for services",
      "date": "2024-03-15",
      "amount": 1250.5,
      "type": "contribution",
      "typeOperation": "string",
      "statusValidation": "string",
      "statusBo": "string",
      "processed": true,
      "comment": "string",
      "manager": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "managerBo": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created": "string",
      "updated": "string",
      "assetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "assetName": "string",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "insurerName": "string",
      "productCatalogue": {
        "id": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
        "name": "Cardif Elite Retraite",
        "insurerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "insurerName": "CARDIF"
      }
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total": 0,
    "totalPages": 0
  }
}

Loading...