Update a specific document

1 import requests 2 3 url = "https://api-billing.koywe.com/V1/documents/document_id" 4 5 payload = {} 6 headers = { 7 "Authorization": "Bearer <token>", 8 "Content-Type": "application/json" 9 } 10 11 response = requests.put(url, json=payload, headers=headers) 12 13 print(response.json())

1 { 2 "document_id": 1, 3 "document_status": 1, 4 "header": { 5 "document_type_id": 1, 6 "issue_date": "issue_date", 7 "issuer_address": "issuer_address", 8 "issuer_district": "issuer_district", 9 "issuer_city": "issuer_city", 10 "issuer_phone": "issuer_phone", 11 "issuer_activity": "issuer_activity", 12 "receiver_address": "receiver_address", 13 "receiver_district": "receiver_district", 14 "receiver_city": "receiver_city", 15 "receiver_phone": "receiver_phone", 16 "receiver_activity": "receiver_activity", 17 "currency_id": 1.1, 18 "account_id": 1, 19 "document_type_taxbureau": "document_type_taxbureau", 20 "document_number": 1, 21 "received_issued_flag": 1, 22 "taxbureau_validation_status": 1, 23 "issuer_tax_id_code": "issuer_tax_id_code", 24 "issuer_tax_id_type": "issuer_tax_id_type", 25 "issuer_legal_name": "issuer_legal_name", 26 "issuer_state_id": 1, 27 "issuer_country_id": 1, 28 "customer_supplier_id": 1, 29 "receiver_tax_id_code": "receiver_tax_id_code", 30 "receiver_tax_id_type": "receiver_tax_id_type", 31 "receiver_legal_name": "receiver_legal_name", 32 "receiver_state_id": 1, 33 "receiver_country_id": 1, 34 "receiver_postalcode": "receiver_postalcode", 35 "payment_conditions": "payment_conditions", 36 "exchange_rate_value": 1, 37 "sale_modality": 1, 38 "sale_clause": 1, 39 "transportation_doc_type": 1.1, 40 "transportation_doc_billing": 1.1, 41 "document_status": 1.1 42 }, 43 "details": [ 44 { 45 "quantity": 1.1, 46 "unit_price": 1.1, 47 "total_amount_line": 1.1, 48 "line_description": "line_description", 49 "unit_measure": "unit_measure", 50 "long_description": "long_description", 51 "modifier_amount": 1.1, 52 "total_taxes": 1.1, 53 "modifier_percentage": 1.1 54 } 55 ], 56 "totals": { 57 "net_amount": 1.1, 58 "total_amount": 1.1, 59 "taxes_amount": 1.1 60 }, 61 "electronic_document": { 62 "document_xml": "document_xml", 63 "document_pdf": "document_pdf", 64 "stamp_img": "stamp_img" 65 }, 66 "payment_link": { 67 "payment_url": "payment_url" 68 }, 69 "result": { 70 "status": 1, 71 "error_message": "error_message" 72 } 73 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

document_idstringRequired

Request

This endpoint expects an object.

document_idintegerOptional

Document ID.

document_statusintegerOptional

Indicates the status of the document. 0 = Draft (Chile only), 1 = issued, 2 = cancelled (Mexico only). Changing this value through PATCH operations will issue or cancel the document.

headerobjectOptional

detailslist of objectsOptional

totalsobjectOptional

electronic_documentobjectOptional

payment_linkobjectOptional

resultobjectOptional

Response

Document updated successfully

document_idinteger or null

Document ID.

document_statusinteger or null

Indicates the status of the document. 0 = Draft (Chile only), 1 = issued, 2 = cancelled (Mexico only). Changing this value through PATCH operations will issue or cancel the document.

headerobject or null

detailslist of objects or null

totalsobject or null

electronic_documentobject or null

payment_linkobject or null

resultobject or null

Authentication

Path Parameters

Request

Response

Errors