accountDebtPosition

The delinquent debt position for an account and its ledgers.

Arguments

accountNumber : String!


            required

The account number to retrieve debt position for.

asOn : Date

The date to retrieve the debt position for. If not provided, defaults to today. Allows querying historical debt positions. If a future date is provided, it is clamped to today.

Returns

AccountDebtPositionType

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can access customer queries
OR Can query delinquent debt positions for ledgers

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query AccountDebtPosition(
  $accountNumber: String!,
  $asOn: Date
) {
  accountDebtPosition(
    accountNumber: $accountNumber,
    asOn: $asOn
  ) {
    accountNumber
    ledgerDebtPositions {
      ...LedgerDebtPositionTypeFragment
    }
  }
}

{
  "accountNumber": "A-1F7113E0",
  "asOn": "1989-08-25"
}

{
  "data": {
    "accountDebtPosition": {
      "accountNumber": "A-F3B72F68",
      "ledgerDebtPositions": [LedgerDebtPositionType]
    }
  }
}