List sales documents models

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "appId": {
      "type": "integer"
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "comparator": {
            "type": "string",
            "enum": [
              "=",
              "<",
              ">",
              "<=",
              ">=",
              "!=",
              "LIKE",
              "IN",
              "REGEX"
            ]
          },
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      }
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "order": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "direction": {
            "type": "string",
            "enum": [
              "asc",
              "desc"
            ]
          },
          "name": {
            "type": "string"
          }
        }
      }
    },
    "search": {
      "type": "string"
    }
  },
  "required": [
    "appId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "properties": {
      "id": {
        "type": "integer"
      },
      "json": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "account": {
              "type": "object"
            },
            "action": {
              "type": "string",
              "enum": [
                "sell",
                "rent"
              ]
            },
            "amount": {
              "type": "integer",
              "description": "Price without taxes in cents"
            },
            "amount_accurately": {
              "type": "integer",
              "description": "Price without taxes in cents + 3 decimales, example : 9899000 = 98,99€ || 1 = 0,00001€"
            },
            "amount_with_taxes": {
              "type": "boolean",
              "description": "Used when there is a difference of 1 cent when starting from the amount with taxes"
            },
            "detail": {
              "type": "string",
              "description": "Description of the product or service"
            },
            "discount": {
              "type": "object",
              "properties": {
                "amount": {
                  "type": "integer",
                  "description": "Use discount value for fix discount"
                },
                "percent": {
                  "type": "integer",
                  "description": "Use discount percent for variable discount"
                }
              }
            },
            "document": {
              "type": "object"
            },
            "id": {
              "type": "integer"
            },
            "metadata": {
              "type": "array",
              "items": {
                "type": "object"
              }
            },
            "product": {
              "type": "object",
              "properties": {
                "accounting_number": {
                  "type": "string"
                },
                "amount_accurately": {
                  "type": "integer",
                  "description": "Price without taxes in milli-cents"
                },
                "category": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer"
                    },
                    "image": {
                      "type": "object"
                    },
                    "name": {
                      "type": "string"
                    },
                    "parent": {
                      "type": "object",
                      "additionalProperties": true
                    },
                    "products": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                },
                "currency": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "id": {
                  "type": "integer"
                },
                "image": {
                  "type": "object"
                },
                "intangible": {
                  "type": "boolean",
                  "description": "Is a service or a product ?"
                },
                "lifetime": {
                  "type": "integer",
                  "description": "Product life time in seconds"
                },
                "metadata": {
                  "type": "array",
                  "items": {
                    "type": "object"
                  }
                },
                "name": {
                  "type": "string"
                },
                "quantity_name": {
                  "type": "string",
                  "description": "Name of the quantity: days, liters, m2, m3..."
                },
                "reference": {
                  "type": "string"
                },
                "tags": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "unity": {
                  "type": "string",
                  "description": "Unity, hours, days, meters, liters.."
                },
                "vat_percent": {
                  "type": "integer",
                  "description": "VAT rate in cents"
                }
              }
            },
            "quantity": {
              "type": "number",
              "format": "double",
              "description": "Quantity of product or service"
            },
            "stock": {
              "properties": {
                "bar_code": {
                  "type": "integer"
                },
                "cost_amount": {
                  "type": "integer"
                },
                "entered_at": {
                  "type": "integer"
                },
                "expired_at": {
                  "type": "integer"
                },
                "id": {
                  "type": "integer"
                },
                "initial_quantity": {
                  "type": "integer"
                },
                "location": {
                  "type": "integer"
                },
                "product": {
                  "type": "object",
                  "additionalProperties": true
                },
                "product_stocks_movements": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "description": {
                        "type": "string"
                      },
                      "future_return_date": {
                        "type": "string",
                        "format": "date-time"
                      },
                      "id": {
                        "type": "integer"
                      },
                      "invoice": {
                        "type": "object"
                      },
                      "moved_at": {
                        "type": "string",
                        "format": "date-time"
                      },
                      "product_stock": {
                        "type": "object",
                        "additionalProperties": true
                      },
                      "quantity": {
                        "type": "integer"
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "buy",
                          "sell",
                          "back",
                          "temporaryexit",
                          "destruct"
                        ]
                      },
                      "use_duration": {
                        "type": "integer",
                        "description": "Usage duration in seconds"
                      }
                    }
                  }
                },
                "purchase": {
                  "properties": {
                    "account": {
                      "type": "object",
                      "properties": {
                        "accounting_number": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "editable": {
                          "type": "boolean"
                        },
                        "id": {
                          "type": "integer"
                        },
                        "is_associate": {
                          "type": "boolean"
                        },
                        "is_cashflow": {
                          "type": "boolean"
                        },
                        "is_purchase": {
                          "type": "boolean"
                        },
                        "is_sales": {
                          "type": "boolean"
                        },
                        "is_various": {
                          "type": "boolean"
                        },
                        "journalcode": {
                          "type": "string"
                        },
                        "keywords": {
                          "type": "string",
                          "description": "keywords comma separated"
                        },
                        "name": {
                          "type": "string"
                        },
                        "need_charge": {
                          "type": "boolean"
                        },
                        "need_employee": {
                          "type": "boolean"
                        },
                        "need_invoice": {
                          "type": "boolean"
                        },
                        "technical_name": {
                          "type": "string"
                        }
                      }
                    },
                    "accounted_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Date on which the accounting entries were generated"
                    },
                    "amount": {
                      "type": "integer",
                      "description": "Amount without taxes in cents"
                    },
                    "amount_net_foreign_currency": {
                      "type": "integer",
                      "description": "Amount without taxes in cents"
                    },
                    "amount_tax": {
                      "type": "integer",
                      "description": "Amount of taxes in cents"
                    },
                    "balance": {
                      "type": "object",
                      "properties": {
                        "completed": {
                          "type": "boolean"
                        },
                        "due": {
                          "type": "integer",
                          "description": "Initial balance total due"
                        },
                        "meaning": {
                          "type": "string",
                          "enum": [
                            "completed",
                            "remaining",
                            "overpaid"
                          ]
                        },
                        "paid": {
                          "type": "integer"
                        },
                        "remaining": {
                          "type": "integer"
                        }
                      }
                    },
                    "billed_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Date of invoice"
                    },
                    "comment": {
                      "type": "string",
                      "description": "free field"
                    },
                    "completed_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Date on which the account, supplier, amount and billed_at fields were completed"
                    },
                    "foreign_currency": {
                      "type": "string",
                      "description": "Amount of taxes in cents"
                    },
                    "id": {
                      "type": "integer"
                    },
                    "is_late": {
                      "type": "boolean",
                      "description": "The payment deadline has passed and full payment has not been received"
                    },
                    "md5": {
                      "type": "string",
                      "description": "Md5 hash of the initial file sent"
                    },
                    "paid_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Date on which the invoice was fully paid"
                    },
                    "payment_account_number": {
                      "type": "string",
                      "description": "Payment Account number"
                    },
                    "payment_deadline_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Payment deadline"
                    },
                    "payment_iban": {
                      "type": "string",
                      "description": "Payment IBAN"
                    },
                    "payment_routing_number": {
                      "type": "string",
                      "description": "Payment Routing number"
                    },
                    "payment_swift": {
                      "type": "string",
                      "description": "Payment SWIFT"
                    },
                    "picture": {
                      "type": "string",
                      "description": "Purchase picture"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "new",
                        "completed",
                        "paid"
                      ]
                    },
                    "supplier": {
                      "type": "object"
                    },
                    "supplier_name": {
                      "type": "string"
                    },
                    "tags": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "title": {
                      "type": "string",
                      "description": "Name visible on the accounting entries of the purchase"
                    },
                    "vat_detail": {
                      "type": "object",
                      "description": "VAT breakdown"
                    },
                    "vat_repayment": {
                      "type": "string",
                      "description": "In France, depending on the type of purchase (product or service), VAT is not payable at the same time. VAT on products is due on the date of the invoice, while VAT on services is due on the date of payment thereof",
                      "enum": [
                        "payment",
                        "billing"
                      ]
                    },
                    "will_be_late_at": {
                      "type": "string",
                      "format": "date-time",
                      "description": "Date the payment will be late. Is `false` if payment has been made"
                    }
                  }
                },
                "quantity_in": {
                  "type": "integer"
                },
                "quantity_out": {
                  "type": "integer"
                },
                "sales_lines": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": true
                  }
                },
                "use_duration": {
                  "type": "integer"
                }
              }
            },
            "style": {
              "type": "object",
              "properties": {
                "position": {
                  "type": "integer"
                },
                "section_id": {
                  "type": "integer",
                  "description": "Section is an Order with a position like SectionId"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "section",
                    "description",
                    "product"
                  ]
                }
              }
            },
            "total_quantity": {
              "type": "string",
              "description": "Information about total quantity to sell, only for display"
            },
            "totals": {
              "type": "object",
              "properties": {
                "due": {
                  "type": "integer"
                },
                "subtotal": {
                  "type": "integer"
                },
                "taxes": {
                  "type": "integer"
                }
              }
            },
            "unity": {
              "type": "string",
              "description": "Unity, hours, days, meters, liters.."
            },
            "vat_percent": {
              "type": "integer",
              "description": "VAT rate in cents"
            }
          }
        }
      },
      "name": {
        "type": "string"
      },
      "title": {
        "type": "string"
      }
    }
  }
}