Rebilly API Docs

Update external service settings

Updates the external service settings.

SecuritySecretApiKey or JWT

Request

Request Body schema: application/json
required

object (QuickBooksOnlineExternalServiceSettings)

QuickBooks Online settings.

object (QuickBooksOnlineCustomerExternalServiceSettings)

Customer settings.

sync

string

Default: "manually"

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

Enum:	Description
manually	Customer data is only synchronized when it is manually executed.
when-used	Customer data is synchronized when related entities, such as transactions or invoices are created or updated.
always	Customer data is synchronized automatically as data is created or updated.

displayName

string

Default: "full-name"

Enum: "id" "full-name" "organization-name"

object (QuickBooksOnlineInvoiceExternalServiceSettings)

Invoice settings.

sync

string

Default: "manually"

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

Enum:	Description
manually	Invoice data is only synchronized when it is manually executed.
when-issued	Invoice data is synchronized when issued.
always	Invoice data is synchronized automatically as data it is issued or updated.

unearnedRevenueAccountId

string

ID of the journal account where all products are created.

taxesAccountId

string or null

Default: null

ID of the journal account where all taxes are created.

department

string or null

Default: null

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

itemName

string

Name of the invoice item.

itemDescription

string

Description of the invoice item.

itemSku

string

Stock Keeping Unit (SKU) of the invoice item.

itemLineDescription

string

Description of the invoice line item.

taxName

string

Name of the tax that is applied to the invoice.

taxDescription

string

Description of the tax that is applied to the invoice.

taxSku

string

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

taxLineDescription

string

Description of the tax line.

object (QuickBooksOnlineTransactionExternalServiceSettings)

Transaction settings.

syncPayments

string

Default: "manually"

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

Enum:	Description
manually	Transaction data is only synchronized when it is manually executed.
always	Transaction data is synchronized automatically as data is created or updated.

syncRefundReceipts

string

Default: "manually"

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

Enum:	Description
manually	Invoice data is only synchronized when it is manually executed.
always	Invoice data is synchronized automatically as data is created or updated.

depositAccountId

string

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

department

string or null

Default: null

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

object (QuickBooksOnlineJournalEntryExternalServiceSettings)

Journal entry settings.

sync

string

Default: "manually"

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

Enum:	Description
manually	Journal entry data is only synchronized when it is manually executed.
always	Journal entry data is synchronized automatically as data is created or updated.

Responses

200

External service settings updated.

Response Schema: application/json

object (QuickBooksOnlineExternalServiceSettings)

QuickBooks Online settings.

object (QuickBooksOnlineCustomerExternalServiceSettings)

Customer settings.

sync

string

Default: "manually"

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

Enum:	Description
manually	Customer data is only synchronized when it is manually executed.
when-used	Customer data is synchronized when related entities, such as transactions or invoices are created or updated.
always	Customer data is synchronized automatically as data is created or updated.

displayName

string

Default: "full-name"

Enum: "id" "full-name" "organization-name"

object (QuickBooksOnlineInvoiceExternalServiceSettings)

Invoice settings.

sync

string

Default: "manually"

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

Enum:	Description
manually	Invoice data is only synchronized when it is manually executed.
when-issued	Invoice data is synchronized when issued.
always	Invoice data is synchronized automatically as data it is issued or updated.

unearnedRevenueAccountId

string

ID of the journal account where all products are created.

taxesAccountId

string or null

Default: null

ID of the journal account where all taxes are created.

department

string or null

Default: null

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

itemName

string

Name of the invoice item.

itemDescription

string

Description of the invoice item.

itemSku

string

Stock Keeping Unit (SKU) of the invoice item.

itemLineDescription

string

Description of the invoice line item.

taxName

string

Name of the tax that is applied to the invoice.

taxDescription

string

Description of the tax that is applied to the invoice.

taxSku

string

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

taxLineDescription

string

Description of the tax line.

object (QuickBooksOnlineTransactionExternalServiceSettings)

Transaction settings.

syncPayments

string

Default: "manually"

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

Enum:	Description
manually	Transaction data is only synchronized when it is manually executed.
always	Transaction data is synchronized automatically as data is created or updated.

syncRefundReceipts

string

Default: "manually"

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

Enum:	Description
manually	Invoice data is only synchronized when it is manually executed.
always	Invoice data is synchronized automatically as data is created or updated.

depositAccountId

string

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

department

string or null

Default: null

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

object (QuickBooksOnlineJournalEntryExternalServiceSettings)

Journal entry settings.

sync

string

Default: "manually"

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

Enum:	Description
manually	Journal entry data is only synchronized when it is manually executed.
always	Journal entry data is synchronized automatically as data is created or updated.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

put/external-services-settings

Request samples

application/json

{"quickBooksOnline": {"customer": {"sync": "manually",
"displayName": "id"
},
"invoice": {"sync": "manually",
"unearnedRevenueAccountId": "jrn_acc_01H32J1C97KWGRCKF1E1JY0QG8",
"taxesAccountId": "jrn_acc_01H32J1KGXSRDH0K8Q7YYA552T",
"department": "jrn_acc_01H32J1KGXSRDH0K8Q7YYA552T",
"itemName": "string",
"itemDescription": "string",
"itemSku": "string",
"itemLineDescription": "string",
"taxName": "string",
"taxDescription": "string",
"taxSku": "string",
"taxLineDescription": "string"
},
"transaction": {"syncPayments": "manually",
"syncRefundReceipts": "manually",
"depositAccountId": "jrn_acc_01H32J1C97KWGRCKF1E1JY0QG8",
"department": "jrn_acc_01H32J1KGXSRDH0K8Q7YYA552T"
},
"journalEntry": {"sync": "manually"
}
}
}

Response samples

application/json

{"quickBooksOnline": {"customer": {"sync": "manually",
"displayName": "id"
},
"invoice": {"sync": "manually",
"unearnedRevenueAccountId": "jrn_acc_01H32J1C97KWGRCKF1E1JY0QG8",
"taxesAccountId": "jrn_acc_01H32J1KGXSRDH0K8Q7YYA552T",
"department": "jrn_acc_01H32J1KGXSRDH0K8Q7YYA552T",
"itemName": "string",
"itemDescription": "string",
"itemSku": "string",
"itemLineDescription": "string",
"taxName": "string",
"taxDescription": "string",
"taxSku": "string",
"taxLineDescription": "string"
},
"transaction": {"syncPayments": "manually",
"syncRefundReceipts": "manually",
"depositAccountId": "jrn_acc_01H32J1C97KWGRCKF1E1JY0QG8",
"department": "jrn_acc_01H32J1KGXSRDH0K8Q7YYA552T"
},
"journalEntry": {"sync": "manually"
}
}
}

➔ Next to Metadata

Update external service settings

Request Body schema: application/jsonrequired

Response Schema: application/json

Request Body schema: application/json
required