{ "swagger" : "2.0", "info" : { "description" : null, "version" : "1.0.0", "title" : null, "termsOfService" : null, "contact" : null, "license" : null }, "host" : "api-na.hosted.exlibrisgroup.com", "basePath" : "/almaws/v1/acq/invoices", "schemes" : [ "https" ], "paths" : { "/" : { "get" : { "tags" : [ "alma-invoices" ], "summary" : null, "description" : null, "operationId" : "alma-invoices", "produces" : [ "application/json" ], "consumes" : [ "application/json" ], "parameters" : [ { "name" : "invoice_workflow_status", "in" : "query", "description" : null, "required" : false, "type" : "string" }, { "name" : "base_status", "in" : "query", "description" : null, "required" : false, "type" : "string" }, { "name" : "apikey", "in" : "query", "description" : null, "required" : false, "type" : "string" }, { "name" : "offset", "in" : "query", "description" : null, "required" : false, "type" : "string" }, { "name" : "limit", "in" : "query", "description" : null, "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/alma-invoices" } } } } } }, "definitions" : { "alma-invoices##invoice##vendor" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##currency" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##owner" : { "properties" : { "value" : { "type" : "string" } } }, "alma-invoices##invoice##payment##payment_status" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##payment##voucher_currency" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##payment" : { "properties" : { "prepaid" : { "type" : "boolean" }, "internal_copy" : { "type" : "boolean" }, "payment_status" : { "$ref" : "#/definitions/alma-invoices##invoice##payment##payment_status" }, "voucher_date" : { "type" : "string" }, "voucher_number" : { "type" : "string" }, "voucher_amount" : { "type" : "string" }, "voucher_currency" : { "$ref" : "#/definitions/alma-invoices##invoice##payment##voucher_currency" } } }, "alma-invoices##invoice##payment_method" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##creation_form" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##invoice_status" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##invoice_workflow_status" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##invoice_approval_status" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##additional_charges" : { "properties" : { "shipment" : { "type" : "number", "format" : "double" }, "overhead" : { "type" : "number", "format" : "double" }, "insurance" : { "type" : "number", "format" : "double" }, "discount" : { "type" : "number", "format" : "double" }, "use_pro_rata" : { "type" : "boolean" } } }, "alma-invoices##invoice##invoice_vat##type" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##invoice_vat##vat_code" : { "properties" : { "value" : { "type" : "string" } } }, "alma-invoices##invoice##invoice_vat" : { "properties" : { "percentage" : { "type" : "number", "format" : "double" }, "type" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_vat##type" }, "report_tax" : { "type" : "boolean" }, "vat_per_invoice_line" : { "type" : "boolean" }, "vat_code" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_vat##vat_code" }, "vat_amount" : { "type" : "number", "format" : "int32" }, "expended_from_fund" : { "type" : "boolean" } } }, "alma-invoices##invoice##alert" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##note" : { "properties" : { "content" : { "type" : "string" }, "creation_date" : { "type" : "string" }, "created_by" : { "type" : "string" } } }, "alma-invoices##invoice##number_of_lines" : { "properties" : { "value" : { "type" : "number", "format" : "int32" }, "link" : { "type" : "string" } } }, "alma-invoices##invoice##invoice_lines##invoice_line##type" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##invoice_lines##invoice_line##status" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##invoice_lines##invoice_line##reporting_code" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##invoice_lines##invoice_line##secondary_reporting_code" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##invoice_lines##invoice_line##tertiary_reporting_code" : { "properties" : { "value" : { "type" : "string" } } }, "alma-invoices##invoice##invoice_lines##invoice_line##invoice_line_vat##vat_code" : { "properties" : { "value" : { "type" : "string" } } }, "alma-invoices##invoice##invoice_lines##invoice_line##invoice_line_vat" : { "properties" : { "percentage" : { "type" : "number", "format" : "double" }, "vat_code" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_lines##invoice_line##invoice_line_vat##vat_code" }, "vat_amount" : { "type" : "number", "format" : "int32" } } }, "alma-invoices##invoice##invoice_lines##invoice_line##fund_distribution##fund_code" : { "properties" : { "value" : { "type" : "string" }, "desc" : { "type" : "string" } } }, "alma-invoices##invoice##invoice_lines##invoice_line##fund_distribution" : { "properties" : { "percent" : { "type" : "number" }, "amount" : { "type" : "number" }, "fund_code" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_lines##invoice_line##fund_distribution##fund_code" } } }, "alma-invoices##invoice##invoice_lines##invoice_line" : { "properties" : { "id" : { "type" : "string" }, "type" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_lines##invoice_line##type" }, "number" : { "type" : "string" }, "status" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_lines##invoice_line##status" }, "price" : { "type" : "number" }, "quantity" : { "type" : "number" }, "note" : { "type" : "string" }, "po_line" : { "type" : "string" }, "price_note" : { "type" : "string" }, "total_price" : { "type" : "number" }, "vat_note" : { "type" : "string" }, "check_subscription_date_overlap" : { "type" : "boolean" }, "fully_invoiced" : { "type" : "boolean" }, "additional_info" : { "type" : "string" }, "release_remaining_encumbrance" : { "type" : "boolean" }, "reporting_code" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_lines##invoice_line##reporting_code" }, "secondary_reporting_code" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_lines##invoice_line##secondary_reporting_code" }, "tertiary_reporting_code" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_lines##invoice_line##tertiary_reporting_code" }, "invoice_line_vat" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_lines##invoice_line##invoice_line_vat" }, "fund_distribution" : { "type" : "array", "items" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_lines##invoice_line##fund_distribution" } }, "link" : { "type" : "string" }, "subscription_from_date" : { "type" : "string" }, "subscription_to_date" : { "type" : "string" } } }, "alma-invoices##invoice##invoice_lines" : { "properties" : { "invoice_line" : { "type" : "array", "items" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_lines##invoice_line" } }, "total_record_count" : { "type" : "number", "format" : "int32" } } }, "alma-invoices##invoice" : { "properties" : { "id" : { "type" : "string" }, "number" : { "type" : "string" }, "vendor" : { "$ref" : "#/definitions/alma-invoices##invoice##vendor" }, "currency" : { "$ref" : "#/definitions/alma-invoices##invoice##currency" }, "owner" : { "$ref" : "#/definitions/alma-invoices##invoice##owner" }, "payment" : { "$ref" : "#/definitions/alma-invoices##invoice##payment" }, "invoice_date" : { "type" : "string" }, "vendor_account" : { "type" : "string" }, "total_amount" : { "type" : "number" }, "total_invoice_lines_amount" : { "type" : "number" }, "vendor_contact_person" : { "type" : "string" }, "payment_method" : { "$ref" : "#/definitions/alma-invoices##invoice##payment_method" }, "reference_number" : { "type" : "string" }, "creation_form" : { "$ref" : "#/definitions/alma-invoices##invoice##creation_form" }, "invoice_status" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_status" }, "invoice_workflow_status" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_workflow_status" }, "invoice_approval_status" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_approval_status" }, "approved_by" : { "type" : "string" }, "approval_date" : { "type" : "string" }, "additional_charges" : { "$ref" : "#/definitions/alma-invoices##invoice##additional_charges" }, "invoice_vat" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_vat" }, "explicit_ratio" : { "type" : "string" }, "alert" : { "type" : "array", "items" : { "$ref" : "#/definitions/alma-invoices##invoice##alert" } }, "note" : { "type" : "string" }, "number_of_lines" : { "$ref" : "#/definitions/alma-invoices##invoice##number_of_lines" }, "invoice_lines" : { "$ref" : "#/definitions/alma-invoices##invoice##invoice_lines" }, "link" : { "type" : "string" } } }, "alma-invoices" : { "properties" : { "invoice" : { "type" : "array", "items" : { "$ref" : "#/definitions/alma-invoices##invoice" } }, "total_record_count" : { "type" : "number", "format" : "int32" } } } } }