POST CustomerAdjustment/Calculate

Calculates the specified Customer Adjustment total fields.

Request Information

URI Parameters

None.

Body Parameters

The Customer Adjustment.

Customer Adjustment
NameTypeAdditional informationDescription
ID integer

None.

Date date

Required

CustomerId integer

None.

DocumentNumber string

None.

Reference string

None.

Description string

None.

TaxTypeId integer

None.

Exclusive decimal

None.

Tax decimal

None.

Total decimal

None.

ContraAccountId integer

None.

Memo string

None.

AnalysisCategoryId1 nullable integer

None.

Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.

AnalysisCategoryId2 nullable integer

None.

Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.

AnalysisCategoryId3 nullable integer

None.

Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.

HasAttachments bool

None.

Customer Customer

Read Only / System Generated

Account Account

Read Only / System Generated

Locked bool

Read Only / System Generated

TaxPeriodId nullable integer

Read Only / System Generated

TotalOutstanding nullable decimal

Read Only / System Generated

Inclusive bool

None.

Customer_CurrencyId nullable integer

None.

Customer_ExchangeRate nullable decimal

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "Date": "2021-10-23",
  "CustomerId": 3,
  "DocumentNumber": "sample string 4",
  "Reference": "sample string 5",
  "Description": "sample string 6",
  "TaxTypeId": 7,
  "Exclusive": 8.0,
  "Tax": 9.0,
  "Total": 10.0,
  "ContraAccountId": 11,
  "Memo": "sample string 12",
  "AnalysisCategoryId1": 1,
  "AnalysisCategoryId2": 1,
  "AnalysisCategoryId3": 1,
  "HasAttachments": true,
  "Customer": {
    "Name": "sample string 1",
    "Category": {
      "Description": "sample string 1",
      "ID": 2,
      "Modified": "2021-10-23",
      "Created": "2021-10-23"
    },
    "SalesRepresentativeId": 1,
    "SalesRepresentative": {
      "ID": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Name": "sample string 2 sample string 3",
      "Active": true,
      "Email": "sample string 6",
      "Mobile": "sample string 7",
      "Telephone": "sample string 8",
      "Created": "2021-10-23",
      "Modified": "2021-10-23"
    },
    "TaxReference": "sample string 2",
    "ContactName": "sample string 3",
    "Telephone": "sample string 4",
    "Fax": "sample string 5",
    "Mobile": "sample string 6",
    "Email": "sample string 7",
    "WebAddress": "sample string 8",
    "Active": true,
    "IsObfuscated": true,
    "Balance": 11.0,
    "CreditLimit": 12.0,
    "CommunicationMethod": 1,
    "PostalAddress01": "sample string 13",
    "PostalAddress02": "sample string 14",
    "PostalAddress03": "sample string 15",
    "PostalAddress04": "sample string 16",
    "PostalAddress05": "sample string 17",
    "DeliveryAddress01": "sample string 18",
    "DeliveryAddress02": "sample string 19",
    "DeliveryAddress03": "sample string 20",
    "DeliveryAddress04": "sample string 21",
    "DeliveryAddress05": "sample string 22",
    "AutoAllocateToOldestInvoice": true,
    "EnableCustomerZone": true,
    "CustomerZoneGuid": "a06352f4-fd91-4cd6-a996-3a90c68f9538",
    "CashSale": true,
    "TextField1": "sample string 25",
    "TextField2": "sample string 26",
    "TextField3": "sample string 27",
    "NumericField1": 1.0,
    "NumericField2": 1.0,
    "NumericField3": 1.0,
    "YesNoField1": true,
    "YesNoField2": true,
    "YesNoField3": true,
    "DateField1": "2021-10-23",
    "DateField2": "2021-10-23",
    "DateField3": "2021-10-23",
    "DefaultPriceListId": 1,
    "DefaultPriceList": {
      "ID": 1,
      "Description": "sample string 2",
      "IsDefault": true
    },
    "DefaultPriceListName": "sample string 2",
    "AcceptsElectronicInvoices": true,
    "Modified": "2021-10-23",
    "Created": "2021-10-23",
    "BusinessRegistrationNumber": "sample string 34",
    "TaxStatusVerified": "2021-10-23",
    "CurrencyId": 1,
    "CurrencySymbol": "sample string 35",
    "HasActivity": true,
    "DefaultDiscountPercentage": 1.0,
    "DefaultTaxTypeId": 1,
    "DefaultTaxType": {
      "ID": 1,
      "Name": "sample string 2",
      "Percentage": 3.1,
      "IsDefault": true,
      "HasActivity": true,
      "IsManualTax": true,
      "Active": true,
      "Created": "2021-10-23",
      "Modified": "2021-10-23",
      "TaxTypeDefaultUID": "1fa14670-13fe-4830-a161-1ef94ab5790e",
      "CompanyId": 9
    },
    "DueDateMethodId": 1,
    "DueDateMethodValue": 1,
    "CityId": 1,
    "HasSpecialCountryTax": true,
    "AccountingAgreement": true,
    "HasSpecialCountryTaxActivity": true,
    "OutstandingInvoices": true,
    "OverdueInvoices": true,
    "OnHold": true,
    "ExcludeFromDebtorsManager": true,
    "ID": 39
  },
  "Account": {
    "Name": "sample string 2",
    "Category": {
      "Comment": "sample string 1",
      "Order": 6,
      "Description": "sample string 7",
      "ID": 8,
      "Modified": "2021-10-23",
      "Created": "2021-10-23"
    },
    "Active": true,
    "Balance": 4.0,
    "Description": "sample string 5",
    "ReportingGroupId": 1,
    "UnallocatedAccount": true,
    "IsTaxLocked": true,
    "Modified": "2021-10-23",
    "Created": "2021-10-23",
    "AccountType": 9,
    "HasActivity": true,
    "DefaultTaxTypeId": 1,
    "DefaultTaxType": {
      "ID": 1,
      "Name": "sample string 2",
      "Percentage": 3.1,
      "IsDefault": true,
      "HasActivity": true,
      "IsManualTax": true,
      "Active": true,
      "Created": "2021-10-23",
      "Modified": "2021-10-23",
      "TaxTypeDefaultUID": "1fa14670-13fe-4830-a161-1ef94ab5790e",
      "CompanyId": 9
    },
    "ID": 11
  },
  "Locked": true,
  "TaxPeriodId": 1,
  "TotalOutstanding": 1.0,
  "Inclusive": true,
  "Customer_CurrencyId": 1,
  "Customer_ExchangeRate": 1.0,
  "Link_CurrencyId": 1,
  "Link_ExchangeRate": 1.0
}

Response Information

Resource Description

Customer Adjustment
NameTypeAdditional informationDescription
ID integer

None.

Date date

Required

CustomerId integer

None.

DocumentNumber string

None.

Reference string

None.

Description string

None.

TaxTypeId integer

None.

Exclusive decimal

None.

Tax decimal

None.

Total decimal

None.

ContraAccountId integer

None.

Memo string

None.

AnalysisCategoryId1 nullable integer

None.

Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.

AnalysisCategoryId2 nullable integer

None.

Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.

AnalysisCategoryId3 nullable integer

None.

Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.

HasAttachments bool

None.

Customer Customer

Read Only / System Generated

Account Account

Read Only / System Generated

Locked bool

Read Only / System Generated

TaxPeriodId nullable integer

Read Only / System Generated

TotalOutstanding nullable decimal

Read Only / System Generated

Inclusive bool

None.

Customer_CurrencyId nullable integer

None.

Customer_ExchangeRate nullable decimal

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "Date": "2021-10-23",
  "CustomerId": 3,
  "DocumentNumber": "sample string 4",
  "Reference": "sample string 5",
  "Description": "sample string 6",
  "TaxTypeId": 7,
  "Exclusive": 8.0,
  "Tax": 9.0,
  "Total": 10.0,
  "ContraAccountId": 11,
  "Memo": "sample string 12",
  "AnalysisCategoryId1": 1,
  "AnalysisCategoryId2": 1,
  "AnalysisCategoryId3": 1,
  "HasAttachments": true,
  "Customer": {
    "Name": "sample string 1",
    "Category": {
      "Description": "sample string 1",
      "ID": 2,
      "Modified": "2021-10-23",
      "Created": "2021-10-23"
    },
    "SalesRepresentativeId": 1,
    "SalesRepresentative": {
      "ID": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Name": "sample string 2 sample string 3",
      "Active": true,
      "Email": "sample string 6",
      "Mobile": "sample string 7",
      "Telephone": "sample string 8",
      "Created": "2021-10-23",
      "Modified": "2021-10-23"
    },
    "TaxReference": "sample string 2",
    "ContactName": "sample string 3",
    "Telephone": "sample string 4",
    "Fax": "sample string 5",
    "Mobile": "sample string 6",
    "Email": "sample string 7",
    "WebAddress": "sample string 8",
    "Active": true,
    "IsObfuscated": true,
    "Balance": 11.0,
    "CreditLimit": 12.0,
    "CommunicationMethod": 1,
    "PostalAddress01": "sample string 13",
    "PostalAddress02": "sample string 14",
    "PostalAddress03": "sample string 15",
    "PostalAddress04": "sample string 16",
    "PostalAddress05": "sample string 17",
    "DeliveryAddress01": "sample string 18",
    "DeliveryAddress02": "sample string 19",
    "DeliveryAddress03": "sample string 20",
    "DeliveryAddress04": "sample string 21",
    "DeliveryAddress05": "sample string 22",
    "AutoAllocateToOldestInvoice": true,
    "EnableCustomerZone": true,
    "CustomerZoneGuid": "92033792-2ef8-4393-aff9-a036fc7e8c01",
    "CashSale": true,
    "TextField1": "sample string 25",
    "TextField2": "sample string 26",
    "TextField3": "sample string 27",
    "NumericField1": 1.0,
    "NumericField2": 1.0,
    "NumericField3": 1.0,
    "YesNoField1": true,
    "YesNoField2": true,
    "YesNoField3": true,
    "DateField1": "2021-10-23",
    "DateField2": "2021-10-23",
    "DateField3": "2021-10-23",
    "DefaultPriceListId": 1,
    "DefaultPriceList": {
      "ID": 1,
      "Description": "sample string 2",
      "IsDefault": true
    },
    "DefaultPriceListName": "sample string 2",
    "AcceptsElectronicInvoices": true,
    "Modified": "2021-10-23",
    "Created": "2021-10-23",
    "BusinessRegistrationNumber": "sample string 34",
    "TaxStatusVerified": "2021-10-23",
    "CurrencyId": 1,
    "CurrencySymbol": "sample string 35",
    "HasActivity": true,
    "DefaultDiscountPercentage": 1.0,
    "DefaultTaxTypeId": 1,
    "DefaultTaxType": {
      "ID": 1,
      "Name": "sample string 2",
      "Percentage": 3.1,
      "IsDefault": true,
      "HasActivity": true,
      "IsManualTax": true,
      "Active": true,
      "Created": "2021-10-23",
      "Modified": "2021-10-23",
      "TaxTypeDefaultUID": "050de902-9afe-4284-96f8-9be1ad61feb3",
      "CompanyId": 9
    },
    "DueDateMethodId": 1,
    "DueDateMethodValue": 1,
    "CityId": 1,
    "HasSpecialCountryTax": true,
    "AccountingAgreement": true,
    "HasSpecialCountryTaxActivity": true,
    "OutstandingInvoices": true,
    "OverdueInvoices": true,
    "OnHold": true,
    "ExcludeFromDebtorsManager": true,
    "ID": 39
  },
  "Account": {
    "Name": "sample string 2",
    "Category": {
      "Comment": "sample string 1",
      "Order": 6,
      "Description": "sample string 7",
      "ID": 8,
      "Modified": "2021-10-23",
      "Created": "2021-10-23"
    },
    "Active": true,
    "Balance": 4.0,
    "Description": "sample string 5",
    "ReportingGroupId": 1,
    "UnallocatedAccount": true,
    "IsTaxLocked": true,
    "Modified": "2021-10-23",
    "Created": "2021-10-23",
    "AccountType": 9,
    "HasActivity": true,
    "DefaultTaxTypeId": 1,
    "DefaultTaxType": {
      "ID": 1,
      "Name": "sample string 2",
      "Percentage": 3.1,
      "IsDefault": true,
      "HasActivity": true,
      "IsManualTax": true,
      "Active": true,
      "Created": "2021-10-23",
      "Modified": "2021-10-23",
      "TaxTypeDefaultUID": "050de902-9afe-4284-96f8-9be1ad61feb3",
      "CompanyId": 9
    },
    "ID": 11
  },
  "Locked": true,
  "TaxPeriodId": 1,
  "TotalOutstanding": 1.0,
  "Inclusive": true,
  "Customer_CurrencyId": 1,
  "Customer_ExchangeRate": 1.0,
  "Link_CurrencyId": 1,
  "Link_ExchangeRate": 1.0
}