PUT /external-services-settings

Updates external service settings.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
quickBooksOnline Object No

Settings for QuickBooks Online.

quickBooksOnline.customer Object No

Settings for customers.

quickBooksOnline.customer.sync String No

Specifies how to synchronize customers between your Rebilly and QuickBooks Online account.

Valid values:

  • "when-used"
  • "manually"
  • "always"

Default value: "manually"

quickBooksOnline.customer.displayName String No

Format used to display the customer name in QuickBooks Online.

Valid values:

  • "id"
  • "full-name"
  • "organization-name"

Default value: "full-name"

quickBooksOnline.transaction Object No

Settings for transactions.

quickBooksOnline.transaction.syncRefundReceipts String No

Specifies how to synchronize refund receipts between your Rebilly and QuickBooks Online account.

Valid values:

  • "manually"
  • "always"

Default value: "manually"

quickBooksOnline.transaction.syncPayments String No

Specifies how to synchronize transactions between your Rebilly and QuickBooks Online account.

Valid values:

  • "manually"
  • "always"

Default value: "manually"

quickBooksOnline.transaction.department String No

ID of the QuickBooks Online department that payments and refund receipts are related to.

quickBooksOnline.transaction.depositAccountId String No

ID of the journal account where all payments and refund receipts are deposited.

quickBooksOnline.invoice Object No

Settings for invoices.

quickBooksOnline.invoice.sync String No

Specifies how to synchronize invoices between your Rebilly and QuickBooks Online account.

Valid values:

  • "when-issued"
  • "manually"
  • "always"

Default value: "manually"

quickBooksOnline.invoice.taxSku String No

Stock Keeping Unit (SKU) of the tax that is applied to the invoice.

quickBooksOnline.invoice.taxLineDescription String No

Description of the tax line.

quickBooksOnline.invoice.department String No

ID of the QuickBooks Online department that invoices are related to.

quickBooksOnline.invoice.taxesAccountId String No

ID of the journal account where all taxes are created.

quickBooksOnline.invoice.itemDescription String No

Description of the invoice item.

quickBooksOnline.invoice.taxDescription String No

Description of the tax that is applied to the invoice.

quickBooksOnline.invoice.itemLineDescription String No

Description of the invoice line item.

quickBooksOnline.invoice.syncZeroInvoices Boolean No

Specifies if zero amount invoices must be synchronized.

Default value: false

quickBooksOnline.invoice.taxName String No

Name of the tax that is applied to the invoice.

quickBooksOnline.invoice.unearnedRevenueAccountId String No

ID of the unearned revenue journal account for product items.

quickBooksOnline.invoice.itemSku String No

Stock Keeping Unit (SKU) of the invoice item.

quickBooksOnline.invoice.discountsAccountId String No

ID of the journal account where all discounts are created.

quickBooksOnline.invoice.itemName String No

Name of the invoice item.

quickBooksOnline.journalEntry Object No

Settings for journal entries.

quickBooksOnline.journalEntry.sync String No

Specifies how to synchronize journal entries between your Rebilly and QuickBooks Online account.

Valid values:

  • "manually"
  • "always"

Default value: "manually"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.