POST CustomerWriteOff/Save?useSystemDocumentNumber={useSystemDocumentNumber}
Saves the specified Customer Write Off.
Request Information
URI Parameters
Name | Type | Additional information | Description |
---|---|---|---|
useSystemDocumentNumber | bool |
Default value is True |
Use system Document Number or Document Number provided. |
Body Parameters
The Customer Write Off.
Customer Write OffName | Type | Additional information | Description |
---|---|---|---|
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": "2024-03-29", "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": "2024-03-29", "Created": "2024-03-29" }, "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": "2024-03-29", "Modified": "2024-03-29" }, "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": "a0e113a7-cc6b-455e-9408-311fc4e0c26b", "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": "2024-03-29", "DateField2": "2024-03-29", "DateField3": "2024-03-29", "DefaultPriceListId": 1, "DefaultPriceList": { "ID": 1, "Description": "sample string 2", "IsDefault": true }, "DefaultPriceListName": "sample string 2", "AcceptsElectronicInvoices": true, "Modified": "2024-03-29", "Created": "2024-03-29", "BusinessRegistrationNumber": "sample string 34", "TaxStatusVerified": "2024-03-29", "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": "2024-03-29", "Modified": "2024-03-29", "TaxTypeDefaultUID": "5b115409-4b18-4f1d-8e37-4dd869b1769d", "CompanyId": 9 }, "DueDateMethodId": 1, "DueDateMethodValue": 1, "CityId": 1, "AccountingAgreement": true, "HasSpecialCountryTaxActivity": true, "OutstandingInvoices": true, "OverdueInvoices": true, "OnHold": true, "ExcludeFromDebtorsManager": true, "SubjectToDRCVat": true, "ID": 40 }, "Locked": true, "TaxPeriodId": 1 }
Response Information
Resource Description
Customer Write OffName | Type | Additional information | Description |
---|---|---|---|
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": "2024-03-29", "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": "2024-03-29", "Created": "2024-03-29" }, "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": "2024-03-29", "Modified": "2024-03-29" }, "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": "f0b0aec6-b50e-47f6-98ea-7d714d332955", "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": "2024-03-29", "DateField2": "2024-03-29", "DateField3": "2024-03-29", "DefaultPriceListId": 1, "DefaultPriceList": { "ID": 1, "Description": "sample string 2", "IsDefault": true }, "DefaultPriceListName": "sample string 2", "AcceptsElectronicInvoices": true, "Modified": "2024-03-29", "Created": "2024-03-29", "BusinessRegistrationNumber": "sample string 34", "TaxStatusVerified": "2024-03-29", "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": "2024-03-29", "Modified": "2024-03-29", "TaxTypeDefaultUID": "2e7d1d5e-2490-400c-b0e7-db89769e3c7d", "CompanyId": 9 }, "DueDateMethodId": 1, "DueDateMethodValue": 1, "CityId": 1, "AccountingAgreement": true, "HasSpecialCountryTaxActivity": true, "OutstandingInvoices": true, "OverdueInvoices": true, "OnHold": true, "ExcludeFromDebtorsManager": true, "SubjectToDRCVat": true, "ID": 40 }, "Locked": true, "TaxPeriodId": 1 }