Payment Informations Queries

Access customer payment information and methods.

Available queries

`PaymentInformation` - Returns a single currency based on the `id` provided

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

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

query {
  PaymentInformations {
    data {
      label
    }
  }
}

`CheckChorusPaymentInformation` - Reads the IBAN and BIC out of a Chorus Pro payment information text

query {
  CheckChorusPaymentInformation(information: "IBAN FR7612345678901234567890123 BIC BNPAFRPPXXX") {
    valid
    iban
    bic
  }
}

Return Type	Description
ChorusPaymentInformationCheck	Whether the text is valid, with the IBAN and BIC it contains.

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.

Data Types

`ChorusPaymentInformationCheck`

Field	Type	Description
`valid`	Boolean!	Whether payment details could be read from the text.
`iban`	String	IBAN found in the text.
`bic`	String	BIC found in the text.

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

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

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

Example of data returned

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