apideck.accounting
Module apideck.accounting
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_apideck.accounting_1.1.1.png)
ballerinax/apideck.accounting Ballerina library
Overview
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.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Apideck account
- Obtain tokens by following this guide
Clients![](/images/permalink.svg)
apideck.accounting: Client![](/images/permalink.svg)
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![](/images/permalink.svg)
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, ClientConfiguration clientConfig, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://unify.apideck.com" - URL of the target service
companiesAll![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
apideck.accounting: Address![](/images/permalink.svg)
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![](/images/permalink.svg)
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>
- Bearer authorization header:
apideck.accounting: BankAccount![](/images/permalink.svg)
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: Company![](/images/permalink.svg)
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: Contact![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
The customer this invoice is linked to.
Fields
- company_name string? - The company name.
- id Id? - The unique Id.
apideck.accounting: CustomField![](/images/permalink.svg)
Fields
- id string -
apideck.accounting: DeleteCompanyResponse![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- email string -
- id string? -
- 'type string? -
apideck.accounting: GetCompaniesResponse![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- balance decimal? -
- billing_address Address? -
- created_at CreatedAt? -
- created_by CreatedBy? -
- 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![](/images/permalink.svg)
Fields
- id Id? - The unique Id.
- name string? -
apideck.accounting: InvoiceLineItems![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- code string? -
- id Id? - The unique Id.
- name string? -
apideck.accounting: Lead![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- active boolean? -
- bank_account BankAccount? -
- classification string? -
- created_at CreatedAt? -
- created_by CreatedBy? -
- 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![](/images/permalink.svg)
Fields
- display_id string? -
- id string? -
- name string? -
apideck.accounting: LedgeraccountSubAccounts![](/images/permalink.svg)
Fields
- account_sub_name string? -
- id string? -
apideck.accounting: Links![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- id string? -
- number string -
- 'type string? -
apideck.accounting: Pipeline![](/images/permalink.svg)
Fields
- archived boolean? -
- created_at string? -
- currency string? -
- display_order int? -
- id string? -
- name string -
- stages PipelineStages[]? -
- updated_at string? -
apideck.accounting: PipelineStages![](/images/permalink.svg)
Fields
- display_order int? -
- id string? -
- name string? -
- value string? -
apideck.accounting: SocialLink![](/images/permalink.svg)
Fields
- id string? -
- 'type string? -
- url string -
apideck.accounting: TaxRate![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- compound boolean? -
- name string? -
- rate decimal? -
apideck.accounting: UnifiedId![](/images/permalink.svg)
Fields
- id string -
apideck.accounting: UpdateCompanyResponse![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
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![](/images/permalink.svg)
Fields
- id string? -
- 'type string? -
- url string -
String types![](/images/permalink.svg)
Import
import ballerinax/apideck.accounting;
Metadata
Released date: over 2 years ago
Version: 1.1.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: slbeta6
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Finance/Accounting
Cost/Freemium
Contributors
Dependencies