Sync
Developing
POST
https://brandcheck-nonprod-api-dev.azurewebsites.net/api/v1/altair/sync
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Body Params application/json
Example
{
"ClientRecord": [
{
"GeneralData": {
"ObjectType": "Client",
"ClientID": "12345",
"ClientName": "Sample Client",
"ClientName2": "Alternate Name",
"ClientStreet": "123 Main St",
"ClientStreet2": "Apt 101",
"ClientStreet3": "",
"ClientPostalCode": "12345",
"ClientCity": "Metropolis",
"ClientState": "MetroState",
"ClientCountry": "Countryland",
"CorporateGroup": "GroupA",
"HFMNamedClient": "HFM123",
"TaxNumber1": "123-456-789",
"TaxNumber2": "987-654-321",
"VATRegNo": "VAT123456",
"TaxJuridiction": "TaxJurisdictionA",
"IndustryCode": "IndustryXYZ",
"ContactName": "John Doe",
"ClientLock": "Unlocked",
"ClientStatus": "Active",
"ClientEmail": "client@example.com",
"ClientPhoneNr": "+1234567890",
"DeletionFlag": "Not Deleted",
"SearchTerm": "Sample",
"ClientType": "TypeA",
"TaxNumber3": "111-222-333",
"TaxNumber4": "",
"TaxNumber5": "",
"PXPClientName": "PXP Client",
"PXPBrandName": "PXP Brand"
},
"OrgaData": [
{
"HFMEntity": "EntityA",
"CompanyCode": "C123",
"AgencyCode": "A456",
"SalesOrg": "SalesOrg123",
"Currency": "USD",
"JobAccountDir": "AccountDir123",
"FinanceControl": "FinanceCtrl123",
"HFMEntityLock": "Unlocked",
"ZZLegacyID": "LegacyID789",
"BillingStyle": "StyleA",
"PaymentTerms": "Net30",
"Biller": "Biller123",
"BillingApprover": "ApproverA",
"ROARProjectApprover": "ProjectApprover123",
"ROARFeeApprover": "FeeApprover123",
"PXPClientAbbr": "PXPAbbr",
"PXPBrandAbbr": "PXPA",
"Partners": {
"PartnerFunction": "FunctionA",
"PartnerID": "PartnerID123"
}
}
]
}
]
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://brandcheck-nonprod-api-dev.azurewebsites.net/api/v1/altair/sync' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"ClientRecord": [
{
"GeneralData": {
"ObjectType": "Client",
"ClientID": "12345",
"ClientName": "Sample Client",
"ClientName2": "Alternate Name",
"ClientStreet": "123 Main St",
"ClientStreet2": "Apt 101",
"ClientStreet3": "",
"ClientPostalCode": "12345",
"ClientCity": "Metropolis",
"ClientState": "MetroState",
"ClientCountry": "Countryland",
"CorporateGroup": "GroupA",
"HFMNamedClient": "HFM123",
"TaxNumber1": "123-456-789",
"TaxNumber2": "987-654-321",
"VATRegNo": "VAT123456",
"TaxJuridiction": "TaxJurisdictionA",
"IndustryCode": "IndustryXYZ",
"ContactName": "John Doe",
"ClientLock": "Unlocked",
"ClientStatus": "Active",
"ClientEmail": "client@example.com",
"ClientPhoneNr": "+1234567890",
"DeletionFlag": "Not Deleted",
"SearchTerm": "Sample",
"ClientType": "TypeA",
"TaxNumber3": "111-222-333",
"TaxNumber4": "",
"TaxNumber5": "",
"PXPClientName": "PXP Client",
"PXPBrandName": "PXP Brand"
},
"OrgaData": [
{
"HFMEntity": "EntityA",
"CompanyCode": "C123",
"AgencyCode": "A456",
"SalesOrg": "SalesOrg123",
"Currency": "USD",
"JobAccountDir": "AccountDir123",
"FinanceControl": "FinanceCtrl123",
"HFMEntityLock": "Unlocked",
"ZZLegacyID": "LegacyID789",
"BillingStyle": "StyleA",
"PaymentTerms": "Net30",
"Biller": "Biller123",
"BillingApprover": "ApproverA",
"ROARProjectApprover": "ProjectApprover123",
"ROARFeeApprover": "FeeApprover123",
"PXPClientAbbr": "PXPAbbr",
"PXPBrandAbbr": "PXPA",
"Partners": {
"PartnerFunction": "FunctionA",
"PartnerID": "PartnerID123"
}
}
]
}
]
}'Responses
🟢200Success
application/json
Body
Example
"statusCode": 200,
"isSucceded": true,
"errors": []🔴500Server Error
Modified at 2024-05-22 07:30:55