mergepythonclient 2.1.0__py3-none-any.whl → 2.2.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- merge/core/client_wrapper.py +2 -2
- merge/core/force_multipart.py +4 -2
- merge/core/http_response.py +1 -1
- merge/core/unchecked_base_model.py +41 -3
- merge/resources/accounting/__init__.py +64 -0
- merge/resources/accounting/client.py +5 -0
- merge/resources/accounting/resources/__init__.py +10 -0
- merge/resources/accounting/resources/accounting_periods/client.py +6 -2
- merge/resources/accounting/resources/accounts/client.py +6 -2
- merge/resources/accounting/resources/attachments/client.py +6 -2
- merge/resources/accounting/resources/audit_trail/client.py +6 -2
- merge/resources/accounting/resources/balance_sheets/client.py +6 -2
- merge/resources/accounting/resources/bank_feed_accounts/client.py +6 -2
- merge/resources/accounting/resources/bank_feed_transactions/client.py +6 -2
- merge/resources/accounting/resources/cash_flow_statements/client.py +6 -2
- merge/resources/accounting/resources/company_info/client.py +6 -2
- merge/resources/accounting/resources/contacts/client.py +195 -4
- merge/resources/accounting/resources/contacts/raw_client.py +203 -0
- merge/resources/accounting/resources/credit_notes/client.py +6 -2
- merge/resources/accounting/resources/employees/client.py +67 -2
- merge/resources/accounting/resources/employees/raw_client.py +62 -0
- merge/resources/accounting/resources/expense_reports/__init__.py +15 -0
- merge/resources/accounting/resources/expense_reports/client.py +1015 -0
- merge/resources/accounting/resources/expense_reports/raw_client.py +1020 -0
- merge/resources/accounting/resources/expense_reports/types/__init__.py +13 -0
- merge/resources/accounting/resources/expense_reports/types/expense_reports_lines_list_request_expand.py +265 -0
- merge/resources/accounting/resources/expense_reports/types/expense_reports_list_request_expand.py +73 -0
- merge/resources/accounting/resources/expense_reports/types/expense_reports_retrieve_request_expand.py +73 -0
- merge/resources/accounting/resources/expenses/client.py +18 -6
- merge/resources/accounting/resources/general_ledger_transactions/client.py +6 -2
- merge/resources/accounting/resources/income_statements/client.py +6 -2
- merge/resources/accounting/resources/invoices/client.py +18 -6
- merge/resources/accounting/resources/issues/client.py +6 -2
- merge/resources/accounting/resources/items/client.py +6 -2
- merge/resources/accounting/resources/journal_entries/client.py +18 -6
- merge/resources/accounting/resources/linked_accounts/client.py +6 -2
- merge/resources/accounting/resources/payment_methods/client.py +6 -2
- merge/resources/accounting/resources/payment_terms/client.py +6 -2
- merge/resources/accounting/resources/payments/client.py +18 -6
- merge/resources/accounting/resources/projects/client.py +67 -2
- merge/resources/accounting/resources/projects/raw_client.py +62 -0
- merge/resources/accounting/resources/purchase_orders/client.py +18 -6
- merge/resources/accounting/resources/sync_status/client.py +6 -2
- merge/resources/accounting/resources/tax_rates/client.py +6 -2
- merge/resources/accounting/resources/tracking_categories/client.py +6 -2
- merge/resources/accounting/resources/transactions/client.py +6 -2
- merge/resources/accounting/resources/transactions/types/transactions_list_request_expand.py +141 -0
- merge/resources/accounting/resources/transactions/types/transactions_retrieve_request_expand.py +141 -0
- merge/resources/accounting/resources/vendor_credits/client.py +6 -2
- merge/resources/accounting/types/__init__.py +56 -0
- merge/resources/accounting/types/expense_report.py +423 -0
- merge/resources/accounting/types/expense_report_company.py +7 -0
- merge/resources/accounting/types/expense_report_line.py +441 -0
- merge/resources/accounting/types/expense_report_line_account.py +7 -0
- merge/resources/accounting/types/expense_report_line_company.py +7 -0
- merge/resources/accounting/types/expense_report_line_contact.py +7 -0
- merge/resources/accounting/types/expense_report_line_employee.py +7 -0
- merge/resources/accounting/types/expense_report_line_project.py +7 -0
- merge/resources/accounting/types/expense_report_line_request.py +427 -0
- merge/resources/accounting/types/expense_report_line_request_account.py +7 -0
- merge/resources/accounting/types/expense_report_line_request_company.py +7 -0
- merge/resources/accounting/types/expense_report_line_request_contact.py +7 -0
- merge/resources/accounting/types/expense_report_line_request_employee.py +7 -0
- merge/resources/accounting/types/expense_report_line_request_project.py +7 -0
- merge/resources/accounting/types/expense_report_line_request_tax_rate.py +7 -0
- merge/resources/accounting/types/expense_report_line_tax_rate.py +7 -0
- merge/resources/accounting/types/expense_report_request.py +401 -0
- merge/resources/accounting/types/expense_report_request_accounting_period.py +7 -0
- merge/resources/accounting/types/expense_report_request_company.py +7 -0
- merge/resources/accounting/types/expense_report_request_employee.py +7 -0
- merge/resources/accounting/types/expense_report_response.py +27 -0
- merge/resources/accounting/types/expense_report_status.py +7 -0
- merge/resources/accounting/types/expense_report_status_enum.py +36 -0
- merge/resources/accounting/types/external_target_field_api_response.py +3 -0
- merge/resources/accounting/types/field_mapping_api_instance_response.py +3 -0
- merge/resources/accounting/types/item.py +11 -0
- merge/resources/accounting/types/item_type.py +7 -0
- merge/resources/accounting/types/paginated_expense_report_line_list.py +23 -0
- merge/resources/accounting/types/paginated_expense_report_list.py +23 -0
- merge/resources/accounting/types/patched_contact_request.py +91 -0
- merge/resources/accounting/types/patched_contact_request_addresses_item.py +7 -0
- merge/resources/accounting/types/remote_field_class.py +1 -0
- merge/resources/ats/resources/activities/client.py +6 -2
- merge/resources/ats/resources/applications/client.py +6 -2
- merge/resources/ats/resources/attachments/client.py +6 -2
- merge/resources/ats/resources/audit_trail/client.py +6 -2
- merge/resources/ats/resources/candidates/client.py +6 -2
- merge/resources/ats/resources/departments/client.py +6 -2
- merge/resources/ats/resources/eeocs/client.py +6 -2
- merge/resources/ats/resources/interviews/client.py +6 -2
- merge/resources/ats/resources/issues/client.py +6 -2
- merge/resources/ats/resources/job_interview_stages/client.py +6 -2
- merge/resources/ats/resources/job_postings/client.py +6 -2
- merge/resources/ats/resources/jobs/client.py +8 -2
- merge/resources/ats/resources/linked_accounts/client.py +6 -2
- merge/resources/ats/resources/offers/client.py +6 -2
- merge/resources/ats/resources/offices/client.py +6 -2
- merge/resources/ats/resources/reject_reasons/client.py +6 -2
- merge/resources/ats/resources/scorecards/client.py +6 -2
- merge/resources/ats/resources/sync_status/client.py +6 -2
- merge/resources/ats/resources/tags/client.py +6 -2
- merge/resources/ats/resources/users/client.py +6 -2
- merge/resources/ats/types/event_type_enum.py +4 -0
- merge/resources/crm/resources/accounts/client.py +12 -4
- merge/resources/crm/resources/association_types/client.py +2 -0
- merge/resources/crm/resources/associations/client.py +2 -0
- merge/resources/crm/resources/audit_trail/client.py +6 -2
- merge/resources/crm/resources/contacts/client.py +12 -4
- merge/resources/crm/resources/custom_object_classes/client.py +6 -2
- merge/resources/crm/resources/custom_objects/client.py +8 -2
- merge/resources/crm/resources/engagement_types/client.py +12 -4
- merge/resources/crm/resources/engagements/client.py +12 -4
- merge/resources/crm/resources/issues/client.py +6 -2
- merge/resources/crm/resources/leads/client.py +12 -4
- merge/resources/crm/resources/linked_accounts/client.py +6 -2
- merge/resources/crm/resources/notes/client.py +12 -4
- merge/resources/crm/resources/opportunities/client.py +12 -4
- merge/resources/crm/resources/stages/client.py +12 -4
- merge/resources/crm/resources/sync_status/client.py +6 -2
- merge/resources/crm/resources/tasks/client.py +12 -4
- merge/resources/crm/resources/users/client.py +12 -4
- merge/resources/crm/types/remote_field_class.py +1 -0
- merge/resources/filestorage/resources/audit_trail/client.py +6 -2
- merge/resources/filestorage/resources/drives/client.py +6 -2
- merge/resources/filestorage/resources/files/client.py +42 -4
- merge/resources/filestorage/resources/files/raw_client.py +38 -0
- merge/resources/filestorage/resources/folders/client.py +6 -2
- merge/resources/filestorage/resources/groups/client.py +6 -2
- merge/resources/filestorage/resources/issues/client.py +6 -2
- merge/resources/filestorage/resources/linked_accounts/client.py +6 -2
- merge/resources/filestorage/resources/sync_status/client.py +6 -2
- merge/resources/filestorage/resources/users/client.py +6 -2
- merge/resources/hris/resources/audit_trail/client.py +6 -2
- merge/resources/hris/resources/bank_info/client.py +6 -2
- merge/resources/hris/resources/benefits/client.py +6 -2
- merge/resources/hris/resources/companies/client.py +6 -2
- merge/resources/hris/resources/dependents/client.py +6 -2
- merge/resources/hris/resources/employee_payroll_runs/client.py +6 -2
- merge/resources/hris/resources/employees/client.py +6 -2
- merge/resources/hris/resources/employer_benefits/client.py +6 -2
- merge/resources/hris/resources/employments/client.py +6 -2
- merge/resources/hris/resources/groups/client.py +6 -2
- merge/resources/hris/resources/issues/client.py +6 -2
- merge/resources/hris/resources/linked_accounts/client.py +6 -2
- merge/resources/hris/resources/locations/client.py +6 -2
- merge/resources/hris/resources/pay_groups/client.py +6 -2
- merge/resources/hris/resources/payroll_runs/client.py +6 -2
- merge/resources/hris/resources/sync_status/client.py +6 -2
- merge/resources/hris/resources/teams/client.py +6 -2
- merge/resources/hris/resources/time_off/client.py +6 -2
- merge/resources/hris/resources/time_off_balances/client.py +6 -2
- merge/resources/hris/resources/timesheet_entries/client.py +6 -2
- merge/resources/hris/types/benefit.py +4 -4
- merge/resources/ticketing/resources/accounts/client.py +6 -2
- merge/resources/ticketing/resources/attachments/client.py +6 -2
- merge/resources/ticketing/resources/audit_trail/client.py +6 -2
- merge/resources/ticketing/resources/collections/client.py +8 -2
- merge/resources/ticketing/resources/comments/client.py +6 -2
- merge/resources/ticketing/resources/contacts/client.py +6 -2
- merge/resources/ticketing/resources/issues/client.py +6 -2
- merge/resources/ticketing/resources/linked_accounts/client.py +6 -2
- merge/resources/ticketing/resources/projects/client.py +8 -2
- merge/resources/ticketing/resources/roles/client.py +6 -2
- merge/resources/ticketing/resources/sync_status/client.py +6 -2
- merge/resources/ticketing/resources/tags/client.py +6 -2
- merge/resources/ticketing/resources/teams/client.py +6 -2
- merge/resources/ticketing/resources/tickets/client.py +24 -4
- merge/resources/ticketing/resources/tickets/raw_client.py +10 -0
- merge/resources/ticketing/resources/users/client.py +6 -2
- merge/resources/ticketing/types/patched_ticket_request.py +5 -5
- merge/resources/ticketing/types/remote_field_class.py +1 -0
- {mergepythonclient-2.1.0.dist-info → mergepythonclient-2.2.0.dist-info}/METADATA +5 -2
- {mergepythonclient-2.1.0.dist-info → mergepythonclient-2.2.0.dist-info}/RECORD +175 -140
- {mergepythonclient-2.1.0.dist-info → mergepythonclient-2.2.0.dist-info}/LICENSE.md +0 -0
- {mergepythonclient-2.1.0.dist-info → mergepythonclient-2.2.0.dist-info}/WHEEL +0 -0
|
@@ -0,0 +1,1015 @@
|
|
|
1
|
+
# This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
|
|
3
|
+
import datetime as dt
|
|
4
|
+
import typing
|
|
5
|
+
|
|
6
|
+
from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
|
|
7
|
+
from .....core.request_options import RequestOptions
|
|
8
|
+
from ...types.expense_report import ExpenseReport
|
|
9
|
+
from ...types.expense_report_request import ExpenseReportRequest
|
|
10
|
+
from ...types.expense_report_response import ExpenseReportResponse
|
|
11
|
+
from ...types.meta_response import MetaResponse
|
|
12
|
+
from ...types.paginated_expense_report_line_list import PaginatedExpenseReportLineList
|
|
13
|
+
from ...types.paginated_expense_report_list import PaginatedExpenseReportList
|
|
14
|
+
from ...types.paginated_remote_field_class_list import PaginatedRemoteFieldClassList
|
|
15
|
+
from .raw_client import AsyncRawExpenseReportsClient, RawExpenseReportsClient
|
|
16
|
+
from .types.expense_reports_lines_list_request_expand import ExpenseReportsLinesListRequestExpand
|
|
17
|
+
from .types.expense_reports_list_request_expand import ExpenseReportsListRequestExpand
|
|
18
|
+
from .types.expense_reports_retrieve_request_expand import ExpenseReportsRetrieveRequestExpand
|
|
19
|
+
|
|
20
|
+
# this is used as the default value for optional parameters
|
|
21
|
+
OMIT = typing.cast(typing.Any, ...)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
class ExpenseReportsClient:
|
|
25
|
+
def __init__(self, *, client_wrapper: SyncClientWrapper):
|
|
26
|
+
self._raw_client = RawExpenseReportsClient(client_wrapper=client_wrapper)
|
|
27
|
+
|
|
28
|
+
@property
|
|
29
|
+
def with_raw_response(self) -> RawExpenseReportsClient:
|
|
30
|
+
"""
|
|
31
|
+
Retrieves a raw implementation of this client that returns raw responses.
|
|
32
|
+
|
|
33
|
+
Returns
|
|
34
|
+
-------
|
|
35
|
+
RawExpenseReportsClient
|
|
36
|
+
"""
|
|
37
|
+
return self._raw_client
|
|
38
|
+
|
|
39
|
+
def list(
|
|
40
|
+
self,
|
|
41
|
+
*,
|
|
42
|
+
company_id: typing.Optional[str] = None,
|
|
43
|
+
created_after: typing.Optional[dt.datetime] = None,
|
|
44
|
+
created_before: typing.Optional[dt.datetime] = None,
|
|
45
|
+
cursor: typing.Optional[str] = None,
|
|
46
|
+
expand: typing.Optional[ExpenseReportsListRequestExpand] = None,
|
|
47
|
+
include_deleted_data: typing.Optional[bool] = None,
|
|
48
|
+
include_remote_data: typing.Optional[bool] = None,
|
|
49
|
+
include_remote_fields: typing.Optional[bool] = None,
|
|
50
|
+
include_shell_data: typing.Optional[bool] = None,
|
|
51
|
+
modified_after: typing.Optional[dt.datetime] = None,
|
|
52
|
+
modified_before: typing.Optional[dt.datetime] = None,
|
|
53
|
+
page_size: typing.Optional[int] = None,
|
|
54
|
+
remote_id: typing.Optional[str] = None,
|
|
55
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
56
|
+
) -> PaginatedExpenseReportList:
|
|
57
|
+
"""
|
|
58
|
+
Returns a list of `ExpenseReport` objects.
|
|
59
|
+
|
|
60
|
+
Parameters
|
|
61
|
+
----------
|
|
62
|
+
company_id : typing.Optional[str]
|
|
63
|
+
If provided, will only return expense reports for this company.
|
|
64
|
+
|
|
65
|
+
created_after : typing.Optional[dt.datetime]
|
|
66
|
+
If provided, will only return objects created after this datetime.
|
|
67
|
+
|
|
68
|
+
created_before : typing.Optional[dt.datetime]
|
|
69
|
+
If provided, will only return objects created before this datetime.
|
|
70
|
+
|
|
71
|
+
cursor : typing.Optional[str]
|
|
72
|
+
The pagination cursor value.
|
|
73
|
+
|
|
74
|
+
expand : typing.Optional[ExpenseReportsListRequestExpand]
|
|
75
|
+
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
76
|
+
|
|
77
|
+
include_deleted_data : typing.Optional[bool]
|
|
78
|
+
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
|
|
79
|
+
|
|
80
|
+
include_remote_data : typing.Optional[bool]
|
|
81
|
+
Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
82
|
+
|
|
83
|
+
include_remote_fields : typing.Optional[bool]
|
|
84
|
+
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
|
|
85
|
+
|
|
86
|
+
include_shell_data : typing.Optional[bool]
|
|
87
|
+
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
|
|
88
|
+
|
|
89
|
+
modified_after : typing.Optional[dt.datetime]
|
|
90
|
+
If provided, only objects synced by Merge after this date time will be returned.
|
|
91
|
+
|
|
92
|
+
modified_before : typing.Optional[dt.datetime]
|
|
93
|
+
If provided, only objects synced by Merge before this date time will be returned.
|
|
94
|
+
|
|
95
|
+
page_size : typing.Optional[int]
|
|
96
|
+
Number of results to return per page.
|
|
97
|
+
|
|
98
|
+
remote_id : typing.Optional[str]
|
|
99
|
+
The API provider's ID for the given object.
|
|
100
|
+
|
|
101
|
+
request_options : typing.Optional[RequestOptions]
|
|
102
|
+
Request-specific configuration.
|
|
103
|
+
|
|
104
|
+
Returns
|
|
105
|
+
-------
|
|
106
|
+
PaginatedExpenseReportList
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
Examples
|
|
110
|
+
--------
|
|
111
|
+
from merge import Merge
|
|
112
|
+
|
|
113
|
+
client = Merge(
|
|
114
|
+
account_token="YOUR_ACCOUNT_TOKEN",
|
|
115
|
+
api_key="YOUR_API_KEY",
|
|
116
|
+
)
|
|
117
|
+
client.accounting.expense_reports.list(
|
|
118
|
+
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
|
|
119
|
+
)
|
|
120
|
+
"""
|
|
121
|
+
_response = self._raw_client.list(
|
|
122
|
+
company_id=company_id,
|
|
123
|
+
created_after=created_after,
|
|
124
|
+
created_before=created_before,
|
|
125
|
+
cursor=cursor,
|
|
126
|
+
expand=expand,
|
|
127
|
+
include_deleted_data=include_deleted_data,
|
|
128
|
+
include_remote_data=include_remote_data,
|
|
129
|
+
include_remote_fields=include_remote_fields,
|
|
130
|
+
include_shell_data=include_shell_data,
|
|
131
|
+
modified_after=modified_after,
|
|
132
|
+
modified_before=modified_before,
|
|
133
|
+
page_size=page_size,
|
|
134
|
+
remote_id=remote_id,
|
|
135
|
+
request_options=request_options,
|
|
136
|
+
)
|
|
137
|
+
return _response.data
|
|
138
|
+
|
|
139
|
+
def create(
|
|
140
|
+
self,
|
|
141
|
+
*,
|
|
142
|
+
model: ExpenseReportRequest,
|
|
143
|
+
is_debug_mode: typing.Optional[bool] = None,
|
|
144
|
+
run_async: typing.Optional[bool] = None,
|
|
145
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
146
|
+
) -> ExpenseReportResponse:
|
|
147
|
+
"""
|
|
148
|
+
Creates an `ExpenseReport` object with the given values.
|
|
149
|
+
|
|
150
|
+
Parameters
|
|
151
|
+
----------
|
|
152
|
+
model : ExpenseReportRequest
|
|
153
|
+
|
|
154
|
+
is_debug_mode : typing.Optional[bool]
|
|
155
|
+
Whether to include debug fields (such as log file links) in the response.
|
|
156
|
+
|
|
157
|
+
run_async : typing.Optional[bool]
|
|
158
|
+
Whether or not third-party updates should be run asynchronously.
|
|
159
|
+
|
|
160
|
+
request_options : typing.Optional[RequestOptions]
|
|
161
|
+
Request-specific configuration.
|
|
162
|
+
|
|
163
|
+
Returns
|
|
164
|
+
-------
|
|
165
|
+
ExpenseReportResponse
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
Examples
|
|
169
|
+
--------
|
|
170
|
+
from merge import Merge
|
|
171
|
+
from merge.resources.accounting import ExpenseReportRequest
|
|
172
|
+
|
|
173
|
+
client = Merge(
|
|
174
|
+
account_token="YOUR_ACCOUNT_TOKEN",
|
|
175
|
+
api_key="YOUR_API_KEY",
|
|
176
|
+
)
|
|
177
|
+
client.accounting.expense_reports.create(
|
|
178
|
+
model=ExpenseReportRequest(
|
|
179
|
+
tracking_categories=[
|
|
180
|
+
"a1b2c3d4-e5f6-4a5b-9c3d-2e1f0a9b8c7d",
|
|
181
|
+
"d4c3b2a1-9e8f-7g6h-5i4j-3k2l1m0n9o8p",
|
|
182
|
+
],
|
|
183
|
+
),
|
|
184
|
+
)
|
|
185
|
+
"""
|
|
186
|
+
_response = self._raw_client.create(
|
|
187
|
+
model=model, is_debug_mode=is_debug_mode, run_async=run_async, request_options=request_options
|
|
188
|
+
)
|
|
189
|
+
return _response.data
|
|
190
|
+
|
|
191
|
+
def lines_list(
|
|
192
|
+
self,
|
|
193
|
+
expense_report_id: str,
|
|
194
|
+
*,
|
|
195
|
+
cursor: typing.Optional[str] = None,
|
|
196
|
+
expand: typing.Optional[ExpenseReportsLinesListRequestExpand] = None,
|
|
197
|
+
include_deleted_data: typing.Optional[bool] = None,
|
|
198
|
+
include_remote_data: typing.Optional[bool] = None,
|
|
199
|
+
include_remote_fields: typing.Optional[bool] = None,
|
|
200
|
+
include_shell_data: typing.Optional[bool] = None,
|
|
201
|
+
page_size: typing.Optional[int] = None,
|
|
202
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
203
|
+
) -> PaginatedExpenseReportLineList:
|
|
204
|
+
"""
|
|
205
|
+
Returns a list of `ExpenseReportLine` objects that point to a `ExpenseReport` with the given id.
|
|
206
|
+
|
|
207
|
+
Parameters
|
|
208
|
+
----------
|
|
209
|
+
expense_report_id : str
|
|
210
|
+
|
|
211
|
+
cursor : typing.Optional[str]
|
|
212
|
+
The pagination cursor value.
|
|
213
|
+
|
|
214
|
+
expand : typing.Optional[ExpenseReportsLinesListRequestExpand]
|
|
215
|
+
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
216
|
+
|
|
217
|
+
include_deleted_data : typing.Optional[bool]
|
|
218
|
+
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
|
|
219
|
+
|
|
220
|
+
include_remote_data : typing.Optional[bool]
|
|
221
|
+
Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
222
|
+
|
|
223
|
+
include_remote_fields : typing.Optional[bool]
|
|
224
|
+
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
|
|
225
|
+
|
|
226
|
+
include_shell_data : typing.Optional[bool]
|
|
227
|
+
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
|
|
228
|
+
|
|
229
|
+
page_size : typing.Optional[int]
|
|
230
|
+
Number of results to return per page.
|
|
231
|
+
|
|
232
|
+
request_options : typing.Optional[RequestOptions]
|
|
233
|
+
Request-specific configuration.
|
|
234
|
+
|
|
235
|
+
Returns
|
|
236
|
+
-------
|
|
237
|
+
PaginatedExpenseReportLineList
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
Examples
|
|
241
|
+
--------
|
|
242
|
+
from merge import Merge
|
|
243
|
+
|
|
244
|
+
client = Merge(
|
|
245
|
+
account_token="YOUR_ACCOUNT_TOKEN",
|
|
246
|
+
api_key="YOUR_API_KEY",
|
|
247
|
+
)
|
|
248
|
+
client.accounting.expense_reports.lines_list(
|
|
249
|
+
expense_report_id="expense_report_id",
|
|
250
|
+
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
|
|
251
|
+
)
|
|
252
|
+
"""
|
|
253
|
+
_response = self._raw_client.lines_list(
|
|
254
|
+
expense_report_id,
|
|
255
|
+
cursor=cursor,
|
|
256
|
+
expand=expand,
|
|
257
|
+
include_deleted_data=include_deleted_data,
|
|
258
|
+
include_remote_data=include_remote_data,
|
|
259
|
+
include_remote_fields=include_remote_fields,
|
|
260
|
+
include_shell_data=include_shell_data,
|
|
261
|
+
page_size=page_size,
|
|
262
|
+
request_options=request_options,
|
|
263
|
+
)
|
|
264
|
+
return _response.data
|
|
265
|
+
|
|
266
|
+
def retrieve(
|
|
267
|
+
self,
|
|
268
|
+
id: str,
|
|
269
|
+
*,
|
|
270
|
+
expand: typing.Optional[ExpenseReportsRetrieveRequestExpand] = None,
|
|
271
|
+
include_remote_data: typing.Optional[bool] = None,
|
|
272
|
+
include_remote_fields: typing.Optional[bool] = None,
|
|
273
|
+
include_shell_data: typing.Optional[bool] = None,
|
|
274
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
275
|
+
) -> ExpenseReport:
|
|
276
|
+
"""
|
|
277
|
+
Returns an `ExpenseReport` object with the given `id`.
|
|
278
|
+
|
|
279
|
+
Parameters
|
|
280
|
+
----------
|
|
281
|
+
id : str
|
|
282
|
+
|
|
283
|
+
expand : typing.Optional[ExpenseReportsRetrieveRequestExpand]
|
|
284
|
+
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
285
|
+
|
|
286
|
+
include_remote_data : typing.Optional[bool]
|
|
287
|
+
Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
288
|
+
|
|
289
|
+
include_remote_fields : typing.Optional[bool]
|
|
290
|
+
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
|
|
291
|
+
|
|
292
|
+
include_shell_data : typing.Optional[bool]
|
|
293
|
+
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
|
|
294
|
+
|
|
295
|
+
request_options : typing.Optional[RequestOptions]
|
|
296
|
+
Request-specific configuration.
|
|
297
|
+
|
|
298
|
+
Returns
|
|
299
|
+
-------
|
|
300
|
+
ExpenseReport
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
Examples
|
|
304
|
+
--------
|
|
305
|
+
from merge import Merge
|
|
306
|
+
|
|
307
|
+
client = Merge(
|
|
308
|
+
account_token="YOUR_ACCOUNT_TOKEN",
|
|
309
|
+
api_key="YOUR_API_KEY",
|
|
310
|
+
)
|
|
311
|
+
client.accounting.expense_reports.retrieve(
|
|
312
|
+
id="id",
|
|
313
|
+
)
|
|
314
|
+
"""
|
|
315
|
+
_response = self._raw_client.retrieve(
|
|
316
|
+
id,
|
|
317
|
+
expand=expand,
|
|
318
|
+
include_remote_data=include_remote_data,
|
|
319
|
+
include_remote_fields=include_remote_fields,
|
|
320
|
+
include_shell_data=include_shell_data,
|
|
321
|
+
request_options=request_options,
|
|
322
|
+
)
|
|
323
|
+
return _response.data
|
|
324
|
+
|
|
325
|
+
def lines_remote_field_classes_list(
|
|
326
|
+
self,
|
|
327
|
+
*,
|
|
328
|
+
cursor: typing.Optional[str] = None,
|
|
329
|
+
include_deleted_data: typing.Optional[bool] = None,
|
|
330
|
+
include_remote_data: typing.Optional[bool] = None,
|
|
331
|
+
include_shell_data: typing.Optional[bool] = None,
|
|
332
|
+
is_common_model_field: typing.Optional[bool] = None,
|
|
333
|
+
is_custom: typing.Optional[bool] = None,
|
|
334
|
+
page_size: typing.Optional[int] = None,
|
|
335
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
336
|
+
) -> PaginatedRemoteFieldClassList:
|
|
337
|
+
"""
|
|
338
|
+
Returns a list of `RemoteFieldClass` objects.
|
|
339
|
+
|
|
340
|
+
Parameters
|
|
341
|
+
----------
|
|
342
|
+
cursor : typing.Optional[str]
|
|
343
|
+
The pagination cursor value.
|
|
344
|
+
|
|
345
|
+
include_deleted_data : typing.Optional[bool]
|
|
346
|
+
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
|
|
347
|
+
|
|
348
|
+
include_remote_data : typing.Optional[bool]
|
|
349
|
+
Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
350
|
+
|
|
351
|
+
include_shell_data : typing.Optional[bool]
|
|
352
|
+
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
|
|
353
|
+
|
|
354
|
+
is_common_model_field : typing.Optional[bool]
|
|
355
|
+
If provided, will only return remote field classes with this is_common_model_field value
|
|
356
|
+
|
|
357
|
+
is_custom : typing.Optional[bool]
|
|
358
|
+
If provided, will only return remote fields classes with this is_custom value
|
|
359
|
+
|
|
360
|
+
page_size : typing.Optional[int]
|
|
361
|
+
Number of results to return per page.
|
|
362
|
+
|
|
363
|
+
request_options : typing.Optional[RequestOptions]
|
|
364
|
+
Request-specific configuration.
|
|
365
|
+
|
|
366
|
+
Returns
|
|
367
|
+
-------
|
|
368
|
+
PaginatedRemoteFieldClassList
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
Examples
|
|
372
|
+
--------
|
|
373
|
+
from merge import Merge
|
|
374
|
+
|
|
375
|
+
client = Merge(
|
|
376
|
+
account_token="YOUR_ACCOUNT_TOKEN",
|
|
377
|
+
api_key="YOUR_API_KEY",
|
|
378
|
+
)
|
|
379
|
+
client.accounting.expense_reports.lines_remote_field_classes_list(
|
|
380
|
+
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
|
|
381
|
+
)
|
|
382
|
+
"""
|
|
383
|
+
_response = self._raw_client.lines_remote_field_classes_list(
|
|
384
|
+
cursor=cursor,
|
|
385
|
+
include_deleted_data=include_deleted_data,
|
|
386
|
+
include_remote_data=include_remote_data,
|
|
387
|
+
include_shell_data=include_shell_data,
|
|
388
|
+
is_common_model_field=is_common_model_field,
|
|
389
|
+
is_custom=is_custom,
|
|
390
|
+
page_size=page_size,
|
|
391
|
+
request_options=request_options,
|
|
392
|
+
)
|
|
393
|
+
return _response.data
|
|
394
|
+
|
|
395
|
+
def meta_post_retrieve(self, *, request_options: typing.Optional[RequestOptions] = None) -> MetaResponse:
|
|
396
|
+
"""
|
|
397
|
+
Returns metadata for `ExpenseReport` POSTs.
|
|
398
|
+
|
|
399
|
+
Parameters
|
|
400
|
+
----------
|
|
401
|
+
request_options : typing.Optional[RequestOptions]
|
|
402
|
+
Request-specific configuration.
|
|
403
|
+
|
|
404
|
+
Returns
|
|
405
|
+
-------
|
|
406
|
+
MetaResponse
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
Examples
|
|
410
|
+
--------
|
|
411
|
+
from merge import Merge
|
|
412
|
+
|
|
413
|
+
client = Merge(
|
|
414
|
+
account_token="YOUR_ACCOUNT_TOKEN",
|
|
415
|
+
api_key="YOUR_API_KEY",
|
|
416
|
+
)
|
|
417
|
+
client.accounting.expense_reports.meta_post_retrieve()
|
|
418
|
+
"""
|
|
419
|
+
_response = self._raw_client.meta_post_retrieve(request_options=request_options)
|
|
420
|
+
return _response.data
|
|
421
|
+
|
|
422
|
+
def remote_field_classes_list(
|
|
423
|
+
self,
|
|
424
|
+
*,
|
|
425
|
+
cursor: typing.Optional[str] = None,
|
|
426
|
+
include_deleted_data: typing.Optional[bool] = None,
|
|
427
|
+
include_remote_data: typing.Optional[bool] = None,
|
|
428
|
+
include_shell_data: typing.Optional[bool] = None,
|
|
429
|
+
is_common_model_field: typing.Optional[bool] = None,
|
|
430
|
+
is_custom: typing.Optional[bool] = None,
|
|
431
|
+
page_size: typing.Optional[int] = None,
|
|
432
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
433
|
+
) -> PaginatedRemoteFieldClassList:
|
|
434
|
+
"""
|
|
435
|
+
Returns a list of `RemoteFieldClass` objects.
|
|
436
|
+
|
|
437
|
+
Parameters
|
|
438
|
+
----------
|
|
439
|
+
cursor : typing.Optional[str]
|
|
440
|
+
The pagination cursor value.
|
|
441
|
+
|
|
442
|
+
include_deleted_data : typing.Optional[bool]
|
|
443
|
+
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
|
|
444
|
+
|
|
445
|
+
include_remote_data : typing.Optional[bool]
|
|
446
|
+
Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
447
|
+
|
|
448
|
+
include_shell_data : typing.Optional[bool]
|
|
449
|
+
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
|
|
450
|
+
|
|
451
|
+
is_common_model_field : typing.Optional[bool]
|
|
452
|
+
If provided, will only return remote field classes with this is_common_model_field value
|
|
453
|
+
|
|
454
|
+
is_custom : typing.Optional[bool]
|
|
455
|
+
If provided, will only return remote fields classes with this is_custom value
|
|
456
|
+
|
|
457
|
+
page_size : typing.Optional[int]
|
|
458
|
+
Number of results to return per page.
|
|
459
|
+
|
|
460
|
+
request_options : typing.Optional[RequestOptions]
|
|
461
|
+
Request-specific configuration.
|
|
462
|
+
|
|
463
|
+
Returns
|
|
464
|
+
-------
|
|
465
|
+
PaginatedRemoteFieldClassList
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
Examples
|
|
469
|
+
--------
|
|
470
|
+
from merge import Merge
|
|
471
|
+
|
|
472
|
+
client = Merge(
|
|
473
|
+
account_token="YOUR_ACCOUNT_TOKEN",
|
|
474
|
+
api_key="YOUR_API_KEY",
|
|
475
|
+
)
|
|
476
|
+
client.accounting.expense_reports.remote_field_classes_list(
|
|
477
|
+
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
|
|
478
|
+
)
|
|
479
|
+
"""
|
|
480
|
+
_response = self._raw_client.remote_field_classes_list(
|
|
481
|
+
cursor=cursor,
|
|
482
|
+
include_deleted_data=include_deleted_data,
|
|
483
|
+
include_remote_data=include_remote_data,
|
|
484
|
+
include_shell_data=include_shell_data,
|
|
485
|
+
is_common_model_field=is_common_model_field,
|
|
486
|
+
is_custom=is_custom,
|
|
487
|
+
page_size=page_size,
|
|
488
|
+
request_options=request_options,
|
|
489
|
+
)
|
|
490
|
+
return _response.data
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
class AsyncExpenseReportsClient:
|
|
494
|
+
def __init__(self, *, client_wrapper: AsyncClientWrapper):
|
|
495
|
+
self._raw_client = AsyncRawExpenseReportsClient(client_wrapper=client_wrapper)
|
|
496
|
+
|
|
497
|
+
@property
|
|
498
|
+
def with_raw_response(self) -> AsyncRawExpenseReportsClient:
|
|
499
|
+
"""
|
|
500
|
+
Retrieves a raw implementation of this client that returns raw responses.
|
|
501
|
+
|
|
502
|
+
Returns
|
|
503
|
+
-------
|
|
504
|
+
AsyncRawExpenseReportsClient
|
|
505
|
+
"""
|
|
506
|
+
return self._raw_client
|
|
507
|
+
|
|
508
|
+
async def list(
|
|
509
|
+
self,
|
|
510
|
+
*,
|
|
511
|
+
company_id: typing.Optional[str] = None,
|
|
512
|
+
created_after: typing.Optional[dt.datetime] = None,
|
|
513
|
+
created_before: typing.Optional[dt.datetime] = None,
|
|
514
|
+
cursor: typing.Optional[str] = None,
|
|
515
|
+
expand: typing.Optional[ExpenseReportsListRequestExpand] = None,
|
|
516
|
+
include_deleted_data: typing.Optional[bool] = None,
|
|
517
|
+
include_remote_data: typing.Optional[bool] = None,
|
|
518
|
+
include_remote_fields: typing.Optional[bool] = None,
|
|
519
|
+
include_shell_data: typing.Optional[bool] = None,
|
|
520
|
+
modified_after: typing.Optional[dt.datetime] = None,
|
|
521
|
+
modified_before: typing.Optional[dt.datetime] = None,
|
|
522
|
+
page_size: typing.Optional[int] = None,
|
|
523
|
+
remote_id: typing.Optional[str] = None,
|
|
524
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
525
|
+
) -> PaginatedExpenseReportList:
|
|
526
|
+
"""
|
|
527
|
+
Returns a list of `ExpenseReport` objects.
|
|
528
|
+
|
|
529
|
+
Parameters
|
|
530
|
+
----------
|
|
531
|
+
company_id : typing.Optional[str]
|
|
532
|
+
If provided, will only return expense reports for this company.
|
|
533
|
+
|
|
534
|
+
created_after : typing.Optional[dt.datetime]
|
|
535
|
+
If provided, will only return objects created after this datetime.
|
|
536
|
+
|
|
537
|
+
created_before : typing.Optional[dt.datetime]
|
|
538
|
+
If provided, will only return objects created before this datetime.
|
|
539
|
+
|
|
540
|
+
cursor : typing.Optional[str]
|
|
541
|
+
The pagination cursor value.
|
|
542
|
+
|
|
543
|
+
expand : typing.Optional[ExpenseReportsListRequestExpand]
|
|
544
|
+
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
545
|
+
|
|
546
|
+
include_deleted_data : typing.Optional[bool]
|
|
547
|
+
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
|
|
548
|
+
|
|
549
|
+
include_remote_data : typing.Optional[bool]
|
|
550
|
+
Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
551
|
+
|
|
552
|
+
include_remote_fields : typing.Optional[bool]
|
|
553
|
+
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
|
|
554
|
+
|
|
555
|
+
include_shell_data : typing.Optional[bool]
|
|
556
|
+
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
|
|
557
|
+
|
|
558
|
+
modified_after : typing.Optional[dt.datetime]
|
|
559
|
+
If provided, only objects synced by Merge after this date time will be returned.
|
|
560
|
+
|
|
561
|
+
modified_before : typing.Optional[dt.datetime]
|
|
562
|
+
If provided, only objects synced by Merge before this date time will be returned.
|
|
563
|
+
|
|
564
|
+
page_size : typing.Optional[int]
|
|
565
|
+
Number of results to return per page.
|
|
566
|
+
|
|
567
|
+
remote_id : typing.Optional[str]
|
|
568
|
+
The API provider's ID for the given object.
|
|
569
|
+
|
|
570
|
+
request_options : typing.Optional[RequestOptions]
|
|
571
|
+
Request-specific configuration.
|
|
572
|
+
|
|
573
|
+
Returns
|
|
574
|
+
-------
|
|
575
|
+
PaginatedExpenseReportList
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
Examples
|
|
579
|
+
--------
|
|
580
|
+
import asyncio
|
|
581
|
+
|
|
582
|
+
from merge import AsyncMerge
|
|
583
|
+
|
|
584
|
+
client = AsyncMerge(
|
|
585
|
+
account_token="YOUR_ACCOUNT_TOKEN",
|
|
586
|
+
api_key="YOUR_API_KEY",
|
|
587
|
+
)
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
async def main() -> None:
|
|
591
|
+
await client.accounting.expense_reports.list(
|
|
592
|
+
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
|
|
593
|
+
)
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
asyncio.run(main())
|
|
597
|
+
"""
|
|
598
|
+
_response = await self._raw_client.list(
|
|
599
|
+
company_id=company_id,
|
|
600
|
+
created_after=created_after,
|
|
601
|
+
created_before=created_before,
|
|
602
|
+
cursor=cursor,
|
|
603
|
+
expand=expand,
|
|
604
|
+
include_deleted_data=include_deleted_data,
|
|
605
|
+
include_remote_data=include_remote_data,
|
|
606
|
+
include_remote_fields=include_remote_fields,
|
|
607
|
+
include_shell_data=include_shell_data,
|
|
608
|
+
modified_after=modified_after,
|
|
609
|
+
modified_before=modified_before,
|
|
610
|
+
page_size=page_size,
|
|
611
|
+
remote_id=remote_id,
|
|
612
|
+
request_options=request_options,
|
|
613
|
+
)
|
|
614
|
+
return _response.data
|
|
615
|
+
|
|
616
|
+
async def create(
|
|
617
|
+
self,
|
|
618
|
+
*,
|
|
619
|
+
model: ExpenseReportRequest,
|
|
620
|
+
is_debug_mode: typing.Optional[bool] = None,
|
|
621
|
+
run_async: typing.Optional[bool] = None,
|
|
622
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
623
|
+
) -> ExpenseReportResponse:
|
|
624
|
+
"""
|
|
625
|
+
Creates an `ExpenseReport` object with the given values.
|
|
626
|
+
|
|
627
|
+
Parameters
|
|
628
|
+
----------
|
|
629
|
+
model : ExpenseReportRequest
|
|
630
|
+
|
|
631
|
+
is_debug_mode : typing.Optional[bool]
|
|
632
|
+
Whether to include debug fields (such as log file links) in the response.
|
|
633
|
+
|
|
634
|
+
run_async : typing.Optional[bool]
|
|
635
|
+
Whether or not third-party updates should be run asynchronously.
|
|
636
|
+
|
|
637
|
+
request_options : typing.Optional[RequestOptions]
|
|
638
|
+
Request-specific configuration.
|
|
639
|
+
|
|
640
|
+
Returns
|
|
641
|
+
-------
|
|
642
|
+
ExpenseReportResponse
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
Examples
|
|
646
|
+
--------
|
|
647
|
+
import asyncio
|
|
648
|
+
|
|
649
|
+
from merge import AsyncMerge
|
|
650
|
+
from merge.resources.accounting import ExpenseReportRequest
|
|
651
|
+
|
|
652
|
+
client = AsyncMerge(
|
|
653
|
+
account_token="YOUR_ACCOUNT_TOKEN",
|
|
654
|
+
api_key="YOUR_API_KEY",
|
|
655
|
+
)
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
async def main() -> None:
|
|
659
|
+
await client.accounting.expense_reports.create(
|
|
660
|
+
model=ExpenseReportRequest(
|
|
661
|
+
tracking_categories=[
|
|
662
|
+
"a1b2c3d4-e5f6-4a5b-9c3d-2e1f0a9b8c7d",
|
|
663
|
+
"d4c3b2a1-9e8f-7g6h-5i4j-3k2l1m0n9o8p",
|
|
664
|
+
],
|
|
665
|
+
),
|
|
666
|
+
)
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
asyncio.run(main())
|
|
670
|
+
"""
|
|
671
|
+
_response = await self._raw_client.create(
|
|
672
|
+
model=model, is_debug_mode=is_debug_mode, run_async=run_async, request_options=request_options
|
|
673
|
+
)
|
|
674
|
+
return _response.data
|
|
675
|
+
|
|
676
|
+
async def lines_list(
|
|
677
|
+
self,
|
|
678
|
+
expense_report_id: str,
|
|
679
|
+
*,
|
|
680
|
+
cursor: typing.Optional[str] = None,
|
|
681
|
+
expand: typing.Optional[ExpenseReportsLinesListRequestExpand] = None,
|
|
682
|
+
include_deleted_data: typing.Optional[bool] = None,
|
|
683
|
+
include_remote_data: typing.Optional[bool] = None,
|
|
684
|
+
include_remote_fields: typing.Optional[bool] = None,
|
|
685
|
+
include_shell_data: typing.Optional[bool] = None,
|
|
686
|
+
page_size: typing.Optional[int] = None,
|
|
687
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
688
|
+
) -> PaginatedExpenseReportLineList:
|
|
689
|
+
"""
|
|
690
|
+
Returns a list of `ExpenseReportLine` objects that point to a `ExpenseReport` with the given id.
|
|
691
|
+
|
|
692
|
+
Parameters
|
|
693
|
+
----------
|
|
694
|
+
expense_report_id : str
|
|
695
|
+
|
|
696
|
+
cursor : typing.Optional[str]
|
|
697
|
+
The pagination cursor value.
|
|
698
|
+
|
|
699
|
+
expand : typing.Optional[ExpenseReportsLinesListRequestExpand]
|
|
700
|
+
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
701
|
+
|
|
702
|
+
include_deleted_data : typing.Optional[bool]
|
|
703
|
+
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
|
|
704
|
+
|
|
705
|
+
include_remote_data : typing.Optional[bool]
|
|
706
|
+
Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
707
|
+
|
|
708
|
+
include_remote_fields : typing.Optional[bool]
|
|
709
|
+
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
|
|
710
|
+
|
|
711
|
+
include_shell_data : typing.Optional[bool]
|
|
712
|
+
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
|
|
713
|
+
|
|
714
|
+
page_size : typing.Optional[int]
|
|
715
|
+
Number of results to return per page.
|
|
716
|
+
|
|
717
|
+
request_options : typing.Optional[RequestOptions]
|
|
718
|
+
Request-specific configuration.
|
|
719
|
+
|
|
720
|
+
Returns
|
|
721
|
+
-------
|
|
722
|
+
PaginatedExpenseReportLineList
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
Examples
|
|
726
|
+
--------
|
|
727
|
+
import asyncio
|
|
728
|
+
|
|
729
|
+
from merge import AsyncMerge
|
|
730
|
+
|
|
731
|
+
client = AsyncMerge(
|
|
732
|
+
account_token="YOUR_ACCOUNT_TOKEN",
|
|
733
|
+
api_key="YOUR_API_KEY",
|
|
734
|
+
)
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
async def main() -> None:
|
|
738
|
+
await client.accounting.expense_reports.lines_list(
|
|
739
|
+
expense_report_id="expense_report_id",
|
|
740
|
+
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
|
|
741
|
+
)
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
asyncio.run(main())
|
|
745
|
+
"""
|
|
746
|
+
_response = await self._raw_client.lines_list(
|
|
747
|
+
expense_report_id,
|
|
748
|
+
cursor=cursor,
|
|
749
|
+
expand=expand,
|
|
750
|
+
include_deleted_data=include_deleted_data,
|
|
751
|
+
include_remote_data=include_remote_data,
|
|
752
|
+
include_remote_fields=include_remote_fields,
|
|
753
|
+
include_shell_data=include_shell_data,
|
|
754
|
+
page_size=page_size,
|
|
755
|
+
request_options=request_options,
|
|
756
|
+
)
|
|
757
|
+
return _response.data
|
|
758
|
+
|
|
759
|
+
async def retrieve(
|
|
760
|
+
self,
|
|
761
|
+
id: str,
|
|
762
|
+
*,
|
|
763
|
+
expand: typing.Optional[ExpenseReportsRetrieveRequestExpand] = None,
|
|
764
|
+
include_remote_data: typing.Optional[bool] = None,
|
|
765
|
+
include_remote_fields: typing.Optional[bool] = None,
|
|
766
|
+
include_shell_data: typing.Optional[bool] = None,
|
|
767
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
768
|
+
) -> ExpenseReport:
|
|
769
|
+
"""
|
|
770
|
+
Returns an `ExpenseReport` object with the given `id`.
|
|
771
|
+
|
|
772
|
+
Parameters
|
|
773
|
+
----------
|
|
774
|
+
id : str
|
|
775
|
+
|
|
776
|
+
expand : typing.Optional[ExpenseReportsRetrieveRequestExpand]
|
|
777
|
+
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
|
778
|
+
|
|
779
|
+
include_remote_data : typing.Optional[bool]
|
|
780
|
+
Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
781
|
+
|
|
782
|
+
include_remote_fields : typing.Optional[bool]
|
|
783
|
+
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
|
|
784
|
+
|
|
785
|
+
include_shell_data : typing.Optional[bool]
|
|
786
|
+
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
|
|
787
|
+
|
|
788
|
+
request_options : typing.Optional[RequestOptions]
|
|
789
|
+
Request-specific configuration.
|
|
790
|
+
|
|
791
|
+
Returns
|
|
792
|
+
-------
|
|
793
|
+
ExpenseReport
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
Examples
|
|
797
|
+
--------
|
|
798
|
+
import asyncio
|
|
799
|
+
|
|
800
|
+
from merge import AsyncMerge
|
|
801
|
+
|
|
802
|
+
client = AsyncMerge(
|
|
803
|
+
account_token="YOUR_ACCOUNT_TOKEN",
|
|
804
|
+
api_key="YOUR_API_KEY",
|
|
805
|
+
)
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
async def main() -> None:
|
|
809
|
+
await client.accounting.expense_reports.retrieve(
|
|
810
|
+
id="id",
|
|
811
|
+
)
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
asyncio.run(main())
|
|
815
|
+
"""
|
|
816
|
+
_response = await self._raw_client.retrieve(
|
|
817
|
+
id,
|
|
818
|
+
expand=expand,
|
|
819
|
+
include_remote_data=include_remote_data,
|
|
820
|
+
include_remote_fields=include_remote_fields,
|
|
821
|
+
include_shell_data=include_shell_data,
|
|
822
|
+
request_options=request_options,
|
|
823
|
+
)
|
|
824
|
+
return _response.data
|
|
825
|
+
|
|
826
|
+
async def lines_remote_field_classes_list(
|
|
827
|
+
self,
|
|
828
|
+
*,
|
|
829
|
+
cursor: typing.Optional[str] = None,
|
|
830
|
+
include_deleted_data: typing.Optional[bool] = None,
|
|
831
|
+
include_remote_data: typing.Optional[bool] = None,
|
|
832
|
+
include_shell_data: typing.Optional[bool] = None,
|
|
833
|
+
is_common_model_field: typing.Optional[bool] = None,
|
|
834
|
+
is_custom: typing.Optional[bool] = None,
|
|
835
|
+
page_size: typing.Optional[int] = None,
|
|
836
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
837
|
+
) -> PaginatedRemoteFieldClassList:
|
|
838
|
+
"""
|
|
839
|
+
Returns a list of `RemoteFieldClass` objects.
|
|
840
|
+
|
|
841
|
+
Parameters
|
|
842
|
+
----------
|
|
843
|
+
cursor : typing.Optional[str]
|
|
844
|
+
The pagination cursor value.
|
|
845
|
+
|
|
846
|
+
include_deleted_data : typing.Optional[bool]
|
|
847
|
+
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
|
|
848
|
+
|
|
849
|
+
include_remote_data : typing.Optional[bool]
|
|
850
|
+
Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
851
|
+
|
|
852
|
+
include_shell_data : typing.Optional[bool]
|
|
853
|
+
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
|
|
854
|
+
|
|
855
|
+
is_common_model_field : typing.Optional[bool]
|
|
856
|
+
If provided, will only return remote field classes with this is_common_model_field value
|
|
857
|
+
|
|
858
|
+
is_custom : typing.Optional[bool]
|
|
859
|
+
If provided, will only return remote fields classes with this is_custom value
|
|
860
|
+
|
|
861
|
+
page_size : typing.Optional[int]
|
|
862
|
+
Number of results to return per page.
|
|
863
|
+
|
|
864
|
+
request_options : typing.Optional[RequestOptions]
|
|
865
|
+
Request-specific configuration.
|
|
866
|
+
|
|
867
|
+
Returns
|
|
868
|
+
-------
|
|
869
|
+
PaginatedRemoteFieldClassList
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
Examples
|
|
873
|
+
--------
|
|
874
|
+
import asyncio
|
|
875
|
+
|
|
876
|
+
from merge import AsyncMerge
|
|
877
|
+
|
|
878
|
+
client = AsyncMerge(
|
|
879
|
+
account_token="YOUR_ACCOUNT_TOKEN",
|
|
880
|
+
api_key="YOUR_API_KEY",
|
|
881
|
+
)
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
async def main() -> None:
|
|
885
|
+
await client.accounting.expense_reports.lines_remote_field_classes_list(
|
|
886
|
+
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
|
|
887
|
+
)
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
asyncio.run(main())
|
|
891
|
+
"""
|
|
892
|
+
_response = await self._raw_client.lines_remote_field_classes_list(
|
|
893
|
+
cursor=cursor,
|
|
894
|
+
include_deleted_data=include_deleted_data,
|
|
895
|
+
include_remote_data=include_remote_data,
|
|
896
|
+
include_shell_data=include_shell_data,
|
|
897
|
+
is_common_model_field=is_common_model_field,
|
|
898
|
+
is_custom=is_custom,
|
|
899
|
+
page_size=page_size,
|
|
900
|
+
request_options=request_options,
|
|
901
|
+
)
|
|
902
|
+
return _response.data
|
|
903
|
+
|
|
904
|
+
async def meta_post_retrieve(self, *, request_options: typing.Optional[RequestOptions] = None) -> MetaResponse:
|
|
905
|
+
"""
|
|
906
|
+
Returns metadata for `ExpenseReport` POSTs.
|
|
907
|
+
|
|
908
|
+
Parameters
|
|
909
|
+
----------
|
|
910
|
+
request_options : typing.Optional[RequestOptions]
|
|
911
|
+
Request-specific configuration.
|
|
912
|
+
|
|
913
|
+
Returns
|
|
914
|
+
-------
|
|
915
|
+
MetaResponse
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
Examples
|
|
919
|
+
--------
|
|
920
|
+
import asyncio
|
|
921
|
+
|
|
922
|
+
from merge import AsyncMerge
|
|
923
|
+
|
|
924
|
+
client = AsyncMerge(
|
|
925
|
+
account_token="YOUR_ACCOUNT_TOKEN",
|
|
926
|
+
api_key="YOUR_API_KEY",
|
|
927
|
+
)
|
|
928
|
+
|
|
929
|
+
|
|
930
|
+
async def main() -> None:
|
|
931
|
+
await client.accounting.expense_reports.meta_post_retrieve()
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
asyncio.run(main())
|
|
935
|
+
"""
|
|
936
|
+
_response = await self._raw_client.meta_post_retrieve(request_options=request_options)
|
|
937
|
+
return _response.data
|
|
938
|
+
|
|
939
|
+
async def remote_field_classes_list(
|
|
940
|
+
self,
|
|
941
|
+
*,
|
|
942
|
+
cursor: typing.Optional[str] = None,
|
|
943
|
+
include_deleted_data: typing.Optional[bool] = None,
|
|
944
|
+
include_remote_data: typing.Optional[bool] = None,
|
|
945
|
+
include_shell_data: typing.Optional[bool] = None,
|
|
946
|
+
is_common_model_field: typing.Optional[bool] = None,
|
|
947
|
+
is_custom: typing.Optional[bool] = None,
|
|
948
|
+
page_size: typing.Optional[int] = None,
|
|
949
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
950
|
+
) -> PaginatedRemoteFieldClassList:
|
|
951
|
+
"""
|
|
952
|
+
Returns a list of `RemoteFieldClass` objects.
|
|
953
|
+
|
|
954
|
+
Parameters
|
|
955
|
+
----------
|
|
956
|
+
cursor : typing.Optional[str]
|
|
957
|
+
The pagination cursor value.
|
|
958
|
+
|
|
959
|
+
include_deleted_data : typing.Optional[bool]
|
|
960
|
+
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
|
|
961
|
+
|
|
962
|
+
include_remote_data : typing.Optional[bool]
|
|
963
|
+
Whether to include the original data Merge fetched from the third-party to produce these models.
|
|
964
|
+
|
|
965
|
+
include_shell_data : typing.Optional[bool]
|
|
966
|
+
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
|
|
967
|
+
|
|
968
|
+
is_common_model_field : typing.Optional[bool]
|
|
969
|
+
If provided, will only return remote field classes with this is_common_model_field value
|
|
970
|
+
|
|
971
|
+
is_custom : typing.Optional[bool]
|
|
972
|
+
If provided, will only return remote fields classes with this is_custom value
|
|
973
|
+
|
|
974
|
+
page_size : typing.Optional[int]
|
|
975
|
+
Number of results to return per page.
|
|
976
|
+
|
|
977
|
+
request_options : typing.Optional[RequestOptions]
|
|
978
|
+
Request-specific configuration.
|
|
979
|
+
|
|
980
|
+
Returns
|
|
981
|
+
-------
|
|
982
|
+
PaginatedRemoteFieldClassList
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
Examples
|
|
986
|
+
--------
|
|
987
|
+
import asyncio
|
|
988
|
+
|
|
989
|
+
from merge import AsyncMerge
|
|
990
|
+
|
|
991
|
+
client = AsyncMerge(
|
|
992
|
+
account_token="YOUR_ACCOUNT_TOKEN",
|
|
993
|
+
api_key="YOUR_API_KEY",
|
|
994
|
+
)
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
async def main() -> None:
|
|
998
|
+
await client.accounting.expense_reports.remote_field_classes_list(
|
|
999
|
+
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
|
|
1000
|
+
)
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
asyncio.run(main())
|
|
1004
|
+
"""
|
|
1005
|
+
_response = await self._raw_client.remote_field_classes_list(
|
|
1006
|
+
cursor=cursor,
|
|
1007
|
+
include_deleted_data=include_deleted_data,
|
|
1008
|
+
include_remote_data=include_remote_data,
|
|
1009
|
+
include_shell_data=include_shell_data,
|
|
1010
|
+
is_common_model_field=is_common_model_field,
|
|
1011
|
+
is_custom=is_custom,
|
|
1012
|
+
page_size=page_size,
|
|
1013
|
+
request_options=request_options,
|
|
1014
|
+
)
|
|
1015
|
+
return _response.data
|