Incoming Invoice API

Manage supplier and incoming invoices — retrieval, creation, modification, and closing

Endpoints

GET Get record
GET Get list
POST Save / create
POST Delete
POST Close

Authentication

Every API request requires sending the X-API-KEY header.

X-API-KEY: {your_api_key}

Still have questions?

Open a ticket with us, or browse our help center.

Base URL

https://{tenant}.logzi.com/api/invoice_in/

Every request returns a JSON response. On success result.code == 1; on error result.code == 0.

GET/api/invoice_in/get

Retrieve a single incoming invoice by identifier, with full details.

Query parameters

Parameter	Type	Required	Description
`id`	int		Unique identifier of the incoming invoice
`identify`	string		Can also be retrieved by invoice number

Example request

GET /api/invoice_in/get?id=77
X-API-KEY: {your_api_key}

GET/api/invoice_in/list

Paginated retrieval of the incoming invoice list with filtering options.

Query parameters

Parameter	Type	Description
`list_offset`	int	Pagination offset (default: 0)
`list_count`	int	Number of records per page
`list_condition[identify]`	string	Filter by invoice number (LIKE)
`list_condition[company_name]`	string	Filter by supplier name (LIKE)
`list_condition[status_id]`	int	Filter by status
`list_condition[date_create_from]`	date	Creation date — from (YYYY-MM-DD)
`list_condition[date_create_to]`	date	Creation date — to (YYYY-MM-DD)

Example request

GET /api/invoice_in/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {your_api_key}

POST/api/invoice_in/save

Create or update an incoming invoice. For a new invoice use data[id] = 0.

POST fields — data object

Field	Type	Description
`id`	int	0 = new invoice, >0 = update
`company_id`	int	Company identifier
`company_user_id`	int	ID of the responsible employee
`company_address_id`	int	Company site ID
`currency_id`	int	Currency identifier
`partner_id`	int	Supplier partner identifier
`date_perform`	date	Performance date (YYYY-MM-DD)
`date_pay`	date	Payment due date (YYYY-MM-DD)
`paymod_id`	int	Payment method identifier
`comment_top`	string	Comment
`comment_bottom`	string	Internal comment
`item`	array	Array of line items (see below)

Line item fields — data[item][]

Field	Type	Description
`product_id`	int	Product identifier
`quantity`	float	Quantity
`price`	float	Net unit price
`tax_id`	int	VAT rate identifier
`store_id`	int	Destination warehouse identifier
`remove`	int	1 = delete the line item on update

Example request

POST /api/invoice_in/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "company_address_id": 1,
    "currency_id": 1,
    "partner_id": 8,
    "date_perform": "2024-06-30",
    "date_pay": "2024-07-30",
    "item": [
      { "product_id": 2, "quantity": 100, "price": 500, "tax_id": 2 }
    ]
  }
}

POST/api/invoice_in/delete

Delete an incoming invoice. Only an open (status_id=1) invoice can be deleted.

POST fields — data object

Field	Type	Required	Description
`receipt_id`	int		Identifier of the invoice to delete

Example request

POST /api/invoice_in/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "receipt_id": 77 } }

POST/api/invoice_in/close

Close an incoming invoice. Closing generates the accounting entries. Warehouse receiving is handled through the warehouse receipt (booking) module. Only an open (status_id=1) invoice can be closed.

POST fields — data object

Field	Type	Required	Description
`receipt_id`	int		Identifier of the invoice to close

Example request

POST /api/invoice_in/close
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "receipt_id": 77 } }

Get in touch with us

Interested in our software? Feel free to write to us!

Send an inquiry

Need help?

If you can't find the answer and need assistance

Browse the help center

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!