Skip to main content

pullAccountingCustomer

Refresh the imported provider values of a Customer. Enqueues a background job, so completion is asynchronous. Once it lands, the Customer's accountingCustomer.external reflects the provider's current values.

Business Rules​

  • The imported snapshot is refreshed; internal values are preserved.
  • The integration has to declare that it can read accounting customers.
  • A Customer whose accounting is inherited from its sales channel cannot be pulled.
  • One pull runs at a time per Customer and integration. A request that overlaps one already running waits for it to finish and then runs.
  • The response returns processId as soon as the job is queued. Follow processStatusUpdates(processId:) or query processStatus(processId:) for completion and failure reasons. Integration notifications are delivered separately.

Error Scenarios​

  • The Customer or the integration is missing, or belongs to another company.
  • The integration cannot read accounting customers.
  • A missing provider customer and other provider errors are reported as a notification, not by this mutation.

Permissions Required​

  • accounting:import_customer to request the pull.
  • accounting:upsert_snapshot and accounting:upsert_external_projection, which the job uses to record what the provider answered.
  • accounting:configure_customer_accounting when the pull establishes a new provider link.
pullAccountingCustomer(
  input: PullAccountingCustomerInput!
): PullAccountingCustomerPayload

Arguments​

pullAccountingCustomer.input ● PullAccountingCustomerInput! non-null input common​

Parameters for PullAccountingCustomer

Type​

PullAccountingCustomerPayload object common​

Autogenerated return type of PullAccountingCustomer.