Skip to content

Index

hypha.apply.projects.services.sageintacct.wrapper

ApiBase 

ApiBase(dimension=None, pagesize=2000, post_legacy_method=None)

The base class for all API classes.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
def __init__(
    self,
    dimension: str = None,
    pagesize: int = 2000,
    post_legacy_method: str = None,
):
    self.__sender_id = None
    self.__sender_password = None
    self.__session_id = None
    self.__api_url = "https://api.intacct.com/ia/xml/xmlgw.phtml"
    self.__dimension = dimension
    self.__pagesize = pagesize
    self.__post_legacy_method = post_legacy_method

set_sender_id 

set_sender_id(sender_id)

Set the sender id for APIs :param sender_id: sender id :return: None

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
42
43
44
45
46
47
48
def set_sender_id(self, sender_id: str):
    """
    Set the sender id for APIs
    :param sender_id: sender id
    :return: None
    """
    self.__sender_id = sender_id

set_sender_password 

set_sender_password(sender_password)

Set the sender password for APIs :param sender_password: sender id :return: None

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
50
51
52
53
54
55
56
def set_sender_password(self, sender_password: str):
    """
    Set the sender password for APIs
    :param sender_password: sender id
    :return: None
    """
    self.__sender_password = sender_password

get_session_id 

get_session_id(user_id, company_id, user_password, entity_id=None)

Sets the session id for APIs :param access_token: acceess token (JWT) :return: session id

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def get_session_id(
    self, user_id: str, company_id: str, user_password: str, entity_id: str = None
):
    """
    Sets the session id for APIs
    :param access_token: acceess token (JWT)
    :return: session id
    """

    timestamp = datetime.datetime.now()
    dict_body = {
        "request": {
            "control": {
                "senderid": self.__sender_id,
                "password": self.__sender_password,
                "controlid": timestamp,
                "uniqueid": False,
                "dtdversion": 3.0,
                "includewhitespace": False,
            },
            "operation": {
                "authentication": {
                    "login": {
                        "userid": user_id,
                        "companyid": company_id,
                        "password": user_password,
                        "locationid": entity_id,
                    }
                },
                "content": {
                    "function": {
                        "@controlid": str(uuid.uuid4()),
                        "getAPISession": None,
                    }
                },
            },
        }
    }

    response = self.__post_request(dict_body, self.__api_url)

    if response["authentication"]["status"] == "success":
        session_details = response["result"]["data"]["api"]
        self.__api_url = session_details["endpoint"]
        self.__session_id = session_details["sessionid"]

        return self.__session_id

    else:
        raise SageIntacctSDKError("Error: {0}".format(response["errormessage"]))

set_session_id 

set_session_id(session_id)

Set the session id for APIs :param session_id: session id :return: None

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
109
110
111
112
113
114
115
def set_session_id(self, session_id: str):
    """
    Set the session id for APIs
    :param session_id: session id
    :return: None
    """
    self.__session_id = session_id

format_and_send_request 

format_and_send_request(data)

Format data accordingly to convert them to xml.

Parameters:

  • data (dict) –

    HTTP POST body data for the wanted API.

Returns:

  • –

    A response from the __post_request (dict).

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
def format_and_send_request(self, data: Dict):
    """Format data accordingly to convert them to xml.

    Parameters:
        data (dict): HTTP POST body data for the wanted API.

    Returns:
        A response from the __post_request (dict).
    """

    key = next(iter(data))
    timestamp = datetime.datetime.now()

    dict_body = {
        "request": {
            "control": {
                "senderid": self.__sender_id,
                "password": self.__sender_password,
                "controlid": timestamp,
                "uniqueid": False,
                "dtdversion": 3.0,
                "includewhitespace": False,
            },
            "operation": {
                "authentication": {"sessionid": self.__session_id},
                "content": {
                    "function": {"@controlid": str(uuid.uuid4()), key: data[key]}
                },
            },
        }
    }

    response = self.__post_request(dict_body, self.__api_url)
    return response["result"]

post 

post(data)
Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
282
283
284
285
286
def post(self, data: Dict):
    if self.__dimension in ("CCTRANSACTION", "EPPAYMENT"):
        return self.__construct_post_legacy_payload(data)

    return self.__construct_post_payload(data)

count 

count()
Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
298
299
300
301
302
303
304
305
306
307
308
def count(self):
    get_count = {
        "query": {
            "object": self.__dimension,
            "select": {"field": "RECORDNO"},
            "pagesize": "1",
        }
    }

    response = self.format_and_send_request(get_count)
    return int(response["data"]["@totalcount"])

read_by_query 

read_by_query(fields=None)

Read by Query from Sage Intacct

Parameters:

  • fields (list, default: None ) –

    Get selective fields to be returned. (optional).

Returns:

  • –

    Dict.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
def read_by_query(self, fields: list = None):
    """Read by Query from Sage Intacct

    Parameters:
        fields (list): Get selective fields to be returned. (optional).

    Returns:
        Dict.
    """
    payload = {
        "readByQuery": {
            "object": self.__dimension,
            "fields": ",".join(fields) if fields else "*",
            "query": None,
            "pagesize": "1000",
        }
    }

    return self.format_and_send_request(payload)

get 

get(field, value, fields=None)

Get data from Sage Intacct based on filter.

Parameters:

  • field (str) –

    A parameter to filter by the field. (required).

  • value (str) –

    A parameter to filter by the field - value. (required).

Returns:

  • –

    Dict.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
def get(self, field: str, value: str, fields: list = None):
    """Get data from Sage Intacct based on filter.

    Parameters:
        field (str): A parameter to filter by the field. (required).
        value (str): A parameter to filter by the field - value. (required).

    Returns:
        Dict.
    """
    data = {
        "readByQuery": {
            "object": self.__dimension,
            "fields": ",".join(fields) if fields else "*",
            "query": "{0} = '{1}'".format(field, value),
            "pagesize": "1000",
        }
    }

    return self.format_and_send_request(data)["data"]

get_all 

get_all(field=None, value=None, fields=None)

Get all data from Sage Intacct

Returns:

  • –

    List of Dict.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
def get_all(self, field: str = None, value: str = None, fields: list = None):
    """Get all data from Sage Intacct

    Returns:
        List of Dict.
    """
    complete_data = []
    count = self.count()
    pagesize = self.__pagesize
    for offset in range(0, count, pagesize):
        data = {
            "query": {
                "object": self.__dimension,
                "select": {
                    "field": fields
                    if fields
                    else dimensions_fields_mapping[self.__dimension]
                },
                "pagesize": pagesize,
                "offset": offset,
            }
        }

        if field and value:
            data["query"]["filter"] = {"equalto": {"field": field, "value": value}}

        paginated_data = self.format_and_send_request(data)["data"][
            self.__dimension
        ]
        complete_data.extend(paginated_data)

    return complete_data

get_by_query 

get_by_query(fields=None, and_filter=None, or_filter=None, filter_payload=None)

Get data from Sage Intacct using query method based on filter.

See sage intacct documentation here for query structures: https://developer.intacct.com/web-services/queries/

    Parameters:
        fields (str): A parameter to filter by the field. (required).
        and_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
        or_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
        filter_payload (dict): Formatted query payload in dictionary format.
        if 'between' operators is used on and_filter or or_filter field must be submitted as
        [str,str]
        if 'in' operator is used field may be submitted as [str,str,str,...]

    Returns:
        Dict.
Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
def get_by_query(
    self,
    fields: List[str] = None,
    and_filter: __query_filter = None,
    or_filter: __query_filter = None,
    filter_payload: dict = None,
):
    """Get data from Sage Intacct using query method based on filter.

    See sage intacct documentation here for query structures:
    https://developer.intacct.com/web-services/queries/

            Parameters:
                fields (str): A parameter to filter by the field. (required).
                and_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
                or_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
                filter_payload (dict): Formatted query payload in dictionary format.
                if 'between' operators is used on and_filter or or_filter field must be submitted as
                [str,str]
                if 'in' operator is used field may be submitted as [str,str,str,...]

            Returns:
                Dict.
    """

    complete_data = []
    count = self.count()
    pagesize = self.__pagesize
    offset = 0
    formatted_filter = filter_payload
    data = {
        "query": {
            "object": self.__dimension,
            "select": {
                "field": fields
                if fields
                else dimensions_fields_mapping[self.__dimension]
            },
            "pagesize": pagesize,
            "offset": offset,
        }
    }
    if and_filter and or_filter:
        formatted_filter = {"and": {}}
        for operator, field, value in and_filter:
            formatted_filter["and"].setdefault(operator, {}).update(
                {"field": field, "value": value}
            )
        formatted_filter["and"]["or"] = {}
        for operator, field, value in or_filter:
            formatted_filter["and"]["or"].setdefault(operator, {}).update(
                {"field": field, "value": value}
            )

    elif and_filter:
        if len(and_filter) > 1:
            formatted_filter = {"and": {}}
            for operator, field, value in and_filter:
                formatted_filter["and"].setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )
        else:
            formatted_filter = {}
            for operator, field, value in and_filter:
                formatted_filter.setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )
    elif or_filter:
        if len(or_filter) > 1:
            formatted_filter = {"or": {}}
            for operator, field, value in or_filter:
                formatted_filter["or"].setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )
        else:
            formatted_filter = {}
            for operator, field, value in or_filter:
                formatted_filter.setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )

    if formatted_filter:
        data["query"]["filter"] = formatted_filter

    for offset in range(0, count, pagesize):
        data["query"]["offset"] = offset
        paginated_data = self.format_and_send_request(data)["data"]
        complete_data.extend(paginated_data[self.__dimension])
        filtered_total = int(paginated_data["@totalcount"])
        if paginated_data["@numremaining"] == "0":
            break
    if filtered_total != len(complete_data):
        warn(
            message="Your data may not be complete. Records returned do not equal total query record count",
            category=DataIntegrityWarning,
            stacklevel=2,
        )
    return complete_data

get_lookup 

get_lookup()

Returns all fields with attributes from the object called on.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
485
486
487
488
489
490
491
492
493
494
495
def get_lookup(self):
    """Returns all fields with attributes from the object called on.

    Parameters:
        self
    Returns:
        Dict.
    """

    data = {"lookup": {"object": self.__dimension}}
    return self.format_and_send_request(data)["data"]

Invoice 

Invoice(dimension=None, pagesize=2000, post_legacy_method=None)

Bases: ApiBase

Class to create Contract Invoice Release at Sage IntAcct.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
def __init__(
    self,
    dimension: str = None,
    pagesize: int = 2000,
    post_legacy_method: str = None,
):
    self.__sender_id = None
    self.__sender_password = None
    self.__session_id = None
    self.__api_url = "https://api.intacct.com/ia/xml/xmlgw.phtml"
    self.__dimension = dimension
    self.__pagesize = pagesize
    self.__post_legacy_method = post_legacy_method

set_sender_id 

set_sender_id(sender_id)

Set the sender id for APIs :param sender_id: sender id :return: None

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
42
43
44
45
46
47
48
def set_sender_id(self, sender_id: str):
    """
    Set the sender id for APIs
    :param sender_id: sender id
    :return: None
    """
    self.__sender_id = sender_id

set_sender_password 

set_sender_password(sender_password)

Set the sender password for APIs :param sender_password: sender id :return: None

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
50
51
52
53
54
55
56
def set_sender_password(self, sender_password: str):
    """
    Set the sender password for APIs
    :param sender_password: sender id
    :return: None
    """
    self.__sender_password = sender_password

get_session_id 

get_session_id(user_id, company_id, user_password, entity_id=None)

Sets the session id for APIs :param access_token: acceess token (JWT) :return: session id

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def get_session_id(
    self, user_id: str, company_id: str, user_password: str, entity_id: str = None
):
    """
    Sets the session id for APIs
    :param access_token: acceess token (JWT)
    :return: session id
    """

    timestamp = datetime.datetime.now()
    dict_body = {
        "request": {
            "control": {
                "senderid": self.__sender_id,
                "password": self.__sender_password,
                "controlid": timestamp,
                "uniqueid": False,
                "dtdversion": 3.0,
                "includewhitespace": False,
            },
            "operation": {
                "authentication": {
                    "login": {
                        "userid": user_id,
                        "companyid": company_id,
                        "password": user_password,
                        "locationid": entity_id,
                    }
                },
                "content": {
                    "function": {
                        "@controlid": str(uuid.uuid4()),
                        "getAPISession": None,
                    }
                },
            },
        }
    }

    response = self.__post_request(dict_body, self.__api_url)

    if response["authentication"]["status"] == "success":
        session_details = response["result"]["data"]["api"]
        self.__api_url = session_details["endpoint"]
        self.__session_id = session_details["sessionid"]

        return self.__session_id

    else:
        raise SageIntacctSDKError("Error: {0}".format(response["errormessage"]))

set_session_id 

set_session_id(session_id)

Set the session id for APIs :param session_id: session id :return: None

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
109
110
111
112
113
114
115
def set_session_id(self, session_id: str):
    """
    Set the session id for APIs
    :param session_id: session id
    :return: None
    """
    self.__session_id = session_id

format_and_send_request 

format_and_send_request(data)

Format data accordingly to convert them to xml.

Parameters:

  • data (dict) –

    HTTP POST body data for the wanted API.

Returns:

  • –

    A response from the __post_request (dict).

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
def format_and_send_request(self, data: Dict):
    """Format data accordingly to convert them to xml.

    Parameters:
        data (dict): HTTP POST body data for the wanted API.

    Returns:
        A response from the __post_request (dict).
    """

    key = next(iter(data))
    timestamp = datetime.datetime.now()

    dict_body = {
        "request": {
            "control": {
                "senderid": self.__sender_id,
                "password": self.__sender_password,
                "controlid": timestamp,
                "uniqueid": False,
                "dtdversion": 3.0,
                "includewhitespace": False,
            },
            "operation": {
                "authentication": {"sessionid": self.__session_id},
                "content": {
                    "function": {"@controlid": str(uuid.uuid4()), key: data[key]}
                },
            },
        }
    }

    response = self.__post_request(dict_body, self.__api_url)
    return response["result"]

count 

count()
Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
298
299
300
301
302
303
304
305
306
307
308
def count(self):
    get_count = {
        "query": {
            "object": self.__dimension,
            "select": {"field": "RECORDNO"},
            "pagesize": "1",
        }
    }

    response = self.format_and_send_request(get_count)
    return int(response["data"]["@totalcount"])

read_by_query 

read_by_query(fields=None)

Read by Query from Sage Intacct

Parameters:

  • fields (list, default: None ) –

    Get selective fields to be returned. (optional).

Returns:

  • –

    Dict.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
def read_by_query(self, fields: list = None):
    """Read by Query from Sage Intacct

    Parameters:
        fields (list): Get selective fields to be returned. (optional).

    Returns:
        Dict.
    """
    payload = {
        "readByQuery": {
            "object": self.__dimension,
            "fields": ",".join(fields) if fields else "*",
            "query": None,
            "pagesize": "1000",
        }
    }

    return self.format_and_send_request(payload)

get 

get(field, value, fields=None)

Get data from Sage Intacct based on filter.

Parameters:

  • field (str) –

    A parameter to filter by the field. (required).

  • value (str) –

    A parameter to filter by the field - value. (required).

Returns:

  • –

    Dict.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
def get(self, field: str, value: str, fields: list = None):
    """Get data from Sage Intacct based on filter.

    Parameters:
        field (str): A parameter to filter by the field. (required).
        value (str): A parameter to filter by the field - value. (required).

    Returns:
        Dict.
    """
    data = {
        "readByQuery": {
            "object": self.__dimension,
            "fields": ",".join(fields) if fields else "*",
            "query": "{0} = '{1}'".format(field, value),
            "pagesize": "1000",
        }
    }

    return self.format_and_send_request(data)["data"]

get_all 

get_all(field=None, value=None, fields=None)

Get all data from Sage Intacct

Returns:

  • –

    List of Dict.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
def get_all(self, field: str = None, value: str = None, fields: list = None):
    """Get all data from Sage Intacct

    Returns:
        List of Dict.
    """
    complete_data = []
    count = self.count()
    pagesize = self.__pagesize
    for offset in range(0, count, pagesize):
        data = {
            "query": {
                "object": self.__dimension,
                "select": {
                    "field": fields
                    if fields
                    else dimensions_fields_mapping[self.__dimension]
                },
                "pagesize": pagesize,
                "offset": offset,
            }
        }

        if field and value:
            data["query"]["filter"] = {"equalto": {"field": field, "value": value}}

        paginated_data = self.format_and_send_request(data)["data"][
            self.__dimension
        ]
        complete_data.extend(paginated_data)

    return complete_data

get_by_query 

get_by_query(fields=None, and_filter=None, or_filter=None, filter_payload=None)

Get data from Sage Intacct using query method based on filter.

See sage intacct documentation here for query structures: https://developer.intacct.com/web-services/queries/

    Parameters:
        fields (str): A parameter to filter by the field. (required).
        and_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
        or_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
        filter_payload (dict): Formatted query payload in dictionary format.
        if 'between' operators is used on and_filter or or_filter field must be submitted as
        [str,str]
        if 'in' operator is used field may be submitted as [str,str,str,...]

    Returns:
        Dict.
Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
def get_by_query(
    self,
    fields: List[str] = None,
    and_filter: __query_filter = None,
    or_filter: __query_filter = None,
    filter_payload: dict = None,
):
    """Get data from Sage Intacct using query method based on filter.

    See sage intacct documentation here for query structures:
    https://developer.intacct.com/web-services/queries/

            Parameters:
                fields (str): A parameter to filter by the field. (required).
                and_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
                or_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
                filter_payload (dict): Formatted query payload in dictionary format.
                if 'between' operators is used on and_filter or or_filter field must be submitted as
                [str,str]
                if 'in' operator is used field may be submitted as [str,str,str,...]

            Returns:
                Dict.
    """

    complete_data = []
    count = self.count()
    pagesize = self.__pagesize
    offset = 0
    formatted_filter = filter_payload
    data = {
        "query": {
            "object": self.__dimension,
            "select": {
                "field": fields
                if fields
                else dimensions_fields_mapping[self.__dimension]
            },
            "pagesize": pagesize,
            "offset": offset,
        }
    }
    if and_filter and or_filter:
        formatted_filter = {"and": {}}
        for operator, field, value in and_filter:
            formatted_filter["and"].setdefault(operator, {}).update(
                {"field": field, "value": value}
            )
        formatted_filter["and"]["or"] = {}
        for operator, field, value in or_filter:
            formatted_filter["and"]["or"].setdefault(operator, {}).update(
                {"field": field, "value": value}
            )

    elif and_filter:
        if len(and_filter) > 1:
            formatted_filter = {"and": {}}
            for operator, field, value in and_filter:
                formatted_filter["and"].setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )
        else:
            formatted_filter = {}
            for operator, field, value in and_filter:
                formatted_filter.setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )
    elif or_filter:
        if len(or_filter) > 1:
            formatted_filter = {"or": {}}
            for operator, field, value in or_filter:
                formatted_filter["or"].setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )
        else:
            formatted_filter = {}
            for operator, field, value in or_filter:
                formatted_filter.setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )

    if formatted_filter:
        data["query"]["filter"] = formatted_filter

    for offset in range(0, count, pagesize):
        data["query"]["offset"] = offset
        paginated_data = self.format_and_send_request(data)["data"]
        complete_data.extend(paginated_data[self.__dimension])
        filtered_total = int(paginated_data["@totalcount"])
        if paginated_data["@numremaining"] == "0":
            break
    if filtered_total != len(complete_data):
        warn(
            message="Your data may not be complete. Records returned do not equal total query record count",
            category=DataIntegrityWarning,
            stacklevel=2,
        )
    return complete_data

get_lookup 

get_lookup()

Returns all fields with attributes from the object called on.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
485
486
487
488
489
490
491
492
493
494
495
def get_lookup(self):
    """Returns all fields with attributes from the object called on.

    Parameters:
        self
    Returns:
        Dict.
    """

    data = {"lookup": {"object": self.__dimension}}
    return self.format_and_send_request(data)["data"]

post 

post(data)
Source code in hypha/apply/projects/services/sageintacct/wrapper/invoice.py 
7
8
9
def post(self, data: dict):
    data = {"create_potransaction": data}
    return self.format_and_send_request(data)

Project 

Project()

Bases: ApiBase

Class for contract APIs.

Source code in hypha/apply/projects/services/sageintacct/wrapper/project.py 
11
12
def __init__(self):
    ApiBase.__init__(self, dimension="PODOCUMENT")

set_sender_id 

set_sender_id(sender_id)

Set the sender id for APIs :param sender_id: sender id :return: None

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
42
43
44
45
46
47
48
def set_sender_id(self, sender_id: str):
    """
    Set the sender id for APIs
    :param sender_id: sender id
    :return: None
    """
    self.__sender_id = sender_id

set_sender_password 

set_sender_password(sender_password)

Set the sender password for APIs :param sender_password: sender id :return: None

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
50
51
52
53
54
55
56
def set_sender_password(self, sender_password: str):
    """
    Set the sender password for APIs
    :param sender_password: sender id
    :return: None
    """
    self.__sender_password = sender_password

get_session_id 

get_session_id(user_id, company_id, user_password, entity_id=None)

Sets the session id for APIs :param access_token: acceess token (JWT) :return: session id

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def get_session_id(
    self, user_id: str, company_id: str, user_password: str, entity_id: str = None
):
    """
    Sets the session id for APIs
    :param access_token: acceess token (JWT)
    :return: session id
    """

    timestamp = datetime.datetime.now()
    dict_body = {
        "request": {
            "control": {
                "senderid": self.__sender_id,
                "password": self.__sender_password,
                "controlid": timestamp,
                "uniqueid": False,
                "dtdversion": 3.0,
                "includewhitespace": False,
            },
            "operation": {
                "authentication": {
                    "login": {
                        "userid": user_id,
                        "companyid": company_id,
                        "password": user_password,
                        "locationid": entity_id,
                    }
                },
                "content": {
                    "function": {
                        "@controlid": str(uuid.uuid4()),
                        "getAPISession": None,
                    }
                },
            },
        }
    }

    response = self.__post_request(dict_body, self.__api_url)

    if response["authentication"]["status"] == "success":
        session_details = response["result"]["data"]["api"]
        self.__api_url = session_details["endpoint"]
        self.__session_id = session_details["sessionid"]

        return self.__session_id

    else:
        raise SageIntacctSDKError("Error: {0}".format(response["errormessage"]))

set_session_id 

set_session_id(session_id)

Set the session id for APIs :param session_id: session id :return: None

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
109
110
111
112
113
114
115
def set_session_id(self, session_id: str):
    """
    Set the session id for APIs
    :param session_id: session id
    :return: None
    """
    self.__session_id = session_id

format_and_send_request 

format_and_send_request(data)

Format data accordingly to convert them to xml.

Parameters:

  • data (dict) –

    HTTP POST body data for the wanted API.

Returns:

  • –

    A response from the __post_request (dict).

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
def format_and_send_request(self, data: Dict):
    """Format data accordingly to convert them to xml.

    Parameters:
        data (dict): HTTP POST body data for the wanted API.

    Returns:
        A response from the __post_request (dict).
    """

    key = next(iter(data))
    timestamp = datetime.datetime.now()

    dict_body = {
        "request": {
            "control": {
                "senderid": self.__sender_id,
                "password": self.__sender_password,
                "controlid": timestamp,
                "uniqueid": False,
                "dtdversion": 3.0,
                "includewhitespace": False,
            },
            "operation": {
                "authentication": {"sessionid": self.__session_id},
                "content": {
                    "function": {"@controlid": str(uuid.uuid4()), key: data[key]}
                },
            },
        }
    }

    response = self.__post_request(dict_body, self.__api_url)
    return response["result"]

post 

post(data)
Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
282
283
284
285
286
def post(self, data: Dict):
    if self.__dimension in ("CCTRANSACTION", "EPPAYMENT"):
        return self.__construct_post_legacy_payload(data)

    return self.__construct_post_payload(data)

count 

count()
Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
298
299
300
301
302
303
304
305
306
307
308
def count(self):
    get_count = {
        "query": {
            "object": self.__dimension,
            "select": {"field": "RECORDNO"},
            "pagesize": "1",
        }
    }

    response = self.format_and_send_request(get_count)
    return int(response["data"]["@totalcount"])

read_by_query 

read_by_query(fields=None)

Read by Query from Sage Intacct

Parameters:

  • fields (list, default: None ) –

    Get selective fields to be returned. (optional).

Returns:

  • –

    Dict.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
def read_by_query(self, fields: list = None):
    """Read by Query from Sage Intacct

    Parameters:
        fields (list): Get selective fields to be returned. (optional).

    Returns:
        Dict.
    """
    payload = {
        "readByQuery": {
            "object": self.__dimension,
            "fields": ",".join(fields) if fields else "*",
            "query": None,
            "pagesize": "1000",
        }
    }

    return self.format_and_send_request(payload)

get 

get(field, value, fields=None)

Get data from Sage Intacct based on filter.

Parameters:

  • field (str) –

    A parameter to filter by the field. (required).

  • value (str) –

    A parameter to filter by the field - value. (required).

Returns:

  • –

    Dict.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
def get(self, field: str, value: str, fields: list = None):
    """Get data from Sage Intacct based on filter.

    Parameters:
        field (str): A parameter to filter by the field. (required).
        value (str): A parameter to filter by the field - value. (required).

    Returns:
        Dict.
    """
    data = {
        "readByQuery": {
            "object": self.__dimension,
            "fields": ",".join(fields) if fields else "*",
            "query": "{0} = '{1}'".format(field, value),
            "pagesize": "1000",
        }
    }

    return self.format_and_send_request(data)["data"]

get_all 

get_all(field=None, value=None, fields=None)

Get all data from Sage Intacct

Returns:

  • –

    List of Dict.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
def get_all(self, field: str = None, value: str = None, fields: list = None):
    """Get all data from Sage Intacct

    Returns:
        List of Dict.
    """
    complete_data = []
    count = self.count()
    pagesize = self.__pagesize
    for offset in range(0, count, pagesize):
        data = {
            "query": {
                "object": self.__dimension,
                "select": {
                    "field": fields
                    if fields
                    else dimensions_fields_mapping[self.__dimension]
                },
                "pagesize": pagesize,
                "offset": offset,
            }
        }

        if field and value:
            data["query"]["filter"] = {"equalto": {"field": field, "value": value}}

        paginated_data = self.format_and_send_request(data)["data"][
            self.__dimension
        ]
        complete_data.extend(paginated_data)

    return complete_data

get_by_query 

get_by_query(fields=None, and_filter=None, or_filter=None, filter_payload=None)

Get data from Sage Intacct using query method based on filter.

See sage intacct documentation here for query structures: https://developer.intacct.com/web-services/queries/

    Parameters:
        fields (str): A parameter to filter by the field. (required).
        and_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
        or_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
        filter_payload (dict): Formatted query payload in dictionary format.
        if 'between' operators is used on and_filter or or_filter field must be submitted as
        [str,str]
        if 'in' operator is used field may be submitted as [str,str,str,...]

    Returns:
        Dict.
Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
def get_by_query(
    self,
    fields: List[str] = None,
    and_filter: __query_filter = None,
    or_filter: __query_filter = None,
    filter_payload: dict = None,
):
    """Get data from Sage Intacct using query method based on filter.

    See sage intacct documentation here for query structures:
    https://developer.intacct.com/web-services/queries/

            Parameters:
                fields (str): A parameter to filter by the field. (required).
                and_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
                or_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
                filter_payload (dict): Formatted query payload in dictionary format.
                if 'between' operators is used on and_filter or or_filter field must be submitted as
                [str,str]
                if 'in' operator is used field may be submitted as [str,str,str,...]

            Returns:
                Dict.
    """

    complete_data = []
    count = self.count()
    pagesize = self.__pagesize
    offset = 0
    formatted_filter = filter_payload
    data = {
        "query": {
            "object": self.__dimension,
            "select": {
                "field": fields
                if fields
                else dimensions_fields_mapping[self.__dimension]
            },
            "pagesize": pagesize,
            "offset": offset,
        }
    }
    if and_filter and or_filter:
        formatted_filter = {"and": {}}
        for operator, field, value in and_filter:
            formatted_filter["and"].setdefault(operator, {}).update(
                {"field": field, "value": value}
            )
        formatted_filter["and"]["or"] = {}
        for operator, field, value in or_filter:
            formatted_filter["and"]["or"].setdefault(operator, {}).update(
                {"field": field, "value": value}
            )

    elif and_filter:
        if len(and_filter) > 1:
            formatted_filter = {"and": {}}
            for operator, field, value in and_filter:
                formatted_filter["and"].setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )
        else:
            formatted_filter = {}
            for operator, field, value in and_filter:
                formatted_filter.setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )
    elif or_filter:
        if len(or_filter) > 1:
            formatted_filter = {"or": {}}
            for operator, field, value in or_filter:
                formatted_filter["or"].setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )
        else:
            formatted_filter = {}
            for operator, field, value in or_filter:
                formatted_filter.setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )

    if formatted_filter:
        data["query"]["filter"] = formatted_filter

    for offset in range(0, count, pagesize):
        data["query"]["offset"] = offset
        paginated_data = self.format_and_send_request(data)["data"]
        complete_data.extend(paginated_data[self.__dimension])
        filtered_total = int(paginated_data["@totalcount"])
        if paginated_data["@numremaining"] == "0":
            break
    if filtered_total != len(complete_data):
        warn(
            message="Your data may not be complete. Records returned do not equal total query record count",
            category=DataIntegrityWarning,
            stacklevel=2,
        )
    return complete_data

get_lookup 

get_lookup()

Returns all fields with attributes from the object called on.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
485
486
487
488
489
490
491
492
493
494
495
def get_lookup(self):
    """Returns all fields with attributes from the object called on.

    Parameters:
        self
    Returns:
        Dict.
    """

    data = {"lookup": {"object": self.__dimension}}
    return self.format_and_send_request(data)["data"]

Purchasing 

Purchasing()

Bases: ApiBase

Class for Purchasing APIs.

Source code in hypha/apply/projects/services/sageintacct/wrapper/purchasing.py 
11
12
def __init__(self):
    ApiBase.__init__(self, dimension="PODOCUMENTENTRY")

set_sender_id 

set_sender_id(sender_id)

Set the sender id for APIs :param sender_id: sender id :return: None

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
42
43
44
45
46
47
48
def set_sender_id(self, sender_id: str):
    """
    Set the sender id for APIs
    :param sender_id: sender id
    :return: None
    """
    self.__sender_id = sender_id

set_sender_password 

set_sender_password(sender_password)

Set the sender password for APIs :param sender_password: sender id :return: None

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
50
51
52
53
54
55
56
def set_sender_password(self, sender_password: str):
    """
    Set the sender password for APIs
    :param sender_password: sender id
    :return: None
    """
    self.__sender_password = sender_password

get_session_id 

get_session_id(user_id, company_id, user_password, entity_id=None)

Sets the session id for APIs :param access_token: acceess token (JWT) :return: session id

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def get_session_id(
    self, user_id: str, company_id: str, user_password: str, entity_id: str = None
):
    """
    Sets the session id for APIs
    :param access_token: acceess token (JWT)
    :return: session id
    """

    timestamp = datetime.datetime.now()
    dict_body = {
        "request": {
            "control": {
                "senderid": self.__sender_id,
                "password": self.__sender_password,
                "controlid": timestamp,
                "uniqueid": False,
                "dtdversion": 3.0,
                "includewhitespace": False,
            },
            "operation": {
                "authentication": {
                    "login": {
                        "userid": user_id,
                        "companyid": company_id,
                        "password": user_password,
                        "locationid": entity_id,
                    }
                },
                "content": {
                    "function": {
                        "@controlid": str(uuid.uuid4()),
                        "getAPISession": None,
                    }
                },
            },
        }
    }

    response = self.__post_request(dict_body, self.__api_url)

    if response["authentication"]["status"] == "success":
        session_details = response["result"]["data"]["api"]
        self.__api_url = session_details["endpoint"]
        self.__session_id = session_details["sessionid"]

        return self.__session_id

    else:
        raise SageIntacctSDKError("Error: {0}".format(response["errormessage"]))

set_session_id 

set_session_id(session_id)

Set the session id for APIs :param session_id: session id :return: None

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
109
110
111
112
113
114
115
def set_session_id(self, session_id: str):
    """
    Set the session id for APIs
    :param session_id: session id
    :return: None
    """
    self.__session_id = session_id

format_and_send_request 

format_and_send_request(data)

Format data accordingly to convert them to xml.

Parameters:

  • data (dict) –

    HTTP POST body data for the wanted API.

Returns:

  • –

    A response from the __post_request (dict).

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
def format_and_send_request(self, data: Dict):
    """Format data accordingly to convert them to xml.

    Parameters:
        data (dict): HTTP POST body data for the wanted API.

    Returns:
        A response from the __post_request (dict).
    """

    key = next(iter(data))
    timestamp = datetime.datetime.now()

    dict_body = {
        "request": {
            "control": {
                "senderid": self.__sender_id,
                "password": self.__sender_password,
                "controlid": timestamp,
                "uniqueid": False,
                "dtdversion": 3.0,
                "includewhitespace": False,
            },
            "operation": {
                "authentication": {"sessionid": self.__session_id},
                "content": {
                    "function": {"@controlid": str(uuid.uuid4()), key: data[key]}
                },
            },
        }
    }

    response = self.__post_request(dict_body, self.__api_url)
    return response["result"]

post 

post(data)
Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
282
283
284
285
286
def post(self, data: Dict):
    if self.__dimension in ("CCTRANSACTION", "EPPAYMENT"):
        return self.__construct_post_legacy_payload(data)

    return self.__construct_post_payload(data)

count 

count()
Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
298
299
300
301
302
303
304
305
306
307
308
def count(self):
    get_count = {
        "query": {
            "object": self.__dimension,
            "select": {"field": "RECORDNO"},
            "pagesize": "1",
        }
    }

    response = self.format_and_send_request(get_count)
    return int(response["data"]["@totalcount"])

read_by_query 

read_by_query(fields=None)

Read by Query from Sage Intacct

Parameters:

  • fields (list, default: None ) –

    Get selective fields to be returned. (optional).

Returns:

  • –

    Dict.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
def read_by_query(self, fields: list = None):
    """Read by Query from Sage Intacct

    Parameters:
        fields (list): Get selective fields to be returned. (optional).

    Returns:
        Dict.
    """
    payload = {
        "readByQuery": {
            "object": self.__dimension,
            "fields": ",".join(fields) if fields else "*",
            "query": None,
            "pagesize": "1000",
        }
    }

    return self.format_and_send_request(payload)

get 

get(field, value, fields=None)

Get data from Sage Intacct based on filter.

Parameters:

  • field (str) –

    A parameter to filter by the field. (required).

  • value (str) –

    A parameter to filter by the field - value. (required).

Returns:

  • –

    Dict.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
def get(self, field: str, value: str, fields: list = None):
    """Get data from Sage Intacct based on filter.

    Parameters:
        field (str): A parameter to filter by the field. (required).
        value (str): A parameter to filter by the field - value. (required).

    Returns:
        Dict.
    """
    data = {
        "readByQuery": {
            "object": self.__dimension,
            "fields": ",".join(fields) if fields else "*",
            "query": "{0} = '{1}'".format(field, value),
            "pagesize": "1000",
        }
    }

    return self.format_and_send_request(data)["data"]

get_all 

get_all(field=None, value=None, fields=None)

Get all data from Sage Intacct

Returns:

  • –

    List of Dict.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
def get_all(self, field: str = None, value: str = None, fields: list = None):
    """Get all data from Sage Intacct

    Returns:
        List of Dict.
    """
    complete_data = []
    count = self.count()
    pagesize = self.__pagesize
    for offset in range(0, count, pagesize):
        data = {
            "query": {
                "object": self.__dimension,
                "select": {
                    "field": fields
                    if fields
                    else dimensions_fields_mapping[self.__dimension]
                },
                "pagesize": pagesize,
                "offset": offset,
            }
        }

        if field and value:
            data["query"]["filter"] = {"equalto": {"field": field, "value": value}}

        paginated_data = self.format_and_send_request(data)["data"][
            self.__dimension
        ]
        complete_data.extend(paginated_data)

    return complete_data

get_by_query 

get_by_query(fields=None, and_filter=None, or_filter=None, filter_payload=None)

Get data from Sage Intacct using query method based on filter.

See sage intacct documentation here for query structures: https://developer.intacct.com/web-services/queries/

    Parameters:
        fields (str): A parameter to filter by the field. (required).
        and_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
        or_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
        filter_payload (dict): Formatted query payload in dictionary format.
        if 'between' operators is used on and_filter or or_filter field must be submitted as
        [str,str]
        if 'in' operator is used field may be submitted as [str,str,str,...]

    Returns:
        Dict.
Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
def get_by_query(
    self,
    fields: List[str] = None,
    and_filter: __query_filter = None,
    or_filter: __query_filter = None,
    filter_payload: dict = None,
):
    """Get data from Sage Intacct using query method based on filter.

    See sage intacct documentation here for query structures:
    https://developer.intacct.com/web-services/queries/

            Parameters:
                fields (str): A parameter to filter by the field. (required).
                and_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
                or_filter (list(tuple)): List of tuple containing (operator (str),field (str), value (str))
                filter_payload (dict): Formatted query payload in dictionary format.
                if 'between' operators is used on and_filter or or_filter field must be submitted as
                [str,str]
                if 'in' operator is used field may be submitted as [str,str,str,...]

            Returns:
                Dict.
    """

    complete_data = []
    count = self.count()
    pagesize = self.__pagesize
    offset = 0
    formatted_filter = filter_payload
    data = {
        "query": {
            "object": self.__dimension,
            "select": {
                "field": fields
                if fields
                else dimensions_fields_mapping[self.__dimension]
            },
            "pagesize": pagesize,
            "offset": offset,
        }
    }
    if and_filter and or_filter:
        formatted_filter = {"and": {}}
        for operator, field, value in and_filter:
            formatted_filter["and"].setdefault(operator, {}).update(
                {"field": field, "value": value}
            )
        formatted_filter["and"]["or"] = {}
        for operator, field, value in or_filter:
            formatted_filter["and"]["or"].setdefault(operator, {}).update(
                {"field": field, "value": value}
            )

    elif and_filter:
        if len(and_filter) > 1:
            formatted_filter = {"and": {}}
            for operator, field, value in and_filter:
                formatted_filter["and"].setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )
        else:
            formatted_filter = {}
            for operator, field, value in and_filter:
                formatted_filter.setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )
    elif or_filter:
        if len(or_filter) > 1:
            formatted_filter = {"or": {}}
            for operator, field, value in or_filter:
                formatted_filter["or"].setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )
        else:
            formatted_filter = {}
            for operator, field, value in or_filter:
                formatted_filter.setdefault(operator, {}).update(
                    {"field": field, "value": value}
                )

    if formatted_filter:
        data["query"]["filter"] = formatted_filter

    for offset in range(0, count, pagesize):
        data["query"]["offset"] = offset
        paginated_data = self.format_and_send_request(data)["data"]
        complete_data.extend(paginated_data[self.__dimension])
        filtered_total = int(paginated_data["@totalcount"])
        if paginated_data["@numremaining"] == "0":
            break
    if filtered_total != len(complete_data):
        warn(
            message="Your data may not be complete. Records returned do not equal total query record count",
            category=DataIntegrityWarning,
            stacklevel=2,
        )
    return complete_data

get_lookup 

get_lookup()

Returns all fields with attributes from the object called on.

Source code in hypha/apply/projects/services/sageintacct/wrapper/api_base.py 
485
486
487
488
489
490
491
492
493
494
495
def get_lookup(self):
    """Returns all fields with attributes from the object called on.

    Parameters:
        self
    Returns:
        Dict.
    """

    data = {"lookup": {"object": self.__dimension}}
    return self.format_and_send_request(data)["data"]