Documents

Represents a type of document by which a transaction is declared. This object is used by the Subscriptions, Billing APIs and the Purchases application.

Document object

Attributes

Attributes

id string Unique object's identifier.

currency object Base currency used by document type. Learn more about currencies

tax decimal Base tax percentage used by document type.

code string Internal Piriod ID to the document type.

name string Name of the document type.

has_taxes string Determines if the document type includes taxes.

has_taxes_detail boolean Determines if the document type shows taxes.

has_lines_total boolean Determines if taxes are included in the lines of the related object to the document type.

has_local_format boolean Determines if the related object to the document type has a local format representation.

hold_taxes boolean Determines if the related object to the document type hold taxes (add or subtract).

is_foreign boolean Determines if the document type can be used to foreign operations.

is_sale boolean Determines if the document type can be used to sale operations.

is_purshase boolean Determines if the document type can be used to purchase operations.

is_order boolean Determines if the document type can be used to shipping operations.

send boolean Determine if it supports submissions through the Reminders API.

given boolean Determines if the document type can be given to another business through tax agency.

country string The country to which the document type belongs. Learn more about countries

Document object

{
  "id": "US1",
  "currency": {
    "id": "USD",
    "conversion": null,
    "name": "Dólar Estadounidense",
    "name_en": "American Dollar",
    "default": true,
    "is_chargeable": true,
    "available": true,
    "rounded": false,
    "country": "US"
  },
  "tax": 0,
  "code": 1,
  "name": "Invoice",
  "has_taxes": false,
  "has_taxes_detail": false,
  "has_lines_total": false,
  "has_local_format": false,
  "hold_taxes": false,
  "is_foreign": false,
  "is_sale": true,
  "is_purshase": true,
  "is_order": false,
  "send": true,
  "given": false,
  "country": "US"
}

List documents

GET https://api.piriod.com/generals/documents/

Lists documents types objects. Learn more about pagination and filtering.

Query Parameters

Name	Type	Description
country	string	ID string of a particular country or multiple countries (using __in filter operator)
currency	string	ID string of a particular currency or multiple currencies (using __in filter operator)
is_sale	string	True or False
is_purchase	string	True or False
is_order	string	True or False
hold_taxes	string	True or False

200 A list with document list.

{
  "count": 6,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "US1",
      "currency": {
        "id": "USD",
        "conversion": null,
        "name": "Dólar Estadounidense",
        "name_en": "American Dollar",
        "default": true,
        "is_chargeable": true,
        "available": true,
        "rounded": false,
        "country": "US"
      },
      "tax": 0,
      "code": 1,
      "name": "Invoice",
      "has_taxes": false,
      "has_taxes_detail": false,
      "has_lines_total": false,
      "has_local_format": false,
      "hold_taxes": false,
      "is_foreign": false,
      "is_sale": true,
      "is_purshase": true,
      "is_order": false,
      "send": true,
      "given": false,
      "country": "US"
    },
    {
      "id": "CL33",
      "currency": {
        "id": "CLP",
        "conversion": null,
        "name": "Peso Chileno",
        "name_en": "Chilean Peso",
        "default": true,
        "is_chargeable": true,
        "available": true,
        "rounded": true,
        "country": "CL"
      },
      "tax": 19,
      "code": 33,
      "name": "Factura electrónica",
      "has_taxes": true,
      "has_taxes_detail": true,
      "has_lines_total": false,
      "has_local_format": true,
      "hold_taxes": false,
      "is_foreign": false,
      "is_sale": true,
      "is_purshase": true,
      "is_order": false,
      "send": true,
      "given": true,
      "country": "CL"
    },
    {
      "id": "CL34",
      "currency": {
        "id": "CLP",
        "conversion": null,
        "name": "Peso Chileno",
        "name_en": "Chilean Peso",
        "default": true,
        "is_chargeable": true,
        "available": true,
        "rounded": true,
        "country": "CL"
      },
      "tax": 19,
      "code": 34,
      "name": "Factura exenta electrónica",
      "has_taxes": false,
      "has_taxes_detail": false,
      "has_lines_total": false,
      "has_local_format": true,
      "hold_taxes": false,
      "is_foreign": false,
      "is_sale": true,
      "is_purshase": true,
      "is_order": false,
      "send": true,
      "given": true,
      "country": "CL"
    },
    {
      "id": "CL39",
      "currency": {
        "id": "CLP",
        "conversion": null,
        "name": "Peso Chileno",
        "name_en": "Chilean Peso",
        "default": true,
        "is_chargeable": true,
        "available": true,
        "rounded": true,
        "country": "CL"
      },
      "tax": 19,
      "code": 39,
      "name": "Boleta electrónica",
      "has_taxes": true,
      "has_taxes_detail": true,
      "has_lines_total": true,
      "has_local_format": true,
      "hold_taxes": false,
      "is_foreign": false,
      "is_sale": true,
      "is_purshase": true,
      "is_order": false,
      "send": true,
      "given": false,
      "country": "CL"
    },
    {
      "id": "CL41",
      "currency": {
        "id": "CLP",
        "conversion": null,
        "name": "Peso Chileno",
        "name_en": "Chilean Peso",
        "default": true,
        "is_chargeable": true,
        "available": true,
        "rounded": true,
        "country": "CL"
      },
      "tax": 19,
      "code": 41,
      "name": "Boleta exenta electrónica",
      "has_taxes": false,
      "has_taxes_detail": true,
      "has_lines_total": true,
      "has_local_format": true,
      "hold_taxes": false,
      "is_foreign": false,
      "is_sale": true,
      "is_purshase": true,
      "is_order": false,
      "send": true,
      "given": false,
      "country": "CL"
    },
    {
      "id": "CL110",
      "currency": {
        "id": "USD",
        "conversion": null,
        "name": "Dólar Estadounidense",
        "name_en": "American Dollar",
        "default": true,
        "is_chargeable": true,
        "available": true,
        "rounded": false,
        "country": "US"
      },
      "tax": 19,
      "code": 110,
      "name": "Factura electrónica de exportación",
      "has_taxes": false,
      "has_taxes_detail": false,
      "has_lines_total": false,
      "has_local_format": true,
      "hold_taxes": false,
      "is_foreign": false,
      "is_sale": true,
      "is_purshase": false,
      "is_order": false,
      "send": true,
      "given": false,
      "country": "CL"
    }
  ]
}