test_openAPI

swagger: '2.0'
info:
  description: AccountingSuite v2 API
  version: 2.0.1
  title: AccountingSuite v2 API
host: accountingsuite.com
schemes:
  - http
basePath: /v2
tags: 
  - name: 'invoices'
paths:
  /invoices:
    get:
      tags: 
      - 'invoices'
      summary: 'Retrieve a list of invoices'
      responses:
        '200':
          description: Success response
          schema:
            $ref: '#/definitions/Invoice'
    post:
      tags: 
      - 'invoices'    
      summary: Create new invoices
      description: ""
      consumes:
      - "application/json"
      produces:
      - "application/json"      
      parameters:
        - in: body
          name: 'body'
          required: true
          schema:
            $ref: '#/definitions/Invoice'
      responses:
        '200':
          description: Success response
          schema:
            $ref: '#/definitions/Invoice'          

definitions:

  Account:
    type: object
    properties:
      Number:
        type: 'string'
        example: '1003' 

  Address:
    type: object
    properties:
      ID:
        type: 'string'
        description: 'The unique identifier generated by AccountingSuite.'
        example: '71206de7-0ceb-4165-912b-1dc7561c72a8'
      Name:
        type: 'string'
        description: 'Full name of Contact / Address'
        example: "Jane Thompson's default address"
      AddressLine1:
        type: 'string'
        example: 'Germany, Berlin'
      AddressLine2:
        type: 'string'
        example: 'Elm Street, 18a'
      AddressLine3:
        type: 'string'
        example: 'Second entrance from left side'
      FirstName:
        type: 'string'
        example: 'Jane'
      MiddleName:
        type: 'string'
        example: 'Anne'        
      LastName:
        type: 'string'
        example: 'Thompson'
      City:
        type: 'string'
        example: 'Berlin'
      State:
        type: 'string'
        example: 'Berlin'      
      Country:
        type: 'string'
        example: 'Germany'        
      ZIP:
        type: 'string'
        example: '12345'
      Phone:
        type: 'string'
        example: '(555) 754-3010'
      Cell:
        type: 'string'
        example: '555-754-3010'
      Fax:
        type: 'string'
        example: '001-555-754-3010'
      Email:
        type: 'string'
        example: 'janethompson@example.com'

  Company:
    type: object
    required:
    - "Name"
    properties:
      ID:
        type: 'string'
        description: 'The unique identifier generated by AccountingSuite.'
        example: '96166ed6-dc57-4439-95a0-c27290ad62f3'
      Name:
        type: 'string'
        description: 'Full name of contact / organisation.'
        example: 'Jane Thompson'
      LastModifiedDate:
        type: 'string'
        format: 'date-time'
        example: '2018-01-01T11:00:00Z'
        description: 'Date and time in UTC of the last change of the Currency, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Attribute is filled automatically.'
      BillingAddress:
        $ref: "#/definitions/Address"
      ShippingAddress:
        $ref: "#/definitions/Address" 
      DefaultCurrency:
        $ref: "#/definitions/Currency"
      Notes:
        type: 'string'
        description: 'Free form text describing the Company.'
        example: 'Has no debts'
      Website:
        type: 'string'
        description: 'Website address.'
        example: 'example.com'
      IsCustomer:
        type: 'boolean'
        default: false
        example: true
      IsVendor:
        type: 'boolean'
        default: false
        example: false
      Taxable:
        type: 'boolean'
        description: 'If true, transactions for this customer are taxable.'
        example: true
        default: true

  Currency:
    type: object
    properties:
      Code:
        type: 'string'
        example: 'USD'
        description: 'The three letter code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_8601) format for the currency.'
      Name:
        type: 'string'
        example: 'US Dollar'
      LastModifiedDate:
        type: 'string'
        format: 'date-time'
        example: '2018-01-01T11:00:00Z'
        description: 'Date and time in UTC of the last change of the Currency, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Attribute is filled automatically.'

  Invoice:
    type: "object"
    properties:
      InvoiceNumber:
        type: 'string'
        example: '1001'
      ID:
        type: 'string'
        example: '5e891e00-bcb6-467d-b0fa-1aaf5956f2a8'
      LastModifiedDate:
        type: 'string'
        format: 'date-time'
        example: '2018-01-01T11:00:00Z'
      Status:
        type: "string"
        description: "Invoice Status"
        enum:
        - "Deleted"
        - "Draft"
        - "Paid"
        - "Open"
        - "PartiallyPaid"
        - "NoCharge"
        example: "Draft"
      Date:
        type: 'string'
        format: 'date-time'
      DeliveryDate:
        type: 'string'
        format: 'date-time'      
        example: '2018-01-09T12:00:00-07:00Z'
      DueDate:
        type: 'string'
        format: 'date-time'      
        example: '2018-02-08T12:00:00-07:00Z'
      Currency:
        $ref: "#/definitions/Currency"
      BillingAddress:
        $ref: "#/definitions/Address"
      ShippingAddress:
        $ref: "#/definitions/Address"
      Customer:
        $ref: "#/definitions/Company"
      LineItems:
        type: array
        items:
          $ref: "#/definitions/InvoiceLineItem"
      Location:
        $ref: "#/definitions/Location"

  InvoiceLineItem:
    type: object
    properties:
      Item:
        $ref: "#/definitions/Item"
      Description:
        type: string
        description: 'Free form text description of the line item that appears in the print forms.'
        example: 'entrenching shovel'
      Quantity:
        type: number
        example: 15
      Price:
        type: number
        example: '99.90'
      TotalAmount:
        type: number
        example: '1487.60'

  Item:
    type: object
    required:
    - "Name"    
    properties:    
      ID:
        type: 'string'
        example: '72ccd3b1-194f-4e5e-b004-1e2b1d328689'
      Name:
        type: 'string'
        example: 'Pillow'
      LastModifiedDate:
        type: 'string'
        format: 'date-time'
        example: '2018-01-01T11:00:00Z'
        description: 'Date and time in UTC of the last change of the Item, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Attribute is filled automatically.'
      SKU:
        type: 'string'
        example: '654321'
      Type:
        type: 'string'
        description: "Item type"
        enum:
        - "inventory"
        - "service"
        default: 'inventory'
      Taxable:
        type: boolean
        description: 'If true, transactions for this item are taxable. If not specified, value is filled according to "Quick menu" - "Settings" - "Sales settings" - "Mark all new products taxable" setting.'
      Status:
        type: string
        enum: 
        - "active"
        - "inactive"
        default: 'active'
      PreferredVendor:
        $ref: "#/definitions/Company"
      IncomeAccount:
        $ref: "#/definitions/Account"
      ExpenseAccount:
        $ref: "#/definitions/Account"
      InventoryAccount:
        $ref: "#/definitions/Account"
      Price:
        type: number
        description: 'Price of an item.'
        example: 99.99
        
  Location:
    type: object
    required:
    - "Name"
    properties:
      ID:
        type: 'string'
        description: 'The unique identifier generated by AccountingSuite.'
        example: 'c946323e-cbca-499e-a054-9029112255e7'
      Name:
        type: string
        example: 'main warehouse'
      LastModifiedDate:
        type: 'string'
        format: 'date-time'
        example: '2018-01-01T11:00:00Z'
        description: 'Date and time in UTC of the last change of the Location, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Attribute is filled automatically.'