API reference · Pricing, reporting & reconciliation

Reconciliations

Statement files in, a matching ladder, breaks with owners, signed certificates. About reconciliation Live

POST/reconciliation/definitionDefine what is reconciled against what
GET/reconciliation/definition/{code}Read one reconciliation and its sides
GET/reconciliation/definitionsList the reconciliations on this tenant

POST Define what is reconciled against what

POST /reconciliation/definition

A definition names the entities to compare and how often. It needs at least two sides, and the same entity cannot be two of them - a comparison with one party agrees with itself by construction, produces a perfect match rate and proves nothing, which is worse than not running it because the certificate would look like success. A CRITICAL reconciliation cannot resolve differences automatically, whatever the tolerance says.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Example

Request body: CreateDefinitionRequest · Response: GenericResponseDefinitionResponse

curl -X POST "https://api.bridgemoni.com/reconciliation/definition" \
  -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",
  "currencyCode": "string",
  "frequency": "string",
  "timezone": "string",
  "cutOffTime": "string",
  "graceHours": 0,
  "riskRating": "string",
  "absoluteTolerance": "string",
  "percentageTolerance": "string",
  "autoResolveEnabled": true,
  "signOffRequired": true,
  "ageingDays": 0,
  "overdueDays": 0,
  "escalatedDays": 0,
  "dateWindowDays": 0,
  "sides": [
    {
      "sideKey": "string",
      "entityCode": "string",
      "displayName": "string",
      "isAuthority": true,
      "stageOrder": 0,
      "forwardGapCategory": "string"
    }
  ]
}'

{
  "code": "string",
  "displayName": "string",
  "currencyCode": "string",
  "frequency": "string",
  "timezone": "string",
  "cutOffTime": "string",
  "graceHours": 0,
  "riskRating": "string",
  "absoluteTolerance": "string",
  "percentageTolerance": "string",
  "autoResolveEnabled": true,
  "signOffRequired": true,
  "ageingDays": 0,
  "overdueDays": 0,
  "escalatedDays": 0,
  "dateWindowDays": 0,
  "sides": [
    {
      "sideKey": "string",
      "entityCode": "string",
      "displayName": "string",
      "isAuthority": true,
      "stageOrder": 0,
      "forwardGapCategory": "string"
    }
  ]
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "code": "string",
    "displayName": "string",
    "currencyCode": "string",
    "frequency": "string",
    "timezone": "string",
    "cutOffTime": "string",
    "graceHours": 0,
    "riskRating": "string",
    "absoluteTolerance": "string",
    "percentageTolerance": "string",
    "autoResolveEnabled": true,
    "signOffRequired": true,
    "active": true,
    "sides": [
      {
        "sideKey": "string",
        "entityCode": "string",
        "displayName": "string",
        "isAuthority": true,
        "stageOrder": 0,
        "forwardGapCategory": "string"
      }
    ]
  },
  "description": "Reconciliation defined successfully"
}

Responses

Status	When
`200`	Reconciliation defined successfully

GET Read one reconciliation and its sides

GET /reconciliation/definition/{code}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`code`

Example

Response: GenericResponseDefinitionResponse

curl -X GET "https://api.bridgemoni.com/reconciliation/definition/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",
    "displayName": "string",
    "currencyCode": "string",
    "frequency": "string",
    "timezone": "string",
    "cutOffTime": "string",
    "graceHours": 0,
    "riskRating": "string",
    "absoluteTolerance": "string",
    "percentageTolerance": "string",
    "autoResolveEnabled": true,
    "signOffRequired": true,
    "active": true,
    "sides": [
      {
        "sideKey": "string",
        "entityCode": "string",
        "displayName": "string",
        "isAuthority": true,
        "stageOrder": 0,
        "forwardGapCategory": "string"
      }
    ]
  },
  "description": "Reconciliation retrieved successfully"
}

Responses

Status	When
`200`	Reconciliation retrieved successfully

GET List the reconciliations on this tenant

GET /reconciliation/definitions

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Example

Response: GenericResponseListDefinitionResponse

curl -X GET "https://api.bridgemoni.com/reconciliation/definitions" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "code": "string",
      "displayName": "string",
      "currencyCode": "string",
      "frequency": "string",
      "timezone": "string",
      "cutOffTime": "string",
      "graceHours": 0,
      "riskRating": "string",
      "absoluteTolerance": "string",
      "percentageTolerance": "string",
      "autoResolveEnabled": true,
      "signOffRequired": true,
      "active": true,
      "sides": [
        {
          "sideKey": "string",
          "entityCode": "string",
          "displayName": "string",
          "isAuthority": true,
          "stageOrder": 0,
          "forwardGapCategory": "string"
        }
      ]
    }
  ],
  "description": "Reconciliations retrieved successfully"
}

Responses

Status	When
`200`	Reconciliations retrieved successfully

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors