Skip to content
digizeDocs

What the books offer

GET
/api/v1/accounting/{provider}/options
curl --request GET \
  --url https://digize.com/api/v1/accounting/quickbooks/options \
  --header 'x-api-key: <x-api-key>'

The products or services, accounts and tax codes in the connected QuickBooks company or Xero organisation, for the export’s settings.

Needs the settings:read permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
provider
required

quickbooks or xero.

string
Allowed values: quickbooks xero

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
items
required

QuickBooks’ products and services.

Array<object>
object
id
required
string
name
required
string
type
string
rate
number | null
salesAccounts
required

Xero’s revenue accounts.

Array<object>
object
id
required
string
name
required
string
type
string
rate
number | null
paymentAccounts
required
Array<object>
object
id
required
string
name
required
string
type
string
rate
number | null
taxCodes
required
Array<object>
object
id
required
string
name
required
string
type
string
rate
number | null
salesTax
required

A US QuickBooks company, which works sales tax out itself.

boolean

Example generated

{
  "items": [
    {
      "id": "example",
      "name": "example",
      "type": "example",
      "rate": 1
    }
  ],
  "salesAccounts": [
    {
      "id": "example",
      "name": "example",
      "type": "example",
      "rate": 1
    }
  ],
  "paymentAccounts": [
    {
      "id": "example",
      "name": "example",
      "type": "example",
      "rate": 1
    }
  ],
  "taxCodes": [
    {
      "id": "example",
      "name": "example",
      "type": "example",
      "rate": 1
    }
  ],
  "salesTax": true
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}