Exchange rate types

An exchange rate type enables an organization to process foreign currency transactions, such as foreign currency invoices and bills, using exchange rates specific to the business requirements. You can use a custom exchange rate type for global consolidation, or to override the standard Intacct daily rate type. See Exchange rate types for more information.

List exchange rate types

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

Returns a collection with a key, ID, and link for each exchange rate type. 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": "1",
      • "id": "1",
      • "href": "/objects/company-config/exchange-rate-type/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/company-config/exchange-rate-type/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/company-config/exchange-rate-type/3"
      },
    • {
      • "key": "4",
      • "id": "4",
      • "href": "/objects/company-config/exchange-rate-type/4"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an exchange rate type
post/objects/company-config/exchange-rate-type
Creates a new exchange rate type.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Create an exchange rate type.


name
required
string
Name or other unique identifier for the exchange rate type.


 
 Example:  "GBP-Rate"
isDefault
boolean
 Default:  false
Indicates whether the system should use the exchange rate type as the default. Setting isDefault to true for an exchange rate type will automatically set it to false for the current default exchange rate type.


 
 Example:  false
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "name": "CUS-Rate",
  • "isDefault": true
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "5",
    • "href": "/objects/company-config/exchange-rate-type/5"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an exchange rate type
get/objects/company-config/exchange-rate-type/{key}
Returns detailed information for a specified exchange rate type.


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


 
 Example:  5
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "5",
    • "name": "CUS-Rate",
    • "isDefault": false,
    • "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-type/5"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an exchange rate type
patch/objects/company-config/exchange-rate-type/{key}
Updates an existing exchange rate type 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 type.


 
 Example:  5
Request Body schema: application/json
name
string
Name or other unique identifier for the exchange rate type.


 
 Example:  "GBP-Rate"
isDefault
boolean
 Default:  false
Indicates whether the system should use the exchange rate type as the default. Setting isDefault to true for an exchange rate type will automatically set it to false for the current default exchange rate type.


 
 Example:  false
Responses 
200
OK


400
Bad Request


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


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


 
 Example:  5
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
    }
}