action envoice_invoice_api_all {
  label: "Return all invoices for the account"
  provider: envoice
  method: GET
  path: "/api/invoice/all"
  encoding: json
  input: {
    type: "object"
    properties: {
      "queryOptions.page": {
        type: "integer"
        format: "int32"
      }
      "queryOptions.pageSize": {
        type: "integer"
        format: "int32"
      }
      "x-auth-key": {
        type: "string"
      }
      "x-auth-secret": {
        type: "string"
      }
    }
    required: ["x-auth-key", "x-auth-secret"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      Count: {
        type: "integer"
        format: "int32"
      }
      ErrorMessages: {
        type: "array"
        items: {
          type: "object"
          properties: {
            Code: {
              type: "string"
            }
            FaultMessage: {
              type: "string"
            }
            Group: {
              type: "string"
            }
            UserVisibleMessage: {
              type: "string"
            }
          }
        }
      }
      IsFaulted: {
        type: "boolean"
      }
      Result: {
        type: "array"
        items: {
          type: "object"
          properties: {
            AccessToken: {
              type: "string"
              description: "Security access token used for accessing the invoice anonymously"
            }
            Client: {
              type: "object"
              properties: {
                AdditionalEmails: {
                  type: "array"
                  description: "Client additional emails contact for CC"
                  items: {
                    type: "object"
                    properties: {
                      Email: {
                        type: "string"
                        description: "CC"
                      }
                    }
                  }
                }
                Address: {
                  type: "string"
                  description: "Client business address"
                }
                ClientCountryId: {
                  type: "integer"
                  format: "int32"
                  description: "Indicates the country where the clients is from"
                }
                ClientCurrencyId: {
                  type: "integer"
                  format: "int32"
                  description: "Indicates the default system currency used by the user for the client"
                }
                CompanyRegistrationNumber: {
                  type: "string"
                  description: "Client's Company Registration Number"
                }
                CreatedOn: {
                  type: "string"
                  format: "date-time"
                  description: "Date of creation"
                }
                DefaultDueDateInDays: {
                  type: "integer"
                  format: "int32"
                  description: "Client custom payment terms"
                }
                Email: {
                  type: "string"
                  description: "Client email"
                }
                Id: {
                  type: "integer"
                  format: "int32"
                  description: "Entity id"
                }
                Name: {
                  type: "string"
                  description: "Name of the client"
                }
                PhoneNumber: {
                  type: "string"
                  description: "Client phone numer"
                }
                UiLanguageId: {
                  type: "integer"
                  format: "int32"
                  description: "Hold a value of the language in which the invoice will be sent"
                }
                Vat: {
                  type: "string"
                  description: "Client's VAT number"
                }
              }
            }
            ClonedFromId: {
              type: "integer"
              format: "int32"
              description: "Indicate from which invoice this invoice has been cloned from"
            }
            Currency: {
              type: "object"
              properties: {
                Code: {
                  type: "string"
                  description: "Currency short numeric code"
                }
                Id: {
                  type: "integer"
                  format: "int32"
                  description: "Entity id"
                }
                Name: {
                  type: "string"
                  description: "Name of the country"
                }
                Symbol: {
                  type: "string"
                  description: "Currency symbol"
                }
                Value: {
                  type: "string"
                  description: "Currency short alpha code"
                }
              }
            }
            DiscountAmount: {
              type: "number"
              format: "double"
              description: "Amount that goes as a discount"
            }
            Duedate: {
              type: "string"
              format: "date-time"
              description: "Indicates when the invoice will be proclamed as due"
            }
            EnablePartialPayments: {
              type: "boolean"
              description: "Indicate that the invoice allows the user to pay the invoice partially"
            }
            Id: {
              type: "integer"
              format: "int32"
              description: "Invoice id"
            }
            InvoiceCategoryId: {
              type: "integer"
              format: "int32"
              description: "Hold the id of the invoice category"
            }
            IssuedOn: {
              type: "string"
              format: "date-time"
              description: "Indicates when the invoice was issued"
            }
            Notes: {
              type: "string"
              description: "Internal note regarding the invoice"
            }
            Number: {
              type: "string"
              description: "Unique invoice number"
            }
            PoNumber: {
              type: "string"
              description: "Unique number generated by the buyer"
            }
            RecurringProfile: {
              type: "object"
              description: "Definition of invoice recurring profile"
              properties: {
                DayOfMonth: {
                  type: "integer"
                  format: "int32"
                  description: "Day of month when the recurrance should happen"
                }
                DayOfWeek: {
                  type: "string"
                  description: "Day when the recurrance should happen"
                  enum: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
                }
                DueDateInDays: {
                  type: "integer"
                  format: "int32"
                  description: "Total number of days for the client to pay the invoice after issuing it"
                }
                EndOfRecurrance: {
                  type: "string"
                  format: "date-time"
                  description: "Indcate the date when the recurrance should stop"
                }
                Month: {
                  type: "integer"
                  format: "int32"
                  description: "Month when the recurrance should happen"
                }
                RecurrancePattern: {
                  type: "string"
                  description: "How often the recurrance occurs"
                  enum: ["Daily", "Weekly", "Monthly", "Yearly"]
                }
                RecurranceValue: {
                  type: "integer"
                  format: "int32"
                  description: "Recurring every [value] RecurrancePattern
\nEx: Recur every 1 week"
                }
                StartOfRecurrance: {
                  type: "string"
                  format: "date-time"
                  description: "Indcate the date when the recurrance has started"
                }
                Status: {
                  type: "string"
                  description: "The status of the recurrance"
                  enum: ["Pending", "Active", "Cancelled", "Finished"]
                }
                Title: {
                  type: "string"
                  description: "Title of the recurring profile. 
\nEx: BRAND PACKAGE - 2017-08-16 - 2018-08-16"
                }
              }
            }
            RecurringProfileId: {
              type: "integer"
              format: "int32"
              description: "Hold the id of the recurring profile"
            }
            ShouldSendReminders: {
              type: "boolean"
              description: "Should send email reminders to client?"
            }
            Status: {
              type: "string"
              description: "Indicate the status of the invoice (paid/unpaid/overdue)"
              enum: ["Draft", "Paid", "Unpaid", "Overdue", "Void"]
            }
            SubTotalAmount: {
              type: "number"
              format: "double"
              description: "Total amount of the invoice without tax"
            }
            TaxAmount: {
              type: "number"
              format: "double"
              description: "Amount that goes to the tax"
            }
            Terms: {
              type: "string"
              description: "Terms of agreement"
            }
            TotalAmount: {
              type: "number"
              format: "double"
              description: "Total amount of the invoice with tax"
            }
          }
        }
      }
      TotalCount: {
        type: "integer"
        format: "int32"
      }
    }
  }
}