Exchange rate line items represent entries in an exchange rate object.
Returns a collection with a key, ID, and link for each exchange rate line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Subscription | Company |
---|---|
User type | Business |
Permissions | List, View Exchange Rates |
OK
Bad Request
{- "ia::result": [
- {
- "key": "85",
- "id": "85",
- "href": "/objects/company-config/exchange-rate-line/85"
}, - {
- "key": "86",
- "id": "86",
- "href": "/objects/company-config/exchange-rate-line/86"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Creates a new exchange rate line.
Subscription | Company |
---|---|
User type | Business |
Permissions | List, View, Add Exchange Rates |
Create an exchange rate line.
effectiveStartDate required | string <date> The date the exchange rate becomes effective. Example: "2021-01-31" | ||||
rate required | number The conversion rate to use, beginning with the effective start date. Example: 2 | ||||
required | object Header level details for the exchange rate line entries. | ||||
| |||||
reciprocalRate | number The reverse of the conversion rate ( Example: 0.5 |
Created
Bad Request
{- "exchangeRate": {
- "key": "40"
}, - "effectiveStartDate": "2024-12-30",
- "rate": 1.555
}
{- "ia::result": {
- "key": "87",
- "id": "87",
- "href": "/objects/company-config/exchange-rate-line/87"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified exchange rate line.
Subscription | Company |
---|---|
User type | Business |
Permissions | List, View Exchange Rates |
key required | string System-assigned unique key for the exchange rate line. |
OK
Bad Request
{- "ia::result": {
- "id": "87",
- "key": "87",
- "exchangeRate": {
- "id": "40",
- "key": "40",
- "href": "/objects/company-config/exchange-rate/40"
}, - "effectiveStartDate": "2024-12-30",
- "rate": 1.555,
- "reciprocalRate": 0.64308682,
- "audit": {
- "createdDateTime": "2023-11-08T13:02:58Z",
- "modifiedDateTime": "2023-11-08T13:02:58Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "href": "/objects/company-config/exchange-rate-line/87"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing exchange rate line by setting field values. Any fields not provided remain unchanged.
Subscription | Company |
---|---|
User type | Business |
Permissions | List, View, Edit Exchange Rates |
key required | string System-assigned unique key for the exchange rate line. |
rate | number The conversion rate to use, beginning with the effective start date. Example: 2 |
reciprocalRate | number The reverse of the conversion rate ( Example: 0.5 |
OK
Bad Request
{- "rate": 1,
- "reciprocalRate": 0.5
}
{- "ia::result": {
- "key": "87",
- "id": "87",
- "href": "/objects/company-config/exchange-rate-line/87"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes an exchange rate line.
Subscription | Company |
---|---|
User type | Business |
Permissions | List, View, Delete Exchange Rates |
key required | string System-assigned unique key for the exchange rate line. |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "company-config/exchange-rate-line" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
Example: ["key","id","max:vendor.creditLimit"] | ||||||||
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object) Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}] | |||||||||
Array Any of: Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
Array of objects Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}] | |||||||||
Array
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "id": "Vend-00002",
- "name": "Test vendor",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/85"
}, - {
- "id": "VEND-00010",
- "name": "Design Works",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/111"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}