Update rate table

PATCH 
/rates/tables/:id

JSON-RPC

rates.tables.update

info

All parameters except id are optional, only provided parameters will be updated.

Request

Path Parameters

id integerrequired

Rate table ID.

application/json

Bodyrequired

namestringrequired
Name.
Possible values: <= 128 characters
currencies_idintegerrequired
Currency ID.
tagstring
Rating tag.
Default value: @
parent_rate_tables_idinteger | nullnullable
Parent rate table ID.
Default value: null
src_code_decks_idinteger | nullnullable
Code deck ID for source codes.
Default value: null
code_decks_idinteger | nullnullable
Code deck ID for destination codes.
Default value: null
agreements_idinteger | nullnullable
Rate agreement ID.
Default value: null
with_taxesboolean
If True, the system assumes that rates within rate table include taxes. In this case, the tax value will be calculated from the rate value and the tax rate according to the tax profile of the client.
Default value: false
notesstring | nullnullable
Notes.
Default value: null
rates_generators_idinteger | nullnullable
Associated rate generator ID.
Default value: null
rates_generation_autoboolean
If True, the rate generator will be used to generate rates for this rate table.
Default value: false
mail_import_template_idinteger | nullnullable
Rate import template ID. Required when automatic import is enabled.
Default value: null
mail_auto_importboolean
If True, automatic rate import from email is enabled. This requires mail_import_template_id, credentials_id and remote_settings to be set.
Default value: false
credentials_idinteger | nullnullable
Credentials ID. Required when automatic import is enabled.
Default value: null
remote_settings object
Additional settings for matching messages within automatic rate import from email.
oneOf
imap
email_senderstring | nullnullable
Possible values: <= 256 characters
Default value: null
email_subjectregexnullable
Possible values: <= 256 characters
Default value: null
null
object
imap_microsoft
email_senderstring | nullnullable
Possible values: <= 256 characters
Default value: null
email_subjectregexnullable
Possible values: <= 256 characters
Default value: null
export_templates_idinteger | nullnullable
Rate export template ID.
Default value: null
import_templates_idinteger | nullnullable
Rate import template ID.
Default value: null

Responses

200

Number of the affected rows.

application/json

Schema

Schema

integerinteger

400

The request contains invalid arguments or is malformed

application/json

Schema

Schema

error object
messagestring
Error message
Example: Invalid request
dataobject
Details for validation errors (if applicable)
Example: {"name":"Empty value is not allowed","payment_terms_id":"Object \"payment_terms(123)\" was not found!"}

Example (auto)

{
  "error": {
    "message": "Invalid request",
    "data": {
      "name": "Empty value is not allowed",
      "payment_terms_id": "Object \"payment_terms(123)\" was not found!"
    }
  }
}

401

Access is not authorized

application/json

Schema

Schema

error object
messagestring
Example: utoken-auth-failed: Authentication Failed: IP 10.0.0.1 is not allowed
data object
codestring
Error code
Example: utoken-auth-failed
messagestring
Example: Authentication Failed: IP 10.0.0.1 is not allowed

Example (auto)

{
  "error": {
    "message": "utoken-auth-failed: Authentication Failed: IP 10.0.0.1 is not allowed",
    "data": {
      "code": "utoken-auth-failed",
      "message": "Authentication Failed: IP 10.0.0.1 is not allowed"
    }
  }
}

404

Requested object was not found

application/json

Schema

Schema

error object
messagestring
Example: not_found: Object "clients(123)" was not found!
data object
codestring
Error code (static: not_found)
Example: not_found
messagestring
Error message
Example: Object "clients(123)" was not found!
object_namestring
Type of the object
Example: clients
object_idstring
ID of the object
Example: 123

Example (auto)

{
  "error": {
    "message": "not_found: Object \"clients(123)\" was not found!",
    "data": {
      "code": "not_found",
      "message": "Object \"clients(123)\" was not found!",
      "object_name": "clients",
      "object_id": "123"
    }
  }
}

422

A logical error occurred, making the request unprocessable

application/json

Schema

Schema

error object
messagestring
Error message
Example: invoices-zero-amount: Impossible to create an invoice with zero amount
data object
codestring
Error code
Example: invoices-zero-amount
messagestring
Error message
Example: Impossible to create an invoice with zero amount

Example (auto)

{
  "error": {
    "message": "invoices-zero-amount: Impossible to create an invoice with zero amount",
    "data": {
      "code": "invoices-zero-amount",
      "message": "Impossible to create an invoice with zero amount"
    }
  }
}

500

An unexpected error occurred

application/json

Schema

Schema

error object
messagestring
Error message
Example: An unexpected error occurred

Example (auto)

{
  "error": {
    "message": "An unexpected error occurred"
  }
}

Authorization: X-Api-Key

name: X-Api-Keytype: apiKeyin: headerdescription: Token for API access

• curl
• python
• nodejs
• php

• CURL

curl -L -X PATCH 'https://docs.jerasoft.net/rates/tables/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>' \
--data-raw '{
  "name": "string",
  "currencies_id": 0,
  "tag": "@",
  "with_taxes": false,
  "rates_generation_auto": false,
  "mail_auto_import": false,
  "remote_settings": {}
}'

Request Collapse all

Auth

ApiKeyAuth

Parameters

id — pathrequired

Body required

{
  "name": "string",
  "currencies_id": 0,
  "tag": "@",
  "with_taxes": false,
  "rates_generation_auto": false,
  "mail_auto_import": false,
  "remote_settings": {}
}