# DR11 - List accounting documents requests

PaginationThis resource supports seek pagination (see documentation)Sort fieldssort field can have the following values:dateCreated (Default) - Sort by creation date (desc by default)

Endpoint: GET /api/document-request/requests

## Query parameters:

  - `id` (string)
    Filter document requests with the given id

  - `document_number` (string)
    Filter document requests with the given document number

  - `date_created_from` (string)
    Filter document requests created after the given date

  - `date_created_to` (string)
    Filter document requests created before the given date

  - `last_updated_from` (string)
    Filter document requests updated after the given date

  - `last_updated_to` (string)
    Filter document requests updated before the given date

  - `issue_date_from` (string)
    Filter document requests issued after the given date

  - `issue_date_to` (string)
    Filter document requests issued before the given date

  - `state` (array)
    Document request states. This parameter can be supplied multiple times.
    Enum: "STAGING", "TO_PROCESS", "ISSUED", "CANCELED"

  - `type` (array)
    Accounting document types. This parameter can be supplied multiple times.
    Enum: "INVOICE", "CREDIT_NOTE"

  - `issuer_type` (array)
    Issuer types. This parameter can be supplied multiple times.
    Enum: "OPERATOR", "SHOP"

  - `shop_ids` (array)
    Shop identifiers linked to the entity. This parameter can be supplied multiple times.

  - `entity_id` (array)
    Entity identifiers. (default: include all). This parameter can be supplied multiple times.The entity_type must be specified to use this filter, otherwise an error 400 will be returned.Example: entity_id=order1-A&entity_id=order20-A&entity_type=PRODUCT_LOGISTIC_ORDER

  - `entity_type` (array)
    Entity types. This parameter can be supplied multiple times.
    Enum: "PRODUCT_LOGISTIC_ORDER", "SHOP_BILLING_CYCLE_PURCHASE_ORDER", "LOGISTIC_PURCHASE_ORDER"

  - `billing_cycle_from` (string)
    Filter document requests generated by billing cycle after the given date. This filter is only available for documents requests of the type: SHOP_BILLING_CYCLE_PURCHASE_ORDER.

  - `billing_cycle_to` (string)
    Filter document requests generated by billing cycle before the given date. This filter is only available for documents requests of the type: SHOP_BILLING_CYCLE_PURCHASE_ORDER.

  - `payment_state` (string)
    Filter document requests with the given payment state. This filter is only available for documents requests of the type: SHOP_BILLING_CYCLE_PURCHASE_ORDER, LOGISTIC_PURCHASE_ORDER.
    Enum: "PAID", "PENDING"

## Response 200 fields (application/json):

  - `data` (array, required)
    Page of data

  - `data.currency_iso_code` (string, required)
    The currency of the document request
    Enum: "AED", "ARS", "AUD", "BAM", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CZK", "DKK", "EGP", "EUR", "GBP", "GEL", "GTQ", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "IQD", "JOD", "JPY", "KES", "KRW", "KWD", "LKR", "MAD", "MGA", "MXN", "MYR", "NGN", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "TND", "TRY", "THB", "TWD", "UAH", "USD", "UYU", "UZS", "VND", "ZAR"

  - `data.date_created` (string, required)
    The document request creation date

  - `data.document_details` (array, required)
    The document details

  - `data.document_details.format` (string, required)
    The document format
    Enum: "PDF", "cXML"

  - `data.document_number` (string)
    The accounting document number

  - `data.document_upload_date` (string)
    The last upload date of the accounting document

  - `data.due_date` (string, required)
    The document due date

  - `data.entities` (object)
    Node containing additional information depending on type of document request, if any

  - `data.entities.delivery_bill_information` (array)
    A list of delivery bill information

  - `data.entities.delivery_bill_information.delivery_bill_date` (string)
    Delivery bill date

  - `data.entities.delivery_bill_information.delivery_bill_id` (string)
    Delivery bill ID

  - `data.entities.ship_to_iso_country_code` (string)
    Ship to ISO country code

  - `data.entities.shipping_information` (object)
    A node containing shipping information

  - `data.entities.shipping_information.ship_to_address` (object)
    A node containing shipping address information

  - `data.entities.shipping_information.ship_to_address.city` (string)
    The city of the shipping address

  - `data.entities.shipping_information.ship_to_address.civility` (string)
    The civility of the recipient (e.g., Mr., Mrs., Dr.)

  - `data.entities.shipping_information.ship_to_address.company` (string)
    The company name of the shipping address

  - `data.entities.shipping_information.ship_to_address.company2` (string)
    The secondary company name of the shipping address

  - `data.entities.shipping_information.ship_to_address.country_iso_code` (string)
    The ISO country code of the shipping address

  - `data.entities.shipping_information.ship_to_address.firstname` (string)
    The first name of the recipient

  - `data.entities.shipping_information.ship_to_address.lastname` (string)
    The last name of the recipient

  - `data.entities.shipping_information.ship_to_address.phone` (string)
    The phone number of the recipient

  - `data.entities.shipping_information.ship_to_address.phone_secondary` (string)
    The secondary phone number of the recipient

  - `data.entities.shipping_information.ship_to_address.state` (string)
    The state of the shipping address

  - `data.entities.shipping_information.ship_to_address.street1` (string)
    The first line of the street address

  - `data.entities.shipping_information.ship_to_address.street2` (string)
    The second line of the street address

  - `data.entities.shipping_information.ship_to_address.zip_code` (string)
    The zip code of the shipping address

  - `data.entities.shop_billing_cycle` (object)
    A node containing shop billing cycle information

  - `data.entities.shop_billing_cycle.date_from` (string)
    Shop billing cycle date from

  - `data.entities.shop_billing_cycle.date_to` (string)
    Shop billing cycle date to

  - `data.entity_date_created` (string)
    The entity creation date, not applicable for entity_type=SHOP_BILLING_CYCLE_PURCHASE_ORDER

  - `data.entity_id` (string, required)
    The entity id the document request relates to

  - `data.entity_type` (string, required)
    The entity type the document request relates to
    Enum: "PRODUCT_LOGISTIC_ORDER", "SHOP_BILLING_CYCLE_PURCHASE_ORDER", "LOGISTIC_PURCHASE_ORDER"

  - `data.id` (string, required)
    The document request unique identifier

  - `data.initial_documents` (array)
    In the case of CREDIT_NOTE or reissued INVOICE, information about the initial accounting documents

  - `data.initial_documents.id` (string, required)
    The initial document request unique identifier

  - `data.initial_documents.issue_date` (string, required)
    The initial document request issue date

  - `data.initial_documents.number` (string)
    The initial document accounting number

  - `data.initial_documents.type` (string, required)
    The initial document request type
    Enum: "INVOICE", "CREDIT_NOTE"

  - `data.initial_payment_state` (string, required)
    The document request payment state at the time when the document request was created
    Enum: "PAID", "NOT_PAID"

  - `data.issue_date` (string, required)
    The document issue date

  - `data.issuer` (object, required)
    The issuer details of the document

  - `data.issuer.id` (string)
    The identifier of the issuer. This will be the operator or seller 'billing information identifier'.

  - `data.issuer.organization` (object, required)
    The issuer organization.

  - `data.issuer.organization.address` (object, required)
    The address of the organization.

  - `data.issuer.organization.address.city` (string, required)
    Address city

  - `data.issuer.organization.address.country_iso_code` (string, required)
    Country ISO 3166-1 code of the address

  - `data.issuer.organization.address.state` (string)
    Address state

  - `data.issuer.organization.address.street_1` (string, required)
    First information line of the address street

  - `data.issuer.organization.address.street_2` (string)
    Second information line of the address street

  - `data.issuer.organization.address.zip_code` (string)
    Address zip code

  - `data.issuer.organization.business_activity_code` (string)
    The business activity code of the organization.

  - `data.issuer.organization.company_shareholders` (string)
    Indicates if there is a single shareholder or several shareholders.

  - `data.issuer.organization.fiscal_representative` (object)
    The fiscal representative of the organization.

  - `data.issuer.organization.fiscal_representative.city` (string, required)
    The the city where the fiscal representative is located.

  - `data.issuer.organization.fiscal_representative.civility` (string, required)
    The civility of the fiscal representative.

  - `data.issuer.organization.fiscal_representative.company_registration_name` (string, required)
    The name of the fiscal representative.

  - `data.issuer.organization.fiscal_representative.company_registration_number` (string, required)
    The registration number of the fiscal representative.

  - `data.issuer.organization.fiscal_representative.country_iso_code` (string, required)
    The country ISO 3166-1 code of the fiscal representative address.

  - `data.issuer.organization.fiscal_representative.first_name` (string, required)
    The first name of the fiscal representative.

  - `data.issuer.organization.fiscal_representative.last_name` (string, required)
    The last name of the fiscal representative.

  - `data.issuer.organization.fiscal_representative.local_tax_number` (string)
    The VAT/GST number.

  - `data.issuer.organization.fiscal_representative.state` (string)
    The state/province/region where the fiscal representative is located.

  - `data.issuer.organization.fiscal_representative.street_1` (string, required)
    The first line of address of the fiscal representative.

  - `data.issuer.organization.fiscal_representative.street_2` (string)
    The second line of address of the fiscal representative.

  - `data.issuer.organization.fiscal_representative.zip_code` (string)
    The Zip/Postal code corresponding to the fiscal representative location.

  - `data.issuer.organization.identification_number` (string)
    The identification number of the organization.

  - `data.issuer.organization.is_in_liquidation` (boolean)
    Indicates whether the company is in liquidation or not.

  - `data.issuer.organization.legal_form` (string)
    The legal form of the organization.

  - `data.issuer.organization.local_tax_number_country` (string)
    The local tax number country of the organization.

  - `data.issuer.organization.name` (string, required)
    The organization name.

  - `data.issuer.organization.personal_information` (object)
    The personal information of the organization.

  - `data.issuer.organization.personal_information.civility` (string)
    The civility of the shop owner

  - `data.issuer.organization.personal_information.first_name` (string)
    The first name of the shop owner

  - `data.issuer.organization.personal_information.last_name` (string)
    The last name of the shop owner.

  - `data.issuer.organization.share_capital` (number)
    The share capital of the organization.

  - `data.issuer.organization.share_capital_currency` (string)
    The share capital currency of the organization.

  - `data.issuer.organization.sole_trader` (boolean)
    Indicates if the organization is a sole trader.

  - `data.issuer.organization.tax_identification_number` (string)
    The tax identification number of the organization.

  - `data.issuer.organization.tax_number_country` (string)
    The tax number country of the organization.

  - `data.issuer.organization.trade_company_registration_location` (string)
    The trade company registration location of the organization.

  - `data.issuer.type` (string, required)
    The issuer type (operator or shop) of the document.
    Enum: "OPERATOR", "SHOP"

  - `data.last_updated` (string, required)
    The document request last update date

  - `data.payment` (object)
    Accounting document payment details

  - `data.payment.reference` (string)
    Transaction reference

  - `data.payment.state` (string)
    Payment status
    Enum: "PAID", "PENDING"

  - `data.payment.transaction_date` (string)
    Transaction date

  - `data.payment_destination` (object)
    The payment destination

  - `data.payment_destination.@type` (string)
    Enum: "IBAN"

  - `data.payment_destination.payment_reference` (string)
    The payment reference for bank transfer

  - `data.payment_terms` (object)
    The document payment terms

  - `data.payment_terms.days` (integer)
    The payment terms days

  - `data.payment_terms.type` (string)
    The payment terms type.Possible values:END_OF_MONTH: payment is due after a number of calendar days following the invoice issue date, at the end of the given month.NET: payment is due after a number of calendar days following the invoice issue date.
    Enum: "END_OF_MONTH", "NET"

  - `data.recipient` (object)
    The document recipient

  - `data.recipient.billing_address` (object, required)
    The billing address

  - `data.recipient.billing_address.civility` (string)
    The civility of the person associated with the address

  - `data.recipient.billing_address.company` (string)
    Company name

  - `data.recipient.billing_address.company_2` (string)
    Second company information of the person associated with the address

  - `data.recipient.billing_address.country` (string, required)
    Address country

  - `data.recipient.billing_address.firstname` (string)
    The firstname of the person associated with the address

  - `data.recipient.billing_address.lastname` (string, required)
    The lastname of the person associated with the address

  - `data.recipient.id` (string, required)
    The identifier of the recipient. In the case of a customer, this will be the customer identifier. In the case of a operator, this will be the operator 'billing information identifier'

  - `data.recipient.locale` (string)
    The recipient locale

  - `data.recipient.organization` (object)
    The recipient organization, if any

  - `data.recipient.organization.organization_id` (string)
    Identifier of the customer organization

  - `data.recipient.shipping_address` (object)
    The shipping address

  - `data.state` (string, required)
    The document request state
    Enum: "STAGING", "TO_PROCESS", "ISSUED", "CANCELED"

  - `data.taxes` (array)
    Total amount of taxes aggregated per tax code and rate

  - `data.taxes.code` (string, required)
    Tax code

  - `data.taxes.rate` (number)
    Tax rate

  - `data.taxes.total_amount` (number, required)
    Total tax amount aggregated by tax code and rate

  - `data.total_amount_excluding_taxes` (number, required)
    The total document amount (excluding taxes)

  - `data.total_amount_including_taxes` (number, required)
    The total document amount (including taxes)

  - `data.total_tax_amount` (number, required)
    The total taxes amount of the document

  - `data.type` (string, required)
    The accounting document type
    Enum: "INVOICE", "CREDIT_NOTE"

  - `next_page_token` (string)
    Token to access the next page. Absent if the current page is the last one.

  - `previous_page_token` (string)
    Token to access the previous page. Absent if the current page is the first one.