Upload New File

get-alma-invoices-swagger.json

+{
+  "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" : [ "invoices" ],
+        "summary" : null,
+        "description" : null,
+        "operationId" : "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" : "offset",
+          "in" : "query",
+          "description" : null,
+          "required" : false,
+          "type" : "string"
+        }, {
+          "name" : "apikey",
+          "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/invoices"
+            }
+          }
+        }
+      }
+    }
+  },
+  "definitions" : {
+    "invoices##invoice##additional_charges" : {
+      "properties" : {
+        "use_pro_rata" : {
+          "type" : "boolean"
+        },
+        "shipment" : {
+          "type" : "number",
+          "format" : "int32"
+        },
+        "overhead" : {
+          "type" : "number",
+          "format" : "int32"
+        },
+        "insurance" : {
+          "type" : "number",
+          "format" : "int32"
+        },
+        "discount" : {
+          "type" : "number",
+          "format" : "int32"
+        }
+      }
+    },
+    "invoices##invoice##invoice_vat" : {
+      "properties" : {
+        "report_tax" : {
+          "type" : "boolean"
+        },
+        "vat_per_invoice_line" : {
+          "type" : "boolean"
+        },
+        "vat_code" : {
+          "type" : "string"
+        },
+        "percentage" : {
+          "type" : "number",
+          "format" : "int32"
+        },
+        "vat_amount" : {
+          "type" : "number",
+          "format" : "int32"
+        },
+        "type" : {
+          "type" : "string"
+        },
+        "expended_from_fund" : {
+          "type" : "boolean"
+        }
+      }
+    },
+    "invoices##invoice##payment" : {
+      "properties" : {
+        "prepaid" : {
+          "type" : "boolean"
+        },
+        "internal_copy" : {
+          "type" : "boolean"
+        },
+        "payment_status" : {
+          "type" : "string"
+        },
+        "voucher_date" : {
+          "type" : "string"
+        },
+        "voucher_number" : {
+          "type" : "string"
+        },
+        "voucher_amount" : {
+          "type" : "number",
+          "format" : "int32"
+        },
+        "voucher_currency" : {
+          "type" : "string"
+        }
+      }
+    },
+    "invoices##invoice##alerts" : {
+      "properties" : {
+        "alert" : {
+          "type" : "array",
+          "items" : {
+            "type" : "string"
+          }
+        }
+      }
+    },
+    "invoices##invoice##invoice_lines##invoice_line##invoice_line_vat" : {
+      "properties" : {
+        "vat_code" : {
+          "type" : "string"
+        },
+        "percentage" : {
+          "type" : "number",
+          "format" : "int32"
+        },
+        "vat_amount" : {
+          "type" : "number",
+          "format" : "int32"
+        }
+      }
+    },
+    "invoices##invoice##invoice_lines##invoice_line##fund_distributions##fund_distribution" : {
+      "properties" : {
+        "fund_code" : {
+          "type" : "string"
+        },
+        "percent" : {
+          "type" : "number",
+          "format" : "int32"
+        },
+        "amount" : {
+          "type" : "number",
+          "format" : "double"
+        }
+      }
+    },
+    "invoices##invoice##invoice_lines##invoice_line##fund_distributions" : {
+      "properties" : {
+        "fund_distribution" : {
+          "$ref" : "#/definitions/invoices##invoice##invoice_lines##invoice_line##fund_distributions##fund_distribution"
+        }
+      }
+    },
+    "invoices##invoice##invoice_lines##invoice_line" : {
+      "properties" : {
+        "id" : {
+          "type" : "number",
+          "format" : "int64"
+        },
+        "type" : {
+          "type" : "string"
+        },
+        "number" : {
+          "type" : "number",
+          "format" : "int32"
+        },
+        "status" : {
+          "type" : "string"
+        },
+        "po_line" : {
+          "type" : "string"
+        },
+        "price" : {
+          "type" : "number",
+          "format" : "double"
+        },
+        "price_note" : {
+          "type" : "string"
+        },
+        "total_price" : {
+          "type" : "number",
+          "format" : "double"
+        },
+        "quantity" : {
+          "type" : "number",
+          "format" : "int32"
+        },
+        "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" : {
+          "type" : "number",
+          "format" : "int32"
+        },
+        "secondary_reporting_code" : {
+          "type" : "string"
+        },
+        "tertiary_reporting_code" : {
+          "type" : "string"
+        },
+        "note" : {
+          "type" : "string"
+        },
+        "invoice_line_vat" : {
+          "$ref" : "#/definitions/invoices##invoice##invoice_lines##invoice_line##invoice_line_vat"
+        },
+        "fund_distributions" : {
+          "$ref" : "#/definitions/invoices##invoice##invoice_lines##invoice_line##fund_distributions"
+        },
+        "subscription_from_date" : {
+          "type" : "string"
+        },
+        "subscription_to_date" : {
+          "type" : "string"
+        }
+      }
+    },
+    "invoices##invoice##invoice_lines" : {
+      "properties" : {
+        "invoice_line" : {
+          "$ref" : "#/definitions/invoices##invoice##invoice_lines##invoice_line"
+        }
+      }
+    },
+    "invoices##invoice##notes##note" : {
+      "properties" : {
+        "content" : {
+          "type" : "string"
+        },
+        "creation_date" : {
+          "type" : "string"
+        },
+        "created_by" : {
+          "type" : "number",
+          "format" : "int64"
+        }
+      }
+    },
+    "invoices##invoice##notes" : {
+      "properties" : {
+        "note" : {
+          "$ref" : "#/definitions/invoices##invoice##notes##note"
+        }
+      }
+    },
+    "invoices##invoice" : {
+      "properties" : {
+        "id" : {
+          "type" : "number"
+        },
+        "number" : {
+          "type" : "string"
+        },
+        "invoice_date" : {
+          "type" : "string"
+        },
+        "vendor" : {
+          "type" : "string"
+        },
+        "vendor_account" : {
+          "type" : "string"
+        },
+        "total_amount" : {
+          "type" : "number"
+        },
+        "currency" : {
+          "type" : "string"
+        },
+        "total_invoice_lines_amount" : {
+          "type" : "number"
+        },
+        "vendor_contact_person" : {
+          "type" : "string"
+        },
+        "payment_method" : {
+          "type" : "string"
+        },
+        "reference_number" : {
+          "type" : "string"
+        },
+        "creation_form" : {
+          "type" : "string"
+        },
+        "owner" : {
+          "type" : "string"
+        },
+        "invoice_status" : {
+          "type" : "string"
+        },
+        "invoice_workflow_status" : {
+          "type" : "string"
+        },
+        "invoice_approval_status" : {
+          "type" : "string"
+        },
+        "approved_by" : {
+          "type" : "string"
+        },
+        "approval_date" : {
+          "type" : "string"
+        },
+        "additional_charges" : {
+          "$ref" : "#/definitions/invoices##invoice##additional_charges"
+        },
+        "invoice_vat" : {
+          "$ref" : "#/definitions/invoices##invoice##invoice_vat"
+        },
+        "explicit_ratios" : {
+          "type" : "string"
+        },
+        "payment" : {
+          "$ref" : "#/definitions/invoices##invoice##payment"
+        },
+        "alerts" : {
+          "$ref" : "#/definitions/invoices##invoice##alerts"
+        },
+        "notes" : {
+          "type" : "string"
+        },
+        "number_of_lines" : {
+          "type" : "number"
+        },
+        "invoice_lines" : {
+          "$ref" : "#/definitions/invoices##invoice##invoice_lines"
+        }
+      }
+    },
+    "invoices##invoices" : {
+      "properties" : {
+        "invoice" : {
+          "type" : "array",
+          "items" : {
+            "$ref" : "#/definitions/invoices##invoice"
+          }
+        }
+      }
+    },
+    "invoices" : {
+      "properties" : {
+        "invoices" : {
+          "$ref" : "#/definitions/invoices##invoices"
+        }
+      }
+    }
+  }
+}
\ No newline at end of file