setCustomAttributesOnInvoice mutation

The setCustomAttributesOnInvoice mutation sets custom attributes on a credit memo item. The mutation accepts a invoice ID and an array of custom attribute key/value pairs. It returns the updated invoice. All ID values are treated as strings.

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

Syntax

Copy
mutation {
  setCustomAttributesOnInvoice(
    input: InvoiceCustomAttributesInput
  ){    
    InvoiceOutput
  }
}
Copied to your clipboard
mutation {
  setCustomAttributesOnInvoice(
    input: InvoiceCustomAttributesInput
  ){    
    InvoiceOutput
  }
}

Reference

The setCustomAttributesOnInvoice 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.

Request:

Copy
mutation {
  setCustomAttributesOnInvoice(
    input: {
      invoice_id: "MzQ="
      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 {
  setCustomAttributesOnInvoice(
    input: {
      invoice_id: "MzQ="
      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": {
    "setCustomAttributesOnInvoice": {
      "invoice": {
        "id": "MzQ=",
        "custom_attributes": [
          {
            "attribute_code": "attribute_one",
            "value": "value_one"
          },
          {
            "attribute_code": "attribute_two",
            "value": "value_two"
          }
        ]
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "setCustomAttributesOnInvoice": {
      "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