InvoicesResource class

The invoices endpoints with client already applied.

Constructors

InvoicesResource(ExsitedClient client): Bind the resource to a client; normally reached via client.invoices.
const

Properties

client → ExsitedClient: The client every call below is made through.
final
hashCode → int: The hash code for this object.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

amendInvoice(Object invoiceId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: POST /api/{api_version}/invoices/{invoice_id}/amend
cancelInvoice(Object invoiceId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: POST /api/{api_version}/invoices/{invoice_id}/cancel
createInvoice(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: POST /api/{api_version}/invoices
createInvoiceNote(Object invoiceId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceNote>>: POST /api/{api_version}/invoices/{invoice_id}/notes
createOrderInvoice(Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: POST /api/{api_version}/orders/{order_id}/invoices
deleteInvoice(Object invoiceId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: DELETE /api/{api_version}/invoices/{invoice_id}
deleteInvoiceNote(Object invoiceId, Object invoiceNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/invoices/{invoice_id}/notes/{invoice_note_id}
deleteInvoiceNoteFile(Object invoiceId, Object noteId, Object fileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/invoices/{invoice_id}/notes/{invoice_note_id}/files/{invoice_file_id}
getInvoice(Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: GET /api/{api_version}/invoices/{invoice_id}
getInvoiceCreditNoteApplication(Object invoiceId, Object creditNoteApplicationId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<CreditNoteApplicationRead>>: GET /api/{api_version}/invoices/{invoice_id}/credit_note_applications/{credit_note_application_id}
getInvoiceCustomObject(Object invoiceId, Object customObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/invoices/{invoice_id}/custom_objects/{custom_object_id}
getInvoiceCustomObjectInstance(Object invoiceId, Object customObjectId, Object instanceId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/invoices/{invoice_id}/custom_objects/{custom_object_id}/instances/{instance_id}
getInvoiceCustomObjects(Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/invoices/{invoice_id}/custom_objects
getInvoiceInformation(Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: GET /api/{api_version}/invoices/{invoice_id}/information
getInvoiceItemFulfillment(Object invoiceId, Object fulfillmentId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceItemFulfillment>>: GET /api/{api_version}/invoices/{invoice_id}/item_fulfillments/{fulfillment_id}
getInvoiceItemFulfillments(Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceItemFulfillmentList>>: GET /api/{api_version}/invoices/{invoice_id}/item_fulfillments
getInvoiceKpis(Object invoiceId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceKpisRead>>: GET /api/{api_version}/invoices/{invoice_id}/kpis
getInvoiceLine(Object invoiceId, Object lineId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceLineRead>>: GET /api/{api_version}/invoices/{invoice_id}/lines/{line_id}
getInvoiceLines(Object invoiceId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceLines>>: GET /api/{api_version}/invoices/{invoice_id}/lines
getInvoiceNote(Object invoiceId, Object invoiceNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceNote>>: GET /api/{api_version}/invoices/{invoice_id}/notes/{invoice_note_id}
getInvoiceNoteFile(Object invoiceId, Object invoiceNoteId, Object invoiceFileId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceNoteFile>>: GET /api/{api_version}/invoices/{invoice_id}/notes/{invoice_note_id}/files/{invoice_file_id}
getInvoiceNoteFiles(Object invoiceId, Object invoiceNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceNoteFileList>>: GET /api/{api_version}/invoices/{invoice_id}/notes/{invoice_note_id}/files
getInvoiceNotes(Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceNoteList>>: GET /api/{api_version}/invoices/{invoice_id}/notes
getInvoicePdf(Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoicePdf>>: GET /api/{api_version}/invoices/{invoice_id}/pdf
getInvoiceReturnMerchandiseAuthorisation(Object invoiceId, Object rmaId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceReturnMerchandiseAuthorisation>>: GET /api/{api_version}/invoices/{invoice_id}/return_merchandise_authorisations/{rma_id}
getInvoiceReturnMerchandiseAuthorisations(Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceReturnMerchandiseAuthorisationList>>: GET /api/{api_version}/invoices/{invoice_id}/return_merchandise_authorisations
getInvoices({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceList>>: GET /api/{api_version}/invoices
getOrderInvoices(Object orderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderInvoiceList>>: GET /api/{api_version}/orders/{order_id}/invoices
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
reactivateInvoice(Object invoiceId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: POST /api/{api_version}/invoices/{invoice_id}/reactivate
toString() → String: A string representation of this object.
inherited
updateInvoiceInformation(Object invoiceId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: PATCH /api/{api_version}/invoices/{invoice_id}/information

Operators

operator ==(Object other) → bool: The equality operator.
inherited

InvoicesResource class

Constructors

Properties

Methods

Operators

invoices library