POST SupplierAdjustment/Calculate

Calculates the total, exclusive, tax and inclusive value of the Supplier Adjustment for the Document Header.

Request Information

URI Parameters

None.

Body Parameters

The Supplier Adjustment Object.

Name	Type	Additional information	Description
ID	integer	None.
Date	date	Required
SupplierId	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.
HasAttachments	bool	None.
Supplier	Supplier	None.
AccountName	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.
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.
Supplier_CurrencyId	nullable integer	None.
Supplier_ExchangeRate	nullable decimal	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Date": "2025-10-25",
  "SupplierId": 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",
  "HasAttachments": true,
  "Supplier": {
    "Name": "sample string 1",
    "Category": {
      "Description": "sample string 1",
      "ID": 2,
      "Modified": "2025-10-25",
      "Created": "2025-10-25"
    },
    "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,
    "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,
    "TextField1": "sample string 23",
    "TextField2": "sample string 24",
    "TextField3": "sample string 25",
    "NumericField1": 1.0,
    "NumericField2": 1.0,
    "NumericField3": 1.0,
    "YesNoField1": true,
    "YesNoField2": true,
    "YesNoField3": true,
    "DateField1": "2025-10-25",
    "DateField2": "2025-10-25",
    "DateField3": "2025-10-25",
    "AccountingAgreement": true,
    "HasSpecialCountryTaxActivity": true,
    "Modified": "2025-10-25",
    "Created": "2025-10-25",
    "BusinessRegistrationNumber": "sample string 33",
    "RMCDApprovalNumber": "sample string 34",
    "TaxStatusVerified": "2025-10-25",
    "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": "2025-10-25",
      "Modified": "2025-10-25",
      "TaxTypeDefaultUID": "9fe0def6-f30b-4010-aa5c-6902295f327f",
      "CompanyId": 9
    },
    "DueDateMethodId": 1,
    "DueDateMethodValue": 1,
    "SubjectToDRCVat": true,
    "ID": 38
  },
  "AccountName": "sample string 14",
  "AnalysisCategoryId1": 1,
  "AnalysisCategoryId2": 1,
  "AnalysisCategoryId3": 1,
  "Account": {
    "Name": "sample string 2",
    "Category": {
      "Comment": "sample string 1",
      "Order": 6,
      "Description": "sample string 7",
      "ID": 8,
      "Modified": "2025-10-25",
      "Created": "2025-10-25"
    },
    "Active": true,
    "Balance": 4.0,
    "Description": "sample string 5",
    "ReportingGroupId": 1,
    "UnallocatedAccount": true,
    "IsTaxLocked": true,
    "Modified": "2025-10-25",
    "Created": "2025-10-25",
    "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": "2025-10-25",
      "Modified": "2025-10-25",
      "TaxTypeDefaultUID": "9fe0def6-f30b-4010-aa5c-6902295f327f",
      "CompanyId": 9
    },
    "ID": 11
  },
  "Locked": true,
  "TaxPeriodId": 1,
  "TotalOutstanding": 1.0,
  "Inclusive": true,
  "Supplier_CurrencyId": 1,
  "Supplier_ExchangeRate": 1.0,
  "Link_CurrencyId": 1,
  "Link_ExchangeRate": 1.0
}

Response Information

Resource Description

Returns the Supplier Adjustment Object with the calculated values.

Supplier Adjustment

Name	Type	Additional information	Description
ID	integer	None.
Date	date	Required
SupplierId	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.
HasAttachments	bool	None.
Supplier	Supplier	None.
AccountName	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.
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.
Supplier_CurrencyId	nullable integer	None.
Supplier_ExchangeRate	nullable decimal	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Date": "2025-10-25",
  "SupplierId": 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",
  "HasAttachments": true,
  "Supplier": {
    "Name": "sample string 1",
    "Category": {
      "Description": "sample string 1",
      "ID": 2,
      "Modified": "2025-10-25",
      "Created": "2025-10-25"
    },
    "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,
    "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,
    "TextField1": "sample string 23",
    "TextField2": "sample string 24",
    "TextField3": "sample string 25",
    "NumericField1": 1.0,
    "NumericField2": 1.0,
    "NumericField3": 1.0,
    "YesNoField1": true,
    "YesNoField2": true,
    "YesNoField3": true,
    "DateField1": "2025-10-25",
    "DateField2": "2025-10-25",
    "DateField3": "2025-10-25",
    "AccountingAgreement": true,
    "HasSpecialCountryTaxActivity": true,
    "Modified": "2025-10-25",
    "Created": "2025-10-25",
    "BusinessRegistrationNumber": "sample string 33",
    "RMCDApprovalNumber": "sample string 34",
    "TaxStatusVerified": "2025-10-25",
    "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": "2025-10-25",
      "Modified": "2025-10-25",
      "TaxTypeDefaultUID": "52151fd4-083a-400a-81f8-bd28ca83614b",
      "CompanyId": 9
    },
    "DueDateMethodId": 1,
    "DueDateMethodValue": 1,
    "SubjectToDRCVat": true,
    "ID": 38
  },
  "AccountName": "sample string 14",
  "AnalysisCategoryId1": 1,
  "AnalysisCategoryId2": 1,
  "AnalysisCategoryId3": 1,
  "Account": {
    "Name": "sample string 2",
    "Category": {
      "Comment": "sample string 1",
      "Order": 6,
      "Description": "sample string 7",
      "ID": 8,
      "Modified": "2025-10-25",
      "Created": "2025-10-25"
    },
    "Active": true,
    "Balance": 4.0,
    "Description": "sample string 5",
    "ReportingGroupId": 1,
    "UnallocatedAccount": true,
    "IsTaxLocked": true,
    "Modified": "2025-10-25",
    "Created": "2025-10-25",
    "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": "2025-10-25",
      "Modified": "2025-10-25",
      "TaxTypeDefaultUID": "52151fd4-083a-400a-81f8-bd28ca83614b",
      "CompanyId": 9
    },
    "ID": 11
  },
  "Locked": true,
  "TaxPeriodId": 1,
  "TotalOutstanding": 1.0,
  "Inclusive": true,
  "Supplier_CurrencyId": 1,
  "Supplier_ExchangeRate": 1.0,
  "Link_CurrencyId": 1,
  "Link_ExchangeRate": 1.0
}