Organization

Organization API - CRUD operations for Office, Cost Center, Regions, Countries, Currencies

APIDescription
GET warmup

Warm up the API by making a first call to the DB
GET corporation/get/{corporationId}

Gets an existing corporation
POST corporation/add

Adds a new corporation
PUT corporation/update

Updates an existing corporation
DELETE corporation/remove?ids[0]={ids[0]}&ids[1]={ids[1]}

Marks a corporation as inactive
GET corporation/find?CorporationId={CorporationId}&Name={Name}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform a Corporation search
GET division/get/{divisionId}

Gets an existing Division
POST division/add

Adds a new Division
PUT division/update

Updates an existing division
DELETE division/remove?ids[0]={ids[0]}&ids[1]={ids[1]}

Marks a division as inactive
GET division/find?Name={Name}&DivisionId={DivisionId}&CorporationId={CorporationId}&DCFOUserName={DCFOUserName}&DEVPUserName={DEVPUserName}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform a Division search
GET office/get/{officeId}

Gets an existing office
GET office/find?Name={Name}&CompanyCode={CompanyCode}&RegionId={RegionId}&CountryId={CountryId}&OfficeId={OfficeId}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform an office search
GET office/find/namecode?Name={Name}&CompanyCode={CompanyCode}&RegionId={RegionId}&CountryId={CountryId}&OfficeId={OfficeId}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform an office search
GET office/find/dropdown?Name={Name}&CompanyCode={CompanyCode}&RegionId={RegionId}&CountryId={CountryId}&OfficeId={OfficeId}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform an office search
POST office/add

Adds a new office
PUT office/update

Updates an existing office
DELETE office/remove?ids[0]={ids[0]}&ids[1]={ids[1]}

Marks a office as inactive
GET office/user/office/permission/find/dropdown?Name={Name}&CompanyCode={CompanyCode}&RegionId={RegionId}&CountryId={CountryId}&OfficeId={OfficeId}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform an office search
GET jurisdictionCode/get/{jurisdictionCodeId}

No documentation available.
GET jurisdictionCode/find?CountryId={CountryId}&Code={Code}&SapTaxCodeSettingId={SapTaxCodeSettingId}&Name={Name}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform a SapTaxCodeSetting search
POST jurisdictionCode/add

No documentation available.
PUT jurisdictionCode/update

Updates an existing JurisdictionCode
DELETE jurisdictionCode/remove?ids[0]={ids[0]}&ids[1]={ids[1]}

Marks a jurisdictionCode as inactive
GET saptaxcodesetting/get/{sapTaxCodeSettingId}

No documentation available.
GET saptaxcodesetting/find?SapCode={SapCode}&Name={Name}&CountryId={CountryId}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform a SapTaxCodeSetting search
POST saptaxcodesetting/add

No documentation available.
PUT saptaxcodesetting/update

Updates an existing SapTaxCodeSetting
DELETE saptaxcodesetting/remove?ids[0]={ids[0]}&ids[1]={ids[1]}

Marks a saptaxcodesettings as inactive
GET category/get/{categoryId}

No documentation available.
GET category/find?SAPCategoryId={SAPCategoryId}&Description={Description}&CategoryTypeId={CategoryTypeId}&CategoryGroupId={CategoryGroupId}&OfficeId={OfficeId}&ClaimType={ClaimType}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform a categories search
POST category/add

No documentation available.
PUT category/update

Updates an existing Categories
DELETE category/remove?ids[0]={ids[0]}&ids[1]={ids[1]}

Marks a saptaxcodesettings as inactive
GET categorygroup/find?CategoryGroupId={CategoryGroupId}&Description={Description}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform a categories search
GET categorytype/find?CategoryTypeId={CategoryTypeId}&Description={Description}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform a categories search
GET sapcategory/find?SAPCategoryId={SAPCategoryId}&Description={Description}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform a categories search
GET costcenter/get/{costCenterId}

Gets an existing Cost Center
GET costcenter/find?Name={Name}&Code={Code}&OfficeId={OfficeId}&BeneficiaryId={BeneficiaryId}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform a cost center search
GET costcenter/find/dropdown?Name={Name}&Code={Code}&OfficeId={OfficeId}&BeneficiaryId={BeneficiaryId}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform a cost center search
POST costcenter/add

Adds a new Cost Center
POST costcenter/bulkupload/{updateExistingRecords}/{culture}

No documentation available.
PUT costcenter/update

Updates an existing cost center
DELETE costcenter/remove?ids[0]={ids[0]}&ids[1]={ids[1]}

Marks a cost center as inactive
GET region/get/{regionId}

Gets an existing Region
GET region/find?RegionId={RegionId}&DivisionId={DivisionId}&Name={Name}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform a region search
POST region/add

Adds a new Region
PUT region/update

Updates an existing region
DELETE region/remove?ids[0]={ids[0]}&ids[1]={ids[1]}

Marks a region as inactive
GET country/get/{countryId}

Gets an existing Country
GET country/find?Name={Name}&Abbreviation={Abbreviation}&RegionId={RegionId}&OfficeId={OfficeId}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform a country search
POST country/add

Adds a new Country
PUT country/update

Updates an existing country
DELETE country/remove?ids[0]={ids[0]}&ids[1]={ids[1]}

Marks a country as inactive
GET country/finddistinct?Name={Name}&Abbreviation={Abbreviation}&RegionId={RegionId}&OfficeId={OfficeId}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform a country search
GET currency/get/{currencyId}

Gets an existing Currency
GET currency/convert?FromAmount={FromAmount}&FromNonTaxAmount={FromNonTaxAmount}&FromCurrency={FromCurrency}&ToCurrency={ToCurrency}&IsActive={IsActive}

convert a value from one currency to another
GET currency/exchangerate/get?FromAmount={FromAmount}&FromNonTaxAmount={FromNonTaxAmount}&FromCurrency={FromCurrency}&ToCurrency={ToCurrency}&IsActive={IsActive}

convert a value from one currency to another
GET currency/find?CurrencyId={CurrencyId}&Name={Name}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

Perform a currency search
POST currency/add

Adds a new Currency
PUT currency/update

Updates an existing currency
DELETE currency/remove?ids[0]={ids[0]}&ids[1]={ids[1]}

Marks a currency as inactive
POST event/add

Adds a new Region
GET event/get?RecordName={RecordName}&RecordId={RecordId}&ActiveOnly={ActiveOnly}&Page={Page}&PageSize={PageSize}&OrderBy={OrderBy}&Order={Order}&IsPaged={IsPaged}&AddedByUserId={AddedByUserId}&ApprovedByUserId={ApprovedByUserId}&NextActionUserId={NextActionUserId}

returns all the events for a record
GET menu/get/{officeId}

Gets the list of menu items available for an office
POST document/upload

Uploads bank guarantee related files on the server
POST document/upload/v2

Uploads bank guarantee related files on the server
DELETE document/remove/{documentId}

remove a document from the db
GET document/download/{documentId}

Uploads bank guarantee related files on the server