setCustomAttributesOnInvoiceItem mutation

The setCustomAttributesOnInvoiceItem mutation sets custom attributes on an invoice item. The mutation accepts a invoice ID, invoice item ID, and an array of custom attribute key/value pairs. It returns the updated invoice.

To remove a custom attribute, rerun the mutation without the previously applied custom attribute.

Syntax

Copy
mutation {
  setCustomAttributesOnInvoiceItem(
    input: InvoiceItemCustomAttributesInput
  ){
    InvoiceOutput
  }
}
Copied to your clipboard
mutation {
  setCustomAttributesOnInvoiceItem(
    input: InvoiceItemCustomAttributesInput
  ){
    InvoiceOutput
  }
}

Reference

The setCustomAttributesOnInvoiceItem reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following example sets two custom attributes on an invoice item.

Request:

Copy
mutation {
  setCustomAttributesOnInvoiceItem(
    input: {
      invoice_id: "MzQ="
      invoice_item_id: "1"
      custom_attributes: [
        {
          attribute_code: "attribute_one"
          value: "value_one"
        },
        {
          attribute_code: "attribute_two"
          value: "value_two"
        }
      ]
    }
  ) {
    invoice {
      id
      custom_attributes {
        attribute_code
        value
      }
    }
  }
}
Copied to your clipboard
mutation {
  setCustomAttributesOnInvoiceItem(
    input: {
      invoice_id: "MzQ="
      invoice_item_id: "1"
      custom_attributes: [
        {
          attribute_code: "attribute_one"
          value: "value_one"
        },
        {
          attribute_code: "attribute_two"
          value: "value_two"
        }
      ]
    }
  ) {
    invoice {
      id
      custom_attributes {
        attribute_code
        value
      }
    }
  }
}

Response:

Copy
{
  "data": {
    "setCustomAttributesOnInvoiceItem": {
      "invoice": {
        "id": "MzQ=",
        "custom_attributes": [
          {
            "attribute_code": "attribute_one",
            "value": "value_one"
          },
          {
            "attribute_code": "attribute_two",
            "value": "value_two"
          }
        ]
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "setCustomAttributesOnInvoiceItem": {
      "invoice": {
        "id": "MzQ=",
        "custom_attributes": [
          {
            "attribute_code": "attribute_one",
            "value": "value_one"
          },
          {
            "attribute_code": "attribute_two",
            "value": "value_two"
          }
        ]
      }
    }
  }
}

Last updated 6/10/2025

Was this helpful?

Yes

No