FAF Profiles
FAF profiles define the percentage-based freight values used in charge calculations. These endpoints let users review available FAF profiles and their rate schedules so they can select the correct profile when creating ad hoc charges or validating freight pricing.
Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
GET |
/v1/faf-profiles |
Get a page of FAF profiles |
GET |
/v1/faf-profiles/{fafProfileId}/rates |
Get the rate schedule for a FAF profile |
Get FAF Profiles Page
Retrieve a paginated list of FAF profiles with optional filters. This is typically used by users to find the applicable FAF profile before creating or reviewing an ad hoc charge.
Endpoint: GET /v1/faf-profiles
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
PageIndex |
integer | No | Page number (default: 0) |
PageSize |
integer | No | Number of profiles per response (default: 25, max: 500) |
SearchText |
string | No | Filter by profile name |
Status |
integer | No | Filter by profile status: 1 = Active, 2 = Inactive |
Request Example
curl -X GET "https://api.consignlyhq.com/v1/faf-profiles?PageIndex=0&PageSize=25&Status=1" \
-H "Authorization: Bearer ACCESS_TOKEN"
Response Example
{
"index": 0,
"total": 2,
"fafProfiles": [
{
"id": "550e8400-e29b-41d4-a716-446655442000",
"name": "Domestic",
"status": 1
},
{
"id": "550e8400-e29b-41d4-a716-446655442001",
"name": "International",
"status": 2
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
index |
integer | Current page index |
total |
integer | Total matching FAF profiles |
fafProfiles |
array | Collection of profile summaries |
fafProfiles[].id |
uuid | FAF profile ID |
fafProfiles[].name |
string | Profile name |
fafProfiles[].status |
integer | Profile status: 1 = Active, 2 = Inactive |
Get FAF Profile Rates
Retrieve the effective rate schedule for a specific FAF profile. This lets users review the fractional percentage rate to apply for a profile before creating or validating an ad hoc charge.
Endpoint: GET /v1/faf-profiles/{fafProfileId}/rates
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
fafProfileId |
uuid | Yes | The FAF profile ID |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
PageIndex |
integer | No | Page number (default: 0) |
PageSize |
integer | No | Number of rate records per response (default: 25, max: 500) |
CarrierId |
uuid | No | Filter rates by carrier |
EffectiveDate |
datetime | No | Filter to the rate schedule effective on a specific date |
Request Example
curl -X GET "https://api.consignlyhq.com/v1/faf-profiles/550e8400-e29b-41d4-a716-446655442000/rates?PageIndex=0&PageSize=25&EffectiveDate=2026-09-01T00:00:00Z" \
-H "Authorization: Bearer ACCESS_TOKEN"
Response Example
{
"index": 0,
"total": 3,
"fafProfileRates": [
{
"carrier": {
"id": "3d80c9d8-3d41-4d93-a2f6-b9ac91a2d1dd",
"externalId": "CARRIER-01",
"name": "Fast Freight",
"code": "FFR",
"email": "ops@fastfreight.com",
"relationship": 2,
"status": 1
},
"isDefault": false,
"fafPercent": 0.125,
"effectiveFromUtc": "2026-04-01T00:00:00Z",
"isExpired": false
},
{
"carrier": null,
"isDefault": true,
"fafPercent": 0.10,
"effectiveFromUtc": "2025-01-01T00:00:00Z",
"isExpired": false
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
index |
integer | Current page index |
total |
integer | Total matching rate rows |
fafProfileRates |
array | Rate rows for the FAF profile |
fafProfileRates[].carrier |
object | Carrier the rate applies to; null for the default profile rate |
fafProfileRates[].isDefault |
boolean | Whether the row is the default rate for all carriers |
fafProfileRates[].fafPercent |
decimal | FAF percentage, stored as a decimal fraction; for example, 0.125 represents 12.5% |
fafProfileRates[].effectiveFromUtc |
datetime | The UTC date and time from which the rate becomes effective |
fafProfileRates[].isExpired |
boolean | Whether the rate has expired |
Status Values
| Value | Status | Description |
|---|---|---|
1 |
Active | The profile is active and available for use |
2 |
Inactive | The profile is not currently active |
Related Endpoints
- Cost Centres - Retrieve financial cost centre lookups used in charge configuration
- Revenue Accounts - Retrieve revenue account lookups used in charge configuration