delphiDll / easybill REST API / To complete a document.
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Date_from: HCkDtObj;
Date_to: HCkDtObj;
strVal: PWideChar;
description: PWideChar;
document_note: PWideChar;
quantity: Integer;
quantity_str: PWideChar;
unit: PWideChar;
position: PWideChar;
single_price_net: PWideChar;
single_price_gross: PWideChar;
vat_percent: Integer;
position_id: PWideChar;
total_price_net: PWideChar;
total_price_gross: PWideChar;
total_vat: PWideChar;
serial_number_id: PWideChar;
serial_number: PWideChar;
booking_account: PWideChar;
export_cost_1: PWideChar;
export_cost_2: PWideChar;
cost_price_net: PWideChar;
cost_price_total: PWideChar;
cost_price_charge: PWideChar;
cost_price_charge_type: PWideChar;
itemType: PWideChar;
Salutation: PWideChar;
Personal: PWideChar;
Title: PWideChar;
First_name: PWideChar;
Last_name: PWideChar;
Suffix_1: PWideChar;
Suffix_2: PWideChar;
Company_name: PWideChar;
Street: PWideChar;
Zip_code: PWideChar;
City: PWideChar;
State: PWideChar;
Country: PWideChar;
label_addressSalutation: PWideChar;
label_addressPersonal: PWideChar;
label_addressTitle: PWideChar;
label_addressFirst_name: PWideChar;
label_addressLast_name: PWideChar;
label_addressSuffix_1: PWideChar;
label_addressSuffix_2: PWideChar;
label_addressCompany_name: PWideChar;
label_addressStreet: PWideChar;
label_addressZip_code: PWideChar;
label_addressCity: PWideChar;
label_addressState: PWideChar;
label_addressCountry: PWideChar;
amount: PWideChar;
amount_net: PWideChar;
bank_debit_form: PWideChar;
billing_country: PWideChar;
calc_vat_from: Integer;
cancel_id: PWideChar;
cash_allowance: PWideChar;
cash_allowance_days: PWideChar;
cash_allowance_text: PWideChar;
contact_id: PWideChar;
contact_label: PWideChar;
contact_text: PWideChar;
created_at: PWideChar;
v_currency: PWideChar;
customer_id: PWideChar;
customer_snapshotLast_name: PWideChar;
customer_snapshotCompany_name: PWideChar;
Acquire_options: Integer;
Bank_account: PWideChar;
Bank_account_owner: PWideChar;
Bank_bic: PWideChar;
Bank_code: PWideChar;
Bank_iban: PWideChar;
Bank_name: PWideChar;
Birth_date: PWideChar;
Cash_allowance: PWideChar;
Cash_allowance_days: Integer;
Cash_discount: PWideChar;
Cash_discount_type: PWideChar;
customer_snapshotCity: PWideChar;
customer_snapshotState: PWideChar;
customer_snapshotCountry: PWideChar;
Created_at: PWideChar;
Updated_at: PWideChar;
Delivery_title: PWideChar;
Delivery_city: PWideChar;
Delivery_state: PWideChar;
Delivery_company_name: PWideChar;
Delivery_country: PWideChar;
Delivery_first_name: PWideChar;
Delivery_last_name: PWideChar;
Delivery_personal: PWideChar;
Delivery_salutation: Integer;
Delivery_street: PWideChar;
Delivery_suffix_1: PWideChar;
Delivery_suffix_2: PWideChar;
Delivery_zip_code: PWideChar;
Display_name: PWideChar;
Fax: PWideChar;
customer_snapshotFirst_name: PWideChar;
Grace_period: PWideChar;
Due_in_days: PWideChar;
Group_id: PWideChar;
Id: PWideChar;
Info_1: PWideChar;
Info_2: PWideChar;
Internet: PWideChar;
Login_id: PWideChar;
Mobile: PWideChar;
Note: PWideChar;
v_Number: PWideChar;
Payment_options: Integer;
customer_snapshotPersonal: Boolean;
Phone_1: PWideChar;
Phone_2: PWideChar;
Postbox: PWideChar;
Postbox_city: PWideChar;
Postbox_state: PWideChar;
Postbox_country: PWideChar;
Postbox_zip_code: PWideChar;
Sale_price_level: PWideChar;
customer_snapshotSalutation: Integer;
Sepa_agreement: PWideChar;
Sepa_agreement_date: PWideChar;
Sepa_mandate_reference: PWideChar;
Since_date: PWideChar;
customer_snapshotStreet: PWideChar;
customer_snapshotSuffix_1: PWideChar;
customer_snapshotSuffix_2: PWideChar;
Tax_number: PWideChar;
Court: PWideChar;
Court_registry_number: PWideChar;
Tax_options: PWideChar;
customer_snapshotTitle: PWideChar;
Archived: PWideChar;
Vat_identifier: PWideChar;
customer_snapshotZip_code: PWideChar;
Document_pdf_type: PWideChar;
Buyer_reference: PWideChar;
Foreign_supplier_number: PWideChar;
discount: PWideChar;
discount_type: PWideChar;
document_date: PWideChar;
due_date: PWideChar;
edited_at: PWideChar;
external_id: PWideChar;
replica_url: PWideChar;
grace_period: PWideChar;
due_in_days: PWideChar;
id: PWideChar;
is_acceptable_on_public_domain: Boolean;
is_archive: Boolean;
is_draft: PWideChar;
is_replica: Boolean;
is_oss: Boolean;
last_postbox_id: PWideChar;
login_id: PWideChar;
v_number: PWideChar;
order_number: PWideChar;
buyer_reference: PWideChar;
paid_amount: PWideChar;
paid_at: PWideChar;
pdf_pages: PWideChar;
pdf_template: PWideChar;
project_id: PWideChar;
Next_date: PWideChar;
Frequency: PWideChar;
Frequency_special: PWideChar;
Interval: Integer;
End_date_or_count: PWideChar;
Status: PWideChar;
As_draft: Boolean;
Is_notify: Boolean;
Send_as: PWideChar;
Is_sign: Boolean;
Is_paid: Boolean;
Paid_date_option: PWideChar;
Is_sepa: Boolean;
Sepa_local_instrument: PWideChar;
Sepa_sequence_type: PWideChar;
Sepa_reference: PWideChar;
Sepa_remittance_information: PWideChar;
Target_type: PWideChar;
ref_id: PWideChar;
root_id: PWideChar;
v_Type: PWideChar;
Date: PWideChar;
Text: PWideChar;
shipping_country: PWideChar;
status: PWideChar;
text: PWideChar;
text_prefix: PWideChar;
text_tax: PWideChar;
title: PWideChar;
v_type: PWideChar;
use_shipping_address: Boolean;
vat_country: PWideChar;
vat_id: PWideChar;
fulfillment_country: PWideChar;
vat_option: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_SetRequestHeader(http,'Authorization','{{apiKey}}');
CkHttp_SetRequestHeader(http,'Accept','application/json');
resp := CkHttp_QuickRequest(http,'PUT','https://api.easybill.de/rest/v1/documents/:id/done?reason_for_change=<string>');
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// 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
Date_from := CkDtObj_Create();
Date_to := CkDtObj_Create();
Salutation := CkJsonObject__stringOf(jResp,'address.salutation');
Personal := CkJsonObject__stringOf(jResp,'address.personal');
Title := CkJsonObject__stringOf(jResp,'address.title');
First_name := CkJsonObject__stringOf(jResp,'address.first_name');
Last_name := CkJsonObject__stringOf(jResp,'address.last_name');
Suffix_1 := CkJsonObject__stringOf(jResp,'address.suffix_1');
Suffix_2 := CkJsonObject__stringOf(jResp,'address.suffix_2');
Company_name := CkJsonObject__stringOf(jResp,'address.company_name');
Street := CkJsonObject__stringOf(jResp,'address.street');
Zip_code := CkJsonObject__stringOf(jResp,'address.zip_code');
City := CkJsonObject__stringOf(jResp,'address.city');
State := CkJsonObject__stringOf(jResp,'address.state');
Country := CkJsonObject__stringOf(jResp,'address.country');
label_addressSalutation := CkJsonObject__stringOf(jResp,'label_address.salutation');
label_addressPersonal := CkJsonObject__stringOf(jResp,'label_address.personal');
label_addressTitle := CkJsonObject__stringOf(jResp,'label_address.title');
label_addressFirst_name := CkJsonObject__stringOf(jResp,'label_address.first_name');
label_addressLast_name := CkJsonObject__stringOf(jResp,'label_address.last_name');
label_addressSuffix_1 := CkJsonObject__stringOf(jResp,'label_address.suffix_1');
label_addressSuffix_2 := CkJsonObject__stringOf(jResp,'label_address.suffix_2');
label_addressCompany_name := CkJsonObject__stringOf(jResp,'label_address.company_name');
label_addressStreet := CkJsonObject__stringOf(jResp,'label_address.street');
label_addressZip_code := CkJsonObject__stringOf(jResp,'label_address.zip_code');
label_addressCity := CkJsonObject__stringOf(jResp,'label_address.city');
label_addressState := CkJsonObject__stringOf(jResp,'label_address.state');
label_addressCountry := CkJsonObject__stringOf(jResp,'label_address.country');
amount := CkJsonObject__stringOf(jResp,'amount');
amount_net := CkJsonObject__stringOf(jResp,'amount_net');
bank_debit_form := CkJsonObject__stringOf(jResp,'bank_debit_form');
billing_country := CkJsonObject__stringOf(jResp,'billing_country');
calc_vat_from := CkJsonObject_IntOf(jResp,'calc_vat_from');
cancel_id := CkJsonObject__stringOf(jResp,'cancel_id');
cash_allowance := CkJsonObject__stringOf(jResp,'cash_allowance');
cash_allowance_days := CkJsonObject__stringOf(jResp,'cash_allowance_days');
cash_allowance_text := CkJsonObject__stringOf(jResp,'cash_allowance_text');
contact_id := CkJsonObject__stringOf(jResp,'contact_id');
contact_label := CkJsonObject__stringOf(jResp,'contact_label');
contact_text := CkJsonObject__stringOf(jResp,'contact_text');
created_at := CkJsonObject__stringOf(jResp,'created_at');
v_currency := CkJsonObject__stringOf(jResp,'currency');
customer_id := CkJsonObject__stringOf(jResp,'customer_id');
customer_snapshotLast_name := CkJsonObject__stringOf(jResp,'customer_snapshot.last_name');
customer_snapshotCompany_name := CkJsonObject__stringOf(jResp,'customer_snapshot.company_name');
Acquire_options := CkJsonObject_IntOf(jResp,'customer_snapshot.acquire_options');
Bank_account := CkJsonObject__stringOf(jResp,'customer_snapshot.bank_account');
Bank_account_owner := CkJsonObject__stringOf(jResp,'customer_snapshot.bank_account_owner');
Bank_bic := CkJsonObject__stringOf(jResp,'customer_snapshot.bank_bic');
Bank_code := CkJsonObject__stringOf(jResp,'customer_snapshot.bank_code');
Bank_iban := CkJsonObject__stringOf(jResp,'customer_snapshot.bank_iban');
Bank_name := CkJsonObject__stringOf(jResp,'customer_snapshot.bank_name');
Birth_date := CkJsonObject__stringOf(jResp,'customer_snapshot.birth_date');
Cash_allowance := CkJsonObject__stringOf(jResp,'customer_snapshot.cash_allowance');
Cash_allowance_days := CkJsonObject_IntOf(jResp,'customer_snapshot.cash_allowance_days');
Cash_discount := CkJsonObject__stringOf(jResp,'customer_snapshot.cash_discount');
Cash_discount_type := CkJsonObject__stringOf(jResp,'customer_snapshot.cash_discount_type');
customer_snapshotCity := CkJsonObject__stringOf(jResp,'customer_snapshot.city');
customer_snapshotState := CkJsonObject__stringOf(jResp,'customer_snapshot.state');
customer_snapshotCountry := CkJsonObject__stringOf(jResp,'customer_snapshot.country');
Created_at := CkJsonObject__stringOf(jResp,'customer_snapshot.created_at');
Updated_at := CkJsonObject__stringOf(jResp,'customer_snapshot.updated_at');
Delivery_title := CkJsonObject__stringOf(jResp,'customer_snapshot.delivery_title');
Delivery_city := CkJsonObject__stringOf(jResp,'customer_snapshot.delivery_city');
Delivery_state := CkJsonObject__stringOf(jResp,'customer_snapshot.delivery_state');
Delivery_company_name := CkJsonObject__stringOf(jResp,'customer_snapshot.delivery_company_name');
Delivery_country := CkJsonObject__stringOf(jResp,'customer_snapshot.delivery_country');
Delivery_first_name := CkJsonObject__stringOf(jResp,'customer_snapshot.delivery_first_name');
Delivery_last_name := CkJsonObject__stringOf(jResp,'customer_snapshot.delivery_last_name');
Delivery_personal := CkJsonObject__stringOf(jResp,'customer_snapshot.delivery_personal');
Delivery_salutation := CkJsonObject_IntOf(jResp,'customer_snapshot.delivery_salutation');
Delivery_street := CkJsonObject__stringOf(jResp,'customer_snapshot.delivery_street');
Delivery_suffix_1 := CkJsonObject__stringOf(jResp,'customer_snapshot.delivery_suffix_1');
Delivery_suffix_2 := CkJsonObject__stringOf(jResp,'customer_snapshot.delivery_suffix_2');
Delivery_zip_code := CkJsonObject__stringOf(jResp,'customer_snapshot.delivery_zip_code');
Display_name := CkJsonObject__stringOf(jResp,'customer_snapshot.display_name');
Fax := CkJsonObject__stringOf(jResp,'customer_snapshot.fax');
customer_snapshotFirst_name := CkJsonObject__stringOf(jResp,'customer_snapshot.first_name');
Grace_period := CkJsonObject__stringOf(jResp,'customer_snapshot.grace_period');
Due_in_days := CkJsonObject__stringOf(jResp,'customer_snapshot.due_in_days');
Group_id := CkJsonObject__stringOf(jResp,'customer_snapshot.group_id');
Id := CkJsonObject__stringOf(jResp,'customer_snapshot.id');
Info_1 := CkJsonObject__stringOf(jResp,'customer_snapshot.info_1');
Info_2 := CkJsonObject__stringOf(jResp,'customer_snapshot.info_2');
Internet := CkJsonObject__stringOf(jResp,'customer_snapshot.internet');
Login_id := CkJsonObject__stringOf(jResp,'customer_snapshot.login_id');
Mobile := CkJsonObject__stringOf(jResp,'customer_snapshot.mobile');
Note := CkJsonObject__stringOf(jResp,'customer_snapshot.note');
v_Number := CkJsonObject__stringOf(jResp,'customer_snapshot.number');
Payment_options := CkJsonObject_IntOf(jResp,'customer_snapshot.payment_options');
customer_snapshotPersonal := CkJsonObject_BoolOf(jResp,'customer_snapshot.personal');
Phone_1 := CkJsonObject__stringOf(jResp,'customer_snapshot.phone_1');
Phone_2 := CkJsonObject__stringOf(jResp,'customer_snapshot.phone_2');
Postbox := CkJsonObject__stringOf(jResp,'customer_snapshot.postbox');
Postbox_city := CkJsonObject__stringOf(jResp,'customer_snapshot.postbox_city');
Postbox_state := CkJsonObject__stringOf(jResp,'customer_snapshot.postbox_state');
Postbox_country := CkJsonObject__stringOf(jResp,'customer_snapshot.postbox_country');
Postbox_zip_code := CkJsonObject__stringOf(jResp,'customer_snapshot.postbox_zip_code');
Sale_price_level := CkJsonObject__stringOf(jResp,'customer_snapshot.sale_price_level');
customer_snapshotSalutation := CkJsonObject_IntOf(jResp,'customer_snapshot.salutation');
Sepa_agreement := CkJsonObject__stringOf(jResp,'customer_snapshot.sepa_agreement');
Sepa_agreement_date := CkJsonObject__stringOf(jResp,'customer_snapshot.sepa_agreement_date');
Sepa_mandate_reference := CkJsonObject__stringOf(jResp,'customer_snapshot.sepa_mandate_reference');
Since_date := CkJsonObject__stringOf(jResp,'customer_snapshot.since_date');
customer_snapshotStreet := CkJsonObject__stringOf(jResp,'customer_snapshot.street');
customer_snapshotSuffix_1 := CkJsonObject__stringOf(jResp,'customer_snapshot.suffix_1');
customer_snapshotSuffix_2 := CkJsonObject__stringOf(jResp,'customer_snapshot.suffix_2');
Tax_number := CkJsonObject__stringOf(jResp,'customer_snapshot.tax_number');
Court := CkJsonObject__stringOf(jResp,'customer_snapshot.court');
Court_registry_number := CkJsonObject__stringOf(jResp,'customer_snapshot.court_registry_number');
Tax_options := CkJsonObject__stringOf(jResp,'customer_snapshot.tax_options');
customer_snapshotTitle := CkJsonObject__stringOf(jResp,'customer_snapshot.title');
Archived := CkJsonObject__stringOf(jResp,'customer_snapshot.archived');
Vat_identifier := CkJsonObject__stringOf(jResp,'customer_snapshot.vat_identifier');
customer_snapshotZip_code := CkJsonObject__stringOf(jResp,'customer_snapshot.zip_code');
Document_pdf_type := CkJsonObject__stringOf(jResp,'customer_snapshot.document_pdf_type');
Buyer_reference := CkJsonObject__stringOf(jResp,'customer_snapshot.buyer_reference');
Foreign_supplier_number := CkJsonObject__stringOf(jResp,'customer_snapshot.foreign_supplier_number');
discount := CkJsonObject__stringOf(jResp,'discount');
discount_type := CkJsonObject__stringOf(jResp,'discount_type');
document_date := CkJsonObject__stringOf(jResp,'document_date');
due_date := CkJsonObject__stringOf(jResp,'due_date');
edited_at := CkJsonObject__stringOf(jResp,'edited_at');
external_id := CkJsonObject__stringOf(jResp,'external_id');
replica_url := CkJsonObject__stringOf(jResp,'replica_url');
grace_period := CkJsonObject__stringOf(jResp,'grace_period');
due_in_days := CkJsonObject__stringOf(jResp,'due_in_days');
id := CkJsonObject__stringOf(jResp,'id');
is_acceptable_on_public_domain := CkJsonObject_BoolOf(jResp,'is_acceptable_on_public_domain');
is_archive := CkJsonObject_BoolOf(jResp,'is_archive');
is_draft := CkJsonObject__stringOf(jResp,'is_draft');
is_replica := CkJsonObject_BoolOf(jResp,'is_replica');
is_oss := CkJsonObject_BoolOf(jResp,'is_oss');
last_postbox_id := CkJsonObject__stringOf(jResp,'last_postbox_id');
login_id := CkJsonObject__stringOf(jResp,'login_id');
v_number := CkJsonObject__stringOf(jResp,'number');
order_number := CkJsonObject__stringOf(jResp,'order_number');
buyer_reference := CkJsonObject__stringOf(jResp,'buyer_reference');
paid_amount := CkJsonObject__stringOf(jResp,'paid_amount');
paid_at := CkJsonObject__stringOf(jResp,'paid_at');
pdf_pages := CkJsonObject__stringOf(jResp,'pdf_pages');
pdf_template := CkJsonObject__stringOf(jResp,'pdf_template');
project_id := CkJsonObject__stringOf(jResp,'project_id');
Next_date := CkJsonObject__stringOf(jResp,'recurring_options.next_date');
Frequency := CkJsonObject__stringOf(jResp,'recurring_options.frequency');
Frequency_special := CkJsonObject__stringOf(jResp,'recurring_options.frequency_special');
Interval := CkJsonObject_IntOf(jResp,'recurring_options.interval');
End_date_or_count := CkJsonObject__stringOf(jResp,'recurring_options.end_date_or_count');
Status := CkJsonObject__stringOf(jResp,'recurring_options.status');
As_draft := CkJsonObject_BoolOf(jResp,'recurring_options.as_draft');
Is_notify := CkJsonObject_BoolOf(jResp,'recurring_options.is_notify');
Send_as := CkJsonObject__stringOf(jResp,'recurring_options.send_as');
Is_sign := CkJsonObject_BoolOf(jResp,'recurring_options.is_sign');
Is_paid := CkJsonObject_BoolOf(jResp,'recurring_options.is_paid');
Paid_date_option := CkJsonObject__stringOf(jResp,'recurring_options.paid_date_option');
Is_sepa := CkJsonObject_BoolOf(jResp,'recurring_options.is_sepa');
Sepa_local_instrument := CkJsonObject__stringOf(jResp,'recurring_options.sepa_local_instrument');
Sepa_sequence_type := CkJsonObject__stringOf(jResp,'recurring_options.sepa_sequence_type');
Sepa_reference := CkJsonObject__stringOf(jResp,'recurring_options.sepa_reference');
Sepa_remittance_information := CkJsonObject__stringOf(jResp,'recurring_options.sepa_remittance_information');
Target_type := CkJsonObject__stringOf(jResp,'recurring_options.target_type');
ref_id := CkJsonObject__stringOf(jResp,'ref_id');
root_id := CkJsonObject__stringOf(jResp,'root_id');
v_Type := CkJsonObject__stringOf(jResp,'service_date.type');
Date := CkJsonObject__stringOf(jResp,'service_date.date');
CkJsonObject_DtOf(jResp,'service_date.date_from',False,Date_from);
CkJsonObject_DtOf(jResp,'service_date.date_to',False,Date_to);
Text := CkJsonObject__stringOf(jResp,'service_date.text');
shipping_country := CkJsonObject__stringOf(jResp,'shipping_country');
status := CkJsonObject__stringOf(jResp,'status');
text := CkJsonObject__stringOf(jResp,'text');
text_prefix := CkJsonObject__stringOf(jResp,'text_prefix');
text_tax := CkJsonObject__stringOf(jResp,'text_tax');
title := CkJsonObject__stringOf(jResp,'title');
v_type := CkJsonObject__stringOf(jResp,'type');
use_shipping_address := CkJsonObject_BoolOf(jResp,'use_shipping_address');
vat_country := CkJsonObject__stringOf(jResp,'vat_country');
vat_id := CkJsonObject__stringOf(jResp,'vat_id');
fulfillment_country := CkJsonObject__stringOf(jResp,'fulfillment_country');
vat_option := CkJsonObject__stringOf(jResp,'vat_option');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'attachment_ids');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'attachment_ids[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'customer_snapshot.additional_groups_ids');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'customer_snapshot.additional_groups_ids[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'customer_snapshot.emails');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'customer_snapshot.emails[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'item_notes');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'item_notes[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'items');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
v_number := CkJsonObject__stringOf(jResp,'items[i].number');
description := CkJsonObject__stringOf(jResp,'items[i].description');
document_note := CkJsonObject__stringOf(jResp,'items[i].document_note');
quantity := CkJsonObject_IntOf(jResp,'items[i].quantity');
quantity_str := CkJsonObject__stringOf(jResp,'items[i].quantity_str');
unit := CkJsonObject__stringOf(jResp,'items[i].unit');
v_type := CkJsonObject__stringOf(jResp,'items[i].type');
position := CkJsonObject__stringOf(jResp,'items[i].position');
single_price_net := CkJsonObject__stringOf(jResp,'items[i].single_price_net');
single_price_gross := CkJsonObject__stringOf(jResp,'items[i].single_price_gross');
vat_percent := CkJsonObject_IntOf(jResp,'items[i].vat_percent');
discount := CkJsonObject__stringOf(jResp,'items[i].discount');
discount_type := CkJsonObject__stringOf(jResp,'items[i].discount_type');
position_id := CkJsonObject__stringOf(jResp,'items[i].position_id');
total_price_net := CkJsonObject__stringOf(jResp,'items[i].total_price_net');
total_price_gross := CkJsonObject__stringOf(jResp,'items[i].total_price_gross');
total_vat := CkJsonObject__stringOf(jResp,'items[i].total_vat');
serial_number_id := CkJsonObject__stringOf(jResp,'items[i].serial_number_id');
serial_number := CkJsonObject__stringOf(jResp,'items[i].serial_number');
booking_account := CkJsonObject__stringOf(jResp,'items[i].booking_account');
export_cost_1 := CkJsonObject__stringOf(jResp,'items[i].export_cost_1');
export_cost_2 := CkJsonObject__stringOf(jResp,'items[i].export_cost_2');
cost_price_net := CkJsonObject__stringOf(jResp,'items[i].cost_price_net');
cost_price_total := CkJsonObject__stringOf(jResp,'items[i].cost_price_total');
cost_price_charge := CkJsonObject__stringOf(jResp,'items[i].cost_price_charge');
cost_price_charge_type := CkJsonObject__stringOf(jResp,'items[i].cost_price_charge_type');
itemType := CkJsonObject__stringOf(jResp,'items[i].itemType');
id := CkJsonObject__stringOf(jResp,'items[i].id');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'file_format_config');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
v_type := CkJsonObject__stringOf(jResp,'file_format_config[i].type');
i := i + 1;
end;
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
CkDtObj_Dispose(Date_from);
CkDtObj_Dispose(Date_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": ""
}
]
}
