INTRODUCTION

RECIPIENT USE CASES

FINANCIAL ACCOUNT USE CASES

PAYMENT REASON USE CASES

TRANSACTION USE CASES

NOTE USE CASES

Design  /  Note Use Cases  /  List All Notes

List All Notes

Overview

In this use case, we’ll walk through retrieving all notes belonging to a Financial Account, Recipient Account, Team Member, or transaction.

API Operation

Steps

Send a request to the following endpoint:

GET /api/external/v1/notes

  • Use the entityId query parameter to retrieve notes for a specific Financial Account, Recipient Account, Team Member, or transaction.
  • Use the entityType query parameter to retrieve all notes attached to a specific type of entity (Financial Account, Recipient Account, Team Member, or transaction). For example, you could retrieve all notes attached to transactions.
  • Use the sort query parameter to sort the results.
  • Use the page and size query parameters to limit the number of results returned.
  • Request body is not required.
  • Include a Basic Auth Authorization header where the username is your API key ID and the password is your API key secret.

Sample Response

Returns a paginated response with an array of note objects. Details are returned for each note.

In the following example, all notes belonging to Financial Accounts have been returned.

				
					{
  "totalElements": 100,
  "totalPages": 50,
  "number": 1,
  "numberOfElements": 2,
  "hasNext": true,
  "content": [
    {
      "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
      "createdAt": "2021-09-20T22:09:31.947Z",
      "updatedAt": "2021-09-20T22:09:31.947Z",
      "createdBy": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
      "state": "ACTIVE",
      "businessAccountId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
      "entityType": "FINANCIAL_ACCOUNT",
      "entityId": "7wu45p35-2178-3098-x6wg-2s749k37alk2",
      "title": "USD",
      "contentText": "Account uses USD funds.",
      "contentType": "",
      "externalUrl": "",
      "sizeInBytes": 0
    },
    {
      "id": "2av81w47-9367-1295-h4ng-1q520p28wfn1",
      "createdAt": "2021-10-20T22:09:31.947Z",
      "updatedAt": "2021-01-20T22:09:31.947Z",
      "createdBy": "1wl83a98-1243-6856-g3sg-2s680s13pkm3",
      "state": "ACTIVE",
      "businessAccountId": "5ws94h37-1792-6523-r3jn-9z754i34kin5",
      "entityType": "FINANCIAL_ACCOUNT",
      "entityId": "9qw98h31-3978-2498-g2ko-8w965t32kwe6",
      "title": "Joint Account",
      "contentText": "Joint account.",
      "contentType": "",
      "externalUrl": "",
      "sizeInBytes": 0
    }
  ]
}
				
			
ON THIS PAGE