Payment Informations Mutations

See the Queries page for a presentation of this resource.

CreatePaymentInformation

Create a payment information

Parameters

input PaymentInformationInput
Data of the payment information

Example

GraphQL

mutation CreatePaymentInformation($input: PaymentInformationInput!) {
  CreatePaymentInformation(input: $input) {
    id
    label
    information
    default
  }
}

Variables (JSON)

{
  "input": {
    "label": "Bank of America",
    "information": "IBAN: 348953409534509",
    "default": false
  }
}

Returned data

JSON

{
  "data": {
    "CreatePaymentInformation": {
      "id": 100010,
      "label": "Bank of America",
      "information": "IBAN: 348953409534509",
      "default": false
    }
  }
}

UpdatePaymentInformation

Update a payment information

Parameters

id ID
Id of the payment information

input PaymentInformationInput
Data of the payment information

Example

GraphQL

mutation UpdatePaymentInformation($id: ID!, $input: PaymentInformationInput!) {
  UpdatePaymentInformation(id: $id, input: $input) {
    id
    label
    information
    default
  }
}

Variables (JSON)

{
  "id": 100010,
  "input": {
    "label": "Bank of America",
    "information": "IBAN: 348953409534509",
    "default": false
  }
}

Returned data

JSON

{
  "data": {
    "UpdatePaymentInformation": {
      "id": 100010,
      "label": "Bank of America",
      "information": "IBAN: 348953409534509",
      "default": false
    }
  }
}

DisablePaymentInformation

Disable a payment information

Parameters

id ID
Id of the payment information

Example

GraphQL

mutation DisablePaymentInformation($id: ID!) {
  DisablePaymentInformation(id: $id) {
    id
    active
  }
}

Variables (JSON)

{
  "id": 100010
}

Returned data

JSON

{
  "data": {
    "DisablePaymentInformation": {
      "id": 100010,
      "active": false
    }
  }
}

EnablePaymentInformation

Enable a payment information

Parameters

id ID
Id of the payment information

Example

GraphQL

mutation EnablePaymentInformation($id: ID!) {
  EnablePaymentInformation(id: $id) {
    id
    active
  }
}

JSON

{
  "id": 100010
}

Returned data

JSON

{
  "data": {
    "EnablePaymentInformation": {
      "id": 100010,
      "active": true
    }
  }
}

DeletePaymentInformation

Delete a payment information

Parameters

id ID
Id of the payment information to delete

Example

GraphQL

mutation DeletePaymentInformation($id: ID!) {
  DeletePaymentInformation(id: $id)
}

Variables (JSON)

{
  "id": 100010
}

Returned data

JSON

{
  "data": {
    "DeletePaymentInformation": true
  }
}

PaymentInformationInput data type

id ID
ID for updates.

label String
Name of the payment information

information String
Payment information content

active Boolean
If true, the payment information is active and can be used in documents.

default Boolean
Set the payment information as the default one if true

deposit_default Boolean
If true, the payment information is the default for deposits.