📄 MIPYME Documents

Update a specific document

PUT

Endpoint URL https://api-billing.koywe.com/V1/documents/{document_id}

Requires authentication

Authentication

Send header Authorization: Bearer <token> (obtained from POST /auth) for protected endpoints.

Parameters

Name	Location	Type	Required	Description
`document_id`	`path`	string	✓	—

Request body — fields

Field	Type	Required	Description
`document_id`	integer	Optional	Document ID.
`document_status`	integer	Optional	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.
`header`	object	Optional	—
`header.account_id`	integer	Optional	Account ID.
`header.document_type_id`	integer	Always required	Document type ID according to document type table.
`header.document_type_taxbureau`	string	Optional	Type of document at the tax bureau.
`header.document_number`	integer	Optional	Document number.
`header.received_issued_flag`	integer	Optional	0 = received 1 = issued
`header.taxbureau_validation_status`	integer	Optional	Document status at the tax bureau.
`header.issue_date`	string (date)	Always required	Document issue date.
`header.issuer_tax_id_code`	string	Optional	Tax ID code according to tax id table. Required when the document requires the receiver to be specified.
`header.issuer_tax_id_type`	string	Optional	Tax ID type according to tax id table. Required when the document requires the receiver to be specified.
`header.issuer_legal_name`	string	Optional	Issuer legal name
`header.issuer_address`	string	Always required	Issuer address
`header.issuer_district`	string	Always required	Identifier for the district of the document issuer
`header.issuer_city`	string	Always required	Identifier for the city of the document issuer
`header.issuer_state_id`	integer	Optional	Refers to the issuer's state. Empty if it doesn't apply. This is a required field on some countries, check the examples for your country
`header.issuer_country_id`	integer	Optional	Identifier for the country of the document issuer
`header.issuer_phone`	string	Always required	Issuer phone number
`header.issuer_activity`	string	Always required	Represents the activity or business operation of the document issuer
`header.customer_supplier_id`	integer	Optional	Returns the customer or supplier ID
`header.receiver_tax_id_code`	string	Optional	The tax identification code of the document receiver
`header.receiver_tax_id_type`	string	Optional	Tax ID type according to tax id table. Required when the document requires the receiver to be specified.
`header.receiver_legal_name`	string	Optional	Receiver legal name
`header.receiver_address`	string	Always required	Required address
`header.receiver_district`	string	Always required	The location code of the document receiver
`header.receiver_city`	string	Always required	The city of the document receiver
`header.receiver_state_id`	integer	Optional	Refers to the recipient's state. Empty if it doesn't apply. This is a required field on some countries, check the examples for your country
`header.receiver_country_id`	integer	Optional	Country ID according to ID table
`header.receiver_phone`	string	Always required	The phone of the document receiver
`header.receiver_activity`	string	Always required	The activity of the document receiver
`header.receiver_postalcode`	string	Optional	Optional postal code according to the national format.
`header.payment_conditions`	string	Optional	Payment due dates separated by comma. Example: 0 = same day 30 = 30 days 0,30 = 50% on issuance date, 50% 30 days later 0,30,60 = 33% on issuance, 33% 30 days, 34% 60 days
`header.currency_id`	number	Always required	Currency ID according to currency table
`header.exchange_rate_value`	integer	Optional	Only when currency_id is defined and its value is a foreign currency.
`header.sale_modality`	integer	Optional	Only for export documents: optional. Valid values: 1 = Sale agreed 2 = Under condition 3 = Free consignment 4 = Consignment with minimum sale 9 = No payment
`header.sale_clause`	integer	Optional	Only for export documents: optional. Valid values: 1 = CIF 2 = CFR 3 = EXW 4 = FAS 5 = FOB 6 = S/CL 9 = DDP 10 = FCA 11 = CPT 12 = CIP 17 = DAT 18 = DAP 8 = Other
`header.transportation_doc_type`	number	Optional	Waybills only. 1 = Operation constitutes a sale 2 = Ventas por efectuar 3 = Consignaciones 4 = Entrega gratuita 5 = Traslados internos 6 = Otros traslados no venta 7 = Guía de devolución 8 = Traslado para exportación (no venta) 9 = Venta para exportación
`header.transportation_doc_billing`	number	Optional	Waybills only. 1 = Despacho por cuenta del receptor 2 = Despacho por cuenta del emisor a instalaciones del receptor 3 = Despacho por cuenta del emisor a otras instalaciones
`header.document_status`	number	Optional	0 = draft 1 = document_issued 2 = document sent to counterparty 3 = document accepted by counterparty
`details`	array<object>	Optional	—
`details[].quantity`	number	Always required	Quantity of this product or service included in this line
`details[].line_description`	string	Optional	Short description to be included in the invoice as line title. Max 100 chars
`details[].unit_measure`	string	Optional	Unit that this line is measured in
`details[].unit_price`	number	Always required	Price per unit
`details[].long_description`	string	Optional	Long description to be included in the invoice as line title. Max 100 chars
`details[].modifier_amount`	number	Optional	—
`details[].total_taxes`	number	Optional	Total of all taxes included for this detail
`details[].modifier_percentage`	number	Optional	Positive or negative percentage to be applied before calculating the line total. Example: -6.5 for a 6.5% discount
`details[].total_amount_line`	number	Always required	Total of the line, including net price and taxes
`totals`	object	Optional	—
`totals.net_amount`	number	Always required	Total of all net values from each of the detail lines.
`totals.taxes_amount`	number	Optional	Total of all other taxes
`totals.total_amount`	number	Always required	Document grand total
`electronic_document`	object	Optional	—
`electronic_document.document_xml`	string	Optional	Base64 encoded XML
`electronic_document.document_pdf`	string	Optional	Base64 encoded PDF
`electronic_document.stamp_img`	string	Optional	Base64 encoded stamp image
`electronic_document.document_transfer_copy_pdf`	string	Optional	Base64 encoded transfer copy PDF (copia cedible). Present when pdf_transfer_copy option was used on create or GET. VALID ONLY FOR CHILE.
`payment_link`	object	Optional	—
`payment_link.payment_url`	string	Optional	URL of the payment link for the document
`result`	object	Optional	—
`result.status`	integer	Optional	Represents the current status of the result
`result.error_message`	string	Optional	URL of the payment link for the document

Request body — JSON example

{
    "document_id": 0,
    "document_status": 0,
    "header": {
        "account_id": 0,
        "document_type_id": 0,
        "document_type_taxbureau": "string",
        "document_number": 0,
        "received_issued_flag": 0,
        "taxbureau_validation_status": 0,
        "issue_date": "string",
        "issuer_tax_id_code": "string",
        "issuer_tax_id_type": "string",
        "issuer_legal_name": "string",
        "issuer_address": "string",
        "issuer_district": "string",
        "issuer_city": "string",
        "issuer_state_id": 0,
        "issuer_country_id": 0,
        "issuer_phone": "string",
        "issuer_activity": "string",
        "customer_supplier_id": 0,
        "receiver_tax_id_code": "string",
        "receiver_tax_id_type": "string",
        "receiver_legal_name": "string",
        "receiver_address": "string",
        "receiver_district": "string",
        "receiver_city": "string",
        "receiver_state_id": 0,
        "receiver_country_id": 0,
        "receiver_phone": "string",
        "receiver_activity": "string",
        "receiver_postalcode": "string",
        "payment_conditions": "string",
        "currency_id": 0,
        "exchange_rate_value": 0,
        "sale_modality": 0,
        "sale_clause": 0,
        "transportation_doc_type": 0,
        "transportation_doc_billing": 0,
        "document_status": 0
    },
    "details": [
        {
            "quantity": 0,
            "line_description": "string",
            "unit_measure": "string",
            "unit_price": 0,
            "long_description": "string",
            "modifier_amount": 0,
            "total_taxes": 0,
            "modifier_percentage": 0,
            "total_amount_line": 0
        }
    ],
    "totals": {
        "net_amount": 0,
        "taxes_amount": 0,
        "total_amount": 0
    },
    "electronic_document": {
        "document_xml": "string",
        "document_pdf": "string",
        "stamp_img": "string",
        "document_transfer_copy_pdf": "string"
    },
    "payment_link": {
        "payment_url": "string"
    },
    "result": {
        "status": 0,
        "error_message": "string"
    }
}

Responses

Document updated successfully

Request PUT /documents/{document_id}

curl -X PUT \
  "https://api-billing.koywe.com/V1/documents/{document_id}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"..."}'

Response

{
    "document_id": 0,
    "document_status": 0,
    "header": {
        "account_id": 0,
        "document_type_id": 0,
        "document_type_taxbureau": "string",
        "document_number": 0,
        "received_issued_flag": 0,
        "taxbureau_validation_status": 0,
        "issue_date": "string",
        "issuer_tax_id_code": "string",
        "issuer_tax_id_type": "string",
        "issuer_legal_name": "string",
        "issuer_address": "string",
        "issuer_district": "string",
        "issuer_city": "string",
        "issuer_state_id": 0,
        "issuer_country_id": 0,
        "issuer_phone": "string",
        "issuer_activity": "string",
        "customer_supplier_id": 0,
        "receiver_tax_id_code": "string",
        "receiver_tax_id_type": "string",
        "receiver_legal_name": "string",
        "receiver_address": "string",
        "receiver_district": "string",
        "receiver_city": "string",
        "receiver_state_id": 0,
        "receiver_country_id": 0,
        "receiver_phone": "string",
        "receiver_activity": "string",
        "receiver_postalcode": "string",
        "payment_conditions": "string",
        "currency_id": 0,
        "exchange_rate_value": 0,
        "sale_modality": 0,
        "sale_clause": 0,
        "transportation_doc_type": 0,
        "transportation_doc_billing": 0,
        "document_status": 0
    },
    "details": [
        {
            "quantity": 0,
            "line_description": "string",
            "unit_measure": "string",
            "unit_price": 0,
            "long_description": "string",
            "modifier_amount": 0,
            "total_taxes": 0,
            "modifier_percentage": 0,
            "total_amount_line": 0
        }
    ],
    "totals": {
        "net_amount": 0,
        "taxes_amount": 0,
        "total_amount": 0
    },
    "electronic_document": {
        "document_xml": "string",
        "document_pdf": "string",
        "stamp_img": "string",
        "document_transfer_copy_pdf": "string"
    },
    "payment_link": {
        "payment_url": "string"
    },
    "result": {
        "status": 0,
        "error_message": "string"
    }
}