# Save Collection Strategies

Save Collection Strategies

Endpoint: POST /rest/2.0/CS_STRATEGY
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.Name` (string, required)
    Name

  - `brmObjects.DefaultFlag` (integer)
    Default Strategy: This strategy will become the Default strategy of the environment, and it will be the last strategy to be evaluated. This strategy will be evaluated against Individual Accounts only.

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

  - `brmObjects.Status` (string)
    Status

  - `brmObjects.AccountSelectionFormula` (string, required)
    Account Selection Formula: Formula detailing the criteria that an account needs to meet in order to be evaluated against the Amount Outstanding and Days Past Due thresholds. E.g., {!AccountObj.Name} = ‘Big Corp’

  - `brmObjects.AccountScope` (string, required)
    Account Scope: Indicates the accounts that will be taken into account when calculating the Days Past Due and the Amount OutstandingIndividual Accounts: The strategy will analyze the Days Past Due and the Amount Outstanding of the account’s approved invoices without looking into child accounts or any custom hierarchyAccount Hierarchy: Amounts Outstanding and Days Past Due of invoices from child accounts will also be taken into account.Custom Hierarchy: Same as Account Hierarchy, but using accounts determined by a custom filed instead of the standard Account Hierarchy.

  - `brmObjects.HierarchyField` (integer)
    Custom Hierarchy Field

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

  - `brmObjects.ExcludePTPFlag` (integer)
    ExcludePTPFlag

  - `brmObjects.ExcludeDisputeFlag` (integer)
    Exclude Invoices

  - `brmObjects.Priority` (string)
    Priority: Order in which the strategies will be evaluated. The strategy with Priority 1 will be evaluated first, and the Default strategy will be evaluated last.

  - `brmObjects.Id` (string, required)
    Id: Primary key

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

  - `brmObjects.AmountOutstanding` (string, required)
    Amount Outstanding: Minimum sum of the outstanding balances from the account’s approved invoices required for the Strategy to apply.

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

  - `brmObjects.DaysPastDue` (string, required)
    Days Past Due: Minimum days past due of any approved invoice required for the Strategy to apply

  - `brmObjects.SeparateCasesInHierarchy` (integer)
    Collections Case For Each Account: When unselected, the strategy will create a single collections case that includes all overdue accounts under its hierarchy. When this option is selected, the strategy will create a separate collections case for each overdue account under its hierarchy. Each separate collections case will still be located at the parent account level.

  - `brmObjects.AmountOutstandingForChilds` (integer)
    Evaluate Amount Outstanding at Individual Accounts: When this option is selected, the strategy will evaluate the Amount Outstanding for each individual account in the hierarchy against the Amount Outstanding in the collections strategy configuration.

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

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

  - `retrieveResponse.Name` (string)
    Name

  - `retrieveResponse.DefaultFlag` (integer)
    Default Strategy: This strategy will become the Default strategy of the environment, and it will be the last strategy to be evaluated. This strategy will be evaluated against Individual Accounts only.

  - `retrieveResponse.Description` (string)
    Description

  - `retrieveResponse.Status` (string)
    Status

  - `retrieveResponse.AccountSelectionFormula` (string)
    Account Selection Formula: Formula detailing the criteria that an account needs to meet in order to be evaluated against the Amount Outstanding and Days Past Due thresholds. E.g., {!AccountObj.Name} = ‘Big Corp’

  - `retrieveResponse.AccountScope` (string)
    Account Scope: Indicates the accounts that will be taken into account when calculating the Days Past Due and the Amount OutstandingIndividual Accounts: The strategy will analyze the Days Past Due and the Amount Outstanding of the account’s approved invoices without looking into child accounts or any custom hierarchyAccount Hierarchy: Amounts Outstanding and Days Past Due of invoices from child accounts will also be taken into account.Custom Hierarchy: Same as Account Hierarchy, but using accounts determined by a custom filed instead of the standard Account Hierarchy.

  - `retrieveResponse.HierarchyField` (integer)
    Custom Hierarchy Field

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

  - `retrieveResponse.ExcludePTPFlag` (integer)
    ExcludePTPFlag

  - `retrieveResponse.ExcludeDisputeFlag` (integer)
    Exclude Invoices

  - `retrieveResponse.Priority` (string)
    Priority: Order in which the strategies will be evaluated. The strategy with Priority 1 will be evaluated first, and the Default strategy will be evaluated last.

  - `retrieveResponse.Id` (string)
    Id: Primary key

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

  - `retrieveResponse.AmountOutstanding` (string)
    Amount Outstanding: Minimum sum of the outstanding balances from the account’s approved invoices required for the Strategy to apply.

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

  - `retrieveResponse.DaysPastDue` (string)
    Days Past Due: Minimum days past due of any approved invoice required for the Strategy to apply

  - `retrieveResponse.SeparateCasesInHierarchy` (integer)
    Collections Case For Each Account: When unselected, the strategy will create a single collections case that includes all overdue accounts under its hierarchy. When this option is selected, the strategy will create a separate collections case for each overdue account under its hierarchy. Each separate collections case will still be located at the parent account level.

  - `retrieveResponse.AmountOutstandingForChilds` (integer)
    Evaluate Amount Outstanding at Individual Accounts: When this option is selected, the strategy will evaluate the Amount Outstanding for each individual account in the hierarchy against the Amount Outstanding in the collections strategy configuration.

## 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