Reconciliation statement profiles
- POST
/reconciliation/profilePublish a statement profile - GET
/reconciliation/profile/{code}Read the statement profile version in force - GET
/reconciliation/profile/{code}/version/{profileVersion}Read one version of a statement profile - GET
/reconciliation/profile/{code}/versionsRead every version of a statement profile
POST Publish a statement profile
POST /reconciliation/profile
A profile is how somebody else's file becomes our entries, and it is versioned rather than edited. Publishing against an existing code mints the next version and supersedes the one in force; the older version stays readable, so re-running a period reaches the same answer it reached the first time - which is the only property that makes a reconciliation worth anything. The field map is checked against the fields we actually carry and against the amount mode: a map that cannot produce a date, an amount and something to match on is refused here rather than producing rows that can only ever fail to match.
Headers
| Name | Notes |
|---|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Content-Type | application/json |
Example
Request body: PublishProfileRequest · Response: GenericResponseProfileResponse
curl -X POST "https://api.bridgemoni.com/reconciliation/profile" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" \
-H "Content-Type: application/json" \
-d '{
"code": "string",
"displayName": "string",
"format": "string",
"delimiter": "string",
"encoding": "string",
"headerRows": 0,
"dateFormat": "string",
"timezone": "string",
"decimalSeparator": "string",
"amountMode": "string",
"fieldMap": {},
"rowFilter": "string"
}' {
"code": "string",
"displayName": "string",
"format": "string",
"delimiter": "string",
"encoding": "string",
"headerRows": 0,
"dateFormat": "string",
"timezone": "string",
"decimalSeparator": "string",
"amountMode": "string",
"fieldMap": {},
"rowFilter": "string"
} {
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"code": "string",
"profileVersion": 0,
"displayName": "string",
"format": "string",
"delimiter": "string",
"encoding": "string",
"headerRows": 0,
"dateFormat": "string",
"timezone": "string",
"decimalSeparator": "string",
"amountMode": "string",
"fieldMap": {},
"rowFilter": "string",
"inForce": true,
"supersededAt": "string"
},
"description": "Statement profile published successfully"
} Responses
| Status | When |
|---|---|
200 | Statement profile published successfully |
GET Read the statement profile version in force
GET /reconciliation/profile/{code}
The version a delivery arriving now would be parsed under. A run records the version it used, so this answer changes over time and a run's answer does not.
Headers
| Name | Notes |
|---|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
| Name |
|---|
code |
Example
Response: GenericResponseProfileResponse
curl -X GET "https://api.bridgemoni.com/reconciliation/profile/value" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" {
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"code": "string",
"profileVersion": 0,
"displayName": "string",
"format": "string",
"delimiter": "string",
"encoding": "string",
"headerRows": 0,
"dateFormat": "string",
"timezone": "string",
"decimalSeparator": "string",
"amountMode": "string",
"fieldMap": {},
"rowFilter": "string",
"inForce": true,
"supersededAt": "string"
},
"description": "Statement profile retrieved successfully"
} Responses
| Status | When |
|---|---|
200 | Statement profile retrieved successfully |
GET Read one version of a statement profile
GET /reconciliation/profile/{code}/version/{profileVersion}
Superseded versions are kept and readable. Where a certificate names the version a period was parsed under, this is how anybody checks what that version said.
Headers
| Name | Notes |
|---|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
| Name |
|---|
code |
profileVersion |
Example
Response: GenericResponseProfileResponse
curl -X GET "https://api.bridgemoni.com/reconciliation/profile/value/version/value" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" {
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"code": "string",
"profileVersion": 0,
"displayName": "string",
"format": "string",
"delimiter": "string",
"encoding": "string",
"headerRows": 0,
"dateFormat": "string",
"timezone": "string",
"decimalSeparator": "string",
"amountMode": "string",
"fieldMap": {},
"rowFilter": "string",
"inForce": true,
"supersededAt": "string"
},
"description": "Statement profile version retrieved successfully"
} Responses
| Status | When |
|---|---|
200 | Statement profile version retrieved successfully |
GET Read every version of a statement profile
GET /reconciliation/profile/{code}/versions
The history of how a counterparty's export has changed, oldest first. A customer who changed their file format mid-period is the most common cause of a period that reconciled yesterday and does not today.
Headers
| Name | Notes |
|---|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
| Name |
|---|
code |
Example
Response: GenericResponseListProfileResponse
curl -X GET "https://api.bridgemoni.com/reconciliation/profile/value/versions" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" {
"data": [
{
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"code": "string",
"profileVersion": 0,
"displayName": "string",
"format": "string",
"delimiter": "string",
"encoding": "string",
"headerRows": 0,
"dateFormat": "string",
"timezone": "string",
"decimalSeparator": "string",
"amountMode": "string",
"fieldMap": {},
"rowFilter": "string",
"inForce": true,
"supersededAt": "string"
}
],
"description": "Statement profile history retrieved successfully"
} Responses
| Status | When |
|---|---|
200 | Statement profile history retrieved successfully |
Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors