invoices library

The v4 invoices family: its endpoints, bound class, path templates and views.

Import it with a prefix, import 'package:exsited/invoices.dart' as invoices;, because families declare the same top-level names and a Dart export can neither rename nor prefix them.

Classes

AccountInvoice: One entry of a AccountInvoiceList's data.
AccountInvoiceAccount: A AccountInvoice's account.
AccountInvoiceCreatedBy: A AccountInvoice's created_by.
AccountInvoiceCurrency: A AccountInvoice's currency.
AccountInvoiceCustomForm: A AccountInvoice's custom_form.
AccountInvoiceLastPayment: A AccountInvoice's last_payment.
AccountInvoiceLastUpdatedBy: A AccountInvoice's last_updated_by.
AccountInvoiceList: One page of what getAccountInvoices lists, under data.
AccountInvoiceOrder: A AccountInvoice's order.
Invoice: One invoice.
InvoiceAccount: A Invoice's account.
InvoiceActivityLog: One entry of a Invoice's activity_logs.
InvoiceCreatedBy: A Invoice's created_by.
InvoiceCurrency: A Invoice's currency.
InvoiceCustomForm: A Invoice's custom_form.
InvoiceItemFulfillment: What getInvoiceItemFulfillment answers, under item_fulfillment.
InvoiceItemFulfillmentAccount: A InvoiceItemFulfillment's account.
InvoiceItemFulfillmentCreatedBy: A InvoiceItemFulfillment's created_by.
InvoiceItemFulfillmentEntry: One entry of a InvoiceItemFulfillmentList's data.
InvoiceItemFulfillmentEntryAccount: A InvoiceItemFulfillmentEntry's account.
InvoiceItemFulfillmentEntryCreatedBy: A InvoiceItemFulfillmentEntry's created_by.
InvoiceItemFulfillmentEntryFulfillment: One entry of a InvoiceItemFulfillmentEntry's fulfillments.
InvoiceItemFulfillmentEntryFulfillmentItem: A InvoiceItemFulfillmentEntryFulfillment's item.
InvoiceItemFulfillmentEntryInvoice: A InvoiceItemFulfillmentEntry's invoice.
InvoiceItemFulfillmentEntryLastUpdatedBy: A InvoiceItemFulfillmentEntry's last_updated_by.
InvoiceItemFulfillmentFulfillment: One entry of a InvoiceItemFulfillment's fulfillments.
InvoiceItemFulfillmentFulfillmentItem: A InvoiceItemFulfillmentFulfillment's item.
InvoiceItemFulfillmentInvoice: A InvoiceItemFulfillment's invoice.
InvoiceItemFulfillmentLastUpdatedBy: A InvoiceItemFulfillment's last_updated_by.
InvoiceItemFulfillmentList: One page of what getInvoiceItemFulfillments lists, under data.
InvoiceKpisRead: What getInvoiceKpis answers, under invoice_kpis: the block an invoice carries as kpis, with an object beside it.
InvoiceLastPayment: A Invoice's last_payment.
InvoiceLastUpdatedBy: A Invoice's last_updated_by.
InvoiceLine: One entry of a Invoice's lines.
InvoiceLineAccountingCode: A InvoiceLine's accounting_code.
InvoiceLineItem: A InvoiceLine's item.
InvoiceLineRead: What getInvoiceLine answers, under invoice: its object and one line.
InvoiceLines: What getInvoiceLines answers, under invoice: its object and lines, and nothing else of the invoice.
InvoiceLineTax: A InvoiceLine's tax.
InvoiceList: A page of invoices.
InvoiceNote: What getInvoiceNote answers, under note.
InvoiceNoteAttachment: One entry of a InvoiceNote's attachments.
InvoiceNoteCreatedBy: A InvoiceNote's created_by.
InvoiceNoteEntry: One entry of a InvoiceNoteList's data.
InvoiceNoteEntryAttachment: One entry of a InvoiceNoteEntry's attachments.
InvoiceNoteEntryCreatedBy: A InvoiceNoteEntry's created_by.
InvoiceNoteEntryInvoice: A InvoiceNoteEntry's invoice.
InvoiceNoteEntryWatcher: One entry of a InvoiceNoteEntry's watchers.
InvoiceNoteFile: What getInvoiceNoteFile answers, under file.
InvoiceNoteFileEntry: One entry of a InvoiceNoteFileList's data.
InvoiceNoteFileList: One page of what getInvoiceNoteFiles lists, under data.
InvoiceNoteInvoice: A InvoiceNote's invoice.
InvoiceNoteList: A page of an invoice's notes.
InvoiceNoteWatcher: One entry of a InvoiceNote's watchers.
InvoiceOrder: A Invoice's order.
InvoicePdf: What getInvoicePdf answers, under invoice.
InvoicePdfPdf: A InvoicePdf's pdf.
InvoiceReturnMerchandiseAuthorisation: What getInvoiceReturnMerchandiseAuthorisation answers, under return_merchandise_authorisation.
InvoiceReturnMerchandiseAuthorisationAccount: A InvoiceReturnMerchandiseAuthorisation's account.
InvoiceReturnMerchandiseAuthorisationCreatedBy: A InvoiceReturnMerchandiseAuthorisation's created_by.
InvoiceReturnMerchandiseAuthorisationEntry: One entry of a InvoiceReturnMerchandiseAuthorisationList's data.
InvoiceReturnMerchandiseAuthorisationEntryAccount: A InvoiceReturnMerchandiseAuthorisationEntry's account.
InvoiceReturnMerchandiseAuthorisationEntryCreatedBy: A InvoiceReturnMerchandiseAuthorisationEntry's created_by.
InvoiceReturnMerchandiseAuthorisationEntrySaleInvoice: A InvoiceReturnMerchandiseAuthorisationEntry's sale_invoice.
InvoiceReturnMerchandiseAuthorisationList: One page of what getInvoiceReturnMerchandiseAuthorisations lists, under data.
InvoiceReturnMerchandiseAuthorisationReceiveRma: One entry of a InvoiceReturnMerchandiseAuthorisation's receive_rmas.
InvoiceReturnMerchandiseAuthorisationReceiveRmaCreatedBy: A InvoiceReturnMerchandiseAuthorisationReceiveRma's created_by.
InvoiceReturnMerchandiseAuthorisationSaleInvoice: A InvoiceReturnMerchandiseAuthorisation's sale_invoice.
InvoicesResource: The invoices endpoints with client already applied.
InvoicesUrls
OrderInvoice: One entry of a OrderInvoiceList's data.
OrderInvoiceAccount: A OrderInvoice's account.
OrderInvoiceCreatedBy: A OrderInvoice's created_by.
OrderInvoiceCurrency: A OrderInvoice's currency.
OrderInvoiceCustomForm: A OrderInvoice's custom_form.
OrderInvoiceList: One page of what getOrderInvoices lists, under data.
OrderInvoiceOrder: A OrderInvoice's order.

Functions

amendInvoice(ExsitedClient client, Object invoiceId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: POST /api/{api_version}/invoices/{invoice_id}/amend
cancelInvoice(ExsitedClient client, Object invoiceId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: POST /api/{api_version}/invoices/{invoice_id}/cancel
createInvoice(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: POST /api/{api_version}/invoices
createInvoiceNote(ExsitedClient client, Object invoiceId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceNote>>: POST /api/{api_version}/invoices/{invoice_id}/notes
createOrderInvoice(ExsitedClient client, Object orderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: POST /api/{api_version}/orders/{order_id}/invoices
deleteInvoice(ExsitedClient client, Object invoiceId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: DELETE /api/{api_version}/invoices/{invoice_id}
deleteInvoiceNote(ExsitedClient client, Object invoiceId, Object invoiceNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/invoices/{invoice_id}/notes/{invoice_note_id}
deleteInvoiceNoteFile(ExsitedClient client, 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(ExsitedClient client, Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: GET /api/{api_version}/invoices/{invoice_id}
getInvoiceCreditNoteApplication(ExsitedClient client, 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(ExsitedClient client, Object invoiceId, Object customObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/invoices/{invoice_id}/custom_objects/{custom_object_id}
getInvoiceCustomObjectInstance(ExsitedClient client, 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(ExsitedClient client, Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/invoices/{invoice_id}/custom_objects
getInvoiceInformation(ExsitedClient client, Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: GET /api/{api_version}/invoices/{invoice_id}/information
getInvoiceItemFulfillment(ExsitedClient client, 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(ExsitedClient client, Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceItemFulfillmentList>>: GET /api/{api_version}/invoices/{invoice_id}/item_fulfillments
getInvoiceKpis(ExsitedClient client, Object invoiceId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceKpisRead>>: GET /api/{api_version}/invoices/{invoice_id}/kpis
getInvoiceLine(ExsitedClient client, Object invoiceId, Object lineId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceLineRead>>: GET /api/{api_version}/invoices/{invoice_id}/lines/{line_id}
getInvoiceLines(ExsitedClient client, Object invoiceId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceLines>>: GET /api/{api_version}/invoices/{invoice_id}/lines
getInvoiceNote(ExsitedClient client, 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(ExsitedClient client, 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(ExsitedClient client, 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(ExsitedClient client, Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceNoteList>>: GET /api/{api_version}/invoices/{invoice_id}/notes
getInvoicePdf(ExsitedClient client, Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoicePdf>>: GET /api/{api_version}/invoices/{invoice_id}/pdf
getInvoiceReturnMerchandiseAuthorisation(ExsitedClient client, 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(ExsitedClient client, Object invoiceId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceReturnMerchandiseAuthorisationList>>: GET /api/{api_version}/invoices/{invoice_id}/return_merchandise_authorisations
getInvoices(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<InvoiceList>>: GET /api/{api_version}/invoices
getOrderInvoices(ExsitedClient client, Object orderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<OrderInvoiceList>>: GET /api/{api_version}/orders/{order_id}/invoices
reactivateInvoice(ExsitedClient client, Object invoiceId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: POST /api/{api_version}/invoices/{invoice_id}/reactivate
updateInvoiceInformation(ExsitedClient client, Object invoiceId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Invoice>>: PATCH /api/{api_version}/invoices/{invoice_id}/information

invoices library

Classes

Functions

exsited package

invoices library