Get list of supported currencies
No parameters
CurrencyViewModel[] Array of CurrencyViewModel
| Property | Type | Description |
|---|---|---|
| Code | String | |
| Name | String | |
| Symbol | String | |
| Country | String |
Get client by VAT number. Search by whole value, not by partial substring matching
ClientViewModel ClientViewModel or 404
| Property | Type | Description |
|---|---|---|
| VatNumber | String | Required property for both create and edit document case |
| String | Required on creation | |
| Phone | String | |
| City | String | |
| Address | String | |
| AdditionEmails | ICollection<String> | Set emty array if no addition emails |
| AdditionPhones | ICollection<String> | Set emty array if no addition phones |
| Id | Int32 | |
| Name | String | Required property for both create and edit document case |
Get clients by name. Substring search
ClientViewModel[] IEnumerable of ClientViewModel or 404
| Property | Type | Description |
|---|---|---|
| VatNumber | String | Required property for both create and edit document case |
| String | Required on creation | |
| Phone | String | |
| City | String | |
| Address | String | |
| AdditionEmails | ICollection<String> | Set emty array if no addition emails |
| AdditionPhones | ICollection<String> | Set emty array if no addition phones |
| Id | Int32 | |
| Name | String | Required property for both create and edit document case |
Update client fields by Id number: Name, VatNumber, City, Address, AdditionEmails, AdditionPhones
ClientViewModel item type of ClientViewModel
| Property | Type | Description |
|---|---|---|
| VatNumber | String | Required property for both create and edit document case |
| String | Required on creation | |
| Phone | String | |
| City | String | |
| Address | String | |
| AdditionEmails | ICollection<String> | Set emty array if no addition emails |
| AdditionPhones | ICollection<String> | Set emty array if no addition phones |
| Id | Int32 | |
| Name | String | Required property for both create and edit document case |
Create Client item
ClientViewModel Return created client item in case of success.
| Property | Type | Description |
|---|---|---|
| VatNumber | String | Required property for both create and edit document case |
| String | Required on creation | |
| Phone | String | |
| City | String | |
| Address | String | |
| AdditionEmails | ICollection<String> | Set emty array if no addition emails |
| AdditionPhones | ICollection<String> | Set emty array if no addition phones |
| Id | Int32 | |
| Name | String | Required property for both create and edit document case |
delete client item
Void Return 200 or 404 status
Creates Tax invoice - receipt and sends it to the client. Returns 422 response code if Client VAT number is invalid and can't be used to get allocation number from Israel Tax Authority.In this case, please send request to next endpoint insted, to skip sending document to Israel Tax Authority: api/InvoiceReceipts/CreateAndSendToClientWithoutGettingAllocationNumber.CatalogItems: Price includes VAT.Client: when creating a document, specify only the vatNumber for existing Client. For new client you have to spacify also Email and Name properties.
InvoiceReceiptResponseDto
| Property | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Id | Guid | ||||||||||||||||
| Number | Int64 | ||||||||||||||||
| Subject | String | ||||||||||||||||
| IsExport | Boolean | ||||||||||||||||
| Currency | String | ||||||||||||||||
| TaxPercentage | Decimal | ||||||||||||||||
| Client | ClientDto | ||||||||||||||||
|
|||||||||||||||||
| CatalogItems | CatalogItemDto[] | ||||||||||||||||
|
|||||||||||||||||
| Payments | PaymentDto[] | ||||||||||||||||
|
|||||||||||||||||
| DateCreated | DateTime | ||||||||||||||||
Creates Tax invoice - receipt and sends it to the client without getting allocation number from Israel Tax Authority. CatalogItems: Price includes VAT. Client: when creating a document, specify only the vatNumber for existing Client. For new client you have to spacify also Email and Name properties.
InvoiceReceiptResponseDto
| Property | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Id | Guid | ||||||||||||||||
| Number | Int64 | ||||||||||||||||
| Subject | String | ||||||||||||||||
| IsExport | Boolean | ||||||||||||||||
| Currency | String | ||||||||||||||||
| TaxPercentage | Decimal | ||||||||||||||||
| Client | ClientDto | ||||||||||||||||
|
|||||||||||||||||
| CatalogItems | CatalogItemDto[] | ||||||||||||||||
|
|||||||||||||||||
| Payments | PaymentDto[] | ||||||||||||||||
|
|||||||||||||||||
| DateCreated | DateTime | ||||||||||||||||
Get Invoice receipts by searchString. Ordered by Date descending. Search searchString match in document description, document number, client name, catalog item name
InvoiceReceiptResponseDto[]
| Property | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Id | Guid | ||||||||||||||||
| Number | Int64 | ||||||||||||||||
| Subject | String | ||||||||||||||||
| IsExport | Boolean | ||||||||||||||||
| Currency | String | ||||||||||||||||
| TaxPercentage | Decimal | ||||||||||||||||
| Client | ClientDto | ||||||||||||||||
|
|||||||||||||||||
| CatalogItems | CatalogItemDto[] | ||||||||||||||||
|
|||||||||||||||||
| Payments | PaymentDto[] | ||||||||||||||||
|
|||||||||||||||||
| DateCreated | DateTime | ||||||||||||||||