Skip to content
This repository has been archived by the owner on May 11, 2022. It is now read-only.

Latest commit

 

History

History
executable file
·
123 lines (79 loc) · 4.92 KB

CompanyInformationApi.md

File metadata and controls

executable file
·
123 lines (79 loc) · 4.92 KB

\CompanyInformationApi

All URIs are relative to https://api.businesscentral.dynamics.com/v2.0/sandbox/api/v1.0

Method HTTP request Description
GetCompanyInformation Get /companies({company_id})/companyInformation({companyInformation_id}) getCompanyInformation
ListCompanyInformation Get /companies({company_id})/companyInformation listCompanyInformation
PatchCompanyInformation Patch /companies({company_id})/companyInformation({companyInformation_id}) patchCompanyInformation

GetCompanyInformation

CompanyInformation GetCompanyInformation(ctx, companyId, companyInformationId, optional) getCompanyInformation

Retrieve the properties and relationships of an object of type companyInformation for Dynamics 365 Business Central.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId string id for company
companyInformationId string id for companyInformation
optional *GetCompanyInformationOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCompanyInformationOpts struct

Name Type Description Notes

select_ | optional.Interface of []string| Selected properties to be retrieved |

Return type

CompanyInformation

Authorization

auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListCompanyInformation

CompaniesApiCompanyInformationResponse ListCompanyInformation(ctx, companyId, optional) listCompanyInformation

Returns a list of companyInformation

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId string id for company
optional *ListCompanyInformationOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListCompanyInformationOpts struct

Name Type Description Notes

top | optional.Int32| Number of items to return from the top of the list | skip | optional.Int32| Number of items to skip from the list | limit | optional.Int32| Number of items to return from the list | filter | optional.String| Filtering expression | select_ | optional.Interface of []string| Selected properties to be retrieved |

Return type

CompaniesApiCompanyInformationResponse

Authorization

auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchCompanyInformation

CompanyInformation PatchCompanyInformation(ctx, companyId, companyInformationId, contentType, ifMatch, body) patchCompanyInformation

Updates an object of type companyInformation in Dynamics 365 Business Central

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
companyId string id for company
companyInformationId string id for companyInformation
contentType string application/json
ifMatch string Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
body CompanyInformation

Return type

CompanyInformation

Authorization

auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]