Accounting Families Mutations

See the Queries page for a presentation of this resource.

CreateAccountingFamily

Create an accounting family

Parameters

input - AccountingFamilyInput
Data of the accounting family

mutation CreateAccountingFamily($input: AccountingFamilyInput!) {
  CreateAccountingFamily(input: $input) {
    id
    label
    sales_label
    purchases_label
    default
  }
}

{
  "input": {
    "label": "Equipment",
    "sales_label": "Equipment Sales",
    "purchases_label": "Equipment Purchases",
    "default": false
  }
}

{
  "data": {
    "CreateAccountingFamily": {
      "id": 100003,
      "label": "Equipment",
      "sales_label": "Equipment Sales",
      "purchases_label": "Equipment Purchases",
      "default": false
    }
  }
}

UpdateAccountingFamily

Update an accounting family

Parameters

id - ID
Id of the accounting family

input - AccountingFamilyInput
Data of the accounting family

mutation UpdateAccountingFamily($id: ID!, $input: AccountingFamilyInput!) {
  UpdateAccountingFamily(id: $id, input: $input) {
    id
    label
    sales_label
    purchases_label
    default
  }
}

{
  "id": 100003,
  "input": {
    "label": "Equipment & Tools",
    "sales_label": "Equipment Sales",
    "purchases_label": "Equipment Purchases"
  }
}

{
  "data": {
    "UpdateAccountingFamily": {
      "id": 100003,
      "label": "Equipment & Tools",
      "sales_label": "Equipment Sales",
      "purchases_label": "Equipment Purchases",
      "default": false
    }
  }
}

HandleAccountingFamilies

Handle multiple accounting families (create/update)

Parameters

input - [AccountingFamilyInput]
Array of accounting family data

mutation HandleAccountingFamilies($input: [AccountingFamilyInput!]!) {
  HandleAccountingFamilies(input: $input) {
    id
    label
    sales_label
    purchases_label
    default
  }
}

{
  "input": [
    {
      "label": "Products",
      "sales_label": "Product Sales",
      "purchases_label": "Product Purchases",
      "default": true
    },
    {
      "label": "Services",
      "sales_label": "Service Sales",
      "purchases_label": "Service Purchases",
      "default": false
    }
  ]
}

{
  "data": {
    "HandleAccountingFamilies": [
      {
        "id": 100001,
        "label": "Products",
        "sales_label": "Product Sales",
        "purchases_label": "Product Purchases",
        "default": true
      },
      {
        "id": 100002,
        "label": "Services",
        "sales_label": "Service Sales",
        "purchases_label": "Service Purchases",
        "default": false
      }
    ]
  }
}

DeleteAccountingFamily

Delete an accounting family

Parameters

id - ID
Id of the accounting family

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

{
  "id": 100003
}

{
  "data": { "DeleteAccountingFamily": true }
}

AccountingFamilyInput data type

id - ID
Identifier (optional)

label - String
Label of the accounting family

sales_label - String
Sales label for the accounting family

purchases_label - String
Purchases label for the accounting family

default - Boolean
Whether this is the default accounting family

default_for_service - Boolean
Whether this is the default family for service items