Counterparties Transactions

GET /api/v1/Counterparties/transactions

Description

This endpoint is used to retrieve a list of transactions for a specific counterparty. It returns a GetPaymentReportsResponseListPagedResponse object containing information about the transactions.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain
• application/json
• text/json

Path Parameters:

• version: string, required

Query Parameters:

• counterpartyId: string, format: uuid, required, the id of the counterparty for which to retrieve the transactions

• pageNumber: integer, format: int32, optional, the page number (default is 1)

• pageSize: integer, format: int32, optional, the number of items to include per page (default is 10)

Request Body:

• None

URL:

• GET: {{baseUrl API url}}/api/v1/Counterparties/transactions

Response:

• A GetPaymentReportsResponseListPagedResponse object containing information about the transactions.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

GET /api/v1/Counterparties/transactions?counterpartyId=1234567890&pageSize=5&pageNumber=1

Response:

HTTP/1.1 200 OK
{
  "totalItems": 3,
  "pageNumber": 1,
  "pageSize": 5,
  "items": [
    {
      "transactionId": "1234567890",
      "amount": 1000.00,
      "currency": "USD",
      "status": "Completed"
    },
    {
      "transactionId": "0987654321",
      "amount": 1500.00,
      "currency": "USD",
      "status": "Pending"
    },
    {
      "transactionId": "9876543210",
      "amount": 2000.00,
      "currency": "USD",
      "status": "Completed"
    }
  ]
}

Method: GET

/api/v1/Counterparties/transactions?counterpartyId=<uuid>&pageNumber=1&pageSize=10

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
counterpartyId	<uuid>
pageNumber	1
pageSize	10

Response: 200

{
  "pageNumber": "<integer>",
  "pageSize": "<integer>",
  "total": "<integer>",
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": [
    {
      "invoiceId": "<uuid>",
      "invoiceCode": "<string>",
      "activity": 2,
      "paymentMode": 3,
      "counterpartyId": "<uuid>",
      "counterpartyName": "<string>",
      "paidAmount": "<double>",
      "balance": "<double>",
      "paymentId": "<string>",
      "accountName": "<string>",
      "accountNumber": "<string>",
      "bankName": "<string>",
      "accountId": "<uuid>",
      "transactionStatus": 3,
      "created": "<dateTime>"
    },
    {
      "invoiceId": "<uuid>",
      "invoiceCode": "<string>",
      "activity": 1,
      "paymentMode": 6,
      "counterpartyId": "<uuid>",
      "counterpartyName": "<string>",
      "paidAmount": "<double>",
      "balance": "<double>",
      "paymentId": "<string>",
      "accountName": "<string>",
      "accountNumber": "<string>",
      "bankName": "<string>",
      "accountId": "<uuid>",
      "transactionStatus": 4,
      "created": "<dateTime>"
    }
  ]
}