Choose a version:

BusinessCustomerUserError

object

Requires read_customers access scope or read_companies access scope.

An error that happens during the execution of a business customer mutation.

Anchor to FieldsFields

Anchor to codecode •BusinessCustomerErrorCode: The error code.
Anchor to fieldfield •[String!]: The path to the input field that caused the error.
Anchor to messagemessage •String!non-null: The error message.

Was this section helpful?

Anchor to MutationsMutations

companiesDelete

•mutation

Deletes a list of companies.

Anchor to companyIdscompanyIds •[ID!]!required: A list of IDs of companies to delete.

Anchor to deletedCompanyIdsdeletedCompanyIds •[ID!]: A list of IDs of the deleted companies.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyAddressDelete

•mutation

Deletes a company address.

Anchor to addressIdaddressId •ID!required: The ID of the address to delete.

Anchor to deletedAddressIddeletedAddressId •ID: The ID of the deleted address.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyAssignCustomerAsContact

•mutation

Assigns the customer as a company contact.

Anchor to companyIdcompanyId •ID!required: The ID of the company to assign the contact to.
Anchor to customerIdcustomerId •ID!required: The ID of the customer to assign as the contact.

Anchor to companyContactcompanyContact •CompanyContact: The created company contact.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyAssignMainContact

•mutation

Assigns the main contact for the company.

Anchor to companyContactIdcompanyContactId •ID!required: The ID of the company contact to be assigned as the main contact.
Anchor to companyIdcompanyId •ID!required: The ID of the company to assign the main contact to.

Anchor to companycompany •Company: The company for which the main contact is assigned.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyContactAssignRole

•mutation

Assigns a role to a contact for a location.

Anchor to companyContactIdcompanyContactId •ID!required: The ID of the contact to assign a role to.
Anchor to companyContactRoleIdcompanyContactRoleId •ID!required: The ID of the role to assign to a contact.
Anchor to companyLocationIdcompanyLocationId •ID!required: The ID of the location to assign a role to a contact.

Anchor to companyContactRoleAssignmentcompanyContactRoleAssignment •CompanyContactRoleAssignment: The company contact role assignment.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyContactAssignRoles

•mutation

Assigns roles on a company contact.

Anchor to companyContactIdcompanyContactId •ID!required: The contact whose roles are being assigned.
Anchor to rolesToAssignrolesToAssign •[CompanyContactRoleAssign!]!required: The new roles to assign.

Anchor to roleAssignmentsroleAssignments •[CompanyContactRoleAssignment!]: A list of newly created assignments of company contacts to a company location.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyContactCreate

•mutation

Creates a company contact and the associated customer.

Anchor to companyIdcompanyId •ID!required: The ID of the company that the company contact belongs to.
Anchor to inputinput •CompanyContactInput!required: The fields to use to create the company contact.

Anchor to companyContactcompanyContact •CompanyContact: The created company contact.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyContactDelete

•mutation

Deletes a company contact.

Anchor to companyContactIdcompanyContactId •ID!required: The ID of the company contact to delete.

Anchor to deletedCompanyContactIddeletedCompanyContactId •ID: The ID of the deleted company contact.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyContactRemoveFromCompany

•mutation

Removes a company contact from a Company.

Anchor to companyContactIdcompanyContactId •ID!required: The ID of the company contact to remove from the Company.

Anchor to removedCompanyContactIdremovedCompanyContactId •ID: The ID of the removed company contact.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyContactRevokeRole

•mutation

Revokes a role on a company contact.

Anchor to companyContactIdcompanyContactId •ID!required: The ID of the contact to revoke a role from.
Anchor to companyContactRoleAssignmentIdcompanyContactRoleAssignmentId •ID!required: The ID of the role assignment to revoke from a contact.

Anchor to revokedCompanyContactRoleAssignmentIdrevokedCompanyContactRoleAssignmentId •ID: The role assignment that was revoked.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyContactRevokeRoles

•mutation

Revokes roles on a company contact.

Anchor to companyContactIdcompanyContactId •ID!required: The contact whose roles are being revoked.
Anchor to revokeAllrevokeAll •BooleanDefault:false: Flag to revoke all roles on the contact.
Anchor to roleAssignmentIdsroleAssignmentIds •[ID!]: The current role assignment IDs to revoke.

Anchor to revokedRoleAssignmentIdsrevokedRoleAssignmentIds •[ID!]: A list of role assignment IDs that were removed from the company contact.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyContactsDelete

•mutation

Deletes one or more company contacts.

Anchor to companyContactIdscompanyContactIds •[ID!]!required: The list of IDs of the company contacts to delete.

Anchor to deletedCompanyContactIdsdeletedCompanyContactIds •[ID!]: The list of IDs of the deleted company contacts.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyContactUpdate

•mutation

Updates a company contact.

Anchor to companyContactIdcompanyContactId •ID!required: The ID of the company contact to be updated.
Anchor to inputinput •CompanyContactInput!required: The fields to use to update the company contact.

Anchor to companyContactcompanyContact •CompanyContact: The updated company contact.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyCreate

•mutation

Creates a company.

Anchor to inputinput •CompanyCreateInput!required: The fields to use when creating the company.

Anchor to companycompany •Company: The created company.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyDelete

•mutation

Deletes a company.

Anchor to idid •ID!required: The ID of the company to delete.

Anchor to deletedCompanyIddeletedCompanyId •ID: The ID of the deleted company.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyLocationAssignAddress

•mutation

Updates an address on a company location.

Anchor to addressaddress •CompanyAddressInput!required: The input fields to use to update the address.
Anchor to addressTypesaddressTypes •[CompanyAddressType!]!required: The list of address types on the location to update.
Anchor to locationIdlocationId •ID!required: The ID of the company location to update addresses on.

Anchor to addressesaddresses •[CompanyAddress!]: The list of updated addresses on the company location.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyLocationAssignRoles

•mutation

Assigns roles on a company location.

Anchor to companyLocationIdcompanyLocationId •ID!required: The location whose roles are being assigned.
Anchor to rolesToAssignrolesToAssign •[CompanyLocationRoleAssign!]!required: The roles to assign.

Anchor to roleAssignmentsroleAssignments •[CompanyContactRoleAssignment!]: A list of newly created assignments of company contacts to a company location.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyLocationAssignStaffMembers

•mutation

Creates one or more mappings between a staff member at a shop and a company location.

Anchor to companyLocationIdcompanyLocationId •ID!required: The ID of the company location to assign the staff member to.
Anchor to staffMemberIdsstaffMemberIds •[ID!]!required: The list of IDs of the staff members to assign.

Anchor to companyLocationStaffMemberAssignmentscompanyLocationStaffMemberAssignments •[CompanyLocationStaffMemberAssignment!]: The list of created staff member assignments.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyLocationCreate

•mutation

Creates a company location.

Anchor to companyIdcompanyId •ID!required: The ID of the company that the company location belongs to.
Anchor to inputinput •CompanyLocationInput!required: The fields to use to create the company location.

Anchor to companyLocationcompanyLocation •CompanyLocation: The created company location.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyLocationDelete

•mutation

Deletes a company location.

Anchor to companyLocationIdcompanyLocationId •ID!required: The ID of the company location to delete.

Anchor to deletedCompanyLocationIddeletedCompanyLocationId •ID: The ID of the deleted company location.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyLocationRemoveStaffMembers

•mutation

Deletes one or more existing mappings between a staff member at a shop and a company location.

Anchor to companyLocationStaffMemberAssignmentIdscompanyLocationStaffMemberAssignmentIds •[ID!]!required: The list of IDs of the company location staff member assignment to delete.

Anchor to deletedCompanyLocationStaffMemberAssignmentIdsdeletedCompanyLocationStaffMemberAssignmentIds •[ID!]: The list of IDs of the deleted staff member assignment.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyLocationRevokeRoles

•mutation

Revokes roles on a company location.

Anchor to companyLocationIdcompanyLocationId •ID!required: The location whose roles are being revoked.
Anchor to rolesToRevokerolesToRevoke •[ID!]!required: The current roles to revoke.

Anchor to revokedRoleAssignmentIdsrevokedRoleAssignmentIds •[ID!]: A list of role assignment IDs that were removed from the company location.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyLocationsDelete

•mutation

Deletes a list of company locations.

Anchor to companyLocationIdscompanyLocationIds •[ID!]!required: A list of IDs of company locations to delete.

Anchor to deletedCompanyLocationIdsdeletedCompanyLocationIds •[ID!]: A list of IDs of the deleted company locations.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyLocationTaxSettingsUpdate

•mutation

Sets the tax settings for a company location.

Anchor to companyLocationIdcompanyLocationId •ID!required: The ID of the company location that the tax settings get assigned to.
Anchor to exemptionsToAssignexemptionsToAssign •[TaxExemption!]: The list of tax exemptions to assign to the company location.
Anchor to exemptionsToRemoveexemptionsToRemove •[TaxExemption!]: The list of tax exemptions to remove from the company location.
Anchor to taxExempttaxExempt •Boolean: Whether the location is exempt from taxes.
Anchor to taxRegistrationIdtaxRegistrationId •String: The unique tax registration ID for the company location.

Anchor to companyLocationcompanyLocation •CompanyLocation: The company location with the updated tax settings.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyLocationUpdate

•mutation

Updates a company location.

Anchor to companyLocationIdcompanyLocationId •ID!required: The ID of the company location to update.
Anchor to inputinput •CompanyLocationUpdateInput!required: The input fields to update in the company location.

Anchor to companyLocationcompanyLocation •CompanyLocation: The updated company location.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyRevokeMainContact

•mutation

Revokes the main contact from the company.

Anchor to companyIdcompanyId •ID!required: The ID of the company to revoke the main contact from.

Anchor to companycompany •Company: The company from which the main contact is revoked.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

companyUpdate

•mutation

Updates a company.

Anchor to companyIdcompanyId •ID!required: The ID of the company to be updated.
Anchor to inputinput •CompanyInput!required: The input fields to update the company.

Anchor to companycompany •Company: The updated company.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]!non-null: The list of errors that occurred from executing the mutation.

Deprecated mutations

Anchor to companyLocationAssignTaxExemptions companyLocationAssignTaxExemptions •mutationDeprecated
Anchor to companyLocationCreateTaxRegistration companyLocationCreateTaxRegistration •mutationDeprecated
Anchor to companyLocationRevokeTaxExemptions companyLocationRevokeTaxExemptions •mutationDeprecated
Anchor to companyLocationRevokeTaxRegistration companyLocationRevokeTaxRegistration •mutationDeprecated

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to DisplayableError DisplayableError •interface

Was this section helpful?

Anchor to FieldsFields

Anchor to MutationsMutations

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Deprecated mutations

Anchor to InterfacesInterfaces