diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index b679c33b5c82..329e314a1580 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -12144,9 +12144,8 @@ paths: - invoices summary: "List invoices" description: | - Lists invoices, search and filters allow fine grained lists to be generated. - Query parameters can be added to performed more fine grained filtering of the invoices, - these are handled by the InvoiceFilters class which defines the methods available" + Lists invoices with the option to chain multiple query parameters allowing fine grained filtering of the list. + operationId: getInvoices parameters: - $ref: "#/components/parameters/X-API-TOKEN" @@ -12275,7 +12274,7 @@ paths: $ref: "#/components/schemas/FillableInvoice" responses: 200: - description: "Returns the saved invoice object" + description: "Returns the saved invoice entity" headers: X-MINIMUM-CLIENT-VERSION: $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" @@ -12419,7 +12418,7 @@ paths: tags: - invoices summary: "Edit invoice" - description: "Displays an invoice by id" + description: "Displays an invoice by id for editting" operationId: editInvoice parameters: - $ref: "#/components/parameters/X-API-TOKEN" @@ -12502,16 +12501,66 @@ paths: - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/index" requestBody: - description: "User credentials" + description: "Bulk action details" required: true content: application/json: schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" + type: object + properties: + action: + type: string + description: "The action to be performed" + examples: + bulk_download: + value: bulk_download + summary: Bulk download an array of invoice PDFs (These are sent to the admin via email.) + download: + value: download + summary: Download a single PDF. (Returns a single PDF object) + bulk_print: + value: bulk_print + summary: Merges an array of Invoice PDFs for easy one click printing. + auto_bill: + value: auto_bill + summary: Attempts to automatically bill the invoices with the payment method on file. + clone_to_invoice: + value: clone_to_invoice + summary: Returns a clone of the invoice. + clone_to_quote: + value: clone_to_quote + summary: Returns a quote cloned using the properties of the given invoice. + mark_paid: + value: mark_paid + summary: Marks an array of invoices as paid. + mark_sent: + value: mark_sent + summary: Marks an array of invoices as sent. + restore: + value: restore + summary: Restores an array of invoices + delete: + value: delete + summary: Deletes an array of invoices + archive: + value: archive + summary: Archives an array of invoices + cancel: + value: cancel + summary: Cancels an array of invoices + email: + value: email + summary: Emails an array of invoices + send_email: + value: send_email + summary: Emails an array of invoices. Requires additional properties to be sent. `email_type` + ids: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: 200: description: "The Bulk Action response" diff --git a/openapi/paths/invoices.yaml b/openapi/paths/invoices.yaml index 2008cf9c23f6..1e5ef306854c 100644 --- a/openapi/paths/invoices.yaml +++ b/openapi/paths/invoices.yaml @@ -375,12 +375,45 @@ bulk_download: value: bulk_download summary: Bulk download an array of invoice PDFs (These are sent to the admin via email.) - account: - value: account - summary: The associated Account - bank_transactions: - value: bank_transactions - summary: The associated Bank Transactions + download: + value: download + summary: Download a single PDF. (Returns a single PDF object) + bulk_print: + value: bulk_print + summary: Merges an array of Invoice PDFs for easy one click printing. + auto_bill: + value: auto_bill + summary: Attempts to automatically bill the invoices with the payment method on file. + clone_to_invoice: + value: clone_to_invoice + summary: Returns a clone of the invoice. + clone_to_quote: + value: clone_to_quote + summary: Returns a quote cloned using the properties of the given invoice. + mark_paid: + value: mark_paid + summary: Marks an array of invoices as paid. + mark_sent: + value: mark_sent + summary: Marks an array of invoices as sent. + restore: + value: restore + summary: Restores an array of invoices + delete: + value: delete + summary: Deletes an array of invoices + archive: + value: archive + summary: Archives an array of invoices + cancel: + value: cancel + summary: Cancels an array of invoices + email: + value: email + summary: Emails an array of invoices + send_email: + value: send_email + summary: Emails an array of invoices. Requires additional properties to be sent. `email_type` ids: type: array items: