Skip to main content

List of documents for export

GET 

/documents-export

Returns a paginated list of documents for export

Audit event:

  • document.export.list

Privilege (one of):

  • finance-invoices.view
  • finance-invoices-own.view

Filter fields:

  • id
  • instanceId
  • bpInstanceId
  • bizPartnerId
  • bizPartnerCountry
  • bizPartnerExternalRefId
  • bizPartnerName
  • bizPartnerBriefName
  • bizPartnerType
  • bizPartnerAttn
  • bizPartnerAddress
  • bizPartnerPost
  • bizPartnerCity
  • bizPartnerVatNumber
  • documentDate
  • deliveryDate
  • documentNumber
  • documentNumberMask
  • documentNumberNum
  • dueDate
  • periodStart
  • periodEnd
  • currency
  • amountNoVat
  • amountVat
  • vatPercent
  • vat
  • rounding
  • total
  • totalUnpaid
  • totalPaid
  • domesticCurrency
  • domesticCurrencyRate
  • domesticAmountNoVat
  • domesticAmountVat
  • domesticRounding
  • domesticTotal
  • status
  • insertDt
  • statusDt
  • paymentStatus
  • paymentStatusDate
  • documentType
  • documentTypeName
  • selfBilling
  • domainId
  • dataSourceId
  • documentClassDomain
  • documentClassArea
  • syncStatus
  • syncStatusDt
  • disputeStatus
  • docsDeliveryStatus
  • docsDeliveryStatusDate
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • documentSync
  • documentUuid
  • currencyCode
  • domesticCurrencyCode
  • domainCodeName
  • lang
  • dataSourceCodeName
  • documentClassCodeName
  • dataSourceSelector

Sortable fields:

  • documentUuid
  • id
  • instanceId
  • bizPartnerId
  • bizPartnerCountry
  • bizPartnerExternalRefId
  • bizPartnerName
  • bizPartnerBriefName
  • bizPartnerType
  • bizPartnerAttn
  • bizPartnerAddress
  • bizPartnerPost
  • bizPartnerCity
  • bizPartnerVatNumber
  • documentDate
  • deliveryDate
  • documentNumber
  • documentNumberMask
  • documentNumberNum
  • dueDate
  • periodStart
  • periodEnd
  • currency
  • currencyCode
  • amountNoVat
  • amountVat
  • vatPercent
  • vat
  • rounding
  • total
  • totalUnpaid
  • totalPaid
  • domesticCurrency
  • domesticCurrencyCode
  • domesticCurrencyRate
  • domesticAmountNoVat
  • domesticAmountVat
  • domesticRounding
  • domesticTotal
  • status
  • insertDt
  • statusDt
  • paymentStatus
  • paymentStatusDate
  • lang
  • documentType
  • documentTypeName
  • selfBilling
  • domainId
  • domainCodeName
  • dataSourceId
  • dataSourceCodeName
  • documentClassCodeName
  • documentClassDomain
  • documentClassArea
  • dataSourceSelector
  • syncStatus
  • syncStatusDt
  • disputeStatus
  • docsDeliveryStatus
  • docsDeliveryStatusDate
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • documentSync

Searchable attributes:

  • documentUuid
  • bizPartnerExternalRefId
  • bizPartnerName
  • bizPartnerBriefName
  • bizPartnerType
  • bizPartnerAttn
  • bizPartnerAddress
  • bizPartnerPost
  • bizPartnerCity
  • bizPartnerVatNumber
  • documentNumber
  • documentNumberMask
  • currencyCode
  • domesticCurrencyCode
  • status
  • paymentStatus
  • lang
  • documentTypeName
  • domainCodeName
  • dataSourceCodeName
  • documentClassCodeName
  • documentClassDomain
  • documentClassArea
  • dataSourceSelector
  • syncStatus
  • disputeStatus
  • ownerId
  • ownerBpName
  • ownerBpBriefName
  • docsDeliveryStatus

Errors:

  • INVOICE_NOTFOUND - Invoice not found
  • NOT_AUTHORIZED - Not authorized
  • NOT_AUTHENTICATED - Not authenticated
  • INT_APP_ERROR - Unexpected internal error

Request

Responses

List of documents for export