Green Invoice API Reference

April 3, 2026 ยท View on GitHub

Source: Apiary Blueprint | Last updated: 2026-03-11
Production base: https://api.greeninvoice.co.il/api/v1/
Sandbox base: https://sandbox.d.greeninvoice.co.il/api/v1/
Reference data base: https://cache.greeninvoice.co.il/

Endpoints (66 total)

Businesses (10)

MethodPathDescription
GET/businessesList all user businesses
PUT/businessesUpdate business
GET/businesses/meGet current business
GET/businesses/{id}Get business by ID
POST/businesses/fileUpload file (logo, signature, deduction/bookkeeping doc) - base64
DELETE/businesses/fileDelete business file
GET/businesses/numberingGet document numbering
PUT/businesses/numberingSet initial document numbering
GET/businesses/footerGet document footer text
GET/businesses/types?lang=Get business types

Clients (8)

MethodPathDescription
POST/clientsAdd client
GET/clients/{id}Get client
PUT/clients/{id}Update client
DELETE/clients/{id}Delete client (must be inactive)
POST/clients/searchSearch clients
POST/clients/{id}/assocAssociate documents to client
POST/clients/{id}/mergeMerge clients (one must be inactive)
POST/clients/{id}/balanceUpdate client balance

Suppliers (6)

MethodPathDescription
POST/suppliersAdd supplier
GET/suppliers/{id}Get supplier
PUT/suppliers/{id}Update supplier
DELETE/suppliers/{id}Delete supplier
POST/suppliers/searchSearch suppliers
POST/suppliers/{id}/mergeMerge suppliers

Items (5)

MethodPathDescription
POST/itemsAdd item
GET/items/{id}Get item
PUT/items/{id}Update item
DELETE/items/{id}Delete item
POST/items/searchSearch items

Documents (15)

MethodPathDescription
POST/documentsCreate document
POST/documents/previewPreview document (returns base64 PDF)
GET/documents/{id}Get document
POST/documents/searchSearch documents
POST/documents/payments/searchSearch payments in documents
POST/documents/{id}/closeClose document
POST/documents/{id}/openReopen document
GET/documents/{id}/linkedGet linked documents
GET/documents/{id}/download/linksGet download links (he, en, origin)
GET/documents/info?type=Get document info for type
GET/documents/templatesGet document templates
GET/documents/types?lang=Get document types
GET/documents/statuses?lang=Get document statuses
POST/documents/{id}/paymentAdd payment to document
POST/documents/{id}/sendSend document via email

Expenses (13)

MethodPathDescription
POST/expensesAdd expense
GET/expenses/{id}Get expense
PUT/expenses/{id}Update expense (not if reported)
DELETE/expenses/{id}Delete expense
POST/expenses/searchSearch expenses
POST/expenses/{id}/openOpen expense
POST/expenses/{id}/closeClose/report expense
GET/expenses/statusesGet expense statuses
GET/accounting/classifications/mapGet accounting classifications
GET/expenses/fileGet file upload URL (S3 presigned)
POST/expenses/exampleCreate expense draft via file
POST/expenses/exampleUpdate expense file
POST/expenses/drafts/searchSearch expense drafts

Payments (3)

MethodPathDescription
POST/payments/formGet payment form URL
POST/payments/tokens/searchSearch credit card tokens
POST/payments/tokens/{id}/chargeCharge credit card token

Partners (4)

MethodPathDescription
GET/partners/usersGet all connected users
POST/partners/users/connectionRequest user approval
GET/partners/users?email=Get connected user by email
DELETE/partners/users/connection?email=Disconnect partner user

Reference/Tools (4)

MethodBase URLPathDescription
GETcache.greeninvoice.co.il/businesses/v1/occupations?locale=Business categories
GETcache.greeninvoice.co.il/geo-location/v1/countries?locale=Countries
GETcache.greeninvoice.co.il/geo-location/v1/cities?locale=&country=Cities
GETcache.greeninvoice.co.il/currency-exchange/v1/latest?base=Exchange rates

Enum Reference

Document Types

CodeType
10Price Quote
100Order
200Delivery Note
210Return Delivery Note
300Transaction Account
305Tax Invoice
320Tax Invoice + Receipt
330Credit Invoice
400Receipt
405Donation Receipt
500Purchase Order
600Deposit Receipt
610Deposit Withdrawal

Document Statuses

CodeStatus
0Open
1Closed
2Manually Closed
3Canceling
4Canceled

Payment Types

CodeType
-1Unpaid
0Deduction at Source
1Cash
2Check
3Credit Card
4Bank Transfer
5PayPal
10Payment App
11Other

Expense Statuses

CodeStatus
10Open
20Reported

Expense Document Types

CodeType
10Invoice
20Receipt
30Invoice + Receipt
40Other

VAT Types

CodeType
0Default (before VAT)
1VAT included
2VAT exempt

Currencies (28 supported)

ILS, USD, EUR, GBP, JPY, CHF, CNY, AUD, CAD, DKK, NOK, ZAR, SEK, CZK, IMP, JOD, LBP, EGP, HRK, HUF, INR, RUB, TRY, UAH, BRL, PLN, RON, MXN

Key API Notes

  • Field names: use income (not items), payment (not payments), remarks (not notes), lang (not language), emails (array, not email)
  • Document types 320, 400, 405 require a payment array
  • Payment dates cannot be in the future for receipt-type documents
  • Set client.add = true to auto-create a client during document creation
  • JWT tokens last ~30 minutes; re-authenticate via POST /account/token with {id, secret}
  • Rate limit: ~3 requests/second
  • Only inactive clients/suppliers can be deleted
  • Expenses cannot be updated once reported (status=20)