Getting Started

Catalog Update

Order Management

Total Sales

Suppliers Details

Buyers Details

Order management

Get delivery documents

Invoices or  delivery certificate are sent using the following URL:

Request:

				
					Method: GET
URL: /api/v1/supplierApi/deliveryDocumentsByCriteria?fromDate=YYYY-MM-DD&toDate=YYYY-MM-DD&status={status num}&updated=true
headers :
Authorization: bearer {token}

The “status” variable should change according to the chosen document:

Parameters

Param Name Type Required Explanation
fromDate YYYY-MM-DD true Start documents creation date range
toDate YYYY-MM-DD true End documents creation date range
status Number false Filter by document's status
updated boolean false Mark 'true' to receive documents that were updated on these dates range

Statuses list

Field Name status number
Drafts 0
Open 1
Canceled 2
Used in collective invoice 5
pending for approval 6

Export_status list

Field Name status number
NotExported 0
Approved 1
Exported 2
Pending 3

Document discount type

Field Name status number
Percentage 0
NIS 1

Response:

				
					{
    "status": "200",
    "documents": [
        {
            "id": "2323264",
            "supplierId": 53227,
            "buyerId": 75264,
            "supplierName": "לחם לחם - מאפיית העיר שם ממש ערוך מייגע",
            "buyerName": "המבורגרי באר שבע",
            "status": 1,
            "type": 5,
            "number": "67687",
            "date_sent": "2025-01-08",
            "customer_number": null,
            "date_delivery": "2025-01-08",
            "description": null,
            "totalNoVATAfterDiscount": 7667.0000,
            "totalWithVATAfterDiscount": 9047.0600,
            "items": [{
                    "cat_number": "2587413",
                    "name": "test 0606",
                    "unitQuantity": 1.00,
                    "unitQuantityType": 0,
                    "quantity": 1.000,
                    "price": 16.0000,
                    "totalQuantity": 1.00000,
                    "totalPrice": 16.0000000,
                    "withoutVAT": false,
                    "orderId": null,
                    "expenseAccount": null,
                    "discount_percentage": 20.00
                },
                {
                    "cat_number": "435345",
                    "name": "sdfsdf",
                    "unitQuantity": 1.00,
                    "unitQuantityType": 0,
                    "quantity": 1.000,
                    "price": 14.0000,
                    "totalQuantity": 1.00000,
                    "totalPrice": 14.0000000,
                    "withoutVAT": false,
                    "orderId": null,
                    "expenseAccount": null,
                    "discount_percentage": 30.00
                }],
            "related_documents": [
                {
                    "id": "2323230",
                    "status": 5,
                    "type": 3,
                    "number": "3453454",
                    "date_sent": "2025-01-06",
                    "date_delivery": "2025-01-07",
                    "totalNoVATAfterDiscount": 100.0000,
                    "totalWithVATAfterDiscount": 118.0000
                },
                {
                    "id": "2323225",
                    "status": 5,
                    "type": 3,
                    "number": "73",
                    "date_sent": "2025-01-07",
                    "date_delivery": "2025-01-05",
                    "totalNoVATAfterDiscount": 20.0000,
                    "totalWithVATAfterDiscount": 23.6000
                }
            ],
            "attached_files": null,
            "procurement_type": "אירועים",
            "export_status": null,
            "has_refund_request": false,// true if a refund request 
            //was created for this document at its creation
            "expense_accounts": [
                {
                    "account_number": "456456",
                    "value": 0.0000000,
                    "is_difference": false
                },
                {
                    "account_number": "111",
                    "value": 120.0000000,
                    "is_difference": false
                },
                {
                    "account_number": "456456",
                    "value": 7547.0000000,
                    "is_difference": true
                }
            ],
            "assignment_number": "35485",
            "document_discount": 10.00,
            "discount_type": 0,
            "ERPSupplierNumber": 123456,
            "latestUpdateDate": null
        }
    ]
}

Status: 200