# Save Lockbox Matching Rule

Save Lockbox Matching Rule

Endpoint: POST /rest/2.0/LOCKBOX_MATCHING_RULE
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `brmObjects.RuleName` (string, required)
    Rule Name

  - `brmObjects.InvoiceCriteriaJoinLogic` (string)
    Criteria Join Logic

  - `brmObjects.BPCriteriaJoinLogic` (string)
    Criteria Join Logic: Billing Profile Criteria Join Logic

  - `brmObjects.PaymentCriteriaJoinLogic` (string)
    Criteria Join Logic

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

  - `brmObjects.OverallocationRule` (string)
    Overpayment Behavior

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `brmObjects.Id` (string, required)
    Id

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.RuleType` (string, required)
    Rule Type

  - `brmObjects.RegenerateRulesFlag` (string)
    RegenerateRulesFlag

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.RuleName` (string)
    Rule Name

  - `retrieveResponse.InvoiceCriteriaJoinLogic` (string)
    Criteria Join Logic

  - `retrieveResponse.BPCriteriaJoinLogic` (string)
    Criteria Join Logic: Billing Profile Criteria Join Logic

  - `retrieveResponse.PaymentCriteriaJoinLogic` (string)
    Criteria Join Logic

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.OverallocationRule` (string)
    Overpayment Behavior

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.Id` (string)
    Id

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.RuleType` (string)
    Rule Type

  - `retrieveResponse.RegenerateRulesFlag` (string)
    RegenerateRulesFlag

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error