Chilkat Online Tools

Swift / easybill REST API / Fetch documents list

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    let queryParams = CkoJsonObject()
    queryParams.UpdateString("limit", value: "<integer>")
    queryParams.UpdateString("page", value: "<integer>")
    queryParams.UpdateString("type", value: "REMINDER")
    queryParams.UpdateInt("is_draft", value: 0)
    queryParams.UpdateInt("is_archive", value: 0)
    queryParams.UpdateString("customer_id", value: "<string>")
    queryParams.UpdateString("project_id", value: "<string>")
    queryParams.UpdateString("ref_id", value: "<string>")
    queryParams.UpdateString("document_date", value: "<string>")
    queryParams.UpdateString("paid_at", value: "<string>")
    queryParams.UpdateString("title", value: "<string>")
    queryParams.UpdateString("number", value: "<string>")
    queryParams.UpdateString("cancel_id", value: "<string>")
    queryParams.UpdateString("fulfillment_country", value: "<string>")
    queryParams.UpdateString("vat_country", value: "<string>")
    queryParams.UpdateString("shipping_country", value: "<string>")
    queryParams.UpdateString("status", value: "<string>")

    http.SetRequestHeader("Authorization", value: "{{apiKey}}")
    http.SetRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://api.easybill.de/rest/v1/documents", json: queryParams)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

}

Curl Command

curl -G -d "limit=%3Cinteger%3E"
	-d "page=%3Cinteger%3E"
	-d "type=REMINDER"
	-d "is_draft=0"
	-d "is_archive=0"
	-d "customer_id=%3Cstring%3E"
	-d "project_id=%3Cstring%3E"
	-d "ref_id=%3Cstring%3E"
	-d "document_date=%3Cstring%3E"
	-d "paid_at=%3Cstring%3E"
	-d "title=%3Cstring%3E"
	-d "number=%3Cstring%3E"
	-d "cancel_id=%3Cstring%3E"
	-d "fulfillment_country=%3Cstring%3E"
	-d "vat_country=%3Cstring%3E"
	-d "shipping_country=%3Cstring%3E"
	-d "status=%3Cstring%3E"
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/documents

Postman Collection Item JSON

{
  "name": "Fetch documents list",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/documents?limit=<integer>&page=<integer>&type=REMINDER&is_draft=0&is_archive=0&customer_id=<string>&project_id=<string>&ref_id=<string>&document_date=<string>&paid_at=<string>&title=<string>&number=<string>&cancel_id=<string>&fulfillment_country=<string>&vat_country=<string>&shipping_country=<string>&status=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "documents"
      ],
      "query": [
        {
          "key": "limit",
          "value": "<integer>",
          "description": "Limited the result. Default is 100. Maximum can be 1000."
        },
        {
          "key": "page",
          "value": "<integer>",
          "description": "Set current Page. Default is 1."
        },
        {
          "key": "type",
          "value": "REMINDER",
          "description": "Filter documents by type. Multiple typs seperate with , like type=INVOICE,CREDIT."
        },
        {
          "key": "is_draft",
          "value": "0",
          "description": "Filter documents by draft flag."
        },
        {
          "key": "is_archive",
          "value": "0",
          "description": "Filter documents by archive flag."
        },
        {
          "key": "customer_id",
          "value": "<string>",
          "description": "Filter documents by customer_id. You can add multiple customer_is separate by comma like id,id,id."
        },
        {
          "key": "project_id",
          "value": "<string>",
          "description": "Filter documents by project_id. You can add multiple project_id separate by comma like id,id,id."
        },
        {
          "key": "ref_id",
          "value": "<string>",
          "description": "Filter documents by ref_id."
        },
        {
          "key": "document_date",
          "value": "<string>",
          "description": "Filter documents by document_date. You can filter one date with document_date=2014-12-10 or between like 2015-01-01,2015-12-31."
        },
        {
          "key": "paid_at",
          "value": "<string>",
          "description": "Filter documents by paid_at. You can filter one date with paid_at=2014-12-10 or between like 2015-01-01,2015-12-31. With paid_at=null you get all unpaid documents."
        },
        {
          "key": "title",
          "value": "<string>",
          "description": "Filter documents by title."
        },
        {
          "key": "number",
          "value": "<string>",
          "description": "Filter documents by number."
        },
        {
          "key": "cancel_id",
          "value": "<string>",
          "description": "Filter documents by cancel_id. You can add multiple ids separate by comma like id,id,id. With cancel_id=null you get all not canceled documents."
        },
        {
          "key": "fulfillment_country",
          "value": "<string>",
          "description": "Filter documents by fulfillment_country."
        },
        {
          "key": "vat_country",
          "value": "<string>",
          "description": "Filter documents by vat_country."
        },
        {
          "key": "shipping_country",
          "value": "<string>",
          "description": "Filter documents by shipping_country."
        },
        {
          "key": "status",
          "value": "<string>",
          "description": "Filter documents by status. Keep in mind that not every document type has a status."
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/documents?limit=<integer>&page=<integer>&type=REMINDER&is_draft=0&is_archive=0&customer_id=<string>&project_id=<string>&ref_id=<string>&document_date=<string>&paid_at=<string>&title=<string>&number=<string>&cancel_id=<string>&fulfillment_country=<string>&vat_country=<string>&shipping_country=<string>&status=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "documents"
          ],
          "query": [
            {
              "key": "limit",
              "value": "<integer>",
              "description": "Limited the result. Default is 100. Maximum can be 1000."
            },
            {
              "key": "page",
              "value": "<integer>",
              "description": "Set current Page. Default is 1."
            },
            {
              "key": "type",
              "value": "REMINDER",
              "description": "Filter documents by type. Multiple typs seperate with , like type=INVOICE,CREDIT."
            },
            {
              "key": "is_draft",
              "value": "0",
              "description": "Filter documents by draft flag."
            },
            {
              "key": "is_archive",
              "value": "0",
              "description": "Filter documents by archive flag."
            },
            {
              "key": "customer_id",
              "value": "<string>",
              "description": "Filter documents by customer_id. You can add multiple customer_is separate by comma like id,id,id."
            },
            {
              "key": "project_id",
              "value": "<string>",
              "description": "Filter documents by project_id. You can add multiple project_id separate by comma like id,id,id."
            },
            {
              "key": "ref_id",
              "value": "<string>",
              "description": "Filter documents by ref_id."
            },
            {
              "key": "document_date",
              "value": "<string>",
              "description": "Filter documents by document_date. You can filter one date with document_date=2014-12-10 or between like 2015-01-01,2015-12-31."
            },
            {
              "key": "paid_at",
              "value": "<string>",
              "description": "Filter documents by paid_at. You can filter one date with paid_at=2014-12-10 or between like 2015-01-01,2015-12-31. With paid_at=null you get all unpaid documents."
            },
            {
              "key": "title",
              "value": "<string>",
              "description": "Filter documents by title."
            },
            {
              "key": "number",
              "value": "<string>",
              "description": "Filter documents by number."
            },
            {
              "key": "cancel_id",
              "value": "<string>",
              "description": "Filter documents by cancel_id. You can add multiple ids separate by comma like id,id,id. With cancel_id=null you get all not canceled documents."
            },
            {
              "key": "fulfillment_country",
              "value": "<string>",
              "description": "Filter documents by fulfillment_country."
            },
            {
              "key": "vat_country",
              "value": "<string>",
              "description": "Filter documents by vat_country."
            },
            {
              "key": "shipping_country",
              "value": "<string>",
              "description": "Filter documents by shipping_country."
            },
            {
              "key": "status",
              "value": "<string>",
              "description": "Filter documents by status. Keep in mind that not every document type has a status."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"page\": \"<integer>\",\n  \"pages\": \"<integer>\",\n  \"limit\": \"<integer>\",\n  \"total\": \"<integer>\",\n  \"items\": [\n    {\n      \"address\": {\n        \"salutation\": \"<integer>\",\n        \"personal\": \"<boolean>\",\n        \"title\": \"<string>\",\n        \"first_name\": \"<string>\",\n        \"last_name\": \"<string>\",\n        \"suffix_1\": \"<string>\",\n        \"suffix_2\": \"<string>\",\n        \"company_name\": \"<string>\",\n        \"street\": \"<string>\",\n        \"zip_code\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"country\": \"<string>\"\n      },\n      \"attachment_ids\": [\n        \"<integer>\",\n        \"<integer>\"\n      ],\n      \"label_address\": {\n        \"salutation\": \"<integer>\",\n        \"personal\": \"<boolean>\",\n        \"title\": \"<string>\",\n        \"first_name\": \"<string>\",\n        \"last_name\": \"<string>\",\n        \"suffix_1\": \"<string>\",\n        \"suffix_2\": \"<string>\",\n        \"company_name\": \"<string>\",\n        \"street\": \"<string>\",\n        \"zip_code\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"country\": \"<string>\"\n      },\n      \"amount\": \"<integer>\",\n      \"amount_net\": \"<integer>\",\n      \"bank_debit_form\": null,\n      \"billing_country\": \"<string>\",\n      \"calc_vat_from\": 0,\n      \"cancel_id\": \"<long>\",\n      \"cash_allowance\": null,\n      \"cash_allowance_days\": null,\n      \"cash_allowance_text\": null,\n      \"contact_id\": null,\n      \"contact_label\": \"\",\n      \"contact_text\": \"\",\n      \"created_at\": \"<dateTime>\",\n      \"currency\": \"EUR\",\n      \"customer_id\": null,\n      \"customer_snapshot\": {\n        \"last_name\": \"<string>\",\n        \"company_name\": \"<string>\",\n        \"acquire_options\": 2,\n        \"additional_groups_ids\": [\n          \"<integer>\",\n          \"<integer>\"\n        ],\n        \"bank_account\": \"<string>\",\n        \"bank_account_owner\": \"<string>\",\n        \"bank_bic\": \"<string>\",\n        \"bank_code\": \"<string>\",\n        \"bank_iban\": \"<string>\",\n        \"bank_name\": \"<string>\",\n        \"birth_date\": \"<date>\",\n        \"cash_allowance\": \"<float>\",\n        \"cash_allowance_days\": 7,\n        \"cash_discount\": \"<float>\",\n        \"cash_discount_type\": \"AMOUNT\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"country\": \"<string>\",\n        \"created_at\": \"<date>\",\n        \"updated_at\": \"<string>\",\n        \"delivery_title\": \"<string>\",\n        \"delivery_city\": \"<string>\",\n        \"delivery_state\": \"<string>\",\n        \"delivery_company_name\": \"<string>\",\n        \"delivery_country\": \"<string>\",\n        \"delivery_first_name\": \"<string>\",\n        \"delivery_last_name\": \"<string>\",\n        \"delivery_personal\": \"<boolean>\",\n        \"delivery_salutation\": 0,\n        \"delivery_street\": \"<string>\",\n        \"delivery_suffix_1\": \"<string>\",\n        \"delivery_suffix_2\": \"<string>\",\n        \"delivery_zip_code\": \"<string>\",\n        \"display_name\": \"<string>\",\n        \"emails\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"fax\": \"<string>\",\n        \"first_name\": \"<string>\",\n        \"grace_period\": \"<integer>\",\n        \"due_in_days\": \"<integer>\",\n        \"group_id\": \"<integer>\",\n        \"id\": \"<long>\",\n        \"info_1\": \"<string>\",\n        \"info_2\": \"<string>\",\n        \"internet\": \"<string>\",\n        \"login_id\": \"<long>\",\n        \"mobile\": \"<string>\",\n        \"note\": \"<string>\",\n        \"number\": \"<string>\",\n        \"payment_options\": 1,\n        \"personal\": false,\n        \"phone_1\": \"<string>\",\n        \"phone_2\": \"<string>\",\n        \"postbox\": \"<string>\",\n        \"postbox_city\": \"<string>\",\n        \"postbox_state\": \"<string>\",\n        \"postbox_country\": \"<string>\",\n        \"postbox_zip_code\": \"<string>\",\n        \"sale_price_level\": \"SALEPRICE9\",\n        \"salutation\": 0,\n        \"sepa_agreement\": \"COMPANY\",\n        \"sepa_agreement_date\": \"<date>\",\n        \"sepa_mandate_reference\": \"<string>\",\n        \"since_date\": \"<date>\",\n        \"street\": \"<string>\",\n        \"suffix_1\": \"<string>\",\n        \"suffix_2\": \"<string>\",\n        \"tax_number\": \"<string>\",\n        \"court\": \"<string>\",\n        \"court_registry_number\": \"<string>\",\n        \"tax_options\": \"sStfr\",\n        \"title\": \"<string>\",\n        \"archived\": \"<boolean>\",\n        \"vat_identifier\": \"<string>\",\n        \"zip_code\": \"<string>\",\n        \"document_pdf_type\": \"default\",\n        \"buyer_reference\": \"<string>\",\n        \"foreign_supplier_number\": \"<string>\"\n      },\n      \"discount\": null,\n      \"discount_type\": null,\n      \"document_date\": \"<date>\",\n      \"due_date\": \"<date>\",\n      \"edited_at\": \"<dateTime>\",\n      \"external_id\": null,\n      \"replica_url\": null,\n      \"grace_period\": \"<integer>\",\n      \"due_in_days\": \"<integer>\",\n      \"id\": \"<long>\",\n      \"is_acceptable_on_public_domain\": false,\n      \"is_archive\": false,\n      \"is_draft\": \"<boolean>\",\n      \"is_replica\": false,\n      \"is_oss\": false,\n      \"item_notes\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"items\": [\n        {\n          \"number\": null,\n          \"description\": null,\n          \"document_note\": \"<string>\",\n          \"quantity\": 1,\n          \"quantity_str\": \"<string>\",\n          \"unit\": null,\n          \"type\": \"POSITION\",\n          \"position\": \"<integer>\",\n          \"single_price_net\": null,\n          \"single_price_gross\": \"<float>\",\n          \"vat_percent\": 0,\n          \"discount\": null,\n          \"discount_type\": null,\n          \"position_id\": null,\n          \"total_price_net\": \"<float>\",\n          \"total_price_gross\": \"<float>\",\n          \"total_vat\": \"<float>\",\n          \"serial_number_id\": \"<string>\",\n          \"serial_number\": \"<string>\",\n          \"booking_account\": null,\n          \"export_cost_1\": null,\n          \"export_cost_2\": null,\n          \"cost_price_net\": null,\n          \"cost_price_total\": \"<float>\",\n          \"cost_price_charge\": \"<float>\",\n          \"cost_price_charge_type\": \"AMOUNT\",\n          \"itemType\": \"UNDEFINED\",\n          \"id\": \"<long>\"\n        },\n        {\n          \"number\": null,\n          \"description\": null,\n          \"document_note\": \"<string>\",\n          \"quantity\": 1,\n          \"quantity_str\": \"<string>\",\n          \"unit\": null,\n          \"type\": \"POSITION\",\n          \"position\": \"<integer>\",\n          \"single_price_net\": null,\n          \"single_price_gross\": \"<float>\",\n          \"vat_percent\": 0,\n          \"discount\": null,\n          \"discount_type\": null,\n          \"position_id\": null,\n          \"total_price_net\": \"<float>\",\n          \"total_price_gross\": \"<float>\",\n          \"total_vat\": \"<float>\",\n          \"serial_number_id\": \"<string>\",\n          \"serial_number\": \"<string>\",\n          \"booking_account\": null,\n          \"export_cost_1\": null,\n          \"export_cost_2\": null,\n          \"cost_price_net\": null,\n          \"cost_price_total\": \"<float>\",\n          \"cost_price_charge\": \"<float>\",\n          \"cost_price_charge_type\": \"AMOUNT\",\n          \"itemType\": \"UNDEFINED\",\n          \"id\": \"<long>\"\n        }\n      ],\n      \"last_postbox_id\": \"<long>\",\n      \"login_id\": \"<long>\",\n      \"number\": null,\n      \"order_number\": \"\",\n      \"buyer_reference\": \"\",\n      \"paid_amount\": \"<integer>\",\n      \"paid_at\": \"<date>\",\n      \"pdf_pages\": \"<integer>\",\n      \"pdf_template\": \"<string>\",\n      \"project_id\": null,\n      \"recurring_options\": {\n        \"next_date\": \"<date>\",\n        \"frequency\": \"MONTHLY\",\n        \"frequency_special\": null,\n        \"interval\": 1,\n        \"end_date_or_count\": null,\n        \"status\": \"WAITING\",\n        \"as_draft\": false,\n        \"is_notify\": false,\n        \"send_as\": null,\n        \"is_sign\": false,\n        \"is_paid\": false,\n        \"paid_date_option\": \"created_date\",\n        \"is_sepa\": false,\n        \"sepa_local_instrument\": null,\n        \"sepa_sequence_type\": null,\n        \"sepa_reference\": null,\n        \"sepa_remittance_information\": null,\n        \"target_type\": \"INVOICE\"\n      },\n      \"ref_id\": null,\n      \"root_id\": null,\n      \"service_date\": {\n        \"type\": \"DELIVERY\",\n        \"date\": \"<date>\",\n        \"date_from\": \"<date>\",\n        \"date_to\": \"<date>\",\n        \"text\": null\n      },\n      \"shipping_country\": null,\n      \"status\": null,\n      \"text\": \"<string>\",\n      \"text_prefix\": \"<string>\",\n      \"text_tax\": null,\n      \"title\": null,\n      \"type\": \"INVOICE\",\n      \"use_shipping_address\": false,\n      \"vat_country\": null,\n      \"vat_id\": \"\",\n      \"fulfillment_country\": null,\n      \"vat_option\": null,\n      \"file_format_config\": [\n        {\n          \"type\": \"xrechnung3_0_xml\"\n        },\n        {\n          \"type\": \"default\"\n        }\n      ]\n    },\n    {\n      \"address\": {\n        \"salutation\": \"<integer>\",\n        \"personal\": \"<boolean>\",\n        \"title\": \"<string>\",\n        \"first_name\": \"<string>\",\n        \"last_name\": \"<string>\",\n        \"suffix_1\": \"<string>\",\n        \"suffix_2\": \"<string>\",\n        \"company_name\": \"<string>\",\n        \"street\": \"<string>\",\n        \"zip_code\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"country\": \"<string>\"\n      },\n      \"attachment_ids\": [\n        \"<integer>\",\n        \"<integer>\"\n      ],\n      \"label_address\": {\n        \"salutation\": \"<integer>\",\n        \"personal\": \"<boolean>\",\n        \"title\": \"<string>\",\n        \"first_name\": \"<string>\",\n        \"last_name\": \"<string>\",\n        \"suffix_1\": \"<string>\",\n        \"suffix_2\": \"<string>\",\n        \"company_name\": \"<string>\",\n        \"street\": \"<string>\",\n        \"zip_code\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"country\": \"<string>\"\n      },\n      \"amount\": \"<integer>\",\n      \"amount_net\": \"<integer>\",\n      \"bank_debit_form\": null,\n      \"billing_country\": \"<string>\",\n      \"calc_vat_from\": 0,\n      \"cancel_id\": \"<long>\",\n      \"cash_allowance\": null,\n      \"cash_allowance_days\": null,\n      \"cash_allowance_text\": null,\n      \"contact_id\": null,\n      \"contact_label\": \"\",\n      \"contact_text\": \"\",\n      \"created_at\": \"<dateTime>\",\n      \"currency\": \"EUR\",\n      \"customer_id\": null,\n      \"customer_snapshot\": {\n        \"last_name\": \"<string>\",\n        \"company_name\": \"<string>\",\n        \"acquire_options\": 1,\n        \"additional_groups_ids\": [\n          \"<integer>\",\n          \"<integer>\"\n        ],\n        \"bank_account\": \"<string>\",\n        \"bank_account_owner\": \"<string>\",\n        \"bank_bic\": \"<string>\",\n        \"bank_code\": \"<string>\",\n        \"bank_iban\": \"<string>\",\n        \"bank_name\": \"<string>\",\n        \"birth_date\": \"<date>\",\n        \"cash_allowance\": \"<float>\",\n        \"cash_allowance_days\": 7,\n        \"cash_discount\": \"<float>\",\n        \"cash_discount_type\": \"PERCENT\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"country\": \"<string>\",\n        \"created_at\": \"<date>\",\n        \"updated_at\": \"<string>\",\n        \"delivery_title\": \"<string>\",\n        \"delivery_city\": \"<string>\",\n        \"delivery_state\": \"<string>\",\n        \"delivery_company_name\": \"<string>\",\n        \"delivery_country\": \"<string>\",\n        \"delivery_first_name\": \"<string>\",\n        \"delivery_last_name\": \"<string>\",\n        \"delivery_personal\": \"<boolean>\",\n        \"delivery_salutation\": 0,\n        \"delivery_street\": \"<string>\",\n        \"delivery_suffix_1\": \"<string>\",\n        \"delivery_suffix_2\": \"<string>\",\n        \"delivery_zip_code\": \"<string>\",\n        \"display_name\": \"<string>\",\n        \"emails\": [\n          \"<string>\",\n          \"<string>\"\n        ],\n        \"fax\": \"<string>\",\n        \"first_name\": \"<string>\",\n        \"grace_period\": \"<integer>\",\n        \"due_in_days\": \"<integer>\",\n        \"group_id\": \"<integer>\",\n        \"id\": \"<long>\",\n        \"info_1\": \"<string>\",\n        \"info_2\": \"<string>\",\n        \"internet\": \"<string>\",\n        \"login_id\": \"<long>\",\n        \"mobile\": \"<string>\",\n        \"note\": \"<string>\",\n        \"number\": \"<string>\",\n        \"payment_options\": 2,\n        \"personal\": false,\n        \"phone_1\": \"<string>\",\n        \"phone_2\": \"<string>\",\n        \"postbox\": \"<string>\",\n        \"postbox_city\": \"<string>\",\n        \"postbox_state\": \"<string>\",\n        \"postbox_country\": \"<string>\",\n        \"postbox_zip_code\": \"<string>\",\n        \"sale_price_level\": \"SALEPRICE8\",\n        \"salutation\": 0,\n        \"sepa_agreement\": \"COR1\",\n        \"sepa_agreement_date\": \"<date>\",\n        \"sepa_mandate_reference\": \"<string>\",\n        \"since_date\": \"<date>\",\n        \"street\": \"<string>\",\n        \"suffix_1\": \"<string>\",\n        \"suffix_2\": \"<string>\",\n        \"tax_number\": \"<string>\",\n        \"court\": \"<string>\",\n        \"court_registry_number\": \"<string>\",\n        \"tax_options\": \"nStbIm\",\n        \"title\": \"<string>\",\n        \"archived\": \"<boolean>\",\n        \"vat_identifier\": \"<string>\",\n        \"zip_code\": \"<string>\",\n        \"document_pdf_type\": \"default\",\n        \"buyer_reference\": \"<string>\",\n        \"foreign_supplier_number\": \"<string>\"\n      },\n      \"discount\": null,\n      \"discount_type\": null,\n      \"document_date\": \"<date>\",\n      \"due_date\": \"<date>\",\n      \"edited_at\": \"<dateTime>\",\n      \"external_id\": null,\n      \"replica_url\": null,\n      \"grace_period\": \"<integer>\",\n      \"due_in_days\": \"<integer>\",\n      \"id\": \"<long>\",\n      \"is_acceptable_on_public_domain\": false,\n      \"is_archive\": false,\n      \"is_draft\": \"<boolean>\",\n      \"is_replica\": false,\n      \"is_oss\": false,\n      \"item_notes\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"items\": [\n        {\n          \"number\": null,\n          \"description\": null,\n          \"document_note\": \"<string>\",\n          \"quantity\": 1,\n          \"quantity_str\": \"<string>\",\n          \"unit\": null,\n          \"type\": \"POSITION\",\n          \"position\": \"<integer>\",\n          \"single_price_net\": null,\n          \"single_price_gross\": \"<float>\",\n          \"vat_percent\": 0,\n          \"discount\": null,\n          \"discount_type\": null,\n          \"position_id\": null,\n          \"total_price_net\": \"<float>\",\n          \"total_price_gross\": \"<float>\",\n          \"total_vat\": \"<float>\",\n          \"serial_number_id\": \"<string>\",\n          \"serial_number\": \"<string>\",\n          \"booking_account\": null,\n          \"export_cost_1\": null,\n          \"export_cost_2\": null,\n          \"cost_price_net\": null,\n          \"cost_price_total\": \"<float>\",\n          \"cost_price_charge\": \"<float>\",\n          \"cost_price_charge_type\": \"AMOUNT\",\n          \"itemType\": \"UNDEFINED\",\n          \"id\": \"<long>\"\n        },\n        {\n          \"number\": null,\n          \"description\": null,\n          \"document_note\": \"<string>\",\n          \"quantity\": 1,\n          \"quantity_str\": \"<string>\",\n          \"unit\": null,\n          \"type\": \"POSITION\",\n          \"position\": \"<integer>\",\n          \"single_price_net\": null,\n          \"single_price_gross\": \"<float>\",\n          \"vat_percent\": 0,\n          \"discount\": null,\n          \"discount_type\": null,\n          \"position_id\": null,\n          \"total_price_net\": \"<float>\",\n          \"total_price_gross\": \"<float>\",\n          \"total_vat\": \"<float>\",\n          \"serial_number_id\": \"<string>\",\n          \"serial_number\": \"<string>\",\n          \"booking_account\": null,\n          \"export_cost_1\": null,\n          \"export_cost_2\": null,\n          \"cost_price_net\": null,\n          \"cost_price_total\": \"<float>\",\n          \"cost_price_charge\": \"<float>\",\n          \"cost_price_charge_type\": \"AMOUNT\",\n          \"itemType\": \"UNDEFINED\",\n          \"id\": \"<long>\"\n        }\n      ],\n      \"last_postbox_id\": \"<long>\",\n      \"login_id\": \"<long>\",\n      \"number\": null,\n      \"order_number\": \"\",\n      \"buyer_reference\": \"\",\n      \"paid_amount\": \"<integer>\",\n      \"paid_at\": \"<date>\",\n      \"pdf_pages\": \"<integer>\",\n      \"pdf_template\": \"<string>\",\n      \"project_id\": null,\n      \"recurring_options\": {\n        \"next_date\": \"<date>\",\n        \"frequency\": \"MONTHLY\",\n        \"frequency_special\": null,\n        \"interval\": 1,\n        \"end_date_or_count\": null,\n        \"status\": \"WAITING\",\n        \"as_draft\": false,\n        \"is_notify\": false,\n        \"send_as\": null,\n        \"is_sign\": false,\n        \"is_paid\": false,\n        \"paid_date_option\": \"created_date\",\n        \"is_sepa\": false,\n        \"sepa_local_instrument\": null,\n        \"sepa_sequence_type\": null,\n        \"sepa_reference\": null,\n        \"sepa_remittance_information\": null,\n        \"target_type\": \"INVOICE\"\n      },\n      \"ref_id\": null,\n      \"root_id\": null,\n      \"service_date\": {\n        \"type\": \"DEFAULT\",\n        \"date\": \"<date>\",\n        \"date_from\": \"<date>\",\n        \"date_to\": \"<date>\",\n        \"text\": null\n      },\n      \"shipping_country\": null,\n      \"status\": null,\n      \"text\": \"<string>\",\n      \"text_prefix\": \"<string>\",\n      \"text_tax\": null,\n      \"title\": null,\n      \"type\": \"INVOICE\",\n      \"use_shipping_address\": false,\n      \"vat_country\": null,\n      \"vat_id\": \"\",\n      \"fulfillment_country\": null,\n      \"vat_option\": null,\n      \"file_format_config\": [\n        {\n          \"type\": \"default_without_stationery\"\n        },\n        {\n          \"type\": \"zugferd2_2\"\n        }\n      ]\n    }\n  ]\n}"
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/documents?limit=<integer>&page=<integer>&type=REMINDER&is_draft=0&is_archive=0&customer_id=<string>&project_id=<string>&ref_id=<string>&document_date=<string>&paid_at=<string>&title=<string>&number=<string>&cancel_id=<string>&fulfillment_country=<string>&vat_country=<string>&shipping_country=<string>&status=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "documents"
          ],
          "query": [
            {
              "key": "limit",
              "value": "<integer>",
              "description": "Limited the result. Default is 100. Maximum can be 1000."
            },
            {
              "key": "page",
              "value": "<integer>",
              "description": "Set current Page. Default is 1."
            },
            {
              "key": "type",
              "value": "REMINDER",
              "description": "Filter documents by type. Multiple typs seperate with , like type=INVOICE,CREDIT."
            },
            {
              "key": "is_draft",
              "value": "0",
              "description": "Filter documents by draft flag."
            },
            {
              "key": "is_archive",
              "value": "0",
              "description": "Filter documents by archive flag."
            },
            {
              "key": "customer_id",
              "value": "<string>",
              "description": "Filter documents by customer_id. You can add multiple customer_is separate by comma like id,id,id."
            },
            {
              "key": "project_id",
              "value": "<string>",
              "description": "Filter documents by project_id. You can add multiple project_id separate by comma like id,id,id."
            },
            {
              "key": "ref_id",
              "value": "<string>",
              "description": "Filter documents by ref_id."
            },
            {
              "key": "document_date",
              "value": "<string>",
              "description": "Filter documents by document_date. You can filter one date with document_date=2014-12-10 or between like 2015-01-01,2015-12-31."
            },
            {
              "key": "paid_at",
              "value": "<string>",
              "description": "Filter documents by paid_at. You can filter one date with paid_at=2014-12-10 or between like 2015-01-01,2015-12-31. With paid_at=null you get all unpaid documents."
            },
            {
              "key": "title",
              "value": "<string>",
              "description": "Filter documents by title."
            },
            {
              "key": "number",
              "value": "<string>",
              "description": "Filter documents by number."
            },
            {
              "key": "cancel_id",
              "value": "<string>",
              "description": "Filter documents by cancel_id. You can add multiple ids separate by comma like id,id,id. With cancel_id=null you get all not canceled documents."
            },
            {
              "key": "fulfillment_country",
              "value": "<string>",
              "description": "Filter documents by fulfillment_country."
            },
            {
              "key": "vat_country",
              "value": "<string>",
              "description": "Filter documents by vat_country."
            },
            {
              "key": "shipping_country",
              "value": "<string>",
              "description": "Filter documents by shipping_country."
            },
            {
              "key": "status",
              "value": "<string>",
              "description": "Filter documents by status. Keep in mind that not every document type has a status."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}