Skip to content
API Documentation

creditors

Query

Fetch Creditors.

Query Signature

query {
  creditors(where: CreditorWhereInput, skip: Int, search: String, after: String, first: Int, before: String, last: Int): CreditorResponse
}

Example Request

query Creditors($where: CreditorWhereInput, $skip: Int, $search: String, $after: String, $first: Int, $before: String, $last: Int) {
  creditors(where: $where, skip: $skip, search: $search, after: $after, first: $first, before: $before, last: $last) {
    # Add fields you want to retrieve
  }
}

Example Variables:

{
  "first": 10,
  "search": "Capital"
}

Example Response

{
  "data": {
    "creditors": {
      "data": {
        "totalCount": 3,
        "pageInfo": {
          "hasNextPage": false,
          "hasPreviousPage": false,
          "startCursor": "cursor-1",
          "endCursor": "cursor-3"
        },
        "edges": [
          {
            "cursor": "cursor-1",
            "node": {
              "creditorId": "cred-001",
              "creditorName": "Capital One",
              "createdAt": "2024-01-15T10:00:00.000Z"
            }
          },
          {
            "cursor": "cursor-2",
            "node": {
              "creditorId": "cred-002",
              "creditorName": "Capital One Auto Finance",
              "createdAt": "2024-02-20T14:30:00.000Z"
            }
          },
          {
            "cursor": "cursor-3",
            "node": {
              "creditorId": "cred-003",
              "creditorName": "Capital One Bank",
              "createdAt": "2024-03-10T09:15:00.000Z"
            }
          }
        ]
      },
      "errors": null
    }
  }
}

Arguments

ArgumentTypeDescription
whereCreditorWhereInputFilter conditions for creditors

Input Types

CreditorWhereInput

Where conditions for filtering Creditorslist.

Optional Fields:

FieldTypeDescription
updatedAfterStringISO time format with optional time offset. Valid examples:- 2025-01-01T00:00:00.233Z | 2025-01-01T00:00:00.233 | 2025-01-01T00:00:00.233-0000 | 2025-01-01T00:00:00.233-00:00 | 2025-01-01T00:00:…

Response Type

Returns: CreditorResponse

CreditorResponse

CreditorResponse

FieldTypeDescription
dataCreditorConnectionCreditor Connection.
errors[CreditorResponseError]Error(s) mesage list

CreditorConnection

Pagination connection for Creditors.

FieldTypeDescription
pageInfoPageInfo!Pagination information
edges[CreditorEdge]!List of creditor edges
totalCountInt!Total number of creditors matching the query
PageInfo

Page information for navigating collections.

FieldTypeDescription
hasNextPageBoolean!Whether there are more results after the current page
startCursorStringCursor pointing to the first item in the current page
endCursorStringCursor pointing to the last item in the current page
CreditorEdge

Edge type for Creditor.

FieldTypeDescription
nodeCreditorNodeThe creditor data
cursorString!Cursor for pagination
CreditorNode

Creditor Node

FieldTypeDescription
creditorIdID!Creditor ID
creditorNameString!Creditor Name
createdAtStringCreditor created at date ISO format

CreditorResponseError

CreditorResponse Error

FieldTypeDescription
messageStringError message

Error Types

The response may include the following error types:

CreditorResponseError

CreditorResponse Error

FieldTypeDescription
messageStringError message

Common Errors

Error CodeDescriptionResolution
VALIDATION_ERRORInput validation failedCheck required fields and formats
UNAUTHORIZEDInvalid or expired tokenRe-authenticate and retry
NOT_FOUNDResource not foundVerify the ID or reference