POST Customer/Save

Saves the specified Customer.

Request Information

URI Parameters

None.

Body Parameters

The Customer.

Customer
NameTypeAdditional informationDescription
ID integer

None.

Name string

Required

String length: inclusive between 0 and 100

Category Customer Category

None.

SalesRepresentativeId nullable integer

None.

SalesRepresentative Sales Representative

None.

TaxReference string

String length: inclusive between 0 and 30

ContactName string

String length: inclusive between 0 and 100

Telephone string

String length: inclusive between 0 and 30

Fax string

String length: inclusive between 0 and 30

Mobile string

String length: inclusive between 0 and 30

Email string

None.

WebAddress string

String length: inclusive between 0 and 100

Active bool

None.

IsObfuscated bool

None.

Balance decimal

Read Only / System Generated

CreditLimit decimal

None.

CommunicationMethod nullable integer

None.

Gets or sets the communication method. Optional. None = 0, Print = 1, Email = 2, Print and Email = 3

PostalAddress01 string

String length: inclusive between 0 and 100

PostalAddress02 string

String length: inclusive between 0 and 100

PostalAddress03 string

String length: inclusive between 0 and 100

PostalAddress04 string

String length: inclusive between 0 and 100

PostalAddress05 string

String length: inclusive between 0 and 100

DeliveryAddress01 string

String length: inclusive between 0 and 100

DeliveryAddress02 string

String length: inclusive between 0 and 100

DeliveryAddress03 string

String length: inclusive between 0 and 100

DeliveryAddress04 string

String length: inclusive between 0 and 100

DeliveryAddress05 string

String length: inclusive between 0 and 100

AutoAllocateToOldestInvoice nullable bool

None.

EnableCustomerZone bool

None.

CustomerZoneGuid globally unique identifier

Read Only / System Generated

CashSale nullable bool

None.

TextField1 string

String length: inclusive between 0 and 100

TextField2 string

String length: inclusive between 0 and 100

TextField3 string

String length: inclusive between 0 and 100

NumericField1 nullable decimal

None.

NumericField2 nullable decimal

None.

NumericField3 nullable decimal

None.

YesNoField1 bool

None.

YesNoField2 bool

None.

YesNoField3 bool

None.

DateField1 nullable date

None.

DateField2 nullable date

None.

DateField3 nullable date

None.

DefaultPriceListId nullable integer

None.

DefaultPriceList Additional Price List

None.

DefaultPriceListName string

None.

AcceptsElectronicInvoices bool

None.

Modified nullable date

Read Only / System Generated

Created date

Read Only / System Generated

BusinessRegistrationNumber string

None.

TaxStatusVerified nullable date

None.

CurrencyId nullable integer

None.

CurrencySymbol string

None.

HasActivity bool

Read Only / System Generated

DefaultDiscountPercentage nullable decimal

None.

DefaultTaxTypeId nullable integer

None.

DefaultTaxType Tax Type

None.

DueDateMethodId nullable integer

None.

Specifies which method should be used to determine the invoice due date. Days from date of Invoice = 0, Day of the current Month = 1, Day of the following Month = 2, End of the current Month = 3, Days from the end of the Invoice Month = 4

DueDateMethodValue nullable integer

None.

CityId nullable integer

None.

HasSpecialCountryTax bool

None.

AccountingAgreement nullable bool

None.

HasSpecialCountryTaxActivity bool

Read Only / System Generated

OutstandingInvoices nullable bool

None.

OverdueInvoices nullable bool

None.

OnHold nullable bool

None.

ExcludeFromDebtorsManager nullable bool

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Category": {
    "Description": "sample string 1",
    "ID": 2,
    "Modified": "2021-10-24",
    "Created": "2021-10-24"
  },
  "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-24",
    "Modified": "2021-10-24"
  },
  "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": "0b6ad637-f58b-4ce3-8279-4be164ed192d",
  "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-24",
  "DateField2": "2021-10-24",
  "DateField3": "2021-10-24",
  "DefaultPriceListId": 1,
  "DefaultPriceList": {
    "ID": 1,
    "Description": "sample string 2",
    "IsDefault": true
  },
  "DefaultPriceListName": "sample string 2",
  "AcceptsElectronicInvoices": true,
  "Modified": "2021-10-24",
  "Created": "2021-10-24",
  "BusinessRegistrationNumber": "sample string 34",
  "TaxStatusVerified": "2021-10-24",
  "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-24",
    "Modified": "2021-10-24",
    "TaxTypeDefaultUID": "ca9abf39-dbe6-4ffb-b0d5-e93cf1372297",
    "CompanyId": 9
  },
  "DueDateMethodId": 1,
  "DueDateMethodValue": 1,
  "CityId": 1,
  "HasSpecialCountryTax": true,
  "AccountingAgreement": true,
  "HasSpecialCountryTaxActivity": true,
  "OutstandingInvoices": true,
  "OverdueInvoices": true,
  "OnHold": true,
  "ExcludeFromDebtorsManager": true,
  "ID": 39
}

Response Information

Resource Description

Customer
NameTypeAdditional informationDescription
ID integer

None.

Name string

Required

String length: inclusive between 0 and 100

Category Customer Category

None.

SalesRepresentativeId nullable integer

None.

SalesRepresentative Sales Representative

None.

TaxReference string

String length: inclusive between 0 and 30

ContactName string

String length: inclusive between 0 and 100

Telephone string

String length: inclusive between 0 and 30

Fax string

String length: inclusive between 0 and 30

Mobile string

String length: inclusive between 0 and 30

Email string

None.

WebAddress string

String length: inclusive between 0 and 100

Active bool

None.

IsObfuscated bool

None.

Balance decimal

Read Only / System Generated

CreditLimit decimal

None.

CommunicationMethod nullable integer

None.

Gets or sets the communication method. Optional. None = 0, Print = 1, Email = 2, Print and Email = 3

PostalAddress01 string

String length: inclusive between 0 and 100

PostalAddress02 string

String length: inclusive between 0 and 100

PostalAddress03 string

String length: inclusive between 0 and 100

PostalAddress04 string

String length: inclusive between 0 and 100

PostalAddress05 string

String length: inclusive between 0 and 100

DeliveryAddress01 string

String length: inclusive between 0 and 100

DeliveryAddress02 string

String length: inclusive between 0 and 100

DeliveryAddress03 string

String length: inclusive between 0 and 100

DeliveryAddress04 string

String length: inclusive between 0 and 100

DeliveryAddress05 string

String length: inclusive between 0 and 100

AutoAllocateToOldestInvoice nullable bool

None.

EnableCustomerZone bool

None.

CustomerZoneGuid globally unique identifier

Read Only / System Generated

CashSale nullable bool

None.

TextField1 string

String length: inclusive between 0 and 100

TextField2 string

String length: inclusive between 0 and 100

TextField3 string

String length: inclusive between 0 and 100

NumericField1 nullable decimal

None.

NumericField2 nullable decimal

None.

NumericField3 nullable decimal

None.

YesNoField1 bool

None.

YesNoField2 bool

None.

YesNoField3 bool

None.

DateField1 nullable date

None.

DateField2 nullable date

None.

DateField3 nullable date

None.

DefaultPriceListId nullable integer

None.

DefaultPriceList Additional Price List

None.

DefaultPriceListName string

None.

AcceptsElectronicInvoices bool

None.

Modified nullable date

Read Only / System Generated

Created date

Read Only / System Generated

BusinessRegistrationNumber string

None.

TaxStatusVerified nullable date

None.

CurrencyId nullable integer

None.

CurrencySymbol string

None.

HasActivity bool

Read Only / System Generated

DefaultDiscountPercentage nullable decimal

None.

DefaultTaxTypeId nullable integer

None.

DefaultTaxType Tax Type

None.

DueDateMethodId nullable integer

None.

Specifies which method should be used to determine the invoice due date. Days from date of Invoice = 0, Day of the current Month = 1, Day of the following Month = 2, End of the current Month = 3, Days from the end of the Invoice Month = 4

DueDateMethodValue nullable integer

None.

CityId nullable integer

None.

HasSpecialCountryTax bool

None.

AccountingAgreement nullable bool

None.

HasSpecialCountryTaxActivity bool

Read Only / System Generated

OutstandingInvoices nullable bool

None.

OverdueInvoices nullable bool

None.

OnHold nullable bool

None.

ExcludeFromDebtorsManager nullable bool

None.

Response Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Category": {
    "Description": "sample string 1",
    "ID": 2,
    "Modified": "2021-10-24",
    "Created": "2021-10-24"
  },
  "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-24",
    "Modified": "2021-10-24"
  },
  "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": "06f06df1-0228-4b0b-85d3-6559e96565cd",
  "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-24",
  "DateField2": "2021-10-24",
  "DateField3": "2021-10-24",
  "DefaultPriceListId": 1,
  "DefaultPriceList": {
    "ID": 1,
    "Description": "sample string 2",
    "IsDefault": true
  },
  "DefaultPriceListName": "sample string 2",
  "AcceptsElectronicInvoices": true,
  "Modified": "2021-10-24",
  "Created": "2021-10-24",
  "BusinessRegistrationNumber": "sample string 34",
  "TaxStatusVerified": "2021-10-24",
  "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-24",
    "Modified": "2021-10-24",
    "TaxTypeDefaultUID": "4d3e1936-7556-44a3-bb7e-ff466260d17d",
    "CompanyId": 9
  },
  "DueDateMethodId": 1,
  "DueDateMethodValue": 1,
  "CityId": 1,
  "HasSpecialCountryTax": true,
  "AccountingAgreement": true,
  "HasSpecialCountryTaxActivity": true,
  "OutstandingInvoices": true,
  "OverdueInvoices": true,
  "OnHold": true,
  "ExcludeFromDebtorsManager": true,
  "ID": 39
}