Update the tax configuration

PUT

/api/v1/org/tax-config

curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/org/tax-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "tax_enabled": true, "tax_label": "example", "tax_lines": [ { "_id": "example", "name": "example", "rate": 1, "is_default": true } ], "tax_inclusive": true, "show_tax_id": true, "compound_tax": true }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

tax_enabled

boolean

tax_label

string

>= 1 characters <= 30 characters

tax_lines

Array<object>

<= 10 items

object

_id

string

/^[0-9a-fA-F]{24}$/

name

required

string

>= 1 characters <= 50 characters

rate

required

number

<= 100

is_default

required

boolean

tax_inclusive

boolean

show_tax_id

boolean

compound_tax

boolean

Example^generated

{
  "tax_enabled": true,
  "tax_label": "example",
  "tax_lines": [
    {
      "_id": "example",
      "name": "example",
      "rate": 1,
      "is_default": true
    }
  ],
  "tax_inclusive": true,
  "show_tax_id": true,
  "compound_tax": true
}

Responses

200

OK

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}