Codat.Sync.Payroll 3.0.0

Sync for Payroll

Push payroll to accounting platforms.

SDK Installation

Nuget

dotnet add package Codat.Sync.Payroll

Example Usage

SDK Example Usage

Example

using Codat.Sync.Payroll;
using Codat.Sync.Payroll.Models.Shared;
using System.Collections.Generic;

var sdk = new CodatSyncPayroll(security: new Security() {
        AuthHeader = "Basic BASE_64_ENCODED(API_KEY)",
    });

CompanyRequestBody req = new CompanyRequestBody() {
    Description = "Requested early access to the new financing scheme.",
    Name = "Bank of Dave",
};

var res = await sdk.Companies.CreateAsync(req);

// handle response

Available Resources and Operations

Companies

• Create - Create company
• Delete - Delete a company
• Get - Get company
• List - List companies
• Update - Update company

Connections

• Create - Create connection
• Delete - Delete connection
• Get - Get connection
• List - List connections
• Unlink - Unlink connection

Accounts

• Create - Create account
• Get - Get account
• GetCreateModel - Get create account model
• List - List accounts

JournalEntries

• Create - Create journal entry
• Delete - Delete journal entry
• Get - Get journal entry
• GetCreateModel - Get create journal entry model
• List - List journal entries

Journals

• Create - Create journal
• Get - Get journal
• GetCreateModel - Get create journal model
• List - List journals

ManageData

• GetDataStatus - Get data status
• GetPullOperation - Get pull operation
• GetPushOperation - Get push operation
• List - List push operations
• ListPullOperations - List pull operations
• RefreshAllDataTypes - Refresh all data
• RefreshDataType - Refresh data type

CompanyInfo

• GetAccountingProfile - Get company accounting profile

TrackingCategories

• Get - Get tracking categories
• List - List tracking categories

Server Selection

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIndex: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverUrl: str optional parameter when initializing the SDK client instance. For example:

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

using Codat.Sync.Payroll;
using Codat.Sync.Payroll.Models.Shared;
using System.Collections.Generic;

var sdk = new CodatSyncPayroll(security: new Security() {
        AuthHeader = "Basic BASE_64_ENCODED(API_KEY)",
    });

CompanyRequestBody req = new CompanyRequestBody() {
    Description = "Requested early access to the new financing scheme.",
    Name = "Bank of Dave",
};

var res = await sdk.Companies.CreateAsync(req);

// handle response

Support

If you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. You can raise any issues by contacting your dedicated Codat representative or reaching out to our support team. We're here to help ensure a smooth experience for you.

Library generated by Speakeasy