Foxpro / easybill REST API / To complete a document.
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL loDate_from
LOCAL loDate_to
LOCAL lcStrVal
LOCAL lcDescription
LOCAL lcDocument_note
LOCAL lnQuantity
LOCAL lcQuantity_str
LOCAL lcUnit
LOCAL lcPosition
LOCAL lcSingle_price_net
LOCAL lcSingle_price_gross
LOCAL lnVat_percent
LOCAL lcPosition_id
LOCAL lcTotal_price_net
LOCAL lcTotal_price_gross
LOCAL lcTotal_vat
LOCAL lcSerial_number_id
LOCAL lcSerial_number
LOCAL lcBooking_account
LOCAL lcExport_cost_1
LOCAL lcExport_cost_2
LOCAL lcCost_price_net
LOCAL lcCost_price_total
LOCAL lcCost_price_charge
LOCAL lcCost_price_charge_type
LOCAL lcItemType
LOCAL lcSalutation
LOCAL lcPersonal
LOCAL lcTitle
LOCAL lcFirst_name
LOCAL lcLast_name
LOCAL lcSuffix_1
LOCAL lcSuffix_2
LOCAL lcCompany_name
LOCAL lcStreet
LOCAL lcZip_code
LOCAL lcCity
LOCAL lcState
LOCAL lcCountry
LOCAL lcLabel_addressSalutation
LOCAL lcLabel_addressPersonal
LOCAL lcLabel_addressTitle
LOCAL lcLabel_addressFirst_name
LOCAL lcLabel_addressLast_name
LOCAL lcLabel_addressSuffix_1
LOCAL lcLabel_addressSuffix_2
LOCAL lcLabel_addressCompany_name
LOCAL lcLabel_addressStreet
LOCAL lcLabel_addressZip_code
LOCAL lcLabel_addressCity
LOCAL lcLabel_addressState
LOCAL lcLabel_addressCountry
LOCAL lcAmount
LOCAL lcAmount_net
LOCAL lcBank_debit_form
LOCAL lcBilling_country
LOCAL lnCalc_vat_from
LOCAL lcCancel_id
LOCAL lcCash_allowance
LOCAL lcCash_allowance_days
LOCAL lcCash_allowance_text
LOCAL lcContact_id
LOCAL lcContact_label
LOCAL lcContact_text
LOCAL lcCreated_at
LOCAL lcV_currency
LOCAL lcCustomer_id
LOCAL lcCustomer_snapshotLast_name
LOCAL lcCustomer_snapshotCompany_name
LOCAL lnAcquire_options
LOCAL lcBank_account
LOCAL lcBank_account_owner
LOCAL lcBank_bic
LOCAL lcBank_code
LOCAL lcBank_iban
LOCAL lcBank_name
LOCAL lcBirth_date
LOCAL lcCash_allowance
LOCAL lnCash_allowance_days
LOCAL lcCash_discount
LOCAL lcCash_discount_type
LOCAL lcCustomer_snapshotCity
LOCAL lcCustomer_snapshotState
LOCAL lcCustomer_snapshotCountry
LOCAL lcCreated_at
LOCAL lcUpdated_at
LOCAL lcDelivery_title
LOCAL lcDelivery_city
LOCAL lcDelivery_state
LOCAL lcDelivery_company_name
LOCAL lcDelivery_country
LOCAL lcDelivery_first_name
LOCAL lcDelivery_last_name
LOCAL lcDelivery_personal
LOCAL lnDelivery_salutation
LOCAL lcDelivery_street
LOCAL lcDelivery_suffix_1
LOCAL lcDelivery_suffix_2
LOCAL lcDelivery_zip_code
LOCAL lcDisplay_name
LOCAL lcFax
LOCAL lcCustomer_snapshotFirst_name
LOCAL lcGrace_period
LOCAL lcDue_in_days
LOCAL lcGroup_id
LOCAL lcId
LOCAL lcInfo_1
LOCAL lcInfo_2
LOCAL lcInternet
LOCAL lcLogin_id
LOCAL lcMobile
LOCAL lcNote
LOCAL lcV_Number
LOCAL lnPayment_options
LOCAL lnCustomer_snapshotPersonal
LOCAL lcPhone_1
LOCAL lcPhone_2
LOCAL lcPostbox
LOCAL lcPostbox_city
LOCAL lcPostbox_state
LOCAL lcPostbox_country
LOCAL lcPostbox_zip_code
LOCAL lcSale_price_level
LOCAL lnCustomer_snapshotSalutation
LOCAL lcSepa_agreement
LOCAL lcSepa_agreement_date
LOCAL lcSepa_mandate_reference
LOCAL lcSince_date
LOCAL lcCustomer_snapshotStreet
LOCAL lcCustomer_snapshotSuffix_1
LOCAL lcCustomer_snapshotSuffix_2
LOCAL lcTax_number
LOCAL lcCourt
LOCAL lcCourt_registry_number
LOCAL lcTax_options
LOCAL lcCustomer_snapshotTitle
LOCAL lcArchived
LOCAL lcVat_identifier
LOCAL lcCustomer_snapshotZip_code
LOCAL lcDocument_pdf_type
LOCAL lcBuyer_reference
LOCAL lcForeign_supplier_number
LOCAL lcDiscount
LOCAL lcDiscount_type
LOCAL lcDocument_date
LOCAL lcDue_date
LOCAL lcEdited_at
LOCAL lcExternal_id
LOCAL lcReplica_url
LOCAL lcGrace_period
LOCAL lcDue_in_days
LOCAL lcId
LOCAL lnIs_acceptable_on_public_domain
LOCAL lnIs_archive
LOCAL lcIs_draft
LOCAL lnIs_replica
LOCAL lnIs_oss
LOCAL lcLast_postbox_id
LOCAL lcLogin_id
LOCAL lcV_number
LOCAL lcOrder_number
LOCAL lcBuyer_reference
LOCAL lcPaid_amount
LOCAL lcPaid_at
LOCAL lcPdf_pages
LOCAL lcPdf_template
LOCAL lcProject_id
LOCAL lcNext_date
LOCAL lcFrequency
LOCAL lcFrequency_special
LOCAL lnInterval
LOCAL lcEnd_date_or_count
LOCAL lcStatus
LOCAL lnAs_draft
LOCAL lnIs_notify
LOCAL lcSend_as
LOCAL lnIs_sign
LOCAL lnIs_paid
LOCAL lcPaid_date_option
LOCAL lnIs_sepa
LOCAL lcSepa_local_instrument
LOCAL lcSepa_sequence_type
LOCAL lcSepa_reference
LOCAL lcSepa_remittance_information
LOCAL lcTarget_type
LOCAL lcRef_id
LOCAL lcRoot_id
LOCAL lcV_Type
LOCAL lcDate
LOCAL lcText
LOCAL lcShipping_country
LOCAL lcStatus
LOCAL lcText
LOCAL lcText_prefix
LOCAL lcText_tax
LOCAL lcTitle
LOCAL lcV_type
LOCAL lnUse_shipping_address
LOCAL lcVat_country
LOCAL lcVat_id
LOCAL lcFulfillment_country
LOCAL lcVat_option
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.SetRequestHeader("Authorization","{{apiKey}}")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequest("PUT","https://api.easybill.de/rest/v1/documents/:id/done?reason_for_change=<string>")
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "address": {
* "salutation": "<integer>",
* "personal": "<boolean>",
* "title": "<string>",
* "first_name": "<string>",
* "last_name": "<string>",
* "suffix_1": "<string>",
* "suffix_2": "<string>",
* "company_name": "<string>",
* "street": "<string>",
* "zip_code": "<string>",
* "city": "<string>",
* "state": "<string>",
* "country": "<string>"
* },
* "attachment_ids": [
* "<integer>",
* "<integer>"
* ],
* "label_address": {
* "salutation": "<integer>",
* "personal": "<boolean>",
* "title": "<string>",
* "first_name": "<string>",
* "last_name": "<string>",
* "suffix_1": "<string>",
* "suffix_2": "<string>",
* "company_name": "<string>",
* "street": "<string>",
* "zip_code": "<string>",
* "city": "<string>",
* "state": "<string>",
* "country": "<string>"
* },
* "amount": "<integer>",
* "amount_net": "<integer>",
* "bank_debit_form": null,
* "billing_country": "<string>",
* "calc_vat_from": 0,
* "cancel_id": "<long>",
* "cash_allowance": null,
* "cash_allowance_days": null,
* "cash_allowance_text": null,
* "contact_id": null,
* "contact_label": "",
* "contact_text": "",
* "created_at": "<dateTime>",
* "currency": "EUR",
* "customer_id": null,
* "customer_snapshot": {
* "last_name": "<string>",
* "company_name": "<string>",
* "acquire_options": 2,
* "additional_groups_ids": [
* "<integer>",
* "<integer>"
* ],
* "bank_account": "<string>",
* "bank_account_owner": "<string>",
* "bank_bic": "<string>",
* "bank_code": "<string>",
* "bank_iban": "<string>",
* "bank_name": "<string>",
* "birth_date": "<date>",
* "cash_allowance": "<float>",
* "cash_allowance_days": 7,
* "cash_discount": "<float>",
* "cash_discount_type": "AMOUNT",
* "city": "<string>",
* "state": "<string>",
* "country": "<string>",
* "created_at": "<date>",
* "updated_at": "<string>",
* "delivery_title": "<string>",
* "delivery_city": "<string>",
* "delivery_state": "<string>",
* "delivery_company_name": "<string>",
* "delivery_country": "<string>",
* "delivery_first_name": "<string>",
* "delivery_last_name": "<string>",
* "delivery_personal": "<boolean>",
* "delivery_salutation": 0,
* "delivery_street": "<string>",
* "delivery_suffix_1": "<string>",
* "delivery_suffix_2": "<string>",
* "delivery_zip_code": "<string>",
* "display_name": "<string>",
* "emails": [
* "<string>",
* "<string>"
* ],
* "fax": "<string>",
* "first_name": "<string>",
* "grace_period": "<integer>",
* "due_in_days": "<integer>",
* "group_id": "<integer>",
* "id": "<long>",
* "info_1": "<string>",
* "info_2": "<string>",
* "internet": "<string>",
* "login_id": "<long>",
* "mobile": "<string>",
* "note": "<string>",
* "number": "<string>",
* "payment_options": 1,
* "personal": false,
* "phone_1": "<string>",
* "phone_2": "<string>",
* "postbox": "<string>",
* "postbox_city": "<string>",
* "postbox_state": "<string>",
* "postbox_country": "<string>",
* "postbox_zip_code": "<string>",
* "sale_price_level": "SALEPRICE6",
* "salutation": 0,
* "sepa_agreement": "BASIC",
* "sepa_agreement_date": "<date>",
* "sepa_mandate_reference": "<string>",
* "since_date": "<date>",
* "street": "<string>",
* "suffix_1": "<string>",
* "suffix_2": "<string>",
* "tax_number": "<string>",
* "court": "<string>",
* "court_registry_number": "<string>",
* "tax_options": "nStbIm",
* "title": "<string>",
* "archived": "<boolean>",
* "vat_identifier": "<string>",
* "zip_code": "<string>",
* "document_pdf_type": "default",
* "buyer_reference": "<string>",
* "foreign_supplier_number": "<string>"
* },
* "discount": null,
* "discount_type": null,
* "document_date": "<date>",
* "due_date": "<date>",
* "edited_at": "<dateTime>",
* "external_id": null,
* "replica_url": null,
* "grace_period": "<integer>",
* "due_in_days": "<integer>",
* "id": "<long>",
* "is_acceptable_on_public_domain": false,
* "is_archive": false,
* "is_draft": "<boolean>",
* "is_replica": false,
* "is_oss": false,
* "item_notes": [
* "<string>",
* "<string>"
* ],
* "items": [
* {
* "number": null,
* "description": null,
* "document_note": "<string>",
* "quantity": 1,
* "quantity_str": "<string>",
* "unit": null,
* "type": "POSITION",
* "position": "<integer>",
* "single_price_net": null,
* "single_price_gross": "<float>",
* "vat_percent": 0,
* "discount": null,
* "discount_type": null,
* "position_id": null,
* "total_price_net": "<float>",
* "total_price_gross": "<float>",
* "total_vat": "<float>",
* "serial_number_id": "<string>",
* "serial_number": "<string>",
* "booking_account": null,
* "export_cost_1": null,
* "export_cost_2": null,
* "cost_price_net": null,
* "cost_price_total": "<float>",
* "cost_price_charge": "<float>",
* "cost_price_charge_type": "PERCENT",
* "itemType": "UNDEFINED",
* "id": "<long>"
* },
* {
* "number": null,
* "description": null,
* "document_note": "<string>",
* "quantity": 1,
* "quantity_str": "<string>",
* "unit": null,
* "type": "POSITION",
* "position": "<integer>",
* "single_price_net": null,
* "single_price_gross": "<float>",
* "vat_percent": 0,
* "discount": null,
* "discount_type": null,
* "position_id": null,
* "total_price_net": "<float>",
* "total_price_gross": "<float>",
* "total_vat": "<float>",
* "serial_number_id": "<string>",
* "serial_number": "<string>",
* "booking_account": null,
* "export_cost_1": null,
* "export_cost_2": null,
* "cost_price_net": null,
* "cost_price_total": "<float>",
* "cost_price_charge": "<float>",
* "cost_price_charge_type": "PERCENT",
* "itemType": "UNDEFINED",
* "id": "<long>"
* }
* ],
* "last_postbox_id": "<long>",
* "login_id": "<long>",
* "number": null,
* "order_number": "",
* "buyer_reference": "",
* "paid_amount": "<integer>",
* "paid_at": "<date>",
* "pdf_pages": "<integer>",
* "pdf_template": "<string>",
* "project_id": null,
* "recurring_options": {
* "next_date": "<date>",
* "frequency": "MONTHLY",
* "frequency_special": null,
* "interval": 1,
* "end_date_or_count": null,
* "status": "WAITING",
* "as_draft": false,
* "is_notify": false,
* "send_as": null,
* "is_sign": false,
* "is_paid": false,
* "paid_date_option": "created_date",
* "is_sepa": false,
* "sepa_local_instrument": null,
* "sepa_sequence_type": null,
* "sepa_reference": null,
* "sepa_remittance_information": null,
* "target_type": "INVOICE"
* },
* "ref_id": null,
* "root_id": null,
* "service_date": {
* "type": "SERVICE",
* "date": "<date>",
* "date_from": "<date>",
* "date_to": "<date>",
* "text": null
* },
* "shipping_country": null,
* "status": null,
* "text": "<string>",
* "text_prefix": "<string>",
* "text_tax": null,
* "title": null,
* "type": "INVOICE",
* "use_shipping_address": false,
* "vat_country": null,
* "vat_id": "",
* "fulfillment_country": null,
* "vat_option": null,
* "file_format_config": [
* {
* "type": "xrechnung2_2_xml"
* },
* {
* "type": "xrechnung3_0_xml"
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.DtObj')
loDate_from = CreateObject('Chilkat.DtObj')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.DtObj')
loDate_to = CreateObject('Chilkat.DtObj')
lcSalutation = loJResp.StringOf("address.salutation")
lcPersonal = loJResp.StringOf("address.personal")
lcTitle = loJResp.StringOf("address.title")
lcFirst_name = loJResp.StringOf("address.first_name")
lcLast_name = loJResp.StringOf("address.last_name")
lcSuffix_1 = loJResp.StringOf("address.suffix_1")
lcSuffix_2 = loJResp.StringOf("address.suffix_2")
lcCompany_name = loJResp.StringOf("address.company_name")
lcStreet = loJResp.StringOf("address.street")
lcZip_code = loJResp.StringOf("address.zip_code")
lcCity = loJResp.StringOf("address.city")
lcState = loJResp.StringOf("address.state")
lcCountry = loJResp.StringOf("address.country")
lcLabel_addressSalutation = loJResp.StringOf("label_address.salutation")
lcLabel_addressPersonal = loJResp.StringOf("label_address.personal")
lcLabel_addressTitle = loJResp.StringOf("label_address.title")
lcLabel_addressFirst_name = loJResp.StringOf("label_address.first_name")
lcLabel_addressLast_name = loJResp.StringOf("label_address.last_name")
lcLabel_addressSuffix_1 = loJResp.StringOf("label_address.suffix_1")
lcLabel_addressSuffix_2 = loJResp.StringOf("label_address.suffix_2")
lcLabel_addressCompany_name = loJResp.StringOf("label_address.company_name")
lcLabel_addressStreet = loJResp.StringOf("label_address.street")
lcLabel_addressZip_code = loJResp.StringOf("label_address.zip_code")
lcLabel_addressCity = loJResp.StringOf("label_address.city")
lcLabel_addressState = loJResp.StringOf("label_address.state")
lcLabel_addressCountry = loJResp.StringOf("label_address.country")
lcAmount = loJResp.StringOf("amount")
lcAmount_net = loJResp.StringOf("amount_net")
lcBank_debit_form = loJResp.StringOf("bank_debit_form")
lcBilling_country = loJResp.StringOf("billing_country")
lnCalc_vat_from = loJResp.IntOf("calc_vat_from")
lcCancel_id = loJResp.StringOf("cancel_id")
lcCash_allowance = loJResp.StringOf("cash_allowance")
lcCash_allowance_days = loJResp.StringOf("cash_allowance_days")
lcCash_allowance_text = loJResp.StringOf("cash_allowance_text")
lcContact_id = loJResp.StringOf("contact_id")
lcContact_label = loJResp.StringOf("contact_label")
lcContact_text = loJResp.StringOf("contact_text")
lcCreated_at = loJResp.StringOf("created_at")
lcV_currency = loJResp.StringOf("currency")
lcCustomer_id = loJResp.StringOf("customer_id")
lcCustomer_snapshotLast_name = loJResp.StringOf("customer_snapshot.last_name")
lcCustomer_snapshotCompany_name = loJResp.StringOf("customer_snapshot.company_name")
lnAcquire_options = loJResp.IntOf("customer_snapshot.acquire_options")
lcBank_account = loJResp.StringOf("customer_snapshot.bank_account")
lcBank_account_owner = loJResp.StringOf("customer_snapshot.bank_account_owner")
lcBank_bic = loJResp.StringOf("customer_snapshot.bank_bic")
lcBank_code = loJResp.StringOf("customer_snapshot.bank_code")
lcBank_iban = loJResp.StringOf("customer_snapshot.bank_iban")
lcBank_name = loJResp.StringOf("customer_snapshot.bank_name")
lcBirth_date = loJResp.StringOf("customer_snapshot.birth_date")
lcCash_allowance = loJResp.StringOf("customer_snapshot.cash_allowance")
lnCash_allowance_days = loJResp.IntOf("customer_snapshot.cash_allowance_days")
lcCash_discount = loJResp.StringOf("customer_snapshot.cash_discount")
lcCash_discount_type = loJResp.StringOf("customer_snapshot.cash_discount_type")
lcCustomer_snapshotCity = loJResp.StringOf("customer_snapshot.city")
lcCustomer_snapshotState = loJResp.StringOf("customer_snapshot.state")
lcCustomer_snapshotCountry = loJResp.StringOf("customer_snapshot.country")
lcCreated_at = loJResp.StringOf("customer_snapshot.created_at")
lcUpdated_at = loJResp.StringOf("customer_snapshot.updated_at")
lcDelivery_title = loJResp.StringOf("customer_snapshot.delivery_title")
lcDelivery_city = loJResp.StringOf("customer_snapshot.delivery_city")
lcDelivery_state = loJResp.StringOf("customer_snapshot.delivery_state")
lcDelivery_company_name = loJResp.StringOf("customer_snapshot.delivery_company_name")
lcDelivery_country = loJResp.StringOf("customer_snapshot.delivery_country")
lcDelivery_first_name = loJResp.StringOf("customer_snapshot.delivery_first_name")
lcDelivery_last_name = loJResp.StringOf("customer_snapshot.delivery_last_name")
lcDelivery_personal = loJResp.StringOf("customer_snapshot.delivery_personal")
lnDelivery_salutation = loJResp.IntOf("customer_snapshot.delivery_salutation")
lcDelivery_street = loJResp.StringOf("customer_snapshot.delivery_street")
lcDelivery_suffix_1 = loJResp.StringOf("customer_snapshot.delivery_suffix_1")
lcDelivery_suffix_2 = loJResp.StringOf("customer_snapshot.delivery_suffix_2")
lcDelivery_zip_code = loJResp.StringOf("customer_snapshot.delivery_zip_code")
lcDisplay_name = loJResp.StringOf("customer_snapshot.display_name")
lcFax = loJResp.StringOf("customer_snapshot.fax")
lcCustomer_snapshotFirst_name = loJResp.StringOf("customer_snapshot.first_name")
lcGrace_period = loJResp.StringOf("customer_snapshot.grace_period")
lcDue_in_days = loJResp.StringOf("customer_snapshot.due_in_days")
lcGroup_id = loJResp.StringOf("customer_snapshot.group_id")
lcId = loJResp.StringOf("customer_snapshot.id")
lcInfo_1 = loJResp.StringOf("customer_snapshot.info_1")
lcInfo_2 = loJResp.StringOf("customer_snapshot.info_2")
lcInternet = loJResp.StringOf("customer_snapshot.internet")
lcLogin_id = loJResp.StringOf("customer_snapshot.login_id")
lcMobile = loJResp.StringOf("customer_snapshot.mobile")
lcNote = loJResp.StringOf("customer_snapshot.note")
lcV_Number = loJResp.StringOf("customer_snapshot.number")
lnPayment_options = loJResp.IntOf("customer_snapshot.payment_options")
lnCustomer_snapshotPersonal = loJResp.BoolOf("customer_snapshot.personal")
lcPhone_1 = loJResp.StringOf("customer_snapshot.phone_1")
lcPhone_2 = loJResp.StringOf("customer_snapshot.phone_2")
lcPostbox = loJResp.StringOf("customer_snapshot.postbox")
lcPostbox_city = loJResp.StringOf("customer_snapshot.postbox_city")
lcPostbox_state = loJResp.StringOf("customer_snapshot.postbox_state")
lcPostbox_country = loJResp.StringOf("customer_snapshot.postbox_country")
lcPostbox_zip_code = loJResp.StringOf("customer_snapshot.postbox_zip_code")
lcSale_price_level = loJResp.StringOf("customer_snapshot.sale_price_level")
lnCustomer_snapshotSalutation = loJResp.IntOf("customer_snapshot.salutation")
lcSepa_agreement = loJResp.StringOf("customer_snapshot.sepa_agreement")
lcSepa_agreement_date = loJResp.StringOf("customer_snapshot.sepa_agreement_date")
lcSepa_mandate_reference = loJResp.StringOf("customer_snapshot.sepa_mandate_reference")
lcSince_date = loJResp.StringOf("customer_snapshot.since_date")
lcCustomer_snapshotStreet = loJResp.StringOf("customer_snapshot.street")
lcCustomer_snapshotSuffix_1 = loJResp.StringOf("customer_snapshot.suffix_1")
lcCustomer_snapshotSuffix_2 = loJResp.StringOf("customer_snapshot.suffix_2")
lcTax_number = loJResp.StringOf("customer_snapshot.tax_number")
lcCourt = loJResp.StringOf("customer_snapshot.court")
lcCourt_registry_number = loJResp.StringOf("customer_snapshot.court_registry_number")
lcTax_options = loJResp.StringOf("customer_snapshot.tax_options")
lcCustomer_snapshotTitle = loJResp.StringOf("customer_snapshot.title")
lcArchived = loJResp.StringOf("customer_snapshot.archived")
lcVat_identifier = loJResp.StringOf("customer_snapshot.vat_identifier")
lcCustomer_snapshotZip_code = loJResp.StringOf("customer_snapshot.zip_code")
lcDocument_pdf_type = loJResp.StringOf("customer_snapshot.document_pdf_type")
lcBuyer_reference = loJResp.StringOf("customer_snapshot.buyer_reference")
lcForeign_supplier_number = loJResp.StringOf("customer_snapshot.foreign_supplier_number")
lcDiscount = loJResp.StringOf("discount")
lcDiscount_type = loJResp.StringOf("discount_type")
lcDocument_date = loJResp.StringOf("document_date")
lcDue_date = loJResp.StringOf("due_date")
lcEdited_at = loJResp.StringOf("edited_at")
lcExternal_id = loJResp.StringOf("external_id")
lcReplica_url = loJResp.StringOf("replica_url")
lcGrace_period = loJResp.StringOf("grace_period")
lcDue_in_days = loJResp.StringOf("due_in_days")
lcId = loJResp.StringOf("id")
lnIs_acceptable_on_public_domain = loJResp.BoolOf("is_acceptable_on_public_domain")
lnIs_archive = loJResp.BoolOf("is_archive")
lcIs_draft = loJResp.StringOf("is_draft")
lnIs_replica = loJResp.BoolOf("is_replica")
lnIs_oss = loJResp.BoolOf("is_oss")
lcLast_postbox_id = loJResp.StringOf("last_postbox_id")
lcLogin_id = loJResp.StringOf("login_id")
lcV_number = loJResp.StringOf("number")
lcOrder_number = loJResp.StringOf("order_number")
lcBuyer_reference = loJResp.StringOf("buyer_reference")
lcPaid_amount = loJResp.StringOf("paid_amount")
lcPaid_at = loJResp.StringOf("paid_at")
lcPdf_pages = loJResp.StringOf("pdf_pages")
lcPdf_template = loJResp.StringOf("pdf_template")
lcProject_id = loJResp.StringOf("project_id")
lcNext_date = loJResp.StringOf("recurring_options.next_date")
lcFrequency = loJResp.StringOf("recurring_options.frequency")
lcFrequency_special = loJResp.StringOf("recurring_options.frequency_special")
lnInterval = loJResp.IntOf("recurring_options.interval")
lcEnd_date_or_count = loJResp.StringOf("recurring_options.end_date_or_count")
lcStatus = loJResp.StringOf("recurring_options.status")
lnAs_draft = loJResp.BoolOf("recurring_options.as_draft")
lnIs_notify = loJResp.BoolOf("recurring_options.is_notify")
lcSend_as = loJResp.StringOf("recurring_options.send_as")
lnIs_sign = loJResp.BoolOf("recurring_options.is_sign")
lnIs_paid = loJResp.BoolOf("recurring_options.is_paid")
lcPaid_date_option = loJResp.StringOf("recurring_options.paid_date_option")
lnIs_sepa = loJResp.BoolOf("recurring_options.is_sepa")
lcSepa_local_instrument = loJResp.StringOf("recurring_options.sepa_local_instrument")
lcSepa_sequence_type = loJResp.StringOf("recurring_options.sepa_sequence_type")
lcSepa_reference = loJResp.StringOf("recurring_options.sepa_reference")
lcSepa_remittance_information = loJResp.StringOf("recurring_options.sepa_remittance_information")
lcTarget_type = loJResp.StringOf("recurring_options.target_type")
lcRef_id = loJResp.StringOf("ref_id")
lcRoot_id = loJResp.StringOf("root_id")
lcV_Type = loJResp.StringOf("service_date.type")
lcDate = loJResp.StringOf("service_date.date")
loJResp.DtOf("service_date.date_from",0,loDate_from)
loJResp.DtOf("service_date.date_to",0,loDate_to)
lcText = loJResp.StringOf("service_date.text")
lcShipping_country = loJResp.StringOf("shipping_country")
lcStatus = loJResp.StringOf("status")
lcText = loJResp.StringOf("text")
lcText_prefix = loJResp.StringOf("text_prefix")
lcText_tax = loJResp.StringOf("text_tax")
lcTitle = loJResp.StringOf("title")
lcV_type = loJResp.StringOf("type")
lnUse_shipping_address = loJResp.BoolOf("use_shipping_address")
lcVat_country = loJResp.StringOf("vat_country")
lcVat_id = loJResp.StringOf("vat_id")
lcFulfillment_country = loJResp.StringOf("fulfillment_country")
lcVat_option = loJResp.StringOf("vat_option")
i = 0
lnCount_i = loJResp.SizeOfArray("attachment_ids")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("attachment_ids[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("customer_snapshot.additional_groups_ids")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("customer_snapshot.additional_groups_ids[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("customer_snapshot.emails")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("customer_snapshot.emails[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("item_notes")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("item_notes[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("items")
DO WHILE i < lnCount_i
loJResp.I = i
lcV_number = loJResp.StringOf("items[i].number")
lcDescription = loJResp.StringOf("items[i].description")
lcDocument_note = loJResp.StringOf("items[i].document_note")
lnQuantity = loJResp.IntOf("items[i].quantity")
lcQuantity_str = loJResp.StringOf("items[i].quantity_str")
lcUnit = loJResp.StringOf("items[i].unit")
lcV_type = loJResp.StringOf("items[i].type")
lcPosition = loJResp.StringOf("items[i].position")
lcSingle_price_net = loJResp.StringOf("items[i].single_price_net")
lcSingle_price_gross = loJResp.StringOf("items[i].single_price_gross")
lnVat_percent = loJResp.IntOf("items[i].vat_percent")
lcDiscount = loJResp.StringOf("items[i].discount")
lcDiscount_type = loJResp.StringOf("items[i].discount_type")
lcPosition_id = loJResp.StringOf("items[i].position_id")
lcTotal_price_net = loJResp.StringOf("items[i].total_price_net")
lcTotal_price_gross = loJResp.StringOf("items[i].total_price_gross")
lcTotal_vat = loJResp.StringOf("items[i].total_vat")
lcSerial_number_id = loJResp.StringOf("items[i].serial_number_id")
lcSerial_number = loJResp.StringOf("items[i].serial_number")
lcBooking_account = loJResp.StringOf("items[i].booking_account")
lcExport_cost_1 = loJResp.StringOf("items[i].export_cost_1")
lcExport_cost_2 = loJResp.StringOf("items[i].export_cost_2")
lcCost_price_net = loJResp.StringOf("items[i].cost_price_net")
lcCost_price_total = loJResp.StringOf("items[i].cost_price_total")
lcCost_price_charge = loJResp.StringOf("items[i].cost_price_charge")
lcCost_price_charge_type = loJResp.StringOf("items[i].cost_price_charge_type")
lcItemType = loJResp.StringOf("items[i].itemType")
lcId = loJResp.StringOf("items[i].id")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("file_format_config")
DO WHILE i < lnCount_i
loJResp.I = i
lcV_type = loJResp.StringOf("file_format_config[i].type")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
RELEASE loDate_from
RELEASE loDate_to
Curl Command
curl -X PUT
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/documents/:id/done?reason_for_change=<string>
Postman Collection Item JSON
{
"name": "To complete a document.",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/documents/:id/done?reason_for_change=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id",
"done"
],
"query": [
{
"key": "reason_for_change",
"value": "<string>",
"description": "A string that is saved on the document version as reason."
}
],
"variable": [
{
"key": "id",
"value": "<long>",
"description": "(Required) ID of document"
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/documents/:id/done?reason_for_change=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id",
"done"
],
"query": [
{
"key": "reason_for_change",
"value": "<string>",
"description": "A string that is saved on the document version as reason."
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\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\": \"SALEPRICE6\",\n \"salutation\": 0,\n \"sepa_agreement\": \"BASIC\",\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\": \"PERCENT\",\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\": \"PERCENT\",\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\": \"SERVICE\",\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\": \"xrechnung2_2_xml\"\n },\n {\n \"type\": \"xrechnung3_0_xml\"\n }\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/documents/:id/done?reason_for_change=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id",
"done"
],
"query": [
{
"key": "reason_for_change",
"value": "<string>",
"description": "A string that is saved on the document version as reason."
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Resource is locked. This status is returned if a process is currently running which locks the requested resource. Try again later.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/documents/:id/done?reason_for_change=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id",
"done"
],
"query": [
{
"key": "reason_for_change",
"value": "<string>",
"description": "A string that is saved on the document version as reason."
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/documents/:id/done?reason_for_change=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id",
"done"
],
"query": [
{
"key": "reason_for_change",
"value": "<string>",
"description": "A string that is saved on the document version as reason."
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
