Relative request path: | api/orgs/{organisationId}/customers/code({code}) |
Property | Description |
---|---|
organisationId | organisation id |
code | customer code |
Request parameters:
Request parameters:
Request parameters:
Property | Description |
---|---|
CustomerId | Customer id. Mandatory. |
Code | Customer code, unique within organisation. Optional. Max length: 10. |
Name | Customer name. Optional. Max length: 250. |
Address | Customer address. Optional. Max length: 250. |
PostalCode | Customer postal code. Optional. Max length: 30. |
City | Customer city. Optional. Max length: 250. |
Country | class Country. Customer country. Mandatory. |
CountryName | Country name. Optional. Max length: 250. |
TaxNumber | Customer tax number. Optional. Max length: 30. |
RegistrationNumber | Customer registration number. Optional. Max length: 30. |
VATIdentificationNumber | Customer VAT Identification Number. Optional. Max length: 30. |
SubjectToVAT | Possible values: (D, M, N). Customer VAT settings. For EU customers:
|
ConsiderCountryForBookkeeping | Possible values: (D, N). Take customers country into account for bookkeeping (Foreign endusers only).
Usage:
|
Currency | class Currency. Default currency. Optional. |
ExpirationDays | Invoice expiration days. Mandatory. |
RebatePercent | Rebate (%) Mandatory. |
WebSiteURL | Web site. Optional. Max length: 100. |
EInvoiceIssuing | Possible values: (SeNePripravlja, RocniIzvoz, Ponudnik, EPosta). e-Invoices issuing type:
|
InternalCustomerNumber | Internal reference for e-invoices. Optional. Max length: 30. |
GLN | GLN Optional. Max length: 30. |
BudgetUserNumber | Optional. |
Usage | Possible values: (D, N). Usage:
|
RecordDtModified | Optional. |
RowVersion | Row version is used for concurrency check. |
This method returns result of type 'SAOP.API.Models.Customer.Customer'.
/// Customer details.
public class Customer
{
// Customer id.
// Mandatory field. Ignored on create request.
public long CustomerId { get; set; }
// Customer code, unique within organisation.
// Max length: 10
public string Code { get; set; }
// Customer name.
// Max length: 250
public string Name { get; set; }
// Customer address.
// Max length: 250
public string Address { get; set; }
// Customer postal code.
// Max length: 30
public string PostalCode { get; set; }
// Customer city.
// Max length: 250
public string City { get; set; }
// Customer country.
public mMApiFkField Country { get; set; }
// Country name.
// Max length: 250
public string CountryName { get; set; }
// Customer tax number.
// Max length: 30
public string TaxNumber { get; set; }
// Customer registration number.
// Max length: 30
public string RegistrationNumber { get; set; }
// Customer VAT Identification Number.
// Max length: 30
public string VATIdentificationNumber { get; set; }
// Customer VAT settings.<br/>
// For EU customers:
// <ul>
//     <li>D - Legal person or a person with business who is subject to VAT,</li>
//     <li>M - Legal person or a person with business who is NOT subject to VAT,</li>
//     <li>N – Enduser.</li>
// </ul>
// For customers outside EU:
// <ul>
//     <li>D - Legal person (VAT on the issued invoice is not to be accounted for),</li>
//     <li>N – Enduser.</li>
// </ul>
// Mandatory field. Max length: 1
public string SubjectToVAT { get; set; }
// Take customers country into account for bookkeeping (Foreign endusers only).
// Usage:
// <ul>
//     <li>D - Yes,</li>
//     <li>N - No.</li>
// </ul>
// Max length: 1
public string ConsiderCountryForBookkeeping { get; set; }
// Default currency.
public mMApiFkField Currency { get; set; }
// Invoice expiration days.
// Mandatory field.
public int ExpirationDays { get; set; }
// Rebate (%)
// Mandatory field.
public Decimal RebatePercent { get; set; }
// Web site.
// Max length: 100
public string WebSiteURL { get; set; }
// e-Invoices issuing type:
// <ul>
//     <li>SeNePripravlja  - None(won't be prepared)</li>
//     <li>RocniIzvoz  - Import to bank</li>
//     <li>Ponudnik  -Import to ZZInet</li>
//     <li>EPosta  - Send by email</li>
// <ul>
// Mandatory field. Max length: 1
public string EInvoiceIssuing { get; set; }
// Internal reference for e-invoices.
// Max length: 30
public string InternalCustomerNumber { get; set; }
// GLN
// Max length: 30
public long? GLN { get; set; }
public string BudgetUserNumber { get; set; }
// Usage:
// <ul>
//     <li>D - Yes,</li>
//     <li>N - No.</li>
// </ul>
// Mandatory field. Max length: 1
public string Usage { get; set; }
public DateTime RecordDtModified { get; set; }
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public string RowVersion { get; set; }
}
/// Link with id, name and url to related data.
public class mMApiFkField
{
// Record id.
public long? ID { get; set; }
// Record name.
public string Name { get; private set; }
// Url to full record details.
public string ResourceUrl { get; private set; }
}
This method returns result of type 'SAOP.API.Models.Customer.Customer'.
/// Customer details.
class Customer
{
// Customer id.
// Mandatory field. Ignored on create request.
public $CustomerId;
// Customer code, unique within organisation.
// Max length: 10
public $Code;
// Customer name.
// Max length: 250
public $Name;
// Customer address.
// Max length: 250
public $Address;
// Customer postal code.
// Max length: 30
public $PostalCode;
// Customer city.
// Max length: 250
public $City;
// Customer country.
public $Country;
// Country name.
// Max length: 250
public $CountryName;
// Customer tax number.
// Max length: 30
public $TaxNumber;
// Customer registration number.
// Max length: 30
public $RegistrationNumber;
// Customer VAT Identification Number.
// Max length: 30
public $VATIdentificationNumber;
// Customer VAT settings.<br/>
// For EU customers:
// <ul>
//     <li>D - Legal person or a person with business who is subject to VAT,</li>
//     <li>M - Legal person or a person with business who is NOT subject to VAT,</li>
//     <li>N – Enduser.</li>
// </ul>
// For customers outside EU:
// <ul>
//     <li>D - Legal person (VAT on the issued invoice is not to be accounted for),</li>
//     <li>N – Enduser.</li>
// </ul>
// Mandatory field. Max length: 1
public $SubjectToVAT;
// Take customers country into account for bookkeeping (Foreign endusers only).
// Usage:
// <ul>
//     <li>D - Yes,</li>
//     <li>N - No.</li>
// </ul>
// Max length: 1
public $ConsiderCountryForBookkeeping;
// Default currency.
public $Currency;
// Invoice expiration days.
// Mandatory field.
public $ExpirationDays;
// Rebate (%)
// Mandatory field.
public $RebatePercent;
// Web site.
// Max length: 100
public $WebSiteURL;
// e-Invoices issuing type:
// <ul>
//     <li>SeNePripravlja  - None(won't be prepared)</li>
//     <li>RocniIzvoz  - Import to bank</li>
//     <li>Ponudnik  -Import to ZZInet</li>
//     <li>EPosta  - Send by email</li>
// <ul>
// Mandatory field. Max length: 1
public $EInvoiceIssuing;
// Internal reference for e-invoices.
// Max length: 30
public $InternalCustomerNumber;
// GLN
// Max length: 30
public $GLN;
public $BudgetUserNumber;
// Usage:
// <ul>
//     <li>D - Yes,</li>
//     <li>N - No.</li>
// </ul>
// Mandatory field. Max length: 1
public $Usage;
public $RecordDtModified;
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public $RowVersion;
}
/// Link with id, name and url to related data.
class mMApiFkField
{
// Record id.
public $ID;
// Record name.
public $Name;
// Url to full record details.
public $ResourceUrl;
}
This method returns result of type 'SAOP.API.Models.Customer.Customer'.
/// Customer details.
public class Customer
{
// Customer id.
// Mandatory field. Ignored on create request.
public Long CustomerId;
// Customer code, unique within organisation.
// Max length: 10
public String Code;
// Customer name.
// Max length: 250
public String Name;
// Customer address.
// Max length: 250
public String Address;
// Customer postal code.
// Max length: 30
public String PostalCode;
// Customer city.
// Max length: 250
public String City;
// Customer country.
public mMApiFkField Country;
// Country name.
// Max length: 250
public String CountryName;
// Customer tax number.
// Max length: 30
public String TaxNumber;
// Customer registration number.
// Max length: 30
public String RegistrationNumber;
// Customer VAT Identification Number.
// Max length: 30
public String VATIdentificationNumber;
// Customer VAT settings.<br/>
// For EU customers:
// <ul>
//     <li>D - Legal person or a person with business who is subject to VAT,</li>
//     <li>M - Legal person or a person with business who is NOT subject to VAT,</li>
//     <li>N – Enduser.</li>
// </ul>
// For customers outside EU:
// <ul>
//     <li>D - Legal person (VAT on the issued invoice is not to be accounted for),</li>
//     <li>N – Enduser.</li>
// </ul>
// Mandatory field. Max length: 1
public String SubjectToVAT;
// Take customers country into account for bookkeeping (Foreign endusers only).
// Usage:
// <ul>
//     <li>D - Yes,</li>
//     <li>N - No.</li>
// </ul>
// Max length: 1
public String ConsiderCountryForBookkeeping;
// Default currency.
public mMApiFkField Currency;
// Invoice expiration days.
// Mandatory field.
public Integer ExpirationDays;
// Rebate (%)
// Mandatory field.
public Double RebatePercent;
// Web site.
// Max length: 100
public String WebSiteURL;
// e-Invoices issuing type:
// <ul>
//     <li>SeNePripravlja  - None(won't be prepared)</li>
//     <li>RocniIzvoz  - Import to bank</li>
//     <li>Ponudnik  -Import to ZZInet</li>
//     <li>EPosta  - Send by email</li>
// <ul>
// Mandatory field. Max length: 1
public String EInvoiceIssuing;
// Internal reference for e-invoices.
// Max length: 30
public String InternalCustomerNumber;
// GLN
// Max length: 30
public Long GLN;
public String BudgetUserNumber;
// Usage:
// <ul>
//     <li>D - Yes,</li>
//     <li>N - No.</li>
// </ul>
// Mandatory field. Max length: 1
public String Usage;
public Date RecordDtModified;
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public String RowVersion;
}
/// Link with id, name and url to related data.
public class mMApiFkField
{
// Record id.
public Long ID;
// Record name.
public String Name;
// Url to full record details.
public String ResourceUrl;
}