Public API Documentation

Currency endpoints


GET https://api-qa.gizbarit.biz/api/Currencies

Get list of supported currencies

Parameters:

No parameters

Returns:

CurrencyViewModel[] Array of CurrencyViewModel

Model:
Property Type Description
Code String
Name String
Symbol String
Country String

Clients endpoints


GET https://api-qa.gizbarit.biz/api/Clients/ByVatNumber?vatNumber={vatNumber}

Get client by VAT number. Search by whole value, not by partial substring matching

Parameters:
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-qa.gizbarit.biz/api/Clients?name={name}

Get clients by name. Substring search

Parameters:
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-qa.gizbarit.biz/api/Clients

Update client fields by Id number: Name, VatNumber, City, Address, AdditionEmails, AdditionPhones

Parameters:
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-qa.gizbarit.biz/api/Clients

Create Client item

Parameters:
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-qa.gizbarit.biz/api/Clients/{id}

delete client item

Parameters:
Returns:

Void Return 200 or 404 status

InvoiceReceipt endpoints


POST https://api-qa.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:
Returns:

InvoiceReceiptResponseDto

Model:
Property Type Description
Id Guid
Number Int64
Subject String
IsExport Boolean
Currency String
TaxPercentage Decimal
Client ClientDto
Property Type Description
Name String
VatNumber String
Email String
Phone String
CatalogItems CatalogItemDto[]
Property Type Description
Name String
Price Decimal
Quantity Decimal
Payments PaymentDto[]
Property Type Description
PaymentType PaymentTypeEnum

Enum values: BankTransfer (2 - Bank transfer), CreditCard (4 - Payment by credit card), PayPalOrCrypto (8 - Bit, PayPal, PayBox, cryptocurrency)

Sum Decimal
DateOperation DateTime
DateCreated DateTime

POST https://api-qa.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:
Returns:

InvoiceReceiptResponseDto

Model:
Property Type Description
Id Guid
Number Int64
Subject String
IsExport Boolean
Currency String
TaxPercentage Decimal
Client ClientDto
Property Type Description
Name String
VatNumber String
Email String
Phone String
CatalogItems CatalogItemDto[]
Property Type Description
Name String
Price Decimal
Quantity Decimal
Payments PaymentDto[]
Property Type Description
PaymentType PaymentTypeEnum

Enum values: BankTransfer (2 - Bank transfer), CreditCard (4 - Payment by credit card), PayPalOrCrypto (8 - Bit, PayPal, PayBox, cryptocurrency)

Sum Decimal
DateOperation DateTime
DateCreated DateTime

GET https://api-qa.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:
Returns:

InvoiceReceiptResponseDto[]

Model:
Property Type Description
Id Guid
Number Int64
Subject String
IsExport Boolean
Currency String
TaxPercentage Decimal
Client ClientDto
Property Type Description
Name String
VatNumber String
Email String
Phone String
CatalogItems CatalogItemDto[]
Property Type Description
Name String
Price Decimal
Quantity Decimal
Payments PaymentDto[]
Property Type Description
PaymentType PaymentTypeEnum

Enum values: BankTransfer (2 - Bank transfer), CreditCard (4 - Payment by credit card), PayPalOrCrypto (8 - Bit, PayPal, PayBox, cryptocurrency)

Sum Decimal
DateOperation DateTime
DateCreated DateTime