Receipt Cross-Reference API

Retrieve and record cross-references between receipts

Base URL

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

Every request returns a JSON response. On success result.code == 1, on failure result.code == 0. A receipt cross-reference records the relationship between two receipts (source and destination) — e.g. linking a delivery note created from an order to the original order. These links make it possible to trace the conversion chain.

GET /api/receipt_cross/list

Paginated list of cross-references, with advanced filtering options.

Query parameters

ParameterTypeRequiredDescription
receipt_idintSource receipt identifier
receipt_type_idintSource receipt type identifier
receipt_type_id_resultintResult (destination) receipt type identifier
receipt_identify_not_in_resultint1 = only source receipts that do not yet have a destination receipt
receipt_not_in_resultint1 = exclude the source receipt if it already has a destination receipt
receipt_type_id_evenintExclusion receipt type identifier (for balance logic)
group_bystringName of the field to group by
list_offsetintPagination offset (default: 0)
list_conditionobjectFilter conditions object
list_paramsobjectAdditional query parameters

Example request — list of unconverted orders

GET /api/receipt_cross/list?receipt_type_id=5&receipt_type_id_result=15&receipt_identify_not_in_result=1&list_offset=0
X-API-KEY: {your_api_key}
POST /api/receipt_cross/save

Record a cross-reference between a source and a destination receipt.

POST fields — data object

FieldTypeRequiredDescription
src_receipt_type_idintSource receipt type identifier
src_receipt_idintSource receipt identifier
src_receipt_identifystringSource receipt unique identifier string
dst_receipt_type_idintDestination receipt type identifier
dst_receipt_idintDestination receipt identifier
dst_receipt_identifystringDestination receipt unique identifier string
company_user_idintIdentifier of the recording user

POST fields — params object (optional)

The params object accepts additional save parameters — e.g. a comment, a date override.

Example request

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

{
  "data": {
    "src_receipt_type_id": 5,
    "src_receipt_id": 100,
    "dst_receipt_type_id": 15,
    "dst_receipt_id": 200,
    "company_user_id": 1
  },
  "params": {}
}

Get in touch with us

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

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

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