POST CustomerWriteOff/Save?useSystemDocumentNumber={useSystemDocumentNumber}

Saves the specified Customer Write Off.

Request Information

URI Parameters

NameTypeAdditional informationDescription
useSystemDocumentNumber bool

Default value is True

Use system Document Number or Document Number provided.

Body Parameters

The Customer Write Off.

Customer Write Off
NameTypeAdditional informationDescription
ID integer

None.

CustomerId integer

None.

Date date

None.

DocumentNumber string

String length: inclusive between 0 and 100

Reference string

String length: inclusive between 0 and 100

Description string

String length: inclusive between 0 and 100

Comments string

String length: inclusive between 0 and 8000

Total decimal

None.

TotalUnallocated decimal

None.

Reconciled bool

None.

Customer Customer

None.

Locked bool

Read Only / System Generated

TaxPeriodId nullable integer

Read Only / System Generated

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "CustomerId": 2,
  "Date": "2021-10-16",
  "DocumentNumber": "sample string 4",
  "Reference": "sample string 5",
  "Description": "sample string 6",
  "Comments": "sample string 7",
  "Total": 8.0,
  "TotalUnallocated": 9.0,
  "Reconciled": true,
  "Customer": {
    "Name": "sample string 1",
    "Category": {
      "Description": "sample string 1",
      "ID": 2,
      "Modified": "2021-10-16",
      "Created": "2021-10-16"
    },
    "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-16",
      "Modified": "2021-10-16"
    },
    "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": "4ad5053f-2c5f-4753-b061-ba2f325822ee",
    "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-16",
    "DateField2": "2021-10-16",
    "DateField3": "2021-10-16",
    "DefaultPriceListId": 1,
    "DefaultPriceList": {
      "ID": 1,
      "Description": "sample string 2",
      "IsDefault": true
    },
    "DefaultPriceListName": "sample string 2",
    "AcceptsElectronicInvoices": true,
    "Modified": "2021-10-16",
    "Created": "2021-10-16",
    "BusinessRegistrationNumber": "sample string 34",
    "TaxStatusVerified": "2021-10-16",
    "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-16",
      "Modified": "2021-10-16",
      "TaxTypeDefaultUID": "0dc7e226-b730-4639-9cc8-81be21b5fe2c",
      "CompanyId": 9
    },
    "DueDateMethodId": 1,
    "DueDateMethodValue": 1,
    "CityId": 1,
    "HasSpecialCountryTax": true,
    "AccountingAgreement": true,
    "HasSpecialCountryTaxActivity": true,
    "OutstandingInvoices": true,
    "OverdueInvoices": true,
    "OnHold": true,
    "ExcludeFromDebtorsManager": true,
    "ID": 39
  },
  "Locked": true,
  "TaxPeriodId": 1
}

Response Information

Resource Description

Customer Write Off
NameTypeAdditional informationDescription
ID integer

None.

CustomerId integer

None.

Date date

None.

DocumentNumber string

String length: inclusive between 0 and 100

Reference string

String length: inclusive between 0 and 100

Description string

String length: inclusive between 0 and 100

Comments string

String length: inclusive between 0 and 8000

Total decimal

None.

TotalUnallocated decimal

None.

Reconciled bool

None.

Customer Customer

None.

Locked bool

Read Only / System Generated

TaxPeriodId nullable integer

Read Only / System Generated

Response Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "CustomerId": 2,
  "Date": "2021-10-16",
  "DocumentNumber": "sample string 4",
  "Reference": "sample string 5",
  "Description": "sample string 6",
  "Comments": "sample string 7",
  "Total": 8.0,
  "TotalUnallocated": 9.0,
  "Reconciled": true,
  "Customer": {
    "Name": "sample string 1",
    "Category": {
      "Description": "sample string 1",
      "ID": 2,
      "Modified": "2021-10-16",
      "Created": "2021-10-16"
    },
    "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-16",
      "Modified": "2021-10-16"
    },
    "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": "34463d32-25c5-4a89-8d28-a5aac6467ac1",
    "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-16",
    "DateField2": "2021-10-16",
    "DateField3": "2021-10-16",
    "DefaultPriceListId": 1,
    "DefaultPriceList": {
      "ID": 1,
      "Description": "sample string 2",
      "IsDefault": true
    },
    "DefaultPriceListName": "sample string 2",
    "AcceptsElectronicInvoices": true,
    "Modified": "2021-10-16",
    "Created": "2021-10-16",
    "BusinessRegistrationNumber": "sample string 34",
    "TaxStatusVerified": "2021-10-16",
    "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-16",
      "Modified": "2021-10-16",
      "TaxTypeDefaultUID": "8bd18f15-5e53-4054-bba5-e4101a6ff4dd",
      "CompanyId": 9
    },
    "DueDateMethodId": 1,
    "DueDateMethodValue": 1,
    "CityId": 1,
    "HasSpecialCountryTax": true,
    "AccountingAgreement": true,
    "HasSpecialCountryTaxActivity": true,
    "OutstandingInvoices": true,
    "OverdueInvoices": true,
    "OnHold": true,
    "ExcludeFromDebtorsManager": true,
    "ID": 39
  },
  "Locked": true,
  "TaxPeriodId": 1
}