Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
#include <C_CkDtObj.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
HCkDtObj Date_from;
HCkDtObj Date_to;
const char *strVal;
const char *description;
const char *document_note;
int quantity;
const char *quantity_str;
const char *unit;
const char *position;
const char *single_price_net;
const char *single_price_gross;
int vat_percent;
const char *position_id;
const char *total_price_net;
const char *total_price_gross;
const char *total_vat;
const char *serial_number_id;
const char *serial_number;
const char *booking_account;
const char *export_cost_1;
const char *export_cost_2;
const char *cost_price_net;
const char *cost_price_total;
const char *cost_price_charge;
const char *cost_price_charge_type;
const char *itemType;
const char *Salutation;
const char *Personal;
const char *Title;
const char *First_name;
const char *Last_name;
const char *Suffix_1;
const char *Suffix_2;
const char *Company_name;
const char *Street;
const char *Zip_code;
const char *City;
const char *State;
const char *Country;
const char *label_addressSalutation;
const char *label_addressPersonal;
const char *label_addressTitle;
const char *label_addressFirst_name;
const char *label_addressLast_name;
const char *label_addressSuffix_1;
const char *label_addressSuffix_2;
const char *label_addressCompany_name;
const char *label_addressStreet;
const char *label_addressZip_code;
const char *label_addressCity;
const char *label_addressState;
const char *label_addressCountry;
const char *amount;
const char *amount_net;
const char *bank_debit_form;
const char *billing_country;
int calc_vat_from;
const char *cancel_id;
const char *cash_allowance;
const char *cash_allowance_days;
const char *cash_allowance_text;
const char *contact_id;
const char *contact_label;
const char *contact_text;
const char *created_at;
const char *v_currency;
const char *customer_id;
const char *customer_snapshotLast_name;
const char *customer_snapshotCompany_name;
int Acquire_options;
const char *Bank_account;
const char *Bank_account_owner;
const char *Bank_bic;
const char *Bank_code;
const char *Bank_iban;
const char *Bank_name;
const char *Birth_date;
const char *Cash_allowance;
int Cash_allowance_days;
const char *Cash_discount;
const char *Cash_discount_type;
const char *customer_snapshotCity;
const char *customer_snapshotState;
const char *customer_snapshotCountry;
const char *Created_at;
const char *Updated_at;
const char *Delivery_title;
const char *Delivery_city;
const char *Delivery_state;
const char *Delivery_company_name;
const char *Delivery_country;
const char *Delivery_first_name;
const char *Delivery_last_name;
const char *Delivery_personal;
int Delivery_salutation;
const char *Delivery_street;
const char *Delivery_suffix_1;
const char *Delivery_suffix_2;
const char *Delivery_zip_code;
const char *Display_name;
const char *Fax;
const char *customer_snapshotFirst_name;
const char *Grace_period;
const char *Due_in_days;
const char *Group_id;
const char *Id;
const char *Info_1;
const char *Info_2;
const char *Internet;
const char *Login_id;
const char *Mobile;
const char *Note;
const char *v_Number;
int Payment_options;
BOOL customer_snapshotPersonal;
const char *Phone_1;
const char *Phone_2;
const char *Postbox;
const char *Postbox_city;
const char *Postbox_state;
const char *Postbox_country;
const char *Postbox_zip_code;
const char *Sale_price_level;
int customer_snapshotSalutation;
const char *Sepa_agreement;
const char *Sepa_agreement_date;
const char *Sepa_mandate_reference;
const char *Since_date;
const char *customer_snapshotStreet;
const char *customer_snapshotSuffix_1;
const char *customer_snapshotSuffix_2;
const char *Tax_number;
const char *Court;
const char *Court_registry_number;
const char *Tax_options;
const char *customer_snapshotTitle;
const char *Archived;
const char *Vat_identifier;
const char *customer_snapshotZip_code;
const char *Document_pdf_type;
const char *Buyer_reference;
const char *Foreign_supplier_number;
const char *discount;
const char *discount_type;
const char *document_date;
const char *due_date;
const char *edited_at;
const char *external_id;
const char *replica_url;
const char *grace_period;
const char *due_in_days;
const char *id;
BOOL is_acceptable_on_public_domain;
BOOL is_archive;
const char *is_draft;
BOOL is_replica;
BOOL is_oss;
const char *last_postbox_id;
const char *login_id;
const char *v_number;
const char *order_number;
const char *buyer_reference;
const char *paid_amount;
const char *paid_at;
const char *pdf_pages;
const char *pdf_template;
const char *project_id;
const char *Next_date;
const char *Frequency;
const char *Frequency_special;
int Interval;
const char *End_date_or_count;
const char *Status;
BOOL As_draft;
BOOL Is_notify;
const char *Send_as;
BOOL Is_sign;
BOOL Is_paid;
const char *Paid_date_option;
BOOL Is_sepa;
const char *Sepa_local_instrument;
const char *Sepa_sequence_type;
const char *Sepa_reference;
const char *Sepa_remittance_information;
const char *Target_type;
const char *ref_id;
const char *root_id;
const char *v_Type;
const char *Date;
const char *Text;
const char *shipping_country;
const char *status;
const char *text;
const char *text_prefix;
const char *text_tax;
const char *title;
const char *v_type;
BOOL use_shipping_address;
const char *vat_country;
const char *vat_id;
const char *fulfillment_country;
const char *vat_option;
int i;
int count_i;
// 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) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
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) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"attachment_ids[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"customer_snapshot.additional_groups_ids");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"customer_snapshot.additional_groups_ids[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"customer_snapshot.emails");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"customer_snapshot.emails[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"item_notes");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"item_notes[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"items");
while (i < count_i) {
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;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"file_format_config");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
v_type = CkJsonObject_stringOf(jResp,"file_format_config[i].type");
i = i + 1;
}
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": ""
}
]
}
