FacturaSend

https://www.facturasend.com.py/docs
Admin
FacturaSend is an electronic invoicing API platform for managing and issuing electronic documents...
Tokens:3,829
Snippets:39
Trust Score:4.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get JSON Example by Document Type

Source: https://www.facturasend.com.py/docs

Provides a JSON example for a specific document type.

```APIDOC
## GET /document/electronic/json/example/{type}

### Description
Provides a JSON example for a specific type of electronic document.

### Method
GET

### Endpoint
/document/electronic/json/example/{type}

### Parameters
#### Path Parameters
- **type** (string) - Required - The type of the document (e.g., 'invoice', 'credit_note').

### Response
#### Success Response (200)
- **json_example** (object) - An example JSON payload for the specified document type.
```

--------------------------------

### Get Dependency Version

Source: https://www.facturasend.com.py/docs

Retrieves the version of the API's dependencies.

```APIDOC
## GET /version/dependencies

### Description
Retrieves the version information for the API's dependencies.

### Method
GET

### Endpoint
/version/dependencies

### Response
#### Success Response (200)
- **versions** (object) - An object detailing the versions of various dependencies.
```

--------------------------------

### Get Digital Receipt KuDE

Source: https://www.facturasend.com.py/docs

Retrieves the KuDE for a digital receipt.

```APIDOC
## GET /receipt/digital/{id}/kude

### Description
Retrieves the KuDE for a digital receipt.

### Method
GET

### Endpoint
/receipt/digital/{id}/kude

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the digital receipt.

### Response
#### Success Response (200)
- **kude** (string) - The KuDE of the digital receipt.
```

--------------------------------

### Get Electronic Document KuDE

Source: https://www.facturasend.com.py/docs

Retrieves the KuDE (Código Único de Documento Electrónico) of an electronic document.

```APIDOC
## GET /document/electronic/{id}/kude

### Description
Retrieves the KuDE of an electronic document.

### Method
GET

### Endpoint
/document/electronic/{id}/kude

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the electronic document.

### Response
#### Success Response (200)
- **kude** (string) - The KuDE of the electronic document.
```

--------------------------------

### SIFEN - Consult DTE by CDC

Source: https://www.facturasend.com.py/docs

Queries SIFEN to get DTE (Documento Tributario Electrónico) details using CDC.

```APIDOC
## GET /sifen/dte/consult/{cdc}

### Description
Consults SIFEN for DTE details using the CDC.

### Method
GET

### Endpoint
/sifen/dte/consult/{cdc}

### Parameters
#### Path Parameters
- **cdc** (string) - Required - The CDC of the DTE.

### Response
#### Success Response (200)
- **dte_data** (object) - The DTE data retrieved from SIFEN.
```

--------------------------------

### Get Electronic Document XML

Source: https://www.facturasend.com.py/docs

Retrieves the XML representation of an electronic document.

```APIDOC
## GET /document/electronic/{id}/xml

### Description
Retrieves the XML content of an electronic document.

### Method
GET

### Endpoint
/document/electronic/{id}/xml

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the electronic document.

### Response
#### Success Response (200)
- **xml_content** (string) - The XML content of the document.
```

--------------------------------

### Get Electronic Document JSON Structure

Source: https://www.facturasend.com.py/docs

Provides the JSON structure for an electronic document.

```APIDOC
## GET /document/electronic/json/structure

### Description
Returns the standard JSON structure for an electronic document.

### Method
GET

### Endpoint
/document/electronic/json/structure

### Response
#### Success Response (200)
- **json_structure** (object) - The JSON schema for electronic documents.
```

--------------------------------

### Handle Conformity Event

Source: https://www.facturasend.com.py/docs

Submits a conformity event for an electronic document.

```APIDOC
## POST /document/electronic/{id}/event/conform

### Description
Submits a conformity event for an electronic document.

### Method
POST

### Endpoint
/document/electronic/{id}/event/conform

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the electronic document.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the conformity event submission.
```

--------------------------------

### Create Digital Receipt

Source: https://www.facturasend.com.py/docs

Creates a digital receipt.

```APIDOC
## POST /receipt/digital

### Description
Creates a digital receipt.

### Method
POST

### Endpoint
/receipt/digital

### Request Body
- **receipt_data** (object) - Required - The data for the digital receipt.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of receipt creation.
- **id** (string) - The ID of the created digital receipt.
```

--------------------------------

### Consult Cities

Source: https://www.facturasend.com.py/docs

Retrieves a list of all available cities.

```APIDOC
## GET /catalog/cities

### Description
Retrieves a list of all cities.

### Method
GET

### Endpoint
/catalog/cities

### Response
#### Success Response (200)
- **cities** (array) - A list of city objects.
```

--------------------------------

### Handle Unknown Event

Source: https://www.facturasend.com.py/docs

Submits an unknown event for an electronic document.

```APIDOC
## POST /document/electronic/{id}/event/unknown

### Description
Submits an unknown event for an electronic document.

### Method
POST

### Endpoint
/document/electronic/{id}/event/unknown

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the electronic document.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the unknown event submission.
```

--------------------------------

### Consult Contributor Parameters

Source: https://www.facturasend.com.py/docs

Retrieves the parameters configured for the contributor.

```APIDOC
## GET /contributor/parameters

### Description
Retrieves the parameters configured for the contributor.

### Method
GET

### Endpoint
/contributor/parameters

### Response
#### Success Response (200)
- **parameters** (object) - An object containing contributor parameters.
```

--------------------------------

### Consult Departments

Source: https://www.facturasend.com.py/docs

Retrieves a list of all available departments.

```APIDOC
## GET /catalog/departments

### Description
Retrieves a list of all departments.

### Method
GET

### Endpoint
/catalog/departments

### Response
#### Success Response (200)
- **departments** (array) - A list of department objects.
```

--------------------------------

### Handle Notification Event

Source: https://www.facturasend.com.py/docs

Submits a notification event for an electronic document.

```APIDOC
## POST /document/electronic/{id}/event/notify

### Description
Submits a notification event for an electronic document.

### Method
POST

### Endpoint
/document/electronic/{id}/event/notify

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the electronic document.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the notification event submission.
```

--------------------------------

### Create Electronic Document

Source: https://www.facturasend.com.py/docs

Allows the creation of an electronic document.

```APIDOC
## POST /document/electronic

### Description
Creates an electronic document.

### Method
POST

### Endpoint
/document/electronic

### Request Body
- **json_data** (object) - Required - The JSON payload representing the electronic document.

### Response
#### Success Response (200)
- **message** (string) - Description of the success.
- **id** (string) - The ID of the created electronic document.
- **cdc** (string) - The CDC of the created electronic document.
```

--------------------------------

### Consult Districts

Source: https://www.facturasend.com.py/docs

Retrieves a list of all available districts.

```APIDOC
## GET /catalog/districts

### Description
Retrieves a list of all districts.

### Method
GET

### Endpoint
/catalog/districts

### Response
#### Success Response (200)
- **districts** (array) - A list of district objects.
```

--------------------------------

### Handle Nomination Event

Source: https://www.facturasend.com.py/docs

Submits a nomination event for an electronic document.

```APIDOC
## POST /document/electronic/{id}/event/nominate

### Description
Submits a nomination event for an electronic document.

### Method
POST

### Endpoint
/document/electronic/{id}/event/nominate

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the electronic document.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the nomination event submission.
```

--------------------------------

### Handle Cancellation Event

Source: https://www.facturasend.com.py/docs

Submits a cancellation event for an electronic document.

```APIDOC
## POST /document/electronic/{id}/event/cancel

### Description
Submits a cancellation event for an electronic document.

### Method
POST

### Endpoint
/document/electronic/{id}/event/cancel

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the electronic document.

### Request Body
- **reason** (string) - Required - The reason for cancellation.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the cancellation event submission.
```

--------------------------------

### Handle Disconformity Event

Source: https://www.facturasend.com.py/docs

Submits a disconformity event for an electronic document.

```APIDOC
## POST /document/electronic/{id}/event/disconform

### Description
Submits a disconformity event for an electronic document.

### Method
POST

### Endpoint
/document/electronic/{id}/event/disconform

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the electronic document.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the disconformity event submission.
```

--------------------------------

### Consult Document by CDC

Source: https://www.facturasend.com.py/docs

Retrieves an electronic document using its CDC (Control de Correo Certificado).

```APIDOC
## GET /document/electronic/cdc/{cdc}

### Description
Retrieves an electronic document by its CDC.

### Method
GET

### Endpoint
/document/electronic/cdc/{cdc}

### Parameters
#### Path Parameters
- **cdc** (string) - Required - The CDC of the electronic document.

### Response
#### Success Response (200)
- **document_data** (object) - The data of the electronic document.
```

--------------------------------

### SIFEN - Consult RUC

Source: https://www.facturasend.com.py/docs

Queries the SIFEN system to validate a RUC (Registro Único de Contribuyentes).

```APIDOC
## GET /sifen/ruc/consult/{ruc}

### Description
Consults the SIFEN system to validate a RUC.

### Method
GET

### Endpoint
/sifen/ruc/consult/{ruc}

### Parameters
#### Path Parameters
- **ruc** (string) - Required - The RUC to validate.

### Response
#### Success Response (200)
- **validation_result** (object) - The result of the RUC validation.
```

--------------------------------

### Manage Draft Batches

Source: https://www.facturasend.com.py/docs

Operations related to managing batches of documents in draft status.

```APIDOC
## GET /document/batches/draft

### Description
Retrieves a list of document batches currently in draft status.

### Method
GET

### Endpoint
/document/batches/draft

### Response
#### Success Response (200)
- **batches** (array) - A list of draft document batches.
```

--------------------------------

### Consult Document Statuses

Source: https://www.facturasend.com.py/docs

Retrieves the status of electronic documents.

```APIDOC
## GET /document/electronic/statuses

### Description
Retrieves the statuses of electronic documents.

### Method
GET

### Endpoint
/document/electronic/statuses

### Response
#### Success Response (200)
- **statuses** (array) - A list of document statuses.
```

--------------------------------

### Consult Document by ID

Source: https://www.facturasend.com.py/docs

Retrieves an electronic document using its unique ID.

```APIDOC
## GET /document/electronic/{id}

### Description
Retrieves an electronic document by its ID.

### Method
GET

### Endpoint
/document/electronic/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the document.

### Response
#### Success Response (200)
- **document_data** (object) - The data of the electronic document.
```

--------------------------------

### Consult Document by Number

Source: https://www.facturasend.com.py/docs

Retrieves an electronic document using its document number.

```APIDOC
## GET /document/electronic/number/{number}

### Description
Retrieves an electronic document by its number.

### Method
GET

### Endpoint
/document/electronic/number/{number}

### Parameters
#### Path Parameters
- **number** (string) - Required - The document number.

### Response
#### Success Response (200)
- **document_data** (object) - The data of the electronic document.
```

--------------------------------

### Handle Invalidation Event

Source: https://www.facturasend.com.py/docs

Submits an invalidation event for an electronic document.

```APIDOC
## POST /document/electronic/{id}/event/invalidate

### Description
Submits an invalidation event for an electronic document.

### Method
POST

### Endpoint
/document/electronic/{id}/event/invalidate

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the electronic document.

### Request Body
- **reason** (string) - Required - The reason for invalidation.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the invalidation event submission.
```

--------------------------------

### Resend Document WhatsApp Message

Source: https://www.facturasend.com.py/docs

Resends the WhatsApp message for a specific document.

```APIDOC
## POST /document/electronic/{id}/whatsapp/resend

### Description
Resends the WhatsApp message for a specific electronic document.

### Method
POST

### Endpoint
/document/electronic/{id}/whatsapp/resend

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the electronic document.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message that the WhatsApp message has been resent.
```

--------------------------------

### Consult Email Sending Status

Source: https://www.facturasend.com.py/docs

Checks the status of an email sent for a document.

```APIDOC
## GET /document/electronic/{id}/email/status

### Description
Consults the status of an email sent for a document.

### Method
GET

### Endpoint
/document/electronic/{id}/email/status

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the electronic document.

### Response
#### Success Response (200)
- **status** (string) - The status of the email sending.
```

--------------------------------

### Resend Document Email

Source: https://www.facturasend.com.py/docs

Resends the email for a specific document.

```APIDOC
## POST /document/electronic/{id}/email/resend

### Description
Resends the email for a specific electronic document.

### Method
POST

### Endpoint
/document/electronic/{id}/email/resend

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the electronic document.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message that the email has been resent.
```

--------------------------------

### Update Electronic Document Status

Source: https://www.facturasend.com.py/docs

Updates the current status of an electronic document.

```APIDOC
## PUT /document/electronic/{id}/status

### Description
Updates the current status of an electronic document.

### Method
PUT

### Endpoint
/document/electronic/{id}/status

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the electronic document.

### Request Body
- **status** (string) - Required - The new status for the document.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the status update.
```

--------------------------------

### Modify DTE Extra Data

Source: https://www.facturasend.com.py/docs

Modifies extra data associated with a DTE (Documento Tributario Electrónico).

```APIDOC
## PUT /document/dte/{id}/extradata

### Description
Modifies extra data for a DTE.

### Method
PUT

### Endpoint
/document/dte/{id}/extradata

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the DTE.

### Request Body
- **extra_data** (object) - Required - The extra data to update.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the update.
```
Tokens:
Raw