Release 0.5.8

mercoa-finance · Sep 10, 2024 · 152b7b6 · 152b7b6
1 parent 01a139d
commit 152b7b6
Show file tree

Hide file tree

Showing 19 changed files with 238 additions and 217 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mercoa"
-version = "0.5.8-rc1"
+version = "0.5.8"
 description = ""
 readme = "README.md"
 authors = []

diff --git a/reference.md b/reference.md
@@ -1332,7 +1332,15 @@ If false, entities that are marked as payors will not be returned.
 <dl>
 <dd>
 
-**return_metadata:** `typing.Optional[bool]` — If true, will return simple key/value metadata for the entity. For more complex metadata, use the Metadata API.
+**metadata:** `typing.Optional[MetadataFilter]` — Filter entities by simple key/value metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**return_metadata:** `typing.Optional[bool]` — If true, will return simple key/value metadata for the entities. For more complex metadata, use the Metadata API.
 
 </dd>
 </dl>
@@ -3182,19 +3190,15 @@ client.invoice.find(
 <dl>
 <dd>
 
-**metadata:** `typing.Optional[
-    typing.Union[InvoiceMetadataFilter, typing.Sequence[InvoiceMetadataFilter]]
-]` — Filter invoices by metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
+**metadata:** `typing.Optional[typing.Union[MetadataFilter, typing.Sequence[MetadataFilter]]]` — Filter invoices by metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**line_item_metadata:** `typing.Optional[
-    typing.Union[InvoiceMetadataFilter, typing.Sequence[InvoiceMetadataFilter]]
-]` — Filter invoices by line item metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
+**line_item_metadata:** `typing.Optional[typing.Union[MetadataFilter, typing.Sequence[MetadataFilter]]]` — Filter invoices by line item metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
 
 </dd>
 </dl>
@@ -4852,9 +4856,7 @@ client.entity_group.invoice.find(
 <dl>
 <dd>
 
-**metadata:** `typing.Optional[
-    typing.Union[InvoiceMetadataFilter, typing.Sequence[InvoiceMetadataFilter]]
-]` — Filter invoices by metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
+**metadata:** `typing.Optional[typing.Union[MetadataFilter, typing.Sequence[MetadataFilter]]]` — Filter invoices by metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
 
 </dd>
 </dl>
@@ -4976,10 +4978,10 @@ client.entity_group.invoice.metrics(
     entity_group_id="entg_8545a84e-a45f-41bf-bdf1-33b42a55812c",
     return_by_date="CREATION_DATE",
     exclude_receivables=True,
-    created_date_start=datetime.datetime.fromisoformat(
+    start_date=datetime.datetime.fromisoformat(
         "2021-01-01 00:00:00+00:00",
     ),
-    created_date_end=datetime.datetime.fromisoformat(
+    end_date=datetime.datetime.fromisoformat(
         "2021-01-31 23:59:59.999000+00:00",
     ),
     currency="USD",
@@ -5040,95 +5042,81 @@ client.entity_group.invoice.metrics(
 <dl>
 <dd>
 
-**payer_id:** `typing.Optional[typing.Union[EntityId, typing.Sequence[EntityId]]]` — Filter invoices by payer ID.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**vendor_id:** `typing.Optional[typing.Union[EntityId, typing.Sequence[EntityId]]]` — Filter invoices by vendor ID.
+**return_by_date_frequency:** `typing.Optional[InvoiceMetricsPerDateFrequency]` — Return invoice metrics grouped by date. Defaults to daily.
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**approver_id:** `typing.Optional[typing.Union[EntityUserId, typing.Sequence[EntityUserId]]]` — Filter invoices by assigned approver user ID.
+**group_by:** `typing.Optional[
+    typing.Union[InvoiceMetricsGroupBy, typing.Sequence[InvoiceMetricsGroupBy]]
+]` — Return invoice metrics grouped by.
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**invoice_id:** `typing.Optional[typing.Union[InvoiceId, typing.Sequence[InvoiceId]]]` — Filter invoices by invoice ID.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**status:** `typing.Optional[typing.Union[InvoiceStatus, typing.Sequence[InvoiceStatus]]]` — Invoice status to filter on
+**payer_id:** `typing.Optional[typing.Union[EntityId, typing.Sequence[EntityId]]]` — Filter invoices by payer ID.
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**start_date:** `typing.Optional[dt.datetime]` — Start date filter. Defaults to CREATED_AT unless specified the dateType is specified
+**vendor_id:** `typing.Optional[typing.Union[EntityId, typing.Sequence[EntityId]]]` — Filter invoices by vendor ID.
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**end_date:** `typing.Optional[dt.datetime]` — End date filter. Defaults to CREATED_AT unless specified the dateType is specified
+**approver_id:** `typing.Optional[typing.Union[EntityUserId, typing.Sequence[EntityUserId]]]` — Filter invoices by assigned approver user ID.
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**date_type:** `typing.Optional[InvoiceDateFilter]` — Type of date to filter by if startDate and endDate filters are provided. Defaults to CREATED_AT.
+**invoice_id:** `typing.Optional[typing.Union[InvoiceId, typing.Sequence[InvoiceId]]]` — Filter invoices by invoice ID.
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**due_date_start:** `typing.Optional[dt.datetime]` — DEPRECATED. Use startDate, endDate, and dateType instead. Start date for invoice dueDate filter.
+**status:** `typing.Optional[typing.Union[InvoiceStatus, typing.Sequence[InvoiceStatus]]]` — Invoice status to filter on
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**due_date_end:** `typing.Optional[dt.datetime]` — DEPRECATED. Use startDate, endDate, and dateType instead. End date for invoice dueDate filter.
+**start_date:** `typing.Optional[dt.datetime]` — Start date filter. Defaults to CREATED_AT unless specified the dateType is specified
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**created_date_start:** `typing.Optional[dt.datetime]` — DEPRECATED. Use startDate, endDate, and dateType instead. Start date for invoice created on date filter.
+**end_date:** `typing.Optional[dt.datetime]` — End date filter. Defaults to CREATED_AT unless specified the dateType is specified
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**created_date_end:** `typing.Optional[dt.datetime]` — DEPRECATED. Use startDate, endDate, and dateType instead. End date for invoice created date filter.
+**date_type:** `typing.Optional[InvoiceDateFilter]` — Type of date to filter by if startDate and endDate filters are provided. Defaults to CREATED_AT.
 
 </dd>
 </dl>
@@ -5692,7 +5680,15 @@ client.entity.counterparty.find_payees(
 <dl>
 <dd>
 
-**return_metadata:** `typing.Optional[bool]` — If true, will return simple key/value metadata for the counterparties.
+**metadata:** `typing.Optional[MetadataFilter]` — Filter counterparties by simple key/value metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**return_metadata:** `typing.Optional[bool]` — If true, will return simple key/value metadata for the counterparties. For more complex metadata, use the Metadata API.
 
 </dd>
 </dl>
@@ -5833,7 +5829,15 @@ client.entity.counterparty.find_payors(
 <dl>
 <dd>
 
-**return_metadata:** `typing.Optional[bool]` — If true, will return simple key/value metadata for the counterparties.
+**metadata:** `typing.Optional[MetadataFilter]` — Filter counterparties by simple key/value metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**return_metadata:** `typing.Optional[bool]` — If true, will return simple key/value metadata for the counterparties. For more complex metadata, use the Metadata API.
 
 </dd>
 </dl>
@@ -7125,19 +7129,15 @@ client.entity.invoice.find(
 <dl>
 <dd>
 
-**metadata:** `typing.Optional[
-    typing.Union[InvoiceMetadataFilter, typing.Sequence[InvoiceMetadataFilter]]
-]` — Filter invoices by metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
+**metadata:** `typing.Optional[typing.Union[MetadataFilter, typing.Sequence[MetadataFilter]]]` — Filter invoices by metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**line_item_metadata:** `typing.Optional[
-    typing.Union[InvoiceMetadataFilter, typing.Sequence[InvoiceMetadataFilter]]
-]` — Filter invoices by line item metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
+**line_item_metadata:** `typing.Optional[typing.Union[MetadataFilter, typing.Sequence[MetadataFilter]]]` — Filter invoices by line item metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
 
 </dd>
 </dl>
@@ -7241,7 +7241,7 @@ client.entity.invoice.find(
 <dl>
 <dd>
 
-Get invoice metrics for an entity with the given filters. Invoices will be grouped by currency. If none of excludePayables, excludeReceivables, payerId, vendorId, or invoiceId status filters are provided, excludeReceivables will be set to true.
+Get invoice metrics for an entity with the given filters. Invoices will always be grouped by currency. If none of excludePayables, excludeReceivables, payerId, vendorId, or invoiceId status filters are provided, excludeReceivables will be set to true.
 </dd>
 </dl>
 </dd>
@@ -7267,10 +7267,10 @@ client.entity.invoice.metrics(
     entity_id="ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
     return_by_date="CREATION_DATE",
     exclude_receivables=True,
-    created_date_start=datetime.datetime.fromisoformat(
+    start_date=datetime.datetime.fromisoformat(
         "2021-01-01 00:00:00+00:00",
     ),
-    created_date_end=datetime.datetime.fromisoformat(
+    end_date=datetime.datetime.fromisoformat(
         "2021-01-31 23:59:59.999000+00:00",
     ),
     currency="USD",
@@ -7331,95 +7331,81 @@ client.entity.invoice.metrics(
 <dl>
 <dd>
 
-**payer_id:** `typing.Optional[typing.Union[EntityId, typing.Sequence[EntityId]]]` — Filter invoices by payer ID.
+**return_by_date_frequency:** `typing.Optional[InvoiceMetricsPerDateFrequency]` — Return invoice metrics grouped by date. Defaults to daily.
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**vendor_id:** `typing.Optional[typing.Union[EntityId, typing.Sequence[EntityId]]]` — Filter invoices by vendor ID.
+**group_by:** `typing.Optional[
+    typing.Union[InvoiceMetricsGroupBy, typing.Sequence[InvoiceMetricsGroupBy]]
+]` — Return invoice metrics grouped by.
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**approver_id:** `typing.Optional[typing.Union[EntityUserId, typing.Sequence[EntityUserId]]]` — Filter invoices by assigned approver user ID.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**invoice_id:** `typing.Optional[typing.Union[InvoiceId, typing.Sequence[InvoiceId]]]` — Filter invoices by invoice ID.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**status:** `typing.Optional[typing.Union[InvoiceStatus, typing.Sequence[InvoiceStatus]]]` — Invoice status to filter on
+**payer_id:** `typing.Optional[typing.Union[EntityId, typing.Sequence[EntityId]]]` — Filter invoices by payer ID.
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**start_date:** `typing.Optional[dt.datetime]` — Start date filter. Defaults to CREATED_AT unless specified the dateType is specified
+**vendor_id:** `typing.Optional[typing.Union[EntityId, typing.Sequence[EntityId]]]` — Filter invoices by vendor ID.
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**end_date:** `typing.Optional[dt.datetime]` — End date filter. Defaults to CREATED_AT unless specified the dateType is specified
+**approver_id:** `typing.Optional[typing.Union[EntityUserId, typing.Sequence[EntityUserId]]]` — Filter invoices by assigned approver user ID.
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**date_type:** `typing.Optional[InvoiceDateFilter]` — Type of date to filter by if startDate and endDate filters are provided. Defaults to CREATED_AT.
+**invoice_id:** `typing.Optional[typing.Union[InvoiceId, typing.Sequence[InvoiceId]]]` — Filter invoices by invoice ID.
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**due_date_start:** `typing.Optional[dt.datetime]` — DEPRECATED. Use startDate, endDate, and dateType instead. Start date for invoice dueDate filter.
+**status:** `typing.Optional[typing.Union[InvoiceStatus, typing.Sequence[InvoiceStatus]]]` — Invoice status to filter on
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**due_date_end:** `typing.Optional[dt.datetime]` — DEPRECATED. Use startDate, endDate, and dateType instead. End date for invoice dueDate filter.
+**start_date:** `typing.Optional[dt.datetime]` — Start date filter. Defaults to CREATED_AT unless specified the dateType is specified
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**created_date_start:** `typing.Optional[dt.datetime]` — DEPRECATED. Use startDate, endDate, and dateType instead. Start date for invoice created on date filter.
+**end_date:** `typing.Optional[dt.datetime]` — End date filter. Defaults to CREATED_AT unless specified the dateType is specified
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**created_date_end:** `typing.Optional[dt.datetime]` — DEPRECATED. Use startDate, endDate, and dateType instead. End date for invoice created date filter.
+**date_type:** `typing.Optional[InvoiceDateFilter]` — Type of date to filter by if startDate and endDate filters are provided. Defaults to CREATED_AT.
 
 </dd>
 </dl>