Skip to content

SDK for the Ungerboeck API generated with the swagger codegen project, which allows generation of API client libraries (SDK generation).

Notifications You must be signed in to change notification settings

AWAREcode/ungerboeck-sdk-php

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

UngerboeckSDK

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: 20.94.1.1
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/AWAREcode/ungerboeck-sdk-php.git"
    }
  ],
  "require": {
    "AWAREcode/ungerboeck-sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/UngerboeckSDK/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new FomF\Ungerboeck\Client\Api\APDemographicsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$org_code = "org_code_example"; // string | The organization code of the ap demographic.
$supplier = "supplier_example"; // string | The supplier of the ap demographic.

try {
    $result = $apiInstance->aPDemographicsGetAPDemographic($org_code, $supplier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling APDemographicsApi->aPDemographicsGetAPDemographic: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://fomf.ungerboeck.com/TEST

Class Method HTTP request Description
APDemographicsApi aPDemographicsGetAPDemographic GET /api/v1/APDemographics/{OrgCode}/{Supplier} Standard - Get a single ap demographic by its parameters
APDemographicsApi aPDemographicsGetAPDemographicList GET /api/v1/APDemographics/{OrgCode} Standard - Search for ap demographic using OData.
APPaymentTaxesApi aPPaymentTaxesGetAPPaymentTax GET /api/v1/APPaymentTaxes/{OrgCode}/{Sequence}/{Voucher}/{VoucherTaxSeq} Standard - Retrieve a APPaymentTaxes record
APPaymentTaxesApi aPPaymentTaxesGetAPPaymentTaxList GET /api/v1/APPaymentTaxes/{OrgCode} Standard - Search for APPaymentTaxes using OData.
APTaxesApi aPTaxesGetAPTax GET /api/v1/APTaxes/{OrgCode}/{SupplierAccountCode}/{SequenceNumber} Standard - Get an ap tax by its parameters
APTaxesApi aPTaxesGetAPTaxList GET /api/v1/APTaxes/{OrgCode} Standard - Search for ap taxes using OData.
ARDemographicsApi aRDemographicsDeleteARDemographic DELETE /api/v1/ARDemographics/{OrgCode}/{Account} Standard - Delete AR demographics
ARDemographicsApi aRDemographicsGetARDemographic GET /api/v1/ARDemographics/{OrgCode}/{Account} Standard - Get a single AR demographic entry by its parameters
ARDemographicsApi aRDemographicsGetARDemographicList GET /api/v1/ARDemographics/{OrgCode} Standard - Search for AR demographics using OData.
ARDemographicsApi aRDemographicsPostARDemographic POST /api/v1/ARDemographics Standard - Add new AR demographic entry
ARDemographicsApi aRDemographicsPutARDemographic PUT /api/v1/ARDemographics/{OrgCode}/{Account} Standard - Edit AR demographics
AccountAffiliationsApi accountAffiliationsDeleteAccountAffiliation DELETE /api/v1/AccountAffiliations/{OrgCode}/{AccountCode}/{AffiliationCode} Standard - Remove an affiliation from an account
AccountAffiliationsApi accountAffiliationsGetAccountAffiliation GET /api/v1/AccountAffiliations/{OrgCode}/{AccountCode}/{AffiliationCode} Basic - Get a single affiliation on an account by its parameters
AccountAffiliationsApi accountAffiliationsGetAccountAffiliationList GET /api/v1/AccountAffiliations/{OrgCode} Basic - Search for account affiliations using OData.
AccountAffiliationsApi accountAffiliationsPostAccountAffiliation POST /api/v1/AccountAffiliations Standard - Add an affiliation to an account
AccountLeadsApi accountLeadsDeleteAccountLead DELETE /api/v1/AccountLeads/{OrgCode}/{LeadId} Standard - Delete Account lead entry
AccountLeadsApi accountLeadsGetAccountLead GET /api/v1/AccountLeads/{OrgCode}/{LeadId} Standard - Get a single Account Lead entry by its parameters
AccountLeadsApi accountLeadsGetAccountLeads GET /api/v1/AccountLeads/{OrgCode} Standard - Search for Account lead using OData.
AccountLeadsApi accountLeadsPostAccountLead POST /api/v1/AccountLeads Standard - Add new Account Lead entry
AccountLeadsApi accountLeadsPutAccountLead PUT /api/v1/AccountLeads/{OrgCode}/{LeadId} Standard - Edit Account Lead entry
AccountMailingListsApi accountMailingListsDeleteAccountMailingList DELETE /api/v1/AccountMailingLists/{OrgCode}/{ID} Standard - Remove a Mailing list from an account
AccountMailingListsApi accountMailingListsGetAccountMailingList GET /api/v1/AccountMailingLists/{OrgCode}/{ID} Standard - Get a single account mailing list entry by its parameters
AccountMailingListsApi accountMailingListsGetAccountMailingListList GET /api/v1/AccountMailingLists/{OrgCode} Standard - Search for account mailing list using OData.
AccountMailingListsApi accountMailingListsPostAccountMailingList POST /api/v1/AccountMailingLists Standard - Add a Mailing list to an account
AccountMailingListsApi accountMailingListsPutAccountMailingList PUT /api/v1/AccountMailingLists/{OrgCode}/{Id} Standard - Edit account Mailing list
AccountProductsAndServicesApi accountProductsAndServicesDeleteAccountProductService DELETE /api/v1/AccountProductsAndServices/{OrgCode}/{AccountCode}/{ProductServiceCode} Standard - Remove a product/service from an account
AccountProductsAndServicesApi accountProductsAndServicesGetAccountProductAndServiceList GET /api/v1/AccountProductsAndServices/{OrgCode} Basic - Search for account products and services using OData.
AccountProductsAndServicesApi accountProductsAndServicesGetAccountProductService GET /api/v1/AccountProductsAndServices/{OrgCode}/{AccountCode}/{ProductServiceCode} Basic - Get a single product/service on an account by its parameters
AccountProductsAndServicesApi accountProductsAndServicesPostAccountProductService POST /api/v1/AccountProductsAndServices Standard - Add a product/service to an account
AccountTypesApi accountTypesGetAccountType GET /api/v1/AccountTypes/{OrgCode}/{Code} Basic - Get a single account type by its parameters
AccountTypesApi accountTypesGetAccountTypeList GET /api/v1/AccountTypes/{OrgCode} Basic - Search for account type using OData.
AccountsApi accountsGetAccount GET /api/v1/Accounts/{OrgCode}/{AccountCode} Basic - Get a single account by its parameters
AccountsApi accountsGetAccountList GET /api/v1/Accounts/{OrgCode} Basic - Search for accounts using OData. Note, this will not return user fields. Use the single GET endpoint to retrieve user fields.
AccountsApi accountsPostAccount POST /api/v1/Accounts Standard - Add an account
AccountsApi accountsPutAccount PUT /api/v1/Accounts/{OrgCode}/{AccountCode} Standard - Edit an account
AccountsReceivableVoucherAllocationsApi accountsReceivableVoucherAllocationsGetAccountsReceivableVoucherAllocation GET /api/v1/AccountsReceivableVoucherAllocations/{OrgCode}/{VoucherSequence}/{VoucherDetailSequence} Standard - Retrieve a AccountsReceivableVoucherAllocations record
AccountsReceivableVoucherAllocationsApi accountsReceivableVoucherAllocationsGetAccountsReceivableVoucherAllocationList GET /api/v1/AccountsReceivableVoucherAllocations/{OrgCode} Standard - Search for AccountsReceivableVoucherAllocations using OData.
AccountsReceivableVouchersApi accountsReceivableVouchersGetAccountsReceivableVoucher GET /api/v1/AccountsReceivableVouchers/{OrgCode}/{VoucherSequence} Standard - Get a single accounts receivable voucher by its parameters
AccountsReceivableVouchersApi accountsReceivableVouchersGetAccountsReceivableVoucherList GET /api/v1/AccountsReceivableVouchers/{OrgCode} Standard - Search for accounts receivable vouchers using OData.
ActivitiesApi activitiesDeleteActivity DELETE /api/v1/Activities/{OrgCode}/{AccountCode}/{SequenceNumber} Basic - Delete an activity
ActivitiesApi activitiesGetActivity GET /api/v1/Activities/{OrgCode}/{AccountCode}/{SequenceNumber} Basic - Get a single activity by its parameters
ActivitiesApi activitiesGetActivityList GET /api/v1/Activities/{OrgCode} Basic - Search for activities using OData.
ActivitiesApi activitiesPostActivity POST /api/v1/Activities Basic - Add an activity
ActivitiesApi activitiesPutActivity PUT /api/v1/Activities/{OrgCode}/{AccountCode}/{SequenceNumber} Basic - Edit an activity
AffiliationsApi affiliationsGetAffiliation GET /api/v1/Affiliations/{OrgCode}/{AffiliationCode} Basic - Get a single affiliation by its parameters
AffiliationsApi affiliationsGetAffiliationList GET /api/v1/Affiliations/{OrgCode} Basic - Search for affiliations using OData.
AlternateAddressesApi alternateAddressesGetAlternateAddress GET /api/v1/AlternateAddresses/{OrgCode}/{Account}/{SequenceNumber}/{RecordType} Basic - Get a single alternate address by its parameters
AlternateAddressesApi alternateAddressesGetAlternateAddressList GET /api/v1/AlternateAddresses/{OrgCode} Basic - Search for alternate address using OData.
AssetBookDefaultsApi assetBookDefaultsGetAssetBookDefault GET /api/v1/AssetBookDefaults/{OrgCode}/{SequenceNumber} Standard - Get an Asset Book Default by its parameters
AssetBookDefaultsApi assetBookDefaultsGetAssetBookDefaultList GET /api/v1/AssetBookDefaults/{OrgCode} Standard - Search for Asset Book Defaults using OData.
AssetTransactionsApi assetTransactionsGetAssetTransaction GET /api/v1/AssetTransactions/{OrgCode}/{Asset}/{Book}/{Sequence} Standard - Get an asset transaction by its parameters
AssetTransactionsApi assetTransactionsGetAssetTransactionList GET /api/v1/AssetTransactions/{OrgCode} Standard - Search for asset transactions using OData.
AssetsDepreciationDetailsApi assetsDepreciationDetailsGetAssetsDepreciationDetail GET /api/v1/AssetsDepreciationDetails/{OrgCode}/{Sequence}/{Asset}/{Revision}/{Book} Standard - Retrieve a AssetsDepreciationDetail record
AssetsDepreciationDetailsApi assetsDepreciationDetailsGetAssetsDepreciationDetailList GET /api/v1/AssetsDepreciationDetails/{OrgCode} Standard - Search for AssetsDepreciationDetails using OData.
BankAccountsApi bankAccountsGetBankAccount GET /api/v1/BankAccounts/{OrgCode}/{Code} Standard - Get a single bank account by its parameters
BankAccountsApi bankAccountsGetBankAccountList GET /api/v1/BankAccounts/{OrgCode} Standard - Search for bank accounts using OData.
BankReconciliationsApi bankReconciliationsGetBankReconciliation GET /api/v1/BankReconciliations/{OrgCode}/{SequenceNumber} Standard - Get Bank Reconciliation by its parameters
BankReconciliationsApi bankReconciliationsGetBankReconciliationList GET /api/v1/BankReconciliations/{OrgCode} Standard - Search for Bank Reconciliations using OData.
BookingsApi bookingsGetBooking GET /api/v1/Bookings/{OrgCode}/{Event}/{SequenceNumber} Basic - Get a single booking by its parameters
BookingsApi bookingsGetBookingList GET /api/v1/Bookings/{OrgCode} Basic - Search for bookings using OData.
BookingsApi bookingsPostBooking POST /api/v1/Bookings Extended (Bookings) - Add a booking to an existing event
BookingsApi bookingsPutBooking PUT /api/v1/Bookings/{OrgCode}/{Event}/{SequenceNumber} Extended (Bookings) - Edit a booking on an event
BoothsApi boothsDeleteBooth DELETE /api/v1/Booths/{OrgCode}/{SequenceNumber} Standard - Delete a Booth
BoothsApi boothsGetBooth GET /api/v1/Booths/{OrgCode}/{SequenceNumber} Standard - Get a single booth by its parameters
BoothsApi boothsGetBoothList GET /api/v1/Booths/{OrgCode} Standard - Search for booth using OData.
BoothsApi boothsPostBooth POST /api/v1/Booths Standard - Add a Booth
BoothsApi boothsPutBooth PUT /api/v1/Booths/{OrgCode}/{SequenceNumber} Standard - Edit a Booth
BudgetTransactionsApi budgetTransactionsGetBudgetTransaction GET /api/v1/BudgetTransactions/{OrgCode}/{Batch}/{TransactionNum} Standard - Retrieve a BudgetTransaction record
BudgetTransactionsApi budgetTransactionsGetBudgetTransactionList GET /api/v1/BudgetTransactions/{OrgCode} Standard - Search for BudgetTransactions using OData.
BulkApi bulkBookings POST /api/v1/Bulk/Bookings Extended (Bookings) - Add and edit multiple bookings at once.
BulkApi bulkServiceOrderItems POST /api/v1/Bulk/ServiceOrderItems Extended (Service Orders) - Add and edit multiple ServiceOrderItems at once.
BulletinApprovalApi bulletinApprovalGetBulletinApproval GET /api/v1/BulletinApproval/{OrgCode}/{MeetingSequenceNumber}/{BulletinSequenceNumber}/{SequenceNumber}/{BulletinFileID} Standard - Get a single bulletin approval by its parameters
BulletinApprovalApi bulletinApprovalGetBulletinApprovalList GET /api/v1/BulletinApproval/{OrgCode} Standard - Search for bulletin approval using OData.
BulletinsApi bulletinsGetBulletin GET /api/v1/Bulletins/{OrgCode}/{BulletinApplication}/{Meeting}/{Bulletin} Standard - Get a single bulletin by its parameters
BulletinsApi bulletinsGetBulletinList GET /api/v1/Bulletins/{OrgCode} Standard - Search for bulletin using OData.
CampaignDetailsApi campaignDetailsGetCampaignDetail GET /api/v1/CampaignDetails/{OrgCode}/{CampaignDesignation}/{Campaign}/{SequenceNumber} Standard - Get a single campaign by its parameters
CampaignDetailsApi campaignDetailsGetCampaignDetailList GET /api/v1/CampaignDetails/{OrgCode} Standard - Search for campaign using OData.
CampaignsApi campaignsGetCampaignList GET /api/v1/Campaigns/{OrgCode} Standard - Search for campaign using OData.
CampaignsApi campaignsGetCampaigns GET /api/v1/Campaigns/{OrgCode}/{ID}/{Designation} Standard - Get a single campaign by its parameters
CampaignsApi campaignsPostCampaign POST /api/v1/Campaigns Standard - Add new Campaign entry
CampaignsApi campaignsPutCampaign PUT /api/v1/Campaigns/{OrgCode}/{ID}/{Designation} Standard - Edit Campaign
CashBookTransactionsApi cashBookTransactionsGetCashBookTransaction GET /api/v1/CashBookTransactions/{OrgCode}/{Sequence} Standard - Get an Cash Book Transaction by its parameters
CashBookTransactionsApi cashBookTransactionsGetCashBookTransactionList GET /api/v1/CashBookTransactions/{OrgCode} Standard - Search for Cash Book Transactions using OData.
ChecklistsApi checklistsGetChecklist GET /api/v1/Checklists/{OrgCode}/{Code} Standard - Get a single Checklist entry by its parameters
ChecklistsApi checklistsGetChecklistList GET /api/v1/Checklists/{OrgCode} Standard - Search for Checklist using OData.
ChecklistsApi checklistsPostChecklist POST /api/v1/Checklists Standard - Add new Checklist entry
ChecklistsApi checklistsPutChecklist PUT /api/v1/Checklists/{OrgCode}/{Code} Standard - Edit Checklist
CommunicationsApi communicationsDeleteCommunication DELETE /api/v1/Communications/{OrgCode}/{AccountCode}/{SequenceNumber} Standard - Delete a communication entry from an account
CommunicationsApi communicationsGetCommunication GET /api/v1/Communications/{OrgCode}/{AccountCode}/{SequenceNumber} Basic - Get a single communication entry by its parameters
CommunicationsApi communicationsGetCommunicationList GET /api/v1/Communications/{OrgCode} Basic - Search for account communication entries using OData.
CommunicationsApi communicationsPostCommunication POST /api/v1/Communications Standard - Add a communication entry to an account
CommunicationsApi communicationsPutCommunication PUT /api/v1/Communications/{OrgCode}/{AccountCode}/{SequenceNumber} Standard - Edit a communication entry
ConcessionsApi concessionsGetConcession GET /api/v1/Concessions/{OrgCode}/{SequenceNumber} Standard - Get a single concession by its parameters
ConcessionsApi concessionsGetConcessionList GET /api/v1/Concessions/{OrgCode} Standard - Search for concession using OData.
ContractsApi contractsGetContract GET /api/v1/Contracts/{OrgCode}/{Sequence} Standard - Get a single contract by its parameters
ContractsApi contractsGetContractList GET /api/v1/Contracts/{OrgCode} Standard - Search for contract using OData.
CountriesApi countriesGetCountry GET /api/v1/Countries/{OrgCode}/{Code} Basic - Get a single country by its parameters
CountriesApi countriesGetCountryList GET /api/v1/Countries/{OrgCode} Basic - Search for countries using OData.
CurrencyCodesApi currencyCodesGetCurrencyCode GET /api/v1/CurrencyCodes/{Code} Basic - Get a single Currency Code by its parameters
CurrencyCodesApi currencyCodesGetCurrencyCodesList GET /api/v1/CurrencyCodes Basic - Search for Currency codes using OData. Note that this search endpoint does not use OrgCode.
CurrencyRatesApi currencyRatesGetCurrencyRate GET /api/v1/CurrencyRates/{CurrencyCode}/{SequenceNumber} Basic - Get a single Currency Rate by its parameters
CurrencyRatesApi currencyRatesGetCurrencyRateList GET /api/v1/CurrencyRates Basic - Search for Currency Rates using OData. Note that this search endpoint does not use OrgCode.
CurrencyRatesApi currencyRatesPostCurrencyRate POST /api/v1/CurrencyRates Standard - Add a Currency Rates
CurrencyRatesApi currencyRatesPutCurrencyRate PUT /api/v1/CurrencyRates/{currencyCode}/{sequenceNumber} Standard - Edit a Currency Rates
CustomFieldSetsApi customFieldSetsGetCustomFieldSet GET /api/v1/CustomFieldSets/{OrgCode}/{Class}/{Code} Basic - Get a single custom field set by its parameters
CustomFieldSetsApi customFieldSetsGetCustomFieldSetList GET /api/v1/CustomFieldSets/{OrgCode} Basic - Search for custom field set using OData.
CustomFieldValidationTablesApi customFieldValidationTablesGetCustomFieldValidationTable GET /api/v1/CustomFieldValidationTables/{OrgCode}/{ID} Basic - Get a single custom field validation table by its parameters
CustomFieldValidationTablesApi customFieldValidationTablesGetCustomFieldValidationTableList GET /api/v1/CustomFieldValidationTables/{OrgCode} Basic - Search for custom field validation table using OData.
CustomerTermsApi customerTermsGetCustomerTerm GET /api/v1/CustomerTerms/{OrgCode}/{Code} Standard - Get a single customer term by its parameters
CustomerTermsApi customerTermsGetCustomerTermList GET /api/v1/CustomerTerms/{OrgCode} Standard - Search for customer terms using OData.
CyclesApi cyclesGetCycle GET /api/v1/Cycles/{OrgCode}/{Code} Standard - Get a single membership cycle by its parameters
CyclesApi cyclesGetCycleList GET /api/v1/Cycles/{OrgCode} Standard - Search for membership cycle using OData.
DailyRevenueAndCostAnalysisApi dailyRevenueAndCostAnalysisGetDailyRevenueAndCostAnalysis GET /api/v1/DailyRevenueAndCostAnalysis/{OrgCode}/{RevenueSequence} Standard - Get a daily revenue and cost analysis by its parameters
DailyRevenueAndCostAnalysisApi dailyRevenueAndCostAnalysisGetDailyRevenueAndCostAnalysisList GET /api/v1/DailyRevenueAndCostAnalysis/{OrgCode} Standard - Search for daily revenue and cost analysis using OData.
DailyRevenueJobControlsApi dailyRevenueJobControlsGetDailyRevenueJobControl GET /api/v1/DailyRevenueJobControl/{Orgcode}/{Sequence} Standard - Get a daily revenue job control by its parameters
DailyRevenueJobControlsApi dailyRevenueJobControlsGetDailyRevenueJobControlList GET /api/v1/DailyRevenueJobControl/{OrgCode} Standard - Search for daily revenue job controls using OData.
DepartmentsApi departmentsGetDepartment GET /api/v1/Departments/{OrgCode}/{Code} Basic - Get a single department by its parameters
DepartmentsApi departmentsGetDepartmentList GET /api/v1/Departments/{OrgCode} Basic - Search for department using OData.
DistributionsApi distributionsGetDistribution GET /api/v1/Distributions/{OrgCode}/{BulletinApplication}/{Meeting}/{Bulletin}/{DistributionEntrySeqNbr} Standard - Get a single bulletin distribution by its parameters
DocumentClassesApi documentClassesGetDocumentClass GET /api/v1/DocumentClasses/{OrgCode}/{Class} Basic - Get a single document class by its parameters
DocumentClassesApi documentClassesGetDocumentClassList GET /api/v1/DocumentClasses/{OrgCode} Basic - Search for document class using OData.
DocumentsApi documentsDeleteDocument DELETE /api/v1/Documents/{OrgCode}/{Type}/{SequenceNumber} Standard - Delete a Document entry from Ungerboeck
DocumentsApi documentsDownload GET /api/v1/Documents/{OrgCode}/{Type}/{SequenceNumber}/Download Basic - Get the bytes of a document. WARNING: The API help page does not react well to large (500+ characters) data strings. We suggest using a seperate app to test adding/editing/downloading document data.
DocumentsApi documentsGetDocument GET /api/v1/Documents/{OrgCode}/{Type}/{SequenceNumber} Basic - Get a single Document entry by its parameters. To download a document file, use the /Download endpoint
DocumentsApi documentsGetDocumentList GET /api/v1/Documents/{OrgCode} Basic - Search for document entries using OData.
DocumentsApi documentsPostDocument POST /api/v1/Documents Standard - Add a Document entry in Ungerboeck. You need to fill NewDocumentData and NewFilename with the document file to import. WARNING: The API help page does not react well to large (500+ characters) data strings. We suggest using a seperate app to test adding/editing/downloading document data.
DocumentsApi documentsPutDocument PUT /api/v1/Documents/{OrgCode}/{Type}/{SequenceNumber} Standard - Edit a Document entry properties. You can use NewDocumentData and NewFilename to update the document file with an imported document. WARNING: The API help page does not react well to large (500+ characters) data strings. We suggest using a seperate app to test adding/editing/downloading document data.
EventJobCategoriesApi eventJobCategoriesGetEventJobCategory GET /api/v1/EventJobCategories/{OrgCode}/{Code} Basic - Get a single event category entry by its parameters
EventJobCategoriesApi eventJobCategoriesGetEventJobCategoryList GET /api/v1/EventJobCategories/{OrgCode} Basic - Search for event job categories using OData.
EventJobClassesApi eventJobClassesGetEventJobClass GET /api/v1/EventJobClasses/{OrgCode}/{Code} Basic - Get a single event class by its parameters
EventJobClassesApi eventJobClassesGetEventJobClassList GET /api/v1/EventJobClasses/{OrgCode} Basic - Search for event class using OData.
EventJobTypesApi eventJobTypesGetEventJobType GET /api/v1/EventJobTypes/{OrgCode}/{Code} Basic - Get a single event type by its parameters
EventJobTypesApi eventJobTypesGetEventJobTypeList GET /api/v1/EventJobTypes/{OrgCode} Basic - Search for event types using OData.
EventProductsAndServicesApi eventProductsAndServicesGetEventProductAndServiceList GET /api/v1/EventProductsAndServices/{OrgCode} Basic - Search for event products and services using OData.
EventProductsAndServicesApi eventProductsAndServicesGetEventProductService GET /api/v1/EventProductsAndServices/{OrgCode}/{SequenceNumber} Basic - Get a single event product and service by its parameters
EventProductsAndServicesApi eventProductsAndServicesPostEventProductService POST /api/v1/EventProductsAndServices Standard - Add an event product and service
EventProductsAndServicesApi eventProductsAndServicesPutEventProductService PUT /api/v1/EventProductsAndServices/{OrgCode}/{SequenceNumber} Standard - Edit an event product and service
EventServicesApi eventServicesDeleteEventService DELETE /api/v1/EventServices/{OrgCode}/{EventID}/{SequenceNumber} Standard - Delete an Event Service
EventServicesApi eventServicesGetEventService GET /api/v1/EventServices/{OrgCode}/{EventID}/{SequenceNumber} Basic - Get an Event Service by its parameters
EventServicesApi eventServicesGetEventServiceList GET /api/v1/EventServices/{OrgCode} Basic - Search for Event Services using OData. Note, this will not return user fields. Use the single GET endpoint to retrieve user fields.
EventServicesApi eventServicesPostEventService POST /api/v1/EventServices Standard - Add an Event Service
EventServicesApi eventServicesPutEventService PUT /api/v1/EventServices/{OrgCode}/{EventID}/{SequenceNumber} Standard - Edit an Event Service
EventStatusesApi eventStatusesGetEventStatus GET /api/v1/EventStatuses/{OrgCode}/{Code} Basic - Get a single event status entry by its parameters
EventStatusesApi eventStatusesGetEventStatusList GET /api/v1/EventStatuses/{OrgCode} Basic - Search for event status entries using OData.
EventsApi eventsAddFromProfile POST /api/v1/Events/AddFromProfile Standard - Add a new event from an event profile.
EventsApi eventsGetEvent GET /api/v1/Events/{OrgCode}/{EventID} Basic - Get a single event by its parameters
EventsApi eventsGetEventList GET /api/v1/Events/{OrgCode} Basic - Search for Events using OData. This will also retrieve user fields matching the default user field class, configured in Event Management Configuration.
EventsApi eventsPostEvent POST /api/v1/Events Standard - Add an event
EventsApi eventsPutEvent PUT /api/v1/Events/{OrgCode}/{EventID} Standard - Edit an Event
EventsPriceListApi eventsPriceListGetEventPriceList GET /api/v1/EventsPriceList/{OrgCode}/{Code}/{EventID} Basic - Get a single event price list by its parameters
EventsPriceListApi eventsPriceListGetEventPriceListList GET /api/v1/EventsPriceList/{OrgCode} Basic - Search for event price list using OData.
ExhibitorsApi exhibitorsGetExhibitor GET /api/v1/Exhibitors/{OrgCode}/{ExhibitorID} Standard - Get a single Exhibitor by its parameters
ExhibitorsApi exhibitorsGetExhibitorList GET /api/v1/Exhibitors/{OrgCode} Standard - Search for Exhibitors using OData. Note, this will not return user fields. Use the single GET endpoint to retrieve user fields.
ExhibitorsApi exhibitorsPostExhibitor POST /api/v1/Exhibitors Standard - Add an Exhibitor
ExhibitorsApi exhibitorsPutExhibitor PUT /api/v1/Exhibitors/{OrgCode}/{ExhibitorID} Standard - Edit an Exhibitor
ExpenseReportApprovalsApi expenseReportApprovalsGetExpenseReportApproval GET /api/v1/ExpenseReportApprovals/{LogSequence} Standard - Get an Expense Report Approval by its parameters
ExpenseReportApprovalsApi expenseReportApprovalsGetExpenseReportApprovalList GET /api/v1/ExpenseReportApprovals Standard - Search for Expense Report Approvals using OData.
ExpenseReportCreditCardDetailsApi expenseReportCreditCardDetailsGetExpenseReportCreditCardDetail GET /api/v1/ExpenseReportCreditCardDetails/{CardTransactionDetailID} Standard - Get a single Card Transaction Detail by its parameters
ExpenseReportCreditCardDetailsApi expenseReportCreditCardDetailsGetExpenseReportCreditCardDetailList GET /api/v1/ExpenseReportCreditCardDetails Standard - Search for Expense Report Credit Card Details using OData. Note that this search endpoint does not use OrgCode.
ExpenseReportCreditCardDetailsApi expenseReportCreditCardDetailsPostExpenseReportCreditCardDetail POST /api/v1/ExpenseReportCreditCardDetails Standard - Add a Expense Report Credit Card Details
ExpenseReportCreditCardDetailsApi expenseReportCreditCardDetailsPutExpenseReportCreditCardDetail PUT /api/v1/ExpenseReportCreditCardDetails/{cardTransactionDetailID} Standard - Edit a Expense Report Credit Card Details
ExpenseReportDetailsApi expenseReportDetailsGetExpenseReportDetail GET /api/v1/ExpenseReportDetails/{Sequence} Standard - Get an expense report detail by its parameters
ExpenseReportDetailsApi expenseReportDetailsGetExpenseReportDetailList GET /api/v1/ExpenseReportDetails Standard - Search for expense report details using OData.
ExpenseReportHeadersApi expenseReportHeadersGetExpenseReportDetail GET /api/v1/ExpenseReportHeaders/{ID} Standard - Get an expense report header by its parameters
ExpenseReportHeadersApi expenseReportHeadersGetExpenseReportDetailList GET /api/v1/ExpenseReportHeaders Standard - Search for expense report headers using OData.
ExternalInvoiceDetailsApi externalInvoiceDetailsGetExternalInvoiceDetail GET /api/v1/ExternalInvoiceDetails/{DetailIDExt} Standard - Retrieve an ExternalInvoiceDetail record
ExternalInvoiceDetailsApi externalInvoiceDetailsGetExternalInvoiceDetailList GET /api/v1/ExternalInvoiceDetails Standard - Search for GetExternalInvoiceDetails using OData.
ExternalInvoiceSummariesApi externalInvoiceSummariesGetExternalInvoiceSummary GET /api/v1/ExternalInvoiceSummaries/{SummaryID} Standard - Retrieve a ExternalInvoiceSummary record
ExternalInvoiceSummariesApi externalInvoiceSummariesGetExternalInvoiceSummaryList GET /api/v1/ExternalInvoiceSummaries Standard - Search for GetExternalInvoiceSummaries using OData.
ExternalInvoicesApi externalInvoicesGetExternalInvoice GET /api/v1/ExternalInvoices/{HeaderIDExt} Standard - Retrieve an ExternalInvoice record
ExternalInvoicesApi externalInvoicesGetExternalInvoiceList GET /api/v1/ExternalInvoices Standard - Search for GetExternalInvoices using OData.
FiscalPeriodsApi fiscalPeriodsGetFiscalPeriod GET /api/v1/FiscalPeriods/{OrgCode}/{Module}/{Year}/{Period} Standard - Get a fiscal period by its parameters
FiscalPeriodsApi fiscalPeriodsGetFiscalPeriodList GET /api/v1/FiscalPeriods/{OrgCode} Standard - Search for fiscal periods using OData.
FiscalYearsApi fiscalYearsGetFiscalYear GET /api/v1/FiscalYears/{OrgCode}/{Year} Standard - Get a fiscal year by its parameters
FiscalYearsApi fiscalYearsGetFiscalYearList GET /api/v1/FiscalYears/{OrgCode} Standard - Search for fiscal years using OData.
FixedAssetBookDetailsApi fixedAssetBookDetailsGetFixedAssetBookDetail GET /api/v1/FixedAssetBookDetails/{OrgCode}/{Asset}/{Book} Standard - Retrieve a FixedAssetBookDetail record
FixedAssetBookDetailsApi fixedAssetBookDetailsGetFixedAssetBookDetailList GET /api/v1/FixedAssetBookDetails/{OrgCode} Standard - Search for GetFixedAssetBookDetails using OData.
FixedAssetsRegistersApi fixedAssetsRegistersGetAssetRegister GET /api/v1/FixedAssetsRegisters/{OrgCode}/{Code} Standard - Retrieve a FixedAssetsRegister record
FixedAssetsRegistersApi fixedAssetsRegistersGetAssetRegisterList GET /api/v1/FixedAssetsRegisters/{OrgCode} Standard - Search for FixedAssetsRegisters using OData.
FunctionCheckInsApi functionCheckInsDeleteFunctionCheckIn DELETE /api/v1/FunctionCheckIns/{Sequence} Standard - Delete a function checkin entry
FunctionCheckInsApi functionCheckInsGetFunctionCheckIn GET /api/v1/FunctionCheckIns/{Sequence} Standard - Get a single function check-in entry by its parameters
FunctionCheckInsApi functionCheckInsGetFunctionCheckInList GET /api/v1/FunctionCheckIns Standard - Search for function check-in record OData. Note that this search endpoint does not use OrgCode.
FunctionCheckInsApi functionCheckInsPostFunctionCheckIn POST /api/v1/FunctionCheckIns Standard - Add a function check-in
FunctionCheckInsApi functionCheckInsPutFunctionCheckIn PUT /api/v1/FunctionCheckIns/{Sequence} Standard - Edit a function check-in. This is the same as the 'Function Check-Out' action in backoffice.
FunctionSeatingChartsApi functionSeatingChartsDeleteFunctionSeatingChart DELETE /api/v1/FunctionSeatingCharts/{OrgCode}/{SequenceNumber} Standard - Delete a Function seating chart from an event
FunctionSeatingChartsApi functionSeatingChartsGetFunctionSeatingChart GET /api/v1/FunctionSeatingCharts/{OrgCode}/{SequenceNumber} Basic - Get a single Function seating chart by sequence number
FunctionSeatingChartsApi functionSeatingChartsGetFunctionSeatingChartList GET /api/v1/FunctionSeatingCharts/{OrgCode} Basic - Get a list of Function seating charts by specified search data
FunctionSeatingChartsApi functionSeatingChartsPostFunctionSeatingChart POST /api/v1/FunctionSeatingCharts Standard - Add a Function seating chart
FunctionSeatingChartsApi functionSeatingChartsPutFunctionSeatingChart PUT /api/v1/FunctionSeatingCharts/{OrgCode}/{SequenceNumber} Standard - Edit a Function seating chart
FunctionsApi functionsDeleteFunction DELETE /api/v1/Functions/{OrgCode}/{EventID}/{FunctionID} Standard - Delete a function from an event
FunctionsApi functionsGetFunction GET /api/v1/Functions/{OrgCode}/{EventID}/{FunctionID} Basic - Get a single function by its parameters
FunctionsApi functionsGetFunctionList GET /api/v1/Functions/{OrgCode} Basic - Search for Functions using OData. Note, this will not return user fields. Use the single GET endpoint to retrieve user fields.
FunctionsApi functionsInsertAfter POST /api/v1/Functions/InsertAfter/{TargetFunctionID} Standard - Add a function to an event after the target function the function hierarchy. The new function will appear on the same level as the target function.
FunctionsApi functionsInsertIndented POST /api/v1/Functions/InsertIndented/{ParentFunctionID} Standard - Add a function to an event indented into the target function in the function hierarchy. The new function will appear as a child of the parent function.
FunctionsApi functionsPutFunction PUT /api/v1/Functions/{OrgCode}/{EventID}/{FunctionID} Standard - Edit a Function
GLAccountsApi gLAccountsGetGLAccount GET /api/v1/GLAccounts/{OrgCode}/{GLAccount}/{SubAccount} Standard - Get a GL account by its parameters
GLAccountsApi gLAccountsGetGLAccountList GET /api/v1/GLAccounts/{OrgCode} Standard - Search for GL accounts using OData.
GLDeferralRevenueDetailsApi gLDeferralRevenueDetailsGetGlDeferralRevenueDetail GET /api/v1/GLDeferralRevenueDetails/{HdrSequence}/{Sequence} Standard - Get an GlDeferral Revenue Detail by its parameters
GLDeferralRevenueDetailsApi gLDeferralRevenueDetailsGetGlDeferralRevenueDetailList GET /api/v1/GLDeferralRevenueDetails Standard - Search for GlDeferral Revenue Details using OData.
GLDeferralRevenueHeadersApi gLDeferralRevenueHeadersGetGLDeferralRevenueHeaders GET /api/v1/GLDeferralRevenueHeaders/{Sequence} Standard - Get an GlDeferral Revenue Header by its parameters
GLDeferralRevenueHeadersApi gLDeferralRevenueHeadersGetGLDeferralRevenueHeadersList GET /api/v1/GLDeferralRevenueHeaders Standard - Search for GlDeferral Revenue Header using OData.
GLDistributionsApi gLDistributionsGetGLDistribution GET /api/v1/GLDistributions/{OrgCode}/{RecordType}/{SequenceNumber} Standard - Get GLDistribution by its parameters
GLDistributionsApi gLDistributionsGetGLDistributionList GET /api/v1/GLDistributions/{OrgCode} Standard - Search for GLDistributions using OData.
GLMainAccountsApi gLMainAccountsGetGLMainAccount GET /api/v1/GLMainAccounts/{OrgCode}/{GLMainAccount} Standard - Retrieve a GLMainAccount record
GLMainAccountsApi gLMainAccountsGetGLMainAccountList GET /api/v1/GLMainAccounts/{OrgCode} Standard - Search for GLMainAccounts using OData.
GLSourcesApi gLSourcesGetGLSource GET /api/v1/GlSources/{OrgCode}/{Source} Standard - Get a single GLSources by its parameters
GLSourcesApi gLSourcesGetGLSourcesList GET /api/v1/GlSources/{OrgCode} Standard - Search for GLSources using OData.
InventoryBalancesApi inventoryBalancesGetInventoryBalance GET /api/v1/InventoryBalances/{OrgCode}/{Item}/{LotSerialNumber}/{Location}/{FiscalYear}/{FiscalPeriod} Standard - Retrieve a InventoryBalance record
InventoryBalancesApi inventoryBalancesGetInventoryBalanceList GET /api/v1/InventoryBalances/{OrgCode} Standard - Search for records.
InventoryBatchDetailsApi inventoryBatchDetailsGetInventoryBatchDetail GET /api/v1/InventoryBatchDetails/{OrgCode}/{Batch}/{Sequence} Standard - Get an inventory batch detail by its parameters
InventoryBatchDetailsApi inventoryBatchDetailsGetInventoryBatchDetailList GET /api/v1/InventoryBatchDetails/{OrgCode} Standard - Search for inventory batch details using OData.
InventoryItemsApi inventoryItemsGetInventoryItem GET /api/v1/InventoryItems/{OrgCode}/{Code} Basic - Get a single Inventory Item by its parameters
InventoryItemsApi inventoryItemsGetInventoryItemList GET /api/v1/InventoryItems/{OrgCode} Basic - Search for Inventory Stats List using OData.
InventoryStatsApi inventoryStatsGetInventoryStat GET /api/v1/InventoryStats/{OrgCode}/{Item}/{Space}/{LotSerialNumber} Basic - Get a single Inventory Stat entry by its parameters
InventoryStatsApi inventoryStatsGetInventoryStatList GET /api/v1/InventoryStats/{OrgCode} Basic - Search for Inventory Stats List using OData.
InventorySuppliersApi inventorySuppliersGetInventorySupplier GET /api/v1/InventorySuppliers/{OrgCode}/{InventoryItem}/{Supplier} Basic - Get a single Inventory Supplier entry by its parameters
InventorySuppliersApi inventorySuppliersGetInventorySupplierList GET /api/v1/InventorySuppliers/{OrgCode} Basic - Search for Inventory Suppliers List using OData.
InventoryTransactionsApi inventoryTransactionsGetInventoryTransaction GET /api/v1/InventoryTransactions/{UniqueId} Standard - Get a single Inventory transaction record
InventoryTransactionsApi inventoryTransactionsGetInventoryTransactionList GET /api/v1/InventoryTransactions Standard - Search for InventoryTransactions using OData.
InvoiceDetailTaxesApi invoiceDetailTaxesGetInvoiceDetailTaxes GET /api/v1/InvoiceDetailTaxes/{OrgCode}/{InvoiceNumber}/{OrderNumber}/{OrderLineNumber}/{SequenceNumber} Standard - Get an invoice detail tax by its parameters
InvoiceDetailTaxesApi invoiceDetailTaxesGetInvoiceDetailTaxesList GET /api/v1/InvoiceDetailTaxes/{OrgCode} Standard - Search for invoice detail taxes using OData.
InvoiceDetailsApi invoiceDetailsGetInvoiceDetails GET /api/v1/InvoiceDetails/{OrgCode}/{InvoiceNumber}/{OrderNumber}/{OrderLine} Standard - Get an invoice detail by its parameters
InvoiceDetailsApi invoiceDetailsGetInvoiceDetailsList GET /api/v1/InvoiceDetails/{OrgCode} Standard - Search for invoice details using OData.
InvoicesApi invoicesGetInvoice GET /api/v1/Invoices/{OrgCode}/{InvoiceNumber}/{Source} Standard - Get a single invoice by its parameters
InvoicesApi invoicesGetInvoiceList GET /api/v1/Invoices/{OrgCode} Standard - Search for invoices using OData.
InvoicesApi invoicesPutInvoice PUT /api/v1/Invoices/{OrgCode}/{InvoiceNumber}/{Source} Standard - Edit an invoice
JobsApi jobsGetJob GET /api/v1/Jobs/{OrgCode}/{JobID} Standard - Get a single job by its parameters
JobsApi jobsGetJobList GET /api/v1/Jobs/{OrgCode} Standard - Search for Jobs using OData. This will also retrieve user fields matching the default user field class, configured in Job Management Configuration.
JobsApi jobsPostJob POST /api/v1/Jobs Standard - Add an job
JobsApi jobsPutJob PUT /api/v1/Jobs/{OrgCode}/{JobID} Standard - Edit an Job
JournalEntriesApi journalEntriesGetJournalEntry GET /api/v1/JournalEntries/{OrgCode}/{Year}/{Period}/{Source}/{EntryNumber} Standard - Get a single journal entry by its parameters
JournalEntriesApi journalEntriesGetJournalEntryList GET /api/v1/JournalEntries/{OrgCode} Standard - Search for journal entry using OData.
JournalEntriesApi journalEntriesPostJournalEntry POST /api/v1/JournalEntries Extended (Journal Entries) - Add a journal entry
JournalEntriesApi journalEntriesPutJournalEntry PUT /api/v1/JournalEntries/{OrgCode}/{Year}/{Period}/{Source}/{EntryNumber} Extended (Journal Entries) - Edit a Journal Entry item
JournalEntryDetailsApi journalEntryDetailsGetJournalEntryDetail GET /api/v1/JournalEntryDetails/{OrgCode}/{Year}/{Period}/{Source}/{EntryNumber}/{Line} Standard - Get a single journal entry detail by its parameters
JournalEntryDetailsApi journalEntryDetailsGetJournalEntryDetailList GET /api/v1/JournalEntryDetails/{OrgCode} Standard - Search for journal entry detail using OData.
JournalEntryDetailsApi journalEntryDetailsPostJournalEntryDetail POST /api/v1/JournalEntryDetails Extended (Journal Entries) - Add a Journal Entry item
JournalEntryDetailsApi journalEntryDetailsPutJournalEntryDetail PUT /api/v1/JournalEntryDetails/{OrgCode}/{Year}/{Period}/{Source}/{EntryNumber}/{Line} Extended (Journal Entries) - Edit a Journal Entry item
MailingListsApi mailingListsGetMailingList GET /api/v1/MailingLists/{OrgCode}/{ID} Standard - Get a single mailing list entry by its parameters
MailingListsApi mailingListsGetMailingListList GET /api/v1/MailingLists/{OrgCode} Standard - Search for mailing list using OData.
MarketListItemsApi marketListItemsGetMarketListItem GET /api/v1/MarketListItems/{OrgCode}/{MarketList}/{Sequence} Standard - Get a single Market List Item by its parameters
MarketListItemsApi marketListItemsGetMarketListItemList GET /api/v1/MarketListItems/{OrgCode} Standard - Search for Market List Items using OData. Note that this search endpoint does not use OrgCode.
MarketListsApi marketListsGetMarketList GET /api/v1/MarketLists/{OrgCode}/{Code} Standard - Get a single Market List by its parameters
MarketListsApi marketListsGetMarketListList GET /api/v1/MarketLists/{OrgCode} Standard - Search for Market Lists using OData. Note that this search endpoint does not use OrgCode.
MarketSegmentsApi marketSegmentsGetMarketSegment GET /api/v1/MarketSegments/{OrgCode}/{Major}/{Minor} Basic - Get a single market segment by its parameters
MarketSegmentsApi marketSegmentsGetMarketSegmentList GET /api/v1/MarketSegments/{OrgCode} Basic - Search for market segment using OData.
MeetingFlowPatternApi meetingFlowPatternGetMeetingFlowPattern GET /api/v1/MeetingFlowPattern/{OrgCode}/{FlowApplicationCode}/{MeetingTourSequenceNbr}/{FlowSequenceNumber} Standard - Get a single meeting flow pattern by its parameters
MeetingFlowPatternApi meetingFlowPatternGetMeetingFlowPatternList GET /api/v1/MeetingFlowPattern/{OrgCode} Standard - Search for meeting flow pattern using OData.
MeetingNotesApi meetingNotesGetMeetingNote GET /api/v1/MeetingNotes/{OrgCode}/{BulletinApplication}/{Meeting}/{BulletinSeqNbr}/{SequenceNbr} Standard - Get a single meeting note by its parameters
MeetingNotesApi meetingNotesGetMeetingNoteList GET /api/v1/MeetingNotes/{OrgCode} Standard - Search for meeting note using OData.
MeetingsApi meetingsGetMeeting GET /api/v1/Meetings/{OrgCode}/{MeetingSequence} Standard - Get a single meeting by its parameters
MeetingsApi meetingsGetMeetingList GET /api/v1/Meetings/{OrgCode} Standard - Search for meeting using OData.
MeetingsApi meetingsPostMeeting POST /api/v1/Meetings Standard - Add meeting
MeetingsApi meetingsPutMeeting PUT /api/v1/Meetings/{OrgCode}/{MeetingSequence} Standard - Edit Meeting
MembershipOrderItemsApi membershipOrderItemsDeleteMembershipOrderItem DELETE /api/v1/MembershipOrderItems/{OrgCode}/{OrderNumber}/{OrderLineNumber} Extended (Membership Orders) - Delete a order item from an order
MembershipOrderItemsApi membershipOrderItemsGetMembershipOrderItem GET /api/v1/MembershipOrderItems/{OrgCode}/{OrderNumber}/{OrderLineNumber} Standard - Get a single membership order item by its parameters
MembershipOrderItemsApi membershipOrderItemsGetMembershipOrderItemList GET /api/v1/MembershipOrderItems/{OrgCode} Standard - Search for membership order items using OData.
MembershipOrderItemsApi membershipOrderItemsPostMembershipOrderItem POST /api/v1/MembershipOrderItems Extended (Membership Orders) - Add an item to an existing membership order
MembershipOrderItemsApi membershipOrderItemsPutMembershipOrderItem PUT /api/v1/MembershipOrderItems/{OrgCode}/{OrderNumber}/{OrderLineNumber} Extended (Membership Orders) - Edit a item on a membership order
MembershipOrdersApi membershipOrdersGetMembershipOrder GET /api/v1/MembershipOrders/{OrgCode}/{OrderNumber} Standard - Get a single membership order by its parameters
MembershipOrdersApi membershipOrdersGetMembershipOrderList GET /api/v1/MembershipOrders/{OrgCode} Standard - Search for membership orders using OData.
MembershipOrdersApi membershipOrdersPostMembershipOrder POST /api/v1/MembershipOrders Extended (Membership Orders) - Add a membership order
MembershipOrdersApi membershipOrdersPrepareMembershipOrderForInvoicing PUT /api/v1/MembershipOrders/{OrgCode}/{OrderNumber}/PrepareMembershipOrderForInvoicing Extended (Membership Orders) - Use this action endpoint to prepare a membership order for invoicing. This process replicates the &quot;Prepare Order&quot; functionality found in v20's &quot;Prepare Membership Orders For Invoicing&quot; window. The response content contains the newly created Membership Order number (type MB).
MembershipOrdersApi membershipOrdersPutMembershipOrder PUT /api/v1/MembershipOrders/{OrgCode}/{OrderNumber} Extended (Membership Orders) - Edit a membership order
NotesApi notesDeleteNote DELETE /api/v1/Notes/{OrgCode}/{Type}/{Code}/{SequenceNumber} Basic - Delete a note
NotesApi notesGetNote GET /api/v1/Notes/{OrgCode}/{Type}/{Code}/{SequenceNumber} Basic - Get a single note by its parameters
NotesApi notesGetNoteList GET /api/v1/Notes/{OrgCode} Basic - Search for note using OData.
NotesApi notesPostNote POST /api/v1/Notes Basic - Add an note
NotesApi notesPutNote PUT /api/v1/Notes/{OrgCode}/{Type}/{Code}/{SequenceNumber} Basic - Edit an note
OpportunitiesApi opportunitiesDeleteOpportunity DELETE /api/v1/Opportunities/{OrgCode}/{AccountCode}/{Occurrence} Standard - Delete an opportunity
OpportunitiesApi opportunitiesGetOpportunity GET /api/v1/Opportunities/{OrgCode}/{AccountCode}/{Occurrence} Basic - Get a single opportunity by its parameters
OpportunitiesApi opportunitiesGetOpportunityList GET /api/v1/Opportunities/{OrgCode} Basic - Search for opportunities using OData. Note, this will not return user fields. Use the single GET endpoint to retrieve user fields.
OpportunitiesApi opportunitiesPostOpportunity POST /api/v1/Opportunities Standard - Add a opportunity
OpportunitiesApi opportunitiesPutOpportunity PUT /api/v1/Opportunities/{OrgCode}/{AccountCode}/{Occurrence} Standard - Edit an opportunity
OpportunityStatusesApi opportunityStatusesGetOpportunityStatus GET /api/v1/OpportunityStatuses/{OrgCode}/{Code}/{Designation} Basic - Get a single Opportunity Status entry by its parameters
OpportunityStatusesApi opportunityStatusesGetOpportunityStatusList GET /api/v1/OpportunityStatuses/{OrgCode} Basic - Search for opportunity status using OData.
OrderRegistrantsApi orderRegistrantsCheckIn PUT /api/v1/OrderRegistrants/{OrgCode}/{RegistrantSequenceNbr}/{EventID}/CheckIn Extended (Registration Orders) - Registrant check-in
OrderRegistrantsApi orderRegistrantsClearCheckIn PUT /api/v1/OrderRegistrants/{OrgCode}/{RegistrantSequenceNbr}/{EventID}/ClearCheckIn Extended (Registration Orders) - Registrant clear check-in
OrderRegistrantsApi orderRegistrantsGetOrderRegistrant GET /api/v1/OrderRegistrants/{OrgCode}/{RegistrantSequenceNbr} Standard - Get a single order registrant by its parameters
OrderRegistrantsApi orderRegistrantsGetOrderRegistrantList GET /api/v1/OrderRegistrants/{OrgCode} Standard - Search for order registrant using OData. Note, this will not return user fields. Use the single GET endpoint to retrieve user fields.
OrderRegistrantsApi orderRegistrantsPutOrderRegistrant PUT /api/v1/OrderRegistrants/{OrgCode}/{RegistrantSequenceNbr} Standard - Edit a order registrant
OrderRegistrantsApi orderRegistrantsSetRegistrantApproval PUT /api/v1/OrderRegistrants/{OrgCode}/{RegistrantSequenceNbr}/SetRegistrantApproval Extended (Registration Orders) - Set order registrant Approval Status
OrderStatusesApi orderStatusesGetOrderStatus GET /api/v1/OrderStatuses/{OrgCode}/{Code} Basic - Get a single order status by its parameters
OrderStatusesApi orderStatusesGetOrderStatusList GET /api/v1/OrderStatuses/{OrgCode} Basic - Search for order status using OData.
OrganizationParametersApi organizationParametersGetOrganizationParameter GET /api/v1/OrganizationParameters/{OrgCode}/{ApplicationCode}/{ParameterCode} Standard - Get a single organization parameter by its parameters
OrganizationParametersApi organizationParametersGetOrganizationParameterList GET /api/v1/OrganizationParameters/{OrgCode} Standard - Search for organization parameters using OData.
POContractsApi pOContractsGetPOContract GET /api/v1/POContracts/{OrgCode}/{ContractID} Standard - Retrieve a POContracts record
POContractsApi pOContractsGetPOContractList GET /api/v1/POContracts/{OrgCode} Standard - Search for records. Note that this search endpoint does not use OrgCode.
PaymentPlanDetailsApi paymentPlanDetailsGetPaymentPlanDetail GET /api/v1/PaymentPlanDetails/{OrgCode}/{PayPlanID}/{PayNumber}/{Sequence} Standard - Get a single payment plan detail by its parameters
PaymentPlanDetailsApi paymentPlanDetailsGetPaymentPlanDetailList GET /api/v1/PaymentPlanDetails/{OrgCode} Standard - Search for payment plan details using OData.
PaymentPlanHeadersApi paymentPlanHeadersGetPaymentPlanHeader GET /api/v1/PaymentPlanHeaders/{OrgCode}/{PayPlanID}/{PaymentNumber} Standard - Get a single payment plan header by its parameters
PaymentPlanHeadersApi paymentPlanHeadersGetPaymentPlanHeaderList GET /api/v1/PaymentPlanHeaders/{OrgCode} Standard - Search for payment plan headers using OData.
PaymentPlansApi paymentPlansGetPaymentPlan GET /api/v1/PaymentPlans/{OrgCode}/{PaymentPlanID} Standard - Get a single payment plan by its parameters
PaymentPlansApi paymentPlansGetPaymentPlanList GET /api/v1/PaymentPlans/{OrgCode} Standard - Search for payment plan using OData.
PaymentsApi paymentsGetPayment GET /api/v1/Payments/{OrgCode}/{AccountCode}/{Sequence} Standard - Get a single Payment entry by its parameters
PaymentsApi paymentsGetPaymentList GET /api/v1/Payments/{OrgCode} Standard - Search for payments using OData.
PaymentsApi paymentsPostPayment POST /api/v1/Payments Standard - Add a Payment entry to an account
PaymentsApi paymentsPutPayment PUT /api/v1/Payments/{OrgCode}/{AccountCode}/{Sequence} Standard - Edit a Payment entry
PendingPaymentsApi pendingPaymentsGetPendingPayment GET /api/v1/PendingPayments/{OrgCode}/{PendingPaymentID} Basic - Get a single Pending Payment by its parameters
PendingPaymentsApi pendingPaymentsGetPendingPaymentList GET /api/v1/PendingPayments/{OrgCode} Basic - Search for Pending Payments List using OData.
PhysicalCountInventoryBatchHeadersApi physicalCountInventoryBatchHeadersGetPhysicalCountInventoryBatchHeader GET /api/v1/PhysicalCountInventoryBatchHeader/{OrgCode}/{BatchID} Standard - Get a physical count inventory batch header by its parameters
PhysicalCountInventoryBatchHeadersApi physicalCountInventoryBatchHeadersGetPhysicalCountInventoryBatchHeaderList GET /api/v1/PhysicalCountInventoryBatchHeader/{OrgCode} Standard - Search for physical count inventory batch headers using OData.
PreferenceSettingsApi preferenceSettingsDeletePreferenceSettings DELETE /api/v1/PreferenceSettings/{OrgCode}/{ID} Standard - Delete a preference setting
PreferenceSettingsApi preferenceSettingsGetPreferenceSetting GET /api/v1/PreferenceSettings/{OrgCode}/{ID} Basic - Get a single preference setting by its parameters
PreferenceSettingsApi preferenceSettingsGetPreferenceSettingList GET /api/v1/PreferenceSettings/{OrgCode} Basic - Search for preference settings using OData.
PreferenceSettingsApi preferenceSettingsPostPreferenceSetting POST /api/v1/PreferenceSettings Standard - Add a preference setting
PreferenceSettingsApi preferenceSettingsPutPreferenceSetting PUT /api/v1/PreferenceSettings/{OrgCode}/{ID} Standard - Edit a preference setting
PriceListApi priceListDeletePriceList DELETE /api/v1/PriceList/{OrgCode}/{Code} Extended (Resources and Price Lists) - Delete a price list
PriceListApi priceListGetPriceList GET /api/v1/PriceList/{OrgCode}/{Code} Basic - Get a single price list entry by its parameters
PriceListApi priceListGetPriceListList GET /api/v1/PriceList/{OrgCode} Basic - Search for price list using OData.
PriceListApi priceListPostPriceList POST /api/v1/PriceList Extended (Resources and Price Lists) - Add a PriceList
PriceListApi priceListPutPriceList PUT /api/v1/PriceList/{OrgCode}/{Code} Extended (Resources and Price Lists) - Edit a PriceList
PriceListItemsApi priceListItemsDeletePriceListItem DELETE /api/v1/PriceListItems/{OrgCode}/{PriceList}/{Sequence} Extended (Resources and Price Lists) - Delete a price list item from a price list
PriceListItemsApi priceListItemsGetPriceListItem GET /api/v1/PriceListItems/{OrgCode}/{PriceList}/{Sequence} Basic - Get a single price list item by its parameters
PriceListItemsApi priceListItemsGetPriceListItemList GET /api/v1/PriceListItems/{OrgCode} Basic - Search for price list item using OData.
PriceListItemsApi priceListItemsPostPriceListItem POST /api/v1/PriceListItems Extended (Resources and Price Lists) - Add a PriceListItem
PriceListItemsApi priceListItemsPutPriceListItem PUT /api/v1/PriceListItems/{OrgCode}/{PriceList}/{Sequence} Extended (Resources and Price Lists) - Edit a PriceListItem
ProductsAndServicesApi productsAndServicesGetProductAndServiceList GET /api/v1/ProductsAndServices/{OrgCode} Basic - Search for products and services using OData.
ProductsAndServicesApi productsAndServicesGetProductService GET /api/v1/ProductsAndServices/{OrgCode}/{Code} Basic - Get a single product or a service by its parameters
PublicLanguagesApi publicLanguagesDeletePublicLanguage DELETE /api/v1/PublicLanguages/{Sequence} Standard - Delete a public language entry
PublicLanguagesApi publicLanguagesGetPublicLanguage GET /api/v1/PublicLanguages/{Sequence} Standard - Get a single public language by its parameters
PublicLanguagesApi publicLanguagesGetPublicLanguageList GET /api/v1/PublicLanguages Standard - Search for public languages using OData. Note, this will not return user fields. Use the single GET endpoint to retrieve user fields.
PublicLanguagesApi publicLanguagesPostPublicLanguage POST /api/v1/PublicLanguages Standard - Add a public language
PublicLanguagesApi publicLanguagesPutPublicLanguage PUT /api/v1/PublicLanguages/{Sequence} Standard - Edit a public language
PurchaseOrderApprovalApi purchaseOrderApprovalGetPurchaseOrderApproval GET /api/v1/PurchaseOrderApproval/{OrgCode}/{Number}/{ItemSequence}/{Sequence} Standard - Get a single purchase order approval by its parameters
PurchaseOrderApprovalApi purchaseOrderApprovalGetPurchaseOrderApprovalList GET /api/v1/PurchaseOrderApproval/{OrgCode} Standard - Search for purchase order approval using OData.
PurchaseOrderApprovalApi purchaseOrderApprovalPostPurchaseOrderApproval POST /api/v1/PurchaseOrderApproval Standard - Approve Purchase Order
PurchaseOrderApprovalLevelsApi purchaseOrderApprovalLevelsGetPurchaseOrderApprovalLevel GET /api/v1/PurchaseOrderApprovalLevels/{OrgCode}/{Type}/{ApprovalLevel} Standard - Get a purchase order approval level by its parameters
PurchaseOrderApprovalLevelsApi purchaseOrderApprovalLevelsGetPurchaseOrderApprovalLevelList GET /api/v1/PurchaseOrderApprovalLevels/{OrgCode} Standard - Search for purchase order approval levels using OData.
PurchaseOrderDistributionsApi purchaseOrderDistributionsGetPurchaseOrderDistribution GET /api/v1/PurchaseOrderDistribution/{OrgCode}/{Number}/{Sequence}/{Line} Standard - Get a purchase order distribution by its parameters
PurchaseOrderDistributionsApi purchaseOrderDistributionsGetPurchaseOrderDistributionList GET /api/v1/PurchaseOrderDistribution/{OrgCode} Standard - Search for purchase order distributions using OData.
PurchaseOrderItemsApi purchaseOrderItemsGetPurchaseOrderItem GET /api/v1/PurchaseOrderItems/{OrgCode}/{Number}/{ItemSequence} Standard - Get a single purchase order item by its parameters
PurchaseOrderItemsApi purchaseOrderItemsGetPurchaseOrderItemList GET /api/v1/PurchaseOrderItems/{OrgCode} Standard - Search for purchase order items using OData.
PurchaseOrderItemsApi purchaseOrderItemsPostPurchaseOrderItems POST /api/v1/PurchaseOrderItems Standard - Add a Purchase order item
PurchaseOrderItemsApi purchaseOrderItemsPutPurchaseOrder PUT /api/v1/PurchaseOrderItems/{OrgCode}/{Number}/{ItemSequence} Standard - Edit a Purchase order item
PurchaseOrderTaxesApi purchaseOrderTaxesGetPurchaseOrderTax GET /api/v1/PurchaseOrderTaxes/{OrgCode}/{Number}/{ItemSequence}/{Sequence} Standard - Retrieve a PurchaseOrderTax record
PurchaseOrderTaxesApi purchaseOrderTaxesGetPurchaseOrderTaxList GET /api/v1/PurchaseOrderTaxes/{OrgCode} Standard - Search for PurchaseOrderTaxes using OData.
PurchaseOrderUserApprovalsApi purchaseOrderUserApprovalsGetPurchaseOrderUserApproval GET /api/v1/PurchaseOrderUserApprovals/{OrgCode}/{Sequence} Standard - Get a purchase order user approval by its parameters
PurchaseOrderUserApprovalsApi purchaseOrderUserApprovalsGetPurchaseOrderUserApprovalList GET /api/v1/PurchaseOrderUserApprovals/{OrgCode} Standard - Search for purchase order user approvals using OData.
PurchaseOrdersApi purchaseOrdersGetPurchaseOrder GET /api/v1/PurchaseOrders/{OrgCode}/{Number} Standard - Get a single purchase order by its parameters
PurchaseOrdersApi purchaseOrdersGetPurchaseOrderList GET /api/v1/PurchaseOrders/{OrgCode} Standard - Search for purchase orders using OData.
PurchaseOrdersApi purchaseOrdersPostPurchaseOrder POST /api/v1/PurchaseOrders Standard - Add a Purchase order
PurchaseOrdersApi purchaseOrdersPutPurchaseOrder PUT /api/v1/PurchaseOrders/{OrgCode}/{Number} Standard - Edit a Purchase order
ReceivableTransactionTypesApi receivableTransactionTypesGetReceivableTransactionType GET /api/v1/ReceivableTransactionTypes/{OrgCode}/{TSM} Standard - Retrieve a ReceivableTransactionTypes record
ReceivableTransactionTypesApi receivableTransactionTypesGetReceivableTransactionTypeList GET /api/v1/ReceivableTransactionTypes/{OrgCode} Standard - Search for ReceivableTransactionTypes using OData.
RegistrationAssignmentsApi registrationAssignmentsDeleteRegistrationAssignment DELETE /api/v1/RegistrationAssignments/{OrgCode}/{SequenceNumber} Standard - Delete a Registration Assignment from an order.
RegistrationAssignmentsApi registrationAssignmentsGetRegistrationAssignment GET /api/v1/RegistrationAssignments/{OrgCode}/{SequenceNumber} Basic - Get a single Registration Assignment by sequence number
RegistrationAssignmentsApi registrationAssignmentsGetRegistrationAssignmentList GET /api/v1/RegistrationAssignments/{OrgCode} Basic - Gets a list of all Registration Assignments on the provided Organization.
RegistrationAssignmentsApi registrationAssignmentsPostRegistrationAssignment POST /api/v1/RegistrationAssignments Standard - Add a Registration Assignment
RegistrationAssignmentsApi registrationAssignmentsPutRegistrationAssignment PUT /api/v1/RegistrationAssignments/{OrgCode}/{SequenceNumber} Standard - Edit a Registration Assignment
RegistrationConfigurationsApi registrationConfigurationsDeleteRegistrationConfiguration DELETE /api/v1/RegistrationConfigurations/{OrgCode}/{ConfigurationCode} Standard - Delete a registration configuration entry
RegistrationConfigurationsApi registrationConfigurationsGetRegistrationConfiguration GET /api/v1/RegistrationConfigurations/{OrgCode}/{ConfigurationCode} Standard - Get a single registration configuration by its parameters
RegistrationConfigurationsApi registrationConfigurationsGetRegistrationConfigurationList GET /api/v1/RegistrationConfigurations/{OrgCode} Standard - Search for registration configuration using OData. Note, this will not return user fields. Use the single GET endpoint to retrieve user fields.
RegistrationConfigurationsApi registrationConfigurationsPostRegistrationConfiguration POST /api/v1/RegistrationConfigurations Standard - Add a registration configuration
RegistrationConfigurationsApi registrationConfigurationsPutRegistrationConfiguration PUT /api/v1/RegistrationConfigurations/{OrgCode}/{ConfigurationCode} Standard - Edit a registration configuration
RegistrationOrderItemsApi registrationOrderItemsDeleteRegistrationOrderItem DELETE /api/v1/RegistrationOrderItems/{OrgCode}/{OrderNumber}/{OrderLineNumber} Extended (Registration Orders) - Delete a order item from an order
RegistrationOrderItemsApi registrationOrderItemsGetRegistrationOrderItem GET /api/v1/RegistrationOrderItems/{OrgCode}/{OrderNumber}/{OrderLineNumber} Standard - Get a single registration order item by its parameters
RegistrationOrderItemsApi registrationOrderItemsGetRegistrationOrderItemList GET /api/v1/RegistrationOrderItems/{OrgCode} Standard - Search for registration order items using OData.
RegistrationOrderItemsApi registrationOrderItemsPostRegistrationOrderItem POST /api/v1/RegistrationOrderItems Extended (Registration Orders) - Add an item to an existing registration order
RegistrationOrderItemsApi registrationOrderItemsPutRegistrationOrderItem PUT /api/v1/RegistrationOrderItems/{OrgCode}/{OrderNumber}/{OrderLineNumber} Extended (Registration Orders) - Edit a item on a registration order
RegistrationOrdersApi registrationOrdersCalculateTaxes POST /api/v1/RegistrationOrders/CalculateTaxes Extended (Registration Orders) - Calculate Taxes on a registration order
RegistrationOrdersApi registrationOrdersGetRegistrationOrder GET /api/v1/RegistrationOrders/{OrgCode}/{OrderNumber} Standard - Get a single registration order by its parameters
RegistrationOrdersApi registrationOrdersGetRegistrationOrderList GET /api/v1/RegistrationOrders/{OrgCode} Standard - Search for registration orders using OData. Note, this will not return user fields. Use the single GET endpoint to retrieve user fields.
RegistrationOrdersApi registrationOrdersMoveOrder PUT /api/v1/RegistrationOrders/MoveOrder Extended (Registration Orders) - Use this action endpoint to move Registration Orders a different event or a different function on the same event. This process replicates the &quot;Move Order&quot; functionality found in Ungerboeck's &quot;Registration Orders&quot; window.
RegistrationOrdersApi registrationOrdersMoveOrdersBulk PUT /api/v1/RegistrationOrders/MoveOrdersBulk Extended (Registration Orders) - Use this action endpoint to move multiple Registration Orders to a different event or a different function on the same event. This process replicates the &quot;Move Order&quot; functionality found in Ungerboeck's &quot;Registration Orders&quot; window. If one or more orders fails to move, this endpoint will return a MoveOrdersBulkErrorsModel object.
RegistrationOrdersApi registrationOrdersPostRegistrationOrder POST /api/v1/RegistrationOrders Extended (Registration Orders) - Add a registration order
RegistrationOrdersApi registrationOrdersPutRegistrationOrder PUT /api/v1/RegistrationOrders/{OrgCode}/{OrderNumber} Extended (Registration Orders) - Edit a registration order
RegistrationPreferenceTypesApi registrationPreferenceTypesDeleteRegistrationPreferenceType DELETE /api/v1/RegistrationPreferenceTypes/{RegistrationPreferenceID} Standard - Delete a registration preference type
RegistrationPreferenceTypesApi registrationPreferenceTypesGetRegistrationPreferenceType GET /api/v1/RegistrationPreferenceTypes/{RegistrationPreferenceID} Standard - Get a single registration preference type by its parameters
RegistrationPreferenceTypesApi registrationPreferenceTypesGetRegistrationPreferenceTypeList GET /api/v1/RegistrationPreferenceTypes Standard - Search for registration preference type using OData. Note, this will not return user fields. Use the single GET endpoint to retrieve user fields.
RegistrationPreferenceTypesApi registrationPreferenceTypesPostRegistrationPreferenceType POST /api/v1/RegistrationPreferenceTypes Standard - Add a registration preference type
RegistrationPreferenceTypesApi registrationPreferenceTypesPutRegistrationPreferenceType PUT /api/v1/RegistrationPreferenceTypes/{RegistrationPreferenceID} Standard - Edit a registration preference type
RelationshipTypesApi relationshipTypesGetRelationshipType GET /api/v1/RelationshipTypes/{OrgCode}/{Code} Basic - Get a single relationship type by its parameters
RelationshipTypesApi relationshipTypesGetRelationshipTypeList GET /api/v1/RelationshipTypes/{OrgCode} Basic - Search for relationship type using OData.
RelationshipsApi relationshipsDeleteRelationship DELETE /api/v1/Relationships/{OrgCode}/{MasterAccountCode}/{SubordinateAccountCode}/{RelationshipType} Standard - Delete a relationship between two accounts
RelationshipsApi relationshipsGetRelationship GET /api/v1/Relationships/{OrgCode}/{MasterAccountCode}/{SubordinateAccountCode}/{RelationshipType} Basic - Get a single relationship entry connecting two accounts by its parameters
RelationshipsApi relationshipsGetRelationshipList GET /api/v1/Relationships/{OrgCode} Basic - Search for account relationships using OData.
RelationshipsApi relationshipsPostRelationship POST /api/v1/Relationships Standard - Add a relationship to tie two accounts together
RelationshipsApi relationshipsPutRelationship PUT /api/v1/Relationships/{OrgCode}/{MasterAccountCode}/{SubordinateAccountCode}/{RelationshipType} Standard - Edit a relationship between two accounts
ReportsApi reportsGetParameters GET /api/v1/Reports/{OrgCode}/{ReportSequence}/GetParameters Standard - This returns a paramaters model with parameters needed to run the report
ReportsApi reportsRunReport PUT /api/v1/Reports/{OrgCode}/{ReportSequence}/RunReport Standard - This runs a report
RequisitionApprovalApi requisitionApprovalGetRequisitionApproval GET /api/v1/RequisitionApproval/{OrgCode}/{Number}/{Line}/{Sequence} Standard - Get a single requisition approval by its parameters
RequisitionApprovalApi requisitionApprovalGetRequisitionApprovalList GET /api/v1/RequisitionApproval/{OrgCode} Standard - Search for requisition approval using OData.
RequisitionItemsApi requisitionItemsGetRequisitionItem GET /api/v1/RequisitionItems/{OrgCode}/{Number}/{Sequence} Standard - Get a single requisition item by its parameters
RequisitionItemsApi requisitionItemsGetRequisitionItemList GET /api/v1/RequisitionItems/{OrgCode} Standard - Search for requisition item using OData.
RequisitionTaxesApi requisitionTaxesGetRequisitionTax GET /api/v1/RequisitionTaxes/{OrgCode}/{Number}/{Line}/{Sequence} Basic - Retrieve a RequisitionTax record
RequisitionTaxesApi requisitionTaxesGetRequisitionTaxList GET /api/v1/RequisitionTaxes/{OrgCode} Basic - Search for RequisitionTaxes using OData.
RequisitionsApi requisitionsGetRequisition GET /api/v1/Requisitions/{OrgCode}/{Number} Standard - Get a single requisition by its parameters
RequisitionsApi requisitionsGetRequisitionList GET /api/v1/Requisitions/{OrgCode} Standard - Search for requisitions using OData.
ResourceTaxRatesApi resourceTaxRatesGetResourceMasterTaxRate GET /api/v1/ResourceTaxRates/{OrgCode}/{Sequence} Basic - Retrieve a ResourceMasterTaxRate record
ResourceTaxRatesApi resourceTaxRatesGetResourceMasterTaxRateList GET /api/v1/ResourceTaxRates/{OrgCode} Basic - Search for ResourceTaxRates using OData.
ResourcesApi resourcesDeleteResource DELETE /api/v1/Resources/{OrgCode}/{Sequence} Extended (Resources and Price Lists) - Delete a resource
ResourcesApi resourcesGetResource GET /api/v1/Resources/{OrgCode}/{Sequence} Basic - Get a single resource by its parameters
ResourcesApi resourcesGetResourceList GET /api/v1/Resources/{OrgCode} Basic - Search for resource using OData.
ResourcesApi resourcesPostResource POST /api/v1/Resources Extended (Resources and Price Lists) - Add a Resource
ResourcesApi resourcesPutResource PUT /api/v1/Resources/{OrgCode}/{Sequence} Extended (Resources and Price Lists) - Edit a Resource
RolesApi rolesGetRole GET /api/v1/Roles/{ID} Basic - Get a single Role by its parameters
RolesApi rolesGetRolesList GET /api/v1/Roles Basic - Search for Roles using OData. Note that this search endpoint does not use OrgCode.
RolesApi rolesPostRole POST /api/v1/Roles Standard - Add a Role
RolesApi rolesPutRole PUT /api/v1/Roles/{ID} Standard - Edit a Role
ServiceOrderItemsApi serviceOrderItemsDeleteServiceOrderItem DELETE /api/v1/ServiceOrderItems/{OrgCode}/{OrderNumber}/{OrderLineNumber} Extended (Service Orders) - Delete a order item from an order
ServiceOrderItemsApi serviceOrderItemsGetServiceOrderItem GET /api/v1/ServiceOrderItems/{OrgCode}/{OrderNumber}/{OrderLineNumber} Standard - Get a single service order item by its parameters
ServiceOrderItemsApi serviceOrderItemsGetServiceOrderItemList GET /api/v1/ServiceOrderItems/{OrgCode} Standard - Search for Service order items using OData.
ServiceOrderItemsApi serviceOrderItemsPostServiceOrderItem POST /api/v1/ServiceOrderItems Extended (Service Orders) - Add an item to an existing Service order
ServiceOrderItemsApi serviceOrderItemsPutServiceOrderItem PUT /api/v1/ServiceOrderItems/{OrgCode}/{OrderNumber}/{OrderLineNumber} Extended (Service Orders) - Edit a item on a Service order
ServiceOrdersApi serviceOrdersCompleteWorkOrders PUT /api/v1/ServiceOrders/{OrgCode}/{OrderNumber}/CompleteWorkOrders Extended (Service Orders) - Use this action endpoint to set all work orders on a service order to status Complete. This process replicates the &quot;Complete Work Orders&quot; functionality found in v20's &quot;Service Orders&quot; window.
ServiceOrdersApi serviceOrdersGetServiceOrder GET /api/v1/ServiceOrders/{OrgCode}/{OrderNumber} Standard - Get a single Service order by its parameters
ServiceOrdersApi serviceOrdersGetServiceOrderList GET /api/v1/ServiceOrders/{OrgCode} Standard - Search for Service orders using OData. Note, this will not return user fields. Use the single GET endpoint to retrieve user fields.
ServiceOrdersApi serviceOrdersMoveOrder PUT /api/v1/ServiceOrders/MoveOrder Extended (Service Orders) - Use this action endpoint to move Service Orders to a different event or a different function on the same event. This process replicates the &quot;Move Order&quot; functionality found in Ungerboeck's &quot;Service Orders&quot; window.
ServiceOrdersApi serviceOrdersMoveOrdersBulk PUT /api/v1/ServiceOrders/MoveOrdersBulk Extended (Service Orders) - Use this action endpoint to move multiple Service Orders to a different event or a different function on the same event. This process replicates the &quot;Move Order&quot; functionality found in Ungerboeck's &quot;Service Orders&quot; window. If one or more orders fails to move, this endpoint will return a MoveOrdersBulkErrorsModel object.
ServiceOrdersApi serviceOrdersPostServiceOrder POST /api/v1/ServiceOrders Extended (Service Orders) - Add a Service order
ServiceOrdersApi serviceOrdersPutServiceOrder PUT /api/v1/ServiceOrders/{OrgCode}/{OrderNumber} Extended (Service Orders) - Edit a Service order
SessionProposalEvaluationCriteriaResponsesApi sessionProposalEvaluationCriteriaResponsesDeleteSessionProposalEvaluationCriteriaResponse DELETE /api/v1/SessionProposalEvaluationCriteriaResponses/{AbstractEvaluationResponseId} Standard - Delete a session proposal evaluation response entry
SessionProposalEvaluationCriteriaResponsesApi sessionProposalEvaluationCriteriaResponsesGetSessionProposalEvaluationCriteriaResponse GET /api/v1/SessionProposalEvaluationCriteriaResponses/{AbstractEvaluationResponseId} Standard - Get a single session proposal evaluation response by its parameters
SessionProposalEvaluationCriteriaResponsesApi sessionProposalEvaluationCriteriaResponsesGetSessionProposalEvaluationCriteriaResponseList GET /api/v1/SessionProposalEvaluationCriteriaResponses Standard - Search for session proposal evaluation responses using OData. Note, this will not return user fields. Use the single GET endpoint to retrieve user fields.
SessionProposalEvaluationCriteriaResponsesApi sessionProposalEvaluationCriteriaResponsesPostSessionProposalEvaluationCriteriaResponse POST /api/v1/SessionProposalEvaluationCriteriaResponses Standard - Add a session proposal evaluation response
SessionProposalEvaluationCriteriaResponsesApi sessionProposalEvaluationCriteriaResponsesPutSessionProposalEvaluationCriteriaResponse PUT /api/v1/SessionProposalEvaluationCriteriaResponses/{AbstractEvaluationResponseId} Standard - Edit a session proposal evaluation response
SessionProposalEvaluationsApi sessionProposalEvaluationsDeleteSessionProposalEvaluation DELETE /api/v1/SessionProposalEvaluations/{SessionProposalEvaluationID} Standard - Delete a session proposal evaluation entry
SessionProposalEvaluationsApi sessionProposalEvaluationsGetSessionProposalEvaluation GET /api/v1/SessionProposalEvaluations/{SessionProposalEvaluationID} Standard - Get a single session proposal evaluation by its parameters
SessionProposalEvaluationsApi sessionProposalEvaluationsGetSessionProposalEvaluationList GET /api/v1/SessionProposalEvaluations Standard - Search for session proposal evaluations using OData. Note, this will not return user fields. Use the single GET endpoint to retrieve user fields.
SessionProposalEvaluationsApi sessionProposalEvaluationsPostSessionProposalEvaluation POST /api/v1/SessionProposalEvaluations Standard - Add a session proposal evaluation
SessionProposalEvaluationsApi sessionProposalEvaluationsPutSessionProposalEvaluation PUT /api/v1/SessionProposalEvaluations/{SessionProposalEvaluationID} Standard - Edit a session proposal evaluation
SessionProposalsApi sessionProposalsAssignEvaluators PUT /api/v1/SessionProposals/{OrgCode}/{Id}/AssignEvaluators Standard - Assign evaluators to session propoal
SessionProposalsApi sessionProposalsDeleteSessionProposal DELETE /api/v1/SessionProposals/{OrgCode}/{Id} Standard - Delete a session proposal entry
SessionProposalsApi sessionProposalsGetSessionProposal GET /api/v1/SessionProposals/{OrgCode}/{Id} Standard - Get a single session proposal by its parameters
SessionProposalsApi sessionProposalsGetSessionProposalList GET /api/v1/SessionProposals/{OrgCode} Standard - Search for session proposal using OData. Note, this will not return user fields. Use the single GET endpoint to retrieve user fields.
SessionProposalsApi sessionProposalsPostSessionProposal POST /api/v1/SessionProposals Standard - Add a session proposal
SessionProposalsApi sessionProposalsPutSessionProposal PUT /api/v1/SessionProposals/{OrgCode}/{Id} Standard - Edit a session proposal
SetupsApi setupsGetSetup GET /api/v1/Setups/{OrgCode}/{Code} Basic - Get a single setup by its parameters
SetupsApi setupsGetSetupList GET /api/v1/Setups/{OrgCode} Basic - Search for setups using OData.
SpaceComponentsApi spaceComponentsGetSpaceComponent GET /api/v1/SpaceComponents/{OrgCode}/{Space}/{Component} Basic - Get a single space component by its parameters
SpaceComponentsApi spaceComponentsGetSpaceComponentList GET /api/v1/SpaceComponents/{OrgCode} Basic - Search for space components using OData.
SpaceFeaturesApi spaceFeaturesGetSpaceFeature GET /api/v1/SpaceFeatures/{OrgCode}/{Code} Basic - Get a single space feature by its parameters
SpaceFeaturesApi spaceFeaturesGetSpaceFeatureList GET /api/v1/SpaceFeatures/{OrgCode} Basic - Search for space features using OData.
SpaceHierarchyLevelOnesApi spaceHierarchyLevelOnesGetSpaceHierarchyLevelOne GET /api/v1/SpaceHierarchyLevelOnes/{OrgCode}/{LevelOneSequence} Basic - Get a single level 1 space hierarchy by its parameters
SpaceHierarchyLevelOnesApi spaceHierarchyLevelOnesGetSpaceHierarchyLevelOneList GET /api/v1/SpaceHierarchyLevelOnes/{OrgCode} Basic - Search for a level 1 space hierarchy using OData.
SpaceHierarchyLevelTwosApi spaceHierarchyLevelTwosGetSpaceHierarchyLevelTwo GET /api/v1/SpaceHierarchyLevelTwos/{OrgCode}/{LevelOneSequence}/{LevelTwoSequence} Basic - Get a single level 2 space hierarchy by its parameters
SpaceHierarchyLevelTwosApi spaceHierarchyLevelTwosGetSpaceHierarchyLevelTwoList GET /api/v1/SpaceHierarchyLevelTwos/{OrgCode} Basic - Search for a level 2 space hierarchy using OData.
SpaceImagesApi spaceImagesDeleteSpaceImage DELETE /api/v1/SpaceImages/{OrgCode}/{Id} Standard - Delete a single space image by its parameters
SpaceImagesApi spaceImagesGetSpaceImage GET /api/v1/SpaceImages/{OrgCode}/{Id} Basic - Get a single space image by its parameters
SpaceImagesApi spaceImagesGetSpaceImageList GET /api/v1/SpaceImages/{OrgCode} Basic - Search for space images using OData.
SpaceImagesApi spaceImagesPostSpaceImage POST /api/v1/SpaceImages Standard - Add a space image
SpaceImagesApi spaceImagesPutSpaceImage PUT /api/v1/SpaceImages/{OrgCode}/{Id} Standard - Edit a space image
SpaceSetupsApi spaceSetupsDeleteSpaceSetup DELETE /api/v1/SpaceSetups/{OrgCode}/{Space}/{Code} Standard - Delete a single space setup by its parameters
SpaceSetupsApi spaceSetupsGetSpaceSetup GET /api/v1/SpaceSetups/{OrgCode}/{Space}/{Code} Basic - Get a single space setup by its parameters
SpaceSetupsApi spaceSetupsGetSpaceSetupList GET /api/v1/SpaceSetups/{OrgCode} Basic - Search for space setups using OData.
SpaceSetupsApi spaceSetupsPostSpaceSetup POST /api/v1/SpaceSetups Standard - Add a space setup
SpaceSetupsApi spaceSetupsPutSpaceSetup PUT /api/v1/SpaceSetups/{OrgCode}/{Space}/{Code} Standard - Edit a space setup
SpacesApi spacesGetSpace GET /api/v1/Spaces/{OrgCode}/{Code} Basic - Get a single space by its parameters
SpacesApi spacesGetSpaceList GET /api/v1/Spaces/{OrgCode} Basic - Search for space using OData.
SpacesApi spacesPostSpace POST /api/v1/Spaces Standard - Add a space
SpacesApi spacesPutSpace PUT /api/v1/Spaces/{OrgCode}/{Code} Standard - Edit a space
StatementBatchesApi statementBatchesGetStatementBatch GET /api/v1/StatementBatches/{OrgCode}/{Batch} Standard - Get Statement Batch by its parameters
StatementBatchesApi statementBatchesGetStatementBatchList GET /api/v1/StatementBatches/{OrgCode} Standard - Search for StatementBatches using OData.
StatementDetailsApi statementDetailsGetStatementDetail GET /api/v1/StatementDetails/{OrgCode}/{BatchSequence}/{HeaderSequence}/{SequenceNumber} Standard - Get Statement Detail by its parameters
StatementDetailsApi statementDetailsGetStatementDetailList GET /api/v1/StatementDetails/{OrgCode} Standard - Search for StatementDetails using OData.
StatementHeadersApi statementHeadersGetStatementHeader GET /api/v1/StatementHeaders/{OrgCode}/{BatchSequence}/{Sequence} Standard - Get Statement Header by its parameters
StatementHeadersApi statementHeadersGetStatementHeaderList GET /api/v1/StatementHeaders/{OrgCode} Standard - Search for Statement Headers using OData.
TransactionMethodsApi transactionMethodsGetTransactionMethod GET /api/v1/TransactionMethods/{OrgCode}/{Code} Standard - Get a single transaction method by its parameters
TransactionMethodsApi transactionMethodsGetTransactionMethodList GET /api/v1/TransactionMethods/{OrgCode} Standard - Search for transaction methods using OData.
UserDefinedFieldsApi userDefinedFieldsGetUserDefinedField GET /api/v1/UserDefinedFields/{OrgCode}/{IssueOpportunityClass}/{IssueOpportunityType}/{SequenceNumber} Basic - Get a single user defined field entry by its parameters. Note, this is referring to the metadata of the User Field itself, not the user field values stored on the various Ungerboeck areas.
UserDefinedFieldsApi userDefinedFieldsGetUserDefinedFieldList GET /api/v1/UserDefinedFields/{OrgCode} Basic - Search for user defined field metadata using OData. Note, this is referring to the metadata of the User Field itself, not the user field values stored on the various Ungerboeck areas.
UserRolesApi userRolesDeleteUserRole DELETE /api/v1/UserRoles/{User}/{Role} Standard - Delete a Role from a User
UserRolesApi userRolesGetUserRole GET /api/v1/UserRoles/{User}/{Role} Basic - Get a single UserRole entry by its parameters
UserRolesApi userRolesGetUserRoleList GET /api/v1/UserRoles Basic - Search for UserRoles using OData. Note that this search endpoint does not use OrgCode.
UserRolesApi userRolesPostUserRole POST /api/v1/UserRoles Standard - Add a role to a user. You can include a comma delimited list of User ID's, Role ID's, but not both.
UsersApi usersCopy PUT /api/v1/Users/{SourceID}/Copy Standard - Copy a User, optionally bringing along its sub items
UsersApi usersGetUser GET /api/v1/Users/{ID} Basic - Get a single user by its parameters
UsersApi usersGetUserList GET /api/v1/Users Basic - Search for users using OData. Note that this search endpoint does not use OrgCode.
UsersApi usersPostUser POST /api/v1/Users Standard - Add a user
UsersApi usersPutUser PUT /api/v1/Users/{ID} Standard - Edit a User
UsersApi usersSendActivateUserEmail PUT /api/v1/Users/{ID}/SendActivateUserEmail Standard - This will generate and send a set password message to the user's email address. Once the user completes the process, they wil be able to log in to Ungerboeck. Running this endpoint will not affect anything on the user data.
ValidationEntriesApi validationEntriesGetValidationEntry GET /api/v1/ValidationEntries/{OrgCode}/{ValidationTableID}/{SequenceNumber} Basic - Get a single validation entry by its parameters
ValidationEntriesApi validationEntriesGetValidationEntryList GET /api/v1/ValidationEntries/{OrgCode} Basic - Search for validation entries using OData.
VoucherApprovalsApi voucherApprovalsGetVoucherApproval GET /api/v1/VoucherApprovals/{OrgCode}/{VoucherNumber}/{VoucherDistrSeq}/{Sequence} Standard - Get a voucher approval by its parameters
VoucherApprovalsApi voucherApprovalsGetVoucherApprovalList GET /api/v1/VoucherApprovals/{OrgCode} Standard - Search for voucher approvals using OData.
VoucherBatchesApi voucherBatchesGetVoucherBatch GET /api/v1/VoucherBatches/{OrgCode}/{Batch} Standard - Get a voucher batch by its parameters
VoucherBatchesApi voucherBatchesGetVoucherBatchList GET /api/v1/VoucherBatches/{OrgCode} Standard - Search for voucher batches using OData.
VoucherDistributionApi voucherDistributionGetVoucherDistribution GET /api/v1/VoucherDistribution/{OrgCode}/{Voucher}/{Sequence} Standard - Get a voucher distribution by its parameters
VoucherDistributionApi voucherDistributionGetVoucherDistributionList GET /api/v1/VoucherDistribution/{OrgCode} Standard - Search for voucher distributions using OData.
VoucherPaymentInstructionsApi voucherPaymentInstructionsGetVoucherPaymentInstruction GET /api/v1/VoucherPaymentInstructions/{OrgCode}/{Voucher}/{SequenceNumber} Standard - Get a voucher payment instruction by its parameters
VoucherPaymentInstructionsApi voucherPaymentInstructionsGetVoucherPaymentInstructionList GET /api/v1/VoucherPaymentInstructions/{OrgCode} Standard - Search for voucher payment instructions using OData.
VoucherPurchaseOrderDetailsApi voucherPurchaseOrderDetailsGetVoucherPurchaseOrderDetail GET /api/v1/VoucherPurchaseOrderDetails/{OrgCode}/{Voucher}/{PONumber}/{Sequence} Standard - Get a voucher purchase order detail by its parameters
VoucherPurchaseOrderDetailsApi voucherPurchaseOrderDetailsGetVoucherPurchaseOrderDetailList GET /api/v1/VoucherPurchaseOrderDetails/{OrgCode} Standard - Search for voucher purchase order details using OData.
VoucherTaxesApi voucherTaxesGetVoucherTax GET /api/v1/VoucherTaxes/{OrgCode}/{Voucher}/{Sequence} Standard - Get a voucher tax by its parameters
VoucherTaxesApi voucherTaxesGetVoucherTaxList GET /api/v1/VoucherTaxes/{OrgCode} Standard - Search for voucher taxes using OData.
VouchersApi vouchersGetVoucher GET /api/v1/Vouchers/{OrgCode}/{Voucher} Standard - Get Voucher by its parameters
VouchersApi vouchersGetVouchersList GET /api/v1/Vouchers/{OrgCode} Standard - Search for Vouchers using OData.
WebhooksApi webhooksGetWebhook GET /api/v1/Webhooks/{OrgCode}/{SequenceNumber} Standard - Get a single web hook by its parameters
WebhooksApi webhooksGetWebhookList GET /api/v1/Webhooks/{OrgCode} Standard - Search for web hooks using OData.
WorkOrderItemsApi workOrderItemsGetWorkOrderItem GET /api/v1/WorkOrderItems/{OrgCode}/{OrderNumber}/{OrderLineNumber} Basic - Get a single work order item by its parameters
WorkOrderItemsApi workOrderItemsGetWorkOrderItemList GET /api/v1/WorkOrderItems/{OrgCode} Basic - Search for work order items using OData.
WorkOrdersApi workOrdersGetWorkOrder GET /api/v1/WorkOrders/{OrgCode}/{Order}/{Department} Basic - Get a single work order by its parameters
WorkOrdersApi workOrdersGetWorkOrderList GET /api/v1/WorkOrders/{OrgCode} Basic - Search for work order using OData.

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

About

SDK for the Ungerboeck API generated with the swagger codegen project, which allows generation of API client libraries (SDK generation).

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages