Permalink
Cannot retrieve contributors at this time
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
72 lines (62 sloc)
2.91 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#%RAML 1.0 | |
title: Finance Transaction Summaries | |
version: v1.1 | |
protocols: [ HTTP, HTTPS ] | |
baseUri: https://github.com/folio-org/mod-finance | |
documentation: | |
- title: Transaction Summaries API | |
content: This documents the API calls that can be made to create Transaction summaries for Orders and Invoices | |
types: | |
order-transaction-summary: !include acq-models/mod-finance/schemas/order_transaction_summary.json | |
invoice-transaction-summary: !include acq-models/mod-finance/schemas/invoice_transaction_summary.json | |
errors: !include raml-util/schemas/errors.schema | |
traits: | |
validate: !include raml-util/traits/validation.raml | |
language: !include raml-util/traits/language.raml | |
resourceTypes: | |
post-with-201: !include rtypes/post-json-201.raml | |
put-json: !include rtypes/post-put-json.raml | |
/finance/order-transaction-summaries: | |
displayName: Create a transaction allocation | |
description: Create a new order transaction summary | |
type: | |
post-with-201: | |
requestSchema: order-transaction-summary | |
responseSchema: order-transaction-summary | |
requestExample: !include acq-models/mod-finance/examples/order_transaction_summary.sample | |
responseExample: !include acq-models/mod-finance/examples/order_transaction_summary.sample | |
is: [validate] | |
post: | |
description: Create a new order transaction summary, for an order with number of transactions(encumbrances) | |
/{id}: | |
displayName: Create a transaction summary | |
description: Create a new order transaction summary | |
type: | |
put-json: | |
schemaItem: order-transaction-summary | |
exampleItem: !include acq-models/mod-finance/examples/order_transaction_summary.sample | |
is: [validate] | |
put: | |
description: Updated order transaction summary, for an order with number of transactions(encumbrances) | |
/finance/invoice-transaction-summaries: | |
displayName: Create a transaction allocation | |
description: Create a new invoice transaction summary | |
type: | |
post-with-201: | |
requestSchema: invoice-transaction-summary | |
responseSchema: invoice-transaction-summary | |
requestExample: !include acq-models/mod-finance/examples/invoice_transaction_summary.sample | |
responseExample: !include acq-models/mod-finance/examples/invoice_transaction_summary.sample | |
is: [validate] | |
post: | |
description: Create a new invoice transaction summary, for an order with number of transactions(encumbrances) and number of payment credits | |
/{id}: | |
displayName: Update a transaction summary | |
description: Update a new invoice transaction summary | |
type: | |
put-json: | |
schemaItem: invoice-transaction-summary | |
exampleItem: !include acq-models/mod-finance/examples/invoice_transaction_summary.sample | |
is: [validate] | |
put: | |
description: Updated invoice transaction summary, for an invoice with number of pending payments and number of payment/credits |