# Update Promises to Pay

Update Promises to Pay

Endpoint: PUT /rest/2.0/CS_PTP
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

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

  - `brmObjects` (object)

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

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

  - `brmObjects.Amount` (string, required)
    Tolerance Amount: The maximum underpayment allowed without breaching the Promise-to-Pay (PTP) requirements. Set this limit as a currency amount or as a percentage using the Tolerance Type selector.

  - `brmObjects.TrackType` (string)
    Track Payments: Sets the PTP to track all the payments registered for the account, or only those payment allocated to specific invoices.

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

  - `brmObjects.Status` (string)
    Status

  - `brmObjects.PauseFlag` (integer)
    Pause Collection Actions: When selected, all other pending Collection Actions associated to the account are paused until the PTP is no longer Open.

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

  - `brmObjects.Days` (string, required)
    Tolerance Days: The maximum number of days a payment can be late without breaching the PTP requirements.

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

  - `brmObjects.AccountId` (integer, required)
    Account

  - `brmObjects.AmountType` (string)
    Tolerance Type

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

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

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

  - `retrieveResponse.Note` (string)
    Note

  - `retrieveResponse.Amount` (string)
    Tolerance Amount: The maximum underpayment allowed without breaching the Promise-to-Pay (PTP) requirements. Set this limit as a currency amount or as a percentage using the Tolerance Type selector.

  - `retrieveResponse.TrackType` (string)
    Track Payments: Sets the PTP to track all the payments registered for the account, or only those payment allocated to specific invoices.

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

  - `retrieveResponse.Status` (string)
    Status

  - `retrieveResponse.PauseFlag` (integer)
    Pause Collection Actions: When selected, all other pending Collection Actions associated to the account are paused until the PTP is no longer Open.

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

  - `retrieveResponse.Days` (string)
    Tolerance Days: The maximum number of days a payment can be late without breaching the PTP requirements.

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

  - `retrieveResponse.AccountId` (integer)
    Account

  - `retrieveResponse.AmountType` (string)
    Tolerance Type

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

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