Module apideck.accounting

ballerinax/apideck.accounting Ballerina library

1.5.2

Overview

The Apideck Accounting API v5.3.0 connector(https://docs.apideck.com/apis/accounting/reference) OpenAPI specification.

You can use this API to access all Accounting API endpoints.

Key Features

Programmatic access to create and manage resources via REST API
Manage user accounts and profiles
Secure authentication with API key or OAuth support

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Create a Apideck account
Obtain tokens by following this guide

Clients

apideck.accounting: Client

Isolated

This is a generated connector from Apideck Accounting API v5.3.0 OpenAPI specification. You can use this API to access all Accounting API endpoints.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Unify API accounts have sandbox mode and live mode API keys. To change modes just use the appropriate key to get a live or test object. You can find your API keys on the unify settings of your Apideck app.Your Apideck application_id can also be found on the same page. Obtain API keys following this guide.

init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)

apiKeyConfig ApiKeysConfig - API keys for authorization

config ConnectionConfig {} - The configurations to be used when initializing the connector

serviceUrl string "https://unify.apideck.com" - URL of the target service

companiesAll

Isolated FunctionRemote Function

function companiesAll(string xApideckConsumerId, string xApideckAppId, boolean raw, string? xApideckServiceId, string? cursor, int 'limit) returns GetCompaniesResponse|error

List Companies

Parameters

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

cursor string? (default ()) - Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

'limit int (default 20) - Number of records to return

Return Type

GetCompaniesResponse|error - Company

companiesAdd

Isolated FunctionRemote Function

function companiesAdd(string xApideckConsumerId, string xApideckAppId, Company payload, boolean raw, string? xApideckServiceId) returns CreateCompanyResponse|error

Create Company

Parameters

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

payload Company - A record of type Company which contains details to create company.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

Return Type

CreateCompanyResponse|error - Companies

companiesOne

Isolated FunctionRemote Function

function companiesOne(string id, string xApideckConsumerId, string xApideckAppId, string? xApideckServiceId, boolean raw) returns GetCompanyResponse|error

Get Company

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

GetCompanyResponse|error - Companies

companiesDelete

Isolated FunctionRemote Function

function companiesDelete(string id, string xApideckConsumerId, string xApideckAppId, string? xApideckServiceId, boolean raw) returns DeleteCompanyResponse|error

Delete Company

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

DeleteCompanyResponse|error - Companies

companiesUpdate

Isolated FunctionRemote Function

function companiesUpdate(string id, string xApideckConsumerId, string xApideckAppId, Company payload, string? xApideckServiceId, boolean raw) returns UpdateCompanyResponse|error

Update Company

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

payload Company - A record of type Company which contains details to update company.

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

UpdateCompanyResponse|error - Companies

contactsAll

Isolated FunctionRemote Function

function contactsAll(string xApideckConsumerId, string xApideckAppId, boolean raw, string? xApideckServiceId, string? cursor, int 'limit) returns GetContactsResponse|error

List Contacts

Parameters

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

cursor string? (default ()) - Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

'limit int (default 20) - Number of records to return

Return Type

GetContactsResponse|error - Contacts

contactsAdd

Isolated FunctionRemote Function

function contactsAdd(string xApideckConsumerId, string xApideckAppId, Contact payload, boolean raw, string? xApideckServiceId) returns CreateContactResponse|error

Create Contact

Parameters

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

payload Contact - A record of type Contact which contains details to create contact.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

Return Type

CreateContactResponse|error - Contacts

contactsOne

Isolated FunctionRemote Function

function contactsOne(string id, string xApideckConsumerId, string xApideckAppId, string? xApideckServiceId, boolean raw) returns GetContactResponse|error

Get Contact

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

GetContactResponse|error - Contacts

contactsDelete

Isolated FunctionRemote Function

function contactsDelete(string id, string xApideckConsumerId, string xApideckAppId, string? xApideckServiceId, boolean raw) returns DeleteContactResponse|error

Delete Contact

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

DeleteContactResponse|error - Contacts

contactsUpdate

Isolated FunctionRemote Function

function contactsUpdate(string id, string xApideckConsumerId, string xApideckAppId, Contact payload, string? xApideckServiceId, boolean raw) returns UpdateContactResponse|error

Update Contact

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

payload Contact - A record of type Contact which contains details to update contact.

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

UpdateContactResponse|error - Contacts

invoicesAll

Isolated FunctionRemote Function

function invoicesAll(string xApideckConsumerId, string xApideckAppId, boolean raw, string? xApideckServiceId, string? cursor, int 'limit) returns GetInvoicesResponse|error

List Invoices

Parameters

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

cursor string? (default ()) - Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

'limit int (default 20) - Number of records to return

Return Type

GetInvoicesResponse|error - Invoices

invoicesAdd

Isolated FunctionRemote Function

function invoicesAdd(string xApideckConsumerId, string xApideckAppId, Invoice payload, boolean raw, string? xApideckServiceId) returns CreateInvoiceResponse|error

Create Invoice

Parameters

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

payload Invoice - A record of type Invoice which contains details to create invoice.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

Return Type

CreateInvoiceResponse|error - Invoices

invoicesOne

Isolated FunctionRemote Function

function invoicesOne(string id, string xApideckConsumerId, string xApideckAppId, string? xApideckServiceId, boolean raw) returns GetInvoiceResponse|error

Get Invoice

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

GetInvoiceResponse|error - Invoices

invoicesDelete

Isolated FunctionRemote Function

function invoicesDelete(string id, string xApideckConsumerId, string xApideckAppId, string? xApideckServiceId, boolean raw) returns DeleteInvoiceResponse|error

Delete Invoice

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

DeleteInvoiceResponse|error - Invoices

invoicesUpdate

Isolated FunctionRemote Function

function invoicesUpdate(string id, string xApideckConsumerId, string xApideckAppId, Invoice payload, string? xApideckServiceId, boolean raw) returns UpdateInvoiceResponse|error

Update Invoice

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

payload Invoice - A record of type Invoice which contains details to update invoice.

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

UpdateInvoiceResponse|error - Invoices

ledgerAccountsAll

Isolated FunctionRemote Function

function ledgerAccountsAll(string xApideckConsumerId, string xApideckAppId, boolean raw, string? xApideckServiceId, string? cursor, int 'limit) returns GetLedgerAccountsResponse|error

List Ledger Accounts

Parameters

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

cursor string? (default ()) - Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

'limit int (default 20) - Number of records to return

Return Type

GetLedgerAccountsResponse|error - LedgerAccounts

ledgerAccountsAdd

Isolated FunctionRemote Function

function ledgerAccountsAdd(string xApideckConsumerId, string xApideckAppId, LedgerAccount payload, boolean raw, string? xApideckServiceId) returns CreateLedgerAccountResponse|error

Create Ledger Account

Parameters

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

payload LedgerAccount - A record of type LedgerAccount which contains details to create ledger account.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

Return Type

CreateLedgerAccountResponse|error - LedgerAccounts

ledgerAccountsOne

Isolated FunctionRemote Function

function ledgerAccountsOne(string id, string xApideckConsumerId, string xApideckAppId, string? xApideckServiceId, boolean raw) returns GetLedgerAccountResponse|error

Get Ledger Account

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

GetLedgerAccountResponse|error - LedgerAccounts

ledgerAccountsDelete

Isolated FunctionRemote Function

function ledgerAccountsDelete(string id, string xApideckConsumerId, string xApideckAppId, string? xApideckServiceId, boolean raw) returns DeleteLedgerAccountResponse|error

Delete Ledger Account

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

DeleteLedgerAccountResponse|error - LedgerAccounts

ledgerAccountsUpdate

Isolated FunctionRemote Function

function ledgerAccountsUpdate(string id, string xApideckConsumerId, string xApideckAppId, LedgerAccount payload, string? xApideckServiceId, boolean raw) returns UpdateLedgerAccountResponse|error

Update Ledger Account

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

payload LedgerAccount - A record of type LedgerAccount which contains details to update ledger account.

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

UpdateLedgerAccountResponse|error - LedgerAccounts

taxRatesAll

Isolated FunctionRemote Function

function taxRatesAll(string xApideckConsumerId, string xApideckAppId, boolean raw, string? xApideckServiceId, string? cursor, int 'limit) returns GetTaxRatesResponse|error

List Tax Rates

Parameters

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

cursor string? (default ()) - Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

'limit int (default 20) - Number of records to return

Return Type

GetTaxRatesResponse|error - TaxRates

taxRatesAdd

Isolated FunctionRemote Function

function taxRatesAdd(string xApideckConsumerId, string xApideckAppId, TaxRate payload, boolean raw, string? xApideckServiceId) returns CreateTaxRateResponse|error

Create Tax Rate

Parameters

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

payload TaxRate - A record of type TaxRate which contains details to create tax rate.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

Return Type

CreateTaxRateResponse|error - TaxRates

taxRatesOne

Isolated FunctionRemote Function

function taxRatesOne(string id, string xApideckConsumerId, string xApideckAppId, string? xApideckServiceId, boolean raw) returns GetTaxRateResponse|error

Get Tax Rate

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

GetTaxRateResponse|error - TaxRates

taxRatesDelete

Isolated FunctionRemote Function

function taxRatesDelete(string id, string xApideckConsumerId, string xApideckAppId, string? xApideckServiceId, boolean raw) returns DeleteTaxRateResponse|error

Delete Tax Rate

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

DeleteTaxRateResponse|error - TaxRates

taxRatesUpdate

Isolated FunctionRemote Function

function taxRatesUpdate(string id, string xApideckConsumerId, string xApideckAppId, TaxRate payload, string? xApideckServiceId, boolean raw) returns UpdateTaxRateResponse|error

Update Tax Rate

Parameters

id string - ID of the record you are acting upon.

xApideckConsumerId string - ID of the consumer which you want to get or push data from

xApideckAppId string - The ID of your Unify application

payload TaxRate - A record of type TaxRate which contains details to update tax rate.

xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.

raw boolean (default true) - Include raw response. Mostly used for debugging purposes

Return Type

UpdateTaxRateResponse|error - TaxRates

Records

apideck.accounting: Address

Fields

city? string? - Name of city.

country? string? - country code according to ISO 3166-1 alpha-2.

id? string? -

latitude? string? -

line1? string? - Line 1 of the address e.g. number, street, suite, apt #, etc.

line2? string? - Line 2 of the address

longitude? string? -

name? string? -

postal_code? string? - Zip code or equivalent.

state? string? - Name of state

'string? string? -

'type? string -

apideck.accounting: ApiKeysConfig

Closed record

Provides API key configurations needed when communicating with a remote HTTP endpoint.

Fields

authorization string - To use API you have to sign up and get your own API key. Unify API accounts have sandbox mode and live mode API keys. To change modes just use the appropriate key to get a live or test object. You can find your API keys on the unify settings of your Apideck app. Your Apideck application_id can also be found on the same page. Authenticate your API requests by including your test or live secret API key in the request header.
- Bearer authorization header: Authorization: Bearer <your-apideck-api-key>
- Application id header: x-apideck-app-id: <your-apideck-app-id>
You should use the public keys on the SDKs and the secret keys to authenticate API requests. Do not share or include your secret API keys on client side code. Your API keys carry significant privileges. Please ensure to keep them 100% secure and be sure to not share your secret API keys in areas that are publicly accessible like GitHub. Learn how to set the Authorization header inside Postman https://learning.postman.com/docs/postman/sending-api-requests/authorization/#api-key Go to Unify to grab your API KEY https://app.apideck.com/unify/api-keys

apideck.accounting: BankAccount

Fields

account_name? string? - The name which you used in opening your bank account.

account_number? string? - A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number.

bank_code? string? - A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.

bic? string? -

bsb_number? string? - A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution.

iban? string? -

apideck.accounting: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields

keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests

chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

proxy? ProxyConfig - Proxy server related options

apideck.accounting: Company

Fields

abn_branch? string? - An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity.

abn_or_tfn? string? - An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia.

acn? string? - The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank.

addresses? Address[] -

annual_revenue? string? - Annual revenue

bank_accounts? BankAccount[] -

created_at? string -

created_by? string? -

currency? string? -

custom_fields? CustomField[] -

deleted? boolean -

description? string? -

emails? Email[] -

fax? string? -

id? string -

image? string? -

industry? string? - Industry

interaction_count? int? -

last_activity_at? string? -

name string -

number_of_employees? string? - Number of employees

owner_id? string -

ownership? string? - Ownership

parent_id? string - Parent ID

payee_number? string? -

phone_numbers? PhoneNumber[] -

read_only? boolean? -

sales_tax_number? string? -

social_links? SocialLink[] -

status? string? -

tags? Tags -

updated_at? string -

updated_by? string? -

vat_number? string? - VAT number

websites? Website[] -

apideck.accounting: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol

http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol

timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache? CacheConfig - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

apideck.accounting: Contact

Fields

active? boolean? -

addresses? Address[] -

birthday? string? -

company_id? string? -

company_name? string? -

created_at? string -

current_balance? decimal? -

custom_fields? CustomField[] -

department? string? -

description? string? -

emails? Email[] -

fax? string? -

first_call_at? string? -

first_email_at? string? -

first_name? string? -

gender? string? -

id? string -

image? string? -

language? string? - language code according to ISO 639-1. For the United States - EN

last_activity_at? string? -

last_name? string? -

lead_id? string? -

lead_source? string? -

middle_name? string? -

name string -

owner_id? string? -

phone_numbers? PhoneNumber[] -

prefix? string? -

social_links? SocialLink[] -

status? string? -

suffix? string? -

tags? Tags -

title? string? -

'type? string? -

updated_at? string -

websites? Website[] -

apideck.accounting: CreateCompanyResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: CreateContactResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: CreateInvoiceResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: CreateLedgerAccountResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: CreateTaxRateResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: Customer

The customer this invoice is linked to.

Fields

company_name? string? - The company name.

id? Id - The unique Id.

apideck.accounting: CustomField

Fields

id string -

value? string?|decimal?|boolean?|string[] -

apideck.accounting: DeleteCompanyResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: DeleteContactResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: DeleteInvoiceResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: DeleteLedgerAccountResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: DeleteTaxRateResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: Email

Fields

email string -

id? string -

'type? string -

apideck.accounting: GetCompaniesResponse

Fields

data Company[] -

links? Links - Links to navigate to previous or next pages through the API

meta? Meta - Reponse metadata

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: GetCompanyResponse

Fields

data Company -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: GetContactResponse

Fields

data Contact -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: GetContactsResponse

Fields

data Contact[] -

links? Links - Links to navigate to previous or next pages through the API

meta? Meta - Reponse metadata

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: GetInvoiceResponse

Fields

data Invoice -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: GetInvoicesResponse

Fields

data Invoice[] -

links? Links - Links to navigate to previous or next pages through the API

meta? Meta - Reponse metadata

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: GetLedgerAccountResponse

Fields

data LedgerAccount -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: GetLedgerAccountsResponse

Fields

data LedgerAccount[] -

links? Links - Links to navigate to previous or next pages through the API

meta? Meta - Reponse metadata

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: GetTaxRateResponse

Fields

data TaxRate -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: GetTaxRatesResponse

Fields

data TaxRate[] -

links? Links - Links to navigate to previous or next pages through the API

meta? Meta - Reponse metadata

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: InlineResponse400

Fields

detail? string|record {} - Contains parameter or domain specific information related to the error and why it occured.

'error? string - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)

message? string - A human-readable message providing more details about the error.

ref? string - Link to documentation of error type

status_code? decimal - HTTP status code

type_name? string - The type of error returned

apideck.accounting: InlineResponse401

Fields

detail? string - Contains parameter or domain specific information related to the error and why it occured.

'error? string - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)

message? string - A human-readable message providing more details about the error.

ref? string - Link to documentation of error type

status_code? decimal - HTTP status code

type_name? string - The type of error returned

apideck.accounting: InlineResponse402

Fields

detail? string - Contains parameter or domain specific information related to the error and why it occured.

'error? string - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)

message? string - A human-readable message providing more details about the error.

ref? string - Link to documentation of error type

status_code? decimal - HTTP status code

type_name? string - The type of error returned

apideck.accounting: InlineResponse404

Fields

detail? string|record {} - Contains parameter or domain specific information related to the error and why it occured.

'error? string - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)

message? string - A human-readable message providing more details about the error.

ref? string - Link to documentation of error type

status_code? decimal - HTTP status code

type_name? string - The type of error returned

apideck.accounting: InlineResponse422

Fields

detail? string - Contains parameter or domain specific information related to the error and why it occured.

'error? string - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)

message? string - A human-readable message providing more details about the error.

ref? string - Link to documentation of error type

status_code? decimal - HTTP status code

type_name? string - The type of error returned

apideck.accounting: InlineResponseDefault

Fields

detail? string|record {} - Contains parameter or domain specific information related to the error and why it occured.

'error? string - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)

message? string - A human-readable message providing more details about the error.

ref? string - Link to documentation of error type

status_code? decimal - HTTP status code

type_name? string - The type of error returned

apideck.accounting: Invoice

Fields

balance? decimal? -

billing_address? Address -

created_at? CreatedAt -

created_by? CreatedBy? -

currency? Currency? - Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

customer? Customer? - The customer this invoice is linked to.

customer_memo? string? -

date? string - Date invoice was issued - YYYY-MM-DD

deposit? decimal? -

due_date? string - The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD

id? Id - The unique Id.

line_items? InvoiceLineItems[] -

number? string? -

po_number? string? - A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.

shipping_address? Address -

status? string? - Invoice status

sub_total? decimal? -

total? decimal? -

total_tax? decimal? -

'type? string? -

updated_at? UpdatedAt -

updated_by? UpdatedBy? -

apideck.accounting: InvoiceGeneralLedgerAccount

Fields

id? Id - The unique Id.

name? string? -

apideck.accounting: InvoiceLineItems

Fields

description? string? -

discount_percentage? int? -

general_ledger_account? InvoiceGeneralLedgerAccount -

id? Id - The unique Id.

item_id? int? - ID of the linked item

line_number? int? -

quantity? int? -

tax_amount? int? -

tax_rate? InvoiceTaxRate -

total_amount? int? -

'type? string? -

unit_price? int? -

apideck.accounting: InvoiceTaxRate

Fields

code? string? -

id? Id - The unique Id.

name? string? -

apideck.accounting: Lead

Fields

addresses? Address[] -

company_id? string? -

company_name string? -

contact_id? string? -

created_at? string -

currency? string? -

custom_fields? CustomField[] -

description? string? -

emails? Email[] -

fax? string? -

first_name? string? -

id? string -

language? string? - language code according to ISO 639-1. For the United States - EN

last_name? string? -

lead_source? string? -

monetary_amount? decimal? -

name string -

owner_id? string -

phone_numbers? PhoneNumber[] -

prefix? string? -

social_links? SocialLink[] -

status? string? -

tags? Tags -

title? string? -

updated_at? string -

websites? Website[] -

apideck.accounting: LedgerAccount

Fields

active? boolean? -

bank_account? BankAccount -

classification? string? -

created_at? CreatedAt -

created_by? CreatedBy? -

currency? Currency? - Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

current_balance? decimal? - The current balance. A positive integer representing the smallest currency unit (e.g., 20000 cents equals $200.00 or 20000 equals ¥20000, a zero-decimal currency)

description? string? -

display_id? string -

fully_qualified_name? string? -

id? Id - The unique Id.

last_reconciliation_date? string - Reconciliation Date means the last calendar day of each Reconciliation Period.

level? string? -

name? string? -

nominal_code? string? -

opening_balance? decimal? - The opening balance. A positive integer representing the smallest currency unit (e.g., 100 cents equals $1.00 or 100 equals ¥100, a zero-decimal currency)

parent_account? LedgeraccountParentAccount -

sub_account? boolean? -

sub_accounts? LedgeraccountSubAccounts[] -

sub_type? string? -

tax_code? string? -

tax_type? string? -

'type? string? -

updated_at? UpdatedAt -

updated_by? UpdatedBy? -

apideck.accounting: LedgeraccountParentAccount

Fields

display_id? string -

id? string -

name? string -

apideck.accounting: LedgeraccountSubAccounts

Fields

account_sub_name? string -

id? string -

apideck.accounting: Links

Links to navigate to previous or next pages through the API

Fields

current? string - Link to navigate to the current page through the API

next? string? - Link to navigate to the previous page through the API

previous? string? - Link to navigate to the previous page through the API

apideck.accounting: Meta

Reponse metadata

Fields

cursors? MetaCursors - Cursors to navigate to previous or next pages through the API

items_on_page? int - Number of items returned in the data property of the response

apideck.accounting: MetaCursors

Cursors to navigate to previous or next pages through the API

Fields

current? string? - Cursor to navigate to the current page of results through the API

next? string? - Cursor to navigate to the next page of results through the API

previous? string? - Cursor to navigate to the previous page of results through the API

apideck.accounting: Opportunity

Fields

close_date? string? -

company_id? string? -

company_name? string? -

contact_id? string? -

created_at? string -

created_by? string? -

currency? string? -

custom_fields? CustomField[] -

date_last_contacted? string? -

date_lead_created? string? -

date_stage_changed? string? -

deleted? boolean -

description? string? -

expected_revenue? decimal? - Expected Revenue

id? string -

interaction_count? decimal? -

last_activity_at? string? -

lead_id? string? -

lead_source? string? - Lead source

loss_reason? string? -

loss_reason_id? string? -

monetary_amount? decimal? -

owner_id? string? -

pipeline_id? string? -

pipeline_stage_id? string? -

primary_contact_id string? -

priority? string? -

source_id? string? -

stage_last_changed_at? string? -

status? string? -

status_id? string? -

tags? Tags -

title string -

'type? string? -

updated_at? string -

updated_by? string? -

win_probability? decimal? -

won_reason? string? -

won_reason_id? string? -

apideck.accounting: PhoneNumber

Fields

id? string? -

number string -

'type? string -

apideck.accounting: Pipeline

Fields

archived? boolean -

created_at? string -

currency? string -

display_order? int -

id? string -

name string -

stages? PipelineStages[] -

updated_at? string -

apideck.accounting: PipelineStages

Fields

display_order? int -

id? string -

name? string -

value? string -

apideck.accounting: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields

host string(default "") - Host name of the proxy server

port int(default 0) - Proxy server port

userName string(default "") - Proxy server username

password string(default "") - Proxy server password

apideck.accounting: SocialLink

Fields

id? string? -

'type? string? -

url string -

apideck.accounting: TaxRate

Fields

active? boolean? -

code? string? -

components? TaxrateComponents[]? -

created_at? CreatedAt -

created_by? CreatedBy? -

description? string? -

effective_tax_rate? decimal? -

id? Id - The unique Id.

name? string -

original_tax_rate_id? string? - ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities.

special_tax_type? string? - Special tax type to handle zero rate taxes. Used with VAT registered Businesses who receive goods/services (acquisitions) from other EU countries, will need to calculate the VAT due, but not paid, on these acquisitions. The rate of VAT payable is the same that would have been paid if the goods had been supplied by a UK supplier.

total_tax_rate? decimal? - Not compounded sum of the components of a tax rate

updated_at? UpdatedAt -

updated_by? UpdatedBy? -

apideck.accounting: TaxrateComponents

Fields

compound? boolean? -

name? string -

rate? decimal? -

apideck.accounting: UnifiedId

Fields

id string -

apideck.accounting: UpdateCompanyResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: UpdateContactResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: UpdateInvoiceResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: UpdateLedgerAccountResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: UpdateTaxRateResponse

Fields

data UnifiedId -

operation string - Operation performed

'resource string - Unified API resource name

'service string - Apideck ID of service provider

status string - HTTP Response Status

status_code int - HTTP Response Status Code

apideck.accounting: User

Fields

created_at? string -

email string -

first_name? string? -

id? string -

image? string? -

language? string? -

last_name? string? -

parent_id? string? -

password? string -

status? string? -

updated_at? string -

username? string? -

apideck.accounting: Website

Fields

id? string? -

'type? string -

url string -

Array types

apideck.accounting: Tags

string[]

String types

apideck.accounting: CreatedAt

string

CreatedAt

apideck.accounting: UpdatedBy

string?

UpdatedBy

apideck.accounting: Currency

string?

Currency

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

apideck.accounting: CreatedBy

string?

CreatedBy

apideck.accounting: Id

string

The unique Id.

apideck.accounting: UpdatedAt

string

UpdatedAt

Import

import ballerinax/apideck.accounting;

Other versions

1.5.2

1.5.1 1.5.0 1.4.0 1.2.0

Metadata

Released date: about 1 hour ago

Version: 1.5.2

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.8.0

GraalVM compatible: Yes

Pull count

Total: 24

Current verison: 0

Weekly downloads

Source repository

Keywords

Type/Connector

Vendor/Apideck

Area/Finance & Accounting

Finance/Accounting

Cost/Freemium

Contributors

Dependencies

ballerina/url/2.4.0 ballerina/constraint/1.5.0 ballerina/http/2.10.24

Cookie policy

Delete policy

clients

records

arrayTypes

stringTypes

ballerinax/apideck.accounting Ballerina library

Overview

Key Features

Prerequisites

Clients

apideck.accounting: Client

Constructor

companiesAll

Parameters

Return Type

companiesAdd

Parameters

Return Type

companiesOne

Parameters

Return Type

companiesDelete

Parameters

Return Type

companiesUpdate

Parameters

Return Type

contactsAll

Parameters

Return Type

contactsAdd

Parameters

Return Type

contactsOne

Parameters

Return Type

contactsDelete

Parameters

Return Type

contactsUpdate

Parameters

Return Type

invoicesAll

Parameters

Return Type

invoicesAdd

Parameters

Return Type

invoicesOne

Parameters

Return Type

invoicesDelete

Parameters

Return Type

invoicesUpdate

Parameters

Return Type

ledgerAccountsAll

Parameters

Return Type

ledgerAccountsAdd

Parameters

Return Type

ledgerAccountsOne

Parameters

Return Type

ledgerAccountsDelete

Parameters

Return Type

ledgerAccountsUpdate

Parameters

Return Type

taxRatesAll

Parameters

Return Type

taxRatesAdd

Parameters

Return Type

taxRatesOne

Parameters

Return Type