Query - Features

GraphQL offers the flexibility to precisely specify data you want to fetch.

For more information about GraphQL query construction, see https://graphql.org/learn/queries/.

Sample Request

A GraphQL query request consists of two parts: GraphQL Query and Query Variables. Both are required for executing a query request.

GraphQL Query

query ($organizationID: Int!, $projectNumber: String, $offset: Int!, $next: Int!, $dateModifiedBegin: DateTime) {
  payment(
    organizationID: $organizationID
    projectNumber: $projectNumber
    offset: $offset
    next: $next
    dateModifiedBegin: $dateModifiedBegin
  ) {
    id
    paymentAmount
    remainingAmount
    invoicePaidToDate
    paymentMethod
    paymentStatus
    checkNumber
    bankUploadDateTime
    paidDate
    settlementDate
    disbursementDateTime
    tpaFunderReferenceID
    tpaMaturityDate
    tpaEffectiveDate
    tpaTransmissionDate
    tpaSubFeeAmount
    tpaFundingAccount
    tpaMaturityAccount
    discount
    tax
    dateModified
    exportDate
    isDeleted
    disburserName {
      firstName
      lastName
    }
    invoice {
      id
      invoiceLines(offset: 0, next: 100) {
        id
      }
    }
    draw {
      number
    }
    contract {
      contractNumber
    }
    project {
      name
    }
    payFromOrganization {
      name
    }
    payToOrganization {
      name
    }
  }
}

Query Variables (JSON)

{
  "organizationID": 2534,
  "projectNumber": "10004746",
  "offset": 0,
  "next": 20,
  "dateModifiedBegin": "2025-01-20T10:00"
}

Related Topics