Adjustment Presets version v1.0

HTTP status code 200

Returns a list of adjustment-preset items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of adjustment presets",
  "type": "object",
  "properties": {
    "adjustmentPresets": {
      "description": "An array of adjustment preset records",
      "id": "adjustmentPresets",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Adjustment Preset",
        "properties": {
          "id": {
            "description": "UUID of this adjustment preset",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "description": {
            "description": "Displayed in invoice line as a name for the input",
            "type": "string"
          },
          "exportToAccounting": {
            "description": "Whether or not to show this adjustment in batchedVoucherLines",
            "type": "boolean",
            "default": false
          },
          "prorate": {
            "description": "Displayed in invoice line per adjustment in toggled on in settings",
            "type": "string",
            "enum": [
              "By line",
              "By amount",
              "By quantity",
              "Not prorated"
            ],
            "default": "Not prorated"
          },
          "relationToTotal": {
            "description": "Relationship of this adjustment to the total;In addition to: added to subtotal;Included in: reported as subtotal portion;Separate from:calculated from subtotal",
            "type": "string",
            "enum": [
              "In addition to",
              "Included in",
              "Separate from"
            ],
            "default": "In addition to"
          },
          "type": {
            "description": "Adjustment type",
            "type": "string",
            "enum": [
              "Percentage",
              "Amount"
            ]
          },
          "alwaysShow": {
            "description": "Flag to toggle to always show this adjustment preset",
            "type": "boolean",
            "default": false
          },
          "defaultAmount": {
            "description": "Default adjustment value",
            "type": "number"
          },
          "metadata": {
            "type": "object",
            "readonly": true,
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "metadata.schema",
            "title": "Metadata Schema",
            "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
            "properties": {
              "createdDate": {
                "description": "Date and time when the record was created",
                "type": "string",
                "format": "date-time"
              },
              "createdByUserId": {
                "description": "ID of the user who created the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "createdByUsername": {
                "description": "Username of the user who created the record (when available)",
                "type": "string"
              },
              "updatedDate": {
                "description": "Date and time when the record was last updated",
                "type": "string",
                "format": "date-time"
              },
              "updatedByUserId": {
                "description": "ID of the user who last updated the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "updatedByUsername": {
                "description": "Username of the user who last updated the record (when available)",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "createdDate"
            ]
          },
          "_version": {
            "type": "integer",
            "description": "Record version for optimistic locking"
          }
        },
        "additionalProperties": false,
        "required": [
          "description",
          "exportToAccounting",
          "prorate",
          "relationToTotal",
          "type",
          "alwaysShow"
        ]
      }
    },
    "totalRecords": {
      "description": "Total number of records in the array",
      "type": "integer"
    }
  },
  "required": [
    "adjustmentPresets",
    "totalRecords"
  ]
}

Example:

{
  "adjustmentPresets": [
    {
      "id": "9d07cef9-9c9a-48f9-ac33-6cff4f23b160",
      "description": "Service Fee",
      "exportToAccounting": false,
      "prorate": "By line",
      "relationToTotal": "In addition to",
      "type": "Amount",
      "alwaysShow": true,
      "defaultAmount": 10,
      "metadata": {
        "createdDate": "2025-10-31T09:21:44.386+0000",
        "createdByUserId": "12408630-bce2-5a82-b577-9be500e9b324",
        "updatedDate": "2025-10-31T09:21:44.386+0000",
        "updatedByUserId": "12408630-bce2-5a82-b577-9be500e9b324"
      },
      "_version": 1
    }
  ],
  "totalRecords": 1
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

unable to list adjustment-presets -- malformed parameter 'query', syntax error at column 6

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list adjustment-presets -- unauthorized

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

HTTP status code 201

Adjustment Preset added

Headers

• Location: required(string)

  URI to the created adjustment-preset item

Body

Media type: application/json

Type: any

Example:

{
  "id": "9d07cef9-9c9a-48f9-ac33-6cff4f23b160",
  "description": "Service Fee",
  "exportToAccounting": false,
  "prorate": "By line",
  "relationToTotal": "In addition to",
  "type": "Amount",
  "alwaysShow": true,
  "defaultAmount": 10,
  "metadata": {
    "createdDate": "2025-10-31T09:21:44.386+0000",
    "createdByUserId": "12408630-bce2-5a82-b577-9be500e9b324",
    "updatedDate": "2025-10-31T09:21:44.386+0000",
    "updatedByUserId": "12408630-bce2-5a82-b577-9be500e9b324"
  },
  "_version": 1
}

HTTP status code 400

Bad Request

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "error.schema",
  "description": "An error",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error message text"
    },
    "type": {
      "type": "string",
      "description": "Error message type"
    },
    "code": {
      "type": "string",
      "description": "Error message code"
    },
    "parameters": {
      "description": "Error message parameters",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "parameters.schema",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "message"
  ]
}

Media type: text/plain

Type: any

Example:

"unable to add adjustment-preset -- malformed JSON at 13:3"

HTTP status code 401

Not found

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "error.schema",
  "description": "An error",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error message text"
    },
    "type": {
      "type": "string",
      "description": "Error message type"
    },
    "code": {
      "type": "string",
      "description": "Error message code"
    },
    "parameters": {
      "description": "Error message parameters",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "parameters.schema",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "message"
  ]
}

Media type: text/plain

Type: any

Example:

unable to create adjustment-presets -- unauthorized

HTTP status code 500

Internal error

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "error.schema",
  "description": "An error",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error message text"
    },
    "type": {
      "type": "string",
      "description": "Error message type"
    },
    "code": {
      "type": "string",
      "description": "Error message code"
    },
    "parameters": {
      "description": "Error message parameters",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "parameters.schema",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "message"
  ]
}

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

HTTP status code 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Adjustment Preset",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this adjustment preset",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "description": {
      "description": "Displayed in invoice line as a name for the input",
      "type": "string"
    },
    "exportToAccounting": {
      "description": "Whether or not to show this adjustment in batchedVoucherLines",
      "type": "boolean",
      "default": false
    },
    "prorate": {
      "description": "Displayed in invoice line per adjustment in toggled on in settings",
      "type": "string",
      "enum": [
        "By line",
        "By amount",
        "By quantity",
        "Not prorated"
      ],
      "default": "Not prorated"
    },
    "relationToTotal": {
      "description": "Relationship of this adjustment to the total;In addition to: added to subtotal;Included in: reported as subtotal portion;Separate from:calculated from subtotal",
      "type": "string",
      "enum": [
        "In addition to",
        "Included in",
        "Separate from"
      ],
      "default": "In addition to"
    },
    "type": {
      "description": "Adjustment type",
      "type": "string",
      "enum": [
        "Percentage",
        "Amount"
      ]
    },
    "alwaysShow": {
      "description": "Flag to toggle to always show this adjustment preset",
      "type": "boolean",
      "default": false
    },
    "defaultAmount": {
      "description": "Default adjustment value",
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "_version": {
      "type": "integer",
      "description": "Record version for optimistic locking"
    }
  },
  "additionalProperties": false,
  "required": [
    "description",
    "exportToAccounting",
    "prorate",
    "relationToTotal",
    "type",
    "alwaysShow"
  ]
}

Example:

{
  "id": "9d07cef9-9c9a-48f9-ac33-6cff4f23b160",
  "description": "Service Fee",
  "exportToAccounting": false,
  "prorate": "By line",
  "relationToTotal": "In addition to",
  "type": "Amount",
  "alwaysShow": true,
  "defaultAmount": 10,
  "metadata": {
    "createdDate": "2025-10-31T09:21:44.386+0000",
    "createdByUserId": "12408630-bce2-5a82-b577-9be500e9b324",
    "updatedDate": "2025-10-31T09:21:44.386+0000",
    "updatedByUserId": "12408630-bce2-5a82-b577-9be500e9b324"
  },
  "_version": 1
}

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"adjustment-preset not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

HTTP status code 204

Item deleted successfully

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to delete adjustment-preset -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"adjustment-preset not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

HTTP status code 204

Item successfully updated

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to update adjustment-preset -- malformed JSON at 13:4"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"adjustment-preset not found"

HTTP status code 409

Optimistic locking version conflict

Body

Media type: text/plain

Type: any

Example:

version conflict

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator