Skip to content

Latest commit

 

History

History
96 lines (68 loc) · 3.51 KB

PhoneNumbersApi.md

File metadata and controls

96 lines (68 loc) · 3.51 KB

MergeAccountingClient.PhoneNumbersApi

All URIs are relative to https://api.merge.dev/api/accounting/v1

Method HTTP request Description
phone_numbers_retrieve GET /phone-numbers/{id}

phone_numbers_retrieve

AccountingPhoneNumber phone_numbers_retrieve(x_account_token, id)

Returns an AccountingPhoneNumber object with the given id.

Example

  • Api Key Authentication (tokenAuth):
import time
import MergeAccountingClient
from MergeAccountingClient.api import phone_numbers_api
from MergeAccountingClient.model.accounting_phone_number import AccountingPhoneNumber
from pprint import pprint
# Defining the host is optional and defaults to https://api.merge.dev/api/accounting/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = MergeAccountingClient.Configuration(
    host = "https://api.merge.dev/api/accounting/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with MergeAccountingClient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phone_numbers_api.PhoneNumbersApi(api_client)
    x_account_token = "X-Account-Token_example" # str | Token identifying the end user.
    id = "id_example" # str | 
    include_remote_data = True # bool | Whether to include the original data Merge fetched from the third-party to produce these models. (optional)

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.phone_numbers_retrieve(x_account_token, id)
        pprint(api_response)
    except MergeAccountingClient.ApiException as e:
        print("Exception when calling PhoneNumbersApi->phone_numbers_retrieve: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.phone_numbers_retrieve(x_account_token, id, include_remote_data=include_remote_data)
        pprint(api_response)
    except MergeAccountingClient.ApiException as e:
        print("Exception when calling PhoneNumbersApi->phone_numbers_retrieve: %s\n" % e)

Parameters

Name Type Description Notes
x_account_token str Token identifying the end user.
id str
include_remote_data bool Whether to include the original data Merge fetched from the third-party to produce these models. [optional]

Return type

AccountingPhoneNumber

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -

[Back to top] [Back to API list] [Back to Model list] [Back to README]