Overview
Configuration is provided for establishing connections with Sage Business Cloud service. The configuration is used in the REST Connection Manager.
Setup
Press icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to Sage Business Cloud Accounting REST API using COZYROC's REST Connection Manager.
Congratulations! You have now established a connection to your Sage Business Cloud Accounting instance.
In this guide, we will show how to read data from the Sage Business Cloud Accounting service resource using the COZYROC REST Source component.
In this guide, we will show how to write data to the Sage Business Cloud Accounting service resource using the COZYROC REST Destination component.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Sage Business Cloud Accounting resource.
Configuration
Base URL address: https://api.accounting.sage.com/v3.1
.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}
.The authentication has the following user-defined parameters:
- Scopes:
- Country:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developer.sage.com/api/accounting/guides/authentication/.
Based on resource template Base.
- [Read contact_type] action
-
Endpoint URL address:
/contact_types
.Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/getContactTypes.
- [Read ledger_account_class] action
-
Endpoint URL address:
/ledger_account_classifications
.Documentation: https://developer.sage.com/api/accounting/api/accounting-setup/#operation/getLedgerAccountClassifications.
- [Read ledger_account_type] action
-
Endpoint URL address:
/ledger_account_types
.Documentation: https://developer.sage.com/api/accounting/api/accounting-setup/#operation/getLedgerAccountTypes.
- [Read address_type] action
-
Endpoint URL address:
/address_types
.Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/getAddressTypes.
- [Read country] action
-
Endpoint URL address:
/countries
.Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/getCountries.
- [Read country_group] action
-
Endpoint URL address:
/country_groups
.Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/getCountryGroups.
- [Read contact_person_type] action
-
Endpoint URL address:
/contact_person_types
.Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/getContactPersonTypes.
- [Read currency] action
-
Endpoint URL address:
/currencies
.Documentation: https://developer.sage.com/api/accounting/api/currencies/#operation/getCurrencies.
- [Read business_activity_type] action
-
Endpoint URL address:
/business_activity_types
.Documentation: https://developer.sage.com/api/accounting/api/settings/#operation/getBusinessActivityTypes.
- [Read legal_form_type] action
-
Endpoint URL address:
/legal_form_types
.Documentation: https://developer.sage.com/api/accounting/api/settings/#operation/getLegalFormTypes.
- [Read country_registration] action
-
Endpoint URL address:
/countries_of_registration
.Documentation: https://developer.sage.com/api/accounting/api/settings/#operation/getCountriesOfRegistration.
- [Read attachment_context_type] action
-
Endpoint URL address:
/attachment_context_types
.Documentation: https://developer.sage.com/api/accounting/api/attachments/#operation/getAttachmentContextTypes.
- [Read corrective_reason_code] action
-
Endpoint URL address:
/corrective_reason_codes
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-general/#operation/getCorrectiveReasonCodes.
- [Read quick_entry_type] action
-
Endpoint URL address:
/quick_entry_types
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-general/#operation/getQuickEntryTypes.
- [Read artefact_status] action
-
Endpoint URL address:
/artefact_statuses
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-general/#operation/getArtefactStatuses.
- [Read eu_goods_services_type] action
-
Endpoint URL address:
/eu_goods_services_types
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-general/#operation/getEuGoodsServicesTypes.
- [Read tax_return_frequency] action
-
Endpoint URL address:
/tax_return_frequencies
.Documentation: https://developer.sage.com/api/accounting/api/taxes/#operation/getTaxReturnFrequencies.
- [Read tax_scheme] action
-
Endpoint URL address:
/tax_schemes
.Documentation: https://developer.sage.com/api/accounting/api/taxes/#operation/getTaxSchemes.
- [Read catalog_item_type] action
-
Endpoint URL address:
/catalog_item_types
.Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/getCatalogItemTypes.
- [Read journal_code_type] action
-
Endpoint URL address:
/journal_code_types
.Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/getJournalCodeTypes.
- [Read transaction_type] action
-
Endpoint URL address:
/transaction_types
.Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/getTransactionTypes.
- [Read eu_sales_description] action
-
Endpoint URL address:
/eu_sales_descriptions
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getEuSalesDescriptions.
- [Read bank_account_type] action
-
Endpoint URL address:
/bank_account_types
.Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/getBankAccountTypes.
- [Read payment_method] action
-
Endpoint URL address:
/payment_methods
.Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/getPaymentMethods.
- [Read contact_opening_balance_type] action
-
Endpoint URL address:
/contact_opening_balance_types
.Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/getContactOpeningBalanceTypes.
The resource includes the fields from the ReferenceT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/coa_accounts
.Documentation: https://developer.sage.com/api/accounting/api/accounting-setup/#operation/getCoaAccounts.
- [Read single] action
-
Endpoint URL address:
/coa_accounts/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Please specify COA Account identifier.
Documentation: https://developer.sage.com/api/accounting/api/accounting-setup/#operation/getCoaAccountsKey.
- [Read template] action
-
Endpoint URL address:
/coa_templates
.Documentation: https://developer.sage.com/api/accounting/api/accounting-setup/#operation/getCoaTemplates.
- [Read single_template] action
-
Endpoint URL address:
/coa_templates/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Please specify COA Account template identifier.
Documentation: https://developer.sage.com/api/accounting/api/accounting-setup/#operation/getCoaTemplatesKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- ledger_account_group
Template: ReferenceT.
- name
Template: ShortText.
- control_name
Template: ShortText.
- nominal_code
Data type: DT_I4
- ledger_account_type
Template: ReferenceT.
- ledger_account_classification
Template: ReferenceT.
- tax_rate
Template: ReferenceT.
- fixed_tax_rate
Data type: DT_BOOL
- cis_materials
Data type: DT_BOOL
- cis_labour
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ledger_accounts
.Documentation: https://developer.sage.com/api/accounting/api/accounting-setup/#operation/getLedgerAccounts.
- [Read single] action
-
Endpoint URL address:
/ledger_accounts/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify ledger account identifier.
Documentation: https://developer.sage.com/api/accounting/api/accounting-setup/#operation/getLedgerAccountsKey.
- [Create] action
-
Endpoint URL address:
/ledger_accounts
.The following request parameters will be automatically processed:
-
application/json:
{{= { ledger_account: item } }}
Documentation: https://developer.sage.com/api/accounting/api/accounting-setup/#operation/postLedgerAccounts.
-
application/json:
- [Update] action
-
Endpoint URL address:
/ledger_accounts/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ ledger_account : item } }}
Documentation: https://developer.sage.com/api/accounting/api/accounting-setup/#operation/putLedgerAccountsKey.
-
application/json:
The resource includes the fields from the LedgerAccountT template.
- ledger_account_type_id
Template: ShortText.
- non_recoverable_ledger_account_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/addresses
.Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/getAddresses.
- [Read single] action
-
Endpoint URL address:
/addresses/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Please specify the address identifier.
Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/getAddressesKey.
- [Create] action
-
Endpoint URL address:
/addresses
.The following request parameters will be automatically processed:
-
application/json:
{{= { address: item } }}
Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/postAddresses.
-
application/json:
- [Update] action
-
Endpoint URL address:
/addresses/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { address: item } }}
Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/putAddressesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/addresses/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/deleteAddressesKey.
The resource includes the fields from the AddressT template.
- address_type_id
Template: ShortText.
- contact_id
Template: ShortText.
- bank_account_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/address_regions
.Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/getAddressRegions.
- [Read single] action
-
Endpoint URL address:
/address_regions/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify address region identifier.
Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/getAddressRegionsKey.
The resource includes the fields from the ReferenceT template.
- name
Template: ShortText.
- code
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts
.Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/getContacts.
- [Read single] action
-
Endpoint URL address:
/contacts/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Please specify contact identifier.
Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/getContactsKey.
- [Create] action
-
Endpoint URL address:
/contacts
.The following request parameters will be automatically processed:
-
application/json:
{{= { contact: item } }}
Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/postContacts.
-
application/json:
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ contact : item } }}
Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/putContactsKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/deleteContactsKey.
The resource includes the fields from the ContactT template.
- contact_type_ids
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contact_persons
.Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/getContactPersons.
- [Read single] action
-
Endpoint URL address:
/contact_persons/{{=parameters.id}}
.
The result is extracted from:{{= [response] }}
.The action has the following user-defined parameters:
- id: Required. Specify contact person identifier.
Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/getContactPersonsKey.
- [Create] action
-
Endpoint URL address:
/contact_persons
.The following request parameters will be automatically processed:
-
application/json:
{{= { contact_person: item } }}
Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/postContactPersons.
-
application/json:
- [Update] action
-
Endpoint URL address:
/contact_persons/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { contact_person: item } }}
Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/putContactPersonsKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/contact_persons/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/contacts/#operation/deleteContactPersonsKey.
The resource includes the fields from the MainContactT template.
- contact_person_type_ids
Template: ShortText.
- address_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/product_sales_price_types
.Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/getProductSalesPriceTypes.
- [Read single] action
-
Endpoint URL address:
/product_sales_price_types/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify product sale price type identifier.
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/getProductSalesPriceTypesKey.
- [Create] action
-
Endpoint URL address:
/product_sales_price_types
.The following request parameters will be automatically processed:
-
application/json:
{{={ product_sales_price_type : item } }}
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/postProductSalesPriceTypes.
-
application/json:
- [Update] action
-
Endpoint URL address:
/product_sales_price_types/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { product_sales_price_type : item } }}
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/putProductSalesPriceTypesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/product_sales_price_types/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/deleteProductSalesPriceTypesKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- name
Template: ShortText.
- active
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/products
.Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/getProducts.
- [Read single] action
-
Endpoint URL address:
/products/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify product identifier.
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/getProductsKey.
- [Create] action
-
Endpoint URL address:
/products
.The following request parameters will be automatically processed:
-
application/json:
{{={ product: item } }}
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/postProducts.
-
application/json:
- [Update] action
-
Endpoint URL address:
/products/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ product: item } }}
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/putProductsKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/products/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/deleteProductsKey.
The resource includes the fields from the ProductT template.
- purchase_ledger_account_id
Template: ShortText.
- sales_ledger_account_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/services
.Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/getServices.
- [Read single] action
-
Endpoint URL address:
/services/{{=parameters.id}}
.
The result is extracted from:{{=[response] }}
.The action has the following user-defined parameters:
- id: Required. Specify service identifier.
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/getServicesKey.
- [Create] action
-
Endpoint URL address:
/services
.The following request parameters will be automatically processed:
-
application/json:
{{= { service : item } }}
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/postServices.
-
application/json:
- [Update] action
-
Endpoint URL address:
/services/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { service : item } }}
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/putServicesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/services/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/deleteServicesKey.
The resource includes the fields from the ServiceT template.
- sales_ledger_account_id
Template: ShortText.
- purchase_ledger_account_id
Template: ShortText.
- sales_tax_rate_id
Template: ShortText.
- purchase_tax_rate_id
Template: ShortText.
- usual_supplier_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/service_rate_types
.Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/getServiceRateTypes.
- [Read single] action
-
Endpoint URL address:
/service_rate_types/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify service rate type identifier.
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/getServiceRateTypesKey.
- [Create] action
-
Endpoint URL address:
/service_rate_types
.The following request parameters will be automatically processed:
-
application/json:
{{= { service_rate_type : item } }}
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/postServiceRateTypes.
-
application/json:
- [Update] action
-
Endpoint URL address:
/service_rate_types/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { service_rate_type : item } }}
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/putServiceRateTypesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/service_rate_types/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/deleteServiceRateTypesKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- name
Template: ShortText.
- active
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/stock_items
.Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/getStockItems.
- [Read single] action
-
Endpoint URL address:
/stock_items/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify stock item identifier.
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/getStockItemsKey.
- [Create] action
-
Endpoint URL address:
/stock_items
.The following request parameters will be automatically processed:
-
application/json:
{{= { stock_item : item } }}
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/postStockItems.
-
application/json:
- [Update] action
-
Endpoint URL address:
/stock_items/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { stock_item : item } }}
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/putStockItemsKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/stock_items/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/deleteStockItemsKey.
The resource includes the fields from the StockItemT template.
- sales_ledger_account_id
Template: ShortText.
- purchase_ledger_account_id
Template: ShortText.
- sales_tax_rate_id
Template: ShortText.
- usual_supplier_id
Template: ShortText.
- purchase_tax_rate_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/stock_movements
.Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/getStockMovements.
- [Read single] action
-
Endpoint URL address:
/stock_movements/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify stock movement identifier.
- [Create] action
-
Endpoint URL address:
/stock_movements
.The following request parameters will be automatically processed:
-
application/json:
{{= { stock_movement : item } }}
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/postStockMovements.
-
application/json:
- [Update] action
-
Endpoint URL address:
/stock_movements/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { stock_movement : item } }}
Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/putStockMovementsKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/stock_movements/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/products-services/#operation/deleteStockMovementsKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- movement_number
Template: ShortText.
- date
Template: DateTime.
- cost_price
Data type: DT_R8
- quantity
Data type: DT_I4
- details
Template: ShortText.
- reference
Template: ShortText.
- stock_item
Template: StockItemT.
- links
Field components:
- An array.
-
Uses template:
LinkReferenceT
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/journals
.Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/getJournals.
- [Read single] action
-
Endpoint URL address:
/journals/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify journal identifier.
Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/getJournalsKey.
- [Create] action
-
Endpoint URL address:
/journals
.The following request parameters will be automatically processed:
-
application/json:
{{={ journal: item } }}
Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/postJournals.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/journals/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/deleteJournalsKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- transaction
Template: ReferenceT.
- transaction_type
Template: ReferenceT.
- deleted_at
Template: DateTime.
- date
Template: DateTime.
- reference
Template: ShortText.
- description
Template: ShortText.
- total
Data type: DT_I4
- journal_code
Template: JournalCodeT.
- journal_lines
Field components:
- An array.
- Contains the following components: id, ledger_account, details, debit, credit, include_on_tax_return, tax_reconciled, cleared, bank_reconciled.
- migrated
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/journal_codes
.Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/getJournalCodes.
- [Read single] action
-
Endpoint URL address:
/journal_codes/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify journal code identifier.
Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/getJournalCodesKey.
- [Create] action
-
Endpoint URL address:
/journal_codes
.The following request parameters will be automatically processed:
-
application/json:
{{={ journal_code: item } }}
Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/postJournalCodes.
-
application/json:
- [Update] action
-
Endpoint URL address:
/journal_codes/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ journal_code : item } }}
Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/putJournalCodesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/journal_codes/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/deleteJournalCodesKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- name
Template: ShortText.
- code
Template: ShortText.
- journal_code_type
Template: ReferenceT.
- control_name
Template: ShortText.
- reserved
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ledger_entries
.Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/getLedgerEntries.
- [Read single] action
-
Endpoint URL address:
/ledger_entries/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify ledger entry identifier.
Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/getLedgerEntriesKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- date
Template: DateTime.
- credit
Data type: DT_R8
- debit
Data type: DT_R8
- ledger_account
Template: LedgerAccountT.
- transaction
Template: TransactionT.
- contact
Template: ContactT.
- deleted
Data type: DT_BOOL
- tax_rate
Template: TaxRateT.
- description
Template: ShortText.
- journal_code
Template: JournalCodeT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/transactions
.Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/getTransactions.
- [Read single] action
-
Endpoint URL address:
/transactions/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify transaction identifier.
Documentation: https://developer.sage.com/api/accounting/api/accounting/#operation/getTransactionsKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- date
Template: DateTime.
- deleted
Data type: DT_BOOL
- reference
Template: ShortText.
- total
Data type: DT_R8
- total_in_transaction_currency
Data type: DT_R8
- contact
Template: ReferenceT.
- transaction_type
Template: ReferenceT.
- origin
Template: ArtefactT. Field components:
-
Uses template:
DateTime
. - Contains the following components: due_date, outstanding_amount, currency, status, sent.
-
Uses template:
- audit_trail_id
Template: ShortText.
- number_of_attachments
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sales_corrective_invoices
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getSalesCorrectiveInvoices.
- [Read single] action
-
Endpoint URL address:
/sales_corrective_invoices/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify sale corrective invoice identifier.
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getSalesCorrectiveInvoicesKey.
- [Create] action
-
Endpoint URL address:
/sales_corrective_invoices
.The following request parameters will be automatically processed:
-
application/json:
{{= { sales_corrective_invoice : item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/postSalesCorrectiveInvoices.
-
application/json:
- [Update] action
-
Endpoint URL address:
/sales_corrective_invoices/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { sales_corrective_invoice : item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/putSalesCorrectiveInvoicesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/sales_corrective_invoices/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/deleteSalesCorrectiveInvoicesKey.
The resource includes the fields from the SaleCorrectionT template.
- contact_id
Template: ShortText.
- shipping_tax_rate_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sales_credit_notes
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getSalesCreditNotes.
- [Read single] action
-
Endpoint URL address:
/sales_credit_notes/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify sale credit note identifier.
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getSalesCreditNotesKey.
- [Create] action
-
Endpoint URL address:
/sales_credit_notes
.The following request parameters will be automatically processed:
-
application/json:
{{= { sales_credit_note : item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/postSalesCreditNotes.
-
application/json:
- [Update] action
-
Endpoint URL address:
/sales_credit_notes/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { sales_credit_note : item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/putSalesCreditNotesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/sales_credit_notes/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/deleteSalesCreditNotesKey.
The resource includes the fields from the SaleTransactionT template.
- is_cis
Data type: DT_BOOL
- cis_applicable_amount
Data type: DT_R8
- base_currency_cis_applicable_amount
Data type: DT_R8
- total_after_cis_deduction
Data type: DT_R8
- base_currency_total_after_cis_deduction
Data type: DT_R8
- has_cis_labour
Data type: DT_BOOL
- has_cis_materials
Data type: DT_BOOL
- credit_note_number_prefix
Template: ShortText.
- credit_note_number
Template: ShortText.
- notes
Template: ShortText.
- credit_note_lines
Field components:
- An array.
-
Uses template:
BaseLineT
. - Contains the following components: discount_amount, base_currency_discount_amount, discount_percentage, eu_sales_description, ledger_account_id.
- tax_address_region
Template: ReferenceT.
- migrated
Data type: DT_BOOL
- contact_id
Template: ShortText.
- shipping_tax_rate_id
Template: ShortText.
- ledger_account_id
Template: ShortText.
Based on resource template Base.
- [Read getSingleSalesEstimate] action (alias: "getSingleSaleEstimate")
-
Endpoint URL address:
/sales_estimates/{{=parameters.id}}
.
The result is extracted from:{{= [response ] }}
.The action has the following user-defined parameters:
- id: Required. Please provide the id
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getSalesEstimatesKey.
- [Read] action
-
Endpoint URL address:
/sales_estimates
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getSalesEstimates.
- [Create] action
-
Endpoint URL address:
/sales_estimates
.The following request parameters will be automatically processed:
-
application/json:
{{= { sales_estimate : item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/postSalesEstimates.
-
application/json:
- [Update] action
-
Endpoint URL address:
/sales_estimates/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { sales_estimate: item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/putSalesEstimatesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/sales_estimates/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/deleteSalesEstimatesKey.
The resource includes the fields from the SaleTransactionT template.
- expiry_date
Template: DateTime.
- estimate_number_prefix
Template: ShortText.
- estimate_number
Template: ShortText.
- estimate_lines
Field components:
- An array.
-
Uses template:
BaseLineT
. - Contains the following components: discount_amount, base_currency_discount_amount, discount_percentage, eu_sales_description, product_id, service_id, ledger_account_id, tax_rate_id.
- tax_address_region
Template: ReferenceT.
- profit_analysis
Template: ProfitAnalysisT.
- invoice
Template: ArtefactT.
- contact_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sales_invoices
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getSalesInvoices.
- [Read single] action
-
Endpoint URL address:
/sales_invoices/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify sale invoice identifier.
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getSalesInvoicesKey.
- [Create] action
-
Endpoint URL address:
/sales_invoices
.The following request parameters will be automatically processed:
-
application/json:
{{= { sales_invoice : item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/postSalesInvoices.
-
application/json:
- [Update] action
-
Endpoint URL address:
/sales_invoices/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { sales_invoice:item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/putSalesInvoicesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/sales_invoices/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/deleteSalesInvoicesKey.
The resource includes the fields from the SaleTransactionT template.
- is_cis
Data type: DT_BOOL
- cis_applicable_amount
Data type: DT_R8
- base_currency_cis_applicable_amount
Data type: DT_R8
- total_after_cis_deduction
Data type: DT_R8
- base_currency_total_after_cis_deduction
Data type: DT_R8
- has_cis_labour
Data type: DT_BOOL
- has_cis_materials
Data type: DT_BOOL
- recurring_invoice
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, links, frequency, on_week_day, on_day_number, recurrence_type, recurrence_status_identifier.
-
Uses template:
- invoice_number_prefix
Template: ShortText.
- invoice_number
Template: ShortText.
- invoice_lines
Field components:
- An array.
-
Uses template:
BaseLineT
. - Contains the following components: discount_amount, base_currency_discount_amount, discount_percentage, eu_sales_description, ledger_account_id, product_id, service_id, tax_rate_id.
- original_quote_estimate
Template: ArtefactT.
- tax_address_region
Template: ReferenceT.
- delivery_performance_date
Template: ShortText.
- corrections
Field components:
- An array.
-
Uses template:
SaleCorrectionT
.
- migrated
Data type: DT_BOOL
- contact_id
Template: ShortText.
- status_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sales_quick_entries
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getSalesQuickEntries.
- [Read single] action
-
Endpoint URL address:
/sales_quick_entries/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify sale quick entry identifier.
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getSalesQuickEntriesKey.
- [Create] action
-
Endpoint URL address:
/sales_quick_entries
.The following request parameters will be automatically processed:
-
application/json:
{{= { sales_quick_entry: item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/postSalesQuickEntries.
-
application/json:
- [Update] action
-
Endpoint URL address:
/sales_quick_entries/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { sales_quick_entry:item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/putSalesQuickEntriesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/sales_quick_entries/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/deleteSalesQuickEntriesKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- transaction
Template: ReferenceT.
- transaction_type
Template: ReferenceT.
- deleted_at
Template: DateTime.
- quick_entry_type
Template: ReferenceT.
- contact_name
Template: ShortText.
- contact_reference
Template: ShortText.
- contact
Template: ReferenceT.
- date
Template: DateTime.
- reference
Template: ShortText.
- ledger_account
Template: ReferenceT.
- details
Template: ShortText.
- net_amount
Data type: DT_R8
- tax_rate
Template: ReferenceT.
- tax_amount
Data type: DT_R8
- tax_breakdown
Field components:
- An array.
-
Uses template:
TaxBreakdownT
.
- total_amount
Data type: DT_R8
- outstanding_amount
Data type: DT_R8
- currency
Template: ReferenceT.
- exchange_rate
Data type: DT_R8
- inverse_exchange_rate
Data type: DT_R8
- base_currency_net_amount
Data type: DT_R8
- base_currency_tax_amount
Data type: DT_R8
- base_currency_tax_breakdown
Field components:
- An array.
-
Uses template:
TaxBreakdownT
.
- base_currency_total_amount
Data type: DT_R8
- base_currency_outstanding_amount
Data type: DT_R8
- status
Template: ReferenceT.
- payments_allocations
Field components:
- An array.
-
Uses template:
PaymentAllocationT
.
- tax_address_region
Template: ReferenceT.
- migrated
Data type: DT_BOOL
- trade_of_asset
Data type: DT_BOOL
- quick_entry_type_id
Template: ShortText.
- contact_id
Template: ShortText.
- ledger_account_id
Template: ShortText.
- tax_rate_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sales_quotes
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getSalesQuotes.
- [Read getSingelSaleQuote] action (alias: "getSingleSAleQuote")
-
Endpoint URL address:
/sales_quotes/{{=parameters.id}}
.
The result is extracted from:{{= [response] }}
.The action has the following user-defined parameters:
- id: please provide id
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getSalesQuotesKey.
- [Create] action
-
Endpoint URL address:
/sales_quotes
.The following request parameters will be automatically processed:
-
application/json:
{{= { sales_quote: item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/postSalesQuotes.
-
application/json:
- [Update] action
-
Endpoint URL address:
/sales_quotes/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { sales_quote:item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/putSalesQuotesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/sales_quotes/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/deleteSalesQuotesKey.
The resource includes the fields from the SaleTransactionT template.
- quote_number_prefix
Template: ShortText.
- quote_number
Template: ShortText.
- expiry_date
Template: ShortText.
- quote_lines
Field components:
- An array.
- Contains the following components: id, displayed_as, description, product, service, ledger_account, trade_of_asset, quantity, unit_price, net_amount, tax_rate, tax_amount, tax_breakdown, total_amount, base_currency_unit_price, unit_price_includes_tax, base_currency_net_amount, base_currency_tax_amount, base_currency_tax_breakdown, base_currency_total_amount, eu_goods_services_type, discount_amount, base_currency_discount_amount, discount_percentage, eu_sales_description, ledger_account_id, product_id, service_id, tax_rate_id.
- tax_address_region
Template: ReferenceT.
- profit_analysis
Template: ProfitAnalysisT.
- invoice
Template: ArtefactT.
- contact_id
Template: ShortText.
- shipping_tax_rate_id
Template: ShortText.
- currency_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hosted_artefact_payment_settings
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getHostedArtefactPaymentSettings.
- [Read single] action
-
Endpoint URL address:
/hosted_artefact_payment_settings/{{=parameters.id}}
.
The result is extracted from:{{= [response] }}
.The action has the following user-defined parameters:
- id: Required. Specify setting identifier.
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/getHostedArtefactPaymentSettingsKey.
- [Create] action
-
Endpoint URL address:
/hosted_artefact_payment_settings
.The following request parameters will be automatically processed:
-
application/json:
{{= { hosted_artefact_payment_setting : item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/postHostedArtefactPaymentSettings.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/hosted_artefact_payment_settings/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-sales/#operation/deleteHostedArtefactPaymentSettingsKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- object_guid
Template: ShortText.
- disable_payment
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/purchase_corrective_invoices
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/getPurchaseCorrectiveInvoices.
- [Read single] action
-
Endpoint URL address:
/purchase_corrective_invoices/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify purchase corrective invoice identifier.
Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/getPurchaseCorrectiveInvoicesKey.
- [Create] action
-
Endpoint URL address:
/purchase_corrective_invoices
.The following request parameters will be automatically processed:
-
application/json:
{{= { purchase_corrective_invoice : item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/postPurchaseCorrectiveInvoices.
-
application/json:
- [Update] action
-
Endpoint URL address:
/purchase_corrective_invoices/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { purchase_corrective_invoice: item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/putPurchaseCorrectiveInvoicesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/purchase_corrective_invoices/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/deletePurchaseCorrectiveInvoicesKey.
The resource includes the fields from the PurchaseTransactionT template.
- invoice_lines
Field components:
- An array.
-
Uses template:
BaseLineT
. - Contains the following components: is_purchase_for_resale, gst_amount, pst_amount, tax_recoverable, product_id, service_id, ledger_account_id, tax_rate_id.
- original_invoice
Template: ArtefactT.
- original_invoice_number
Template: ShortText.
- original_invoice_date
Template: ShortText.
- contact_id
Template: ShortText.
- currency_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/purchase_credit_notes
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/getPurchaseCreditNotes.
- [Read single] action
-
Endpoint URL address:
/purchase_credit_notes/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify purchase credit note identifier.
Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/getPurchaseCreditNotesKey.
- [Create] action
-
Endpoint URL address:
/purchase_credit_notes
.The following request parameters will be automatically processed:
-
application/json:
{{= { purchase_credit_note: item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/postPurchaseCreditNotes.
-
application/json:
- [Update] action
-
Endpoint URL address:
/purchase_credit_notes/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { purchase_credit_note : item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/putPurchaseCreditNotesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/purchase_credit_notes/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/deletePurchaseCreditNotesKey.
The resource includes the fields from the PurchaseTransactionT template.
- postponed_accounting
Data type: DT_BOOL
- is_cis
Data type: DT_BOOL
- cis_applicable_amount
Data type: DT_R8
- base_currency_cis_applicable_amount
Data type: DT_R8
- total_after_cis_deduction
Data type: DT_R8
- base_currency_total_after_cis_deduction
Data type: DT_R8
- has_cis_labour
Data type: DT_BOOL
- has_cis_materials
Data type: DT_BOOL
- base_currency_total_itc_amount
Data type: DT_R8
- total_itc_amount
Data type: DT_R8
- base_currency_total_itr_amount
Data type: DT_R8
- total_itr_amount
Data type: DT_R8
- part_recoverable
Data type: DT_BOOL
- credit_note_lines
Field components:
- An array.
-
Uses template:
BaseLineT
. - Contains the following components: is_purchase_for_resale, gst_amount, pst_amount, tax_recoverable, product_id, service_id, tax_rate_id.
- tax_address_region
Template: ReferenceT.
- migrated
Data type: DT_BOOL
- contact_id
Template: ShortText.
- currency_id
Template: ShortText.
- status_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/purchase_invoices
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/getPurchaseInvoices.
- [Read single] action
-
Endpoint URL address:
/purchase_invoices/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify purchase invoice identifier.
Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/getPurchaseInvoicesKey.
- [Create] action
-
Endpoint URL address:
/purchase_invoices
.The following request parameters will be automatically processed:
-
application/json:
{{= { purchase_invoice : item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/postPurchaseInvoices.
-
application/json:
- [Update] action
-
Endpoint URL address:
/purchase_invoices/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { purchase_invoice:item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/putPurchaseInvoicesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/purchase_invoices/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/deletePurchaseInvoicesKey.
The resource includes the fields from the PurchaseTransactionT template.
- postponed_accounting
Data type: DT_BOOL
- is_cis
Data type: DT_BOOL
- cis_applicable_amount
Data type: DT_R8
- base_currency_cis_applicable_amount
Data type: DT_R8
- total_after_cis_deduction
Data type: DT_R8
- base_currency_total_after_cis_deduction
Data type: DT_R8
- has_cis_labour
Data type: DT_BOOL
- has_cis_materials
Data type: DT_BOOL
- base_currency_total_itc_amount
Data type: DT_R8
- total_itc_amount
Data type: DT_R8
- base_currency_total_itr_amount
Data type: DT_R8
- total_itr_amount
Data type: DT_R8
- part_recoverable
Data type: DT_BOOL
- invoice_lines
Field components:
- An array.
-
Uses template:
BaseLineT
. - Contains the following components: is_purchase_for_resale, gst_amount, pst_amount, tax_recoverable, product_id, service_id, ledger_account_id, tax_rate_id.
- tax_address_region
Template: ReferenceT.
- corrections
Field components:
- An array.
-
Uses template:
PurchaseCorrectionT
.
- migrated
Data type: DT_BOOL
- contact_id
Template: ShortText.
- status_id
Template: ShortText.
- tax_address_region_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/purchase_quick_entries
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/getPurchaseQuickEntries.
- [Read SinglePurchaseQuickEntry] action (alias: "getSinglePurchaseQuickEntries")
-
Endpoint URL address:
/purchase_quick_entries/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify purchase quick entry identifier.
Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/getPurchaseQuickEntriesKey.
- [Create] action
-
Endpoint URL address:
/purchase_quick_entries
.The following request parameters will be automatically processed:
-
application/json:
{{= { purchase_quick_entry : item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/postPurchaseQuickEntries.
-
application/json:
- [Update] action
-
Endpoint URL address:
/purchase_quick_entries/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { purchase_quick_entry : item } }}
Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/putPurchaseQuickEntriesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/purchase_quick_entries/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/invoicing-purchases/#operation/deletePurchaseQuickEntriesKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- transaction
Template: ReferenceT.
- transaction_type
Template: ReferenceT.
- deleted_at
Template: DateTime.
- quick_entry_type
Template: ReferenceT.
- contact_name
Template: ShortText.
- contact_reference
Template: ShortText.
- contact
Template: ReferenceT.
- date
Template: DateTime.
- reference
Template: ShortText.
- ledger_account
Template: ReferenceT.
- details
Template: ShortText.
- net_amount
Data type: DT_R8
- tax_rate
Template: ReferenceT.
- tax_amount
Data type: DT_R8
- tax_breakdown
Field components:
- An array.
-
Uses template:
TaxBreakdownT
.
- total_amount
Data type: DT_R8
- outstanding_amount
Data type: DT_R8
- currency
Template: ReferenceT.
- exchange_rate
Data type: DT_R8
- inverse_exchange_rate
Data type: DT_R8
- base_currency_net_amount
Data type: DT_R8
- base_currency_tax_amount
Data type: DT_R8
- base_currency_tax_breakdown
Field components:
- An array.
-
Uses template:
TaxBreakdownT
.
- base_currency_total_amount
Data type: DT_R8
- base_currency_outstanding_amount
Data type: DT_R8
- status
Template: ReferenceT.
- payments_allocations
Field components:
- An array.
-
Uses template:
PaymentAllocationT
.
- tax_address_region
Template: ReferenceT.
- migrated
Data type: DT_BOOL
- trade_of_asset
Data type: DT_BOOL
- gst_amount
Data type: DT_R8
- pst_amount
Data type: DT_R8
- tax_recoverable
Data type: DT_BOOL
- quick_entry_type_id
Template: ShortText.
- contact_id
Template: ShortText.
- ledger_account_id
Template: ShortText.
- tax_rate_id
Template: ShortText.
- currency_id
Template: ShortText.
- status_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/bank_accounts
.Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/getBankAccounts.
- [Read single] action
-
Endpoint URL address:
/bank_accounts/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify bank account identifier.
Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/getBankAccountsKey.
- [Create] action
-
Endpoint URL address:
/bank_accounts
.The following request parameters will be automatically processed:
-
application/json:
{{= { bank_account : item } }}
Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/postBankAccounts.
-
application/json:
- [Update] action
-
Endpoint URL address:
/bank_accounts/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { bank_account : item } }}
Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/putBankAccountsKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/bank_accounts/{{=item.id }}
.Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/deleteBankAccountsKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- deleted_at
Template: DateTime.
- bank_account_details
Template: BankAccountT.
- ledger_account
Template: ReferenceT.
- bank_account_type
Template: ReferenceT.
- balance
Data type: DT_R8
- main_address
Template: AddressT.
- main_contact_person
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, job_title, telephone, mobile, email, fax.
-
Uses template:
- nominal_code
Data type: DT_I4
- editable
Data type: DT_BOOL
- deletable
Data type: DT_BOOL
- journal_code
Template: JournalCodeT.
- default_payment_method
Template: ReferenceT.
- gifi_code
Data type: DT_I4
- bank_account_type_id
Template: ShortText.
- ledger_account_id
Template: ShortText.
- default_payment_method_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/bank_deposits
.Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/getBankDeposits.
- [Read single] action
-
Endpoint URL address:
/bank_deposits/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify bank deposit identifer.
Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/getBankDepositsKey.
- [Create] action
-
Endpoint URL address:
/bank_deposits
.The following request parameters will be automatically processed:
-
application/json:
{{= { bank_deposit : item } }}
Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/postBankDeposits.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/bank_deposits/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/deleteBankDepositsKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- transaction
Template: ReferenceT.
- transaction_type
Template: ReferenceT.
- deleted_at
Template: DateTime.
- from_bank_account
Template: ToFromBankT.
- to_bank_account
Template: ToFromBankT.
- date
Template: DateTime.
- reference
Template: ShortText.
- cash_amount
Data type: DT_R8
- cheque_amount
Data type: DT_R8
- total_amount
Data type: DT_R8
- from_bank_account_id
Template: ShortText.
- to_bank_account_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/bank_reconciliations
.Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/getBankReconciliations.
- [Read single] action
-
Endpoint URL address:
/bank_reconciliations/{{=paramters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify bank reconciliation identifier.
Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/getBankReconciliationsKey.
- [Create] action
-
Endpoint URL address:
/bank_reconciliations
.The following request parameters will be automatically processed:
-
application/json:
{{= { bank_reconciliation : item } }}
Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/postBankReconciliations.
-
application/json:
- [Update] action
-
Endpoint URL address:
/bank_reconciliations/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { bank_reconciliation : item } }}
Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/putBankReconciliationsKey.
-
application/json:
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- bank_account
Template: ReferenceT.
- statement_date
Template: DateTime.
- statement_end_balance
Data type: DT_R8
- reference
Template: ShortText.
- total_received
Data type: DT_R8
- total_paid
Data type: DT_R8
- starting_balance
Data type: DT_R8
- closing_balance
Data type: DT_R8
- reconciled_balance
Data type: DT_R8
- balance_difference
Data type: DT_R8
- status
Template: LedgerReferenceT.
- bank_account_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/bank_transfers
.Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/getBankTransfers.
- [Read single] action
-
Endpoint URL address:
/bank_transfers/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify bank transfer identifier.
Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/getBankTransfersKey.
- [Create] action
-
Endpoint URL address:
/bank_transfers
.The following request parameters will be automatically processed:
-
application/json:
{{= { bank_transfer : item } }}
Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/postBankTransfers.
-
application/json:
- [Update] action
-
Endpoint URL address:
/bank_transfers/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { bank_transfer : item } }}
Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/putBankTransfersKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/bank_transfers/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/banking/#operation/deleteBankTransfersKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- transaction
Template: ReferenceT.
- transaction_type
Template: ReferenceT.
- deleted_at
Template: DateTime.
- from_bank_account
Template: ToFromBankT.
- to_bank_account
Template: ToFromBankT.
- date
Template: DateTime.
- reference
Template: ShortText.
- amount
Data type: DT_R8
- description
Template: ShortText.
- from_bank_account_id
Template: ShortText.
- to_bank_account_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contact_allocations
.Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/getContactAllocations.
- [Read single] action
-
Endpoint URL address:
/contact_allocations/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/getContactAllocationsKey.
- [Create] action
-
Endpoint URL address:
/contact_allocations
.The following request parameters will be automatically processed:
-
application/json:
{{= { contact_allocation : item } }}
Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/postContactAllocations.
-
application/json:
- [Update] action
-
Endpoint URL address:
/contact_allocations/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { contact_allocation : item } }}
Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/putContactAllocationsKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/contact_allocations/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/deleteContactAllocationsKey.
- id
Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- links
Field components:
- An array.
-
Uses template:
LinkReferenceT
.
- transaction
Template: ReferenceT.
- transaction_type
Template: ReferenceT.
- deleted_at
Template: ShortText.
- date
Template: DateTime.
- contact
Template: ReferenceT.
- allocated_artefacts
Field components:
- An array.
- Contains the following components: id, artefact, amount, artefact_id.
- transaction_type_id
Template: ShortText.
- contact_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contact_payments
.Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/getContactPayments.
- [Read single] action
-
Endpoint URL address:
/contact_payments/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify contact payment identifier.
Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/getContactPaymentsKey.
- [Create] action
-
Endpoint URL address:
/contact_payments
.The following request parameters will be automatically processed:
-
application/json:
{{= { contact_payment : item } }}
Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/postContactPayments.
-
application/json:
- [Update] action
-
Endpoint URL address:
/contact_payments/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { contact_payment : item } }}
Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/putContactPaymentsKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/contact_payments/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/deleteContactPaymentsKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- links
Field components:
- An array.
-
Uses template:
LinkReferenceT
.
- transaction
Template: ReferenceT.
- transaction_type
Template: ReferenceT.
- deleted_at
Template: DateTime.
- payment_method
Template: ReferenceT.
- contact
Template: ReferenceT.
- bank_account
Template: ReferenceT.
- date
Template: DateTime.
- net_amount
Data type: DT_R8
- tax_amount
Data type: DT_R8
- total_amount
Data type: DT_R8
- currency
Template: ReferenceT.
- exchange_rate
Data type: DT_R8
- base_currency_net_amount
Data type: DT_R8
- base_currency_tax_amount
Data type: DT_R8
- base_currency_total_amount
Data type: DT_R8
- base_currency_currency_charge
Data type: DT_R8
- reference
Template: ShortText.
- allocated_artefacts
Field components:
- An array.
- Contains the following components: id, artefact, amount, discount.
- tax_rate
Template: ReferenceT.
- payment_on_account
Template: PaymentOnAccountT.
- editable
Data type: DT_BOOL
- transaction_type_id
Template: ShortText.
- contact_id
Template: ShortText.
- bank_account_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/other_payments
.Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/getOtherPayments.
- [Read single] action
-
Endpoint URL address:
/other_payments/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify other payment identifier.
Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/getOtherPaymentsKey.
- [Create] action
-
Endpoint URL address:
/other_payments
.The following request parameters will be automatically processed:
-
application/json:
{{= { other_payment : item } }}
Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/postOtherPayments.
-
application/json:
- [Update] action
-
Endpoint URL address:
/other_payments/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { other_payment : item } }}
Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/putOtherPaymentsKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/other_payments/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/deleteOtherPaymentsKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- transaction
Template: ReferenceT.
- transaction_type
Template: ReferenceT.
- deleted_at
Template: DateTime.
- base_currency_total_itc_amount
Data type: DT_R8
- total_itc_amount
Data type: DT_I4
- base_currency_total_itr_amount
Data type: DT_R8
- total_itr_amount
Data type: DT_R8
- part_recoverable
Data type: DT_BOOL
- payment_method
Template: ReferenceT.
- contact
Template: ReferenceT.
- bank_account
Template: ReferenceT.
- tax_address_region
Template: ReferenceT.
- date
Template: DateTime.
- net_amount
Data type: DT_R8
- tax_amount
Data type: DT_R8
- total_amount
Data type: DT_R8
- reference
Template: ShortText.
- payment_lines
Field components:
- An array.
- Contains the following components: id, displayed_as, ledger_account, details, tax_rate, net_amount, tax_amount, total_amount, tax_breakdown, is_purchase_for_resale, trade_of_asset, gst_amount, pst_amount, tax_recoverable.
- editable
Data type: DT_BOOL
- deletable
Data type: DT_BOOL
- withholding_tax_rate
Data type: DT_R8
- withholding_tax_amount
Data type: DT_R8
- transaction_type_id
Template: ShortText.
- payment_method_id
Template: ShortText.
- bank_account_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/unallocated_artefacts
.Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/getUnallocatedArtefacts.
- [Read single] action
-
Endpoint URL address:
/unallocated_artefacts/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify unallocated artefact identifier.
Documentation: https://developer.sage.com/api/accounting/api/payments/#operation/getUnallocatedArtefactsKey.
The resource includes the fields from the ArtefactT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/business_settings
.
The result is extracted from:{{=[response]}}
.Documentation: https://developer.sage.com/api/accounting/api/settings/#operation/getBusinessSettings.
- [Update] action
-
Endpoint URL address:
/business_settings
.The following request parameters will be automatically processed:
-
application/json:
{{={ business_settings : item } }}
Documentation: https://developer.sage.com/api/accounting/api/settings/#operation/putBusinessSettings.
-
application/json:
- $path
Template: ShortText.
- siret
Template: ShortText.
- management_centre_member
Data type: DT_BOOL
- rcs_number
Template: ShortText.
- share_capital
Data type: DT_I4
- business_activity_type
Template: ReferenceT.
- legal_form_type
Template: ReferenceT.
- auxiliary_accounts_visible
Data type: DT_BOOL
- default_ledger_accounts
Field components:
-
Uses template:
ReferenceT
. - Contains the following components: bank_charges_ledger_account, bank_interest_received_ledger_account, bank_interest_charges_paid_ledger_account, exchange_rate_gains_ledger_account, exchange_rate_losses_ledger_account, sales_ledger_account, sales_discount_ledger_account, purchase_ledger_account, purchase_discount_ledger_account, product_sales_ledger_account, product_purchase_ledger_account, service_sales_ledger_account, service_purchase_ledger_account, stock_purchase_ledger_account, other_receipt_ledger_account, other_payment_ledger_account, customer_receipt_discount_ledger_account, vendor_payment_discount_ledger_account, carriage_ledger_account.
-
Uses template:
- business_type
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, name, description.
-
Uses template:
- country_of_registration
Template: ReferenceT.
- business_created_at
Template: DateTime.
- updated_at
Template: DateTime.
- business_activity_type_id
Template: ShortText.
- legal_form_type_id
Template: ShortText.
- business_type_id
Template: ShortText.
- country_of_registration_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/business_types
.Documentation: https://developer.sage.com/api/accounting/api/settings/#operation/getBusinessTypes.
- id
Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- name
Template: ShortText.
- description
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/datev_settings
.Documentation: https://developer.sage.com/api/accounting/api/settings/#operation/getDatevSettings.
- [Update] action
-
Endpoint URL address:
/datev_settings
.The following request parameters will be automatically processed:
-
application/json:
{{={ datev_settings: item }}
Documentation: https://developer.sage.com/api/accounting/api/settings/#operation/putDatevSettings.
-
application/json:
- $path
Template: ShortText.
- tax_consultant_number
Data type: DT_I4
- client_number
Data type: DT_I4
- next_customer_number
Data type: DT_I4
- next_supplier_number
Data type: DT_I4
- updated_at
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/financial_settings
.
The result is extracted from:{{=[response]}}
.Documentation: https://developer.sage.com/api/accounting/api/settings/#operation/getFinancialSettings.
- [Update] action
-
Endpoint URL address:
/financial_settings
.The following request parameters will be automatically processed:
-
application/json:
{{={ financial_settings: item } }}
Documentation: https://developer.sage.com/api/accounting/api/settings/#operation/putBusinessSettings.
-
application/json:
- $path
Template: ShortText.
- year_end_date
Template: DateTime.
- year_end_lockdown_date
Template: DateTime.
- accounting_type
Template: ShortText.
- accounts_start_date
Template: DateTime.
- base_currency
Template: ReferenceT.
- multi_currency_enabled
Data type: DT_BOOL
- use_live_exchange_rates
Data type: DT_BOOL
- mtd_activation_status
Template: ShortText.
- mtd_connected
Data type: DT_BOOL
- mtd_authenticated_date
Template: DateTime.
- tax_scheme
Template: ReferenceT.
- tax_return_frequency
Template: ReferenceT.
- tax_number
Template: ShortText.
- general_tax_number
Template: ShortText.
- tax_office
Template: ReferenceT.
- default_irpf_rate
Data type: DT_R8
- flat_rate_tax_percentage
Data type: DT_R8
- recoverable_percentage
Data type: DT_R8
- sales_tax_calculation
Template: ShortText.
- purchase_tax_calculation
Template: ShortText.
- updated_at
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/invoice_settings
.
The result is extracted from:{{=[response]}}
.Documentation: https://developer.sage.com/api/accounting/api/settings/#operation/getInvoiceSettings.
- [Update] action
-
Endpoint URL address:
/invoice_settings
.The following request parameters will be automatically processed:
-
application/json:
{{={ invoice_settings : item } }}
Documentation: https://developer.sage.com/api/accounting/api/settings/#operation/putInvoiceSettings.
-
application/json:
- $path
Template: ShortText.
- next_invoice_number
Data type: DT_I4
- next_credit_note_number
Data type: DT_I4
- separate_invoice_credit_note_numbering
Data type: DT_BOOL
- sales_invoice_number_prefix
Template: ShortText.
- sales_credit_note_number_prefix
Template: ShortText.
- invoice_terms_and_conditions
Template: ShortText.
- default_note_on_invoice
Template: ShortText.
- default_note_on_credit_note
Template: ShortText.
- next_quote_number
Data type: DT_I4
- quote_number_prefix
Template: ShortText.
- estimate_number_prefix
Template: ShortText.
- quote_default_days_to_expiry
Data type: DT_I4
- estimate_default_days_to_expiry
Data type: DT_I4
- quote_terms_and_conditions
Template: ShortText.
- estimate_terms_and_conditions
Template: ShortText.
- delivery_note_terms_and_conditions
Template: ShortText.
- delivery_note_show_signature
Data type: DT_BOOL
- delivery_note_show_picked
Data type: DT_BOOL
- delivery_note_show_notes
Data type: DT_BOOL
- delivery_note_show_contact_details
Data type: DT_BOOL
- quick_entry_prefix
Template: ShortText.
- late_payment_percentage
Data type: DT_R8
- prompt_payment_percentage
Data type: DT_R8
- show_auto_entrepreneur
Data type: DT_BOOL
- show_insurance
Data type: DT_BOOL
- insurer
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, created_at, updated_at, links, deleted_at, balance, contact_types, name, reference, default_sales_ledger_account, default_sales_tax_rate, default_purchase_ledger_account, tax_number, notes, locale, main_address, delivery_address, main_contact_person, bank_account_details, credit_limit, credit_days, credit_terms_and_conditions, product_sales_price_type, source_guid, currency, aux_reference, registered_number, deletable, tax_treatment, email, tax_calculation, auxiliary_account, gdpr_obfuscated, system, has_unfinished_recurring_invoices, cis_registered, cis_settings.
-
Uses template:
- insurance_area
Template: ShortText.
- insurance_type
Template: ShortText.
- insurance_text
Template: ShortText.
- payment_bank_account
Template: ReferenceT.
- sales_corrective_invoice_number_prefix
Template: ShortText.
- next_sales_corrective_invoice_number
Data type: DT_I4
- document_headings
Field components:
-
Uses template:
ShortText
. - Contains the following components: sales_invoice, sales_credit_note, sales_corrective_invoice, sales_quote, sales_estimate, pro_forma, remittance_advice, statement, delivery_note.
-
Uses template:
- line_item_titles
Field components:
-
Uses template:
ShortText
. - Contains the following components: description, unit_price, quantity, discount.
-
Uses template:
- footer_details
Field components:
-
Uses template:
ShortText
. - Contains the following components: column_1, column_2, column_3.
-
Uses template:
- print_contact_details
Field components:
-
Uses template:
ShortText
. - Contains the following components: business_name, website, telephone, mobile, email_address, due_date, default_delivery_address.
-
Uses template:
- print_statements
Field components:
- Contains the following components: days_overdue, table_of_balances.
- customer_credit_days
Data type: DT_I4
- vendor_credit_days
Data type: DT_I4
- updated_at
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/attachments
.Documentation: https://developer.sage.com/api/accounting/api/attachments/#operation/getAttachments.
- [Read single] action
-
Endpoint URL address:
/attachments/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify attachment identifier.
Documentation: https://developer.sage.com/api/accounting/api/attachments/#operation/getAttachmentsKey.
- [Create] action
-
Endpoint URL address:
/attachments
.The following request parameters will be automatically processed:
-
application/json:
{{={ attachment : item } }}
Documentation: https://developer.sage.com/api/accounting/api/attachments/#operation/postAttachments.
-
application/json:
- [Update] action
-
Endpoint URL address:
/attachment/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { attachment : item } }}
Documentation: https://developer.sage.com/api/accounting/api/attachments/#operation/putAttachmentsKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/attachments/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/attachments/#operation/deleteAttachmentsKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- deleted_at
Template: DateTime.
- file
Data type: DT_IMAGE The value is gathered from
/attachments/{{=item.id}}/file
address. Before setting, the value is processed with{{=getClrType('System.Convert').ToBase64String(value.readAll())}}
expression.- mime_type
Template: ShortText.
- description
Template: ShortText.
- file_extension
Template: ShortText.
- transaction
Template: ReferenceT.
- file_size
Data type: DT_I4
- file_name
Template: ShortText.
- $file_path
Template: ShortText.
- attachment_context_type
Template: ReferenceT.
- attachment_context
Template: ReferenceT.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- transaction_id
Template: ShortText.
- attachment_context_type_id
Template: ShortText.
- attachment_context_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/exchange_rates
.Documentation: https://developer.sage.com/api/accounting/api/currencies/#operation/getExchangeRates.
- [Read business] action
-
Endpoint URL address:
/business_exchange_rates
.Documentation: https://developer.sage.com/api/accounting/api/currencies/#operation/getBusinessExchangeRates.
- [Read live] action
-
Endpoint URL address:
/live_exchange_rates
.Documentation: https://developer.sage.com/api/accounting/api/currencies/#operation/getLiveExchangeRates.
- [Create] action
-
Endpoint URL address:
/business_exchange_rates
.The following request parameters will be automatically processed:
-
application/json:
{{= { business_exchange_rate: item } }}
Documentation: https://developer.sage.com/api/accounting/api/currencies/#operation/postBusinessExchangeRates.
-
application/json:
- [Update] action
-
Endpoint URL address:
/business_exchange_rates/{{=item.currency_id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { business_exchange_rate: item } }}
Documentation: https://developer.sage.com/api/accounting/api/currencies/#operation/putBusinessExchangeRatesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/business_exchange_rates/{{=item.currency_id}}
.Documentation: https://developer.sage.com/api/accounting/api/currencies/#operation/deleteBusinessExchangeRatesKey.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- rate
Data type: DT_R8
- inverse_rate
Data type: DT_R8
- base_currency
Template: ReferenceT.
- currency
Template: ReferenceT.
- currency_id
Template: ShortText.
- base_currency_id
Template: ShortText.
- retrieved_at
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tax_offices
.Documentation: https://developer.sage.com/api/accounting/api/taxes/#operation/getTaxOffices.
- [Read single] action
-
Endpoint URL address:
/tax_offices
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify tax office identifier.
Documentation: https://developer.sage.com/api/accounting/api/taxes/#operation/getTaxOfficesKey.
- id
Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- office_number
Template: ShortText.
- name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tax_profiles
.Documentation: https://developer.sage.com/api/accounting/api/taxes/#operation/getTaxProfiles.
- [Read single] action
-
Endpoint URL address:
/tax_profiles
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify tax profile identifier.
Documentation: https://developer.sage.com/api/accounting/api/taxes/#operation/getTaxProfilesKey.
- [Update] action
-
Endpoint URL address:
/tax_profiles/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { tax_profile : item } }}
Documentation: https://developer.sage.com/api/accounting/api/taxes/#operation/putTaxProfilesKey.
-
application/json:
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- tax_type
Template: ReferenceT.
- tax_number
Template: ShortText.
- tax_number_suffix
Template: ShortText.
- collect_tax
Data type: DT_BOOL
- tax_return_frequency
Template: ReferenceT.
- address_region
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, $path, code, displayed_as.
-
Uses template:
- tax_type_id
Template: ShortText.
- tax_return_frequency_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tax_rates
.Documentation: https://developer.sage.com/api/accounting/api/taxes/#operation/getTaxRates.
- [Read single] action
-
Endpoint URL address:
/tax_rates/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify tax rate identifier.
Documentation: https://developer.sage.com/api/accounting/api/taxes/#operation/getTaxRatesKey.
- [Create] action
-
Endpoint URL address:
/tax_rates
.The following request parameters will be automatically processed:
-
application/json:
{{={ tax_rate : item } }}
Documentation: https://developer.sage.com/api/accounting/api/taxes/#operation/postTaxRates.
-
application/json:
- [Update] action
-
Endpoint URL address:
/tax_rates/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ tax_rate : item } }}
Documentation: https://developer.sage.com/api/accounting/api/taxes/#operation/putTaxRatesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/tax_rates/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/taxes/#operation/deleteTaxRatesKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- name
Template: ShortText.
- agency
Template: ShortText.
- percentage
Data type: DT_R8
- percentages
Field components:
- An array.
- Contains the following components: percentage, from_date, to_date.
- is_visible
Data type: DT_BOOL
- retailer
Data type: DT_BOOL
- editable
Data type: DT_BOOL
- deletable
Data type: DT_BOOL
- is_combined_rate
Data type: DT_BOOL
- component_tax_rates
Field components:
- An array.
- Contains the following components: id, displayed_as, $path, created_at, updated_at, name, agency, percentage, percentages, is_visible, retailer, editable, deletable, is_combined_rate.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tax_types
.Documentation: https://developer.sage.com/api/accounting/api/taxes/#operation/getTaxTypes.
- [Read single] action
-
Endpoint URL address:
/tax_types/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify tax type identifier.
Documentation: https://developer.sage.com/api/accounting/api/taxes/#operation/getTaxTypesKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- federal_tax
Data type: DT_BOOL
- country
Template: ReferenceT.
- address_regions
Field components:
- An array.
-
Uses template:
ReferenceT
.
- tax_rates
Field components:
- An array.
-
Uses template:
ReferenceT
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contact_opening_balances
.
The result is extracted from:{{= response.$items }}
.Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/getContactOpeningBalances.
- [Read single] action
-
Endpoint URL address:
/contact_opening_balances/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Specify contact opening balance identifier.
Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/getContactOpeningBalancesKey.
- [Create] action
-
Endpoint URL address:
/contact_opening_balances
.The following request parameters will be automatically processed:
-
application/json:
{{={ contact_opening_balance: item } }}
Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/postContactOpeningBalances.
-
application/json:
- [Update] action
-
Endpoint URL address:
/contact_opening_balances/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ contact_opening_balance: item } }}
Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/putContactOpeningBalancesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/contact_opening_balances/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/deleteContactOpeningBalancesKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- transaction
Template: ReferenceT.
- transaction_type
Template: ReferenceT.
- deleted_at
Template: DateTime.
- contact_opening_balance_type
Template: ReferenceT.
- contact
Template: ReferenceT.
- date
Template: DateTime.
- reference
Template: ShortText.
- details
Template: ShortText.
- net_amount
Data type: DT_R8
- tax_rate
Template: ReferenceT.
- tax_amount
Data type: DT_R8
- tax_breakdown
Field components:
- An array.
-
Uses template:
TaxBreakdownT
.
- total_amount
Data type: DT_R8
- currency
Template: ReferenceT.
- exchange_rate
Data type: DT_R8
- base_currency_net_amount
Data type: DT_R8
- base_currency_tax_amount
Data type: DT_R8
- base_currency_tax_breakdown
Field components:
- An array.
-
Uses template:
TaxBreakdownT
.
- base_currency_total_amount
Data type: DT_R8
- contact_opening_balance_type_id
Template: ShortText.
- contact_id
Template: ShortText.
- transaction_type_id
Template: ShortText.
- tax_rate_id
Template: ShortText.
- currency_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/bank_opening_balances
.Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/getBankOpeningBalances.
- [Read single] action
-
Endpoint URL address:
/bank_opening_balances/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/getBankOpeningBalancesKey.
- [Create] action
-
Endpoint URL address:
/bank_opening_balances
.The following request parameters will be automatically processed:
-
application/json:
{{= { bank_opening_balance: item } }}
Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/postBankOpeningBalances.
-
application/json:
- [Update] action
-
Endpoint URL address:
/bank_opening_balances/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{= { bank_opening_balance } }}
Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/putBankOpeningBalancesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/bank_opening_balances/{{= item.id }}
.Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/deleteBankOpeningBalancesKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- transaction
Template: ReferenceT.
- transaction_type
Template: ReferenceT.
- bank_account
Template: ReferenceT.
- date
Template: DateTime.
- debit
Data type: DT_R8
- credit
Data type: DT_R8
- bank_account_id
Template: ShortText.
- transaction_type_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ledger_account_opening_balances
.Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/getLedgerAccountOpeningBalances.
- [Read single] action
-
Endpoint URL address:
/ledger_account_opening_balances/{{= parameters.id }}
.The action has the following user-defined parameters:
- id: Required. Specify ledger account opening balance identifier.
Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/getLedgerAccountOpeningBalancesKey.
- [Create] action
-
Endpoint URL address:
/ledger_account_opening_balances
.The following request parameters will be automatically processed:
-
application/json:
{{={ ledger_account_opening_balance: item } }}
Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/postLedgerAccountOpeningBalances.
-
application/json:
- [Update] action
-
Endpoint URL address:
/ledger_account_opening_balances/{{= item.id }}
.The following request parameters will be automatically processed:
-
application/json:
{{={ ledger_account_opening_balance: item }}
Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/putLedgerAccountOpeningBalancesKey.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/ledger_account_opening_balances/{{= item.id }}
.Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/deleteLedgerAccountOpeningBalancesKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- ledger_account
Template: ReferenceT.
- details
Template: ShortText.
- debit
Data type: DT_R8
- credit
Data type: DT_R8
- ledger_account_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/opening_balance_journals
.Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/getOpeningBalanceJournals.
- [Create] action
-
Endpoint URL address:
/opening_balance_journals
.The following request parameters will be automatically processed:
-
application/json:
{{={ opening_balance_journal: item } }}
Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/postOpeningBalanceJournals.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/opening_balance_journals/{{=item.id}}
.Documentation: https://developer.sage.com/api/accounting/api/opening-balances/#operation/deleteOpeningBalanceJournalsKey.
- id
A key field. Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- transaction
Template: ReferenceT.
- transaction_type
Template: ReferenceT.
- deleted_at
Template: DateTime.
- date
Template: DateTime.
- reference
Template: ShortText.
- journal_lines
Field components:
- An array.
- Contains the following components: id, ledger_account, details, debit, credit, ledger_account_id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/trial_balance
.
The result is extracted from:{{=response.trial_balance.ledger_accounts}}
.The action has the following user-defined parameters:
- from_date: Required. Specify from date.
- to_date: Required. Specify to date.
- id
Template: ShortText.
- displayed_as
Template: ShortText.
- $path
Template: ShortText.
- opening_balance
Field components:
- Contains the following components: credit, debit.
- closing_balance
Field components:
- Contains the following components: credit, debit.
- credit
Data type: DT_R8
- debit
Data type: DT_R8
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/businesses
.Documentation: https://developer.sage.com/api/accounting/api/user-businesses/#tag/Businesses%2Fpaths%2F~1businesses%2Fget.
- [Read single] action
-
Endpoint URL address:
/businesses/{{=parameters.id}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- id: Required. Please specify business identifier.
Documentation: https://developer.sage.com/api/accounting/api/user-businesses/#tag/Businesses%2Fpaths%2F~1businesses~1%7Bkey%7D%2Fget.
- [Update] action
-
Endpoint URL address:
/businesses/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ business: item } }}
Documentation: https://developer.sage.com/api/accounting/api/user-businesses/#tag/Businesses%2Fpaths%2F~1businesses~1%7Bkey%7D%2Fput.
-
application/json:
- id
A key field. Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- displayed_as
Template: ShortText.
- name
Template: ShortText.
- address_line_1
Template: ShortText.
- address_line_2
Template: ShortText.
- city
Template: ShortText.
- postal_code
Template: ShortText.
- country
Template: LedgerReferenceT.
- region
Template: ShortText.
- telephone
Template: ShortText.
- mobile
Template: ShortText.
- website
Template: ShortText.
- is_demo
Data type: DT_BOOL
- subscriptions
Field components:
- An array.
- Contains the following components: id, created_at, updated_at, displayed_as, active, status.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/user
.
The result is extracted from:{{=[response]}}
.Documentation: https://developer.sage.com/api/accounting/api/user-businesses/#tag/User%2Fpaths%2F~1user%2Fget.
- [Update] action
-
Endpoint URL address:
/user
.The following request parameters will be automatically processed:
-
application/json:
{{={ user: item } }}
Documentation: https://developer.sage.com/api/accounting/api/user-businesses/#tag/User%2Fpaths%2F~1user%2Fput.
-
application/json:
- id
A key field. Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- displayed_as
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- initials
Template: ShortText.
Template: ShortText.
- locale
Template: ShortText.
- [Read] action
-
The result is extracted from:{{=response.$items}}
.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}}
-
items_per_page:
{{=parameters.batchSize}}
-
attributes:
{{=_.filter(_.without(parameters.fields, '$path'), function(field) { return field.indexOf('.') == -1; }).join()}}
-
nested_attributes:
all
-
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- ReferenceT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path.
-
Uses template:
- LinkReferenceT
Field components:
-
Uses template:
ShortText
. - Contains the following components: rel, href, type.
-
Uses template:
- BaseAddressT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, address_line_1, address_line_2, city, postal_code, country, deleted_at, address_type, region, country_group.
-
Uses template:
- AddressT
Template: BaseAddressT. Field components:
-
Uses template:
DateTime
. - Contains the following components: created_at, updated_at, bank_account, contact, name, is_main_contact.
-
Uses template:
- MainContactT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, created_at, updated_at, deleted_at, contact_person_types, name, job_title, telephone, mobile, email, fax, is_main_contact, address, is_preferred_contact.
-
Uses template:
- BankAccountT
Field components:
-
Uses template:
ShortText
. - Contains the following components: account_name, account_number, sort_code, bic, iban.
-
Uses template:
- LedgerReferenceT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as.
-
Uses template:
- BalanceT
Field components:
-
Uses template:
ShortText
. - Contains the following components: balance, credit_or_debit, credits, debits, from_date, to_date.
-
Uses template:
- LedgerAccountT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, created_at, updated_at, ledger_account_group, name, display_name, visible_scopes, included_in_chart, nominal_code, ledger_account_type, ledger_account_classification, tax_rate, fixed_tax_rate, visible_in_banking, visible_in_expenses, visible_in_journals, visible_in_other_payments, visible_in_other_receipts, visible_in_reporting, visible_in_sales, balance_details, is_control_account, control_name, display_formatted, tax_recoverable, recoverable_percentage, non_recoverable_ledger_account, cis_materials, cis_labour, gifi_code.
-
Uses template:
- SalesPriceT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, created_at, updated_at, price_name, price, price_includes_tax, product_sales_price_type, product_sales_price_type_id.
-
Uses template:
- ArtefactT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, links.
-
Uses template:
- TransactionT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, created_at, updated_at, date, deleted, reference, total, total_in_transaction_currency, contact, transaction_type, origin, audit_trail_id, number_of_attachments.
-
Uses template:
- ContactT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, created_at, updated_at, links, deleted_at, balance, contact_types, name, reference, default_sales_ledger_account, default_sales_tax_rate, default_purchase_ledger_account, tax_number, notes, locale, main_address, delivery_address, main_contact_person, bank_account_details, credit_limit, credit_days, credit_terms_and_conditions, product_sales_price_type, source_guid, currency, aux_reference, registered_number, deletable, tax_treatment, email, tax_calculation, auxiliary_account, gdpr_obfuscated, system, has_unfinished_recurring_invoices, cis_registered, cis_settings.
-
Uses template:
- ProductT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, created_at, updated_at, deleted_at, deletable, deactivatable, used_on_recurring_invoice, item_code, description, notes, sales_ledger_account, sales_tax_rate, purchase_ledger_account, usual_supplier, purchase_tax_rate, cost_price, sales_prices, source_guid, purchase_description, active, catalog_item_type.
-
Uses template:
- TaxRateT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, created_at, updated_at, name, agency, percentage, percentages, is_visible, retailer, editable, deletable, is_combined_rate, component_tax_rates.
-
Uses template:
- PaymentOnAccountT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, created_at, updated_at, contact_name, contact_reference, contact, date, reference, net_amount, tax_amount, total_amount, outstanding_amount, currency, exchange_rate, base_currency_net_amount, base_currency_tax_amount, base_currency_total_amount, base_currency_outstanding_amount, status.
-
Uses template:
- TaxAnalysisT
Field components:
-
Uses template:
ReferenceT
. - Contains the following components: tax_rate, net_amount, tax_amount, total_amount, goods_amount, service_amount.
-
Uses template:
- DetailedAnalysisT
Field components:
- Contains the following components: tax_rates_breakdown, total_net, total_tax, total, total_goods_amount, total_services_amount, base_currency_total_net, base_currency_total_tax, base_currency_total, base_currency_total_goods_amount, base_currency_total_services_amount, total_retailer_tax.
- JournalCodeT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, created_at, updated_at, name, code, journal_code_type, control_name, reserved.
-
Uses template:
- ToFromBankT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, created_at, updated_at, deleted_at, bank_account_details, ledger_account, bank_account_type, balance, main_address, main_contact_person, nominal_code, editable, deletable, journal_code, default_payment_method, gifi_code.
-
Uses template:
- TaxTreatmentT
Field components:
- Contains the following components: home_tax, eu_tax_registered, eu_not_tax_registered, rest_of_world_tax, is_importer.
- ContactPaymentT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, created_at, updated_at, links, transaction, transaction_type, deleted_at, payment_method, contact, bank_account, date, net_amount, tax_amount, total_amount, currency, exchange_rate, base_currency_net_amount, base_currency_tax_amount, base_currency_total_amount, base_currency_currency_charge, reference, allocated_artefacts, tax_rate, payment_on_account, editable.
-
Uses template:
- SalesRateT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, created_at, updated_at, rate_name, rate, rate_includes_tax, service_rate_type, service_rate_type_id.
-
Uses template:
- ServiceT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, created_at, updated_at, deleted_at, deletable, deactivatable, used_on_recurring_invoice, item_code, description, notes, sales_ledger_account, purchase_ledger_account, sales_tax_rate, purchase_tax_rate, sales_rates, source_guid, purchase_description, usual_supplier, active.
-
Uses template:
- PaymentAllocationT
Field components:
-
Uses template:
ShortText
. - Contains the following components: links, date, type, reference, amount, discount, stripe_transaction_id, contact_allocation, artefact, contact_payment, displayed_as, negative_payment.
-
Uses template:
- StockItemT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, created_at, updated_at, deleted_at, deletable, deactivatable, used_on_recurring_invoice, item_code, description, notes, sales_ledger_account, sales_tax_rate, purchase_ledger_account, usual_supplier, purchase_tax_rate, cost_price, sales_prices, source_guid, purchase_description, reorder_level, reorder_quantity, location, barcode, supplier_part_number, weight, measurement_unit, weight_converted, active, quantity_in_stock, last_cost_price, last_cost_price_stock_value, average_cost_price, average_cost_price_stock_value, cost_price_last_updated.
-
Uses template:
- TaxBreakdownT
Field components:
-
Uses template:
ReferenceT
. - Contains the following components: tax_rate, percentage, amount.
-
Uses template:
- BaseLineT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, description, product, service, ledger_account, trade_of_asset, quantity, unit_price, net_amount, tax_rate, tax_amount, tax_breakdown, total_amount, base_currency_unit_price, unit_price_includes_tax, base_currency_net_amount, base_currency_tax_amount, base_currency_tax_breakdown, base_currency_total_amount, eu_goods_services_type.
-
Uses template:
- ProfitAnalysisT
Field components:
- Contains the following components: total, line_breakdown.
- BaseTransactionT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, displayed_as, $path, created_at, updated_at, links, editable, transaction, transaction_type, contact, deleted_at, contact_name, contact_reference, date, due_date, reference, notes, total_quantity, net_amount, tax_amount, total_amount, payments_allocations_total_amount, payments_allocations_total_discount, total_paid, outstanding_amount, currency, exchange_rate, inverse_exchange_rate, base_currency_net_amount, base_currency_tax_amount, base_currency_total_amount, base_currency_outstanding_amount, status, void_reason, tax_analysis, detailed_tax_analysis, payments_allocations, last_paid, withholding_tax_rate, withholding_tax_amount, base_currency_withholding_tax_amount.
-
Uses template:
- SaleTransactionT
Template: BaseTransactionT. Field components:
-
Uses template:
ShortText
. - Contains the following components: tax_calculation_method, main_address_free_form, main_address, delivery_address_free_form, delivery_address, terms_and_conditions, shipping_net_amount, shipping_tax_rate, shipping_tax_amount, shipping_tax_breakdown, shipping_total_amount, base_currency_shipping_net_amount, base_currency_shipping_tax_amount, base_currency_shipping_tax_breakdown, base_currency_shipping_total_amount, sent, sent_by_email, tax_reconciled, total_discount_amount, base_currency_total_discount_amount.
-
Uses template:
- SaleCorrectionT
Template: SaleTransactionT. Field components:
-
Uses template:
ArtefactT
. - Contains the following components: original_invoice, original_invoice_number, original_invoice_date, invoice_lines, invoice_number_prefix, invoice_number, corrective_reason_code, details.
-
Uses template:
- PurchaseTransactionT
Template: BaseTransactionT. Field components:
-
Uses template:
ShortText
. - Contains the following components: vendor_reference, import, tax_reconciled.
-
Uses template:
- PurchaseCorrectionT
Template: PurchaseTransactionT. Field components:
-
Uses template:
ArtefactT
. - Contains the following components: original_invoice, original_invoice_number, original_invoice_date, invoice_lines.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.