invoiceninja/openapi/components/schemas/purchase_order.yaml

    PurchaseOrder:
      properties:
        id:
          description: 'The unique hashed identifier for the purchase order'
          type: string
          example: Opnel5aKBz
        user_id:
          description: 'The unique hashed identifier for the user who created the purchase order'
          type: string
          example: ''
        assigned_user_id:
          description: 'The unique hashed identifier for the user assigned to the purchase order'
          type: string
          example: ''
        vendor_id:
          description: 'The unique hashed identifier for the vendor associated with the purchase order'
          type: string
          example: ''
        status_id:
          description: 'The status of the purchase order represented by a unique identifier'
          type: string
          example: ''
        number:
          description: 'The unique alpha-numeric purchase order number per company'
          type: string
          example: PO_101
        quote_number:
          description: 'The quote number associated with this purchase order'
          type: string
          example: QUOTE_101
        terms:
          description: 'The terms and conditions for the purchase order'
          type: string
          example: 'These are some purchase order terms. Valid for 14 days.'
        public_notes:
          description: 'Publicly visible notes associated with the purchase order'
          type: string
          example: 'These are public notes which the vendor may see'
        private_notes:
          description: 'Privately visible notes associated with the purchase order, not disclosed to the vendor'
          type: string
          example: 'These are private notes, not to be disclosed to the vendor'
        footer:
          description: 'The footer text of the purchase order'
          type: string
          example: 'The text goes in the footer of the purchase order'
        custom_value1:
          description: 'First custom value field for additional information'
          type: string
          example: 'A custom value'
        custom_value2:
          description: 'Second custom value field for additional information'
          type: string
          example: 'A custom value'
        custom_value3:
          description: 'Third custom value field for additional information'
          type: string
          example: 'A custom value'
        custom_value4:
          description: 'Fourth custom value field for additional information'
          type: string
          example: 'A custom value'
        tax_name1:
          description: 'The name of the first tax applied to the purchase order'
          type: string
          example: GST
        tax_name2:
          description: 'The name of the second tax applied to the purchase order'
          type: string
          example: VAT
        tax_rate1:
          description: 'The rate of the first tax applied to the purchase order'
          type: number
          format: float
          example: 10.00
        tax_rate2:
          description: 'The rate of the second tax applied to the purchase order'
          type: number
          format: float
          example: 10.00
        tax_name3:
          description: 'The name of the third tax applied to the purchase order'
          type: string
          example: ''
        tax_rate3:
          description: 'The rate of the third tax applied to the purchase order'
          type: number
          format: float
          example: 10.00
        total_taxes:
          description: 'The total amount of taxes applied to the purchase order'
          type: number
          format: float
          example: 10.00
        line_items:
          type: array
          description: 'An array of objects which define the line items of the purchase order'
          items:
            $ref: '#/components/schemas/InvoiceItem'
        amount:
          description: 'The total amount of the purchase order before taxes and discounts'
          type: number
          format: float
          example: 10.00
        balance:
          description: 'The balance due for the purchase order after accounting for payments'
          type: number
          format: float
          example: 10.00
        paid_to_date:
          description: 'The total amount paid on the purchase order so far'
          type: number
          format: float
          example: 10.00
        discount:
          description: 'The discount amount or percentage applied to the purchase order'
          type: number
          format: float
          example: 10.00
        partial:
          description: 'The partial or deposit amount for the purchase order'
          type: number
          format: float
          example: 10.00
        is_amount_discount:
          description: 'Boolean flag indicating if the discount is a fixed amount or a percentage'
          type: boolean
          example: true
        is_deleted:
          description: 'Boolean flag indicating if the purchase order has been deleted'
          type: boolean
          example: false
        uses_inclusive_taxes:
          description: 'Boolean flag indicating if the taxes used are inclusive or exclusive'
          type: boolean
          example: true
        date:
          description: 'The date the purchase order was created'
          type: string
          format: date
          example: '1994-07-30'
        last_sent_date:
          description: 'The last date the purchase order was sent to the vendor'
          type: string
          format: date
          example: '1994-07-30'
        next_send_date:
          description: 'The next scheduled date for sending a reminder for the purchase order'
          type: string
          format: date
          example: '1994-07-30'
        partial_due_date:
          description: 'The due date for the partial or deposit amount'
          type: string
          format: date
          example: '1994-07-30'
        due_date:
          description: 'The due date for the total amount of the purchase order'
          type: string
          format: date
          example: '1994-07-30'
        settings:
          $ref: '#/components/schemas/CompanySettings'
        last_viewed:
          description: Timestamp
          type: number
          format: integer
          example: 1434342123
        updated_at:
          description: Timestamp
          type: number
          format: integer
          example: 1434342123
        archived_at:
          description: Timestamp
          type: number
          format: integer
          example: 1434342123
        custom_surcharge1:
          description: 'First custom surcharge amount for the purchase order'
          type: number
          format: float
          example: 10.00
        custom_surcharge2:
          description: 'Second custom surcharge amount for the purchase order'
          type: number
          format: float
          example: 10.00
        custom_surcharge3:
          description: 'Third custom surcharge amount for the purchase order'
          type: number
          format: float
          example: 10.00
        custom_surcharge4:
          description: 'Fourth custom surcharge amount for the purchase order'
          type: number
          format: float
          example: 10.00
        custom_surcharge_tax1:
          description: 'Boolean flag indicating if taxes are charged on the first custom surcharge amount'
          type: boolean
          example: true
        custom_surcharge_tax2:
          description: 'Boolean flag indicating if taxes are charged on the second custom surcharge amount'
          type: boolean
          example: true
        custom_surcharge_tax3:
          description: 'Boolean flag indicating if taxes are charged on the third custom surcharge amount'
          type: boolean
          example: true
        custom_surcharge_tax4:
          description: 'Boolean flag indicating if taxes are charged on the fourth custom surcharge amount'
          type: boolean
          example: true
      type: object