Rate Group Detail Upload

Rates 2.0 does not support Rate Grids.

Connector Overview

Component	Detail
Company Type	Buyer
Version Type	API-V1.0 API-A-V1.0
Format	CSV
Prerequisites	Company plug-ins must be turned on for Integration – Rate Group Detail Upload. User role permission must be turned on for Upload Data and Download Data.
Predecessors	Rate Codes Rate Groups
Related Connectors	Rate Code Upload Rate Group Upload Rate Grid Upload

File Formatting

Header

Component	Required?	Definition/Use	Notes	Value
Type	Yes	Upload File Type	If you have a custom connector name for a standard connector, you may use the exact same custom name for the Type header; otherwise, you must use the standard name shown in the Value field.	Rate Group Detail Upload
Transaction	No	Only applicable for the API-V1.0 version. Transaction Type	Transaction Type. Valid type names are: True: If any record errors, the entire upload fails. False: Only records that are in error fail. Remaining records are committed successfully. If this field is not included in the header, the default value will be True.
Language	No	Determines the language to be used for values in the file, such as drop-down lists and radio buttons. Column headers will always default to the upload user's preferred language.	The valid language values are: Arabic (Standard Arabic) Chinese (Simplified) Chinese (Traditional) Dutch (Netherlands) English (United Kingdom) English (United States) French (Canada) French (France) German (Germany) Hebrew (Israel) Hungarian (Hungary) Italian (Italy) Japanese (Japan) Korean (Korea) Mongolian (Mongolia) Polish (Poland) Portuguese (Brazil) Portuguese (European) Russian (Russia) Spanish (Mexico) Swedish (Sweden)

Component

Required?

Definition/Use

Notes

Value

Type

Yes

Upload File Type

If you have a custom connector name for a standard connector, you may use the exact same custom name for the Type header; otherwise, you must use the standard name shown in the Value field.

Rate Group Detail Upload

Transaction

No

Only applicable for the API-V1.0 version.

Transaction Type

Transaction Type. Valid type names are:

True: If any record errors, the entire upload fails.
False: Only records that are in error fail. Remaining records are committed successfully.

If this field is not included in the header, the default value will be True.

Language

No

Determines the language to be used for values in the file, such as drop-down lists and radio buttons. Column headers will always default to the upload user's preferred language.

The valid language values are:

Arabic (Standard Arabic)
Chinese (Simplified)
Chinese (Traditional)
Dutch (Netherlands)
English (United Kingdom)
English (United States)
French (Canada)
French (France)
German (Germany)
Hebrew (Israel)
Hungarian (Hungary)
Italian (Italy)
Japanese (Japan)
Korean (Korea)
Mongolian (Mongolia)
Polish (Poland)
Portuguese (Brazil)
Portuguese (European)
Russian (Russia)
Spanish (Mexico)
Swedish (Sweden)

Immediately following the Header section of the upload is one blank line.

Detail

Field Header Name	Data Type	Length	Required?	Value(s)/Format	Description/Use/Field Rules
Modification Type	Char	1	Required for Updates and Deletes only.	Valid values: A U D	Action to be performed: A = Add U= Will delete all existing codes and update only what is in the upload file. D = Delete If this field is blank, it will be processed as an Add.
Rate Group Code	Text	100	Yes		Valid Rate Group Code.
RateCode	Text	100	Yes		Valid Rate Code(s) Associated with Rate Group. Adding multiple rate codes for a rate group can be done using a tilde (~) as a separator or in multiple lines for the same group, using the ‘A’ modification type.

Field Header Name

Data Type

Length

Required?

Value(s)/Format

Description/Use/Field Rules

Modification Type

Char

1

Required for Updates and Deletes only.

Valid values:

A
U
D

Action to be performed:

A = Add

U= Will delete all existing codes and update only what is in the upload file.

D = Delete

If this field is blank, it will be processed as an Add.

Rate Group Code

Text

100

Yes

Valid Rate Group Code.

RateCode

Text

100

Yes

Valid Rate Code(s) Associated with Rate Group.

Adding multiple rate codes for a rate group can be done using a tilde (~) as a separator or in multiple lines for the same group, using the ‘A’ modification type.

Unique Identifier

Rate Group Code field
RateCode field