Attachments

(accounting.attachments)

Overview

Available Operations

list - List Attachments
upload - Upload attachment
get - Get Attachment
delete - Delete Attachment
download - Download Attachment

list

List Attachments

Example Usage

import apideck_unify
from apideck_unify import Apideck
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.attachments.list(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", raw=False, service_id="salesforce", company_id="12345", limit=20, fields="id,updated_at")

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter	Type	Required	Description	Example
`reference_type`	models.AttachmentReferenceType	✔️	The reference type of the document.	invoice
`reference_id`	str	✔️	The reference id of the object to retrieve.	12345
`raw`	Optional[bool]	➖	Include raw response. Mostly used for debugging purposes
`consumer_id`	Optional[str]	➖	ID of the consumer which you want to get or push data from	test-consumer
`app_id`	Optional[str]	➖	The ID of your Unify application	dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
`service_id`	Optional[str]	➖	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	salesforce
`company_id`	Optional[str]	➖	The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.	12345
`cursor`	OptionalNullable[str]	➖	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
`limit`	Optional[int]	➖	Number of results to return. Minimum 1, Maximum 200, Default 20
`fields`	OptionalNullable[str]	➖	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	id,updated_at
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.AccountingAttachmentsAllResponse

Errors

Error Type	Status Code	Content Type
models.BadRequestResponse	400	application/json
models.UnauthorizedResponse	401	application/json
models.PaymentRequiredResponse	402	application/json
models.NotFoundResponse	404	application/json
models.UnprocessableResponse	422	application/json
models.APIError	4XX, 5XX	/

upload

Upload attachment

Example Usage

import apideck_unify
from apideck_unify import Apideck
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.attachments.upload(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", request_body=open("example.file", "rb"), raw=False, x_apideck_metadata="{\"name\":\"document.pdf\",\"description\":\"Invoice attachment\"}", service_id="salesforce")

    assert res.create_attachment_response is not None

    # Handle response
    print(res.create_attachment_response)

Parameters

Parameter	Type	Required	Description	Example
`reference_type`	models.AttachmentReferenceType	✔️	The reference type of the document.	invoice
`reference_id`	str	✔️	The reference id of the object to retrieve.	12345
`request_body`	Union[bytes, IO[bytes], io.BufferedReader]	✔️	N/A
`raw`	Optional[bool]	➖	Include raw response. Mostly used for debugging purposes
`x_apideck_metadata`	Optional[str]	➖	Metadata to attach to the attachment file (JSON string)
`consumer_id`	Optional[str]	➖	ID of the consumer which you want to get or push data from	test-consumer
`app_id`	Optional[str]	➖	The ID of your Unify application	dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
`service_id`	Optional[str]	➖	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	salesforce
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.
`server_url`	Optional[str]	➖	An optional server URL to use.	http://localhost:8080

Response

models.AccountingAttachmentsUploadResponse

Errors

Error Type	Status Code	Content Type
models.BadRequestResponse	400	application/json
models.UnauthorizedResponse	401	application/json
models.PaymentRequiredResponse	402	application/json
models.NotFoundResponse	404	application/json
models.UnprocessableResponse	422	application/json
models.APIError	4XX, 5XX	/

get

Get Attachment

Example Usage

import apideck_unify
from apideck_unify import Apideck
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.attachments.get(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="<id>", service_id="salesforce", company_id="12345", raw=False, fields="id,updated_at")

    assert res.get_attachment_response is not None

    # Handle response
    print(res.get_attachment_response)

Parameters

Parameter	Type	Required	Description	Example
`reference_type`	models.AttachmentReferenceType	✔️	The reference type of the document.	invoice
`reference_id`	str	✔️	The reference id of the object to retrieve.	12345
`id`	str	✔️	ID of the record you are acting upon.
`consumer_id`	Optional[str]	➖	ID of the consumer which you want to get or push data from	test-consumer
`app_id`	Optional[str]	➖	The ID of your Unify application	dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
`service_id`	Optional[str]	➖	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	salesforce
`company_id`	Optional[str]	➖	The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.	12345
`raw`	Optional[bool]	➖	Include raw response. Mostly used for debugging purposes
`fields`	OptionalNullable[str]	➖	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	id,updated_at
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.AccountingAttachmentsOneResponse

Errors

Error Type	Status Code	Content Type
models.BadRequestResponse	400	application/json
models.UnauthorizedResponse	401	application/json
models.PaymentRequiredResponse	402	application/json
models.NotFoundResponse	404	application/json
models.UnprocessableResponse	422	application/json
models.APIError	4XX, 5XX	/

delete

Delete Attachment

Example Usage

import apideck_unify
from apideck_unify import Apideck
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.attachments.delete(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="<id>", service_id="salesforce", raw=False)

    assert res.delete_attachment_response is not None

    # Handle response
    print(res.delete_attachment_response)

Parameters

Parameter	Type	Required	Description	Example
`reference_type`	models.AttachmentReferenceType	✔️	The reference type of the document.	invoice
`reference_id`	str	✔️	The reference id of the object to retrieve.	12345
`id`	str	✔️	ID of the record you are acting upon.
`consumer_id`	Optional[str]	➖	ID of the consumer which you want to get or push data from	test-consumer
`app_id`	Optional[str]	➖	The ID of your Unify application	dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
`service_id`	Optional[str]	➖	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	salesforce
`raw`	Optional[bool]	➖	Include raw response. Mostly used for debugging purposes
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.AccountingAttachmentsDeleteResponse

Errors

Error Type	Status Code	Content Type
models.BadRequestResponse	400	application/json
models.UnauthorizedResponse	401	application/json
models.PaymentRequiredResponse	402	application/json
models.NotFoundResponse	404	application/json
models.UnprocessableResponse	422	application/json
models.APIError	4XX, 5XX	/

download

Download Attachment

Example Usage

import apideck_unify
from apideck_unify import Apideck
import os


with Apideck(
    consumer_id="test-consumer",
    app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    api_key=os.getenv("APIDECK_API_KEY", ""),
) as apideck:

    res = apideck.accounting.attachments.download(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="<id>", service_id="salesforce", company_id="12345", fields="id,updated_at")

    assert res.get_attachment_download_response is not None

    # Handle response
    print(res.get_attachment_download_response)

Parameters

Parameter	Type	Required	Description	Example
`reference_type`	models.AttachmentReferenceType	✔️	The reference type of the document.	invoice
`reference_id`	str	✔️	The reference id of the object to retrieve.	12345
`id`	str	✔️	ID of the record you are acting upon.
`consumer_id`	Optional[str]	➖	ID of the consumer which you want to get or push data from	test-consumer
`app_id`	Optional[str]	➖	The ID of your Unify application	dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
`service_id`	Optional[str]	➖	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	salesforce
`company_id`	Optional[str]	➖	The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.	12345
`fields`	OptionalNullable[str]	➖	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	id,updated_at
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.AccountingAttachmentsDownloadResponse

Errors

Error Type	Status Code	Content Type
models.BadRequestResponse	400	application/json
models.UnauthorizedResponse	401	application/json
models.PaymentRequiredResponse	402	application/json
models.NotFoundResponse	404	application/json
models.UnprocessableResponse	422	application/json
models.APIError	4XX, 5XX	/

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Attachments

Overview

Available Operations

list

Example Usage

Parameters

Response

Errors

upload

Example Usage

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

delete

Example Usage

Parameters

Response

Errors

download

Example Usage

Parameters

Response

Errors

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Attachments

Overview

Available Operations

list

Example Usage

Parameters

Response

Errors

upload

Example Usage

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

delete

Example Usage

Parameters

Response

Errors

download

Example Usage

Parameters

Response

Errors