Skip to main content

addCustomerIntegrationMapping

Map a customer to its identifier in an external system, such as the QuickBooks customer that invoices and sales receipts should post against, or an ERP customer number.

Business Rules​

  • A customer holds one mapping per integration.
  • The integration must be connected and belong to the same company as the customer.
  • The mapping records the identifier only; it does not import or create anything in the external system.

Error Scenarios​

  • **BAD_REQUEST**: the integration belongs to another company.
  • **NOT_FOUND**: the customer does not belong to this company, or the integration does not exist.
  • **CONFLICT**: this customer is already mapped to this integration.

Permissions Required​

  • customers:add_integration_mapping permission.
addCustomerIntegrationMapping(
  input: AddCustomerIntegrationMappingInput!
): AddCustomerIntegrationMappingPayload

Arguments​

addCustomerIntegrationMapping.input ● AddCustomerIntegrationMappingInput! non-null input common​

Parameters for AddCustomerIntegrationMapping

Type​

AddCustomerIntegrationMappingPayload object common​

Autogenerated return type of AddCustomerIntegrationMapping.