foliolib.folio.api.financeStorage.TransactionSummary

class foliolib.folio.api.financeStorage.TransactionSummary(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

mod-finance-storage (Transaction summaries)

CRUD APIs used to manage transaction summaries.

Parameters

• tenant (str) – Tenant id

• okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

delete_invoiceTransactionSummary(...)	Delete invoiceTransactionSummary item with given {invoiceTransactionSummaryId}
delete_orderTransactionSummary(...)	Delete orderTransactionSummary item with given {orderTransactionSummaryId}
get_invoiceTransactionSummary(...)	Retrieve invoiceTransactionSummary item with given {invoiceTransactionSummaryId}
get_orderTransactionSummary(...)	Retrieve orderTransactionSummary item with given {orderTransactionSummaryId}
modify_invoiceTransactionSummary(...)	Update invoiceTransactionSummary item with given {invoiceTransactionSummaryId}
modify_orderTransactionSummary(...)	Update orderTransactionSummary item with given {orderTransactionSummaryId}
set_invoiceTransactionSummary(...)	Create a new invoice transaction summary item.
set_orderTransactionSummary(...)	Create a new order transaction summary item.

delete_invoiceTransactionSummary(invoiceTransactionSummariesId: str)

Delete invoiceTransactionSummary item with given {invoiceTransactionSummaryId}

DELETE /finance-storage/invoice-transaction-summaries/{invoiceTransactionSummariesId}

Parameters

invoiceTransactionSummariesId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

delete_orderTransactionSummary(orderTransactionSummariesId: str)

Delete orderTransactionSummary item with given {orderTransactionSummaryId}

DELETE /finance-storage/order-transaction-summaries/{orderTransactionSummariesId}

Parameters

orderTransactionSummariesId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

get_invoiceTransactionSummary(invoiceTransactionSummariesId: str)

Retrieve invoiceTransactionSummary item with given {invoiceTransactionSummaryId}

GET /finance-storage/invoice-transaction-summaries/{invoiceTransactionSummariesId}

Parameters

invoiceTransactionSummariesId (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestNotFound – Not Found

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Invoice transactions Summary",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this summary",
      "$ref": "../../common/schemas/uuid.json"
    },
    "numPendingPayments": {
      "description": "Total number of pending payments(transactions) expected for this invoice. Negative value indicates that all transactions have been processed",
      "type": "integer"
    },
    "numPaymentsCredits": {
      "description": "Total number of payments/credits(transactions) expected for this invoice. Negative value indicates that all transactions have been processed",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "numPendingPayments",
    "numPaymentsCredits"
  ]
}

get_orderTransactionSummary(orderTransactionSummariesId: str)

Retrieve orderTransactionSummary item with given {orderTransactionSummaryId}

GET /finance-storage/order-transaction-summaries/{orderTransactionSummariesId}

Parameters

orderTransactionSummariesId (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestNotFound – Not Found

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Order transactions summary",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this summary",
      "$ref": "../../common/schemas/uuid.json"
    },
    "numTransactions": {
      "description": "Total number of transactions (encumbrances) expected for this order. Negative value indicates that all transactions have been processed",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "numTransactions"
  ]
}

modify_invoiceTransactionSummary(invoiceTransactionSummariesId: str, invoiceTransactionSummary: dict)

Update invoiceTransactionSummary item with given {invoiceTransactionSummaryId}

PUT /finance-storage/invoice-transaction-summaries/{invoiceTransactionSummariesId}

Parameters

• invoiceTransactionSummariesId (str) –

• invoiceTransactionSummary (dict) – See Schema below

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestConflict – Conflict

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Invoice transactions Summary",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this summary",
      "$ref": "../../common/schemas/uuid.json"
    },
    "numPendingPayments": {
      "description": "Total number of pending payments(transactions) expected for this invoice. Negative value indicates that all transactions have been processed",
      "type": "integer"
    },
    "numPaymentsCredits": {
      "description": "Total number of payments/credits(transactions) expected for this invoice. Negative value indicates that all transactions have been processed",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "numPendingPayments",
    "numPaymentsCredits"
  ]
}

modify_orderTransactionSummary(orderTransactionSummariesId: str, orderTransactionSummary: dict)

Update orderTransactionSummary item with given {orderTransactionSummaryId}

PUT /finance-storage/order-transaction-summaries/{orderTransactionSummariesId}

Parameters

• orderTransactionSummariesId (str) –

• orderTransactionSummary (dict) – See Schema below

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestConflict – Conflict

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Order transactions summary",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this summary",
      "$ref": "../../common/schemas/uuid.json"
    },
    "numTransactions": {
      "description": "Total number of transactions (encumbrances) expected for this order. Negative value indicates that all transactions have been processed",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "numTransactions"
  ]
}

set_invoiceTransactionSummary(invoiceTransactionSummary: dict)

Create a new invoice transaction summary item.

POST /finance-storage/invoice-transaction-summaries

Parameters

invoiceTransactionSummary (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

Headers

• Location - URI to the created invoice transaction summary item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Invoice transactions Summary",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this summary",
      "$ref": "../../common/schemas/uuid.json"
    },
    "numPendingPayments": {
      "description": "Total number of pending payments(transactions) expected for this invoice. Negative value indicates that all transactions have been processed",
      "type": "integer"
    },
    "numPaymentsCredits": {
      "description": "Total number of payments/credits(transactions) expected for this invoice. Negative value indicates that all transactions have been processed",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "numPendingPayments",
    "numPaymentsCredits"
  ]
}

set_orderTransactionSummary(orderTransactionSummary: dict)

Create a new order transaction summary item.

POST /finance-storage/order-transaction-summaries

Parameters

orderTransactionSummary (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

Headers

• Location - URI to the created order transaction summary item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Order transactions summary",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this summary",
      "$ref": "../../common/schemas/uuid.json"
    },
    "numTransactions": {
      "description": "Total number of transactions (encumbrances) expected for this order. Negative value indicates that all transactions have been processed",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "numTransactions"
  ]
}