Skip to content

Latest commit

 

History

History
218 lines (158 loc) · 13.3 KB

README.md

File metadata and controls

218 lines (158 loc) · 13.3 KB

Attachments

(Accounting.Attachments)

Overview

Available Operations

List

List Attachments

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;
using ApideckUnifySdk.Models.Requests;

var sdk = new Apideck(
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
    consumerId: "test-consumer",
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"
);

AccountingAttachmentsAllRequest req = new AccountingAttachmentsAllRequest() {
    ReferenceType = AttachmentReferenceType.Invoice,
    ReferenceId = "12345",
    ServiceId = "salesforce",
    Fields = "id,updated_at",
};

AccountingAttachmentsAllResponse? res = await sdk.Accounting.Attachments.ListAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

Parameter Type Required Description
request AccountingAttachmentsAllRequest ✔️ The request object to use for the request.

Response

AccountingAttachmentsAllResponse

Errors

Error Type Status Code Content Type
ApideckUnifySdk.Models.Errors.BadRequestResponse 400 application/json
ApideckUnifySdk.Models.Errors.UnauthorizedResponse 401 application/json
ApideckUnifySdk.Models.Errors.PaymentRequiredResponse 402 application/json
ApideckUnifySdk.Models.Errors.NotFoundResponse 404 application/json
ApideckUnifySdk.Models.Errors.UnprocessableResponse 422 application/json
ApideckUnifySdk.Models.Errors.APIException 4XX, 5XX */*

Get

Get Attachment

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;
using ApideckUnifySdk.Models.Requests;

var sdk = new Apideck(
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
    consumerId: "test-consumer",
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"
);

AccountingAttachmentsOneRequest req = new AccountingAttachmentsOneRequest() {
    ReferenceType = AttachmentReferenceType.Invoice,
    ReferenceId = "12345",
    Id = "<id>",
    ServiceId = "salesforce",
    Fields = "id,updated_at",
};

var res = await sdk.Accounting.Attachments.GetAsync(req);

// handle response

Parameters

Parameter Type Required Description
request AccountingAttachmentsOneRequest ✔️ The request object to use for the request.

Response

AccountingAttachmentsOneResponse

Errors

Error Type Status Code Content Type
ApideckUnifySdk.Models.Errors.BadRequestResponse 400 application/json
ApideckUnifySdk.Models.Errors.UnauthorizedResponse 401 application/json
ApideckUnifySdk.Models.Errors.PaymentRequiredResponse 402 application/json
ApideckUnifySdk.Models.Errors.NotFoundResponse 404 application/json
ApideckUnifySdk.Models.Errors.UnprocessableResponse 422 application/json
ApideckUnifySdk.Models.Errors.APIException 4XX, 5XX */*

Delete

Delete Attachment

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;
using ApideckUnifySdk.Models.Requests;

var sdk = new Apideck(
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
    consumerId: "test-consumer",
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"
);

AccountingAttachmentsDeleteRequest req = new AccountingAttachmentsDeleteRequest() {
    ReferenceType = AttachmentReferenceType.Invoice,
    ReferenceId = "12345",
    Id = "<id>",
    ServiceId = "salesforce",
};

var res = await sdk.Accounting.Attachments.DeleteAsync(req);

// handle response

Parameters

Parameter Type Required Description
request AccountingAttachmentsDeleteRequest ✔️ The request object to use for the request.

Response

AccountingAttachmentsDeleteResponse

Errors

Error Type Status Code Content Type
ApideckUnifySdk.Models.Errors.BadRequestResponse 400 application/json
ApideckUnifySdk.Models.Errors.UnauthorizedResponse 401 application/json
ApideckUnifySdk.Models.Errors.PaymentRequiredResponse 402 application/json
ApideckUnifySdk.Models.Errors.NotFoundResponse 404 application/json
ApideckUnifySdk.Models.Errors.UnprocessableResponse 422 application/json
ApideckUnifySdk.Models.Errors.APIException 4XX, 5XX */*

Download

Download Attachment

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;
using ApideckUnifySdk.Models.Requests;

var sdk = new Apideck(
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
    consumerId: "test-consumer",
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"
);

AccountingAttachmentsDownloadRequest req = new AccountingAttachmentsDownloadRequest() {
    ReferenceType = AttachmentReferenceType.Invoice,
    ReferenceId = "12345",
    Id = "<id>",
    ServiceId = "salesforce",
    Fields = "id,updated_at",
};

var res = await sdk.Accounting.Attachments.DownloadAsync(req);

// handle response

Parameters

Parameter Type Required Description
request AccountingAttachmentsDownloadRequest ✔️ The request object to use for the request.

Response

AccountingAttachmentsDownloadResponse

Errors

Error Type Status Code Content Type
ApideckUnifySdk.Models.Errors.BadRequestResponse 400 application/json
ApideckUnifySdk.Models.Errors.UnauthorizedResponse 401 application/json
ApideckUnifySdk.Models.Errors.PaymentRequiredResponse 402 application/json
ApideckUnifySdk.Models.Errors.NotFoundResponse 404 application/json
ApideckUnifySdk.Models.Errors.UnprocessableResponse 422 application/json
ApideckUnifySdk.Models.Errors.APIException 4XX, 5XX */*