GetDocumentsFromRoaming

[POST] .../v1/docinvoice/getdocumentsfromroaming

Gets provider invoices available in roaming. Use this method to browse invoices available in the firm's configured EDI provider before importing one with DocInvoice/ImportDocumentFromRoaming. The request body must identify a firm with firm_id and can include date filters, limit and offset; the response returns paged DocInvoiceFromRoaming records with next_offset and total from the provider adapter. The firm must have DEFAULT_EDO_INTEGRATION configured and provider-side period and paging behavior depends on the connected EDI adapter. The current request user must have invoice select permission; missing body, invalid firm_id, denied access, missing EDI configuration, provider lookup failures or adapter errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of provider documents to return.
offset Int32 Optional Offset from the beginning of the provider result set.

Filterable Fields

Field Type Description
date int
end_date int Period end as Unix time in seconds for provider-side document selection.
firm_id int Company ID used to resolve the DEFAULT_EDO_INTEGRATION setting.
start_date int Period start as Unix time in seconds for provider-side document selection.

Request Example

{
  "filters": [
    {
      "field": "firm_id",
      "operator": "Equal",
      "value": "1"
    },
    {
      "field": "date",
      "operator": "GreaterOrEqual",
      "value": "1764547200"
    },
    {
      "field": "date",
      "operator": "LessOrEqual",
      "value": "1767225600"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of DocInvoiceFromRoaming Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": "EDI-123456",
      "roaming_id": "ROAM-7890",
      "name": "Incoming invoice INV-2026-001",
      "partner_name": "Coffee Supplier LLC",
      "partner_inn": "301234567",
      "contract": "SUP-2026",
      "firm": "123456789 Regos Demo LLC",
      "date": "2026-01-01T00:00:00",
      "create_date": "2026-01-01T09:00:00",
      "update_date": "2026-01-01T09:30:00",
      "amount": 150000
    }
  ],
  "next_offset": 0,
  "total": 1
}