DataFlex / easybill REST API / Convert an existing document to one of a different type
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
Variant vDate_from
Handle hoDate_from
Variant vDate_to
Handle hoDate_to
String sStrVal
String sDescription
String sDocument_note
Integer iQuantity
String sQuantity_str
String sUnit
String sPosition
String sSingle_price_net
String sSingle_price_gross
Integer iVat_percent
String sPosition_id
String sTotal_price_net
String sTotal_price_gross
String sTotal_vat
String sSerial_number_id
String sSerial_number
String sBooking_account
String sExport_cost_1
String sExport_cost_2
String sCost_price_net
String sCost_price_total
String sCost_price_charge
String sCost_price_charge_type
String sItemType
String sSalutation
String sPersonal
String sTitle
String sFirst_name
String sLast_name
String sSuffix_1
String sSuffix_2
String sCompany_name
String sStreet
String sZip_code
String sCity
String sState
String sCountry
String sLabel_addressSalutation
String sLabel_addressPersonal
String sLabel_addressTitle
String sLabel_addressFirst_name
String sLabel_addressLast_name
String sLabel_addressSuffix_1
String sLabel_addressSuffix_2
String sLabel_addressCompany_name
String sLabel_addressStreet
String sLabel_addressZip_code
String sLabel_addressCity
String sLabel_addressState
String sLabel_addressCountry
String sAmount
String sAmount_net
String sBank_debit_form
String sBilling_country
Integer iCalc_vat_from
String sCancel_id
String sCash_allowance
String sCash_allowance_days
String sCash_allowance_text
String sContact_id
String sContact_label
String sContact_text
String sCreated_at
String sV_currency
String sCustomer_id
String sCustomer_snapshotLast_name
String sCustomer_snapshotCompany_name
Integer iAcquire_options
String sBank_account
String sBank_account_owner
String sBank_bic
String sBank_code
String sBank_iban
String sBank_name
String sBirth_date
String sCash_allowance
Integer iCash_allowance_days
String sCash_discount
String sCash_discount_type
String sCustomer_snapshotCity
String sCustomer_snapshotState
String sCustomer_snapshotCountry
String sCreated_at
String sUpdated_at
String sDelivery_title
String sDelivery_city
String sDelivery_state
String sDelivery_company_name
String sDelivery_country
String sDelivery_first_name
String sDelivery_last_name
String sDelivery_personal
Integer iDelivery_salutation
String sDelivery_street
String sDelivery_suffix_1
String sDelivery_suffix_2
String sDelivery_zip_code
String sDisplay_name
String sFax
String sCustomer_snapshotFirst_name
String sGrace_period
String sDue_in_days
String sGroup_id
String sId
String sInfo_1
String sInfo_2
String sInternet
String sLogin_id
String sMobile
String sNote
String sV_Number
Integer iPayment_options
Boolean iCustomer_snapshotPersonal
String sPhone_1
String sPhone_2
String sPostbox
String sPostbox_city
String sPostbox_state
String sPostbox_country
String sPostbox_zip_code
String sSale_price_level
Integer iCustomer_snapshotSalutation
String sSepa_agreement
String sSepa_agreement_date
String sSepa_mandate_reference
String sSince_date
String sCustomer_snapshotStreet
String sCustomer_snapshotSuffix_1
String sCustomer_snapshotSuffix_2
String sTax_number
String sCourt
String sCourt_registry_number
String sTax_options
String sCustomer_snapshotTitle
String sArchived
String sVat_identifier
String sCustomer_snapshotZip_code
String sDocument_pdf_type
String sBuyer_reference
String sForeign_supplier_number
String sDiscount
String sDiscount_type
String sDocument_date
String sDue_date
String sEdited_at
String sExternal_id
String sReplica_url
String sGrace_period
String sDue_in_days
String sId
Boolean iIs_acceptable_on_public_domain
Boolean iIs_archive
String sIs_draft
Boolean iIs_replica
Boolean iIs_oss
String sLast_postbox_id
String sLogin_id
String sV_number
String sOrder_number
String sBuyer_reference
String sPaid_amount
String sPaid_at
String sPdf_pages
String sPdf_template
String sProject_id
String sNext_date
String sFrequency
String sFrequency_special
Integer iInterval
String sEnd_date_or_count
String sStatus
Boolean iAs_draft
Boolean iIs_notify
String sSend_as
Boolean iIs_sign
Boolean iIs_paid
String sPaid_date_option
Boolean iIs_sepa
String sSepa_local_instrument
String sSepa_sequence_type
String sSepa_reference
String sSepa_remittance_information
String sTarget_type
String sRef_id
String sRoot_id
String sV_Type
String sDate
String sText
String sShipping_country
String sStatus
String sText
String sText_prefix
String sText_tax
String sTitle
String sV_type
Boolean iUse_shipping_address
String sVat_country
String sVat_id
String sFulfillment_country
String sVat_option
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Send ComSetRequestHeader To hoHttp "Authorization" "{{apiKey}}"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get ComQuickRequest Of hoHttp "POST" "https://api.easybill.de/rest/v1/documents/:id/:type?pdf_template=DE" To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get Create (RefClass(cComChilkatDtObj)) To hoDate_from
If (Not(IsComObjectCreated(hoDate_from))) Begin
Send CreateComObject of hoDate_from
End
Get Create (RefClass(cComChilkatDtObj)) To hoDate_to
If (Not(IsComObjectCreated(hoDate_to))) Begin
Send CreateComObject of hoDate_to
End
Get ComStringOf Of hoJResp "address.salutation" To sSalutation
Get ComStringOf Of hoJResp "address.personal" To sPersonal
Get ComStringOf Of hoJResp "address.title" To sTitle
Get ComStringOf Of hoJResp "address.first_name" To sFirst_name
Get ComStringOf Of hoJResp "address.last_name" To sLast_name
Get ComStringOf Of hoJResp "address.suffix_1" To sSuffix_1
Get ComStringOf Of hoJResp "address.suffix_2" To sSuffix_2
Get ComStringOf Of hoJResp "address.company_name" To sCompany_name
Get ComStringOf Of hoJResp "address.street" To sStreet
Get ComStringOf Of hoJResp "address.zip_code" To sZip_code
Get ComStringOf Of hoJResp "address.city" To sCity
Get ComStringOf Of hoJResp "address.state" To sState
Get ComStringOf Of hoJResp "address.country" To sCountry
Get ComStringOf Of hoJResp "label_address.salutation" To sLabel_addressSalutation
Get ComStringOf Of hoJResp "label_address.personal" To sLabel_addressPersonal
Get ComStringOf Of hoJResp "label_address.title" To sLabel_addressTitle
Get ComStringOf Of hoJResp "label_address.first_name" To sLabel_addressFirst_name
Get ComStringOf Of hoJResp "label_address.last_name" To sLabel_addressLast_name
Get ComStringOf Of hoJResp "label_address.suffix_1" To sLabel_addressSuffix_1
Get ComStringOf Of hoJResp "label_address.suffix_2" To sLabel_addressSuffix_2
Get ComStringOf Of hoJResp "label_address.company_name" To sLabel_addressCompany_name
Get ComStringOf Of hoJResp "label_address.street" To sLabel_addressStreet
Get ComStringOf Of hoJResp "label_address.zip_code" To sLabel_addressZip_code
Get ComStringOf Of hoJResp "label_address.city" To sLabel_addressCity
Get ComStringOf Of hoJResp "label_address.state" To sLabel_addressState
Get ComStringOf Of hoJResp "label_address.country" To sLabel_addressCountry
Get ComStringOf Of hoJResp "amount" To sAmount
Get ComStringOf Of hoJResp "amount_net" To sAmount_net
Get ComStringOf Of hoJResp "bank_debit_form" To sBank_debit_form
Get ComStringOf Of hoJResp "billing_country" To sBilling_country
Get ComIntOf Of hoJResp "calc_vat_from" To iCalc_vat_from
Get ComStringOf Of hoJResp "cancel_id" To sCancel_id
Get ComStringOf Of hoJResp "cash_allowance" To sCash_allowance
Get ComStringOf Of hoJResp "cash_allowance_days" To sCash_allowance_days
Get ComStringOf Of hoJResp "cash_allowance_text" To sCash_allowance_text
Get ComStringOf Of hoJResp "contact_id" To sContact_id
Get ComStringOf Of hoJResp "contact_label" To sContact_label
Get ComStringOf Of hoJResp "contact_text" To sContact_text
Get ComStringOf Of hoJResp "created_at" To sCreated_at
Get ComStringOf Of hoJResp "currency" To sV_currency
Get ComStringOf Of hoJResp "customer_id" To sCustomer_id
Get ComStringOf Of hoJResp "customer_snapshot.last_name" To sCustomer_snapshotLast_name
Get ComStringOf Of hoJResp "customer_snapshot.company_name" To sCustomer_snapshotCompany_name
Get ComIntOf Of hoJResp "customer_snapshot.acquire_options" To iAcquire_options
Get ComStringOf Of hoJResp "customer_snapshot.bank_account" To sBank_account
Get ComStringOf Of hoJResp "customer_snapshot.bank_account_owner" To sBank_account_owner
Get ComStringOf Of hoJResp "customer_snapshot.bank_bic" To sBank_bic
Get ComStringOf Of hoJResp "customer_snapshot.bank_code" To sBank_code
Get ComStringOf Of hoJResp "customer_snapshot.bank_iban" To sBank_iban
Get ComStringOf Of hoJResp "customer_snapshot.bank_name" To sBank_name
Get ComStringOf Of hoJResp "customer_snapshot.birth_date" To sBirth_date
Get ComStringOf Of hoJResp "customer_snapshot.cash_allowance" To sCash_allowance
Get ComIntOf Of hoJResp "customer_snapshot.cash_allowance_days" To iCash_allowance_days
Get ComStringOf Of hoJResp "customer_snapshot.cash_discount" To sCash_discount
Get ComStringOf Of hoJResp "customer_snapshot.cash_discount_type" To sCash_discount_type
Get ComStringOf Of hoJResp "customer_snapshot.city" To sCustomer_snapshotCity
Get ComStringOf Of hoJResp "customer_snapshot.state" To sCustomer_snapshotState
Get ComStringOf Of hoJResp "customer_snapshot.country" To sCustomer_snapshotCountry
Get ComStringOf Of hoJResp "customer_snapshot.created_at" To sCreated_at
Get ComStringOf Of hoJResp "customer_snapshot.updated_at" To sUpdated_at
Get ComStringOf Of hoJResp "customer_snapshot.delivery_title" To sDelivery_title
Get ComStringOf Of hoJResp "customer_snapshot.delivery_city" To sDelivery_city
Get ComStringOf Of hoJResp "customer_snapshot.delivery_state" To sDelivery_state
Get ComStringOf Of hoJResp "customer_snapshot.delivery_company_name" To sDelivery_company_name
Get ComStringOf Of hoJResp "customer_snapshot.delivery_country" To sDelivery_country
Get ComStringOf Of hoJResp "customer_snapshot.delivery_first_name" To sDelivery_first_name
Get ComStringOf Of hoJResp "customer_snapshot.delivery_last_name" To sDelivery_last_name
Get ComStringOf Of hoJResp "customer_snapshot.delivery_personal" To sDelivery_personal
Get ComIntOf Of hoJResp "customer_snapshot.delivery_salutation" To iDelivery_salutation
Get ComStringOf Of hoJResp "customer_snapshot.delivery_street" To sDelivery_street
Get ComStringOf Of hoJResp "customer_snapshot.delivery_suffix_1" To sDelivery_suffix_1
Get ComStringOf Of hoJResp "customer_snapshot.delivery_suffix_2" To sDelivery_suffix_2
Get ComStringOf Of hoJResp "customer_snapshot.delivery_zip_code" To sDelivery_zip_code
Get ComStringOf Of hoJResp "customer_snapshot.display_name" To sDisplay_name
Get ComStringOf Of hoJResp "customer_snapshot.fax" To sFax
Get ComStringOf Of hoJResp "customer_snapshot.first_name" To sCustomer_snapshotFirst_name
Get ComStringOf Of hoJResp "customer_snapshot.grace_period" To sGrace_period
Get ComStringOf Of hoJResp "customer_snapshot.due_in_days" To sDue_in_days
Get ComStringOf Of hoJResp "customer_snapshot.group_id" To sGroup_id
Get ComStringOf Of hoJResp "customer_snapshot.id" To sId
Get ComStringOf Of hoJResp "customer_snapshot.info_1" To sInfo_1
Get ComStringOf Of hoJResp "customer_snapshot.info_2" To sInfo_2
Get ComStringOf Of hoJResp "customer_snapshot.internet" To sInternet
Get ComStringOf Of hoJResp "customer_snapshot.login_id" To sLogin_id
Get ComStringOf Of hoJResp "customer_snapshot.mobile" To sMobile
Get ComStringOf Of hoJResp "customer_snapshot.note" To sNote
Get ComStringOf Of hoJResp "customer_snapshot.number" To sV_Number
Get ComIntOf Of hoJResp "customer_snapshot.payment_options" To iPayment_options
Get ComBoolOf Of hoJResp "customer_snapshot.personal" To iCustomer_snapshotPersonal
Get ComStringOf Of hoJResp "customer_snapshot.phone_1" To sPhone_1
Get ComStringOf Of hoJResp "customer_snapshot.phone_2" To sPhone_2
Get ComStringOf Of hoJResp "customer_snapshot.postbox" To sPostbox
Get ComStringOf Of hoJResp "customer_snapshot.postbox_city" To sPostbox_city
Get ComStringOf Of hoJResp "customer_snapshot.postbox_state" To sPostbox_state
Get ComStringOf Of hoJResp "customer_snapshot.postbox_country" To sPostbox_country
Get ComStringOf Of hoJResp "customer_snapshot.postbox_zip_code" To sPostbox_zip_code
Get ComStringOf Of hoJResp "customer_snapshot.sale_price_level" To sSale_price_level
Get ComIntOf Of hoJResp "customer_snapshot.salutation" To iCustomer_snapshotSalutation
Get ComStringOf Of hoJResp "customer_snapshot.sepa_agreement" To sSepa_agreement
Get ComStringOf Of hoJResp "customer_snapshot.sepa_agreement_date" To sSepa_agreement_date
Get ComStringOf Of hoJResp "customer_snapshot.sepa_mandate_reference" To sSepa_mandate_reference
Get ComStringOf Of hoJResp "customer_snapshot.since_date" To sSince_date
Get ComStringOf Of hoJResp "customer_snapshot.street" To sCustomer_snapshotStreet
Get ComStringOf Of hoJResp "customer_snapshot.suffix_1" To sCustomer_snapshotSuffix_1
Get ComStringOf Of hoJResp "customer_snapshot.suffix_2" To sCustomer_snapshotSuffix_2
Get ComStringOf Of hoJResp "customer_snapshot.tax_number" To sTax_number
Get ComStringOf Of hoJResp "customer_snapshot.court" To sCourt
Get ComStringOf Of hoJResp "customer_snapshot.court_registry_number" To sCourt_registry_number
Get ComStringOf Of hoJResp "customer_snapshot.tax_options" To sTax_options
Get ComStringOf Of hoJResp "customer_snapshot.title" To sCustomer_snapshotTitle
Get ComStringOf Of hoJResp "customer_snapshot.archived" To sArchived
Get ComStringOf Of hoJResp "customer_snapshot.vat_identifier" To sVat_identifier
Get ComStringOf Of hoJResp "customer_snapshot.zip_code" To sCustomer_snapshotZip_code
Get ComStringOf Of hoJResp "customer_snapshot.document_pdf_type" To sDocument_pdf_type
Get ComStringOf Of hoJResp "customer_snapshot.buyer_reference" To sBuyer_reference
Get ComStringOf Of hoJResp "customer_snapshot.foreign_supplier_number" To sForeign_supplier_number
Get ComStringOf Of hoJResp "discount" To sDiscount
Get ComStringOf Of hoJResp "discount_type" To sDiscount_type
Get ComStringOf Of hoJResp "document_date" To sDocument_date
Get ComStringOf Of hoJResp "due_date" To sDue_date
Get ComStringOf Of hoJResp "edited_at" To sEdited_at
Get ComStringOf Of hoJResp "external_id" To sExternal_id
Get ComStringOf Of hoJResp "replica_url" To sReplica_url
Get ComStringOf Of hoJResp "grace_period" To sGrace_period
Get ComStringOf Of hoJResp "due_in_days" To sDue_in_days
Get ComStringOf Of hoJResp "id" To sId
Get ComBoolOf Of hoJResp "is_acceptable_on_public_domain" To iIs_acceptable_on_public_domain
Get ComBoolOf Of hoJResp "is_archive" To iIs_archive
Get ComStringOf Of hoJResp "is_draft" To sIs_draft
Get ComBoolOf Of hoJResp "is_replica" To iIs_replica
Get ComBoolOf Of hoJResp "is_oss" To iIs_oss
Get ComStringOf Of hoJResp "last_postbox_id" To sLast_postbox_id
Get ComStringOf Of hoJResp "login_id" To sLogin_id
Get ComStringOf Of hoJResp "number" To sV_number
Get ComStringOf Of hoJResp "order_number" To sOrder_number
Get ComStringOf Of hoJResp "buyer_reference" To sBuyer_reference
Get ComStringOf Of hoJResp "paid_amount" To sPaid_amount
Get ComStringOf Of hoJResp "paid_at" To sPaid_at
Get ComStringOf Of hoJResp "pdf_pages" To sPdf_pages
Get ComStringOf Of hoJResp "pdf_template" To sPdf_template
Get ComStringOf Of hoJResp "project_id" To sProject_id
Get ComStringOf Of hoJResp "recurring_options.next_date" To sNext_date
Get ComStringOf Of hoJResp "recurring_options.frequency" To sFrequency
Get ComStringOf Of hoJResp "recurring_options.frequency_special" To sFrequency_special
Get ComIntOf Of hoJResp "recurring_options.interval" To iInterval
Get ComStringOf Of hoJResp "recurring_options.end_date_or_count" To sEnd_date_or_count
Get ComStringOf Of hoJResp "recurring_options.status" To sStatus
Get ComBoolOf Of hoJResp "recurring_options.as_draft" To iAs_draft
Get ComBoolOf Of hoJResp "recurring_options.is_notify" To iIs_notify
Get ComStringOf Of hoJResp "recurring_options.send_as" To sSend_as
Get ComBoolOf Of hoJResp "recurring_options.is_sign" To iIs_sign
Get ComBoolOf Of hoJResp "recurring_options.is_paid" To iIs_paid
Get ComStringOf Of hoJResp "recurring_options.paid_date_option" To sPaid_date_option
Get ComBoolOf Of hoJResp "recurring_options.is_sepa" To iIs_sepa
Get ComStringOf Of hoJResp "recurring_options.sepa_local_instrument" To sSepa_local_instrument
Get ComStringOf Of hoJResp "recurring_options.sepa_sequence_type" To sSepa_sequence_type
Get ComStringOf Of hoJResp "recurring_options.sepa_reference" To sSepa_reference
Get ComStringOf Of hoJResp "recurring_options.sepa_remittance_information" To sSepa_remittance_information
Get ComStringOf Of hoJResp "recurring_options.target_type" To sTarget_type
Get ComStringOf Of hoJResp "ref_id" To sRef_id
Get ComStringOf Of hoJResp "root_id" To sRoot_id
Get ComStringOf Of hoJResp "service_date.type" To sV_Type
Get ComStringOf Of hoJResp "service_date.date" To sDate
Get pvComObject of hoDate_from to vDate_from
Get ComDtOf Of hoJResp "service_date.date_from" False vDate_from To iSuccess
Get pvComObject of hoDate_to to vDate_to
Get ComDtOf Of hoJResp "service_date.date_to" False vDate_to To iSuccess
Get ComStringOf Of hoJResp "service_date.text" To sText
Get ComStringOf Of hoJResp "shipping_country" To sShipping_country
Get ComStringOf Of hoJResp "status" To sStatus
Get ComStringOf Of hoJResp "text" To sText
Get ComStringOf Of hoJResp "text_prefix" To sText_prefix
Get ComStringOf Of hoJResp "text_tax" To sText_tax
Get ComStringOf Of hoJResp "title" To sTitle
Get ComStringOf Of hoJResp "type" To sV_type
Get ComBoolOf Of hoJResp "use_shipping_address" To iUse_shipping_address
Get ComStringOf Of hoJResp "vat_country" To sVat_country
Get ComStringOf Of hoJResp "vat_id" To sVat_id
Get ComStringOf Of hoJResp "fulfillment_country" To sFulfillment_country
Get ComStringOf Of hoJResp "vat_option" To sVat_option
Move 0 To i
Get ComSizeOfArray Of hoJResp "attachment_ids" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "attachment_ids[i]" To sStrVal
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "customer_snapshot.additional_groups_ids" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "customer_snapshot.additional_groups_ids[i]" To sStrVal
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "customer_snapshot.emails" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "customer_snapshot.emails[i]" To sStrVal
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "item_notes" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "item_notes[i]" To sStrVal
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "items" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "items[i].number" To sV_number
Get ComStringOf Of hoJResp "items[i].description" To sDescription
Get ComStringOf Of hoJResp "items[i].document_note" To sDocument_note
Get ComIntOf Of hoJResp "items[i].quantity" To iQuantity
Get ComStringOf Of hoJResp "items[i].quantity_str" To sQuantity_str
Get ComStringOf Of hoJResp "items[i].unit" To sUnit
Get ComStringOf Of hoJResp "items[i].type" To sV_type
Get ComStringOf Of hoJResp "items[i].position" To sPosition
Get ComStringOf Of hoJResp "items[i].single_price_net" To sSingle_price_net
Get ComStringOf Of hoJResp "items[i].single_price_gross" To sSingle_price_gross
Get ComIntOf Of hoJResp "items[i].vat_percent" To iVat_percent
Get ComStringOf Of hoJResp "items[i].discount" To sDiscount
Get ComStringOf Of hoJResp "items[i].discount_type" To sDiscount_type
Get ComStringOf Of hoJResp "items[i].position_id" To sPosition_id
Get ComStringOf Of hoJResp "items[i].total_price_net" To sTotal_price_net
Get ComStringOf Of hoJResp "items[i].total_price_gross" To sTotal_price_gross
Get ComStringOf Of hoJResp "items[i].total_vat" To sTotal_vat
Get ComStringOf Of hoJResp "items[i].serial_number_id" To sSerial_number_id
Get ComStringOf Of hoJResp "items[i].serial_number" To sSerial_number
Get ComStringOf Of hoJResp "items[i].booking_account" To sBooking_account
Get ComStringOf Of hoJResp "items[i].export_cost_1" To sExport_cost_1
Get ComStringOf Of hoJResp "items[i].export_cost_2" To sExport_cost_2
Get ComStringOf Of hoJResp "items[i].cost_price_net" To sCost_price_net
Get ComStringOf Of hoJResp "items[i].cost_price_total" To sCost_price_total
Get ComStringOf Of hoJResp "items[i].cost_price_charge" To sCost_price_charge
Get ComStringOf Of hoJResp "items[i].cost_price_charge_type" To sCost_price_charge_type
Get ComStringOf Of hoJResp "items[i].itemType" To sItemType
Get ComStringOf Of hoJResp "items[i].id" To sId
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "file_format_config" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "file_format_config[i].type" To sV_type
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -X POST
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/documents/:id/:type?pdf_template=DE
Postman Collection Item JSON
{
"name": "Convert an existing document to one of a different type",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/documents/:id/:type?pdf_template=DE",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id",
":type"
],
"query": [
{
"key": "pdf_template",
"value": "DE",
"description": "The ID of the printer template to use. Defaults to 'DE' if not given."
}
],
"variable": [
{
"key": "id",
"value": "<long>",
"description": "(Required) ID of document"
},
{
"key": "type",
"value": "DUNNING",
"description": "(Required) The target document type"
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "POST",
"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/:type?pdf_template=DE",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id",
":type"
],
"query": [
{
"key": "pdf_template",
"value": "DE",
"description": "The ID of the printer template to use. Defaults to 'DE' if not given."
}
],
"variable": [
{
"key": "id"
},
{
"key": "type"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Location",
"value": "<uri>",
"description": {
"content": "Absolute URL to the newly created document",
"type": "text/plain"
}
}
],
"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": "Invalid target document type",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/documents/:id/:type?pdf_template=DE",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id",
":type"
],
"query": [
{
"key": "pdf_template",
"value": "DE",
"description": "The ID of the printer template to use. Defaults to 'DE' if not given."
}
],
"variable": [
{
"key": "id"
},
{
"key": "type"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/documents/:id/:type?pdf_template=DE",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id",
":type"
],
"query": [
{
"key": "pdf_template",
"value": "DE",
"description": "The ID of the printer template to use. Defaults to 'DE' if not given."
}
],
"variable": [
{
"key": "id"
},
{
"key": "type"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
