Data types

String

Unicode string. When used in URL as parameter value, must be URL-encoded.

Example:
Some simple text.
Some text containing ðíäčŕïťĩçŝ and $ρ€©|&₺ characters.
URL-encoded: Some%20text%20containing%20%C3%B0%C3%AD%C3%A4%C4%8D%C5%95%C3%AF%C5%A5%C4%A9%C3%A7%C5%9D%20and%20%24%CF%81%E2%82%AC%C2%A9%7C%26%E2%82%BA%20characters.

Number

In requests is expected and in a response is returned using decimal digits, with decimal point and no thousands separators. Negative numbers use a '-' (hyphen-minus) sign in front of them with no space, positive numbers and zero are unsigned. Currency symbols are not allowed.

For integer values, Int32 and Int64 are used. Otherwise, Decimal is used.

Example:
24138
12.4
-138
0.250468

Boolean

True or false value, represented as strings "True" and "False", respectively. Lowercase "true" or "false" are allowed. Other values (0, 1, x, etc.) are not allowed.

Example:
True
false

Date

In requests is expected and in a response is returned in ISO 8601 format YYYY-MM-DD. Any time information is truncated.

Example:
Both 6/15/2009 and 6/15/2009 1:45:30 PM are converted to 2009-06-15

Date and time

In requests is expected and in a response is returned in ISO 8601 format YYYY-MM-DDThh:mm:ss. When time information is omitted, it is interpreted as T00:00:00 (midnight beginning the that date).

Example:
6/15/2009 1:45:30 PM is converted to 2009-06-15T13:45:30

GUID

GUID or Globally unique identifier is widely used in Profit365 as a unique identifier (primary key) of records. GUID is a 128-bit value and is displayed as a 32 hexadecimal digits in groups separated by hyphens. Case-insensitive.

Example:
CF7B6417-5310-4BC2-A160-45DCC6B82449

Date and DateTime range

To specify range of dates or range of datetimes enclose values in square brackets and separate them by semicolon in the format [{from};{to}]. To specify open range, omit one of the values.

Example:

• range of dates from 12th to 15th of April, 2017, including both days: [2017-04-12;2017-04-15]
• everything before and up to 14:30 on 15th of April, 2017: [;2017-04-15T14:30:00]
• 12th of April, 2017 and all days after that: [2017-04-12;]
• exact date of 14th of April, 2017: [2017-04-14;2017-04-14] Can be more easily specified without the range as 2017-04-14, both formats are equivalent.

In Profit365, ranges are always inclusive, i.e. include both {from} and {to} values. However, be mindful of the expected data type. When the range expects DateTime and only date part is specified, it is interpreted as midnight beginning that date. E.g. /CRM/partners?editedAt=[2017-04-12;2017-04-15] expects a range of DateTime values, not Date values, and will not return partners edited on 15th of April, 2017, unless one has been edited at precisely midnight of that day.

String range

Use string range to search for results that contain specified string at certain positions.

Example:

• exact string: Some%20text
• string starting with 'Some': Some*
• string ending in 'text': *text
• string that contains 'tex': *tex*