YABI•CO E-INVOICE GRAPHQL API REFERENCE

API version 2.0 YABI•CO e-invoice (electronic invoice) in compliance with Resolution 000012 of 2021 of Colombia, which adopts the Technical Annex of Electronic Sales Invoice in its version 1.8 ,the Technical Annex Support Document version 1.0, and resolution 000085 of the RADIAN in order to provide an updated tool, developed under the UBL 2.1 standard for the generation and online validation of electronic invoicing as a technology provider authorized by the DIAN.

Contact

API Support

soporte@yabi.co

API Endpoints
# Staging (The endpoint will be provided when you purchase our plans):
https://api.yabi.co/
# Production (The endpoint will be provided when you purchase our plans):
https://api.yabi.co/
Headers
# Your foo from bar
Authorization: Bearer <YOUR_TOKEN_HERE>

GraphQL

GraphQL is an open-source data query and manipulation language for APIs, and a runtime for fulfilling queries with existing data. Our API is developed in GRAPHQL, for more information please visit the GraphQL website.

Client Libraries

Use YABI•CO officially supported libraries to make API queries.
- Curl: to make API queries from the command line.
- Insomnia: API client, you can quickly and easily send REST, SOAP, GraphQL, and GRPC requests directly within Insomnia.
The examples we deliver with our plan are with this tool.

Authentication

The token is created through the YABI•CO API manager.

Electronic Documents Reception

It is the reception of electronic documents (electronic sales invoices, credit notes, debit notes and electronic invoice events) that your suppliers make to you.
Because the DIAN does not have in its web service the consultation of the list of sales invoices made by your suppliers, and you can only search the invoice by CUFE or CUDE, our API has two alternatives for the reception of the documents, the first is to automatically forward emails with electronic invoices from your suppliers to a yabi.co email or from your ERP you can send the CUFE or CUDE that you want to receive.
In the case of the credit sales invoices events that your customers generate to these, these are received by mail, but to provide security to these events yabi.co through our robot YABI-Bot periodically reviews in the DIAN through the CUFE the events sent to the credit sales invoices made.

DIAN Events

  • Acknowledgment of mail reading of Electronic Sales Invoice: It is an event that is not requested by DIAN and that we created for you to perform a tracking task of when the sales invoice has been viewed by your customers. It is executed automatically when the customer (a person) checks or reads the mail if the mail client has the remote content upload active. This event does not involve legal or contractual issues with the electronic sales invoice and as mentioned is informational only. It is not dependent on another event or a prerequisite for another event.
  • Acknowledgment delivery of goods and services of the electronic sales invoice by the electronic biller: This is an event that is not requested by the DIAN and that we have created for you to follow up and inform your customer via e-mail that you have already delivered the goods or provided the service so that your customer has a starting point to continue or perform the events of the credit sales invoice that are pending. Your customer is only notified via mail if he/she has not made the event "Receipt of the goods or rendering of the service". This event does not imply legal or contractual issues with the electronic sales invoice and as indicated is only informative. It does not depend on another event or is a prerequisite for another event.
  • Electronic Sales Invoice Acknowledgement of Receipt: This event only applies to the electronic invoices to credit that your suppliers make to you and can only be made by you, who is the acquirer (debtor) of the invoice. The acknowledgment indicates to your supplier that you received the invoice, this event does not imply the acceptance of the invoice or the products (goods or services). This event has no prior event.
  • Receipt of the good or service rendered: This event only applies to electronic credit invoices issued by your suppliers and can only be performed by you who is the acquirer (debtor) of the invoice. The receipt of the goods only indicates that you received the products (goods or services). This event does not imply tacit acceptance of the invoice or acceptance (that the good or service was delivered in full and without any claim), only the receipt of the goods or service. As a prerequisite of this event, it is necessary to have made the event of “Electronic Invoice of Sale Acknowledgement of Receipt”.
  • Express acceptance of the electronic sales invoice: This event only applies to electronic credit invoices made to you by your suppliers and can only be made by you who are the acquirer(debtor) of the invoice. The express acceptance of the invoice indicates that you accept the content of the invoice (that you have no claims), that the products (goods or services) comply with what is indicated in the invoice, and that they were delivered without any claim. Once this event has taken place, you will NOT be able to generate credit notes or debit notes due to this invoice. You have a term of three working days to make this event when you have made the event Receipt of the goods or rendering of the service, in case of not making this event in this period of time your supplier (electronic biller) can make the event of Tacit Acceptance of Electronic Invoice of Sale. As a prerequisite of this event, it is necessary to have made the event of receipt of the goods or rendering of the service.
  • Tacit Acceptance of the electronic sales invoice: This event only applies to electronic credit invoices that you generate for your customers and can only be made by you as the electronic biller (who issues the invoice). The tacit acceptance of the invoice is made under oath, indicating that after three days the acquirer (debtor customer) did not expressly state the acceptance or rejection of the invoice, or claim against its content. Once this event is done, it will NOT be able to create notes, credit, or debit notes due to this invoice. This can only be done on the fourth business day and if your customer has not made the event of express acceptance of the Electronic Sale Invoice or the event of Claim of the Electronic Bill of Sale. As a prerequisite for this event, it is necessary that your customer has made the event of receipt of the goods or provision of the service.
  • Rejection of the electronic sales invoice: This event only applies to electronic invoices to credit that your suppliers make to you and can only be made by you who are the acquirer (debtor) of the invoice. The claim implies that you reject or have a claim on the invoice or on the products (goods or services) received. Once this event has taken place, it will not be possible to carry out the events of express or tacit acceptance of the invoice, and it is recommended that your supplier generates a cancellation credit note. You have a period of three working days after the event of receipt of products to perform this event, if not performed in this period of time your supplier can perform the event of tacit acceptance. For this event is necessary to have made the event of receipt of the good or service rendered.

Notes: If you want to use as support the credit sales invoices that your suppliers generate as expenses, costs, and deductible taxes, it is mandatory to make these events from July 13, 2022. If you do not make these events, you will NOT be able to use the invoices as support for expenses, costs, and deductible taxes, in case you do it for example in the VAT tax the DIAN will not know these expenses, costs, and deductible taxes, and you will have to assume the VAT of these purchases.
In other electronic invoicing platforms there is an acceptance or rejection button for electronic invoices that are made in the seller´s platform, but this is not what is requested by resolution 000085 of April 8, 2022, of the DIAN (this type of button YABI-co has not implemented them because they lack technical and legal validity), because these events should not be made by the seller (the electronic biller who generated the electronic sales invoice) and are not digitally signed, nor sent as electronic invoicing events to the DIAN. What the DIAN technically requests in this resolution, as explained above in the events, is that the acquirer (debtor customer) must perform the events as a buyer and this cannot and should not be done by the seller with this type of button, since the acquirer must digitally sign these events through its digital certificates of the files (XML) and file them digitally with the DIAN.

Document Status

Sales invoice status

A sales invoice is an accounting document that records a business transaction.
Sales invoice provide the business with a record of the services they have provided to a client.
This invoice can be paid on credit or in cash, it is on credit when the payment for the products or services purchased is made after a certain period of time, and it is in cash when the payment for the products or services that have been purchased is made at the time of delivery.
This is the electronic invoice status, this field "documentStatus" can be found when querying an invoice.

Status Indicator Description Credit Cash
YABICO_ CREATED E-invoice filed with YABI•CO. X X
DIAN_ VALIDATING The DIAN is currently validating the electronic invoice. X X
DIAN_ REJECTED DIAN has rejected the invoice due to the following errors: - reason 1 ... - reason n X X
DIAN_ VALIDATED Electronic invoice validated by DIAN. X X
SEND_ EMAIL Mail sent to the customer and to the electronic biller. X X
PRODUCTS_ DELIVERY The customer abc has acknowledged receipt of the sales invoice. X N/A
MAIL_ RECEPTION_ ACK Your customer has opened or viewed the email, not necessarily read or reviewed it in detail. X X
RECEIPT_ ACK The customer abc has acknowledged receipt of the sales invoice. X N/A
PRODUCTS_ RECEPTION Your customer abc has made the receipt of the good or service provision of the electronic sales invoice. X N/A
EXPRESS_ ACCEPTANCE Your customer abc has expressly accepted the electronic sales invoice from your supplier. X N/A
REJECTION Your customer abc has made the claim for the electronic sales invoice, it is recommended that the cancellation credit note be generated. X N/A
REJECTION_ ISSUED_ CREDIT_ NOTE Your customer abc has made the claim for the electronic sales invoice and has already made the cancellation credit note. X N/A
TACIT_ ACCEPTANCE User abc has made a tacit acceptance of the electronic sales invoice, since his customer did not make the express acceptance or claim within three business days after receipt of the good or service. X N/A

Purchase invoice status

A purchase invoice is an invoice that is used in conjunction with a purchase order. It is used to indicate how much money the buyer owes to the seller. Purchase invoices are the invoices that companies generate for you as a buyer. This invoice can be paid on credit or in cash, it is on credit when the payment for the products or services purchased is made after a certain period of time, and it is in cash when the payment for the products or services that have been purchased is made at the time of delivery.

This is the electronic invoice status, this field "documentStatus" can be found when querying an invoice.

Status Indicator Description Credit Cash
DIAN_ VALIDATED The electronic sales invoice from your supplier has been added to YABI-CO via mail/API. X X
RECEIPT_ ACK User abc has acknowledged receipt of the sales invoice from his supplier. X N/A
PRODUCTS_ RECEPTION The user abc has received the receipt of the good or service from the electronic sales invoice from his supplier. X N/A
EXPRESS_ ACCEPTANCE User abc has expressly accepted the electronic sales invoice from his supplier. X N/A
REJECTION User abc has claimed the electronic sales invoice from his supplier and his supplier is pending to generate the credit note to cancel the invoice. X N/A
REJECTION_ ISSUED_ CREDIT_ NOTE User abc has made a claim for the electronic sales invoice from his supplier and his supplier has already generated a credit note to cancel the invoice. X N/A
TACIT_ ACCEPTANCE Your supplier has made a tacit acceptance of the electronic sales invoice, since he did not make the express acceptance or claim within three business days after receipt of the good or service. X N/A

Credit note status

A legal document used in purchase and sale transactions involving a discount subsequent to the issuance of the invoice, a total cancellation, a collection of an over-incurred expense or the partial or total return of goods.

Status Indicator Description
YABICO_CREATED The credit note has been filed with YABI-CO.
DIAN_VALIDATING The credit note is being validated at DIAN.
DIAN_REJECTED The credit note was rejected by DIAN for the following reasons: - reason 1...- reason n
DIAN_VALIDATED The credit note has been validated by DIAN.
SEND_EMAIL The credit note was sent to the acquirer (debtor customer) and to the electronic biller.

Debit note status

It is a document or accounting voucher used to specify the debts incurred by the acquirer of the document.

Status Indicator Description
YABICO_CREATED The debit note has been filed with YABI-CO.
DIAN_VALIDATING The debit note is being validated at DIAN.
DIAN_REJECTED The debit note was rejected by DIAN for the following reasons: - reason 1...- reason n
DIAN_VALIDATED The debit note has been validated by DIAN.
SEND_EMAIL The debit note was sent to the acquirer (debtor customer) and to the electronic biller.

Acquisition support document status

It is the document that supports the purchase of a good or the rendering of a service when the supplier is not obliged to issue electronic invoices.

Status Indicator Description
YABICO_CREATED The supporting document for acquisitions from non-obligated parties has been filed with YABI-CO.
DIAN_VALIDATING The supporting document for acquisitions from non-obligated parties is being validated at the DIAN.
DIAN_REJECTED The supporting document for acquisitions from non-obligated parties was rejected by the DIAN for the following reasons: - reason 1 - reason n
DIAN_VALIDATED The supporting document for acquisitions from non-obligated parties has been validated by the DIAN.
SEND_EMAIL The support document for acquisitions from non-obligated parties was sent to the acquiring mail (debtor client) and to the electronic invoicer.

Error codes

Error processing

In the standard defined by Neia SAS, all errors must have:

  • id: Error code defined under the standard of the present document.
  • type: General type of the error (e.g. inputError, formError, etc.).
  • subType: Error subtype that specifies the general type. This should be defined by the microservice, application or web portal as appropriate.
  • message: A message explaining the error itself.
  • title: A title or name of the error itself.
  • helpText: A help text that can be used by the person receiving the error to understand the cause of the error and how to correct it or, in the worst case, notify the help desk. In general, this should be a URL to which the user who has received the error can go to find useful information about the error.
  • language: Language in which the error is returned. By default all errors are returned in English (en-US).

Error Code Standard

Any error code will be a three-digit string `XXX` specifying the general error type, followed by a hyphen and an alphanumeric subtype modifier `Y`.
Below you will find the types, subtypes and codes defined to date. These will be returned in the `type`, `subType` and `id` fields respectively. Each type and subtype will go with its respective code. General errors will generally not have an alphanumeric modifier.

Application errors

Code range:`0XX-YYZ`

Request Errors (000-XY):

It may occur because the request does not include mandatory values or does not define one of the allowed values for a certain field.
Code Name Description
000-99 unknownError Error unknown or not contemplated in the request.

Validation errors (001-XYZ):

Validation errors occur when there are fields with inconsistent or incorrectly filled out information.
General Errors
Code Name Description
001-T1 taxes Inconsistencies Inconsistencies presented in the taxes.
001-T2 taxes Dont Exist In Lines The document reported taxes that do not exist in the lines.
001-T3 taxes Dont Exist Taxes that do not exist in the (type) of the document were reported in the lines.
001-T4 sum Of Taxes Error When comparing the sum of taxes of the lines is different from the sum of those reported in the document.
001-T5 sum Of Taxes Not Consistent When operating sum(documentLines/ taxDescription/ taxAmount) = A , it is not consistent with sum(taxDescription/ taxAmount) = B.
001-T6 sum Of Taxes Not Consistent When operating sum(documentLines/ taxDescription/ roundingAmount) = A, it is not consistent with sum(taxDescription/ roundingAmount) = B.
001-T7 taxes Reported Are Different The taxes reported on the lines are different from the taxes reported at the document level.
001-T8 tax Not Found In Totals The taxNameDescription reported in the lines is not found in the totals.
001-LT1 line Totals Error The sum of sum(documentLines/ taxDescription/ taxAmount) = A , it is not consistent with taxDescription/ taxAmount = B.
001-DS1 withholding Subtotals Error The inconsistencies presented in the subtotals of witholdings
001-DS2 taxes Subtotals Error The inconsistencies presented in the subtotals of taxes
001-DS3 percent Subtotals Error The percent reported subtotals of tax_name in the lines are not consistent with those in the document.
001-DS4 subtotals Error The sum of sum(documentLines/ taxDescription/ taxAmount) = A when it is {tax_name}, it is not consistent with taxDescription/ taxAmount = B.
001-DS5 subtotals Error The sum of sum(documentLines/ taxDescription/ taxableAmount) = A when it is {tax_name}, it is not consistent with taxDescription/ taxableAmount = B.
001-LA1 line Extension Amount Error Error presented in lineExtensionAmount
001-LA2 line Extension Amount Error When operating (price - discounts) + charges = A, it is not consistent with the entered value B.
001-LA3 line Extension Amount Error When operating (price - discounts) + charges = A = value, must be greater than or equal to 0.
001-PD1 payment Description Error PaymentDescription(Prepayments): Error presented in the list of prepaids.
001-ID1 issue Date Error The date (date_time) must be less than the invoice issue date.
001-PM1 price Modifier Error Error presented in priceModifier object of type X.
001-PC1 price Change Error When operating (base_amount * (percentage / 100)) = A, it is not consistent with the entered value B.
001-TD1 tax Description Error Error presented in the taxDescription: tax_name
001-TD2 tax Groups Error There cannot be two tax groups of the same type in a line.
001-TD3 tax Inconsistencies When operating sum(taxSubtotal/ taxAmout) = A, it is not consistent with the entered value B.
001-TD4 tax Inconsistencies When operating (sum((taxSubtotal/ taxableAmout * taxSubtotal/ percent) - taxSubtotal/ taxAmout) withholding_name, it is not consistent with the entered value X.
001-TS1 tax Subtotals Error Error presented in the tax subtotals: There must be subtotals of the tax paid.
001-TS2 tax Subtotals Value Error The value of taxable_amount(A) must be greater than or equal to 0.
001-TS3 tax Subtotals Value Error The value of taxable_amount(A) must be less than or equal to (B).
001-TS4 tax Subtotals Percentage Error There cannot be two percentages in the subtotals with the same value.
001-LT2 sum Lines Error Totals: Error presented when comparing the total results and the sum of the lines.
001-DT1 discounts Error When we compare documentTotals/ allowanceTotalAmount(A) with the sum of discounts(B) on the lines it does not match.
001-DT2 charges Error When we compare documentTotals/ chargeTotalAmount(A) with the sum of charges(B) on the lines it does not match.
001-DT3 line Error When we compare documentTotals/ lineExtensionAmount(A) with the sum of line extension amounts(B) on the lines it does not match.
001-DT4 tax Exclusive Error When we compare documentTotals/ taxExclusiveAmount(A) with the sum of tax amount(B) on the lines it does not match.
001-DT5 tax Inclusive Error When we compare documentTotals/ taxInclusiveAmount(A) with the sum of tax amount(B) on the lines it does not match.
001-DT6 prePaid Amount Error When we compare documentTotals/ prePaidAmount(A) with the sum of prepayments(B) it does not match.
001-DW1 withholdings Inconsistencies Inconsistencies presented in the withholdings.
001-DW2 withholdings Inconsistencies The witholdings reported on the lines are different from the witholdings reported at the document level.
001-DW3 withholding Description Error Error presented in the withholdingDescription:
001-DW4 withholding Groups Error There cannot be two withholding groups of the same type in a line.
001-DW5 withholding Subtotal Error When operating sum(withholdingSubtotal/ taxAmout) = A, it is not consistent with the entered value B.
001-DW6 not Consistent Withholdings Error When operating (sum((withholdingSubtotal/ taxableAmout * withholdingSubtotal/ percent) - withholdingSubtotal/ taxAmout) = A, it is not consistent with the entered value B.
001-DW7 withholdings Subtotals Error There must be subtotals of the withholding paid.
001-DW8 withholdings Percent Error "When operating ({taxable_amount} * ({withholding.percent} / 100)) = A, it is not consistent with the entered value B.
001-DW9 taxable Amount Error The value of taxable_amount(A) must be greater than or equal to 0
001-DW10 taxable Amount Error The value of taxable_amount(A) must be less than or equal to (B).
001-DW11 subtotals Percentages Error There cannot be two percentages in the subtotals with the same value.
001-F1 field Not Exist The field cannot exist, since the X field exists.
001-N1 Name Error You must enter the corporate name or full name of the person
001-N2 Name Error the first name of the person must be entered in first_name
001-N3 Sur Name Error the first surname of the person must be entered in first_surname
001-N4 invalid Corporate Name According to the type of identification, the corporate name must be entered.
001-D1 wrong Date Compares the dates and returns the error if it was found
001-FN1 non-floating Number The value X is not floating and not decimal
001-V1 Wrong Value In the value X, the value must be greater than or equal to N
001-V2 Wrong Value In the value X, the value must be less than or equal to N
001-V3 Wrong Value In the value X, the number of decimal places in its floating part must have at least N digits
001-V4 Wrong Value In the value X, the number of decimal places in its floating part must have N or fewer digits
001-V5 Wrong Value In the value X, the number of decimal places in its floating part must be between N and M digits
001-V6 Wrong Value The value X entered does not correspond to a GTIN
001-V7 not A Nit The value X entered does not correspond to a NIT
001-V8 percentage Error The percentage must be a whole 1 and 100 with only two digits in its decimal part if it has one.
001-V9 not A Nit It is responsible for validating the size of a text.
Validation errors for specific documents
Invoice Errors
Code Name Description
001-EI1 Invoice Request Error This error only occurs in the context of invoices and only applies to invoice processes.
001-AIU1 Invalid AIU The AIU invoice creation request does not meet the standards for this type of invoice.
001-AIU2 Invalid AIU The AIU invoice creation request has a utility of less than 10%.
001-AL1 Invalid AIU Product Lines The AIU invoice creation request includes more than two detail lines.
001-AT1 Invalid AIU Taxes The AIU invoice creation request has tax validation errors.
001-ALM1 Invalid AIU Modifiers The AIU invoice creation request has detail line modifiers (Charges or Discounts).
001-ALM2 Invalid AIU Modifiers The electronic document request has detail lines with validation errors. The recordable basis reported in the document totals differs from the net taxable basis in the detail lines.
Credit Note
Code Name Description
001-EC1 Credit Note Request Error This error only occurs in the context of credit notes and only applies to credit note processes.
Debit Note
Code Name Description
001-ED1 Debit Note Request Error This error only occurs in the context of debit memos and only applies to debit note processes.
Support Document Request errors
Code Name Description
001-AS1 Support Document Request Error This error only occurs in the context of acquisition support documents and only applies to acquisition support documents processes.

DIAN Errors (002-X)

This type of error only occurs in applications made to DIAN.
Code Name Description
002 DIAN Request Error This error only occurs in applications made to DIAN.

Pagination Errors (003-X)

Paging errors occur because the request includes values that fall outside the range of allowed or possible results.
Code Name Description
003-1 Page Number Error Page number error. This is usually due to the request including a page number that is outside the range of allowed or possible results.
003-2 Page Size Error Page size error. This is usually due to the request including a page number that is outside the range of allowed or possible results.

YABI•CO Errors (004-X)

These are YABI-CO internal errors, usually document generation or database errors.
Code Name
004-1 Database error
004-2 PDF generation error
004-3 Error generating XML
004-4 Database partitioning error
004-5 Insertion record error
004-6 Structure entering error
004-7 Modifying record error
004-8 Structure error when modifying record

Authentication Errors (090)

Authentication errors can be due to invalid credentials.
Code Name Description
090 Authentication Error Authentication error due to invalid credentials.

Key errors or non-existent data (1XX-Y)

These errors may be caused by trying to use a key or data that does not exist within the system.
General errors
Code Name Description
100 dataNotFound Usually occurs in creation or update contexts. It is due to the lack of information associated to one or more of the identifiers (UUID, NIT, C.C., etc.) present in the request.
110 userNotFound Occurs in user handling contexts. This includes; session management, user queries or user modifications.
Business Unit Errors
Code Name Description
100-BU1 Business Unit Not Found This is because there is no Business Unit associated with the uuid present in the application.
Invoice errors
Code Name Description
100-EI1 Invoice Not Found This is because there is no Invoice associated with the UUID or consecutive present in the request.
Credit Note errors
Code Name Description
100-EC1 Credit Note Not Found This is because there is no Credit Note associated to the uuid or consecutive present in the application.
Debit Note errors
Code Name Description
100-ED1 Debit Note Not Found This is because there is no Debit Note associated to the uuid or consecutive present in the application.
Support Document errors
Code Name Description
100-AS1 Support Document Not Found This is because there is no Supporting Document associated to the uuid or consecutive present in the request.

Existing or already used data errors (2XX-Y)

These errors may be caused by trying to use a key or data that already exists within the system.
General Errors:
Code Name Description
200 dataAlreadyUsed One or more fields in the request have unique values already used.
Invoice errors
Code Name Description
200-EI1 Invoice Consecutive Already Used The invoice consecutive has already been used.
Credit Note errors
Code Name Description
200-EC1 Credit Note Consecutive Already Used The credit note consecutive has already been used.
Debit Note errors
Code Name Description
200-ED1 Debit Note Consecutive Already Used The debit note consecutive has already been used.
Support Document errors
Code Name Description
200-AS1 Support Document Consecutive Already Used The support document consecutive has already been used.

Definitions

In the documentation we are going to find that some fields contain elements such as:

  • [1-n]: Identifies that the element or group is mandatory, with a maximum of N occurrences.
  • [0-n]: Identifies that the element or group is optional (possible not to be reported), with a maximum of n occurrences, where n is any integer value.
  • Acquirer: Natural person, legal entity and other subjects that acquire goods and/or services that are obliged to demand and exhibit the sales invoice or equivalent document.
  • Array[a-n]: Means that the object receives a list of objects with a minimum of a object and a maximum of n elements of the specified type. Where n is an integer.
  • Acquisition Support Document: It is the document that supports the purchase of a good or the rendering of a service when the supplier is not obliged to issue electronic invoices. To learn more about the acquisition support document please visit the following DIAN website.
  • Credit Note: A legal document used in purchase and sale transactions involving a discount subsequent to the issuance of the invoice, a total cancellation, a collection of an over-incurred expense or the partial or total return of goods. Our system does not support all types of credit notes, it only accepts the cancellation credit note (voidInvoice) and the partial credit note. To learn more about the credit note document please visit the following DIAN website.
  • Debit Note: It is a document or accounting voucher used to specify the debts incurred by the acquirer of the document. To learn more about the credit note document please visit the following DIAN website.
  • DIAN Events: Prerequisites of the electronic bill of sale as a security instrument. To know more about if, follow the next link.
  • Electronic invoicing (FE) Subject obliged to issue electronic sales invoices, debit notes, credit notes and other electronic documents derived from the electronic sales invoice, in accordance with the requirements, characteristics and conditions, terms and technical and technological mechanisms established by the DIAN.
  • Error: An error message indicates a reason for document rejection by YABI•CO or DIAN.
  • Invoice: A commercial document that reflects all the information of a purchase and sale transaction. The fundamental information that appears in an invoice must reflect the delivery of a product or the provision of a service together with the date of accrual. Additionally; it must indicate the amount to be paid in relation to stocks, goods of a company to be sold for ordinary use of the operation or for its transformation or incorporation to the productive process. Finally, you must indicate the Value Added Tax rate to be applied in relation to the transaction based on the goods or services negotiated. To learn more about the credit note document please visit the following DIAN website.
  • Product: It is defined as the result of processes, either a tangible or intangible element (a good or a service), which generates an income or an added value to whoever produces it.
  • Goods: Goods are of a tangible nature, either an object or a commodity and have certain characteristics:
    • Material: goods can be touched, they are tangible, so their transformation is also possible.
    • Utility: they are capable of satisfying a large number of human desires.
    • Scarcity: goods are scarce because, in general, they are not found in abundance, and therefore almost always have an unrelated value. For example, milk is a scarce good because it is a limited commodity.
    • Transferable: goods can be transferred between individuals by buying and selling.
  • Services: Services are intangible and are defined as an activity provided by a service provider. They have other characteristics different from goods:
    • Intangibility services cannot be touched, but symbolize an action, process or activity.
    • Variability: services are always different from each other, no two services are ever the same since the delivery of each service is performed by a person or personnel in specific places and at specific times. When any of these aspects change, the service offered changes.
    • Inseparability: the services provided are not separated from the one receiving the service, but the process is simultaneous.
  • Notification: It is a message that informs in a formal way any kind of important information about the document. (e.g. "The document is in validation status").
  • String(a-n): indicates that the field will receive a String with a minimum of a and a maximum of n characters. Where a and n are integer values.
  • Transactions: Is a request that is made to the system, where the invoice is registered in our system. It refers to the communication that there is either with our API or from our API to another information system.
  • Warning: A warning message indicates a reason or advice why the document might be rejected.

Queries

accountStatement

Description

Query YabiCo's Plan Summary.

Query the YabiCo's Active Plan Summary using the client's UID.

Response

Returns an AccountStatement

Arguments
Name Description
id - UID!

Unique identifier of the organization.

  • Mandatory: required

Example

Query
query AccountStatement($id: UID!) {
  accountStatement(id: $id) {
    accountStatementId
    availableCredits
    concurrency
    creditsData {
      annualValue
      anualCredits
      creditValue
      monthlyCredits
      monthlyValue
    }
    insertedAt
    notifications
    planName
    planSpecificationEmission {
      adquisitionSupport
      creditNote
      debitNote
      einvoiceAui
      einvoiceCambistas
      einvoiceCambistas1000
      einvoiceCarnicos
      einvoiceStandar
      payroll
      pos
      publicServices
      radianEvents
      tituloValorEvents
    }
    planSpecificationReception {
      creditNote
      debitNote
      einvoice
      tituloValorEvents
    }
    productSpecification
    productVersion
    purchaseDate
    totalCredits
    updatedAt
    validityDateEnd
    validityDateStart
  }
}
Variables
{"id": UID}
Response
{
  "data": {
    "accountStatement": {
      "accountStatementId": "xyz789",
      "availableCredits": decimal,
      "concurrency": 123,
      "creditsData": CreditsData,
      "insertedAt": "2007-12-03T10:15:30Z",
      "notifications": "xyz789",
      "planName": "abc123",
      "planSpecificationEmission": EmissionData,
      "planSpecificationReception": ReceptionData,
      "productSpecification": json,
      "productVersion": 987,
      "purchaseDate": "2007-12-03",
      "totalCredits": decimal,
      "updatedAt": "2007-12-03T10:15:30Z",
      "validityDateEnd": "2007-12-03",
      "validityDateStart": "2007-12-03"
    }
  }
}

accountStatements

Description

Query one or more account statements.

Query to search one or more account statements based on one of the established filters.

Response

Returns an AccountStatementConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - AccountStatementOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - AccountStatementQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

Query
query AccountStatements(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $orderBy: AccountStatementOrderInput,
  $query: AccountStatementQueryInput,
  $skip: Int
) {
  accountStatements(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    orderBy: $orderBy,
    query: $query,
    skip: $skip
  ) {
    edges {
      cursor
      node {
        ...AccountStatementFragment
      }
    }
    pageCursors {
      cursors {
        ...CursorFragment
      }
      page {
        ...PageFragment
      }
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
    totalCount
    totalPages
  }
}
Variables
{
  "after": "abc123",
  "before": "xyz789",
  "first": 123,
  "last": 987,
  "orderBy": "ACCOUNT_STATEMENT_ID_ASC",
  "query": AccountStatementQueryInput,
  "skip": 987
}
Response
{
  "data": {
    "accountStatements": {
      "edges": [AccountStatementEdge],
      "pageCursors": PageCursors,
      "pageInfo": PageInfo,
      "totalCount": 123,
      "totalPages": 123
    }
  }
}

acquisitionAdjustmentNote

Description

Query one acquisition adjustment note.

Makes the query of an electronic acquisition adjustment note by its UID.

Response

Returns an AcquisitionAdjustmentNoteDocument

Arguments
Name Description
uid - UID!

Unique identifier of the acquisition adjustment note.

  • Mandatory: required

Example

Query
query AcquisitionAdjustmentNote($uid: UID!) {
  acquisitionAdjustmentNote(uid: $uid) {
    assessmentState
    billingPrefix {
      creationDate
      id
      prefix
      range {
        ...IntegerRangeFragment
      }
    }
    dianState
    documentLines {
      description {
        ...LocalizedStringFragment
      }
      invoicePeriod {
        ...ProductLinePeriodFragment
      }
      itemDescription {
        ...ItemDescriptorFragment
      }
      lineExtensionAmount
      note {
        ...LocalizedStringFragment
      }
      price {
        ...PriceFragment
      }
      priceModifier {
        ...AllowanceChargeFragment
      }
      pricingReference {
        ...PricingReferenceFragment
      }
      quantity
      taxDescription {
        ...TaxTotalFragment
      }
      unitCode {
        ...UnitCodeOutputFragment
      }
      uuid
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    documentModifiers {
      amount
      baseAmount
      chargeIndicator
      percentage
      reason {
        ...LocalizedStringFragment
      }
      reasonCode {
        ...reasonCodeFragment
      }
    }
    documentParties {
      accountingCustomerParty {
        ...AccountingCustomerPartyFragment
      }
      accountingSupplierParty {
        ...AccountingSupplierPartyFragment
      }
    }
    documentQr
    documentStatus {
      code
      description
    }
    documentTotals {
      allowanceTotalAmount
      chargeTotalAmount
      lineExtensionAmount
      payableAmount
      prePaidAmount
      taxExclusiveAmount
      taxInclusiveAmount
    }
    documentType
    documentUid
    events {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    files {
      attachedDocument {
        ...FileDescriptorFragment
      }
      graphicalRepresentationHtml {
        ...FileDescriptorFragment
      }
      graphicalRepresentationPdf {
        ...FileDescriptorFragment
      }
    }
    generalInformation {
      acquirerEmail
      currency {
        ...CurrencyFragment
      }
      environment
      issueDateTime
      operationCode {
        ...OperationCodeFragment
      }
      subtypeCode {
        ...SubTypeCodeFragment
      }
    }
    goodsState
    id
    insertedAt
    issuerSoftwareSystem {
      companyName
      companyNit
      softwareName
      softwareVersion
    }
    notes {
      key
      value
    }
    organizationalUnitId
    paymentDescription {
      paymentExchangeRate {
        ...PaymentExchangeRateFragment
      }
      paymentMeans {
        ...PaymentMeanFragment
      }
      prepayments {
        ...PrepaidPaymentFragment
      }
    }
    referencedDocuments {
      description {
        ...LocalizedStringFragment
      }
      issueDate
      referenceId
      referenceType {
        ...ReferenceTypeOutputFragment
      }
      uid
    }
    taxDescription {
      roundingAmount
      taxAmount
      taxName {
        ...TaxNameOutputFragment
      }
      taxSubtotal {
        ...TaxSubtotalFragment
      }
    }
    transactions {
      application
      applicationResponse
      documentId
      insertedAt
      requestedAt
      respondedAt
      transactionChannel
      transactionFrom
      transactionId
      transactionStage
      transactionStatus {
        ...TransactionStatusFragment
      }
      transactionTo
      transactionType
      updatedAt
    }
    uid
    updatedAt
    withholdingsDescription {
      roundingAmount
      withholdingAmount
      withholdingName {
        ...WithholdingNameOutputFragment
      }
      withholdingSubtotal {
        ...TaxSubtotalFragment
      }
    }
  }
}
Variables
{"uid": UID}
Response
{
  "data": {
    "acquisitionAdjustmentNote": {
      "assessmentState": 123,
      "billingPrefix": BillingPrefix,
      "dianState": 987,
      "documentLines": [DocumentLine],
      "documentModifiers": [AllowanceCharge],
      "documentParties": DocumentParties,
      "documentQr": "abc123",
      "documentStatus": StatusDescriptor,
      "documentTotals": LegalMonetaryTotal,
      "documentType": "xyz789",
      "documentUid": UID,
      "events": [Event],
      "files": DocumentFiles,
      "generalInformation": GeneralInformationInterface,
      "goodsState": 987,
      "id": "xyz789",
      "insertedAt": "2007-12-03T10:15:30Z",
      "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
      "notes": [DocumentNotesOutput],
      "organizationalUnitId": UID,
      "paymentDescription": DocumentPaymentDescriptor,
      "referencedDocuments": [DocumentReference],
      "taxDescription": [TaxTotal],
      "transactions": [Transaction],
      "uid": UID,
      "updatedAt": "2007-12-03T10:15:30Z",
      "withholdingsDescription": [WithholdingTotal]
    }
  }
}

acquisitionAdjustmentNotes

Description

Query one or more electronic acquisition support document notes.

Query to search one or more electronic acquisition support document notes based on one of the established filters.

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - AcquisitionAdjustmentNoteQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

Query
query AcquisitionAdjustmentNotes(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $orderBy: DocumentOrderInput,
  $query: AcquisitionAdjustmentNoteQueryInput,
  $skip: Int
) {
  acquisitionAdjustmentNotes(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    orderBy: $orderBy,
    query: $query,
    skip: $skip
  ) {
    ... on AcquisitionAdjustmentNoteDocumentConnection {
      edges {
        ...AcquisitionAdjustmentNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on AcquisitionSupportDocumentConnection {
      edges {
        ...AcquisitionSupportDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on CreditNoteConnection {
      edges {
        ...CreditNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on DebitNoteConnection {
      edges {
        ...DebitNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on InvoiceConnection {
      edges {
        ...InvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PosInvoiceConnection {
      edges {
        ...PosInvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseCreditNoteDocumentConnection {
      edges {
        ...PurchaseCreditNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDebitNoteDocumentConnection {
      edges {
        ...PurchaseDebitNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDocumentConnection {
      edges {
        ...PurchaseDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 987,
  "last": 123,
  "orderBy": "CONSECUTIVE_ASC",
  "query": AcquisitionAdjustmentNoteQueryInput,
  "skip": 987
}
Response
{
  "data": {
    "acquisitionAdjustmentNotes": AcquisitionAdjustmentNoteDocumentConnection
  }
}

acquisitionSupportDocument

Description

Query one electronic support document.

Makes the query of an electronic support document by its UID.

Response

Returns an AcquisitionSupportDocument

Arguments
Name Description
uid - UID!

Unique identifier of the acquisition support document.

  • Mandatory: required

Example

Query
query AcquisitionSupportDocument($uid: UID!) {
  acquisitionSupportDocument(uid: $uid) {
    adjustmentNoteSummary {
      date
      id
      orden
      type
      uuid
      value
    }
    assessmentState
    billingPrefix {
      creationDate
      id
      prefix
      range {
        ...IntegerRangeFragment
      }
    }
    dianState
    documentLines {
      description {
        ...LocalizedStringFragment
      }
      invoicePeriod {
        ...ProductLinePeriodFragment
      }
      itemDescription {
        ...ItemDescriptorFragment
      }
      lineExtensionAmount
      note {
        ...LocalizedStringFragment
      }
      price {
        ...PriceFragment
      }
      priceModifier {
        ...AllowanceChargeFragment
      }
      pricingReference {
        ...PricingReferenceFragment
      }
      quantity
      taxDescription {
        ...TaxTotalFragment
      }
      unitCode {
        ...UnitCodeOutputFragment
      }
      uuid
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    documentModifiers {
      amount
      baseAmount
      chargeIndicator
      percentage
      reason {
        ...LocalizedStringFragment
      }
      reasonCode {
        ...reasonCodeFragment
      }
    }
    documentParties {
      accountingCustomerParty {
        ...AccountingCustomerPartyFragment
      }
      accountingSupplierParty {
        ...AccountingSupplierPartyFragment
      }
    }
    documentQr
    documentStatus {
      code
      description
    }
    documentSummary {
      adjustmentNoteTotal
      adjustmentNotes
      referenceDocuments
    }
    documentTotals {
      allowanceTotalAmount
      chargeTotalAmount
      lineExtensionAmount
      payableAmount
      prePaidAmount
      taxExclusiveAmount
      taxInclusiveAmount
    }
    documentType
    documentUid
    events {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    files {
      attachedDocument {
        ...FileDescriptorFragment
      }
      graphicalRepresentationHtml {
        ...FileDescriptorFragment
      }
      graphicalRepresentationPdf {
        ...FileDescriptorFragment
      }
    }
    generalInformation {
      acquirerEmail
      currency {
        ...CurrencyFragment
      }
      environment
      issueDateTime
      operationCode {
        ...OperationCodeFragment
      }
      subtypeCode {
        ...SubTypeCodeFragment
      }
    }
    goodsState
    id
    insertedAt
    issuerSoftwareSystem {
      companyName
      companyNit
      softwareName
      softwareVersion
    }
    notes {
      key
      value
    }
    organizationalUnitId
    paymentDescription {
      paymentExchangeRate {
        ...PaymentExchangeRateFragment
      }
      paymentMeans {
        ...PaymentMeanFragment
      }
      prepayments {
        ...PrepaidPaymentFragment
      }
    }
    referencedDocuments {
      description {
        ...LocalizedStringFragment
      }
      issueDate
      referenceId
      referenceType {
        ...ReferenceTypeOutputFragment
      }
      uid
    }
    taxDescription {
      roundingAmount
      taxAmount
      taxName {
        ...TaxNameOutputFragment
      }
      taxSubtotal {
        ...TaxSubtotalFragment
      }
    }
    transactions {
      application
      applicationResponse
      documentId
      insertedAt
      requestedAt
      respondedAt
      transactionChannel
      transactionFrom
      transactionId
      transactionStage
      transactionStatus {
        ...TransactionStatusFragment
      }
      transactionTo
      transactionType
      updatedAt
    }
    uid
    updatedAt
    withholdingsDescription {
      roundingAmount
      withholdingAmount
      withholdingName {
        ...WithholdingNameOutputFragment
      }
      withholdingSubtotal {
        ...TaxSubtotalFragment
      }
    }
  }
}
Variables
{"uid": UID}
Response
{
  "data": {
    "acquisitionSupportDocument": {
      "adjustmentNoteSummary": [NoteSummary],
      "assessmentState": 987,
      "billingPrefix": BillingPrefix,
      "dianState": 987,
      "documentLines": [DocumentLine],
      "documentModifiers": [AllowanceCharge],
      "documentParties": DocumentParties,
      "documentQr": "xyz789",
      "documentStatus": StatusDescriptor,
      "documentSummary": AcquisitionDocumentSummary,
      "documentTotals": LegalMonetaryTotal,
      "documentType": "abc123",
      "documentUid": UID,
      "events": [Event],
      "files": DocumentFiles,
      "generalInformation": GeneralInformationInterface,
      "goodsState": 123,
      "id": "abc123",
      "insertedAt": "2007-12-03T10:15:30Z",
      "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
      "notes": [DocumentNotesOutput],
      "organizationalUnitId": UID,
      "paymentDescription": DocumentPaymentDescriptor,
      "referencedDocuments": [DocumentReference],
      "taxDescription": [TaxTotal],
      "transactions": [Transaction],
      "uid": UID,
      "updatedAt": "2007-12-03T10:15:30Z",
      "withholdingsDescription": [WithholdingTotal]
    }
  }
}

acquisitionSupportDocuments

Description

Query one or more electronic acquisition support documents.

Query to search one or more electronic acquisition support documents based on one of the established filters.

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - AcquisitionSupportDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

Query
query AcquisitionSupportDocuments(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $orderBy: DocumentOrderInput,
  $query: AcquisitionSupportDocumentQueryInput,
  $skip: Int
) {
  acquisitionSupportDocuments(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    orderBy: $orderBy,
    query: $query,
    skip: $skip
  ) {
    ... on AcquisitionAdjustmentNoteDocumentConnection {
      edges {
        ...AcquisitionAdjustmentNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on AcquisitionSupportDocumentConnection {
      edges {
        ...AcquisitionSupportDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on CreditNoteConnection {
      edges {
        ...CreditNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on DebitNoteConnection {
      edges {
        ...DebitNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on InvoiceConnection {
      edges {
        ...InvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PosInvoiceConnection {
      edges {
        ...PosInvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseCreditNoteDocumentConnection {
      edges {
        ...PurchaseCreditNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDebitNoteDocumentConnection {
      edges {
        ...PurchaseDebitNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDocumentConnection {
      edges {
        ...PurchaseDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 987,
  "orderBy": "CONSECUTIVE_ASC",
  "query": AcquisitionSupportDocumentQueryInput,
  "skip": 123
}
Response
{
  "data": {
    "acquisitionSupportDocuments": AcquisitionAdjustmentNoteDocumentConnection
  }
}

billingResolution

Description

Query one Organization's Billing Resolution.

Query one Organization's Billing Resolution by its UID.

Response

Returns a BillingResolution

Arguments
Name Description
id - UID!

Unique identifier of the billing resolution.

  • Mandatory: required

Example

Query
query BillingResolution($id: UID!) {
  billingResolution(id: $id) {
    billingPrefix
    billingPrefixData {
      endDate
      from
      prefixDescription
      resolutionDate
      startDate
      to
    }
    billingRangeId
    documentType
    insertedAt
    organizationId
    organizationUnitId
    resolutionNumber
    updatedAt
  }
}
Variables
{"id": UID}
Response
{
  "data": {
    "billingResolution": {
      "billingPrefix": "abc123",
      "billingPrefixData": BillingPrefixData,
      "billingRangeId": UID,
      "documentType": "CREDIT_NOTE",
      "insertedAt": "2007-12-03T10:15:30Z",
      "organizationId": UID,
      "organizationUnitId": UID,
      "resolutionNumber": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

billingResolutions

Description

Query one or more Organization's Billing Resolution.

Query to search one or more Organization's Billing Resolution based on one of the established filters.

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - BillingResolutionOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - BillingResolutionQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

Query
query BillingResolutions(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $orderBy: BillingResolutionOrderInput,
  $query: BillingResolutionQueryInput,
  $skip: Int
) {
  billingResolutions(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    orderBy: $orderBy,
    query: $query,
    skip: $skip
  ) {
    edges {
      cursor
      node {
        ...BillingResolutionFragment
      }
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 987,
  "orderBy": "BILLING_RANGE_ID_ASC",
  "query": BillingResolutionQueryInput,
  "skip": 987
}
Response
{
  "data": {
    "billingResolutions": {
      "edges": [BillingResolutionEdge],
      "pageInfo": PageInfo
    }
  }
}

creditNote

Description

Query one electronic sale credit note.

Makes the query of an electronic sale credit note by its UID.

Response

Returns a CreditNote

Arguments
Name Description
uid - UID!

Unique identifier for a credit note.

  • Mandatory: required

Example

Query
query CreditNote($uid: UID!) {
  creditNote(uid: $uid) {
    assessmentState
    billingPrefix {
      creationDate
      id
      prefix
      range {
        ...IntegerRangeFragment
      }
    }
    dianState
    documentLines {
      description {
        ...LocalizedStringFragment
      }
      invoicePeriod {
        ...ProductLinePeriodFragment
      }
      itemDescription {
        ...ItemDescriptorFragment
      }
      lineExtensionAmount
      note {
        ...LocalizedStringFragment
      }
      price {
        ...PriceFragment
      }
      priceModifier {
        ...AllowanceChargeFragment
      }
      pricingReference {
        ...PricingReferenceFragment
      }
      quantity
      taxDescription {
        ...TaxTotalFragment
      }
      unitCode {
        ...UnitCodeOutputFragment
      }
      uuid
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    documentModifiers {
      amount
      baseAmount
      chargeIndicator
      percentage
      reason {
        ...LocalizedStringFragment
      }
      reasonCode {
        ...reasonCodeFragment
      }
    }
    documentParties {
      accountingCustomerParty {
        ...AccountingCustomerPartyFragment
      }
      accountingSupplierParty {
        ...AccountingSupplierPartyFragment
      }
    }
    documentQr
    documentStatus {
      code
      description
    }
    documentTotals {
      allowanceTotalAmount
      chargeTotalAmount
      lineExtensionAmount
      payableAmount
      prePaidAmount
      taxExclusiveAmount
      taxInclusiveAmount
    }
    documentType
    documentUid
    events {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    files {
      attachedDocument {
        ...FileDescriptorFragment
      }
      graphicalRepresentationHtml {
        ...FileDescriptorFragment
      }
      graphicalRepresentationPdf {
        ...FileDescriptorFragment
      }
    }
    generalInformation {
      acquirerEmail
      currency {
        ...CurrencyFragment
      }
      environment
      issueDateTime
      operationCode {
        ...OperationCodeFragment
      }
      subtypeCode {
        ...SubTypeCodeFragment
      }
    }
    goodsState
    id
    insertedAt
    issuerSoftwareSystem {
      companyName
      companyNit
      softwareName
      softwareVersion
    }
    notes {
      key
      value
    }
    organizationalUnitId
    paymentDescription {
      paymentExchangeRate {
        ...PaymentExchangeRateFragment
      }
      paymentMeans {
        ...PaymentMeanFragment
      }
      prepayments {
        ...PrepaidPaymentFragment
      }
    }
    referencedDocuments {
      description {
        ...LocalizedStringFragment
      }
      issueDate
      referenceId
      referenceType {
        ...ReferenceTypeOutputFragment
      }
      uid
    }
    taxDescription {
      roundingAmount
      taxAmount
      taxName {
        ...TaxNameOutputFragment
      }
      taxSubtotal {
        ...TaxSubtotalFragment
      }
    }
    transactions {
      application
      applicationResponse
      documentId
      insertedAt
      requestedAt
      respondedAt
      transactionChannel
      transactionFrom
      transactionId
      transactionStage
      transactionStatus {
        ...TransactionStatusFragment
      }
      transactionTo
      transactionType
      updatedAt
    }
    uid
    updatedAt
    withholdingsDescription {
      roundingAmount
      withholdingAmount
      withholdingName {
        ...WithholdingNameOutputFragment
      }
      withholdingSubtotal {
        ...TaxSubtotalFragment
      }
    }
  }
}
Variables
{"uid": UID}
Response
{
  "data": {
    "creditNote": {
      "assessmentState": 987,
      "billingPrefix": BillingPrefix,
      "dianState": 987,
      "documentLines": [DocumentLine],
      "documentModifiers": [AllowanceCharge],
      "documentParties": DocumentParties,
      "documentQr": "abc123",
      "documentStatus": StatusDescriptor,
      "documentTotals": LegalMonetaryTotal,
      "documentType": "abc123",
      "documentUid": UID,
      "events": [Event],
      "files": DocumentFiles,
      "generalInformation": GeneralInformationInterface,
      "goodsState": 987,
      "id": "abc123",
      "insertedAt": "2007-12-03T10:15:30Z",
      "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
      "notes": [DocumentNotesOutput],
      "organizationalUnitId": UID,
      "paymentDescription": DocumentPaymentDescriptor,
      "referencedDocuments": [DocumentReference],
      "taxDescription": [TaxTotal],
      "transactions": [Transaction],
      "uid": UID,
      "updatedAt": "2007-12-03T10:15:30Z",
      "withholdingsDescription": [WithholdingTotal]
    }
  }
}

creditNotes

Description

Query one or more electronic sale credit notes.

Query to search one or more electronic sale credit notes based on one of the established filters.

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - CreditNoteDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

Query
query CreditNotes(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $orderBy: DocumentOrderInput,
  $query: CreditNoteDocumentQueryInput,
  $skip: Int
) {
  creditNotes(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    orderBy: $orderBy,
    query: $query,
    skip: $skip
  ) {
    ... on AcquisitionAdjustmentNoteDocumentConnection {
      edges {
        ...AcquisitionAdjustmentNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on AcquisitionSupportDocumentConnection {
      edges {
        ...AcquisitionSupportDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on CreditNoteConnection {
      edges {
        ...CreditNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on DebitNoteConnection {
      edges {
        ...DebitNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on InvoiceConnection {
      edges {
        ...InvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PosInvoiceConnection {
      edges {
        ...PosInvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseCreditNoteDocumentConnection {
      edges {
        ...PurchaseCreditNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDebitNoteDocumentConnection {
      edges {
        ...PurchaseDebitNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDocumentConnection {
      edges {
        ...PurchaseDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 987,
  "orderBy": "CONSECUTIVE_ASC",
  "query": CreditNoteDocumentQueryInput,
  "skip": 987
}
Response
{
  "data": {
    "creditNotes": AcquisitionAdjustmentNoteDocumentConnection
  }
}

debitNote

Description

Query one electronic debit note.

Makes the query of an electronic sale debit note by its UID.

Response

Returns a DebitNote

Arguments
Name Description
uid - UID!

Unique debit note identifier.

  • Mandatory: required

Example

Query
query DebitNote($uid: UID!) {
  debitNote(uid: $uid) {
    billingPrefix {
      creationDate
      id
      prefix
      range {
        ...IntegerRangeFragment
      }
    }
    documentLines {
      description {
        ...LocalizedStringFragment
      }
      invoicePeriod {
        ...ProductLinePeriodFragment
      }
      itemDescription {
        ...ItemDescriptorFragment
      }
      lineExtensionAmount
      note {
        ...LocalizedStringFragment
      }
      price {
        ...PriceFragment
      }
      priceModifier {
        ...AllowanceChargeFragment
      }
      pricingReference {
        ...PricingReferenceFragment
      }
      quantity
      taxDescription {
        ...TaxTotalFragment
      }
      unitCode {
        ...UnitCodeOutputFragment
      }
      uuid
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    documentModifiers {
      amount
      baseAmount
      chargeIndicator
      percentage
      reason {
        ...LocalizedStringFragment
      }
      reasonCode {
        ...reasonCodeFragment
      }
    }
    documentParties {
      accountingCustomerParty {
        ...AccountingCustomerPartyFragment
      }
      accountingSupplierParty {
        ...AccountingSupplierPartyFragment
      }
    }
    documentQr
    documentStatus {
      code
      description
    }
    documentTotals {
      allowanceTotalAmount
      chargeTotalAmount
      lineExtensionAmount
      payableAmount
      prePaidAmount
      taxExclusiveAmount
      taxInclusiveAmount
    }
    documentType
    documentUid
    events {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    files {
      attachedDocument {
        ...FileDescriptorFragment
      }
      graphicalRepresentationHtml {
        ...FileDescriptorFragment
      }
      graphicalRepresentationPdf {
        ...FileDescriptorFragment
      }
    }
    generalInformation {
      acquirerEmail
      currency {
        ...CurrencyFragment
      }
      environment
      issueDateTime
      operationCode {
        ...OperationCodeFragment
      }
      subtypeCode {
        ...SubTypeCodeFragment
      }
    }
    id
    insertedAt
    issuerSoftwareSystem {
      companyName
      companyNit
      softwareName
      softwareVersion
    }
    notes {
      key
      value
    }
    organizationalUnitId
    paymentDescription {
      paymentExchangeRate {
        ...PaymentExchangeRateFragment
      }
      paymentMeans {
        ...PaymentMeanFragment
      }
      prepayments {
        ...PrepaidPaymentFragment
      }
    }
    referencedDocuments {
      description {
        ...LocalizedStringFragment
      }
      issueDate
      referenceId
      referenceType {
        ...ReferenceTypeOutputFragment
      }
      uid
    }
    taxDescription {
      roundingAmount
      taxAmount
      taxName {
        ...TaxNameOutputFragment
      }
      taxSubtotal {
        ...TaxSubtotalFragment
      }
    }
    transactions {
      application
      applicationResponse
      documentId
      insertedAt
      requestedAt
      respondedAt
      transactionChannel
      transactionFrom
      transactionId
      transactionStage
      transactionStatus {
        ...TransactionStatusFragment
      }
      transactionTo
      transactionType
      updatedAt
    }
    uid
    updatedAt
    withholdingsDescription {
      roundingAmount
      withholdingAmount
      withholdingName {
        ...WithholdingNameOutputFragment
      }
      withholdingSubtotal {
        ...TaxSubtotalFragment
      }
    }
  }
}
Variables
{"uid": UID}
Response
{
  "data": {
    "debitNote": {
      "billingPrefix": BillingPrefix,
      "documentLines": [DocumentLine],
      "documentModifiers": [AllowanceCharge],
      "documentParties": DocumentParties,
      "documentQr": "abc123",
      "documentStatus": StatusDescriptor,
      "documentTotals": LegalMonetaryTotal,
      "documentType": "xyz789",
      "documentUid": UID,
      "events": [Event],
      "files": DocumentFiles,
      "generalInformation": GeneralInformationInterface,
      "id": "xyz789",
      "insertedAt": "2007-12-03T10:15:30Z",
      "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
      "notes": [DocumentNotesOutput],
      "organizationalUnitId": UID,
      "paymentDescription": DocumentPaymentDescriptor,
      "referencedDocuments": [DocumentReference],
      "taxDescription": [TaxTotal],
      "transactions": [Transaction],
      "uid": UID,
      "updatedAt": "2007-12-03T10:15:30Z",
      "withholdingsDescription": [WithholdingTotal]
    }
  }
}

debitNotes

Description

Query one or more electronic sale debit notes.

Query to search one or more electronic sale debit notes based on one of the established filters.

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - DebitNoteDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

Query
query DebitNotes(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $orderBy: DocumentOrderInput,
  $query: DebitNoteDocumentQueryInput,
  $skip: Int
) {
  debitNotes(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    orderBy: $orderBy,
    query: $query,
    skip: $skip
  ) {
    ... on AcquisitionAdjustmentNoteDocumentConnection {
      edges {
        ...AcquisitionAdjustmentNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on AcquisitionSupportDocumentConnection {
      edges {
        ...AcquisitionSupportDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on CreditNoteConnection {
      edges {
        ...CreditNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on DebitNoteConnection {
      edges {
        ...DebitNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on InvoiceConnection {
      edges {
        ...InvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PosInvoiceConnection {
      edges {
        ...PosInvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseCreditNoteDocumentConnection {
      edges {
        ...PurchaseCreditNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDebitNoteDocumentConnection {
      edges {
        ...PurchaseDebitNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDocumentConnection {
      edges {
        ...PurchaseDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 123,
  "orderBy": "CONSECUTIVE_ASC",
  "query": DebitNoteDocumentQueryInput,
  "skip": 987
}
Response
{
  "data": {
    "debitNotes": AcquisitionAdjustmentNoteDocumentConnection
  }
}

electronicDocument

Description

Query one electronic document.

Makes the query of an electronic acquisition adjustment note by its CUFE/CUDE and the document type.

The types of documents are:

  • Invoice
  • Credit Note
  • Debit Note
Response

Returns an AcquisitionAdjustmentNoteDocument

Arguments
Name Description
documentType - DocumentType!

Docuemnt's type.

  • Mandatory: required
uid - UID!

Docuemnt's CUFE/CUDE.

  • Mandatory: required

Example

Query
query ElectronicDocument(
  $documentType: DocumentType!,
  $uid: UID!
) {
  electronicDocument(
    documentType: $documentType,
    uid: $uid
  ) {
    assessmentState
    billingPrefix {
      creationDate
      id
      prefix
      range {
        ...IntegerRangeFragment
      }
    }
    dianState
    documentLines {
      description {
        ...LocalizedStringFragment
      }
      invoicePeriod {
        ...ProductLinePeriodFragment
      }
      itemDescription {
        ...ItemDescriptorFragment
      }
      lineExtensionAmount
      note {
        ...LocalizedStringFragment
      }
      price {
        ...PriceFragment
      }
      priceModifier {
        ...AllowanceChargeFragment
      }
      pricingReference {
        ...PricingReferenceFragment
      }
      quantity
      taxDescription {
        ...TaxTotalFragment
      }
      unitCode {
        ...UnitCodeOutputFragment
      }
      uuid
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    documentModifiers {
      amount
      baseAmount
      chargeIndicator
      percentage
      reason {
        ...LocalizedStringFragment
      }
      reasonCode {
        ...reasonCodeFragment
      }
    }
    documentParties {
      accountingCustomerParty {
        ...AccountingCustomerPartyFragment
      }
      accountingSupplierParty {
        ...AccountingSupplierPartyFragment
      }
    }
    documentQr
    documentStatus {
      code
      description
    }
    documentTotals {
      allowanceTotalAmount
      chargeTotalAmount
      lineExtensionAmount
      payableAmount
      prePaidAmount
      taxExclusiveAmount
      taxInclusiveAmount
    }
    documentType
    documentUid
    events {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    files {
      attachedDocument {
        ...FileDescriptorFragment
      }
      graphicalRepresentationHtml {
        ...FileDescriptorFragment
      }
      graphicalRepresentationPdf {
        ...FileDescriptorFragment
      }
    }
    generalInformation {
      acquirerEmail
      currency {
        ...CurrencyFragment
      }
      environment
      issueDateTime
      operationCode {
        ...OperationCodeFragment
      }
      subtypeCode {
        ...SubTypeCodeFragment
      }
    }
    goodsState
    id
    insertedAt
    issuerSoftwareSystem {
      companyName
      companyNit
      softwareName
      softwareVersion
    }
    notes {
      key
      value
    }
    organizationalUnitId
    paymentDescription {
      paymentExchangeRate {
        ...PaymentExchangeRateFragment
      }
      paymentMeans {
        ...PaymentMeanFragment
      }
      prepayments {
        ...PrepaidPaymentFragment
      }
    }
    referencedDocuments {
      description {
        ...LocalizedStringFragment
      }
      issueDate
      referenceId
      referenceType {
        ...ReferenceTypeOutputFragment
      }
      uid
    }
    taxDescription {
      roundingAmount
      taxAmount
      taxName {
        ...TaxNameOutputFragment
      }
      taxSubtotal {
        ...TaxSubtotalFragment
      }
    }
    transactions {
      application
      applicationResponse
      documentId
      insertedAt
      requestedAt
      respondedAt
      transactionChannel
      transactionFrom
      transactionId
      transactionStage
      transactionStatus {
        ...TransactionStatusFragment
      }
      transactionTo
      transactionType
      updatedAt
    }
    uid
    updatedAt
    withholdingsDescription {
      roundingAmount
      withholdingAmount
      withholdingName {
        ...WithholdingNameOutputFragment
      }
      withholdingSubtotal {
        ...TaxSubtotalFragment
      }
    }
  }
}
Variables
{"documentType": "CREDIT_NOTE", "uid": UID}
Response
{
  "data": {
    "electronicDocument": {
      "assessmentState": 987,
      "billingPrefix": BillingPrefix,
      "dianState": 987,
      "documentLines": [DocumentLine],
      "documentModifiers": [AllowanceCharge],
      "documentParties": DocumentParties,
      "documentQr": "abc123",
      "documentStatus": StatusDescriptor,
      "documentTotals": LegalMonetaryTotal,
      "documentType": "xyz789",
      "documentUid": UID,
      "events": [Event],
      "files": DocumentFiles,
      "generalInformation": GeneralInformationInterface,
      "goodsState": 123,
      "id": "xyz789",
      "insertedAt": "2007-12-03T10:15:30Z",
      "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
      "notes": [DocumentNotesOutput],
      "organizationalUnitId": UID,
      "paymentDescription": DocumentPaymentDescriptor,
      "referencedDocuments": [DocumentReference],
      "taxDescription": [TaxTotal],
      "transactions": [Transaction],
      "uid": UID,
      "updatedAt": "2007-12-03T10:15:30Z",
      "withholdingsDescription": [WithholdingTotal]
    }
  }
}

electronicInvoicer

Description

Query one ectronic invoicer.

Makes the query of an electronic invoicer by its ID.

Response

Returns an ElectronicInvoicer

Arguments
Name Description
id - String

Unique identifier of the electronic invoicer.

  • Mandatory: required

Example

Query
query ElectronicInvoicer($id: String) {
  electronicInvoicer(id: $id) {
    email
    identifier
    lastDianConsult
    startDate
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "electronicInvoicer": {
      "email": email,
      "identifier": "xyz789",
      "lastDianConsult": "2007-12-03T10:15:30Z",
      "startDate": "2007-12-03"
    }
  }
}

invoice

Description

Query one electronic sale invoice

Make the query of an electronic sales invoice by its UID.

Response

Returns an Invoice

Arguments
Name Description
uid - UID!

Invoice unique identifier.

  • Mandatory: required

Example

Query
query Invoice($uid: UID!) {
  invoice(uid: $uid) {
    assessmentState
    billingPrefix {
      creationDate
      id
      prefix
      range {
        ...IntegerRangeFragment
      }
    }
    creditNoteSummary {
      date
      id
      orden
      type
      uuid
      value
    }
    debitNoteSummary {
      date
      id
      orden
      type
      uuid
      value
    }
    dianState
    documentLines {
      description {
        ...LocalizedStringFragment
      }
      invoicePeriod {
        ...ProductLinePeriodFragment
      }
      itemDescription {
        ...ItemDescriptorFragment
      }
      lineExtensionAmount
      note {
        ...LocalizedStringFragment
      }
      price {
        ...PriceFragment
      }
      priceModifier {
        ...AllowanceChargeFragment
      }
      pricingReference {
        ...PricingReferenceFragment
      }
      quantity
      taxDescription {
        ...TaxTotalFragment
      }
      unitCode {
        ...UnitCodeOutputFragment
      }
      uuid
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    documentModifiers {
      amount
      baseAmount
      chargeIndicator
      percentage
      reason {
        ...LocalizedStringFragment
      }
      reasonCode {
        ...reasonCodeFragment
      }
    }
    documentParties {
      accountingCustomerParty {
        ...AccountingCustomerPartyFragment
      }
      accountingSupplierParty {
        ...AccountingSupplierPartyFragment
      }
    }
    documentQr
    documentStatus {
      code
      description
    }
    documentSummary {
      creditNoteTotal
      creditNotes
      debitNoteTotal
      debitNotes
      referenceDocuments
    }
    documentTotals {
      allowanceTotalAmount
      chargeTotalAmount
      lineExtensionAmount
      payableAmount
      prePaidAmount
      taxExclusiveAmount
      taxInclusiveAmount
    }
    documentType
    documentUid
    events {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    files {
      attachedDocument {
        ...FileDescriptorFragment
      }
      graphicalRepresentationHtml {
        ...FileDescriptorFragment
      }
      graphicalRepresentationPdf {
        ...FileDescriptorFragment
      }
    }
    generalInformation {
      acquirerEmail
      currency {
        ...CurrencyFragment
      }
      environment
      issueDateTime
      operationCode {
        ...OperationCodeFragment
      }
      subtypeCode {
        ...SubTypeCodeFragment
      }
    }
    goodsState
    id
    insertedAt
    issuerSoftwareSystem {
      companyName
      companyNit
      softwareName
      softwareVersion
    }
    notes {
      key
      value
    }
    organizationalUnitId
    paymentDescription {
      paymentExchangeRate {
        ...PaymentExchangeRateFragment
      }
      paymentMeans {
        ...PaymentMeanFragment
      }
      prepayments {
        ...PrepaidPaymentFragment
      }
    }
    referencedDocuments {
      description {
        ...LocalizedStringFragment
      }
      issueDate
      referenceId
      referenceType {
        ...ReferenceTypeOutputFragment
      }
      uid
    }
    taxDescription {
      roundingAmount
      taxAmount
      taxName {
        ...TaxNameOutputFragment
      }
      taxSubtotal {
        ...TaxSubtotalFragment
      }
    }
    transactions {
      application
      applicationResponse
      documentId
      insertedAt
      requestedAt
      respondedAt
      transactionChannel
      transactionFrom
      transactionId
      transactionStage
      transactionStatus {
        ...TransactionStatusFragment
      }
      transactionTo
      transactionType
      updatedAt
    }
    uid
    updatedAt
    withholdingsDescription {
      roundingAmount
      withholdingAmount
      withholdingName {
        ...WithholdingNameOutputFragment
      }
      withholdingSubtotal {
        ...TaxSubtotalFragment
      }
    }
  }
}
Variables
{"uid": UID}
Response
{
  "data": {
    "invoice": {
      "assessmentState": 123,
      "billingPrefix": BillingPrefix,
      "creditNoteSummary": [NoteSummary],
      "debitNoteSummary": [NoteSummary],
      "dianState": 123,
      "documentLines": [DocumentLine],
      "documentModifiers": [AllowanceCharge],
      "documentParties": DocumentParties,
      "documentQr": "xyz789",
      "documentStatus": StatusDescriptor,
      "documentSummary": InvoiceDocumentSummary,
      "documentTotals": LegalMonetaryTotal,
      "documentType": "xyz789",
      "documentUid": UID,
      "events": [Event],
      "files": DocumentFiles,
      "generalInformation": GeneralInformationInterface,
      "goodsState": 123,
      "id": "abc123",
      "insertedAt": "2007-12-03T10:15:30Z",
      "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
      "notes": [DocumentNotesOutput],
      "organizationalUnitId": UID,
      "paymentDescription": DocumentPaymentDescriptor,
      "referencedDocuments": [DocumentReference],
      "taxDescription": [TaxTotal],
      "transactions": [Transaction],
      "uid": UID,
      "updatedAt": "2007-12-03T10:15:30Z",
      "withholdingsDescription": [WithholdingTotal]
    }
  }
}

invoices

Description

Query one or more electronic sale invoices.

Query to search one or more electronic sale invoices based on one of the established filters.

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - InvoiceDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

Query
query Invoices(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $orderBy: DocumentOrderInput,
  $query: InvoiceDocumentQueryInput,
  $skip: Int
) {
  invoices(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    orderBy: $orderBy,
    query: $query,
    skip: $skip
  ) {
    ... on AcquisitionAdjustmentNoteDocumentConnection {
      edges {
        ...AcquisitionAdjustmentNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on AcquisitionSupportDocumentConnection {
      edges {
        ...AcquisitionSupportDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on CreditNoteConnection {
      edges {
        ...CreditNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on DebitNoteConnection {
      edges {
        ...DebitNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on InvoiceConnection {
      edges {
        ...InvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PosInvoiceConnection {
      edges {
        ...PosInvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseCreditNoteDocumentConnection {
      edges {
        ...PurchaseCreditNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDebitNoteDocumentConnection {
      edges {
        ...PurchaseDebitNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDocumentConnection {
      edges {
        ...PurchaseDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 123,
  "last": 123,
  "orderBy": "CONSECUTIVE_ASC",
  "query": InvoiceDocumentQueryInput,
  "skip": 123
}
Response
{
  "data": {
    "invoices": AcquisitionAdjustmentNoteDocumentConnection
  }
}

organization

Description

Query one Organization.

Query an organization using the client's access token.

Response

Returns an Organization

Example

Query
query Organization {
  organization {
    insertedAt
    organizationBusinessData {
      address {
        ...PhysicalLocationFragment
      }
      economicActivities {
        ...OrgEconomicActivitiesFragment
      }
      email
      phone
    }
    organizationContactData {
      address {
        ...PhysicalLocationFragment
      }
      contactId {
        ...PersonIdFragment
      }
      email
      name {
        ...PersonNameFragment
      }
      phone
    }
    organizationFiscalData {
      fiscalAddress {
        ...PhysicalLocationFragment
      }
      responsibilities
    }
    organizationId
    organizationMiscData {
      key
      values
    }
    organizationName
    organizationNit
    organizationSettings {
      composite
      testSetId
      valueTitleIssuer
    }
    organizationState {
      key
      values
    }
    organizationType {
      code
      description
    }
    organizationalUnits {
      documents {
        ...DocumentInterfaceFragment
      }
      insertedAt
      organizationId
      organizationUnitBusinessData {
        ...OrganizationUnitBusinessDataFragment
      }
      organizationUnitContactData {
        ...ContactDataFragment
      }
      organizationUnitFiscalData {
        ...FiscalDataFragment
      }
      organizationUnitId
      organizationUnitMiscData {
        ...NoteFieldOutputFragment
      }
      organizationUnitName
      organizationUnitNit
      organizationUnitSettings {
        ...NoteFieldOutputFragment
      }
      organizationUnitState {
        ...NoteFieldOutputFragment
      }
      organizationUnitUpdateDataJ
      updatedAt
    }
    updatedAt
  }
}
Response
{
  "data": {
    "organization": {
      "insertedAt": "2007-12-03T10:15:30Z",
      "organizationBusinessData": OrganizationBusinessData,
      "organizationContactData": ContactData,
      "organizationFiscalData": FiscalData,
      "organizationId": UID,
      "organizationMiscData": NoteFieldOutput,
      "organizationName": "abc123",
      "organizationNit": "abc123",
      "organizationSettings": OrganizationSettings,
      "organizationState": NoteFieldOutput,
      "organizationType": PersonTypeOutput,
      "organizationalUnits": [OrganizationUnit],
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

organizationUnit

Description

Query one Business Unit.

Query one Business Unit by its UID.

Response

Returns an OrganizationUnit

Arguments
Name Description
id - UID!

Unique identifier of the organizational unit.

  • Mandatory: required

Example

Query
query OrganizationUnit($id: UID!) {
  organizationUnit(id: $id) {
    documents {
      billingPrefix {
        ...BillingPrefixFragment
      }
      documentLines {
        ...DocumentLineFragment
      }
      documentModifiers {
        ...AllowanceChargeFragment
      }
      documentParties {
        ...DocumentPartiesFragment
      }
      documentStatus {
        ...StatusDescriptorFragment
      }
      documentTotals {
        ...LegalMonetaryTotalFragment
      }
      documentType
      documentUid
      events {
        ...EventFragment
      }
      generalInformation {
        ...GeneralInformationInterfaceFragment
      }
      id
      insertedAt
      organizationalUnitId
      paymentDescription {
        ...DocumentPaymentDescriptorFragment
      }
      referencedDocuments {
        ...DocumentReferenceFragment
      }
      taxDescription {
        ...TaxTotalFragment
      }
      transactions {
        ...TransactionFragment
      }
      uid
      updatedAt
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    insertedAt
    organizationId
    organizationUnitBusinessData {
      address {
        ...PhysicalLocationFragment
      }
      economicActivities {
        ...EconomicActivityCodeOutputFragment
      }
      email
      phone
    }
    organizationUnitContactData {
      address {
        ...PhysicalLocationFragment
      }
      contactId {
        ...PersonIdFragment
      }
      email
      name {
        ...PersonNameFragment
      }
      phone
    }
    organizationUnitFiscalData {
      fiscalAddress {
        ...PhysicalLocationFragment
      }
      responsibilities
    }
    organizationUnitId
    organizationUnitMiscData {
      key
      values
    }
    organizationUnitName
    organizationUnitNit
    organizationUnitSettings {
      key
      values
    }
    organizationUnitState {
      key
      values
    }
    organizationUnitUpdateDataJ
    updatedAt
  }
}
Variables
{"id": UID}
Response
{
  "data": {
    "organizationUnit": {
      "documents": [DocumentInterface],
      "insertedAt": "2007-12-03T10:15:30Z",
      "organizationId": "xyz789",
      "organizationUnitBusinessData": OrganizationUnitBusinessData,
      "organizationUnitContactData": ContactData,
      "organizationUnitFiscalData": FiscalData,
      "organizationUnitId": "abc123",
      "organizationUnitMiscData": NoteFieldOutput,
      "organizationUnitName": "abc123",
      "organizationUnitNit": "abc123",
      "organizationUnitSettings": NoteFieldOutput,
      "organizationUnitState": NoteFieldOutput,
      "organizationUnitUpdateDataJ": json,
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

organizationUnits

Description

Query one or more bussines units.

Query to search one or more bussines units based on one of the established filters.

Response

Returns an OrganizationUnitConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - OrganizationalUnitOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - OrganizationalUnitQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

Query
query OrganizationUnits(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $orderBy: OrganizationalUnitOrderInput,
  $query: OrganizationalUnitQueryInput,
  $skip: Int
) {
  organizationUnits(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    orderBy: $orderBy,
    query: $query,
    skip: $skip
  ) {
    edges {
      cursor
      node {
        ...OrganizationUnitFragment
      }
    }
    pageCursors {
      cursors {
        ...CursorFragment
      }
      page {
        ...PageFragment
      }
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
    totalCount
    totalPages
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 987,
  "last": 123,
  "orderBy": "INSERTED_AT_ASC",
  "query": OrganizationalUnitQueryInput,
  "skip": 123
}
Response
{
  "data": {
    "organizationUnits": {
      "edges": [OrganizationUnitEdge],
      "pageCursors": PageCursors,
      "pageInfo": PageInfo,
      "totalCount": 123,
      "totalPages": 987
    }
  }
}

posInvoice

Description

Query one electronic sale POS invoice

Make the query of an electronic sales POS invoice by its UID.

Response

Returns a PosInvoice

Arguments
Name Description
uid - UID!

PosInvoice unique identifier.

  • Mandatory: required

Example

Query
query PosInvoice($uid: UID!) {
  posInvoice(uid: $uid) {
    assessmentState
    billingPrefix {
      creationDate
      id
      prefix
      range {
        ...IntegerRangeFragment
      }
    }
    creditNoteSummary {
      date
      id
      orden
      type
      uuid
      value
    }
    debitNoteSummary {
      date
      id
      orden
      type
      uuid
      value
    }
    dianState
    documentLines {
      description {
        ...LocalizedStringFragment
      }
      invoicePeriod {
        ...ProductLinePeriodFragment
      }
      itemDescription {
        ...ItemDescriptorFragment
      }
      lineExtensionAmount
      note {
        ...LocalizedStringFragment
      }
      price {
        ...PriceFragment
      }
      priceModifier {
        ...AllowanceChargeFragment
      }
      pricingReference {
        ...PricingReferenceFragment
      }
      quantity
      taxDescription {
        ...TaxTotalFragment
      }
      unitCode {
        ...UnitCodeOutputFragment
      }
      uuid
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    documentModifiers {
      amount
      baseAmount
      chargeIndicator
      percentage
      reason {
        ...LocalizedStringFragment
      }
      reasonCode {
        ...reasonCodeFragment
      }
    }
    documentParties {
      accountingCustomerParty {
        ...AccountingCustomerPartyFragment
      }
      accountingSupplierParty {
        ...AccountingSupplierPartyFragment
      }
    }
    documentQr
    documentStatus {
      code
      description
    }
    documentSummary {
      creditNoteTotal
      creditNotes
      debitNoteTotal
      debitNotes
      referenceDocuments
    }
    documentTotals {
      allowanceTotalAmount
      chargeTotalAmount
      lineExtensionAmount
      payableAmount
      prePaidAmount
      taxExclusiveAmount
      taxInclusiveAmount
    }
    documentType
    documentUid
    events {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    files {
      attachedDocument {
        ...FileDescriptorFragment
      }
      graphicalRepresentationHtml {
        ...FileDescriptorFragment
      }
      graphicalRepresentationPdf {
        ...FileDescriptorFragment
      }
    }
    generalInformation {
      acquirerEmail
      currency {
        ...CurrencyFragment
      }
      environment
      issueDateTime
      operationCode {
        ...OperationCodeFragment
      }
      subtypeCode {
        ...SubTypeCodeFragment
      }
    }
    goodsState
    id
    insertedAt
    issuerSoftwareSystem {
      companyName
      companyNit
      softwareName
      softwareVersion
    }
    notes {
      key
      value
    }
    organizationalUnitId
    paymentDescription {
      paymentExchangeRate {
        ...PaymentExchangeRateFragment
      }
      paymentMeans {
        ...PaymentMeanFragment
      }
      prepayments {
        ...PrepaidPaymentFragment
      }
    }
    referencedDocuments {
      description {
        ...LocalizedStringFragment
      }
      issueDate
      referenceId
      referenceType {
        ...ReferenceTypeOutputFragment
      }
      uid
    }
    taxDescription {
      roundingAmount
      taxAmount
      taxName {
        ...TaxNameOutputFragment
      }
      taxSubtotal {
        ...TaxSubtotalFragment
      }
    }
    transactions {
      application
      applicationResponse
      documentId
      insertedAt
      requestedAt
      respondedAt
      transactionChannel
      transactionFrom
      transactionId
      transactionStage
      transactionStatus {
        ...TransactionStatusFragment
      }
      transactionTo
      transactionType
      updatedAt
    }
    uid
    updatedAt
    withholdingsDescription {
      roundingAmount
      withholdingAmount
      withholdingName {
        ...WithholdingNameOutputFragment
      }
      withholdingSubtotal {
        ...TaxSubtotalFragment
      }
    }
  }
}
Variables
{"uid": UID}
Response
{
  "data": {
    "posInvoice": {
      "assessmentState": 123,
      "billingPrefix": BillingPrefix,
      "creditNoteSummary": [NoteSummary],
      "debitNoteSummary": [NoteSummary],
      "dianState": 123,
      "documentLines": [DocumentLine],
      "documentModifiers": [AllowanceCharge],
      "documentParties": DocumentParties,
      "documentQr": "xyz789",
      "documentStatus": StatusDescriptor,
      "documentSummary": InvoiceDocumentSummary,
      "documentTotals": LegalMonetaryTotal,
      "documentType": "xyz789",
      "documentUid": UID,
      "events": [Event],
      "files": DocumentFiles,
      "generalInformation": GeneralInformationInterface,
      "goodsState": 987,
      "id": "abc123",
      "insertedAt": "2007-12-03T10:15:30Z",
      "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
      "notes": [DocumentNotesOutput],
      "organizationalUnitId": UID,
      "paymentDescription": DocumentPaymentDescriptor,
      "referencedDocuments": [DocumentReference],
      "taxDescription": [TaxTotal],
      "transactions": [Transaction],
      "uid": UID,
      "updatedAt": "2007-12-03T10:15:30Z",
      "withholdingsDescription": [WithholdingTotal]
    }
  }
}

posInvoices

Description

Query one or more electronic sale POS invoices.

Query to search one or more electronic sale POS invoices based on one of the established filters.

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - InvoiceDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

Query
query PosInvoices(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $orderBy: DocumentOrderInput,
  $query: InvoiceDocumentQueryInput,
  $skip: Int
) {
  posInvoices(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    orderBy: $orderBy,
    query: $query,
    skip: $skip
  ) {
    ... on AcquisitionAdjustmentNoteDocumentConnection {
      edges {
        ...AcquisitionAdjustmentNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on AcquisitionSupportDocumentConnection {
      edges {
        ...AcquisitionSupportDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on CreditNoteConnection {
      edges {
        ...CreditNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on DebitNoteConnection {
      edges {
        ...DebitNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on InvoiceConnection {
      edges {
        ...InvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PosInvoiceConnection {
      edges {
        ...PosInvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseCreditNoteDocumentConnection {
      edges {
        ...PurchaseCreditNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDebitNoteDocumentConnection {
      edges {
        ...PurchaseDebitNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDocumentConnection {
      edges {
        ...PurchaseDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 987,
  "last": 123,
  "orderBy": "CONSECUTIVE_ASC",
  "query": InvoiceDocumentQueryInput,
  "skip": 123
}
Response
{
  "data": {
    "posInvoices": AcquisitionAdjustmentNoteDocumentConnection
  }
}

purchaseCreditNote

Description

Query one electronic purchase credit note.

Makes the query of an electronic purchase credit note by its UID.

Response

Returns a PurchaseCreditNoteDocument

Arguments
Name Description
uid - UID!

Invoice unique identifier.

  • Mandatory: required

Example

Query
query PurchaseCreditNote($uid: UID!) {
  purchaseCreditNote(uid: $uid) {
    billingPrefix {
      creationDate
      id
      prefix
      range {
        ...IntegerRangeFragment
      }
    }
    documentLines {
      description {
        ...LocalizedStringFragment
      }
      invoicePeriod {
        ...ProductLinePeriodFragment
      }
      itemDescription {
        ...ItemDescriptorFragment
      }
      lineExtensionAmount
      note {
        ...LocalizedStringFragment
      }
      price {
        ...PriceFragment
      }
      priceModifier {
        ...AllowanceChargeFragment
      }
      pricingReference {
        ...PricingReferenceFragment
      }
      quantity
      taxDescription {
        ...TaxTotalFragment
      }
      unitCode {
        ...UnitCodeOutputFragment
      }
      uuid
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    documentModifiers {
      amount
      baseAmount
      chargeIndicator
      percentage
      reason {
        ...LocalizedStringFragment
      }
      reasonCode {
        ...reasonCodeFragment
      }
    }
    documentParties {
      accountingCustomerParty {
        ...AccountingCustomerPartyFragment
      }
      accountingSupplierParty {
        ...AccountingSupplierPartyFragment
      }
    }
    documentStatus {
      code
      description
    }
    documentTotals {
      allowanceTotalAmount
      chargeTotalAmount
      lineExtensionAmount
      payableAmount
      prePaidAmount
      taxExclusiveAmount
      taxInclusiveAmount
    }
    documentType
    documentUid
    events {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    files {
      attachedDocument {
        ...FileDescriptorFragment
      }
      graphicalRepresentationHtml {
        ...FileDescriptorFragment
      }
      graphicalRepresentationPdf {
        ...FileDescriptorFragment
      }
    }
    generalInformation {
      acquirerEmail
      currency {
        ...CurrencyFragment
      }
      environment
      issueDateTime
      operationCode {
        ...OperationCodeFragment
      }
      subtypeCode {
        ...SubTypeCodeFragment
      }
    }
    id
    insertedAt
    organizationalUnitId
    paymentDescription {
      paymentExchangeRate {
        ...PaymentExchangeRateFragment
      }
      paymentMeans {
        ...PaymentMeanFragment
      }
      prepayments {
        ...PrepaidPaymentFragment
      }
    }
    referencedDocuments {
      description {
        ...LocalizedStringFragment
      }
      issueDate
      referenceId
      referenceType {
        ...ReferenceTypeOutputFragment
      }
      uid
    }
    taxDescription {
      roundingAmount
      taxAmount
      taxName {
        ...TaxNameOutputFragment
      }
      taxSubtotal {
        ...TaxSubtotalFragment
      }
    }
    transactions {
      application
      applicationResponse
      documentId
      insertedAt
      requestedAt
      respondedAt
      transactionChannel
      transactionFrom
      transactionId
      transactionStage
      transactionStatus {
        ...TransactionStatusFragment
      }
      transactionTo
      transactionType
      updatedAt
    }
    uid
    updatedAt
    withholdingsDescription {
      roundingAmount
      withholdingAmount
      withholdingName {
        ...WithholdingNameOutputFragment
      }
      withholdingSubtotal {
        ...TaxSubtotalFragment
      }
    }
  }
}
Variables
{"uid": UID}
Response
{
  "data": {
    "purchaseCreditNote": {
      "billingPrefix": BillingPrefix,
      "documentLines": [DocumentLine],
      "documentModifiers": [AllowanceCharge],
      "documentParties": DocumentParties,
      "documentStatus": StatusDescriptor,
      "documentTotals": LegalMonetaryTotal,
      "documentType": "abc123",
      "documentUid": UID,
      "events": [Event],
      "files": DocumentFiles,
      "generalInformation": GeneralInformationInterface,
      "id": "xyz789",
      "insertedAt": "2007-12-03T10:15:30Z",
      "organizationalUnitId": UID,
      "paymentDescription": DocumentPaymentDescriptor,
      "referencedDocuments": [DocumentReference],
      "taxDescription": [TaxTotal],
      "transactions": [Transaction],
      "uid": UID,
      "updatedAt": "2007-12-03T10:15:30Z",
      "withholdingsDescription": [WithholdingTotal]
    }
  }
}

purchaseCreditNotes

Description

Query one or more electronic purchase credit notes.

Query to search one or more electronic purchase credit notes based on one of the established filters.

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - PurchaseCreditNoteDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

Query
query PurchaseCreditNotes(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $orderBy: DocumentOrderInput,
  $query: PurchaseCreditNoteDocumentQueryInput,
  $skip: Int
) {
  purchaseCreditNotes(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    orderBy: $orderBy,
    query: $query,
    skip: $skip
  ) {
    ... on AcquisitionAdjustmentNoteDocumentConnection {
      edges {
        ...AcquisitionAdjustmentNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on AcquisitionSupportDocumentConnection {
      edges {
        ...AcquisitionSupportDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on CreditNoteConnection {
      edges {
        ...CreditNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on DebitNoteConnection {
      edges {
        ...DebitNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on InvoiceConnection {
      edges {
        ...InvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PosInvoiceConnection {
      edges {
        ...PosInvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseCreditNoteDocumentConnection {
      edges {
        ...PurchaseCreditNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDebitNoteDocumentConnection {
      edges {
        ...PurchaseDebitNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDocumentConnection {
      edges {
        ...PurchaseDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
  }
}
Variables
{
  "after": "abc123",
  "before": "abc123",
  "first": 123,
  "last": 987,
  "orderBy": "CONSECUTIVE_ASC",
  "query": PurchaseCreditNoteDocumentQueryInput,
  "skip": 123
}
Response
{
  "data": {
    "purchaseCreditNotes": AcquisitionAdjustmentNoteDocumentConnection
  }
}

purchaseDebitNote

Description

Query one electronic purchase debit note.

Makes the query of an electronic purchase debit note by its UID.

Response

Returns a PurchaseDebitNoteDocument

Arguments
Name Description
uid - UID!

Invoice unique identifier.

  • Mandatory: required

Example

Query
query PurchaseDebitNote($uid: UID!) {
  purchaseDebitNote(uid: $uid) {
    billingPrefix {
      creationDate
      id
      prefix
      range {
        ...IntegerRangeFragment
      }
    }
    documentLines {
      description {
        ...LocalizedStringFragment
      }
      invoicePeriod {
        ...ProductLinePeriodFragment
      }
      itemDescription {
        ...ItemDescriptorFragment
      }
      lineExtensionAmount
      note {
        ...LocalizedStringFragment
      }
      price {
        ...PriceFragment
      }
      priceModifier {
        ...AllowanceChargeFragment
      }
      pricingReference {
        ...PricingReferenceFragment
      }
      quantity
      taxDescription {
        ...TaxTotalFragment
      }
      unitCode {
        ...UnitCodeOutputFragment
      }
      uuid
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    documentModifiers {
      amount
      baseAmount
      chargeIndicator
      percentage
      reason {
        ...LocalizedStringFragment
      }
      reasonCode {
        ...reasonCodeFragment
      }
    }
    documentParties {
      accountingCustomerParty {
        ...AccountingCustomerPartyFragment
      }
      accountingSupplierParty {
        ...AccountingSupplierPartyFragment
      }
    }
    documentStatus {
      code
      description
    }
    documentTotals {
      allowanceTotalAmount
      chargeTotalAmount
      lineExtensionAmount
      payableAmount
      prePaidAmount
      taxExclusiveAmount
      taxInclusiveAmount
    }
    documentType
    documentUid
    events {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    files {
      attachedDocument {
        ...FileDescriptorFragment
      }
      graphicalRepresentationHtml {
        ...FileDescriptorFragment
      }
      graphicalRepresentationPdf {
        ...FileDescriptorFragment
      }
    }
    generalInformation {
      acquirerEmail
      currency {
        ...CurrencyFragment
      }
      environment
      issueDateTime
      operationCode {
        ...OperationCodeFragment
      }
      subtypeCode {
        ...SubTypeCodeFragment
      }
    }
    id
    insertedAt
    organizationalUnitId
    paymentDescription {
      paymentExchangeRate {
        ...PaymentExchangeRateFragment
      }
      paymentMeans {
        ...PaymentMeanFragment
      }
      prepayments {
        ...PrepaidPaymentFragment
      }
    }
    referencedDocuments {
      description {
        ...LocalizedStringFragment
      }
      issueDate
      referenceId
      referenceType {
        ...ReferenceTypeOutputFragment
      }
      uid
    }
    taxDescription {
      roundingAmount
      taxAmount
      taxName {
        ...TaxNameOutputFragment
      }
      taxSubtotal {
        ...TaxSubtotalFragment
      }
    }
    transactions {
      application
      applicationResponse
      documentId
      insertedAt
      requestedAt
      respondedAt
      transactionChannel
      transactionFrom
      transactionId
      transactionStage
      transactionStatus {
        ...TransactionStatusFragment
      }
      transactionTo
      transactionType
      updatedAt
    }
    uid
    updatedAt
    withholdingsDescription {
      roundingAmount
      withholdingAmount
      withholdingName {
        ...WithholdingNameOutputFragment
      }
      withholdingSubtotal {
        ...TaxSubtotalFragment
      }
    }
  }
}
Variables
{"uid": UID}
Response
{
  "data": {
    "purchaseDebitNote": {
      "billingPrefix": BillingPrefix,
      "documentLines": [DocumentLine],
      "documentModifiers": [AllowanceCharge],
      "documentParties": DocumentParties,
      "documentStatus": StatusDescriptor,
      "documentTotals": LegalMonetaryTotal,
      "documentType": "abc123",
      "documentUid": UID,
      "events": [Event],
      "files": DocumentFiles,
      "generalInformation": GeneralInformationInterface,
      "id": "abc123",
      "insertedAt": "2007-12-03T10:15:30Z",
      "organizationalUnitId": UID,
      "paymentDescription": DocumentPaymentDescriptor,
      "referencedDocuments": [DocumentReference],
      "taxDescription": [TaxTotal],
      "transactions": [Transaction],
      "uid": UID,
      "updatedAt": "2007-12-03T10:15:30Z",
      "withholdingsDescription": [WithholdingTotal]
    }
  }
}

purchaseDebitNotes

Description

Query one or more electronic purchase debit notes.

Query to search one or more electronic purchase debit notes based on one of the established filters.

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - PurchaseDebitNoteDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

Query
query PurchaseDebitNotes(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $orderBy: DocumentOrderInput,
  $query: PurchaseDebitNoteDocumentQueryInput,
  $skip: Int
) {
  purchaseDebitNotes(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    orderBy: $orderBy,
    query: $query,
    skip: $skip
  ) {
    ... on AcquisitionAdjustmentNoteDocumentConnection {
      edges {
        ...AcquisitionAdjustmentNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on AcquisitionSupportDocumentConnection {
      edges {
        ...AcquisitionSupportDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on CreditNoteConnection {
      edges {
        ...CreditNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on DebitNoteConnection {
      edges {
        ...DebitNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on InvoiceConnection {
      edges {
        ...InvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PosInvoiceConnection {
      edges {
        ...PosInvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseCreditNoteDocumentConnection {
      edges {
        ...PurchaseCreditNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDebitNoteDocumentConnection {
      edges {
        ...PurchaseDebitNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDocumentConnection {
      edges {
        ...PurchaseDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
  }
}
Variables
{
  "after": "xyz789",
  "before": "abc123",
  "first": 123,
  "last": 123,
  "orderBy": "CONSECUTIVE_ASC",
  "query": PurchaseDebitNoteDocumentQueryInput,
  "skip": 987
}
Response
{
  "data": {
    "purchaseDebitNotes": AcquisitionAdjustmentNoteDocumentConnection
  }
}

purchaseInvoice

Description

Query one electronic purchase invoice

Makes the query of an electronic purchase invoice by its UID.

Response

Returns a PurchaseDocument

Arguments
Name Description
uid - UID!

Invoice unique identifier.

  • Mandatory: required

Example

Query
query PurchaseInvoice($uid: UID!) {
  purchaseInvoice(uid: $uid) {
    billingPrefix {
      creationDate
      id
      prefix
      range {
        ...IntegerRangeFragment
      }
    }
    documentLines {
      description {
        ...LocalizedStringFragment
      }
      invoicePeriod {
        ...ProductLinePeriodFragment
      }
      itemDescription {
        ...ItemDescriptorFragment
      }
      lineExtensionAmount
      note {
        ...LocalizedStringFragment
      }
      price {
        ...PriceFragment
      }
      priceModifier {
        ...AllowanceChargeFragment
      }
      pricingReference {
        ...PricingReferenceFragment
      }
      quantity
      taxDescription {
        ...TaxTotalFragment
      }
      unitCode {
        ...UnitCodeOutputFragment
      }
      uuid
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    documentModifiers {
      amount
      baseAmount
      chargeIndicator
      percentage
      reason {
        ...LocalizedStringFragment
      }
      reasonCode {
        ...reasonCodeFragment
      }
    }
    documentParties {
      accountingCustomerParty {
        ...AccountingCustomerPartyFragment
      }
      accountingSupplierParty {
        ...AccountingSupplierPartyFragment
      }
    }
    documentStatus {
      code
      description
    }
    documentTotals {
      allowanceTotalAmount
      chargeTotalAmount
      lineExtensionAmount
      payableAmount
      prePaidAmount
      taxExclusiveAmount
      taxInclusiveAmount
    }
    documentType
    documentUid
    events {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    files {
      attachedDocument {
        ...FileDescriptorFragment
      }
      graphicalRepresentationHtml {
        ...FileDescriptorFragment
      }
      graphicalRepresentationPdf {
        ...FileDescriptorFragment
      }
    }
    generalInformation {
      acquirerEmail
      currency {
        ...CurrencyFragment
      }
      environment
      issueDateTime
      operationCode {
        ...OperationCodeFragment
      }
      subtypeCode {
        ...SubTypeCodeFragment
      }
    }
    id
    insertedAt
    organizationalUnitId
    paymentDescription {
      paymentExchangeRate {
        ...PaymentExchangeRateFragment
      }
      paymentMeans {
        ...PaymentMeanFragment
      }
      prepayments {
        ...PrepaidPaymentFragment
      }
    }
    referencedDocuments {
      description {
        ...LocalizedStringFragment
      }
      issueDate
      referenceId
      referenceType {
        ...ReferenceTypeOutputFragment
      }
      uid
    }
    taxDescription {
      roundingAmount
      taxAmount
      taxName {
        ...TaxNameOutputFragment
      }
      taxSubtotal {
        ...TaxSubtotalFragment
      }
    }
    transactions {
      application
      applicationResponse
      documentId
      insertedAt
      requestedAt
      respondedAt
      transactionChannel
      transactionFrom
      transactionId
      transactionStage
      transactionStatus {
        ...TransactionStatusFragment
      }
      transactionTo
      transactionType
      updatedAt
    }
    uid
    updatedAt
    withholdingsDescription {
      roundingAmount
      withholdingAmount
      withholdingName {
        ...WithholdingNameOutputFragment
      }
      withholdingSubtotal {
        ...TaxSubtotalFragment
      }
    }
  }
}
Variables
{"uid": UID}
Response
{
  "data": {
    "purchaseInvoice": {
      "billingPrefix": BillingPrefix,
      "documentLines": [DocumentLine],
      "documentModifiers": [AllowanceCharge],
      "documentParties": DocumentParties,
      "documentStatus": StatusDescriptor,
      "documentTotals": LegalMonetaryTotal,
      "documentType": "abc123",
      "documentUid": UID,
      "events": [Event],
      "files": DocumentFiles,
      "generalInformation": GeneralInformationInterface,
      "id": "abc123",
      "insertedAt": "2007-12-03T10:15:30Z",
      "organizationalUnitId": UID,
      "paymentDescription": DocumentPaymentDescriptor,
      "referencedDocuments": [DocumentReference],
      "taxDescription": [TaxTotal],
      "transactions": [Transaction],
      "uid": UID,
      "updatedAt": "2007-12-03T10:15:30Z",
      "withholdingsDescription": [WithholdingTotal]
    }
  }
}

purchaseInvoices

Description

Query one or more electronic purchase invoices

Query to search one or more electronic purchase invoices based on one of the established filters.

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - PurchaseDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

Query
query PurchaseInvoices(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $orderBy: DocumentOrderInput,
  $query: PurchaseDocumentQueryInput,
  $skip: Int
) {
  purchaseInvoices(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    orderBy: $orderBy,
    query: $query,
    skip: $skip
  ) {
    ... on AcquisitionAdjustmentNoteDocumentConnection {
      edges {
        ...AcquisitionAdjustmentNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on AcquisitionSupportDocumentConnection {
      edges {
        ...AcquisitionSupportDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on CreditNoteConnection {
      edges {
        ...CreditNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on DebitNoteConnection {
      edges {
        ...DebitNoteEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on InvoiceConnection {
      edges {
        ...InvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PosInvoiceConnection {
      edges {
        ...PosInvoiceEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseCreditNoteDocumentConnection {
      edges {
        ...PurchaseCreditNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDebitNoteDocumentConnection {
      edges {
        ...PurchaseDebitNoteDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
    ... on PurchaseDocumentConnection {
      edges {
        ...PurchaseDocumentEdgeFragment
      }
      pageCursors {
        ...PageCursorsFragment
      }
      pageInfo {
        ...PageInfoFragment
      }
      totalCount
      totalPages
    }
  }
}
Variables
{
  "after": "abc123",
  "before": "abc123",
  "first": 987,
  "last": 987,
  "orderBy": "CONSECUTIVE_ASC",
  "query": PurchaseDocumentQueryInput,
  "skip": 987
}
Response
{
  "data": {
    "purchaseInvoices": AcquisitionAdjustmentNoteDocumentConnection
  }
}

report

Description

Query Report Summary.

Query the YabiCo's Active Plan Summary Report using the client's UID.

Response

Returns a Report

Arguments
Name Description
orgId - UID!

Unique identifier of the organization.

  • Mandatory: required
planId - UID
unitId - UID!

Example

Query
query Report(
  $orgId: UID!,
  $planId: UID,
  $unitId: UID!
) {
  report(
    orgId: $orgId,
    planId: $planId,
    unitId: $unitId
  ) {
    creationDate
    credits
    date
    emissionConsumed {
      adquisitionSupport
      creditNote
      debitNote
      einvoiceAui
      einvoiceCambistas
      einvoiceCambistas1000
      einvoiceCarnicos
      einvoiceStandar
      payroll
      pos
      publicServices
      radianEvents
      tituloValorEvents
    }
    emissionCreditsConsumed {
      adquisitionSupport
      creditNote
      debitNote
      einvoiceAui
      einvoiceCambistas
      einvoiceCambistas1000
      einvoiceCarnicos
      einvoiceStandar
      payroll
      pos
      publicServices
      radianEvents
      tituloValorEvents
    }
    emissionTotalCredits
    insertedAt
    percentageTotalCreditsConsumed
    receptionConsumed {
      creditNote
      debitNote
      einvoice
      tituloValorEvents
    }
    receptionCreditsConsumed {
      creditNote
      debitNote
      einvoice
      tituloValorEvents
    }
    receptionTotalCredits
    reportId
    totalCreditsConsumed
    updatedAt
  }
}
Variables
{
  "orgId": UID,
  "planId": UID,
  "unitId": UID
}
Response
{
  "data": {
    "report": {
      "creationDate": "2007-12-03T10:15:30Z",
      "credits": 987,
      "date": "2007-12-03",
      "emissionConsumed": EmissionData,
      "emissionCreditsConsumed": EmissionData,
      "emissionTotalCredits": 987,
      "insertedAt": "2007-12-03T10:15:30Z",
      "percentageTotalCreditsConsumed": 987.65,
      "receptionConsumed": ReceptionData,
      "receptionCreditsConsumed": ReceptionData,
      "receptionTotalCredits": 123,
      "reportId": "abc123",
      "totalCreditsConsumed": 123,
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

transaction

Description

Query a transaction.

Query to search for a transaction by its ID.

Response

Returns a Transaction

Arguments
Name Description
id - UID!

The identificator of the transaction in the system, represented as an uuid or another identificator.

  • Mandatory: required

Example

Query
query Transaction($id: UID!) {
  transaction(id: $id) {
    application
    applicationResponse
    documentId
    insertedAt
    requestedAt
    respondedAt
    transactionChannel
    transactionFrom
    transactionId
    transactionStage
    transactionStatus {
      message
      title
      warningsAndErrors
    }
    transactionTo
    transactionType
    updatedAt
  }
}
Variables
{"id": UID}
Response
{
  "data": {
    "transaction": {
      "application": "abc123",
      "applicationResponse": "xyz789",
      "documentId": "xyz789",
      "insertedAt": "2007-12-03T10:15:30Z",
      "requestedAt": "2007-12-03T10:15:30Z",
      "respondedAt": "2007-12-03T10:15:30Z",
      "transactionChannel": "abc123",
      "transactionFrom": "xyz789",
      "transactionId": "abc123",
      "transactionStage": "abc123",
      "transactionStatus": TransactionStatus,
      "transactionTo": "abc123",
      "transactionType": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

transactions

Description

Query one or more transactions.

Query to search for a group of transactions based on one of the established filters.

Response

Returns a TransactionConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - TransactionsOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - TransactionsQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

Query
query Transactions(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $orderBy: TransactionsOrderInput,
  $query: TransactionsQueryInput,
  $skip: Int
) {
  transactions(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    orderBy: $orderBy,
    query: $query,
    skip: $skip
  ) {
    edges {
      cursor
      node {
        ...TransactionFragment
      }
    }
    pageCursors {
      cursors {
        ...CursorFragment
      }
      page {
        ...PageFragment
      }
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
    totalCount
    totalPages
  }
}
Variables
{
  "after": "xyz789",
  "before": "xyz789",
  "first": 987,
  "last": 987,
  "orderBy": "INSERTED_AT_ASC",
  "query": TransactionsQueryInput,
  "skip": 123
}
Response
{
  "data": {
    "transactions": {
      "edges": [TransactionEdge],
      "pageCursors": PageCursors,
      "pageInfo": PageInfo,
      "totalCount": 123,
      "totalPages": 123
    }
  }
}

Mutations

addEvent

Description

Adds an Invoice Event.

Adds an invoice event, which is consulted in the DIAN through its CUDE. The referenced invoice's ownership is validated (And saved if said invoice is not already added), then the event is added referencing the invoice (InvoiceEventInput).

Response

Returns an EventOutput

Arguments
Name Description
document - InvoiceEventInput!

Example

Query
mutation AddEvent($document: InvoiceEventInput!) {
  addEvent(document: $document) {
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    event {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"document": InvoiceEventInput}
Response
{
  "data": {
    "addEvent": {
      "errors": [Error],
      "event": Event,
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

addPurchaseCreditNote

Description

Adds a Purchase Credit Note.

Adds a credit note to a purchase e-invoice already filed with DIAN. Our system does not support all types of credit notes (PurchaseCreditNote).

Arguments
Name Description
document - PurchaseCreditNoteInput!

Example

Query
mutation AddPurchaseCreditNote($document: PurchaseCreditNoteInput!) {
  addPurchaseCreditNote(document: $document) {
    document {
      billingPrefix {
        ...BillingPrefixFragment
      }
      documentLines {
        ...DocumentLineFragment
      }
      documentModifiers {
        ...AllowanceChargeFragment
      }
      documentParties {
        ...DocumentPartiesFragment
      }
      documentStatus {
        ...StatusDescriptorFragment
      }
      documentTotals {
        ...LegalMonetaryTotalFragment
      }
      documentType
      documentUid
      events {
        ...EventFragment
      }
      files {
        ...DocumentFilesFragment
      }
      generalInformation {
        ...GeneralInformationInterfaceFragment
      }
      id
      insertedAt
      organizationalUnitId
      paymentDescription {
        ...DocumentPaymentDescriptorFragment
      }
      referencedDocuments {
        ...DocumentReferenceFragment
      }
      taxDescription {
        ...TaxTotalFragment
      }
      transactions {
        ...TransactionFragment
      }
      uid
      updatedAt
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"document": PurchaseCreditNoteInput}
Response
{
  "data": {
    "addPurchaseCreditNote": {
      "document": PurchaseCreditNoteDocument,
      "errors": [Error],
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

addPurchaseDebitNote

Description

Adds a Purchase Debit Note.

Adds a debit note to a purchase e-invoice already filed with DIAN (PurchaseDebitNote).

Response

Returns a PurchaseDebitNoteDocumentOutput

Arguments
Name Description
document - PurchaseDebitNoteInput!

Example

Query
mutation AddPurchaseDebitNote($document: PurchaseDebitNoteInput!) {
  addPurchaseDebitNote(document: $document) {
    document {
      billingPrefix {
        ...BillingPrefixFragment
      }
      documentLines {
        ...DocumentLineFragment
      }
      documentModifiers {
        ...AllowanceChargeFragment
      }
      documentParties {
        ...DocumentPartiesFragment
      }
      documentStatus {
        ...StatusDescriptorFragment
      }
      documentTotals {
        ...LegalMonetaryTotalFragment
      }
      documentType
      documentUid
      events {
        ...EventFragment
      }
      files {
        ...DocumentFilesFragment
      }
      generalInformation {
        ...GeneralInformationInterfaceFragment
      }
      id
      insertedAt
      organizationalUnitId
      paymentDescription {
        ...DocumentPaymentDescriptorFragment
      }
      referencedDocuments {
        ...DocumentReferenceFragment
      }
      taxDescription {
        ...TaxTotalFragment
      }
      transactions {
        ...TransactionFragment
      }
      uid
      updatedAt
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"document": PurchaseDebitNoteInput}
Response
{
  "data": {
    "addPurchaseDebitNote": {
      "document": PurchaseDebitNoteDocument,
      "errors": [Error],
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

addPurchaseInvoice

Description

Adds a Purchase Invoice.

Adds a purchase e-invoice, which is consulted in the DIAN through its CUFE. The existance and ownership of the invoice is also verified (PurchaseInvoiceInput).

Response

Returns a PurchaseInvoiceDocumentOutput

Arguments
Name Description
document - PurchaseInvoiceInput!

Example

Query
mutation AddPurchaseInvoice($document: PurchaseInvoiceInput!) {
  addPurchaseInvoice(document: $document) {
    document {
      billingPrefix {
        ...BillingPrefixFragment
      }
      documentLines {
        ...DocumentLineFragment
      }
      documentModifiers {
        ...AllowanceChargeFragment
      }
      documentParties {
        ...DocumentPartiesFragment
      }
      documentStatus {
        ...StatusDescriptorFragment
      }
      documentTotals {
        ...LegalMonetaryTotalFragment
      }
      documentType
      documentUid
      events {
        ...EventFragment
      }
      files {
        ...DocumentFilesFragment
      }
      generalInformation {
        ...GeneralInformationInterfaceFragment
      }
      id
      insertedAt
      organizationalUnitId
      paymentDescription {
        ...DocumentPaymentDescriptorFragment
      }
      referencedDocuments {
        ...DocumentReferenceFragment
      }
      taxDescription {
        ...TaxTotalFragment
      }
      transactions {
        ...TransactionFragment
      }
      uid
      updatedAt
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"document": PurchaseInvoiceInput}
Response
{
  "data": {
    "addPurchaseInvoice": {
      "document": PurchaseDocument,
      "errors": [Error],
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

createAccountStatement

Description

Add a Account Statement.

Add an Account Statement to an Organization or Organizational unit based on a defined product.

Response

Returns an AccountStatementOutput

Arguments
Name Description
data - AccountStatementInput!

Example

Query
mutation CreateAccountStatement($data: AccountStatementInput!) {
  createAccountStatement(data: $data) {
    accountStatement {
      accountStatementId
      availableCredits
      concurrency
      creditsData {
        ...CreditsDataFragment
      }
      insertedAt
      notifications
      planName
      planSpecificationEmission {
        ...EmissionDataFragment
      }
      planSpecificationReception {
        ...ReceptionDataFragment
      }
      productSpecification
      productVersion
      purchaseDate
      totalCredits
      updatedAt
      validityDateEnd
      validityDateStart
    }
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"data": AccountStatementInput}
Response
{
  "data": {
    "createAccountStatement": {
      "accountStatement": AccountStatement,
      "errors": [Error],
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

createAcquisitionAdjustmentNote

Description

Create one Support Document Note.

Creates a note to an Acquisition Support Document (AcquisitionAdjustmentNoteInput).

Response

Returns an AcquisitionAdjustmentNoteOutput

Arguments
Name Description
document - AcquisitionAdjustmentNoteInput!

Example

Query
mutation CreateAcquisitionAdjustmentNote($document: AcquisitionAdjustmentNoteInput!) {
  createAcquisitionAdjustmentNote(document: $document) {
    document {
      assessmentState
      billingPrefix {
        ...BillingPrefixFragment
      }
      dianState
      documentLines {
        ...DocumentLineFragment
      }
      documentModifiers {
        ...AllowanceChargeFragment
      }
      documentParties {
        ...DocumentPartiesFragment
      }
      documentQr
      documentStatus {
        ...StatusDescriptorFragment
      }
      documentTotals {
        ...LegalMonetaryTotalFragment
      }
      documentType
      documentUid
      events {
        ...EventFragment
      }
      files {
        ...DocumentFilesFragment
      }
      generalInformation {
        ...GeneralInformationInterfaceFragment
      }
      goodsState
      id
      insertedAt
      issuerSoftwareSystem {
        ...IssuerSoftwareSystemOutputFragment
      }
      notes {
        ...DocumentNotesOutputFragment
      }
      organizationalUnitId
      paymentDescription {
        ...DocumentPaymentDescriptorFragment
      }
      referencedDocuments {
        ...DocumentReferenceFragment
      }
      taxDescription {
        ...TaxTotalFragment
      }
      transactions {
        ...TransactionFragment
      }
      uid
      updatedAt
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"document": AcquisitionAdjustmentNoteInput}
Response
{
  "data": {
    "createAcquisitionAdjustmentNote": {
      "document": AcquisitionAdjustmentNoteDocument,
      "errors": [Error],
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

createAcquisitionSupportDocument

Description

Create one Support Document.

The supporting document is created in acquisitions made to parties not obliged to issue a sales e-invoice or equivalent document (AcquisitionSupportDocumentInput).

Response

Returns an AcquisitionSupportDocumentOutput

Arguments
Name Description
document - AcquisitionSupportDocumentInput!

Example

Query
mutation CreateAcquisitionSupportDocument($document: AcquisitionSupportDocumentInput!) {
  createAcquisitionSupportDocument(document: $document) {
    document {
      adjustmentNoteSummary {
        ...NoteSummaryFragment
      }
      assessmentState
      billingPrefix {
        ...BillingPrefixFragment
      }
      dianState
      documentLines {
        ...DocumentLineFragment
      }
      documentModifiers {
        ...AllowanceChargeFragment
      }
      documentParties {
        ...DocumentPartiesFragment
      }
      documentQr
      documentStatus {
        ...StatusDescriptorFragment
      }
      documentSummary {
        ...AcquisitionDocumentSummaryFragment
      }
      documentTotals {
        ...LegalMonetaryTotalFragment
      }
      documentType
      documentUid
      events {
        ...EventFragment
      }
      files {
        ...DocumentFilesFragment
      }
      generalInformation {
        ...GeneralInformationInterfaceFragment
      }
      goodsState
      id
      insertedAt
      issuerSoftwareSystem {
        ...IssuerSoftwareSystemOutputFragment
      }
      notes {
        ...DocumentNotesOutputFragment
      }
      organizationalUnitId
      paymentDescription {
        ...DocumentPaymentDescriptorFragment
      }
      referencedDocuments {
        ...DocumentReferenceFragment
      }
      taxDescription {
        ...TaxTotalFragment
      }
      transactions {
        ...TransactionFragment
      }
      uid
      updatedAt
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"document": AcquisitionSupportDocumentInput}
Response
{
  "data": {
    "createAcquisitionSupportDocument": {
      "document": AcquisitionSupportDocument,
      "errors": [Error],
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

createCreditNote

Description

Create one Credit Note.

Creates a credit note to an e-invoice already filed with DIAN, our system does not support all types of credit notes, it only accepts the cancellation credit note (voidInvoice) and the partial credit note (createCreditNote).

Response

Returns a CreditNoteDocumentOutput

Arguments
Name Description
document - CreditNoteInput!

Example

Query
mutation CreateCreditNote($document: CreditNoteInput!) {
  createCreditNote(document: $document) {
    document {
      assessmentState
      billingPrefix {
        ...BillingPrefixFragment
      }
      dianState
      documentLines {
        ...DocumentLineFragment
      }
      documentModifiers {
        ...AllowanceChargeFragment
      }
      documentParties {
        ...DocumentPartiesFragment
      }
      documentQr
      documentStatus {
        ...StatusDescriptorFragment
      }
      documentTotals {
        ...LegalMonetaryTotalFragment
      }
      documentType
      documentUid
      events {
        ...EventFragment
      }
      files {
        ...DocumentFilesFragment
      }
      generalInformation {
        ...GeneralInformationInterfaceFragment
      }
      goodsState
      id
      insertedAt
      issuerSoftwareSystem {
        ...IssuerSoftwareSystemOutputFragment
      }
      notes {
        ...DocumentNotesOutputFragment
      }
      organizationalUnitId
      paymentDescription {
        ...DocumentPaymentDescriptorFragment
      }
      referencedDocuments {
        ...DocumentReferenceFragment
      }
      taxDescription {
        ...TaxTotalFragment
      }
      transactions {
        ...TransactionFragment
      }
      uid
      updatedAt
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"document": CreditNoteInput}
Response
{
  "data": {
    "createCreditNote": {
      "document": CreditNote,
      "errors": [Error],
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

createDebitNote

Description

Create one Debit Note.

Creates a debit note to an e-invoice already filed with DIAN, remember that when you make a debit note you are required to have made an electronic invoice (SaleDebitNoteInput).

Response

Returns a DebitNoteDocumentOutput

Arguments
Name Description
document - SaleDebitNoteInput!

Example

Query
mutation CreateDebitNote($document: SaleDebitNoteInput!) {
  createDebitNote(document: $document) {
    document {
      billingPrefix {
        ...BillingPrefixFragment
      }
      documentLines {
        ...DocumentLineFragment
      }
      documentModifiers {
        ...AllowanceChargeFragment
      }
      documentParties {
        ...DocumentPartiesFragment
      }
      documentQr
      documentStatus {
        ...StatusDescriptorFragment
      }
      documentTotals {
        ...LegalMonetaryTotalFragment
      }
      documentType
      documentUid
      events {
        ...EventFragment
      }
      files {
        ...DocumentFilesFragment
      }
      generalInformation {
        ...GeneralInformationInterfaceFragment
      }
      id
      insertedAt
      issuerSoftwareSystem {
        ...IssuerSoftwareSystemOutputFragment
      }
      notes {
        ...DocumentNotesOutputFragment
      }
      organizationalUnitId
      paymentDescription {
        ...DocumentPaymentDescriptorFragment
      }
      referencedDocuments {
        ...DocumentReferenceFragment
      }
      taxDescription {
        ...TaxTotalFragment
      }
      transactions {
        ...TransactionFragment
      }
      uid
      updatedAt
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"document": SaleDebitNoteInput}
Response
{
  "data": {
    "createDebitNote": {
      "document": DebitNote,
      "errors": [Error],
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

createDocument

Description

Creates one Document.

Creates an electronic document following the DIAN's standards. (In the case of Colombia these are defined in the Technical Annex that can be found in the DIAN's homepage).

Response

Returns a DocumentOutput

Arguments
Name Description
document - XmlFileInput!

Example

Query
mutation CreateDocument($document: XmlFileInput!) {
  createDocument(document: $document) {
    document {
      billingPrefix {
        ...BillingPrefixFragment
      }
      documentLines {
        ...DocumentLineFragment
      }
      documentModifiers {
        ...AllowanceChargeFragment
      }
      documentParties {
        ...DocumentPartiesFragment
      }
      documentStatus {
        ...StatusDescriptorFragment
      }
      documentTotals {
        ...LegalMonetaryTotalFragment
      }
      documentType
      documentUid
      events {
        ...EventFragment
      }
      generalInformation {
        ...GeneralInformationInterfaceFragment
      }
      id
      insertedAt
      organizationalUnitId
      paymentDescription {
        ...DocumentPaymentDescriptorFragment
      }
      referencedDocuments {
        ...DocumentReferenceFragment
      }
      taxDescription {
        ...TaxTotalFragment
      }
      transactions {
        ...TransactionFragment
      }
      uid
      updatedAt
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"document": XmlFileInput}
Response
{
  "data": {
    "createDocument": {
      "document": DocumentInterface,
      "errors": [Error],
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

createInvoice

Description

Create one Invoice.

Creates the electronic sales invoice. (In the case of Colombia it is electronic by resolution of the DIAN). The types of operation that invoices can have are:

  • AIU(Administration, incidentals and utility)
  • Standard Sales Invoice
  • Mandate Invoice
  • Money Exchange Invoice
  • Transportation Invoice
Response

Returns an InvoiceDocumentOutput

Arguments
Name Description
document - InvoiceInput!

Example

Query
mutation CreateInvoice($document: InvoiceInput!) {
  createInvoice(document: $document) {
    document {
      assessmentState
      billingPrefix {
        ...BillingPrefixFragment
      }
      creditNoteSummary {
        ...NoteSummaryFragment
      }
      debitNoteSummary {
        ...NoteSummaryFragment
      }
      dianState
      documentLines {
        ...DocumentLineFragment
      }
      documentModifiers {
        ...AllowanceChargeFragment
      }
      documentParties {
        ...DocumentPartiesFragment
      }
      documentQr
      documentStatus {
        ...StatusDescriptorFragment
      }
      documentSummary {
        ...InvoiceDocumentSummaryFragment
      }
      documentTotals {
        ...LegalMonetaryTotalFragment
      }
      documentType
      documentUid
      events {
        ...EventFragment
      }
      files {
        ...DocumentFilesFragment
      }
      generalInformation {
        ...GeneralInformationInterfaceFragment
      }
      goodsState
      id
      insertedAt
      issuerSoftwareSystem {
        ...IssuerSoftwareSystemOutputFragment
      }
      notes {
        ...DocumentNotesOutputFragment
      }
      organizationalUnitId
      paymentDescription {
        ...DocumentPaymentDescriptorFragment
      }
      referencedDocuments {
        ...DocumentReferenceFragment
      }
      taxDescription {
        ...TaxTotalFragment
      }
      transactions {
        ...TransactionFragment
      }
      uid
      updatedAt
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"document": InvoiceInput}
Response
{
  "data": {
    "createInvoice": {
      "document": Invoice,
      "errors": [Error],
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

createPosInvoice

Description

Create one POS Invoice.

Creates the electronic sales invoice. (In the case of Colombia it is electronic by resolution of the DIAN). The types of operation that invoices can have are:

  • AIU(Administration, incidentals and utility)
  • Standard Sales Invoice
  • Mandate Invoice
  • Money Exchange Invoice
  • Transportation Invoice
Response

Returns a PosInvoiceDocumentOutput

Arguments
Name Description
document - PosInvoiceInput!

Example

Query
mutation CreatePosInvoice($document: PosInvoiceInput!) {
  createPosInvoice(document: $document) {
    document {
      assessmentState
      billingPrefix {
        ...BillingPrefixFragment
      }
      creditNoteSummary {
        ...NoteSummaryFragment
      }
      debitNoteSummary {
        ...NoteSummaryFragment
      }
      dianState
      documentLines {
        ...DocumentLineFragment
      }
      documentModifiers {
        ...AllowanceChargeFragment
      }
      documentParties {
        ...DocumentPartiesFragment
      }
      documentQr
      documentStatus {
        ...StatusDescriptorFragment
      }
      documentSummary {
        ...InvoiceDocumentSummaryFragment
      }
      documentTotals {
        ...LegalMonetaryTotalFragment
      }
      documentType
      documentUid
      events {
        ...EventFragment
      }
      files {
        ...DocumentFilesFragment
      }
      generalInformation {
        ...GeneralInformationInterfaceFragment
      }
      goodsState
      id
      insertedAt
      issuerSoftwareSystem {
        ...IssuerSoftwareSystemOutputFragment
      }
      notes {
        ...DocumentNotesOutputFragment
      }
      organizationalUnitId
      paymentDescription {
        ...DocumentPaymentDescriptorFragment
      }
      referencedDocuments {
        ...DocumentReferenceFragment
      }
      taxDescription {
        ...TaxTotalFragment
      }
      transactions {
        ...TransactionFragment
      }
      uid
      updatedAt
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"document": PosInvoiceInput}
Response
{
  "data": {
    "createPosInvoice": {
      "document": PosInvoice,
      "errors": [Error],
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

eventInvoiceExpressAcceptance

Description

Create an "Explicit Acceptance" event of a Purchase e-invoice.

Create the "Explicit Acceptance" event (ExplicitAcceptanceEventInput).

This event only applies to electronic invoices to credit that your suppliers make to you and can only be made by you who is the acquirer (debtor) of the invoice. The express acceptance of the invoice indicates that you accept the content of the invoice (that you have no claims), that the products (goods or services) comply with what is indicated on the invoice and that they were delivered without any claim.

Response

Returns an EventOutput

Arguments
Name Description
data - ExpressAcceptanceEventInput!

Example

Query
mutation EventInvoiceExpressAcceptance($data: ExpressAcceptanceEventInput!) {
  eventInvoiceExpressAcceptance(data: $data) {
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    event {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"data": ExpressAcceptanceEventInput}
Response
{
  "data": {
    "eventInvoiceExpressAcceptance": {
      "errors": [Error],
      "event": Event,
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

eventInvoiceProductsDelivery

Description

Create a "Goods and Services delivered" event of a sale e-invoice.

Create the Goods and Services delivered event (ProductsDeliveryEventInput).

Response

Returns an EventOutput

Arguments
Name Description
data - ProductsDeliveryEventInput!

Example

Query
mutation EventInvoiceProductsDelivery($data: ProductsDeliveryEventInput!) {
  eventInvoiceProductsDelivery(data: $data) {
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    event {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"data": ProductsDeliveryEventInput}
Response
{
  "data": {
    "eventInvoiceProductsDelivery": {
      "errors": [Error],
      "event": Event,
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

eventInvoiceProductsReception

Description

Create a "Goods and Services received" event of a Purchase Invoice.

Create the "Goods and Services received" event (ProductsReceptionEventInput).

This event only applies to electronic credit invoices issued by your suppliers and can only be performed by the acquirer (debtor) of the invoice. The receipt of the goods only indicates that you received the products (goods or services). This event does not imply tacit acceptance of the invoice or acceptance (that it was delivered in full and without any claim) of the good or service rendered, only the receipt of these.

Response

Returns an EventOutput

Arguments
Name Description
data - ProductsReceptionEventInput!

Example

Query
mutation EventInvoiceProductsReception($data: ProductsReceptionEventInput!) {
  eventInvoiceProductsReception(data: $data) {
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    event {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"data": ProductsReceptionEventInput}
Response
{
  "data": {
    "eventInvoiceProductsReception": {
      "errors": [Error],
      "event": Event,
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

eventInvoiceReceiptAck

Description

Create an "Acknowledgement Of receipt" event of a Purchase e-invoice.

Create an Acknowledgement Of receipt event of a Purchase e-invoice.(AcknowledgementEventInput).

This event only applies to the electronic invoices to credit that your suppliers make to you and can only be made by the acquirer (debtor) of the invoice. The acknowledgement indicates to your supplier that you received the invoice, this event does not imply acceptance of the invoice or the products (goods or services).

Response

Returns an EventOutput

Arguments
Name Description
data - AckEventInput!

Example

Query
mutation EventInvoiceReceiptAck($data: AckEventInput!) {
  eventInvoiceReceiptAck(data: $data) {
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    event {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"data": AckEventInput}
Response
{
  "data": {
    "eventInvoiceReceiptAck": {
      "errors": [Error],
      "event": Event,
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

eventInvoiceRejection

Description

Create the "Complaint On The Document" event (InvoiceComplaintEventInput).

This event only applies to electronic invoices to credit that your suppliers make to you and can only be made by you who is the acquirer (debtor) of the invoice. The claim implies that you had a rejection or a claim on the invoice or on the products (goods or services) received.

Response

Returns an EventOutput

Arguments
Name Description
data - InvoiceRejectionEventInput!

Example

Query
mutation EventInvoiceRejection($data: InvoiceRejectionEventInput!) {
  eventInvoiceRejection(data: $data) {
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    event {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"data": InvoiceRejectionEventInput}
Response
{
  "data": {
    "eventInvoiceRejection": {
      "errors": [Error],
      "event": Event,
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

eventInvoiceTacitAcceptance

Description

Create a "Tacit Acceptance" event of a sale e-invoice.

Creates the event "Tacit Acceptance" event of a sale e-invoice (TacitAcceptanceEventInput).

It is an event that is generated by the issuer of the invoice when at least 72 hours have passed after the acceptance of goods or services by the acquirer. It is an acceptance by omission..

Response

Returns an EventOutput

Arguments
Name Description
data - TacitAcceptanceEventInput!

Example

Query
mutation EventInvoiceTacitAcceptance($data: TacitAcceptanceEventInput!) {
  eventInvoiceTacitAcceptance(data: $data) {
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    event {
      additionalDocuments {
        ...FileDescriptorFragment
      }
      applicationResponse
      dianState
      documentId
      eventDescription
      eventNotes
      eventType
      eventUid
      id
      issueDate
      issuerParty {
        ...EventPartyFragment
      }
      notificationState
      reason
      receiverParty {
        ...EventPartyFragment
      }
      receptionDate
      senderParty {
        ...EventPartyFragment
      }
      statusIndicator
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"data": TacitAcceptanceEventInput}
Response
{
  "data": {
    "eventInvoiceTacitAcceptance": {
      "errors": [Error],
      "event": Event,
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

updateDianResolutions

Description

Updates the DIAN resolutions.

Downloads and saves the resolutions registered in the DIAN systems

Response

Returns a DianResolutionDataOutput

Example

Query
mutation UpdateDianResolutions {
  updateDianResolutions {
    billingResolutions {
      billingPrefix
      billingPrefixData {
        ...BillingPrefixDataFragment
      }
      billingRangeId
      documentType
      insertedAt
      organizationId
      organizationUnitId
      resolutionNumber
      updatedAt
    }
  }
}
Response
{
  "data": {
    "updateDianResolutions": {
      "billingResolutions": [BillingResolution]
    }
  }
}

updateInvoicerData

Description

Updates the Invoicer data.

Updates either the Organization, a specific Organizational Unit or all of them. This mutation can be used to:

  • Update fiscal data (Responsibilities, Economic activities, etc.)
  • Assign a billing prefix to an specific Organizational Unit
  • Update Organizational Unit settings (Test set ID, billing email, etc.)
  • Update Billing resolutions
Response

Returns a Client

Arguments
Name Description
data - InvoicerDataInput!

Example

Query
mutation UpdateInvoicerData($data: InvoicerDataInput!) {
  updateInvoicerData(data: $data) {
    billingResolutions {
      billingPrefix
      billingPrefixData {
        ...BillingPrefixDataFragment
      }
      billingRangeId
      documentType
      insertedAt
      organizationId
      organizationUnitId
      resolutionNumber
      updatedAt
    }
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    organization {
      insertedAt
      organizationBusinessData {
        ...OrganizationBusinessDataFragment
      }
      organizationContactData {
        ...ContactDataFragment
      }
      organizationFiscalData {
        ...FiscalDataFragment
      }
      organizationId
      organizationMiscData {
        ...NoteFieldOutputFragment
      }
      organizationName
      organizationNit
      organizationSettings {
        ...OrganizationSettingsFragment
      }
      organizationState {
        ...NoteFieldOutputFragment
      }
      organizationType {
        ...PersonTypeOutputFragment
      }
      organizationalUnits {
        ...OrganizationUnitFragment
      }
      updatedAt
    }
    organizationUnits {
      documents {
        ...DocumentInterfaceFragment
      }
      insertedAt
      organizationId
      organizationUnitBusinessData {
        ...OrganizationUnitBusinessDataFragment
      }
      organizationUnitContactData {
        ...ContactDataFragment
      }
      organizationUnitFiscalData {
        ...FiscalDataFragment
      }
      organizationUnitId
      organizationUnitMiscData {
        ...NoteFieldOutputFragment
      }
      organizationUnitName
      organizationUnitNit
      organizationUnitSettings {
        ...NoteFieldOutputFragment
      }
      organizationUnitState {
        ...NoteFieldOutputFragment
      }
      organizationUnitUpdateDataJ
      updatedAt
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"data": InvoicerDataInput}
Response
{
  "data": {
    "updateInvoicerData": {
      "billingResolutions": [BillingResolution],
      "errors": [Error],
      "notifications": [Information],
      "organization": Organization,
      "organizationUnits": [OrganizationUnit],
      "warnings": [Warning]
    }
  }
}

voidAcquisitionSupportDocument

Description

Void one Support Document.

Voids the Aquisition Support Document (AcquisitionSupportDocumentInput).

Response

Returns an AcquisitionAdjustmentNoteOutput

Arguments
Name Description
document - AcquisitionSupportDocumentVoidInput!

Example

Query
mutation VoidAcquisitionSupportDocument($document: AcquisitionSupportDocumentVoidInput!) {
  voidAcquisitionSupportDocument(document: $document) {
    document {
      assessmentState
      billingPrefix {
        ...BillingPrefixFragment
      }
      dianState
      documentLines {
        ...DocumentLineFragment
      }
      documentModifiers {
        ...AllowanceChargeFragment
      }
      documentParties {
        ...DocumentPartiesFragment
      }
      documentQr
      documentStatus {
        ...StatusDescriptorFragment
      }
      documentTotals {
        ...LegalMonetaryTotalFragment
      }
      documentType
      documentUid
      events {
        ...EventFragment
      }
      files {
        ...DocumentFilesFragment
      }
      generalInformation {
        ...GeneralInformationInterfaceFragment
      }
      goodsState
      id
      insertedAt
      issuerSoftwareSystem {
        ...IssuerSoftwareSystemOutputFragment
      }
      notes {
        ...DocumentNotesOutputFragment
      }
      organizationalUnitId
      paymentDescription {
        ...DocumentPaymentDescriptorFragment
      }
      referencedDocuments {
        ...DocumentReferenceFragment
      }
      taxDescription {
        ...TaxTotalFragment
      }
      transactions {
        ...TransactionFragment
      }
      uid
      updatedAt
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"document": AcquisitionSupportDocumentVoidInput}
Response
{
  "data": {
    "voidAcquisitionSupportDocument": {
      "document": AcquisitionAdjustmentNoteDocument,
      "errors": [Error],
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

voidInvoice

Description

Void an Invoice.

Void an e-invoice, with the following data: invoice sequence, invoice ID and the reason for the cancellation (VoidInvoiceInput).

Response

Returns a CreditNoteDocumentOutput

Arguments
Name Description
document - VoidInvoiceInput!

Example

Query
mutation VoidInvoice($document: VoidInvoiceInput!) {
  voidInvoice(document: $document) {
    document {
      assessmentState
      billingPrefix {
        ...BillingPrefixFragment
      }
      dianState
      documentLines {
        ...DocumentLineFragment
      }
      documentModifiers {
        ...AllowanceChargeFragment
      }
      documentParties {
        ...DocumentPartiesFragment
      }
      documentQr
      documentStatus {
        ...StatusDescriptorFragment
      }
      documentTotals {
        ...LegalMonetaryTotalFragment
      }
      documentType
      documentUid
      events {
        ...EventFragment
      }
      files {
        ...DocumentFilesFragment
      }
      generalInformation {
        ...GeneralInformationInterfaceFragment
      }
      goodsState
      id
      insertedAt
      issuerSoftwareSystem {
        ...IssuerSoftwareSystemOutputFragment
      }
      notes {
        ...DocumentNotesOutputFragment
      }
      organizationalUnitId
      paymentDescription {
        ...DocumentPaymentDescriptorFragment
      }
      referencedDocuments {
        ...DocumentReferenceFragment
      }
      taxDescription {
        ...TaxTotalFragment
      }
      transactions {
        ...TransactionFragment
      }
      uid
      updatedAt
      withholdingsDescription {
        ...WithholdingTotalFragment
      }
    }
    errors {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    notifications {
      helpText
      id
      language
      message
      subType
      title
      type
    }
    warnings {
      helpText
      id
      language
      message
      subType
      title
      type
    }
  }
}
Variables
{"document": VoidInvoiceInput}
Response
{
  "data": {
    "voidInvoice": {
      "document": CreditNote,
      "errors": [Error],
      "notifications": [Information],
      "warnings": [Warning]
    }
  }
}

Types

AccountStatement

Description

Defines the response object for a business Unit type

Fields
Field Name Description
accountStatementId - String The account_statement ID
availableCredits - decimal The amount available of credits.
concurrency - Int The concurrency in the creation.
creditsData - CreditsData Structure for the Organization's unit contact details.
insertedAt - DateTime Date and time at which the account statement was inserted.
notifications - String Notifications about plan.
planName - String The name of the plan
planSpecificationEmission - EmissionData Structure for an Emission data.
planSpecificationReception - ReceptionData Structure for the Organization's unit contact details.
productSpecification - json The Version of the product when the purchase was made
productVersion - Int The Version of the product when the purchase was made
purchaseDate - Date The date the plan was purchased
totalCredits - decimal The total amount of credits.
updatedAt - DateTime Date and time at which the account statement was updated.
validityDateEnd - Date The date the plan end its validity
validityDateStart - Date The date the plan start its validity
Example
{
  "accountStatementId": "xyz789",
  "availableCredits": decimal,
  "concurrency": 987,
  "creditsData": CreditsData,
  "insertedAt": "2007-12-03T10:15:30Z",
  "notifications": "abc123",
  "planName": "abc123",
  "planSpecificationEmission": EmissionData,
  "planSpecificationReception": ReceptionData,
  "productSpecification": json,
  "productVersion": 987,
  "purchaseDate": "2007-12-03",
  "totalCredits": decimal,
  "updatedAt": "2007-12-03T10:15:30Z",
  "validityDateEnd": "2007-12-03",
  "validityDateStart": "2007-12-03"
}

AccountStatementConnection

Description

Defines the response object for a query to list account statements.

Fields
Field Name Description
edges - [AccountStatementEdge] Used to select the fields that you want to retrieve from each edge in the connection.
pageCursors - PageCursors Returns the structure with the pagination of the search results.
pageInfo - PageInfo Returns details about the current page of results.
totalCount - Int Total number of records in the table taking into account the filters applied.
totalPages - Int Total number of pages under the filters set by the user.
Example
{
  "edges": [AccountStatementEdge],
  "pageCursors": PageCursors,
  "pageInfo": PageInfo,
  "totalCount": 987,
  "totalPages": 987
}

AccountStatementEdge

Description

Defines each edge, in this case account statement together with their cursor.

Fields
Field Name Description
cursor - String A marker for an edge's position in the connection.
node - AccountStatement The fields to be returned for each node.
Example
{
  "cursor": "xyz789",
  "node": AccountStatement
}

AccountStatementInput

Description

Structure that defines all the necessary information for a Account Statement.

Fields
Input Field Description
credits - Int

The amount of credits.

  • Mandatory: required
notifications - String

Notifications about plan.

  • Mandatory: optional
organizationUuid - UID

The uuid of the organization

  • Mandatory: required
organizationalUnitUuid - UID

The uuid of the organizational unit

  • Mandatory: required
planName - String

The name of the plan

  • Mandatory: required
planSpecificationEmission - EmissionDataInput

Structure for an Emission data.

  • Mandatory: required
planSpecificationReception - ReceptionDataInput

Structure for the Organization's unit contact details.

  • Mandatory: required
productSpecification - json

The Version of the product when the purchase was made

  • Mandatory: optional
productUuid - String

The Uuid of the product

  • Mandatory: optional
productVersion - Int

The Version of the product when the purchase was made

  • Mandatory: optional
purchaseDate - Date

The date the plan was purchased

  • Mandatory: required
validityDateEnd - Date

The date the plan end its validity

  • Mandatory: required
validityDateStart - Date

The date the plan start its validity

  • Mandatory: required
Example
{
  "credits": 123,
  "notifications": "xyz789",
  "organizationUuid": UID,
  "organizationalUnitUuid": UID,
  "planName": "abc123",
  "planSpecificationEmission": EmissionDataInput,
  "planSpecificationReception": ReceptionDataInput,
  "productSpecification": json,
  "productUuid": "xyz789",
  "productVersion": 987,
  "purchaseDate": "2007-12-03",
  "validityDateEnd": "2007-12-03",
  "validityDateStart": "2007-12-03"
}

AccountStatementOrderInput

Description

Code to identify the type of account statement ordering

Values
Enum Value Description

ACCOUNT_STATEMENT_ID_ASC

Sort by account statement id in ascending order.

ACCOUNT_STATEMENT_ID_DESC

Sort by account statement id in descending order.

INSERTED_AT_ASC

Sort by inserted at in ascending order.

INSERTED_AT_DESC

Sort by inserted at in descending order.

PLAN_NAME_ASC

Sort by plan name in ascending order.

PLAN_NAME_DESC

Sort by plan name in descending order.

PURCHASE_AT_ASC

Sort by purchase at in ascending order.

PURCHASE_AT_DESC

Sort by purchase at in descending order.
Example
"ACCOUNT_STATEMENT_ID_ASC"

AccountStatementOutput

Description

Structure for an account statement output

Fields
Field Name Description
accountStatement - AccountStatement The created event.
errors - [Error] List of errors associated with this organization.
notifications - [Information] List of notifications associated with this organization.
warnings - [Warning] List of warnings associated with this organization.
Example
{
  "accountStatement": AccountStatement,
  "errors": [Error],
  "notifications": [Information],
  "warnings": [Warning]
}

AccountStatementQueryInput

Description

Query Input: Define the query and search options for the account statement according to the filters presented.

Fields
Input Field Description
and - [AccountStatementQueryOptionsInput]

List of filters where all must happen.

  • Mandatory: optional
  • Length: [1-∞]
contains - [AccountStatementQuerySearchInput]

A partial search. The text is a substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
endsWith - [AccountStatementQuerySearchInput]

A partial search. The text is the ending substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
not - [AccountStatementQueryOptionsInput]

List of filters where none must happen.

  • Mandatory: optional
  • Length: [1-∞]
or - [AccountStatementQueryOptionsInput]

List of filters where only one has to happen.

  • Mandatory: optional
  • Length: [1-∞]
startsWith - [AccountStatementQuerySearchInput]

A partial search. The text is the starting substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
Example
{
  "and": [AccountStatementQueryOptionsInput],
  "contains": [AccountStatementQuerySearchInput],
  "endsWith": [AccountStatementQuerySearchInput],
  "not": [AccountStatementQueryOptionsInput],
  "or": [AccountStatementQueryOptionsInput],
  "startsWith": [AccountStatementQuerySearchInput]
}

AccountStatementQueryOptionsInput

Description

Structure that defines all the necessary information for the query options for And/Or/Not statements of the organizational unit.

Fields
Input Field Description
id - String

The id of the organization.

  • Mandatory: optional
  • Length: 3-150
planName - String

The Organization's business email.
Example value: organizationemail@gmail.com

  • Mandatory: optional
purchaseDate - Date

Code that identify each Colombian township.

  • Mandatory: optional
  • Length: 3-12
validityDateEnd - Date

The name of the township.

  • Mandatory: optional
  • Length: 3-25
validityDateStart - Date

The name of the township.

  • Mandatory: optional
  • Length: 3-25
Example
{
  "id": "abc123",
  "planName": "abc123",
  "purchaseDate": "2007-12-03",
  "validityDateEnd": "2007-12-03",
  "validityDateStart": "2007-12-03"
}

AccountStatementQuerySearchInput

Description

Structure that defines all the necessary information for the query options for text search statements.

Fields
Input Field Description
name - AccountStatementSearchInput

Query options for organization unit text search statements.

  • Mandatory: optional
value - String

Value to be assigned to this search.

  • Mandatory: optional
  • Length: 1-100
Example
{"name": "ID", "value": "xyz789"}

AccountStatementSearchInput

Description

Query options for account statement search statements

Values
Enum Value Description

ID

Text search by ID

PLAN_NAME

Text search by plan name
Example
"ID"

AccountingCustomerParty

Description

Group with information defining the Acquirer or buyer

Fields
Field Name Description
additionalAccountId - AdditionalAccountId Customer's person type
contact - PartyContactData An identifier for the end point of the routing service.
endpointId - EndpointId An identifier for the end point of the routing service.
identification - PersonId The identifier for this party.
name - PersonName A name for this party.
partyTaxScheme - PartyTaxScheme A tax scheme applying to this party.
physicalLocation - PhysicalLocation The physical location of this party.
Example
{
  "additionalAccountId": AdditionalAccountId,
  "contact": PartyContactData,
  "endpointId": EndpointId,
  "identification": PersonId,
  "name": PersonName,
  "partyTaxScheme": PartyTaxScheme,
  "physicalLocation": PhysicalLocation
}

AccountingCustomerPartyInput

Description

Structure that defines all the necessary information for the accounting customer party

Fields
Input Field Description
additionalAccountId - PersonType!

Customer's person type. Field indicating whether the person is a natural or legal person. (Posible values: "NATURAL_PERSON" or "LEGAL_ENTITY")

  • Mandatory: required
contact - ContactInput

The primary contact for this party.

  • Mandatory: optional
customerAssignedAccountId - String

An identifier for the customer's account,assigned by the customer itself.

  • Mandatory: optional
  • Length: 3-50
endpointId - EndpointIdInput

Structure that defines all the necessary information for an identifier for the end point of the routing service.

  • Mandatory: optional
industryClassificationCode - OrgEconomicActivitiesInput

The party's economic activities.

  • Mandatory: optional
partyTaxScheme - PartyTaxSchemeInput

Structure that defines all the necessary information for a tax scheme applying to this party.

  • Mandatory: optional
personId - PersonIdInput!

Structure that defines all the necessary information for an identifier for this party.

  • Mandatory: required
personName - PersonNameInput!

Structure that defines all the necessary information for the person name for this party.
Here is the full name of the person or the corporate name, as applicable.

Example values:

  • For a natural person firstName and firstSurname are mandatory: Daniel Smith.
  • For a legal person: Cats Marketplace.
  • Mandatory: mandatory
physicalLocation - PhysicalLocationInput

Structure that defines all the necessary information for the physical location of this party.

  • Mandatory: optional
supplierAssignedAccountId - String

An identifier for the customer's account, assigned by the supplier.

  • Mandatory: optional
  • Length: 3-50
Example
{
  "additionalAccountId": "LEGAL_ENTITY",
  "contact": ContactInput,
  "customerAssignedAccountId": "abc123",
  "endpointId": EndpointIdInput,
  "industryClassificationCode": OrgEconomicActivitiesInput,
  "partyTaxScheme": PartyTaxSchemeInput,
  "personId": PersonIdInput,
  "personName": PersonNameInput,
  "physicalLocation": PhysicalLocationInput,
  "supplierAssignedAccountId": "abc123"
}

AccountingSupplierParty

Description

Group with information defining the obligor to invoice: Invoicing party or the seller

Fields
Field Name Description
additionalAccountId - AdditionalAccountId Seller's person type.
contact - PartyContactData An identifier for the end point of the routing service.
endpointId - EndpointId An identifier for the end point of the routing service.
identification - PersonId The identifier for this party.
name - PersonName A name for this party.
partyTaxScheme - PartyTaxScheme A tax scheme applying to this party.
physicalLocation - PhysicalLocation The physical location of this party.
Example
{
  "additionalAccountId": AdditionalAccountId,
  "contact": PartyContactData,
  "endpointId": EndpointId,
  "identification": PersonId,
  "name": PersonName,
  "partyTaxScheme": PartyTaxScheme,
  "physicalLocation": PhysicalLocation
}

AccountingSupplierPartyInput

Description

Structure that defines all the necessary information for the accounting customer party

Fields
Input Field Description
additionalAccountId - PersonType!

Customer's person type. Field indicating whether the person is a natural or legal person. (Posible values: "NATURAL_PERSON" or "LEGAL_ENTITY")

  • Mandatory: required
contact - ContactInput

The primary contact for this party.

  • Mandatory: optional
customerAssignedAccountId - String

An identifier for the customer's account,assigned by the customer itself.

  • Mandatory: optional
  • Length: 3-50
endpointId - EndpointIdInput

Structure that defines all the necessary information for an identifier for the end point of the routing service.

  • Mandatory: optional
industryClassificationCode - OrgEconomicActivitiesInput

The party's economic activities.

  • Mandatory: optional
partyTaxScheme - PartyTaxSchemeInput!

Structure that defines all the necessary information for a tax scheme applying to this party.

  • Mandatory: optional
personId - PersonIdInput!

Structure that defines all the necessary information for an identifier for this party.

  • Mandatory: required
personName - PersonNameInput!

Structure that defines all the necessary information for the person name for this party.
Here is the full name of the person or the corporate name, as applicable.

Example values:

  • For a natural person firstName and firstSurname are mandatory: Daniel Smith.
  • For a legal person: Cats Marketplace.
  • Mandatory: required
physicalLocation - PhysicalLocationInput!

Structure that defines all the necessary information for the physical location of this party.

  • Mandatory: required
Example
{
  "additionalAccountId": "LEGAL_ENTITY",
  "contact": ContactInput,
  "customerAssignedAccountId": "abc123",
  "endpointId": EndpointIdInput,
  "industryClassificationCode": OrgEconomicActivitiesInput,
  "partyTaxScheme": PartyTaxSchemeInput,
  "personId": PersonIdInput,
  "personName": PersonNameInput,
  "physicalLocation": PhysicalLocationInput
}

AckEventInput

Description

Ack Of receipt of the invoice.

Fields
Input Field Description
eventNotes - [NoteField]

Additional named notes for the event. Each note requires a name or concept.

  • Mandatory: optional
  • Length: [0-n]
id - EventIdInput!

The unique identifier of an Event.

  • Mandatory: required
issueDate - DateTime!

Date and time of the event issuance

  • Mandatory: required
issuerParty - EventPartyInput!

Description of the person/entity who received the event

  • Mandatory: required
purchaseInvoiceUid - UID!

The unique identifier of an already imported Purchase Invoice.

  • Mandatory: required
Example
{
  "eventNotes": [NoteField],
  "id": EventIdInput,
  "issueDate": "2007-12-03T10:15:30Z",
  "issuerParty": EventPartyInput,
  "purchaseInvoiceUid": UID
}

AcquisitionAdjustmentNoteDocument

Description

Defines the response object for a Acquisition Adjustment Notes

Fields
Field Name Description
assessmentState - Int Assessment state
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for an acquisition document prefix.
dianState - Int State code in the DIAN
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentQr - String QR's code content represented as text
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
files - DocumentFiles Files related to the document.
generalInformation - GeneralInformationInterface Document's general information.
goodsState - Int Goods state
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the support document was inserted.
issuerSoftwareSystem - IssuerSoftwareSystemOutput Additional information to inform the software system issuing the document.
notes - [DocumentNotesOutput] Additional information: Free text, related to the document
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's UUID.
updatedAt - DateTime Date and time when the support document was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "assessmentState": 987,
  "billingPrefix": BillingPrefix,
  "dianState": 123,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentQr": "xyz789",
  "documentStatus": StatusDescriptor,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "abc123",
  "documentUid": UID,
  "events": [Event],
  "files": DocumentFiles,
  "generalInformation": GeneralInformationInterface,
  "goodsState": 123,
  "id": "abc123",
  "insertedAt": "2007-12-03T10:15:30Z",
  "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
  "notes": [DocumentNotesOutput],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

AcquisitionAdjustmentNoteDocumentConnection

Description

Defines the response object for a query to list acquisition adjustment note documents.

Fields
Field Name Description
edges - [AcquisitionAdjustmentNoteDocumentEdge] Used to select the fields that you want to retrieve from each edge in the connection.
pageCursors - PageCursors Returns the structure with the pagination of the search results.
pageInfo - PageInfo Returns details about the current page of results.
totalCount - Int Total number of records in the table taking into account the filters applied.
totalPages - Int Total number of pages under the filters set by the user.
Example
{
  "edges": [AcquisitionAdjustmentNoteDocumentEdge],
  "pageCursors": PageCursors,
  "pageInfo": PageInfo,
  "totalCount": 987,
  "totalPages": 987
}

AcquisitionAdjustmentNoteDocumentEdge

Description

Defines each edge, in this case discount code together with their cursor.

Fields
Field Name Description
cursor - String A marker for an edge's position in the connection.
node - AcquisitionAdjustmentNoteDocumentNode The fields to be returned for each node.
Example
{
  "cursor": "xyz789",
  "node": AcquisitionAdjustmentNoteDocumentNode
}

AcquisitionAdjustmentNoteDocumentNode

Description

Defines the response object for a Acquisition Adjustment Notes

Fields
Field Name Description
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for an acquisition document prefix.
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
generalInformation - GeneralInformationInterface Document's general information.
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the support document was inserted.
issuerSoftwareSystem - IssuerSoftwareSystemOutput Additional information to inform the software system issuing the document.
notes - [DocumentNotesOutput] Additional information: Free text, related to the document
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's UUID.
updatedAt - DateTime Date and time when the support document was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "billingPrefix": BillingPrefix,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentStatus": StatusDescriptor,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "xyz789",
  "documentUid": UID,
  "events": [Event],
  "generalInformation": GeneralInformationInterface,
  "id": "xyz789",
  "insertedAt": "2007-12-03T10:15:30Z",
  "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
  "notes": [DocumentNotesOutput],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

AcquisitionAdjustmentNoteGeneralInformationInput

Description

Structure that defines all the necessary information for a acquisition support document general information

Fields
Input Field Description
acquirerEmail - email

Buyer's Email.
Example value: buyeremail@gmail.com

  • Mandatory: optional
issueDateTime - DateTime!

Date and Time of Issuance.

  • Mandatory: required
operationCode - AcquisitionAdjustmentNoteOperationType!

The Acquirer Support Document's operation.

  • Mandatory: required
reasonOfIssuance - LocalizedStringInput!

The Debit Note's reason of issuance.

  • Mandatory: required
subtypeCode - AcquisitionAdjustmentNoteSubtype!

The Acquirer Support Document's subtype.

  • Mandatory: required
Example
{
  "acquirerEmail": email,
  "issueDateTime": "2007-12-03T10:15:30Z",
  "operationCode": "PARTIAL_OR_TOTAL_DISCOUNT",
  "reasonOfIssuance": LocalizedStringInput,
  "subtypeCode": "ADJUSTMENT_NOTE"
}

AcquisitionAdjustmentNoteInput

Description

Structure that defines all the necessary information for a Support Document.

Fields
Input Field Description
documentLines - [DocumentLineInput!]!

Input with information concerning products within the document.

  • Mandatory: required
  • Length: [1-n]
documentModifiers - [AllowanceChargeInput]

Input where discount's or charges are found.

  • Mandatory: optional
  • Length: [0-n]
documentTotals - LegalMonetaryTotalInput!

The total amount payable, including allowances, charges, and taxes.

  • Mandatory: required
generalInformation - AcquisitionAdjustmentNoteGeneralInformationInput!

Document's general information.

  • Mandatory: required
id - DocumentConsecutiveInput!

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: required
issuerSoftwareSystem - IssuerSoftwareSystem

Additional information to inform the software system issuing the document.

  • Mandatory: optional
notes - [DocumentNotes]

Additional information: Free text, related to the document.

  • Mandatory: optional
  • Length: [1-n]
paymentDescription - DocumentPaymentDescriptorInput!

Document's Payment Description.

  • Mandatory: required
referencedDocuments - [DocumentReferenceInput]

Additional Documents referenced inside the document

  • Mandatory: optional
  • Length: [0-n]
supportDocumentToModify - InvoiceIdInput!

This structure stores the consecutive and the ID of the support document to be modified.

  • Mandatory: required
taxDescription - [TaxTotalInput]

Structure with the information of the total amount of tax, like: the withholding tax, the total tax amount, etc.

  • Mandatory: optional
  • Length: [0-n]
withholdingsDescription - [WithholdingTotalInput!]

The total amount of tax.

  • Mandatory: optional
  • Length: [0-n]
Example
{
  "documentLines": [DocumentLineInput],
  "documentModifiers": [AllowanceChargeInput],
  "documentTotals": LegalMonetaryTotalInput,
  "generalInformation": AcquisitionAdjustmentNoteGeneralInformationInput,
  "id": DocumentConsecutiveInput,
  "issuerSoftwareSystem": IssuerSoftwareSystem,
  "notes": [DocumentNotes],
  "paymentDescription": DocumentPaymentDescriptorInput,
  "referencedDocuments": [DocumentReferenceInput],
  "supportDocumentToModify": InvoiceIdInput,
  "taxDescription": [TaxTotalInput],
  "withholdingsDescription": [WithholdingTotalInput]
}

AcquisitionAdjustmentNoteOperationType

Description

Type of operation

Values
Enum Value Description

PARTIAL_OR_TOTAL_DISCOUNT

Partial or total discount of the document

PARTIAL_REFUND

Partial refund of one or more products

PRICE_ADJUSTMENT

Price adjustment over one or moreproducts
Example
"PARTIAL_OR_TOTAL_DISCOUNT"

AcquisitionAdjustmentNoteOutput

Description

Structure for a document output

Fields
Field Name Description
document - AcquisitionAdjustmentNoteDocument The document.
errors - [Error] List of errors associated with this organization.
notifications - [Information] List of notifications associated with this organization.
warnings - [Warning] List of warnings associated with this organization.
Example
{
  "document": AcquisitionAdjustmentNoteDocument,
  "errors": [Error],
  "notifications": [Information],
  "warnings": [Warning]
}

AcquisitionAdjustmentNoteQueryInput

Description

Query Input: Define the query and search options for the document according to the filters presented.

Fields
Input Field Description
and - [AcquisitionAdjustmentNoteQueryOptionsInput]

List of filters where all must happen.

  • Mandatory: optional
  • Length: [1-∞]
contains - [DocumentQuerySearchInput]

A partial search. The text is a substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
endsWith - [DocumentQuerySearchInput]

A partial search. The text is the ending substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
not - [AcquisitionAdjustmentNoteQueryOptionsInput]

List of filters where none must happen.

  • Mandatory: optional
  • Length: [1-∞]
or - [AcquisitionAdjustmentNoteQueryOptionsInput]

List of filters where only one has to happen.

  • Mandatory: optional
  • Length: [1-∞]
startsWith - [DocumentQuerySearchInput]

A partial search. The text is the starting substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
Example
{
  "and": [AcquisitionAdjustmentNoteQueryOptionsInput],
  "contains": [DocumentQuerySearchInput],
  "endsWith": [DocumentQuerySearchInput],
  "not": [AcquisitionAdjustmentNoteQueryOptionsInput],
  "or": [AcquisitionAdjustmentNoteQueryOptionsInput],
  "startsWith": [DocumentQuerySearchInput]
}

AcquisitionAdjustmentNoteQueryOptionsInput

Description

Structure that defines all the necessary information for query options for And/Or/Not statements.

Fields
Input Field Description
creationDate - Date

Document creation date in the system.

  • Mandatory: optional
currency - CurrencyCode

Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3

  • Mandatory: optional
dateRange - DateRangeInput

Date range for document search.

  • Mandatory: optional
documentUid - UID

This is the document's UUID in YabiCo.

  • Mandatory: optional
id - String

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: optional
  • Length: 3-20
issueDate - Date

Date on which the document was sent to DIAN.

  • Mandatory: optional
operationCode - AcquisitionAdjustmentNoteOperationType

The Invoice's operation.

  • Mandatory: optional
organizationalUnitId - UID

UID of the organizational unit.

  • Mandatory: optional
personCompStringName - String

The company name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-50
personEmail - email

The email of the person assigned on the document.
Example value: youremail@gmail.com

  • Mandatory: optional
personFirstSurname - String

First sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personFirtsName - String

First name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personId - String

The identifier of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-25
personIdType - IdType

Type of person ID.

  • Mandatory: optional
personSecondName - String

Middle name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personSecondSurname - String

Seecond sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
subtypeCode - AcquisitionAdjustmentNoteSubtype

The Invoice's subtype.

  • Mandatory: optional
Example
{
  "creationDate": "2007-12-03",
  "currency": "AED",
  "dateRange": DateRangeInput,
  "documentUid": UID,
  "id": "abc123",
  "issueDate": "2007-12-03",
  "operationCode": "PARTIAL_OR_TOTAL_DISCOUNT",
  "organizationalUnitId": UID,
  "personCompStringName": "abc123",
  "personEmail": email,
  "personFirstSurname": "xyz789",
  "personFirtsName": "abc123",
  "personId": "abc123",
  "personIdType": "CC",
  "personSecondName": "abc123",
  "personSecondSurname": "xyz789",
  "subtypeCode": "ADJUSTMENT_NOTE"
}

AcquisitionAdjustmentNoteSubtype

Description

Acquisition adjustment note subtypes

Values
Enum Value Description

ADJUSTMENT_NOTE

Standard Adjustment Note
Example
"ADJUSTMENT_NOTE"

AcquisitionDocumentSummary

Description

Defines the structure with the summary with respect to the credit notes it contains.

Fields
Field Name Description
adjustmentNoteTotal - decimal Contains the total value of the sum of the adjustment notes of an acquisition document.
adjustmentNotes - Int Contains the number of adjustment notes in an acquisition document.
referenceDocuments - Int Contains the number of reference documents in an acquisition document.
Example
{
  "adjustmentNoteTotal": decimal,
  "adjustmentNotes": 123,
  "referenceDocuments": 123
}

AcquisitionSupportDocument

Description

Defines the response object for a Support Document

Fields
Field Name Description
adjustmentNoteSummary - [NoteSummary] Contains a summary of the list of adjustment notes made to the purchase invoice.
assessmentState - Int Assessment state
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for an acquisition document prefix.
dianState - Int State code in the DIAN
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentQr - String QR's code content represented as text
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentSummary - AcquisitionDocumentSummary Acquisition Document summary with respect to the credit notes it contains.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
files - DocumentFiles Files related to the invoice.
generalInformation - GeneralInformationInterface Document's general information.
goodsState - Int Goods state
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the support document was inserted.
issuerSoftwareSystem - IssuerSoftwareSystemOutput Additional information to inform the software system issuing the document.
notes - [DocumentNotesOutput] Additional information: Free text, related to the document
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's UUID.
updatedAt - DateTime Date and time when the support document was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "adjustmentNoteSummary": [NoteSummary],
  "assessmentState": 123,
  "billingPrefix": BillingPrefix,
  "dianState": 987,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentQr": "abc123",
  "documentStatus": StatusDescriptor,
  "documentSummary": AcquisitionDocumentSummary,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "abc123",
  "documentUid": UID,
  "events": [Event],
  "files": DocumentFiles,
  "generalInformation": GeneralInformationInterface,
  "goodsState": 987,
  "id": "abc123",
  "insertedAt": "2007-12-03T10:15:30Z",
  "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
  "notes": [DocumentNotesOutput],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

AcquisitionSupportDocumentConnection

Description

Defines the response object for a query to list support documents.

Fields
Field Name Description
edges - [AcquisitionSupportDocumentEdge] Used to select the fields that you want to retrieve from each edge in the connection.
pageCursors - PageCursors Returns the structure with the pagination of the search results.
pageInfo - PageInfo Returns details about the current page of results.
totalCount - Int Total number of records in the table taking into account the filters applied.
totalPages - Int Total number of pages under the filters set by the user.
Example
{
  "edges": [AcquisitionSupportDocumentEdge],
  "pageCursors": PageCursors,
  "pageInfo": PageInfo,
  "totalCount": 123,
  "totalPages": 123
}

AcquisitionSupportDocumentEdge

Description

Defines each edge, in this case discount code together with their cursor.

Fields
Field Name Description
cursor - String A marker for an edge's position in the connection.
node - AcquisitionSupportDocumentNode The fields to be returned for each node.
Example
{
  "cursor": "xyz789",
  "node": AcquisitionSupportDocumentNode
}

AcquisitionSupportDocumentGeneralInformation

Description

Acquisition Support Document's General Information

Fields
Field Name Description
acquirerEmail - email Buyer's Email.
Example value: buyeremail@gmail.com
currency - Currency Document's Currency code.
Here is the complete list of possible values for this field, go to page 596 #13.3.3
environment - String Document Environment (Test, Hab or Prod)
issueDateTime - DateTime! Date and Time of Issuance
operationCode - OperationCode The Acquirer Support Document's operation.
subtypeCode - SubTypeCode The Acquirer Support Document's subtype.
Example
{
  "acquirerEmail": email,
  "currency": Currency,
  "environment": "xyz789",
  "issueDateTime": "2007-12-03T10:15:30Z",
  "operationCode": OperationCode,
  "subtypeCode": SubTypeCode
}

AcquisitionSupportDocumentGeneralInformationInput

Description

Structure that defines all the necessary information for a acquisition support document general information

Fields
Input Field Description
acquirerEmail - email

Buyer's Email.
Example value: buyeremail@gmail.com

  • Mandatory: optional
currency - CurrencyCode!

Document's Currency code.
Here is the complete list of possible values for this field, go to page 596 #13.3.3

  • Mandatory: required
issueDateTime - DateTime!

Date and Time of Issuance.

  • Mandatory: required
operationCode - AcquisitionSupportDocumentOperationType!

The Acquirer Support Document's operation.

  • Mandatory: required
subtypeCode - AcquisitionSupportDocumentSubtype!

The Acquirer Support Document's subtype.

  • Mandatory: required
Example
{
  "acquirerEmail": email,
  "currency": "AED",
  "issueDateTime": "2007-12-03T10:15:30Z",
  "operationCode": "NON_RESIDENT_PURCHASE",
  "subtypeCode": "REGULAR_PURCHASE"
}

AcquisitionSupportDocumentInput

Description

Structure that defines all the necessary information for a Support Document.

Fields
Input Field Description
documentLines - [DocumentLineInput!]!

Input with information concerning products within the document.

  • Mandatory: required
  • Length: [1-n]
documentModifiers - [AllowanceChargeInput]

Input where discount's or charges are found.

  • Mandatory: optional
  • Length: [0-n]
documentParties - PurchaseDocumentPartiesInput!

Parties involved in the document.

  • Mandatory: required
documentTotals - LegalMonetaryTotalInput!

The total amount payable, including allowances, charges, and taxes.

  • Mandatory: required
generalInformation - AcquisitionSupportDocumentGeneralInformationInput!

Document's general information.

  • Mandatory: required
id - DocumentConsecutiveInput!

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: required
issuerSoftwareSystem - IssuerSoftwareSystem

Additional information to inform the software system issuing the document.

  • Mandatory: optional
notes - [DocumentNotes]

Additional information: Free text, related to the document.

  • Mandatory: optional
  • Length: [1-n]
organizationalUnitId - UID!

Organizational Unit's Id.

  • Mandatory: required
paymentDescription - DocumentPaymentDescriptorInput!

Document's Payment Description.

  • Mandatory: required
referencedDocuments - [DocumentReferenceInput]

Additional Documents referenced inside the document

  • Mandatory: optional
  • Length: [0-n]
taxDescription - [TaxTotalInput]

Structure with the information of the total amount of tax, like: the withholding tax, the total tax amount, etc.

  • Mandatory: optional
  • Length: [0-n]
withholdingsDescription - [WithholdingTotalInput!]

The total amount of tax.

  • Mandatory: optional
  • Length: [0-n]
Example
{
  "documentLines": [DocumentLineInput],
  "documentModifiers": [AllowanceChargeInput],
  "documentParties": PurchaseDocumentPartiesInput,
  "documentTotals": LegalMonetaryTotalInput,
  "generalInformation": AcquisitionSupportDocumentGeneralInformationInput,
  "id": DocumentConsecutiveInput,
  "issuerSoftwareSystem": IssuerSoftwareSystem,
  "notes": [DocumentNotes],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptorInput,
  "referencedDocuments": [DocumentReferenceInput],
  "taxDescription": [TaxTotalInput],
  "withholdingsDescription": [WithholdingTotalInput]
}

AcquisitionSupportDocumentNode

Description

Defines the response object for a Support Document

Fields
Field Name Description
adjustmentNoteSummary - [NoteSummary] Contains a summary of the list of adjustment notes made to the purchase invoice.
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for an acquisition document prefix.
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentSummary - AcquisitionDocumentSummary Acquisition Document summary with respect to the credit notes it contains.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
generalInformation - GeneralInformationInterface Document's general information.
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the support document was inserted.
issuerSoftwareSystem - IssuerSoftwareSystemOutput Additional information to inform the software system issuing the document.
notes - [DocumentNotesOutput] Additional information: Free text, related to the document
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's UUID.
updatedAt - DateTime Date and time when the support document was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "adjustmentNoteSummary": [NoteSummary],
  "billingPrefix": BillingPrefix,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentStatus": StatusDescriptor,
  "documentSummary": AcquisitionDocumentSummary,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "abc123",
  "documentUid": UID,
  "events": [Event],
  "generalInformation": GeneralInformationInterface,
  "id": "abc123",
  "insertedAt": "2007-12-03T10:15:30Z",
  "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
  "notes": [DocumentNotesOutput],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

AcquisitionSupportDocumentOperationType

Description

Type of operation

Values
Enum Value Description

NON_RESIDENT_PURCHASE

Purchase to a non-resident in the country

RESIDENT_PURCHASE

Purchase to a resident in the country
Example
"NON_RESIDENT_PURCHASE"

AcquisitionSupportDocumentOutput

Description

Structure for a document output

Fields
Field Name Description
document - AcquisitionSupportDocument The document.
errors - [Error] List of errors associated with this organization.
notifications - [Information] List of notifications associated with this organization.
warnings - [Warning] List of warnings associated with this organization.
Example
{
  "document": AcquisitionSupportDocument,
  "errors": [Error],
  "notifications": [Information],
  "warnings": [Warning]
}

AcquisitionSupportDocumentQueryInput

Description

Query Input: Define the query and search options for the document according to the filters presented.

Fields
Input Field Description
and - [AcquisitionSupportDocumentQueryOptionsInput]

List of filters where all must happen.

  • Mandatory: optional
  • Length: [1-∞]
contains - [DocumentQuerySearchInput]

A partial search. The text is a substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
endsWith - [DocumentQuerySearchInput]

A partial search. The text is the ending substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
not - [AcquisitionSupportDocumentQueryOptionsInput]

List of filters where none must happen.

  • Mandatory: optional
  • Length: [1-∞]
or - [AcquisitionSupportDocumentQueryOptionsInput]

List of filters where only one has to happen.

  • Mandatory: optional
  • Length: [1-∞]
startsWith - [DocumentQuerySearchInput]

A partial search. The text is the starting substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
Example
{
  "and": [AcquisitionSupportDocumentQueryOptionsInput],
  "contains": [DocumentQuerySearchInput],
  "endsWith": [DocumentQuerySearchInput],
  "not": [AcquisitionSupportDocumentQueryOptionsInput],
  "or": [AcquisitionSupportDocumentQueryOptionsInput],
  "startsWith": [DocumentQuerySearchInput]
}

AcquisitionSupportDocumentQueryOptionsInput

Description

Structure that defines all the necessary information for query options for And/Or/Not statements.

Fields
Input Field Description
creationDate - Date

Document creation date in the system.

  • Mandatory: optional
currency - CurrencyCode

Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3

  • Mandatory: optional
dateRange - DateRangeInput

Date range for document search.

  • Mandatory: optional
documentUid - UID

This is the document's UUID in YabiCo.

  • Mandatory: optional
id - String

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: optional
  • Length: 3-20
issueDate - Date

Date on which the document was sent to DIAN.

  • Mandatory: optional
organizationalUnitId - UID

UID of the organizational unit.

  • Mandatory: optional
personCompStringName - String

The company name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-50
personEmail - email

The email of the person assigned on the document.
Example value: youremail@gmail.com

  • Mandatory: optional
personFirstSurname - String

First sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personFirtsName - String

First name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personId - String

The identifier of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-25
personIdType - IdType

Type of person ID.

  • Mandatory: optional
personSecondName - String

Middle name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personSecondSurname - String

Seecond sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
Example
{
  "creationDate": "2007-12-03",
  "currency": "AED",
  "dateRange": DateRangeInput,
  "documentUid": UID,
  "id": "xyz789",
  "issueDate": "2007-12-03",
  "organizationalUnitId": UID,
  "personCompStringName": "abc123",
  "personEmail": email,
  "personFirstSurname": "abc123",
  "personFirtsName": "xyz789",
  "personId": "xyz789",
  "personIdType": "CC",
  "personSecondName": "xyz789",
  "personSecondSurname": "abc123"
}

AcquisitionSupportDocumentSubtype

Description

Acquisition support document subtypes

Values
Enum Value Description

REGULAR_PURCHASE

A regular Acquisition Support Document
Example
"REGULAR_PURCHASE"

AcquisitionSupportDocumentVoidInput

Description

Structure that defines all the necessary information for a Support Document.

Fields
Input Field Description
acquisitionSupportDocumentToVoid - AcquisitionSupportIdInput!

This structure stores the consecutive and the ID of the acquisition support document to be voided.

  • Mandatory: required
id - DocumentConsecutiveInput!

Document number: Invoice or exchange acquisition support document number. Includes prefix + consecutive acquisition support document number authorized by DIAN.

  • Mandatory: required
issuerSoftwareSystem - IssuerSoftwareSystem

Additional information to inform the software system issuing the document.

  • Mandatory: optional
notes - [DocumentNotes]

Additional information: Free text, related to the document.

  • Mandatory: optional
  • Length: [1-n]
reason - LocalizedStringInput!

Free text field to enter the reason for cancelling the acquisition support document.

  • Mandatory: optional
Example
{
  "acquisitionSupportDocumentToVoid": AcquisitionSupportIdInput,
  "id": DocumentConsecutiveInput,
  "issuerSoftwareSystem": IssuerSoftwareSystem,
  "notes": [DocumentNotes],
  "reason": LocalizedStringInput
}

AcquisitionSupportIdInput

Description

Structure that defines all the necessary information of the acquisition support identifiers.

Fields
Input Field Description
id - DocumentConsecutiveInput

Document number: Invoice or exchange acquisition support document number. Includes prefix + consecutive acquisition support document number authorized by DIAN.

  • Mandatory: optional
uid - UID

The identificator of the acquisition support document in the system, represented as an uuid or another identificator.

  • Mandatory: optional
Example
{
  "id": DocumentConsecutiveInput,
  "uid": UID
}

AdditionalAccountId

Description

Defines the response object for the additional account ID

Fields
Field Name Description
code - String A code signifying the person type.
description - String The description or meaning of the additional account ID.
Example
{
  "code": "xyz789",
  "description": "abc123"
}

AllowanceCharge

Description

Structure for the allowance charge

Fields
Field Name Description
amount - decimal The monetary amount of this allowance or charge to be applied.
baseAmount - decimal The monetary amount to which the multiplier factor is applied in calculating the amount of this allowance or charge.
chargeIndicator - String An indicator that this AllowanceCharge describes a charge or a discount.
percentage - Float Used for percentaged discounts/charges.
reason - LocalizedString The reason for this allowance or charge.
reasonCode - reasonCode A code signifying the reason for this allowance or charge.
Example
{
  "amount": decimal,
  "baseAmount": decimal,
  "chargeIndicator": "abc123",
  "percentage": 987.65,
  "reason": LocalizedString,
  "reasonCode": reasonCode
}

AllowanceChargeInput

Description

Structure that defines all the necessary information for discount's or Charges

Fields
Input Field Description
amount - decimal!

The monetary amount of this allowance or charge to be applied.

  • Mandatory: required
  • Range: It must have between 4 and 15 positions, with between 0 and 6 decimal places
baseAmount - decimal!

The monetary amount to which the multiplier factor is applied in calculating the amount of this allowance or charge.

  • Mandatory: required
  • Range: It must have between 4 and 15 positions, with between 0 and 6 decimal places
chargeIndicator - IndicatorTypeCode!

An indicator that this AllowanceCharge describes a charge or a discount.

  • Mandatory: required
percentage - Float

Used for percentaged discounts/charges.

  • Mandatory: required
  • Range: It must have between 1 and 6 positions, with between 0 and 2 decimal places
reason - LocalizedStringInput!

The reason for this allowance or charge.

  • Mandatory: required
reasonCode - LineModifierCode

A code signifying the reason for this allowance or charge.

  • Mandatory: optional
Example
{
  "amount": decimal,
  "baseAmount": decimal,
  "chargeIndicator": "CHARGE",
  "percentage": 123.45,
  "reason": LocalizedStringInput,
  "reasonCode": "M00"
}

BillingPrefix

Description

Defines the structure for a Billing Prefix

Fields
Field Name Description
creationDate - Date Creation date of the referenced invoice.
id - UID The UID or identifier.
prefix - String Referenced invoice prefix.
range - IntegerRange Referenced invoice price range.
Example
{
  "creationDate": "2007-12-03",
  "id": UID,
  "prefix": "abc123",
  "range": IntegerRange
}

BillingPrefixData

Description

Defines the response object for a billing Range type

Fields
Field Name Description
endDate - DateTime Date and time at which the prefix can no longer be used.
from - Int Initial range number.
prefixDescription - String Quick summary
resolutionDate - DateTime Resolution's date of issuance.
startDate - DateTime Date and time from which the prefix can be used.
to - Int Final range number.
Example
{
  "endDate": "2007-12-03T10:15:30Z",
  "from": 123,
  "prefixDescription": "abc123",
  "resolutionDate": "2007-12-03T10:15:30Z",
  "startDate": "2007-12-03T10:15:30Z",
  "to": 123
}

BillingResolution

Description

Defines the response object for billing resolution

Fields
Field Name Description
billingPrefix - String Billing prefix.
billingPrefixData - BillingPrefixData Prefix data. It includes numbering limits and effective dates.
billingRangeId - UID Prefix's uuid.
documentType - DocumentType Document type
insertedAt - DateTime Date and time at which the organization unit was updated.
organizationId - UID Resolution's owner.
organizationUnitId - UID Current user of the prefix.
resolutionNumber - String Resolution number
updatedAt - DateTime Date and time at which the organization unit was updated.
Example
{
  "billingPrefix": "abc123",
  "billingPrefixData": BillingPrefixData,
  "billingRangeId": UID,
  "documentType": "CREDIT_NOTE",
  "insertedAt": "2007-12-03T10:15:30Z",
  "organizationId": UID,
  "organizationUnitId": UID,
  "resolutionNumber": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z"
}

BillingResolutionConnectionOutput

Description

Defines the response object for a query to list billing resolutions

Fields
Field Name Description
edges - [BillingResolutionEdge] Used to select the fields that you want to retrieve from each edge in the connection.
pageInfo - PageInfo Returns details about the current page of results.
Example
{
  "edges": [BillingResolutionEdge],
  "pageInfo": PageInfo
}

BillingResolutionEdge

Description

Defines each edge, in this case billing resolution together with their cursor.

Fields
Field Name Description
cursor - String A marker for an edge's position in the connection.
node - BillingResolution The fields to be returned for each node.
Example
{
  "cursor": "abc123",
  "node": BillingResolution
}

BillingResolutionOrderInput

Description

Code to identify the type of organization unit ordering

Values
Enum Value Description

BILLING_RANGE_ID_ASC

Sort by billing_range_id nit in ascending order.

BILLING_RANGE_ID_DESC

Sort by billing_range_id nit in descending order.

INSERTED_AT_ASC

Sort by inserted at in ascending order.

INSERTED_AT_DESC

Sort by inserted at in descending order.

PREFIX_DESCRIPTION_ASC

Sort by prefix description in ascending order.

PREFIX_DESCRIPTION_DESC

Sort by prefix description in descending order.

RESOLUTION_NUMBER_ASC

Sort by resolution number in ascending order.

RESOLUTION_NUMBER_DESC

Sort by resolution number in descending order.
Example
"BILLING_RANGE_ID_ASC"

BillingResolutionQueryInput

Description

Query Input: Define the query and search options for the billing resolution according to the filters presented.

Fields
Input Field Description
and - [BillingResolutionQueryOptionsInput]

List of filters where all must happen.

  • Mandatory: optional
  • Length: [1-∞]
contains - [BillingResolutionQuerySearchInput]

A partial search. The text is a substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
endsWith - [BillingResolutionQuerySearchInput]

A partial search. The text is the ending substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
not - [BillingResolutionQueryOptionsInput]

List of filters where none must happen.

  • Mandatory: optional
  • Length: [1-∞]
or - [BillingResolutionQueryOptionsInput]

List of filters where only one has to happen.

  • Mandatory: optional
  • Length: [1-∞]
startsWith - [BillingResolutionQuerySearchInput]

A partial search. The text is the starting substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
Example
{
  "and": [BillingResolutionQueryOptionsInput],
  "contains": [BillingResolutionQuerySearchInput],
  "endsWith": [BillingResolutionQuerySearchInput],
  "not": [BillingResolutionQueryOptionsInput],
  "or": [BillingResolutionQueryOptionsInput],
  "startsWith": [BillingResolutionQuerySearchInput]
}

BillingResolutionQueryOptionsInput

Description

Structure that defines all the necessary information for the query options for And/Or/Not statements of the billing resolution.

Fields
Input Field Description
prefixDescription - String

Quick summary of the prefix of the billing.

  • Mandatory: optional
  • Length: 3-15
resolutionNumber - String

The billing resolution number.

  • Mandatory: optional
  • Length: 3-15
Example
{
  "prefixDescription": "abc123",
  "resolutionNumber": "xyz789"
}

BillingResolutionQuerySearchInput

Description

Structure that defines all the necessary information for the Query options for text search statements.

Fields
Input Field Description
name - BillingResolutionSearchInput

Query options for billing resolution text search statements.

  • Mandatory: optional
value - String

Value to be assigned to this search.

  • Mandatory: optional
  • Length: 1-100
Example
{
  "name": "PREFIX_DESCRIPTION",
  "value": "abc123"
}

BillingResolutionSearchInput

Description

Query options for billing resolution search

Values
Enum Value Description

PREFIX_DESCRIPTION

Text search by prefix description

RESOLUTION_NUMBER

Text search by resolution number
Example
"PREFIX_DESCRIPTION"

Boolean

Description

The Boolean scalar type represents true or false.

Example
true

BuyerBenefitsExtensionInput

Description

Structure that defines all the necessary information for the POS Invoice extension

Fields
Input Field Description
customerIdCode - String!

Customer's id code in the seller's system.

  • Mandatory: optional
customerName - NaturalPersonNameInput!

Customer's Name

  • Mandatory: required
customerPoints - Int

Customer's account fidelity points.

  • Mandatory: optional. Default = 0
Example
{
  "customerIdCode": "xyz789",
  "customerName": NaturalPersonNameInput,
  "customerPoints": 123
}

ClaimConcept

Description

Claim concept

Values
Enum Value Description

CO_01

Documento con inconsistencias

CO_02

Mercancía no entregada totalmente

CO_03

Mercancía no entregada parcialmente

CO_04

Servicio no prestado
Example
"CO_01"

Client

Description

Defines the response object for a Client

Fields
Field Name Description
billingResolutions - [BillingResolution] List of the current billing prefixes.
errors - [Error] List of errors associated with this client.
notifications - [Information] List of notifications associated with this client.
organization - Organization Structure for an organization.
organizationUnits - [OrganizationUnit] List of the organizational units associated with this client.
warnings - [Warning] List of warnings associated with this client.
Example
{
  "billingResolutions": [BillingResolution],
  "errors": [Error],
  "notifications": [Information],
  "organization": Organization,
  "organizationUnits": [OrganizationUnit],
  "warnings": [Warning]
}

ContactData

Description

Structure for contact data

Fields
Field Name Description
address - PhysicalLocation Structure with the Contact's address.
contactId - PersonId Structure with the Contact's ID.
email - email Contact's email.
Example value: contactemail@gmail.com
name - PersonName Structure with the Contact's Name.
phone - String Contact's phone.
Example value for Colombia: 3133723182 or +57 3133723182
Example
{
  "address": PhysicalLocation,
  "contactId": PersonId,
  "email": email,
  "name": PersonName,
  "phone": "xyz789"
}

ContactDataUpdateInput

Description

Structure for an Organization's contact data update

Fields
Input Field Description
address - PhysicalLocationInput

Structure with the Contact's address.

  • Mandatory: optional
contactId - PersonIdInput

Structure with the Contact's ID.

  • Mandatory: optional
email - email

Contact's email.
Example value: contactemail@gmail.com

  • Mandatory: optional
name - PersonNameInput

Structure with the Contact's Name.

  • Mandatory: optional
phone - String

Contact's phone.
Example: '+57(601) 123 4567' '601 123 4567 / 601 765 4321' '1234567'

  • Mandatory: optional
Example
{
  "address": PhysicalLocationInput,
  "contactId": PersonIdInput,
  "email": email,
  "name": PersonNameInput,
  "phone": "xyz789"
}

ContactInput

Description

Structure that defines all the necessary information for a contact.

Fields
Input Field Description
email - email

The primary email address of this contact.
Example value: youremail@gmail.com

  • Mandatory: optional
id - PersonIdInput

Structure containing a person identifier for this contact.

  • Mandatory: optional
name - PersonNameInput

Structure containing the name of this contact.
Here is the full name of the person or the corporate name, as applicable.

Example values:

  • For a natural person firstName and firstSurname are mandatory: Daniel Smith.
  • For a legal person: Cats Marketplace
  • Mandatory: optional
note - [NoteField]

Structure containing a Free-form text conveying informaation.
Example value: "Only contact this person after 3pm"

  • Mandatory: optional
  • Length: [1-n]
otherCommunication - [NoteField]

Structure containing another means of communication with this contact.
Example value: "You can also contact this person by calling his office at 1234567 between the hours of 8am-5pm."

  • Mandatory: optional
  • Length: [1-n]
telefax - String

The primary fax number of this contact.
Example value: 555-123-4567, if you do business in area code 555, your fax number will begin with 555 and be followed by the 7 digits of a phone number.

  • Mandatory: optional
  • Length: 3-20
telephone - String

The primary telephone number of this contact.
Example value for Colombia: +57 3219407715, (+57) is the country code and then the phone number is entered.

  • Mandatory: optional
  • Length: 3-20
uid - UID

Contact identifier in the issuer's system

  • Mandatory: optional
Example
{
  "email": email,
  "id": PersonIdInput,
  "name": PersonNameInput,
  "note": [NoteField],
  "otherCommunication": [NoteField],
  "telefax": "abc123",
  "telephone": "xyz789",
  "uid": UID
}

CountryCode

Description

Country codes (Alpha-2) List of all country ISO codes: https://www.iban.com/country-codes

Values
Enum Value Description

AD

Andorra

AE

United Arab Emirates

AF

Afghanistan

AG

Antigua and Barbuda

AI

Anguilla

AL

Albania

AM

Armenia

AO

Angola

AQ

Antarctica

AR

Argentina

AS

American Samoa

AT

Austria

AU

Australia

AW

Aruba

AX

Åland Islands

AZ

Azerbaijan

BA

Bosnia and Herzegovina

BB

Barbados

BD

Bangladesh

BE

Belgium

BF

Burkina Faso

BG

Bulgaria

BH

Bahrain

BI

Burundi

BJ

Benin

BL

Saint Barthélemy

BM

Bermuda

BN

Brunei Darussalam

BO

Bolivia (Plurinational State of)

BQ

Bonaire, Sint Eustatius and Saba

BR

Brazil

BS

Bahamas

BT

Bhutan

BV

Bouvet Island

BW

Botswana

BY

Belarus

BZ

Belize

CA

Canada

CC

Cocos (Keeling) Islands

CD

Democratic Republic of the Congo

CF

Central African Republic

CG

Congo

CH

Switzerland

CI

Côte d'Ivoire

CK

Cook Islands

CL

Chile

CM

Cameroon

CN

China

CO

Colombia

CR

Costa Rica

CU

Cuba

CV

Cabo Verde

CW

Curaçao

CX

Christmas Island

CY

Cyprus

CZ

Czechia

DE

Germany

DJ

Djibouti

DK

Denmark

DM

Dominica

DO

Dominican Republic

DZ

Algeria

EC

Ecuador

EE

Estonia

EG

Egypt

EH

Western Sahara

ER

Eritrea

ES

Spain

ET

Ethiopia

FI

Finland

FJ

Fiji

FK

Falkland Islands (Malvinas)

FM

Micronesia (Federated States of)

FO

Faroe Islands

FR

France

GA

Gabon

GB

United Kingdom of Great Britain and Northern Ireland

GD

Grenada

GE

Georgia

GF

French Guiana

GG

Guernsey

GH

Ghana

GI

Gibraltar

GL

Greenland

GM

Gambia

GN

Guinea

GP

Guadeloupe

GQ

Equatorial Guinea

GR

Greece

GS

South Georgia and the South Sandwich Islands

GT

Guatemala

GU

Guam

GW

Guinea-Bissau

GY

Guyana

HK

China, Hong Kong Special Administrative Region

HM

Heard Island and McDonald Islands

HN

Honduras

HR

Croatia

HT

Haiti

HU

Hungary

ID

Indonesia

IE

Ireland

IL

Israel

IM

Isle of Man

IN

India

IO

British Indian Ocean Territory

IQ

Iraq

IR

Iran (Islamic Republic of)

IS

Iceland

IT

Italy

JE

Jersey

JM

Jamaica

JO

Jordan

JP

Japan

KE

Kenya

KG

Kyrgyzstan

KH

Cambodia

KI

Kiribati

KM

Comoros

KN

Saint Kitts and Nevis

KP

Democratic People's Republic of Korea

KR

Republic of Korea

KW

Kuwait

KY

Cayman Islands

KZ

Kazakhstan

LA

Lao People's Democratic Republic

LB

Lebanon

LC

Saint Lucia

LI

Liechtenstein

LK

Sri Lanka

LR

Liberia

LS

Lesotho

LT

Lithuania

LU

Luxembourg

LV

Latvia

LY

Libya

MA

Morocco

MC

Monaco

MD

Republic of Moldova

ME

Montenegro

MF

Saint Martin (French Part)

MG

Madagascar

MH

Marshall Islands

MK

The former Yugoslav Republic of Macedonia

ML

Mali

MM

Myanmar

MN

Mongolia

MO

China, Macao Special Administrative Region

MP

Northern Mariana Islands

MQ

Martinique

MR

Mauritania

MS

Montserrat

MT

Malta

MU

Mauritius

MV

Maldives

MW

Malawi

MX

Mexico

MY

Malaysia

MZ

Mozambique

NA

Namibia

NC

New Caledonia

NE

Niger

NF

Norfolk Island

NG

Nigeria

NI

Nicaragua

NL

Netherlands

NO

Norway

NP

Nepal

NR

Nauru

NU

Niue

NZ

New Zealand

OM

Oman

PA

Panama

PE

Peru

PF

French Polynesia

PG

Papua New Guinea

PH

Philippines

PK

Pakistan

PL

Poland

PM

Saint Pierre and Miquelon

PN

Pitcairn

PR

Puerto Rico

PS

State of Palestine

PT

Portugal

PW

Palau

PY

Paraguay

QA

Qatar

RE

Réunion

RO

Romania

RS

Serbia

RU

Russian Federation

RW

Rwanda

SA

Saudi Arabia

SB

Solomon Islands

SC

Seychelles

SD

Sudan

SE

Sweden

SG

Singapore

SH

Saint Helena

SI

Slovenia

SJ

Svalbard and Jan Mayen Islands

SK

Slovakia

SL

Sierra Leone

SM

San Marino

SN

Senegal

SO

Somalia

SR

Suriname

SS

South Sudan

ST

Sao Tome and Principe

SV

El Salvador

SX

Sint Maarten (Dutch part)

SY

Syrian Arab Republic

SZ

Eswatini

TC

Turks and Caicos Islands

TD

Chad

TF

French Southern Territories

TG

Togo

TH

Thailand

TJ

Tajikistan

TK

Tokelau

TL

Timor-Leste

TM

Turkmenistan

TN

Tunisia

TO

Tonga

TR

Turkey

TT

Trinidad and Tobago

TV

Tuvalu

TW

Taiwan (Province of China)

TZ

United Republic of Tanzania

UA

Ukraine

UG

Uganda

UM

United States Minor Outlying Islands

US

United States of America

UY

Uruguay

UZ

Uzbekistan

VA

Holy See

VC

Saint Vincent and the Grenadines

VE

Venezuela (Bolivarian Republic of)

VG

British Virgin Islands

VI

United States Virgin Islands

VN

Viet Nam

VU

Vanuatu

WF

Wallis and Futuna Islands

WS

Samoa

YE

Yemen

YT

Mayotte

ZA

South Africa

ZM

Zambia

ZW

Zimbabwe
Example
"AD"

CreditNote

Description

Defines the response object for a Credit Note

Fields
Field Name Description
assessmentState - Int Assessment state
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for an credit note prefix.
dianState - Int State code in the DIAN
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentQr - String QR's code content represented as text
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
files - DocumentFiles Files related to the invoice.
generalInformation - GeneralInformationInterface Document's general information.
goodsState - Int Goods state
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the credit note was inserted.
issuerSoftwareSystem - IssuerSoftwareSystemOutput Additional information to inform the software system issuing the document.
notes - [DocumentNotesOutput] Additional information: Free text, related to the document
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's UUID
updatedAt - DateTime Date and time when the credit note was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "assessmentState": 123,
  "billingPrefix": BillingPrefix,
  "dianState": 987,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentQr": "abc123",
  "documentStatus": StatusDescriptor,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "xyz789",
  "documentUid": UID,
  "events": [Event],
  "files": DocumentFiles,
  "generalInformation": GeneralInformationInterface,
  "goodsState": 987,
  "id": "xyz789",
  "insertedAt": "2007-12-03T10:15:30Z",
  "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
  "notes": [DocumentNotesOutput],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

CreditNoteConnection

Description

Defines the response object for a query to list credit notes.

Fields
Field Name Description
edges - [CreditNoteEdge] Used to select the fields that you want to retrieve from each edge in the connection.
pageCursors - PageCursors Returns the structure with the pagination of the search results.
pageInfo - PageInfo Returns details about the current page of results.
totalCount - Int Total number of records in the table taking into account the filters applied.
totalPages - Int Total number of pages under the filters set by the user.
Example
{
  "edges": [CreditNoteEdge],
  "pageCursors": PageCursors,
  "pageInfo": PageInfo,
  "totalCount": 987,
  "totalPages": 123
}

CreditNoteDocumentOutput

Description

Structure for a document output

Fields
Field Name Description
document - CreditNote The document.
errors - [Error] List of errors associated with this organization.
notifications - [Information] List of notifications associated with this organization.
warnings - [Warning] List of warnings associated with this organization.
Example
{
  "document": CreditNote,
  "errors": [Error],
  "notifications": [Information],
  "warnings": [Warning]
}

CreditNoteDocumentQueryInput

Description

Query Input: Define the query and search options for the document according to the filters presented.

Fields
Input Field Description
and - [CreditNoteDocumentQueryOptionsInput]

List of filters where all must happen.

  • Mandatory: optional
  • Length: [1-∞]
contains - [DocumentQuerySearchInput]

A partial search. The text is a substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
endsWith - [DocumentQuerySearchInput]

A partial search. The text is the ending substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
not - [CreditNoteDocumentQueryOptionsInput]

List of filters where none must happen.

  • Mandatory: optional
  • Length: [1-∞]
or - [CreditNoteDocumentQueryOptionsInput]

List of filters where only one has to happen.

  • Mandatory: optional
  • Length: [1-∞]
startsWith - [DocumentQuerySearchInput]

A partial search. The text is the starting substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
Example
{
  "and": [CreditNoteDocumentQueryOptionsInput],
  "contains": [DocumentQuerySearchInput],
  "endsWith": [DocumentQuerySearchInput],
  "not": [CreditNoteDocumentQueryOptionsInput],
  "or": [CreditNoteDocumentQueryOptionsInput],
  "startsWith": [DocumentQuerySearchInput]
}

CreditNoteDocumentQueryOptionsInput

Description

Structure that defines all the necessary information for query options for And/Or/Not statements.

Fields
Input Field Description
creationDate - Date

Document creation date in the system.

  • Mandatory: optional
currency - CurrencyCode

Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3

  • Mandatory: optional
dateRange - DateRangeInput

Date range for document search.

  • Mandatory: optional
documentUid - UID

This is the document's UUID in YabiCo.

  • Mandatory: optional
id - String

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: optional
  • Length: 3-20
issueDate - Date

Date on which the document was sent to DIAN.

  • Mandatory: optional
organizationalUnitId - UID

UID of the organizational unit.

  • Mandatory: optional
personCompStringName - String

The company name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-50
personEmail - email

The email of the person assigned on the document.
Example value: youremail@gmail.com

  • Mandatory: optional
personFirstSurname - String

First sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personFirtsName - String

First name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personId - String

The identifier of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-25
personIdType - IdType

Type of person ID.

  • Mandatory: optional
personSecondName - String

Middle name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personSecondSurname - String

Seecond sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
Example
{
  "creationDate": "2007-12-03",
  "currency": "AED",
  "dateRange": DateRangeInput,
  "documentUid": UID,
  "id": "xyz789",
  "issueDate": "2007-12-03",
  "organizationalUnitId": UID,
  "personCompStringName": "abc123",
  "personEmail": email,
  "personFirstSurname": "xyz789",
  "personFirtsName": "xyz789",
  "personId": "xyz789",
  "personIdType": "CC",
  "personSecondName": "abc123",
  "personSecondSurname": "abc123"
}

CreditNoteEdge

Description

Type-Object

Defines each edge, in this case credit note together with their cursor.

Fields
Field Name Description
cursor - String A marker for an edge's position in the connection.
node - CreditNoteNode The fields to be returned for each node.
Example
{
  "cursor": "xyz789",
  "node": CreditNoteNode
}

CreditNoteGeneralInformation

Description

CreditNote's General Information

Fields
Field Name Description
acquirerEmail - email Buyer's Email
Example value: buyeremail@gmail.com
currency - Currency Document's Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3
environment - String Document Environment (Test, Hab or Prod)
issueDateTime - DateTime! Date and Time of Issuance
operationCode - OperationCode The Credit Note's operation.
reasonOfIssuance - LocalizedString The Credit Note's reason of issuance.
subtypeCode - SubTypeCode The Credit Note's subtype.
Example
{
  "acquirerEmail": email,
  "currency": Currency,
  "environment": "abc123",
  "issueDateTime": "2007-12-03T10:15:30Z",
  "operationCode": OperationCode,
  "reasonOfIssuance": LocalizedString,
  "subtypeCode": SubTypeCode
}

CreditNoteGeneralInformationInput

Description

Structure that defines all the necessary information for a credit note general information

Fields
Input Field Description
acquirerEmail - email

Buyer's Email.
Example value: buyeremail@gmail.com

  • Mandatory: optional
issueDateTime - DateTime!

Date and Time of Issuance.

  • Mandatory: required
operationCode - CreditNoteOperationType!

The Credit Note's operation.

  • Mandatory: required
reasonOfIssuance - LocalizedStringInput!

The Credit Note's reason of issuance

  • Mandatory: required
subtypeCode - CreditNoteSubtype!

The Credit Note's subtype.

  • Mandatory: required
Example
{
  "acquirerEmail": email,
  "issueDateTime": "2007-12-03T10:15:30Z",
  "operationCode": "PARTIAL_REFUND",
  "reasonOfIssuance": LocalizedStringInput,
  "subtypeCode": "CREDIT_NOTE"
}

CreditNoteInput

Description

Structure that defines all the necessary information for a Credit Note.

Fields
Input Field Description
documentLines - [DocumentLineInput!]!

Input with information concerning products within the document.

  • Mandatory: required
  • Length: [1-n]
documentModifiers - [AllowanceChargeInput] documentModifiers[0-n]: Input where discount's or charges are found.
documentTotals - LegalMonetaryTotalInput!

The total amount payable, including allowances, charges, and taxes.

  • Mandatory: required
generalInformation - CreditNoteGeneralInformationInput!

Document's general information.

  • Mandatory: required
id - DocumentConsecutiveInput!

Document number: Credit note number. Includes prefix + consecutive number.

  • Mandatory: required
invoiceToModify - InvoiceIdInput!

This structure stores the consecutive and the ID of the invoice to be modified.

  • Mandatory: required
issuerSoftwareSystem - IssuerSoftwareSystem

Additional information to inform the software system issuing the document.

  • Mandatory: optional
notes - [DocumentNotes]

Additional information: Free text, related to the document.

  • Mandatory: optional
  • Length: [1-n]
organizationalUnitId - UID!

Organizational Unit's Id.

  • Mandatory: required
paymentDescription - DocumentPaymentDescriptorInput!

Document's Payment Description.

  • Mandatory: required
referencedDocuments - [DocumentReferenceInput]

Additional Documents referenced inside the document.

  • Mandatory: optional
  • Length: [1-n]
taxDescription - [TaxTotalInput]

taxDescription: Structure with the information of the total amount of tax, like: the withholding tax, the total tax amount, etc.

  • Mandatory: optional
  • Length: [1-n]
withholdingsDescription - [WithholdingTotalInput!]

The total amount of tax.

  • Mandatory: required
  • Length: [1-n]
Example
{
  "documentLines": [DocumentLineInput],
  "documentModifiers": [AllowanceChargeInput],
  "documentTotals": LegalMonetaryTotalInput,
  "generalInformation": CreditNoteGeneralInformationInput,
  "id": DocumentConsecutiveInput,
  "invoiceToModify": InvoiceIdInput,
  "issuerSoftwareSystem": IssuerSoftwareSystem,
  "notes": [DocumentNotes],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptorInput,
  "referencedDocuments": [DocumentReferenceInput],
  "taxDescription": [TaxTotalInput],
  "withholdingsDescription": [WithholdingTotalInput]
}

CreditNoteNode

Description

Defines the response object for a Credit Note

Fields
Field Name Description
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for an credit note prefix.
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
generalInformation - GeneralInformationInterface Document's general information.
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the credit note was inserted.
issuerSoftwareSystem - IssuerSoftwareSystemOutput Additional information to inform the software system issuing the document.
notes - [DocumentNotesOutput] Additional information: Free text, related to the document
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's UUID
updatedAt - DateTime Date and time when the credit note was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "billingPrefix": BillingPrefix,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentStatus": StatusDescriptor,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "abc123",
  "documentUid": UID,
  "events": [Event],
  "generalInformation": GeneralInformationInterface,
  "id": "xyz789",
  "insertedAt": "2007-12-03T10:15:30Z",
  "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
  "notes": [DocumentNotesOutput],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

CreditNoteOperationType

Description

Type of operation

Values
Enum Value Description

PARTIAL_REFUND

Partial Refund
Example
"PARTIAL_REFUND"

CreditNoteSubtype

Description

Credit Note subtypes

Values
Enum Value Description

CREDIT_NOTE

A regular Credit Note
Example
"CREDIT_NOTE"

CreditsData

Description

Defines the response object for a Credits Data

Fields
Field Name Description
annualValue - decimal Anual cost.
anualCredits - Int Amount of credits per year.
creditValue - decimal Cost per credit.
monthlyCredits - Int Amount of credits per month.
monthlyValue - decimal Monthly cost.
Example
{
  "annualValue": decimal,
  "anualCredits": 123,
  "creditValue": decimal,
  "monthlyCredits": 123,
  "monthlyValue": decimal
}

Currency

Description

Defines the response object for the currency

Fields
Field Name Description
code - String Currency selected for the document. Here is the complete list of possible values for this field, go to page 596 #13.3.3
description - String The description or meaning of the currency code.
Example
{
  "code": "xyz789",
  "description": "abc123"
}

CurrencyCode

Description

Document Currencies

Values
Enum Value Description

AED

United Arab Emi

AFA

Afghanistan, Af

ALL

Albania, Leke

AMD

Armenia, Drams

ANG

Netherlands Ant

AOA

Angola, Kwanza

ARS

Argentina, Peso

AUD

Australia, Doll

AWG

Aruba, Guilders

AZM

Azerbaijan, Man

BAM

Bosnia and Herz

BBD

Barbados, Dolla

BDT

Bangladesh, Tak

BGN

Bulgaria, Leva

BHD

Bahrain, Dinars

BIF

Burundi, Francs

BMD

Bermuda, Dollar

BND

Brunei Darussal

BOB

Bolivia, Bolivi

BRL

Brazil, Brazil

BSD

Bahamas, Dollar

BTN

Bhutan, Ngultru

BWP

Botswana, Pulas

BYR

Belarus, Rubles

BZD

Belize, Dollars

CAD

Canada, Dollars

CDF

Congo/Kinshasa

CHF

Switzerland, Fr

CLP

Chile, Pesos

CNY

China, Yuan Ren

COP

Colombia, Pesos

CRC

Costa Rica, Col

CUP

Cuba, Pesos

CVE

Cape Verde, Esc

CYP

Cyprus, Pounds

CZK

Czech Recurrencies

DJF

Djibouti, Franc

DKK

Denmark, Kroner

DOP

Dominican Repub

DZD

Algeria, Algeri

EEK

Estonia, Krooni

EGP

Egypt, Pounds

ERN

Eritrea, Nakfa

ETB

Ethiopia, Birr

EUR

Euro Member Country

FJD

Fiji, Dollars

FKP

Falkland Island

GBP

United Kingdom

GEL

Georgia, Lari

GGP

Guernsey, Pound

GHC

Ghana, Cedis

GIP

Gibraltar, Poun

GMD

Gambia, Dalasi

GNF

Guinea, Francs

GTQ

Guatemala, Quet

GYD

Guyana, Dollars

HKD

Hong Kong, Doll

HRK

Croatia, Kuna

HTG

Haiti, Gourdes

HUF

Hungary, Forint

IDR

Indonesia, Rupi

ILS

Israel, New She

IMP

Isle of Man, Po

INR

India, Rupees

IQD

Iraq, Dinars

IRR

Iran, Rials

ISK

Iceland, Kronur

JMD

Jamaica, Dollar

JOD

Jordan, Dinars

JPY

Japan, Yen

KES

Kenya, Shilling

KGS

Kyrgyzstan, Som

KHR

Cambodia, Riels

KMF

Comoros, Francs

KPW

Korea (North)

KRW

Korea (South)

KWD

Kuwait, Dinars

KYD

Cayman Islands,

KZT

Kazakstan, Teng

LAK

Laos, Kips

LBP

Lebanon, Pounds

LKR

Sri Lanka, Rupe

LRD

Liberia, Dollar

LSL

Lesotho, Maloti

LTL

Lithuania, Lita

LVL

Latvia, Lati

LYD

Libya, Dinars

MAD

Morocco, Dirham

MDL

Moldova, Lei

MGA

Madagascar, Ari

MKD

Macedonia, Dena

MMK

Myanmar (Burma)

MNT

Mongolia, Tugri

MOP

Macau, Patacas

MRO

Mauritania, Oug

MTL

Malta, Liri

MUR

Mauritius, Rupe

MVR

Maldives (Maldi

MWK

Malawi, Kwachas

MXN

Mexico, Pesos

MYR

Malaysia, Ringg

MZM

Mozambique, Met

NAD

Namibia, Dollar

NGN

Nigeria, Nairas

NIO

Nicaragua, Gold

NOK

Norway, Krone

NPR

Nepal, Nepal Ru

NZD

New Zealand, Do

OMR

Oman, Rials

PAB

Panama, Balboa

PEN

Peru, Nuevos So

PGK

Papua New Guine

PHP

Philippines, Pe

PKR

Pakistan, Rupee

PLN

Poland, Zlotych

PYG

Paraguay, Guara

QAR

Qatar, Rials

ROL

Romania, Lei

RSD

Serbia, Dinars

RUB

Russia, Rubles

RWF

Rwanda, Rwanda

SAR

Saudi Arabia, R

SBD

Solomon Islands

SCR

Seychelles, Rup

SDD

Sudan, Dinars

SDG

Sudan, Pounds

SEK

Sweden, Kronor

SGD

Singapore, Doll

SHP

Saint Helena, P

SIT

Slovenia, Tolar

SKK

Slovakia, Korun

SLL

Sierra Leone, L

SOS

Somalia, Shilli

SRD

Suriname, Dolla

STD

Sao Tome and P

SVC

El Salvador, Co

SYP

Syria, Pounds

SZL

Swaziland, Emal

THB

Thailand, Baht

TJS

Tajik., Somo.

TMT

Turkmenistan, M

TND

Tunisia, Dinars

TOP

Tonga, Paanga

TRY

Turkey, Liras

TTD

Trinidad and To

TVD

Tuvalu, Tuvalu

TWD

Taiwan, New Dol

TZS

Tanzania, Shill

UAH

Ukraine, Hryvni

UGX

Uganda, Shillin

USD

United States of America, Dollar

UYU

Uruguay, Pesos

UZS

Uzbekistan, Sum

VEB

Venezuela, Boli

VEF

Venez.Bol.Frte

VND

Viet Nam, Dong

VUV

Vanuatu, Vatu

WST

Samoa, Tala

XAF

C. Afri., Fra.

XCD

E. Car., Dol.

XOF

Africa, Francs

XPF

Polyn. Francs

YER

Yemen, Rials

ZAR

S. Afri., Rands

ZMK

Zamb., Kwachas

ZWL

Zimb., Dollars
Example
"AED"

Cursor

Description

Returns details about the cursors.

Fields
Field Name Description
cursor - String Id that identifies the cursor..
order - Int Order from left to right in relation to the other cursors.
page - Int Number of the page that translates the cursor.
type - String Cursor type to know the type of button to use (Numeric, First, Back, Next, Last).
Example
{
  "cursor": "abc123",
  "order": 987,
  "page": 123,
  "type": "xyz789"
}

Date

Description

The Date scalar type represents a date, the format is YYYY-MM-DD

Example
"2007-12-03"

DateRangeInput

Description

Structure that defines the dates between which documents can be filtered.

Fields
Input Field Description
endDate - Date

Indicates the date up to which the documents are leaked.

  • Mandatory: optional
startDate - Date

Indicates the date from which the documents are leaked.

  • Mandatory: optional
Example
{
  "endDate": "2007-12-03",
  "startDate": "2007-12-03"
}

DateTime

Description

The DateTime scalar type represents a date with time, the format is YYYY-MM-DD HH:mm:ssZ

Example
"2007-12-03T10:15:30Z"

DebitNote

Description

Defines the response object for a Debit Note

Fields
Field Name Description
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for an invoice prefix.
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentQr - String QR's code content represented as text
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
files - DocumentFiles Files related to the invoice.
generalInformation - GeneralInformationInterface Document's general information.
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the debit note was inserted.
issuerSoftwareSystem - IssuerSoftwareSystemOutput Additional information to inform the software system issuing the document.
notes - [DocumentNotesOutput] Additional information: Free text, related to the document
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's UUID.
updatedAt - DateTime Date and time when the debit note was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "billingPrefix": BillingPrefix,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentQr": "xyz789",
  "documentStatus": StatusDescriptor,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "xyz789",
  "documentUid": UID,
  "events": [Event],
  "files": DocumentFiles,
  "generalInformation": GeneralInformationInterface,
  "id": "abc123",
  "insertedAt": "2007-12-03T10:15:30Z",
  "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
  "notes": [DocumentNotesOutput],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

DebitNoteConnection

Description

Defines the response object for a query to list debit notes.

Fields
Field Name Description
edges - [DebitNoteEdge] Used to select the fields that you want to retrieve from each edge in the connection.
pageCursors - PageCursors Returns the structure with the pagination of the search results.
pageInfo - PageInfo Returns details about the current page of results.
totalCount - Int Total number of records in the table taking into account the filters applied.
totalPages - Int Total number of pages under the filters set by the user.
Example
{
  "edges": [DebitNoteEdge],
  "pageCursors": PageCursors,
  "pageInfo": PageInfo,
  "totalCount": 123,
  "totalPages": 123
}

DebitNoteDocumentOutput

Description

Structure for a document output

Fields
Field Name Description
document - DebitNote The document.
errors - [Error] List of errors associated with this organization.
notifications - [Information] List of notifications associated with this organization.
warnings - [Warning] List of warnings associated with this organization.
Example
{
  "document": DebitNote,
  "errors": [Error],
  "notifications": [Information],
  "warnings": [Warning]
}

DebitNoteDocumentQueryInput

Description

Query Input: Define the query and search options for the document according to the filters presented.

Fields
Input Field Description
and - [DebitNoteDocumentQueryOptionsInput]

List of filters where all must happen.

  • Mandatory: optional
  • Length: [1-∞]
contains - [DocumentQuerySearchInput]

A partial search. The text is a substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
endsWith - [DocumentQuerySearchInput]

A partial search. The text is the ending substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
not - [DebitNoteDocumentQueryOptionsInput]

List of filters where none must happen.

  • Mandatory: optional
  • Length: [1-∞]
or - [DebitNoteDocumentQueryOptionsInput]

List of filters where only one has to happen.

  • Mandatory: optional
  • Length: [1-∞]
startsWith - [DocumentQuerySearchInput]

A partial search. The text is the starting substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
Example
{
  "and": [DebitNoteDocumentQueryOptionsInput],
  "contains": [DocumentQuerySearchInput],
  "endsWith": [DocumentQuerySearchInput],
  "not": [DebitNoteDocumentQueryOptionsInput],
  "or": [DebitNoteDocumentQueryOptionsInput],
  "startsWith": [DocumentQuerySearchInput]
}

DebitNoteDocumentQueryOptionsInput

Description

Structure that defines all the necessary information for query options for And/Or/Not statements.

Fields
Input Field Description
creationDate - Date

Document creation date in the system.

  • Mandatory: optional
currency - CurrencyCode

Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3

  • Mandatory: optional
dateRange - DateRangeInput

Date range for document search.

  • Mandatory: optional
documentUid - UID

This is the document's UUID in YabiCo.

  • Mandatory: optional
id - String

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: optional
  • Length: 3-20
issueDate - Date

Date on which the document was sent to DIAN.

  • Mandatory: optional
organizationalUnitId - UID

UID of the organizational unit.

  • Mandatory: optional
personCompStringName - String

The company name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-50
personEmail - email

The email of the person assigned on the document.
Example value: youremail@gmail.com

  • Mandatory: optional
personFirstSurname - String

First sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personFirtsName - String

First name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personId - String

The identifier of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-25
personIdType - IdType

Type of person ID.

  • Mandatory: optional
personSecondName - String

Middle name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personSecondSurname - String

Seecond sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
Example
{
  "creationDate": "2007-12-03",
  "currency": "AED",
  "dateRange": DateRangeInput,
  "documentUid": UID,
  "id": "abc123",
  "issueDate": "2007-12-03",
  "organizationalUnitId": UID,
  "personCompStringName": "abc123",
  "personEmail": email,
  "personFirstSurname": "xyz789",
  "personFirtsName": "xyz789",
  "personId": "xyz789",
  "personIdType": "CC",
  "personSecondName": "abc123",
  "personSecondSurname": "xyz789"
}

DebitNoteEdge

Description

Defines each edge, in this case debit note together with their cursor.

Fields
Field Name Description
cursor - String A marker for an edge's position in the connection.
node - DebitNoteNode The fields to be returned for each node.
Example
{
  "cursor": "xyz789",
  "node": DebitNoteNode
}

DebitNoteGeneralInformation

Description

Debit Note's General Information

Fields
Field Name Description
acquirerEmail - email Buyer's Email.
Example value: buyeremail@gmail.com
currency - Currency Document's Currency code.
Here is the complete list of possible values for this field, go to page 596 #13.3.3
environment - String Document Environment (Test, Hab or Prod)
issueDateTime - DateTime! Date and Time of Issuance
operationCode - OperationCode The Debit Note's operation code.
reasonOfIssuance - LocalizedString The Debit Note's reason of issuance.
subtypeCode - SubTypeCode The Debit Note's subtype.
Example
{
  "acquirerEmail": email,
  "currency": Currency,
  "environment": "abc123",
  "issueDateTime": "2007-12-03T10:15:30Z",
  "operationCode": OperationCode,
  "reasonOfIssuance": LocalizedString,
  "subtypeCode": SubTypeCode
}

DebitNoteGeneralInformationInput

Description

Structure that defines all the necessary information for a debit note general information

Fields
Input Field Description
acquirerEmail - email

Buyer's Email.
Example value: buyeremail@gmail.com

  • Mandatory: optional
issueDateTime - DateTime!

Date and Time of Issuance.

  • Mandatory: required
operationCode - DebitNoteOperationType!

The Debit Note's operation.

  • Mandatory: required
reasonOfIssuance - LocalizedStringInput!

The Debit Note's reason of issuance.

  • Mandatory: required
subtypeCode - DebitNoteSubtype!

The Debit Note's subtype.

  • Mandatory: required
Example
{
  "acquirerEmail": email,
  "issueDateTime": "2007-12-03T10:15:30Z",
  "operationCode": "CHANGE_OF_VALUE",
  "reasonOfIssuance": LocalizedStringInput,
  "subtypeCode": "DEBIT_NOTE"
}

DebitNoteNode

Description

Defines the response object for a Debit Note

Fields
Field Name Description
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for an invoice prefix.
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
generalInformation - GeneralInformationInterface Document's general information.
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the debit note was inserted.
issuerSoftwareSystem - IssuerSoftwareSystemOutput Additional information to inform the software system issuing the document.
notes - [DocumentNotesOutput] Additional information: Free text, related to the document
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's UUID.
updatedAt - DateTime Date and time when the debit note was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "billingPrefix": BillingPrefix,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentStatus": StatusDescriptor,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "abc123",
  "documentUid": UID,
  "events": [Event],
  "generalInformation": GeneralInformationInterface,
  "id": "xyz789",
  "insertedAt": "2007-12-03T10:15:30Z",
  "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
  "notes": [DocumentNotesOutput],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

DebitNoteOperationType

Description

Type of operation

Values
Enum Value Description

CHANGE_OF_VALUE

Change of value on the invoice

EXPENSES_FOR_COLLECTION

Expenses for collection

OTHER

Other reason of issueance

TAX_CHARGE

Additional tax charge
Example
"CHANGE_OF_VALUE"

DebitNoteSubtype

Description

Debit Note subtypes

Values
Enum Value Description

DEBIT_NOTE

A regular Debit Note
Example
"DEBIT_NOTE"

DescriptiveCode

Description

An encoded value with its own description.

Fields
Field Name Description
code - String A code
description - String The description or meaning of the code.
Example
{
  "code": "xyz789",
  "description": "xyz789"
}

DianResolutionDataOutput

Description

Structure with the updated list of the current resolutions

Fields
Field Name Description
billingResolutions - [BillingResolution]
Example
{"billingResolutions": [BillingResolution]}

DocumentConnection

Example
AcquisitionAdjustmentNoteDocumentConnection

DocumentConsecutiveInput

Description

Structure that defines all the necessary information for the document consecutive number.

Document number: Includes prefix + consecutive invoice number authorized by DIAN.
Example of document number: SETP990000002

  • prefix: SETP
  • consecutive number: 990000002
Fields
Input Field Description
number - Int!

Consecutive document serial number authorized by DIAN. For more information, please follow the link

  • Mandatory: required
prefix - String!

DIAN prefix for the document.

  • Mandatory: required
  • Length: 0-4
Example
{"number": 987, "prefix": "xyz789"}

DocumentExtensionsInput

Description

Structure that defines all the necessary information for the POS Invoice extensions

Fields
Input Field Description
buyerBenefits - BuyerBenefitsExtensionInput

UBL DIAN Extension to characterize the buyer's benefits for a sale.

  • Mandatory: optional
salePoint - SalePointExtensionInput!

UBL DIAN Extension to characterize the buyer's benefits for a sale.

  • Mandatory: optional
Example
{
  "buyerBenefits": BuyerBenefitsExtensionInput,
  "salePoint": SalePointExtensionInput
}

DocumentFiles

Description
Fields
Field Name Description
attachedDocument - FileDescriptor The document's AttachedDocument according to the DIAN's standard.
graphicalRepresentationHtml - FileDescriptor Graphical representation in html format.
graphicalRepresentationPdf - FileDescriptor Graphical representation in pdf format.
Example
{
  "attachedDocument": FileDescriptor,
  "graphicalRepresentationHtml": FileDescriptor,
  "graphicalRepresentationPdf": FileDescriptor
}

DocumentInterface

Description

Document types

Fields
Field Name Description
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for an invoice prefix.
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
generalInformation - GeneralInformationInterface Document's general information.
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the document was inserted.
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document Transactions.
uid - UID YabiCo's UUID.
updatedAt - DateTime Date and time when the document was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "billingPrefix": BillingPrefix,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentStatus": StatusDescriptor,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "xyz789",
  "documentUid": UID,
  "events": [Event],
  "generalInformation": GeneralInformationInterface,
  "id": "xyz789",
  "insertedAt": "2007-12-03T10:15:30Z",
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

DocumentLine

Description

Structure for Document Line

Fields
Field Name Description
description - LocalizedString A description for this product.
invoicePeriod - ProductLinePeriod

An invoicing period related to the product itself.

  • Mandatory: optional
itemDescription - ItemDescriptor The product or service description.
lineExtensionAmount - decimal Amount to be paid without taxes.
note - LocalizedString A note for the Product.
price - Price The price of this product. May include Taxes or not.
priceModifier - [AllowanceCharge] Discounts and/or charges for this product
pricingReference - PricingReference A pricing refence used for the cases of free samples.
quantity - decimal The presentation's quantity.
taxDescription - [TaxTotal] The total amount of tax.
unitCode - UnitCodeOutput The code that characterizes each unit.
To know more about the economic unit codes, please follow the next link where is the technical annex of the DIAN in version 1.8, go to page 603 #13.3.6.
The list contains all the unit codes, if you do not find one that fits your requirements, please enter de code "CO_ZZ".
NOTE: The code descriptions in this table will be returned in English.
uuid - UID A UUID for this product.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "description": LocalizedString,
  "invoicePeriod": ProductLinePeriod,
  "itemDescription": ItemDescriptor,
  "lineExtensionAmount": decimal,
  "note": LocalizedString,
  "price": Price,
  "priceModifier": [AllowanceCharge],
  "pricingReference": PricingReference,
  "quantity": decimal,
  "taxDescription": [TaxTotal],
  "unitCode": UnitCodeOutput,
  "uuid": UID,
  "withholdingsDescription": [WithholdingTotal]
}

DocumentLineInput

Description

Structure that defines all the necessary information for a document line

Fields
Input Field Description
description - LocalizedStringInput!

Structure that defines all the necessary information for a description for this product.

  • Mandatory: required
invoicePeriod - ProductLinePeriodInput

An invoicing period related to the product itself.

  • Mandatory: optional
itemDescription - ItemDescriptorInput!

Structure that defines all the necessary information for the products or services description.

  • Mandatory: required
lineExtensionAmount - decimal!

lineExtensionAmount(decimal): Amount to be paid without taxes.

  • Mandatory: required
  • Range: It must have between 4 and 15 positions, with between 0 and 6 decimal places
lineId - Int!

Item's id is only used in error messages from yabi.co

  • Mandatory: required
note - LocalizedStringInput

A note for the Product.

  • Mandatory: optional
price - LinePriceInput!

Structure that defines all the necessary information for the price of this product. May include Taxes or not.

  • Mandatory: required
priceModifier - [AllowanceChargeInput]

Structure that defines all the necessary information for discounts and/or charges for this product.

  • Mandatory: optional
  • Length: [0-n]
pricingReference - LinePricingReferenceInput

Structure that defines all the necessary information for a pricing refence used for the cases of free samples

  • Mandatory: optional
quantity - decimal!

The presentation's quantity.

  • Mandatory: required
  • Range: It must have between 2 and 15 positions, with between 0 and 6 decimal places
taxDescription - [TaxTotalInput]

The total amount of tax.

  • Mandatory: optional
  • Length: [0-n]
unitCode - UnitCode!

The code that characterizes each unit.
To know more about the economic unit codes, please follow the next link where is the technical annex of the DIAN in version 1.8, go to page 603 #13.3.6.
The list contains all the unit codes, if you do not find one that fits your requirements, please enter de code "CO_ZZ".
NOTE: The code descriptions in this table will be returned in English.

  • Mandatory: required
uuid - UID

A UUID for this product.

  • Mandatory: required
withholdingsDescription - [WithholdingTotalInput!]

The total amount of tax.

  • Mandatory: optional
  • Length: [1-n]
Example
{
  "description": LocalizedStringInput,
  "invoicePeriod": ProductLinePeriodInput,
  "itemDescription": ItemDescriptorInput,
  "lineExtensionAmount": decimal,
  "lineId": 123,
  "note": LocalizedStringInput,
  "price": LinePriceInput,
  "priceModifier": [AllowanceChargeInput],
  "pricingReference": LinePricingReferenceInput,
  "quantity": decimal,
  "taxDescription": [TaxTotalInput],
  "unitCode": "CO_04",
  "uuid": UID,
  "withholdingsDescription": [WithholdingTotalInput]
}

DocumentNotes

Description

Structure that defines all the necessary information for document notes.

Fields
Input Field Description
key - String!

Key name of the data to be stored.

  • Mandatory: required
  • Length: 3-50
value - String!

The note size must be greater than 5 and less than 500 characters(5-500). Additional information: Free text, related to the document.

  • Mandatory: required
Example
{
  "key": "xyz789",
  "value": "abc123"
}

DocumentNotesOutput

Description

Defines the response for an information of document notes.

Fields
Field Name Description
key - String Key name of the data stored.
value - String Additional information: Free text, related to the document.
Example
{
  "key": "abc123",
  "value": "xyz789"
}

DocumentOrderInput

Description

Code to identify the type of document ordering

Values
Enum Value Description

CONSECUTIVE_ASC

Sort by consecutive in ascending order.

CONSECUTIVE_DESC

Sort by consecutive in descending order.

CREATION_DATE_ASC

Sort by creation date at in ascending order.

CREATION_DATE_DESC

Sort by creation date at in descending order.

CUSTOMER_DOCUMENT_ASC

Sort by customer document ID in ascending order.

CUSTOMER_DOCUMENT_DESC

Sort by customer document ID in descending order.

CUSTOMER_DOCUMENT_TYPE_ASC

Sort by customer document type in ascending order.

CUSTOMER_DOCUMENT_TYPE_DESC

Sort by customer document type in descending order.

CUSTOMER_EMAIL_ASC

Sort by customer email at in ascending order.

CUSTOMER_EMAIL_DESC

Sort by customer email at in descending order.

CUSTOMER_NAME_ASC

Sort by customer name at in ascending order.

CUSTOMER_NAME_DESC

Sort by customer name at in descending order.

DOCUMENT_OPERATION_ASC

Sort by type operation at in ascending order.

DOCUMENT_OPERATION_DESC

Sort by type operation at in descending order.

DOCUMENT_STATUS_ASC

Sort by customer document status in ascending order.

DOCUMENT_STATUS_DESC

Sort by supplier document status in descending order.

INSERTED_AT_ASC

Sort by inserted at in ascending order.

INSERTED_AT_DESC

Sort by inserted at in descending order.

ORGANIZATIONAL_UNIT_ASC

Sort by organizational unit uuid in ascending order.

ORGANIZATIONAL_UNIT_DESC

Sort by organizational unit uuid in descending order.

SUBTOTAL_ASC

Sort by subtotal in ascending order.

SUBTOTAL_DESC

Sort by subtotal in descending order.

SUPPLIER_DOCUMENT_ASC

Sort by supplier document ID in ascending order.

SUPPLIER_DOCUMENT_DESC

Sort by supplier document ID in descending order.

SUPPLIER_DOCUMENT_TYPE_ASC

Sort by supplier document type in ascending order.

SUPPLIER_DOCUMENT_TYPE_DESC

Sort by supplier document type in descending order.

SUPPLIER_EMAIL_ASC

Sort by supplier email at in ascending order.

SUPPLIER_EMAIL_DESC

Sort by supplier email at in descending order.

SUPPLIER_NAME_ASC

Sort by supplier name at in ascending order.

SUPPLIER_NAME_DESC

Sort by supplier name at in descending order.

TAXES_ASC

Sort by taxes in ascending order.

TAXES_DESC

Sort by taxes in descending order.

TOTAL_ASC

Sort by total price in ascending order.

TOTAL_DESC

Sort by total price in descending order.
Example
"CONSECUTIVE_ASC"

DocumentOutput

Description

Structure for a document output

Fields
Field Name Description
document - DocumentInterface The document.
errors - [Error] List of errors associated with this organization.
notifications - [Information] List of notifications associated with this organization.
warnings - [Warning] List of warnings associated with this organization.
Example
{
  "document": DocumentInterface,
  "errors": [Error],
  "notifications": [Information],
  "warnings": [Warning]
}

DocumentParties

Description

Structure for document parties

Fields
Field Name Description
accountingCustomerParty - AccountingCustomerParty Group with information defining the Acquirer or buyer.
accountingSupplierParty - AccountingSupplierParty Group with information defining the obligor to invoice: Invoicing party or the seller.
Example
{
  "accountingCustomerParty": AccountingCustomerParty,
  "accountingSupplierParty": AccountingSupplierParty
}

DocumentPartiesInput

Description

Structure that defines all the necessary information for document parties

Fields
Input Field Description
accountingCustomerParty - AccountingCustomerPartyInput!

Buyer's Party.

  • Mandatory: required
Example
{"accountingCustomerParty": AccountingCustomerPartyInput}

DocumentPaymentDescriptor

Description

Defines the structure for a document payment descriptor

Fields
Field Name Description
paymentExchangeRate - PaymentExchangeRate Document's Payment Exchange rate.
paymentMeans - [PaymentMean] Group of fields for document payment related information.
prepayments - [PrepaidPayment] Group of fields for document prepaidment related information.
Example
{
  "paymentExchangeRate": PaymentExchangeRate,
  "paymentMeans": [PaymentMean],
  "prepayments": [PrepaidPayment]
}

DocumentPaymentDescriptorInput

Description

Structure that defines all the necessary information for the document payment descriptor.

Fields
Input Field Description
paymentExchangeRate - PaymentExchangeRateInput

Document's Payment Exchange rate.

  • Mandatory: optional
paymentMeans - [PaymentMeanInput!]!

Expected means of payment.

  • Mandatory: required
  • Length: [1-n]
prepayments - [PrepaidPaymentInput]

Expected means of Prepaid Payment.

  • Mandatory: optional
  • Length: [0-n]
Example
{
  "paymentExchangeRate": PaymentExchangeRateInput,
  "paymentMeans": [PaymentMeanInput],
  "prepayments": [PrepaidPaymentInput]
}

DocumentPeriod

Description

Structure that defines all the necessary information for the document period

Fields
Field Name Description
endDate - Date End date of the period.
endTime - Time End time of the period.
startDate - Date Start date of the period.
startTime - Time Start time of the period.
Example
{
  "endDate": "2007-12-03",
  "endTime": "10:15:30Z",
  "startDate": "2007-12-03",
  "startTime": "10:15:30Z"
}

DocumentPeriodInput

Description

Structure that defines all the necessary information for the document period

Fields
Input Field Description
endDate - Date!

End date of the period.

  • Mandatory: required
endTime - Time

End time of the period.

  • Mandatory: optional
startDate - Date!

Start date of the period.

  • Mandatory: required
startTime - Time

Start time of the period.

  • Mandatory: optional
Example
{
  "endDate": "2007-12-03",
  "endTime": "10:15:30Z",
  "startDate": "2007-12-03",
  "startTime": "10:15:30Z"
}

DocumentQuerySearchInput

Description

Structure that defines all the necessary information for query options for text search statements.

Fields
Input Field Description
name - DocumentQuerySearchNames!

Query options for text search statements.

  • Mandatory: optional
value - String!

Value to be assigned to this search.

  • Mandatory: optional
  • Length: 1-100
Example
{"name": "CONSECUTIVE", "value": "xyz789"}

DocumentQuerySearchNames

Description

Query options for text search statements

Values
Enum Value Description

CONSECUTIVE

Text search by the document consecutive

PERSON_CORPORATE_NAME

Text search by the person's company name

PERSON_EMAIL

Text search by person's email

PERSON_FIRST_SURNAME

Text search by the person's first surname

PERSON_FIRTS_NAME

Text search by person's first name

PERSON_ID

Text search by the person's ID or identification

PERSON_SECOND_NAME

Text search by the person's middle name

PERSON_SECOND_SURNAME

Text search by the person's second surname
Example
"CONSECUTIVE"

DocumentReference

Description

Defines the structure for a Referenced Document

Fields
Field Name Description
description - LocalizedString Document's description.
issueDate - Date Document's date of Issuance.
referenceId - String Document's Prefix and Serial
referenceType - ReferenceTypeOutput Referenced Document Type
uid - String Document's CUFE/Unique Id
Example
{
  "description": LocalizedString,
  "issueDate": "2007-12-03",
  "referenceId": "abc123",
  "referenceType": ReferenceTypeOutput,
  "uid": "abc123"
}

DocumentReferenceInput

Description

A Referenced Document

Fields
Input Field Description
description - LocalizedStringInput!

Document's description.

  • Mandatory: required
issueDate - Date

Document's date of Issuance.

  • Mandatory: optional
referenceId - String!

Document's Prefix and Serial.

  • Mandatory: required
  • Length: 3-50
referenceType - ReferenceTypeCode!

Referenced Document Type.

  • Mandatory: required
uid - UID!

Document's CUFE/CUDE/CUDS/UUID

  • Mandatory: required
Example
{
  "description": LocalizedStringInput,
  "issueDate": "2007-12-03",
  "referenceId": "abc123",
  "referenceType": "CONTINGENCY_INVOICE",
  "uid": UID
}

DocumentType

Description

Electronic Document Types

Values
Enum Value Description

CREDIT_NOTE

Refers to credit note document

DEBIT_NOTE

Refers to debit note document

INVOICE

Refers to the electronic invoice document

PURCHASE_SUPPORT

Purchase support document
Example
"CREDIT_NOTE"

EconomicActivityCode

Description

Falta

Values
Enum Value Description

CIIU_V4_0010

Salaried employees

CIIU_V4_0020

Pensioners

CIIU_V4_0081

Individuals and unliquidated successions without economic activity

CIIU_V4_0082

Individuals Subsidized by Third Parties

CIIU_V4_0090

Capital Annuitant, only for natural persons and illiquid successions.

CIIU_V4_0111

Growing of cereals (except rice), leguminous crops and oil seeds

CIIU_V4_0112

Growing of rice

CIIU_V4_0113

Growing of vegetables and melons, roots and tubers

CIIU_V4_0114

Growing of tobacco

CIIU_V4_0115

Growing of textile plants

CIIU_V4_0119

Other transitory crops n.e.c.

CIIU_V4_0121

Growing of tropical and subtropical fruits

CIIU_V4_0122

Growing of plantain and banana

CIIU_V4_0123

Growing of coffee

CIIU_V4_0124

Growing of sugar cane

CIIU_V4_0125

Growing of cut flower

CIIU_V4_0126

Growing of oil palm (African palm) and other oleaginous fruits.

CIIU_V4_0127

Growing of beverage crops

CIIU_V4_0128

Growing of spices, aromatic and drug crops

CIIU_V4_0129

Other permanent crops n.e.c.

CIIU_V4_0130

Plant propagation(activities of nurseries, except forestry nurseries)

CIIU_V4_0141

Raising of cattle and buffaloes

CIIU_V4_0142

Raising of horses and other equines

CIIU_V4_0143

Raising of sheep and goats

CIIU_V4_0144

Raising of swine/pigs

CIIU_V4_0145

Raising of poultry

CIIU_V4_0149

Raising of other animals

CIIU_V4_0150

Mixed farming

CIIU_V4_0161

Support activities for crop production

CIIU_V4_0162

Support activities for animal production

CIIU_V4_0163

Post-harvest crop activities

CIIU_V4_0164

Seed processing for propagation

CIIU_V4_0170

Hunting, trapping and related service activities

CIIU_V4_0210

Silviculture and other forestry activities

CIIU_V4_0220

Logging

CIIU_V4_0230

Gathering of non-wood forest products

CIIU_V4_0240

Support services to forestry

CIIU_V4_0311

Marine fishing

CIIU_V4_0312

Freshwater fishing

CIIU_V4_0321

Marine aquaculture

CIIU_V4_0322

Freshwater aquaculture

CIIU_V4_0510

Mining of hard coal

CIIU_V4_0520

Mining of lignite

CIIU_V4_0610

Extraction of crude petroleum

CIIU_V4_0620

Extraction of natural gas

CIIU_V4_0710

Mining of iron ores

CIIU_V4_0721

Mining of uranium and thorium ores

CIIU_V4_0722

Mining of gold and other precious metals

CIIU_V4_0723

Mining of nickel ore

CIIU_V4_0729

Mining of other non-ferrous metal ores

CIIU_V4_0811

Extraction of stone, sand, common clays, gypsum and anhydrite.

CIIU_V4_0812

Extraction of industrial clays, limestone, kaolin and bentonites

CIIU_V4_0820

Extraction of emeralds, precious and semiprecious stones

CIIU_V4_0891

Mining of chemical and fertilizer minerals

CIIU_V4_0892

Extraction of salt

CIIU_V4_0899

Mining of other non-ferrous metal ores

CIIU_V4_0910

Support activities for petroleum and natural gas extraction

CIIU_V4_0990

Support activities for other mining and quarrying

CIIU_V4_1011

Processing and preserving of meat

CIIU_V4_1012

Processing and preserving of fish, crustaceans and molluscs

CIIU_V4_1020

Processing and preserving of fruit and vegetables

CIIU_V4_1030

Manufacture of vegetable and animal oils and fats

CIIU_V4_1040

Manufacture of dairy products

CIIU_V4_1051

Manufacture of grain mill products

CIIU_V4_1052

Manufacture of grain mill products, starches and starch products

CIIU_V4_1061

Coffee threshing

CIIU_V4_1062

Decaffeination, roasting and coffee grinding

CIIU_V4_1063

Other coffee derivatives

CIIU_V4_1071

Processing and refining of sugar

CIIU_V4_1072

Manufacture of panela

CIIU_V4_1081

Manufacture of bakery products

CIIU_V4_1082

Manufacture of cocoa, chocolate and sugar confectionery

CIIU_V4_1083

Manufacture of macaroni, noodles, couscous and similar farinaceous products

CIIU_V4_1084

Manufacture of prepared meals and dishes

CIIU_V4_1089

Manufacture of other food products n.e.c.

CIIU_V4_1090

Manufacture of prepared animal feeds

CIIU_V4_1101

Distilling, rectifying and blending of spirits

CIIU_V4_1102

Manufacture of non-distilled fermented beverages

CIIU_V4_1103

Manufacture of malt liquors and malt

CIIU_V4_1104

Manufacture of soft drinks; production of mineral waters and other bottled waters

CIIU_V4_1200

Manufacture of tobacco products

CIIU_V4_1311

Preparation and spinning of textile fibres

CIIU_V4_1312

Weaving of textiles

CIIU_V4_1313

Finishing of textiles

CIIU_V4_1391

Manufacture of knitted and crocheted fabrics

CIIU_V4_1392

Manufacture of made-up textile articles, except apparel

CIIU_V4_1393

Manufacture of carpets and rugs

CIIU_V4_1394

Manufacture of cordage, rope, twine and netting

CIIU_V4_1399

Manufacture of other textiles n.e.c.

CIIU_V4_1410

Manufacture of wearing apparel, except fur apparel

CIIU_V4_1420

Manufacture of articles of fur

CIIU_V4_1430

Manufacture of knitted and crocheted apparel

CIIU_V4_1511

Tanning and dressing of leather; dressing and dyeing of fur

CIIU_V4_1512

Tanning and dressing of leather; manufacture of luggage, handbags, saddlery and harness; dressing and dyeing of fur

CIIU_V4_1513

Manufacture of luggage, handbags and the like, saddlery and harness

CIIU_V4_1521

Manufacture of leather and fur footwear, with any type of sole

CIIU_V4_1522

Manufacture of other footwear, except leather and fur footwear

CIIU_V4_1523

Manufacture of footwear parts

CIIU_V4_1610

Sawmilling and planing of wood

CIIU_V4_1620

Manufacture of veneer sheets and wood-based panels

CIIU_V4_1630

Manufacture of builders' carpentry and joinery

CIIU_V4_1640

Manufacture of wooden containers

CIIU_V4_1690

Manufacture of other products of wood; manufacture of articles of cork, straw and plaiting materials

CIIU_V4_1701

Manufacture of pulp, paper and paperboard

CIIU_V4_1702

Manufacture of corrugated paper and paperboard and of containers of paper and paperboard

CIIU_V4_1709

Manufacture of other articles of paper and paperboard

CIIU_V4_1811

Printing

CIIU_V4_1812

Service activities related to printing

CIIU_V4_1820

Reproduction of recorded media

CIIU_V4_1910

Manufacture of coke oven products

CIIU_V4_1921

Manufacture of refined petroleum products

CIIU_V4_1922

Fuel blending activity

CIIU_V4_2011

Manufacture of basic chemicals

CIIU_V4_2012

Manufacture of fertilizers and nitrogen compounds

CIIU_V4_2013

Manufacture of plastics in primary forms

CIIU_V4_2014

Manufacture of synthetic rubber in primary forms

CIIU_V4_2021

Manufacture of pesticides and other agrochemical products

CIIU_V4_2022

Manufacture of paints, varnishes and similar coatings, printing ink and mastics

CIIU_V4_2023

Manufacture of soap and detergents, cleaning and polishing preparations, perfumes and toilet preparations

CIIU_V4_2029

Manufacture of other chemical products n.e.c.

CIIU_V4_2030

Manufacture of man-made fibres

CIIU_V4_2100

Manufacture of pharmaceuticals, medicinal chemical and botanical products

CIIU_V4_2211

Manufacture of rubber tyres and tubes; retreading and rebuilding of rubber tyres

CIIU_V4_2212

Retreading of used tires

CIIU_V4_2219

Manufacture of rubber products and other rubber products n.e.c.

CIIU_V4_2221

Manufacture of basic plastic forms

CIIU_V4_2229

Manufacture of plastic articles n.e.c

CIIU_V4_2310

Manufacture of glass and glass products

CIIU_V4_2391

Manufacture of refractory products

CIIU_V4_2392

Manufacture of clay building materials

CIIU_V4_2393

Manufacture of other porcelain and ceramic products

CIIU_V4_2394

Manufacture of cement, lime and plaster

CIIU_V4_2395

Manufacture of articles of concrete, cement and plaster

CIIU_V4_2396

Cutting, shaping and finishing of stone

CIIU_V4_2399

Manufacture of other non-metallic mineral products n.e.c.

CIIU_V4_2410

Manufacture of basic iron and steel

CIIU_V4_2421

Manufacture of basic precious metals

CIIU_V4_2429

Manufacture of basic precious and other non-ferrous metals

CIIU_V4_2431

Casting of iron and steel

CIIU_V4_2432

Casting of non-ferrous metals

CIIU_V4_2511

Manufacture of structural metal products

CIIU_V4_2512

Manufacture of tanks, reservoirs and containers of metal

CIIU_V4_2513

Manufacture of steam generators, except central heating hot water boilers

CIIU_V4_2520

Manufacture of weapons and ammunition

CIIU_V4_2591

Forging, pressing, stamping and roll-forming of metal; powder metallurgy

CIIU_V4_2592

Treatment and coating of metals; machining

CIIU_V4_2593

Manufacture of cutlery, hand tools and general hardware

CIIU_V4_2599

Manufacture of other fabricated metal products n.e.c.

CIIU_V4_2610

Manufacture of electronic components and boards

CIIU_V4_2620

Manufacture of computers and peripheral equipment

CIIU_V4_2630

Manufacture of communication equipment

CIIU_V4_2640

Manufacture of consumer electronics

CIIU_V4_2651

Manufacture of measuring, testing, navigating and control equipment

CIIU_V4_2652

Manufacture of watches and clocks

CIIU_V4_2660

Manufacture of irradiation, electromedical and electrotherapeutic equipment

CIIU_V4_2670

Manufacture of optical instruments and photographic equipment

CIIU_V4_2680

Manufacture of magnetic and optical data storage media

CIIU_V4_2711

Manufacture of electric motors, generators and transformers

CIIU_V4_2712

Manufacture of electrical energy distribution and control equipment

CIIU_V4_2720

Manufacture of batteries and accumulators

CIIU_V4_2731

Manufacture of fibre optic cables

CIIU_V4_2732

Manufacture of other electronic and electric wires and cables

CIIU_V4_2740

Manufacture of electric lighting equipment

CIIU_V4_2750

Manufacture of domestic appliances

CIIU_V4_2790

Manufacture of other electrical equipment n.e.c

CIIU_V4_2811

Manufacture of engines and turbines, except aircraft, vehicle and cycle engines

CIIU_V4_2812

Manufacture of fluid power equipment

CIIU_V4_2813

Manufacture of other pumps, compressors, taps and valves

CIIU_V4_2814

Manufacture of bearings, gears, gearing and driving elements

CIIU_V4_2815

Manufacture of ovens, furnaces and furnace burners

CIIU_V4_2816

Manufacture of lifting and handling equipment

CIIU_V4_2817

Manufacture of office machinery and equipment (except computers and peripheral equipment)

CIIU_V4_2818

Manufacture of power-driven hand tools

CIIU_V4_2819

Manufacture of other general-purpose machinery n.e.c

CIIU_V4_2821

Manufacture of agricultural and forestry machinery

CIIU_V4_2822

Manufacture of metal-forming machinery and machine tools

CIIU_V4_2823

Manufacture of machinery for metallurgy

CIIU_V4_2824

Manufacture of machinery for mining, quarrying and construction

CIIU_V4_2825

Manufacture of machinery for food, beverage and tobacco processing

CIIU_V4_2826

Manufacture of machinery for textile, apparel and leather production

CIIU_V4_2829

Manufacture of other special-purpose machinery n.e.c

CIIU_V4_2910

Manufacture of motor vehicles

CIIU_V4_2920

Manufacture of bodies (coachwork) for motor vehicles; manufacture of trailers and semi-trailers

CIIU_V4_2930

Manufacture of parts and accessories for motor vehicles

CIIU_V4_3011

Building of ships and floating structures

CIIU_V4_3012

Building of pleasure and sporting boats

CIIU_V4_3020

Manufacture of railway locomotives and rolling stock

CIIU_V4_3030

Manufacture of air and spacecraft and related machinery

CIIU_V4_3040

Manufacture of military fighting vehicles

CIIU_V4_3091

Manufacture of motorcycles

CIIU_V4_3092

Manufacture of bicycles and invalid carriages

CIIU_V4_3099

Manufacture of other transport equipment n.e.c.

CIIU_V4_3110

Manufacture of furniture

CIIU_V4_3120

Manufacture of mattresses and bed bases

CIIU_V4_3210

Manufacture of jewellery, bijouterie and related articles

CIIU_V4_3220

Manufacture of musical instruments

CIIU_V4_3230

Manufacture of sports goods

CIIU_V4_3240

Manufacture of games, toy and puzzles

CIIU_V4_3250

Manufacture of medical and dental instruments and supplies

CIIU_V4_3290

Other manufacturing n.e.c.

CIIU_V4_3311

Repair of fabricated metal products

CIIU_V4_3312

Repair of machinery

CIIU_V4_3313

Repair of electronic and optical equipment

CIIU_V4_3314

Repair of electrical equipment

CIIU_V4_3315

Repair of transport equipment, except motor vehicles

CIIU_V4_3319

Repair of other equipment n.e.c.

CIIU_V4_3320

Installation of industrial machinery and equipment

CIIU_V4_3511

Electric power generation

CIIU_V4_3512

Electric power transmission

CIIU_V4_3513

Electric power distribution

CIIU_V4_3514

Commercialization of electric energy.

CIIU_V4_3520

Manufacture of gas; distribution of gaseous fuels through mains

CIIU_V4_3530

Steam and air conditioning supply

CIIU_V4_3600

Water collection, treatment and supply

CIIU_V4_3700

Sewerage

CIIU_V4_3811

Collection of non-hazardous waste

CIIU_V4_3812

Collection of hazardous waste

CIIU_V4_3821

Treatment and disposal of non-hazardous waste

CIIU_V4_3822

Treatment and disposal of hazardous waste

CIIU_V4_3830

Materials recovery

CIIU_V4_3900

Remediation activities and other waste management services

CIIU_V4_4111

Construction of residential buildings

CIIU_V4_4112

Construction of non-residential buildings

CIIU_V4_4210

Construction of roads and railways

CIIU_V4_4220

Construction of utility projects

CIIU_V4_4290

Construction of other civil engineering projects

CIIU_V4_4311

Demolition

CIIU_V4_4312

Site preparation

CIIU_V4_4321

Electrical installation

CIIU_V4_4322

Plumbing, heat and air-conditioning installation

CIIU_V4_4329

Other construction installation

CIIU_V4_4330

Building completion and finishing

CIIU_V4_4390

Other specialized construction activities

CIIU_V4_4511

Sales of new motor vehicles

CIIU_V4_4512

Sales of used motor vehicles

CIIU_V4_4520

Maintenance and repair of motor vehicles

CIIU_V4_4530

Sale of motor vehicle parts and accessories

CIIU_V4_4541

Sale of motorcycles and related parts and accessories

CIIU_V4_4542

Maintenance and repair of motorcycles and related parts and accessories

CIIU_V4_4610

Wholesale on a fee or contract basis

CIIU_V4_4620

Wholesale of agricultural raw materials and live animals

CIIU_V4_4631

Wholesale of food

CIIU_V4_4632

Wholesale of beverages and tobacco

CIIU_V4_4641

Wholesale of textiles

CIIU_V4_4642

Wholesale of clothing

CIIU_V4_4643

Wholesale of footwear

CIIU_V4_4644

Wholesale of household appliances and equipment

CIIU_V4_4645

Wholesale of pharmaceutical, medicinal and cosmetic products

CIIU_V4_4649

Wholesale of other household goods n.e.c.

CIIU_V4_4651

Wholesale of computers, computer peripheral equipment and software

CIIU_V4_4652

Wholesale of electronic and telecommunications equipment and parts

CIIU_V4_4653

Wholesale of agricultural machinery, equipment and supplies

CIIU_V4_4659

Wholesale of other machinery and equipment n.e.c

CIIU_V4_4661

Wholesale of solid, liquid and gaseous fuels and related products

CIIU_V4_4662

Wholesale of metals and metal ores

CIIU_V4_4663

Wholesale of construction materials, hardware, plumbing and heating equipment and supplies

CIIU_V4_4664

Wholesale of basic chemical products, rubber and plastics in primary forms and agricultural chemical products

CIIU_V4_4665

Wholesale trade in waste, scrap and scrap metal

CIIU_V4_4669

Wholesale of other products n.e.c.

CIIU_V4_4690

Non-specialized wholesale trade

CIIU_V4_4711

Retail sale in non-specialized stores with food, beverages or tobacco predominating

CIIU_V4_4719

Other retail sale in non-specialized stores

CIIU_V4_4721

Retail sale of agricultural products for consumption in specialized stores

CIIU_V4_4722

Retail sale of milk, dairy products and eggs, in specialized establishments

CIIU_V4_4723

Retail sale of meat (including poultry), meat products, fish and seafood, in specialized establishments

CIIU_V4_4724

Retail sale of beverages and tobacco in specialized stores

CIIU_V4_4729

Retail sale of other food products n.e.c., in specialized stores

CIIU_V4_4731

Retail sale of automotive fuel in specialized stores

CIIU_V4_4732

Retail trade of lubricants (oils, greases), additives and cleaning products for motor vehicles

CIIU_V4_4741

Retail sale of computers, peripheral units, software and telecommunications equipment in specialized stores

CIIU_V4_4742

Retail sale of audio and video equipment in specialized stores

CIIU_V4_4751

Retail sale of textiles in specialized stores

CIIU_V4_4752

Retail sale of hardware, paints and glass in specialized stores

CIIU_V4_4753

Retail sale of carpets, rugs, wall and floor coverings in specialized stores

CIIU_V4_4754

Retail sale of household appliances and gas appliances, furniture and lighting equipment in specialized stores

CIIU_V4_4755

Retail sale of household articles and utensils in specialized stores

CIIU_V4_4759

Retail sale other household articles in specialized stores

CIIU_V4_4761

Retail sale of books, newspapers and stationary in specialized stores

CIIU_V4_4762

Retail sale of sporting equipment in specialized stores

CIIU_V4_4769

Retail sale of cultural and recreation goods in specialized stores

CIIU_V4_4771

Retail sale of clothing and clothing accessories (including leather goods) in specialized stores

CIIU_V4_4772

Retail sale of all types of footwear and leather goods and leather substitutes in specialized establishments

CIIU_V4_4773

Retail sale of pharmaceutical and medical goods, cosmetic and toilet articles in specialized stores

CIIU_V4_4774

Other retail sale of new goods in specialized stores

CIIU_V4_4775

Retail sale of second-hand goods

CIIU_V4_4781

Retail sale via stalls and markets of food, beverages and tobacco products

CIIU_V4_4782

Retail sale via stalls and markets of textiles, clothing and footwear

CIIU_V4_4789

Retail sale via stalls and markets of other goods

CIIU_V4_4791

Retail sale via Internet

CIIU_V4_4792

Retail sale via mail order houses or mail

CIIU_V4_4799

Other retail sale not in stores, stalls or markets

CIIU_V4_4911

Passenger rail transport, interurban

CIIU_V4_4912

Freight rail transport

CIIU_V4_4921

Urban and suburban passenger land transport

CIIU_V4_4922

Other passenger land transport

CIIU_V4_4923

Freight transport by road

CIIU_V4_4930

Transport via pipeline

CIIU_V4_5011

Sea and coastal passenger water transport

CIIU_V4_5012

Sea and coastal freight water transport

CIIU_V4_5021

Inland passenger water transport

CIIU_V4_5022

Inland freight water transport

CIIU_V4_5111

Domestic passenger air transportation.

CIIU_V4_5112

International passenger air transportation.

CIIU_V4_5121

Domestic reight air transport.

CIIU_V4_5122

International reight air transport.

CIIU_V4_5210

Warehousing and storage

CIIU_V4_5221

Service activities incidental to land transportation

CIIU_V4_5222

Service activities incidental to water transportation

CIIU_V4_5223

Service activities incidental to air transportation

CIIU_V4_5224

Cargo handling

CIIU_V4_5229

Other transportation support activities

CIIU_V4_5310

Postal activities

CIIU_V4_5320

Courier activities

CIIU_V4_5511

Hotels accommodation

CIIU_V4_5512

Aparthotels accommodation

CIIU_V4_5513

Resorts Accommodation

CIIU_V4_5514

Rural accommodation

CIIU_V4_5519

Other types of visitor accommodations

CIIU_V4_5520

Camping grounds, recreational vehicle parks and trailer parks

CIIU_V4_5530

Hourly stay service

CIIU_V4_5590

Other accommodation n.e.c.

CIIU_V4_5611

Table service of prepared foods.

CIIU_V4_5612

Self-service vending of prepared foods.

CIIU_V4_5613

Ready-to-eat food vending in cafeterias.

CIIU_V4_5619

Other food service activities n.e.c.

CIIU_V4_5621

Event catering

CIIU_V4_5629

Other food service activities

CIIU_V4_5630

Beverage serving activities

CIIU_V4_5811

Book publishing

CIIU_V4_5812

Publishing of directories and mailing lists

CIIU_V4_5813

Publishing of newspapers, journals and periodicals

CIIU_V4_5819

Other publishing activities

CIIU_V4_5820

Software publishing

CIIU_V4_5911

Motion picture, video and television programme production activities

CIIU_V4_5912

Motion picture, video and television programme post-production activities

CIIU_V4_5913

Motion picture, video and television programme distribution activities

CIIU_V4_5914

Motion picture projection activities

CIIU_V4_5920

Sound recording and music publishing activities

CIIU_V4_6010

Radio programming and broadcasting activities

CIIU_V4_6020

Television programming and broadcasting activities

CIIU_V4_6110

Wired telecommunications activities

CIIU_V4_6120

Wireless telecommunications activities

CIIU_V4_6130

Satellite telecommunications activities

CIIU_V4_6190

Other telecommunications activities

CIIU_V4_6201

Computer programming activities

CIIU_V4_6202

Computer consultancy and computer facilities management activities

CIIU_V4_6209

Other information technology and computer service activities

CIIU_V4_6311

Data processing, hosting and related activities

CIIU_V4_6312

Web portals

CIIU_V4_6391

News agency activities

CIIU_V4_6399

Other information service activities n.e.c.

CIIU_V4_6411

Central banking

CIIU_V4_6412

Commercial banks

CIIU_V4_6421

Activities of financial corporations

CIIU_V4_6422

Activities of financing companies

CIIU_V4_6423

Second-floor banking

CIIU_V4_6424

Activities of financial cooperatives

CIIU_V4_6431

Trusts, funds and similar financial entities

CIIU_V4_6432

Severance funds

CIIU_V4_6491

Financial leasing

CIIU_V4_6492

Financial activities of employee funds and other associative forms of the solidarity sector

CIIU_V4_6493

Portfolio purchase or factoring activities

CIIU_V4_6494

Other fund distribution activities

CIIU_V4_6495

Official special institutions

CIIU_V4_6496

Capitalization

CIIU_V4_6499

Other financial service activities, except insurance and pension funding activities, n.e.c.

CIIU_V4_6511

Non-life insurance

CIIU_V4_6512

Life insurance

CIIU_V4_6513

Reinsurance

CIIU_V4_6515

Health insurance

CIIU_V4_6521

Health insurance services

CIIU_V4_6522

Social insurance services in occupational hazards

CIIU_V4_6523

Social insurance services in family risks

CIIU_V4_6531

Average premium defined benefit plan

CIIU_V4_6532

Individual Solidarity Savings System

CIIU_V4_6611

Administration of financial markets

CIIU_V4_6612

Security and commodity contracts brokerage

CIIU_V4_6613

Other activities related to the securities market

CIIU_V4_6614

Activities of foreign exchange brokerage and special financial services companies

CIIU_V4_6615

Activities of foreign exchange trading professionals

CIIU_V4_6619

Other activities auxiliary to financial service activities n.e.c.

CIIU_V4_6621

Activities of insurance agents and brokers

CIIU_V4_6629

Other activities auxiliary to insurance and pension funding

CIIU_V4_6630

Fund management activities

CIIU_V4_6810

Real estate activities with own or leased property

CIIU_V4_6820

Real estate activities on a fee or contract basis

CIIU_V4_6910

Legal activities

CIIU_V4_6920

Accounting, bookkeeping and auditing activities; tax consultancy

CIIU_V4_7010

Activities of head offices

CIIU_V4_7020

Management consultancy activities

CIIU_V4_7111

Architectural and engineering activities

CIIU_V4_7112

Architectural and engineering activities and related technical consultancy

CIIU_V4_7120

Technical testing and analysis

CIIU_V4_7210

Research and experimental development on natural sciences and engineering

CIIU_V4_7220

Research and experimental development on social sciences and humanities

CIIU_V4_7310

Advertising

CIIU_V4_7320

Market research and public opinion polling

CIIU_V4_7410

Specialized design activities

CIIU_V4_7420

Photographic activities

CIIU_V4_7490

Other professional, scientific and technical activities n.e.c.

CIIU_V4_7500

Veterinary activities

CIIU_V4_7710

Renting and leasing of motor vehicles

CIIU_V4_7721

Renting and leasing of recreational and sports goods

CIIU_V4_7722

Renting of video tapes and disks

CIIU_V4_7729

Renting and leasing of other personal and household goods n.e.c.

CIIU_V4_7730

Renting and leasing of other machinery, equipment and tangible goods n.e.c.

CIIU_V4_7740

Leasing of intellectual property and similar products, except copyrighted works

CIIU_V4_7810

Activities of employment placement agencies

CIIU_V4_7820

Temporary employment agency activities

CIIU_V4_7830

Other human resources provision

CIIU_V4_7911

Travel agency activities

CIIU_V4_7912

Tour operator activities

CIIU_V4_7990

Other reservation service and related activities

CIIU_V4_8010

Private security activities

CIIU_V4_8020

Security systems service activities

CIIU_V4_8030

Activities of private detectives and private investigators

CIIU_V4_8110

Combined facilities support activities

CIIU_V4_8121

General interior cleaning of buildings

CIIU_V4_8129

Other building and industrial cleaning activities

CIIU_V4_8130

Landscape care and maintenance service activities

CIIU_V4_8211

Combined office administrative service activities

CIIU_V4_8219

Photocopying, document preparation and other specialized office support activities

CIIU_V4_8220

Activities of call centres

CIIU_V4_8230

Organization of conventions and trade shows

CIIU_V4_8291

Activities of collection agencies and credit bureaus

CIIU_V4_8292

Packaging activities

CIIU_V4_8299

Other business support service activities n.e.c.

CIIU_V4_8411

Legislative general public administration activities

CIIU_V4_8412

Executive general public administration activities

CIIU_V4_8413

Regulation of the activities of providing health care, education, cultural services and other social services, excluding social security

CIIU_V4_8414

Regulation of and contribution to more efficient operation of businesses

CIIU_V4_8415

Activities of control agencies and other institutions

CIIU_V4_8421

Foreign affairs

CIIU_V4_8422

Defence activities

CIIU_V4_8423

Public order and safety activities

CIIU_V4_8424

Justice administration

CIIU_V4_8430

Compulsory social security activities

CIIU_V4_8511

Early Childhood Education

CIIU_V4_8512

Pre-primary education

CIIU_V4_8513

Primary education

CIIU_V4_8521

Basic secondary education

CIIU_V4_8522

Academic high school education

CIIU_V4_8523

Technical educa tion

CIIU_V4_8530

Establishments that combine different levels of education

CIIU_V4_8541

Professional technical education

CIIU_V4_8542

Technical education

CIIU_V4_8543

Education from universities or technological schools

CIIU_V4_8544

University education

CIIU_V4_8551

Training for work

CIIU_V4_8552

Sports and recreation education

CIIU_V4_8553

Cultural education

CIIU_V4_8559

Other education n.e.c.

CIIU_V4_8560

Educational support activities

CIIU_V4_8610

Hospital and clinic activities, with hospitalization.

CIIU_V4_8621

Medical practice activities, without hospitalization

CIIU_V4_8622

Odontological practice activities

CIIU_V4_8691

Diagnostic support activities

CIIU_V4_8692

Therapeutic support activities

CIIU_V4_8699

Other human health activities

CIIU_V4_8710

General medicalized residential care activities.

CIIU_V4_8720

Residential care activities for mental retardation, mental health and substance abuse

CIIU_V4_8730

Actividades de atención en instituciones para personas de edad y personas con discapacidad

CIIU_V4_8790

Other institutional care activities with accommodation

CIIU_V4_8810

Social work activities without accommodation for the elderly and disabled

CIIU_V4_8891

Nursery activities for boys and girls.

CIIU_V4_8899

Other social work activities without accommodation n.e.c.

CIIU_V4_9001

Literary creation.

CIIU_V4_9002

Musical creation.

CIIU_V4_9003

Theatrical creation.

CIIU_V4_9004

Audiovisual creation.

CIIU_V4_9005

Plastic and visual arts.

CIIU_V4_9006

Theatrical activities.

CIIU_V4_9007

Live music show activities.

CIIU_V4_9008

Other live entertainment activities n.e.c.

CIIU_V4_9101

Library and archives activities

CIIU_V4_9102

Museums activities and operation of historical sites and buildings

CIIU_V4_9103

Botanical and zoological gardens and nature reserves activities

CIIU_V4_9200

Gambling and betting activities

CIIU_V4_9311

Operation of sports facilities

CIIU_V4_9312

Activities of sports clubs

CIIU_V4_9319

Other sports activities

CIIU_V4_9321

Activities of amusement parks and theme parks

CIIU_V4_9329

Other amusement and recreation activities n.e.c.

CIIU_V4_9411

Activities of business and employers membership organizations

CIIU_V4_9412

Activities of professional membership organizations

CIIU_V4_9420

Activities of trade unions

CIIU_V4_9491

Activities of religious organizations

CIIU_V4_9492

Activities of political organizations

CIIU_V4_9499

Activities of other membership organizations n.e.c.

CIIU_V4_9511

Repair of computers and peripheral equipment

CIIU_V4_9512

Repair of communication equipment

CIIU_V4_9521

Repair of consumer electronics

CIIU_V4_9522

Repair of household appliances and home and garden equipment

CIIU_V4_9523

Repair of footwear and leather goods

CIIU_V4_9524

Repair of furniture and home furnishings

CIIU_V4_9529

Repair of other personal and household goods

CIIU_V4_9601

Washing and (dry-) cleaning of textile and fur products

CIIU_V4_9602

Hairdressing and other beauty treatment

CIIU_V4_9603

Funeral and related activities

CIIU_V4_9609

Other personal service activities n.e.c.

CIIU_V4_9700

Activities of households as employers of domestic personnel

CIIU_V4_9810

Undifferentiated goods-producing activities of private households for own use

CIIU_V4_9820

Undifferentiated service-producing activities of private households for own use

CIIU_V4_9900

Activities of extraterritorial organizations and bodies
Example
"CIIU_V4_0010"

EconomicActivityCodeOutput

Description

Defines the response object for the economic activity

Fields
Field Name Description
code - String A code signifying the economic activity.
description - String The description or meaning of the teconomic activity.
Example
{
  "code": "abc123",
  "description": "abc123"
}

ElectronicInvoicer

Description

Structure defining the electronic invoicer information.

Fields
Field Name Description
email - email E-mail registered before the DIAN, if it is null it is because it does not exist in the DIAN at the date of the consultation.
identifier - String Identification number.
lastDianConsult - DateTime Date on which the information was consulted at DIAN.
startDate - Date Start date as electronic invoicer.
Example
{
  "email": email,
  "identifier": "abc123",
  "lastDianConsult": "2007-12-03T10:15:30Z",
  "startDate": "2007-12-03"
}

EmissionData

Description

Defines the response object for a Emission Data

Fields
Field Name Description
adquisitionSupport - decimal Amount of documents of type adquisition support.
creditNote - decimal Amount of documents of type credit note.
debitNote - decimal Amount of documents of type debit note.
einvoiceAui - decimal Amount of documents of type einvoice AUI.
einvoiceCambistas - decimal Amount of documents of type einvoice Cambistas.
einvoiceCambistas1000 - decimal Amount of documents of type einvoice Cambistas 1000.
einvoiceCarnicos - decimal Amount of documents of type einvoice Carnicos.
einvoiceStandar - decimal Amount of documents of type einvoice Standar.
payroll - decimal Amount of documents of type payroll.
pos - decimal Amount of documents of type POS.
publicServices - decimal Amount of documents of type public services.
radianEvents - decimal Amount of documents of type RADIAN events.
tituloValorEvents - decimal Amount of documents of type titulo valor events.
Example
{
  "adquisitionSupport": decimal,
  "creditNote": decimal,
  "debitNote": decimal,
  "einvoiceAui": decimal,
  "einvoiceCambistas": decimal,
  "einvoiceCambistas1000": decimal,
  "einvoiceCarnicos": decimal,
  "einvoiceStandar": decimal,
  "payroll": decimal,
  "pos": decimal,
  "publicServices": decimal,
  "radianEvents": decimal,
  "tituloValorEvents": decimal
}

EmissionDataInput

Description

Structure that defines all the necessary information for a Emission Data

Fields
Input Field Description
adquisitionSupport - decimal

Amount of documents of type adquisition support.

  • Mandatory: required
creditNote - decimal

Amount of documents of type credit note.

  • Mandatory: required
debitNote - decimal

Amount of documents of type debit note.

  • Mandatory: required
einvoiceAui - decimal

Amount of documents of type einvoice AUI.

  • Mandatory: required
einvoiceCambistas - decimal

Amount of documents of type einvoice Cambistas.

  • Mandatory: required
einvoiceCambistas1000 - decimal

Amount of documents of type einvoice Cambistas 1000.

  • Mandatory: required
einvoiceCarnicos - decimal

Amount of documents of type einvoice Carnicos.

  • Mandatory: required
einvoiceStandar - decimal

Amount of documents of type einvoice Standar.

  • Mandatory: required
payroll - decimal

Amount of documents of type payroll.

  • Mandatory: required
pos - decimal

Amount of documents of type POS.

  • Mandatory: required
publicServices - decimal

Amount of documents of type public services.

  • Mandatory: required
radianEvents - decimal

Amount of documents of type RADIAN events.

  • Mandatory: required
tituloValorEvents - decimal

Amount of documents of type titulo valor events.

  • Mandatory: required
Example
{
  "adquisitionSupport": decimal,
  "creditNote": decimal,
  "debitNote": decimal,
  "einvoiceAui": decimal,
  "einvoiceCambistas": decimal,
  "einvoiceCambistas1000": decimal,
  "einvoiceCarnicos": decimal,
  "einvoiceStandar": decimal,
  "payroll": decimal,
  "pos": decimal,
  "publicServices": decimal,
  "radianEvents": decimal,
  "tituloValorEvents": decimal
}

EndpointId

Description

Structure for the endpoint ID

Fields
Field Name Description
agencyId - String The name of the agency that maintains the identification scheme.
id - String The identication of the endpoint.
schemeId - String The id of the identification scheme.
Example
{
  "agencyId": "xyz789",
  "id": "xyz789",
  "schemeId": "abc123"
}

EndpointIdInput

Description

Structure that defines all the necessary information for the endpoint Id or identifier

Fields
Input Field Description
agencyId - String

The name of the agency that maintains the identification scheme.

  • Mandatory: optional
  • Length: 3-50
id - String

The identication of the endpoint.

  • Mandatory: optional
  • Length: 3-50
schemeId - String

The identification of the identification scheme.

  • Mandatory: optional
  • Length: 3-50
Example
{
  "agencyId": "abc123",
  "id": "abc123",
  "schemeId": "xyz789"
}

Error

Description

Defines the return structure for an error.

Fields
Field Name Description
helpText - String Informative text of the error that was presented.
id - String Identifier of the error presented.
language - String Language in which error is returned.
message - String Detailed error message.
subType - String Error subcategorization.
title - String The title of the error presented.
type - String The type of error presented.
Example
{
  "helpText": "abc123",
  "id": "abc123",
  "language": "abc123",
  "message": "abc123",
  "subType": "abc123",
  "title": "abc123",
  "type": "xyz789"
}

Event

Description

Structure for a document event

Fields
Field Name Description
additionalDocuments - [FileDescriptor] Additional files related to the delivery of the goods.
applicationResponse - String The response describing this event. In general, this will follow the DIAN standard stated in the Invoice Annex v1.8
dianState - Int State code in the DIAN
documentId - String The type of event according to the DIAN standard stated on the Invoice Annex v1.8
eventDescription - String The description of the event according to the DIAN standard stated on the Invoice Annex v1.8
eventNotes - json Additional named notes for the event. Each note requires a name or concept.
eventType - String The type of event according to the DIAN standard stated on the Invoice Annex v1.8
eventUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
id - String The unique identifier of an Event.
issueDate - DateTime Date and time of the event issuance
issuerParty - EventParty Description of the person/entity that issued the event.
notificationState - Int Customer notification status
reason - String Reason of rejection
receiverParty - EventParty Description of the person/entity who received the event.
receptionDate - DateTime Date on which the receipt of the goods or service was generated.
senderParty - EventParty Description of the person/entity who is the acquirer of the document.
statusIndicator - String Process status indicator
Example
{
  "additionalDocuments": [FileDescriptor],
  "applicationResponse": "abc123",
  "dianState": 987,
  "documentId": "abc123",
  "eventDescription": "xyz789",
  "eventNotes": json,
  "eventType": "abc123",
  "eventUid": UID,
  "id": "xyz789",
  "issueDate": "2007-12-03T10:15:30Z",
  "issuerParty": EventParty,
  "notificationState": 987,
  "reason": "xyz789",
  "receiverParty": EventParty,
  "receptionDate": "2007-12-03T10:15:30Z",
  "senderParty": EventParty,
  "statusIndicator": "abc123"
}

EventIdInput

Description

The unique identifier of an Event.

Fields
Input Field Description
number - Int!

The number of the consecutive id.

  • Mandatory: required
prefix - String!

The prefix in the consecutive id.

  • Mandatory: required
Example
{"number": 987, "prefix": "xyz789"}

EventOutput

Description

Structure for an event output

Fields
Field Name Description
errors - [Error] List of errors associated with this organization.
event - Event The created event.
notifications - [Information] List of notifications associated with this organization.
warnings - [Warning] List of warnings associated with this organization.
Example
{
  "errors": [Error],
  "event": Event,
  "notifications": [Information],
  "warnings": [Warning]
}

EventParty

Description
Fields
Field Name Description
contact - ContactData The primary contact for this party.
jobDescriptor - JobDescriptor A job description for a natural person.
partyIdentification - PersonId An identifier for this party.
partyName - PersonName

A name for this party.
Here is the full name of the person or the corporate name, as applicable. Example values:

  • For a natural person firstName and firstSurname are mandatory: Daniel Smith
  • For a legal person: Cats Marketplace
partyTaxScheme - PartyTaxScheme A tax scheme applying to this party.
physicalLocation - PhysicalLocation The physical location of this party.
postalAddress - PhysicalLocation The party's postal address.
Example
{
  "contact": ContactData,
  "jobDescriptor": JobDescriptor,
  "partyIdentification": PersonId,
  "partyName": PersonName,
  "partyTaxScheme": PartyTaxScheme,
  "physicalLocation": PhysicalLocation,
  "postalAddress": PhysicalLocation
}

EventPartyInput

Description

An event party descriptor.

Fields
Input Field Description
contact - ContactInput

The primary contact for this party.

  • Mandatory: optional
jobDescriptor - JobDescriptorInput

A job description for a natural person.

  • Mandatory: optional
partyIdentification - PersonIdInput!

An identifier for this party.

  • Mandatory: required
partyName - PersonNameInput!

A name for this party.
Here is the full name of the person or the corporate name, as applicable.

Example values:

  • For a natural person firstName and firstSurname are mandatory: Daniel Smith
  • For a legal person: Cats Marketplace
  • Mandatory: required
partyTaxScheme - PartyTaxSchemeInput

A tax scheme applying to this party.

  • Mandatory: optional
physicalLocation - PhysicalLocationInput

The physical location of this party.

  • Mandatory: optional
postalAddress - PhysicalLocationInput

The party's postal address.

  • Mandatory: optional
Example
{
  "contact": ContactInput,
  "jobDescriptor": JobDescriptorInput,
  "partyIdentification": PersonIdInput,
  "partyName": PersonNameInput,
  "partyTaxScheme": PartyTaxSchemeInput,
  "physicalLocation": PhysicalLocationInput,
  "postalAddress": PhysicalLocationInput
}

ExpressAcceptanceEventInput

Description

Explicit acceptance by acquirer.

Fields
Input Field Description
additionalDocuments - [FileInput]

Additional files related to the delivery of the goods.

  • Mandatory: optional
  • Length: [0-n]
eventNotes - [NoteField]

Additional named notes for the event. Each note requires a name or concept.

  • Mandatory: optional
id - EventIdInput!

The unique identifier of an Event.

  • Mandatory: required
issueDate - DateTime!

Date and time of the event issuance

  • Mandatory: required
issuerParty - EventPartyInput

Description of the person/entity who received the event

  • Mandatory: optional
purchaseInvoiceUid - UID!

The unique identifier of an already imported Purchase Invoice.

  • Mandatory: required
Example
{
  "additionalDocuments": [FileInput],
  "eventNotes": [NoteField],
  "id": EventIdInput,
  "issueDate": "2007-12-03T10:15:30Z",
  "issuerParty": EventPartyInput,
  "purchaseInvoiceUid": UID
}

FileDescriptor

Description

Structure used to describe a File.

Fields
Field Name Description
data - StringBase64! File contents.
fileType - String The file's MIME type (Example values: PDF, HTML, XML, etc.).
filename - String The name of the file
Example
{
  "data": StringBase64,
  "fileType": "xyz789",
  "filename": "xyz789"
}

FileInput

Description

Structure that defines all the necessary information for a File.

Fields
Input Field Description
data - StringBase64!

File contents.

  • Mandatory: required
fileType - FileType

The file type (Example values: PDF, HTML, XML, etc.).

  • Mandatory: optional
filename - String

The name of the file.

  • Mandatory: optional
  • Length: 3-50
Example
{
  "data": StringBase64,
  "fileType": "BITMAP",
  "filename": "abc123"
}

FileType

Description

A file's file type

Values
Enum Value Description

BITMAP

Bitmap Image File

HTML

Hypertext Markup Language File

PDF

Portable Document Format File

PLAIN_TEXT

Plain Text File (TXT)

XML

XML(Extensible Markup Language) File
Example
"BITMAP"

FiscalData

Description

Structure for a Client's fiscal data

Fields
Field Name Description
fiscalAddress - PhysicalLocation Client's address used for Fiscal purposes.
responsibilities - [String] Client's list of fiscal responsibilities
Example
{
  "fiscalAddress": PhysicalLocation,
  "responsibilities": ["xyz789"]
}

FiscalDataUpdateInput

Description

Structure that defines all the necessary information for a fiscal data update

Fields
Input Field Description
fiscalAddress - PhysicalLocationInput

Client's address used for Fiscal purposes.

  • Mandatory: optional
responsibilities - [String!]

Client's list of fiscal responsibilities

  • Mandatory: optional
  • Length: [1-n]
Example
{
  "fiscalAddress": PhysicalLocationInput,
  "responsibilities": ["xyz789"]
}

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65

GenderCode

Description

A code signifying the gender of the person

Values
Enum Value Description

FEMALE

Code indicating that the person is a woman

MALE

Code indicating that the person is a man

PREFER_NOT_TO_SAY

Code indicating that the person did not want to give information about their gender
Example
"FEMALE"

GeneralInformationInterface

Description

Structure that defines document's General Information

Fields
Field Name Description
acquirerEmail - email Buyer's Email.
Example value: buyeremail@gmail.com
currency - Currency Document's Currency code
environment - String Document Environment (Test, Hab or Prod)
issueDateTime - DateTime Date and Time of Issuance.
operationCode - OperationCode The Document's operation.
subtypeCode - SubTypeCode The Document's subtype.
Example
{
  "acquirerEmail": email,
  "currency": Currency,
  "environment": "xyz789",
  "issueDateTime": "2007-12-03T10:15:30Z",
  "operationCode": OperationCode,
  "subtypeCode": SubTypeCode
}

GenerationAndTransmisionCode

Description

Generation and Transmission type for a product

Values
Enum Value Description

PER_OPERATION

Collection generated in the operation

WEEKLY_ACCUMULATED

Weekly accrued collection
Example
"PER_OPERATION"

IdType

Description

List of identification documents.

Values
Enum Value Description

CC

Citizenship Card

CE

Alien Registration Card

DIE

Foreign Identification Document

NIT

Tax Identification Number

NITE

Foreign Tax Identification Number

NUIP

Unique Personal Identification Number

P

Passport

PEP

Special Stay Permit

RC

Civil Registry

TE

Foreigners Card

TI

Identity Card
Example
"CC"

IdTypeOutput

Description

Defines the response object for the tax name

Fields
Field Name Description
code - String The code of the person's document type.
description - String The description or meaning of the document type.
Example
{
  "code": "xyz789",
  "description": "xyz789"
}

IncomeOwnershipType

Description

Type of ownership over the income of a product

Values
Enum Value Description

SELF_OWNED

Own Income

THIRD_PARTY

Income to third parties
Example
"SELF_OWNED"

IndicatorTypeCode

Description

Global/Line Modifier - Indicates that the item is a Charge or a discount

Values
Enum Value Description

CHARGE

Indicates that the item is a Charge

DISCOUNT

Indicates that the item is a discount
Example
"CHARGE"

Information

Description

Structure that defines all the necessary information for notifications.

Fields
Field Name Description
helpText - String Informative text of the notification that was presented.
id - String Identifier of the notification presented.
language - String Language in which the notification is returned.
message - String Detailed notification message.
subType - String Notification subcategorization.
title - String Title of the notification presented.
type - String Type of notification presented.
Example
{
  "helpText": "abc123",
  "id": "xyz789",
  "language": "abc123",
  "message": "xyz789",
  "subType": "abc123",
  "title": "abc123",
  "type": "abc123"
}

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. It is NOT compliant with the GraphQl spec, it can represent values between -(2^53 - 1) and 2^53 - 1 as specified by IEEE 754. It is kept here for backwards compatibility, prefer using the SpecCompliantInt.

Example
123

IntegerRange

Description

Structure that defines all the necessary information for an integer range price

Fields
Field Name Description
from - Int The minimum value in this range of values.
to - Int The maximum value in this range of values.
Example
{"from": 123, "to": 123}

Invoice

Description

Defines the response object for an invoice

Fields
Field Name Description
assessmentState - Int Assessment state
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for an invoice prefix.
creditNoteSummary - [NoteSummary] List with the summary of the credit notes contained in the invoice.
debitNoteSummary - [NoteSummary] List with the summary of the debit notes contained in the invoice.
dianState - Int State code in the DIAN
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentQr - String QR's code content represented as text
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentSummary - InvoiceDocumentSummary Sales Invoice summary with respect to the credit notes it contains.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
files - DocumentFiles Files related to the invoice.
generalInformation - GeneralInformationInterface Invoice's general information.
goodsState - Int Goods state
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the invoice was inserted.
issuerSoftwareSystem - IssuerSoftwareSystemOutput Additional information to inform the software system issuing the document.
notes - [DocumentNotesOutput] Additional information: Free text, related to the document
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the invoice
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's invoice UUID.
updatedAt - DateTime Date and time when the invoice was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "assessmentState": 987,
  "billingPrefix": BillingPrefix,
  "creditNoteSummary": [NoteSummary],
  "debitNoteSummary": [NoteSummary],
  "dianState": 987,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentQr": "abc123",
  "documentStatus": StatusDescriptor,
  "documentSummary": InvoiceDocumentSummary,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "xyz789",
  "documentUid": UID,
  "events": [Event],
  "files": DocumentFiles,
  "generalInformation": GeneralInformationInterface,
  "goodsState": 123,
  "id": "abc123",
  "insertedAt": "2007-12-03T10:15:30Z",
  "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
  "notes": [DocumentNotesOutput],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

InvoiceConnection

Description

Defines the response object for a query to list invoices.

Fields
Field Name Description
edges - [InvoiceEdge] Used to select the fields that you want to retrieve from each edge in the connection.
pageCursors - PageCursors Returns the structure with the pagination of the search results.
pageInfo - PageInfo Returns details about the current page of results.
totalCount - Int Total number of records in the table taking into account the filters applied.
totalPages - Int Total number of pages under the filters set by the user.
Example
{
  "edges": [InvoiceEdge],
  "pageCursors": PageCursors,
  "pageInfo": PageInfo,
  "totalCount": 123,
  "totalPages": 123
}

InvoiceDocumentOutput

Description

Structure for a document output

Fields
Field Name Description
document - Invoice The document.
errors - [Error] List of errors associated with this organization.
notifications - [Information] List of notifications associated with this organization.
warnings - [Warning] List of warnings associated with this organization.
Example
{
  "document": Invoice,
  "errors": [Error],
  "notifications": [Information],
  "warnings": [Warning]
}

InvoiceDocumentQueryInput

Description

Query Input: Define the query and search options for the document according to the filters presented.

Fields
Input Field Description
and - [InvoiceDocumentQueryOptionsInput]

List of filters where all must happen.

  • Mandatory: optional
  • Length: [1-∞]
contains - [DocumentQuerySearchInput]

A partial search. The text is a substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
endsWith - [DocumentQuerySearchInput]

A partial search. The text is the ending substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
not - [InvoiceDocumentQueryOptionsInput]

List of filters where none must happen.

  • Mandatory: optional
  • Length: [1-∞]
or - [InvoiceDocumentQueryOptionsInput]

List of filters where only one has to happen.

  • Mandatory: optional
  • Length: [1-∞]
startsWith - [DocumentQuerySearchInput]

A partial search. The text is the starting substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
Example
{
  "and": [InvoiceDocumentQueryOptionsInput],
  "contains": [DocumentQuerySearchInput],
  "endsWith": [DocumentQuerySearchInput],
  "not": [InvoiceDocumentQueryOptionsInput],
  "or": [InvoiceDocumentQueryOptionsInput],
  "startsWith": [DocumentQuerySearchInput]
}

InvoiceDocumentQueryOptionsInput

Description

Structure that defines all the necessary information for query options for And/Or/Not statements.

Fields
Input Field Description
creationDate - Date

Document creation date in the system.

  • Mandatory: optional
currency - CurrencyCode

Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3

  • Mandatory: optional
dateRange - DateRangeInput

Date range for document search.

  • Mandatory: optional
documentUid - UID

This is the document's UUID in YabiCo.

  • Mandatory: optional
id - String

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: optional
  • Length: 3-20
issueDate - Date

Date on which the document was sent to DIAN.

  • Mandatory: optional
operationCode - InvoiceOperationType

The Invoice's operation.

  • Mandatory: optional
organizationalUnitId - UID

UID of the organizational unit.

  • Mandatory: optional
personCompStringName - String

The company name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-50
personEmail - email

The email of the person assigned on the document.
Example value: youremail@gmail.com

  • Mandatory: optional
personFirstSurname - String

First sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personFirtsName - String

First name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personId - String

The identifier of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-25
personIdType - IdType

Type of person ID.

  • Mandatory: optional
personSecondName - String

Middle name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personSecondSurname - String

Seecond sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
subtypeCode - InvoiceSubtype

The Invoice's subtype.

  • Mandatory: optional
Example
{
  "creationDate": "2007-12-03",
  "currency": "AED",
  "dateRange": DateRangeInput,
  "documentUid": UID,
  "id": "abc123",
  "issueDate": "2007-12-03",
  "operationCode": "AIU",
  "organizationalUnitId": UID,
  "personCompStringName": "xyz789",
  "personEmail": email,
  "personFirstSurname": "abc123",
  "personFirtsName": "abc123",
  "personId": "xyz789",
  "personIdType": "CC",
  "personSecondName": "abc123",
  "personSecondSurname": "abc123",
  "subtypeCode": "CONTINGENCY_INVOICE"
}

InvoiceDocumentSummary

Description

Defines the structure with the summary of the invoice with respect to the credit notes it contains.

Fields
Field Name Description
creditNoteTotal - decimal Contains the total value of the sum of the credit notes of an invoice.
creditNotes - Int Contains the number of credit notes in an invoice.
debitNoteTotal - decimal Contains the total value of the sum of the debit notes of an invoice.
debitNotes - Int Contains the number of debit notes in an invoice.
referenceDocuments - Int Contains the number of reference documents in an invoice.
Example
{
  "creditNoteTotal": decimal,
  "creditNotes": 987,
  "debitNoteTotal": decimal,
  "debitNotes": 123,
  "referenceDocuments": 123
}

InvoiceEdge

Description

Defines each edge, in this case invoice together with their cursor.

Fields
Field Name Description
cursor - String A marker for an edge's position in the connection.
node - InvoiceNode The fields to be returned for each node.
Example
{
  "cursor": "xyz789",
  "node": InvoiceNode
}

InvoiceEventInput

Description

Structure that defines all the necessary information for an invoice event importation

Fields
Input Field Description
cude - String!

Event's CUDE according to the DIAN's standard.

  • Mandatory: optional
Example
{"cude": "xyz789"}

InvoiceGeneralInformation

Description

Invoice's General Information

Fields
Field Name Description
acquirerEmail - email Buyer's Email.
Example value: buyeremail@gmail.com
currency - Currency Document's Currency code.
Here is the complete list of possible values for this field, go to page 596 #13.3.3
documentPeriod - DocumentPeriod The Invoice's invoicing pediod.
environment - String Document Environment (Test, Hab or Prod)
issueDateTime - DateTime! Date and Time of Issuance.
operationCode - OperationCode The Invoice's operation.
reasonOfIssuance - LocalizedString The Invoice's reason of issuance.
subtypeCode - SubTypeCode The Invoice's subtype.
Example
{
  "acquirerEmail": email,
  "currency": Currency,
  "documentPeriod": DocumentPeriod,
  "environment": "xyz789",
  "issueDateTime": "2007-12-03T10:15:30Z",
  "operationCode": OperationCode,
  "reasonOfIssuance": LocalizedString,
  "subtypeCode": SubTypeCode
}

InvoiceGeneralInformationInput

Description

Document's General Information

Fields
Input Field Description
acquirerEmail - email

Buyer's Email.
Example value: buyeremail@gmail.com

  • Mandatory: optional
currency - CurrencyCode!

Document's Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3

  • Mandatory: required
documentPeriod - DocumentPeriodInput

The Invoice's invoicing pediod.

  • Mandatory: optional
issueDateTime - DateTime!

Date and Time of Issuance.

  • Mandatory: required
operationCode - InvoiceOperationType!

The Invoice's operation.

  • Mandatory: required
reasonOfIssuance - LocalizedStringInput

The Debit Note's reason of issuance.

  • Mandatory: optional
subtypeCode - InvoiceSubtype!

The Invoice's subtype.

  • Mandatory: required
Example
{
  "acquirerEmail": email,
  "currency": "AED",
  "documentPeriod": DocumentPeriodInput,
  "issueDateTime": "2007-12-03T10:15:30Z",
  "operationCode": "AIU",
  "reasonOfIssuance": LocalizedStringInput,
  "subtypeCode": "CONTINGENCY_INVOICE"
}

InvoiceIdInput

Description

Structure that defines all the necessary information of the invoice identifiers.

Fields
Input Field Description
id - DocumentConsecutiveInput

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: optional
uid - UID

The identificator of the invoice in the system, represented as an uuid or another identificator.

  • Mandatory: optional
Example
{
  "id": DocumentConsecutiveInput,
  "uid": UID
}

InvoiceInput

Description

Structure that defines all the necessary information for an invoice input

Fields
Input Field Description
documentLines - [DocumentLineInput!]!

Input with information concerning products within the document.

  • Mandatory: required
  • Length: [1-n]
documentModifiers - [AllowanceChargeInput]

Input where discount's or charges are found.

  • Mandatory: optional
  • Length: [1-n]
documentParties - DocumentPartiesInput!

Parties involved in the document.

  • Mandatory: optional
documentTotals - LegalMonetaryTotalInput!

The total amount payable, including allowances, charges, and taxes.

  • Mandatory: required
generalInformation - InvoiceGeneralInformationInput!

Document's general information.

  • Mandatory: required
id - DocumentConsecutiveInput!

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: optional
issuerSoftwareSystem - IssuerSoftwareSystem

Additional information to inform the software system issuing the document.

  • Mandatory: optional
notes - [DocumentNotes]

Additional information: Free text, related to the document.

  • Mandatory: optional
  • Length: [1-n]
organizationalUnitId - UID!

Organizational Unit's Id.

  • Mandatory: required
paymentDescription - DocumentPaymentDescriptorInput!

Document's Payment Description.

  • Mandatory: required
  • Length: [1-n]
referencedDocuments - [DocumentReferenceInput]

Additional Documents referenced inside the document.

  • Mandatory: optional
  • Length: [1-n]
taxDescription - [TaxTotalInput]

Structure with the information of the total amount of tax, like: the withholding tax, the total tax amount, etc.

  • Mandatory: optional
  • Length: [1-n]
withholdingsDescription - [WithholdingTotalInput!]

The total amount of tax.

  • Mandatory: required
  • Length: [1-n]
Example
{
  "documentLines": [DocumentLineInput],
  "documentModifiers": [AllowanceChargeInput],
  "documentParties": DocumentPartiesInput,
  "documentTotals": LegalMonetaryTotalInput,
  "generalInformation": InvoiceGeneralInformationInput,
  "id": DocumentConsecutiveInput,
  "issuerSoftwareSystem": IssuerSoftwareSystem,
  "notes": [DocumentNotes],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptorInput,
  "referencedDocuments": [DocumentReferenceInput],
  "taxDescription": [TaxTotalInput],
  "withholdingsDescription": [WithholdingTotalInput]
}

InvoiceNode

Description

Defines the response object for an invoice

Fields
Field Name Description
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for an invoice prefix.
creditNoteSummary - [NoteSummary] List with the summary of the credit notes contained in the invoice.
debitNoteSummary - [NoteSummary] List with the summary of the debit notes contained in the invoice.
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentSummary - InvoiceDocumentSummary Sales Invoice summary with respect to the credit notes it contains.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
generalInformation - GeneralInformationInterface Invoice's general information.
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the invoice was inserted.
issuerSoftwareSystem - IssuerSoftwareSystemOutput Additional information to inform the software system issuing the document.
notes - [DocumentNotesOutput] Additional information: Free text, related to the document
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the invoice
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's invoice UUID.
updatedAt - DateTime Date and time when the invoice was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "billingPrefix": BillingPrefix,
  "creditNoteSummary": [NoteSummary],
  "debitNoteSummary": [NoteSummary],
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentStatus": StatusDescriptor,
  "documentSummary": InvoiceDocumentSummary,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "abc123",
  "documentUid": UID,
  "events": [Event],
  "generalInformation": GeneralInformationInterface,
  "id": "xyz789",
  "insertedAt": "2007-12-03T10:15:30Z",
  "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
  "notes": [DocumentNotesOutput],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

InvoiceOperationType

Description

List of operation types.

Values
Enum Value Description

AIU

AIU (Administration, contiengencies and utility)

MDT

Mandates

MXC

Money Exchange

STD

Standard

TRA

Transportation
Example
"AIU"

InvoiceRejectionEventInput

Description

Complaint on the document by acquirer.

Fields
Input Field Description
additionalDocuments - [FileInput]

Additional files related to the delivery of the goods.

  • Mandatory: optional
  • Length: [0-n]
claimConcept - ClaimConcept!

Concept for which the invoice is rejected.

  • Mandatory: required
eventNotes - [NoteField]

Additional named notes for the event. Each note requires a name or concept.

  • Mandatory: optional
id - EventIdInput!

The unique identifier of an Event.

  • Mandatory: required
issueDate - DateTime!

Date and time of the event issuance

  • Mandatory: required
issuerParty - EventPartyInput

Description of the person/entity who received the event

  • Mandatory: optional
purchaseInvoiceUid - UID!

The unique identifier of an already imported Purchase Invoice

  • Mandatory: required
reason - String!

Reason of rejection

  • Mandatory: required
Example
{
  "additionalDocuments": [FileInput],
  "claimConcept": "CO_01",
  "eventNotes": [NoteField],
  "id": EventIdInput,
  "issueDate": "2007-12-03T10:15:30Z",
  "issuerParty": EventPartyInput,
  "purchaseInvoiceUid": UID,
  "reason": "abc123"
}

InvoiceSubtype

Description

List of Invoice subtypes

Values
Enum Value Description

CONTINGENCY_INVOICE

Cheque book invoice

EXPORT_INVOICE

Exportation invoice

SALES_INVOICE

Regular sales invoice
Example
"CONTINGENCY_INVOICE"

InvoicerDataInput

Description

Structure that defines all the necessary information for an invoicer update

Fields
Input Field Description
organization - OrganizationUpdateInput

Structure for an organization.

  • Mandatory: optional
organizationUnits - [OrganizationalUnitUpdateInput!]

List of the organizational units associated with this client.

  • Mandatory: optional
  • Length: [1-n]
Example
{
  "organization": OrganizationUpdateInput,
  "organizationUnits": [OrganizationalUnitUpdateInput]
}

IssuerSoftwareSystem

Description

Structure that defines all the necessary information for issuer software system.

Fields
Input Field Description
companyName - String!

Name of the company that has the electronic document issuing software.

  • Mandatory: required
  • Length: 3-50
companyNit - String

Nit of the company that has the electronic document issuing software.

  • Mandatory: optional
  • Length: 3-16
softwareName - String!

Name of the software issuing electronic documents.

  • Mandatory: _required
  • Length: 3-100
softwareVersion - String!

Version of the software that issues the document.

  • Mandatory: _required
  • Length: 3-30
Example
{
  "companyName": "xyz789",
  "companyNit": "xyz789",
  "softwareName": "xyz789",
  "softwareVersion": "xyz789"
}

IssuerSoftwareSystemOutput

Description

Defines the response for issuer software system.

Fields
Field Name Description
companyName - String Name of the company that has the electronic document issuing software.
companyNit - String Nit of the company that has the electronic document issuing software.
softwareName - String Name of the software issuing electronic documents.
softwareVersion - String Version of the software that issues the document.
Example
{
  "companyName": "xyz789",
  "companyNit": "xyz789",
  "softwareName": "xyz789",
  "softwareVersion": "abc123"
}

ItemDescriptor

Description

Structure for the product or service description

Fields
Field Name Description
additionalItemProperty - [NoteFieldOutput] Information group to add product or service specific information that may be requested by authorities or entities other than the DIAN.
Example value: "use of private car".
brandName - String Product or service brand name.
incomeType - DescriptiveCode Identifying the type of income ownership related to the product.
informationContentProviderParty - Party The party responsible for specification of this product or service.
manufacturerParty - Party Product or service manufacturer.
modelName - String Product or service name.
originCountry - DescriptiveCode Origin country of the products or services.
standardItemId - LineItemId Identifying information for this product or service, assigned according to a standard system.
Example
{
  "additionalItemProperty": [NoteFieldOutput],
  "brandName": "abc123",
  "incomeType": DescriptiveCode,
  "informationContentProviderParty": Party,
  "manufacturerParty": Party,
  "modelName": "xyz789",
  "originCountry": DescriptiveCode,
  "standardItemId": LineItemId
}

ItemDescriptorInput

Description

Structure that defines all the necessary information for the products or services description

Fields
Input Field Description
additionalItemProperty - [NoteField]

Information group to add product or service specific information that may be requested by authorities or entities other than the DIAN.
Example value: "use of private car".

  • Mandatory: optional
  • Length: [0-n]
brandName - String

Product or service brand name.

  • Mandatory: optional
  • Length: 3-50
incomeType - IncomeOwnershipType

Identifying the type of income ownership related to the product.

  • Mandatory: optional
informationContentProviderParty - PartyInput

The party responsible for specification of this product or service.

  • Mandatory: optional
manufacturerParty - PartyInput

Structure that defines all the necessary information for the product or service manufacturer.

  • Mandatory: optional
modelName - String

Product or service name.

  • Mandatory: optional
  • Length: 3-50
originCountry - CountryCode

Origin country of the products or services.

  • Mandatory: optional
  • Length: 3-50
standardItemId - LineItemIdInput!

Identifying information for this product or service, assigned according to a standard system.

  • Mandatory: required
Example
{
  "additionalItemProperty": [NoteField],
  "brandName": "xyz789",
  "incomeType": "SELF_OWNED",
  "informationContentProviderParty": PartyInput,
  "manufacturerParty": PartyInput,
  "modelName": "xyz789",
  "originCountry": "AD",
  "standardItemId": LineItemIdInput
}

JobDescriptor

Fields
Field Name Description
jobTitle - String The job's title or name.
organizationDepartment - String The Organization's department to which the job title belongs.
Example
{
  "jobTitle": "abc123",
  "organizationDepartment": "abc123"
}

JobDescriptorInput

Description

Job description for a natural person.

Fields
Input Field Description
jobTitle - String

The job's title or name.

  • Mandatory: optional
  • Length: 3-100
organizationDepartment - String

The Organization's department to which the job title belongs.

  • Mandatory: optional
  • Length: 3-100
Example
{
  "jobTitle": "xyz789",
  "organizationDepartment": "xyz789"
}

LanguageCode

Description

IETF language tag is a standardized code or tag that is used to identify human languages in the Internet

Values
Enum Value Description

EN_US

English United States

ES_CO

Spanish Colombia
Example
"EN_US"

LegalMonetaryTotal

Description

Defines the structure for the total amount payable, including allowances, charges, and taxes.

Fields
Field Name Description
allowanceTotalAmount - decimal Total discount applied at document level.
chargeTotalAmount - decimal Total charge applied at document level.
lineExtensionAmount - decimal Amount to be paid without taxes.
payableAmount - decimal Total amount to be paid.
prePaidAmount - decimal Total prepayments.
taxExclusiveAmount - decimal Document's taxable base.
taxInclusiveAmount - decimal Amount to be paid with taxes.
Example
{
  "allowanceTotalAmount": decimal,
  "chargeTotalAmount": decimal,
  "lineExtensionAmount": decimal,
  "payableAmount": decimal,
  "prePaidAmount": decimal,
  "taxExclusiveAmount": decimal,
  "taxInclusiveAmount": decimal
}

LegalMonetaryTotalInput

Description
Fields
Input Field Description
allowanceTotalAmount - decimal

Total discount applied at document level.

  • Mandatory: optional
  • Range: It must have between 4 and 15 positions, with between 0 and 6 decimal places
chargeTotalAmount - decimal

Total charge applied at document level.

  • Mandatory: optional
  • Range: It must have between 4 and 15 positions, with between 0 and 6 decimal places
lineExtensionAmount - decimal!

Amount to be paid without taxes.

  • Mandatory: required
  • Range: It must have between 4 and 15 positions, with between 0 and 6 decimal places
payableAmount - decimal!

Document net payable value.

  • Mandatory: required
  • Range: It must have between 4 and 15 positions, with between 0 and 6 decimal places
prePaidAmount - decimal

Total prepayments.

  • Mandatory: optional
  • Range: It must have between 4 and 15 positions, with between 0 and 6 decimal places
taxExclusiveAmount - decimal!

Document's taxable base.

  • Mandatory: required
  • Range: It must have between 4 and 15 positions, with between 0 and 6 decimal places
taxInclusiveAmount - decimal!

Amount to be paid with taxes.

  • Mandatory: required
  • Range: It must have between 4 and 15 positions, with between 0 and 6 decimal places
Example
{
  "allowanceTotalAmount": decimal,
  "chargeTotalAmount": decimal,
  "lineExtensionAmount": decimal,
  "payableAmount": decimal,
  "prePaidAmount": decimal,
  "taxExclusiveAmount": decimal,
  "taxInclusiveAmount": decimal
}

LineItemId

Description

Identifying information for this product or service, assigned according to a standard system. For more information please follow this link , from the DIAN's technical appendix version 1.8, go to page 603 - #13.3.5

Fields
Field Name Description
id - String The product or service Id.
name - String Standard's Name.
schemeAgencyId - String Agency's UID.
schemeId - String Standard's Id.
Example
{
  "id": "abc123",
  "name": "xyz789",
  "schemeAgencyId": "abc123",
  "schemeId": "abc123"
}

LineItemIdInput

Description

Structure that defines all the necessary information for a line product or service.

Identifying information for this item, assigned according to a standard system.
To know more about the standard item codes, please follow the next link DIAN's Annex - Page 603 - #13.3.5

Fields
Input Field Description
id - String!

The product or service Id.

  • Mandatory: optional
  • Length: 3-50
standardId - StandardItemIdCode!

Standard's Name Here you can find more information about the standar item code, in this link you can find the technical annex of the DIAN in version 1.8, go to page 603 #13.3.5.

  • Mandatory: optional
Example
{"id": "xyz789", "standardId": "GTIN"}

LineModifierCode

Description

Document line modifier codes

Values
Enum Value Description

M00

Assumed tax discount

M01

Pay one carry the other

M02

Contractual discounts

M03

Prompt payment discount

M04

Free shipping

M05

Specific inventory discounts

M06

Discount for purchase amount

M07

Season discount

M08

Discount for product / service upgrades

M09

General discount

M10

Volume discount

M11

Other discount
Example
"M00"

LinePriceInput

Description

Structure that defines all the necessary information for line pricing

Fields
Input Field Description
baseQuantity - decimal

The quantity at which this price applies.

  • Mandatory: optional. Default = "1.00"
priceAmount - decimal!

The price of the product.

  • Mandatory: required
  • Range: It must have between 0 and 15 positions, with between 0 and 6 decimal places
priceChangeReason - String

The reason for the price change

  • Mandatory: optional
  • Length: 3-100
priceType - PriceType

Indicates what type of price it is. (Example value: "COMMERCIAL_VALUE")

  • Mandatory: optional
unitCode - UnitCode

The code that characterizes each unit.
To know more about the economic unit codes, please follow the next link where is the technical annex of the DIAN in version 1.8, go to page 603 #13.3.6.
The list contains all the unit codes, if you do not find one that fits your requirements, please enter de code "CO_ZZ".
NOTE: The code descriptions in this table will be returned in English.

  • Mandatory: optional
Example
{
  "baseQuantity": decimal,
  "priceAmount": decimal,
  "priceChangeReason": "xyz789",
  "priceType": "COMMERCIAL_VALUE",
  "unitCode": "CO_04"
}

LinePricingReferenceInput

Description

Structure that defines all the necessary information for line pricing reference

Fields
Input Field Description
amount - decimal!

Value referenced.

  • Mandatory: required
  • Range: It must have between 0 and 15 positions, with between 0 and 6 decimal places
priceType - PriceType!

Indicates what type of price it is. (Example value: "COMMERCIAL_VALUE")

  • Mandatory: required
Example
{"amount": decimal, "priceType": "COMMERCIAL_VALUE"}

LocalizedString

Description

Defines the localized text with a specific language

Fields
Field Name Description
locale - String The text's language/locale.
text - String The text.
Example
{
  "locale": "xyz789",
  "text": "abc123"
}

LocalizedStringInput

Description

Structure that defines all the necessary information for a localized text with a specific language

Fields
Input Field Description
locale - LanguageCode!

The text's language/locale.
IETF language tag is a standardized code or tag that is used to identify human languages in the Internet.
Here you can find a list with all the language codes.

  • Mandatory: required
text - String!

The text.

  • Mandatory: required
  • Length: 3-150
Example
{"locale": "EN_US", "text": "abc123"}

NaturalPersonNameInput

Description

Structure that defines all the necessary information for a natural person's name input.

A person's full name is: firstName + secondName + firstSurname + secondSurname. (In total this can not be larger than 50 digits).

Fields
Input Field Description
firstName - String!

First name of the person.

  • Mandatory: optional
  • Length: 2-25
firstSurname - String!

First family name AKA surname or last name.

  • Mandatory: optional
  • Length: 2-25
secondName - String

Second name of the person.

  • Mandatory: optional
  • Length: 2-25
secondSurname - String

Second family name AKA surname or last name.

  • Mandatory: optional
  • Length: 2-25
Example
{
  "firstName": "abc123",
  "firstSurname": "abc123",
  "secondName": "xyz789",
  "secondSurname": "abc123"
}

NoteField

Description

Structure that defines all the necessary information for an arbitrady named field

Fields
Input Field Description
key - String!

Key name of the data to be stored.

  • Mandatory: mandatory
  • Length: 3-50
value - String!

The note size must be greater than 5 and less than 500 characters(5-500). Additional information: Free text, related to the document.

  • Mandatory: mandatory
Example
{
  "key": "abc123",
  "value": "xyz789"
}

NoteFieldOutput

Description

Defines the response object for an arbitrary note field

Fields
Field Name Description
key - String Key name of the data stored.
values - [String] Additional information: Free text, related to the document.
Example
{
  "key": "xyz789",
  "values": ["xyz789"]
}

NoteSummary

Description

Defines the structure with the summary with respect to the credit notes it contains.

Fields
Field Name Description
date - Date Date on which the note was created.
id - String Document number: Includes prefix + consecutive invoice number authorized by DIAN.
orden - Int Order of creation of the note.
type - String Note type.
uuid - UID Unique identifier of the note in the system.
value - decimal Total value of the note.
Example
{
  "date": "2007-12-03",
  "id": "abc123",
  "orden": 987,
  "type": "xyz789",
  "uuid": UID,
  "value": decimal
}

OperationCode

Description

Defines the response object for the document operation code.

Fields
Field Name Description
code - String The document operation code.
description - String The description of the type of operation.
Example
{
  "code": "abc123",
  "description": "xyz789"
}

OrgEconomicActivities

Description

Structure for an Organization's economic activities

Fields
Field Name Description
mainActivity - EconomicActivityCodeOutput Client's main economic activity.
others - [EconomicActivityCodeOutput] Client's secondary economic activities.
Example
{
  "mainActivity": EconomicActivityCodeOutput,
  "others": [EconomicActivityCodeOutput]
}

OrgEconomicActivitiesInput

Description

Structure for an Organization's economic activities

Fields
Input Field Description
mainActivity - EconomicActivityCode

Client's main economic activity.

  • Mandatory: optional
others - [EconomicActivityCode]

Client's secondary economic activities.

  • Mandatory: optional
Example
{"mainActivity": "CIIU_V4_0010", "others": ["CIIU_V4_0010"]}

Organization

Description

Structure for an Organization

Fields
Field Name Description
insertedAt - DateTime Date and time at which the organization was inserted.
organizationBusinessData - OrganizationBusinessData Structure for an organization's business data(adress, economic activities, email, phone).
organizationContactData - ContactData Structure for the Organization's contact details.
organizationFiscalData - FiscalData Structure where the fiscal management of the organization is located and a list of the fiscal responsibilities of the organization
organizationId - UID The organization UID.
organizationMiscData - NoteFieldOutput Notes with relevant information about the organization that have not been specified in the other fields.
organizationName - String The organization name.
organizationNit - String The tax identification number(NIT) of the organization.
organizationSettings - OrganizationSettings organizationSettings(OrganizationSettings): Notes with relevant information about the organization settings
organizationState - NoteFieldOutput General information about the organization.
organizationType - PersonTypeOutput Field indicating whether the person is a natural or legal person.
organizationalUnits - [OrganizationUnit] The organizational units.
updatedAt - DateTime Date and time when the organization was updated.
Example
{
  "insertedAt": "2007-12-03T10:15:30Z",
  "organizationBusinessData": OrganizationBusinessData,
  "organizationContactData": ContactData,
  "organizationFiscalData": FiscalData,
  "organizationId": UID,
  "organizationMiscData": NoteFieldOutput,
  "organizationName": "xyz789",
  "organizationNit": "abc123",
  "organizationSettings": OrganizationSettings,
  "organizationState": NoteFieldOutput,
  "organizationType": PersonTypeOutput,
  "organizationalUnits": [OrganizationUnit],
  "updatedAt": "2007-12-03T10:15:30Z"
}

OrganizationBusinessData

Description

Structure for an Organization's business data

Fields
Field Name Description
address - PhysicalLocation The Organization's business address.
economicActivities - OrgEconomicActivities The Organization's economic activities.
email - email The Organization's business email.
Example value: organizationemail@gmail.com
phone - String The Organization's business phone.
Example
{
  "address": PhysicalLocation,
  "economicActivities": OrgEconomicActivities,
  "email": email,
  "phone": "xyz789"
}

OrganizationBusinessDataUpdateInput

Description

Structure for an Organization's business data update

Fields
Input Field Description
address - PhysicalLocationInput

The Organization's business address.

  • Mandatory: optional
economicActivities - OrgEconomicActivitiesInput

The Organization's economic activities.

  • Mandatory: optional
email - email

The Organization's business email.
Example: 'organizationemail@gmail.com'

  • Mandatory: optional
phone - String

The Organization's business phone. Example: '+57(601) 123 4567' '601 123 4567 / 601 765 4321' '1234567'

  • Mandatory: optional
Example
{
  "address": PhysicalLocationInput,
  "economicActivities": OrgEconomicActivitiesInput,
  "email": email,
  "phone": "abc123"
}

OrganizationSettings

Description

Defines the organization's settings

Fields
Field Name Description
composite - Boolean composite(Boolean): Defines if the organization is a consortium or not.
testSetId - String testSetId(String): The id issued by the DIAN used to identify the test set required by the DIAN.
valueTitleIssuer - Boolean valueTitleIssuer(Boolean): Defines whether the organization will issue value titles at some point.
Example
{
  "composite": false,
  "testSetId": "xyz789",
  "valueTitleIssuer": false
}

OrganizationUnit

Description

Defines the response object for a business Unit type

Fields
Field Name Description
documents - [DocumentInterface] List of created documents
insertedAt - DateTime Date and time at which the organization unit was inserted.
organizationId - String The organization ID
organizationUnitBusinessData - OrganizationUnitBusinessData Structure for an organization's unit business data(adress, economic activities, email, phone).
organizationUnitContactData - ContactData Structure for the Organization's unit contact details.
organizationUnitFiscalData - FiscalData The organization unit fiscal data.
organizationUnitId - String The organization unit ID
organizationUnitMiscData - NoteFieldOutput Notes with relevant information about the organization unit that have not been specified in the other fields.
organizationUnitName - String The organization unit name
organizationUnitNit - String The organization unit NIT
organizationUnitSettings - NoteFieldOutput Notes with relevant information about the organization settings.
organizationUnitState - NoteFieldOutput General information about the organization.
organizationUnitUpdateDataJ - json

All the required information for an organization update. e.g

{
  "organizationName": "Houston Food Bank"
  "organizationFiscalData":[
    {
      "fiscalAddress":[
        "ID": "25473",
        "CityName":"MOSQUERA",
        "CountrySubentity": "CUNDINAMARCA",
        "CountrySubentityCode": 25,
        "AddressLine": "AV TRONCAL DE OCCIDENTE 18 76 MZ J LT 4 PAR INDUSTRIAL SANTO DOMINGO"
      ]
      "responsibilities": "O_15"
    }
  ]
  "organizationBusinessData":[
    {
      "adress":[
        "ID": "25473",
        "CityName":"MOSQUERA",
        "CountrySubentity": "CUNDINAMARCA",
        "CountrySubentityCode":25,
        "AddressLine": "AV TRONCAL DE OCCIDENTE 18 76 MZ J LT 4 PAR INDUSTRIAL SANTO DOMINGO"
      ]
      "economicActivities":[
        {
          "mainActivity": "CIIU_V4_0090"
        }
      ]
      "email": "houstonfoodbank@gmail.com",
      "phone": "1234567"
    }
  ]
  "organizationContactData":[
    {
      "name": "Ruben Danyil"
      "contactId": "123456789"
      "adress":[
        "ID": "25473",
        "CityName":"MOSQUERA",
        "CountrySubentity": "CUNDINAMARCA",
        "CountrySubentityCode":25,
        "AddressLine": "AV TRONCAL DE OCCIDENTE 18 76 MZ J LT 4 PAR INDUSTRIAL SANTO DOMINGO"
      ] 
      "email": "RubenDanyil@gmail.com",
      "phone": "1234567"
    }
  ]
}

NOTE: this field may be deprecated in future versions.

updatedAt - DateTime Date and time at which the organization unit was updated.
Example
{
  "documents": [DocumentInterface],
  "insertedAt": "2007-12-03T10:15:30Z",
  "organizationId": "xyz789",
  "organizationUnitBusinessData": OrganizationUnitBusinessData,
  "organizationUnitContactData": ContactData,
  "organizationUnitFiscalData": FiscalData,
  "organizationUnitId": "abc123",
  "organizationUnitMiscData": NoteFieldOutput,
  "organizationUnitName": "xyz789",
  "organizationUnitNit": "abc123",
  "organizationUnitSettings": NoteFieldOutput,
  "organizationUnitState": NoteFieldOutput,
  "organizationUnitUpdateDataJ": json,
  "updatedAt": "2007-12-03T10:15:30Z"
}

OrganizationUnitBusinessData

Description

Structure for an Organization's business data

Fields
Field Name Description
address - PhysicalLocation The Organization's business address.
economicActivities - EconomicActivityCodeOutput The Organization's economic activities.
email - email The Organization's business email.
Example value: organizationemail@gmail.com
phone - String The Organization's business phone number.
Example
{
  "address": PhysicalLocation,
  "economicActivities": EconomicActivityCodeOutput,
  "email": email,
  "phone": "xyz789"
}

OrganizationUnitConnection

Description

Defines the response object for a query to list organization units.

Fields
Field Name Description
edges - [OrganizationUnitEdge] Used to select the fields that you want to retrieve from each edge in the connection.
pageCursors - PageCursors Returns the structure with the pagination of the search results.
pageInfo - PageInfo Returns details about the current page of results.
totalCount - Int Total number of records in the table taking into account the filters applied.
totalPages - Int Total number of pages under the filters set by the user.
Example
{
  "edges": [OrganizationUnitEdge],
  "pageCursors": PageCursors,
  "pageInfo": PageInfo,
  "totalCount": 987,
  "totalPages": 123
}

OrganizationUnitEdge

Description

Defines each edge, in this case organization unit together with their cursor.

Fields
Field Name Description
cursor - String A marker for an edge's position in the connection.
node - OrganizationUnit The fields to be returned for each node.
Example
{
  "cursor": "abc123",
  "node": OrganizationUnit
}

OrganizationUpdateInput

Description

Structure that defines all the necessary information for an organization update

Fields
Input Field Description
organizationBusinessData - OrganizationBusinessDataUpdateInput

Structure for an organization's business data(adress, economic activities, email, phone).

  • Mandatory: optional
organizationContactData - ContactDataUpdateInput

Structure for the Organization's contact details.

  • Mandatory: optional
organizationFiscalData - FiscalDataUpdateInput

Structure where the fiscal management of the organization is located and a list of the fiscal responsibilities of the organization

  • Mandatory: optional
organizationName - String

The organization name.

  • Mandatory: optional
Example
{
  "organizationBusinessData": OrganizationBusinessDataUpdateInput,
  "organizationContactData": ContactDataUpdateInput,
  "organizationFiscalData": FiscalDataUpdateInput,
  "organizationName": "xyz789"
}

OrganizationalUnitBusinessDataUpdateInput

Description

Structure for an Organization's business data update

Fields
Input Field Description
address - PhysicalLocationInput The Organization's business address.
economicActivities - [EconomicActivityCode] The Organization's economic activities.
email - email The Organization's business email.
Example: 'organizationemail@gmail.com'
phone - String The Organization's business phone. Example: '+57(601) 123 4567' '601 123 4567 / 601 765 4321' '1234567'
Example
{
  "address": PhysicalLocationInput,
  "economicActivities": ["CIIU_V4_0010"],
  "email": email,
  "phone": "abc123"
}

OrganizationalUnitOrderInput

Description

Code to identify the type of organization unit ordering

Values
Enum Value Description

INSERTED_AT_ASC

Sort by inserted at in ascending order.

INSERTED_AT_DESC

Sort by inserted at in descending order.

ORGANIZATION_UNIT_NAME_ASC

Sort by organization unit name in ascending order.

ORGANIZATION_UNIT_NAME_DESC

Sort by organization unit name in descending order.

ORGANIZATION_UNIT_NIT_ASC

Sort by organization unit nit in ascending order.

ORGANIZATION_UNIT_NIT_DESC

Sort by organization unit nit in descending order.
Example
"INSERTED_AT_ASC"

OrganizationalUnitQueryInput

Description

Query Input: Define the query and search options for the organizational unit according to the filters presented.

Fields
Input Field Description
and - [OrganizationalUnitQueryOptionsInput]

List of filters where all must happen.

  • Mandatory: optional
  • Length: [1-∞]
contains - [OrganizationalUnitQuerySearchInput]

A partial search. The text is a substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
endsWith - [OrganizationalUnitQuerySearchInput]

A partial search. The text is the ending substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
not - [OrganizationalUnitQueryOptionsInput]

List of filters where none must happen.

  • Mandatory: optional
  • Length: [1-∞]
or - [OrganizationalUnitQueryOptionsInput]

List of filters where only one has to happen.

  • Mandatory: optional
  • Length: [1-∞]
startsWith - [OrganizationalUnitQuerySearchInput]

A partial search. The text is the starting substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
Example
{
  "and": [OrganizationalUnitQueryOptionsInput],
  "contains": [OrganizationalUnitQuerySearchInput],
  "endsWith": [OrganizationalUnitQuerySearchInput],
  "not": [OrganizationalUnitQueryOptionsInput],
  "or": [OrganizationalUnitQueryOptionsInput],
  "startsWith": [OrganizationalUnitQuerySearchInput]
}

OrganizationalUnitQueryOptionsInput

Description

Structure that defines all the necessary information for the query options for And/Or/Not statements of the organizational unit.

Fields
Input Field Description
cityCode - String

Code that identify each Colombian township.

  • Mandatory: optional
  • Length: 3-12
cityName - String

The name of the township.

  • Mandatory: optional
  • Length: 3-25
countryCode - CountryCode

Afabetic country code (Ej. CO, US, etc.).
Here is the list of all country ISO codes.

  • Mandatory: optional
email - email

The Organization's business email.
Example value: organizationemail@gmail.com

  • Mandatory: optional
organizationUnitName - String

The name of the organization unit.

  • Mandatory: optional
  • Length: 3-150
Example
{
  "cityCode": "xyz789",
  "cityName": "abc123",
  "countryCode": "AD",
  "email": email,
  "organizationUnitName": "abc123"
}

OrganizationalUnitQuerySearchInput

Description

Structure that defines all the necessary information for the query options for text search statements.

Fields
Input Field Description
name - OrganizationalUnitSearchInput

Query options for organization unit text search statements.

  • Mandatory: optional
value - String

Value to be assigned to this search.

  • Mandatory: optional
  • Length: 1-100
Example
{"name": "CITY_NAME", "value": "abc123"}

OrganizationalUnitSearchInput

Description

Query options for organization unit search

Values
Enum Value Description

CITY_NAME

Text search by city name

EMAIL

Text search by email

ENVIRONMENT

Text search by the organization environment

ORGANIZATION_UNIT_NAME

Text search by the organization unit name
Example
"CITY_NAME"

OrganizationalUnitUpdateInput

Description

Structure that defines all the necessary information for an organizational unit update

Fields
Input Field Description
billingResolutions - [UID!] Billing resolutions that will be configured on the unit.
organizationBusinessData - OrganizationalUnitBusinessDataUpdateInput Structure for an Unit's business data(adress, economic activities, email, phone).
unitContactData - ContactDataUpdateInput Structure for the Unit's contact details.
unitId - UID!

The 'to-be update' unit uid.

  • Mandatory: mandatory
unitName - String The organizational unit name.
Example
{
  "billingResolutions": [UID],
  "organizationBusinessData": OrganizationalUnitBusinessDataUpdateInput,
  "unitContactData": ContactDataUpdateInput,
  "unitId": UID,
  "unitName": "xyz789"
}

Page

Description

Returns details about page where the paginator is located.

Fields
Field Name Description
cursor - String Id that identifies the cursor.
page - Int Number of the page that translates the cursor.
Example
{"cursor": "abc123", "page": 123}

PageCursors

Description

Returns details about the current page of results.

Fields
Field Name Description
cursors - [Cursor] Pages and cursors to paginate listing results.
page - Page Page where the paginator is located.
Example
{"cursors": [Cursor], "page": Page}

PageInfo

Fields
Field Name Description
endCursor - String When paginating forwards, the cursor to continue.
hasNextPage - Boolean! When paginating forwards, are there more items?
hasPreviousPage - Boolean! When paginating backwards, are there more items?
startCursor - String When paginating backwards, the cursor to continue.
Example
{
  "endCursor": "xyz789",
  "hasNextPage": false,
  "hasPreviousPage": false,
  "startCursor": "xyz789"
}

Party

Description

Structure with al the information of a party

Fields
Field Name Description
endpointId - EndpointId An identifier for the end point of the routing service.
identification - PersonId The identifier for this party.
name - PersonName A name for this party.
partyTaxScheme - PartyTaxScheme A tax scheme applying to this party.
physicalLocation - PhysicalLocation The physical location of this party.
Example
{
  "endpointId": EndpointId,
  "identification": PersonId,
  "name": PersonName,
  "partyTaxScheme": PartyTaxScheme,
  "physicalLocation": PhysicalLocation
}

PartyContactData

Description

Structure for contact data

Fields
Field Name Description
email - String Party's email.
Example value: contactemail@gmail.com
id - PersonId Structure with the Party's ID.
name - PersonName A name for this party.
note - json Structure containing a Free-form text conveying information.
otherCommunication - json Structure containing a Free-form text conveying any other form of comunication.
telefax - String A telefax number for this party.
telephone - String A phone number for this party.
uid - UID Structure with the Party's unique id.
Example
{
  "email": "abc123",
  "id": PersonId,
  "name": PersonName,
  "note": json,
  "otherCommunication": json,
  "telefax": "abc123",
  "telephone": "xyz789",
  "uid": UID
}

PartyInput

Description

Structure that defines all the necessary information for a Party.

Fields
Input Field Description
contact - ContactInput

contact(ContactInput): The primary contact for this party.

  • Mandatory: optional
industryClasificationCode - OrgEconomicActivitiesInput

Corresponds to the CIUU economic activity code.
Here you can find more information about the CIUU codes.

  • Mandatory: optional
  • Length: 3-4
partyIdentification - PersonIdInput!

An identifier for this party.

  • Mandatory: required
partyName - PersonNameInput!

A name for this party.
Here is the full name of the person or the corporate name, as applicable.

Example values:

  • For a natural person firstName and firstSurname are mandatory: Daniel Smith
  • For a legal person: Cats Marketplace
  • Mandatory: required
partyTaxScheme - PartyTaxSchemeInput!

A tax scheme applying to this party.

  • Mandatory: required
person - [PersonInput]

Natural or legal person responsible for this party.

  • Mandatory: optional
  • Length: [0-n]
physicalLocation - PhysicalLocationInput

The physical location of this party.

  • Mandatory: optional
postalAddress - PhysicalLocationInput

The party's postal address.

  • Mandatory: optional
websiteUri - uri

The Uniform Resource Identifier (URI) that identifies this party's web site.

  • Mandatory: optional
Example
{
  "contact": ContactInput,
  "industryClasificationCode": OrgEconomicActivitiesInput,
  "partyIdentification": PersonIdInput,
  "partyName": PersonNameInput,
  "partyTaxScheme": PartyTaxSchemeInput,
  "person": [PersonInput],
  "physicalLocation": PhysicalLocationInput,
  "postalAddress": PhysicalLocationInput,
  "websiteUri": uri
}

PartyLegalEntity

Description
Fields
Field Name Description
shareholders - [Shareholder] where n is the sum of all shareholders up to 100% A party owning shares in this legal entity.
Example
{"shareholders": [Shareholder]}

PartyLegalEntityInput

Description
Fields
Input Field Description
shareHolderParty - [ShareHolderPartyInput!]!

Where n is the sum of all shareholders up to 100%
Is the percentage of shares held by the individual or legal entity in this company.

  • Mandatory: mandatory
  • Length: [1-n]
Example
{"shareHolderParty": [ShareHolderPartyInput]}

PartyTaxScheme

Description

Structure that defines all the necessary information for the Tax Information Group

Fields
Field Name Description
compStringId - PersonId Structure containing the company or person id.
partyLegalEntity - PartyLegalEntity A description of this party as a legal entity.
registrationAddress - PhysicalLocation The person's fiscal address.
registrationName - String The person's name AKA Razón Social
taxLevelCode - [json] The person's responsibilities
taxScheme - TaxScheme The person's tax obligations.
Example
{
  "compStringId": PersonId,
  "partyLegalEntity": PartyLegalEntity,
  "registrationAddress": PhysicalLocation,
  "registrationName": "xyz789",
  "taxLevelCode": [json],
  "taxScheme": TaxScheme
}

PartyTaxSchemeInput

Description

Structure that defines all the necessary information for a person's tax scheme.

Fields
Input Field Description
compStringId - PersonIdInput!

Structure containing the company id or identifier.

  • Mandatory: required
partyLegalEntity - PartyLegalEntityInput

Party legal information group.

  • Mandatory: optional
registrationAddress - PhysicalLocationInput

The person's fiscal address.

  • Mandatory: optional
registrationName - String!

The person's name AKA Razón Social.

  • Mandatory: required
  • Length: 3-150
taxLevelCode - [ResponsibilityCode!]!

The person's responsibilities.
Here you can find more information about the responsability codes endorsed by the dian in its technical annex. Go to page 603 #13.2.6.1.

  • Mandatory: required
  • Length: [1-n]
taxScheme - TaxSchemeCode!

The taxation scheme applicable to the party.

  • Mandatory: required
Example
{
  "compStringId": PersonIdInput,
  "partyLegalEntity": PartyLegalEntityInput,
  "registrationAddress": PhysicalLocationInput,
  "registrationName": "xyz789",
  "taxLevelCode": ["A_01"],
  "taxScheme": "CO_01"
}

PaymentExchangeRate

Description

Structure for a payment exchange rate

Fields
Field Name Description
calculationRate - decimal The factor applied to the source currency to calculate the target currency.
date - Date Negotiation Date.
sourceBaseRate - Float Must be 1.0 by DIAN's Standards.
sourceCurrency - String Document's base currency.
targetBaseDate - Float Must be 1.0 by DIAN's Standards.
targetCurrency - String Document's target currency
Example
{
  "calculationRate": decimal,
  "date": "2007-12-03",
  "sourceBaseRate": 987.65,
  "sourceCurrency": "xyz789",
  "targetBaseDate": 987.65,
  "targetCurrency": "xyz789"
}

PaymentExchangeRateInput

Description

Structure that defines all the necessary information for the Payment Exchange Rate

Fields
Input Field Description
calculationRate - decimal!

Exchange rate (Eg. Today's TRM).

  • Mandatory: required
  • Range: It must have between 2 and 15 positions, with between 0 and 6 decimal places.
date - Date!

Negotiation Date.

  • Mandatory: required
Example
{
  "calculationRate": decimal,
  "date": "2007-12-03"
}

PaymentIdCode

Description

Payment Id Code

Values
Enum Value Description

CREDIT

Indicates that payment is on credit

IN_CASH

Indicates that payment is in cash
Example
"CREDIT"

PaymentMean

Description
Fields
Field Name Description
paymentDueDate - DateTime Due date for payment.
paymentMeanCode - PaymentMeanCodeOutput Structure with the information of the payment mean code.
paymentMeanId - PaymentMeanId Structure with the information of the payment method identifier.
paymentTerms - LocalizedString A set of payment terms associated with this document
Example
{
  "paymentDueDate": "2007-12-03T10:15:30Z",
  "paymentMeanCode": PaymentMeanCodeOutput,
  "paymentMeanId": PaymentMeanId,
  "paymentTerms": LocalizedString
}

PaymentMeanCode

Description

Payment methods available for Colombia.

DIAN Annex - 13.3.4.2 - Page 602

https://www.dian.gov.co/impuestos/factura-electronica/Documents/Anexo-Tecnico-Resolucion-000012-09022021.pdf

Values
Enum Value Description

CO_1

Instrument not defined

CO_10

Cash

CO_11

Reversal Savings Credit

CO_12

Reversal Savings Debit

CO_13

Savings Credit

CO_14

Debit Savings

CO_15

Bookentry Credit

CO_16

Bookentry Debit

CO_17

Concentration of Cash Demand / Disbursement (CCD) Credit (CCD)

CO_18

Concentration of Cash Demand / Disbursement (CCD) Debit

CO_19

Credit Corporate Business Payment (CTP)

CO_2

ACH Credit

CO_20

Check

CO_21

Banking project

CO_22

Certified banking project

CO_23

Bank check

CO_24

Exchange note awaiting acceptance

CO_25

Certified check

CO_26

Crazy Check

CO_27

Debit Corporate Business Payment (CTP)

CO_28

Credit Corporate Trade Exchange Business (CTX)

CO_29

Debit Business Corporate Exchange (CTX)

CO_3

ACH Debit

CO_30

Credit Transfer

CO_31

Debit Transfer

CO_32

Cash Concentration / Disbursement Credit plus (CCD+)

CO_33

Concentration Cash / Disbursement Debit plus (CCD+)

CO_34

Pre-arranged Payment and Deposit (PPD)

CO_35

Concentration Cash Savings / Disbursement Credit (CCD)

CO_36

Concentration Cash Savings / Disbursement Credit (CCD)

CO_37

Corporate Business Savings Credit Disbursement (CTP)

CO_38

Payment Corporate Business Savings Debit (CTP)

CO_39

Corporate Business Exchange Credit (CTX)

CO_4

ACH Demand Debit Reversal

CO_40

Debit Business Corporate Trade Exchange (CTX)

CO_41

Cash Concentration/Disbursement Credit Plus (CCD+)

CO_42

Bank Consignment

CO_43

Cash Concentration / Disbursement Debit plus (CCD+)

CO_44

Exchange Note

CO_45

Bank Credit Transfer

CO_46

Interbank Debit Transfer

CO_47

Bank Debit Transfer

CO_48

Credit Card

CO_49

Debit Card

CO_5

ACH demand credit reversal

CO_50

Postdraft

CO_51

Standard French bank telex

CO_52

Urgent commercial payment

CO_53

Urgent Treasury Payment

CO_6

ACH demand credit

CO_60

Promissory note

CO_61

Promissory note signed by the creditor

CO_62

Promissory note signed by the creditor, endorsed by the bank

CO_63

Promissory note signed by the creditor, guaranteed by a third party

CO_64

Promissory note signed by the bank

CO_65

Promissory note signed by a bank and guaranteed by another bank

CO_66

Promissory note signed

CO_67

Promissory note signed by a third party and guaranteed by a bank

CO_7

ACH demand credit

CO_70

Withdrawal of the note by the creditor

CO_71

Bonuses

CO_72

Vouchers

CO_74

Withdrawal of a note by the creditor from a bank

CO_75

Withdrawal of note by creditor, guaranteed by another bank

CO_76

Withdrawal of note by creditor, on a bank guaranteed by a third party

CO_77

Withdrawal of a note by the creditor on a third party

CO_78

Withdrawal of a note by the creditor on a third party guaranteed by a bank

CO_8

Maintain

CO_9

National or Regional Clearing

CO_91

Transferable bank note

CO_92

Transferable local check

CO_93

Referenced money order

CO_94

Urgent money order

CO_95

Open format money order

CO_96

Payment method requested not used

CO_97

Clearing between partners

CO_98

Simplified Transaction Savings Accounts (CATS) (Nequi, Daviplata, etc.)

CO_ZZZ

Mutual agreement
Example
"CO_1"

PaymentMeanCodeOutput

Description

Defines the response object for the payment mean code

Fields
Field Name Description
code - String A code signifying the type of means of payment
description - String The description or meaning of the payment mean code.
Example
{
  "code": "abc123",
  "description": "xyz789"
}

PaymentMeanId

Description

Defines the response object for the payment mean id

Fields
Field Name Description
code - String A code signifying the payment method identifier.
description - String The description or meaning of the payment method.
Example
{
  "code": "abc123",
  "description": "abc123"
}

PaymentMeanInput

Description

Structure that defines all the necessary information for payment methods

Fields
Input Field Description
paymentDueDate - DateTime

Payment deadline.

  • Mandatory: optional
paymentMeanCode - PaymentMeanCode!

Method of payment used (e.g. Check, Cash, Card, etc.).

  • Mandatory: required
paymentMeanId - PaymentIdCode!

Payment method identifier (credit or cash).

  • Mandatory: required
paymentTerms - LocalizedStringInput

Text with the payment terms.

  • Mandatory: optional
Example
{
  "paymentDueDate": "2007-12-03T10:15:30Z",
  "paymentMeanCode": "CO_1",
  "paymentMeanId": "CREDIT",
  "paymentTerms": LocalizedStringInput
}

PersonId

Description

Structure for person ID

Fields
Field Name Description
idType - IdTypeOutput Person document types.
identifier - String The person identifier
Example
{
  "idType": IdTypeOutput,
  "identifier": "abc123"
}

PersonIdInput

Description

Structure that defines all the necessary information for a person's id document input

Fields
Input Field Description
idType - IdType!

Person document types.
Example values: CC, NIT, P(passport), etc..

  • Mandatory: optional
identifier - String!

The person's identification number.

  • Mandatory: optional
  • Length: 3-16
Example
{"idType": "CC", "identifier": "xyz789"}

PersonInput

Description

Structure that defines all the necessary information for a Person.

Fields
Input Field Description
contact - ContactInput

Structure containing the contact information for this person.

  • Mandatory: optional
genderCode - GenderCode

A code signifying the gender of this person.(Example values: "MALE", "FEMALE", "PREFER_NOT_TO_SAY").

  • Mandatory: optional
id - PersonIdInput

Structure containing an identifier for this person.

  • Mandatory: optional
name - PersonNameInput

name(PersonNameInput): Structure containing the full name of this person.
Here is the full name of the person or the corporate name, as applicable.

Example values:

  • For a natural person firstName and firstSurname are mandatory: Daniel Smith.
  • For a legal person: Cats Marketplace
  • Mandatory: optional
nationality - CountryCode

An identifier for this person's nationality. (Example values: CO, US, etc).
Here you can find a list of all country ISO codes.

  • Mandatory: optional
residenceAddress - PhysicalLocationInput

Structure containing this person's address of residence.

  • Mandatory: optional
Example
{
  "contact": ContactInput,
  "genderCode": "FEMALE",
  "id": PersonIdInput,
  "name": PersonNameInput,
  "nationality": "AD",
  "residenceAddress": PhysicalLocationInput
}

PersonName

Description

Response structure for a person's name.

A person's full name is: firstName + secondName + firstSurname + secondSurname. (In total this can not be larger than 50 digits).
Corporate name is only for a legal entity, for a natural person the firstName and firstSurName are mandatory.
NOTE: Here you can only enter the full name of the person or the corporate name, NOT BOTH.

Fields
Field Name Description
corporateName - String Legal registered name. (Example values: MyCorp S.A., Imported Stuff Ltda., etc.)
firstName - String First name of the person.
firstSurname - String First family name AKA surname or last name.
secondName - String Second name of the person.
secondSurname - String Second family name AKA surname or last name.
Example
{
  "corporateName": "xyz789",
  "firstName": "xyz789",
  "firstSurname": "xyz789",
  "secondName": "xyz789",
  "secondSurname": "abc123"
}

PersonNameInput

Description

Structure that defines all the necessary information for person's name input.

A person's full name is: firstName + secondName + firstSurname + secondSurname. (In total this can not be larger than 50 digits).
Corporate name is only for a legal entity, for a natural person the firstName and firstSurName are mandatory.
Example values:

  • For a natural person firstName and firstSurname are mandatory: Daniel Smith.
  • For a legal person: Cats Marketplace NOTE: Here you can only enter the full name of the person or the corporate name, NOT BOTH.
Fields
Input Field Description
corporateName - String

Legal registered name.
Example values: MyCorp S.A., Imported Stuff Ltda., etc..

  • Mandatory: optional
  • Length: 3-50
firstName - String

First name of the person.

  • Mandatory: optional
  • Length: 2-25
firstSurname - String

First family name AKA surname or last name.

  • Mandatory: optional
  • Length: 2-25
secondName - String

Second name of the person.

  • Mandatory: optional
  • Length: 2-25
secondSurname - String

Second family name AKA surname or last name.

  • Mandatory: optional
  • Length: 2-25
Example
{
  "corporateName": "abc123",
  "firstName": "abc123",
  "firstSurname": "xyz789",
  "secondName": "xyz789",
  "secondSurname": "xyz789"
}

PersonType

Description

Person type

Values
Enum Value Description

LEGAL_ENTITY

The legal entity responds to a company that may be formed by multiple persons exercising rights and contracting obligations

NATURAL_PERSON

A natural person is liable for his obligations in his personal capacity
Example
"LEGAL_ENTITY"

PersonTypeOutput

Description

Defines the response object for the person type

Fields
Field Name Description
code - String A code signifying the person type.
description - String The description or meaning of person type.
Example
{
  "code": "xyz789",
  "description": "xyz789"
}

PhysicalLocation

Description

Structure that defines all the necessary information for a Physical location description.

Example values:

  • If the location is "Bogotá" or any Colombian township, the values to enter will be:

    • countryCode: CO (Here is the list of all country ISO codes).
    • city: 11001 (For colombian townships here are the list of codes, go to page 633 #13.4.3).

    The return information will be:

    • countryName: "COLOMBIA"
    • countryCode: CO
    • cityName: "Bogota"
    • cityCode: "11001"
    • countrySubentity: "Bogota"
    • countrySubentityCode: "11"
  • In case the location is in a country other than Colombia, for example "Miami", the input data will be as follows:

    • country: US (Here is the list of all country ISO codes).
    • countrySubentity: "FLORIDA" (The code or name of a non Colombian Department/State)
    • city: "MIAMI" (The city code or name of a non Colombian township).

    The return information will be:

    • countryName: "ESTADOS_UNIDOS"
    • countryCode: US
    • cityName: "MIAMI"
    • countrySubentity: "US-FL"
Fields
Field Name Description
address - String The Address text.
cityCode - String 5 Digit code used by the DANE to identify each Colombian township.
cityName - String The name of the township.
countryCode - String Afabetic country code (Ej. CO, US, etc.). Here is the list of all country ISO codes.
countrySubentity - String Department/State name.
countrySubentityCode - String Department code used by the DANE to identify each Colombian Department.
description - NoteFieldOutput Structure with open text area describing the location.
informationUri - uri The Uniform Resource Identifier (URI) of a document providing information about this location.
name - String Name of the location
postalCode - String Postal code of the location.
Example
{
  "address": "xyz789",
  "cityCode": "abc123",
  "cityName": "abc123",
  "countryCode": "xyz789",
  "countrySubentity": "xyz789",
  "countrySubentityCode": "xyz789",
  "description": NoteFieldOutput,
  "informationUri": uri,
  "name": "abc123",
  "postalCode": "abc123"
}

PhysicalLocationInput

Description

Structure that defines all the necessary information for a Physical location description.

Example values:

  • If the location is "Bogotá" or any Colombian township, the values to enter will be:

    • countryCode: CO (Here is the list of all country ISO codes).
    • city: 11001 (For colombian townships here are the list of codes, go to page 633 #13.4.3).

    The return information will be:

    • countryName: "COLOMBIA"
    • countryCode: CO
    • cityName: "Bogota"
    • cityCode: "11001"
    • countrySubentity: "Bogota"
    • countrySubentityCode: "11"
  • In case the location is in a country other than Colombia, for example "Miami", the input data will be as follows:

    • country: US (Here is the list of all country ISO codes).
    • countrySubentity: "FLORIDA" (The code or name of a non Colombian Department/State)
    • city: "MIAMI" (The city code or name of a non Colombian township).

    The return information will be:

    • countryName: "ESTADOS_UNIDOS"
    • countryCode: US
    • cityName: "MIAMI"
    • countrySubentity: "US-FL"
Fields
Input Field Description
address - String!

The Address text.

  • Mandatory: required
  • Length: 1-300
city - String

It can be either the 5 Digit code used by the DIAN/DANE to identify a Colombian township or the code or name of a non Colombian township.
For colombian townships here are the list of codes, go to page 633 #13.4.3.
NOTE: For any Colombian address the 5 Digit code is mandatory.

  • Mandatory: optional
  • Length: 3-60
country - CountryCode!

Afabetic country code (Ej. CO, US, etc.).
Here is the list of all country ISO codes.

  • Mandatory: required
countrySubentity - String

It can be either the 2 Digit code used by the DIAN/DANE to identify a Colombian Department/State or the code or name of a non Colombian Department/State

  • Mandatory: optional
  • Length: 3-60
description - NoteField

Open text area describing the location, where you can put all the address information, instead of using structured elements (the other elements of this structure).
Example value: "3425 Stone Street, Apt. 2A, Jacksonville, FL 39404"

  • Mandatory: optional
informationUri - uri

The Uniform Resource Identifier (URI) of a document providing information about this location.

  • Mandatory: optional
name - String

The name of the location.

  • Mandatory: optional
  • Length: 3-50
postalCode - String

Postal code of the location.

  • Mandatory: optional
  • Length: 3-10
Example
{
  "address": "xyz789",
  "city": "abc123",
  "country": "AD",
  "countrySubentity": "abc123",
  "description": NoteField,
  "informationUri": uri,
  "name": "xyz789",
  "postalCode": "xyz789"
}

PosInvoice

Description

Defines the response object for an invoice

Fields
Field Name Description
assessmentState - Int Assessment state
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for an invoice prefix.
creditNoteSummary - [NoteSummary] List with the summary of the credit notes contained in the invoice.
debitNoteSummary - [NoteSummary] List with the summary of the debit notes contained in the invoice.
dianState - Int State code in the DIAN
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentQr - String QR's code content represented as text
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentSummary - InvoiceDocumentSummary Sales Invoice summary with respect to the credit notes it contains.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
files - DocumentFiles Files related to the invoice.
generalInformation - GeneralInformationInterface Invoice's general information.
goodsState - Int Goods state
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the invoice was inserted.
issuerSoftwareSystem - IssuerSoftwareSystemOutput Additional information to inform the software system issuing the document.
notes - [DocumentNotesOutput] Additional information: Free text, related to the document
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the invoice
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's invoice UUID.
updatedAt - DateTime Date and time when the invoice was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "assessmentState": 987,
  "billingPrefix": BillingPrefix,
  "creditNoteSummary": [NoteSummary],
  "debitNoteSummary": [NoteSummary],
  "dianState": 987,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentQr": "xyz789",
  "documentStatus": StatusDescriptor,
  "documentSummary": InvoiceDocumentSummary,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "abc123",
  "documentUid": UID,
  "events": [Event],
  "files": DocumentFiles,
  "generalInformation": GeneralInformationInterface,
  "goodsState": 123,
  "id": "xyz789",
  "insertedAt": "2007-12-03T10:15:30Z",
  "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
  "notes": [DocumentNotesOutput],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

PosInvoiceConnection

Description

Defines the response object for a query to list POS invoices.

Fields
Field Name Description
edges - [PosInvoiceEdge] Used to select the fields that you want to retrieve from each edge in the connection.
pageCursors - PageCursors Returns the structure with the pagination of the search results.
pageInfo - PageInfo Returns details about the current page of results.
totalCount - Int Total number of records in the table taking into account the filters applied.
totalPages - Int Total number of pages under the filters set by the user.
Example
{
  "edges": [PosInvoiceEdge],
  "pageCursors": PageCursors,
  "pageInfo": PageInfo,
  "totalCount": 987,
  "totalPages": 123
}

PosInvoiceDocumentOutput

Description

Structure for a document output

Fields
Field Name Description
document - PosInvoice The document.
errors - [Error] List of errors associated with this organization.
notifications - [Information] List of notifications associated with this organization.
warnings - [Warning] List of warnings associated with this organization.
Example
{
  "document": PosInvoice,
  "errors": [Error],
  "notifications": [Information],
  "warnings": [Warning]
}

PosInvoiceEdge

Description

Defines each edge, in this case POS invoice together with their cursor.

Fields
Field Name Description
cursor - String A marker for an edge's position in the connection.
node - PosInvoiceNode The fields to be returned for each node.
Example
{
  "cursor": "abc123",
  "node": PosInvoiceNode
}

PosInvoiceInput

Description

Structure that defines all the necessary information for an invoice input

Fields
Input Field Description
documentExtensions - DocumentExtensionsInput

UBL DIAN Extensions.

  • Mandatory: required
documentLines - [DocumentLineInput!]!

Input with information concerning products within the document.

  • Mandatory: required
  • Length: [1-n]
documentModifiers - [AllowanceChargeInput]

Input where discount's or charges are found.

  • Mandatory: optional
  • Length: [1-n]
documentParties - DocumentPartiesInput!

Parties involved in the document.

  • Mandatory: optional
documentTotals - LegalMonetaryTotalInput!

The total amount payable, including allowances, charges, and taxes.

  • Mandatory: required
generalInformation - InvoiceGeneralInformationInput!

Document's general information.

  • Mandatory: required
id - DocumentConsecutiveInput!

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: optional
issuerSoftwareSystem - IssuerSoftwareSystem

Additional information to inform the software system issuing the document.

  • Mandatory: optional
notes - [DocumentNotes]

Additional information: Free text, related to the document.

  • Mandatory: optional
  • Length: [1-n]
organizationalUnitId - UID!

Organizational Unit's Id.

  • Mandatory: required
paymentDescription - DocumentPaymentDescriptorInput!

Document's Payment Description.

  • Mandatory: required
  • Length: [1-n]
referencedDocuments - [DocumentReferenceInput]

Additional Documents referenced inside the document.

  • Mandatory: optional
  • Length: [1-n]
taxDescription - [TaxTotalInput]

Structure with the information of the total amount of tax, like: the withholding tax, the total tax amount, etc.

  • Mandatory: optional
  • Length: [1-n]
withholdingsDescription - [WithholdingTotalInput!]

The total amount of tax.

  • Mandatory: required
  • Length: [1-n]
Example
{
  "documentExtensions": DocumentExtensionsInput,
  "documentLines": [DocumentLineInput],
  "documentModifiers": [AllowanceChargeInput],
  "documentParties": DocumentPartiesInput,
  "documentTotals": LegalMonetaryTotalInput,
  "generalInformation": InvoiceGeneralInformationInput,
  "id": DocumentConsecutiveInput,
  "issuerSoftwareSystem": IssuerSoftwareSystem,
  "notes": [DocumentNotes],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptorInput,
  "referencedDocuments": [DocumentReferenceInput],
  "taxDescription": [TaxTotalInput],
  "withholdingsDescription": [WithholdingTotalInput]
}

PosInvoiceNode

Description

Defines the response object for an invoice

Fields
Field Name Description
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for an invoice prefix.
creditNoteSummary - [NoteSummary] List with the summary of the credit notes contained in the invoice.
debitNoteSummary - [NoteSummary] List with the summary of the debit notes contained in the invoice.
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentSummary - InvoiceDocumentSummary Sales Invoice summary with respect to the credit notes it contains.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
generalInformation - GeneralInformationInterface Invoice's general information.
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the invoice was inserted.
issuerSoftwareSystem - IssuerSoftwareSystemOutput Additional information to inform the software system issuing the document.
notes - [DocumentNotesOutput] Additional information: Free text, related to the document
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the invoice
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's invoice UUID.
updatedAt - DateTime Date and time when the invoice was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "billingPrefix": BillingPrefix,
  "creditNoteSummary": [NoteSummary],
  "debitNoteSummary": [NoteSummary],
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentStatus": StatusDescriptor,
  "documentSummary": InvoiceDocumentSummary,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "xyz789",
  "documentUid": UID,
  "events": [Event],
  "generalInformation": GeneralInformationInterface,
  "id": "xyz789",
  "insertedAt": "2007-12-03T10:15:30Z",
  "issuerSoftwareSystem": IssuerSoftwareSystemOutput,
  "notes": [DocumentNotesOutput],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

PrepaidPayment

Description
Fields
Field Name Description
id - String! Payment identification
instructionId - String An identifier for the payment instruction
paidAmount - decimal! Value of payment.
paidDateTime - DateTime! Date and Time in which the payment was done.
paymentInstructions - String Payment instructions
receivedDate - Date! Date and Time in which the payment was received.
Example
{
  "id": "xyz789",
  "instructionId": "abc123",
  "paidAmount": decimal,
  "paidDateTime": "2007-12-03T10:15:30Z",
  "paymentInstructions": "xyz789",
  "receivedDate": "2007-12-03"
}

PrepaidPaymentInput

Description

Structure that defines all the necessary information for prepaid payment

Fields
Input Field Description
id - String!

Payment's UID.

  • Mandatory: required
  • Length: 3-50
instructionId - String

An identifier for the payment instruction.

  • Mandatory: optional
  • Length: 3-50
paidAmount - decimal!

Paid amount. Can't be negative or 0

  • Mandatory: required
  • Range: It must have between 4 and 15 positions, with between 0 and 6 decimal places
paidDateTime - DateTime! paidDateTime(DateTime): The Date and Time when the payment was done.
paymentInstructions - String

Payment instructions.

  • Mandatory: optional
  • Length: 3-100
receivedDate - Date

The date when the payment was received.

  • Mandatory: optional
Example
{
  "id": "abc123",
  "instructionId": "xyz789",
  "paidAmount": decimal,
  "paidDateTime": "2007-12-03T10:15:30Z",
  "paymentInstructions": "xyz789",
  "receivedDate": "2007-12-03"
}

Price

Description

Structure for a Price

Fields
Field Name Description
baseQuantity - decimal Quantity of items present in the presentation.
priceAmount - decimal The price of each unit present in the product or service presentation.
priceChangeReason - String The reason for the price change
priceType - PriceTypeOutput Indicates what type of price it is.
unitCode - UnitCodeOutput The code that characterizes each unit.
To know more about the economic unit codes, please follow the next link where is the technical annex of the DIAN in version 1.8, go to page 603 #13.3.6.
The list contains all the unit codes, if you do not find one that fits your requirements, please enter de code "CO_ZZ".
NOTE: The code descriptions in this table will be returned in English.
Example
{
  "baseQuantity": decimal,
  "priceAmount": decimal,
  "priceChangeReason": "abc123",
  "priceType": PriceTypeOutput,
  "unitCode": UnitCodeOutput
}

PriceType

Description

Indicates the reference price for lines that do not contain commercial value

Values
Enum Value Description

COMMERCIAL_VALUE

Indicates that the price type is commercial value
Example
"COMMERCIAL_VALUE"

PriceTypeOutput

Description

Defines the response object for the price type

Fields
Field Name Description
code - String A code signifying the price type.
description - String The description or meaning of price type.
Example
{
  "code": "abc123",
  "description": "xyz789"
}

PricingReference

Description

Structure for a Pricing Reference

Fields
Field Name Description
amount - decimal The price of each unit present in the product or service presentation.
priceType - PriceTypeOutput Price type.
Example
{
  "amount": decimal,
  "priceType": PriceTypeOutput
}

ProductLinePeriod

Description

Structure that defines all the necessary information for a document line

Fields
Field Name Description
endDate - Date Indicates the date up to which the products are leaked.
startDate - Date Indicates the date from which the products are leaked.
Example
{
  "endDate": "2007-12-03",
  "startDate": "2007-12-03"
}

ProductLinePeriodInput

Description

Structure that defines all the necessary information for a document line

Fields
Input Field Description
description - GenerationAndTransmisionCode!

Indicates the date up to which the products are leaked.

  • Mandatory: required
endDate - Date

Indicates the date up to which the products are leaked.

  • Mandatory: optional
startDate - Date!

Indicates the date from which the products are leaked.

  • Mandatory: required
Example
{
  "description": "PER_OPERATION",
  "endDate": "2007-12-03",
  "startDate": "2007-12-03"
}

ProductsDeliveryEventInput

Description

Products delivered by issuer.

Fields
Input Field Description
additionalDocuments - [FileInput]

Additional files related to the delivery of the goods.

  • Mandatory: optional
  • Length: [0-n]
eventNotes - [NoteField]

Additional named notes for the event. Each note requires a name or concept.

  • Mandatory: optional
id - EventIdInput!

The unique identifier of an Event.

  • Mandatory: required
invoiceUid - UID!

The unique identifier of an already created Sale Invoice.

  • Mandatory: required
issueDate - DateTime!

Date and time of the event issuance

  • Mandatory: required
issuerParty - EventPartyInput!

Description of the person/entity who received the event

  • Mandatory: required
Example
{
  "additionalDocuments": [FileInput],
  "eventNotes": [NoteField],
  "id": EventIdInput,
  "invoiceUid": UID,
  "issueDate": "2007-12-03T10:15:30Z",
  "issuerParty": EventPartyInput
}

ProductsReceptionEventInput

Description

Products received by acquirer.

Fields
Input Field Description
additionalDocuments - [FileInput]

Additional files related to the delivery of the goods.

  • Mandatory: optional
  • Length: [0-n]
eventNotes - [NoteField]

Additional named notes for the event. Each note requires a name or concept.

  • Mandatory: optional
id - EventIdInput!

The unique identifier of an Event.

  • Mandatory: required
issueDate - DateTime!

Date and time of the event issuance

  • Mandatory: required
issuerParty - EventPartyInput!

Description of the person/entity who received the event

  • Mandatory: required
purchaseInvoiceUid - UID!

The unique identifier of an already imported Purchase Invoice.

  • Mandatory: required
receptionDate - DateTime!

Date and time of the products/service reception

  • Mandatory: required
Example
{
  "additionalDocuments": [FileInput],
  "eventNotes": [NoteField],
  "id": EventIdInput,
  "issueDate": "2007-12-03T10:15:30Z",
  "issuerParty": EventPartyInput,
  "purchaseInvoiceUid": UID,
  "receptionDate": "2007-12-03T10:15:30Z"
}

PurchaseCreditNoteDocument

Description

Defines the response object for a Purchase Credit Note Document

Fields
Field Name Description
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for a purchase invoice prefix.
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
files - DocumentFiles Files related to the invoice.
generalInformation - GeneralInformationInterface Document's general information.
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the support document was inserted.
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's UUID.
updatedAt - DateTime Date and time when the support document was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "billingPrefix": BillingPrefix,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentStatus": StatusDescriptor,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "abc123",
  "documentUid": UID,
  "events": [Event],
  "files": DocumentFiles,
  "generalInformation": GeneralInformationInterface,
  "id": "xyz789",
  "insertedAt": "2007-12-03T10:15:30Z",
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

PurchaseCreditNoteDocumentConnection

Description

Defines the response object for a query to list purchase documents.

Fields
Field Name Description
edges - [PurchaseCreditNoteDocumentEdge] Used to select the fields that you want to retrieve from each edge in the connection.
pageCursors - PageCursors Returns the structure with the pagination of the search results.
pageInfo - PageInfo Returns details about the current page of results.
totalCount - Int Total number of records in the table taking into account the filters applied.
totalPages - Int Total number of pages under the filters set by the user.
Example
{
  "edges": [PurchaseCreditNoteDocumentEdge],
  "pageCursors": PageCursors,
  "pageInfo": PageInfo,
  "totalCount": 123,
  "totalPages": 987
}

PurchaseCreditNoteDocumentEdge

Description

Defines each edge, in this case discount code together with their cursor.

Fields
Field Name Description
cursor - String A marker for an edge's position in the connection.
node - PurchaseCreditNoteDocumentNode The fields to be returned for each node.
Example
{
  "cursor": "abc123",
  "node": PurchaseCreditNoteDocumentNode
}

PurchaseCreditNoteDocumentNode

Description

Defines the response object for a Purchase Credit Note Document

Fields
Field Name Description
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for a purchase invoice prefix.
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
generalInformation - GeneralInformationInterface Document's general information.
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the support document was inserted.
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's UUID.
updatedAt - DateTime Date and time when the support document was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "billingPrefix": BillingPrefix,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentStatus": StatusDescriptor,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "abc123",
  "documentUid": UID,
  "events": [Event],
  "generalInformation": GeneralInformationInterface,
  "id": "abc123",
  "insertedAt": "2007-12-03T10:15:30Z",
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

PurchaseCreditNoteDocumentOutput

Description

Structure for a document output

Fields
Field Name Description
document - PurchaseCreditNoteDocument The document.
errors - [Error] List of errors associated with this organization.
notifications - [Information] List of notifications associated with this organization.
warnings - [Warning] List of warnings associated with this organization.
Example
{
  "document": PurchaseCreditNoteDocument,
  "errors": [Error],
  "notifications": [Information],
  "warnings": [Warning]
}

PurchaseCreditNoteDocumentQueryInput

Description

Query Input: Define the query and search options for the document according to the filters presented.

Fields
Input Field Description
and - [PurchaseCreditNoteDocumentQueryOptionsInput]

List of filters where all must happen.

  • Mandatory: optional
  • Length: [1-∞]
contains - [DocumentQuerySearchInput]

A partial search. The text is a substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
endsWith - [DocumentQuerySearchInput]

A partial search. The text is the ending substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
not - [PurchaseCreditNoteDocumentQueryOptionsInput]

List of filters where none must happen.

  • Mandatory: optional
  • Length: [1-∞]
or - [PurchaseCreditNoteDocumentQueryOptionsInput]

List of filters where only one has to happen.

  • Mandatory: optional
  • Length: [1-∞]
startsWith - [DocumentQuerySearchInput]

A partial search. The text is the starting substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
Example
{
  "and": [PurchaseCreditNoteDocumentQueryOptionsInput],
  "contains": [DocumentQuerySearchInput],
  "endsWith": [DocumentQuerySearchInput],
  "not": [PurchaseCreditNoteDocumentQueryOptionsInput],
  "or": [PurchaseCreditNoteDocumentQueryOptionsInput],
  "startsWith": [DocumentQuerySearchInput]
}

PurchaseCreditNoteDocumentQueryOptionsInput

Description

Structure that defines all the necessary information for query options for And/Or/Not statements.

Fields
Input Field Description
creationDate - Date

Document creation date in the system.

  • Mandatory: optional
currency - CurrencyCode

Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3

  • Mandatory: optional
dateRange - DateRangeInput

Date range for document search.

  • Mandatory: optional
documentUid - UID

This is the document's UUID in YabiCo.

  • Mandatory: optional
id - String

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: optional
  • Length: 3-20
issueDate - Date

Date on which the document was sent to DIAN.

  • Mandatory: optional
organizationalUnitId - UID

UID of the organizational unit.

  • Mandatory: optional
personCompStringName - String

The company name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-50
personEmail - email

The email of the person assigned on the document.
Example value: youremail@gmail.com

  • Mandatory: optional
personFirstSurname - String

First sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personFirtsName - String

First name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personId - String

The identifier of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-25
personIdType - IdType

Type of person ID.

  • Mandatory: optional
personSecondName - String

Middle name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personSecondSurname - String

Seecond sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
Example
{
  "creationDate": "2007-12-03",
  "currency": "AED",
  "dateRange": DateRangeInput,
  "documentUid": UID,
  "id": "xyz789",
  "issueDate": "2007-12-03",
  "organizationalUnitId": UID,
  "personCompStringName": "abc123",
  "personEmail": email,
  "personFirstSurname": "abc123",
  "personFirtsName": "xyz789",
  "personId": "xyz789",
  "personIdType": "CC",
  "personSecondName": "abc123",
  "personSecondSurname": "abc123"
}

PurchaseCreditNoteInput

Description

Structure that defines all the necessary information for a purchase credit note input

Fields
Input Field Description
cude - String!

Document's CUDE according to the DIAN's standard.

  • Mandatory: optional
Example
{"cude": "abc123"}

PurchaseDebitNoteDocument

Description

Defines the response object for a Purchase Debit Note Document

Fields
Field Name Description
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for a purchase invoice prefix.
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
files - DocumentFiles Files related to the invoice.
generalInformation - GeneralInformationInterface Document's general information.
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the support document was inserted.
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's UUID.
updatedAt - DateTime Date and time when the support document was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "billingPrefix": BillingPrefix,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentStatus": StatusDescriptor,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "abc123",
  "documentUid": UID,
  "events": [Event],
  "files": DocumentFiles,
  "generalInformation": GeneralInformationInterface,
  "id": "abc123",
  "insertedAt": "2007-12-03T10:15:30Z",
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

PurchaseDebitNoteDocumentConnection

Description

Defines the response object for a query to list purchase documents.

Fields
Field Name Description
edges - [PurchaseDebitNoteDocumentEdge] Used to select the fields that you want to retrieve from each edge in the connection.
pageCursors - PageCursors Returns the structure with the pagination of the search results.
pageInfo - PageInfo Returns details about the current page of results.
totalCount - Int Total number of records in the table taking into account the filters applied.
totalPages - Int Total number of pages under the filters set by the user.
Example
{
  "edges": [PurchaseDebitNoteDocumentEdge],
  "pageCursors": PageCursors,
  "pageInfo": PageInfo,
  "totalCount": 123,
  "totalPages": 123
}

PurchaseDebitNoteDocumentEdge

Description

Defines each edge, in this case discount code together with their cursor.

Fields
Field Name Description
cursor - String A marker for an edge's position in the connection.
node - PurchaseDebitNoteDocumentNode The fields to be returned for each node.
Example
{
  "cursor": "abc123",
  "node": PurchaseDebitNoteDocumentNode
}

PurchaseDebitNoteDocumentNode

Description

Defines the response object for a Purchase Debit Note Document

Fields
Field Name Description
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for a purchase invoice prefix.
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
generalInformation - GeneralInformationInterface Document's general information.
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the support document was inserted.
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's UUID.
updatedAt - DateTime Date and time when the support document was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "billingPrefix": BillingPrefix,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentStatus": StatusDescriptor,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "xyz789",
  "documentUid": UID,
  "events": [Event],
  "generalInformation": GeneralInformationInterface,
  "id": "abc123",
  "insertedAt": "2007-12-03T10:15:30Z",
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

PurchaseDebitNoteDocumentOutput

Description

Structure for a document output

Fields
Field Name Description
document - PurchaseDebitNoteDocument The document.
errors - [Error] List of errors associated with this organization.
notifications - [Information] List of notifications associated with this organization.
warnings - [Warning] List of warnings associated with this organization.
Example
{
  "document": PurchaseDebitNoteDocument,
  "errors": [Error],
  "notifications": [Information],
  "warnings": [Warning]
}

PurchaseDebitNoteDocumentQueryInput

Description

Query Input: Define the query and search options for the document according to the filters presented.

Fields
Input Field Description
and - [PurchaseDebitNoteDocumentQueryOptionsInput]

List of filters where all must happen.

  • Mandatory: optional
  • Length: [1-∞]
contains - [DocumentQuerySearchInput]

A partial search. The text is a substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
endsWith - [DocumentQuerySearchInput]

A partial search. The text is the ending substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
not - [PurchaseDebitNoteDocumentQueryOptionsInput]

List of filters where none must happen.

  • Mandatory: optional
  • Length: [1-∞]
or - [PurchaseDebitNoteDocumentQueryOptionsInput]

List of filters where only one has to happen.

  • Mandatory: optional
  • Length: [1-∞]
startsWith - [DocumentQuerySearchInput]

A partial search. The text is the starting substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
Example
{
  "and": [PurchaseDebitNoteDocumentQueryOptionsInput],
  "contains": [DocumentQuerySearchInput],
  "endsWith": [DocumentQuerySearchInput],
  "not": [PurchaseDebitNoteDocumentQueryOptionsInput],
  "or": [PurchaseDebitNoteDocumentQueryOptionsInput],
  "startsWith": [DocumentQuerySearchInput]
}

PurchaseDebitNoteDocumentQueryOptionsInput

Description

Structure that defines all the necessary information for query options for And/Or/Not statements.

Fields
Input Field Description
creationDate - Date

Document creation date in the system.

  • Mandatory: optional
currency - CurrencyCode

Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3

  • Mandatory: optional
dateRange - DateRangeInput

Date range for document search.

  • Mandatory: optional
documentUid - UID

This is the document's UUID in YabiCo.

  • Mandatory: optional
id - String

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: optional
  • Length: 3-20
issueDate - Date

Date on which the document was sent to DIAN.

  • Mandatory: optional
organizationalUnitId - UID

UID of the organizational unit.

  • Mandatory: optional
personCompStringName - String

The company name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-50
personEmail - email

The email of the person assigned on the document.
Example value: youremail@gmail.com

  • Mandatory: optional
personFirstSurname - String

First sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personFirtsName - String

First name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personId - String

The identifier of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-25
personIdType - IdType

Type of person ID.

  • Mandatory: optional
personSecondName - String

Middle name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personSecondSurname - String

Seecond sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
Example
{
  "creationDate": "2007-12-03",
  "currency": "AED",
  "dateRange": DateRangeInput,
  "documentUid": UID,
  "id": "xyz789",
  "issueDate": "2007-12-03",
  "organizationalUnitId": UID,
  "personCompStringName": "xyz789",
  "personEmail": email,
  "personFirstSurname": "xyz789",
  "personFirtsName": "xyz789",
  "personId": "abc123",
  "personIdType": "CC",
  "personSecondName": "abc123",
  "personSecondSurname": "xyz789"
}

PurchaseDebitNoteInput

Description

Structure that defines all the necessary information for a purchase debit note input

Fields
Input Field Description
cude - String!

Document's CUDE according to the DIAN's standard.

  • Mandatory: optional
Example
{"cude": "xyz789"}

PurchaseDocument

Description

Defines the response object for a Purchase Document

Fields
Field Name Description
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for a purchase invoice prefix.
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
files - DocumentFiles Files related to the invoice.
generalInformation - GeneralInformationInterface Document's general information.
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the support document was inserted.
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's UUID.
updatedAt - DateTime Date and time when the support document was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "billingPrefix": BillingPrefix,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentStatus": StatusDescriptor,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "xyz789",
  "documentUid": UID,
  "events": [Event],
  "files": DocumentFiles,
  "generalInformation": GeneralInformationInterface,
  "id": "abc123",
  "insertedAt": "2007-12-03T10:15:30Z",
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

PurchaseDocumentConnection

Description

Defines the response object for a query to list purchase documents.

Fields
Field Name Description
edges - [PurchaseDocumentEdge] Used to select the fields that you want to retrieve from each edge in the connection.
pageCursors - PageCursors Returns the structure with the pagination of the search results.
pageInfo - PageInfo Returns details about the current page of results.
totalCount - Int Total number of records in the table taking into account the filters applied.
totalPages - Int Total number of pages under the filters set by the user.
Example
{
  "edges": [PurchaseDocumentEdge],
  "pageCursors": PageCursors,
  "pageInfo": PageInfo,
  "totalCount": 987,
  "totalPages": 123
}

PurchaseDocumentEdge

Description

Defines each edge, in this case discount code together with their cursor.

Fields
Field Name Description
cursor - String A marker for an edge's position in the connection.
node - PurchaseDocumentNode The fields to be returned for each node.
Example
{
  "cursor": "xyz789",
  "node": PurchaseDocumentNode
}

PurchaseDocumentNode

Description

Defines the response object for a Purchase Document

Fields
Field Name Description
billingPrefix - BillingPrefix Structure that defines all the necessary information(ID, creation date, prefix, range) for a purchase invoice prefix.
documentLines - [DocumentLine] Input with information concerning products within the document.
documentModifiers - [AllowanceCharge] Here discount's or charges are found.
documentParties - DocumentParties Parties involved in the document.
documentStatus - StatusDescriptor Characterises the status and stage of the document. For more information go to the following link.
documentTotals - LegalMonetaryTotal The total amount payable, including allowances, charges, and taxes.
documentType - String Structure with the information of the electronic document type code.
documentUid - UID DIAN's Unique Code (CUFE/CUDE/CUDS).
events - [Event] The document Events.
generalInformation - GeneralInformationInterface Document's general information.
id - String Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
insertedAt - DateTime Date and time at which the support document was inserted.
organizationalUnitId - UID Organizational Unit's Id.
paymentDescription - DocumentPaymentDescriptor Document's Payment Description.
referencedDocuments - [DocumentReference] Additional Documents referenced inside the document.
taxDescription - [TaxTotal] The total amount of tax.
transactions - [Transaction] The document transactions.
uid - UID YabiCo's UUID.
updatedAt - DateTime Date and time when the support document was updated.
withholdingsDescription - [WithholdingTotal] The total amount of tax.
Example
{
  "billingPrefix": BillingPrefix,
  "documentLines": [DocumentLine],
  "documentModifiers": [AllowanceCharge],
  "documentParties": DocumentParties,
  "documentStatus": StatusDescriptor,
  "documentTotals": LegalMonetaryTotal,
  "documentType": "xyz789",
  "documentUid": UID,
  "events": [Event],
  "generalInformation": GeneralInformationInterface,
  "id": "xyz789",
  "insertedAt": "2007-12-03T10:15:30Z",
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptor,
  "referencedDocuments": [DocumentReference],
  "taxDescription": [TaxTotal],
  "transactions": [Transaction],
  "uid": UID,
  "updatedAt": "2007-12-03T10:15:30Z",
  "withholdingsDescription": [WithholdingTotal]
}

PurchaseDocumentPartiesInput

Description

Structure that defines all the necessary information for document parties

Fields
Input Field Description
accountingSupplierParty - AccountingSupplierPartyInput!

Buyer's Party.

  • Mandatory: required
Example
{"accountingSupplierParty": AccountingSupplierPartyInput}

PurchaseDocumentQueryInput

Description

Query Input: Define the query and search options for the document according to the filters presented.

Fields
Input Field Description
and - [PurchaseDocumentQueryOptionsInput]

List of filters where all must happen.

  • Mandatory: optional
  • Length: [1-∞]
contains - [DocumentQuerySearchInput]

A partial search. The text is a substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
endsWith - [DocumentQuerySearchInput]

A partial search. The text is the ending substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
not - [PurchaseDocumentQueryOptionsInput]

List of filters where none must happen.

  • Mandatory: optional
  • Length: [1-∞]
or - [PurchaseDocumentQueryOptionsInput]

List of filters where only one has to happen.

  • Mandatory: optional
  • Length: [1-∞]
startsWith - [DocumentQuerySearchInput]

A partial search. The text is the starting substring of any of the listed fields.

  • Mandatory: optional
  • Length: [1-∞]
Example
{
  "and": [PurchaseDocumentQueryOptionsInput],
  "contains": [DocumentQuerySearchInput],
  "endsWith": [DocumentQuerySearchInput],
  "not": [PurchaseDocumentQueryOptionsInput],
  "or": [PurchaseDocumentQueryOptionsInput],
  "startsWith": [DocumentQuerySearchInput]
}

PurchaseDocumentQueryOptionsInput

Description

Structure that defines all the necessary information for query options for And/Or/Not statements.

Fields
Input Field Description
creationDate - Date

Document creation date in the system.

  • Mandatory: optional
currency - CurrencyCode

Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3

  • Mandatory: optional
dateRange - DateRangeInput

Date range for document search.

  • Mandatory: optional
documentUid - UID

This is the document's UUID in YabiCo.

  • Mandatory: optional
id - String

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: optional
  • Length: 3-20
issueDate - Date

Date on which the document was sent to DIAN.

  • Mandatory: optional
operationCode - InvoiceOperationType

The Invoice's operation.

  • Mandatory: optional
organizationalUnitId - UID

UID of the organizational unit.

  • Mandatory: optional
personCompStringName - String

The company name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-50
personEmail - email

The email of the person assigned on the document.
Example value: youremail@gmail.com

  • Mandatory: optional
personFirstSurname - String

First sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personFirtsName - String

First name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personId - String

The identifier of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-25
personIdType - IdType

Type of person ID.

  • Mandatory: optional
personSecondName - String

Middle name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
personSecondSurname - String

Seecond sur name of the person assigned on the document.

  • Mandatory: optional
  • Length: 3-15
subtypeCode - InvoiceSubtype

The Invoice's subtype.

  • Mandatory: optional
Example
{
  "creationDate": "2007-12-03",
  "currency": "AED",
  "dateRange": DateRangeInput,
  "documentUid": UID,
  "id": "xyz789",
  "issueDate": "2007-12-03",
  "operationCode": "AIU",
  "organizationalUnitId": UID,
  "personCompStringName": "abc123",
  "personEmail": email,
  "personFirstSurname": "xyz789",
  "personFirtsName": "xyz789",
  "personId": "abc123",
  "personIdType": "CC",
  "personSecondName": "xyz789",
  "personSecondSurname": "abc123",
  "subtypeCode": "CONTINGENCY_INVOICE"
}

PurchaseInvoiceDocumentOutput

Description

Structure for a document output

Fields
Field Name Description
document - PurchaseDocument The document.
errors - [Error] List of errors associated with this organization.
notifications - [Information] List of notifications associated with this organization.
warnings - [Warning] List of warnings associated with this organization.
Example
{
  "document": PurchaseDocument,
  "errors": [Error],
  "notifications": [Information],
  "warnings": [Warning]
}

PurchaseInvoiceInput

Description

Structure that defines all the necessary information for a purchase invoice input

Fields
Input Field Description
cufe - String!

Document's CUFE according to the DIAN's standard.

  • Mandatory: optional
Example
{"cufe": "xyz789"}

ReceptionData

Description

Defines the response object for a Reception Data

Fields
Field Name Description
creditNote - decimal Amount of documents of type credit note.
debitNote - decimal Amount of documents of type debit note.
einvoice - decimal Amount of documents of type einvoice.
tituloValorEvents - decimal Amount of documents of type titulo valor events.
Example
{
  "creditNote": decimal,
  "debitNote": decimal,
  "einvoice": decimal,
  "tituloValorEvents": decimal
}

ReceptionDataInput

Description

Structure that defines all the necessary information for a Reception Data

Fields
Input Field Description
creditNote - decimal

Amount of documents of type credit note.

  • Mandatory: required
debitNote - decimal

Amount of documents of type debit note.

  • Mandatory: required
einvoice - decimal

Amount of documents of type einvoice.

  • Mandatory: required
tituloValorEvents - decimal

Amount of documents of type titulo valor events.

  • Mandatory: required
Example
{
  "creditNote": decimal,
  "debitNote": decimal,
  "einvoice": decimal,
  "tituloValorEvents": decimal
}

ReferenceTypeCode

Description

Type of referenced document

Values
Enum Value Description

CONTINGENCY_INVOICE

Electronic Contingency Invoice

CREDIT_NOTE

Electronic Credit Note

DEBIT_NOTE

Electronic Debit Note

DESPATCH_DOCUMENT

Invoice shipping documents

ELECTRONIC_INVOICE

Electronic Invoice

EXPORT_INVOICE

Electronic Invoice

ORDER_REFERENCE

A purchase order for an invoice

OTHER_DOCUMENT

Another type of document, other than those mentioned above

RECEIPT_DOCUMENT

Invoice recepit documents
Example
"CONTINGENCY_INVOICE"

ReferenceTypeOutput

Description

Defines the response object for the reference type

Fields
Field Name Description
code - String A code signifying the reference type.
description - String The description or meaning of reference type.
Example
{
  "code": "xyz789",
  "description": "xyz789"
}

Report

Description

Defines the response object for a Report type

Fields
Field Name Description
creationDate - DateTime Report creation date in the system.
credits - Int The amount of credits.
date - Date The date the report was generated
emissionConsumed - EmissionData Structure for the Emission Consumed data.
emissionCreditsConsumed - EmissionData Structure for the Emission Consumed data with credits.
emissionTotalCredits - Int The emission credits consumed.
insertedAt - DateTime Date and time at which the account statement was inserted.
percentageTotalCreditsConsumed - Float The percentage of credits consumed.
receptionConsumed - ReceptionData Structure for the Reception Consumed data.
receptionCreditsConsumed - ReceptionData Structure for the Reception Consumed data with credits.
receptionTotalCredits - Int The reception credits consumed.
reportId - String The report ID
totalCreditsConsumed - Int The total credits consumed.
updatedAt - DateTime Date and time at which the account statement was updated.
Example
{
  "creationDate": "2007-12-03T10:15:30Z",
  "credits": 123,
  "date": "2007-12-03",
  "emissionConsumed": EmissionData,
  "emissionCreditsConsumed": EmissionData,
  "emissionTotalCredits": 123,
  "insertedAt": "2007-12-03T10:15:30Z",
  "percentageTotalCreditsConsumed": 123.45,
  "receptionConsumed": ReceptionData,
  "receptionCreditsConsumed": ReceptionData,
  "receptionTotalCredits": 987,
  "reportId": "xyz789",
  "totalCreditsConsumed": 123,
  "updatedAt": "2007-12-03T10:15:30Z"
}

ResponsibilityCode

Description

Economic activities code

Values
Enum Value Description

A_01

International freight forwarder.

A_02

Shipping agent.

A_03

General bonded warehouse.

A_04

International trading company (C.I.).

A_05

Trader of the special customs zone of Inírida, Puerto Carreño, Cumaribo and Primavera.

A_06

Traders in the special customs zone of Leticia.

A_07

Traders of the special customs regime zone of Maicao, Uribia and Manaure.

A_08

Traders in the special customs regime zone of Urabá, Tumaco and Guapí.

A_09

Merchants of the free port of San Andres, Providencia and Santa Catalina.

A_10

Public warehouse for international logistic support.

A_11

Private warehouse for industrial processing.

A_12

Private warehouse for transformation or assembly.

A_13

Free warehouse.

A_14

Private aeronautical warehouse.

A_15

Private warehouse for international distribution.

A_16

Private warehouse for on-board provisions for consumption and to take away.

A_17

Private warehouse for urgent shipments.

A_18

Private warehouse.

A_19

Public warehouse.

A_20

Public warehouse for international distribution.

A_21

Coffee exporter.

A_22

Exporter.

A_23

Importer.

A_24

Intermediary of postal traffic and express shipments.

A_25

Multimodal transport operator.

A_26

Customs brokerage company.

A_27

Port and dock owner of public or private service.

A_28

Carrier under the import and/or export regime.

A_29

National carrier for customs transit regime operations.

A_30

Commercial user free zone.

A_32

Industrial user of goods free zone.

A_34

Industrial user of services free zone.

A_36

Free zone operator user.

A_37

Permanent customs user.

A_38

Highly exporting user.

A_39

User of special economic zones of export.

A_40

Private warehouse of industrial facilities.

A_41

Beneficiaries of special export programs PEX.

A_42

Private warehouses for goods in transit San Andres.

A_43

Observers of import operations.

A_44

Users of special import-export systems.

A_46

Maritime transporter - import and/or export regime.

A_47

Terrestrial transporter import and/or export regime.

A_48

Airport of responsibilitieso or private service.

A_49

Fluvial transporter import regime.

A_50

Industrial user special free zone.

A_53

Customs agencies 1.

A_54

User Operator Special Free Trade Zone.

A_55

Customs agencies 2.

A_56

Customs agencies 3.

A_57

Customs agencies 4.

A_58

National air transporter.

A_60

Air, maritime or fluvial transporter modality Cabotage.

A_61

Importer of food for human and animal consumption.

A_62

Occasional importer.

A_63

Importer of machinery and its parts Decree 2261 of 2012.

A_64

Beneficiary of the Automotive Industry Promotion Program-PROFIA.

A_99

Other type of customs agent.

E_01

Agency.

E_02

Establishment of commerce.

E_03

Agricultural exploitation center.

E_04

Animal exploitation center.

E_05

Center of mining exploitation.

E_06

Center of exploitation of transformation.

E_07

Center of exploitation of services.

E_08

Office.

E_09

Head office.

E_10

Branch office.

E_11

Office.

E_12

Administrations.

E_13

Sectional.

E_14

Regional.

E_15

Quartermaster's offices.

E_16

Local or business.

E_17

Point of sale.

E_18

Factory.

E_19

Workshop.

E_20

Quarry.

E_21

Oil and gas well.

E_22

Other lug of type of natural resource extraction.

E_99

Other type of establishment.

O_01

Special contribution for the administration of justice.

O_02

Tax on financial movements.

O_03

Tax on patrimony.

O_04

Income and complementary tax special regime.

O_05

Income tax and complementary tax ordinary regime.

O_06

Income and equity.

O_07

Income withholding at source.

O_08

National stamp withholding.

O_09

Sales tax withholding at source.

O_10

Customs obligee.

O_11

Sales under the common regime.

O_12

Sales under the simplified regime.

O_13

Large taxpayer.

O_14

Exogenous informant.

O_15

Self-withholding taxpayer.

O_16

Obligation to invoice for income from excluded goods and/or services.

O_17

Professionals of purchase and sale of foreign currency.

O_18

Transfer pricing.

O_19

Producer of exempt goods and/or services (including exporters).

O_20

Obtaining NIT Decree 3050 of 1997 (Art. 3).

O_21

To declare the entry or exit of foreign currency or legal currency from the country.

O_22

Obliged to declare on behalf of third parties.

O_23

VAT Withholding Agent.

O_24

Consolidated declaration of transfer prices.

O_26

Individual declaration of transfer prices.

O_32

National Tax on Gasoline and ACPM.

O_33

National consumption tax.

O_35

Income tax for equity CREE.

O_36

Permanent establishment.

O_37

Customers selected by resolution of the General Director as obliged to invoice electronically.

O_38

Obliged to Invoice Electronically.

O_39

PST Technological Services Provider.

O_40

Wealth Tax.

O_41

Annual declaration of assets abroad.

O_42

Obliged to Keep Accounting.

O_47

Simple Taxation Regime.

O_48

Sales tax.

O_49

Not responsible for VAT.

O_50

Not responsible for consumption in restaurants and bars.

O_51

Real estate consumption tax withholding agent.

O_52

Electronic biller.

O_99

Other type of obligee.

R_99_PN

Not responsible.
Example
"A_01"

SaleDebitNoteInput

Description

Structure that defines all the necessary information for a Debit Note.

Fields
Input Field Description
documentLines - [DocumentLineInput!]!

Input with information concerning products within the document.

  • Mandatory: required
  • Length: [1-n]
documentModifiers - [AllowanceChargeInput]

Input where discount's or charges are found.

  • Mandatory: optional
  • Length: [0-n]
documentTotals - LegalMonetaryTotalInput!

The total amount payable, including allowances, charges, and taxes.

  • Mandatory: required
generalInformation - DebitNoteGeneralInformationInput!

Document's general information.

  • Mandatory: required
id - DocumentConsecutiveInput!

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: required
invoiceToModify - InvoiceIdInput!

This structure stores the consecutive and the ID of the invoice to be modified.

  • Mandatory: required
issuerSoftwareSystem - IssuerSoftwareSystem

Additional information to inform the software system issuing the document.

  • Mandatory: optional
notes - [DocumentNotes]

Additional information: Free text, related to the document.

  • Mandatory: optional
  • Length: [1-n]
organizationalUnitId - UID!

Organizational Unit's Id.

  • Mandatory: required
paymentDescription - DocumentPaymentDescriptorInput!

Document's Payment Description.

  • Mandatory: required
referencedDocuments - [DocumentReferenceInput]

Additional Documents referenced inside the document

  • Mandatory: optional
  • Length: [0-n]
taxDescription - [TaxTotalInput]

Structure with the information of the total amount of tax, like: the withholding tax, the total tax amount, etc.

  • Mandatory: optional
  • Length: [0-n]
withholdingsDescription - [WithholdingTotalInput!]

The total amount of tax.

  • Mandatory: optional
  • Length: [1-n]
Example
{
  "documentLines": [DocumentLineInput],
  "documentModifiers": [AllowanceChargeInput],
  "documentTotals": LegalMonetaryTotalInput,
  "generalInformation": DebitNoteGeneralInformationInput,
  "id": DocumentConsecutiveInput,
  "invoiceToModify": InvoiceIdInput,
  "issuerSoftwareSystem": IssuerSoftwareSystem,
  "notes": [DocumentNotes],
  "organizationalUnitId": UID,
  "paymentDescription": DocumentPaymentDescriptorInput,
  "referencedDocuments": [DocumentReferenceInput],
  "taxDescription": [TaxTotalInput],
  "withholdingsDescription": [WithholdingTotalInput]
}

SalePointCashierDescriptorInput

Description

Structure that characterizes a sale poitn cashier

Fields
Input Field Description
cashierName - NaturalPersonNameInput!

Sale Point ID

  • Mandatory: required
Example
{"cashierName": NaturalPersonNameInput}

SalePointExtensionInput

Description

Structure that defines all the necessary information for the POS Invoice extension

Fields
Input Field Description
saleCode - String!

Identification code of the current sale.

  • Mandatory: required
salePointCashier - SalePointCashierDescriptorInput!

Sale Point cashier/seller's descrition

  • Mandatory: required
salePointId - String!

Sale Point ID or code to identify the sale point by the seller.

  • Mandatory: required
salePointLocation - PhysicalLocationInput!

Sale point address.

  • Mandatory: required
salePointType - String!

Sale Point Type.

  • Mandatory: required
saleSubtotal - decimal!

Sale's subtotal.

  • Mandatory: required
Example
{
  "saleCode": "xyz789",
  "salePointCashier": SalePointCashierDescriptorInput,
  "salePointId": "xyz789",
  "salePointLocation": PhysicalLocationInput,
  "salePointType": "abc123",
  "saleSubtotal": decimal
}

ShareHolderPartyInput

Description
Fields
Input Field Description
id - PersonIdInput!

An identifier for the share holder party.

  • Mandatory: required
name - PersonNameInput!

The name of the share holder party.
Here is the full name of the person or the corporate name, as applicable.

Example values:

  • For a natural person firstName and firstSurname are mandatory: Daniel Smith.
  • For a legal person: Cats Marketplace
  • Mandatory: required
participationPercent - Float!

The shareholder participation, expressed as a percentage.

  • Mandatory: required
  • Range: 0.0001-100.00
physicalLocation - PhysicalLocationInput

The physical location of this party.

  • Mandatory: optional
Example
{
  "id": PersonIdInput,
  "name": PersonNameInput,
  "participationPercent": 987.65,
  "physicalLocation": PhysicalLocationInput
}

Shareholder

Description

Structure for the shareholder

Fields
Field Name Description
identification - PersonId An identifier for the share holder party.
name - PersonName The name of the share holder party.
participationPercent - Float The shareholder participation, expressed as a percentage.
physicalLocation - PhysicalLocation The physical location of this party.
Example
{
  "identification": PersonId,
  "name": PersonName,
  "participationPercent": 987.65,
  "physicalLocation": PhysicalLocation
}

StandardItemIdCode

Description

DIAN's Standard

Values
Enum Value Description

GTIN

Global Product Identification Numbers - GTIN

TARIFF_ITEM

Tariff item according to tax statute

TAXPAYER_STANDARD

Contributor adoption standard

UNSPSC

Colombia Compra Eficiente: use the content of the column "Code"
Example
"GTIN"

StatusDescriptor

Description

Defines the response object for the status description.

For more information go to the following link.

Fields
Field Name Description
code - String An status code
description - String The description or meaning of the status code.
Example
{
  "code": "xyz789",
  "description": "abc123"
}

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"

StringBase64

Description

The StringBase64 scalar type represents a file encoded in base64

Example
StringBase64

SubTypeCode

Description

Defines the response object for the document subtype

Fields
Field Name Description
code - String The document subtype code.
description - String The description or meaning of the document subtype code.
Example
{
  "code": "abc123",
  "description": "xyz789"
}

TacitAcceptanceEventInput

Description

Invoice tacitly accepted by isser.

Fields
Input Field Description
additionalDocuments - [FileInput]

Additional files related to the delivery of the goods.

  • Mandatory: optional
  • Length: [0-n]
eventNotes - [NoteField]

Additional named notes for the event. Each note requires a name or concept.

  • Mandatory: optional
id - EventIdInput!

The unique identifier of an Event.

  • Mandatory: required
issueDate - DateTime!

Date and time of the event issuance

  • Mandatory: required
issuerParty - EventPartyInput

Description of the person/entity who received the event

  • Mandatory: optional
saleInvoiceUid - UID!

The unique identifier of an already created Sale Invoice.

  • Mandatory: required
Example
{
  "additionalDocuments": [FileInput],
  "eventNotes": [NoteField],
  "id": EventIdInput,
  "issueDate": "2007-12-03T10:15:30Z",
  "issuerParty": EventPartyInput,
  "saleInvoiceUid": UID
}

TaxCode

Description

Document taxes

Values
Enum Value Description

CO_01

IVA: Sales tax

CO_02

IC: Nominal Departmental Excise Tax

CO_03

ICA: Industry, Commerce and Notice Tax

CO_04

INC: National Excise Tax

CO_08

IC Porcentual: Departmental Excise Tax Percentage

CO_20

FtoHorticultura: Hortifrutícula Development Quota

CO_21

Timbre: Stamp Tax

CO_22

INC Bolsas: National Excise Tax on Plastic Bags

CO_23

INCarbono: National Carbon Tax

CO_24

INCombustibles: National Fuel Tax

CO_25

Sobretasa Combustibles: Fuel surcharge

CO_26

Retail contribution (Fuels)

CO_30

Data Consumption Tax

CO_ZZ

Another tribute or contribution
Example
"CO_01"

TaxNameOutput

Description

Defines the response object for the tax name

Fields
Field Name Description
code - String A code signifying the document taxes.
description - String The description or meaning of the tax.
Example
{
  "code": "abc123",
  "description": "abc123"
}

TaxScheme

Description

Defines the response object for the tax scheme

Fields
Field Name Description
code - String A code signifying the document taxes.
description - String The description or meaning of the tax code.
Example
{
  "code": "abc123",
  "description": "abc123"
}

TaxSchemeCode

Description

Tax scheme code

Values
Enum Value Description

CO_01

Code for IVA or VAT (Value Added Tax)

CO_04

Code for INC(National Consumption Tax)

CO_ZA

Code for IVA & INC

CO_ZZ

"Not applicable" Used in cases where the Issuer/Acquirer does not have the tax details reported in the first three codes
Example
"CO_01"

TaxSubtotal

Description

Structure that defines the One of the subtotals, the sum of which equals the total tax amount for a particular taxation scheme

Fields
Field Name Description
baseUnitMeasureCode - UnitCodeOutput Fixed Taxes Base unit of measure code for the tax - Used in case the tax is a fixed value per unit taxed: report the unit code of the taxed items
baseUnitMeasureQuantity - decimal Fixed Taxes Base unit of measure quantity for the tax - Used in case the tax is a fixed value per unit taxed: report the total of taxed items
perUnitAmount - decimal It is the nominal value of the tax per unit.
percent - Float The tax rate for this category, expressed as a percentage
taxAmount - decimal The amount of this tax subtotal.
taxableAmount - decimal The net amount to which the tax percent (rate) is applied to calculate the tax amount.
Example
{
  "baseUnitMeasureCode": UnitCodeOutput,
  "baseUnitMeasureQuantity": decimal,
  "perUnitAmount": decimal,
  "percent": 987.65,
  "taxAmount": decimal,
  "taxableAmount": decimal
}

TaxSubtotalInput

Description

Structure that defines all the necessary information for the tax subtotal

Fields
Input Field Description
baseUnitMeasureCode - UnitCode

Fixed Taxes Base unit of measure for the tax - Used in case the tax is a fixed value per unit taxed: report the type of unit taxed.

  • Mandatory: optional
baseUnitMeasureQuantity - decimal

Fixed Taxes Base unit of measure for the tax - Used in case the tax is a fixed value per unit taxed: report the total of taxed items.

  • Mandatory: optional
  • Range: It must have between 0 and 2 positions, with between 0 and 2 decimal places.
perUnitAmount - decimal

It is the nominal value of the tax per unit.

  • Mandatory: optional
  • Range: It must have between 0 and 15 positions, with between 0 and 2 decimal places
percent - Float

The tax rate for this category, expressed as a percentage.

  • Mandatory: required
  • Range: It must have between 0 and 5 positions, with between 0 and 3 decimal places(0.0001-100.000)
taxAmount - decimal!

Value of the tax: product of the percentage applied to the taxable base.

  • Mandatory: required
  • Range: It must have between 0 and 15 positions, with between 0 and 6 decimal places
taxableAmount - decimal

Taxable base on which the value of the tax is calculated.

  • Mandatory: required
  • Range: It must have between 0 and 15 positions, with between 0 and 6 decimal places
Example
{
  "baseUnitMeasureCode": "CO_04",
  "baseUnitMeasureQuantity": decimal,
  "perUnitAmount": decimal,
  "percent": 123.45,
  "taxAmount": decimal,
  "taxableAmount": decimal
}

TaxTotal

Description

Structure for he total amount of a specific type of tax.

Fields
Field Name Description
roundingAmount - decimal The rounding amount (positive or negative) added to the calculated tax total to produce the rounded TaxAmount.
taxAmount - decimal The total tax amount for a particular taxation scheme.
taxName - TaxNameOutput Structure with the selected tax
taxSubtotal - [TaxSubtotal] One of the subtotals the sum of which equals the total tax amount for a particular taxation scheme.
Example
{
  "roundingAmount": decimal,
  "taxAmount": decimal,
  "taxName": TaxNameOutput,
  "taxSubtotal": [TaxSubtotal]
}

TaxTotalInput

Description

Structure that defines all the necessary information for the total amount of a specific type of tax

Fields
Input Field Description
roundingAmount - decimal

The rounding amount (positive or negative) added to the calculated tax total to produce the rounded TaxAmount.

  • Mandatory: required
  • Range: It must have between 0 and 15 positions, with between 0 and 6 decimal places
taxAmount - decimal!

The total tax amount for a particular taxation scheme.

  • Mandatory: required
  • Range: It must have between 0 and 15 positions, with between 0 and 6 decimal places
taxConcept - String

The tribute's concept. Use only when the taxName is CO_ZZ which is used for other tributes.

  • Mandatory: optional
  • Length: 3-100
taxName - TaxCode!

The name of this tax category. (Example value: IVA)

  • Mandatory: required
taxSubtotal - [TaxSubtotalInput!]!

One of the subtotals, the sum of which equals the total tax amount for a particular taxation scheme.

  • Mandatory: required
  • Length: [1-n]
Example
{
  "roundingAmount": decimal,
  "taxAmount": decimal,
  "taxConcept": "abc123",
  "taxName": "CO_01",
  "taxSubtotal": [TaxSubtotalInput]
}

Time

Description

The Time scalar type represents a time, the format is HH:mm:ss

Example
"10:15:30Z"

Transaction

Description

Structure for a transaction

Fields
Field Name Description
application - String Transaction application.
applicationResponse - String Transaction application response.
documentId - String The document ID.
insertedAt - DateTime Date when the transaction was inserted.
requestedAt - DateTime Date when the transaction was requested.
respondedAt - DateTime Date when the transaction was responded.
transactionChannel - String Transaction channel.
transactionFrom - String Transaction inital date.
transactionId - String The transaction ID.
transactionStage - String Transaction stage.
transactionStatus - TransactionStatus Transaction status.
transactionTo - String Transaction end date.
transactionType - String The transaction type.
updatedAt - DateTime Date when the transaction was updated.
Example
{
  "application": "abc123",
  "applicationResponse": "xyz789",
  "documentId": "abc123",
  "insertedAt": "2007-12-03T10:15:30Z",
  "requestedAt": "2007-12-03T10:15:30Z",
  "respondedAt": "2007-12-03T10:15:30Z",
  "transactionChannel": "abc123",
  "transactionFrom": "xyz789",
  "transactionId": "xyz789",
  "transactionStage": "xyz789",
  "transactionStatus": TransactionStatus,
  "transactionTo": "xyz789",
  "transactionType": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z"
}

TransactionConnection

Description

Defines the response object for a query to list transactions.

Fields
Field Name Description
edges - [TransactionEdge] Used to select the fields that you want to retrieve from each edge in the connection.
pageCursors - PageCursors Returns the structure with the pagination of the search results.
pageInfo - PageInfo Returns details about the current page of results.
totalCount - Int Total number of records in the table taking into account the filters applied.
totalPages - Int Total number of pages under the filters set by the user.
Example
{
  "edges": [TransactionEdge],
  "pageCursors": PageCursors,
  "pageInfo": PageInfo,
  "totalCount": 987,
  "totalPages": 123
}

TransactionEdge

Description

Defines each edge, in this case transaction together with their cursor.

Fields
Field Name Description
cursor - String A marker for an edge's position in the connection.
node - Transaction The fields to be returned for each node.
Example
{
  "cursor": "xyz789",
  "node": Transaction
}

TransactionStatus

Description

Structure for a transaction status

Fields
Field Name Description
message - String Transaction message.
title - String Transaction status name.
warningsAndErrors - [String] List of warnings and errors
Example
{
  "message": "abc123",
  "title": "abc123",
  "warningsAndErrors": ["abc123"]
}

TransactionsOrderInput

Description

Code to identify the type of transaction ordering

Values
Enum Value Description

INSERTED_AT_ASC

Sort by inserted at in ascending order.

INSERTED_AT_DESC

Sort by inserted at in descending order.

REQUESTED_AT_ASC

Sort by requested at at in ascending order.

REQUESTED_AT_DESC

Sort by requested at in descending order.

RESPONDED_AT_ASC

Sort by responded at at in ascending order.

RESPONDED_AT_DESC

Sort by responded at in descending order.

SERIAL_ASC

Sort by serial in ascending order.

SERIAL_DESC

Sort by serial in descending order.
Example
"INSERTED_AT_ASC"

TransactionsQueryInput

Description

Structure that defines all the necessary information for a transaction query.

Fields
Input Field Description
documentUid - UID

The identificator of the document in the system, represented as an uuid or another identificator.

  • Mandatory: required
id - UID

The identificator of the transaction in the system, represented as an uuid or another identificator.

  • Mandatory: optional
Example
{"documentUid": UID, "id": UID}

UID

Description

It represents a unique identifier that is often used to retrieve an object or as a key for a cache. The UID can be: yabi-co UUID, Invoice ID or CUFE. A uuid as an string

Example
UID

UnitCode

Values
Enum Value Description

CO_04

Small spray

CO_05

lift

CO_08

heat lot

CO_10

group

CO_11

outfit

CO_13

ration

CO_14

shot

CO_15

stick, military

CO_16

hundred fifteen kg drum

CO_17

hundred lb drum

CO_18

fiftyfive gallon (US) drum

CO_19

tank truck

CO_1A

car mile

CO_1B

car count

CO_1C

locomotive count

CO_1D

caboose count

CO_1E

empty car

CO_1F

train mile

CO_1G

fuel usage gallon (US)

CO_1H

caboose mile

CO_1I

fixed rate

CO_1J

ton mile

CO_1K

locomotive mile

CO_1L

total car count

CO_1M

total car mile

CO_1X

quarter mile

CO_20

twenty foot container

CO_21

forty foot container

CO_22

decilitre per gram

CO_23

gram per cubic centimetre

CO_24

theoretical pound

CO_25

gram per square centimetre

CO_26

actual ton

CO_27

theoretical ton

CO_28

kilogram per square metre

CO_29

pound per thousand square feet

CO_2A

radian per second

CO_2B

radian per second squared

CO_2C

roentgen

CO_2I

British thermal unit per hour

CO_2J

cubic centimetre per second

CO_2K

cubic foot per hour

CO_2L

cubic foot per minute

CO_2M

centimetre per second

CO_2N

decibel

CO_2P

kilobyte

CO_2Q

kilobecquerel

CO_2R

kilocurie

CO_2U

megagram

CO_2V

megagram per hour

CO_2W

bin

CO_2X

metre per minute

CO_2Y

milliröntgen

CO_2Z

millivolt

CO_30

horse power day per air dry metric ton

CO_31

catch weight

CO_32

kilogram per air dry metric ton

CO_33

kilopas:cal square metres per gram

CO_34

kilopas:cals per millimetre

CO_35

millilitres per square centimetre second

CO_36

cubic feet per minute per square foot

CO_37

ounce per square foot

CO_38

ounces per square foot per 0,01inch

CO_3B

megajoule

CO_3C

manmonth

CO_3E

pound per pound of product

CO_3G

pound per piece of product

CO_3H

kilogram per kilogram of product

CO_3I

kilogram per piece of product

CO_40

millilitre per second

CO_41

millilitre per minute

CO_43

super bulk bag

CO_44

fivehundred kg bulk bag

CO_45

threehundred kg bulk bag

CO_46

fifty lb bulk bag

CO_47

fifty lb bag

CO_48

bulk car load

CO_4A

bobbin

CO_4B

cap

CO_4C

centistokes

CO_4E

twenty pack

CO_4G

microlitre

CO_4H

micrometre (micron)

CO_4K

milliampere

CO_4L

megabyte

CO_4M

milligram per hour

CO_4N

megabecquerel

CO_4O

microfarad

CO_4P

newton per metre

CO_4Q

ounce inch

CO_4R

ounce foot

CO_4T

picofarad

CO_4U

pound per hour

CO_4W

ton (US) per hour

CO_4X

kilolitre per hour

CO_53

theoretical kilograms

CO_54

theoretical tonne

CO_56

sitas:

CO_57

mesh

CO_58

net kilogram

CO_59

part per million

CO_5A

barrel (US) per minute

CO_5B

batch

CO_5C

gallon(US) per thousand

CO_5E

MMSCF/day

CO_5F

pounds per thousand

CO_5G

pump

CO_5H

stage

CO_5I

standard cubic foot

CO_5J

hydraulic horse power

CO_5K

count per minute

CO_5P

seismic level

CO_5Q

seismic line

CO_60

percent weight

CO_61

part per billion (US)

CO_62

percent per 1000 hour

CO_63

failure rate in time

CO_64

pound per square inch, gauge

CO_66

oersted

CO_69

test specific scale

CO_71

volt ampere per pound

CO_72

watt per pound

CO_73

ampere tum per centimetre

CO_74

millipas:cal

CO_76

gauss

CO_77

milli-inch

CO_78

kilogauss

CO_80

pounds per square inch absolute

CO_81

henry

CO_84

kilopound per square inch

CO_85

foot pound-force

CO_87

pound per cubic foot

CO_89

poise

CO_90

Saybold universal second

CO_91

stokes

CO_92

calorie per cubic centimetre

CO_93

calorie per gram

CO_94

curl unit

CO_95

twenty thousand gallon (US) tankcar

CO_96

ten thousand gallon (US) tankcar

CO_97

ten kg drum

CO_98

fifteen kg drum

CO_A1

15 °C calorie

CO_A10

ampere square metre per joule second

CO_A11

angstrom

CO_A12

as:tronomical unit

CO_A13

attojoule

CO_A14

barn

CO_A15

barn per electron volt

CO_A16

barn per steradian electronvolt

CO_A17

barn per steradian

CO_A18

becquerel per kilogram

CO_A19

becquerel per metre cubed

CO_A2

ampere per centimetre

CO_A20

British thermal unit per second square foot degree Rankin

CO_A21

British thermal unit per pound degree Rankin

CO_A22

British thermal unit per second foot degree Rankin

CO_A23

British thermal unit per hour square foot degree Rankin

CO_A24

candela per square metre

CO_A25

cheval vapeur

CO_A26

coulomb metre

CO_A27

coulomb metre squared per volt

CO_A28

coulomb per cubic centimetre

CO_A29

coulomb per cubic metre

CO_A3

ampere per millimetre

CO_A30

coulomb per cubic millimetre

CO_A31

coulomb per kilogram second

CO_A32

coulomb per mole

CO_A33

coulomb per square centimetre

CO_A34

coulomb per square metre

CO_A35

coulomb per square millimetre

CO_A36

cubic centimetre per mole

CO_A37

cubic decimetre per mole

CO_A38

cubic metre per coulomb

CO_A39

cubic metre per kilogram

CO_A4

ampere per square centimetre

CO_A40

cubic metre per mole

CO_A41

ampere per square metre

CO_A42

curie per kilogram

CO_A43

deadweight tonnage

CO_A44

decalitre

CO_A45

decametre

CO_A47

decitex

CO_A48

degree Rankin

CO_A49

denier

CO_A5

ampere square metre

CO_A50

dyne second per cubic centimetre

CO_A51

dyne second per centimetre

CO_A52

dyne second per centimetre to the fifth power

CO_A53

electronvolt

CO_A54

electronvolt per metre

CO_A55

electronvolt square metre

CO_A56

electronvolt square metre per kilogram

CO_A57

erg

CO_A58

erg per centimetre

CO_A6

ampere per square metre kelvin squared

CO_A60

erg per cubic centimetre

CO_A61

erg per gram

CO_A62

erg per gram second

CO_A63

erg per second

CO_A64

erg per second square centimetre

CO_A65

erg per square centimetre second

CO_A66

erg square centimetre

CO_A67

erg square centimetre per gram

CO_A68

exajoule

CO_A69

farad per metre

CO_A7

ampere per square millimetre

CO_A70

femtojoule

CO_A71

femtometre

CO_A73

foot per second squared

CO_A74

foot pound-force per second

CO_A75

freight ton

CO_A76

gal

CO_A77

Gaussian CGS unit of displacement

CO_A78

Gaussian CGS unit of electic current

CO_A79

Gaussian CGS unit of electric charge

CO_A8

ampere second

CO_A80

Gaussian CGS unit of electric field strength

CO_A81

Gaussian CGS unit of electric polarization

CO_A82

Gaussian CGS unit of electric potential

CO_A83

Gaussian CGS unit of magnetization

CO_A84

gigacoulomb per cubic metre

CO_A85

gigaelectronvolt

CO_A86

gigahertz

CO_A87

gigaohm

CO_A88

gigaohm metre

CO_A89

gigapas:cal

CO_A9

rate

CO_A90

gigawatt

CO_A91

gon

CO_A93

gram per cubic metre

CO_A94

gram per mole

CO_A95

gray

CO_A96

gray per second

CO_A97

hectopas:cal

CO_A98

henry per metre

CO_AA

ball

CO_AB

bulk pack

CO_ACR

acre

CO_AD

byte

CO_AE

ampere per metre

CO_AH

additional minute

CO_AI

average minute per call

CO_AJ

cop

CO_AK

fathom

CO_AL

access line

CO_AM

ampoule

CO_AMH

ampere hour

CO_AMP

ampere

CO_ANA

Year

CO_AP

aluminium pound only

CO_APZ

troy ounce or apothecary ounce

CO_AQ

anti-hemophilic factor (AHF) unit

CO_AR

suppository

CO_ATM

standard atmosphere

CO_ATT

technical atmosphere

CO_AV

capsule

CO_AW

powder filled vial

CO_AZ

British thermal unit per pound

CO_B0

Btu per cubic foot

CO_B1

barrel (US) per day

CO_B11

joule per kilogram kelvin

CO_B12

joule per metre

CO_B13

joule per metre squared

CO_B14

joule per metre to the fourth power

CO_B15

joule per mole

CO_B16

joule per mole kelvin

CO_B18

joule second

CO_B2

bunk

CO_B20

joule square metre per kilogram

CO_B21

kelvin per watt

CO_B22

kiloampere

CO_B23

kiloampere per square metre

CO_B24

kiloampere per metre

CO_B25

kilobecquerel per kilogram

CO_B26

kilocoulomb

CO_B27

kilocoulomb per cubic metre

CO_B28

kilocoulomb per square metre

CO_B29

kiloelectronvolt

CO_B3

batting pound

CO_B31

kilogram metre per second

CO_B32

kilogram metre squared

CO_B33

kilogram metre squared per second

CO_B34

kilogram per cubic decimetre

CO_B35

kilogram per litre

CO_B36

thermochemical calorie per gram

CO_B37

kilogram-force

CO_B38

kilogram-force metre

CO_B39

kilogram-force metre per second

CO_B4

barrel, imperial

CO_B40

kilogram-force per square metre

CO_B41

kilojoule per kelvin

CO_B42

kilojoule per kilogram

CO_B43

kilojoule per kilogram kelvin

CO_B44

kilojoule per mole

CO_B45

kilomole

CO_B46

kilomole per cubic metre

CO_B47

kilonewton

CO_B48

kilonewton metre

CO_B49

kiloohm

CO_B5

billet

CO_B50

kiloohm metre

CO_B51

kilopond

CO_B52

kilosecond

CO_B53

kilosiemens

CO_B54

kilosiemens per metre

CO_B55

kilovolt per metre

CO_B56

kiloweber per metre

CO_B57

light year

CO_B58

litre per mole

CO_B59

lumen hour

CO_B6

bun

CO_B60

lumen per square metre

CO_B61

lumen per watt

CO_B62

lumen second

CO_B63

lux hour

CO_B64

lux second

CO_B65

maxwell

CO_B66

megaampere per square metre

CO_B67

megabecquerel per kilogram

CO_B69

megacoulomb per cubic metre

CO_B7

cycle

CO_B70

megacoulomb per square metre

CO_B71

megaelectronvolt

CO_B72

megagram per cubic metre

CO_B73

meganewton

CO_B74

meganewton metre

CO_B75

megaohm

CO_B76

megaohm metre

CO_B77

megas:iemens per metre

CO_B78

megavolt

CO_B79

megavolt per metre

CO_B8

joule per cubic metre

CO_B81

reciprocal metre squared reciprocal second

CO_B83

metre to the fourth power

CO_B84

microampere

CO_B85

microbar

CO_B86

microcoulomb

CO_B87

microcoulomb per cubic metre

CO_B88

microcoulomb per square metre

CO_B89

microfarad per metre

CO_B9

batt

CO_B90

microhenry

CO_B91

microhenry per metre

CO_B92

micronewton

CO_B93

micronewton metre

CO_B94

microohm

CO_B95

microohm metre

CO_B96

micropas:cal

CO_B97

microradian

CO_B98

microsecond

CO_B99

microsiemens

CO_BAR

bar [unit of pressure]

CO_BB

bas:e box

CO_BD

board

CO_BFT

board foot

CO_BG

bag

CO_BH

brush

CO_BHP

brake horse power

CO_BIL

billion (EUR)

CO_BJ

bucket

CO_BK

bas:ket

CO_BL

bale

CO_BLD

dry barrel (US)

CO_BLL

barrel (US)

CO_BO

bottle

CO_BP

hundred board feet

CO_BQL

becquerel

CO_BR

bar [unit of packaging]

CO_BT

bolt

CO_BTU

British thermal unit

CO_BUA

bushel (US)

CO_BUI

bushel (UK)

CO_BW

bas:e weight

CO_BX

box

CO_BZ

million BTUs

CO_C0

call

CO_C1

composite product pound (total weight)

CO_C10

millifarad

CO_C11

milligal

CO_C12

milligram per metre

CO_C13

milligray

CO_C14

millihenry

CO_C15

millijoule

CO_C16

millimetre per second

CO_C17

millimetre squared per second

CO_C18

millimole

CO_C19

mole per kilogram

CO_C2

carset

CO_C20

millinewton

CO_C22

millinewton per metre

CO_C23

milliohm metre

CO_C24

millipas:cal second

CO_C25

milliradian

CO_C26

millisecond

CO_C27

millisiemens

CO_C28

millisievert

CO_C29

millitesla

CO_C3

microvolt per metre

CO_C30

millivolt per metre

CO_C31

milliwatt

CO_C32

milliwatt per square metre

CO_C33

milliweber

CO_C34

mole

CO_C35

mole per cubic decimetre

CO_C36

mole per cubic metre

CO_C38

mole per litre

CO_C39

nanoampere

CO_C4

carload

CO_C40

nanocoulomb

CO_C41

nanofarad

CO_C42

nanofarad per metre

CO_C43

nanohenry

CO_C44

nanohenry per metre

CO_C45

nanometre

CO_C46

nanoohm metre

CO_C47

nanosecond

CO_C48

nanotesla

CO_C49

nanowatt

CO_C5

cost

CO_C50

neper

CO_C51

neper per second

CO_C52

picometre

CO_C53

newton metre second

CO_C54

newton metre squared kilogram squared

CO_C55

newton per square metre

CO_C56

newton per square millimetre

CO_C57

newton second

CO_C58

newton second per metre

CO_C59

octave

CO_C6

cell

CO_C60

ohm centimetre

CO_C61

ohm metre

CO_C62

one

CO_C63

parsec

CO_C64

pas:cal per kelvin

CO_C65

pas:cal second

CO_C66

pas:cal second per cubic metre

CO_C67

pas:cal second per metre

CO_C68

petajoule

CO_C69

phon

CO_C7

centipoise

CO_C70

picoampere

CO_C71

picocoulomb

CO_C72

picofarad per metre

CO_C73

picohenry

CO_C75

picowatt

CO_C76

picowatt per square metre

CO_C77

pound gage

CO_C78

pound-force

CO_C8

millicoulomb per kilogram

CO_C80

rad

CO_C81

radian

CO_C82

radian square metre per mole

CO_C83

radian square metre per kilogram

CO_C84

radian per metre

CO_C85

reciprocal angstrom

CO_C86

reciprocal cubic metre

CO_C87

reciprocal cubic metre per second

CO_C88

reciprocal electron volt per cubic metre

CO_C89

reciprocal henry

CO_C9

coil group

CO_C90

reciprocal joule per cubic metre

CO_C91

reciprocal kelvin or kelvin to the power minus one

CO_C92

reciprocal metre

CO_C93

reciprocal metre squared

CO_C94

reciprocal minute

CO_C95

reciprocal mole

CO_C96

reciprocal pas:cal or pas:cal to the power minus one

CO_C97

reciprocal second

CO_C98

reciprocal second per cubic metre

CO_C99

reciprocal second per metre squared

CO_CA

can

CO_CCT

carrying capacity in metric ton

CO_CDL

candela

CO_CE

Each per month

CO_CEL

degree Celsius

CO_CEN

hundred

CO_CG

card

CO_CGM

centigram

CO_CH

container

CO_CJ

cone

CO_CK

connector

CO_CKG

coulomb per kilogram

CO_CL

coil

CO_CLF

hundred leave

CO_CLT

centilitre

CO_CMK

square centimetre

CO_CMQ

cubic centimetre

CO_CMT

centimetre

CO_CNP

hundred pack

CO_CNT

cental (UK)

CO_CO

carboy

CO_COMO

as:sortment

CO_COU

coulomb

CO_CQ

cartridge

CO_CR

crate

CO_CS

cas:e

CO_CT

carton

CO_CTM

metric carat

CO_CU

cup

CO_CUR

curie

CO_CV

cover

CO_CWA

hundred pounds (cwt) / hundred weight (US)

CO_CWI

hundred weight (UK)

CO_CY

cylinder

CO_CZ

combo

CO_D1

reciprocal second per steradian

CO_D10

siemens per metre

CO_D12

siemens square metre per mole

CO_D13

sievert

CO_D14

thousand linear yard

CO_D15

sone

CO_D16

square centimetre per erg

CO_D17

square centimetre per steradian erg

CO_D18

metre kelvin

CO_D19

square metre kelvin per watt

CO_D2

reciprocal second per steradian metre squared

CO_D20

square metre per joule

CO_D21

square metre per kilogram

CO_D22

square metre per mole

CO_D23

pen gram (protein)

CO_D24

square metre per steradian

CO_D25

square metre per steradian joule

CO_D26

square metre per volt second

CO_D27

steradian

CO_D28

syphon

CO_D29

terahertz

CO_D30

terajoule

CO_D31

terawatt

CO_D32

terawatt hour

CO_D33

tesla

CO_D34

tex

CO_D35

thermochemical calorie

CO_D37

thermochemical calorie per gram kelvin

CO_D38

thermochemical calorie per second centimetre kelvin

CO_D39

thermochemical calorie per second square centimetre kelvin

CO_D40

thousand litre

CO_D41

tonne per cubic metre

CO_D42

tropical year

CO_D43

unified atomic mas:s unit

CO_D44

var The name of the unit is an acronym for volt-ampere-reactive.

CO_D45

volt squared per kelvin squared

CO_D46

volt - ampere

CO_D47

volt per centimetre

CO_D48

volt per kelvin

CO_D49

millivolt per kelvin

CO_D5

kilogram per square centimetre

CO_D50

volt per metre

CO_D51

volt per millimetre

CO_D52

watt per kelvin

CO_D53

watt per metre kelvin

CO_D54

watt per square metre

CO_D55

watt per square metre kelvin

CO_D56

watt per square metre kelvin to the fourth power

CO_D57

watt per steradian

CO_D58

watt per steradian square metre

CO_D59

weber per metre

CO_D6

roentgen per second

CO_D60

weber per millimetre

CO_D61

minute [unit of angle]

CO_D62

second [unit of angle]

CO_D63

book

CO_D64

block

CO_D65

round

CO_D66

cas:sette

CO_D67

dollar per hour

CO_D69

inch to the fourth power

CO_D7

sandwich

CO_D70

International Table (IT) calorie

CO_D71

International Table (IT) calorie per second centimetre kelvin

CO_D72

International Table (IT) calorie per second square centimetre kelvin

CO_D73

joule square metre

CO_D74

kilogram per mole

CO_D75

International Table (IT)calorie per gram

CO_D76

International Table (IT) calorie per gram kelvin

CO_D77

megacoulomb

CO_D79

beam

CO_D8

draize score

CO_D80

microwatt

CO_D81

microtesla

CO_D82

microvolt

CO_D83

millinewton metre

CO_D85

microwatt per square metre

CO_D86

millicoulomb

CO_D87

millimole per kilogram

CO_D88

millicoulomb per cubic metre

CO_D89

millicoulomb per square metre

CO_D9

dyne per square centimetre

CO_D90

cubic metre (net)

CO_D91

rem

CO_D92

band

CO_D93

second per cubic metre

CO_D94

second per radian cubic metre

CO_D95

joule per gram

CO_D96

pound gross

CO_D97

pallet/unit load

CO_D98

mas:s pound

CO_D99

sleeve

CO_DAA

decare

CO_DAD

ten day

CO_DAY

day

CO_DB

dry pound

CO_DC

disk (disc)

CO_DD

degree

CO_DE

deal

CO_DEC

decade

CO_DG

decigram

CO_DI

dispenser

CO_DJ

decagram

CO_DLT

decilitre

CO_DMK

square decimetre

CO_DMQ

cubic decimetre

CO_DMT

decimetre

CO_DN

decinewton metre

CO_DPC

dozen piece

CO_DPR

dozen pair

CO_DPT

displacement tonnage

CO_DQ

data record

CO_DR

drum

CO_DRA

dram (US)

CO_DRI

dram (UK)

CO_DRL

dozen roll

CO_DRM

drachm (UK)

CO_DS

display

CO_DT

dry ton

CO_DTN

centner, metric 100 kg

CO_DU

dyne

CO_DWT

pennyweight

CO_DX

dyne per centimetre

CO_DY

directory book

CO_DZN

dozen

CO_DZP

dozen pack

CO_E2

belt

CO_E3

trailer

CO_E4

gross kilogram

CO_E5

metric long ton

CO_EA

each

CO_EB

electronic mail box

CO_EL

Hundredth of a carat

CO_EN

Ounce per square yard

CO_EP

eleven pack

CO_EQ

equivalent gallon

CO_EV

envelope

CO_F1

thousand cubic feet per day

CO_F9

fibre per cubic centimetre of air

CO_FAH

degree Fahrenheit

CO_FAR

farad

CO_FB

field

CO_FC

thousand cubic feet

CO_FD

million particle per cubic foot

CO_FE

track foot

CO_FF

hundred cubic metre

CO_FG

transdermal patch

CO_FH

micromole

CO_FL

flake ton

CO_FM

million cubic feet

CO_FOT

foot

CO_FP

pound per square foot

CO_FR

foot per minute

CO_FS

foot per second

CO_FTK

square foot

CO_FTQ

cubic foot

CO_G2

US gallon per minute

CO_G3

Imperial gallon per minute

CO_G7

microfiche sheet

CO_GB

gallon (US) per day

CO_GBQ

gigabecquerel

CO_GC

gram per 100 gram

CO_GD

gross barrel

CO_GE

pound per gallon (US)

CO_GF

gram per metre (gram per 100 centimetres)

CO_GFI

gram of fissile isotope

CO_GGR

great gross

CO_GH

half gallon (US)

CO_GIA

gill (US)

CO_GII

gill (UK)

CO_GJ

gram per millilitre

CO_GK

gram per kilogram

CO_GL

gram per litre

CO_GLD

dry gallon (US)

CO_GLI

gallon (UK)

CO_GLL

gallon (US)

CO_GM

gram per square metre

CO_GN

gross gallon

CO_GO

milligrams per square metre

CO_GP

milligram per cubic metre

CO_GQ

microgram per cubic metre

CO_GRM

gram

CO_GRN

grain

CO_GRO

gross

CO_GRT

gross register ton

CO_GT

gross ton

CO_GV

gigajoule

CO_GW

gallon per thousand cubic feet

CO_GWH

gigawatt hour

CO_GY

gross yard

CO_GZ

gage system

CO_H1

half page – electronic

CO_H2

half litre

CO_HA

hank A unit of length, typically for yarn.

CO_HAR

hectare

CO_HBA

hectobar

CO_HBX

hundred boxes

CO_HC

hundred count

CO_HD

half dozen

CO_HF

hundred feet

CO_HGM

hectogram

CO_HH

hundred cubic feet

CO_HI

hundred sheet

CO_HIU

hundred international unit

CO_HJ

metric horse power

CO_HK

hundred kilogram

CO_HL

hundred feet (linear)

CO_HLT

hectolitre

CO_HM

mile per hour

CO_HMQ

million cubic metre

CO_HMT

hectometre

CO_HN

conventional millimetre of mercury

CO_HO

hundred troy ounce

CO_HP

conventional millimetre of water

CO_HPA

hectolitre of pure alcohol

CO_HS

hundred square feet

CO_HT

half hour

CO_HTZ

hertz

CO_HUR

hour

CO_HY

hundred yard

CO_IA

inch pound (pound inch)

CO_IC

count per inch

CO_IE

person

CO_IF

inches of water

CO_II

column inch

CO_IL

inch per minute

CO_IM

impression

CO_INH

inch

CO_INK

square inch

CO_INQ

cubic inch

CO_IP

insurance policy

CO_IT

count per centimetre

CO_ITS

stone (UK)

CO_IU

inch per second

CO_IV

inch per second squared

CO_J2

joule per kilogram

CO_JB

jumbo

CO_JE

joule per kelvin

CO_JG

jug

CO_JK

megajoule per kilogram

CO_JM

megajoule per cubic metre

CO_JO

joint

CO_JOU

joule

CO_JR

jar

CO_K1

kilowatt demand

CO_K2

kilovolt ampere reactive demand

CO_K3

kilovolt ampere reactive hour

CO_K5

kilovolt ampere (reactive)

CO_K6

kilolitre

CO_KA

cake

CO_KB

kilocharacter

CO_KBA

kilobar

CO_KD

kilogram decimal

CO_KEL

kelvin

CO_KF

kilopacket

CO_KG

keg

CO_KGM

kilogram

CO_KGS

kilogram per second

CO_KHZ

kilohertz

CO_KI

kilogram per millimetre width

CO_KJ

kilosegment

CO_KJO

kilojoule

CO_KL

kilogram per metre

CO_KMH

kilometre per hour

CO_KMK

square kilometre

CO_KMQ

kilogram per cubic metre

CO_KNI

kilogram of nitrogen

CO_KNS

kilogram named substance

CO_KNT

knot

CO_KO

milliequivalence caustic potas:h per gram of product

CO_KPA

kilopas:cal

CO_KPH

kilogram of potas:sium hydroxide (caustic potas:h)

CO_KPO

kilogram of potas:sium oxide

CO_KPP

kilogram of phosphorus pentoxide (phosphoric anhydride)

CO_KR

kiloroentgen

CO_KS

thousand pound per square inch

CO_KSD

kilogram of substance 90 % dry

CO_KSH

kilogram of sodium hydroxide (caustic soda)

CO_KT

kit

CO_KTM

kilometre

CO_KTN

kilotonne

CO_KUR

kilogram of uranium

CO_KVA

kilovolt - ampere

CO_KVR

kilovar

CO_KVT

kilovolt

CO_KW

kilograms per millimetre

CO_KWH

kilowatt hour

CO_KWT

kilowatt

CO_KX

millilitre per kilogram

CO_L2

litre per minute

CO_LA

pound per cubic inch

CO_LBR

pound

CO_LBT

troy pound (US)

CO_LC

linear centimetre

CO_LD

litre per day

CO_LE

lite

CO_LEF

leaf

CO_LF

linear foot

CO_LH

labour hour

CO_LI

linear inch

CO_LJ

large spray

CO_LK

link

CO_LM

linear metre

CO_LN

length

CO_LO

lot [unit of procurement]

CO_LP

liquid pound

CO_LPA

litre of pure alcohol

CO_LR

layer

CO_LS

lump sum

CO_LTN

ton (UK) or long ton (US)

CO_LTR

litre

CO_LUM

lumen

CO_LUN

Month

CO_LUX

lux

CO_LX

linear yard per pound

CO_LY

linear yard

CO_M0

magnetic tape

CO_M1

milligram per litre

CO_M4

monetary value

CO_M5

microcurie

CO_M7

micro-inch

CO_M9

million Btu per 1000 cubic feet

CO_MA

machine per unit

CO_MAL

mega litre

CO_MAM

megametre

CO_MAW

megawatt

CO_MBE

thousand standard brick equivalent

CO_MBF

thousand board feet

CO_MBR

millibar

CO_MC

microgram

CO_MCU

millicurie

CO_MD

air dry metric ton

CO_MF

milligram per square foot per side

CO_MGM

milligram

CO_MIK

square mile

CO_MIL

thousand

CO_MIN

minute [unit of time]

CO_MIO

million

CO_MIU

million international unit

CO_MK

milligram per square inch

CO_MLD

billion (US)

CO_MLT

millilitre

CO_MMK

square millimetre

CO_MMQ

cubic millimetre

CO_MMT

millimetre

CO_MNI

Nautical mile

CO_MPA

megapas:cal

CO_MQ

thousand metre

CO_MQH

cubic metre per hour

CO_MQS

cubic metre per second

CO_MSK

metre per second squared

CO_MT

mat

CO_MTK

square metre

CO_MTQ

cubic metre

CO_MTR

metre

CO_MTS

metre per second

CO_MV

number of mults

CO_MVA

megavolt - ampere

CO_MWH

megawatt hour (1000 kW.h)

CO_N1

pen calorie

CO_N2

number of lines

CO_N3

print point

CO_NA

milligram per kilogram

CO_NAR

number of articles

CO_NB

barge

CO_NBB

number of bobbins

CO_NC

car

CO_NCL

number of cells

CO_ND

net barrel

CO_NE

net litre

CO_NEW

newton

CO_NF

message

CO_NG

net gallon (us)

CO_NH

message hour

CO_NI

net imperial gallon

CO_NIU

number of international units

CO_NJ

number of screens

CO_NL

load

CO_NMP

number of packs

CO_NN

train

CO_NPL

Number of parcels

CO_NPR

Number of pairs

CO_NQ

mho

CO_NR

micromho

CO_NRL

number of rolls

CO_NT

metric net ton

CO_NTT

net register ton

CO_NU

newton metre

CO_NV

vehicle

CO_NX

part per thousand

CO_NY

pound per air dry metric ton

CO_OA

panel

CO_OCS

Score

CO_OHM

ohm

CO_ONZ

ounce

CO_OP

two pack

CO_OT

overtime hour

CO_OZA

fluid ounce (US)

CO_OZI

fluid ounce (UK)

CO_P0

page - electronic

CO_P1

percent

CO_P2

pound per foot

CO_P3

three pack

CO_P4

four pack

CO_P5

five pack

CO_P6

six pack

CO_P7

seven pack

CO_P8

eight pack

CO_P9

nine pack

CO_PA

packet

CO_PAL

pas:cal

CO_PB

pair inch

CO_PD

pad

CO_PE

pound equivalent

CO_PF

pallet (lift)

CO_PG

plate

CO_PGL

proof gallon

CO_PI

Pitch

CO_PK

pack

CO_PL

pail

CO_PM

pound percentage

CO_PN

pound net

CO_PO

pound per inch of length

CO_PQ

page per inch

CO_PR

pair

CO_PT

pint (US)

CO_PTD

dry pint (US)

CO_PTI

pint (UK)

CO_PTL

liquid pint (US)

CO_PU

tray / tray pack

CO_PV

half pint (US)

CO_PW

pound per inch of width

CO_PY

peck dry (US)

CO_PZ

peck dry (UK)

CO_Q3

meal

CO_QA

page – facsimile

CO_QAN

quarter (of a year)

CO_QB

page – hardcopy

CO_QD

quarter dozen

CO_QH

quarter hour

CO_QK

quarter kilogram

CO_QR

quire

CO_QT

quart (US)

CO_QTD

dry quart (US)

CO_QTI

quart (UK)

CO_QTL

liquid quart (US)

CO_QTR

quarter (UK)

CO_R1

pica

CO_R4

calorie

CO_R9

thousand cubic metre

CO_RA

rack

CO_RD

rod

CO_RG

ring

CO_RH

running or operating hour

CO_RK

roll metric meas:ure

CO_RL

reel

CO_RM

ream

CO_RN

ream metric meas:ure

CO_RO

roll

CO_RP

pound per ream

CO_RPM

revolutions per minute

CO_RPS

revolutions per second

CO_RS

reset

CO_RT

revenue ton mile

CO_RU

run

CO_S3

foot squared per second

CO_S4

metre squared per second (square metres/second US)

CO_S5

sixty fourths of an inch

CO_S6

session

CO_S7

storage unit

CO_S8

standard advertising unit

CO_SA

sack

CO_SAN

half year (6 months)

CO_SCR

scruple

CO_SD

solid pound

CO_SE

section

CO_SEC

second [unit of time]

CO_SER

Haz

CO_SET

set

CO_SG

segment

CO_SHT

shipping ton

CO_SI

as:sembly

CO_SIE

siemens

CO_SK

split tank truck

CO_SL

slipsheet

CO_SMI

mile (statute mile)

CO_SN

square rod

CO_SO

spool

CO_SON

Son

CO_SP

shelf package

CO_SQ

square

CO_SR

strip

CO_SS

sheet metric meas:ure

CO_SST

short standard (7200 matches)

CO_ST

sheet

CO_STN

net ton (2000 lb)

CO_SV

skid

CO_SX

shipment

CO_T0

telecommunication line in service

CO_T1

thousand pound gross

CO_T3

thousand piece

CO_T4

thousand bag

CO_T5

thousand cas:ing

CO_T6

thousand gallon (US)

CO_T7

thousand impression

CO_T8

thousand linear inch

CO_TA

tenth cubic foot

CO_TAH

kiloampere hour (thousand ampere hour)

CO_TC

truckload

CO_TD

therm

CO_TE

tote

CO_TF

ten square yard

CO_TI

thousand square inch

CO_TJ

thousand square centimetre

CO_TK

tank, rectangular

CO_TL

thousand feet (linear)

CO_TN

tin

CO_TNE

metric ton

CO_TNP

Number of parts

CO_TP

ten pack

CO_TPR

ten pair

CO_TQ

thousand feet

CO_TQD

thousand cubic metre per day

CO_TR

ten square feet

CO_TRL

trillion (EUR)

CO_TS

thousand square feet

CO_TSD

tonne of substance 90 % dry

CO_TSH

ton of steam per hour

CO_TT

thousand linear metre

CO_TU

tube

CO_TV

thousand kilogram

CO_TW

thousand sheet

CO_TY

tank, cylindrical

CO_U1

treatment

CO_U2

tablet

CO_UA

torr

CO_UB

telecommunication line in service average

CO_UC

telecommunication port

CO_UD

tenth minute

CO_UE

tenth hour

CO_UF

usage per telecommunication line average

CO_UH

ten thousand yard

CO_UM

million unit

CO_VA

volt ampere per kilogram

CO_VI

vial

CO_VLT

volt

CO_VQ

bulk

CO_VS

visit

CO_W2

wet kilo

CO_W4

two week

CO_WA

watt per kilogram

CO_WB

wet pound

CO_WCD

cord

CO_WE

wet ton

CO_WEB

weber

CO_WEE

week

CO_WG

wine gallon

CO_WH

wheel

CO_WHR

watt hour

CO_WI

weight per square inch

CO_WM

working month

CO_WR

wrap

CO_WSD

standard

CO_WTT

watt

CO_WW

millilitre of water

CO_X1

chain

CO_YDK

square yard

CO_YDQ

cubic yard

CO_YL

hundred linear yard

CO_YRD

yard

CO_YT

ten yard

CO_Z1

lift van

CO_Z2

chest

CO_Z3

cas:k

CO_Z4

hogshead

CO_Z5

lug

CO_Z6

conference point

CO_Z8

newspage agate line

CO_ZP

page

CO_ZZ

mutually defined

CO_AS_M

alcoholic strength by mas:s

CO_AS_U

alcoholic strength by volume
Example
"CO_04"

UnitCodeOutput

Description

Defines the response object for the unit code

Fields
Field Name Description
code - String A code signifying the unit code.
description - String The description or meaning of unit code.
Example
{
  "code": "xyz789",
  "description": "xyz789"
}

VoidInvoiceInput

Description

Structure that defines all the necessary information for void an invoice.

Fields
Input Field Description
id - DocumentConsecutiveInput!

Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.

  • Mandatory: required
invoiceToVoid - InvoiceIdInput!

This structure stores the consecutive and the ID of the invoice to be voided.

  • Mandatory: required
issuerSoftwareSystem - IssuerSoftwareSystem

Additional information to inform the software system issuing the document.

  • Mandatory: optional
notes - [DocumentNotes]

Additional information: Free text, related to the document.

  • Mandatory: optional
  • Length: [1-n]
reason - LocalizedStringInput!

Free text field to enter the reason for cancelling the invoice.

  • Mandatory: optional
Example
{
  "id": DocumentConsecutiveInput,
  "invoiceToVoid": InvoiceIdInput,
  "issuerSoftwareSystem": IssuerSoftwareSystem,
  "notes": [DocumentNotes],
  "reason": LocalizedStringInput
}

Warning

Description

Defines the return structure for a warning

Fields
Field Name Description
helpText - String Informative text of the warning that was presented.
id - String Identifier of the warning presented.
language - String Language in which warning is returned.
message - String Detailed warning message.
subType - String Warning subcategorization.
title - String Title of the warning presented.
type - String Type of warning presented.
Example
{
  "helpText": "xyz789",
  "id": "xyz789",
  "language": "abc123",
  "message": "xyz789",
  "subType": "xyz789",
  "title": "abc123",
  "type": "xyz789"
}

WithholdingCode

Description

Document withholdings

Values
Enum Value Description

CO_05

ReteIVA: IVA withholding

CO_06

ReteRenta: Income Tax Withholding

CO_07

ReteICA: ICA withholding
Example
"CO_05"

WithholdingNameOutput

Description

Defines the response object for the withholding name

Fields
Field Name Description
code - String A code signifying the document withholdings.
description - String The description or meaning of the withholding.
Example
{
  "code": "xyz789",
  "description": "abc123"
}

WithholdingTotal

Description

Estructure for he total amount of a specific type of tax.

Fields
Field Name Description
roundingAmount - decimal The rounding amount (positive or negative) added to the calculated withholding total to produce the rounded WithholdingAmount
withholdingAmount - decimal The total withholding amount for a particular withholding scheme
withholdingName - WithholdingNameOutput Structure with the selected withholding
withholdingSubtotal - [TaxSubtotal] One of the subtotals the sum of which equals the total withholding amount for a particular withholding scheme
Example
{
  "roundingAmount": decimal,
  "withholdingAmount": decimal,
  "withholdingName": WithholdingNameOutput,
  "withholdingSubtotal": [TaxSubtotal]
}

WithholdingTotalInput

Description

Structure that defines all the necessary information for the total amount of a specific type of withholding

Fields
Input Field Description
roundingAmount - decimal

The rounding amount (positive or negative) added to the calculated tax total to produce the rounded TaxAmount.

  • Mandatory: required
  • Range: It must have between 0 and 15 positions, with between 0 and 6 decimal places
withholdingAmount - decimal!

The total withholding amount for a particular withholding scheme.

  • Mandatory: required
  • Range: It must have between 0 and 15 positions, with between 0 and 6 decimal places
withholdingName - WithholdingCode!

he name of this withholding category

  • Mandatory: required
withholdingSubtotal - [TaxSubtotalInput!]!

One of the subtotals the sum of which equals the total withholding amount for a particular withholding scheme

  • Mandatory: required
  • Length: [1-n]
Example
{
  "roundingAmount": decimal,
  "withholdingAmount": decimal,
  "withholdingName": "CO_05",
  "withholdingSubtotal": [TaxSubtotalInput]
}

XmlFileInput

Description

Structure that defines all the necessary information for an XML File.

Fields
Input Field Description
data - StringBase64!

File contents.

  • Mandatory: required
organizationalUnitId - UID!

Unit used to issue the document.

  • Mandatory: required
Example
{
  "data": StringBase64,
  "organizationalUnitId": UID
}

decimal

Description

The decimal sacalar represents an exact numeric value with practically unlimited precision serialized as a string. Example: "25.0", "10", "52.02001"

Example
decimal

email

Description

The email scalar type represents an email address.

Example
email

json

Description

The JSON scalar type represents arbitrary JSON string data, represented as UTF-8 character sequences. The JSON type is most often used to represent a free-form human-readable JSON string.

Example
json

reasonCode

Description

Defines the response object for the reason code

Fields
Field Name Description
code - String The code of the modifier codes.
description - String The description or meaning of the modifier codes.
Example
{
  "code": "xyz789",
  "description": "abc123"
}

uri

Description

A string of characters used to identify a resource on a computer network, of which the best known type is the web address or URL.

Example
uri