purchase_orders library

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

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

Classes

AccountPurchaseOrders: The account purchase orders body.
AccountPurchaseOrdersData: One entry of a AccountPurchaseOrders's data.
AccountPurchaseOrdersDataAccount: A AccountPurchaseOrdersData's account.
AccountPurchaseOrdersDataCreatedBy: A AccountPurchaseOrdersData's created_by.
AccountPurchaseOrdersDataCurrency: A AccountPurchaseOrdersData's currency.
AccountPurchaseOrdersDataCustomForm: A AccountPurchaseOrdersData's custom_form.
AccountPurchaseOrdersDataLastUpdatedBy: A AccountPurchaseOrdersData's last_updated_by.
PurchaseOrder: The purchase order body.
PurchaseOrderAccount: A PurchaseOrder's account.
PurchaseOrderCreatedBy: A PurchaseOrder's created_by.
PurchaseOrderCurrency: A PurchaseOrder's currency.
PurchaseOrderCustomForm: A PurchaseOrder's custom_form.
PurchaseOrderInformation: The purchase order information body.
PurchaseOrderInformationCreatedBy: A PurchaseOrderInformation's created_by.
PurchaseOrderInformationCustomAttribute: One entry of a PurchaseOrderInformation's custom_attributes.
PurchaseOrderInformationCustomForm: A PurchaseOrderInformation's custom_form.
PurchaseOrderInformationLastUpdatedBy: A PurchaseOrderInformation's last_updated_by.
PurchaseOrderKpis: What getPurchaseOrderKpis answers, under purchase_order_kpis: the block a purchase order carries as kpis.
PurchaseOrderLastUpdatedBy: A PurchaseOrder's last_updated_by.
PurchaseOrderLine: The purchase order line body.
PurchaseOrderLineItem: A PurchaseOrderLine's item.
PurchaseOrderLineItemAccountingCode: A PurchaseOrderLine's item_accounting_code.
PurchaseOrderLineItemPriceSnapshot: A PurchaseOrderLine's item_price_snapshot.
PurchaseOrderLineItemPriceSnapshotPricingRule: A PurchaseOrderLineItemPriceSnapshot's pricing_rule.
PurchaseOrderLineItemPriceTax: A PurchaseOrderLine's item_price_tax.
PurchaseOrderLineItemPurchaseAccountingCode: A PurchaseOrderLine's item_purchase_accounting_code.
PurchaseOrderLineItemPurchaseTaxConfiguration: A PurchaseOrderLine's item_purchase_tax_configuration.
PurchaseOrderLineItemPurchaseTaxConfigurationTaxCode: A PurchaseOrderLineItemPurchaseTaxConfiguration's tax_code.
PurchaseOrderLineList: A page of PurchaseOrderLine records.
PurchaseOrderLineRead: The purchase order line read body.
PurchaseOrderLineReadItem: A PurchaseOrderLineRead's item.
PurchaseOrderLineReadItemAccountingCode: A PurchaseOrderLineRead's item_accounting_code.
PurchaseOrderLineReadItemPriceSnapshot: A PurchaseOrderLineRead's item_price_snapshot.
PurchaseOrderLineReadItemPriceSnapshotPricingRule: A PurchaseOrderLineReadItemPriceSnapshot's pricing_rule.
PurchaseOrderLineReadItemPriceTax: A PurchaseOrderLineRead's item_price_tax.
PurchaseOrderLineReadItemPurchaseAccountingCode: A PurchaseOrderLineRead's item_purchase_accounting_code.
PurchaseOrderLineReadItemPurchaseTaxConfiguration: A PurchaseOrderLineRead's item_purchase_tax_configuration.
PurchaseOrderLineReadItemPurchaseTaxConfigurationTaxCode: A PurchaseOrderLineReadItemPurchaseTaxConfiguration's tax_code.
PurchaseOrderLineReadTax: A PurchaseOrderLineRead's tax.
PurchaseOrderLineReadUom: A PurchaseOrderLineRead's uom.
PurchaseOrderLineReadWarehouse: A PurchaseOrderLineRead's warehouse.
PurchaseOrderLineTax: A PurchaseOrderLine's tax.
PurchaseOrderLineUom: A PurchaseOrderLine's uom.
PurchaseOrderLineWarehouse: A PurchaseOrderLine's warehouse.
PurchaseOrderList: A page of PurchaseOrder records.
PurchaseOrderNote: The purchase order note body.
PurchaseOrderNoteFile: What getPurchaseOrderNoteFile answers, under file.
PurchaseOrderNoteFileEntry: One entry of a PurchaseOrderNoteFileList's data.
PurchaseOrderNoteFileList: One page of what getPurchaseOrderNoteFiles lists, under data.
PurchaseOrderNotes: The purchase order notes body.
PurchaseOrderNotesData: One entry of a PurchaseOrderNotes's data.
PurchaseOrderNotesDataAttachment: One entry of a PurchaseOrderNotesData's attachments.
PurchaseOrderNotesDataCreatedBy: A PurchaseOrderNotesData's created_by.
PurchaseOrderNotesDataPurchaseOrder: A PurchaseOrderNotesData's purchase_order.
PurchaseOrderNotesDataWatcher: One entry of a PurchaseOrderNotesData's watchers.
PurchaseOrderNoteView: What getPurchaseOrderNote answers, under note.
PurchaseOrderNoteViewAttachment: One entry of a PurchaseOrderNoteView's attachments.
PurchaseOrderNoteViewCreatedBy: A PurchaseOrderNoteView's created_by.
PurchaseOrderNoteViewPurchaseOrder: A PurchaseOrderNoteView's purchase_order.
PurchaseOrderNoteViewWatcher: One entry of a PurchaseOrderNoteView's watchers.
PurchaseOrderPurchaseInvoice: The purchase order purchase invoice body.
PurchaseOrderPurchaseInvoiceAccount: A PurchaseOrderPurchaseInvoice's account.
PurchaseOrderPurchaseInvoiceCreatedBy: A PurchaseOrderPurchaseInvoice's created_by.
PurchaseOrderPurchaseInvoiceCurrency: A PurchaseOrderPurchaseInvoice's currency.
PurchaseOrderPurchaseInvoiceLastUpdatedBy: A PurchaseOrderPurchaseInvoice's last_updated_by.
PurchaseOrderPurchaseInvoiceList: A page of PurchaseOrderPurchaseInvoice records.
PurchaseOrderPurchaseInvoicePurchaseOrder: A PurchaseOrderPurchaseInvoice's purchase_order.
PurchaseOrderPurchaseInvoices: What createPurchaseOrderPurchaseInvoice answers, under purchase_invoice.
PurchaseOrderPurchaseInvoicesAccount: A PurchaseOrderPurchaseInvoices's account.
PurchaseOrderPurchaseInvoicesCreatedBy: A PurchaseOrderPurchaseInvoices's created_by.
PurchaseOrderPurchaseInvoicesCurrency: A PurchaseOrderPurchaseInvoices's currency.
PurchaseOrderPurchaseInvoicesKpis: A PurchaseOrderPurchaseInvoices's kpis.
PurchaseOrderPurchaseInvoicesLine: One entry of a PurchaseOrderPurchaseInvoices's lines.
PurchaseOrderPurchaseInvoicesLineItem: A PurchaseOrderPurchaseInvoicesLine's item.
PurchaseOrderPurchaseInvoicesPurchaseOrder: A PurchaseOrderPurchaseInvoices's purchase_order.
PurchaseOrderPurchasePayment: The purchase order purchase payment body.
PurchaseOrderPurchasePaymentAccount: A PurchaseOrderPurchasePayment's account.
PurchaseOrderPurchasePaymentCreatedBy: A PurchaseOrderPurchasePayment's created_by.
PurchaseOrderPurchasePaymentCreditNoteApplication: One entry of a PurchaseOrderPurchasePayment's credit_note_applications.
PurchaseOrderPurchasePaymentCreditNoteApplicationPurchaseCreditNote: A PurchaseOrderPurchasePaymentCreditNoteApplication's purchase_credit_note.
PurchaseOrderPurchasePaymentCurrency: A PurchaseOrderPurchasePayment's currency.
PurchaseOrderPurchasePaymentLastUpdatedBy: A PurchaseOrderPurchasePayment's last_updated_by.
PurchaseOrderPurchasePaymentList: A page of PurchaseOrderPurchasePayment records.
PurchaseOrderPurchasePaymentPaymentMethodApplication: One entry of a PurchaseOrderPurchasePayment's payment_method_applications.
PurchaseOrderPurchasePaymentPaymentMethodApplicationPaymentMethod: A PurchaseOrderPurchasePaymentPaymentMethodApplication's payment_method.
PurchaseOrderPurchasePaymentPaymentMethodApplicationPaymentProcessor: A PurchaseOrderPurchasePaymentPaymentMethodApplication's payment_processor.
PurchaseOrderPurchasePaymentPurchaseInvoiceApplication: One entry of a PurchaseOrderPurchasePayment's purchase_invoice_applications.
PurchaseOrderPurchasePaymentPurchaseInvoiceApplicationPurchaseInvoice: A PurchaseOrderPurchasePaymentPurchaseInvoiceApplication's purchase_invoice.
PurchaseOrderRead: The purchase order read body.
PurchaseOrderReadAccount: A PurchaseOrderRead's account.
PurchaseOrderReadCreatedBy: A PurchaseOrderRead's created_by.
PurchaseOrderReadCurrency: A PurchaseOrderRead's currency.
PurchaseOrderReadCustomAttribute: One entry of a PurchaseOrderRead's custom_attributes.
PurchaseOrderReadCustomForm: A PurchaseOrderRead's custom_form.
PurchaseOrderReadKpis: A PurchaseOrderRead's kpis.
PurchaseOrderReadLastUpdatedBy: A PurchaseOrderRead's last_updated_by.
PurchaseOrders: The purchase orders body.
PurchaseOrdersAccount: A PurchaseOrders's account.
PurchaseOrdersCreatedBy: A PurchaseOrders's created_by.
PurchaseOrdersCurrency: A PurchaseOrders's currency.
PurchaseOrdersCustomForm: A PurchaseOrders's custom_form.
PurchaseOrdersKpis: A PurchaseOrders's kpis.
PurchaseOrdersNote: The purchase orders note body.
PurchaseOrdersNoteCreatedBy: A PurchaseOrdersNote's created_by.
PurchaseOrdersNoteList: A page of PurchaseOrdersNote records.
PurchaseOrdersNoteWatcher: One entry of a PurchaseOrdersNote's watchers.
PurchaseOrdersResource: The purchase orders endpoints with client already applied.
PurchaseOrdersUrls
PurchaseOrderUpdated: The purchase order updated body.
PurchaseOrderUpdatedAccount: A PurchaseOrderUpdated's account.
PurchaseOrderUpdatedCreatedBy: A PurchaseOrderUpdated's created_by.
PurchaseOrderUpdatedCurrency: A PurchaseOrderUpdated's currency.
PurchaseOrderUpdatedCustomForm: A PurchaseOrderUpdated's custom_form.
PurchaseOrderUpdatedKpis: A PurchaseOrderUpdated's kpis.
PurchaseOrderUpdatedLastUpdatedBy: A PurchaseOrderUpdated's last_updated_by.

Functions

cancelPurchaseOrder(ExsitedClient client, Object purchaseOrderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderRead>>: POST /api/{api_version}/purchase_orders/{purchase_order_id}/cancel
changePurchaseOrder(ExsitedClient client, Object purchaseOrderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderRead>>: POST /api/{api_version}/purchase_orders/{purchase_order_id}/change
createPurchaseOrder(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrders>>: POST /api/{api_version}/purchase_orders
createPurchaseOrderNote(ExsitedClient client, Object purchaseOrderId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderNoteView>>: POST /api/{api_version}/purchase_orders/{purchase_order_id}/notes
createPurchaseOrderPurchaseInvoice(ExsitedClient client, Object purchaseOrderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderPurchaseInvoices>>: POST /api/{api_version}/purchase_orders/{purchase_order_id}/purchase_invoices
deletePurchaseOrder(ExsitedClient client, Object purchaseOrderId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/purchase_orders/{purchase_order_id}
deletePurchaseOrderNote(ExsitedClient client, Object purchaseOrderId, Object purchaseOrderNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/purchase_orders/{purchase_order_id}/notes/{purchase_order_note_id}
deletePurchaseOrderNoteFile(ExsitedClient client, Object purchaseOrderId, Object purchaseOrderNoteId, Object purchaseOrderFileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/purchase_orders/{purchase_order_id}/notes/{purchase_order_note_id}/files/{purchase_order_file_id}
getPurchaseOrder(ExsitedClient client, Object purchaseOrderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderRead>>: GET /api/{api_version}/purchase_orders/{purchase_order_id}
getPurchaseOrderInformation(ExsitedClient client, Object purchaseOrderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderInformation>>: GET /api/{api_version}/purchase_orders/{purchase_order_id}/information
getPurchaseOrderKpis(ExsitedClient client, Object purchaseOrderId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderKpis>>: GET /api/{api_version}/purchase_orders/{purchase_order_id}/kpis
getPurchaseOrderLine(ExsitedClient client, Object purchaseOrderId, Object purchaseOrderLineUuid, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderLineRead>>: GET /api/{api_version}/purchase_orders/{purchase_order_id}/lines/{purchase_order_line_uuid}
getPurchaseOrderLines(ExsitedClient client, Object purchaseOrderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderLineList>>: GET /api/{api_version}/purchase_orders/{purchase_order_id}/lines
getPurchaseOrderNote(ExsitedClient client, Object purchaseOrderId, Object purchaseOrderNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderNoteView>>: GET /api/{api_version}/purchase_orders/{purchase_order_id}/notes/{purchase_order_note_id}
getPurchaseOrderNoteFile(ExsitedClient client, Object purchaseOrderId, Object purchaseOrderNoteId, Object purchaseOrderFileId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderNoteFile>>: GET /api/{api_version}/purchase_orders/{purchase_order_id}/notes/{purchase_order_note_id}/files/{purchase_order_file_id}
getPurchaseOrderNoteFiles(ExsitedClient client, Object purchaseOrderId, Object purchaseOrderNoteId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderNoteFileList>>: GET /api/{api_version}/purchase_orders/{purchase_order_id}/notes/{purchase_order_note_id}/files
getPurchaseOrderNotes(ExsitedClient client, Object purchaseOrderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderNotes>>: GET /api/{api_version}/purchase_orders/{purchase_order_id}/notes
getPurchaseOrderPurchaseInvoices(ExsitedClient client, Object purchaseOrderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderPurchaseInvoiceList>>: GET /api/{api_version}/purchase_orders/{purchase_order_id}/purchase_invoices
getPurchaseOrderPurchasePayments(ExsitedClient client, Object purchaseOrderId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderPurchasePaymentList>>: GET /api/{api_version}/purchase_orders/{purchase_order_id}/purchase_payments
getPurchaseOrders(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderList>>: GET /api/{api_version}/purchase_orders
getPurchaseOrdersNotes(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrdersNoteList>>: GET /api/{api_version}/purchase_orders/notes
reactivatePurchaseOrder(ExsitedClient client, Object purchaseOrderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderRead>>: POST /api/{api_version}/purchase_orders/{purchase_order_id}/reactivate
updatePurchaseOrder(ExsitedClient client, Object purchaseOrderId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<PurchaseOrderUpdated>>: PATCH /api/{api_version}/purchase_orders/{purchase_order_id}

purchase_orders library

Classes

Functions

exsited package

purchase_orders library