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