API

Core models

These are the code models which will normally be used for Receipt validation.

class django_afip.models.PointOfSales(*args, **kwargs)

Represents an existing AFIP point of sale.

Points of sales need to be created via AFIP’s web interface and it is recommended that you use fetch_points_of_sales() to fetch these programatically.

Parameters:

• number (PositiveSmallIntegerField) – Number
• issuance_type (CharField) – Indicates if thie POS emits using CAE and CAEA.
• blocked (BooleanField) – Blocked
• drop_date (DateField) – Drop date
• owner_id (ForeignKey to TaxPayer) – Owner

class django_afip.models.Receipt(*args, **kwargs)

A receipt, as sent to AFIP.

Note that AFIP allows sending ranges of receipts, but this isn’t generally what you want, so we model invoices individually.

You’ll probably want to relate some Sale or Order object from your model with each Receipt.

All document_ fields contain the recipient’s data.

Parameters:

• batch_id (ForeignKey to ReceiptBatch) – Receipts are validated in batches, so it must be assigned one before validation is possible.
• concept_id (ForeignKey to ConceptType) – Concept
• document_type_id (ForeignKey to DocumentType) – The document type of the customer to whom this receipt is addressed
• document_number (BigIntegerField) – The document number of the customer to whom this receipt is addressed
• receipt_number (PositiveIntegerField) – Receipt number
• issued_date (DateField) – Can diverge up to 5 days for good, or 10 days otherwise
• total_amount (DecimalField) – Must be equal to untaxed amount + exempt amount + taxes + vat.
• net_untaxed (DecimalField) – The total amount to which taxes do not apply. For C-type receipts, this must be zero.
• net_taxed (DecimalField) – The total amount to which taxes apply. For C-type receipts, this is equal to the subtotal.
• exempt_amount (DecimalField) – Only for categories which are tax-exempt. For C-type receipts, this must be zero.
• service_start (DateField) – Date on which a service started. No applicable for goods.
• service_end (DateField) – Date on which a service ended. No applicable for goods.
• expiration_date (DateField) – Date on which this receipt expires. No applicable for goods.
• currency_id (ForeignKey to CurrencyType) – Currency in which this receipt is issued.
• currency_quote (DecimalField) – Quote of the day for the currency used in the receipt
• receipt_type_id (ForeignKey to ReceiptType) – Receipt type
• point_of_sales_id (ForeignKey to PointOfSales) – Point of sales
• related_receipts (ManyToManyField) – Related receipts

class django_afip.models.ReceiptBatch(*args, **kwargs)

Receipts are validated sent in batches.

AFIP’s webservice validates receipts in batches. Many users will want to validate receipts individually, so it’s okay to create a batch with a single receipt.

Parameters:

• receipt_type_id (ForeignKey to ReceiptType) – Receipt type
• point_of_sales_id (ForeignKey to PointOfSales) – Point of sales

validate(ticket=None)

Validates all receipts assigned to this batch.

Attempting to validate an empty batch will do nothing.

Any receipts that fail validation are removed from the batch, so you should never need to modify a batch after validation.

Returns a list of errors as returned from AFIP’s webservices. An exception is not raised because partial failures are possible.

class django_afip.models.ReceiptValidation(*args, **kwargs)

The validation for a single receipt.

This contains all validation-related data for a receipt, including its CAE and the CAE expiration, unless validation ahs failed.

The observation field may contain any data returned by AFIP regarding validation failure.

Parameters:

• validation_id (ForeignKey to Validation) – Validation
• result (CharField) – Result
• cae (CharField) – Cae
• cae_expiration (DateField) – Cae expiration
• receipt_id (OneToOneField to Receipt) – Receipt
• observations (ManyToManyField) – Observations

class django_afip.models.Tax(*args, **kwargs)

A tax (type+amount) for a specific Receipt.

Parameters:

• tax_type_id (ForeignKey to TaxType) – Tax type
• description (CharField) – Description
• base_amount (DecimalField) – Base amount
• aliquot (DecimalField) – Aliquot
• amount (DecimalField) – Amount
• receipt_id (ForeignKey to Receipt) – Receipt

compute_amount()

Auto-assign and return the total amount for this tax.

class django_afip.models.TaxPayer(*args, **kwargs)

Represents an AFIP TaxPayer.

This class has the bare minimum required for most AFIP services.

Note that multiple instances of this object can actually represent the same taxpayer, each using a different key.

Parameters:

• name (CharField) – A friendly name to recognize this taxpayer.
• key (FileField) – Key
• certificate (FileField) – Certificate
• cuit (BigIntegerField) – Cuit
• is_sandboxed (BooleanField) – Indicates if this taxpayer interacts with the sandbox servers rather than the production servers

create_ticket(service)

Create an AuthTicket for a given service.

fetch_points_of_sales(ticket=None)

Fetch all point of sales objects.

Fetch all point of sales from the WS and store (or update) them locally.

Returns a list of tuples with the format (pos, created,).

get_or_create_ticket(service)

Return or create a new AuthTicket for a given serivce.

Return an existing ticket for a service if one is available, otherwise, create a new one and return that.

This is generally the preferred method of obtaining tickets for any service.

get_ticket(service)

Return an existing AuthTicket for a given service.

class django_afip.models.Validation(*args, **kwargs)

The validation result for a batch.

The validation result for an attempt to validate a batch. Note that each Receipt inside the batch will have its own ReceiptValidation.

Parameters:

• processed_date (DateTimeField) – Processed date
• result (CharField) – Result
• batch_id (ForeignKey to ReceiptBatch) – Receipt batch

class django_afip.models.Vat(*args, **kwargs)

A VAT (type+amount) for a specific Receipt.

Parameters:

• vat_type_id (ForeignKey to VatType) – Vat type
• base_amount (DecimalField) – Base amount
• amount (DecimalField) – Amount
• receipt_id (ForeignKey to Receipt) – Receipt

PDF-related models

These models are used only for PDF generation, or can be used for storing additional non-validated metadata. You DO NOT need any of these classes unless you intend to generate PDFs for receipts.

class django_afip.models.ReceiptEntry(*args, **kwargs)

An entry in a receipt.

Each ReceiptEntry represents a line in printable version of a Receipt.

Parameters:

• receipt_id (ForeignKey to Receipt) – Receipt
• description (CharField) – Description
• amount (PositiveSmallIntegerField) – Amount
• unit_price (DecimalField) – Unit price
• vat_id (ForeignKey to VatType) – Vat

total_price

The total price for this line (amount * price).

class django_afip.models.ReceiptPDF(*args, **kwargs)

Printable version of a receipt.

Models all print-related data of a receipt and references generated PDF files.

You will never need to ever use this model if you do not intend to generate receipt PDFs, or intend to use your own logic to generate them.

Parameters:

• receipt_id (OneToOneField to Receipt) – Receipt
• pdf_file (FileField) – Pdf file
• issuing_name (CharField) – Issuing name
• issuing_address (TextField) – Issuing address
• issuing_email (CharField) – Issuing email
• vat_condition (CharField) – Vat condition
• gross_income_condition (CharField) – Gross income condition
• client_name (CharField) – Client name
• client_address (TextField) – Client address
• sales_terms (CharField) – Sales terms

save_pdf()

Save the receipt as a PDF related to this model.

save_pdf_to(file_)

Save the receipt as an actual PDF file into a custom location.

class django_afip.models.TaxPayerProfile(*args, **kwargs)

Custom information about a taxpayer, used in printed receipts.

Most of these can be overriden per-receipt, and are usually just defaults.

None of these are required or sent to the AFIP when notifying about receipt generation. They are used only for PDF generation.

Parameters:

• taxpayer_id (OneToOneField to TaxPayer) – Taxpayer
• issuing_name (CharField) – Issuing name
• issuing_address (TextField) – Issuing address
• issuing_email (CharField) – Issuing email
• vat_condition (CharField) – Vat condition
• gross_income_condition (CharField) – Gross income condition
• sales_terms (CharField) – The terms of the sale printed onto receipts by default (eg: single payment, checking account, etc).
• active_since (DateField) – Date since which this taxpayer has been legally active.

Metadata models

These models represent metadata like currency types or document types. Their tables should be populated from AFIP’s webservices, using the afipmetadata command.

class django_afip.models.ConceptType(*args, **kwargs)

An AFIP concept type.

See the AFIP’s documentation for details on each concept type.

Parameters:

• code (CharField) – Code
• description (CharField) – Description
• valid_from (DateField) – Valid from
• valid_to (DateField) – Valid until

class django_afip.models.CurrencyType(*args, **kwargs)

An AFIP curreny type.

See the AFIP’s documentation for details on each currency type.

Parameters:

• code (CharField) – Code
• description (CharField) – Description
• valid_from (DateField) – Valid from
• valid_to (DateField) – Valid until

class django_afip.models.DocumentType(*args, **kwargs)

An AFIP document type.

See the AFIP’s documentation for details on each document type.

Parameters:

• code (CharField) – Code
• description (CharField) – Description
• valid_from (DateField) – Valid from
• valid_to (DateField) – Valid until

class django_afip.models.Observation(*args, **kwargs)

An observation returned by AFIP.

AFIP seems to assign re-used codes to Observation, so we actually store them as separate objects, and link to them from failed validations.

Parameters:

• code (PositiveSmallIntegerField) – Code
• message (CharField) – Message

class django_afip.models.ReceiptType(*args, **kwargs)

An AFIP receipt type.

See the AFIP’s documentation for details on each receipt type.

Parameters:

• code (CharField) – Code
• description (CharField) – Description
• valid_from (DateField) – Valid from
• valid_to (DateField) – Valid until

class django_afip.models.TaxType(*args, **kwargs)

An AFIP tax type.

See the AFIP’s documentation for details on each tax type.

Parameters:

• code (CharField) – Code
• description (CharField) – Description
• valid_from (DateField) – Valid from
• valid_to (DateField) – Valid until

class django_afip.models.VatType(*args, **kwargs)

An AFIP VAT type.

See the AFIP’s documentation for details on each VAT type.

Parameters:

• code (CharField) – Code
• description (CharField) – Description
• valid_from (DateField) – Valid from
• valid_to (DateField) – Valid until