GET https://api.gizbarit.biz/api/Clients/ByVatNumber?vatNumber={vatNumber}
Get client by VAT number.
Search by whole value, not by partial substring matching
Parameters:
vatNumber (String)
Returns:
ClientViewModel
ClientViewModel or 404
Model:
Property
Type
Description
VatNumber
String
Required property for both create and edit document case
Email
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 https://api.gizbarit.biz/api/Clients?name={name}
Get clients by name. Substring search
Parameters:
name (String)
name of client or empty
Returns:
ClientViewModel[]
IEnumerable of ClientViewModel or 404
Model:
Property
Type
Description
VatNumber
String
Required property for both create and edit document case
Email
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
PUT https://api.gizbarit.biz/api/Clients
Update client fields by Id number: Name, VatNumber, City, Address, AdditionEmails, AdditionPhones
Parameters:
item (ClientViewModel)
item type of ClientViewModel
Model:
Property
Type
Description
VatNumber
String
Required property for both create and edit document case
Email
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
Returns:
ClientViewModel
item type of ClientViewModel
Model:
Property
Type
Description
VatNumber
String
Required property for both create and edit document case
Email
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
POST https://api.gizbarit.biz/api/Clients
Create Client item
Parameters:
itemClientViewModel (ClientViewModel)
ClientViewMode item model
Model:
Property
Type
Description
VatNumber
String
Required property for both create and edit document case
Email
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
Returns:
ClientViewModel
Return created client item in case of success.
Model:
Property
Type
Description
VatNumber
String
Required property for both create and edit document case
Email
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 https://api.gizbarit.biz/api/Clients/{id}
delete client item
Parameters:
id (Int32)
Client item id
Returns:
Void
Return 200 or 404 status
InvoiceReceipt endpoints
POST https://api.gizbarit.biz/api/InvoiceReceipts/CreateAndSendToClient
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.
Parameters:
dto (InvoiceReceiptRequestDto)
Tax invoice - receipt response data
Model:
Property
Type
Description
Subject
String
Document description / subject.
IsExport
Boolean
Set to true for foreign trade (export) documents.
Currency
String
Document currency. Required when IsExport is true, otherwise nullable.
TaxPercentage
Nullable<Decimal>
Tax (VAT) percentage applied to the document. Nullable when IsExport is false.
POST https://api.gizbarit.biz/api/InvoiceReceipts/CreateAndSendToClientWithoutGettingAllocationNumber
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.
Parameters:
dto (InvoiceReceiptRequestDto)
Tax invoice - receipt response data
Model:
Property
Type
Description
Subject
String
Document description / subject.
IsExport
Boolean
Set to true for foreign trade (export) documents.
Currency
String
Document currency. Required when IsExport is true, otherwise nullable.
TaxPercentage
Nullable<Decimal>
Tax (VAT) percentage applied to the document. Nullable when IsExport is false.
GET https://api.gizbarit.biz/api/InvoiceReceipts?searchString={searchString}&limit={limit}
Get Invoice receipts by searchString. Ordered by Date descending.
Search searchString match in document description, document number, client name, catalog item name
Parameters:
searchString (String)
Match given string with a document Description, Number, Client name, Items name
limit (Nullable`1)
Maximum number of documents to result