Exchange rate lines

Exchange rate line items represent entries in an exchange rate object.

List exchange rate lines

get/objects/company-config/exchange-rate-line

Returns a collection with a key, ID, and link for each exchange rate line. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "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
    }
}
Create an exchange rate line
post/objects/company-config/exchange-rate-line
Creates a new exchange rate line.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
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.


 
 Example:  2
required
object
Reference to the exchange rate that this line belongs to.


 
key
string
Unique key for the exchange rate.


 
 Example:  "23"
id
string
Unique identifier for the exchange rate.


 
 Example:  "23"
reciprocalRate
number
The reverse of the conversion rate (rate). For example, if you are establishing a rate to convert dollars to Euros, the reciprocalRate is used to convert Euros to dollars.


 
 Example:  0.5
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "exchangeRate": {
    • "key": "40"
    },
  • "effectiveStartDate": "2024-12-30",
  • "rate": 1.555
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "87",
    • "id": "87",
    • "href": "/objects/company-config/exchange-rate-line/87"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an exchange rate line
get/objects/company-config/exchange-rate-line/{key}
Returns detailed information for a specified exchange rate line.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for an exchange rate line.


 
 Example:  87
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "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": "2022-04-20T16:20:00Z",
      • "modifiedDateTime": "2022-04-20T16:20:00Z",
      • "createdByUser": {
        },
      • "createdBy": "1",
      • "modifiedByUser": {
        },
      • "modifiedBy": "95"
      },
    • "href": "/objects/company-config/exchange-rate-line/87"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an exchange rate line
patch/objects/company-config/exchange-rate-line/{key}
Updates an existing exchange rate line by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for an exchange rate line.


 
 Example:  87
Request Body schema: application/json
rate
number
The conversion rate.


 
 Example:  2
reciprocalRate
number
The reverse of the conversion rate (rate). For example, if you are establishing a rate to convert dollars to Euros, the reciprocalRate is used to convert Euros to dollars.


 
 Example:  0.5
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "rate": 1,
  • "reciprocalRate": 0.5
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "87",
    • "id": "87",
    • "href": "/objects/company-config/exchange-rate-line/87"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an exchange rate line
delete/objects/company-config/exchange-rate-line/{key}
Deletes an exchange rate line.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for an exchange rate line.


 
 Example:  87
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}