Invoice Accounts

GET /api/v1/InvoiceAccounts

Description

This endpoint is used to retrieve a list of Invoice Accounts. It returns an InvoiceAccountResponseListPagedResponse object containing a list of Invoice Account details, as well as paging information.

Headers:

• Content-Type: application/json

ApiKey:

• No API key required

Path Parameters:

• version: string, required

Query Parameters:

• pageNumber: integer, optional (default is 1)

• pageSize: integer, optional (default is 10)

URL:

• GET: {{baseUrl API url}}/api/v1/InvoiceAccounts?pageNumber=1&pageSize=10

Response:

• An InvoiceAccountResponseListPagedResponse object containing a list of Invoice Account details, as well as paging information.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example Request URL:

GET /api/v1/InvoiceAccounts?pageNumber=1&pageSize=10
Content-Type: application/json

Example Response:

HTTP/1.1 200 OK
{
  "totalRecords": 5,
  "pageNumber": 1,
  "pageSize": 10,
  "accounts": [
    {
      "accountId": "98f2d2e5-6140-4f19-9b58-48c5003e92f7",
      "accountName": "Acme Inc.",
      "accountNumber": "ACME001",
      "description": "The account for Acme Inc.",
      "isActive": true,
      "currencyCode": "USD",
      "createdBy": "John Doe",
      "createdDate": "2024-02-18T14:45:00Z"
    },
    {
      "accountId": "4b4d2b5e-8e70-4f29-9b55-58d5003e92f7",
      "accountName": "Beta Corp.",
      "accountNumber": "BETA002",
      "description": "The account for Beta Corp.",
      "isActive": false,
      "currencyCode": "EUR",
      "createdBy": "Jane Smith",
      "createdDate": "2024-02-17T14:45:00Z"
    }
  ]
}

Method: GET

/api/v1/InvoiceAccounts?pageNumber=1&pageSize=10

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
pageNumber	1
pageSize	10

Response: 200

{
  "pageNumber": "<integer>",
  "pageSize": "<integer>",
  "total": "<integer>",
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": [
    {
      "id": "<uuid>",
      "merchantId": "<uuid>",
      "accountName": "<string>",
      "accountNumber": "<string>",
      "walletID": "<string>",
      "bankName": "<string>",
      "lastActivity": "<dateTime>",
      "priorDayBalance": "<double>",
      "availableBalance": "<double>"
    },
    {
      "id": "<uuid>",
      "merchantId": "<uuid>",
      "accountName": "<string>",
      "accountNumber": "<string>",
      "walletID": "<string>",
      "bankName": "<string>",
      "lastActivity": "<dateTime>",
      "priorDayBalance": "<double>",
      "availableBalance": "<double>"
    }
  ]
}