Payment Informations Queries

Access customer payment information and methods.

Available queries

PaymentInformation - Returns a single currency based on the id provided

GraphQL

query {
  PaymentInformation (id: 100012) {
    label
  }
}

PaymentInformations - Returns a list of currencies based on the filter define

GraphQL

query {
  PaymentInformations {
    data {
      label
    }
  }
}

---

Available fields

Field	Type	Description
id	Int	Unique identifier of the payment information.
label	String	Name of the payment information.
information	String	Content of the payment information.
default	Boolean	If true, the payment information is the default for the invoices created.
active	Boolean	If true, the payment information is active and can be used in documents.
deposit_default	Boolean	If true, the payment information is the default for deposits.

---

Filters

You can create filters based on following fields

label
Example:{ "column" : "LABEL", "operator" : "EQ", "value" : "EUR" }

default
Example: { "column": "DEFAULT", "operator": "NEQ", "value": true }

active
Example:{ "column": "ACTIVE", "operator": "EQ", "value": true }

---

Sorting

You can sort data based on following fields : id, label, default, active

GraphQL

query PaymentInformations(
  $where: QueryPaymentInformationsWhereWhereConditions, 
) {
  PaymentInformations(
    orderBy: [{column: LABEL, order: ASC}]
    where: $where
  ) {
    paginatorInfo {
      total
    }
    data {
      id
      label
      default
    }
  }
}

Variables (JSON)

{
  "where": {
    "AND": [
      {
        "column": "ACTIVE",
        "operator": "EQ",
        "value": true
      }
    ]
  }
}

Example of data returned

JSON

{
  "data": {
    "PaymentInformations": {
      "paginatorInfo": {
        "total": 1
      },
      "data": [
        {
          "id": 100002,
          "label": "Bank of America",
          "default": true,
        }
      ]
    }
  }
}