API reference · Pricing, reporting & reconciliation

Reconciliation record store

GET/reconciliation/entity/{code}/entriesRead an entity's record store
GET/reconciliation/entity/{code}/usageRead an entity's metered record counts
GET/reconciliation/ingestion/{reference}/entriesRead the entries a delivery became
GET/reconciliation/ingestion/{reference}/rejectionsRead the rows a delivery could not turn into entries
GET/reconciliation/usage/{billingMonth}Read every entity's metered record counts for a month

GET Read an entity's record store

GET /reconciliation/entity/{code}/entries

Every active entry this entity has ever given us in the window, whatever channel it arrived on and whatever definitions consume it. One delivery is verified once, parsed once and stored once however many reconciliations read it. Superseded entries are excluded here - a correction replaces its original for matching purposes, and both remain on the record.

Headers

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

Path parameters

Name
`code`

Query parameters

Name	Default
`from`	Optional
`to`	Optional

Example

Response: GenericResponseListEntryResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "ingestionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "entityCode": "string",
      "channelKey": "string",
      "rowNumber": 0,
      "externalReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "counterpartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "providerReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "batchReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "amount": "string",
      "feeAmount": "string",
      "currencyCode": "string",
      "direction": "string",
      "valueDate": "string",
      "postedAt": "string",
      "narration": "string",
      "counterpartyName": "string",
      "counterpartyAccountMasked": "string",
      "declaredStatus": "string",
      "entryHash": "string",
      "lifecycle": "string",
      "amendsEntryReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "amendmentKind": "string",
      "supersededAt": "string"
    }
  ],
  "description": "Entries retrieved successfully"
}

Responses

Status	When
`200`	Entries retrieved successfully

GET Read an entity's metered record counts

GET /reconciliation/entity/{code}/usage

What this entity will be billed for, per channel per month, counted as records were accepted rather than reconstructed at invoice time. A duplicate delivery, a quarantined one and a row refused by its profile are all absent; an amendment counts, because it is a new record about the same event and it genuinely costs something to process.

Headers

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

Path parameters

Name
`code`

Example

Response: GenericResponseListUsageResponse

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

{
  "data": [
    {
      "entityCode": "string",
      "channelKey": "string",
      "billingMonth": "string",
      "recordCount": 0,
      "lastCountedAt": "string"
    }
  ],
  "description": "Usage retrieved successfully"
}

Responses

Status	When
`200`	Usage retrieved successfully

GET Read the entries a delivery became

GET /reconciliation/ingestion/{reference}/entries

One canonical entry per accepted row, in the order the rows arrived, with the original row kept alongside so an operator can see what actually came in. Amounts are always positive and the direction is a separate field: a signed column looks convenient until somebody's export uses parentheses for negatives, or inverts the sign because it describes the transaction from the other side, and a receipt quietly matches a payment.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListEntryResponse

curl -X GET "https://api.bridgemoni.com/reconciliation/ingestion/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/entries" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "ingestionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "entityCode": "string",
      "channelKey": "string",
      "rowNumber": 0,
      "externalReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "counterpartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "providerReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "batchReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "amount": "string",
      "feeAmount": "string",
      "currencyCode": "string",
      "direction": "string",
      "valueDate": "string",
      "postedAt": "string",
      "narration": "string",
      "counterpartyName": "string",
      "counterpartyAccountMasked": "string",
      "declaredStatus": "string",
      "entryHash": "string",
      "lifecycle": "string",
      "amendsEntryReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "amendmentKind": "string",
      "supersededAt": "string"
    }
  ],
  "description": "Entries retrieved successfully"
}

Responses

Status	When
`200`	Entries retrieved successfully

GET Read the rows a delivery could not turn into entries

GET /reconciliation/ingestion/{reference}/rejections

A row we refused, the reason we refused it, and the row itself. This is the first place to look when a counterparty's file lands but the totals are short: a profile that no longer matches their export refuses rows quietly and a reconciliation over what is left would be confidently wrong.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListRejectionResponse

curl -X GET "https://api.bridgemoni.com/reconciliation/ingestion/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/rejections" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "ingestionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "entityCode": "string",
      "rowNumber": 0,
      "rejection": "string",
      "detail": "string",
      "raw": "string"
    }
  ],
  "description": "Rejections retrieved successfully"
}

Responses

Status	When
`200`	Rejections retrieved successfully

GET Read every entity's metered record counts for a month

GET /reconciliation/usage/{billingMonth}

The billing month in the form yyyy-MM. Every invoice carries the count per entity per channel, because a reconciliation vendor that cannot let a customer reconcile its own bill has no business selling reconciliation.

Headers

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

Path parameters

Name
`billingMonth`

Example

Response: GenericResponseListUsageResponse

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

{
  "data": [
    {
      "entityCode": "string",
      "channelKey": "string",
      "billingMonth": "string",
      "recordCount": 0,
      "lastCountedAt": "string"
    }
  ],
  "description": "Usage retrieved successfully"
}

Responses

Status	When
`200`	Usage retrieved successfully

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