APG PayAPG Paydocs

Merchants

Get travel file missing dbi workbook

GET/travel-files/{travelFileId}/missing-dbi-workbooks/{layout}
Request
GEThttps://api.tst.au.apgpay.dev/travel-files/{travelFileId}/missing-dbi-workbooks/{layout}
curl -X GET https://api.tst.au.apgpay.dev/travel-files/{travelFileId}/missing-dbi-workbooks/{layout} \
  -H "Authorization: Bearer $API_KEY"

Return the workbook of the entries of this file whose data-based invoicing check failed, as the file itself: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet. Content-Disposition names the file; the name is stated here too, because generated clients drop headers.

The entries are those whose data-based invoicing check failed in the last 14 days. layout is Merchant, the portal's columns, authorised at the merchant the entries belong to, or Admin, the back office's, which shows other merchants' details and is platform staff's. None to export is a 404. The card is never a filter.

Permissions

Required permission
merchantTravelData:query

Requires the `query` action on `merchantTravelData` for the supplied runtime context

Path parameters

travelFileIdstring
required
layoutTvldbiwLayout
required

Which columns the workbook carries.

MerchantAdmin

Query parameters

documentNumberstring

Entries whose document number contains this text.

invoiceNumberstring

Entries whose invoice number contains this text.

fileTypeTvlfileType

Narrow to one kind of file.

MerchantBspEnrichmentUnknown
timezonestring

The IANA timezone the expiry column is written in, Australia/Sydney. Without it, UTC.

Responses

Example response
"string"

Error responses